activerecord-precounter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e486607a409dc25b776267ae02f8bd0ef8f801f5
+  data.tar.gz: 38667cea1241dc1820e77289185a6102b031af3e
+SHA512:
+  metadata.gz: 98e0d0d94a90f233250936bb69ce3e5f9407f30687097c10afff7168710a05bb249de0611ca916700ac04400690f2c5187b694bd14b476a11d13a776a4530d03
+  data.tar.gz: 8c9bdebda2f932c1f7ed4b699020b4528d918a24b5335a7954a4a24bec269ababa1d6cb24484aeff4b0a6ede03f7ea17a50736b9c9b7742cf3de6c8d62f74cc6

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,33 @@
+script: ci/travis.rb
+language: ruby
+sudo: false
+cache: bundler
+branches:
+  only:
+    - master
+matrix:
+  include:
+    - rvm: 2.1.10
+      env: TASK=test ARCONN=mysql2
+      gemfile: ci/Gemfile.activerecord-4.2.x
+    - rvm: 2.2.7
+      env: TASK=test ARCONN=mysql2
+      gemfile: ci/Gemfile.activerecord-5.1.x
+    - rvm: 2.3.4
+      env: TASK=test ARCONN=mysql2
+      gemfile: ci/Gemfile.activerecord-5.1.x
+    - rvm: 2.4.1
+      env: TASK=test ARCONN=mysql2
+      gemfile: ci/Gemfile.activerecord-4.2.x
+    - rvm: 2.4.1
+      env: TASK=test ARCONN=mysql2
+      gemfile: ci/Gemfile.activerecord-5.0.x
+    - rvm: 2.4.1
+      env: TASK=test ARCONN=sqlite3
+      gemfile: ci/Gemfile.activerecord-5.1.x
+    - rvm: 2.4.1
+      env: TASK=test ARCONN=mysql2
+      gemfile: ci/Gemfile.activerecord-5.1.x
+    - rvm: 2.4.1
+      env: TASK=test ARCONN=postgresql
+      gemfile: ci/Gemfile.activerecord-5.1.x

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in activerecord-precounter.gemspec
+gemspec
+
+group :development, :test do
+  gem 'pry'
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Takashi Kokubun
+
+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/README.md

@@ -0,0 +1,65 @@
+# ActiveRecord::Precounter [![Build Status](https://travis-ci.org/k0kubun/activerecord-precounter.svg?branch=master)](https://travis-ci.org/k0kubun/activerecord-precounter)
+
+Yet Another N+1 COUNT Query Killer for ActiveRecord, counter\_cache alternative.  
+ActiveRecord::Precounter allows you to cache count of associated records by eager loading.
+
+This is another version of [activerecord-precount](https://github.com/k0kubun/activerecord-precount),
+which is not elegant but designed to have no monkey-patch to ActiveRecord internal APIs for maintainability.
+
+## Synopsis
+
+### N+1 count query
+
+Sometimes you may see many count queries for one association.
+You can use counter\_cache to solve it, but you need to ALTER table and concern about dead lock to use counter\_cache.
+
+```rb
+tweets = Tweet.all
+tweets.each do |tweet|
+  p tweet.favorites.count
+end
+# SELECT `tweets`.* FROM `tweets`
+# SELECT COUNT(*) FROM `favorites` WHERE `favorites`.`tweet_id` = 1
+# SELECT COUNT(*) FROM `favorites` WHERE `favorites`.`tweet_id` = 2
+# SELECT COUNT(*) FROM `favorites` WHERE `favorites`.`tweet_id` = 3
+# SELECT COUNT(*) FROM `favorites` WHERE `favorites`.`tweet_id` = 4
+# SELECT COUNT(*) FROM `favorites` WHERE `favorites`.`tweet_id` = 5
+```
+
+### Count eager loading
+
+#### precount
+
+With activerecord-precounter gem installed, you can use `ActiveRecord::Precounter#precount` method
+to eagerly load counts of associated records.
+Like `preload`, it loads counts by multiple queries
+
+```rb
+tweets = Tweet.all
+ActiveRecord::Precounter.new(tweets, :favorites).precount
+tweets.each do |tweet|
+  p tweet.favorites_count
+end
+# SELECT `tweets`.* FROM `tweets`
+# SELECT COUNT(`favorites`.`tweet_id`), `favorites`.`tweet_id` FROM `favorites` WHERE `favorites`.`tweet_id` IN (1, 2, 3, 4, 5) GROUP BY `favorites`.`tweet_id`
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'activerecord-precounter'
+```
+
+## Limitation
+
+Target `has_many` association must have inversed `belongs_to`.
+i.e. `ActiveRecord::Precounter.new(tweets, :favorites).precount` needs both `Tweet.has_many(:favorites)` and `Favorite.belongs_to(:tweet)`.
+
+Unlike [activerecord-precount](https://github.com/k0kubun/activerecord-precount), the cache store is not ActiveRecord association and it does not utilize ActiveRecord preloader.
+Thus you can't use `preload` to eager load counts for nested associations. And currently there's no JOIN support.
+
+## License
+
+MIT License

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/activerecord-precounter.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_record/precounter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'activerecord-precounter'
+  spec.version       = ActiveRecord::Precounter::VERSION
+  spec.authors       = ['Takashi Kokubun']
+  spec.email         = ['takashikkbn@gmail.com']
+
+  spec.summary       = %q{Yet Another N+1 COUNT Query Killer for ActiveRecord}
+  spec.description   = %q{Yet Another N+1 COUNT Query Killer for ActiveRecord}
+  spec.homepage      = 'https://github.com/k0kubun/activerecord-precounter'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  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 'mysql2'
+  spec.add_development_dependency 'postgres'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'sqlite3'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "activerecord/precounter"
+
+# 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(__FILE__)

data/bin/setup

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

data/ci/Gemfile.activerecord-4.2.x

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+gem 'rails', '~> 4.2.0'
+gemspec path: '..'

data/ci/Gemfile.activerecord-5.0.x

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+gem 'rails', '~> 5.0.0'
+gemspec path: '..'

data/ci/Gemfile.activerecord-5.1.x

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+gem 'rails', '~> 5.1.0'
+gemspec path: '..'

data/ci/travis.rb

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+commands = [
+  'mysql -e "create database activerecord_unittest;"',
+  'mysql -e "create database activerecord_unittest2;"',
+  'psql  -c "create database activerecord_unittest;" -U postgres',
+  'psql  -c "create database activerecord_unittest2;" -U postgres'
+]
+
+commands.each do |command|
+  system("#{command} > /dev/null 2>&1")
+end
+
+exit system("bundle exec rake $TASK")

data/lib/active_record/precounter.rb

@@ -0,0 +1,56 @@
+require 'active_record/precounter/version'
+
+module ActiveRecord
+  class Precounter
+    class MissingInverseOf < StandardError; end
+
+    # @param [ActiveRecord::Relation] relation - Parent resources relation.
+    # @param [Array<String,Symbol>] association_names - Eager loaded association names. e.g. `[:users, :likes]`
+    def initialize(relation, *association_names)
+      @relation = relation
+      @association_names = association_names.map(&:to_s)
+    end
+
+    # @return [Array<ActiveRecord::Base>]
+    def precount
+      records = @relation.to_a
+      return if records.empty?
+
+      @association_names.each do |association_name|
+        reflection = @relation.klass.reflections.fetch(association_name)
+        if reflection.inverse_of.nil?
+          raise MissingInverseOf.new(
+            "`#{reflection.klass}` does not have inverse of `#{@relation.klass}##{reflection.name}`. "\
+            "Probably missing to call `#{reflection.klass}.belongs_to #{@relation.name.underscore.to_sym.inspect}`?"
+          )
+        end
+
+        count_by_id = reflection.klass.where(reflection.inverse_of.name => @relation).group(
+          reflection.inverse_of.foreign_key
+        ).count
+
+        writer = define_count_accessor(records.first, association_name)
+        records.each do |record|
+          record.public_send(writer, count_by_id.fetch(record.id, 0))
+        end
+      end
+      records
+    end
+
+    private
+
+    # @param [ActiveRecord::Base] record
+    # @param [String] association_name
+    # @return [String] writer method name
+    def define_count_accessor(record, association_name)
+      reader_name = "#{association_name}_count"
+      writer_name = "#{reader_name}="
+
+      if !record.respond_to?(reader_name) && !record.respond_to?(writer_name)
+        record.class.send(:attr_accessor, reader_name)
+      end
+
+      writer_name
+    end
+  end
+end

data/lib/active_record/precounter/version.rb

@@ -0,0 +1,5 @@
+module ActiveRecord
+  class Precounter
+    VERSION = '0.1.0'
+  end
+end

data/lib/activerecord-precounter.rb

@@ -0,0 +1 @@
+require 'active_record/precounter'

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-precounter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Takashi Kokubun
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-08-12 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: mysql2
+  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: postgres
+  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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: sqlite3
+  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: Yet Another N+1 COUNT Query Killer for ActiveRecord
+email:
+- takashikkbn@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- activerecord-precounter.gemspec
+- bin/console
+- bin/setup
+- ci/Gemfile.activerecord-4.2.x
+- ci/Gemfile.activerecord-5.0.x
+- ci/Gemfile.activerecord-5.1.x
+- ci/travis.rb
+- lib/active_record/precounter.rb
+- lib/active_record/precounter/version.rb
+- lib/activerecord-precounter.rb
+homepage: https://github.com/k0kubun/activerecord-precounter
+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.5.2
+signing_key: 
+specification_version: 4
+summary: Yet Another N+1 COUNT Query Killer for ActiveRecord
+test_files: []