snfoil-rails 0.1.0 → 0.3.0

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,151 @@
+# 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 object[:data][:lid]
+        attributes[:lid] = data[:lid]
+      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
+
+      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|
+        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 ::ArguementError, 'missing keyword: id or lid' unless id || lid
+
+      included&.find do |x|
+        x[:type].eql?(type) &&
+          if id
+            x[:id].eql?(id)
+          elsif lid
+            x[:lid].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

@@ -1,11 +1,22 @@
-# frozen_string_literal: true
-
-require 'sn_foil/rails/railtie'
-require 'sn_foil/rails/searcher'
-require 'sn_foil/rails/controller/api'
-
 module SnFoil
   module Rails
-    # Your code goes here...
+    if defined?(Rails)
+      require 'sn_foil/rails/engine'
+    else
+      require 'sn_foil'
+      require_relative '/version'
+      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,24 @@
+# frozen_string_literal: true
+
+require 'rails/engine'
+
+module SnFoil
+  module Rails
+    class Engine < ::Rails::Engine
+      require 'sn_foil'
+      require_relative 'version'
+      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

@@ -2,6 +2,6 @@
 
 module SnFoil
   module Rails
-    VERSION = '0.1.0'
+    VERSION = '0.3.0'
   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)
+      self.class.i_order_block.call(filtered_scope, params)
+    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

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: snfoil-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Matthew Howes
+- Danny Murphy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-07 00:00:00.000000000 Z
+date: 2020-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -24,6 +25,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: fast_jsonapi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +53,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 5.1.7
+- !ruby/object:Gem::Dependency
+  name: snfoil
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -153,26 +182,31 @@ dependencies:
 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/controller/api.rb
-- lib/sn_foil/rails/controller/concerns/change_controller_concern.rb
-- lib/sn_foil/rails/controller/concerns/create_controller_concern.rb
-- lib/sn_foil/rails/controller/concerns/destroy_controller_concern.rb
-- lib/sn_foil/rails/controller/concerns/index_controller_concern.rb
-- lib/sn_foil/rails/controller/concerns/setup_controller_concern.rb
-- lib/sn_foil/rails/controller/concerns/show_controller_concern.rb
-- lib/sn_foil/rails/controller/concerns/update_controller_concern.rb
-- lib/sn_foil/rails/railtie.rb
-- lib/sn_foil/rails/searcher.rb
+- lib/sn_foil/rails/engine.rb
 - lib/sn_foil/rails/version.rb
-- lib/tasks/sn_foil/rails_tasks.rake
+- lib/sn_foil/searcher.rb
 homepage: https://github.com/howeszy/snfoil-rails
 licenses:
 - MIT