eager_group 0.8.2 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5370e57578e725513b391777f1a86e3b1d7560bc596a08b005110d3220d43325
-  data.tar.gz: b4987065f8781190983f2b92a84db5ea7e248f43290763ba483d52ec472cb1e8
+  metadata.gz: 119ff48ee90c0324a8e7f55e521a3606485ad1728ec27eaefea3df1f7c153173
+  data.tar.gz: 7415661b2a4ced20c7673c8d90bfb977fbef22c203062f0bb60a8be5fdd1970a
 SHA512:
-  metadata.gz: 172290ed5e79c34139cdc35976f22e612e225e39f6b417f07f86696970f28969f058c59189e683d9ca299d5d61643dbdbf8220648889f7e4bbcb66cb30f68d7e
-  data.tar.gz: 91577037162ebb062b8939c02fc2aa66e4fdf1e891fb6e20ffd199d7e80879c38f20ae4fc4cc95ae32c7f16ab90377816ed42dc215dd0cd92fad9ce01f9450ea
+  metadata.gz: f3b85835d577315809f1a699c7a717d17b1f61c14ae0e0371312c12615a5088c45a266028fc3f091801639298e9dd6a1ca1e8d6beb37889a6f5e63aacbdc8fe6
+  data.tar.gz: 2475f41755b2b0161bcc4fe01fd04a5cb1b9f69728edd0e165e8596773306e421426efc191aa34eba812912c1e6b8cc608386a3fc29ca490a068c15b2335e337

data/.github/workflows/main.yml

@@ -0,0 +1,18 @@
+name: test
+on:
+  push:
+    branches:
+      - main
+jobs:
+  test:
+    name: test
+    runs-on: ubuntu-latest
+    steps:
+     - uses: actions/checkout@v2
+     - name: Set up Ruby
+       uses: ruby/setup-ruby@v1
+       with:
+         ruby-version: 3.1
+         bundler-cache: true
+     - name: Run tests
+       run: bundle exec rspec

data/.gitignore

@@ -7,3 +7,5 @@
 /pkg/
 /spec/reports/
 /tmp/
+.idea
+.tool-versions

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Next Release
 
+## 0.9.1 (12/15/2022)
+
+* Fix eager group fetch multi definitions
+
+## 0.9.0 (12/04/2022)
+
+* Support `has_many`  through `belongs_to`
+
 ## 0.8.2 (09/22/2022)
 
 * Add MIT-LICENSE

data/eager_group.gemspec

@@ -29,4 +29,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.3'
   spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency 'pry'
 end

data/lib/active_record/with_eager_group.rb

@@ -9,12 +9,16 @@ module ActiveRecord
     end
 
     def eager_group(*args)
-      check_if_method_has_arguments!('eager_group', args)
+      # we does not use the `check_if_method_has_arguments!` here because it would flatten all the arguments,
+      # which would cause `[:eager_group_definition, scope_arg1, scope_arg2]` not able to preload together with other `eager_group_definitions`.
+      # e.g. `Post.eager_group(:approved_comments_count, [:comments_average_rating_by_author, students[0], true])`
+      check_argument_not_blank!(args)
+
       spawn.eager_group!(*args)
     end
 
     def eager_group!(*args)
-      self.eager_group_values += args
+      self.eager_group_values |= args
       self
     end
 
@@ -27,5 +31,12 @@ module ActiveRecord
 
       @values[:eager_group] = values
     end
+
+    private
+
+    def check_argument_not_blank!(args)
+      raise ArgumentError, "The method .eager_group() must contain arguments." if args.blank?
+      args.compact_blank!
+    end
   end
 end

data/lib/eager_group/preloader/aggregation_finder.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module EagerGroup
+  class Preloader
+    class AggregationFinder
+      attr_reader :klass, :reflection, :definition, :arguments, :record_ids
+
+      def initialize(klass, definition, arguments, records)
+        @klass = klass
+        @definition = definition
+        @reflection = @klass.reflect_on_association(definition.association)
+        @arguments = arguments
+        @records = records
+      end
+
+      def definition_scope
+        reflection.klass.instance_exec(*arguments, &definition.scope) if definition.scope
+      end
+
+      def record_ids
+        @record_ids ||= @records.map { |record| record.send(group_by_key) }
+      end
+
+      def group_by_key
+        @klass.primary_key
+      end
+
+      def aggregate_hash
+        raise NotImplementedError, 'Method "aggregate_hash" must be implemented in subclass'
+      end
+
+      private
+
+      def polymophic_as_condition
+        reflection.type ? { reflection.name => { reflection.type => @klass.base_class.name } } : []
+      end
+    end
+  end
+end

data/lib/eager_group/preloader/has_many.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module EagerGroup
+  class Preloader
+    class HasMany < AggregationFinder
+      def group_by_foreign_key
+        reflection.foreign_key
+      end
+
+      def aggregate_hash
+        scope = reflection.klass.all.tap{|query| query.merge!(definition_scope) if definition_scope }
+
+        scope.where(group_by_foreign_key => record_ids).
+          where(polymophic_as_condition).
+          group(group_by_foreign_key).
+          send(definition.aggregation_function, definition.column_name)
+      end
+    end
+  end
+end

data/lib/eager_group/preloader/has_many_through_belongs_to.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module EagerGroup
+  class Preloader
+    class HasManyThroughBelongsTo < AggregationFinder
+      def group_by_foreign_key
+        "#{reflection.table_name}.#{reflection.through_reflection.klass.reflect_on_association(reflection.name).foreign_key}"
+      end
+
+      def aggregate_hash
+        scope = reflection.klass.all.tap{|query| query.merge!(definition_scope) if definition_scope }
+
+        scope.where(group_by_foreign_key => record_ids).
+          where(polymophic_as_condition).
+          group(group_by_foreign_key).
+          send(definition.aggregation_function, definition.column_name)
+      end
+
+      def group_by_key
+        reflection.through_reflection.foreign_key
+      end
+
+      def polymophic_as_condition
+        reflection.type ? { reflection.name => { reflection.type => reflection.through_reflection.klass.base_class.name } } : []
+      end
+    end
+  end
+end

data/lib/eager_group/preloader/has_many_through_many.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module EagerGroup
+  class Preloader
+    class HasManyThroughMany < AggregationFinder
+      def group_by_foreign_key
+        "#{reflection.through_reflection.name}.#{reflection.through_reflection.foreign_key}"
+      end
+
+      def aggregate_hash
+        scope = klass.joins(reflection.name).tap{|query| query.merge!(definition_scope) if definition_scope }
+
+        scope.where(group_by_foreign_key => record_ids).
+          where(polymophic_as_condition).
+          group(group_by_foreign_key).
+          send(definition.aggregation_function, definition.column_name)
+      end
+    end
+  end
+end

data/lib/eager_group/preloader/many_to_many.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module EagerGroup
+  class Preloader
+    class ManyToMany < AggregationFinder
+      def group_by_foreign_key
+        "#{reflection.join_table}.#{reflection.foreign_key}"
+      end
+
+      def aggregate_hash
+        scope = klass.joins(reflection.name).tap{|query| query.merge!(definition_scope) if definition_scope}
+
+        scope.where(group_by_foreign_key => record_ids).
+          where(polymophic_as_condition).
+          group(group_by_foreign_key).
+          send(definition.aggregation_function, definition.column_name)
+      end
+    end
+  end
+end

data/lib/eager_group/preloader.rb

@@ -2,6 +2,12 @@
 
 module EagerGroup
   class Preloader
+    autoload :AggregationFinder, 'eager_group/preloader/aggregation_finder'
+    autoload :HasMany, 'eager_group/preloader/has_many'
+    autoload :HasManyThroughBelongsTo, 'eager_group/preloader/has_many_through_belongs_to'
+    autoload :HasManyThroughMany, 'eager_group/preloader/has_many_through_many'
+    autoload :ManyToMany, 'eager_group/preloader/many_to_many'
+
     def initialize(klass, records, eager_group_values)
       @klass = klass
       @records = Array.wrap(records).compact.uniq
@@ -10,7 +16,6 @@ module EagerGroup
 
     # Preload aggregate functions
     def run
-      primary_key = @klass.primary_key
       @eager_group_values.each do |eager_group_value|
         definition_key, arguments =
           eager_group_value.is_a?(Array) ? [eager_group_value.shift, eager_group_value] : [eager_group_value, nil]
@@ -21,38 +26,44 @@ module EagerGroup
           next if @records.empty?
 
           @klass = @records.first.class
-        end
-        record_ids = @records.map { |record| record.send(primary_key) }
-        unless definition = @klass.eager_group_definitions[definition_key]
-          next
+          self.class.new(@klass, @records, Array.wrap(definition_key)).run
         end
 
-        reflection = @klass.reflect_on_association(definition.association)
-        association_class = reflection.klass
-        association_class = association_class.instance_exec(*arguments, &definition.scope) if definition.scope
+        find_aggregate_values_per_definition!(definition_key, arguments)
+      end
+    end
 
-        foreign_key, aggregate_hash =
-          if reflection.is_a?(ActiveRecord::Reflection::HasAndBelongsToManyReflection)
-            ["#{reflection.join_table}.#{reflection.foreign_key}", @klass.joins(reflection.name)]
-          elsif reflection.through_reflection
-            [
-              "#{reflection.through_reflection.name}.#{reflection.through_reflection.foreign_key}",
-              @klass.joins(reflection.name)
-            ]
-          else
-            [reflection.foreign_key, association_class]
-          end
-        aggregate_hash =
-          aggregate_hash.where(foreign_key => record_ids).where(polymophic_as_condition(reflection)).group(foreign_key)
-            .send(definition.aggregation_function, definition.column_name)
-        if definition.need_load_object
-          aggregate_objects = reflection.klass.find(aggregate_hash.values).each_with_object({}) { |o, h| h[o.id] = o }
-          aggregate_hash.keys.each { |key| aggregate_hash[key] = aggregate_objects[aggregate_hash[key]] }
-        end
-        @records.each do |record|
-          id = record.send(primary_key)
-          record.send("#{definition_key}=", aggregate_hash[id] || definition.default_value)
+    def find_aggregate_values_per_definition!(definition_key, arguments)
+      unless definition = @klass.eager_group_definitions[definition_key]
+        return
+      end
+
+      reflection = @klass.reflect_on_association(definition.association)
+      return if reflection.blank?
+
+      aggregation_finder_class = if reflection.is_a?(ActiveRecord::Reflection::HasAndBelongsToManyReflection)
+        ManyToMany
+      elsif reflection.through_reflection
+        if reflection.through_reflection.is_a?(ActiveRecord::Reflection::BelongsToReflection)
+          HasManyThroughBelongsTo
+        else
+          HasManyThroughMany
         end
+      else
+        HasMany
+      end
+
+      aggregation_finder = aggregation_finder_class.new(@klass, definition, arguments, @records)
+      aggregate_hash = aggregation_finder.aggregate_hash
+
+      if definition.need_load_object
+        aggregate_objects = reflection.klass.find(aggregate_hash.values).each_with_object({}) { |o, h| h[o.id] = o }
+        aggregate_hash.keys.each { |key| aggregate_hash[key] = aggregate_objects[aggregate_hash[key]] }
+      end
+
+      @records.each do |record|
+        id = record.send(aggregation_finder.group_by_key)
+        record.send("#{definition_key}=", aggregate_hash[id] || definition.default_value)
       end
     end
 

data/lib/eager_group/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module EagerGroup
-  VERSION = '0.8.2'
+  VERSION = '0.9.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eager_group
 version: !ruby/object:Gem::Version
-  version: 0.8.2
+  version: 0.9.1
 platform: ruby
 authors:
 - Richard Huang
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-09-22 00:00:00.000000000 Z
+date: 2022-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -122,6 +122,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Fix n+1 aggregate sql functions for rails
 email:
 - flyerhzm@gmail.com
@@ -129,6 +143,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/main.yml"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -145,6 +160,11 @@ files:
 - lib/eager_group.rb
 - lib/eager_group/definition.rb
 - lib/eager_group/preloader.rb
+- lib/eager_group/preloader/aggregation_finder.rb
+- lib/eager_group/preloader/has_many.rb
+- lib/eager_group/preloader/has_many_through_belongs_to.rb
+- lib/eager_group/preloader/has_many_through_many.rb
+- lib/eager_group/preloader/many_to_many.rb
 - lib/eager_group/version.rb
 homepage: https://github.com/flyerhzm/eager_group
 licenses:
@@ -165,7 +185,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
 summary: Fix n+1 aggregate sql functions