Merge pull request #6 from lucid-architecture/master

harris21 · web-flow · commit a7bafd63947e · 2016-09-14T00:27:44.000+02:00
implement support for lucid microservice installations
diff --git a/README.md b/README.md
@@ -1 +1,45 @@
+# Lucid • Console
 The Console companion for the Lucid Architecture.
+
+## Command Line Interface
+The console ships with a command line interface called `lucid` that you can find in `vendor/bin/lucid` and use as
+```
+lucid make:feature ListUsers Api
+```
+
+> To be able to address the `lucid` cli directly you need to have `./vendor/bin` as part of your `$PATH`.
+To do that, put this in your shell profile (~/.bash_profile, ~/.zshrc, ~/bashrc) `export PATH="$PATH:./vendor/bin`"
+
+### Available Commands
+
+- `help`             Displays help for a command
+- `list`             Lists commands
+- **make**
+  - `make:controller`  Create a new resource Controller class in a service
+  - `make:feature   `  Create a new Feature in a service
+  - `make:job       `  Create a new Job in a domain
+  - `make:service   `  Create a new Service
+- **list**
+  - `list:features`    List the features.
+  - `list:services`    List the services in this project.
+- **delete**
+  - `delete:feature`   Delete an existing Feature in a service
+  - `delete:job    `   Delete an existing Job in a domain
+  - `delete:service`   Delete an existing Service
+
+### Commands Usage
+
+#### Make
+- `make:controller <controller> [<service>]`
+- `make:feature <feature> [<service>]`
+- `make:job <job> <domain>`
+- `make:service <name>`
+
+#### List
+- `list:services`
+- `list:features [<service>]`
+
+#### Delete
+- `delete:service <name>`
+- `delete:feature <feature> [<service>]`
+- `delete:job <job> <domain>`
diff --git a/TODO.md b/TODO.md
@@ -1,4 +1,4 @@
-- [ ] Specifying Laravel version on installation
+- [x] Specifying Laravel version on installation
 - [ ] Documentation
 - [ ] Change namespace using CLI
     - > By extending `Illuminate\Foundation\Console\AppNameCommand`
diff --git a/lucid b/lucid
@@ -21,7 +21,7 @@ $commands = [
     new Lucid\Console\Commands\FeaturesListCommand(),
 ];
 
-$app = new Symfony\Component\Console\Application('Lucid Console', '0.4.1');
+$app = new Symfony\Component\Console\Application('Lucid Console', '0.5.0');
 array_walk($commands, [$app, 'add']);
 
 $app->run();
diff --git a/src/Commands/ControllerMakeCommand.php b/src/Commands/ControllerMakeCommand.php
@@ -67,7 +67,7 @@ public function fire()
             $this->info('Controller class created successfully.'.
                 "\n".
                 "\n".
-                'Find it at <comment>'.strstr($controller, 'src/').'</comment>'."\n"
+                'Find it at <comment>'.$controller.'</comment>'."\n"
             );
         } catch (Exception $e) {
             $this->error($e->getMessage());
@@ -82,8 +82,8 @@ public function fire()
     protected function getArguments()
     {
         return [
-            ['service', InputArgument::REQUIRED, 'The service in which the controller should be generated.'],
             ['controller', InputArgument::REQUIRED, 'The controller\'s name.'],
+            ['service', InputArgument::OPTIONAL, 'The service in which the controller should be generated.'],
         ];
     }
 
diff --git a/src/Commands/FeatureDeleteCommand.php b/src/Commands/FeatureDeleteCommand.php
@@ -56,7 +56,7 @@ class FeatureDeleteCommand extends SymfonyCommand
     public function fire()
     {
         try {
-            $service = studly_case($this->argument('service'));
+            $service = Str::service($this->argument('service'));
             $title = $this->parseName($this->argument('feature'));
 
             if (!$this->exists($feature = $this->findFeaturePath($service, $title))) {
@@ -79,8 +79,8 @@ public function fire()
     protected function getArguments()
     {
         return [
-            ['service', InputArgument::REQUIRED, 'The service in which the feature should be deleted from.'],
             ['feature', InputArgument::REQUIRED, 'The feature\'s name.'],
+            ['service', InputArgument::OPTIONAL, 'The service from which the feature should be deleted.'],
         ];
     }
 
diff --git a/src/Commands/FeatureMakeCommand.php b/src/Commands/FeatureMakeCommand.php
@@ -67,7 +67,7 @@ public function fire()
                 'Feature class '.$feature->title.' created successfully.'.
                 "\n".
                 "\n".
-                'Find it at <comment>'.strstr($feature->relativePath, 'src/').'</comment>'."\n"
+                'Find it at <comment>'.$feature->relativePath.'</comment>'."\n"
             );
         } catch (Exception $e) {
             $this->error($e->getMessage());
@@ -82,8 +82,8 @@ public function fire()
     protected function getArguments()
     {
         return [
-            ['service', InputArgument::REQUIRED, 'The service in which the feature should be implemented.'],
             ['feature', InputArgument::REQUIRED, 'The feature\'s name.'],
+            ['service', InputArgument::OPTIONAL, 'The service in which the feature should be implemented.'],
         ];
     }
 
diff --git a/src/Commands/JobDeleteCommand.php b/src/Commands/JobDeleteCommand.php
@@ -78,8 +78,8 @@ public function fire()
     public function getArguments()
     {
         return [
-            ['domain', InputArgument::REQUIRED, 'The domain from which the job will be deleted.'],
             ['job', InputArgument::REQUIRED, 'The job\'s name.'],
+            ['domain', InputArgument::REQUIRED, 'The domain from which the job will be deleted.'],
         ];
     }
 
diff --git a/src/Commands/JobMakeCommand.php b/src/Commands/JobMakeCommand.php
@@ -78,8 +78,8 @@ public function fire()
     public function getArguments()
     {
         return [
-            ['domain', InputArgument::REQUIRED, 'The domain to be responsible for the job.'],
             ['job', InputArgument::REQUIRED, 'The job\'s name.'],
+            ['domain', InputArgument::REQUIRED, 'The domain to be responsible for the job.'],
         ];
     }
 
diff --git a/src/Commands/ServiceDeleteCommand.php b/src/Commands/ServiceDeleteCommand.php
@@ -11,6 +11,7 @@
 
 namespace Lucid\Console\Commands;
 
+use Lucid\Console\Str;
 use Lucid\Console\Finder;
 use Lucid\Console\Command;
 use Lucid\Console\Filesystem;
@@ -71,18 +72,22 @@ protected function getStub()
      */
     public function fire()
     {
+        if ($this->isMicroservice()) {
+            return $this->error('This functionality is disabled in a Microservice');
+        }
+
         try {
-            $name = ucfirst($this->argument('name'));
+            $name = Str::service($this->argument('name'));
 
             if (!$this->exists($service = $this->findServicePath($name))) {
-                $this->error('Service '.$name.' cannot be found.');
-            } else {
-                $this->delete($service);
+                return $this->error('Service '.$name.' cannot be found.');
+            }
 
-                $this->info('Service <comment>'.$name.'</comment> deleted successfully.'."\n");
+            $this->delete($service);
 
-                $this->info('Please remove your registered service providers, if any.');
-            }
+            $this->info('Service <comment>'.$name.'</comment> deleted successfully.'."\n");
+
+            $this->info('Please remove your registered service providers, if any.');
         } catch (\Exception $e) {
             dd($e->getMessage(), $e->getFile(), $e->getLine());
         }
diff --git a/src/Components/Feature.php b/src/Components/Feature.php
@@ -16,7 +16,7 @@
  */
 class Feature extends Component
 {
-    public function __construct($title, $file, $realPath, $relativePath, Service $service, $content = '')
+    public function __construct($title, $file, $realPath, $relativePath, Service $service = null, $content = '')
     {
         $className = str_replace(' ', '', $title).'Feature';
 
diff --git a/src/Finder.php b/src/Finder.php
@@ -20,6 +20,8 @@
 use Lucid\Console\Components\Job;
 use Symfony\Component\Finder\Finder as SymfonyFinder;
 
+define('DS', DIRECTORY_SEPARATOR);
+
 /**
  * @author Abed Halawi <abed.halawi@vinelab.com>
  */
@@ -104,6 +106,31 @@ private function mapFuzzyResults($results)
         }, $results);
      }
 
+    /**
+     * Get the source directory name.
+     * In a microservice installation this will be `app`. `src` otherwise.
+     *
+     * @return string
+     */
+    public function getSourceDirectoryName()
+    {
+        if (file_exists(base_path().'/'.$this->srcDirectoryName)) {
+            return $this->srcDirectoryName;
+        }
+
+        return 'app';
+    }
+
+    /**
+     * Determines whether this is a lucid microservice installation.
+     *
+     * @return bool
+     */
+    public function isMicroservice()
+    {
+        return !($this->getSourceDirectoryName() === $this->srcDirectoryName);
+    }
+
     /**
      * Get the namespace used for the application.
      *
@@ -118,7 +145,7 @@ public function findRootNamespace()
 
         // see which one refers to the "src/" directory
         foreach ($composer['autoload']['psr-4'] as $namespace => $directory) {
-            if ($directory === $this->srcDirectoryName.'/') {
+            if ($directory === $this->getSourceDirectoryName().'/') {
                 return trim($namespace, '\\');
             }
         }
@@ -145,7 +172,9 @@ public function findFoundationNamespace()
      */
     public function findServiceNamespace($service)
     {
-        return $this->findRootNamespace().'\\Services\\'.$service;
+        $root = $this->findRootNamespace();
+
+        return (!$service) ? $root : "$root\\Services\\$service";
     }
 
     /**
@@ -155,7 +184,7 @@ public function findServiceNamespace($service)
      */
     public function findSourceRoot()
     {
-        return base_path().'/'.$this->srcDirectoryName;
+        return ($this->isMicroservice()) ? app_path() : base_path().'/'.$this->srcDirectoryName;
     }
 
     /**
@@ -170,14 +199,15 @@ public function findServicesRootPath()
 
     /**
      * Find the path to the directory of the given service name.
+     * In the case of a microservice service installation this will be app path.
      *
      * @param string $service
      *
      * @return string
      */
     public function findServicePath($service)
     {
-        return $this->findServicesRootPath()."/$service";
+        return (!$service) ? app_path() : $this->findServicesRootPath()."/$service";
     }
 
     /**
@@ -215,7 +245,9 @@ public function findFeaturePath($service, $feature)
      */
     public function findFeatureTestPath($service, $test)
     {
-        return $this->findServicePath($service)."/Tests/Features/$test.php";
+        $root = ($service) ? $this->findServicePath($service).'/Tests' : base_path().'/tests';
+
+        return "$root/Features/$test.php";
     }
 
     /**
@@ -347,7 +379,7 @@ public function listJobs($domainName = null)
      */
     public function findJobPath($domain, $job)
     {
-        return $this->findDomainPath($domain).'/Jobs/'.$job.'.php';
+        return $this->findDomainPath($domain).DS.'Jobs'.DS.$job.'.php';
     }
 
     /**
@@ -386,6 +418,22 @@ public function findDomainJobsTestsNamespace($domain)
         return $this->findDomainNamespace($domain).'\Tests\Jobs';
     }
 
+    /**
+     * Get the path to the tests of the given domain.
+     *
+     * @param string $domain
+     *
+     * @return string
+     */
+    public function findDomainTestsPath($domain)
+    {
+        if ($this->isMicroservice()) {
+            return base_path().DS.'tests'.DS.'Domains'.DS.$domain;
+        }
+
+        return $this->findDomainPath($domain).DS.'Tests';
+    }
+
     /**
      * Find the test path for the given job.
      *
@@ -396,7 +444,7 @@ public function findDomainJobsTestsNamespace($domain)
      */
     public function findJobTestPath($domain, $jobTest)
     {
-        return $this->findDomainPath($domain).DIRECTORY_SEPARATOR.'Tests'.DIRECTORY_SEPARATOR.'Jobs'.DIRECTORY_SEPARATOR.$jobTest.'.php';
+        return $this->findDomainTestsPath($domain).DS.'Jobs'.DS.$jobTest.'.php';
     }
 
     /**
@@ -431,12 +479,15 @@ public function findControllerNamespace($service)
      */
     public function listServices()
     {
-        $finder = new SymfonyFinder();
-
         $services = new Collection();
-        foreach ($finder->directories()->depth('== 0')->in($this->findServicesRootPath())->directories() as $dir) {
-            $realPath = $dir->getRealPath();
-            $services->push(new Service($dir->getRelativePathName(), $realPath, $this->relativeFromReal($realPath)));
+
+        if (file_exists($this->findServicesRootPath())) {
+            $finder = new SymfonyFinder();
+
+            foreach ($finder->directories()->depth('== 0')->in($this->findServicesRootPath())->directories() as $dir) {
+                $realPath = $dir->getRealPath();
+                $services->push(new Service($dir->getRelativePathName(), $realPath, $this->relativeFromReal($realPath)));
+            }
         }
 
         return $services;
@@ -507,7 +558,7 @@ public function findFeature($name)
         $files = $finder->name($fileName)->in($this->findServicesRootPath())->files();
         foreach ($files as $file) {
             $path = $file->getRealPath();
-            $serviceName = strstr($file->getRelativePath(), DIRECTORY_SEPARATOR, true);
+            $serviceName = strstr($file->getRelativePath(), DS, true);
             $service = $this->findService($serviceName);
             $content = file_get_contents($path);
 
@@ -610,8 +661,12 @@ public function listFeatures($serviceName = '')
      *
      * @return string
      */
-    protected function relativeFromReal($path, $needle = 'src/')
+    protected function relativeFromReal($path, $needle = '')
     {
+        if (!$needle) {
+            $needle = $this->getSourceDirectoryName().'/';
+        }
+
         return strstr($path, $needle);
     }
 }
diff --git a/src/Generators/FeatureGenerator.php b/src/Generators/FeatureGenerator.php
@@ -66,7 +66,7 @@ public function generate($feature, $service, array $jobs = [])
             basename($path),
             $path,
             $this->relativeFromReal($path),
-            $this->findService($service),
+            ($service) ? $this->findService($service) : null,
             $content
         );
     }
diff --git a/src/Generators/JobGenerator.php b/src/Generators/JobGenerator.php
@@ -93,7 +93,7 @@ private function generateTestFile($job, $domain)
     private function createDomainDirectory($domain)
     {
         $this->createDirectory($this->findDomainPath($domain).'/Jobs');
-        $this->createDirectory($this->findDomainPath($domain).'/Tests/Jobs');
+        $this->createDirectory($this->findDomainTestsPath($domain).'/Jobs');
     }
 
     /**

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-- [ ] Specifying Laravel version on installation`
	`1`	`+- [x] Specifying Laravel version on installation`
`2`	`2`	`- [ ] Documentation`
`3`	`3`	`- [ ] Change namespace using CLI`
`4`	`4`	- > By extending `Illuminate\Foundation\Console\AppNameCommand`
Original file line number	Diff line number	Diff line change
`@@ -56,7 +56,7 @@ class FeatureDeleteCommand extends SymfonyCommand`
`56`	`56`	`public function fire()`
`57`	`57`	`{`
`58`	`58`	`try {`
`59`		`- $service = studly_case($this->argument('service'));`
	`59`	`+ $service = Str::service($this->argument('service'));`
`60`	`60`	`$title = $this->parseName($this->argument('feature'));`
`61`	`61`
`62`	`62`	`if (!$this->exists($feature = $this->findFeaturePath($service, $title))) {`
`@@ -79,8 +79,8 @@ public function fire()`
`79`	`79`	`protected function getArguments()`
`80`	`80`	`{`
`81`	`81`	`return [`
`82`		`- ['service', InputArgument::REQUIRED, 'The service in which the feature should be deleted from.'],`
`83`	`82`	`['feature', InputArgument::REQUIRED, 'The feature\'s name.'],`
	`83`	`+ ['service', InputArgument::OPTIONAL, 'The service from which the feature should be deleted.'],`
`84`	`84`	`];`
`85`	`85`	`}`
`86`	`86`
Original file line number	Diff line number	Diff line change
`@@ -78,8 +78,8 @@ public function fire()`
`78`	`78`	`public function getArguments()`
`79`	`79`	`{`
`80`	`80`	`return [`
`81`		`- ['domain', InputArgument::REQUIRED, 'The domain from which the job will be deleted.'],`
`82`	`81`	`['job', InputArgument::REQUIRED, 'The job\'s name.'],`
	`82`	`+ ['domain', InputArgument::REQUIRED, 'The domain from which the job will be deleted.'],`
`83`	`83`	`];`
`84`	`84`	`}`
`85`	`85`
Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@`
`16`	`16`	`*/`
`17`	`17`	`class Feature extends Component`
`18`	`18`	`{`
`19`		`- public function __construct($title, $file, $realPath, $relativePath, Service $service, $content = '')`
	`19`	`+ public function __construct($title, $file, $realPath, $relativePath, Service $service = null, $content = '')`
`20`	`20`	`{`
`21`	`21`	`$className = str_replace(' ', '', $title).'Feature';`
`22`	`22`