will_paginate 3.2.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 751b354f97d844f6679cec31ce90298e6d6ff77217446d77e729421caa52c8da
-  data.tar.gz: 5a18d970f3e6b0ca1e1949aa3eb14856ee80f1feea4b919f808e5d02f623bf58
+  metadata.gz: 95d6a838948c59686c5768a47e8e7e52b99c55868775645285022bc0d7c0e280
+  data.tar.gz: c92449392a8191a656e19d5e722314a2f2c1c50d646f5d98359b0d8193539dd2
 SHA512:
-  metadata.gz: 1196350bf1e40de517c21fd8f085df09c682709894d1edd688402d33fab8d15c2b9af91b84c0df5dc5aad2eda9e6e8fbc006474b8ee3829af13879a6c66f24ed
-  data.tar.gz: 5ef9ce7f70c5cc3ba0b1e024e4c4cfeb8e8afbb20cea2b983abfb31cb29eb850931b652f68d95579acaa5b69b71ffdfc384716640e4168e49c108fe3a525441d
+  metadata.gz: 4511c22cbbf023ab6e32fc457c487ec393c2fdf6f8a3910ee0c0d8385061a98307b6a8a8f02a25af33f9f648f735c5d20d942412b3a7ff5a40d2d7ba67491917
+  data.tar.gz: a062b0bce8e25a24b818b926957b98f970e86b79f89fbb1e2cdfbce382a030d02b3f02800cce6dd1671d84d3251e33879095a1bbe669a7348df90a3664be95ec

data/README.md

@@ -1,16 +1,14 @@
 # will_paginate
 
-will_paginate is a pagination library that integrates with Ruby on Rails, Sinatra, Hanami::View, 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', '~> 3.3'
 ```
 
 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
 

data/lib/will_paginate/active_record.rb

@@ -105,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
@@ -212,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/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,7 +1,9 @@
 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}"

data/lib/will_paginate/page_number.rb

@@ -1,4 +1,3 @@
-require 'delegate'
 require 'forwardable'
 
 module WillPaginate
@@ -28,7 +27,7 @@ module WillPaginate
       @value
     end
 
-    def_delegators :@value, :coerce, :==, :<=>, :to_s, :+, :-, :*, :/
+    def_delegators :@value, :coerce, :==, :<=>, :to_s, :+, :-, :*, :/, :to_json
 
     def inspect
       "#{@name} #{to_i}"

data/lib/will_paginate/railtie.rb

@@ -59,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,7 +1,7 @@
 module WillPaginate #:nodoc:
   module VERSION #:nodoc:
-    MAJOR = 3
-    MINOR = 2
+    MAJOR = 4
+    MINOR = 0
     TINY  = 0
 
     STRING = [MAJOR, MINOR, TINY].join('.')

data/lib/will_paginate/view_helpers/action_view.rb

@@ -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/link_renderer.rb

@@ -59,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
       

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.2.0
+  version: 4.0.0
 platform: ruby
 authors:
 - Mislav Marohnić
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-10-09 00:00:00.000000000 Z
+date: 2023-05-29 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, Hanami, 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
@@ -42,52 +41,17 @@ files:
 - 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
 licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/mislav/will_paginate/issues
-  changelog_uri: https://github.com/mislav/will_paginate/releases/tag/v3.2.0
-  documentation_uri: https://www.rubydoc.info/gems/will_paginate/3.2.0
-  source_code_uri: https://github.com/mislav/will_paginate/tree/v3.2.0
+  changelog_uri: https://github.com/mislav/will_paginate/releases/tag/v4.0.0
+  documentation_uri: https://www.rubydoc.info/gems/will_paginate/4.0.0
+  source_code_uri: https://github.com/mislav/will_paginate/tree/v4.0.0
   wiki_uri: https://github.com/mislav/will_paginate/wiki
-post_install_message: 
+post_install_message:
 rdoc_options:
 - "--main"
 - README.md
@@ -98,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.7.6
-signing_key: 
+rubygems_version: 3.4.6
+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
-

data/spec/collection_spec.rb

@@ -1,139 +0,0 @@
-require 'will_paginate/array'
-require 'spec_helper'
-
-describe WillPaginate::Collection do
-
-  before :all do
-    @simple = ('a'..'e').to_a
-  end
-
-  it "should be a subset of original collection" do
-    @simple.paginate(:page => 1, :per_page => 3).should == %w( a b c )
-  end
-
-  it "can be shorter than per_page if on last page" do
-    @simple.paginate(:page => 2, :per_page => 3).should == %w( d e )
-  end
-
-  it "should include whole collection if per_page permits" do
-    @simple.paginate(:page => 1, :per_page => 5).should == @simple
-  end
-
-  it "should be empty if out of bounds" do
-    @simple.paginate(:page => 2, :per_page => 5).should be_empty
-  end
-  
-  it "should default to 1 as current page and 30 per-page" do
-    result = (1..50).to_a.paginate
-    result.current_page.should == 1
-    result.size.should == 30
-  end
-
-  it "should give total_entries precedence over actual size" do
-    %w(a b c).paginate(:total_entries => 5).total_entries.should == 5
-  end
-
-  it "should be an augmented Array" do
-    entries = %w(a b c)
-    collection = create(2, 3, 10) do |pager|
-      pager.replace(entries).should == entries
-    end
-
-    collection.should == entries
-    for method in %w(total_pages each offset size current_page per_page total_entries)
-      collection.should respond_to(method)
-    end
-    collection.should be_kind_of(Array)
-    collection.entries.should be_instance_of(Array)
-    # TODO: move to another expectation:
-    collection.offset.should == 3
-    collection.total_pages.should == 4
-    collection.should_not be_out_of_bounds
-  end
-
-  describe "previous/next pages" do
-    it "should have previous_page nil when on first page" do
-      collection = create(1, 1, 3)
-      collection.previous_page.should be_nil
-      collection.next_page.should == 2
-    end
-    
-    it "should have both prev/next pages" do
-      collection = create(2, 1, 3)
-      collection.previous_page.should == 1
-      collection.next_page.should == 3
-    end
-    
-    it "should have next_page nil when on last page" do
-      collection = create(3, 1, 3)
-      collection.previous_page.should == 2
-      collection.next_page.should be_nil
-    end
-  end
-
-  describe "out of bounds" do
-    it "is out of bounds when page number is too high" do
-      create(2, 3, 2).should be_out_of_bounds
-    end
-
-    it "isn't out of bounds when inside collection" do
-      create(1, 3, 2).should_not be_out_of_bounds
-    end
-
-    it "isn't out of bounds when the collection is empty" do
-      collection = create(1, 3, 0)
-      collection.should_not be_out_of_bounds
-      collection.total_pages.should == 1
-    end
-  end
-
-  describe "guessing total count" do
-    it "can guess when collection is shorter than limit" do
-      collection = create { |p| p.replace array }
-      collection.total_entries.should == 8
-    end
-    
-    it "should allow explicit total count to override guessed" do
-      collection = create(2, 5, 10) { |p| p.replace array }
-      collection.total_entries.should == 10
-    end
-    
-    it "should not be able to guess when collection is same as limit" do
-      collection = create { |p| p.replace array(5) }
-      collection.total_entries.should be_nil
-    end
-    
-    it "should not be able to guess when collection is empty" do
-      collection = create { |p| p.replace array(0) }
-      collection.total_entries.should be_nil
-    end
-    
-    it "should be able to guess when collection is empty and this is the first page" do
-      collection = create(1) { |p| p.replace array(0) }
-      collection.total_entries.should == 0
-    end
-  end
-
-  it "should not respond to page_count anymore" do
-    Proc.new { create.page_count }.should raise_error(NoMethodError)
-  end
-
-  it "inherits per_page from global value" do
-    collection = described_class.new(1)
-    collection.per_page.should == 30
-  end
-
-  private
-  
-    def create(page = 2, limit = 5, total = nil, &block)
-      if block_given?
-        described_class.create(page, limit, total, &block)
-      else
-        described_class.new(page, limit, total)
-      end
-    end
-
-    def array(size = 3)
-      Array.new(size)
-    end
-end

data/spec/console

@@ -1,12 +0,0 @@
-#!/usr/bin/env ruby
-irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
-opts = %w[ --simple-prompt -rirb/completion ]
-if ARGV.include? '-dm'
-  opts << '-rwill_paginate/data_mapper' << '-rfinders/data_mapper_test_connector'
-elsif ARGV.include? '-seq'
-  opts << '-rwill_paginate/sequel' << '-rfinders/sequel_test_connector'
-else
-  opts << '-rconsole_fixtures'
-end
-
-exec 'bundle', 'exec', irb, '-Ilib:spec', *opts

data/spec/console_fixtures.rb

@@ -1,28 +0,0 @@
-require 'bundler'
-Bundler.setup
-
-require 'will_paginate/active_record'
-require 'finders/activerecord_test_connector'
-
-ActiverecordTestConnector.setup
-
-windows = RUBY_PLATFORM =~ /(:?mswin|mingw)/
-# used just for the `color` method
-log_subscriber = ActiveSupport::LogSubscriber.log_subscribers.first
-
-IGNORE_SQL = /\b(sqlite_master|sqlite_version)\b|^(CREATE TABLE|PRAGMA)\b/
-
-ActiveSupport::Notifications.subscribe(/^sql\./) do |*args|
-  data = args.last
-  unless data[:name] =~ /^Fixture/ or data[:sql] =~ IGNORE_SQL
-    if windows
-      puts data[:sql]
-    else
-      puts log_subscriber.send(:color, data[:sql], :cyan)
-    end
-  end
-end
-
-# load all fixtures
-ActiverecordTestConnector::Fixtures.create_fixtures \
-  ActiverecordTestConnector::FIXTURES_PATH, ActiveRecord::Base.connection.tables

data/spec/database.yml

@@ -1,29 +0,0 @@
-sqlite3:
-  database: ":memory:"
-  adapter: sqlite3
-  timeout: 500
-
-mysql: &mysql
-  adapter: mysql
-  database: will_paginate
-  username: root
-  encoding: utf8
-<% if File.exist?("/var/run/mysql5/mysqld.sock") %>
-  host: localhost
-  socket: /var/run/mysql5/mysqld.sock
-<% elsif File.exist? "/tmp/mysql.sock" %>
-  host: localhost
-  socket: /tmp/mysql.sock
-<% else %>
-  host: 127.0.0.1
-<% end %>
-
-mysql2:
-  <<: *mysql
-  adapter: mysql2
-
-postgres:
-  adapter: postgresql
-  database: will_paginate
-  username: <%= "postgres" if ENV["TRAVIS"] %>
-  min_messages: warning

data/spec/fake_rubygems.rb

@@ -1,18 +0,0 @@
-# Makes the test suite compatible with Bundler standalone mode (used in CI)
-# because Active Record uses `gem` for loading adapters.
-Kernel.module_eval do
-
-  remove_method :gem if 'method' == defined? gem
-
-  def gem(*args)
-    return if $VERBOSE.nil?
-    $stderr << "warning: gem(#{args.map {|o| o.inspect }.join(', ')}) ignored"
-    $stderr << "; called from:\n  " << caller[0,5].join("\n  ") if $DEBUG
-    $stderr << "\n"
-  end
-
-  private :gem
-
-end
-
-$" << "rubygems.rb"