kaminari-core 1.0.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 411d49d8ce83d73051514c6ef479b92ce907eea9
-  data.tar.gz: fa0c4408c8e22ccac81ced012536294624bb5b82
+SHA256:
+  metadata.gz: 073f49d2cee52f15a94e03ea16932a7a35c140e21126fcaf32be27b16dd9126b
+  data.tar.gz: d18374c251ef627e9ddb5b57cd0350c0092b139f2926d578b8f006f07db3403c
 SHA512:
-  metadata.gz: 85c3fc1e602c9eb2d23ea4a837cf38055adbb01943862b3c73323eeddc98c417cb6561b5f1c05b916b11af271ed0d5f00270ab052d5af120f41542eee753e735
-  data.tar.gz: dee9d87b0e03af6529afd73d586169382deb47d553dfea2702300895169366fbc1f881b5fcfe4205f35a8a4df0bb92657b87e44d666e5580981969e8c111e42b
+  metadata.gz: 4d22379f9e5189f50288741c894323d9e36d5dc983e7eda26034db2f1900f4593223c53a3084b03fcacd391af039680bf9a22d41a3d503c291f7e7513a964b02
+  data.tar.gz: a1b5d908d102b3929e58e8cbeec729b07c8a1b084aac2675562db0580bdc9970d41ef9c37e6d085781f78dc1510c0b41f78f0d5a1592df518129129aaa80747d

data/CHANGELOG.md

@@ -0,0 +1 @@
+See https://github.com/kaminari/kaminari/tree/master/CHANGELOG.md for changes.

data/README.md

@@ -18,12 +18,12 @@ And bundle.
 
 This gem is basically an internal gem that will be automatically bundled from kaminari gem or kaminari adapter gems.
 
-See [Kaminari README](https://github.com/amatsuda/kaminari/blob/master/README.md) for the documentation.
+See [Kaminari README](https://github.com/kaminari/kaminari/blob/master/README.md) for the documentation.
 
 
 ## Contributing
 
-Pull requests are welcome on GitHub at https://github.com/amatsuda/kaminari.
+Pull requests are welcome on GitHub at https://github.com/kaminari/kaminari.
 
 
 ## License

data/app/views/kaminari/_paginator.html.erb

@@ -7,7 +7,7 @@
     paginator:     the paginator that renders the pagination tags inside
 -%>
 <%= paginator.render do -%>
-  <nav class="pagination">
+  <nav class="pagination" role="navigation" aria-label="pager">
     <%= first_page_tag unless current_page.first? %>
     <%= prev_page_tag unless current_page.first? %>
     <% each_page do |page| -%>

data/kaminari-core.gemspec

@@ -1,5 +1,5 @@
-# coding: utf-8
 # frozen_string_literal: true
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'kaminari/core/version'
@@ -12,8 +12,9 @@ Gem::Specification.new do |spec|
 
   spec.summary       = "Kaminari's core pagination library"
   spec.description   = 'kaminari-core includes pagination logic independent from ORMs and view libraries'
-  spec.homepage      = 'https://github.com/amatsuda/kaminari'
+  spec.homepage      = 'https://github.com/kaminari/kaminari'
   spec.license       = "MIT"
+  spec.required_ruby_version = '>= 2.0.0'
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.require_paths = ["lib"]

data/lib/generators/kaminari/config_generator.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Kaminari
   module Generators
     # rails g kaminari:config

data/lib/generators/kaminari/templates/kaminari_config.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 Kaminari.configure do |config|
   # config.default_per_page = 25
   # config.max_per_page = nil
@@ -8,5 +9,6 @@ Kaminari.configure do |config|
   # config.right = 0
   # config.page_method_name = :page
   # config.param_name = :page
+  # config.max_pages = nil
   # config.params_on_first_page = false
 end

data/lib/generators/kaminari/views_generator.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Kaminari
   module Generators
     # rails g kaminari:views THEME
@@ -110,6 +111,8 @@ BANNER
     end
 
     module GitHubApiHelper
+      require 'open-uri'
+
       def get_files_in_master
         master_tree_sha = open('https://api.github.com/repos/amatsuda/kaminari_themes/git/refs/heads/master') do |json|
           ActiveSupport::JSON.decode(json.read)['object']['sha']

data/lib/kaminari/config.rb

@@ -1,28 +1,40 @@
 # frozen_string_literal: true
-require 'active_support/configurable'
 
 module Kaminari
   # Configures global settings for Kaminari
   #   Kaminari.configure do |config|
   #     config.default_per_page = 10
   #   end
-  include ActiveSupport::Configurable
+  class << self
+    def configure
+      yield config
+    end
+
+    def config
+      @_config ||= Config.new
+    end
+  end
+
+  class Config
+    attr_accessor :default_per_page, :max_per_page, :window, :outer_window, :left, :right, :page_method_name, :max_pages, :params_on_first_page
+    attr_writer :param_name
 
-  config.instance_eval do
-    self.default_per_page = 25
-    self.max_per_page = nil
-    self.window = 4
-    self.outer_window = 0
-    self.left = 0
-    self.right = 0
-    self.page_method_name = :page
-    self.param_name = :page
-    self.max_pages = nil
-    self.params_on_first_page = false
+    def initialize
+      @default_per_page = 25
+      @max_per_page = nil
+      @window = 4
+      @outer_window = 0
+      @left = 0
+      @right = 0
+      @page_method_name = :page
+      @param_name = :page
+      @max_pages = nil
+      @params_on_first_page = false
+    end
 
     # If param_name was given as a callable object, call it when returning
     def param_name
-      self[:param_name].respond_to?(:call) ? self[:param_name].call : self[:param_name]
+      @param_name.respond_to?(:call) ? @param_name.call : @param_name
     end
   end
 end

data/lib/kaminari/core.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Kaminari
 end
 

data/lib/kaminari/core/version.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
+
 module Kaminari
   module Core
-    VERSION = '1.0.0'
+    VERSION = '1.2.1'
   end
 end

data/lib/kaminari/engine.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Kaminari #:nodoc:
   class Engine < ::Rails::Engine #:nodoc:
   end

data/lib/kaminari/exceptions.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Kaminari
   class ZeroPerPageOperation < ZeroDivisionError; end
 end

data/lib/kaminari/helpers/helper_methods.rb

@@ -1,6 +1,98 @@
+# frozen_string_literal: true
+
 module Kaminari
   module Helpers
+
+    # The Kaminari::Helpers::UrlHelper module provides useful methods for
+    # generating a path or url to a particlar page. A class must implement the
+    # following methods:
+    #
+    #   * <tt>url_for</tt>: A method that generates an actual path
+    #   * <tt>params</tt>: A method that returns query string parameters
+    #   * <tt>request</tt>: A method that returns a Rack::Request object
+    #
+    # A normal Rails controller implements all the methods, which makes it
+    # trivial to use this module:
+    #
+    # ==== Examples
+    #
+    #   class UsersController < ApplicationController
+    #     include Kaminari::Helpers::UrlHelper
+    #
+    #     def index
+    #      @users = User.page(1)
+    #
+    #      path_to_next_page(@items)
+    #      # => /items?page=2
+    #     end
+    #   end
+    #
+    module UrlHelper
+
+      # A helper that calculates the url to the next page.
+      #
+      # ==== Examples
+      # Basic usage:
+      #
+      #   <%= next_page_url @items %>
+      #   #-> http://www.example.org/items?page=2
+      #
+      # It will return `nil` if there is no next page.
+      def next_page_url(scope, options = {})
+        "#{request.base_url}#{next_page_path(scope, options)}" if scope.next_page
+      end
+      alias path_to_next_url next_page_url
+
+      # A helper that calculates the url to the previous page.
+      #
+      # ==== Examples
+      # Basic usage:
+      #
+      #   <%= prev_page_url @items %>
+      #   #-> http://www.example.org/items
+      #
+      # It will return `nil` if there is no previous page.
+      def prev_page_url(scope, options = {})
+        "#{request.base_url}#{prev_page_path(scope, options)}" if scope.prev_page
+      end
+      alias previous_page_url     prev_page_url
+      alias url_to_prev_page      prev_page_url
+      alias url_to_previous_page  prev_page_url
+
+      # A helper that calculates the path to the next page.
+      #
+      # ==== Examples
+      # Basic usage:
+      #
+      #   <%= path_to_next_page @items %>
+      #   #-> /items?page=2
+      #
+      # It will return `nil` if there is no next page.
+      def next_page_path(scope, options = {})
+        Kaminari::Helpers::NextPage.new(self, **options.reverse_merge(current_page: scope.current_page)).url if scope.next_page
+      end
+      alias path_to_next_page next_page_path
+
+      # A helper that calculates the path to the previous page.
+      #
+      # ==== Examples
+      # Basic usage:
+      #
+      #   <%= path_to_prev_page @items %>
+      #   #-> /items
+      #
+      # It will return `nil` if there is no previous page.
+      def prev_page_path(scope, options = {})
+        Kaminari::Helpers::PrevPage.new(self, **options.reverse_merge(current_page: scope.current_page)).url if scope.prev_page
+      end
+      alias previous_page_path     prev_page_path
+      alias path_to_previous_page  prev_page_path
+      alias path_to_prev_page      prev_page_path
+    end
+
     module HelperMethods
+      include UrlHelper
+
       # A helper that renders the pagination links.
       #
       #   <%= paginate @articles %>
@@ -20,7 +112,7 @@ module Kaminari
         options[:total_pages] ||= scope.total_pages
         options.reverse_merge! current_page: scope.current_page, per_page: scope.limit_value, remote: false
 
-        paginator = paginator_class.new (template || self), options
+        paginator = paginator_class.new (template || self), **options
         paginator.to_s
       end
 
@@ -47,8 +139,10 @@ module Kaminari
         options.except! :params, :param_name
         options[:rel] ||= 'prev'
 
-        link_to_if prev_page, name, prev_page, options do
-          yield if block_given?
+        if prev_page
+          link_to name, prev_page, options
+        elsif block_given?
+          yield
         end
       end
       alias link_to_prev_page link_to_previous_page
@@ -76,8 +170,10 @@ module Kaminari
         options.except! :params, :param_name
         options[:rel] ||= 'next'
 
-        link_to_if next_page, name, next_page, options do
-          yield if block_given?
+        if next_page
+          link_to name, next_page, options
+        elsif block_given?
+          yield
         end
       end
 
@@ -99,7 +195,7 @@ module Kaminari
       #   #-> Displaying items 6 - 10 of 26 in total
       def page_entries_info(collection, entry_name: nil)
         entry_name = if entry_name
-                       entry_name.pluralize(collection.size)
+                       entry_name.pluralize(collection.size, I18n.locale)
                      else
                        collection.entry_name(count: collection.size).downcase
                      end
@@ -107,7 +203,10 @@ module Kaminari
         if collection.total_pages < 2
           t('helpers.page_entries_info.one_page.display_entries', entry_name: entry_name, count: collection.total_count)
         else
-          t('helpers.page_entries_info.more_pages.display_entries', entry_name: entry_name, first: collection.offset_value + 1, last: [collection.offset_value + collection.limit_value, collection.total_count].min, total: collection.total_count)
+          from = collection.offset_value + 1
+          to   = collection.offset_value + (collection.respond_to?(:records) ? collection.records : collection.to_a).size
+
+          t('helpers.page_entries_info.more_pages.display_entries', entry_name: entry_name, first: from, last: to, total: collection.total_count)
         end.html_safe
       end
 
@@ -134,36 +233,10 @@ module Kaminari
         prev_page = path_to_prev_page(scope, options)
 
         output = String.new
-        output << tag(:link, rel: "next", href: next_page) if next_page
-        output << tag(:link, rel: "prev", href: prev_page) if prev_page
+        output << %Q|<link rel="next" href="#{next_page}"></link>| if next_page
+        output << %Q|<link rel="prev" href="#{prev_page}"></link>| if prev_page
         output.html_safe
       end
-
-      # A helper that calculates the path to the next page.
-      #
-      # ==== Examples
-      # Basic usage:
-      #
-      #   <%= path_to_next_page @items %>
-      #   #-> /items?page=2
-      #
-      # It will return `nil` if there is no next page.
-      def path_to_next_page(scope, options = {})
-        Kaminari::Helpers::NextPage.new(self, options.reverse_merge(current_page: scope.current_page)).url if scope.next_page
-      end
-
-      # A helper that calculates the path to the previous page.
-      #
-      # ==== Examples
-      # Basic usage:
-      #
-      #   <%= path_to_prev_page @items %>
-      #   #-> /items
-      #
-      # It will return `nil` if there is no previous page.
-      def path_to_prev_page(scope, options = {})
-        Kaminari::Helpers::PrevPage.new(self, options.reverse_merge(current_page: scope.current_page)).url if scope.prev_page
-      end
     end
   end
 end

data/lib/kaminari/helpers/paginator.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'active_support/inflector'
 require 'kaminari/helpers/tags'
 
@@ -6,11 +7,8 @@ module Kaminari
   module Helpers
     # The main container tag
     class Paginator < Tag
-      def initialize(template, window: nil, outer_window: nil, left: nil, right: nil, inner_window: nil, **options) #:nodoc:
-        outer_window ||= Kaminari.config.outer_window
-        left ||= Kaminari.config.left
-        right ||= Kaminari.config.right
-        @window_options = {window: window || inner_window || Kaminari.config.window, left: left.zero? ? outer_window : left, right: right.zero? ? outer_window : right}
+      def initialize(template, window: nil, outer_window: Kaminari.config.outer_window, left: Kaminari.config.left, right: Kaminari.config.right, inner_window: Kaminari.config.window, **options) #:nodoc:
+        @window_options = {window: window || inner_window, left: left.zero? ? outer_window : left, right: right.zero? ? outer_window : right}
 
         @template, @options, @theme, @views_prefix, @last = template, options, options[:theme], options[:views_prefix], nil
         @window_options.merge! @options
@@ -29,7 +27,11 @@ module Kaminari
       # render given block as a view template
       def render(&block)
         instance_eval(&block) if @options[:total_pages] > 1
-        @output_buffer
+
+        # This allows for showing fall-back HTML when there's only one page:
+        #
+        #   <%= paginate(@search_results) || "Showing all search results" %>
+        @output_buffer.presence
       end
 
       # enumerate each page providing PageProxy object as the block parameter
@@ -57,13 +59,13 @@ module Kaminari
       private :relevant_pages
 
       def page_tag(page)
-        @last = Page.new @template, @options.merge(page: page)
+        @last = Page.new @template, **@options.merge(page: page)
       end
 
       %w[first_page prev_page next_page last_page gap].each do |tag|
         eval <<-DEF, nil, __FILE__, __LINE__ + 1
           def #{tag}_tag
-            @last = #{tag.classify}.new @template, @options
+            @last = #{tag.classify}.new @template, **@options
           end
         DEF
       end

data/lib/kaminari/helpers/tags.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
+
 module Kaminari
   module Helpers
-    PARAM_KEY_BLACKLIST = [:authenticity_token, :commit, :utf8, :_method, :script_name].freeze
+    PARAM_KEY_EXCEPT_LIST = [:authenticity_token, :commit, :utf8, :_method, :script_name, :original_script_name].freeze
 
     # A tag stands for an HTML tag inside the paginator.
     # Basically, a tag has its own partial template file, so every tag can be
@@ -23,7 +24,7 @@ module Kaminari
         # @params in Rails 5 no longer inherits from Hash
         @params = @params.to_unsafe_h if @params.respond_to?(:to_unsafe_h)
         @params = @params.with_indifferent_access
-        @params.except!(*PARAM_KEY_BLACKLIST)
+        @params.except!(*PARAM_KEY_EXCEPT_LIST)
         @params.merge! params
       end
 
@@ -117,6 +118,19 @@ module Kaminari
     # The "previous" page of the current page
     class PrevPage < Tag
       include Link
+
+      # TODO: Remove this initializer before 1.3.0.
+      def initialize(template, params: {}, param_name: nil, theme: nil, views_prefix: nil, **options) #:nodoc:
+        # params in Rails 5 may not be a Hash either,
+        # so it must be converted to a Hash to be merged into @params
+        if params && params.respond_to?(:to_unsafe_h)
+          ActiveSupport::Deprecation.warn 'Explicitly passing params to helpers could be omitted.'
+          params = params.to_unsafe_h
+        end
+
+        super(template, params: params, param_name: param_name, theme: theme, views_prefix: views_prefix, **options)
+      end
+
       def page #:nodoc:
         @options[:current_page] - 1
       end
@@ -125,6 +139,19 @@ module Kaminari
     # The "next" page of the current page
     class NextPage < Tag
       include Link
+
+      # TODO: Remove this initializer before 1.3.0.
+      def initialize(template, params: {}, param_name: nil, theme: nil, views_prefix: nil, **options) #:nodoc:
+        # params in Rails 5 may not be a Hash either,
+        # so it must be converted to a Hash to be merged into @params
+        if params && params.respond_to?(:to_unsafe_h)
+          ActiveSupport::Deprecation.warn 'Explicitly passing params to helpers could be omitted.'
+          params = params.to_unsafe_h
+        end
+
+        super(template, params: params, param_name: param_name, theme: theme, views_prefix: views_prefix, **options)
+      end
+
       def page #:nodoc:
         @options[:current_page] + 1
       end

data/lib/kaminari/models/array_extension.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'active_support/core_ext/module'
 module Kaminari
   # Kind of Array that can paginate
@@ -34,7 +35,7 @@ module Kaminari
 
     # Used for page_entry_info
     def entry_name(options = {})
-      I18n.t('helpers.page_entries_info.entry', options.reverse_merge(default: ENTRY.pluralize(options[:count])))
+      I18n.t('helpers.page_entries_info.entry', **options.reverse_merge(default: ENTRY.pluralize(options[:count])))
     end
 
     # items at the specified "page"

data/lib/kaminari/models/configuration_methods.rb

@@ -1,4 +1,7 @@
 # frozen_string_literal: true
+
+require 'active_support/concern'
+
 module Kaminari
   module ConfigurationMethods #:nodoc:
     extend ActiveSupport::Concern
@@ -49,7 +52,7 @@ module Kaminari
       end
 
       def max_pages_per(val)
-        ActiveSupport::Deprecation.warn 'max_pages_per is deprecated. Use max_pages instead.', caller_locations(2)
+        ActiveSupport::Deprecation.warn 'max_pages_per is deprecated. Use max_pages instead.'
         max_pages val
       end
     end

data/lib/kaminari/models/page_scope_methods.rb

@@ -1,18 +1,17 @@
 # frozen_string_literal: true
+
 module Kaminari
   module PageScopeMethods
     # Specify the <tt>per_page</tt> value for the preceding <tt>page</tt> scope
     #   Model.page(3).per(10)
     def per(num, max_per_page: nil)
       max_per_page ||= ((defined?(@_max_per_page) && @_max_per_page) || self.max_per_page)
-      @_per = num
-      if num.nil? && max_per_page
-        limit(max_per_page).offset(offset_value / limit_value * max_per_page)
-      elsif (n = num.to_i) < 0 || !(/^\d/ =~ num.to_s)
+      @_per = (num || default_per_page).to_i
+      if (n = num.to_i) < 0 || !(/^\d/ =~ num.to_s)
         self
       elsif n.zero?
         limit(n)
-      elsif max_per_page && max_per_page < n
+      elsif max_per_page && (max_per_page < n)
         limit(max_per_page).offset(offset_value / limit_value * max_per_page)
       else
         limit(n).offset(offset_value / limit_value * n)
@@ -21,7 +20,8 @@ module Kaminari
 
     def max_paginates_per(new_max_per_page)
       @_max_per_page = new_max_per_page
-      per ((defined?(@_per) && @_per) || default_per_page), max_per_page: new_max_per_page
+
+      per (defined?(@_per) && @_per) || default_per_page, max_per_page: new_max_per_page
     end
 
     def padding(num)
@@ -54,6 +54,15 @@ module Kaminari
       raise ZeroPerPageOperation, "Current page was incalculable. Perhaps you called .per(0)?"
     end
 
+    # Current per-page number
+    def current_per_page
+      ActiveSupport::Deprecation.warn '#current_per_page is deprecated and will be removed in the next major ' \
+                                      'version. Please use #limit_value instead.'
+
+      limit_value
+      # (defined?(@_per) && @_per) || default_per_page
+    end
+
     # Next page number in the collection
     def next_page
       current_page + 1 unless last_page? || out_of_range?

data/lib/kaminari/railtie.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Kaminari
   class Railtie < ::Rails::Railtie #:nodoc:
     # Doesn't actually do anything. Just keeping this hook point, mainly for compatibility

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kaminari-core
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Akira Matsuda
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-10 00:00:00.000000000 Z
+date: 2020-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -46,6 +46,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - MIT-LICENSE
 - README.md
 - app/views/kaminari/_first_page.html.erb
@@ -86,7 +87,7 @@ files:
 - lib/kaminari/models/configuration_methods.rb
 - lib/kaminari/models/page_scope_methods.rb
 - lib/kaminari/railtie.rb
-homepage: https://github.com/amatsuda/kaminari
+homepage: https://github.com/kaminari/kaminari
 licenses:
 - MIT
 metadata: {}
@@ -98,15 +99,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 3.2.0.pre1
 signing_key: 
 specification_version: 4
 summary: Kaminari's core pagination library