rest_framework 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 37a40fca2be23a6fe5fb1f982349ce5dd212644ffe450d979d04c339360b22eb
-  data.tar.gz: 3e036f7150018a46756efc378dacf16321a9394cb9d04d9b4af7220158400cda
+  metadata.gz: '09c24135bd79001e0113aa92f21e63c5dcb67e93891db2a5df36b4d83d1c5da2'
+  data.tar.gz: ba3bd5829fdb9fd3c61a6050f5800c91a0077c76e78aedb049f850e581027f67
 SHA512:
-  metadata.gz: 9c4a665ccde25d1c53423c168d1e5849d4ba4b91a2a0bcf6fb1f3b3714b624112d951c06aa84029aeaeb7c3703b30e8c73824688070370b3f0e9e3c3d2fd70ec
-  data.tar.gz: 6a4511553767ed27726a9d12daf0cd46958fe2098566f0daff5c1f9056bfbfa8c26836646b76e3f4a22a1efbea341dc6cb682a04c7c1b5b7635b46cc56548c3a
+  metadata.gz: c89c8af64c2eeb36dba79747770df5497d8505f2a4ced03ed6e25e81804a3a8a8f656e87bb0739a31d26be8e1f0fdcdd9e3df25721766e2e5d4bb2a01d40746f
+  data.tar.gz: 4bd5bdf9f2735622a07795245f605137c0310d16b3596fc544e9ade2046744a499ea0fdf1e7f11c7f5fc49f137650cceefadcf805884e6a6df5361ed919211d4

data/lib/rest_framework/VERSION_STAMP

@@ -1 +1 @@
-0.2.2
+0.2.3

data/lib/rest_framework/controller_mixins/base.rb

@@ -124,7 +124,9 @@ module RESTFramework::BaseControllerMixin
     begin
       formatter = ActionDispatch::Routing::ConsoleFormatter::Sheet
     rescue NameError
+      # :nocov:
       formatter = ActionDispatch::Routing::ConsoleFormatter
+      # :nocov:
     end
     return ActionDispatch::Routing::RoutesInspector.new(Rails.application.routes.routes).format(
       formatter.new

data/lib/rest_framework/generators/controller_generator.rb

@@ -1,26 +1,67 @@
 require 'rails/generators'
 
 
+# Some projects don't have the inflection "REST" as an acronym, so this is a helper class to prevent
+# this generator from being namespaced under `r_e_s_t_framework`.
+# :nocov:
+class RESTFrameworkCustomGeneratorControllerNamespace < String
+  def camelize
+    return "RESTFramework"
+  end
+end
+# :nocov:
+
+
 class RESTFramework::Generators::ControllerGenerator < Rails::Generators::Base
+  PATH_REGEX = /^\/*([a-z0-9_\/]*[a-z0-9_])(?:[\.a-z\/]*)$/
+
   desc <<~END
-    Description:
-      Stubs out a active_scaffolded controller. Pass the model name,
-      either CamelCased or under_scored.
-      The controller name is retrieved as a pluralized version of the model
-      name.
-      To create a controller within a module, specify the model name as a
-      path like 'parent_module/controller_name'.
-      This generates a controller class in app/controllers and invokes helper,
-      template engine and test framework generators.
-    Example:
-      `rails generate rest_framework:controller CreditCard`
-      Credit card controller with URLs like /credit_card/debit.
-          Controller:      app/controllers/credit_cards_controller.rb
-          Functional Test: test/functional/credit_cards_controller_test.rb
-          Helper:          app/helpers/credit_cards_helper.rb
+  Description:
+      Generates a new REST Framework controller.
+
+      Specify the controller as a path, including the module, if needed, like:
+      'parent_module/controller_name'.
+
+  Example:
+      `rails generate rest_framework:controller user_api/groups`
+
+      Generates a controller at `app/controllers/user_api/groups_controller.rb` named
+      `UserApi::GroupsController`.
   END
 
-  def create_controller_file
-    create_file "app/controllers/some_controller.rb", "# Add initialization content here"
+  argument :path, type: :string
+  class_option(
+    :parent_class,
+    type: :string,
+    default: 'ApplicationController',
+    desc: "Inheritance parent",
+  )
+  class_option(
+    :include_base,
+    type: :boolean,
+    default: false,
+    desc: "Include `BaseControllerMixin`, not `ModelControllerMixin`",
+  )
+
+  # Some projects may not have the inflection "REST" as an acronym, which changes this generator to
+  # be namespaced in `r_e_s_t_framework`, which is weird.
+  def self.namespace
+    return RESTFrameworkCustomGeneratorControllerNamespace.new("rest_framework:controller")
+  end
+
+  def create_rest_controller_file
+    unless (path_match = PATH_REGEX.match(self.path))
+      raise StandardError.new("Path isn't correct.")
+    end
+
+    cleaned_path = path_match[1]
+    content = <<~END
+      class #{cleaned_path.camelize}Controller < #{options[:parent_class]}
+        include RESTFramework::#{
+          options[:include_base] ? "BaseControllerMixin" : "ModelControllerMixin"
+        }
+      end
+    END
+    create_file("app/controllers/#{path}_controller.rb", content)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rest_framework
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Gregory N. Schmit
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-28 00:00:00.000000000 Z
+date: 2021-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails