deep_preloader 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 92fe99d9c1c0a4b426c9827491057c3604e5b511c61c749701de5c65da7d4825
-  data.tar.gz: efab30b69e968a8a6f45e000da724189808a91dfedb6279930daeb0058ab3557
+  metadata.gz: 2905039099c3093587202144bffb2241e17c0f524a7e5b391f94f6526e08b1b3
+  data.tar.gz: 03d23e36bbed2e1f6070d7afde2ee27764c8317e4ea28d4e4f5ef624c789d4b4
 SHA512:
-  metadata.gz: 4fed23d8d1df1c47f8665298594adf7741243551f207462eabd74e64e86ead26a977ec39df17d791c0c88f09b22e1958d6120b65820c14b51b313b0cc29e0d7c
-  data.tar.gz: a94f34a7290e83b7f26cbbcdba8ad51445bfd9f1474e2d9ba8f01449196b51a8e44789c8d81114c91a7e647af194331002fe1a1e48c9dedcfab1999ef9fdfc16
+  metadata.gz: 6cab0b0b8ac3c49d1610cd1915198fd784bdb29023d4d88f3401b75d35fe673efaa1c4578ca9e4ed74dab3bc234b78ba0c193e446f894c17ba1ec42fd3e44847
+  data.tar.gz: 8793d51feefa4dea2e3c8ab3f31d5756776b5b44a8edfc856c1d961f9ac46463ff8037cda4c7aec4742f6a3f56ae85c5f0c17ff8410c79b92a74b6fb012a4334

data/.circleci/config.yml

@@ -83,18 +83,18 @@ workflows:
   version: 2.1
   build:
     jobs:
-      - test:
-          name: 'ruby 2.5 ActiveRecord 5.2'
-          ruby-version: "2.5"
-          gemfile: gemfiles/activerecord_5_2.gemfile
       - test:
           name: 'ruby 2.6 ActiveRecord 5.2'
           ruby-version: "2.6"
           gemfile: gemfiles/activerecord_5_2.gemfile
       - test:
-          name: 'ruby 2.6 ActiveRecord 6.0-beta'
-          ruby-version: "2.6"
-          gemfile: gemfiles/activerecord_6_0_beta.gemfile
+          name: 'ruby 2.7 ActiveRecord 5.2'
+          ruby-version: "2.7"
+          gemfile: gemfiles/activerecord_5_2.gemfile
+      - test:
+          name: 'ruby 3.0 ActiveRecord 6.1'
+          ruby-version: "3.0"
+          gemfile: gemfiles/activerecord_6_1.gemfile
       - publish:
           filters:
             branches:

data/.gitignore

@@ -8,3 +8,4 @@
 /spec/reports/
 /tmp/
 gemfiles/*.gemfile.lock
+/nix/gem

data/gemfiles/{activerecord_6_0_beta.gemfile → activerecord_6_1.gemfile}

@@ -3,6 +3,6 @@
 source "https://rubygems.org"
 
 gem "rspec_junit_formatter"
-gem "activerecord", "~> 6.0.0.beta"
+gem "activerecord", "~> 6.1.0"
 
 gemspec path: "../"

data/lib/deep_preloader.rb

@@ -12,23 +12,7 @@ class DeepPreloader
     worker = PreloadWorker.new(lock: lock)
     spec = Spec.parse(spec) unless spec.is_a?(AbstractSpec)
 
-    models_by_class = Array.wrap(models).group_by(&:class)
-
-    case spec
-    when Spec
-      unless models_by_class.size == 1
-        raise ArgumentError.new("Provided multiple model types to non-polymorphic preload spec")
-      end
-
-      model_class, models = models_by_class.first
-      worker.add_associations_from_spec(models, model_class, spec)
-    when PolymorphicSpec
-      models_by_class.each do |model_class, models|
-        model_spec = spec.for_type(model_class)
-        next unless model_spec
-        worker.add_associations_from_spec(models, model_class, model_spec)
-      end
-    end
+    worker.add_associations_from_spec(models, spec)
 
     worker.run!
     models
@@ -40,23 +24,49 @@ class DeepPreloader
       @worklist = {}
     end
 
-    def add_associations_from_spec(models, model_class, spec)
-      spec.association_specs.each do |association_name, child_spec|
-        association_reflection = model_class.reflect_on_association(association_name)
-        if association_reflection.nil?
-          raise ArgumentError.new("Preloading error: couldn't find association #{association_name} on model class #{model_class.name}")
+    def add_associations_from_spec(models, spec)
+      models = Array.wrap(models)
+
+      # A polymorphic spec expects models of several types, and defines which
+      # associations to preload for each of them.
+      if spec.polymorphic?
+        # We expect models to be of different types, and to have different subspecs for each.
+        models_by_class = models.group_by(&:class)
+
+        models_by_class.each do |model_class, class_models|
+          model_spec = spec.for_type(model_class)
+          next unless model_spec
+
+          add_associations_from_spec(class_models, model_spec)
         end
+      else
+        # A non-polymorphic spec implies that the models are all of the same type
+        model_class = models.first.class
 
-        if association_reflection.polymorphic?
-          add_polymorphic_association(models, association_reflection, child_spec)
-        else
-          add_association(models, association_reflection, child_spec)
+        unless models.all? { |m| m.is_a?(model_class) }
+          raise ArgumentError.new('Provided multiple model types to a non-polymorphic preload spec')
+        end
+
+        spec.association_specs.each do |association_name, child_spec|
+          association_reflection = model_class.reflect_on_association(association_name)
+          if association_reflection.nil?
+            raise ArgumentError.new("Preloading error: couldn't find association #{association_name} on model class #{model_class.name}")
+          end
+
+          # A polymorphic association links to many different model types
+          # (discriminated in the referrer), so must be loaded separately per
+          # target model type.
+          if association_reflection.polymorphic?
+            add_polymorphic_association(models, association_reflection, child_spec)
+          else
+            add_association(models, association_reflection, child_spec)
+          end
         end
       end
     end
 
     def run!
-      while(@worklist.present?)
+      while @worklist.present?
         context, entries = @worklist.shift
         ActiveRecord::Base.logger&.debug("Preloading children in context #{context}") if DEBUG
 
@@ -96,12 +106,10 @@ class DeepPreloader
           children = entry.children
           child_spec = entry.child_spec
           next unless child_spec && children.present?
-          child_class = children.first.class # children of a given parent are all of the same type
-          add_associations_from_spec(children, child_class, child_spec)
-        end
 
+          add_associations_from_spec(children, child_spec)
+        end
       end
-
     end
 
     private
@@ -242,8 +250,9 @@ class DeepPreloader
         target = targets
       else
         if targets.size > 1
-          raise RuntimeError.new("Internal preloader error: attempted to attach multiple children to a singular association")
+          raise RuntimeError.new('Internal preloader error: attempted to attach multiple children to a singular association')
         end
+
         target = targets.first
       end
 
@@ -253,7 +262,6 @@ class DeepPreloader
       association.loaded!
       association.target = target
       targets.each { |t| association.set_inverse_instance(t) }
-      targets
     end
 
     def parent_key_column
@@ -267,5 +275,4 @@ class DeepPreloader
       end
     end
   end
-
 end

data/lib/deep_preloader/abstract_spec.rb

@@ -2,4 +2,8 @@ class DeepPreloader::AbstractSpec
   def for_type(clazz)
     raise ArgumentError.new("Cannot type dispatch on non-polymorphic preload spec #{self.inspect}")
   end
+
+  def polymorphic?
+    false
+  end
 end

data/lib/deep_preloader/polymorphic_spec.rb

@@ -18,6 +18,10 @@ class DeepPreloader::PolymorphicSpec < DeepPreloader::AbstractSpec
     @specs_by_type = specs_by_type
   end
 
+  def polymorphic?
+    true
+  end
+
   def for_type(clazz)
     specs_by_type[clazz.name]
   end

data/lib/deep_preloader/version.rb

@@ -1,3 +1,3 @@
 class DeepPreloader
-  VERSION = '1.0.1'
+  VERSION = '1.0.2'
 end

data/nix/generate.rb

@@ -0,0 +1,42 @@
+#! /usr/bin/env nix-shell
+#! nix-shell -i ruby -p ruby -p bundler -p bundix
+# frozen_string_literal: true
+
+# Bundix doesn't support `gemspec` directive in Gemfiles, as it doesn't copy the
+# gemspec (and its dependencies) into the store.
+# This workaround is from https://github.com/manveru/bundix/issues/10#issuecomment-405879379
+
+require 'shellwords'
+require 'uri'
+
+def sh(*args)
+  warn args.shelljoin
+  system(*args) || raise
+end
+
+sh 'bundle', 'lock'
+
+require 'fileutils'
+require 'bundler'
+
+lockfile = Bundler::LockfileParser.new(File.read('Gemfile.lock'))
+gems = lockfile.specs.select { |spec| spec.source.is_a?(Bundler::Source::Rubygems) }
+sources = [URI('https://rubygems.org/')] | gems.map(&:source).flat_map(&:remotes)
+
+FileUtils.mkdir_p 'nix/gem'
+Dir.chdir 'nix/gem' do
+  ['Gemfile', 'Gemfile.lock', 'gemset.nix'].each do |f|
+    File.delete(f) if File.exist?(f)
+  end
+
+  File.open('Gemfile', 'w') do |gemfile|
+    sources.each { |source| gemfile.puts "source #{source.to_s.inspect}" }
+    gemfile.puts
+
+    gems.each do |gem|
+      gemfile.puts "gem #{gem.name.inspect}, #{gem.version.to_s.inspect}"
+    end
+  end
+
+  sh 'bundix', '-l'
+end

data/shell.nix

@@ -0,0 +1,11 @@
+with (import <nixpkgs> {});
+let
+  env = bundlerEnv {
+    name = "bundler-env";
+    gemdir  = ./nix/gem;
+    ruby = ruby_3_0;
+  };
+in stdenv.mkDerivation {
+  name = "shell";
+  buildInputs = [ env ];
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: deep_preloader
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - iKnow Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-05-21 00:00:00.000000000 Z
+date: 2021-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -184,12 +184,14 @@ files:
 - bin/setup
 - deep_preloader.gemspec
 - gemfiles/activerecord_5_2.gemfile
-- gemfiles/activerecord_6_0_beta.gemfile
+- gemfiles/activerecord_6_1.gemfile
 - lib/deep_preloader.rb
 - lib/deep_preloader/abstract_spec.rb
 - lib/deep_preloader/polymorphic_spec.rb
 - lib/deep_preloader/spec.rb
 - lib/deep_preloader/version.rb
+- nix/generate.rb
+- shell.nix
 homepage: http://github.com/iknow/deep_preloader
 licenses:
 - MIT
@@ -209,7 +211,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: Explicit preloader for ActiveRecord