Merge pull request #4590 from Laravel-Backpack/prettier-backpack-crud-command

tabacitu · web-flow · commit 003d015d6622 · 2022-08-09T07:57:40.000+03:00
Improved UI for both custom route command and add sidebar content command
diff --git a/src/app/Console/Commands/AddCustomRouteContent.php b/src/app/Console/Commands/AddCustomRouteContent.php
@@ -8,6 +8,8 @@
 
 class AddCustomRouteContent extends Command
 {
+    use \Backpack\CRUD\app\Console\Commands\Traits\PrettyCommandOutput;
+
     /**
      * The name and signature of the console command.
      *
@@ -45,32 +47,40 @@ public function handle()
         $disk = Storage::disk($disk_name);
         $code = $this->argument('code');
 
-        if ($disk->exists($path)) {
-            $old_file_path = $disk->path($path);
+        $this->progressBlock("Adding route to $path");
 
-            // insert the given code before the file's last line
-            $file_lines = file($old_file_path, FILE_IGNORE_NEW_LINES);
+        // Validate file exists
+        if (! $disk->exists($path)) {
+            Artisan::call('vendor:publish', ['--provider' => \Backpack\CRUD\BackpackServiceProvider::class, '--tag' => 'custom_routes']);
+            $this->handle();
 
-            // if the code already exists in the file, abort
-            if ($this->getLastLineNumberThatContains($code, $file_lines)) {
-                return $this->comment('Route already existed.');
-            }
+            return;
+        }
 
-            $end_line_number = $this->customRoutesFileEndLine($file_lines);
-            $file_lines[$end_line_number + 1] = $file_lines[$end_line_number];
-            $file_lines[$end_line_number] = '    '.$code;
-            $new_file_content = implode(PHP_EOL, $file_lines);
+        // insert the given code before the file's last line
+        $old_file_path = $disk->path($path);
+        $file_lines = file($old_file_path, FILE_IGNORE_NEW_LINES);
 
-            if ($disk->put($path, $new_file_content)) {
-                $this->info('Successfully added code to '.$path);
-            } else {
-                $this->error('Could not write to file: '.$path);
-            }
-        } else {
-            Artisan::call('vendor:publish', ['--provider' => 'Backpack\CRUD\BackpackServiceProvider', '--tag' => 'custom_routes']);
+        // if the code already exists in the file, abort
+        if ($this->getLastLineNumberThatContains($code, $file_lines)) {
+            $this->closeProgressBlock('Already existed', 'yellow');
 
-            $this->handle();
+            return;
         }
+
+        $end_line_number = $this->customRoutesFileEndLine($file_lines);
+        $file_lines[$end_line_number + 1] = $file_lines[$end_line_number];
+        $file_lines[$end_line_number] = '    '.$code;
+        $new_file_content = implode(PHP_EOL, $file_lines);
+
+        if (! $disk->put($path, $new_file_content)) {
+            $this->errorProgressBlock();
+            $this->note('Could not write to file.', 'red');
+
+            return;
+        }
+
+        $this->closeProgressBlock();
     }
 
     private function customRoutesFileEndLine($file_lines)
diff --git a/src/app/Console/Commands/AddSidebarContent.php b/src/app/Console/Commands/AddSidebarContent.php
@@ -7,6 +7,8 @@
 
 class AddSidebarContent extends Command
 {
+    use \Backpack\CRUD\app\Console\Commands\Traits\PrettyCommandOutput;
+
     /**
      * The name and signature of the console command.
      *
@@ -44,22 +46,34 @@ public function handle()
         $disk = Storage::disk($disk_name);
         $code = $this->argument('code');
 
-        if ($disk->exists($path)) {
-            $contents = $disk->get($path);
-            $file_lines = file($disk->path($path), FILE_IGNORE_NEW_LINES);
-
-            if ($this->getLastLineNumberThatContains($code, $file_lines)) {
-                return $this->comment('Sidebar item already existed.');
-            }
-
-            if ($disk->put($path, $contents.PHP_EOL.$code)) {
-                $this->info('Successfully added code to sidebar_content file.');
-            } else {
-                $this->error('Could not write to sidebar_content file.');
-            }
-        } else {
-            $this->error('The sidebar_content file does not exist. Make sure Backpack is properly installed.');
+        $this->progressBlock("Adding sidebar entry to $path");
+
+        // Validate file exists
+        if (! $disk->exists($path)) {
+            $this->errorProgressBlock();
+            $this->note('The sidebar_content file does not exist. Make sure Backpack is properly installed.', 'red');
+
+            return;
         }
+
+        $contents = $disk->get($path);
+        $file_lines = file($disk->path($path), FILE_IGNORE_NEW_LINES);
+
+        // Validate the entry already exists
+        if ($this->getLastLineNumberThatContains($code, $file_lines)) {
+            $this->closeProgressBlock('Already existed', 'yellow');
+
+            return;
+        }
+
+        if (! $disk->put($path, $contents.PHP_EOL.$code)) {
+            $this->errorProgressBlock();
+            $this->note('Could not write to sidebar_content file.', 'red');
+
+            return;
+        }
+
+        $this->closeProgressBlock();
     }
 
     /**
diff --git a/src/resources/views/base/inc/getting_started.blade.php b/src/resources/views/base/inc/getting_started.blade.php
@@ -15,19 +15,12 @@
             <p>
               <code class="text-primary bg-light p-1 rounded">php artisan backpack:crud user</code>
             </p>
-            <p>Go ahead, run it in your terminal. You'll notice it has:</p>
-            <ul>
-              <li>added an item to the sidebar, in <code class="text-primary bg-light p-1 rounded">resources/views/vendor/backpack/base/inc/sidebar_content.blade.php</code></li>
-              <li>added a route, inside <code class="text-primary bg-light p-1 rounded">routes/backpack/custom.php</code></li>
-              <li>created <code class="text-primary bg-light p-1 rounded">app/Http/Controllers/Admin/UserCrudController.php</code></li>
-              <li>created <code class="text-primary bg-light p-1 rounded">app/Http/Requests/UserRequest.php</code></li>
-            </ul>
-            <p>You can now click on the new sidebar item (or <a href="{{ backpack_url('user') }}">here</a>) and you'll be able to see the entries in the <code class="text-primary bg-light p-1 rounded">users</code> table. Even though generated CRUDs work out-of-the-box, they might not be <i>exactly</i> what you need. But that's where Backpack shines, in how easy it is to customize.</p>
+            <p>Go ahead, run it in your terminal. You can now click on the new sidebar item (or <a href="{{ backpack_url('user') }}">here</a>) and you'll be able to see the entries in the <code class="text-primary bg-light p-1 rounded">users</code> table. Even though generated CRUDs work out-of-the-box, they might not be <i>exactly</i> what you need. But that's where Backpack shines, in how easy it is to customize.</p>
 
-            <p>To dig a little deeper, <a href="#" data-toggle="collapse" data-target="#customizeUsersCRUD" aria-expanded="true" aria-controls="customizeUsersCRUD">let's make a few changes to the Users CRUD</a>.</p>
+            <p>To dig a little deeper, <a href="#" data-toggle="collapse" data-target="#customizeUsersCRUD" aria-expanded="true" aria-controls="customizeUsersCRUD">let's make a few changes to the Users CRUD <i class="la la-angle-double-right"></i></a></p>
 
             <div class="collapse" id="customizeUsersCRUD">
-              <p><strong>1. Let's remove the "password" column</strong> - no point in showing it. To do that, go to <code class="text-primary bg-light p-1 rounded">UserCrudController::setupListOperation()</code> and remove the line saying <code class="text-primary bg-light p-1 rounded">CRUD::column('password');</code>. Easy-peasy, right?</p>
+              <p><strong>1. When Listing, let's remove the "password" column</strong> - no point in showing the hash. To do that, go to <code class="text-primary bg-light p-1 rounded">UserCrudController::setupListOperation()</code> and remove the line saying <code class="text-primary bg-light p-1 rounded">CRUD::column('password');</code> - easy-peasy, right?</p>
               <p><strong>2. On Create & Update, let's add validation to forms</strong>. There are <a href="https://backpackforlaravel.com/docs/5.x/crud-operation-create#validation" target="_blank">multiple ways to add validation (A, B, C)</a>. Let's change the standard <a href="https://backpackforlaravel.com/docs/5.x/crud-operation-create#validating-fields-using-formrequests" target="_blank">validation using FormRequests</a> (A), to a simpler validation using <a href="https://backpackforlaravel.com/docs/5.x/crud-operation-create#validating-fields-using-field-attributes" target="_blank">field attributes</a> (C):</p>
               <ul>
                 <li>to remove the current validation:<br>
@@ -39,17 +32,17 @@
                 </li>
                 <li>a quick way to add validation is to go to <code class="text-primary bg-light p-1 rounded">setupCreateOperation()</code> and specify validation rules directly on the fields:
                 <p>
-                  <pre class="text-primary bg-light p-1 rounded">
+                  <pre class="language-php rounded"><code class="language-php p-1">
     CRUD::field('name')->validationRules('required|min:5');
     CRUD::field('email')->validationRules('required|email|unique:users,email');
     CRUD::field('password')->validationRules('required');
-                  </pre>
+                  </code></pre>
                 </p>
                 </li>
               </ul>
               <p><strong>3. On Create, let's hash the password.</strong> Currently, if we create a new User, it'll work. But if you look in the database... you'll notice the password is stored in plain text. We don't want that - we want it hashed. There are <a href="https://backpackforlaravel.com/docs/5.x/crud-operation-create#use-events-in-your-setup-method" target="_blank">multiple ways to achieve this too</a>. Let's use Model Events inside <code class="text-primary bg-light p-1 rounded">setupCreateOperation()</code>. Here's how our method could look, when we also tap into the <code class="text-primary bg-light p-1 rounded">creating</code> event, to hash the password:</p>
               <p>
-                <pre class="text-primary bg-light p-1 rounded">
+                <pre class="language-php rounded"><code class="language-php p-1">
       protected function setupCreateOperation()
       {
           CRUD::field('name')->validationRules('required|min:5');
@@ -60,11 +53,11 @@ protected function setupCreateOperation()
               $entry->password = \Hash::make($entry->password);
           });
       }
-                </pre>
+                </code></pre>
               </p>
-              <p><strong>4. On Update, let's not require the password</strong>. It should only be needed if an admin wants to change it, right? That means the validation rules will be different for "password". But then again... the rules will also be different for "email", right? On Update, we need to pass the ID to the unique rule in Laravel. Since 2/3 rules are different, let's just delete what was inside <code class="text-primary bg-light p-1 rounded">setupUpdateOperation()</code> and code it from scratch:</p>
+              <p><strong>4. On Update, let's not require the password</strong>. It should only be needed if an admin wants to change it, right? That means the validation rules will be different for "password". But then again... the rules will also be different for "email" (because on Update, we need to pass the ID to the unique rule in Laravel). Since 2/3 rules are different, let's just delete what was inside <code class="text-primary bg-light p-1 rounded">setupUpdateOperation()</code> and code it from scratch:</p>
               <p>
-                <pre class="text-primary bg-light p-1 rounded">
+                <pre class="language-php rounded"><code class="language-php p-1">
       protected function setupUpdateOperation()
       {
           CRUD::field('name')->validationRules('required|min:5');
@@ -79,7 +72,7 @@ protected function setupUpdateOperation()
               }
           });
       }
-                </pre>
+                </code></pre>
               </p>
               <p>
                 That's it. You have a working Users CRUD. Plus, you've already learned some advanced techniques, like <a href="https://backpackforlaravel.com/docs/5.x/crud-operation-create#use-events-in-your-setup-method" target="_blank">using Model events inside CrudController</a> and <a href="https://backpackforlaravel.com/docs/5.x/crud-operation-create#b-validating-fields-using-a-rules-array" target="_blank">using field-attribute-validation instead of form-request-validation</a>. Of course, this only scratches the surface of what Backpack can do. To really understand how it works, and how you can best use Backpack's features, <strong>we heavily recommend you move on to the next step, and learn the basics.</strong>
@@ -116,3 +109,12 @@ protected function setupUpdateOperation()
     <p class="mt-3 mb-0"><small>* this card is only visible on <i>localhost</i>. Follow the last step to hide it from <i>localhost</i> too.</small></p>
   </div>
 </div>
+
+@push('after_styles')
+  <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.6.0/styles/base16/dracula.min.css">
+@endpush
+
+@push('after_scripts')
+  <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.6.0/highlight.min.js"></script>
+  <script>hljs.highlightAll();</script>
+@endpush
