deep_preloader 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 92fe99d9c1c0a4b426c9827491057c3604e5b511c61c749701de5c65da7d4825
-  data.tar.gz: efab30b69e968a8a6f45e000da724189808a91dfedb6279930daeb0058ab3557
+  metadata.gz: a4d52fcac4fc5b9b0768ecb6dd0c9db5e8ddee7f0ae8d9475ca3364fceb38b9b
+  data.tar.gz: a41e279ad07e928fdb36a55c3ba33cacc0e3d4137bc09863b234f5b6ca7be256
 SHA512:
-  metadata.gz: 4fed23d8d1df1c47f8665298594adf7741243551f207462eabd74e64e86ead26a977ec39df17d791c0c88f09b22e1958d6120b65820c14b51b313b0cc29e0d7c
-  data.tar.gz: a94f34a7290e83b7f26cbbcdba8ad51445bfd9f1474e2d9ba8f01449196b51a8e44789c8d81114c91a7e647af194331002fe1a1e48c9dedcfab1999ef9fdfc16
+  metadata.gz: 400bfd0eb4d794f3d1b1074e422788a27114dfd8d606dbc8334a08c8cfb31e02e39e55bc02cd13132419238c2d09921a73f8f8ad989b40244d4504dccc3a00c7
+  data.tar.gz: 1eb00d062a73b0d5d8ae94451ee638db04f616f9c535c5154f4db855d048d16604ea129620f0f81708980933c83b845a309bc0a1eb7df1aa54ea74c8f001a9a9

data/.github/workflows/gem-push.yml

@@ -0,0 +1,31 @@
+name: Publish Ruby Gem
+
+on:
+  push:
+    branches: [ "master" ]
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby 2.7
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.7
+
+    - name: Publish to RubyGems
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem
+      env:
+        GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/.github/workflows/test.yml

@@ -0,0 +1,50 @@
+name: Run Tests
+
+on:
+  pull_request:
+    branches: "**"
+
+permissions:
+  contents: read
+  checks: write
+  pull-requests: write
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby-version: ['2.7', '3.1', '3.2']
+        include:
+          - ruby-version: '2.7'
+            bundle-gemfile: gemfiles/activerecord_5_2.gemfile
+          - ruby-version: '3.1'
+            bundle-gemfile: gemfiles/activerecord_6_1.gemfile
+          - ruby-version: '3.2'
+            bundle-gemfile: gemfiles/activerecord_7_0.gemfile
+    env: # $BUNDLE_GEMFILE must be set at the job level, so it is set for all steps
+      BUNDLE_GEMFILE: ${{ github.workspace }}/${{ matrix.bundle-gemfile }}
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rspec --profile 10 --format RspecJunitFormatter --out test_results/rspec.xml --format progress
+    - name: Upload result
+      uses: actions/upload-artifact@v3
+      if: always()
+      with:
+        name: rspec_${{ matrix.ruby-version }}.xml
+        path: test_results/rspec.xml
+    - name: Test Report
+      uses: dorny/test-reporter@v1
+      if: always()
+      with:
+        name: Rspec Tests - ${{ matrix.ruby-version }}
+        path: test_results/rspec.xml
+        reporter: java-junit

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/gemfiles/activerecord_7_0.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rspec_junit_formatter"
+gem "activerecord", "~> 7.0.0"
+
+gemspec path: "../"

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

@@ -15,7 +15,11 @@ class DeepPreloader::PolymorphicSpec < DeepPreloader::AbstractSpec
   end
 
   def initialize(specs_by_type = {})
-    @specs_by_type = specs_by_type
+    @specs_by_type = specs_by_type.transform_keys(&:to_s)
+  end
+
+  def polymorphic?
+    true
   end
 
   def for_type(clazz)

data/lib/deep_preloader/spec.rb

@@ -11,11 +11,11 @@ class DeepPreloader::Spec < DeepPreloader::AbstractSpec
       end
     when Hash
       assoc_specs = data.each_with_object({}) do |(k, v), h|
-        h[k.to_sym] = parse(v)
+        h[k.to_s] = parse(v)
       end
       self.new(assoc_specs)
     when String, Symbol
-      self.new({ data.to_sym => nil })
+      self.new({ data.to_s => nil })
     when DeepPreloader::AbstractSpec
       data
     when nil
@@ -26,7 +26,7 @@ class DeepPreloader::Spec < DeepPreloader::AbstractSpec
   end
 
   def initialize(association_specs = {})
-    @association_specs = association_specs
+    @association_specs = association_specs.transform_keys(&:to_s)
   end
 
   def merge!(other)

data/lib/deep_preloader/version.rb

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

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/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.1.0
 platform: ruby
 authors:
 - iKnow Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-05-21 00:00:00.000000000 Z
+date: 2023-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -171,7 +171,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".circleci/config.yml"
+- ".github/workflows/gem-push.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -184,12 +185,15 @@ files:
 - bin/setup
 - deep_preloader.gemspec
 - gemfiles/activerecord_5_2.gemfile
-- gemfiles/activerecord_6_0_beta.gemfile
+- gemfiles/activerecord_6_1.gemfile
+- gemfiles/activerecord_7_0.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 +213,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Explicit preloader for ActiveRecord

data/.circleci/config.yml

@@ -1,103 +0,0 @@
-version: 2.1
-
-executors:
-  ruby:
-    parameters:
-      ruby-version:
-        type: string
-        default: "2.6"
-      gemfile:
-        type: string
-        default: "Gemfile"
-    docker:
-      - image: circleci/ruby:<< parameters.ruby-version >>
-        environment:
-          BUNDLE_JOBS: 3
-          BUNDLE_RETRY: 3
-          BUNDLE_PATH: vendor/bundle
-          RAILS_ENV: test
-          BUNDLE_GEMFILE: << parameters.gemfile >>
-
-jobs:
-  test:
-    parameters:
-      ruby-version:
-        type: string
-      gemfile:
-        type: string
-    executor:
-      name: ruby
-      ruby-version: << parameters.ruby-version >>
-      gemfile: << parameters.gemfile >>
-    parallelism: 1
-    steps:
-      - checkout
-
-      - run:
-          # Remove the non-appraisal gemfile for safety: we never want to use it.
-          name: Prepare bundler
-          command: bundle -v
-
-      - run:
-          name: Compute a gemfile lock
-          command: bundle lock && cp "${BUNDLE_GEMFILE}.lock" /tmp/gem-lock
-
-      - restore_cache:
-          keys:
-            - deep_preloader-<< parameters.ruby-version >>-{{ checksum "/tmp/gem-lock" }}
-            - deep_preloader-
-
-      - run:
-          name: Bundle Install
-          command: bundle check || bundle install
-
-      - save_cache:
-          key: deep_preloader-<< parameters.ruby-version >>-{{ checksum "/tmp/gem-lock" }}
-          paths:
-            - vendor/bundle
-
-      - run:
-          name: Run rspec
-          command: bundle exec rspec --profile 10 --format RspecJunitFormatter --out test_results/rspec.xml --format progress
-
-      - store_test_results:
-          path: test_results
-
-  publish:
-    executor: ruby
-    steps:
-       - checkout
-       - run:
-           name: Setup Rubygems
-           command: |
-             mkdir ~/.gem &&
-             echo -e "---\r\n:rubygems_api_key: $RUBYGEMS_API_KEY" > ~/.gem/credentials &&
-             chmod 0600 ~/.gem/credentials
-       - run:
-           name: Publish to Rubygems
-           command: |
-             gem build deep_preloader.gemspec
-             gem push deep_preloader-*.gem
-
-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
-      - publish:
-          filters:
-            branches:
-              only: master
-            tags:
-              ignore: /.*/