snfoil-rails 0.8.0 → 0.8.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b91f3f4a14656e627fe9b82d091c81e1fff178536da8866993f548734dda1738
-  data.tar.gz: cf0ffd14498657a1b8611ad71f4c0d07d1d888e72d595660734ca5cba598e169
+  metadata.gz: bfdc322288169bedaad75e87ee5f85c7155bcdaddb1f7acb2e8d446eb518879d
+  data.tar.gz: f08cbf7eccf64cab8a999ee1b0c9b9c276682452de0391fd0d9ea60b08bfcd67
 SHA512:
-  metadata.gz: 86c3cfef031f22074928729d25bc07b856f635463758b9f66a2582c540896e02312234146d784f4d5bd5bdaaec854c671dfa097372468372e1bcc46a55687def
-  data.tar.gz: 61a52228ccc3a4dba8941a8a01a85ce939fb1885cd65ce8c1cc108dd893d1e5103da52f1aef4cabef5e7432a97e421b41eeff63b40d6242a5f4f7b519ed6eda8
+  metadata.gz: 42fe6f01f14697a6d5f17486ad3a0b8e43d9205557b31cffa9f52bb3d1db42749427718902b561c99c5f464cce4b0661dda55c6191d4ebe7ce4564e5226a4784
+  data.tar.gz: d1595ff0f2692da7e14d19187b666089afe8ebf36601baf5ab786d9bf6c4aae11688f67c6c5e4acf2c6d5371dfb0dc4aa90fc4927b049597f58cd42298c98ce1

data/README.md

@@ -8,7 +8,7 @@ How to use my plugin.
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'sn-foil-rails'
+gem 'snfoil-rails'
 ```
 
 And then execute:
@@ -18,7 +18,7 @@ $ bundle
 
 Or install it yourself as:
 ```bash
-$ gem install sn-foil-rails
+$ gem install snfoil-rails
 ```
 
 ## Contributing

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

@@ -12,7 +12,7 @@ module SnFoil
       file_name = if modules.length.zero?
                     name
                   else
-                    modules.join('/') + '/' + name
+                    "#{modules.join('/')}/#{name}"
                   end
 
       template('context.erb', "#{options[:path]}/#{file_name}_context.rb")

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

@@ -19,7 +19,7 @@ module SnFoil
       @file_name ||= if modules.length.zero?
                        name
                      else
-                       modules.join('/') + '/' + name
+                       "#{modules.join('/')}/#{name}"
                      end
     end
 

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

@@ -12,7 +12,7 @@ module SnFoil
       file_name = if modules.length.zero?
                     name
                   else
-                    modules.join('/') + '/' + name
+                    "#{modules.join('/')}/#{name}"
                   end
 
       template('jsonapi_deserializer.erb', "#{options[:path]}/#{file_name}_jsonapi_deserializer.rb")

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

@@ -12,7 +12,7 @@ module SnFoil
       file_name = if modules.length.zero?
                     name
                   else
-                    modules.join('/') + '/' + name
+                    "#{modules.join('/')}/#{name}"
                   end
 
       template('jsonapi_serializer.erb', "#{options[:path]}/#{file_name}_jsonapi_serializer.rb")

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

@@ -12,7 +12,7 @@ module SnFoil
       file_name = if modules.length.zero?
                     name
                   else
-                    modules.join('/') + '/' + name
+                    "#{modules.join('/')}/#{name}"
                   end
 
       template('policy.erb', "#{options[:path]}/#{file_name}_policy.rb")

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

@@ -12,7 +12,7 @@ module SnFoil
       file_name = if modules.length.zero?
                     name
                   else
-                    modules.join('/') + '/' + name
+                    "#{modules.join('/')}/#{name}"
                   end
 
       template('searcher.erb', "#{options[:path]}/#{file_name}_searcher.rb")

data/lib/sn_foil/configuration/lazy_jsonapi_serializer.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module SnFoil
+  module Configuration
+    module LazyJsonapiSerializer
+      extend ActiveSupport::Concern
+
+      class << self
+        def belongs_to(relationship_name, options = {}, &block)
+          block = belongs_to_optimized_block(relationship_name, options, &block)
+          super(relationship_name, options, &block)
+        end
+
+        def has_one(relationship_name, options = {}, &block) # rubocop:disable Naming/PredicateName reason: method override
+          super(relationship_name, has_relation_optimized_options(relationship_name, options), &block)
+        end
+
+        def has_many(relationship_name, options = {}, &block) # rubocop:disable Naming/PredicateName reason: method override
+          super(relationship_name, has_relation_optimized_options(relationship_name, options), &block)
+        end
+
+        private
+
+        # We need to parse the include block because FastJsonAPI does not allow access to the pre-parsed includes
+        def parse_include(params)
+          return [] unless params[:include]
+
+          if params[:include].is_a?(String)
+            params[:include].split(',')
+          else
+            params[:include]
+          end.map { |r| r.to_s.dasherize }.join(',')
+        end
+
+        def lookup_full_object_for_belongs_to(record, relationship_name, options, params)
+          return unless parse_include(params).include?(relationship_name.to_s.dasherize)
+
+          record.send(options[:object_method_name] || relationship_name)
+        end
+
+        def create_substitute_object_for_belongs_to(record, relationship_name, options)
+          relationship_id = options[:id_method_name] || "#{relationship_name}_id".to_sym
+          OpenStruct.new(id: record.send(relationship_id))
+        end
+
+        def belongs_to_optimized_block(relationship_name, options = {}, &block)
+          return block if options[:skip_optimization] == true || block
+
+          proc do |record, params|
+            if params && params[:include]
+              lookup_full_object(record_for_belongs_to, relationship_name, options, params)
+            else
+              create_substitute_object_for_belongs_to(record, relationship_name, options)
+            end
+          end
+        end
+
+        def create_included_proc_for_has_relation(relationship_name)
+          proc do |_record, params|
+            if params && params[:include]
+              parse_include(params).include?(relationship_name.to_s.dasherize)
+            else
+              false
+            end
+          end
+        end
+
+        def create_if_proc_for_has_relation(if_proc, included_proc)
+          if if_proc.present?
+            proc do |record, params|
+              FastJsonapi.call_proc(included_proc, record, params) && FastJsonapi.call_proc(if_proc, record, params)
+            end
+          else
+            included_proc
+          end
+        end
+
+        def has_relation_optimized_options(relationship_name, options) # rubocop:disable Naming/PredicateName reason: method override
+          return options if options[:skip_optimization] == true
+
+          options[:if] = create_if_proc_for_has_relation(options[:if], create_included_proc_for_has_relation(relationship_name))
+          options
+        end
+      end
+    end
+  end
+end

data/lib/sn_foil/controller/api.rb

@@ -31,11 +31,13 @@ module SnFoil
       end
 
       def setup_create(**options)
-        super(**options.merge(deserialize: true))
+        options[:deserialize] = options[:deserialize].nil? ? true : options[:deserialize]
+        super(**options)
       end
 
       def setup_update(**options)
-        super(**options.merge(deserialize: true))
+        options[:deserialize] = options[:deserialize].nil? ? true : options[:deserialize]
+        super(**options)
       end
 
       def render_change(model, **options)

data/lib/sn_foil/jsonapi_deserializer.rb

@@ -32,6 +32,7 @@ module SnFoil
     end
 
     attr_reader :object, :included, :options
+
     def initialize(object, included: nil, **options)
       @object = object
       @included = included || object[:included]
@@ -88,11 +89,12 @@ module SnFoil
     end
 
     def apply_attribute_transform(attributes, data, key, transform_type:, **opts)
-      if transform_type == :attribute
+      case transform_type
+      when :attribute
         parse_attribute_transform(attributes, data, key, **opts)
-      elsif transform_type == :has_one
+      when :has_one
         parse_has_one_relationship(attributes, data, key, **opts)
-      elsif transform_type == :has_many
+      when :has_many
         parse_has_many_relationship(attributes, data, key, **opts)
       end
     end
@@ -100,7 +102,7 @@ module SnFoil
     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]])
+      attributes.merge({ opts.fetch(:key) { key } => data[:attributes][key] })
     end
 
     def parse_relationships(attributes, data)
@@ -138,7 +140,7 @@ module SnFoil
     end
 
     def lookup_relationship(type:, id: nil, lid: nil, **_opts)
-      raise ::ArgumentError, "missing keyword: id or lid for type: #{type}" unless id || lid
+      check_for_id(id, lid)
 
       included&.find do |x|
         x[:type].eql?(type) &&
@@ -149,5 +151,9 @@ module SnFoil
           end
       end
     end
+
+    def check_for_id(id, lid)
+      raise ::ArgumentError, "missing keyword: id or lid for type: #{type}" unless id || lid
+    end
   end
 end

data/lib/sn_foil/jsonapi_serializer.rb

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

data/lib/sn_foil/rails/engine.rb

@@ -16,6 +16,8 @@ module SnFoil
       require_relative '../controller/concerns/update_controller_concern'
       require_relative '../controller/api'
       require_relative '../controller/base'
+
+      require_relative '../configuration/lazy_jsonapi_serializer'
     end
   end
 end

data/lib/sn_foil/rails/version.rb

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

data/lib/sn_foil/rails.rb

@@ -18,6 +18,8 @@ module SnFoil
       require_relative '../controller/concerns/update_controller_concern'
       require_relative '../controller/api'
       require_relative '../controller/base'
+
+      require_relative '../configuration/lazy_jsonapi_serializer'
     end
   end
 end

data/lib/sn_foil/searcher.rb

@@ -6,6 +6,8 @@ require 'sn_foil/searcher'
 module SnFoil
   module Searcher
     extend ActiveSupport::Concern
+    ASC = 'ASC'
+    DESC = 'DESC'
 
     included do
       module_eval do
@@ -17,9 +19,6 @@ module SnFoil
           additional_search(filtered_scope, params)
         end
       end
-
-      ASC ||= 'ASC'
-      DESC ||= 'DESC'
     end
 
     class_methods do
@@ -35,7 +34,7 @@ module SnFoil
         @i_order_by_direction = direction
       end
 
-      def distinct(bool = true)
+      def distinct(bool = true) # rubocop:disable Style/OptionalBooleanParameter reason: class configuration looks better this way
         @i_is_distinct = bool
       end
 
@@ -86,16 +85,14 @@ module SnFoil
     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)
+      if params[:order_by].blank? && params[:order].blank?
+        filtered_scope.order(order_by => order)
+      else
+        filtered_scope.order(order_by(params) => order(params))
+      end
     end
 
     def order_method(filtered_scope, params)

metadata

@@ -1,15 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: snfoil-rails
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.5
 platform: ruby
 authors:
 - Matthew Howes
 - Danny Murphy
+- Cliff Campbell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-08 00:00:00.000000000 Z
+date: 2021-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -17,28 +18,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.2.4.3
+        version: 5.2.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.2.4.3
+        version: 5.2.6
 - !ruby/object:Gem::Dependency
   name: jsonapi-serializer
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: snfoil
   requirement: !ruby/object:Gem::Requirement
@@ -59,42 +60,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.9'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.2.4.3
+        version: 5.2.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 5.2.4.3
+        version: 5.2.6
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -115,56 +116,70 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.9'
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.9'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.76.0
+        version: '1.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.18'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.76.0
+        version: '1.11'
 - !ruby/object:Gem::Dependency
   name: rubocop-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.11'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.36.0
+        version: '2.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.36.0
+        version: '2.4'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -183,6 +198,7 @@ description:
 email:
 - howeszy@gmail.com
 - dmurph24@gmail.com
+- cliffcampbell@hey.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -205,6 +221,7 @@ files:
 - 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/configuration/lazy_jsonapi_serializer.rb
 - lib/sn_foil/controller/api.rb
 - lib/sn_foil/controller/base.rb
 - lib/sn_foil/controller/concerns/change_controller_concern.rb
@@ -221,7 +238,7 @@ files:
 - lib/sn_foil/rails/version.rb
 - lib/sn_foil/searcher.rb
 - lib/snfoil-rails.rb
-homepage: https://github.com/howeszy/snfoil-rails
+homepage: https://github.com/limited-effort/snfoil-rails
 licenses:
 - MIT
 metadata: {}
@@ -233,14 +250,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Additional functionality gem for using SnFoil with Rails