Updating docs

Author: cryptiklemur

docs/blocks.rst

@@ -44,9 +44,6 @@ Then, add it to your ``.bldr.yml`` file:
 
     bldr: ~
 
-    blocks:
-        - Acme\Block\Demo\AcmeDemoBlock
-
     # If you have configs
     acme_demo:
         some_setting: some_value
@@ -64,9 +61,9 @@ This extension lets you run ``exec`` and ``apply`` tasks.
 
 .. code-block:: yaml
 
-    tasks:
+    jobs:
         sample:
-            calls:
+            tasks:
                 -
                     task: exec
                     executable: php
@@ -91,9 +88,9 @@ Some examples:
 
 .. code-block:: yaml
 
-    tasks:
+    jobs:
         sample:
-            calls:
+            tasks:
                 -
                     task: filesystem:mkdir
                     files: [testDir]
@@ -116,9 +113,9 @@ To use this:
 
 .. code-block:: yaml
 
-    tasks:
+    jobs:
         sample:
-            calls:
+            tasks:
                 -
                     task: notify
                     message: Test Message
@@ -128,9 +125,6 @@ When adding this extension, you can specify `smtp` connections:
 
 .. code-block:: yaml
 
-    blocks:
-        - Bldr\Block\Notify\NotifyBlock
-
     notify:
         smtp:
             host: smtp.google.com
@@ -149,17 +143,17 @@ This one needs some work. Right now, you can only have one watch task.
 
 .. code-block:: yaml
 
-    tasks:
+    jobs:
         sample:
-            calls:
+            tasks:
                 -
                     task: watch
                     src:
                         - { path: [src, tests], files: *.php, recursive: true } # Checks src and tests directories for *.php files recursively
                         - { path: vendor/, files: [*.php, *.yml], recursive: true } # Checks vendor/ directory for *.php and *.yml files recursively
                     profile: someProfile
         sample2:
-            calls:
+            tasks:
                 -
                     task: watch
                     src:

docs/creating-a-block.rst

@@ -27,7 +27,7 @@ stable release you will have to add them too into your composer.json as below:
 
     {
         "require-dev": {
-            "bldr-io/bldr":              "~4.2.0",
+            "bldr-io/bldr":              "~7.0.0",
             "dflydev/embedded-composer": "dev-master@dev",
             "composer/composer":         "dev-master@dev"
         }
@@ -36,7 +36,7 @@ stable release you will have to add them too into your composer.json as below:
 4. Create a Block class
 -----------------------
 
-All of bldr, and the official extensions follow `PSR-4`_ (as well as all the other PSR's, and most, if not all, of the bylaws).
+All of bldr, and the official extensions follow `PSR-4`_ (as well as all the other applicable PSR's, and most, if not all, of the bylaws).
 With that, create your directory structure and your Block class:
 
 .. code-block:: shell
@@ -76,22 +76,23 @@ All blocks must extend the `Bldr\DependencyInjection\AbstractBlock`_, so your cl
 The assemble function is where the magic happens. If you take a look at the AbstractBlock, there are some helper functions
 in there to make it easier to add new calls, services, and parameters to the Container.
 
-5. Create your Call
+5. Create your Task
 -------------------
 
-As a demo, let's say we want to make a call that will output a random number to the user when running the call.
+As a demo, let's say we want to make a task that will output a random number to the user when running the task.
 
-First, lets create the call. Directory structure doesn't really matter, but the core structure is normally `src/Call/<Name>Call.php`.
-Similar to blocks, all calls must extend `Bldr\Call\AbstractCall`_.
+First, lets create the task. Directory structure doesn't really matter, but the core structure is normally `src/Task/<Name>Task.php`.
+Similar to blocks, all tasks should extend `Bldr\Block\Core\Task\AbstractTask`_ and must implement `Bldr\Task\TaskInterface`_.
 
-Lets make the `src/Call` directory, and create the new Call:
+Lets make the `src/Task` directory, and create the new task:
 .. code-block:: shell
 
-    mkdir src/Call && vim src/Call/OutputRandomNumberCall.php
+    mkdir src/Task && vim src/Task/OutputRandomNumberCall.php
 
-Then, let's build the call class! Extending the AbstractCall, requires that we implement two methods: `configure`_ and `run`_
+Then, let's build the task class! Extending the AbstractTask, suggests that we implement `configure`_ and requires that we
+implement `run`_.
 
-*src/Call/OutputRandomNumberCall.php*
+*src/Task/OutputRandomNumberTask.php*
 
 .. code-block:: php
 
@@ -101,14 +102,15 @@ Then, let's build the call class! Extending the AbstractCall, requires that we i
      * License Information
      */
 
-    namespace Acme\Block\Demo\Call;
+    namespace Acme\Block\Demo\Task;
 
-    use Bldr\Call\AbstractCall;
+    use Bldr\Block\Core\Task\AbstractTask;
+    use Symfony\Component\Console\Output\OutputInterface;
 
     /**
      * @author John Doe <john@doh.com>
      */
-    class OutputRandomNumberCall extends AbstractCall
+    class OutputRandomNumberTask extends AbstractTask
     {
         /**
          * {@inheritDoc}
@@ -117,24 +119,22 @@ Then, let's build the call class! Extending the AbstractCall, requires that we i
         {
             $this->setName('acme_demo:output_random_number')
                 ->setDescription('This call outputs a random number. If min and max are specified, it will use those as the range')
-                ->addOption('min', true, 'Minimum number in range', 0)
-                ->addOption('max', true, 'Maximum number in range', 100)
+                ->addParameter('min', true, 'Minimum number in range', 0)
+                ->addParameter('max', true, 'Maximum number in range', 100)
             ;
         }
 
         /**
          * {@inheritDoc}
          */
-        public function run()
+        public function run(OutputInterface $output)
         {
-            $random = rand($this->getOption('min'), $this->getOption('max'));
-            $this->output->writeln(['', 'Random Number: '.$random, '']);
-
-            return true;
+            $random = rand($this->getParameter('min'), $this->getParameter('max'));
+            $output->writeln(['', 'Random Number: '.$random, '']);
         }
     }
 
-Next, we need to add the call to the container, so we can use it in .bldr.yml files:
+Next, we need to add the task to the container, so we can use it in .bldr.yml(.dist) files:
 
 *src/AcmeDemoBlock.php*
 
@@ -164,15 +164,15 @@ Next, we need to add the call to the container, so we can use it in .bldr.yml fi
             // Here's one of the shortcut methods! This method will return a Symfony DI Definition
             // that is tagged as `bldr`. If you need to, you can easily add arguments to the constructor,
             // or calls to methods.
-            $call = $this->addCall('acme_demo.output_random_number', 'Acme\Block\Demo\AcmeDemoBlock');
+            $task = $this->addTask('acme_demo.output_random_number', 'Acme\Block\Demo\Task\OutputRandomNumberTask');
 
             // If you need dependencies, you could do the following:
-            // $call->setArgument(0, new Reference('some_service'));
+            // $task->setArgument(0, new Reference('some_service'));
             // or
             // $arguments = array(new Reference('some_service'));
-            // $call->addMethodCall('someMethodName', $arguments);
+            // $task->addMethodCall('someMethodName', $arguments);
 
-            // If you want to add a service, that isn't a call, you can also use:
+            // If you want to add a service, that isn't a task, you can also use:
             // $this->addService($name, $class);
             // Which will also return a Symfony DI Definition
         }
@@ -199,12 +199,12 @@ With this, you should be able to install it with the `bldr.json` file and add it
         name: some/name
         profile:
             test:
-                tasks:
+                jobs:
                     - randomize
 
-        tasks:
+        jobs:
             randomize:
-                calls:
+                tasks:
                     -
                         type: acme_demo:output_random_number
                         min: 0
@@ -214,7 +214,7 @@ And run it!
 
 .. code-block:: shell
 
-    ./bldr.phar build test
+    ./bldr.phar run test
 
 
 There's some more advanced stuff, like being able to specify configuration:
@@ -291,6 +291,7 @@ Then make a Configuration.php file. This config is the config from Symfony. You
 
 .. _PSR-4: http://www.php-fig.org/psr/psr-4/
 .. _BldrDependencyInjectionAbstractBlock: https://github.com/bldr-io/bldr/blob/master/src/DependencyInjection/AbstractBlock.php
-.. _BldrCallAbstractCall:https://github.com/bldr-io/bldr/blob/master/src/Call/AbstractCall.php
+.. _BldrBlockCoreTaskAbstractTask:https://github.com/bldr-io/bldr/blob/master/src/Block/Core/Task/AbstractTask.php
+.. _BldrTaskTaskInterface:https://github.com/bldr-io/bldr/blob/master/src/Task/TaskInterface.php
 .. _configure: https://github.com/bldr-io/bldr/blob/master/src/Call/CallInterface.php#L28
 .. _run: https://github.com/bldr-io/bldr/blob/master/src/Call/CallInterface.php#L54

docs/index.rst

@@ -4,7 +4,7 @@ Welcome to Bldr's documentation!
 Bldr, in the simplest terms, is a task runner, and an awesome one at that. It was written with simpler configs in mind. If you are used to build systems,
 you've probably seen some pretty complicated build files, and they were probably written in xml that is clunky and a pain to maintain.
 
-Well, here's one written for Bldr using yaml (json is also supported):
+Well, here's one written for Bldr using yaml (json and php are also supported):
 
 **This is a sample configuration. Your project may not have the dependencies required to run this configuration.**
 
@@ -17,18 +17,19 @@ Well, here's one written for Bldr using yaml (json is also supported):
         profiles:
             default:
                 description: Development Profile
-                tasks:
+                jobs:
                     - prepare
                     - lint
                     - phpcs
                     - test
 
-        tasks:
+        jobs:
             prepare:
                 description: Cleans up old builds and prepares the new one
-                calls:
+                tasks:
                     -
                         type: filesystem:remove
+                        continue
                         files: [build/coverage, build/logs]
                     -
                         type: filesystem:mkdir
@@ -42,18 +43,17 @@ Well, here's one written for Bldr using yaml (json is also supported):
                         arguments: [install, --prefer-dist]
             lint:
                 description: Lints the files of the project
-                calls:
+                tasks:
                     -
                         type: apply
-                        failOnError: true
                         src:
                             - { path: [src, tests], files: *.php, recursive: true } # Checks src and tests directories for *.php files recursively
                         executable: php
                         arguments: [-l]
 
             phpcs:
                 description: Runs the PHP Code Sniffer
-                calls:
+                tasks:
                     -
                         type: exec
                         executable: php
@@ -66,10 +66,9 @@ Well, here's one written for Bldr using yaml (json is also supported):
                             - src/
             test:
                 description: Runs the PHPUnit Tests
-                calls:
+                tasks:
                     -
                         type: exec
-                        failOnError: true
                         executable: php
                         arguments:
                             - bin/phpunit
@@ -91,7 +90,6 @@ Content
     :maxdepth: 2
 
     installation
-    configuration
     usage
     blocks
     creating-a-block

docs/installation.rst

@@ -9,7 +9,7 @@ in ``$PATH`` as shown here_.
 
 .. code-block:: shell
 
-    $ composer global require bldr-io/bldr=~4.2.0 dflydev/embedded-composer=dev-master@dev composer/composer=dev-master@dev
+    $ composer global require bldr-io/bldr=~7.0.0 dflydev/embedded-composer=dev-master@dev composer/composer=dev-master@dev
 
     # Or
 
@@ -31,7 +31,7 @@ It is suggested that you use the phar, as you can get conflicts with dependencie
 
     # Or
 
-    $ composer require bldr-io/bldr "~6.4.0"
+    $ composer require bldr-io/bldr "~7.0.0"
 
 
 And that's it! From here, you should be able to run ``bldr`` if you set it up globally, or ``./bin/bldr`` or ``php ./vendor/bin/bldr`` if you set

docs/usage.rst

@@ -12,49 +12,49 @@ Create a ``.bldr.yml(.dist)`` file:
     bldr:
         name: some/name
         description:  A description about the project # (Not Required)
-        profiles: # A list of profiles that can be ran with `./bldr.phar build`
-            someTask:
-                description: Gets ran when `./bldr.phar build someTask` is called
-                tasks:
+        profiles: # A list of profiles that can be ran with `./bldr.phar run`
+            someJob:
+                description: Gets ran when `./bldr.phar run someJob` is called
+                jobs:
                     - foo
-            someOtherTask:
-                tasks:
+            someOtherJob:
+                jobs:
                     - bar
             inheritanceExample:
-                description: Will run the tasks from `someTask` and then `someOtherTask`.
+                description: Will run the tasks from `someJob` and then `someOtherJob`.
                 uses:
-                    before: [someTask]
-                    after: [someOtherTask]
-        tasks:
+                    before: [someJob]
+                    after: [someOtherJob]
+        jobs:
             foo:
-                description: Foo task
-                calls:
+                description: Foo job
+                tasks:
                     -
                         type: exec
                         executable: echo
                         arguments: [Hello World]
             bar:
-                description: Bar task
-                calls:
+                description: Bar job
+                tasks:
                     -
                         type: exec
                         executable: sleep
                         arguments: [1]
 
-To view a list of available call types, run:
+To view a list of available task types, run:
 
 .. code-block:: shell
 
     ./bldr.phar task:list
 
-And to get more information on a particular type, run:
+And to get more information on a particular task, run:
 
 .. code-block:: shell
 
     ./bldr.phar task:info <task name>
 
-To run your profiles: (This has changed since version 4)
+To run your profiles: (This has changed since version 7)
 
 .. code-block:: shell
 
-    ./bldr.phar build <profile name>
+    ./bldr.phar run <profile name>