kaminari-activerecord 1.0.0.beta2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d6e55d83b0bccd30eea50b63a401eedab96bd110
+  data.tar.gz: 66b0af1385a854e91e2ed9ff0b4efbfc1b8d5477
+SHA512:
+  metadata.gz: '08ac3a7c80b4f4be3e8618ddacffe49b52ca141943781ca166f699803203bfeaa71feda2cd50834637bb49f8cc98ef0678cb83fead3a7c31c9a63b976521d5a4'
+  data.tar.gz: 459cc20d8083391fb1b4ef4e6d185be221e7e993a5cb684119e2a694c0bef05699f5ddead4c83fecd8cd5e02a4bb8208d0e69c6138901cc9b598efe70b0f150e

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Akira Matsuda
+
+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,32 @@
+# Kaminari::Activerecord
+
+Kaminari Active Record adapter.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'kaminari-activerecord'
+```
+
+And bundle.
+
+
+## Usage
+
+This gem is basically an internal gem that will be automatically bundled from kaminari gem.
+
+Or if you're using ORMs other than Active Record, you might need to explicitly bundle this gem.
+
+See [Kaminari README (Other Framework/Library Support)](https://github.com/amatsuda/kaminari/blob/master/README.md#other-frameworklibrary-support) for details.
+
+## Contributing
+
+Pull requests are welcome on GitHub at https://github.com/amatsuda/kaminari.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/kaminari-activerecord.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+# frozen_string_literal: true
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kaminari/activerecord/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "kaminari-activerecord"
+  spec.version       = Kaminari::Activerecord::VERSION
+  spec.authors       = ["Akira Matsuda"]
+  spec.email         = ["ronnie@dio.jp"]
+
+  spec.summary       = 'Kaminari Active Record adapter'
+  spec.description   = 'kaminari-activerecord lets your Active Record models be paginatable'
+  spec.homepage      = 'https://github.com/amatsuda/kaminari'
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'kaminari-core', Kaminari::Activerecord::VERSION
+  spec.add_dependency 'activerecord'
+
+  spec.add_development_dependency "bundler", ">= 1.12"
+  spec.add_development_dependency "rake", ">= 10.0"
+end

data/lib/kaminari/activerecord.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+require "kaminari/activerecord/version"
+require 'active_support/lazy_load_hooks'
+
+ActiveSupport.on_load :active_record do
+  require 'kaminari/activerecord/active_record_extension'
+  ::ActiveRecord::Base.send :include, Kaminari::ActiveRecordExtension
+end

data/lib/kaminari/activerecord/active_record_extension.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+require 'kaminari/activerecord/active_record_model_extension'
+
+module Kaminari
+  module ActiveRecordExtension
+    extend ActiveSupport::Concern
+
+    module ClassMethods #:nodoc:
+      # Future subclasses will pick up the model extension
+      def inherited(kls) #:nodoc:
+        super
+        kls.send(:include, Kaminari::ActiveRecordModelExtension) if kls.superclass == ::ActiveRecord::Base
+      end
+    end
+
+    included do
+      # Existing subclasses pick up the model extension as well
+      descendants.each do |kls|
+        kls.send(:include, Kaminari::ActiveRecordModelExtension) if kls.superclass == ::ActiveRecord::Base
+      end
+    end
+  end
+end

data/lib/kaminari/activerecord/active_record_model_extension.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+require 'kaminari/activerecord/active_record_relation_methods'
+
+module Kaminari
+  module ActiveRecordModelExtension
+    extend ActiveSupport::Concern
+
+    included do
+      include Kaminari::ConfigurationMethods
+
+      # 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)
+          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
+        end
+      RUBY
+    end
+  end
+end

data/lib/kaminari/activerecord/active_record_relation_methods.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+module Kaminari
+  # Active Record specific page scope methods implementations
+  module ActiveRecordRelationMethods
+    # Used for page_entry_info
+    def entry_name(options = {})
+      default = options[:count] == 1 ? model_name.human : model_name.human.pluralize
+      model_name.human(options.reverse_merge(default: default))
+    end
+
+    def reset #:nodoc:
+      @total_count = nil
+      super
+    end
+
+    def total_count(column_name = :all, _options = nil) #:nodoc:
+      return @total_count if defined?(@total_count) && @total_count
+
+      # There are some cases that total count can be deduced from loaded records
+      if loaded?
+        # Total count has to be 0 if loaded records are 0
+        return @total_count = 0 if (current_page == 1) && @records.empty?
+        # Total count is calculatable at the last page
+        return @total_count = (current_page - 1) * @_per + @records.length if defined?(@_per) && (@records.length < @_per)
+      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?
+      # .group returns an OrderedHash that responds to #count
+      c = c.count(column_name)
+      @total_count = if c.is_a?(Hash) || c.is_a?(ActiveSupport::OrderedHash)
+        c.count
+      else
+        c.respond_to?(:count) ? c.count(column_name) : c
+      end
+    end
+
+    # Turn this Relation to a "without count mode" Relation.
+    # Note that the "without count mode" is supposed to be performant but has a feature limitation.
+    #   Pro: paginates without casting an extra SELECT COUNT query
+    #   Con: unable to know the total number of records/pages
+    def without_count
+      extend ::Kaminari::PaginatableWithoutCount
+    end
+  end
+
+  # A module that makes AR::Relation paginatable without having to cast another SELECT COUNT query
+  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
+      if loaded? || limit_value.nil?
+        super
+      else
+        @values[:limit] = limit_value + 1
+        super
+        @values[:limit] = limit_value - 1
+
+        if @records.any?
+          @records = @records.dup if (frozen = @records.frozen?)
+          @_has_next = !!@records.delete_at(limit_value)
+          @records.freeze if frozen
+        end
+
+        self
+      end
+    end
+
+    # The page wouldn't be the last page if there's "limit + 1" record
+    def last_page?
+      !out_of_range? && !@_has_next
+    end
+
+    # Empty relation needs no pagination
+    def out_of_range?
+      load unless loaded?
+      @records.empty?
+    end
+
+    # Force to raise an exception if #total_count is called explicitly.
+    def total_count
+      raise "This scope is marked as a non-count paginable scope and can't be used in combination " \
+            "with `#paginate' or `#page_entries_info'. Use #link_to_next_page or #link_to_previous_page instead."
+    end
+  end
+end

data/lib/kaminari/activerecord/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+module Kaminari
+  module Activerecord
+    VERSION = '1.0.0.beta2'
+  end
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: kaminari-activerecord
+version: !ruby/object:Gem::Version
+  version: 1.0.0.beta2
+platform: ruby
+authors:
+- Akira Matsuda
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-12-14 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.0.0.beta2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0.beta2
+- !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
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- 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/amatsuda/kaminari
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: Kaminari Active Record adapter
+test_files: []