agnostic-will_paginate 3.0.0

data/lib/will_paginate/view_helpers/action_view.rb

@@ -0,0 +1,158 @@
+require 'will_paginate/view_helpers/base'
+require 'action_view'
+require 'action_pack/version'
+require 'will_paginate/view_helpers/link_renderer'
+
+module WillPaginate
+  module ViewHelpers
+    # = ActionView helpers
+    # 
+    # This module serves for availability in ActionView templates. It also adds a new
+    # view helper: +paginated_section+.
+    # 
+    # == Using the helper without arguments
+    # If the helper is called without passing in the collection object, it will
+    # try to read from the instance variable inferred by the controller name.
+    # For example, calling +will_paginate+ while the current controller is
+    # PostsController will result in trying to read from the <tt>@posts</tt>
+    # variable. Example:
+    #
+    #   <%= will_paginate :id => true %>
+    #
+    # ... will result in <tt>@post</tt> collection getting paginated:
+    #
+    #   <div class="pagination" id="posts_pagination"> ... </div>
+    #
+    module ActionView
+      include WillPaginate::ViewHelpers::Base
+      
+      def will_paginate(collection = nil, options = {}) #:nodoc:
+        options, collection = collection, nil if collection.is_a? Hash
+        collection ||= infer_collection_from_controller
+
+        super(collection, options.symbolize_keys)
+      end
+      
+      def page_entries_info(collection = nil, options = {}) #:nodoc:
+        options, collection = collection, nil if collection.is_a? Hash
+        collection ||= infer_collection_from_controller
+        
+        super(collection, options.symbolize_keys)
+      end
+      
+      # Wrapper for rendering pagination links at both top and bottom of a block
+      # of content.
+      # 
+      #   <% paginated_section @posts do %>
+      #     <ol id="posts">
+      #       <% for post in @posts %>
+      #         <li> ... </li>
+      #       <% end %>
+      #     </ol>
+      #   <% end %>
+      #
+      # will result in:
+      #
+      #   <div class="pagination"> ... </div>
+      #   <ol id="posts">
+      #     ...
+      #   </ol>
+      #   <div class="pagination"> ... </div>
+      #
+      # Arguments are passed to a <tt>will_paginate</tt> call, so the same options
+      # apply. Don't use the <tt>:id</tt> option; otherwise you'll finish with two
+      # blocks of pagination links sharing the same ID (which is invalid HTML).
+      def paginated_section(*args, &block)
+        pagination = will_paginate(*args).to_s
+        
+        unless ::ActionView::Base.respond_to? :erb_variable
+          concat pagination
+          yield
+          concat pagination
+        else
+          content = pagination + capture(&block) + pagination
+          concat(content, block.binding)
+        end
+      end
+      
+    protected
+
+      def infer_collection_from_controller
+        collection_name = "@#{controller.controller_name}"
+        collection = instance_variable_get(collection_name)
+        raise ArgumentError, "The #{collection_name} variable appears to be empty. Did you " +
+          "forget to pass the collection object for will_paginate?" if collection.nil?
+        collection
+      end
+    end
+  end
+end
+
+ActionView::Base.send :include, WillPaginate::ViewHelpers::ActionView
+# :stopdoc:
+if defined?(ActionController::Base) and ActionController::Base.respond_to? :rescue_responses
+  ActionController::Base.rescue_responses['WillPaginate::InvalidPage'] = :not_found
+end
+
+WillPaginate::ViewHelpers::LinkRenderer.class_eval do
+  protected
+  
+  def default_url_params
+    { :escape => false }
+  end
+  
+  def url(page)
+    @base_url_params ||= begin
+      url_params = base_url_params
+      merge_optional_params(url_params)
+      url_params
+    end
+    
+    url_params = @base_url_params.dup
+    add_current_page_param(url_params, page)
+    
+    @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?
+    url_params
+  end
+  
+  def merge_optional_params(url_params)
+    symbolized_update(url_params, @options[:params]) if @options[:params]
+  end
+  
+  def add_current_page_param(url_params, page)
+    unless param_name.index(/[^\w-]/)
+      url_params[param_name.to_sym] = page
+    else
+      page_param = parse_query_parameters("#{param_name}=#{page}")
+      symbolized_update(url_params, page_param)
+    end
+  end
+  
+  def get_request?
+    @template.request.get?
+  end
+  
+  private
+  
+  def parse_query_parameters(params)
+    if defined? Rack::Utils
+      # For Rails > 2.3
+      Rack::Utils.parse_nested_query(params)
+    elsif defined?(ActionController::AbstractRequest)
+      ActionController::AbstractRequest.parse_query_parameters(params)
+    elsif defined?(ActionController::UrlEncodedPairParser)
+      # For Rails > 2.2
+      ActionController::UrlEncodedPairParser.parse_query_parameters(params)
+    elsif defined?(CGIMethods)
+      CGIMethods.parse_query_parameters(params)
+    else
+      raise "unsupported ActionPack version"
+    end
+  end
+end

data/lib/will_paginate/view_helpers/base.rb

@@ -0,0 +1,126 @@
+require 'will_paginate/core_ext'
+require 'will_paginate/view_helpers'
+
+module WillPaginate
+  module ViewHelpers
+    # = The main view helpers module
+    #
+    # This is the base module which provides the +will_paginate+ view helper.
+    module Base
+      # Renders Digg/Flickr-style pagination for a WillPaginate::Collection object. Nil is
+      # returned if there is only one page in total; pagination links aren't needed in that case.
+      # 
+      # ==== Options
+      # * <tt>:class</tt> -- CSS class name for the generated DIV (default: "pagination")
+      # * <tt>:previous_label</tt> -- default: "« Previous"
+      # * <tt>:next_label</tt> -- default: "Next »"
+      # * <tt>:inner_window</tt> -- how many links are shown around the current page (default: 4)
+      # * <tt>:outer_window</tt> -- how many links are around the first and the last page (default: 1)
+      # * <tt>:separator</tt> -- string separator for page HTML elements (default: single space)
+      # * <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>: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)
+      # * <tt>:id</tt> -- HTML ID for the container (default: nil). Pass +true+ to have the ID
+      #   automatically generated from the class name of objects in collection: for example, paginating
+      #   ArticleComment models would yield an ID of "article_comments_pagination".
+      #
+      # All options beside listed ones are passed as HTML attributes to the container
+      # element for pagination links (the DIV). For example:
+      # 
+      #   <%= will_paginate @posts, :id => 'wp_posts' %>
+      #
+      # ... will result in:
+      #
+      #   <div class="pagination" id="wp_posts"> ... </div>
+      #
+      def will_paginate(collection, options = {})
+        # early exit if there is nothing to render
+        return nil unless collection.total_pages > 1
+        
+        options = WillPaginate::ViewHelpers.pagination_options.merge(options)
+        
+        if options[:prev_label]
+          WillPaginate::Deprecation::warn(":prev_label view parameter is now :previous_label; the old name has been deprecated.")
+          options[:previous_label] = options.delete(:prev_label)
+        end
+        
+        # get the renderer instance
+        renderer = case options[:renderer]
+        when String
+          options[:renderer].constantize.new
+        when Class
+          options[:renderer].new
+        else
+          options[:renderer]
+        end
+        # render HTML for pagination
+        renderer.prepare collection, options, self
+        renderer.to_html
+      end
+      
+      # Renders a helpful message with numbers of displayed vs. total entries.
+      # You can use this as a blueprint for your own, similar helpers.
+      #
+      #   <%= page_entries_info @posts %>
+      #   #-> Displaying posts 6 - 10 of 26 in total
+      #
+      # By default, the message will use the humanized class name of objects
+      # in collection: for instance, "project types" for ProjectType models.
+      # Override this to your liking with the <tt>:entry_name</tt> parameter:
+      #
+      #   <%= page_entries_info @posts, :entry_name => 'item' %>
+      #   #-> Displaying items 6 - 10 of 26 in total
+      #
+      # Entry name is entered in singular and pluralized with
+      # <tt>String#pluralize</tt> method from ActiveSupport. If it isn't
+      # loaded, specify plural with <tt>:plural_name</tt> parameter:
+      #
+      #   <%= page_entries_info @posts, :entry_name => 'item', :plural_name => 'items' %>
+      #
+      # By default, this method produces HTML output. You can trigger plain
+      # text output by passing <tt>:html => false</tt> in options.
+      def page_entries_info(collection, options = {})
+        entry_name = options[:entry_name] || (collection.empty?? 'entry' :
+                     collection.first.class.name.underscore.gsub('_', ' '))
+        
+        plural_name = if options[:plural_name]
+          options[:plural_name]
+        elsif entry_name == 'entry'
+          plural_name = 'entries'
+        elsif entry_name.respond_to? :pluralize
+          plural_name = entry_name.pluralize
+        else
+          entry_name + 's'
+        end
+
+        unless options[:html] == false
+          b  = '<b>'
+          eb = '</b>'
+          sp = '&nbsp;'
+        else
+          b  = eb = ''
+          sp = ' '
+        end
+        
+        if collection.total_pages < 2
+          case collection.size
+          when 0; "No #{plural_name} found"
+          when 1; "Displaying #{b}1#{eb} #{entry_name}"
+          else;   "Displaying #{b}all #{collection.size}#{eb} #{plural_name}"
+          end
+        else
+          %{Displaying #{plural_name} #{b}%d#{sp}-#{sp}%d#{eb} of #{b}%d#{eb} in total} % [
+            collection.offset + 1,
+            collection.offset + collection.length,
+            collection.total_entries
+          ]
+        end
+      end
+    end
+  end
+end

data/lib/will_paginate/view_helpers/link_renderer.rb

@@ -0,0 +1,130 @@
+require 'cgi'
+require 'will_paginate/core_ext'
+require 'will_paginate/view_helpers/link_renderer_base'
+
+module WillPaginate
+  module ViewHelpers
+    # This class does the heavy lifting of actually building the pagination
+    # links. It is used by +will_paginate+ helper internally.
+    class LinkRenderer < LinkRendererBase
+      
+      # * +collection+ is a WillPaginate::Collection instance or any other object
+      #   that conforms to that API
+      # * +options+ are forwarded from +will_paginate+ view helper
+      # * +template+ is the reference to the template being rendered
+      def prepare(collection, options, template)
+        super(collection, options)
+        @template = template
+        @container_attributes = @base_url_params = nil
+      end
+
+      # Process it! This method returns the complete HTML string which contains
+      # pagination links. Feel free to subclass LinkRenderer and change this
+      # method as you see fit.
+      def to_html
+        html = pagination.map do |item|
+          item.is_a?(Fixnum) ?
+            page_number(item) :
+            send(item)
+        end.join(@options[:separator])
+        
+        @options[:container] ? html_container(html) : html
+      end
+
+      # 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 ||= begin
+          attributes = @options.except *(WillPaginate::ViewHelpers.pagination_options.keys - [:class])
+          # pagination of Post models will have the ID of "posts_pagination"
+          if @options[:container] and @options[:id] === true
+            attributes[:id] = @collection.first.class.name.underscore.pluralize + '_pagination'
+          end
+          attributes
+        end
+      end
+      
+    protected
+    
+      def page_number(page)
+        unless page == current_page
+          link(page, page, :rel => rel_value(page))
+        else
+          tag(:em, page)
+        end
+      end
+      
+      def gap
+        '<span class="gap">&hellip;</span>'
+      end
+      
+      def previous_page
+        previous_or_next_page(@collection.previous_page, @options[:previous_label], 'previous_page')
+      end
+      
+      def next_page
+        previous_or_next_page(@collection.next_page, @options[:next_label], 'next_page')
+      end
+      
+      def previous_or_next_page(page, text, classname)
+        if page
+          link(text, page, :class => classname)
+        else
+          tag(:span, text, :class => classname + ' disabled')
+        end
+      end
+      
+      def html_container(html)
+        tag(:div, html, container_attributes)
+      end
+      
+      # Returns URL params for +page_link_or_span+, taking the current GET params
+      # and <tt>:params</tt> option into account.
+      def url(page)
+        raise NotImplementedError
+      end
+      
+    private
+
+      def link(text, target, attributes = {})
+        if target.is_a? Fixnum
+          attributes[:rel] = rel_value(target)
+          target = url(target)
+        end
+        attributes[:href] = target
+        tag(:a, text, attributes)
+      end
+      
+      def tag(name, value, attributes = {})
+        string_attributes = attributes.inject('') do |attrs, pair|
+          unless pair.last.nil?
+            attrs << %( #{pair.first}="#{CGI::escapeHTML(pair.last.to_s)}")
+          end
+          attrs
+        end
+        "<#{name}#{string_attributes}>#{value}</#{name}>"
+      end
+
+      def rel_value(page)
+        case page
+        when @collection.previous_page; 'prev' + (page == 1 ? ' start' : '')
+        when @collection.next_page; 'next'
+        when 1; 'start'
+        end
+      end
+
+      def symbolized_update(target, other)
+        other.each do |key, value|
+          key = key.to_sym
+          existing = target[key]
+          
+          if value.is_a?(Hash) and (existing.is_a?(Hash) or existing.nil?)
+            symbolized_update(existing || (target[key] = {}), value)
+          else
+            target[key] = value
+          end
+        end
+      end
+    end
+  end
+end

data/lib/will_paginate/view_helpers/link_renderer_base.rb

@@ -0,0 +1,83 @@
+require 'will_paginate/view_helpers'
+
+module WillPaginate
+  module ViewHelpers
+    # This class does the heavy lifting of actually building the pagination
+    # links. It is used by +will_paginate+ helper internally.
+    class LinkRendererBase
+
+      # * +collection+ is a WillPaginate::Collection instance or any other object
+      #   that conforms to that API
+      # * +options+ are forwarded from +will_paginate+ view helper
+      def prepare(collection, options)
+        @collection = collection
+        @options    = options
+
+        # reset values in case we're re-using this instance
+        @total_pages = @param_name = nil
+      end
+      
+      def pagination
+        items = @options[:page_links] ? windowed_page_numbers : []
+        items.unshift :previous_page
+        items.push :next_page
+      end
+
+    protected
+    
+      # Calculates visible page numbers using the <tt>:inner_window</tt> and
+      # <tt>:outer_window</tt> options.
+      def windowed_page_numbers
+        inner_window, outer_window = @options[:inner_window].to_i, @options[:outer_window].to_i
+        window_from = current_page - inner_window
+        window_to = current_page + inner_window
+        
+        # adjust lower or upper limit if other is out of bounds
+        if window_to > total_pages
+          window_from -= window_to - total_pages
+          window_to = total_pages
+        end
+        if window_from < 1
+          window_to += 1 - window_from
+          window_from = 1
+          window_to = total_pages if window_to > total_pages
+        end
+        
+        # these are always visible
+        middle = window_from..window_to
+
+        # left window
+        if outer_window + 3 < middle.first # there's a gap
+          left = (1..(outer_window + 1)).to_a
+          left << :gap
+        else # runs into visible pages
+          left = 1...middle.first
+        end
+
+        # right window
+        if total_pages - outer_window - 2 > middle.last # again, gap
+          right = ((total_pages - outer_window)..total_pages).to_a
+          right.unshift :gap
+        else # runs into visible pages
+          right = (middle.last + 1)..total_pages
+        end
+        
+        left.to_a + middle.to_a + right.to_a
+      end
+
+    private
+
+      def current_page
+        @collection.current_page
+      end
+
+      def total_pages
+        @collection.total_pages
+      end
+
+      def param_name
+        @param_name ||= @options[:param_name].to_s
+      end
+    end
+  end
+end