Adds protection capability to the resource. Store the table name in the resource file

Author: MikeAlhayek

CHANGELOG.md

@@ -1,3 +1,10 @@
+## v2.2.7
+ - Added capability to lock down resource from with in the resource file. This is helpful if you make code changes to a file and you want the code generator to protect the file from accidentally overriding it when using --force
+ - When creating resources from existing database, the table name is stored in the resource-file. This step will save you from having to provide the table name via command line each time you create model.
+
+
+
+## v2.2.0 - v2.2.6
 ### Upgrade
  - If you are upgrading from v2.0, v2.1, v2.2, v2.3 to v2.4 or v2.5 make sure you publish the vendor resource. There are some updates to the config file.
  - If you are upgrading from v2.0, v2.1 or v2.2 to v2.3 make sure you publish the vendor resource. There are some updates to the config file.

src/Commands/Bases/ViewsCommandBase.php

@@ -4,6 +4,7 @@
 
 use CrestApps\CodeGenerator\HtmlGenerators\LaravelCollectiveHtml;
 use CrestApps\CodeGenerator\HtmlGenerators\StandardHtml;
+use CrestApps\CodeGenerator\Models\Resource;
 use CrestApps\CodeGenerator\Models\ViewInput;
 use CrestApps\CodeGenerator\Support\Config;
 use CrestApps\CodeGenerator\Support\Helpers;
@@ -40,6 +41,26 @@ protected function getStub()
         return $this->getStubContent($this->getStubName(), $this->getTemplateName());
     }
 
+    /**
+     * Get the view type
+     *
+     * @return string
+     */
+    protected function getViewType()
+    {
+        return Helpers::removePostFixWith($this->getStubName(), '.blade');
+    }
+
+    /**
+     * Get the view name
+     *
+     * @return string
+     */
+    protected function getViewName()
+    {
+        return sprintf('%s-view', $this->getViewType());
+    }
+
     /**
      * It gets the views destenation path
      *
@@ -82,15 +103,18 @@ protected function getCommandInput()
      * It generate the view including the full path
      *
      * @param string $viewsDirectory
-     * @param string $action
+     * @param string $routesPrefix
+     * @param string $viewName
      *
      * @return string
      */
-    protected function getDestinationViewFullname($viewsDirectory, $routesPrefix, $action)
+    protected function getDestinationViewFullname($viewsDirectory, $routesPrefix, $viewName = null)
     {
         $viewsPath = $this->getFullViewsPath($viewsDirectory, $routesPrefix);
 
-        return $this->getDestinationPath($viewsPath) . $this->getDestinationViewName($action);
+        $filename = $this->getDestinationViewName($viewName ?: $this->getViewType());
+
+        return $this->getDestinationPath($viewsPath) . $filename;
     }
 
     /**
@@ -133,24 +157,35 @@ protected function replaceCommonTemplates(&$stub, ViewInput $input, array $field
      *
      * @param string $file
      * @param bool $force
-     * @param array $fields
+     * @param CrestApps\CodeGenerator\Models\Resource
      *
      * @return bool
      */
-    protected function canCreateView($file, $force, array $fields = null)
+    protected function canCreateView($file, $force, Resource $resource)
     {
+        $viewName = $this->getViewName();
+
+        if ($resource->isProtected($viewName)) {
+            $this->warn('The ' . $viewName . ' is protected and cannot be regenerated. To regenerate the file, unprotect it from the resource file.');
+
+            return false;
+        }
+
         if ($this->alreadyExists($file) && !$force) {
             $this->error($this->getViewNameFromFile($file) . ' view already exists.');
+
             return false;
         }
 
-        if (!is_null($fields) && !isset($fields[0])) {
+        if (!$resource->hasFields()) {
             $this->error('You must provide at least one field to generate the views!');
+
             return false;
         }
 
-        if (!is_null($fields) && is_null($this->getPrimaryKeyName($fields))) {
+        if (!$resource->hasPrimaryField()) {
             $this->error('None of the fields is set primary! You must assign on of the fields to be a primary field.');
+
             return false;
         }
 
@@ -276,13 +311,16 @@ protected function getViewCommand($view)
      * It checks of a destination view exists or not
      *
      * @param string $viewsDirectory
+     * @param string $routesPrefix
      * @param string $viewName
      *
      * @return bool
      */
     protected function isViewExists($viewsDirectory, $routesPrefix, $viewName)
     {
-        return $this->alreadyExists($this->getDestinationViewFullname($viewsDirectory, $routesPrefix, $viewName));
+        $destenatioFile = $this->getDestinationViewFullname($viewsDirectory, $routesPrefix, $viewName);
+
+        return $this->alreadyExists($destenatioFile);
     }
 
     /**

src/Commands/CreateControllerCommand.php

@@ -84,11 +84,12 @@ public function getNameInput()
     public function handle()
     {
         $input = $this->getCommandInput();
-        $destenationFile = $this->getDestenationFile($input->controllerName, $input->controllerDirectory);
 
-        if ($this->alreadyExists($destenationFile)) {
-            $this->error('The controller already exists!');
+        $resources = Resource::fromFile($input->resourceFile, $input->langFile);
 
+        $destenationFile = $this->getDestenationFile($input->controllerName, $input->controllerDirectory);
+
+        if ($this->hasErrors($resources, $destenationFile)) {
             return false;
         }
 
@@ -104,7 +105,6 @@ public function handle()
             }
         }
 
-        $resources = Resource::fromFile($input->resourceFile, $input->langFile);
         $fields = $resources->fields;
         $viewVariablesForIndex = $this->getCompactVariablesFor($fields, $this->getPluralVariable($input->modelName), 'index');
         $viewVariablesForShow = $this->getCompactVariablesFor($fields, $this->getSingularVariable($input->modelName), 'show');
@@ -153,6 +153,33 @@ public function handle()
             ->info('A controller was crafted successfully.');
     }
 
+    /**
+     * Build the model class with the given name.
+     *
+     * @param  CrestApps\CodeGenerator\Models\Resource $resource
+     * @param string $destenationFile
+     *
+     * @return bool
+     */
+    protected function hasErrors(Resource $resource, $destenationFile)
+    {
+        $hasErrors = false;
+
+        if ($resource->isProtected('controller')) {
+            $this->warn('The controller is protected and cannot be regenerated. To regenerate the file, unprotect it from the resource file.');
+
+            $hasErrors = true;
+        }
+
+        if ($this->alreadyExists($destenationFile)) {
+            $this->error('The controller already exists!');
+
+            $hasErrors = true;
+        }
+
+        return $hasErrors;
+    }
+
     /**
      * Extracts a namespace from a giving string
      *

src/Commands/CreateCreateViewCommand.php

@@ -48,9 +48,9 @@ protected function handleCreateView()
     {
         $input = $this->getCommandInput();
         $resources = Resource::fromFile($input->resourceFile, $input->languageFileName);
-        $destenationFile = $this->getDestinationViewFullname($input->viewsDirectory, $input->prefix, 'create');
+        $destenationFile = $this->getDestinationViewFullname($input->viewsDirectory, $input->prefix);
 
-        if ($this->canCreateView($destenationFile, $input->force, $resources->fields)) {
+        if ($this->canCreateView($destenationFile, $input->force, $resources)) {
             $stub = $this->getStub();
             $headers = $this->getHeaderFieldAccessor($resources->fields, $input->modelName);
 

src/Commands/CreateEditViewCommand.php

@@ -48,9 +48,9 @@ protected function handleCreateView()
     {
         $input = $this->getCommandInput();
         $resources = Resource::fromFile($input->resourceFile, $input->languageFileName);
-        $destenationFile = $this->getDestinationViewFullname($input->viewsDirectory, $input->prefix, 'edit');
+        $destenationFile = $this->getDestinationViewFullname($input->viewsDirectory, $input->prefix);
 
-        if ($this->canCreateView($destenationFile, $input->force, $resources->fields)) {
+        if ($this->canCreateView($destenationFile, $input->force, $resources)) {
             $stub = $this->getStub();
 
             $this->createLanguageFile($input->languageFileName, $input->resourceFile, $input->modelName)

src/Commands/CreateFormRequestCommand.php

@@ -40,17 +40,18 @@ public function handle()
     {
         $input = $this->getCommandInput();
 
-        $stub = $this->getStubContent('form-request', $input->template);
         $resources = Resource::fromFile($input->resourceFile, 'crestapps');
-        $destenationFile = $this->getDestenationFile($input->fileName, $input->formRequestDirectory);
-
-        $validations = $this->getValidationRules($resources->fields, $input->modelName, $input->formRequestDirectory);
 
-        if ($this->alreadyExists($destenationFile)) {
-            $this->error('The form-request already exists! To override the existing file, use --force option.');
+        $destenationFile = $this->getDestenationFile($input->fileName, $input->formRequestDirectory);
 
+        if ($this->hasErrors($resources, $destenationFile)) {
             return false;
         }
+
+        $stub = $this->getStubContent('form-request', $input->template);
+
+        $validations = $this->getValidationRules($resources->fields, $input->modelName, $input->formRequestDirectory);
+
         $this->replaceFormRequestClass($stub, $input->fileName)
             ->replaceValidationRules($stub, $validations)
             ->replaceFileValidationSnippet($stub, $this->getFileValidationSnippet($resources->fields, $input))
@@ -65,6 +66,33 @@ public function handle()
             ->info('A new form-request have been crafted!');
     }
 
+    /**
+     * Build the model class with the given name.
+     *
+     * @param  CrestApps\CodeGenerator\Models\Resource $resource
+     * @param string $destenationFile
+     *
+     * @return bool
+     */
+    protected function hasErrors(Resource $resource, $destenationFile)
+    {
+        $hasErrors = false;
+
+        if ($resource->isProtected('form-request')) {
+            $this->warn('The form-request is protected and cannot be regenerated. To regenerate the file, unprotect it from the resource file.');
+
+            $hasErrors = true;
+        }
+
+        if ($this->alreadyExists($destenationFile)) {
+            $this->error('The form-request already exists! To override the existing file, use --force option.');
+
+            $hasErrors = true;
+        }
+
+        return $hasErrors;
+
+    }
     /**
      * Gets the signature of the getData method.
      *

src/Commands/CreateFormViewCommand.php

@@ -48,9 +48,9 @@ protected function handleCreateView()
     {
         $input = $this->getCommandInput();
         $resources = Resource::fromFile($input->resourceFile, $input->languageFileName);
-        $destenationFile = $this->getDestinationViewFullname($input->viewsDirectory, $input->prefix, 'form');
+        $destenationFile = $this->getDestinationViewFullname($input->viewsDirectory, $input->prefix);
 
-        if ($this->canCreateView($destenationFile, $input->force, $resources->fields)) {
+        if ($this->canCreateView($destenationFile, $input->force, $resources)) {
             $stub = $this->getStub();
             $htmlCreator = $this->getHtmlGenerator($resources->fields, $input->modelName, $this->getTemplateName());
             $headers = $this->getHeaderFieldAccessor($resources->fields, $input->modelName);

src/Commands/CreateIndexViewCommand.php

@@ -48,9 +48,9 @@ protected function handleCreateView()
     {
         $input = $this->getCommandInput();
         $resources = Resource::fromFile($input->resourceFile, $input->languageFileName);
-        $destenationFile = $this->getDestinationViewFullname($input->viewsDirectory, $input->prefix, 'index');
+        $destenationFile = $this->getDestinationViewFullname($input->viewsDirectory, $input->prefix);
 
-        if ($this->canCreateView($destenationFile, $input->force, $resources->fields)) {
+        if ($this->canCreateView($destenationFile, $input->force, $resources)) {
             $stub = $this->getStub();
             $htmlCreator = $this->getHtmlGenerator($resources->fields, $input->modelName, $this->getTemplateName());
 

src/Commands/CreateLanguageCommand.php

@@ -9,8 +9,8 @@
 use CrestApps\CodeGenerator\Support\Helpers;
 use CrestApps\CodeGenerator\Support\ViewLabelsGenerator;
 use CrestApps\CodeGenerator\Traits\CommonCommand;
-use Illuminate\Console\Command;
 use Exception;
+use Illuminate\Console\Command;
 
 class CreateLanguageCommand extends Command
 {
@@ -43,10 +43,14 @@ class CreateLanguageCommand extends Command
     public function handle()
     {
         $input = $this->getCommandInput();
-        $resources = Resource::fromFile($input->resourceFile, $input->fileName);
+        $resource = Resource::fromFile($input->resourceFile, $input->fileName);
+
+        if ($resource->isProtected('languages')) {
+            return $this->warn('The language file(s) is protected and cannot be regenerated. To regenerate the file, unprotect it from the resource file.');
+        }
 
-        $languages = Helpers::getLanguageItems($resources->fields);
-        $viewLabels = new ViewLabelsGenerator($input->modelName, $resources->fields, $this->isCollectiveTemplate());
+        $languages = Helpers::getLanguageItems($resource->fields);
+        $viewLabels = new ViewLabelsGenerator($input->modelName, $resource->fields, $this->isCollectiveTemplate());
 
         $standardLabels = $viewLabels->getTranslatedLabels(array_keys($languages));