eager_group 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c8bad88cf4f0de57942e0477ee107ce8f40eeeded25b37def08ef560907ef143
-  data.tar.gz: f14470d5456dbce04be8fac648623fbc0e1dbb25a3e89af5ebe7bde9dd6a61d5
+  metadata.gz: 3717871f8324a6ec0a0886745b12c17f7443398a8658bcb60ce008fa1e924df1
+  data.tar.gz: 0eccab385f9d6ec341ace42258672f663b03598ee164ef22b1b25fb7bf17779a
 SHA512:
-  metadata.gz: 6e026cf0d9f8a9839b498b995ba7d48ab24afe2dc48f3e7d41cba16069ac4bc9b3c15d202e7b9730859aa81f24c8cb77a9e2bc8572e720a58457cc7f89f171a0
-  data.tar.gz: 0033033e6b427479d0a49c2e2e1b1149f40a63a46f12aa42aa49f54fb91b27f84ee045aa96014c37b745fbad9b5ca84fab20b014ef521e478cbce058f681f803
+  metadata.gz: c1fb52a045e4f2005a78ef698ff915195e705a9729e1fb6a25275d2516c48e7f016d3249946d3a337b07b70a822f75c0ffe1f2acbb130c78a2d13df03107449b
+  data.tar.gz: 0a7393ea354afaaf1c1002c7641c3a4bd94e26b2407eea9b6cb701da243b67733c34d226711650964251aaa2f5d117db0d0e418e5702ebb4b75f59323c3b6c49

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Next Release
 
+## 0.10.0 (12/28/2022)
+
+* Add STI support, use `class_attribute` to prevent subclasses affect each other
+
+## 0.9.1 (12/15/2022)
+
+* Fix eager group fetch multi definitions
+
 ## 0.9.0 (12/04/2022)
 
 * Support `has_many`  through `belongs_to`

data/lib/active_record/with_eager_group.rb

@@ -9,7 +9,11 @@ module ActiveRecord
     end
 
     def eager_group(*args)
-      check_if_method_has_arguments!(__callee__, 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)
+      check_argument_valid!(args)
 
       spawn.eager_group!(*args)
     end
@@ -28,5 +32,38 @@ 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
+
+    def check_argument_valid!(args)
+      args.each do |eager_group_value|
+        check_eager_group_definitions_exists!(klass, eager_group_value)
+      end
+    end
+
+    def check_eager_group_definitions_exists!(klass, eager_group_value)
+      case eager_group_value
+      when Symbol, String
+        raise ArgumentError, "Unknown eager group definition :#{eager_group_value}" unless klass.eager_group_definitions.has_key?(eager_group_value)
+      when Array
+        definition_name = eager_group_value.first
+        raise ArgumentError, "Unknown eager group definition :#{definition_name}" unless klass.eager_group_definitions.has_key?(definition_name)
+      when Hash
+        eager_group_value.each do |association_name, association_eager_group_values|
+          association_klass = klass.reflect_on_association(association_name).klass
+
+          Array.wrap(association_eager_group_values).each do |association_eager_group_value|
+            check_eager_group_definitions_exists!(association_klass, association_eager_group_value)
+          end
+        end
+      else
+        raise ArgumentError, "Unknown eager_group argument :#{eager_group_value.inspect}"
+      end
+    end
   end
 end

data/lib/eager_group/preloader/aggregation_finder.rb

@@ -25,6 +25,10 @@ module EagerGroup
         @klass.primary_key
       end
 
+      def aggregate_hash
+        raise NotImplementedError, 'Method "aggregate_hash" must be implemented in subclass'
+      end
+
       private
 
       def polymophic_as_condition

data/lib/eager_group/preloader.rb

@@ -11,8 +11,7 @@ module EagerGroup
     def initialize(klass, records, eager_group_values)
       @klass = klass
       @records = Array.wrap(records).compact.uniq
-      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]
+      @eager_group_values = eager_group_values
     end
 
     # Preload aggregate functions
@@ -23,15 +22,17 @@ module EagerGroup
 
         if definition_key.is_a?(Hash)
           association_name, definition_key = *definition_key.first
+          next if @records.empty?
+          @klass = @records.first.class.reflect_on_association(association_name).klass
+
           @records = @records.flat_map { |record| record.send(association_name) }
           next if @records.empty?
 
-          @klass = @records.first.class
-        end
 
-        Array.wrap(definition_key).each do |key|
-          find_aggregate_values_per_definition!(key, arguments)
+          self.class.new(@klass, @records, Array.wrap(definition_key)).run
         end
+
+        find_aggregate_values_per_definition!(definition_key, arguments)
       end
     end
 

data/lib/eager_group/version.rb

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

data/lib/eager_group.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require 'active_support/core_ext/module/attribute_accessors'
+require 'active_support/core_ext/class/attribute'
+require 'active_support/core_ext/hash'
 require 'eager_group/version'
 
 module EagerGroup
@@ -9,30 +11,39 @@ module EagerGroup
 
   def self.included(base)
     base.extend ClassMethods
+    base.class_eval do
+      class_attribute :eager_group_definitions, instance_writer: false, default: {}.with_indifferent_access
+    end
   end
 
   module ClassMethods
-    mattr_accessor :eager_group_definitions, default: {}
+    #mattr_accessor :eager_group_definitions, default: {}
+
+    def add_eager_group_definition(ar, definition_name, definition)
+      ar.eager_group_definitions = self.eager_group_definitions.except(definition_name).merge!(definition_name => definition)
+    end
 
     # class Post
     #   define_eager_group :comments_avergage_rating, :comments, :average, :rating
     #   define_eager_group :approved_comments_count, :comments, :count, :*, -> { approved }
     # end
     def define_eager_group(attr, association, aggregate_function, column_name, scope = nil)
-      send :attr_accessor, attr
-      eager_group_definitions[attr] = Definition.new(association, aggregate_function, column_name, scope)
+      add_eager_group_definition(self, attr, Definition.new(association, aggregate_function, column_name, scope))
+      define_definition_accessor(attr)
+    end
 
-      define_method attr,
+    def define_definition_accessor(definition_name)
+      define_method definition_name,
                     lambda { |*args|
-                      query_result_cache = instance_variable_get("@#{attr}")
+                      query_result_cache = instance_variable_get("@#{definition_name}")
                       return query_result_cache if args.blank? && query_result_cache.present?
 
-                      preload_eager_group(attr, *args)
-                      instance_variable_get("@#{attr}")
+                      preload_eager_group(definition_name, *args)
+                      instance_variable_get("@#{definition_name}")
                     }
 
-      define_method "#{attr}=" do |val|
-        instance_variable_set("@#{attr}", val)
+      define_method "#{definition_name}=" do |val|
+        instance_variable_set("@#{definition_name}", val)
       end
     end
   end
@@ -40,7 +51,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.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Richard Huang
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-12-04 00:00:00.000000000 Z
+date: 2022-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -185,7 +185,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.4.1
 signing_key:
 specification_version: 4
 summary: Fix n+1 aggregate sql functions