describe:feature - lists the feature's jobs in sequential order

lucid describe:feature [feature]

Author: Mulkave

TODO.md

@@ -11,6 +11,7 @@
 - [ ] Listing
     - [x] Services
     - [x] Features (per service, and across all services)
-    - [ ] Jobs per feature
+    - [x] Jobs per feature
     - [ ] Domains
+    - [ ] Jobs per domain
 - [ ] Pretty Interface

src/Commands/FeatureDescribeCommand.php

@@ -0,0 +1,75 @@
+<?php
+
+/*
+ * This file is part of the lucid-console project.
+ *
+ * (c) Vinelab <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+ namespace Lucid\Console\Commands;
+
+ use Lucid\Console\Finder;
+ use Lucid\Console\Parser;
+ use Illuminate\Console\Command;
+ use Symfony\Component\Console\Input\InputArgument;
+
+ /**
+ * @author Abed Halawi <[email protected]>
+ */
+ class FeatureDescribeCommand extends Command
+ {
+
+     use Finder;
+
+     /**
+      * The console command name.
+      *
+      * @var string
+      */
+     protected $name = 'describe:feature';
+
+     /**
+      * The console command description.
+      *
+      * @var string
+      */
+     protected $description = 'List the jobs of the specified feature in sequential order.';
+
+     /**
+      * Execute the console command.
+      *
+      * @return bool|null
+      */
+     public function fire()
+     {
+         $feature = $this->findFeature('Create Article');
+         $parser = new Parser();
+         $jobs = $parser->parseFeatureJobs($feature);
+
+         $features = [];
+         foreach ($jobs as $index => $job) {
+             $features[$feature->title][] = [$index+1, $job->title, $job->domain->name, $job->relativePath];
+         }
+
+         foreach ($features as $feature => $jobs) {
+             $this->comment("\n$feature\n");
+             $this->table(['', 'Job', 'Domain', 'Path'], $jobs);
+         }
+     }
+
+
+     /**
+      * Get the console command arguments.
+      *
+      * @return array
+      */
+     protected function getArguments()
+     {
+         return [
+             ['feature', InputArgument::REQUIRED, 'The feature name to list the jobs of.'],
+         ];
+     }
+ }

src/Components/Domain.php

@@ -0,0 +1,28 @@
+<?php
+
+/*
+ * This file is part of the lucid-console project.
+ *
+ * (c) Vinelab <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Lucid\Console\Components;
+
+/**
+ * @author Abed Halawi <[email protected]>
+ */
+class Domain extends Component
+{
+    public function __construct($name, $namespace, $path, $relativePath)
+    {
+        $this->setAttributes([
+            'name' => $name,
+            'namespace' => $namespace,
+            'realPath' => $path,
+            'relativePath' => $relativePath,
+        ]);
+    }
+}

src/Components/Job.php

@@ -0,0 +1,39 @@
+<?php
+
+/*
+ * This file is part of the lucid-console project.
+ *
+ * (c) Vinelab <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Lucid\Console\Components;
+
+/**
+ * @author Abed Halawi <[email protected]>
+ */
+class Job extends Component
+{
+    public function __construct($title, $namespace, $file, $path, $relativePath, Domain $domain)
+    {
+        $this->setAttributes([
+            'title' => $title,
+            'namespace' => $namespace,
+            'file' => $file,
+            'realPath' => $path,
+            'relativePath' => $relativePath,
+            'domain' => $domain,
+        ]);
+    }
+
+    public function toArray()
+    {
+        $attributes = parent::toArray();
+
+        $attributes['domain'] = $attributes['domain']->toArray();
+
+        return $attributes;
+    }
+}

src/Finder.php

@@ -233,6 +233,57 @@ public function listServices()
         return $services;
     }
 
+    /**
+     * Find the service for the given service name.
+     *
+     * @param  string $service
+     *
+     * @return \Lucid\Console\Components\Service
+     */
+    public function findService($service)
+    {
+        $finder = new SymfonyFinder();
+        $dirs = $finder->name($service)->in($this->findServicesRootPath())->directories();
+        if ($dirs->count() < 1) {
+            throw new Exception('Service "'.$service.'" could not be found.');
+        }
+
+        foreach ($dirs as $dir) {
+            $path = $dir->getRealPath();
+
+            return  new Service(Str::service($service), $path, $this->relativeFromReal($path));
+        }
+    }
+
+    /**
+     * Find the feature for the given feature name.
+     *
+     * @param  string $name
+     *
+     * @return \Lucid\Console\Components\Feature
+     */
+    public function findFeature($name)
+    {
+        $name = Str::feature($name);
+        $fileName = "$name.php";
+
+        $finder = new SymfonyFinder();
+        $files = $finder->name($fileName)->in($this->findServicesRootPath())->files();
+        foreach ($files as $file) {
+            $path = $file->getRealPath();
+            $serviceName = strstr($file->getRelativePath(), '/', true);
+            $service = $this->findService($serviceName);
+
+            return new Feature(
+                Str::realName($name, '/Feature/'),
+                $fileName,
+                $path,
+                $this->relativeFromReal($path),
+                $service
+            );
+        }
+    }
+
     /**
      * Get the list of features,
      * optionally withing a specified service.
@@ -256,7 +307,6 @@ public function listFeatures($serviceName = '')
             }
         }
 
-
         $features = [];
         foreach ($services as $service) {
             $serviceFeatures = new Collection();

src/Kernel.php

@@ -31,5 +31,6 @@ class Kernel extends ConsoleKernel
         Commands\ServicesListCommand::class,
         Commands\FeaturesListCommand::class,
         Commands\ControllerMakeCommand::class,
+        Commands\FeatureDescribeCommand::class,
     ];
 }