eager_group 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 36652bc032832f5a84dc02733286cd156a3253b8c1ba3b1b9289fec7686745d7
-  data.tar.gz: da2a878d043e2a02abb5f64c6d1c679dd02fe02220ba6399f5312e1ee096f953
+  metadata.gz: 7ee556b1563f43bb0b0b19d07b47cadf828a0a06586687bb23cea618c85f4d4f
+  data.tar.gz: 67f6b99dae67ae911a02261c98d662fa465407579b4962132d7b7d024bed9816
 SHA512:
-  metadata.gz: b7b4aacb136f425da49b81bf4d34c4bb467abc940b05fb936bd364b6884a322330acdec85449008de6f64716adc461ffebcad7a4b760f58fb44187b6abd2f3ba
-  data.tar.gz: 550d2eb69a366f90227c15382e25044078731610caae901982478baef95935dd581fc3b2a3affa04c48cab92a340d84744c18aeb5cb0a865a083ea78cee7bd69
+  metadata.gz: 912675975d5fab05a06045bc387ac1c128f2c313c692fc60f5df925d04bb7d846d9d1a458cc64c6a2c6139fc77e7d7c0721bf4173c3d115922ad2ffecff047e0
+  data.tar.gz: ce554fd38a31348d7fee55472aaefcf559a88db0f33f24a516273a83d7380079594377a33ff5d625802329496fc50d8f611006dc4b2bf3fabf00eaef8d26e835

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Next Release
 
+## 0.7.0 (03/05/2018)
+
+* Add first_object and last_object aggregation
+
 ## 0.6.1 (03/05/2018)
 
 * Skip preload when association is empty

data/README.md

@@ -8,29 +8,37 @@ flyerhzm/eager_group](https://awesomecode.io/projects/e5386790-9420-4003-831a-c9
 
 Fix n+1 aggregate sql functions for rails, like
 
-    SELECT "posts".* FROM "posts";
-    SELECT COUNT(*) FROM "comments" WHERE "comments"."post_id" = 1 AND "comments"."status" = 'approved'
-    SELECT COUNT(*) FROM "comments" WHERE "comments"."post_id" = 2 AND "comments"."status" = 'approved'
-    SELECT COUNT(*) FROM "comments" WHERE "comments"."post_id" = 3 AND "comments"."status" = 'approved'
+```
+SELECT "posts".* FROM "posts";
+SELECT COUNT(*) FROM "comments" WHERE "comments"."post_id" = 1 AND "comments"."status" = 'approved'
+SELECT COUNT(*) FROM "comments" WHERE "comments"."post_id" = 2 AND "comments"."status" = 'approved'
+SELECT COUNT(*) FROM "comments" WHERE "comments"."post_id" = 3 AND "comments"."status" = 'approved'
+```
 
 =>
 
-    SELECT "posts".* FROM "posts";
-    SELECT COUNT(*) AS count_all, post_id AS post_id FROM "comments" WHERE "comments"."post_id" IN (1, 2, 3) AND "comments"."status" = 'approved' GROUP BY post_id;
+```
+SELECT "posts".* FROM "posts";
+SELECT COUNT(*) AS count_all, post_id AS post_id FROM "comments" WHERE "comments"."post_id" IN (1, 2, 3) AND "comments"."status" = 'approved' GROUP BY post_id;
+```
 
 or
 
-    SELECT "posts".* FROM "posts";
-    SELECT AVG("comments"."rating") AS avg_id FROM "comments" WHERE "comments"."post_id" = 1;
-    SELECT AVG("comments"."rating") AS avg_id FROM "comments" WHERE "comments"."post_id" = 2;
-    SELECT AVG("comments"."rating") AS avg_id FROM "comments" WHERE "comments"."post_id" = 3;
+```
+SELECT "posts".* FROM "posts";
+SELECT AVG("comments"."rating") AS avg_id FROM "comments" WHERE "comments"."post_id" = 1;
+SELECT AVG("comments"."rating") AS avg_id FROM "comments" WHERE "comments"."post_id" = 2;
+SELECT AVG("comments"."rating") AS avg_id FROM "comments" WHERE "comments"."post_id" = 3;
+```
 
 =>
 
-    SELECT "posts".* FROM "posts";
-    SELECT AVG("comments"."rating") AS average_comments_rating, post_id AS post_id FROM "comments" WHERE "comments"."post_id" IN (1, 2, 3) GROUP BY post_id;
+```
+SELECT "posts".* FROM "posts";
+SELECT AVG("comments"."rating") AS average_comments_rating, post_id AS post_id FROM "comments" WHERE "comments"."post_id" IN (1, 2, 3) GROUP BY post_id;
+```
 
-It supports Rails 4.x and Rails 5.x
+It supports Rails 4.x, Rails 5.x and Rails 6.x
 
 ## Installation
 
@@ -42,29 +50,35 @@ gem 'eager_group'
 
 And then execute:
 
-    $ bundle
+```
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install eager_group
+```
+$ gem install eager_group
+```
 
 ## Usage
 
 First you need to define what aggregate function you want to eager
 load.
 
-    class Post < ActiveRecord::Base
-      has_many :comments
+```ruby
+class Post < ActiveRecord::Base
+  has_many :comments
 
-      define_eager_group :comments_average_rating, :comments, :average, :rating
-      define_eager_group :approved_comments_count, :comments, :count, :*, -> { approved }
-    end
+  define_eager_group :comments_average_rating, :comments, :average, :rating
+  define_eager_group :approved_comments_count, :comments, :count, :*, -> { approved }
+end
 
-    class Comment < ActiveRecord::Base
-      belongs_to :post
+class Comment < ActiveRecord::Base
+  belongs_to :post
 
-      scope :approved, -> { where(status: 'approved') }
-    end
+  scope :approved, -> { where(status: 'approved') }
+end
+```
 
 The parameters for `define_eager_group` are as follows
 
@@ -73,18 +87,22 @@ method, it also generates a method with the same name to fetch the
 result.
 * `association`, association name you want to aggregate.
 * `aggregate_function`, aggregate sql function, can be one of `average`,
-`count`, `maximum`, `minimum`, `sum`.
+`count`, `maximum`, `minimum`, `sum`, I define 2 additional aggregate
+function `first_object` and `last_object` to fetch first and last object
+from associations.
 * `column_name`, aggregate column name, it can be `:*` for `count`
 * `scope`, scope is optional, it's used to filter data for aggregation.
 
 Then you can use `eager_group` to fix n+1 aggregate sql functions
 when querying
 
-    posts = Post.all.eager_group(:comments_average_rating, :approved_comments_count)
-    posts.each do |post|
-      post.comments_average_rating
-      post.approved_comments_count
-    end
+```ruby
+posts = Post.all.eager_group(:comments_average_rating, :approved_comments_count)
+posts.each do |post|
+  post.comments_average_rating
+  post.approved_comments_count
+end
+```
 
 EagerGroup will execute `GROUP BY` sqls for you then set the value of
 attributes.
@@ -93,16 +111,51 @@ attributes.
 You can call the `definition_name` directly for convenience,
 but it would not help you to fix n+1 aggregate sql issue.
 
-    post = Post.first
-    post.commets_average_rating
-    post.approved_comments_count
+```
+post = Post.first
+post.commets_average_rating
+post.approved_comments_count
+```
 
 ## Advanced
 
+eager_group through association
+
 ```ruby
 User.limit(10).includes(:posts).eager_group(posts: [:comments_average_rating, :approved_comments_count])
 ```
 
+pass parameter to scope
+
+```ruby
+class Post < ActiveRecord::Base
+  has_many :comments
+
+  define_eager_group :comments_average_rating_by_author, :comments, :average, :rating, ->(author, ignore) { by_author(author, ignore) }
+end
+
+posts = Post.all.eager_group([:comments_average_rating_by_author, author, true])
+posts.each { |post| post.comments_average_rating_by_author }
+```
+
+first_object and last_object aggregation to fetch first and last
+association object.
+
+```ruby
+class Post < ActiveRecord::Base
+  has_many :comments
+
+  define_eager_group :first_comment, :comments, :first_object, :id
+  define_eager_group :last_comment, :comments, :last_object, :id
+end
+
+posts = Post.all.eager_group(:first_comment, :last_comment)
+posts.each do |post|
+  post.first_comment
+  post.last_comment
+end
+```
+
 
 ## Benchmark
 

data/eager_group.gemspec

@@ -27,5 +27,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.3'
-  spec.add_development_dependency 'sqlite3', '~> 1.3'
+  spec.add_development_dependency 'sqlite3'
 end

data/lib/eager_group/active_record_base.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class ActiveRecord::Base
-  class <<self
+  class << self
     # Post.eager_group(:approved_comments_count, :comments_average_rating)
     delegate :eager_group, to: :all
   end

data/lib/eager_group/active_record_relation.rb

@@ -8,6 +8,7 @@ class ActiveRecord::Relation
     EagerGroup::Preloader.new(klass, records, eager_group_values).run if eager_group_values.present?
     records
   end
+
   alias_method_chain :exec_queries, :eager_group
 
   def eager_group(*args)

data/lib/eager_group/definition.rb

@@ -2,7 +2,7 @@
 
 module EagerGroup
   class Definition
-    attr_reader :association, :aggregate_function, :column_name, :scope
+    attr_reader :association, :column_name, :scope
 
     def initialize(association, aggregate_function, column_name, scope)
       @association = association
@@ -10,5 +10,19 @@ module EagerGroup
       @column_name = column_name
       @scope = scope
     end
+
+    def aggregation_function
+      return :maximum if @aggregate_function.to_sym == :last_object
+      return :minimum if @aggregate_function.to_sym == :first_object
+      @aggregate_function
+    end
+
+    def need_load_object
+      %i[first_object last_object].include?(@aggregate_function.to_sym)
+    end
+
+    def default_value
+      %i[first_object last_object].include?(@aggregate_function.to_sym) ? nil : 0
+    end
   end
 end

data/lib/eager_group/preloader.rb

@@ -17,6 +17,7 @@ module EagerGroup
           association_name, definition_key = *definition_key.first
           @records = @records.flat_map { |record| record.send(association_name) }
           next if @records.empty?
+
           @klass = @records.first.class
         end
         record_ids = @records.map { |record| record.send(primary_key) }
@@ -32,16 +33,20 @@ module EagerGroup
                                             .where(foreign_key => record_ids)
                                             .where(polymophic_as_condition(reflection.through_reflection))
                                             .group(foreign_key)
-                                            .send(definition.aggregate_function, definition.column_name)
+                                            .send(definition.aggregation_function, definition.column_name)
         else
           aggregate_hash = association_class.where(reflection.foreign_key => record_ids)
                                             .where(polymophic_as_condition(reflection))
                                             .group(reflection.foreign_key)
-                                            .send(definition.aggregate_function, definition.column_name)
+                                            .send(definition.aggregation_function, definition.column_name)
+        end
+        if definition.need_load_object
+          aggregate_objects = association_class.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] || 0)
+          record.send("#{definition_key}=", aggregate_hash[id] || definition.default_value)
         end
       end
     end

data/lib/eager_group/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eager_group
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Richard Huang
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-03-05 00:00:00.000000000 Z
+date: 2019-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -98,16 +98,16 @@ dependencies:
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
 description: Fix n+1 aggregate sql functions for rails
 email:
 - flyerhzm@gmail.com
@@ -152,7 +152,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Fix n+1 aggregate sql functions