kaminari-core 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e8c36b983453967adcb35acf8e5a07c87fdc811c9d285428a599ec2ced09064e
-  data.tar.gz: 1309e2966e772d9410a1fd9c02bc09bb51f6c46d0a73316b3332597c5f2675bc
+  metadata.gz: 38b5e5dc2c53e8e1194787c1d7767b4f68a2f74ea42125b9be84a52b14c47576
+  data.tar.gz: 0d515874f25e93549891b1d633fb34159075ec32148e93e289b47fb24e45a81a
 SHA512:
-  metadata.gz: aeb83e6fa8f491923a819512390353f2de9193f986bcdecf9f9ec4f4c1f5b4a8924a0561654dd24b020b076168651f2294e1008794c46d22b80b31320255a5be
-  data.tar.gz: e97a0d7f44ae639a019afcde742caa0219c37c7867a905763ea451964a6e6e4be2b946c2262cf62127c6a80cc621be8c717853b9b2aa4e6b65f97e3f573e872b
+  metadata.gz: c2a5687801a8e2b4ae370b206b8d6df3a488fd920f9592a66946c5069b2d90ef72b6f7970517fdc639224e4412b1e4e78cf8da239a484d3452fd62df77b65009
+  data.tar.gz: 8f6e7fad6773b7669002c5df184439b193bc0021cb212a1492fca7adb5735ec92df0c126d2fa3aee50dce82b2ca1ade0bbbf65bf4ede0603cd497f6df456f78c

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'

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

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.1.1'
+    VERSION = '1.2.0'
   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

@@ -2,7 +2,97 @@
 
 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 %>
@@ -22,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
 
@@ -49,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
@@ -78,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
 
@@ -109,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
 
@@ -136,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'
 
@@ -26,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
@@ -54,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].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
 

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,10 +1,10 @@
 # frozen_string_literal: true
+
+require 'active_support/concern'
+
 module Kaminari
   module ConfigurationMethods #:nodoc:
-    def self.included(base)
-      base.extend ClassMethods
-    end
-
+    extend ActiveSupport::Concern
     module ClassMethods #:nodoc:
       # Overrides the default +per_page+ value per model
       #   class Article < ActiveRecord::Base

data/lib/kaminari/models/page_scope_methods.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Kaminari
   module PageScopeMethods
     # Specify the <tt>per_page</tt> value for the preceding <tt>page</tt> scope
@@ -19,7 +20,8 @@ module Kaminari
 
     def max_paginates_per(new_max_per_page)
       @_max_per_page = new_max_per_page
-      per current_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,7 +56,11 @@ module Kaminari
 
     # Current per-page number
     def current_per_page
-      (defined?(@_per) && @_per) || default_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

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.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Akira Matsuda
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-21 00:00:00.000000000 Z
+date: 2020-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -106,8 +106,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Kaminari's core pagination library