RubyGems - kaminari-activerecord - Versions diffs - 1.2.1 → 1.3.0 - Mend

kaminari-activerecord 1.2.1 → 1.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (6) hide show

checksums.yaml +4 -4
data/kaminari-activerecord.gemspec +7 -0
data/lib/kaminari/activerecord/active_record_model_extension.rb +15 -4
data/lib/kaminari/activerecord/active_record_relation_methods.rb +43 -14
data/lib/kaminari/activerecord/version.rb +1 -1
metadata +93 -83

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6876071aa2d14ad868c0b30fe2d47478c6237c8d2e32f5e09ff2d6406d308f8c
-  data.tar.gz: 9ab1589acaec71a5ad35eeb9f80b38d7d6abcfd4f9ee83a468ab9686e8bcb2e1
+  metadata.gz: eefaf1569dfa8c30cb89e8f713ef3662f377fe009f1f88e434d5fe5f2878b7b9
+  data.tar.gz: 77ce58b9c3b353cfa55d3cf2dd135000e482dae3c4468615bc6a16279ded7a2f
 SHA512:
-  metadata.gz: dc82c0b5e7aa6292bdbe94474b1a7c532706a6d07886a7a44134e49d593102d21a052a29cbd8edf187b7b1a0e736a1638bdd92fcfa7fe3bc4a6b54b2fb73599f
-  data.tar.gz: 7c6904976fdc124170c8b01294dacca2433e86895f60f7a1cabfccfd780cfac2f59263cd1777dc70cbf74e745939174b5ee29eee7df20909eca537b45172e001
+  metadata.gz: 1be89a8131bde20e066ceb017c6ca1f00538d8fb6b97c3beaa34c92a6d16db44bbff52e7caa652b801f7af5f5d17465d2b63f078ddfe5c045688b0c6ccbb81ef
+  data.tar.gz: e0343ad91043c04646639edd68bbb508ffd1b4395e5292a02eadeae2b1a48cfee069405e9962cc55a8188ee09e454f5443f5a73704e4081063f1c6ab6c6bce19

data/kaminari-activerecord.gemspec CHANGED Viewed

@@ -14,6 +14,13 @@ Gem::Specification.new do |spec|
   spec.description   = 'kaminari-activerecord lets your Active Record models be paginatable'
   spec.homepage      = 'https://github.com/kaminari/kaminari'
   spec.license       = "MIT"
+  spec.metadata = {
+    'changelog_uri' => 'https://github.com/kaminari/kaminari/blob/master/CHANGELOG.md',
+    'source_code_uri' => 'https://github.com/kaminari/kaminari/tree/master/kaminari-activerecord',
+    'rubygems_mfa_required' => 'true'
+  }
   spec.required_ruby_version = '>= 2.0.0'
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }

data/lib/kaminari/activerecord/active_record_model_extension.rb CHANGED Viewed

@@ -3,21 +3,32 @@
 require 'kaminari/activerecord/active_record_relation_methods'
 module Kaminari
+  # Extends the Relation returned by Model.page.
+  # Passing this module to `extending` rather than a block saves defining a new Module on each call.
+  module ActiveRecordPageScope
+    include Kaminari::PageScopeMethods
+    # included after PageScopeMethods so that it can override PageScopeMethods#limit_and_offset
+    include Kaminari::ActiveRecordRelationMethods
+  end
   module ActiveRecordModelExtension
     extend ActiveSupport::Concern
     included do
       include Kaminari::ConfigurationMethods
+      def self.paginated?
+        false
+      end
       # Fetch the values at the specified page number
       #   Model.page(5)
       eval <<-RUBY, nil, __FILE__, __LINE__ + 1
         def self.#{Kaminari.config.page_method_name}(num = nil)
+          num = num.respond_to?(:to_i) ? num.to_i : 1
           per_page = max_per_page && (default_per_page > max_per_page) ? max_per_page : default_per_page
-          limit(per_page).offset(per_page * ((num = num.to_i - 1) < 0 ? 0 : num)).extending do
-            include Kaminari::ActiveRecordRelationMethods
-            include Kaminari::PageScopeMethods
-          end
+          # spawn only once rather than calling limit, offset, and extending, each of which copies the Relation
+          all.spawn.limit!(per_page).offset!(per_page * ((num = num.to_i - 1) < 0 ? 0 : num)).extending!(Kaminari::ActiveRecordPageScope)
         end
       RUBY
     end

data/lib/kaminari/activerecord/active_record_relation_methods.rb CHANGED Viewed

@@ -18,19 +18,24 @@ module Kaminari
       return @total_count if defined?(@total_count) && @total_count
       # There are some cases that total count can be deduced from loaded records
-      if loaded?
+      # (except with per(0) or without a limit, where loaded records say nothing about the total count)
+      if loaded? && limit_value.to_i != 0
         # Total count has to be 0 if loaded records are 0
         return @total_count = 0 if (current_page == 1) && @records.empty?
         # Total count is calculable at the last page
-        return @total_count = (current_page - 1) * limit_value + @records.length if @records.any? && (@records.length < limit_value)
+        return @total_count = offset_value + @records.length if @records.any? && (@records.length < limit_value)
       end
       # #count overrides the #select which could include generated columns referenced in #order, so skip #order here, where it's irrelevant to the result anyway
       c = except(:offset, :limit, :order)
       # Remove includes only if they are irrelevant
-      c = c.except(:includes) unless references_eager_loaded_tables?
+      c = c.except(:includes, :eager_load, :preload) unless references_eager_loaded_tables?
-      c = c.limit(max_pages * limit_value) if max_pages && max_pages.respond_to?(:*)
+      # Count up to max_pages pages (not with per(0), where LIMIT 0 would make the total count 0, nor without a limit)
+      c = c.limit(max_pages * limit_value) if max_pages && max_pages.respond_to?(:*) && limit_value.to_i != 0
+      # Count the groups in the database instead of fetching a row per group
+      return @total_count = count_groups(c) if c.group_values.any? && !c.eager_loading?
       # .group returns an OrderedHash that responds to #count
       c = c.count(column_name)
@@ -50,6 +55,33 @@ module Kaminari
     def without_count
       extend ::Kaminari::PaginatableWithoutCount
     end
+    private
+    # Overrides PageScopeMethods#limit_and_offset not to copy the Relation twice via limit and offset
+    def limit_and_offset(new_limit, new_offset)
+      spawn.limit!(new_limit).offset!(new_offset)
+    end
+    # SELECT COUNT(*) FROM (SELECT 1 FROM ... GROUP BY ...) subquery_for_count
+    def count_groups(relation)
+      # Each group is one row unless DISTINCT collapses some of them
+      relation = relation.except(:distinct)
+      having = relation.respond_to?(:having_clause) ? !relation.having_clause.empty? : relation.having_values.any?
+      # The HAVING clause may refer to aliases in the custom SELECT clause. Otherwise, SELECT 1 is valid with any GROUP BY clause.
+      relation = relation.except(:select).select('1') unless having && relation.select_values.any?
+      sql = relation.to_sql
+      return 0 if sql.blank?  # Relation#none on Active Record < 5
+      sql = "SELECT COUNT(*) FROM (#{sql}) subquery_for_count"
+      count = if klass.respond_to? :with_connection
+        klass.with_connection {|connection| connection.select_value sql, "#{klass.name} Count" }
+      else
+        klass.connection.select_value sql, "#{klass.name} Count"
+      end
+      count.to_i
+    end
   end
   # A module that makes AR::Relation paginatable without having to cast another SELECT COUNT query
@@ -59,15 +91,17 @@ module Kaminari
       refine ::ActiveRecord::Relation do
         private
-        # Update multiple instance variables that holds `limit` to a given value
+        # Update multiple instance variables that hold `limit` to a given value
         def set_limit_value(new_limit)
           @values[:limit] = new_limit
           if @arel
-            case @arel.limit
-            when Integer
+            case @arel.limit.class.name
+            when 'Integer', 'Fixnum'
               @arel.limit = new_limit
-            when Arel::Nodes::BindParam
+            when 'ActiveModel::Attribute::WithCastValue'  # comparing by class name because ActiveModel::Attribute::WithCastValue is a private constant
+              @arel.limit = build_cast_value 'LIMIT', new_limit
+            when 'Arel::Nodes::BindParam'
               if @arel.limit.respond_to?(:value)
                 @arel.limit = Arel::Nodes::BindParam.new(@arel.limit.value.with_cast_value(new_limit))
               end
@@ -76,13 +110,8 @@ module Kaminari
         end
       end
     end
-  end
-end
-# NOTE: ending all modules and reopening again because using has to be called from the toplevel in Ruby 2.0
-using Kaminari::PaginatableWithoutCount::LimitValueSetter
+    using Kaminari::PaginatableWithoutCount::LimitValueSetter
-module Kaminari
-  module PaginatableWithoutCount
     # Overwrite AR::Relation#load to actually load one more record to judge if the page has next page
     # then store the result in @_has_next ivar
     def load

data/lib/kaminari/activerecord/version.rb CHANGED Viewed

@@ -2,6 +2,6 @@
 module Kaminari
   module Activerecord
-    VERSION = '1.2.1'
+    VERSION = '1.3.0'
   end
 end

metadata CHANGED Viewed

@@ -1,108 +1,118 @@
 --- !ruby/object:Gem::Specification
 name: kaminari-activerecord
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
-- Akira Matsuda
-autorequire:
+  - Akira Matsuda
 bindir: bin
 cert_chain: []
-date: 2020-05-27 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: kaminari-core
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 1.2.1
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 1.2.1
-- !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: '1.12'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.12'
-- !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: kaminari-core
+    requirement: !ruby/object:Gem::Requirement
+      requirements:
+        -
+          - "="
+          - !ruby/object:Gem::Version
+            version: 1.3.0
+    type: :runtime
+    prerelease: false
+    version_requirements: !ruby/object:Gem::Requirement
+      requirements:
+        -
+          - "="
+          - !ruby/object:Gem::Version
+            version: 1.3.0
+  - !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: "1.12"
+    type: :development
+    prerelease: false
+    version_requirements: !ruby/object:Gem::Requirement
+      requirements:
+        -
+          - ">="
+          - !ruby/object:Gem::Version
+            version: "1.12"
+  - !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"
 description: kaminari-activerecord lets your Active Record models be paginatable
 email:
-- ronnie@dio.jp
+  - ronnie@dio.jp
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- CHANGELOG.md
-- MIT-LICENSE
-- README.md
-- kaminari-activerecord.gemspec
-- lib/kaminari/activerecord.rb
-- lib/kaminari/activerecord/active_record_extension.rb
-- lib/kaminari/activerecord/active_record_model_extension.rb
-- lib/kaminari/activerecord/active_record_relation_methods.rb
-- lib/kaminari/activerecord/version.rb
-homepage: https://github.com/kaminari/kaminari
+  - CHANGELOG.md
+  - MIT-LICENSE
+  - README.md
+  - kaminari-activerecord.gemspec
+  - lib/kaminari/activerecord.rb
+  - lib/kaminari/activerecord/active_record_extension.rb
+  - lib/kaminari/activerecord/active_record_model_extension.rb
+  - lib/kaminari/activerecord/active_record_relation_methods.rb
+  - lib/kaminari/activerecord/version.rb
+homepage: "https://github.com/kaminari/kaminari"
 licenses:
-- MIT
-metadata: {}
-post_install_message:
+  - MIT
+metadata:
+  changelog_uri: "https://github.com/kaminari/kaminari/blob/master/CHANGELOG.md"
+  source_code_uri: "https://github.com/kaminari/kaminari/tree/master/kaminari-activerecord"
+  rubygems_mfa_required: "true"
 rdoc_options: []
 require_paths:
-- lib
+  - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
-    - !ruby/object:Gem::Version
-      version: 2.0.0
+    -
+      - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
-    - !ruby/object:Gem::Version
-      version: '0'
+    -
+      - ">="
+      - !ruby/object:Gem::Version
+        version: "0"
 requirements: []
-rubygems_version: 3.2.0.pre1
-signing_key:
+rubygems_version: 4.1.0.beta2
 specification_version: 4
 summary: Kaminari Active Record adapter
 test_files: []