snfoil-rails 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 95946ad8c9da4c8cf3498f8394145465131694074e3aef1b7f3849ae334b9358
-  data.tar.gz: 817e82e8f00557815290a724aa27f69a2c7d01e2c3f28ac5b66e0bd9834b51ec
+  metadata.gz: e837f5987125bbffbb68708d10913c6357ae424d35fe9029daac63fb0d8b2dfc
+  data.tar.gz: 8818603e24b76a442575dfadd726f4dcae6c82756c7edb6ffeb157b691a54943
 SHA512:
-  metadata.gz: 53d257a20b1cc16a9a8d7c54ec62f6c15cfc0b9bf377edc2d86c206af79331078746e9ea0e266103aff15407eaecdad56887c9c72dd790db4142d339f2effccb
-  data.tar.gz: 5863066aa0bb468aef6796d8336e69fda0b207b5b161999ebd86fa3ff2d2ece2500a4a868b0d1fbb83a2509ad486f1b958e29861dfaf99441c23bb7b95922596
+  metadata.gz: 47c77c2ddaba01d200cf3dbca4383ef2dd0d20a47fe43d1030ba32b3025678b75e0ff721896f0e3849aef951b86ee53cd37a0c786f0937fd844caf4f68696522
+  data.tar.gz: 508627b26457a293fc67b64dedb00adaeabd9c0027ed63d079e6a9067f77693051181294c7bf05b51e8ce206b4b67e2b3ee0d6cba9788c2a20729b5566d2a493

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at howeszy@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Rakefile

@@ -10,7 +10,7 @@ require 'rdoc/task'
 
 RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'Sn::Foil::Rails'
+  rdoc.title    = 'SnFoil::Rails'
   rdoc.options << '--line-numbers'
   rdoc.rdoc_files.include('README.md')
   rdoc.rdoc_files.include('lib/**/*.rb')

data/lib/generators/sn_foil/sn_foil_generator.rb

@@ -0,0 +1,47 @@
+# 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
+    puts '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

data/lib/sn_foil/controller/api.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require 'action_controller/api'
+require_relative 'base'
+
+module SnFoil
+  module Controller
+    class API < SnFoil::Controller::Base
+      class << self
+        attr_reader :i_serializer, :i_deserializer
+
+        def serializer(klass = nil)
+          @i_serializer = klass
+        end
+
+        def deserializer(klass = nil)
+          @i_deserializer = klass
+        end
+      end
+
+      def serializer(**options)
+        options[:serializer] || self.class.i_serializer
+      end
+
+      def deserializer(**options)
+        options[:deserializer] || self.class.i_deserializer
+      end
+
+      def setup_options(**options)
+        inject_deserialized_params(super)
+      end
+
+      def setup_create(**options)
+        super(**options.merge(deserialize: true))
+      end
+
+      def setup_update(**options)
+        super(**options.merge(deserialize: true))
+      end
+
+      def render_change(model, **options)
+        if model.errors.empty?
+          render json: serializer(**options).new(model, **options).serializable_hash
+        else
+          render model.errors, status: :unprocessable_entity
+        end
+      end
+
+      def render_destroy(model, **_options)
+        if model.errors.empty?
+          render status: :no_content
+        else
+          render model.errors, status: :unprocessable_entity
+        end
+      end
+
+      def render_index(results, **options)
+        render json: serializer(**options).new(paginate(results, **options), **options, meta: meta(results, **options))
+                                          .serializable_hash
+      end
+
+      def render_show(model, **options)
+        render json: serializer(**options).new(model, **options).serializable_hash
+      end
+
+      private
+
+      def inject_deserialized_params(**options)
+        return options unless options[:params].present? && options[:deserialize] == true
+        return options unless deserializer(**options)
+
+        options[:params] = deserializer(**options).new(options[:params], **options).to_h
+        options
+      end
+    end
+  end
+end

data/lib/sn_foil/controller/base.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative 'concerns/create_controller_concern'
+require_relative 'concerns/destroy_controller_concern'
+require_relative 'concerns/index_controller_concern'
+require_relative 'concerns/show_controller_concern'
+require_relative 'concerns/update_controller_concern'
+
+module SnFoil
+  module Controller
+    class Base < ActionController::Base # rubocop:disable Rails/ApplicationController
+      include Concerns::CreateControllerConcern
+      include Concerns::DestroyControllerConcern
+      include Concerns::IndexControllerConcern
+      include Concerns::ShowControllerConcern
+      include Concerns::UpdateControllerConcern
+    end
+  end
+end

data/lib/sn_foil/controller/concerns/change_controller_concern.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'active_support/concern'
+
+module SnFoil
+  module Controller
+    module Concerns
+      module ChangeControllerConcern
+        extend ActiveSupport::Concern
+
+        def render_change(model, **_options)
+          if model.errors.empty?
+            render model
+          else
+            render model.errors, status: :unprocessable_entity
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sn_foil/controller/concerns/create_controller_concern.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'active_support/concern'
+require_relative 'setup_controller_concern'
+require_relative 'change_controller_concern'
+
+module SnFoil
+  module Controller
+    module Concerns
+      module CreateControllerConcern
+        extend ActiveSupport::Concern
+
+        included do
+          include SetupControllerConcern
+          include ChangeControllerConcern
+        end
+
+        def create(**options)
+          options = setup_create(**options)
+          model = process_create(**options)
+          render_create(model, **options)
+        end
+
+        def setup_create(**options)
+          setup_options(**options)
+        end
+
+        def process_create(**options)
+          current_context(**options).create(**options)
+        end
+
+        def render_create(model, **options)
+          render_change(model, **options)
+        end
+      end
+    end
+  end
+end

data/lib/sn_foil/controller/concerns/destroy_controller_concern.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'active_support/concern'
+require_relative 'setup_controller_concern'
+
+module SnFoil
+  module Controller
+    module Concerns
+      module DestroyControllerConcern
+        extend ActiveSupport::Concern
+
+        included do
+          include SetupControllerConcern
+        end
+
+        def destroy(**options)
+          options = setup_destroy(**options)
+          model = process_destroy(**options)
+          render_destroy(model, **options)
+        end
+
+        def setup_destroy(**options)
+          setup_options(**options)
+        end
+
+        def process_destroy(**options)
+          current_context(**options).destroy(**options)
+        end
+
+        def render_destroy(model, **_options)
+          if model.errors.empty?
+            render nil
+          else
+            render model.errors, status: :unprocessable_entity
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sn_foil/controller/concerns/index_controller_concern.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require 'active_support/concern'
+require_relative 'setup_controller_concern'
+
+module SnFoil
+  module Controller
+    module Concerns
+      module IndexControllerConcern
+        extend ActiveSupport::Concern
+
+        included do
+          include SetupControllerConcern
+        end
+
+        def index(**options)
+          options = setup_index(**options)
+          results = process_index(**options)
+          render_index(results, **options)
+        end
+
+        def setup_index(**options)
+          setup_options(**options)
+        end
+
+        def process_index(**options)
+          current_context(**options).index(options)
+        end
+
+        def render_index(results, **options)
+          render paginate(results, **options), meta: meta(results, options)
+        end
+
+        def paginate(results, **options)
+          return results unless results.respond_to?(:page)
+
+          results.page(page(**options))
+                 .per(per_page(**options))
+        end
+
+        def page(**options)
+          (options.dig(:params, :page) || 1).to_i
+        end
+
+        def per_page(**options)
+          per_page_param = (options.dig(:params, :per_page) || 10).to_i
+          return 1000 if per_page_param.zero? || per_page_param > 1000
+
+          per_page_param
+        end
+
+        def meta(results, **options)
+          total_pages = results.respond_to?(:total_pages) ? results.total_pages : nil
+          total_count = results.respond_to?(:total_count) ? results.total_count : nil
+
+          {
+            page: page(**options),
+            pages: total_pages,
+            total: total_count,
+            per: per_page(**options)
+          }
+        end
+      end
+    end
+  end
+end

data/lib/sn_foil/controller/concerns/setup_controller_concern.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require 'active_support/concern'
+
+module SnFoil
+  module Controller
+    module Concerns
+      module SetupControllerConcern
+        extend ActiveSupport::Concern
+
+        class_methods do
+          attr_reader :i_context
+
+          def context(klass = nil)
+            @i_context = klass
+          end
+        end
+
+        def context(**options)
+          options[:context] || self.class.i_context
+        end
+
+        def setup_options(**options)
+          options = inject_params(**options)
+          options = inject_id(**options)
+          options = inject_includes(**options)
+          inject_controller_action(**options)
+        end
+
+        def current_context(**options)
+          @current_context ||= context(**options).new(context_user)
+        end
+
+        protected
+
+        def pundit_not_authorized
+          head :forbidden
+        end
+
+        private
+
+        # Grab the rails params and inject them into the options
+        def inject_params(**options)
+          return options if options[:params]
+          return options unless params
+
+          options[:params] = params.to_unsafe_h.deep_symbolize_keys
+          options[:controller_params] = options[:params]
+          options
+        end
+
+        def inject_id(**options)
+          return options if options[:id]
+
+          options[:id] = id if defined? id
+          options[:id] ||= options[:params][:id]
+          options
+        end
+
+        def inject_includes(**options)
+          return options if options[:include]
+          return options unless options.dig(:params, :include)
+
+          options[:include] = options.dig(:params, :include)
+                                     .split(',')
+                                     .map { |item| item.underscore.to_sym }
+          options
+        end
+
+        def inject_controller_action(**options)
+          return options if options[:controller_action]
+          return options unless options.dig(:params, :action)
+
+          options[:controller_action] = options[:params][:action]
+          options
+        end
+
+        def context_user
+          return current_user if defined? current_user
+        end
+      end
+    end
+  end
+end