Merge pull request #4 from SwitchDreams/feature/versioning_scope

[CU-338n06m] versioning working

Author: PedroAugustoRamalhoDuarte

.rubocop.yml

@@ -9,6 +9,9 @@ AllCops:
     - 'tmp/**/*'
     - '**/*/bundle'
 
+Naming/FileName:
+  Enabled: false
+
 Style/Documentation:
   Enabled: false
 
@@ -21,5 +24,8 @@ Metrics/MethodLength:
 Metrics/AbcSize:
   Max: 25
 
+RSpec/ExampleLength:
+  Max: 6
+
 Metrics/BlockLength:
   AllowedMethods: [ 'describe', 'context' ]

Gemfile.lock

@@ -2,10 +2,7 @@ PATH
   remote: .
   specs:
     rest-api-generator (0.1.1)
-      actionview (>= 6.0)
-      activerecord (>= 6.0)
-      activesupport (>= 6.0)
-      railties (>= 5.0.0)
+      rails (>= 5.0)
 
 GEM
   remote: https://rubygems.org/
@@ -226,7 +223,6 @@ PLATFORMS
 DEPENDENCIES
   ammeter (~> 1.1.5)
   database_cleaner
-  rails (>= 6.0)
   rake (~> 13.0)
   rest-api-generator!
   rspec (~> 3.0)

README.md

@@ -19,7 +19,8 @@ Following [Switch Dreams's](https://www.switchdreams.com.br/]) coding practices,
 ## Current Features
 
 - [Automatic rest api crud generation](#example)
-- Modular error handler
+- [Nested Resource](#nested-resource)
+- [Modular error handler](#modular-error-handler)
 - [Resource ordering](#ordering)
 - [Resource filter](#filtering)
 
@@ -100,15 +101,83 @@ $ rails g rest_api_generator:resource car name:string color:string
 Will generate following controller and the other files:
 
 ```ruby
-
+# app/controllers/cars_controller.rb
 class CarsController < RestApiGenerator::ResourceController
 end
 ```
 
 For a better experience you can override some methods from the
 [default controller](https://github.com/SwitchDreams/rest-api-generator/blob/main/lib/rest_api_generator/resource_controller.rb)
 
-### Example with eject
+### Options
+
+| Option | Goal                                                         | Default | Usage Example   |
+|--------|--------------------------------------------------------------|---------|-----------------|
+| father | Generate nested resource                                     | nil     | --father Users  |
+| scope  | Scope the resource for other route or namespace organization | nil     | --scope Api::V1 |
+| eject  | Eject the controller to high customization                   | false   | true            |
+
+#### Scope
+
+In REST api one of the best practices is versioning the end-points, and you can achieve this using scope options,
+example:
+
+```bash
+# Command
+rails g rest_api_generator:resource car name:string color:string --scope Api::V1
+```
+
+```ruby
+# GET api/v1/cars
+module Api::V1
+  class CarsController < RestApiGenerator::ResourceController
+  end
+end
+```
+
+For this option you need to manually setup routes, for this example:
+
+```ruby
+# routes.rb
+namespace :api do
+  namespace :v1 do
+    resources :cars
+  end
+end
+```
+
+#### Nested resource
+
+In REST api sometimes we need to build a nested resource, for example when we need to get all devices from a user, for
+this we have nested resource option:
+
+```bash
+# Command
+rails g rest_api_generator:resource Devices name:string color:string users:references --scope Users
+```
+
+```ruby
+# GET users/:user_id/devices
+module Users
+  class DevicesController < RestApiGenerator::ChildResourceController
+  end
+end
+```
+
+For this option you need to manually setup routes, for this example:
+
+```ruby
+# routes.rb
+resources :users do
+  resources :devices, controller: 'users/devices'
+end
+```
+
+Considerations:
+
+- The children model needs to belongs_to parent model and parent model needs to have has_many children model
+
+#### Eject
 
 Or you can use the `eject` option for create the controller with the implemented methods:
 
@@ -154,10 +223,23 @@ class CarsController < ApplicationController
     params.require(:car).permit(:name, :color)
   end
 end
+```
+
+### Resource Features
+
+#### Modular Error Handler
+
+The error module will return a json in this following format when any active record or custom error raises.
 
+```json
+{
+  "status": 422,
+  "error": "",
+  "message": ""
+}
 ```
 
-### Features
+This is good to padronize the error handler in front-end too.
 
 #### Ordering
 

lib/generators/rest_api_generator/helpers.rb

@@ -17,5 +17,35 @@ def editable_attributes
         Rails::Generators::GeneratedAttribute.new(column.name.to_s, column.type.to_s)
       end
     end
+
+    def option_to_path(option)
+      option.downcase.split("::").join("/")
+    end
+
+    def scope_route_path
+      return "" if options["scope"].blank?
+
+      option_to_path(options["scope"])
+    end
+
+    def nested_routes
+      return "" if options["father"].blank?
+
+      "#{options["father"].downcase.pluralize}/\#{#{options["father"].singularize.downcase}.id}/#{plural_name}"
+    end
+
+    def initial_route
+      scope_route_path + "/" + nested_routes
+    end
+
+    def spec_routes
+      {
+        index: initial_route,
+        show: initial_route + "\#{#{singular_name}.id}",
+        create: initial_route,
+        update: initial_route + "\#{#{singular_name}.id}",
+        delete: initial_route + "\#{#{singular_name}.id}",
+      }
+    end
   end
 end

lib/generators/rest_api_generator/resource_generator.rb

@@ -12,6 +12,7 @@ class ResourceGenerator < Rails::Generators::NamedBase
     argument :attributes, type: :array, default: [], banner: "field[:type][:index] field[:type][:index]"
     class_option :eject, type: :boolean, default: false
     class_option :scope, type: :string, default: ""
+    class_option :father, type: :string, default: ""
 
     API_CONTROLLER_DIR_PATH = "app/controllers"
     API_TEST_DIR_PATH = "spec/requests"
@@ -20,30 +21,66 @@ def create_service_file
       create_model_files
 
       # Create controller and specs
-      scope_path = options["scope"].present? ? "/#{options["scope"].pluralize}" : ""
       controller_path = "#{API_CONTROLLER_DIR_PATH}#{scope_path}/#{file_name.pluralize}_controller.rb"
       controller_test_path = "#{API_TEST_DIR_PATH}#{scope_path}/#{file_name.pluralize}_controller_spec.rb"
 
       template controller_template, controller_path
       template spec_controller_template, controller_test_path
 
-      route "resources :#{file_name.pluralize}"
+      if options["scope"].blank? && options["father"].blank?
+        route "resources :#{file_name.pluralize}"
+      else
+        log("You need to manually setup routes files for nested or scoped resource")
+      end
     end
 
     private
 
+    def scope_path
+      return "" if options["scope"].blank? && options["father"].blank?
+
+      if options["scope"].present? && options["father"].present?
+        "/" + option_to_path(options["scope"]) + "/" + option_to_path(options["father"])
+      else
+        "/" + option_to_path(options["scope"]) + option_to_path(options["father"])
+      end
+    end
+
+    def scope_namespacing(&block)
+      content = capture(&block)
+      content = wrap_with_scope(content) if options["scope"].present? || options["father"].present?
+      concat(content)
+    end
+
+    def module_namespace
+      if options["scope"].present? && options["father"].present?
+        options["scope"] + "::" + options["father"]
+      else
+        options["scope"] + options["father"]
+      end
+    end
+
+    def wrap_with_scope(content)
+      content = indent(content).chomp
+      "module #{module_namespace}\n#{content}\nend\n"
+    end
+
     def controller_template
       if options["eject"]
-        "rest_api_controller.rb"
-      elsif options["scope"].present?
-        "child_api_controller.rb"
+        if options["father"].present?
+          "child_api_controller.rb"
+        else
+          "rest_api_controller.rb"
+        end
+      elsif options["father"].present?
+        "implicit_child_resource_controller.rb"
       else
         "implicit_resource_controller.rb"
       end
     end
 
     def spec_controller_template
-      if options["scope"].present?
+      if options["father"].present?
         "child_api_spec.rb"
       else
         "rest_api_spec.rb"

lib/generators/rest_api_generator/templates/child_api_controller.rb.tt

@@ -1,9 +1,10 @@
+<% scope_namespacing do -%>
 class <%= class_name.pluralize %>Controller < ApplicationController
-  before_action :set_<%= options['scope'].downcase %>
-  before_action :set_<%= singular_name %>, only: %i[show update destroy]
+  before_action :set_<%= options['father'].downcase.singularize %>
+  before_action :set_<%= singular_name %>, only: %i[ show update destroy ]
 
   def index
-    @<%= plural_name %> = @<%= options['scope'].downcase %>.<%= plural_name %>
+    @<%= plural_name %> = @<%= options['father'].downcase.singularize %>.<%= plural_name %>
     render json: @<%= plural_name %>, status: :ok
   end
 
@@ -12,7 +13,7 @@ class <%= class_name.pluralize %>Controller < ApplicationController
   end
 
   def create
-    @<%= singular_name %> = @<%= options['scope'].downcase %>.<%= plural_name %>.create!(<%= singular_name %>_params)
+    @<%= singular_name %> = @<%= options['father'].downcase.singularize %>.<%= plural_name %>.create!(<%= singular_name %>_params)
     render json: @<%= singular_name %>, status: :created
   end
 
@@ -25,18 +26,18 @@ class <%= class_name.pluralize %>Controller < ApplicationController
     @<%= singular_name %>.destroy!
   end
 
-
   private
 
-  def set_<%= options['scope'].downcase %>
-    @<%= options['scope'].downcase %> = <%= options['scope'] %>.find(params[:<%= options['scope'].downcase %>_id])
+  def set_<%= options['father'].downcase.singularize %>
+    @<%= options['father'].downcase %> = <%= options['father'] %>.find(params[:<%= options['father'].downcase.singularize %>_id])
   end
 
   def set_<%= singular_name %>
-    @<%= singular_name %> = @<%= options['scope'].downcase %>.<%= plural_name %>.find(params[:id])
+    @<%= singular_name %> = @<%= options['father'].downcase.singularize %>.<%= plural_name %>.find(params[:id])
   end
 
   def <%= singular_name %>_params
     params.require(:<%= singular_name %>).permit(<%= attributes.map { |a| ':' + a.name }.join(', ') %>)
   end
-end
+end
+<% end -%>