Merge pull request #39 from aequasi/finder

cryptiklemur · cryptiklemur · commit 3bf681f87a67 · 2014-04-12T21:29:55.000-07:00
This PR was merged into bldr-io:master branch. Discussion ---------- Migrating to using Symfony Finder Component |Q |A | |--- |---| |Bug Fix? |n | |New Feature? |y | |BC Breaks? |y | |Deprecations?|n | |Tests Pass? |n | |Fixed Tickets| | |License |MIT| |Doc PR | | Commits ------- 7faaca8 Switching to using finder aequasi 486d70b Updating box aequasi 9a74594 Fixing spacing aequasi 343cff8 Removing useless functions aequasi 9e96b7c Adding use statement aequasi 86f0efd Adding use statement aequasi
diff --git a/.bldr.yml.dist b/.bldr.yml.dist
@@ -13,7 +13,6 @@ bldr:
         watch:
             description: "Watch Profile"
             tasks:
-                - test
                 - watch
         server:
             description: Starts a server and waits for a bit. Then kills it.
@@ -93,8 +92,9 @@ bldr:
             calls:
                 -
                     type: watch
-                    files: [src/**.php, tests/**.php]
-                    task: test
+                    profile: default
+                    src:
+                        - { path: [src, tests], files: *.php, recursive: true }
         prepare:
             description: 'Cleans up old builds and prepares the new one'
             calls:
@@ -126,7 +126,9 @@ bldr:
                 -
                     type: apply
                     failOnError: true
-                    fileset: [src/*.php, src/**/*.php]
+                    src:
+                        - { path: [src, tests], files: *.php, recursive: true }
+                    output: /dev/null
                     executable: php
                     arguments: [-l]
 
@@ -162,3 +164,10 @@ bldr:
                     arguments:
                         - bin/phpunit
                         - --coverage-text=php://stdout
+        build:
+            description: Builds the Box
+            calls:
+                -
+                    type: exec
+                    executable: bin/box
+                    arguments: [build]
diff --git a/bin/bldr b/bin/bldr
@@ -14,48 +14,26 @@ ini_set('display_errors', 1);
  * with this source code in the file LICENSE.
  */
 
-function glob_r($pattern, $flags = 0)
-{
-    $files = glob($pattern, $flags);
+$autoloaders = [
+    getcwd().'/vendor/autoload.php',
+    __DIR__.'/../vendor/autoload.php',
+    __DIR__.'/../../../autoload.php'
+];
 
-    foreach (glob(dirname($pattern) . '/*', GLOB_ONLYDIR | GLOB_NOSORT) as $dir) {
-        $files = array_merge($files, glob_r($dir . '/' . basename($pattern), $flags));
-    }
-    return $files;
-}
-
-function glob_recursive($pattern, $flags = 0)
-{
-    if (strpos($pattern, '**') !== false) {
-        return glob_r($pattern, $flags);
-    }
-
-    return glob($pattern, $flags);
-}
-
-if (__DIR__ !== getcwd()) {
-    $paths[] = getcwd() . '/vendor';
-}
-
-$paths[] = __DIR__ . '/../vendor';
-$paths[] = __DIR__ . '/../../..';
-
-$autoloader = false;
 $loaded = [];
-foreach ($paths as $path) {
-    $filePath = $path . '/autoload.php';
-    if (file_exists($filePath)) {
-        @$fileHash = sha1_file($filePath);
-        if(!in_array($fileHash, $loaded)) {
-            $autoloader = true;
-            require $filePath;
+foreach ($autoloaders as $autoloader) {
+    if (file_exists($autoloader)) {
+        @$fileHash = sha1_file($autoloader);
+        echo $fileHash."\n";
+        if (!in_array($fileHash, $loaded)) {
+            require $autoloader;
             $loaded[] = $fileHash;
         }
     }
 }
 
-if (false === $autoloader) {
-    echo "Cannot find an autoload.php file, have you executed composer install command?\n";
+if (!sizeof($loaded)) {
+    echo "Cannot find an autoloader file, have you executed the composer install command?\n";
     exit(1);
 }
 
diff --git a/bldr.phar b/bldr.phar
diff --git a/docs/extensions.rst b/docs/extensions.rst
@@ -38,7 +38,9 @@ This extension lets you run ``exec`` and ``apply`` tasks.
                 -
                     task: apply
                     executeable: php
-                    fileset: [src/*.php, src/*/*.php]
+                    output: /dev/null
+                    src:
+                        - { path: [src, tests], files: *.php, recursive: true } # Checks src and tests directories for *.php files recursively
                     arguments: [-l]
 
 `Filesystem Extension`_ (Official)
@@ -110,13 +112,17 @@ This extension lets you run the ``watch`` commands. It will let you watch the fi
             calls:
                 -
                     task: watch
-                    files: [src/*.php, src/**/*.php]
+                    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:
                 -
                     task: watch
-                    files: [src/*.php, src/**/*.php]
+                    src:
+                        - { path: [src, tests], files: *.php, recursive: true } # Checks src and tests directories for *.php files recursively
+                        - { files: *.yml } # Checks current directory, non-recursively
                     task: someTask
 
 
@@ -138,8 +144,8 @@ This extension lets you run symfony console commands quicker. Needs work... I wa
                     - cache:clear
 
 
-.. _Execute Extension: https://github.com/bldr-io/bldr/tree/master/src/Extension
-.. _Filesystem Extension: https://github.com/bldr-io/bldr/tree/master/src/Filesystem
-.. _Notify Extension: https://github.com/bldr-io/bldr/tree/master/src/Notify
-.. _Watch Extension: https://github.com/bldr-io/bldr/tree/master/src/Watch
+.. _Execute Extension: https://github.com/bldr-io/bldr/tree/master/src/Extension/Execute
+.. _Filesystem Extension: https://github.com/bldr-io/bldr/tree/master/src/Extension/Filesystem
+.. _Notify Extension: https://github.com/bldr-io/bldr/tree/master/src/Extension/Notify
+.. _Watch Extension: https://github.com/bldr-io/bldr/tree/master/src/Extension/Watch
 .. _Symfony Extension: https://www.github.com/bldr-io/bldr-symfony/
diff --git a/src/Call/Traits/FinderAwareTrait.php b/src/Call/Traits/FinderAwareTrait.php
@@ -0,0 +1,80 @@
+<?php
+
+/**
+ * This file is part of bldr
+ *
+ * (c) Aaron Scherer <aequasi@gmail.com>
+ *
+ * This source file is subject to the license that is bundled
+ * with this source code in the file LICENSE
+ */
+
+namespace Bldr\Call\Traits;
+
+use Symfony\Component\Finder\Finder;
+use \Symfony\Component\Finder\SplFileInfo;
+
+/**
+ * @author Aaron Scherer <aequasi@gmail.com>
+ */
+trait FinderAwareTrait
+{
+    /**
+     * Finds all the files for the given config
+     *
+     * @param array $source
+     *
+     * @return string[]
+     *
+     * @throws \Exception
+     */
+    protected function getFiles(array $source)
+    {
+        $fileSet = [];
+        foreach ($source as $set) {
+            if (!array_key_exists('files', $set)) {
+                throw new \Exception("`src` must have a `files` option");
+            }
+
+            if (!array_key_exists('path', $set)) {
+                $set['path'] = getcwd();
+            }
+
+            if (!array_key_exists('recursive', $set)) {
+                $set['recursive'] = false;
+            }
+
+            $paths = is_array($set['path']) ? $set['path'] : [$set['path']];
+            $files = is_array($set['files']) ? $set['files'] : [$set['files']];
+            foreach ($paths as $path) {
+                foreach ($files as $file) {
+                    $finder = new Finder();
+                    $finder->files()->in($path)->name($file);
+                    if (!$set['recursive']) {
+                        $finder->depth('== 0');
+                    }
+
+                    $fileSet = $this->appendFileSet($finder, $fileSet);
+                }
+            }
+        }
+
+        return $fileSet;
+    }
+
+    /**
+     * @param Finder $finder
+     * @param array  $fileSet
+     *
+     * @return array
+     */
+    protected function appendFileSet(Finder $finder, array $fileSet)
+    {
+        foreach ($finder as $file) {
+            /** @var SplFileInfo $file */
+            $fileSet[] = $file->getRealPath();
+        }
+
+        return $fileSet;
+    }
+}
diff --git a/src/Extension/Execute/Call/ApplyCall.php b/src/Extension/Execute/Call/ApplyCall.php
@@ -11,61 +11,48 @@
 
 namespace Bldr\Extension\Execute\Call;
 
+use Bldr\Call\Traits\FinderAwareTrait;
 use Symfony\Component\Console\Helper\FormatterHelper;
 
 /**
  * @author Aaron Scherer <aequasi@gmail.com>
  */
 class ApplyCall extends ExecuteCall
 {
+    use FinderAwareTrait;
+
     /**
      * @var array $files
      */
     private $files;
 
+    /**
+     * {@inheritDoc}
+     */
     public function configure()
     {
         parent::configure();
         $this->setName('apply')
-            ->addOption('fileset', true, 'The fileset to run the executable on');
+            ->addOption('src', true, 'Source to run the apply on');
     }
 
     /**
      * {@inheritDoc}
      */
     public function run()
     {
-        $this->setFileset($this->getOption('fileset'));
-
         /** @var FormatterHelper $formatter */
         $formatter = $this->getHelperSet()->get('formatter');
 
         $this->getOutput()->writeln($formatter->formatSection($this->getTask()->getName(), 'Starting'));
 
         $arguments = $this->getOption('arguments');
-        foreach ($this->files as $file) {
+        $files = $this->getFiles($this->getOption('src'));
+        foreach ($files as $file) {
             $args = $arguments;
             $args[] = $file;
             $this->setOption('arguments', $args);
             parent::run();
         }
     }
-
-    /**
-     * @param string $fileset
-     */
-    public function setFileset($fileset)
-    {
-        $fileOption = $this->getOption('fileset');
-        if (is_array($fileOption)) {
-            $files = [];
-            foreach ($fileOption as $file) {
-                $files = array_merge($files, glob_recursive(getcwd() . '/' . $file));
-            }
-        } else {
-            $files = glob_recursive(getcwd() . '/' . $fileOption);
-        }
-
-        $this->files = $files;
-    }
 }
diff --git a/src/Extension/Watch/Call/WatchCall.php b/src/Extension/Watch/Call/WatchCall.php
@@ -12,14 +12,19 @@
 namespace Bldr\Extension\Watch\Call;
 
 use Bldr\Call\AbstractCall;
+use Bldr\Call\Traits\FinderAwareTrait;
 use Bldr\Model\Task;
 use Bldr\Registry\TaskRegistry;
+use Symfony\Component\Finder\Finder;
+use Symfony\Component\Finder\SplFileInfo;
 
 /**
  * @author Aaron Scherer <aaron@undergroundelephant.com>
  */
 class WatchCall extends AbstractCall
 {
+    use FinderAwareTrait;
+
     /**
      * @var TaskRegistry $tasks
      */
@@ -43,7 +48,7 @@ public function configure()
     {
         $this->setName('watch')
             ->setDescription('Watches the filesystem for changes')
-            ->addOption('files', true, 'Files to watch')
+            ->addOption('src', true, 'Source to watch')
             ->addOption('profile', false, 'Profile to run on filesystem change')
             ->addOption('task', false, 'Task to run on filesystem change');
     }
@@ -61,21 +66,16 @@ public function run()
             throw new \Exception("Watch must have either a task, or a profile");
         }
 
-        $fileOption = $this->getOption('files');
-        if (is_array($fileOption)) {
-            $files = [];
-            foreach ($fileOption as $file) {
-                $files = array_merge($files, glob_recursive(getcwd() . '/' . $file));
-            }
-        } else {
-            $files = glob_recursive(getcwd() . '/' . $fileOption);
+        $source = $this->getOption('src');
+        if (!is_array($source)) {
+            throw new \Exception("`src` must be an array");
         }
 
-        $this->watchForChanges($files);
+        $this->watchForChanges($this->getFiles($source));
     }
 
     /**
-     * @param string[] $files
+     * @param SplFileInfo[] $files
      */
     private function watchForChanges(array $files)
     {
@@ -84,11 +84,15 @@ private function watchForChanges(array $files)
 
         $previously = [];
         while (true) {
-            foreach ($files as $name) {
-                if ($this->checkFile($name, $previously)) {
+            foreach ($files as $file) {
+                /** @var SplFileInfo $file */
+                if ($this->checkFile($file->getRealPath(), $previously)) {
                     $this->getOutput()
                         ->writeln(
-                            sprintf("<info>>>>></info> <comment>The %s file changed.</comment>", $name)
+                            sprintf(
+                                "<info>>>>></info> <comment>The following file changed:</comment> <info>%s</info>",
+                                $file->getPathname()
+                            )
                         );
 
                     $this->getTasks();
@@ -147,12 +151,10 @@ public function fetchTasks($profileName)
     public function buildTasks($names)
     {
         foreach ($names as $name) {
-            $taskInfo                = $this->config['tasks'][$name];
-            $taskInfo['failOnError'] = false;
-            $description             = isset($taskInfo['description']) ? $taskInfo['description'] : "";
+            $taskInfo    = $this->config['tasks'][$name];
+            $description = isset($taskInfo['description']) ? $taskInfo['description'] : "";
 
-            $task = new Task($name, $description, $taskInfo['calls']);
-            $this->tasks->addTask($task);
+            $this->tasks->addTask(new Task($name, $description, false, $taskInfo['calls']));
         }
     }
 }
