snfoil-rails 0.5.3 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f2e314fff30b93ada5ce0fcecbfbc7ee6798df23bdc990311dd167937861b335
-  data.tar.gz: 11362362a7feefaa15cb8ccc27eaba14f49c0bc3cdc81fdf6b7d26b32062b72b
+  metadata.gz: b91f3f4a14656e627fe9b82d091c81e1fff178536da8866993f548734dda1738
+  data.tar.gz: cf0ffd14498657a1b8611ad71f4c0d07d1d888e72d595660734ca5cba598e169
 SHA512:
-  metadata.gz: 000b0f05e6295477bdb55dd6b26edecd7b236078ed80fef5c5e1e93696ec5eea1c63ad9efba69e88a14b4b51e4e67bce23e7022ae3330c733b19df1d72d9925c
-  data.tar.gz: ad0fc2f266dc5fa51224b3e4e764bc6d5c0b9279ba95cd717f766c738aff812dbb4bbe05df351ce7d7e9189288e0d30740700c39dd5efa51bd16ee75254b300d
+  metadata.gz: 86c3cfef031f22074928729d25bc07b856f635463758b9f66a2582c540896e02312234146d784f4d5bd5bdaaec854c671dfa097372468372e1bcc46a55687def
+  data.tar.gz: 61a52228ccc3a4dba8941a8a01a85ce939fb1885cd65ce8c1cc108dd893d1e5103da52f1aef4cabef5e7432a97e421b41eeff63b40d6242a5f4f7b519ed6eda8

data/lib/generators/sn_foil/all/all_generator.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module SnFoil
+  class AllGenerator < Rails::Generators::Base
+    source_root File.expand_path('templates', __dir__)
+
+    argument :model, type: :string
+
+    class_option(:type, desc: 'Generate Base or API', type: :string, default: 'base')
+    class_option(:skip_model, desc: 'Skip Model Creation', type: :boolean, default: false)
+
+    def add_model
+      rails_command "generate model #{call_args.join(' ')}", call_options
+    end
+
+    def add_policy
+      rails_command "generate sn_foil:policy #{call_args.join(' ')}", call_options
+    end
+
+    def add_searcher
+      rails_command "generate sn_foil:searcher #{call_args.join(' ')}", call_options
+    end
+
+    def add_context
+      rails_command "generate sn_foil:context #{call_args.join(' ')}", call_options
+    end
+
+    def add_jsonapi_serializer
+      rails_command "generate sn_foil:jsonapi_serializer #{call_args.join(' ')}", call_options
+    end
+
+    def add_jsonapi_deserializer
+      rails_command "generate sn_foil:jsonapi_deserializer #{call_args.join(' ')}", call_options
+    end
+
+    def add_controller
+      rails_command "generate sn_foil:controller #{call_args.join(' ')}", call_options
+    end
+
+    private
+
+    def call_args
+      @call_args ||= [model].concat(args)
+    end
+
+    def call_options
+      @call_options ||= options.deep_symbolize_keys
+    end
+  end
+end

data/lib/generators/sn_foil/context/context_generator.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module SnFoil
+  class ContextGenerator < Rails::Generators::Base
+    source_root File.expand_path('templates', __dir__)
+
+    argument :model, type: :string
+
+    class_option :path, desc: 'Base path for file', type: :string, default: 'app/contexts'
+
+    def add_app_file
+      file_name = if modules.length.zero?
+                    name
+                  else
+                    modules.join('/') + '/' + name
+                  end
+
+      template('context.erb', "#{options[:path]}/#{file_name}_context.rb")
+    end
+
+    private
+
+    def name
+      @name ||= model.split('/').last.underscore.singularize
+    end
+
+    def class_name
+      @class_name ||= name.camelize
+    end
+
+    def modules
+      @modules ||= model.split('/')[0..-2].map(&:underscore)
+    end
+
+    def class_modules
+      return if modules.length.zero?
+
+      @class_modules ||= "#{modules.map(&:camelize).join('::')}::"
+    end
+  end
+end

data/lib/generators/sn_foil/context/templates/context.erb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class <%= class_modules %><%= class_name %>Context
+  include SnFoil::Context
+
+  model <%= class_name %>
+  searcher <%= class_name.pluralize %>Searcher
+  policy <%= class_name %>Policy
+end

data/lib/generators/sn_foil/controller/controller_generator.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module SnFoil
+  class ControllerGenerator < Rails::Generators::Base
+    source_root File.expand_path('templates', __dir__)
+
+    argument :model, type: :string
+
+    class_option :type, desc: 'Generate Base or API', type: :string, default: 'base'
+    class_option :path, desc: 'Base path for file', type: :string, default: 'app/controllers'
+
+    def add_app_file
+      template(template_name, "#{options[:path]}/#{file_name}_controller.rb")
+    end
+
+    private
+
+    def file_name
+      @file_name ||= if modules.length.zero?
+                       name
+                     else
+                       modules.join('/') + '/' + name
+                     end
+    end
+
+    def template_name
+      @template_name ||= if options[:type] == 'api'
+                           'api_controller.erb'
+                         else
+                           'controller.erb'
+                         end
+    end
+
+    def name
+      @name ||= model.split('/').last.underscore.pluralize
+    end
+
+    def class_name
+      @class_name ||= name.camelize
+    end
+
+    def modules
+      @modules ||= model.split('/')[0..-2].map(&:underscore)
+    end
+
+    def class_modules
+      return if modules.length.zero?
+
+      @class_modules ||= "#{modules.map(&:camelize).join('::')}::"
+    end
+  end
+end

data/lib/generators/sn_foil/controller/templates/api_controller.erb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+class <%= class_modules %><%= class_name %>Controller < SnFoil::Controller::API
+  context <%= class_name.singularize %>Context
+  serializer <%= class_name.singularize %>JsonapiSerializer
+  deserializer <%= class_name.singularize %>JsonapiDeserializer
+
+  # SnFoil::Controller requires current_entity or current_user defined to properly scope
+  # all queries, otherwise data leaks could occur
+  #
+  #  def current_entity
+  #  # logic to find authenticated user
+  #  end
+end

data/lib/generators/sn_foil/controller/templates/controller.erb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+class <%= class_modules %><%= class_name %>Controller < SnFoil::Controller::Base
+  context <%= name.singularize.camelcase %>Context
+  serializer <%= name.singularize.camelcase %>JsonapiSerializer
+  deserializer <%= name.singularize.camelcase %>JsonapiDeserializer
+
+  # SnFoil::Controller requires current_entity or current_user defined to properly scope
+  # all queries, otherwise data leaks could occur
+  #
+  #  def current_entity
+  #  # logic to find authenticated user
+  #  end
+end

data/lib/generators/sn_foil/jsonapi_deserializer/jsonapi_deserializer_generator.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module SnFoil
+  class JsonapiDeserializerGenerator < Rails::Generators::Base
+    source_root File.expand_path('templates', __dir__)
+
+    argument :model, type: :string
+
+    class_option :path, desc: 'Base path for file', type: :string, default: 'app/jsonapi_deserializers'
+
+    def add_app_file
+      file_name = if modules.length.zero?
+                    name
+                  else
+                    modules.join('/') + '/' + name
+                  end
+
+      template('jsonapi_deserializer.erb', "#{options[:path]}/#{file_name}_jsonapi_deserializer.rb")
+    end
+
+    private
+
+    def name
+      @name ||= model.split('/').last.underscore.singularize
+    end
+
+    def class_name
+      @class_name ||= name.camelize
+    end
+
+    def modules
+      @modules ||= model.split('/')[0..-2].map(&:underscore)
+    end
+
+    def class_modules
+      return if modules.length.zero?
+
+      @class_modules ||= "#{modules.map(&:camelize).join('::')}::"
+    end
+  end
+end

data/lib/generators/sn_foil/jsonapi_deserializer/templates/jsonapi_deserializer.erb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+class <%= class_modules %><%= class_name %>JsonapiDeserializer
+  include SnFoil::JsonapiDeserializer
+  
+  # Add attributes of the model you want to serializer with the following syntax
+  attributes :id
+
+  # Add relationships with the following syntax
+  # belongs_to :store, serializer: Jsonapi::StoreJsonapiSerializer
+  # has_many :locations, serializer: Jsonapi::LocationJsonapiSerializer
+end

data/lib/generators/sn_foil/jsonapi_serializer/jsonapi_serializer_generator.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module SnFoil
+  class JsonapiSerializerGenerator < Rails::Generators::Base
+    source_root File.expand_path('templates', __dir__)
+
+    argument :model, type: :string
+
+    class_option :path, desc: 'Base path for file', type: :string, default: 'app/jsonapi_serializers'
+
+    def add_app_file
+      file_name = if modules.length.zero?
+                    name
+                  else
+                    modules.join('/') + '/' + name
+                  end
+
+      template('jsonapi_serializer.erb', "#{options[:path]}/#{file_name}_jsonapi_serializer.rb")
+    end
+
+    private
+
+    def name
+      @name ||= model.split('/').last.underscore.singularize
+    end
+
+    def class_name
+      @class_name ||= name.camelize
+    end
+
+    def modules
+      @modules ||= model.split('/')[0..-2].map(&:underscore)
+    end
+
+    def class_modules
+      return if modules.length.zero?
+
+      @class_modules ||= "#{modules.map(&:camelize).join('::')}::"
+    end
+  end
+end

data/lib/generators/sn_foil/jsonapi_serializer/templates/jsonapi_serializer.erb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+class <%= class_modules %><%= class_name %>JsonapiSerializer
+  include SnFoil::JsonapiSerializer
+
+  set_id :id
+  set_type :<%= name.pluralize.dasherize %>
+
+  # SnFoil::JsonapiSerializer is just a wrapper for jsonapi-serializer (https://github.com/jsonapi-serializer/jsonapi-serializer)
+  # with some defaults added in
+
+  # Add attributes of the model you want to serializer with the following syntax
+  # attributes :name
+  #            :description
+  #            :logo_url
+
+  # Add relationships with the following syntax
+  # belongs_to :store, serializer: Jsonapi::StoreJsonapiSerializer
+  # has_many :locations, serializer: Jsonapi::LocationJsonapiSerializer
+end

data/lib/generators/sn_foil/policy/policy_generator.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module SnFoil
+  class PolicyGenerator < Rails::Generators::Base
+    source_root File.expand_path('templates', __dir__)
+
+    argument :model, type: :string
+
+    class_option :path, desc: 'Base path for file', type: :string, default: 'app/policies'
+
+    def add_app_file
+      file_name = if modules.length.zero?
+                    name
+                  else
+                    modules.join('/') + '/' + name
+                  end
+
+      template('policy.erb', "#{options[:path]}/#{file_name}_policy.rb")
+    end
+
+    private
+
+    def name
+      @name ||= model.split('/').last.underscore.singularize
+    end
+
+    def class_name
+      @class_name ||= name.camelize
+    end
+
+    def modules
+      @modules ||= model.split('/')[0..-2].map(&:underscore)
+    end
+
+    def class_modules
+      return if modules.length.zero?
+
+      @class_modules ||= "#{modules.map(&:camelize).join('::')}::"
+    end
+  end
+end

data/lib/generators/sn_foil/policy/templates/policy.erb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+class <%= class_modules %><%= class_name %>Policy
+  include SnFoil::Policy
+  # A SnFoil::Policy is just a Pundit policy (https://github.com/varvet/pundit)
+  # with some defaults
+  # Available methods: show?, create?, update?, destroy?, index?, associate?
+
+  #  def show?
+  #    true
+  #  end
+
+  # class Scope
+  #   # available read-only attributes
+  #   # - scope: the default scope passed into the policy (ex: an ActiveRecord::Relation)
+  #   # - entity: the object that the scope is build around (ex: a User)
+
+  #   def resolve
+  #     # the new default scope
+  #   end
+  # end
+end

data/lib/generators/sn_foil/searcher/searcher_generator.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module SnFoil
+  class SearcherGenerator < Rails::Generators::Base
+    source_root File.expand_path('templates', __dir__)
+
+    argument :model, type: :string
+
+    class_option :path, desc: 'Base path for file', type: :string, default: 'app/searchers'
+
+    def add_app_file
+      file_name = if modules.length.zero?
+                    name
+                  else
+                    modules.join('/') + '/' + name
+                  end
+
+      template('searcher.erb', "#{options[:path]}/#{file_name}_searcher.rb")
+    end
+
+    private
+
+    def name
+      @name ||= model.split('/').last.underscore.pluralize
+    end
+
+    def class_name
+      @class_name ||= name.camelize
+    end
+
+    def modules
+      @modules ||= model.split('/')[0..-2].map(&:underscore)
+    end
+
+    def class_modules
+      return if modules.length.zero?
+
+      @class_modules ||= "#{modules.map(&:camelize).join('::')}::"
+    end
+  end
+end

data/lib/generators/sn_foil/searcher/templates/searcher.erb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class <%= class_modules %><%= class_name %>Searcher
+  include SnFoil::Searcher
+  
+  model <%= class_name.singularize %>
+end

data/lib/sn_foil/controller/api.rb

@@ -44,7 +44,7 @@ module SnFoil
           render json: serializer(**options).new(model,
                                                  **options,
                                                  params: (options[:controller_params] || options[:params] || {})
-                                                           .merge(current_entity: current_entity)).serializable_hash
+                                                           .merge(current_entity: context_entity)).serializable_hash
         else
           render json: model.errors, status: :unprocessable_entity
         end
@@ -62,7 +62,7 @@ module SnFoil
         render json: serializer(**options).new(paginate(results, **options),
                                                **options,
                                                params: (options[:controller_params] || options[:params] || {})
-                                                         .merge(current_entity: current_entity),
+                                                         .merge(current_entity: context_entity),
                                                meta: meta(results, **options))
                                           .serializable_hash
       end
@@ -71,7 +71,7 @@ module SnFoil
         render json: serializer(**options).new(model,
                                                **options,
                                                params: (options[:controller_params] || options[:params] || {})
-                                                         .merge(current_entity: current_entity)).serializable_hash
+                                                         .merge(current_entity: context_entity)).serializable_hash
       end
 
       private

data/lib/sn_foil/rails/version.rb

@@ -2,6 +2,6 @@
 
 module SnFoil
   module Rails
-    VERSION = '0.5.3'
+    VERSION = '0.8.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: snfoil-rails
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.8.0
 platform: ruby
 authors:
 - Matthew Howes
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-30 00:00:00.000000000 Z
+date: 2021-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -45,14 +45,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -191,7 +191,20 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
-- lib/generators/sn_foil/sn_foil_generator.rb
+- lib/generators/sn_foil/all/all_generator.rb
+- lib/generators/sn_foil/context/context_generator.rb
+- lib/generators/sn_foil/context/templates/context.erb
+- lib/generators/sn_foil/controller/controller_generator.rb
+- lib/generators/sn_foil/controller/templates/api_controller.erb
+- lib/generators/sn_foil/controller/templates/controller.erb
+- lib/generators/sn_foil/jsonapi_deserializer/jsonapi_deserializer_generator.rb
+- lib/generators/sn_foil/jsonapi_deserializer/templates/jsonapi_deserializer.erb
+- lib/generators/sn_foil/jsonapi_serializer/jsonapi_serializer_generator.rb
+- lib/generators/sn_foil/jsonapi_serializer/templates/jsonapi_serializer.erb
+- lib/generators/sn_foil/policy/policy_generator.rb
+- lib/generators/sn_foil/policy/templates/policy.erb
+- lib/generators/sn_foil/searcher/searcher_generator.rb
+- lib/generators/sn_foil/searcher/templates/searcher.erb
 - lib/sn_foil/controller/api.rb
 - lib/sn_foil/controller/base.rb
 - lib/sn_foil/controller/concerns/change_controller_concern.rb
@@ -227,7 +240,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Additional functionality gem for using SnFoil with Rails

data/lib/generators/sn_foil/sn_foil_generator.rb

@@ -1,47 +0,0 @@
-# frozen_string_literal: true
-
-class SnFoilGenerator < Rails::Generators::Base
-  source_root File.expand_path('templates', __dir__)
-  argument :model, type: :string
-
-  def generate_sn_foil
-    generate_model
-    generate_controller
-    generate_searcher
-    generate_serializer
-    generate_deserializer
-    generate_policy
-    generate_context
-    Rails.logger.info 'In order to expose your model, it must be added to the config/routes.rb file'
-  end
-
-  private
-
-  def generate_context
-    template 'context.erb', "app/contexts/#{model.singularize.underscore}_context.rb"
-  end
-
-  def generate_controller
-    template 'controller.erb', "app/controllers/#{model.pluralize.underscore}_controller.rb"
-  end
-
-  def generate_deserializer
-    template 'jsonapi_deserializer.erb', "app/deserializers/#{model.singularize.underscore}_deserializer.rb"
-  end
-
-  def generate_serializer
-    template 'jsonapi_serializer.erb', "app/serializers/#{model.singularize.underscore}_jsonapi_serializer.rb"
-  end
-
-  def generate_model
-    generate('model', model.underscore) unless File.file? "app/models/#{model.singularize.underscore}.rb"
-  end
-
-  def generate_searcher
-    template 'searcher.erb', "app/searchers/#{model.pluralize.underscore}_searcher.rb"
-  end
-
-  def generate_policy
-    template 'policy.erb', "app/policies/#{model.singularize.underscore}_policy.rb"
-  end
-end