snfoil-rails 0.7.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c04a7e0dc66d406d1e758d1d4a6cc3d1626fa02b0beb0d4465ae2940f6f517cd
-  data.tar.gz: 27ffc1f5e63c1e2211ac68c133c9b7ade926c597adfbb05b146cb743a4460d2e
+  metadata.gz: e70578dd091d98c88bb3c7fbf6868187f1549bdc4e1b7db17e4a6ec3114090ce
+  data.tar.gz: e0513e5ed7245a443ded275617b5d72b615e5796286e8361e4ac030e12941af8
 SHA512:
-  metadata.gz: 574a8c564a5d08240c91cc13e365d02b5b16f5c22524ac4160b1a2b4b54c8415a0d3164cf24d0a255f9af59e35df94f1cb48c53fcdb9858c88bfa545cc41b39f
-  data.tar.gz: 8ea4ad813675320a6bf96def1797127c287976daff9aa474a7fe3dc9b30bce24cbbe9b51d3e44a32541416e26ef0d9749397b10dff968a9a80835943c1751a03
+  metadata.gz: c51c1f966922efa1ebea92c123b0adf8893155e43bbf7e4921c73c10295e535812a66b4e1341a170f36931d662c32784b592fb9795e46ae133be598b079046ff
+  data.tar.gz: 30e5c4175d007e73c6d57d8116c7d6808eef9777af52eb3040303b4fc1af36550537c75c0d76033241caeaabd487da7f24d7acf6706748f2998acb441e718e3d

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

@@ -0,0 +1,46 @@
+class SnFoil::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
+    generate('model', *call_args, **call_options) unless File.file?("app/models/#{model.singularize.underscore}.rb") || options[:skip_model]
+  end
+
+  def add_policy
+    generate('sn_foil:policy', *call_args, **call_options)
+  end
+
+  def add_searcher
+    generate('sn_foil:searcher', *call_args, **call_options)
+  end
+
+  def add_context
+    generate('sn_foil:context', *call_args, **call_options)
+  end
+
+  def add_jsonapi_serializer
+    generate('sn_foil:jsonapi_serializer', *call_args, **call_options)
+  end
+
+  def add_jsonapi_deserializer
+    generate('sn_foil:jsonapi_deserializer', *call_args, **call_options)
+  end
+
+  def add_controller
+    generate('sn_foil:controller', *call_args, **call_options)
+  end
+
+  private
+
+  def call_args
+    @call_args ||= [model].concat(args)
+  end
+
+  def call_options
+    @call_options ||= options.deep_symbolize_keys
+  end
+end

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

@@ -0,0 +1,37 @@
+class SnFoil::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

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,44 @@
+class SnFoil::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
+    file_name = if modules.length.zero?
+                  name
+                else
+                  modules.join('/') + '/' + name
+                end
+
+    template_name = if options[:type] == 'api'
+                      'api_controller.erb'
+                    else
+                      'controller.erb'
+                    end
+
+    template(template_name, "#{options[:path]}/#{file_name}_controller.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

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,37 @@
+class SnFoil::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

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,37 @@
+class SnFoil::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

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,37 @@
+class SnFoil::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

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,37 @@
+class SnFoil::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

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.7.0'
+    VERSION = '0.7.1'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: snfoil-rails
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Matthew Howes
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-27 00:00:00.000000000 Z
+date: 2020-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -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

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