will_paginate 3.1.5 → 4.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 5b9c92a0ce3f9e697334ea1bf11c0b57bdfd9fe2
-  data.tar.gz: b2794b2de86ceaa34f86d06f2c1952484b5409f9
+SHA256:
+  metadata.gz: 147ccc8d263975ac53363e03b1ac0e8721a0d2dc3384541b12396335063dbdd5
+  data.tar.gz: 5dc1129aadadf3d861c99cebd6b664b9becf1113ec97f3ae6c2dfb58531b570d
 SHA512:
-  metadata.gz: fe7a7e48c35bda6cd6648f5243f3992ebe576f586afd5d140066fa05ecdd83862681245f44e554f5483e5dc4fe9f957e3b84b6208cc91a8e1dd1804c8593a49b
-  data.tar.gz: 5c388ced4fd0b8ad3da2ce6c5e9b2323b4cff1b950fdf3b35cc6e148b1e12509e8b6c0b83156b483d1a732ce4fe2497a4c09553b2650775cc922803699bf4347
+  metadata.gz: 3ebb1d0564768b4380bd06fceb2f9284065c292812a26c521b401b911bb7561dde76a90ce50024a39a22b63a40fc6f20ebac43364fc989f68bca70f57f39aa20
+  data.tar.gz: f021cb3e9fbbc704439323d41e93897f40d536fc2adfa5ee9c9101e56e4f1a65e1ad0c9cb268ed1a4f3d1eb1d485dbe1bf5d4fd7d082a1bef2c914cbb4970970

data/README.md

@@ -1,25 +1,23 @@
 # will_paginate
 
-will_paginate is a pagination library that integrates with Ruby on Rails, Sinatra, Merb, DataMapper and Sequel.
-
-Installation:
+will_paginate is a pagination library that integrates with Ruby on Rails, Sinatra, Hanami::View, and Sequel.
 
 ``` ruby
-## Gemfile for Rails 3+, Sinatra, and Merb
-gem 'will_paginate', '~> 3.1.0'
+gem 'will_paginate', '~> 4.0'
 ```
 
 See [installation instructions][install] on the wiki for more info.
 
+ℹ️ will_paginate is now in _maintenance mode_ and it will not be receiving new features. [See alternatives](https://www.ruby-toolbox.com/categories/pagination)
 
 ## Basic will_paginate use
 
 ``` ruby
 ## perform a paginated query:
-@posts = Post.paginate(:page => params[:page])
+@posts = Post.paginate(page: params[:page])
 
 # or, use an explicit "per page" limit:
-Post.paginate(:page => params[:page], :per_page => 30)
+Post.paginate(page: params[:page], per_page: 30)
 
 ## render page links in the view:
 <%= will_paginate @posts %>
@@ -43,19 +41,18 @@ New in Active Record 3:
 
 ``` ruby
 # paginate in Active Record now returns a Relation
-Post.where(:published => true).paginate(:page => params[:page]).order('id DESC')
+Post.where(published: true).paginate(page: params[:page]).order(id: :desc)
 
 # the new, shorter page() method
-Post.page(params[:page]).order('created_at DESC')
+Post.page(params[:page]).order(created_at: :desc)
 ```
 
-See [the wiki][wiki] for more documentation. [Ask on the group][group] if you have usage questions. [Report bugs][issues] on GitHub.
+See [the wiki][wiki] for more documentation. [Report bugs][issues] on GitHub.
 
 Happy paginating.
 
 
 [wiki]: https://github.com/mislav/will_paginate/wiki
 [install]: https://github.com/mislav/will_paginate/wiki/Installation "will_paginate installation"
-[group]: http://groups.google.com/group/will_paginate "will_paginate discussion and support group"
 [issues]: https://github.com/mislav/will_paginate/issues
 [css]: http://mislav.github.io/will_paginate/

data/lib/will_paginate/active_record.rb

@@ -83,7 +83,10 @@ module WillPaginate
           excluded = [:order, :limit, :offset, :reorder]
           excluded << :includes unless eager_loading?
           rel = self.except(*excluded)
-          column_name = (select_for_count(rel) || :all)
+          column_name = if rel.select_values.present?
+            select = rel.select_values.join(", ")
+            select if select !~ /[,*]/
+          end || :all
           rel.count(column_name)
         else
           super(*args)
@@ -102,9 +105,7 @@ module WillPaginate
       # overloaded to be pagination-aware
       def empty?
         if !loaded? and offset_value
-          result = count
-          result = result.size if result.respond_to?(:size) and !result.is_a?(Integer)
-          result <= offset_value
+          total_entries <= offset_value
         else
           super
         end
@@ -136,13 +137,6 @@ module WillPaginate
         other.total_entries = nil if defined? @total_entries_queried
         other
       end
-      
-      def select_for_count(rel)
-        if rel.select_values.present?
-          select = rel.select_values.join(", ")
-          select if select !~ /[,*]/
-        end
-      end
     end
 
     module Pagination
@@ -216,6 +210,8 @@ module WillPaginate
                 WHERE rownum <= #{pager.offset + pager.per_page}
               ) WHERE rnum >= #{pager.offset}
             SQL
+          elsif (self.connection.adapter_name =~ /^sqlserver/i)
+            query << " OFFSET #{pager.offset} ROWS FETCH NEXT #{pager.per_page} ROWS ONLY"
           else
             query << " LIMIT #{pager.per_page} OFFSET #{pager.offset}"
           end

data/lib/will_paginate/deprecation.rb

@@ -31,8 +31,8 @@ module WillPaginate::Deprecation
       super
     end
 
-    def deprecate_key(*keys)
-      message = block_given? ? Proc.new : keys.pop
+    def deprecate_key(*keys, &block)
+      message = block_given? ? block : keys.pop
       Array(keys).each { |key| @deprecated[key] = message }
     end
 

data/lib/will_paginate/i18n.rb

@@ -8,11 +8,11 @@ module WillPaginate
       Dir["#{locale_dir}/*.{rb,yml}"]
     end
 
-    def will_paginate_translate(keys, options = {})
+    def will_paginate_translate(keys, options = {}, &block)
       if defined? ::I18n
         defaults = Array(keys).dup
-        defaults << Proc.new if block_given?
-        ::I18n.translate(defaults.shift, options.merge(:default => defaults, :scope => :will_paginate))
+        defaults << block if block_given?
+        ::I18n.translate(defaults.shift, **options.merge(:default => defaults, :scope => :will_paginate))
       else
         key = Array === keys ? keys.first : keys
         yield key, options

data/lib/will_paginate/locale/en.yml

@@ -1,8 +1,12 @@
 en:
   will_paginate:
     previous_label: "← Previous"
+    previous_aria_label: "Previous page"
     next_label: "Next →"
+    next_aria_label: "Next page"
     page_gap: "…"
+    container_aria_label: "Pagination"
+    page_aria_label: "Page %{page}"
 
     page_entries_info:
       single_page:

data/lib/will_paginate/mongoid.rb

@@ -8,6 +8,8 @@ module WillPaginate
         extend CollectionMethods
         @current_page = WillPaginate::PageNumber(options[:page] || @current_page || 1)
         @page_multiplier = current_page - 1
+        @total_entries = options.delete(:total_entries)
+
         pp = (options[:per_page] || per_page || WillPaginate.per_page).to_i
         limit(pp).skip(@page_multiplier * pp)
       end

data/lib/will_paginate/page_number.rb

@@ -1,4 +1,3 @@
-require 'delegate'
 require 'forwardable'
 
 module WillPaginate
@@ -6,7 +5,7 @@ module WillPaginate
   module InvalidPage; end
 
   # integer representing a page number
-  class PageNumber < DelegateClass(Integer)
+  class PageNumber < Numeric
     # a value larger than this is not supported in SQL queries
     BIGINT = 9223372036854775807
 
@@ -18,13 +17,17 @@ module WillPaginate
         raise RangeError, "invalid #{name}: #{value.inspect}"
       end
       @name = name
-      super(value)
+      @value = value
     rescue ArgumentError, TypeError, RangeError => error
       error.extend InvalidPage
       raise error
     end
 
-    alias_method :to_i, :__getobj__
+    def to_i
+      @value
+    end
+
+    def_delegators :@value, :coerce, :==, :<=>, :to_s, :+, :-, :*, :/, :to_json
 
     def inspect
       "#{@name} #{to_i}"
@@ -40,13 +43,6 @@ module WillPaginate
     alias is_a? kind_of?
   end
 
-  # Ultrahax: makes `Fixnum === current_page` checks pass
-  Numeric.extend Module.new {
-    def ===(obj)
-      obj.instance_of? PageNumber or super
-    end
-  }
-
   # An idemptotent coercion method
   def self.PageNumber(value, name = 'page')
     case value

data/lib/will_paginate/railtie.rb

@@ -1,4 +1,3 @@
-require 'will_paginate'
 require 'will_paginate/page_number'
 require 'will_paginate/collection'
 require 'will_paginate/i18n'
@@ -39,7 +38,7 @@ module WillPaginate
       end
       def status_code_with_paginate(exception = @exception)
         actual_exception = if exception.respond_to?(:cause)
-          exception.cause
+          exception.cause || exception
         elsif exception.respond_to?(:original_exception)
           exception.original_exception
         else
@@ -60,11 +59,11 @@ module WillPaginate
     end
 
     module ControllerRescuePatch
-      def rescue_from(*args, &block)
+      def rescue_from(*args, **kwargs, &block)
         if idx = args.index(WillPaginate::InvalidPage)
           args[idx] = args[idx].name
         end
-        super(*args, &block)
+        super(*args, **kwargs, &block)
       end
     end
   end

data/lib/will_paginate/version.rb

@@ -1,8 +1,8 @@
 module WillPaginate #:nodoc:
   module VERSION #:nodoc:
-    MAJOR = 3
-    MINOR = 1
-    TINY  = 5
+    MAJOR = 4
+    MINOR = 0
+    TINY  = 1
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/lib/will_paginate/view_helpers/action_view.rb

@@ -43,7 +43,7 @@ module WillPaginate
     # Wrapper for rendering pagination links at both top and bottom of a block
     # of content.
     # 
-    #   <% paginated_section @posts do %>
+    #   <%= paginated_section @posts do %>
     #     <ol id="posts">
     #       <% for post in @posts %>
     #         <li> ... </li>
@@ -80,7 +80,7 @@ module WillPaginate
           defaults = nil
           key = keys
         end
-        translate(key, options.merge(:default => defaults, :scope => :will_paginate))
+        translate(key, **options.merge(:default => defaults, :scope => :will_paginate))
       else
         super
       end
@@ -119,8 +119,12 @@ module WillPaginate
       end
 
       def merge_get_params(url_params)
-        if @template.respond_to? :request and @template.request and @template.request.get?
-          symbolized_update(url_params, @template.params, GET_PARAMS_BLACKLIST)
+        if @template.respond_to?(:request) and @template.request
+          if @template.request.get?
+            symbolized_update(url_params, @template.params, GET_PARAMS_BLACKLIST)
+          elsif @template.request.respond_to?(:query_parameters)
+            symbolized_update(url_params, @template.request.query_parameters, GET_PARAMS_BLACKLIST)
+          end
         end
         url_params
       end

data/lib/will_paginate/view_helpers/hanami.rb

@@ -0,0 +1,41 @@
+require 'hanami/view'
+require 'will_paginate/view_helpers'
+require 'will_paginate/view_helpers/link_renderer'
+
+module WillPaginate
+  module Hanami
+    module Helpers
+      include ViewHelpers
+
+      def will_paginate(collection, options = {}) #:nodoc:
+        options = options.merge(:renderer => LinkRenderer) unless options[:renderer]
+        str = super(collection, options)
+        str && raw(str)
+      end
+    end
+
+    class LinkRenderer < ViewHelpers::LinkRenderer
+      protected
+
+      def url(page)
+        str = File.join(request_env['SCRIPT_NAME'].to_s, request_env['PATH_INFO'])
+        params = request_env['rack.request.query_hash'].merge(param_name.to_s => page.to_s)
+        params.update @options[:params] if @options[:params]
+        str << '?' << build_query(params)
+      end
+
+      def request_env
+        @template.params.env
+      end
+
+      def build_query(params)
+        Rack::Utils.build_nested_query params
+      end
+    end
+
+    def self.included(base)
+      base.include Helpers
+    end
+
+  end
+end

data/lib/will_paginate/view_helpers/link_renderer.rb

@@ -24,7 +24,7 @@ module WillPaginate
       # method as you see fit.
       def to_html
         html = pagination.map do |item|
-          item.is_a?(Fixnum) ?
+          item.is_a?(Integer) ?
             page_number(item) :
             send(item)
         end.join(@options[:link_separator])
@@ -35,16 +35,20 @@ module WillPaginate
       # Returns the subset of +options+ this instance was initialized with that
       # represent HTML attributes for the container element of pagination links.
       def container_attributes
-        @container_attributes ||= @options.except(*(ViewHelpers.pagination_options.keys + [:renderer] - [:class]))
+        @container_attributes ||= {
+          :role => 'navigation',
+          :"aria-label" => @template.will_paginate_translate(:container_aria_label) { 'Pagination' }
+        }.update @options.except(*(ViewHelpers.pagination_options.keys + [:renderer] - [:class]))
       end
       
     protected
     
       def page_number(page)
+        aria_label = @template.will_paginate_translate(:page_aria_label, :page => page.to_i) { "Page #{page}" }
         if page == current_page
-          tag(:em, page, :class => 'current')
+          tag(:em, page, :class => 'current', :"aria-label" => aria_label, :"aria-current" => 'page')
         else
-          link(page, page, :rel => rel_value(page))
+          link(page, page, :rel => rel_value(page), :"aria-label" => aria_label)
         end
       end
       
@@ -55,19 +59,21 @@ module WillPaginate
       
       def previous_page
         num = @collection.current_page > 1 && @collection.current_page - 1
-        previous_or_next_page(num, @options[:previous_label], 'previous_page')
+        aria_label = @template.will_paginate_translate(:previous_aria_label) { "Previous page" }
+        previous_or_next_page(num, @options[:previous_label], 'previous_page', aria_label)
       end
       
       def next_page
         num = @collection.current_page < total_pages && @collection.current_page + 1
-        previous_or_next_page(num, @options[:next_label], 'next_page')
+        aria_label = @template.will_paginate_translate(:next_aria_label) { "Next page" }
+        previous_or_next_page(num, @options[:next_label], 'next_page', aria_label)
       end
       
-      def previous_or_next_page(page, text, classname)
+      def previous_or_next_page(page, text, classname, aria_label = nil)
         if page
-          link(text, page, :class => classname)
+          link(text, page, :class => classname, :'aria-label' => aria_label)
         else
-          tag(:span, text, :class => classname + ' disabled')
+          tag(:span, text, :class => classname + ' disabled', :'aria-label' => aria_label)
         end
       end
       
@@ -88,7 +94,7 @@ module WillPaginate
       end
 
       def link(text, target, attributes = {})
-        if target.is_a? Fixnum
+        if target.is_a?(Integer)
           attributes[:rel] = rel_value(target)
           target = url(target)
         end
@@ -97,13 +103,12 @@ module WillPaginate
       end
       
       def tag(name, value, attributes = {})
-        string_attributes = attributes.inject('') do |attrs, pair|
+        string_attributes = attributes.map do |pair|
           unless pair.last.nil?
-            attrs << %( #{pair.first}="#{CGI::escapeHTML(pair.last.to_s)}")
+            %( #{pair.first}="#{CGI::escapeHTML(pair.last.to_s)}")
           end
-          attrs
         end
-        "<#{name}#{string_attributes}>#{value}</#{name}>"
+        "<#{name}#{string_attributes.compact.join("")}>#{value}</#{name}>"
       end
 
       def rel_value(page)

data/lib/will_paginate.rb

@@ -8,18 +8,6 @@ elsif defined?(Rails::Initializer)
   raise "will_paginate 3.0 is not compatible with Rails 2.3 or older"
 end
 
-if defined?(Merb::AbstractController)
-  require 'will_paginate/view_helpers/merb'
-
-  Merb::BootLoader.before_app_loads do
-    adapters = { :datamapper => 'data_mapper', :activerecord => 'active_record', :sequel => 'sequel' }
-    # auto-load the right ORM adapter
-    if adapter = adapters[Merb.orm]
-      require "will_paginate/#{adapter}"
-    end
-  end
-end
-
 if defined?(Sinatra) and Sinatra.respond_to? :register
   require 'will_paginate/view_helpers/sinatra'
 end

metadata

@@ -1,18 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: will_paginate
 version: !ruby/object:Gem::Version
-  version: 3.1.5
+  version: 4.0.1
 platform: ruby
 authors:
 - Mislav Marohnić
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-10-15 00:00:00.000000000 Z
+date: 2024-06-10 00:00:00.000000000 Z
 dependencies: []
 description: will_paginate provides a simple API for performing paginated queries
-  with Active Record, DataMapper and Sequel, and includes helpers for rendering pagination
-  links in Rails, Sinatra and Merb web apps.
+  with Active Record and Sequel, and includes helpers for rendering pagination links
+  in Rails, Sinatra, and Hanami web apps.
 email: mislav.marohnic@gmail.com
 executables: []
 extensions: []
@@ -27,7 +27,6 @@ files:
 - lib/will_paginate/array.rb
 - lib/will_paginate/collection.rb
 - lib/will_paginate/core_ext.rb
-- lib/will_paginate/data_mapper.rb
 - lib/will_paginate/deprecation.rb
 - lib/will_paginate/i18n.rb
 - lib/will_paginate/locale/en.yml
@@ -39,49 +38,20 @@ files:
 - lib/will_paginate/version.rb
 - lib/will_paginate/view_helpers.rb
 - lib/will_paginate/view_helpers/action_view.rb
+- lib/will_paginate/view_helpers/hanami.rb
 - lib/will_paginate/view_helpers/link_renderer.rb
 - lib/will_paginate/view_helpers/link_renderer_base.rb
-- lib/will_paginate/view_helpers/merb.rb
 - lib/will_paginate/view_helpers/sinatra.rb
-- spec/collection_spec.rb
-- spec/console
-- spec/console_fixtures.rb
-- spec/database.yml
-- spec/fake_rubygems.rb
-- spec/finders/active_record_spec.rb
-- spec/finders/activerecord_test_connector.rb
-- spec/finders/data_mapper_spec.rb
-- spec/finders/data_mapper_test_connector.rb
-- spec/finders/mongoid_spec.rb
-- spec/finders/sequel_spec.rb
-- spec/finders/sequel_test_connector.rb
-- spec/fixtures/admin.rb
-- spec/fixtures/developer.rb
-- spec/fixtures/developers_projects.yml
-- spec/fixtures/project.rb
-- spec/fixtures/projects.yml
-- spec/fixtures/replies.yml
-- spec/fixtures/reply.rb
-- spec/fixtures/schema.rb
-- spec/fixtures/topic.rb
-- spec/fixtures/topics.yml
-- spec/fixtures/user.rb
-- spec/fixtures/users.yml
-- spec/matchers/deprecation_matcher.rb
-- spec/matchers/phrase_matcher.rb
-- spec/matchers/query_count_matcher.rb
-- spec/page_number_spec.rb
-- spec/per_page_spec.rb
-- spec/spec_helper.rb
-- spec/view_helpers/action_view_spec.rb
-- spec/view_helpers/base_spec.rb
-- spec/view_helpers/link_renderer_base_spec.rb
-- spec/view_helpers/view_example_group.rb
-homepage: https://github.com/mislav/will_paginate/wiki
+homepage: https://github.com/mislav/will_paginate
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  bug_tracker_uri: https://github.com/mislav/will_paginate/issues
+  changelog_uri: https://github.com/mislav/will_paginate/releases/tag/v4.0.1
+  documentation_uri: https://www.rubydoc.info/gems/will_paginate/4.0.1
+  source_code_uri: https://github.com/mislav/will_paginate/tree/v4.0.1
+  wiki_uri: https://github.com/mislav/will_paginate/wiki
+post_install_message:
 rdoc_options:
 - "--main"
 - README.md
@@ -92,16 +62,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.5.4
+signing_key:
 specification_version: 4
 summary: Pagination plugin for web frameworks and other apps
 test_files: []

data/lib/will_paginate/data_mapper.rb

@@ -1,100 +0,0 @@
-require 'dm-core'
-require 'dm-aggregates'
-require 'will_paginate/per_page'
-require 'will_paginate/page_number'
-require 'will_paginate/collection'
-
-module WillPaginate
-  module DataMapper
-    module Pagination
-      def page(num)
-        pagenum = ::WillPaginate::PageNumber(num.nil? ? 1 : num)
-        per_page = query.limit || self.per_page
-        options = {:offset => pagenum.to_offset(per_page).to_i}
-        options[:limit] = per_page unless query.limit
-        col = new_collection(query.merge(options))
-        col.current_page = pagenum
-        col
-      end
-
-      def paginate(options)
-        options  = options.dup
-        pagenum  = options.fetch(:page) { raise ArgumentError, ":page parameter required" }
-        per_page = options.delete(:per_page) || self.per_page
-        total    = options.delete(:total_entries)
-
-        options.delete(:page)
-        options[:limit] = per_page.to_i
-
-
-        col = all(options).page(pagenum)
-        col.total_entries = total.to_i unless total.nil? || (total.kind_of?(String) && total.strip.empty?)
-        col
-      end
-    end
-
-    module CollectionMethods
-      include WillPaginate::CollectionMethods
-
-      attr_accessor :current_page
-      attr_writer :total_entries
-
-      def paginated?
-        !current_page.nil?
-      end
-
-      def per_page
-        query.limit || model.per_page
-      end
-
-      def offset
-        query.offset
-      end
-
-      def total_entries
-        @total_entries ||= begin
-          if loaded? and @array.size < per_page and (current_page == 1 or @array.size > 0)
-            offset + @array.size
-          else
-            # :reload prevents Collection.filter from being run, which
-            # would cause a stack overflow
-            clean_query = query.merge(:reload => true)
-            # seems like the only way
-            clean_query.instance_variable_set('@limit', nil)
-            clean_query.instance_variable_set('@offset', 0)
-            new_collection(clean_query).count
-          end
-        end
-      end
-
-      def to_a
-        if paginated?
-          ::WillPaginate::Collection.create(current_page, per_page) do |col|
-            col.replace super
-            col.total_entries ||= total_entries
-          end
-        else
-          super
-        end
-      end
-
-      private
-
-      def new_collection(query, resources = nil)
-        col = super
-        col.current_page = self.current_page
-        col
-      end
-
-      def initialize_copy(original)
-        super
-        @total_entries = nil
-      end
-    end
-
-    ::DataMapper::Model.append_extensions PerPage
-    ::DataMapper::Model.append_extensions Pagination
-    ::DataMapper::Collection.send(:include, Pagination)
-    ::DataMapper::Collection.send(:include, CollectionMethods)
-  end
-end

data/lib/will_paginate/view_helpers/merb.rb

@@ -1,26 +0,0 @@
-require 'will_paginate/core_ext'
-require 'will_paginate/view_helpers'
-require 'will_paginate/view_helpers/link_renderer'
-
-module WillPaginate
-  module Merb
-    include ViewHelpers
-
-    def will_paginate(collection, options = {}) #:nodoc:
-      options = options.merge(:renderer => LinkRenderer) unless options[:renderer]
-      super(collection, options)
-    end
-
-    class LinkRenderer < ViewHelpers::LinkRenderer
-      protected
-
-      def url(page)
-        params = @template.request.params.except(:action, :controller).merge(param_name => page)
-        @template.url(:this, params)
-      end
-    end
-
-    ::Merb::AbstractController.send(:include, self)
-  end
-end
-