eager_group 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e3e98c847d6d1283e9687c8b1b6a770dddd9c645
+  data.tar.gz: 7525252e8291a4b9ee3c270b6e9f318d5bb1b5da
+SHA512:
+  metadata.gz: 9ee51ef879b7359070dc7f45e9138dabc776e29a209ba2499bb7f799c373ea0c4f6d9c92ea0a04a313dc8b46dcd366bb478bcb44c817bf44a9cfe214231c4389
+  data.tar.gz: 3f201ec3c596ec40990e6b9d5a669b76388df8566a8b31cc15f4ae5a02039cab5276f1f89221e9cd0827806842c68d1f4dc46a4be8eddab449190d44a6a4a102

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.2
+env:
+  - DB=sqlite
+script: bundle exec rspec spec

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Next Release
+
+## 0.1.0 (06/29/2015)
+
+* first release

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in eager_group.gemspec
+gemspec

data/README.md

@@ -0,0 +1,96 @@
+# EagerGroup
+
+[![Build Status](https://secure.travis-ci.org/xinminlabs/eager_group.png)](http://travis-ci.org/xinminlabs/eager_group)
+
+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(*) 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 average_comments_rating, post_id AS post_id FROM "comments" WHERE "comments"."post_id" IN (1, 2, 3) GROUP BY post_id;
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'eager_group'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install eager_group
+
+## Usage
+
+First you need to define what aggregate function you want to eager
+load.
+
+    class Post
+      has_many :comments
+
+      define_eager_group :comments_average_rating, :comments, :average, :rating
+      define_eager_group :approved_comments_count, :comments, :count, :*, -> { approved }
+    end
+
+    class Comment
+      belongs_to :post
+
+      scope :approved, -> { where(status: 'approved') }
+    end
+
+The parameters for `define_eager_group` are as follows
+
+* `definition_name`, it's used to be a reference in `eager_group` query
+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`.
+* `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
+
+EagerGroup will execute `GROUP BY` sqls for you then set the value of
+attributes.
+
+## Benchmark
+
+I wrote a benchmark script [here][1], it queries approved comments count
+and comments average rating for 20 posts, with eager group, it gets 10
+times faster, WOW!
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/xinminlabs/eager_group.
+
+[1]:  https://github.com/xinminlabs/eager_group/blob/master/benchmark.rb

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/benchmark.rb

@@ -0,0 +1,87 @@
+# Calculating -------------------------------------
+#   Without EagerGroup     2.000  i/100ms
+#      With EagerGroup    28.000  i/100ms
+# -------------------------------------------------
+#   Without EagerGroup     28.883  (± 6.9%) i/s -    144.000
+#      With EagerGroup    281.755  (± 5.0%) i/s -      1.428k
+#
+# Comparison:
+#      With EagerGroup:      281.8 i/s
+#   Without EagerGroup:       28.9 i/s - 9.76x slower
+$: << 'lib'
+require 'benchmark/ips'
+require 'active_record'
+require 'activerecord-import'
+require 'eager_group'
+
+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
+
+class Comment < ActiveRecord::Base
+  belongs_to :post
+
+  scope :approved, -> { where(status: 'approved') }
+end
+
+# create database eager_group_benchmark;
+ActiveRecord::Base.establish_connection(:adapter => 'mysql2', :database => 'eager_group_benchmark', :server => '/tmp/mysql.socket', :username => 'root')
+
+ActiveRecord::Base.connection.tables.each do |table|
+  ActiveRecord::Base.connection.drop_table(table)
+end
+
+ActiveRecord::Schema.define do
+  self.verbose = false
+
+  create_table :posts, :force => true do |t|
+    t.string :title
+    t.string :body
+    t.timestamps null: false
+  end
+
+  create_table :comments, :force => true do |t|
+    t.string :body
+    t.string :status
+    t.integer :rating
+    t.integer :post_id
+    t.timestamps null: false
+  end
+end
+
+posts_size = 100
+comments_size = 1000
+
+posts = []
+posts_size.times do |i|
+  posts << Post.new(:title => "Title #{i}", :body => "Body #{i}")
+end
+Post.import posts
+post_ids = Post.all.pluck(:id)
+
+comments = []
+comments_size.times do |i|
+  comments << Comment.new(:body => "Comment #{i}", :post_id => post_ids[i%100], :status => ["approved", "deleted"][i%2], rating: i%5+1)
+end
+Comment.import comments
+
+Benchmark.ips do |x|
+  x.report("Without EagerGroup") do
+    Post.limit(20).each do |post|
+      post.comments.approved.count
+      post.comments.approved.average('rating')
+    end
+  end
+
+  x.report("With EagerGroup") do
+    Post.eager_group(:approved_comments_count, :comments_average_rating).limit(20).each do |post|
+      post.approved_comments_count
+      post.comments_average_rating
+    end
+  end
+
+  x.compare!
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "eager_group"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/eager_group.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'eager_group/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "eager_group"
+  spec.version       = EagerGroup::VERSION
+  spec.authors       = ["Richard Huang"]
+  spec.email         = ["flyerhzm@gmail.com"]
+
+  spec.summary       = %q{Fix n+1 aggregate sql functions}
+  spec.description   = %q{Fix n+1 aggregate sql functions for rails}
+  spec.homepage      = "https://github.com/xinminlabs/eager_group"
+
+  spec.license     = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activerecord"
+  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 "activerecord-import"
+  spec.add_development_dependency "benchmark-ips"
+end

data/lib/eager_group.rb

@@ -0,0 +1,29 @@
+require "eager_group/version"
+require 'active_record'
+require 'eager_group/active_record_base'
+require 'eager_group/active_record_relation'
+
+module EagerGroup
+  autoload :Preloader, 'eager_group/preloader'
+  autoload :Definition, 'eager_group/definition'
+
+  def self.included(base)
+    base.extend ClassMethods
+  end
+
+  module ClassMethods
+    attr_reader :eager_group_definations
+
+    # 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)
+      self.send :attr_accessor, attr
+      @eager_group_definations ||= {}
+      @eager_group_definations[attr] = Definition.new association, aggregate_function, column_name, scope
+    end
+  end
+end
+
+ActiveRecord::Base.send :include, EagerGroup

data/lib/eager_group/active_record_base.rb

@@ -0,0 +1,6 @@
+class ActiveRecord::Base
+  class <<self
+    # Post.eager_group(:approved_comments_count, :comments_average_rating)
+    delegate :eager_group, :to => :all
+  end
+end

data/lib/eager_group/active_record_relation.rb

@@ -0,0 +1,31 @@
+class ActiveRecord::Relation
+  # Post.all.eager_group(:approved_comments_count, :comments_average_rating)
+
+  def exec_queries_with_eager_group
+    records = exec_queries_without_eager_group
+    if eager_group_values.present?
+      EagerGroup::Preloader.new(self.klass, records, eager_group_values).run
+    end
+    records
+  end
+  alias_method_chain :exec_queries, :eager_group
+
+  def eager_group(*args)
+    check_if_method_has_arguments!('eager_group', args)
+    spawn.eager_group!(*args)
+  end
+
+  def eager_group!(*args)
+    self.eager_group_values += args
+    self
+  end
+
+  def eager_group_values
+    @values[:eager_group] || []
+  end
+
+  def eager_group_values=(values)
+    raise ImmutableRelation if @loaded
+    @values[:eager_group] = values
+  end
+end

data/lib/eager_group/definition.rb

@@ -0,0 +1,12 @@
+module EagerGroup
+  class Definition
+    attr_reader :association, :aggregate_function, :column_name, :scope
+
+    def initialize(association, aggregate_function, column_name, scope)
+      @association = association
+      @aggregate_function = aggregate_function
+      @column_name = column_name
+      @scope = scope
+    end
+  end
+end

data/lib/eager_group/preloader.rb

@@ -0,0 +1,30 @@
+module EagerGroup
+  class Preloader
+    def initialize(klass, records, eager_group_values)
+      @klass = klass
+      @records = Array.wrap(records).compact.uniq
+      @eager_group_values = eager_group_values
+    end
+
+    # Preload aggregate functions
+    def run
+      primary_key = @klass.primary_key
+      record_ids = @records.map { |record| record.send primary_key }
+      @eager_group_values.each do |eager_group_value|
+        definition = @klass.eager_group_definations[eager_group_value]
+        if definition
+          reflect = @klass.reflect_on_association(definition.association)
+          association_class = reflect.class_name.constantize
+          association_class = association_class.instance_exec(&definition.scope) if definition.scope
+          aggregate_hash = association_class.where(reflect.foreign_key => record_ids)
+                                            .group(reflect.foreign_key)
+                                            .send(definition.aggregate_function, definition.column_name)
+          @records.each do |record|
+            id = record.send primary_key
+            record.send "#{eager_group_value}=", aggregate_hash[id]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/eager_group/version.rb

@@ -0,0 +1,3 @@
+module EagerGroup
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: eager_group
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Richard Huang
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-06-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: activerecord-import
+  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'
+- !ruby/object:Gem::Dependency
+  name: benchmark-ips
+  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
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- README.md
+- Rakefile
+- benchmark.rb
+- bin/console
+- bin/setup
+- eager_group.gemspec
+- lib/eager_group.rb
+- lib/eager_group/active_record_base.rb
+- lib/eager_group/active_record_relation.rb
+- lib/eager_group/definition.rb
+- lib/eager_group/preloader.rb
+- lib/eager_group/version.rb
+homepage: https://github.com/xinminlabs/eager_group
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.7
+signing_key: 
+specification_version: 4
+summary: Fix n+1 aggregate sql functions
+test_files: []