will_paginate 3.1.6 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 990ad7af08e5c983697a5c1c679801e1641fe3fa
-  data.tar.gz: be048d581649ca2a21e671ab46ea603a291ebff8
+SHA256:
+  metadata.gz: a6263dfb6824224c74e2383ba39b7f35abe25288dfcdd89a3dbab6f2585eb91e
+  data.tar.gz: c26bb41e5bf140fd2564ed63fda7ed4822f3c126a6a3b3885b27e2585dbf3647
 SHA512:
-  metadata.gz: d5fda69cc13387b95b761efc5c697030cf36f41acbc87f513ed5eef5e629aaecab44e94a45150c4c236444d7a79c6653f446d12f4539f057f1789600682209c2
-  data.tar.gz: 449283390fb84c7a91fb50fd007e1f9207024ef7a8ed16b28cd6887ee2f1b1ba5e9f8a4cb4e175fd44aa4298b45bbf5164cb45d63853faa0ccd2537768f1c269
+  metadata.gz: 8f67913552fff8839f5de82d9e55c61ad69c1a57216da3d5d627aef77455ee32a03d2b8c2b732299b37481ea6e9fd72a5baa1432e1fe296e78fc06b6a46ee8e0
+  data.tar.gz: 8979fdd5d35ee416e4c607f759b8e868188b11bb2ca7540d982866e936168170519492a027fff90cb31db12fb758b144389691c9374acfd58fd1880105d2201c

data/README.md

@@ -1,6 +1,6 @@
 # will_paginate
 
-will_paginate is a pagination library that integrates with Ruby on Rails, Sinatra, Merb, DataMapper and Sequel.
+will_paginate is a pagination library that integrates with Ruby on Rails, Sinatra, Hanami::View, Merb, DataMapper and Sequel.
 
 Installation:
 
@@ -16,10 +16,10 @@ See [installation instructions][install] on the wiki for more info.
 
 ``` 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 %>
@@ -49,13 +49,12 @@ Post.where(:published => true).paginate(:page => params[:page]).order('id 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

@@ -3,6 +3,8 @@ en:
     previous_label: "← Previous"
     next_label: "Next →"
     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 `Integer === 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  = 6
+    MINOR = 3
+    TINY  = 0
 
     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

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

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

data/spec/finders/active_record_spec.rb

@@ -163,6 +163,13 @@ describe WillPaginate::ActiveRecord do
       topics.total_entries.should == 999
     end
 
+    it "overrides empty? count call with a total_entries fixed value" do
+      lambda {
+        topics = Topic.paginate :page => 1, :per_page => 3, :total_entries => 999
+        topics.should_not be_empty
+      }.should run_queries(0)
+    end
+
     it "removes :include for count" do
       lambda {
         developers = Developer.paginate(:page => 1, :per_page => 1).includes(:projects)
@@ -213,7 +220,7 @@ describe WillPaginate::ActiveRecord do
         sql = "select content from topics where content like '%futurama%'"
         topics = Topic.paginate_by_sql sql, :page => 1, :per_page => 1
         topics.total_entries.should == 1
-        topics.first.attributes.has_key?('title').should be_false
+        topics.first.attributes.has_key?('title').should be(false)
       }.should run_queries(2)
     end
 
@@ -271,12 +278,12 @@ describe WillPaginate::ActiveRecord do
     }.should run_queries(1)
   end
   
-  it "should get second (inexistent) page of Topics, requiring 2 queries" do
+  it "should get second (inexistent) page of Topics, requiring 1 query" do
     lambda {
       result = Topic.paginate :page => 2
       result.total_pages.should == 1
       result.should be_empty
-    }.should run_queries(2)
+    }.should run_queries(1)
   end
   
   describe "associations" do

data/spec/finders/activerecord_test_connector.rb

@@ -79,6 +79,13 @@ module ActiverecordTestConnector
     ActiveRecord::Base.configurations = { db => configuration }
     ActiveRecord::Base.establish_connection(db.to_sym)
     ActiveRecord::Base.default_timezone = :utc
+
+    case configuration['adapter']
+    when 'mysql'
+      fix_primary_key(ActiveRecord::ConnectionAdapters::MysqlAdapter)
+    when 'mysql2'
+      fix_primary_key(ActiveRecord::ConnectionAdapters::Mysql2Adapter)
+    end
   end
 
   def load_schema
@@ -90,7 +97,13 @@ module ActiverecordTestConnector
       $stdout = STDOUT
     end
   end
-  
+
+  def fix_primary_key(adapter_class)
+    if ActiveRecord::VERSION::STRING < "4.1"
+      adapter_class::NATIVE_DATABASE_TYPES[:primary_key] = "int(11) auto_increment PRIMARY KEY"
+    end
+  end
+
   module FixtureSetup
     def fixtures(*tables)
       table_names = tables.map { |t| t.to_s }

data/spec/finders/mongoid_spec.rb

@@ -10,6 +10,8 @@ if !ENV['SKIP_NONRAILS_TESTS']
   require 'will_paginate/mongoid'
   Object.send(:const_set, :Rails, old_rails) if old_rails
 
+  Mongo::Logger.logger.level = Logger::INFO
+
   Mongoid.connect_to 'will_paginate_test'
   class MongoidModel
     include Mongoid::Document

data/spec/finders/sequel_spec.rb

@@ -11,14 +11,15 @@ end
 describe Sequel::Dataset::Pagination, 'extension' do
   
   class Car < Sequel::Model
+    self.dataset = dataset.extension(:pagination)
   end
 
   it "should have the #paginate method" do
-    Car.should respond_to(:paginate)
+    Car.dataset.should respond_to(:paginate)
   end
 
   it "should NOT have the #paginate_by_sql method" do
-    Car.should_not respond_to(:paginate_by_sql)
+    Car.dataset.should_not respond_to(:paginate_by_sql)
   end
 
   describe 'pagination' do
@@ -29,7 +30,7 @@ describe Sequel::Dataset::Pagination, 'extension' do
     end
 
     it "should imitate WillPaginate::Collection" do
-      result = Car.paginate(1, 2)
+      result = Car.dataset.paginate(1, 2)
       
       result.should_not be_empty
       result.size.should == 2
@@ -41,16 +42,16 @@ describe Sequel::Dataset::Pagination, 'extension' do
     end
     
     it "should perform" do
-      Car.paginate(1, 2).all.should == [Car[1], Car[2]]
+      Car.dataset.paginate(1, 2).all.should == [Car[1], Car[2]]
     end
 
     it "should be empty" do
-      result = Car.paginate(3, 2)
+      result = Car.dataset.paginate(3, 2)
       result.should be_empty
     end
     
     it "should perform with #select and #order" do
-      result = Car.select("name as foo".lit).order(:name).paginate(1, 2).all
+      result = Car.select(Sequel.lit("name as foo")).order(:name).paginate(1, 2).all
       result.size.should == 2
       result.first.values[:foo].should == "Aston Martin"
     end

data/spec/page_number_spec.rb

@@ -1,5 +1,6 @@
 require 'spec_helper'
 require 'will_paginate/page_number'
+require 'json'
 
 describe WillPaginate::PageNumber do
   describe "valid" do
@@ -37,7 +38,14 @@ describe WillPaginate::PageNumber do
 
     it "passes the Numeric=== type check" do |variable|
       (Numeric === num).should be
-      (Integer === num).should be
+    end
+
+    it "fails the Numeric=== type check" do |variable|
+      (Integer === num).should_not be
+    end
+
+    it "serializes as JSON number" do
+      JSON.dump(page: num).should eq('{"page":12}')
     end
   end
 

data/spec/spec_helper.rb

@@ -42,5 +42,5 @@ RSpec.configure do |config|
   }
 
   config.mock_with :mocha
-  config.backtrace_clean_patterns << /view_example_group/
+  config.backtrace_exclusion_patterns << /view_example_group/
 end

data/spec/view_helpers/action_view_spec.rb

@@ -14,7 +14,8 @@ Routes.draw do
   get 'ibocorp(/:page)' => 'ibocorp#index',
         :constraints => { :page => /\d+/ }, :defaults => { :page => 1 }
 
-  get ':controller(/:action(/:id(.:format)))'
+  get 'foo/bar' => 'foo#bar'
+  get 'baz/list' => 'baz#list'
 end
 
 describe WillPaginate::ActionView do
@@ -38,7 +39,14 @@ describe WillPaginate::ActionView do
   attr_reader :assigns, :controller, :request
   
   def render(locals)
-    @view = ActionView::Base.new([], @assigns, @controller)
+    lookup_context = []
+    if defined? ActionView::LookupContext
+      lookup_context = ActionView::LookupContext.new(lookup_context)
+    end
+
+    klass = ActionView::Base
+    klass = klass.with_empty_template_cache if klass.respond_to?(:with_empty_template_cache)
+    @view = klass.new(lookup_context, @assigns, @controller)
     @view.request = @request
     @view.singleton_class.send(:include, @controller._routes.url_helpers)
     @view.render(:inline => @template, :locals => locals)
@@ -120,16 +128,20 @@ describe WillPaginate::ActionView do
   it "should match expected markup" do
     paginate
     expected = <<-HTML
-      <div class="pagination"><span class="previous_page disabled">&#8592; Previous</span>
-      <em class="current">1</em>
-      <a href="/foo/bar?page=2" rel="next">2</a>
-      <a href="/foo/bar?page=3">3</a>
+      <div class="pagination" role="navigation" aria-label="Pagination"><span class="previous_page disabled">&#8592; Previous</span>
+      <em class="current" aria-label="Page 1" aria-current="page">1</em>
+      <a href="/foo/bar?page=2" aria-label="Page 2" rel="next">2</a>
+      <a href="/foo/bar?page=3" aria-label="Page 3">3</a>
       <a href="/foo/bar?page=2" class="next_page" rel="next">Next &#8594;</a></div>
     HTML
     expected.strip!.gsub!(/\s{2,}/, ' ')
-    expected_dom = parse_html_document(expected).root
+    expected_dom = parse_html_document(expected)
 
-    html_document.root.should == expected_dom
+    if expected_dom.respond_to?(:canonicalize)
+      html_document.canonicalize.should == expected_dom.canonicalize
+    else
+      html_document.root.should == expected_dom.root
+    end
   end
   
   it "should output escaped URLs" do

data/spec/view_helpers/view_example_group.rb

@@ -50,7 +50,7 @@ module ViewExampleGroup
   end
 
   def parse_html_document(html)
-    @html_document ||= if defined?(Rails::Dom::Testing::Assertions)
+    if defined?(Rails::Dom::Testing::Assertions)
       Nokogiri::HTML::Document.parse(html)
     else
       HTML::Document.new(html, true, false)

metadata

@@ -1,18 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: will_paginate
 version: !ruby/object:Gem::Version
-  version: 3.1.6
+  version: 3.3.0
 platform: ruby
 authors:
 - Mislav Marohnić
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-07 00:00:00.000000000 Z
+date: 2020-02-26 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.
+  links in Rails, Sinatra, Hanami, and Merb web apps.
 email: mislav.marohnic@gmail.com
 executables: []
 extensions: []
@@ -39,6 +39,7 @@ 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
@@ -77,10 +78,15 @@ files:
 - 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: {}
+metadata:
+  bug_tracker_uri: https://github.com/mislav/will_paginate/issues
+  changelog_uri: https://github.com/mislav/will_paginate/releases/tag/v3.3.0
+  documentation_uri: https://www.rubydoc.info/gems/will_paginate/3.3.0
+  source_code_uri: https://github.com/mislav/will_paginate/tree/v3.3.0
+  wiki_uri: https://github.com/mislav/will_paginate/wiki
 post_install_message: 
 rdoc_options:
 - "--main"
@@ -92,15 +98,14 @@ 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.4.5.1
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Pagination plugin for web frameworks and other apps