activerecord-has_count 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1638ba180bf14cd976c29912e38505fb21b73a4b
+  data.tar.gz: dd52048a4744eb4f5b740b0b0df9ca74f8a8eb99
+SHA512:
+  metadata.gz: c3e3313087b1e78e6ef21b26c938a4ebe17124c74ac9c596970f4614e329f7f89375f1bdf3c2586b6dcd068f0e3ed705ccb38526ddb8b2d59e7635d6e8179930
+  data.tar.gz: 8128b246278b8c678a7fd8a52588e570444555e8e5362a0636cdb86170b77e92c8e2a3695035d393daa485ef7aad6d812ef62ddd923c64ce8065f1d9500bbcec

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Takashi Kokubun
+
+MIT License
+
+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,70 @@
+# ActiveRecord::HasCount
+
+N+1 count query killer for ActiveRecord  
+ActiveRecord::HasCount allows you to cache count of associated records by eager loading
+
+## Why ActiveRecord::HasCount?
+Rails provides a way to resolve N+1 count query, which is [belongs\_to's counter\_cache option](http://guides.rubyonrails.org/association_basics.html#counter-cache).  
+It requires a column to cache the count. But adding a column just for count cache is overkill.  
+  
+Thus this plugin enables you to preload counts in the same way as `has_many` and `belongs_to`.  
+`has_count` is an ActiveRecord's association, which is preloadable by `preload` or `includes`.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'activerecord-has_count'
+```
+
+## Usage
+
+### Add count\_preloadable scope
+First, call `has_count` with an association whose count you want to preload
+
+```rb
+class Tweet
+  has_many :replies
+  has_count :replies # defines association named :replies_count
+end
+```
+
+The option creates an additional association whose name is `replies_count`.  
+Its association type is not an ordinary one (i.e. `has_many`, `belongs_to`) but `has_count`.
+
+### Preload the association
+This association works well by default.
+
+```rb
+@tweets = Tweet.all
+@tweets.each do |tweet|
+  p tweets.replies_count # same as tweets.replies.count
+end
+```
+
+You can eagerly load `has_count` association by `includes` or `preload`.
+
+```rb
+@tweets = Tweet.preload(:replies_count)
+@tweets.each do |tweet|
+  p tweets.replies_count # this line doesn't execute an additional query
+end
+```
+
+Since it is association, you can preload nested `has_count` association.
+
+```rb
+@favorites = Favorite.preload(tweet: :replies_count)
+@favorites.each do |favorite|
+  p favorite.tweet.replies_count # this line doesn't execute an additional query
+end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/k0kubun/has_count/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

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

data/activerecord-has_count.gemspec

@@ -0,0 +1,27 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_record/has_count/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "activerecord-has_count"
+  spec.version       = ActiveRecord::HasCount::VERSION
+  spec.authors       = ["Takashi Kokubun"]
+  spec.email         = ["takashikkbn@gmail.com"]
+  spec.summary       = %q{N+1 count query killer for ActiveRecord}
+  spec.description   = %q{N+1 count query killer for ActiveRecord}
+  spec.homepage      = "https://github.com/k0kubun/activerecord-has_count"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.test_files    = spec.files.grep(%r{^spec/})
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = ">= 1.9.2"
+  spec.add_runtime_dependency "activerecord", ">= 3.0"
+  spec.add_development_dependency "rspec", "~> 3.0.0"
+  spec.add_development_dependency "factory_girl", "~> 4.2.0"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "pry"
+end

data/lib/active_record/associations/builder/has_count.rb

@@ -0,0 +1,15 @@
+module ActiveRecord::Associations::Builder
+  class HasCount < SingularAssociation
+    def macro
+      :has_count
+    end
+
+    def valid_options
+      []
+    end
+
+    def self.valid_dependent_options
+      []
+    end
+  end
+end

data/lib/active_record/associations/has_count.rb

@@ -0,0 +1,39 @@
+module ActiveRecord
+  module Associations
+    module ClassMethods
+      module HasCount
+        private
+
+        def has_count(name, scope = nil, options = {}, &extension)
+          name_with_count = :"#{name}_count"
+
+          reflection = Builder::HasCount.build(self, name_with_count, scope, options, &extension)
+          Reflection.add_reflection(self, name_with_count, reflection)
+        end
+      end
+    end
+
+    class HasCount < SingularAssociation
+      # Not preloaded behaviour of count_preloadable association
+      # When this method is called, it will be N+1 query
+      def load_target
+        count_target = name_without_count.to_sym
+        @target = owner.association(count_target).count
+
+        loaded! unless loaded?
+        target
+      rescue ActiveRecord::RecordNotFound
+        reset
+      end
+
+      # This method is used by preloader when grouping preload target's class
+      def klass
+        reflection.active_record.send(:compute_type, name_without_count.singularize.classify)
+      end
+
+      def name_without_count
+        reflection.name.to_s.sub(/_count$/, "")
+      end
+    end
+  end
+end

data/lib/active_record/associations/join_dependency/has_count.rb

@@ -0,0 +1,25 @@
+module ActiveRecord
+  # This imitates EagerLoadPolymorphicError
+  class EagerLoadHasCountError < ActiveRecordError
+    def initialize(reflection)
+      super("Cannot eagerly load the has_count association #{reflection.name.inspect}")
+    end
+  end
+
+  module Associations
+    class JoinDependency
+      module HasCount
+        def build_with_has_count(associations, base_klass)
+          associations.map do |name, right|
+            reflection = find_reflection base_klass, name
+            if reflection.macro == :has_count
+              raise EagerLoadHasCountError.new(reflection)
+            end
+          end
+
+          build_without_has_count(associations, base_klass)
+        end
+      end
+    end
+  end
+end

data/lib/active_record/associations/preloader/has_count.rb

@@ -0,0 +1,39 @@
+module ActiveRecord
+  module Associations
+    class Preloader
+      class HasCount < SingularAssociation
+        def association_key_name
+          reflection.foreign_key
+        end
+
+        def owner_key_name
+          reflection.active_record_primary_key
+        end
+
+        private
+
+        def preload(preloader)
+          associated_records_by_owner(preloader).each do |owner, associated_records|
+            count = associated_records.count
+
+            association = owner.association(reflection.name)
+            association.target = count
+          end
+        end
+      end
+
+      private
+
+      def preloader_for_with_has_count(reflection, owners, rhs_klass)
+        preloader = preloader_for_without_has_count(reflection, owners, rhs_klass)
+        return preloader if preloader
+
+        case reflection.macro
+        when :has_count
+          HasCount
+        end
+      end
+      alias_method_chain :preloader_for, :has_count
+    end
+  end
+end

data/lib/active_record/has_count/version.rb

@@ -0,0 +1,5 @@
+module ActiveRecord
+  module HasCount
+    VERSION = "0.0.1"
+  end
+end

data/lib/active_record/reflection/has_count.rb

@@ -0,0 +1,27 @@
+module ActiveRecord
+  module Reflection
+    module HasCount
+      def create_with_has_count(macro, name, scope, options, ar)
+        case macro
+        when :has_count
+          AssociationReflection.new(macro, name, scope, options, ar)
+        else
+          create_without_has_count(macro, name, scope, options, ar)
+        end
+      end
+    end
+
+    class AssociationReflection
+      module HasCount
+        def association_class_with_has_count
+          case macro
+          when :has_count
+            ActiveRecord::Associations::HasCount
+          else
+            association_class_without_has_count
+          end
+        end
+      end
+    end
+  end
+end

data/lib/activerecord-has_count.rb

@@ -0,0 +1,36 @@
+require "active_record/associations/has_count"
+require "active_record/associations/builder/has_count"
+require "active_record/associations/preloader/has_count"
+require "active_record/associations/join_dependency/has_count"
+require "active_record/reflection/has_count"
+
+module ActiveRecord
+  module Associations
+    module ClassMethods
+      include HasCount
+    end
+  end
+end
+
+module ActiveRecord
+  module Reflection
+    class << self
+      include HasCount
+      alias_method_chain :create, :has_count
+    end
+
+    class AssociationReflection
+      include HasCount
+      alias_method_chain :association_class, :has_count
+    end
+  end
+end
+
+module ActiveRecord
+  module Associations
+    class JoinDependency
+      include HasCount
+      alias_method_chain :build, :has_count
+    end
+  end
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-has_count
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Takashi Kokubun
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.2.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'
+- !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: 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: 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: N+1 count query killer for ActiveRecord
+email:
+- takashikkbn@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- activerecord-has_count.gemspec
+- lib/active_record/associations/builder/has_count.rb
+- lib/active_record/associations/has_count.rb
+- lib/active_record/associations/join_dependency/has_count.rb
+- lib/active_record/associations/preloader/has_count.rb
+- lib/active_record/has_count/version.rb
+- lib/active_record/reflection/has_count.rb
+- lib/activerecord-has_count.rb
+homepage: https://github.com/k0kubun/activerecord-has_count
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: N+1 count query killer for ActiveRecord
+test_files: []
+has_rdoc: