activerecord-precounter 0.2.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c3c08d0e856aad769711131f6e7276b777e2f6cd
-  data.tar.gz: 6648ad8319c9bd466b0693b2d3386c19f74e2d37
+SHA256:
+  metadata.gz: a80cb8c2919851956774b0c573d3a3271a9b4f017e33edca6fae411f1c4c189b
+  data.tar.gz: 9d479d623ceacf1a93ad4cc64b6ad58ce32f586e07dc8b6335d9e380f82e7d9b
 SHA512:
-  metadata.gz: 966efeff214aa006d5d272afd5197d80a64f93df982ddd8e0302b0326c182024961d50cc9f519f79821f5da651a5d2a23f8ae7e9a11efee663cf0a5bd5199891
-  data.tar.gz: 9df24ac11ae3cfdd91037422b94e4fd3e9b40da5e21fee2a1cb6c42f3651891f389816537e81154ab56d74f5d9b1016f4ec87a7ece58a8901bad60e60955b139
+  metadata.gz: ae135551e4619a121e488e62517c072b3692dd8b717867b45114ffe904ee50ad6cec6f3924755f511a48f640510d902986be83e0205b5b7178a054eae6d9b47d
+  data.tar.gz: 295507cafb1c6de872f92163d74ebfd37bae295cb2fe4478b3c313b967c0faf657090596fb37153a5a32ac5201be6c48b2384d697ca8901c98f4b0f1fe79da42

data/.gitignore

@@ -10,3 +10,4 @@
 
 # rspec failure tracking
 .rspec_status
+*.sqlite3

data/.travis.yml

@@ -5,11 +5,18 @@ cache: bundler
 branches:
   only:
     - master
+dist: trusty
 matrix:
   include:
+    - rvm: 2.4.1
+      env: TASK=spec ARCONN=postgresql
+      gemfile: ci/Gemfile.activerecord-5.0.x
     - rvm: 2.4.1
       env: TASK=spec ARCONN=sqlite3
       gemfile: ci/Gemfile.activerecord-5.1.x
     - rvm: 2.4.1
       env: TASK=spec ARCONN=postgresql
       gemfile: ci/Gemfile.activerecord-5.1.x
+    - rvm: 2.4.1
+      env: TASK=spec ARCONN=postgresql
+      gemfile: ci/Gemfile.activerecord-5.2.x

data/CHANGELOG.md

@@ -0,0 +1,42 @@
+## v0.4.0
+
+* [breaking] Raise `NotPrecountedError` instead of returning nil if `*_count` is called without precount
+* Add `ActiveRecord::Precountable` module to actively define `*_count` readers and writers by `precounts` DSL on ActiveRecord::Base.
+
+## v0.3.3
+
+* Support passing a single record to `ActiveRecord::Precounter.new` [#8](https://github.com/k0kubun/activerecord-precounter/pull/8)
+
+## v0.3.2
+
+* Support primary\_key option of belongs\_to association [#7](https://github.com/k0kubun/activerecord-precounter/pull/7)
+
+## v0.3.1
+
+* Fix [#5](https://github.com/k0kubun/activerecord-precounter/pull/5) for ActiveRecord 5.0 (take 3)
+
+## v0.3.0
+
+* Fix [#5](https://github.com/k0kubun/activerecord-precounter/pull/5) for ActiveRecord 5.0 (take 2)
+* [breaking] Drop ActiveRecord 4.2 support
+
+## v0.2.3
+
+* Fix count of scoped association [#5](https://github.com/k0kubun/activerecord-precounter/pull/5)
+
+## v0.2.2
+
+* Fix unexpected subquery [#4](https://github.com/k0kubun/activerecord-precounter/pull/5)
+
+## v0.2.1
+
+* Add support for counting scoped association
+* Return empty array when target records don't exist
+
+## v0.2.0
+
+* [breaking] Completely change interface
+
+## v0.1.0
+
+* Initial release

data/activerecord-precounter.gemspec

@@ -21,10 +21,10 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'activerecord'
+  spec.add_dependency 'activerecord', '>= 5'
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'mysql2'
-  spec.add_development_dependency 'postgres'
+  spec.add_development_dependency 'pg'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'sqlite3'

data/ci/Gemfile.activerecord-5.2.x

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

data/lib/active_record/precountable.rb

@@ -0,0 +1,20 @@
+module ActiveRecord
+  module Precountable
+    class NotPrecountedError < StandardError
+    end
+
+    def precounts(*association_names)
+      association_names.each do |association_name|
+        var_name = "#{association_name}_count"
+        instance_var_name = "@#{var_name}"
+
+        attr_writer(var_name)
+        define_method(var_name) do
+          count = instance_variable_get(instance_var_name)
+          raise NotPrecountedError.new("`#{association_name}' not precounted") unless count
+          count
+        end
+      end
+    end
+  end
+end

data/lib/active_record/precounter.rb

@@ -1,4 +1,5 @@
 require 'active_record/precounter/version'
+require 'active_record/precountable'
 
 module ActiveRecord
   class Precounter
@@ -12,33 +13,44 @@ module ActiveRecord
     # @param [Array<String,Symbol>] association_names - Eager loaded association names. e.g. `[:users, :likes]`
     # @return [Array<ActiveRecord::Base>]
     def precount(*association_names)
-      records = @relation.to_a
-      return [] if records.empty?
+      # Allow single record instances as well as relations to be passed.
+      # The splat here will return an array of the single record if it's
+      # not a relation or otherwise return the records themselves via #to_a.
+      records = *@relation
+      return records if records.empty?
+
+      # We need to get the relation's active class, which is the class itself
+      # in the case of a single record.
+      klass = @relation.respond_to?(:klass) ? @relation.klass : @relation.class
 
       association_names.each do |association_name|
         association_name = association_name.to_s
-        reflection = @relation.klass.reflections.fetch(association_name)
+        reflection = 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}`?"
+            "`#{reflection.klass}` does not have inverse of `#{klass}##{reflection.name}`. "\
+            "Probably missing to call `#{reflection.klass}.belongs_to #{klass.name.underscore.to_sym.inspect}`?"
           )
         end
 
+        primary_key = reflection.inverse_of.association_primary_key.to_sym
+
         count_by_id = if reflection.has_scope?
-                        reflection.scope_for(reflection.klass).where(reflection.inverse_of.name => records.map(&:id)).group(
+                        # ActiveRecord 5.0 unscopes #scope_for argument, so adding #where outside that:
+                        # https://github.com/rails/rails/blob/v5.0.7/activerecord/lib/active_record/reflection.rb#L314-L316
+                        reflection.scope_for(reflection.klass.unscoped).where(reflection.inverse_of.name => records.map(&primary_key)).group(
                           reflection.inverse_of.foreign_key
                         ).count
                       else
-                        reflection.klass.where(reflection.inverse_of.name => records.map(&:id)).group(
+                        reflection.klass.where(reflection.inverse_of.name => records.map(&primary_key)).group(
                           reflection.inverse_of.foreign_key
                         ).count
                       end
 
-        writer = define_count_accessor(records.first, association_name)
+        writer = define_count_accessor(klass, association_name)
         records.each do |record|
-          record.public_send(writer, count_by_id.fetch(record.id, 0))
+          record.public_send(writer, count_by_id.fetch(record.public_send(primary_key), 0))
         end
       end
       records
@@ -46,15 +58,16 @@ module ActiveRecord
 
     private
 
-    # @param [ActiveRecord::Base] record
+    # @param [Class] record class
     # @param [String] association_name
     # @return [String] writer method name
-    def define_count_accessor(record, association_name)
+    def define_count_accessor(klass, 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)
+      if !klass.method_defined?(reader_name) && !klass.method_defined?(writer_name)
+        klass.extend(ActiveRecord::Precountable)
+        klass.public_send(:precounts, association_name)
       end
 
       writer_name

data/lib/active_record/precounter/version.rb

@@ -1,5 +1,5 @@
 module ActiveRecord
   class Precounter
-    VERSION = '0.2.3'
+    VERSION = '0.4.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-precounter
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.4.0
 platform: ruby
 authors:
 - Takashi Kokubun
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-11-06 00:00:00.000000000 Z
+date: 2020-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: postgres
+  name: pg
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -118,6 +118,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -128,7 +129,9 @@ files:
 - ci/Gemfile.activerecord-4.2.x
 - ci/Gemfile.activerecord-5.0.x
 - ci/Gemfile.activerecord-5.1.x
+- ci/Gemfile.activerecord-5.2.x
 - ci/travis.rb
+- lib/active_record/precountable.rb
 - lib/active_record/precounter.rb
 - lib/active_record/precounter/version.rb
 - lib/activerecord-precounter.rb
@@ -151,8 +154,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 3.2.0.pre1
 signing_key: 
 specification_version: 4
 summary: Yet Another N+1 COUNT Query Killer for ActiveRecord