implement support for lucid microservice installations

Author: Mulkave

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.'],
         ];
     }
 

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::OPTIONAL, 'The domain to be responsible for the job.'],
         ];
     }
 

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';
 

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 <[email protected]>
  */
@@ -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';
     }
 
     /**
@@ -507,7 +555,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);
 

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
         );
     }

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');
     }
 
     /**