kaminari-core 1.2.2 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f97cdb29c6cc0f87f4a3b2439bc98d4015894053aece52f9685f9053d828eee2
-  data.tar.gz: fda4562a4e0fe69e90af6276b78575dc6dbbe6f42f98ffecd70bd54ddf7cf5cc
+  metadata.gz: d08a6963a92273028b03d21b148a1a7d4fb8f7033b315e1af492b54eaf9ba790
+  data.tar.gz: 6aa9625e5db4476c1e76deaa7e548e9821dc19411ff09c753cbb9a16c146e81e
 SHA512:
-  metadata.gz: 0dbaec420bee38126a89931872d0d4dcc37772a7bb22d0c97844399b95c55cc4677a2634d1b908b1c4c5c60a0319ab5b88d8b7bb4f01658db3ecc52400eb9c94
-  data.tar.gz: a5294c22cd10b649243d4ebd4ac85481e1ae16b956d2777121926026eb21f2c3ec6c07a799ca02271f0348a76f9cc4fcf409ce0cdbe69672289fdca1e745e800
+  metadata.gz: 497e6516b7f39d799c9c69a772c3985d1da0f4714e42f1d011686b273d178c534513b074de56d5c888e98ec4f70ca78718c211b918a2d584b5b0ef040b8f697d
+  data.tar.gz: 32cce623d1212f46a77c41974ef225c93b152fcb7ed41de7f03e21c825c8b42b2e75ec1777afd0e0719ea9aa27c77238195a1ce2b16f8ee433fcc04b0cbc212c

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

@@ -5,7 +5,8 @@
     total_pages:   total number of pages
     per_page:      number of items to fetch per page
     remote:        data-remote
+    data:          data-* attributes
 -%>
 <span class="first">
-  <%= link_to_unless current_page.first?, t('views.pagination.first').html_safe, url, remote: remote %>
+  <%= link_to_unless current_page.first?, t('views.pagination.first').html_safe, url, remote: remote, data: data %>
 </span>

data/app/views/kaminari/_first_page.html.haml

@@ -5,5 +5,6 @@
 -#    total_pages:   total number of pages
 -#    per_page:      number of items to fetch per page
 -#    remote:        data-remote
+-#    data:          data-* attributes
 %span.first
-  = link_to_unless current_page.first?, t('views.pagination.first').html_safe, url, remote: remote
+  = link_to_unless current_page.first?, t('views.pagination.first').html_safe, url, remote: remote, data: data

data/app/views/kaminari/_first_page.html.slim

@@ -5,6 +5,7 @@
     total_pages  : total number of pages
     per_page     : number of items to fetch per page
     remote       : data-remote
+    data         : data-* attributes
 span.first
-  == link_to_unless current_page.first?, t('views.pagination.first').html_safe, url, remote: remote
+  == link_to_unless current_page.first?, t('views.pagination.first').html_safe, url, remote: remote, data: data
 '

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

@@ -5,7 +5,8 @@
     total_pages:   total number of pages
     per_page:      number of items to fetch per page
     remote:        data-remote
+    data:          data-* attributes
 -%>
 <span class="last">
-  <%= link_to_unless current_page.last?, t('views.pagination.last').html_safe, url, remote: remote %>
+  <%= link_to_unless current_page.last?, t('views.pagination.last').html_safe, url, remote: remote, data: data %>
 </span>

data/app/views/kaminari/_last_page.html.haml

@@ -5,5 +5,6 @@
 -#    total_pages:   total number of pages
 -#    per_page:      number of items to fetch per page
 -#    remote:        data-remote
+-#    data:          data-* attributes
 %span.last
-  = link_to_unless current_page.last?, t('views.pagination.last').html_safe, url, remote: remote
+  = link_to_unless current_page.last?, t('views.pagination.last').html_safe, url, remote: remote, data: data

data/app/views/kaminari/_last_page.html.slim

@@ -5,6 +5,7 @@
     total_pages  : total number of pages
     per_page     : number of items to fetch per page
     remote       : data-remote
+    data         : data-* attributes
 span.last
-  == link_to_unless current_page.last?, t('views.pagination.last').html_safe, url, remote: remote
+  == link_to_unless current_page.last?, t('views.pagination.last').html_safe, url, remote: remote, data: data
 '

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

@@ -5,7 +5,8 @@
     total_pages:   total number of pages
     per_page:      number of items to fetch per page
     remote:        data-remote
+    data:          data-* attributes
 -%>
 <span class="next">
-  <%= link_to_unless current_page.last?, t('views.pagination.next').html_safe, url, rel: 'next', remote: remote %>
+  <%= link_to_unless current_page.last?, t('views.pagination.next').html_safe, url, rel: 'next', remote: remote, data: data %>
 </span>

data/app/views/kaminari/_next_page.html.haml

@@ -5,5 +5,6 @@
 -#    total_pages:   total number of pages
 -#    per_page:      number of items to fetch per page
 -#    remote:        data-remote
+-#    data:          data-* attributes
 %span.next
-  = link_to_unless current_page.last?, t('views.pagination.next').html_safe, url, rel: 'next', remote: remote
+  = link_to_unless current_page.last?, t('views.pagination.next').html_safe, url, rel: 'next', remote: remote, data: data

data/app/views/kaminari/_next_page.html.slim

@@ -5,6 +5,7 @@
     total_pages  : total number of pages
     per_page     : number of items to fetch per page
     remote       : data-remote
+    data         : data-* attributes
 span.next
-  == link_to_unless current_page.last?, t('views.pagination.next').html_safe, url, rel: 'next', remote: remote
+  == link_to_unless current_page.last?, t('views.pagination.next').html_safe, url, rel: 'next', remote: remote, data: data
 '

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

@@ -6,7 +6,8 @@
     total_pages:   total number of pages
     per_page:      number of items to fetch per page
     remote:        data-remote
+    data:          data-* attributes
 -%>
 <span class="page<%= ' current' if page.current? %>">
-  <%= link_to_unless page.current?, page, url, {remote: remote, rel: page.rel} %>
+  <%= link_to_unless page.current?, page, url, {remote: remote, data: data, rel: page.rel} %>
 </span>

data/app/views/kaminari/_page.html.haml

@@ -6,5 +6,6 @@
 -#    total_pages:   total number of pages
 -#    per_page:      number of items to fetch per page
 -#    remote:        data-remote
+-#    data:          data-* attributes
 %span{class: "page#{' current' if page.current?}"}
-  = link_to_unless page.current?, page, url, {remote: remote, rel: page.rel}
+  = link_to_unless page.current?, page, url, {remote: remote, data: data, rel: page.rel}

data/app/views/kaminari/_page.html.slim

@@ -6,6 +6,7 @@
     total_pages  : total number of pages
     per_page     : number of items to fetch per page
     remote       : data-remote
+    data         : data-* attributes
 span class="page#{' current' if page.current?}"
-  == link_to_unless page.current?, page, url, {remote: remote, rel: page.rel}
+  == link_to_unless page.current?, page, url, {remote: remote, data: data, rel: page.rel}
 '

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

@@ -4,6 +4,7 @@
     total_pages:   total number of pages
     per_page:      number of items to fetch per page
     remote:        data-remote
+    data:          data-* attributes
     paginator:     the paginator that renders the pagination tags inside
 -%>
 <%= paginator.render do -%>

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

@@ -4,9 +4,10 @@
 -#    total_pages:   total number of pages
 -#    per_page:      number of items to fetch per page
 -#    remote:        data-remote
+-#    data:          data-* attributes
 -#    paginator:     the paginator that renders the pagination tags inside
 = paginator.render do
-  %nav.pagination
+  %nav.pagination{role: "navigation", "aria-label" => "pager"}
     = first_page_tag unless current_page.first?
     = prev_page_tag unless current_page.first?
     - each_page do |page|
@@ -14,5 +15,6 @@
         = page_tag page
       - elsif !page.was_truncated?
         = gap_tag
-    = next_page_tag unless current_page.last?
-    = last_page_tag unless current_page.last?
+    - unless current_page.out_of_range?
+      = next_page_tag unless current_page.last?
+      = last_page_tag unless current_page.last?

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

@@ -4,10 +4,11 @@
     total_pages  : total number of pages
     per_page     : number of items to fetch per page
     remote       : data-remote
+    data         : data-* attributes
     paginator    : the paginator that renders the pagination tags inside
 
 == paginator.render do
-  nav.pagination
+  nav.pagination role="navigation" aria-label="pager"
     == first_page_tag unless current_page.first?
     == prev_page_tag unless current_page.first?
     - each_page do |page|
@@ -15,5 +16,6 @@
         == page_tag page
       - elsif !page.was_truncated?
         == gap_tag
-    == next_page_tag unless current_page.last?
-    == last_page_tag unless current_page.last?
+    - unless current_page.out_of_range?
+      == next_page_tag unless current_page.last?
+      == last_page_tag unless current_page.last?

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

@@ -5,7 +5,8 @@
     total_pages:   total number of pages
     per_page:      number of items to fetch per page
     remote:        data-remote
+    data:          data-* attributes
 -%>
 <span class="prev">
-  <%= link_to_unless current_page.first?, t('views.pagination.previous').html_safe, url, rel: 'prev', remote: remote %>
+  <%= link_to_unless current_page.first?, t('views.pagination.previous').html_safe, url, rel: 'prev', remote: remote, data: data %>
 </span>

data/app/views/kaminari/_prev_page.html.haml

@@ -5,5 +5,6 @@
 -#    total_pages:   total number of pages
 -#    per_page:      number of items to fetch per page
 -#    remote:        data-remote
+-#    data:          data-* attributes
 %span.prev
-  = link_to_unless current_page.first?, t('views.pagination.previous').html_safe, url, rel: 'prev', remote: remote
+  = link_to_unless current_page.first?, t('views.pagination.previous').html_safe, url, rel: 'prev', remote: remote, data: data

data/app/views/kaminari/_prev_page.html.slim

@@ -5,6 +5,7 @@
     total_pages  : total number of pages
     per_page     : number of items to fetch per page
     remote       : data-remote
+    data         : data-* attributes
 span.prev
-  == link_to_unless current_page.first?, t('views.pagination.previous').html_safe, url, rel: 'prev', remote: remote
+  == link_to_unless current_page.first?, t('views.pagination.previous').html_safe, url, rel: 'prev', remote: remote, data: data
 '

data/config/locales/kaminari.yml

@@ -20,4 +20,4 @@ en:
           one: "Displaying <b>1</b> %{entry_name}"
           other: "Displaying <b>all %{count}</b> %{entry_name}"
       more_pages:
-        display_entries: "Displaying %{entry_name} <b>%{first}&nbsp;-&nbsp;%{last}</b> of <b>%{total}</b> in total"
+        display_entries: "Displaying %{entry_name} <b>%{first}–%{last}</b> of <b>%{total}</b> in total"

data/kaminari-core.gemspec

@@ -14,6 +14,13 @@ Gem::Specification.new do |spec|
   spec.description   = 'kaminari-core includes pagination logic independent from ORMs and view libraries'
   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-core',
+    '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/generators/kaminari/views_generator.rb

@@ -9,8 +9,9 @@ module Kaminari
       class_option :template_engine, type: :string, aliases: '-e', desc: 'Template engine for the views. Available options are "erb", "haml", and "slim".'
       class_option :views_prefix, type: :string, desc: 'Prefix for path to put views in.'
 
-      def self.banner #:nodoc:
-        <<-BANNER.chomp
+      class << self
+        def banner #:nodoc:
+          <<-BANNER.chomp
 rails g kaminari:views THEME [options]
 
     Copies all paginator partial templates to your application.
@@ -21,29 +22,35 @@ rails g kaminari:views THEME [options]
             This one is used internally while you don't override the partials.
 #{themes.map {|t| "        - #{t.name}\n#{t.description}"}.join("\n")}
 BANNER
+        end
+
+        def themes
+          @themes ||= GitHubApiHelper.get_files_in_master.group_by {|fn, _| fn[0...(fn.index('/') || 0)]}.delete_if {|fn, _| fn.blank?}.map do |name, files|
+            Theme.new name, files
+          end
+        rescue *GitHubApiHelper::NETWORK_ERRORS
+          []
+        end
       end
 
       desc ''
       def copy_or_fetch #:nodoc:
         return copy_default_views if file_name == 'default'
 
-        if (theme = self.class.themes.detect {|t| t.name == file_name})
+        if self.class.themes.empty?
+          say "could not fetch the themes from GitHub. Please try again later."
+        elsif (theme = self.class.themes.detect {|t| t.name == file_name})
           if download_templates(theme).empty?
             say "template_engine: #{template_engine} is not available for theme: #{file_name}"
           end
         else
           say "no such theme: #{file_name}\n  available themes: #{self.class.themes.map(&:name).join ', '}"
         end
+      rescue *GitHubApiHelper::NETWORK_ERRORS => e
+        say "could not download the templates from GitHub (#{e.message}). Please try again later."
       end
 
       private
-      def self.themes
-        @themes ||= GitHubApiHelper.get_files_in_master.group_by {|fn, _| fn[0...(fn.index('/') || 0)]}.delete_if {|fn, _| fn.blank?}.map do |name, files|
-          Theme.new name, files
-        end
-      rescue SocketError
-        []
-      end
 
       def download_templates(theme)
         theme.templates_for(template_engine).each do |template|
@@ -68,14 +75,21 @@ BANNER
       end
 
       def template_engine
-        engine = options[:template_engine].try(:to_s).try(:downcase)
+        @template_engine ||= begin
+          engine = options[:template_engine].try(:to_s).try(:downcase).presence || 'erb'
 
-        if engine == 'haml' || engine == 'slim'
-          ActiveSupport::Deprecation.warn 'The -e option is deprecated and will be removed in the near future. Please use the html2slim gem or the html2haml gem ' \
-                                          'to convert erb templates manually.'
-        end
+          if engine == 'haml' || engine == 'slim'
+            Kaminari.deprecator.warn 'The -e option is deprecated and will be removed in the near future. Please use the html2slim gem or the html2haml gem ' \
+              'to convert erb templates manually.'
+          end
 
-        engine || 'erb'
+          if %w[erb haml slim].include?(engine)
+            engine
+          else
+            say "template_engine: #{engine} is not supported. Falling back to erb."
+            'erb'
+          end
+        end
       end
     end
 
@@ -103,6 +117,8 @@ BANNER
         file = @templates.detect(&:description?)
         return "#{' ' * 12}#{name}" unless file
         GitHubApiHelper.get_content_for("#{@name}/#{file.name}").chomp.gsub(/^/, ' ' * 12)
+      rescue *GitHubApiHelper::NETWORK_ERRORS
+        "#{' ' * 12}#{name}"
       end
 
       def templates_for(template_engine) #:nodoc:
@@ -112,12 +128,16 @@ BANNER
 
     module GitHubApiHelper
       require 'open-uri'
+      require 'net/http'
+
+      # e.g. offline, timed out, or exceeded the API rate limit
+      NETWORK_ERRORS = [SocketError, SystemCallError, Timeout::Error, OpenSSL::SSL::SSLError, OpenURI::HTTPError].freeze
 
       def get_files_in_master
         master_tree_sha = URI.open('https://api.github.com/repos/amatsuda/kaminari_themes/git/refs/heads/master') do |json|
           ActiveSupport::JSON.decode(json.read)['object']['sha']
         end
-        URI.open('https://api.github.com/repos/amatsuda/kaminari_themes/git/trees/' + master_tree_sha + '?recursive=1') do |json|
+        URI.parse("https://api.github.com/repos/amatsuda/kaminari_themes/git/trees/#{master_tree_sha}?recursive=1").open do |json|
           blobs = ActiveSupport::JSON.decode(json.read)['tree'].find_all {|i| i['type'] == 'blob' }
           blobs.map do |blob|
             [blob['path'], blob['sha']]
@@ -127,7 +147,7 @@ BANNER
       module_function :get_files_in_master
 
       def get_content_for(path)
-        URI.open('https://api.github.com/repos/amatsuda/kaminari_themes/contents/' + path) do |json|
+        URI.parse("https://api.github.com/repos/amatsuda/kaminari_themes/contents/#{path}").open do |json|
           Base64.decode64(ActiveSupport::JSON.decode(json.read)['content'])
         end
       end

data/lib/kaminari/core/version.rb

@@ -2,6 +2,6 @@
 
 module Kaminari
   module Core
-    VERSION = '1.2.2'
+    VERSION = '1.3.0'
   end
 end

data/lib/kaminari/core.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 
 module Kaminari
+  def self.deprecator
+    @deprecator ||= ActiveSupport::Deprecation.new("2.0", "kaminari-core")
+  end
 end
 
 # load Rails/Railtie
@@ -14,6 +17,7 @@ end
 require 'kaminari/config'
 require 'kaminari/exceptions'
 require 'kaminari/helpers/paginator'
+require 'kaminari/helpers/helper_methods'
 require 'kaminari/models/page_scope_methods'
 require 'kaminari/models/configuration_methods'
 require 'kaminari/models/array_extension'

data/lib/kaminari/engine.rb

@@ -2,5 +2,8 @@
 
 module Kaminari #:nodoc:
   class Engine < ::Rails::Engine #:nodoc:
+    initializer :deprecator do |app|
+      app.deprecators[:kaminari] = Kaminari.deprecator if app.respond_to?(:deprecators)
+    end
   end
 end

data/lib/kaminari/helpers/helper_methods.rb

@@ -44,7 +44,7 @@ module Kaminari
       alias url_to_next_page next_page_url
 
       def path_to_next_url(scope, options = {})
-        ActiveSupport::Deprecation.warn 'path_to_next_url is deprecated. Use next_page_url or url_to_next_page instead.'
+        Kaminari.deprecator.warn 'path_to_next_url is deprecated. Use next_page_url or url_to_next_page instead.'
         next_page_url(scope, options)
       end
 
@@ -110,10 +110,12 @@ module Kaminari
       # * <tt>:params</tt> - url_for parameters for the links (:controller, :action, etc.)
       # * <tt>:param_name</tt> - parameter name for page number in the links (:page by default)
       # * <tt>:remote</tt> - Ajax? (false by default)
+      # * <tt>:data</tt> - data-* attributes for the links (e.g. <tt>{turbo_frame: 'users'}</tt>)
       # * <tt>:paginator_class</tt> - Specify a custom Paginator (Kaminari::Helpers::Paginator by default)
       # * <tt>:template</tt> - Specify a custom template renderer for rendering the Paginator (receiver by default)
       # * <tt>:ANY_OTHER_VALUES</tt> - Any other hash key & values would be directly passed into each tag as :locals value.
       def paginate(scope, paginator_class: Kaminari::Helpers::Paginator, template: nil, **options)
+        options[:data] ||= {}
         options[:total_pages] ||= scope.total_pages
         options.reverse_merge! current_page: scope.current_page, per_page: scope.limit_value, remote: false
 
@@ -193,23 +195,36 @@ module Kaminari
       #
       # By default, the message will use the humanized class name of objects
       # in collection: for instance, "project types" for ProjectType models.
-      # The namespace will be cutted out and only the last name will be used.
+      # The namespace will be cut out and only the last name will be used.
       # Override this with the <tt>:entry_name</tt> parameter:
       #
       #   <%= page_entries_info @posts, entry_name: 'item' %>
       #   #-> Displaying items 6 - 10 of 26 in total
       def page_entries_info(collection, entry_name: nil)
+        records = collection.respond_to?(:records) ? collection.records : collection.to_a
+        page_size = records.size
         entry_name = if entry_name
-                       entry_name.pluralize(collection.size, I18n.locale)
+                       pluralized = entry_name.pluralize(page_size, I18n.locale)
+                       entry_name.html_safe? ? pluralized.html_safe : pluralized
                      else
-                       collection.entry_name(count: collection.size).downcase
+                       collection.entry_name(count: page_size).downcase
                      end
+        # the translated message is marked as html_safe, so the interpolated entry_name has to be escaped here
+        entry_name = ERB::Util.html_escape entry_name
 
-        if collection.total_pages < 2
+        if collection.out_of_range?
+          # an out of range page displays no entries
+          t('helpers.page_entries_info.one_page.display_entries', entry_name: entry_name, count: 0)
+        elsif collection.total_pages < 2
           t('helpers.page_entries_info.one_page.display_entries', entry_name: entry_name, count: collection.total_count)
         else
           from = collection.offset_value + 1
-          to   = collection.offset_value + (collection.respond_to?(:records) ? collection.records : collection.to_a).size
+          to =
+            if collection.is_a? ::Kaminari::PaginatableArray
+              [collection.offset_value + collection.limit_value, collection.total_count].min
+            else
+              collection.offset_value + page_size
+            end
 
           t('helpers.page_entries_info.more_pages.display_entries', entry_name: entry_name, first: from, last: to, total: collection.total_count)
         end.html_safe

data/lib/kaminari/helpers/paginator.rb

@@ -8,9 +8,13 @@ module Kaminari
     # The main container tag
     class Paginator < Tag
       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:
+        super template, **options
+
         @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
+        @last = nil
+        # shared by all the tags in this paginator
+        @url_cache, @partial_cache = {}, {}
         @window_options.merge! @options
         @window_options[:current_page] = @options[:current_page] = PageProxy.new(@window_options, @options[:current_page], nil)
 
@@ -59,13 +63,13 @@ module Kaminari
       private :relevant_pages
 
       def page_tag(page)
-        @last = Page.new @template, **@options.merge(page: page)
+        @last = Page.new @template, param_name: @param_name, theme: @theme, views_prefix: @views_prefix, internal_params: @params, internal_url_cache: @url_cache, internal_partial_cache: @partial_cache, **@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, param_name: @param_name, theme: @theme, views_prefix: @views_prefix, internal_params: @params, internal_url_cache: @url_cache, internal_partial_cache: @partial_cache, **@options
           end
         DEF
       end
@@ -78,8 +82,8 @@ module Kaminari
       end
 
       # delegates view helper methods to @template
-      def method_missing(name, *args, &block)
-        @template.respond_to?(name) ? @template.send(name, *args, &block) : super
+      def method_missing(name, *args, **kwargs, &block)
+        @template.respond_to?(name) ? @template.send(name, *args, **kwargs, &block) : super
       end
       private :method_missing
 
@@ -88,7 +92,13 @@ module Kaminari
         include Comparable
 
         def initialize(options, page, last) #:nodoc:
-          @options, @page, @last = options, page, last
+          @page = page
+          @current_page = options[:current_page]
+          @total_pages = options[:total_pages]
+          @left = options[:left]
+          @right = options[:right]
+          @window = options[:window]
+          @was_truncated = last.is_a? Gap
         end
 
         # the page number
@@ -98,7 +108,7 @@ module Kaminari
 
         # current page or not
         def current?
-          @page == @options[:current_page]
+          @page == @current_page
         end
 
         # the first page or not
@@ -108,17 +118,17 @@ module Kaminari
 
         # the last page or not
         def last?
-          @page == @options[:total_pages]
+          @page == @total_pages
         end
 
         # the previous page or not
         def prev?
-          @page == @options[:current_page] - 1
+          @page == @current_page - 1
         end
 
         # the next page or not
         def next?
-          @page == @options[:current_page] + 1
+          @page == @current_page + 1
         end
 
         # relationship with the current page
@@ -132,33 +142,33 @@ module Kaminari
 
         # within the left outer window or not
         def left_outer?
-          @page <= @options[:left]
+          @page <= @left
         end
 
         # within the right outer window or not
         def right_outer?
-          @options[:total_pages] - @page < @options[:right]
+          @total_pages - @page < @right
         end
 
         # inside the inner window or not
         def inside_window?
-          (@options[:current_page] - @page).abs <= @options[:window]
+          (@current_page - @page).abs <= @window
         end
 
         # Current page is an isolated gap or not
         def single_gap?
-          ((@page == @options[:current_page] - @options[:window] - 1) && (@page == @options[:left] + 1)) ||
-            ((@page == @options[:current_page] + @options[:window] + 1) && (@page == @options[:total_pages] - @options[:right]))
+          ((@page == @current_page - @window - 1) && (@page == @left + 1)) ||
+            ((@page == @current_page + @window + 1) && (@page == @total_pages - @right))
         end
 
         # The page number exceeds the range of pages or not
         def out_of_range?
-          @page > @options[:total_pages]
+          @page > @total_pages
         end
 
         # The last rendered tag was "truncated" or not
         def was_truncated?
-          @last.is_a? Gap
+          @was_truncated
         end
 
         #Should we display the link tag?

data/lib/kaminari/helpers/tags.rb

@@ -2,7 +2,8 @@
 
 module Kaminari
   module Helpers
-    PARAM_KEY_EXCEPT_LIST = [:authenticity_token, :commit, :utf8, :_method, :script_name, :original_script_name].freeze
+    PARAM_KEY_EXCEPT_LIST = [:authenticity_token, :commit, :utf8, :_method, :script_name, :original_script_name,
+                             :subdomain, :domain, :tld_length, :host, :port, :protocol, :anchor, :trailing_slash, :params, :path_params].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
@@ -17,56 +18,124 @@ module Kaminari
     # installed template will be used.
     #   e.g.)  Paginator  ->  $GEM_HOME/kaminari-x.x.x/app/views/kaminari/_paginator.html.erb
     class Tag
-      def initialize(template, params: {}, param_name: nil, theme: nil, views_prefix: nil, **options) #:nodoc:
+      # A page number that is unlikely to appear in any URL, which stands in for the actual page number in the cached URL
+      PAGE_PLACEHOLDER = rand(10**17...10**18)
+
+      def initialize(template, params: nil, param_name: nil, theme: nil, views_prefix: nil, internal_params: nil, internal_url_cache: nil, internal_partial_cache: nil, **options) #:nodoc:
         @template, @theme, @views_prefix, @options = template, theme, views_prefix, options
         @param_name = param_name || Kaminari.config.param_name
-        @params = template.params
-        # @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_EXCEPT_LIST)
-        @params.merge! params
+        @url_cache, @partial_cache = internal_url_cache, internal_partial_cache
+
+        if internal_params
+          @params = internal_params
+        else
+          @params = template.params
+          # @params in Rails 5 no longer inherits from Hash
+          @params = if @params.respond_to?(:to_unsafe_h)
+            @params.to_unsafe_h
+          else
+            @params.with_indifferent_access
+          end
+          @params.except!(*PARAM_KEY_EXCEPT_LIST)
+          @params.merge! params if params
+        end
       end
 
       def to_s(locals = {}) #:nodoc:
-        formats = (@template.respond_to?(:formats) ? @template.formats : Array(@template.params[:format])) + [:html]
-        @template.render partial: partial_path, locals: @options.merge(locals), formats: formats
+        formats = @template.respond_to?(:formats) ? @template.formats : Array(@template.params[:format])
+        if @partial_cache && formats.include?(:html) && @template.respond_to?(:lookup_context)
+          render_cached_partial @options.merge(locals)
+        else
+          formats += [:html] unless formats.include? :html
+          @template.render partial: partial_path, locals: @options.merge(locals), formats: formats
+        end
       end
 
       def page_url_for(page)
+        @url_cache ? cached_page_url_for(page.to_i) : generate_page_url(page)
+      end
+
+      private
+
+      # Looking up a partial template is costly, so the paginator looks up each partial only once, and then renders the
+      # template directly in the same way as `render partial:` does.
+      # This is done only when the formats already include :html, which means the formats that `to_s` would pass to
+      # `render` are the same as the current ones, and so finding and rendering the template doesn't depend on the formats.
+      def render_cached_partial(locals)
+        path, keys = partial_path, locals.keys
+        cached_keys, template = @partial_cache[path]
+        unless template && (cached_keys == keys)
+          template = @template.lookup_context.find_template(path, [], true, keys)
+          @partial_cache[path] = [keys, template]
+        end
+        # `render partial:` in Action View 4 also puts the partial name into local_assigns (e.g. {gap: nil, ...})
+        if ActionView::VERSION::MAJOR < 5
+          name = File.basename(path).to_sym
+          locals[name] = nil unless locals.key? name
+        end
+
+        ActiveSupport::Notifications.instrument('render_partial.action_view', identifier: template.identifier, layout: nil, locals: locals) do
+          template.render(@template, locals) {|*name| @template._layout_for(*name) }
+        end
+      end
+
+      def generate_page_url(page)
         params = params_for(page)
         params[:only_path] = true
         @template.url_for params
       end
 
-      private
+      # Generating URLs is costly, so the paginator generates the URL only once with a placeholder page number,
+      # and then builds the URL for each page by replacing the placeholder
+      def cached_page_url_for(page)
+        @url_cache.fetch(page) do
+          url_template = @url_cache[:url_template]
+          @url_cache[page] = if url_template && (page > 1)
+            url_template.sub(PAGE_PLACEHOLDER.to_s, page.to_s)
+          else
+            generate_page_url(page).tap {|url| build_url_template(page, url) if url_template.nil? && (page > 1) }
+          end
+        end
+      end
 
-      def params_for(page)
-        page_params = Rack::Utils.parse_nested_query("#{@param_name}=#{page}")
-        page_params = @params.deep_merge(page_params)
-
-        if !Kaminari.config.params_on_first_page && (page <= 1)
-          # This converts a hash:
-          #   from: {other: "params", page: 1}
-          #     to: {other: "params", page: nil}
-          #   (when @param_name == "page")
-          #
-          #   from: {other: "params", user: {name: "yuki", page: 1}}
-          #     to: {other: "params", user: {name: "yuki", page: nil}}
-          #   (when @param_name == "user[page]")
-          @param_name.to_s.scan(/[\w\.]+/)[0..-2].inject(page_params){|h, k| h[k] }[$&] = nil
+      # Use the URL with the placeholder only when it builds exactly the same URL as url_for does.
+      # Otherwise (e.g. when the routes constrain the page number), fall back to calling url_for for each page.
+      def build_url_template(page, url)
+        url_template = begin
+          generate_page_url PAGE_PLACEHOLDER
+        rescue StandardError
+          nil
         end
+        @url_cache[:url_template] = url_template && (url_template.scan(PAGE_PLACEHOLDER.to_s).size == 1) && (url_template.sub(PAGE_PLACEHOLDER.to_s, page.to_s) == url) ? url_template : false
+      end
 
-        page_params
+      def params_for(page)
+        if (@param_name == :page) || !@param_name.to_s.include?('[')
+          page_val = !Kaminari.config.params_on_first_page && (page <= 1) ? nil : page
+          @params[@param_name] = page_val
+          @params
+        else
+          page_params = Rack::Utils.parse_nested_query("#{@param_name}=#{page}")
+          page_params = @params.deep_merge(page_params)
+
+          if !Kaminari.config.params_on_first_page && (page <= 1)
+            # This converts a hash:
+            #   from: {other: "params", page: 1}
+            #     to: {other: "params", page: nil}
+            #   (when @param_name == "page")
+            #
+            #   from: {other: "params", user: {name: "yuki", page: 1}}
+            #     to: {other: "params", user: {name: "yuki", page: nil}}
+            #   (when @param_name == "user[page]")
+            @param_name.to_s.scan(/[\w.]+/)[0..-2].inject(page_params){|h, k| h[k] }[$&] = nil
+          end
+
+          page_params
+        end
       end
 
       def partial_path
-        [
-         @views_prefix,
-         "kaminari",
-         @theme,
-         self.class.name.demodulize.underscore
-        ].compact.join("/").gsub('//', '/')
+        "#{@views_prefix}/kaminari/#{@theme}/#{self.class.name.demodulize.underscore}".gsub('//', '/')
       end
     end
 
@@ -124,7 +193,7 @@ module Kaminari
         # 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.'
+          Kaminari.deprecator.warn 'Explicitly passing params to helpers could be omitted.'
           params = params.to_unsafe_h
         end
 
@@ -145,7 +214,7 @@ module Kaminari
         # 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.'
+          Kaminari.deprecator.warn 'Explicitly passing params to helpers could be omitted.'
           params = params.to_unsafe_h
         end
 

data/lib/kaminari/models/array_extension.rb

@@ -41,13 +41,19 @@ module Kaminari
     # items at the specified "page"
     class_eval <<-RUBY, __FILE__, __LINE__ + 1
       def #{Kaminari.config.page_method_name}(num = 1)
+        num = num.respond_to?(:to_i) ? num.to_i : 1
         offset(limit_value * ((num = num.to_i - 1) < 0 ? 0 : num))
       end
     RUBY
 
     # returns another chunk of the original array
     def limit(num)
-      self.class.new @_original_array, limit: num, offset: @_offset_value, total_count: @_total_count, padding: @_padding
+      spawn limit: num, offset: @_offset_value
+    end
+
+    # overridden by Kaminari::PageScopeMethods once paginated
+    def paginated?
+      false
     end
 
     # total item numbers of the original array
@@ -57,7 +63,17 @@ module Kaminari
 
     # returns another chunk of the original array
     def offset(num)
-      self.class.new @_original_array, limit: @_limit_value, offset: num, total_count: @_total_count, padding: @_padding
+      spawn limit: @_limit_value, offset: num
+    end
+
+    private
+
+    # Builds another chunk of the original array, carrying over the per page settings given to this one
+    def spawn(limit:, offset:)
+      self.class.new(@_original_array, limit: limit, offset: offset, total_count: @_total_count, padding: @_padding).tap do |array|
+        array.instance_variable_set :@_per, @_per if defined?(@_per)
+        array.instance_variable_set :@_max_per_page, @_max_per_page if defined?(@_max_per_page)
+      end
     end
   end
 

data/lib/kaminari/models/configuration_methods.rb

@@ -52,7 +52,7 @@ module Kaminari
       end
 
       def max_pages_per(val)
-        ActiveSupport::Deprecation.warn 'max_pages_per is deprecated. Use max_pages instead.'
+        Kaminari.deprecator.warn 'max_pages_per is deprecated. Use max_pages instead.'
         max_pages val
       end
     end

data/lib/kaminari/models/page_scope_methods.rb

@@ -6,29 +6,31 @@ module Kaminari
     #   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 || default_per_page).to_i
-      if (n = num.to_i) < 0 || !(/^\d/ =~ num.to_s)
-        self
-      elsif n.zero?
+      # ignore a negative or a non-numeric value, and keep the current per value
+      return self if (n = num.to_i) < 0 || !(/\A\d/ =~ num.to_s)
+
+      per_value = n
+      if n.zero?
         limit(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)
-      end
+        n = max_per_page if max_per_page && (max_per_page < n)
+        padding_value = (defined?(@_padding) && @_padding) || 0
+        # the current page is unknown after per(0), so go back to the first page
+        page_offset = limit_value.zero? ? 0 : (offset_value - padding_value) / limit_value * n
+        limit_and_offset n, page_offset + padding_value
+      end.tap {|scope| scope.instance_variable_set :@_per, per_value }
     end
 
     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).tap do |scope|
+        scope.instance_variable_set :@_max_per_page, new_max_per_page
+      end
     end
 
     def padding(num)
       num = num.to_i
       raise ArgumentError, "padding must not be negative" if num < 0
-      @_padding = num
-      offset(offset_value + @_padding)
+      offset(offset_value + num).tap {|scope| scope.instance_variable_set :@_padding, num }
     end
 
     # Total number of pages
@@ -56,8 +58,8 @@ module Kaminari
 
     # 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.'
+      Kaminari.deprecator.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
@@ -87,5 +89,16 @@ module Kaminari
     def out_of_range?
       current_page > total_pages
     end
+
+    def paginated?
+      limit_value.present?
+    end
+
+    private
+
+    # Returns another scope with the given limit and offset
+    def limit_and_offset(new_limit, new_offset)
+      limit(new_limit).offset(new_offset)
+    end
   end
 end

metadata

@@ -1,113 +1,118 @@
 --- !ruby/object:Gem::Specification
 name: kaminari-core
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.3.0
 platform: ruby
 authors:
-- Akira Matsuda
-autorequire:
+  - Akira Matsuda
 bindir: bin
 cert_chain: []
-date: 2021-12-25 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.13'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.13'
-- !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-core includes pagination logic independent from ORMs and view
-  libraries
+  - !ruby/object:Gem::Dependency
+    name: bundler
+    requirement: !ruby/object:Gem::Requirement
+      requirements:
+        -
+          - ">="
+          - !ruby/object:Gem::Version
+            version: "1.13"
+    type: :development
+    prerelease: false
+    version_requirements: !ruby/object:Gem::Requirement
+      requirements:
+        -
+          - ">="
+          - !ruby/object:Gem::Version
+            version: "1.13"
+  - !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-core includes pagination logic independent from ORMs and view libraries
 email:
-- ronnie@dio.jp
+  - ronnie@dio.jp
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- CHANGELOG.md
-- MIT-LICENSE
-- README.md
-- app/views/kaminari/_first_page.html.erb
-- app/views/kaminari/_first_page.html.haml
-- app/views/kaminari/_first_page.html.slim
-- app/views/kaminari/_gap.html.erb
-- app/views/kaminari/_gap.html.haml
-- app/views/kaminari/_gap.html.slim
-- app/views/kaminari/_last_page.html.erb
-- app/views/kaminari/_last_page.html.haml
-- app/views/kaminari/_last_page.html.slim
-- app/views/kaminari/_next_page.html.erb
-- app/views/kaminari/_next_page.html.haml
-- app/views/kaminari/_next_page.html.slim
-- app/views/kaminari/_page.html.erb
-- app/views/kaminari/_page.html.haml
-- app/views/kaminari/_page.html.slim
-- app/views/kaminari/_paginator.html.erb
-- app/views/kaminari/_paginator.html.haml
-- app/views/kaminari/_paginator.html.slim
-- app/views/kaminari/_prev_page.html.erb
-- app/views/kaminari/_prev_page.html.haml
-- app/views/kaminari/_prev_page.html.slim
-- config/locales/kaminari.yml
-- kaminari-core.gemspec
-- lib/generators/kaminari/config_generator.rb
-- lib/generators/kaminari/templates/kaminari_config.rb
-- lib/generators/kaminari/views_generator.rb
-- lib/kaminari/config.rb
-- lib/kaminari/core.rb
-- lib/kaminari/core/version.rb
-- lib/kaminari/engine.rb
-- lib/kaminari/exceptions.rb
-- lib/kaminari/helpers/helper_methods.rb
-- lib/kaminari/helpers/paginator.rb
-- lib/kaminari/helpers/tags.rb
-- lib/kaminari/models/array_extension.rb
-- lib/kaminari/models/configuration_methods.rb
-- lib/kaminari/models/page_scope_methods.rb
-- lib/kaminari/railtie.rb
-homepage: https://github.com/kaminari/kaminari
+  - CHANGELOG.md
+  - MIT-LICENSE
+  - README.md
+  - app/views/kaminari/_first_page.html.erb
+  - app/views/kaminari/_first_page.html.haml
+  - app/views/kaminari/_first_page.html.slim
+  - app/views/kaminari/_gap.html.erb
+  - app/views/kaminari/_gap.html.haml
+  - app/views/kaminari/_gap.html.slim
+  - app/views/kaminari/_last_page.html.erb
+  - app/views/kaminari/_last_page.html.haml
+  - app/views/kaminari/_last_page.html.slim
+  - app/views/kaminari/_next_page.html.erb
+  - app/views/kaminari/_next_page.html.haml
+  - app/views/kaminari/_next_page.html.slim
+  - app/views/kaminari/_page.html.erb
+  - app/views/kaminari/_page.html.haml
+  - app/views/kaminari/_page.html.slim
+  - app/views/kaminari/_paginator.html.erb
+  - app/views/kaminari/_paginator.html.haml
+  - app/views/kaminari/_paginator.html.slim
+  - app/views/kaminari/_prev_page.html.erb
+  - app/views/kaminari/_prev_page.html.haml
+  - app/views/kaminari/_prev_page.html.slim
+  - config/locales/kaminari.yml
+  - kaminari-core.gemspec
+  - lib/generators/kaminari/config_generator.rb
+  - lib/generators/kaminari/templates/kaminari_config.rb
+  - lib/generators/kaminari/views_generator.rb
+  - lib/kaminari/config.rb
+  - lib/kaminari/core.rb
+  - lib/kaminari/core/version.rb
+  - lib/kaminari/engine.rb
+  - lib/kaminari/exceptions.rb
+  - lib/kaminari/helpers/helper_methods.rb
+  - lib/kaminari/helpers/paginator.rb
+  - lib/kaminari/helpers/tags.rb
+  - lib/kaminari/models/array_extension.rb
+  - lib/kaminari/models/configuration_methods.rb
+  - lib/kaminari/models/page_scope_methods.rb
+  - lib/kaminari/railtie.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-core"
+  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.3.0.dev
-signing_key:
+rubygems_version: 4.1.0.beta2
 specification_version: 4
 summary: Kaminari's core pagination library
 test_files: []