merb_paginate 0.9.0

data/lib/will_paginate/finders/active_record/named_scope_patch.rb

@@ -0,0 +1,39 @@
+## based on http://dev.rubyonrails.org/changeset/9084
+
+ActiveRecord::Associations::AssociationProxy.class_eval do
+  protected
+  def with_scope(*args, &block)
+    @reflection.klass.send :with_scope, *args, &block
+  end
+end
+
+[ ActiveRecord::Associations::AssociationCollection,
+    ActiveRecord::Associations::HasManyThroughAssociation ].each do |klass|
+  klass.class_eval do
+    protected
+    alias :method_missing_without_scopes :method_missing_without_paginate
+    def method_missing_without_paginate(method, *args, &block)
+      if @reflection.klass.scopes.include?(method)
+        @reflection.klass.scopes[method].call(self, *args, &block)
+      else
+        method_missing_without_scopes(method, *args, &block)
+      end
+    end
+  end
+end
+
+# Rails 1.2.6
+ActiveRecord::Associations::HasAndBelongsToManyAssociation.class_eval do
+  protected
+  def method_missing(method, *args, &block)
+    if @target.respond_to?(method) || (!@reflection.klass.respond_to?(method) && Class.respond_to?(method))
+      super
+    elsif @reflection.klass.scopes.include?(method)
+      @reflection.klass.scopes[method].call(self, *args)
+    else
+      @reflection.klass.with_scope(:find => { :conditions => @finder_sql, :joins => @join_sql, :readonly => false }) do
+        @reflection.klass.send(method, *args, &block)
+      end
+    end
+  end
+end if ActiveRecord::Base.respond_to? :find_first

data/lib/will_paginate/finders/active_resource.rb

@@ -0,0 +1,51 @@
+require 'will_paginate/finders/base'
+require 'active_resource'
+
+module WillPaginate::Finders
+  # Paginate your ActiveResource models.
+  # 
+  #   @posts = Post.paginate :all, :params => {
+  #              :page => params[:page], :order => 'created_at DESC'
+  #            }
+  # 
+  module ActiveResource
+    include WillPaginate::Finders::Base
+    
+  protected
+  
+    def wp_query(options, pager, args, &block) #:nodoc:
+      unless args.empty? or args.first == :all
+        raise ArgumentError, "finder arguments other than :all are not supported for pagination (#{args.inspect} given)"
+      end
+      params = (options[:params] ||= {})
+      params[:page] = pager.current_page
+      params[:per_page] = pager.per_page
+      
+      pager.replace find_every(options, &block)
+    end
+    
+    # Takes the format that Hash.from_xml produces out of an unknown type
+    # (produced by WillPaginate::Collection#to_xml_with_collection_type), 
+    # parses it into a WillPaginate::Collection,
+    # and forwards the result to the former +instantiate_collection+ method.
+    # It only does this for hashes that have a :type => "collection".
+    def instantiate_collection_with_collection(collection, prefix_options = {}) #:nodoc:
+      if collection.is_a?(Hash) && collection["type"] == "collection"
+        collectables = collection.values.find{ |c| c.is_a?(Hash) || c.is_a?(Array) }
+        collectables = [collectables].compact unless collectables.kind_of?(Array)
+        instantiated_collection = WillPaginate::Collection.create(collection["current_page"], collection["per_page"], collection["total_entries"]) do |pager|
+          pager.replace instantiate_collection_without_collection(collectables, prefix_options)
+        end
+      else
+        instantiate_collection_without_collection(collection, prefix_options)
+      end
+    end
+  end
+end
+
+ActiveResource::Base.class_eval do
+  extend WillPaginate::Finders::ActiveResource
+  class << self
+    # alias_method_chain :instantiate_collection, :collection
+  end
+end

data/lib/will_paginate/finders/base.rb

@@ -0,0 +1,112 @@
+require 'will_paginate/core_ext'
+
+module WillPaginate
+  module Finders
+    # = Database-agnostic finder module
+    # 
+    # Out of the box, will_paginate supports hooking in several ORMs to
+    # provide paginating finders based on their API. As of this writing, the
+    # supported libraries are:
+    #
+    # * ActiveRecord
+    # * DataMapper
+    # * Sequel
+    #
+    # It's easy to write your own adapter for anything that can load data with
+    # explicit limit and offset settings. DataMapper adapter is a nice and
+    # compact example of writing an adapter to bring the +paginate+ method to
+    # DataMapper models.
+    #
+    # == The importance of SQL's <tt>ORDER BY</tt>
+    #
+    # In most ORMs, <tt>:order</tt> parameter specifies columns for the
+    # <tt>ORDER BY</tt> clause in SQL. It is important to have it, since
+    # pagination only makes sense with ordered sets. Without the order clause,
+    # databases aren't required to do consistent ordering when performing
+    # <tt>SELECT</tt> queries.
+    # 
+    # Ordering by a field for which many records share the same value (e.g.
+    # "status") can still result in incorrect ordering with some databases (MS
+    # SQL and Postgres for instance). With these databases it's recommend that
+    # you order by primary key as well. That is, instead of ordering by
+    # "status DESC", use the alternative "status DESC, id DESC" and this will
+    # yield consistent results.
+    #
+    # Therefore, make sure you are doing ordering on a column that makes the
+    # most sense in the current context. Make that obvious to the user, also.
+    # For perfomance reasons you will also want to add an index to that column.
+    module Base
+      def per_page
+        @per_page ||= 30
+      end
+      
+      def per_page=(limit)
+        @per_page = limit.to_i
+      end
+      
+      # This is the main paginating finder.
+      #
+      # == Special parameters for paginating finders
+      # * <tt>:page</tt> -- REQUIRED, but defaults to 1 if false or nil
+      # * <tt>:per_page</tt> -- defaults to <tt>CurrentModel.per_page</tt> (which is 30 if not overridden)
+      # * <tt>:total_entries</tt> -- use only if you manually count total entries
+      # * <tt>:count</tt> -- additional options that are passed on to +count+
+      # * <tt>:finder</tt> -- name of the finder method to use (default: "find")
+      #
+      # All other options (+conditions+, +order+, ...) are forwarded to +find+
+      # and +count+ calls.
+      def paginate(*args, &block)
+        options = args.pop
+        page, per_page, total_entries = wp_parse_options(options)
+
+        WillPaginate::Collection.create(page, per_page, total_entries) do |pager|
+          query_options = options.except :page, :per_page, :total_entries
+          wp_query(query_options, pager, args, &block)
+        end
+      end
+
+      # Iterates through all records by loading one page at a time. This is useful
+      # for migrations or any other use case where you don't want to load all the
+      # records in memory at once.
+      #
+      # It uses +paginate+ internally; therefore it accepts all of its options.
+      # You can specify a starting page with <tt>:page</tt> (default is 1). Default
+      # <tt>:order</tt> is <tt>"id"</tt>, override if necessary.
+      #
+      # {Jamis Buck describes this}[http://weblog.jamisbuck.org/2007/4/6/faking-cursors-in-activerecord]
+      # and also uses a more efficient way for MySQL.
+      def paginated_each(options = {}, &block)
+        options = { :order => 'id', :page => 1 }.merge options
+        options[:page] = options[:page].to_i
+        options[:total_entries] = 0 # skip the individual count queries
+        total = 0
+        
+        begin 
+          collection = paginate(options)
+          total += collection.each(&block).size
+          options[:page] += 1
+        end until collection.size < collection.per_page
+        
+        total
+      end
+      
+      protected
+        
+        def wp_parse_options(options) #:nodoc:
+          raise ArgumentError, 'parameter hash expected' unless Hash === options
+          raise ArgumentError, ':page parameter required' unless options.key? :page
+          
+          if options[:count] and options[:total_entries]
+            raise ArgumentError, ':count and :total_entries are mutually exclusive'
+          end
+
+          page     = options[:page] || 1
+          per_page = options[:per_page] || self.per_page
+          total    = options[:total_entries]
+          
+          return [page, per_page, total]
+        end
+        
+    end
+  end
+end

data/lib/will_paginate/finders/data_mapper.rb

@@ -0,0 +1,30 @@
+require 'will_paginate/finders/base'
+require 'dm-core'
+
+module WillPaginate::Finders
+  module DataMapper
+    include WillPaginate::Finders::Base
+
+  protected
+    
+    def wp_query(options, pager, args, &block) #:nodoc
+      find_options = options.except(:count).update(:offset => pager.offset, :limit => pager.per_page) 
+
+      pager.replace all(find_options, &block)
+      
+      unless pager.total_entries
+        pager.total_entries = wp_count(options)
+      end
+    end
+
+    def wp_count(options) #:nodoc
+      count_options = options.except(:count, :order)
+      # merge the hash found in :count
+      count_options.update options[:count] if options[:count]
+
+      count_options.empty?? count() : count(count_options)
+    end
+  end
+end
+
+DataMapper::Model.send(:include, WillPaginate::Finders::DataMapper)

data/lib/will_paginate/finders/sequel.rb

@@ -0,0 +1,21 @@
+require 'sequel'
+
+existing_methods = Sequel::Dataset::Pagination.instance_methods
+
+Sequel::Dataset::Pagination.module_eval do
+  # it should quack like a WillPaginate::Collection
+  
+  alias :total_pages   :page_count  unless existing_methods.include? 'total_pages'
+  alias :per_page      :page_size   unless existing_methods.include? 'per_page'
+  alias :previous_page :prev_page   unless existing_methods.include? 'previous_page'
+  alias :total_entries :pagination_record_count unless existing_methods.include? 'total_entries'
+  
+  def out_of_bounds?
+    current_page > total_pages
+  end
+
+  # Current offset of the paginated collection
+  def offset
+    (current_page - 1) * per_page
+  end
+end

data/lib/will_paginate/version.rb

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

data/lib/will_paginate/view_helpers.rb

@@ -0,0 +1,42 @@
+require 'will_paginate/deprecation'
+
+module WillPaginate
+  # = Will Paginate view helpers
+  #
+  # The main view helper is +will_paginate+. It renders the pagination links
+  # for the given collection. The helper itself is lightweight and serves only
+  # as a wrapper around LinkRenderer instantiation; the renderer then does
+  # all the hard work of generating the HTML.
+  # 
+  # Read more in WillPaginate::ViewHelpers::Base
+  module ViewHelpers
+    # ==== Global options for helpers
+    #
+    # Options for pagination helpers are optional and get their default values
+    # from the WillPaginate::ViewHelpers.pagination_options hash. You can write
+    # to this hash to override default options on the global level:
+    #
+    #   WillPaginate::ViewHelpers.pagination_options[:previous_label] = 'Previous page'
+    #
+    # By putting this into your environment.rb you can easily translate link
+    # texts to previous and next pages, as well as override some other defaults
+    # to your liking.
+    def self.pagination_options() @pagination_options; end
+    # Overrides the default +pagination_options+
+    def self.pagination_options=(value) @pagination_options = value; end
+    
+    self.pagination_options = {
+      :class          => 'pagination',
+      :previous_label => '« Previous',
+      :next_label     => 'Next »',
+      :inner_window   => 4, # links around the current page
+      :outer_window   => 1, # links around beginning and end
+      :separator      => ' ', # single space is friendly to spiders and non-graphic browsers
+      :param_name     => :page,
+      :params         => nil,
+      :renderer       => 'WillPaginate::ViewHelpers::LinkRenderer',
+      :page_links     => true,
+      :container      => true
+    }
+  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