snfoil-rails 0.8.0 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b91f3f4a14656e627fe9b82d091c81e1fff178536da8866993f548734dda1738
-  data.tar.gz: cf0ffd14498657a1b8611ad71f4c0d07d1d888e72d595660734ca5cba598e169
+  metadata.gz: 3d00195925208a499c8ddc53cd7237ad12bf835fb2f8919e8a367d6c42ea0e51
+  data.tar.gz: 8589deefc725c97dd946126aba442ff0b5f0f1a20b769245ddc3c43c9b0c14df
 SHA512:
-  metadata.gz: 86c3cfef031f22074928729d25bc07b856f635463758b9f66a2582c540896e02312234146d784f4d5bd5bdaaec854c671dfa097372468372e1bcc46a55687def
-  data.tar.gz: 61a52228ccc3a4dba8941a8a01a85ce939fb1885cd65ce8c1cc108dd893d1e5103da52f1aef4cabef5e7432a97e421b41eeff63b40d6242a5f4f7b519ed6eda8
+  metadata.gz: d32a067a6eba8e506678483b3249df6b0297667edac1fe5764dac986978212d4840456d97cf44e3cefff0d6b5388bfbce88819a226b1980f0fad67532cadd004
+  data.tar.gz: 529206939a96babfc648c6cc88528272e8035a21283d033cc9a90565b4dde9e198dddcbcc051615ebe826afbf55c554ba396687c9250cca589ea9bc9733dee0d

data/README.md

@@ -1,4 +1,4 @@
-# Sn::Foil::Rails
+# SnFoil::Rails
 Short description and motivation.
 
 ## Usage

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/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/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/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.1'
   end
 end

data/lib/sn_foil/searcher.rb

@@ -18,8 +18,8 @@ module SnFoil
         end
       end
 
-      ASC ||= 'ASC'
-      DESC ||= 'DESC'
+      ASC = 'ASC'
+      DESC = 'DESC'
     end
 
     class_methods do
@@ -35,7 +35,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
 

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: snfoil-rails
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.1
 platform: ruby
 authors:
 - Matthew Howes
 - Danny Murphy
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-08 00:00:00.000000000 Z
+date: 2021-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -129,42 +129,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.76.0
+        version: '1.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.76.0
+        version: '1.14'
 - !ruby/object:Gem::Dependency
   name: rubocop-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.10'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.36.0
+        version: '2.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.36.0
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -179,7 +179,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - howeszy@gmail.com
 - dmurph24@gmail.com
@@ -205,6 +205,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,11 +222,11 @@ 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: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -233,7 +234,7 @@ 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:
   - - ">="
@@ -241,7 +242,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.4
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Additional functionality gem for using SnFoil with Rails
 test_files: []