will_paginate 3.0.0 → 3.0.1

data/README.md

@@ -6,7 +6,7 @@ Installation:
 
 ``` ruby
 ## Gemfile for Rails 3, Sinatra, and Merb
-gem 'will_paginate', '~> 3.0.pre4'
+gem 'will_paginate', '~> 3.0'
 ```
 
 See [installation instructions][install] on the wiki for more info.

data/lib/will_paginate/active_record.rb

@@ -18,6 +18,8 @@ module WillPaginate
   module ActiveRecord
     # makes a Relation look like WillPaginate::Collection
     module RelationMethods
+      include WillPaginate::CollectionMethods
+
       attr_accessor :current_page
       attr_writer :total_entries, :wp_count_options
 
@@ -81,22 +83,24 @@ module WillPaginate
       # overloaded to be pagination-aware
       def empty?
         if !loaded? and offset_value
-          count <= offset_value
+          rel_count = count
+          if rel_count.respond_to?(:size) and !rel_count.is_a?(Integer)
+            rel_count.size <= offset_value
+          else
+            rel_count <= offset_value
+          end
         else
           super
         end
       end
 
-      def total_pages
-        (total_entries / limit_value.to_f).ceil
+      def clone
+        copy_will_paginate_data super
       end
 
-      def clone
-        other = super
-        other.current_page = current_page unless other.current_page
-        other.total_entries = nil if defined? @total_entries_queried
-        other.wp_count_options = @wp_count_options if defined? @wp_count_options
-        other
+      # workaround for Active Record 3.0
+      def scoped(options = nil)
+        copy_will_paginate_data super
       end
 
       def to_a
@@ -108,6 +112,15 @@ module WillPaginate
           end
         end
       end
+
+      private
+
+      def copy_will_paginate_data(other)
+        other.current_page = current_page unless other.current_page
+        other.total_entries = nil if defined? @total_entries_queried
+        other.wp_count_options = @wp_count_options if defined? @wp_count_options
+        other
+      end
     end
 
     module Pagination

data/lib/will_paginate/collection.rb

@@ -2,6 +2,38 @@ require 'will_paginate/per_page'
 require 'will_paginate/page_number'
 
 module WillPaginate
+  # Any will_paginate-compatible collection should have these methods:
+  #
+  #   current_page, per_page, offset, total_entries, total_pages
+  #
+  # It can also define some of these optional methods:
+  #
+  #   out_of_bounds?, previous_page, next_page
+  #
+  # This module provides few of these methods.
+  module CollectionMethods
+    def total_pages
+      total_entries.zero? ? 1 : (total_entries / per_page.to_f).ceil
+    end
+
+    # current_page - 1 or nil if there is no previous page
+    def previous_page
+      current_page > 1 ? (current_page - 1) : nil
+    end
+
+    # current_page + 1 or nil if there is no next page
+    def next_page
+      current_page < total_pages ? (current_page + 1) : nil
+    end
+
+    # Helper method that is true when someone tries to fetch a page with a
+    # larger number than the last page. Can be used in combination with flashes
+    # and redirecting.
+    def out_of_bounds?
+      current_page > total_pages
+    end
+  end
+
   # = The key to pagination
   # Arrays returned from paginating finds are, in fact, instances of this little
   # class. You may think of WillPaginate::Collection as an ordinary array with
@@ -18,7 +50,9 @@ module WillPaginate
   #   require 'will_paginate/collection'
   #   # WillPaginate::Collection is now available for use
   class Collection < Array
-    attr_reader :current_page, :per_page, :total_entries, :total_pages
+    include CollectionMethods
+
+    attr_reader :current_page, :per_page, :total_entries
 
     # Arguments to the constructor are the current page number, per-page limit
     # and the total number of entries. The last argument is optional because it
@@ -63,35 +97,16 @@ module WillPaginate
       pager
     end
 
-    # Helper method that is true when someone tries to fetch a page with a
-    # larger number than the last page. Can be used in combination with flashes
-    # and redirecting.
-    def out_of_bounds?
-      current_page > total_pages
-    end
-
     # Current offset of the paginated collection. If we're on the first page,
     # it is always 0. If we're on the 2nd page and there are 30 entries per page,
     # the offset is 30. This property is useful if you want to render ordinals
     # side by side with records in the view: simply start with offset + 1.
     def offset
-      @current_page.to_offset(per_page).to_i
-    end
-
-    # current_page - 1 or nil if there is no previous page
-    def previous_page
-      current_page > 1 ? (current_page - 1) : nil
+      current_page.to_offset(per_page).to_i
     end
 
-    # current_page + 1 or nil if there is no next page
-    def next_page
-      current_page < total_pages ? (current_page + 1) : nil
-    end
-    
-    # sets the <tt>total_entries</tt> property and calculates <tt>total_pages</tt>
     def total_entries=(number)
       @total_entries = number.to_i
-      @total_pages   = (@total_entries / per_page.to_f).ceil
     end
 
     # This is a magic wrapper for the original Array#replace method. It serves

data/lib/will_paginate/data_mapper.rb

@@ -30,6 +30,8 @@ module WillPaginate
     end
 
     module CollectionMethods
+      include WillPaginate::CollectionMethods
+
       attr_accessor :current_page
 
       def paginated?
@@ -58,10 +60,6 @@ module WillPaginate
         end
       end
 
-      def total_pages
-        (total_entries / per_page.to_f).ceil
-      end
-
       def to_a
         ::WillPaginate::Collection.create(current_page, per_page) do |col|
           col.replace super

data/lib/will_paginate/deprecation.rb

@@ -0,0 +1,55 @@
+module WillPaginate::Deprecation
+  class << self
+    def warn(message, stack = caller)
+      offending_line = origin_of_call(stack)
+      full_message = "DEPRECATION WARNING: #{message} (called from #{offending_line})"
+      logger = rails_logger || Kernel
+      logger.warn full_message
+    end
+
+    private
+
+    def rails_logger
+      defined?(Rails) && Rails.logger
+    end
+
+    def origin_of_call(stack)
+      lib_root = File.expand_path('../../..', __FILE__)
+      stack.find { |line| line.index(lib_root) != 0 } || stack.first
+    end
+  end
+
+  class Hash < ::Hash
+    def initialize(values = {})
+      super()
+      update values
+      @deprecated = {}
+    end
+
+    def []=(key, value)
+      check_deprecated(key, value)
+      super
+    end
+
+    def deprecate_key(*keys)
+      message = block_given? ? Proc.new : keys.pop
+      Array(keys).each { |key| @deprecated[key] = message }
+    end
+
+    def merge(another)
+      to_hash.update(another)
+    end
+
+    def to_hash
+      ::Hash.new.update(self)
+    end
+
+    private
+
+    def check_deprecated(key, value)
+      if msg = @deprecated[key] and (!msg.respond_to?(:call) or (msg = msg.call(key, value)))
+        WillPaginate::Deprecation.warn(msg)
+      end
+    end
+  end
+end

data/lib/will_paginate/railtie.rb

@@ -1,4 +1,5 @@
 require 'will_paginate'
+require 'will_paginate/page_number'
 require 'will_paginate/collection'
 require 'will_paginate/i18n'
 
@@ -18,14 +19,44 @@ module WillPaginate
       end
 
       self.class.add_locale_path config
+
+      # early access to ViewHelpers.pagination_options
+      require 'will_paginate/view_helpers'
     end
 
     def self.setup_actioncontroller
-      ActionDispatch::ShowExceptions.rescue_responses['WillPaginate::InvalidPage'] = :not_found
+      ActionDispatch::ShowExceptions.send :include, ShowExceptionsPatch
+      ActionController::Base.extend ControllerRescuePatch
     end
 
     def self.add_locale_path(config)
       config.i18n.railties_load_path.unshift(*WillPaginate::I18n.load_path)
     end
+
+    # Extending the exception handler middleware so it properly detects
+    # WillPaginate::InvalidPage regardless of it being a tag module.
+    module ShowExceptionsPatch
+      extend ActiveSupport::Concern
+      included { alias_method_chain :status_code, :paginate }
+      private
+      def status_code_with_paginate(exception)
+        if exception.is_a?(WillPaginate::InvalidPage) or
+            (exception.respond_to?(:original_exception) &&
+              exception.original_exception.is_a?(WillPaginate::InvalidPage))
+          Rack::Utils.status_code(:not_found)
+        else
+          status_code_without_paginate(exception)
+        end
+      end
+    end
+
+    module ControllerRescuePatch
+      def rescue_from(*args, &block)
+        if idx = args.index(WillPaginate::InvalidPage)
+          args[idx] = args[idx].name
+        end
+        super(*args, &block)
+      end
+    end
   end
 end

data/lib/will_paginate/sequel.rb

@@ -1,10 +1,13 @@
 require 'sequel'
 require 'sequel/extensions/pagination'
+require 'will_paginate/collection'
 
 module WillPaginate
   # Sequel already supports pagination; we only need to make the
   # resulting dataset look a bit more like WillPaginate::Collection
   module SequelMethods
+    include WillPaginate::CollectionMethods
+
     def total_pages
       page_count
     end

data/lib/will_paginate/version.rb

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

data/lib/will_paginate/view_helpers.rb

@@ -1,6 +1,7 @@
 # encoding: utf-8
 require 'will_paginate/core_ext'
 require 'will_paginate/i18n'
+require 'will_paginate/deprecation'
 
 module WillPaginate
   # = Will Paginate view helpers
@@ -19,7 +20,7 @@ module WillPaginate
     end
 
     # default view options
-    self.pagination_options = {
+    self.pagination_options = Deprecation::Hash.new \
       :class          => 'pagination',
       :previous_label => nil,
       :next_label     => nil,
@@ -28,10 +29,14 @@ module WillPaginate
       :link_separator => ' ', # single space is friendly to spiders and non-graphic browsers
       :param_name     => :page,
       :params         => nil,
-      :renderer       => nil,
       :page_links     => true,
       :container      => true
+
+    label_deprecation = Proc.new { |key, value|
+      "set the 'will_paginate.#{key}' key in your i18n locale instead of editing pagination_options" if defined? Rails
     }
+    pagination_options.deprecate_key(:previous_label, :next_label, &label_deprecation)
+    pagination_options.deprecate_key(:renderer) { |key, _| "pagination_options[#{key.inspect}] shouldn't be set globally" }
 
     include WillPaginate::I18n
 
@@ -49,8 +54,8 @@ module WillPaginate
     # * <tt>:param_name</tt> -- parameter name for page number in URLs (default: <tt>:page</tt>)
     # * <tt>:params</tt> -- additional parameters when generating pagination links
     #   (eg. <tt>:controller => "foo", :action => nil</tt>)
-    # * <tt>:renderer</tt> -- class name, class or instance of a link renderer (default:
-    #   <tt>WillPaginate::LinkRenderer</tt>)
+    # * <tt>:renderer</tt> -- class name, class or instance of a link renderer (default in Rails:
+    #   <tt>WillPaginate::ActionView::LinkRenderer</tt>)
     # * <tt>:page_links</tt> -- when false, only previous/next links are rendered (default: true)
     # * <tt>:container</tt> -- toggles rendering of the DIV container for pagination links, set to
     #   false only when you are rendering your own pagination markup (default: true)

data/lib/will_paginate/view_helpers/action_view.rb

@@ -72,14 +72,18 @@ module WillPaginate
     end
 
     def will_paginate_translate(keys, options = {})
-      if Array === keys
-        defaults = keys.dup
-        key = defaults.shift
+      if respond_to? :translate
+        if Array === keys
+          defaults = keys.dup
+          key = defaults.shift
+        else
+          defaults = nil
+          key = keys
+        end
+        translate(key, options.merge(:default => defaults, :scope => :will_paginate))
       else
-        defaults = nil
-        key = keys
+        super
       end
-      translate(key, options.merge(:default => defaults, :scope => :will_paginate))
     end
 
     protected
@@ -101,9 +105,8 @@ module WillPaginate
 
       def url(page)
         @base_url_params ||= begin
-          url_params = base_url_params
+          url_params = merge_get_params(default_url_params)
           merge_optional_params(url_params)
-          url_params
         end
 
         url_params = @base_url_params.dup
@@ -112,15 +115,16 @@ module WillPaginate
         @template.url_for(url_params)
       end
 
-      def base_url_params
-        url_params = default_url_params
-        # page links should preserve GET parameters
-        symbolized_update(url_params, @template.params) if get_request?
+      def merge_get_params(url_params)
+        if @template.respond_to? :request and @template.request and @template.request.get?
+          symbolized_update(url_params, @template.params)
+        end
         url_params
       end
 
       def merge_optional_params(url_params)
         symbolized_update(url_params, @options[:params]) if @options[:params]
+        url_params
       end
 
       def add_current_page_param(url_params, page)
@@ -132,10 +136,6 @@ module WillPaginate
         end
       end
 
-      def get_request?
-        @template.request.get?
-      end
-
       private
 
       def parse_query_parameters(params)

data/lib/will_paginate/view_helpers/link_renderer.rb

@@ -35,7 +35,7 @@ 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 - [:class]))
+        @container_attributes ||= @options.except(*(ViewHelpers.pagination_options.keys + [:renderer] - [:class]))
       end
       
     protected

data/spec/collection_spec.rb

@@ -71,12 +71,20 @@ describe WillPaginate::Collection do
     end
   end
 
-  it "should show out of bounds when page number is too high" do
-    create(2, 3, 2).should be_out_of_bounds
-  end
-    
-  it "should not show out of bounds when inside collection" do
-    create(1, 3, 2).should_not be_out_of_bounds
+  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

data/spec/finders/active_record_spec.rb

@@ -91,6 +91,13 @@ describe WillPaginate::ActiveRecord do
       rel = Developer.page(3).limit(3)
       rel.offset.should == 6
     end
+
+    it "keeps pagination data after 'scoped'" do
+      rel = Developer.page(2).scoped
+      rel.per_page.should == 10
+      rel.offset.should == 10
+      rel.current_page.should == 2
+    end
   end
 
   describe "counting" do
@@ -131,6 +138,13 @@ describe WillPaginate::ActiveRecord do
         topics.should_not be_empty
       }.should run_queries(1)
     end
+    
+    it "support empty? for grouped queries" do
+      topics = Topic.group(:project_id).paginate :page => 1, :per_page => 3
+      lambda {
+        topics.should_not be_empty
+      }.should run_queries(1)
+    end
 
     it "overrides total_entries count with a fixed value" do
       lambda {
@@ -165,17 +179,16 @@ describe WillPaginate::ActiveRecord do
     it "should count with group" do
       Developer.group(:salary).page(1).total_entries.should == 4
     end
+
+    it "should not have zero total_pages when the result set is empty" do
+      Developer.where("1 = 2").page(1).total_pages.should == 1
+    end
   end
   
   it "should not ignore :select parameter when it says DISTINCT" do
     users = User.select('DISTINCT salary').paginate :page => 2
     users.total_entries.should == 5
   end
-  
-  it "should count with scoped select when :select => DISTINCT" do
-    pending
-    Topic.distinct.paginate :page => 2
-  end
 
   describe "paginate_by_sql" do
     it "should respond" do
@@ -311,7 +324,7 @@ describe WillPaginate::ActiveRecord do
 
       lambda {
         # with association-specified order
-        result = dhh.projects.paginate(:page => 1)
+        result = ignore_deprecation { dhh.projects.paginate(:page => 1) }
         result.should == expected_name_ordered
         result.total_entries.should == 2
       }.should run_queries(2)
@@ -402,7 +415,7 @@ describe WillPaginate::ActiveRecord do
     it "should paginate on habtm association" do
       project = projects(:active_record)
       lambda {
-        result = project.developers.poor.paginate :page => 1, :per_page => 1
+        result = ignore_deprecation { project.developers.poor.paginate :page => 1, :per_page => 1 }
         result.size.should == 1
         result.total_entries.should == 1
       }.should run_queries(2)
@@ -452,6 +465,10 @@ describe WillPaginate::ActiveRecord do
   
   protected
   
+    def ignore_deprecation
+      ActiveSupport::Deprecation.silence { yield }
+    end
+
     def run_queries(num)
       QueryCountMatcher.new(num)
     end

data/spec/finders/data_mapper_spec.rb

@@ -76,4 +76,8 @@ describe WillPaginate::DataMapper do
     Animal.all(:limit => 2).page(2).per_page.should == 2
   end
 
+  it "has total_pages at 1 for empty collections" do
+    Animal.all(:conditions => ['1=2']).page(1).total_pages.should == 1
+  end
+
 end if datamapper_loaded

data/spec/spec_helper.rb

@@ -6,26 +6,18 @@ rescue LoadError
   # no debugger available
 end
 
-module MyExtras
-  protected
-  
-  def include_phrase(string)
-    PhraseMatcher.new(string)
-  end
+RSpec.configure do |config|
+  config.include Module.new {
+    protected
 
-  def collection(params = {})
-    if params[:total_pages]
-      params[:per_page] = 1
-      params[:total_entries] = params[:total_pages]
+    def include_phrase(string)
+      PhraseMatcher.new(string)
     end
-    WillPaginate::Collection.new(params[:page] || 1, params[:per_page] || 30, params[:total_entries])
-  end
-end
 
-RSpec.configure do |config|
-  # config.include My::Pony, My::Horse, :type => :farm
-  config.include MyExtras
-  # config.predicate_matchers[:swim] = :can_swim?
+    def have_deprecation(msg)
+      DeprecationMatcher.new(msg)
+    end
+  }
   
   config.mock_with :mocha
 end
@@ -33,7 +25,7 @@ end
 class PhraseMatcher
   def initialize(string)
     @string = string
-    @pattern = /\b#{string}\b/
+    @pattern = /\b#{Regexp.escape string}\b/
   end
 
   def matches?(actual)
@@ -49,3 +41,31 @@ class PhraseMatcher
     "expected #{@actual.inspect} not to contain phrase #{@string.inspect}"
   end
 end
+
+require 'stringio'
+
+class DeprecationMatcher
+  def initialize(message)
+    @message = message
+  end
+
+  def matches?(block)
+    @actual = hijack_stderr(&block)
+    PhraseMatcher.new("DEPRECATION WARNING: #{@message}").matches?(@actual)
+  end
+
+  def failure_message
+    "expected deprecation warning #{@message.inspect}, got #{@actual.inspect}"
+  end
+
+  private
+
+  def hijack_stderr
+    err = $stderr
+    $stderr = StringIO.new
+    yield
+    $stderr.string.rstrip
+  ensure
+    $stderr = err
+  end
+end

data/spec/view_helpers/action_view_spec.rb

@@ -293,6 +293,45 @@ describe WillPaginate::ActionView do
     end
   end
 
+  it "renders using ActionView helpers on a custom object" do
+    helper = Object.new
+    class << helper
+      attr_reader :controller
+      include ActionView::Helpers::UrlHelper
+      include Routes.url_helpers
+      include WillPaginate::ActionView
+    end
+    helper.default_url_options[:controller] = 'dummy'
+
+    collection = WillPaginate::Collection.new(2, 1, 3)
+    @render_output = helper.will_paginate(collection)
+
+    assert_select 'a[href]', 4 do |links|
+      urls = links.map {|l| l['href'] }.uniq
+      urls.should == ['/dummy/page/1', '/dummy/page/3']
+    end
+  end
+
+  it "renders using ActionDispatch helper on a custom object" do
+    helper = Object.new
+    class << helper
+      include ActionDispatch::Routing::UrlFor
+      include Routes.url_helpers
+      include WillPaginate::ActionView
+    end
+    helper.default_url_options[:host] = 'example.com'
+    helper.default_url_options[:controller] = 'dummy'
+    # helper.default_url_options[:only_path] = true
+
+    collection = WillPaginate::Collection.new(2, 1, 3)
+    @render_output = helper.will_paginate(collection)
+
+    assert_select 'a[href]', 4 do |links|
+      urls = links.map {|l| l['href'] }.uniq
+      urls.should == ['http://example.com/dummy/page/1', 'http://example.com/dummy/page/3']
+    end
+  end
+
   private
 
   def translation(data)

data/spec/view_helpers/base_spec.rb

@@ -33,6 +33,20 @@ describe WillPaginate::ViewHelpers do
       will_paginate(collection).should be_nil
     end
   end
+
+  describe "pagination_options" do
+    let(:pagination_options) { WillPaginate::ViewHelpers.pagination_options }
+
+    it "deprecates setting :renderer" do
+      begin
+        lambda {
+          pagination_options[:renderer] = 'test'
+        }.should have_deprecation("pagination_options[:renderer] shouldn't be set")
+      ensure
+        pagination_options.delete :renderer
+      end
+    end
+  end
   
   describe "page_entries_info" do
     before :all do

data/spec/view_helpers/link_renderer_base_spec.rb

@@ -71,7 +71,15 @@ describe WillPaginate::ViewHelpers::LinkRendererBase do
   end
   
   protected
-  
+
+    def collection(params = {})
+      if params[:total_pages]
+        params[:per_page] = 1
+        params[:total_entries] = params[:total_pages]
+      end
+      WillPaginate::Collection.new(params[:page] || 1, params[:per_page] || 30, params[:total_entries])
+    end
+
     def prepare(collection_options, options = {})
       @renderer.prepare(collection(collection_options), options)
     end

metadata

@@ -2,7 +2,7 @@
 name: will_paginate
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 3.0.0
+  version: 3.0.1
 platform: ruby
 authors: 
 - "Mislav Marohni\xC4\x87"
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-08-09 00:00:00 Z
+date: 2011-09-17 00:00:00 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.
@@ -29,6 +29,7 @@ files:
 - 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
 - lib/will_paginate/page_number.rb
@@ -100,7 +101,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.5
+rubygems_version: 1.8.8
 signing_key: 
 specification_version: 3
 summary: Pagination plugin for web frameworks and other apps