Merge branch 'master' into master

Author: grasmash

.circleci/config.yml

@@ -0,0 +1,61 @@
+# https://circleci.com/docs/2.0/workflows/#using-workspaces-to-share-data-among-jobs
+defaults: &defaults
+  working_directory: ~/drush
+  environment:
+    TZ: "/usr/share/zoneinfo/America/Los_Angeles"
+    TERM: dumb
+    UNISH_NO_TIMEOUTS: y
+    UNISH_DB_URL: mysql://root:@127.0.0.1
+    UNISH_TMP: /tmp
+    PHPUNIT_ARGS: ""
+
+version: 2
+jobs:
+  build:
+    <<: *defaults
+    docker:
+      - image: circleci/php:7.1-apache-node
+        environment:
+          - MYSQL_HOST=127.0.0.1
+      - image: circleci/mysql:5.7.18
+    steps:
+      - checkout
+      - run: $HOME/drush/.circleci/setup.sh
+      - run: unish.sut.php
+      - run: unish.phpunit.php $PHPUNIT_ARGS
+
+  build_highest:
+    <<: *defaults
+    docker:
+      - image: circleci/php:7.1-apache-node
+        environment:
+          - MYSQL_HOST=127.0.0.1
+          - COMPOSER=composer-highest.json
+      - image: circleci/mysql:5.7.18
+    steps:
+      - checkout
+      - run: $HOME/drush/.circleci/setup.sh
+      - run: unish.sut.php
+      - run: unish.phpunit.php $PHPUNIT_ARGS
+
+  build_56:
+    <<: *defaults
+    docker:
+      - image: circleci/php:5.6-apache-node
+        environment:
+          - MYSQL_HOST=127.0.0.1
+      - image: circleci/mysql:5.7.18
+    steps:
+      - checkout
+      - run: $HOME/drush/.circleci/setup.sh
+      - run: unish.sut.php
+      - run: unish.phpunit.php $PHPUNIT_ARGS
+
+workflows:
+  version: 2
+  build_test:
+    jobs:
+      - build
+      - build_highest
+      - build_56
+

.circleci/setup.sh

@@ -0,0 +1,38 @@
+#!/bin/bash
+
+# Install PHP extensions
+sudo docker-php-ext-install pdo_mysql
+
+# Install extension
+sudo apt-get install -y libpng-dev
+
+# Install PHP Extensions
+sudo docker-php-ext-install gd
+
+# Install Composer
+'curl -sS https://getcomposer.org/installer | sudo php -- --install-dir=/usr/local/bin --filename=composer'
+
+# Display versions
+php -v
+composer --version
+
+# Install mysql-client
+sudo apt-get install mysql-client
+
+# Configure bash environment variables
+echo 'export PATH=~/.composer/vendor/bin:~/drush:$PATH' >> $BASH_ENV
+echo 'export HOME=/tmp/drush-sandbox/home' >> $BASH_ENV
+mkdir -p /tmp/drush-sandbox/home
+
+# Configure php.ini
+echo 'mbstring.http_input = pass' > $HOME/php.ini
+echo 'mbstring.http_output = pass' >> $HOME/php.ini
+echo 'memory_limit = -1' >> $HOME/php.ini
+echo 'sendmail_path = /bin/true' >> $HOME/php.ini
+echo 'date.timezone = "UTC"' >> $HOME/php.ini
+echo 'opcache.enable_cli = 0' >> $HOME/php.ini
+
+# Copy our php.ini configuration to the active php.ini file
+# We can't use `php -r 'print php_ini_loaded_file();` when there is no php.ini
+PHPINI_PATH="$(php -i | grep 'Configuration File (php.ini) Path' | sed -e 's#.*=> *##')/php.ini"
+cat $HOME/php.ini | sudo tee "$PHPINI_PATH" > /dev/null

.travis.yml

@@ -12,6 +12,7 @@ php:
 #  See master-fulltest branch for broader PHP version testing.
   - 5.6
   - 7.0
+  - 7.2
 
 # Cache Composer.
 cache:
@@ -26,23 +27,14 @@ env:
     - TEST_DIR=isolation ISOLATION_INSTALL='install --prefer-dist'
     - TEST_DIR=isolation ISOLATION_INSTALL='update --prefer-dist --prefer-lowest'
     - TEST_DIR=isolation ISOLATION_INSTALL='update --prefer-dist'
-    - PHPUNIT_ARGS=--group=base
-    - PHPUNIT_ARGS=--group=commands
-    - PHPUNIT_ARGS=--exclude-group=base,commands
-    - COMPOSER=composer-highest.json PHPUNIT_ARGS=--group=base
-    - COMPOSER=composer-highest.json PHPUNIT_ARGS=--group=commands
-    - COMPOSER=composer-highest.json PHPUNIT_ARGS=--exclude-group=base,commands
   global:
-    # Github deploy
+    # GitHub deploy
     - secure: VfYokT2CchfuBRJp9/gSwfVGPfsVfkZdDVEuNWEqxww3z4vq+5aLKqoCtPL54E5EIMjhyCE3GVo+biG35Gab1KOVgUs8zD1hAUWA1FPKfMFhoPDfI3ZJC2rX2T1iWK4ZR90pBtcPzS+2OObzTYz8go0PfeSTT6eq69Na1KcNLaE=
     - UNISH_NO_TIMEOUTS=y
     - UNISH_DB_URL=mysql://root:@127.0.0.1
     - UNISH_TMP=/tmp
 
-matrix:
-  allow_failures:
-    - php: 7.0
-      env: COMPOSER=composer-highest.json
+
 
 before_install:
   - echo 'mbstring.http_input = pass' >> ~/.phpenv/versions/$(phpenv version-name)/etc/conf.d/travis.ini
@@ -51,22 +43,20 @@ before_install:
 
 # Build a System-Under-Test.
 install:
-  - if [ -n "$TEST_DIR" ] ; then composer -n --working-dir=${PWD}/$TEST_DIR $ISOLATION_INSTALL ; fi
-  - if [ -z "$TEST_DIR" ] ; then ${PWD}/unish.sut.php ; fi
+  - composer -n --working-dir=${PWD}/$TEST_DIR $ISOLATION_INSTALL
 
 before_script:
   - phpenv config-rm xdebug.ini
   - echo 'sendmail_path = /bin/true' >> ~/.phpenv/versions/$(phpenv version-name)/etc/conf.d/travis.ini
   # - echo "sendmail_path='true'" >> `php --ini | grep "Loaded Configuration" | awk '{print $4}'`
 
 script:
-  - if [ -n "$TEST_DIR" ] ; then cd $TEST_DIR && phpunit ; fi
-  - if [ -z "$TEST_DIR" ] ; then ${PWD}/unish.phpunit.php $PHPUNIT_ARGS; fi
+  - cd $TEST_DIR && phpunit
 
 after_success:
   # Publish updated API documentation on every push to the master branch
   - git config --global user.email $GITHUB_USER_EMAIL
   - git config --global user.name "Drush Documentation Bot"
-  - build/scripts/publish-api-docs.sh
+  - cd $TRAVIS_BUILD_DIR && build/scripts/publish-api-docs.sh
   # Background: https://github.com/drush-ops/drush/pull/1426
   #- ${PWD}/tests/testChildren.sh

CONTRIBUTING.md

@@ -1,7 +1,7 @@
 Drush is built by people like you! Please [join us](https://github.com/drush-ops/drush).
 
 ## Git and Pull requests
-* Contributions are submitted, reviewed, and accepted using Github pull requests. [Read this article](https://help.github.com/articles/using-pull-requests) for some details. We use the _Fork and Pull_ model, as described there.
+* Contributions are submitted, reviewed, and accepted using GitHub pull requests. [Read this article](https://help.github.com/articles/using-pull-requests) for some details. We use the _Fork and Pull_ model, as described there.
 * The latest changes are in the `master` branch. PR's should initially target this branch.
 * Try to make clean commits that are easily readable (including descriptive commit messages!)
 * Test before you push. Get familiar with Unish, our test suite. See the test-specific [README.md](tests/README.md)

README.md

@@ -2,16 +2,20 @@ Drush is a command line shell and Unix scripting interface for Drupal. Drush cor
 
 [![Latest Stable Version](https://poser.pugx.org/drush/drush/v/stable.png)](https://packagist.org/packages/drush/drush) [![Total Downloads](https://poser.pugx.org/drush/drush/downloads.png)](https://packagist.org/packages/drush/drush) [![Latest Unstable Version](https://poser.pugx.org/drush/drush/v/unstable.png)](https://packagist.org/packages/drush/drush) [![License](https://poser.pugx.org/drush/drush/license.png)](https://packagist.org/packages/drush/drush) [![Documentation Status](https://readthedocs.org/projects/drush/badge/?version=master)](https://readthedocs.org/projects/drush/?badge=master)
 
+| Code style | Isolation Tests | Functional Tests |
+| :--------: | :-------------: | :--------------: |
+| <img src="https://api.shippable.com/projects/5507addd5ab6cc1352a213b5/badge?branch=master"> | <img src="https://travis-ci.org/drush-ops/drush.svg?branch=master"> | <img src="https://circleci.com/gh/drush-ops/drush.svg?style=shield"> |
+
 Resources
 -----------
-* [Installing (and Upgrading)](http://docs.drush.org/en/master/install/) [(Drush8)](http://docs.drush.org/en/8.x/install/)
-* [General Documentation](http://docs.drush.org) [(Drush8)](http://docs.drush.org/en/8.x)
-* [API Documentation](http://www.drush.org/api/master/index.html) [(Drush8)](http://api.drush.org)
+* [Installing (and Upgrading)](http://docs.drush.org/en/master/install/)
+* [General Documentation](http://docs.drush.org)
+* [API Documentation](http://www.drush.org/api/master/index.html)
 * [Drush Commands](http://drushcommands.com)
 * Subscribe [this atom feed](https://github.com/drush-ops/drush/releases.atom) to receive notification of new releases. Also, [Version eye](https://www.versioneye.com/).
 * [Drush packages available via Composer](https://packagist.org/search/?type=drupal-drush)
 * [A list of modules that include Drush integration](https://www.drupal.org/project/project_module?f[2]=im_vid_3%3A4654&solrsort=ds_project_latest_release+desc)
-* Drush comes with a [full test suite](https://github.com/drush-ops/drush/blob/master/tests/README.md) powered by [PHPUnit](https://github.com/sebastianbergmann/phpunit). Each commit gets tested by the awesome [Travis.ci continuous integration service](https://travis-ci.org/drush-ops/drush).
+* Drush comes with a [full test suite](https://github.com/drush-ops/drush/blob/master/tests/README.md) powered by [PHPUnit](https://github.com/sebastianbergmann/phpunit). Each commit gets tested by the awesome [Travis CI continuous integration service](https://travis-ci.org/drush-ops/drush).
 
 Support
 -----------
@@ -35,7 +39,7 @@ FAQ
 >     rhymes with hush, rush, flush, etc. This is the preferred pronunciation.
 >
 >  Q: Does Drush have unit tests?<br>
->  A: Drush has an excellent suite of unit tests. See 
+>  A: Drush has an excellent suite of unit tests. See
 > [tests/README.md](https://github.com/drush-ops/drush/blob/master/tests/README.md) for more information.
 
 

build/scripts/publish-api-docs.sh

@@ -7,7 +7,7 @@ BRANCH_REGEX='^\(master\|9\.[0-9x.]*\)$'
 test -n "$TRAVIS"                             || { echo "This script is only designed to be run on Travis."; exit 0; }
 echo "$TRAVIS_BRANCH" | grep -q $BRANCH_REGEX || { echo "Skipping docs update for branch $TRAVIS_BRANCH - docs only updated for master branch and tagged builds."; exit 0; }
 test "$TRAVIS_PULL_REQUEST" == "false"        || { echo "Skipping docs update -- not done on pull requests. (PR #$TRAVIS_PULL_REQUEST)"; exit 0; }
-test "${TRAVIS_PHP_VERSION:0:1}" == "7"     || { echo "Skipping docs update for PHP $TRAVIS_PHP_VERSION -- only update for PHP 5.6 build."; exit 0; }
+test "${TRAVIS_PHP_VERSION:0:1}" == "7"     || { echo "Skipping docs update for PHP $TRAVIS_PHP_VERSION -- only update for PHP 7 builds."; exit 0; }
 test "$TRAVIS_REPO_SLUG" == "drush-ops/drush"   || { echo "Skipping docs update for repository $TRAVIS_REPO_SLUG -- do not build docs for forks."; exit 0; }
 
 # Check our requirements for running this script have been met.

circle.yml

@@ -2,7 +2,7 @@
   "name": "drush/drush",
   "description": "Drush is a command line shell and scripting interface for Drupal, a veritable Swiss Army knife designed to make life easier for those of us who spend some of our working hours hacking away at the command prompt.",
   "homepage": "http://www.drush.org",
-  "license": "GPL-2.0+",
+  "license": "GPL-2.0-or-later",
   "minimum-stability": "dev",
   "prefer-stable": true,
   "authors": [
@@ -26,7 +26,7 @@
   "require": {
     "php": ">=5.6.0",
     "ext-dom": "*",
-    "chi-teck/drupal-code-generator": "^1.21.0",
+    "chi-teck/drupal-code-generator": "^1.24.0",
     "composer/semver": "^1.4",
     "consolidation/annotated-command": "^2.8.1",
     "consolidation/config": "^1.0.9",
@@ -68,8 +68,8 @@
     }
   },
   "scripts": {
-    "cs": "phpcs -n --standard=PSR2 src tests",
-    "cbf": "phpcbf -n --standard=PSR2 src tests",
+    "cs": "phpcs -n --standard=PSR2 src tests examples",
+    "cbf": "phpcbf -n --standard=PSR2 src tests examples",
     "lint": [
       "find includes -name '*.inc' -print0 | xargs -0 -n1 php -l",
       "find src -name '*.php' -print0 | xargs -0 -n1 php -l",
@@ -82,7 +82,7 @@
   },
   "extra": {
     "branch-alias": {
-        "dev-master": "9.0.x-dev"
+        "dev-master": "9.x-dev"
     }
   }
 }

composer.json

@@ -4,7 +4,7 @@ When preparing to run a command, Drush works by "bootstrapping" the Drupal envir
 
 For efficiency and convenience, some Drush commands can work without first bootstrapping a Drupal site, or by only partially bootstrapping a site. This is faster than a full bootstrap. It is also a matter of convenience, because some commands are useful even when you don't have a working Drupal site.
 
-Commands may specify their bootstrap level with a `@bootstrap` annotation. Commands supplied by Drupal modules are `@bootstrap max`.
+Commands may specify their bootstrap level with a `@bootstrap` annotation. Commands supplied by Drupal modules are always `@bootstrap full`.
 
 @bootstrap none
 -----------------------

docs/bootstrap.md

@@ -8,7 +8,7 @@ Creating a new Drush command or porting a legacy command is easy. Follow the ste
     1. (optional) Drush will also prompt for the path to a legacy command file to port. See [tips on porting command to Drush 9](https://weitzman.github.io/blog/port-to-drush9)
     1. The module selected must already exist and be enabled. Use `drush generate module-standard` to create a new module.
 1. Drush will then report that it created a commandfile, a drush.services.yml file and a composer.json file. Edit those files as needed.
-1. Use the classes for the core Drush commands at /src/Drupal/Commands as inspiration and documentation.
+1. Use the classes for the core Drush commands at [/src/Drupal/Commands](https://github.com/drush-ops/drush/tree/master/src/Drupal/Commands) as inspiration and documentation.
 1. See the [dependency injection docs](dependency-injection.md) for interfaces you can implement to gain access to Drush config, Drupal site aliases, etc.
 1. Once your two files are ready, run `drush cr` to get your command recognized by the Drupal container.
 
@@ -42,15 +42,36 @@ It is also possible to use [version ranges](https://getcomposer.org/doc/articles
 
 In Drush 9, the default services file, `drush.services.yml`, will be used in instances where there is no `services` section in the Drush extras of the project's composer.json file. In Drush 10, however, the services section must exist, and must name the services file to be used. If a future Drush extension is written such that it only works with Drush 10 and later, then its entry would read `"drush.services.yml": "^10"`, and Drush 9 would not load the extension's commands. It is all the same recommended that Drush 9 extensions explicitly declare their services file with an appropriate version constraint.
 
+Altering Drush Command Info
+===========================
+
+Drush command info (annotations) can be altered from other modules. This is done by creating and registering 'command info alterers'. Alterers are class services that are able to intercept and manipulate an existing command annotation.
+
+In order to alter an existing command info, follow the next steps:
+
+1. In the module that wants to alter a command info, add a service class that implements the `\Consolidation\AnnotatedCommand\CommandInfoAltererInterface`.
+1. In the module `drush.services.yml` declare a service pointing to this class and tag the service with the `drush.command_info_alterer` tag.
+1. In the class implement the alteration logic the `alterCommandInfo()` method.
+1. Along with the alter code, it's strongly recommended to log a debug message explaining what exactly was altered. This would allow the easy debugging. Also it's a good practice to inject the the logger in the class constructor.
+
+For an example, see the alterer class provided by the testing 'woot' module: `tests/resources/modules/d8/woot/src/WootCommandInfoAlterer.php`.
+
 Global Drush Commands
 ==============================
 
-Commandfiles that don't ship inside Drupal modules are called 'global' commandfiles. See the examples/Commands folder for examples. In general, its better to use modules to carry your Drush commands. If you still prefer using a global commandfiles, please note:
+Commandfiles that don't ship inside Drupal modules are called 'global' commandfiles. See the [examples/Commands](/examples/Commands) folder for examples. In general, it's better to use modules to carry your Drush commands. If you still prefer using a global commandfiles, here are two examples of valid commandfile names and namespaces:
+
+1. Simple
+     - Filename: $PROJECT_ROOT/drush/Commands/ExampleCommands.php
+     - Namespace: Drush\Commands
+1. Nested (e.g. Commandfile is part of a Composer package)
+    - Filename: $PROJECT_ROOT/drush/Commands/dev_modules/ExampleCommands.php
+    - Namespace: Drush\Commands\dev_modules
 
-1. The file's namespace should be `\Drush\Commands`.
-1. The filename must be have a name like Commands/FooCommands.php
-    1. The prefix `Foo` can be whatever string you want. The file must end in `Commands.php`
-    1. The enclosing directory must be named `Commands`
+##### Tips
+1. The filename must be have a name like Commands/ExampleCommands.php
+    1. The prefix `Example` can be whatever string you want.
+    1. The file must end in `Commands.php`
 1. The directory above Commands must be one of: 
     1.  A Folder listed in the 'include' option. include may be provided via config or via CLI.
     1.  ../drush, /drush or /sites/all/drush. These paths are relative to Drupal root.