Better description for option (#2346)

thoughtbot · Apr 6, 2023 · 7dd3ee1 · 7dd3ee1
1 parent 0191ee8
commit 7dd3ee1
Show file tree

Hide file tree

Showing 5 changed files with 27 additions and 7 deletions.
diff --git a/lib/administrate/view_generator.rb b/lib/administrate/view_generator.rb
@@ -5,7 +5,12 @@
 module Administrate
   class ViewGenerator < Rails::Generators::Base
     include Administrate::GeneratorHelpers
-    class_option :namespace, type: :string, default: :admin
+    class_option(
+      :namespace,
+      type: :string,
+      desc: "Namespace where the admin dashboards live",
+      default: "admin",
+    )
 
     def self.template_source_path
       File.expand_path(

diff --git a/lib/generators/administrate/dashboard/dashboard_generator.rb b/lib/generators/administrate/dashboard/dashboard_generator.rb
@@ -27,7 +27,12 @@ class DashboardGenerator < Rails::Generators::NamedBase
       COLLECTION_ATTRIBUTE_LIMIT = 4
       READ_ONLY_ATTRIBUTES = %w[id created_at updated_at]
 
-      class_option :namespace, type: :string, default: :admin
+      class_option(
+        :namespace,
+        type: :string,
+        desc: "Namespace where the admin dashboards live",
+        default: "admin",
+      )
 
       source_root File.expand_path("../templates", __FILE__)
 

diff --git a/lib/generators/administrate/install/install_generator.rb b/lib/generators/administrate/install/install_generator.rb
@@ -14,7 +14,12 @@ class InstallGenerator < Rails::Generators::Base
       include Administrate::GeneratorHelpers
       source_root File.expand_path("../templates", __FILE__)
 
-      class_option :namespace, type: :string, default: "admin"
+      class_option(
+        :namespace,
+        type: :string,
+        desc: "Namespace where the admin dashboards will live",
+        default: "admin",
+      )
 
       def run_routes_generator
         if dashboard_resources.none?

diff --git a/lib/generators/administrate/routes/routes_generator.rb b/lib/generators/administrate/routes/routes_generator.rb
@@ -13,7 +13,12 @@ module Generators
     class RoutesGenerator < Rails::Generators::Base
       include Administrate::GeneratorHelpers
       source_root File.expand_path("../templates", __FILE__)
-      class_option :namespace, type: :string, default: "admin"
+      class_option(
+        :namespace,
+        type: :string,
+        desc: "Namespace where the admin dashboards live",
+        default: "admin",
+      )
 
       def insert_dashboard_routes
         if valid_dashboard_models.any?

diff --git a/spec/generators/views_generator_spec.rb b/spec/generators/views_generator_spec.rb
@@ -14,7 +14,7 @@
         expect(Rails::Generators).
           to invoke_generator(
             "administrate:views:#{generator}",
-            [resource, "--namespace", :admin],
+            [resource, "--namespace", "admin"],
           )
       end
     end
@@ -27,7 +27,7 @@
 
       expect(Rails::Generators).to invoke_generator(
         "administrate:views:index",
-        [resource, "--namespace", :admin],
+        [resource, "--namespace", "admin"],
         behavior: :revoke,
       )
     end
@@ -44,7 +44,7 @@
         %w[index show new edit].each do |generator|
           expect(Rails::Generators). to invoke_generator(
             "administrate:views:#{generator}",
-            [application_resource_path, "--namespace", :admin],
+            [application_resource_path, "--namespace", "admin"],
           )
         end
       end