eager_group 0.8.1 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88912c5696afe9332d53ac15b2365d2e2d7112391672a2cba5db62012876a138
-  data.tar.gz: a18a2d21cd4299a68774f3dbb62556c71f3096b3ebac28bebf7a767a875fc00f
+  metadata.gz: c8bad88cf4f0de57942e0477ee107ce8f40eeeded25b37def08ef560907ef143
+  data.tar.gz: f14470d5456dbce04be8fac648623fbc0e1dbb25a3e89af5ebe7bde9dd6a61d5
 SHA512:
-  metadata.gz: af269ea9b3be9f9a613f56cf14e52a7b183b6d041583f02aa88945f65150f98147ed7271523b9f8ec0d36c622f42ae257f7137e9cf842b381f11cbd7cd6e50bf
-  data.tar.gz: 2878aaefb0b9420b13531927cd46ad47894954c2999fe81d9bf853d7f2255ae97b42df8e56c43a840b5812d71ed1f535c391ccf605fbed99f08ed0769959eab8
+  metadata.gz: 6e026cf0d9f8a9839b498b995ba7d48ab24afe2dc48f3e7d41cba16069ac4bc9b3c15d202e7b9730859aa81f24c8cb77a9e2bc8572e720a58457cc7f89f171a0
+  data.tar.gz: 0033033e6b427479d0a49c2e2e1b1149f40a63a46f12aa42aa49f54fb91b27f84ee045aa96014c37b745fbad9b5ca84fab20b014ef521e478cbce058f681f803

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.0 (12/04/2022)
+
+* Support `has_many`  through `belongs_to`
+
+## 0.8.2 (09/22/2022)
+
+* Add MIT-LICENSE
+
 ## 0.8.1 (10/25/2019)
 
 * Fix for `has_many :through`

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2015 - 2022 Richard Huang (flyerhzm@gmail.com)
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

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,13 @@ module ActiveRecord
     end
 
     def eager_group(*args)
-      check_if_method_has_arguments!('eager_group', args)
+      check_if_method_has_arguments!(__callee__, args)
+
       spawn.eager_group!(*args)
     end
 
     def eager_group!(*args)
-      self.eager_group_values += args
+      self.eager_group_values |= args
       self
     end
 

data/lib/eager_group/preloader/aggregation_finder.rb

@@ -0,0 +1,35 @@
+# 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
+
+      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,15 +2,21 @@
 
 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
-      @eager_group_values = eager_group_values
+      eager_group_definitions = @klass.eager_group_definitions
+      @eager_group_values = eager_group_values.all? { |value| eager_group_definitions.key?(value) } ? eager_group_values : [eager_group_values]
     end
 
     # 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]
@@ -22,35 +28,44 @@ module EagerGroup
 
           @klass = @records.first.class
         end
-        record_ids = @records.map { |record| record.send(primary_key) }
-        unless definition = @klass.eager_group_definitions[definition_key]
-          next
-        end
 
-        reflection = @klass.reflect_on_association(definition.association)
-        association_class = reflection.klass
-        association_class = association_class.instance_exec(*arguments, &definition.scope) if definition.scope
-
-        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]] }
+        Array.wrap(definition_key).each do |key|
+          find_aggregate_values_per_definition!(key, arguments)
         end
-        @records.each do |record|
-          id = record.send(primary_key)
-          record.send("#{definition_key}=", aggregate_hash[id] || definition.default_value)
+      end
+    end
+
+    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.1'
+  VERSION = '0.9.0'
 end

data/lib/eager_group.rb

@@ -40,7 +40,7 @@ module EagerGroup
   private
 
   def preload_eager_group(*eager_group_value)
-    EagerGroup::Preloader.new(self.class, [self], [eager_group_value]).run
+    EagerGroup::Preloader.new(self.class, [self], eager_group_value).run
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eager_group
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.9.0
 platform: ruby
 authors:
 - Richard Huang
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-10-25 00:00:00.000000000 Z
+date: 2022-12-04 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,11 +143,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/main.yml"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile
+- MIT-LICENSE
 - README.md
 - Rakefile
 - benchmark.rb
@@ -144,12 +160,17 @@ 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:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -164,8 +185,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.3.26
+signing_key:
 specification_version: 4
 summary: Fix n+1 aggregate sql functions
 test_files: []