snfoil-rails 0.5.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d48c445c4545a06e5d8e76b7efff38cc25397ee250a0cecf742c662e35b85c0e
+  data.tar.gz: 91b1a44d6fe259a22148bfcbe7e70ae6d5114e1253ab65eecb906032e6b17216
+SHA512:
+  metadata.gz: 53bef1d3d8eaf8f7e46dd5e9d161bb9ff6e83628e0cf0682519aaee965cfcafb575e87031aa2760d4fcb47693670f3c505b83ee828cae9a4efc28906fb2ad982
+  data.tar.gz: 9c6cee13f1ba22c291469b9339c655a5a797fc31666f92ab60eaec8c1229e51aa10648f3beb13a9b29505d1b69e9a61a20c3f56a9b52968fb2d97e4fc85e507d

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/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 Matthew Howes
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,28 @@
+# Sn::Foil::Rails
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sn-foil-rails'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install sn-foil-rails
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'SnFoil::Rails'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

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
+    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

data/lib/sn_foil/controller/api.rb

@@ -0,0 +1,88 @@
+# 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?
+          params
+          render json: serializer(**options).new(model,
+                                                 **options,
+                                                 params: (options[:controller_params] || options[:params] || {})
+                                                           .merge(current_entity: current_entity)).serializable_hash
+        else
+          render json: model.errors, status: :unprocessable_entity
+        end
+      end
+
+      def render_destroy(model, **_options)
+        if model.errors.empty?
+          render json: {}, status: :no_content
+        else
+          render json: model.errors, status: :unprocessable_entity
+        end
+      end
+
+      def render_index(results, **options)
+        render json: serializer(**options).new(paginate(results, **options),
+                                               **options,
+                                               params: (options[:controller_params] || options[:params] || {})
+                                                         .merge(current_entity: current_entity),
+                                               meta: meta(results, **options))
+                                          .serializable_hash
+      end
+
+      def render_show(model, **options)
+        render json: serializer(**options).new(model,
+                                               **options,
+                                               params: (options[:controller_params] || options[:params] || {})
+                                                         .merge(current_entity: current_entity)).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,67 @@
+# 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)
+          results = paginate(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,85 @@
+# 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_entity)
+        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_entity
+          return current_entity if defined? current_entity
+          return current_user if defined? current_user
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'active_support/concern'
+require_relative 'setup_controller_concern'
+
+module SnFoil
+  module Controller
+    module Concerns
+      module ShowControllerConcern
+        extend ActiveSupport::Concern
+
+        included do
+          include SetupControllerConcern
+        end
+
+        def show(**options)
+          options = setup_show(**options)
+          model = process_show(**options)
+          render_show(model, **options)
+        end
+
+        def setup_show(**options)
+          setup_options(**options)
+        end
+
+        def process_show(**options)
+          current_context(**options).show(**options)
+        end
+
+        def render_show(model, **_options)
+          render model
+        end
+      end
+    end
+  end
+end

data/lib/sn_foil/controller/concerns/update_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 UpdateControllerConcern
+        extend ActiveSupport::Concern
+
+        included do
+          include SetupControllerConcern
+          include ChangeControllerConcern
+        end
+
+        def update(**options)
+          options = setup_update(**options)
+          model = process_update(**options)
+          render_update(model, **options)
+        end
+
+        def setup_update(**options)
+          setup_options(**options)
+        end
+
+        def process_update(**options)
+          current_context(**options).update(**options)
+        end
+
+        def render_update(model, **options)
+          render_change(model, **options)
+        end
+      end
+    end
+  end
+end

data/lib/sn_foil/jsonapi_deserializer.rb

@@ -0,0 +1,153 @@
+# frozen_string_literal: true
+
+require 'active_support/concern'
+
+module SnFoil
+  module JsonapiDeserializer # rubocop:disable Metrics/ModuleLength
+    extend ActiveSupport::Concern
+
+    class_methods do
+      attr_reader :i_attribute_fields, :i_attribute_transforms
+
+      def attributes(*fields)
+        @i_attribute_fields ||= []
+        @i_attribute_fields |= fields
+      end
+
+      def attribute(key, **options)
+        @i_attribute_transforms ||= {}
+        @i_attribute_transforms[key] = options.merge(transform_type: :attribute)
+      end
+
+      def has_one(key, deserializer:, **options) # rubocop:disable Naming/PredicateName
+        @i_attribute_transforms ||= {}
+        @i_attribute_transforms[key] = options.merge(deserializer: deserializer, transform_type: :has_one)
+      end
+      alias_method :belongs_to, :has_one
+
+      def has_many(key, deserializer:, **options) # rubocop:disable Naming/PredicateName
+        @i_attribute_transforms ||= {}
+        @i_attribute_transforms[key] = options.merge(deserializer: deserializer, transform_type: :has_many)
+      end
+    end
+
+    attr_reader :object, :included, :options
+    def initialize(object, included: nil, **options)
+      @object = object
+      @included = included || object[:included]
+      @options = options
+    end
+
+    def attribute_fields
+      self.class.i_attribute_fields || []
+    end
+
+    def attribute_transforms
+      self.class.i_attribute_transforms || {}
+    end
+
+    def attributes
+      @attributes ||= attribute_fields | attribute_transforms.map { |k, v| v[:key] || k }
+    end
+
+    def parse
+      parse_data
+    end
+    alias to_h parse
+
+    private
+
+    def parse_data
+      if object[:data].is_a? Array
+        object[:data].map { |d| build_attributes(d) }
+      else
+        build_attributes(object[:data])
+      end
+    end
+
+    def build_attributes(data)
+      attributes = data_id({}, data)
+      attributes = parse_standard_attributes(attributes, data) if data[:attributes]
+      attribute_transforms.each do |key, opts|
+        attributes = apply_attribute_transform(attributes, data, key, **opts)
+      end
+      attributes
+    end
+
+    def data_id(attributes, data)
+      if data[:id]
+        attributes[:id] = data[:id]
+      elsif data[:'local:id']
+        attributes[:lid] = data[:'local:id']
+      end
+      attributes
+    end
+
+    def parse_standard_attributes(attributes, data)
+      attributes.merge!(data[:attributes].select { |k, _| attribute_fields.include? k })
+    end
+
+    def apply_attribute_transform(attributes, data, key, transform_type:, **opts)
+      if transform_type == :attribute
+        parse_attribute_transform(attributes, data, key, **opts)
+      elsif transform_type == :has_one
+        parse_has_one_relationship(attributes, data, key, **opts)
+      elsif transform_type == :has_many
+        parse_has_many_relationship(attributes, data, key, **opts)
+      end
+    end
+
+    def parse_attribute_transform(attributes, data, key, **opts)
+      return attributes unless data.dig(:attributes, key)
+
+      attributes.merge(Hash[opts.fetch(:key) { key }, data[:attributes][key]])
+    end
+
+    def parse_relationships(attributes, data)
+      self.class.has_one_relationships.each do |key, opts|
+        attributes = has_one_relationship(attributes, data, key, **opts)
+      end
+      self.class.has_many_relationships.each do |key, opts|
+        attributes = has_many_relationship(attributes, data, key, **opts)
+      end
+      attributes
+    end
+
+    def parse_has_one_relationship(attributes, data, key, deserializer:, **opts)
+      resource_data = data.dig(:relationships, key, :data)
+      return attributes unless resource_data
+
+      resource_data = data_id(resource_data, resource_data)
+      attribute_data = lookup_relationship(resource_data)
+      relationship_data = { data: attribute_data || resource_data }
+      attributes[opts.fetch(:key) { key }] = deserializer.new(relationship_data, **options, included: included).parse
+      attributes
+    end
+
+    def parse_has_many_relationship(attributes, data, key, deserializer:, **opts)
+      array_data = data.dig(:relationships, key, :data)
+      return attributes unless array_data
+
+      attributes[opts.fetch(:key) { key }] = array_data.map do |resource_data|
+        resource_data = data_id(resource_data, resource_data)
+        attribute_data = lookup_relationship(resource_data)
+        relationship_data = { data: attribute_data || resource_data }
+        deserializer.new(relationship_data, **options, included: included).parse
+      end
+      attributes
+    end
+
+    def lookup_relationship(type:, id: nil, lid: nil, **_opts)
+      raise ::ArgumentError, "missing keyword: id or lid for type: #{type}" unless id || lid
+
+      included&.find do |x|
+        x[:type].eql?(type) &&
+          if id
+            x[:id].eql?(id)
+          elsif lid
+            x[:'local:id'].eql?(lid)
+          end
+      end
+    end
+  end
+end

data/lib/sn_foil/jsonapi_serializer.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'active_support/concern'
+require 'fast_jsonapi/object_serializer'
+
+module SnFoil
+  module JsonapiSerializer
+    extend ActiveSupport::Concern
+
+    included do
+      include FastJsonapi::ObjectSerializer
+
+      set_key_transform :dash
+    end
+  end
+end

data/lib/sn_foil/rails.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module SnFoil
+  module Rails
+    if defined?(Rails)
+      require 'sn_foil/rails/engine'
+    else
+      require 'sn_foil'
+      require_relative '../searcher'
+      require_relative '../jsonapi_serializer'
+      require_relative '../jsonapi_deserializer'
+      require_relative '../controller/concerns/change_controller_concern'
+      require_relative '../controller/concerns/create_controller_concern'
+      require_relative '../controller/concerns/destroy_controller_concern'
+      require_relative '../controller/concerns/index_controller_concern'
+      require_relative '../controller/concerns/setup_controller_concern'
+      require_relative '../controller/concerns/show_controller_concern'
+      require_relative '../controller/concerns/update_controller_concern'
+      require_relative '../controller/api'
+      require_relative '../controller/base'
+    end
+  end
+end

data/lib/sn_foil/rails/engine.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module SnFoil
+  module Rails
+    class Engine < ::Rails::Engine
+      require 'sn_foil'
+      require_relative '../searcher'
+      require_relative '../jsonapi_serializer'
+      require_relative '../jsonapi_deserializer'
+      require_relative '../controller/concerns/change_controller_concern'
+      require_relative '../controller/concerns/create_controller_concern'
+      require_relative '../controller/concerns/destroy_controller_concern'
+      require_relative '../controller/concerns/index_controller_concern'
+      require_relative '../controller/concerns/setup_controller_concern'
+      require_relative '../controller/concerns/show_controller_concern'
+      require_relative '../controller/concerns/update_controller_concern'
+      require_relative '../controller/api'
+      require_relative '../controller/base'
+    end
+  end
+end

data/lib/sn_foil/rails/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module SnFoil
+  module Rails
+    VERSION = '0.5.5'
+  end
+end

data/lib/sn_foil/searcher.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+require 'active_support/concern'
+require 'sn_foil/searcher'
+
+module SnFoil
+  module Searcher
+    extend ActiveSupport::Concern
+
+    included do
+      module_eval do
+        alias_method :base_search, :search
+
+        # patch the additional search capabilities into the method
+        def search(params = {})
+          filtered_scope = base_search(params)
+          additional_search(filtered_scope, params)
+        end
+      end
+
+      ASC ||= 'ASC'
+      DESC ||= 'DESC'
+    end
+
+    class_methods do
+      attr_reader :i_include_params, :i_order_method, :i_order_block, :i_order_by_attr, :i_order_by_direction, :i_is_distinct
+
+      def order(method = nil, &block)
+        @i_order_method = method
+        @i_order_block = block
+      end
+
+      def order_by(attr, direction = nil)
+        @i_order_by_attr = attr
+        @i_order_by_direction = direction
+      end
+
+      def distinct(bool = true)
+        @i_is_distinct = bool
+      end
+
+      def includes(*array)
+        @i_include_params ||= [] # create new array if none exists
+        @i_include_params |= array # combine unique elements of both arrays
+      end
+    end
+
+    def distinct?
+      self.class.i_is_distinct || false
+    end
+
+    def included_params
+      self.class.i_include_params
+    end
+
+    def order_by(params = {})
+      if params[:order_by].present?
+        params[:order_by] = params[:order_by].to_s.underscore
+        return params[:order_by].to_sym if model.attribute_names.include?(params[:order_by])
+      end
+
+      self.class.i_order_by_attr || :id
+    end
+
+    def order(params = {})
+      if params[:order].present?
+        params[:order] = params[:order].to_s.upcase
+        return params[:order] if params[:order].eql?(ASC) || params[:order].eql?(DESC)
+      end
+
+      self.class.i_order_by_direction || ASC
+    end
+
+    private
+
+    def additional_search(filtered_scope, params = {})
+      filtered_scope = apply_order(filtered_scope, params)
+      filtered_scope = apply_includes(filtered_scope)
+      apply_distinct(filtered_scope, params)
+    end
+
+    def apply_includes(filtered_scope)
+      return filtered_scope unless included_params
+
+      filtered_scope.includes(*included_params)
+    end
+
+    def apply_order(filtered_scope, params)
+      return apply_default_order(filtered_scope, params) if params[:order_by].blank? && params[:order].blank?
+
+      filtered_scope.order(order_by(params) => order(params))
+    end
+
+    def apply_default_order(filtered_scope, params)
+      return order_method(filtered_scope, params) if order_method?
+      return order_block(filtered_scope, params) if order_block?
+
+      filtered_scope.order(order_by => order)
+    end
+
+    def order_method(filtered_scope, params)
+      send(self.class.i_order_method, filtered_scope, params)
+    end
+
+    def order_method?
+      self.class.i_order_method.present?
+    end
+
+    def order_block(filtered_scope, params)
+      instance_exec filtered_scope, params, &self.class.i_order_block
+    end
+
+    def order_block?
+      self.class.i_order_block.present?
+    end
+
+    def apply_distinct(filtered_scope, params)
+      return filtered_scope unless distinct? || params[:distinct] == true
+
+      filtered_scope.distinct
+    end
+  end
+end

data/lib/snfoil-rails.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require_relative 'sn_foil/rails'
+module SnFoil
+end

metadata

@@ -0,0 +1,234 @@
+--- !ruby/object:Gem::Specification
+name: snfoil-rails
+version: !ruby/object:Gem::Version
+  version: 0.5.5
+platform: ruby
+authors:
+- Matthew Howes
+- Danny Murphy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-07-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.4.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.4.3
+- !ruby/object:Gem::Dependency
+  name: jsonapi-serializer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: snfoil
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.2.4.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.2.4.3
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.76.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.76.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.36.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.36.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- howeszy@gmail.com
+- dmurph24@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CODE_OF_CONDUCT.md
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/generators/sn_foil/sn_foil_generator.rb
+- lib/sn_foil/controller/api.rb
+- lib/sn_foil/controller/base.rb
+- lib/sn_foil/controller/concerns/change_controller_concern.rb
+- lib/sn_foil/controller/concerns/create_controller_concern.rb
+- lib/sn_foil/controller/concerns/destroy_controller_concern.rb
+- lib/sn_foil/controller/concerns/index_controller_concern.rb
+- lib/sn_foil/controller/concerns/setup_controller_concern.rb
+- lib/sn_foil/controller/concerns/show_controller_concern.rb
+- lib/sn_foil/controller/concerns/update_controller_concern.rb
+- lib/sn_foil/jsonapi_deserializer.rb
+- lib/sn_foil/jsonapi_serializer.rb
+- lib/sn_foil/rails.rb
+- lib/sn_foil/rails/engine.rb
+- lib/sn_foil/rails/version.rb
+- lib/sn_foil/searcher.rb
+- lib/snfoil-rails.rb
+homepage: https://github.com/howeszy/snfoil-rails
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Additional functionality gem for using SnFoil with Rails
+test_files: []