Merge pull request #59 from richmolj/master

Enhance generators

Author: richmolj

lib/generators/jsonapi/resource_generator.rb

@@ -2,60 +2,49 @@ module Jsonapi
   class ResourceGenerator < ::Rails::Generators::NamedBase
     source_root File.expand_path('../templates', __FILE__)
 
+    argument :attributes, type: :array, default: [], banner: "field[:type][:index] field[:type][:index]"
+
     class_option :'omit-comments',
       type: :boolean,
       default: false,
       aliases: ['--omit-comments', '-c'],
       desc: 'Generate without documentation comments'
-    class_option :'omit-controller',
-      type: :boolean,
-      default: false,
-      aliases: ['--omit-controller'],
-      desc: 'Generate without controller'
-    class_option :'omit-serializer',
-      type: :boolean,
-      default: false,
-      aliases: ['--omit-serializer', '-s'],
-      desc: 'Generate without serializer'
-    class_option :'omit-payload',
-      type: :boolean,
-      default: false,
-      aliases: ['--omit-payload', '-p'],
-      desc: 'Generate without spec payload'
-    class_option :'omit-strong-resource',
-      type: :boolean,
-      default: false,
-      aliases: ['--omit-strong-resource', '-r'],
-      desc: 'Generate without strong resource'
-    class_option :'omit-route',
-      type: :boolean,
-      default: false,
-      aliases: ['--omit-route'],
-      desc: 'Generate without specs'
-    class_option :'omit-tests',
-      type: :boolean,
-      default: false,
-      aliases: ['--omit-tests', '-t'],
-      desc: 'Generate without specs'
+    class_option :'actions',
+      type: :array,
+      default: nil,
+      aliases: ['--actions', '-a'],
+      desc: 'Array of controller actions to support, e.g. "index show destroy"'
 
     desc "This generator creates a resource file at app/resources, as well as corresponding controller/specs/route/etc"
     def copy_resource_file
       unless model_klass
         raise "You must define a #{class_name} model before generating the corresponding resource."
       end
 
-      generate_controller unless omit_controller?
-      generate_serializer unless omit_serializer?
+      generate_controller
+      generate_serializer
       generate_application_resource unless application_resource_defined?
-      generate_spec_payload unless omit_spec_payload?
-      generate_strong_resource unless omit_strong_resource?
-      generate_route unless omit_route?
-      generate_tests unless omit_tests?
+      generate_spec_payload
+
+      if actions?('create', 'update')
+        generate_strong_resource
+      end
+
+      generate_route
+      generate_tests
       generate_resource
     end
 
     private
 
+    def actions
+      @options['actions'] || %w(index show create update destroy)
+    end
+
+    def actions?(*methods)
+      methods.any? { |m| actions.include?(m) }
+    end
+
     def omit_comments?
       @options['omit-comments']
     end
@@ -65,19 +54,11 @@ def generate_controller
       template('controller.rb.erb', to)
     end
 
-    def omit_controller?
-      @options['omit-controller']
-    end
-
     def generate_serializer
       to = File.join('app/serializers', class_path, "serializable_#{file_name}.rb")
       template('serializer.rb.erb', to)
     end
 
-    def omit_serializer?
-      @options['omit-serializer']
-    end
-
     def generate_application_resource
       to = File.join('app/resources', class_path, "application_resource.rb")
       template('application_resource.rb.erb', to)
@@ -92,76 +73,103 @@ def generate_spec_payload
       template('payload.rb.erb', to)
     end
 
-    def omit_spec_payload?
-      @options['no-payload']
-    end
-
     def generate_strong_resource
-      code = <<-STR
-  strong_resource :#{file_name} do
-    # Your attributes go here, e.g.
-    # attribute :name, :string
-  end
+      code = "  strong_resource :#{file_name} do\n"
+      attributes.each do |a|
+        code << "    attribute :#{a.name}, :#{a.type}\n"
+      end
+      code << "  end\n"
 
-      STR
       inject_into_file 'config/initializers/strong_resources.rb', after: "StrongResources.configure do\n" do
         code
       end
     end
 
-    def omit_strong_resource?
-      @options['no-strong-resources']
-    end
-
     def generate_route
-      code = <<-STR
-      resources :#{type}
-      STR
+      code = "      resources :#{type}"
+      code << ", only: [#{actions.map { |a| ":#{a}" }.join(', ')}]" if actions.length < 5
+      code << "\n"
       inject_into_file 'config/routes.rb', after: "scope path: '/v1' do\n" do
         code
       end
     end
 
-    def omit_route?
-      @options['no-route']
-    end
-
     def generate_tests
-      to = File.join "spec/api/v1/#{file_name.pluralize}",
-        class_path,
-        "index_spec.rb"
-      template('index_request_spec.rb.erb', to)
-
-      to = File.join "spec/api/v1/#{file_name.pluralize}",
-        class_path,
-        "show_spec.rb"
-      template('show_request_spec.rb.erb', to)
+      if actions?('index')
+        to = File.join "spec/api/v1/#{file_name.pluralize}",
+          class_path,
+          "index_spec.rb"
+        template('index_request_spec.rb.erb', to)
+      end
 
-      to = File.join "spec/api/v1/#{file_name.pluralize}",
-        class_path,
-        "create_spec.rb"
-      template('create_request_spec.rb.erb', to)
+      if actions?('show')
+        to = File.join "spec/api/v1/#{file_name.pluralize}",
+          class_path,
+          "show_spec.rb"
+        template('show_request_spec.rb.erb', to)
+      end
 
-      to = File.join "spec/api/v1/#{file_name.pluralize}",
-        class_path,
-        "update_spec.rb"
-      template('update_request_spec.rb.erb', to)
+      if actions?('create')
+        to = File.join "spec/api/v1/#{file_name.pluralize}",
+          class_path,
+          "create_spec.rb"
+        template('create_request_spec.rb.erb', to)
+      end
 
-      to = File.join "spec/api/v1/#{file_name.pluralize}",
-        class_path,
-        "destroy_spec.rb"
-      template('destroy_request_spec.rb.erb', to)
-    end
+      if actions?('update')
+        to = File.join "spec/api/v1/#{file_name.pluralize}",
+          class_path,
+          "update_spec.rb"
+        template('update_request_spec.rb.erb', to)
+      end
 
-    def omit_tests?
-      @options['no-test']
+      if actions?('destroy')
+        to = File.join "spec/api/v1/#{file_name.pluralize}",
+          class_path,
+          "destroy_spec.rb"
+        template('destroy_request_spec.rb.erb', to)
+      end
     end
 
     def generate_resource
       to = File.join('app/resources', class_path, "#{file_name}_resource.rb")
       template('resource.rb.erb', to)
     end
 
+    def jsonapi_config
+      File.exists?('.jsonapicfg.yml') ? YAML.load_file('.jsonapicfg.yml') : {}
+    end
+
+    def update_config!(attrs)
+      config = jsonapi_config.merge(attrs)
+      File.open('.jsonapicfg.yml', 'w') { |f| f.write(config.to_yaml) }
+    end
+
+    def prompt(header: nil, description: nil, default: nil)
+      say(set_color("\n#{header}", :magenta, :bold)) if header
+      say("\n#{description}") if description
+      answer = ask(set_color("\n(default: #{default}):", :magenta, :bold))
+      answer = default if answer.blank? && default != 'nil'
+      say(set_color("\nGot it!\n", :white, :bold))
+      answer
+    end
+
+    def api_namespace
+      @api_namespace ||= begin
+        ns = jsonapi_config['namespace']
+
+        if ns.blank?
+          ns = prompt \
+            header: "What is your API namespace?",
+            description: "This will be used as a route prefix, e.g. if you want the route '/books_api/v1/authors' your namespace would be 'books_api'",
+            default: 'api'
+          update_config!('namespace' => ns)
+        end
+
+        ns
+      end
+    end
+
     def model_klass
       class_name.safe_constantize
     end

lib/generators/jsonapi/templates/controller.rb.erb

@@ -5,12 +5,14 @@ class <%= model_klass.name.pluralize %>Controller < ApplicationController
   <%- end -%>
   jsonapi resource: <%= model_klass %>Resource
 
+  <%- if actions?('create', 'update') -%>
   <%- unless omit_comments? -%>
   # Reference a strong resource payload defined in
   # config/initializers/strong_resources.rb
   <%- end -%>
   strong_resource :<%= file_name %>
-
+  <%- end -%>
+  <%- if actions?('create', 'update') -%>
   <%- unless omit_comments? -%>
   # Run strong parameter validation for these actions.
   # Invalid keys will be dropped.
@@ -19,6 +21,8 @@ class <%= model_klass.name.pluralize %>Controller < ApplicationController
   <%- end -%>
   before_action :apply_strong_params, only: [:create, :update]
 
+  <%- end -%>
+  <%- if actions?('index') -%>
   <%- unless omit_comments? -%>
   # Start with a base scope and pass to render_jsonapi
   <%- end -%>
@@ -27,6 +31,8 @@ class <%= model_klass.name.pluralize %>Controller < ApplicationController
     render_jsonapi(<%= file_name.pluralize %>)
   end
 
+  <%- end -%>
+  <%- if actions?('show') -%>
   <%- unless omit_comments? -%>
   # Call jsonapi_scope directly here so we can get behavior like
   # sparse fieldsets and statistics.
@@ -36,6 +42,8 @@ class <%= model_klass.name.pluralize %>Controller < ApplicationController
     render_jsonapi(scope.resolve.first, scope: false)
   end
 
+  <%- end -%>
+  <%- if actions?('create') -%>
   <%- unless omit_comments? -%>
   # jsonapi_create will use the configured Resource (and adapter) to persist.
   # This will handle nested relationships as well.
@@ -51,6 +59,8 @@ class <%= model_klass.name.pluralize %>Controller < ApplicationController
     end
   end
 
+  <%- end -%>
+  <%- if actions?('update') -%>
   <%- unless omit_comments? -%>
   # jsonapi_update will use the configured Resource (and adapter) to persist.
   # This will handle nested relationships as well.
@@ -66,6 +76,8 @@ class <%= model_klass.name.pluralize %>Controller < ApplicationController
     end
   end
 
+  <%- end -%>
+  <%- if actions?('destroy') -%>
   <%- unless omit_comments? -%>
   # No need for any special logic here as no_content is jsonapi_compliant.
   # Customize this if you have a more complex use case.
@@ -75,5 +87,6 @@ class <%= model_klass.name.pluralize %>Controller < ApplicationController
     <%= file_name %>.destroy
     return head(:no_content)
   end
+  <%- end -%>
 end
 <% end -%>

lib/generators/jsonapi/templates/create_request_spec.rb.erb

@@ -15,7 +15,7 @@ RSpec.describe "<%= type %>#create", type: :request do
 
     it 'creates the resource' do
       expect {
-        jsonapi_post "/api/v1/<%= type %>", payload
+        jsonapi_post "/<%= api_namespace %>/v1/<%= type %>", payload
       }.to change { <%= model_klass %>.count }.by(1)
       <%= file_name %> = <%= model_klass %>.last
 

lib/generators/jsonapi/templates/destroy_request_spec.rb.erb

@@ -6,7 +6,7 @@ RSpec.describe "<%= type %>#destroy", type: :request do
 
     it 'updates the resource' do
       expect {
-        delete "/api/v1/<%= type %>/#{<%= file_name %>.id}"
+        delete "/<%= api_namespace %>/v1/<%= type %>/#{<%= file_name %>.id}"
       }.to change { <%= model_klass %>.count }.by(-1)
 
       expect(response.status).to eq(204)

lib/generators/jsonapi/templates/index_request_spec.rb.erb

@@ -6,7 +6,7 @@ RSpec.describe "<%= file_name.pluralize %>#index", type: :request do
     let!(:<%= file_name %>2) { create(:<%= file_name %>) }
 
     it 'serializes the list correctly' do
-      get "/api/v1/<%= file_name.pluralize %>"
+      get "/<%= api_namespace %>/v1/<%= file_name.pluralize %>"
 
       expect(json_ids(true)).to match_array([<%= file_name %>1.id, <%= file_name %>2.id])
       assert_payload(:<%= file_name %>, <%= file_name %>1, json_items[0])

lib/generators/jsonapi/templates/payload.rb.erb

@@ -30,4 +30,8 @@
 # For more information, see https://jsonapi-suite.github.io/jsonapi_spec_helpers/
 <%- end -%>
 JsonapiSpecHelpers::Payload.register(:<%= file_name %>) do
+  <%- attributes.each do |a| -%>
+  <%- type = a.type == :boolean ? [TrueClass, FalseClass] : a.type.to_s.classify -%>
+  key(:<%= a.name %>, <%= type %>)
+  <%- end -%>
 end

lib/generators/jsonapi/templates/serializer.rb.erb

@@ -18,5 +18,8 @@ class Serializable<%= class_name %> < JSONAPI::Serializable::Resource
   #   @object.name.upcase
   # end
   <%- end -%>
+  <%- attributes.each do |a| -%>
+  attribute :<%= a.name %>
+  <%- end -%>
 end
 <% end -%>

lib/generators/jsonapi/templates/show_request_spec.rb.erb

@@ -5,7 +5,7 @@ RSpec.describe "<%= file_name.pluralize %>#show", type: :request do
     let!(:<%= file_name %>) { create(:<%= file_name %>) }
 
     it 'serializes the resource correctly' do
-      get "/api/v1/<%= file_name.pluralize %>/#{<%= file_name %>.id}"
+      get "/<%= api_namespace %>/v1/<%= file_name.pluralize %>/#{<%= file_name %>.id}"
 
       assert_payload(:<%= file_name %>, <%= file_name %>, json_item)
     end

lib/generators/jsonapi/templates/update_request_spec.rb.erb

@@ -19,7 +19,7 @@ RSpec.describe "<%= type %>#update", type: :request do
     # Replace 'xit' with 'it' after adding attributes
     xit 'updates the resource' do
       expect {
-        jsonapi_put "/api/v1/<%= type %>/#{<%= file_name %>.id}", payload
+        jsonapi_put "/<%= api_namespace %>/v1/<%= type %>/#{<%= file_name %>.id}", payload
       }.to change { <%= file_name %>.reload.attributes }
       assert_payload(:<%= file_name %>, <%= file_name %>, json_item)