ams_lazy_relationships 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d299c4294fa21bc85d59919b153f88de9f78a4ed9a2f2d7f87cf98cdc8093706
-  data.tar.gz: 9a66c679744b7e8128ce492209f3743e397cb0f3d1eec93097667c7c0e142863
+  metadata.gz: cf2c7b4fd222fcde15c3f1accd9784c421455d988bf4ec6bf2c76b4029cf2718
+  data.tar.gz: 306b361e74fa64697a046c9b67d0b5dd1bdbfc930c2a77df4e443fc65bb2de6a
 SHA512:
-  metadata.gz: 2683f61c4107464423359aecb53193f6e5d9de727812916282e7eb6c3848541fc3212d4be773d288044582ef29ba7832d2558fd80e60fed0af2ef833dc2bb858
-  data.tar.gz: c9c777b5d1d56ad21289db010206cc20aa61225eacd9041a29f68745942e72696bee19acfef86eca4d08dba34152ff3e6ba3a1d0833296a0759c91e6203583f2
+  metadata.gz: 36ed2e0404138db614928261d8dfd771b185fa9fd62dc6e091e5ee037b05bf3fec3d6a0e20fdd254ac100ffbbcc2ee175c9e16296d0a2120fa47968f2c15ef5d
+  data.tar.gz: 0eac844f0f061f4e9769cea6835de6eebc75415d3fefc5aff82c2b838bef9c22609188d24ba8bd2b33851e0ce2c0fc8e19fef4ebc00f92e217e980394529fd3d

data/.travis.yml

@@ -6,8 +6,11 @@ env:
 language: ruby
 gemfile:
   - gemfiles/ams_0.10.0.rc4.gemfile
+  - gemfiles/ams_0.10.0.gemfile
   - gemfiles/ams_0.10.2.gemfile
+  - gemfiles/ams_0.10.3.gemfile
   - gemfiles/ams_0.10.8.gemfile
+  - gemfiles/ams_0.10.10.gemfile
 cache: bundler
 rvm:
   - 2.5.3

data/Appraisals

@@ -2,10 +2,22 @@ appraise "ams-0.10.0.rc4" do
   gem "active_model_serializers", "0.10.0.rc4"
 end
 
+appraise "ams-0.10.0" do
+  gem "active_model_serializers", "0.10.0"
+end
+
 appraise "ams-0.10.2" do
   gem "active_model_serializers", "0.10.2"
 end
 
+appraise "ams-0.10.3" do
+  gem "active_model_serializers", "0.10.3"
+end
+
 appraise "ams-0.10.8" do
   gem "active_model_serializers", "0.10.8"
 end
+
+appraise "ams-0.10.10" do
+  gem "active_model_serializers", "0.10.10"
+end

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Change Log
 
+## [v0.3.0](https://github.com/Bajena/ams_lazy_relationships/tree/v0.3.0) (2020-01-16)
+[Full Changelog](https://github.com/Bajena/ams_lazy_relationships/compare/v0.2.0...v0.3.0)
+
+**Merged pull requests:**
+
+- Fix association duplicates after accepts\_nested\_attributes\_for assignation [\#50](https://github.com/Bajena/ams_lazy_relationships/pull/50) ([stokarenko](https://github.com/stokarenko))
+- Skip active\_support as redundant dependency [\#49](https://github.com/Bajena/ams_lazy_relationships/pull/49) ([stokarenko](https://github.com/stokarenko))
+- Test against AMS v0.10.0.rc4 [\#48](https://github.com/Bajena/ams_lazy_relationships/pull/48) ([stokarenko](https://github.com/stokarenko))
+- Skip redundant queries when include\_data is disabled [\#47](https://github.com/Bajena/ams_lazy_relationships/pull/47) ([stokarenko](https://github.com/stokarenko))
+- Adjust tested ams version [\#46](https://github.com/Bajena/ams_lazy_relationships/pull/46) ([stokarenko](https://github.com/stokarenko))
+- Fix documentation for blocked relationships [\#45](https://github.com/Bajena/ams_lazy_relationships/pull/45) ([stokarenko](https://github.com/stokarenko))
+
 ## [v0.2.0](https://github.com/Bajena/ams_lazy_relationships/tree/v0.2.0) (2020-01-11)
 [Full Changelog](https://github.com/Bajena/ams_lazy_relationships/compare/v0.1.5...v0.2.0)
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ams_lazy_relationships (0.2.0)
+    ams_lazy_relationships (0.3.0)
       active_model_serializers
       batch-loader (~> 1)
 

data/README.md

@@ -63,8 +63,10 @@ class UserSerializer < BaseSerializer
   
   # The previous one is a shorthand for the following lines:
   lazy_relationship :blog_posts, loader: AmsLazyRelationships::Loaders::Association.new("User", :blog_posts)
-  has_many :blog_posts, serializer: BlogPostSerializer do
-    lazy_blog_posts
+  has_many :blog_posts, serializer: BlogPostSerializer do |serializer|
+    # non-proc custom finder will work as well, but it can produce redundant sql
+    # queries, please see [Example 2: Modifying the relationship before rendering](#example-2-modifying-the-relationship-before-rendering)
+    -> { serializer.lazy_blog_posts }
   end
    
   lazy_has_one :poro_model, loader: AmsLazyRelationships::Loaders::Direct.new(:poro_model) { |object| PoroModel.new(object) }
@@ -116,10 +118,43 @@ end
 #### Example 2: Modifying the relationship before rendering
 Sometimes it may happen that you need to process the relationship before rendering, e.g. decorate the records. In this case the gem provides a special method (in our case `lazy_comments`) for each defined relationship. Check out the example - we'll decorate every comment before serializing:
 
+```ruby
+class BlogPostSerializer < BaseSerializer
+  lazy_has_many :comments do |serializer|
+    -> { serializer.lazy_comments.map(&:decorate) }
+   end
+end
+```
+
+Despite the fact that non-block custom finder such as
+
+```ruby
+class BlogPostSerializer < BaseSerializer
+  lazy_has_many :comments do |serializer|
+    serializer.lazy_comments.map(&:decorate)
+   end
+end
+```
+
+will work still, it's better to implement it in a form of lambda, in order to avoid redundant SQL queries when `include_data` AMS setting appears to be `false`:
+
+```ruby
+class BlogPostSerializer < BaseSerializer
+  lazy_has_many :comments do |serializer|
+    include_data :if_sideloaded
+    -> { serializer.lazy_comments.map(&:decorate) }
+   end
+end
+```
+
+Feel free to skip custom lazy finder for association if your goal is just to define `include_data` setting and/or to specify some links and metas:
+
 ```ruby
 class BlogPostSerializer < BaseSerializer
   lazy_has_many :comments do
-    lazy_comments.map(&:decorate)
+    include_data :if_sideloaded
+    link :self, 'a link'
+    meta name: 'Dan Brown'
    end
 end
 ```

data/gemfiles/ams_0.10.0.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "active_model_serializers", "0.10.0"
+
+gemspec path: "../"

data/gemfiles/ams_0.10.10.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "active_model_serializers", "0.10.10"
+
+gemspec path: "../"

data/gemfiles/ams_0.10.3.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "active_model_serializers", "0.10.3"
+
+gemspec path: "../"

data/lib/ams_lazy_relationships.rb

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
 
 require "batch-loader"
+require "active_model_serializers"
 
 require "ams_lazy_relationships/version"
+require "ams_lazy_relationships/extensions"
 require "ams_lazy_relationships/loaders"
 require "ams_lazy_relationships/core"
 

data/lib/ams_lazy_relationships/core/relationship_wrapper_methods.rb

@@ -19,7 +19,7 @@ module AmsLazyRelationships::Core
         define_singleton_method(
           "lazy_#{relationship_type}"
         ) do |relationship_name, options = {}, &block|
-          send(:define_lazy_association, relationship_type, relationship_name, options, block)
+          define_lazy_association(relationship_type, relationship_name, options, block)
         end
       end
     end
@@ -29,11 +29,20 @@ module AmsLazyRelationships::Core
 
       real_relationship_options = options.except(*lazy_relationship_option_keys)
 
-      block ||= lambda do |serializer|
-        serializer.public_send("lazy_#{name}")
-      end
+      public_send(type, name.to_sym, real_relationship_options) do |serializer|
+        block_value = instance_exec(serializer, &block) if block
 
-      public_send(type, name.to_sym, real_relationship_options, &block)
+        if block && block_value != :nil
+          # respect the custom finder for lazy association
+          # @see https://github.com/rails-api/active_model_serializers/blob/v0.10.10/lib/active_model/serializer/reflection.rb#L165-L168
+          block_value
+        else
+          # provide default lazy association finder in a form of lambda,
+          # in order to play nice with possible `include_data` setting.
+          # @see lib/ams_lazy_relationships/extensions/reflection.rb
+          serializer.method("lazy_#{name}")
+        end
+      end
 
       lazy_relationship(name, options.slice(*lazy_relationship_option_keys))
     end

data/lib/ams_lazy_relationships/extensions.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "ams_lazy_relationships/extensions/reflection"
+
+module AmsLazyRelationships
+  module Extensions
+  end
+end

data/lib/ams_lazy_relationships/extensions/reflection.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+# There is a general problem inside AMS related to custom association finder
+# combined with `include_data` setting:
+#
+#   class BlogPostSerializer < BaseSerializer
+#     belongs_to :category do
+#       include_data :if_sideloaded
+#       object.categories.last
+#     end
+#   end
+#
+# The problem is that `belongs_to` block will be fully evaluated each time for
+# each object, and only after that AMS is able to take into account
+# `include_data` mode -
+# https://github.com/rails-api/active_model_serializers/blob/v0.10.10/lib/active_model/serializer/reflection.rb#L162-L163
+#
+#   def value(serializer, include_slice)
+#     # ...
+#     block_value = instance_exec(serializer, &block) if block
+#     return unless include_data?(include_slice)
+#     # ...
+#   end
+#
+# That causing redundant (and so huge potentially!) SQL queries and AR objects
+# allocation when `include_data` appears to be `false` but `belongs_to` block
+# defines instant (not a kind of AR::Relation) custom association finder.
+#
+# Described problem is a very specific use case for pure AMS applications.
+# The bad news is that `ams_lazy_relationships` always utilizes the
+# association block -
+# https://github.com/Bajena/ams_lazy_relationships/blob/v0.2.0/lib/ams_lazy_relationships/core/relationship_wrapper_methods.rb#L32-L36
+#
+# def define_lazy_association(type, name, options, block)
+#   #...
+#   block ||= lambda do |serializer|
+#     serializer.public_send("lazy_#{name}")
+#   end
+#
+#   public_send(type, name.to_sym, real_relationship_options, &block)
+#   #...
+# end
+#
+# This way we break `include_data` optimizations for the host application.
+#
+# In order to overcome that we are forced to monkey-patch
+# `AmsLazyRelationships::Extensions::Reflection#value` method and make it to be
+# ready for Proc returned by association block. This way we will use a kind of
+#
+#   block ||= lambda do |serializer|
+#     -> { serializer.public_send("lazy_#{name}") }
+#   end
+#
+# as association block, then AMS will evaluate it, get the value of `include_data`
+# setting, make a decision do we need to continue with that association, if so -
+# will finally evaluate the proc with lazy relationship inside it.
+
+module AmsLazyRelationships
+  module Extensions
+    module Reflection
+      def value(*)
+        case (block_value = super)
+        when Proc, Method then block_value.call
+        else block_value
+        end
+      end
+    end
+  end
+end
+
+::ActiveModel::Serializer::Reflection.prepend AmsLazyRelationships::Extensions::Reflection

data/lib/ams_lazy_relationships/loaders/association.rb

@@ -45,9 +45,19 @@ module AmsLazyRelationships
         # in a decorator and non-wrapped). In this case Associations::Preloader
         # stores duplicated records in has_many relationships for some reason.
         # Calling uniq(&:id) solves the problem.
-        records.uniq(&:id).reject do |r|
-          r.association(association_name).loaded?
-        end
+        #
+        # One more case when duplicated records appear in has_many relationships
+        # is the recent assignation to `accept_nested_attributes_for` setter.
+        # ActiveRecord will not mark the association as `loaded` but in same
+        # time will keep internal representation of the nested records created
+        # by `accept_nested_attributes_for`. Then Associations::Preloader is
+        # going to merge internal state of associated records with the same
+        # records recently stored in DB. `r.association(association_name).reset`
+        # effectively fixes that.
+        records.
+          uniq(&:id).
+          reject { |r| r.association(association_name).loaded? }.
+          each { |r| r.association(association_name).reset }
       end
     end
   end

data/lib/ams_lazy_relationships/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AmsLazyRelationships
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ams_lazy_relationships
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Jan Bajena
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-11 00:00:00.000000000 Z
+date: 2020-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active_model_serializers
@@ -300,8 +300,11 @@ files:
 - bin/console
 - bin/setup
 - gemfiles/.bundle/config
+- gemfiles/ams_0.10.0.gemfile
 - gemfiles/ams_0.10.0.rc4.gemfile
+- gemfiles/ams_0.10.10.gemfile
 - gemfiles/ams_0.10.2.gemfile
+- gemfiles/ams_0.10.3.gemfile
 - gemfiles/ams_0.10.8.gemfile
 - lib/ams_lazy_relationships.rb
 - lib/ams_lazy_relationships/core.rb
@@ -310,6 +313,8 @@ files:
 - lib/ams_lazy_relationships/core/lazy_relationship_meta.rb
 - lib/ams_lazy_relationships/core/lazy_relationship_method.rb
 - lib/ams_lazy_relationships/core/relationship_wrapper_methods.rb
+- lib/ams_lazy_relationships/extensions.rb
+- lib/ams_lazy_relationships/extensions/reflection.rb
 - lib/ams_lazy_relationships/loaders.rb
 - lib/ams_lazy_relationships/loaders/association.rb
 - lib/ams_lazy_relationships/loaders/base.rb