will_paginate 3.0.pre4 → 3.0.0

data/lib/will_paginate/view_helpers/action_view.rb

@@ -1,136 +1,148 @@
-require 'will_paginate/view_helpers/base'
+require 'will_paginate/view_helpers'
 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+.
+  # = 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 ViewHelpers
+
+    def will_paginate(collection = nil, options = {}) #:nodoc:
+      options, collection = collection, nil if collection.is_a? Hash
+      collection ||= infer_collection_from_controller
+
+      options = options.symbolize_keys
+      options[:renderer] ||= LinkRenderer
+
+      super(collection, options).try(:html_safe)
+    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.
     # 
-    # == 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:
+    #   <% paginated_section @posts do %>
+    #     <ol id="posts">
+    #       <% for post in @posts %>
+    #         <li> ... </li>
+    #       <% end %>
+    #     </ol>
+    #   <% end %>
     #
-    #   <%= will_paginate :id => true %>
+    # will result in:
     #
-    # ... will result in <tt>@post</tt> collection getting paginated:
+    #   <div class="pagination"> ... </div>
+    #   <ol id="posts">
+    #     ...
+    #   </ol>
+    #   <div class="pagination"> ... </div>
     #
-    #   <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).try(:html_safe)
+    # 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)
+      if pagination
+        pagination + capture(&block) + pagination
+      else
+        capture(&block)
+      end
+    end
+
+    def will_paginate_translate(keys, options = {})
+      if Array === keys
+        defaults = keys.dup
+        key = defaults.shift
+      else
+        defaults = nil
+        key = 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).try(:html_safe)
+      translate(key, options.merge(:default => defaults, :scope => :will_paginate))
+    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
+
+    class LinkRenderer < ViewHelpers::LinkRenderer
+      protected
+
+      def default_url_params
+        {}
       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)
-        if pagination
-          pagination + capture(&block) + pagination
+
+      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
-          capture(&block)
+          page_param = parse_query_parameters("#{param_name}=#{page}")
+          symbolized_update(url_params, page_param)
         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
+      def get_request?
+        @template.request.get?
       end
-    end
-  end
-end
 
-# :stopdoc:
+      private
 
-WillPaginate::ViewHelpers::LinkRenderer.class_eval do
-  protected
-  
-  def default_url_params
-    {}
-  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)
+      def parse_query_parameters(params)
+        Rack::Utils.parse_nested_query(params)
+      end
     end
-  end
-  
-  def get_request?
-    @template.request.get?
-  end
-  
-  private
-  
-  def parse_query_parameters(params)
-    Rack::Utils.parse_nested_query(params)
+
+    ::ActionView::Base.send :include, self
   end
 end

data/lib/will_paginate/view_helpers/link_renderer.rb

@@ -1,5 +1,6 @@
 require 'cgi'
 require 'will_paginate/core_ext'
+require 'will_paginate/view_helpers'
 require 'will_paginate/view_helpers/link_renderer_base'
 
 module WillPaginate
@@ -26,7 +27,7 @@ module WillPaginate
           item.is_a?(Fixnum) ?
             page_number(item) :
             send(item)
-        end.join(@options[:separator])
+        end.join(@options[:link_separator])
         
         @options[:container] ? html_container(html) : html
       end
@@ -34,14 +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 ||= 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
+        @container_attributes ||= @options.except(*(ViewHelpers.pagination_options.keys - [:class]))
       end
       
     protected
@@ -50,12 +44,13 @@ module WillPaginate
         unless page == current_page
           link(page, page, :rel => rel_value(page))
         else
-          tag(:em, page)
+          tag(:em, page, :class => 'current')
         end
       end
       
       def gap
-        '<span class="gap">&hellip;</span>'
+        text = @template.will_paginate_translate(:page_gap) { '&hellip;' }
+        %(<span class="gap">#{text}</span>)
       end
       
       def previous_page
@@ -88,6 +83,10 @@ module WillPaginate
       
     private
 
+      def param_name
+        @options[:param_name].to_s
+      end
+
       def link(text, target, attributes = {})
         if target.is_a? Fixnum
           attributes[:rel] = rel_value(target)

data/lib/will_paginate/view_helpers/link_renderer_base.rb

@@ -1,5 +1,3 @@
-require 'will_paginate/view_helpers'
-
 module WillPaginate
   module ViewHelpers
     # This class does the heavy lifting of actually building the pagination
@@ -14,7 +12,7 @@ module WillPaginate
         @options    = options
 
         # reset values in case we're re-using this instance
-        @total_pages = @param_name = nil
+        @total_pages = nil
       end
       
       def pagination
@@ -72,11 +70,7 @@ module WillPaginate
       end
 
       def total_pages
-        @collection.total_pages
-      end
-
-      def param_name
-        @param_name ||= @options[:param_name].to_s
+        @total_pages ||= @collection.total_pages
       end
     end
   end

data/lib/will_paginate/view_helpers/merb.rb

@@ -1,13 +1,26 @@
-require 'will_paginate/view_helpers/base'
+require 'will_paginate/core_ext'
+require 'will_paginate/view_helpers'
 require 'will_paginate/view_helpers/link_renderer'
 
-WillPaginate::ViewHelpers::LinkRenderer.class_eval do
-  protected
+module WillPaginate
+  module Merb
+    include ViewHelpers
 
-  def url(page)
-    params = @template.request.params.except(:action, :controller).merge(param_name => page)
-    @template.url(:this, params)
+    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
 
-Merb::AbstractController.send(:include, WillPaginate::ViewHelpers::Base)

data/lib/will_paginate/view_helpers/sinatra.rb

@@ -0,0 +1,41 @@
+require 'sinatra/base'
+require 'will_paginate/view_helpers'
+require 'will_paginate/view_helpers/link_renderer'
+
+module WillPaginate
+  module Sinatra
+    module Helpers
+      include ViewHelpers
+
+      def will_paginate(collection, options = {}) #:nodoc:
+        options = options.merge(:renderer => LinkRenderer) unless options[:renderer]
+        super(collection, options)
+      end
+    end
+
+    class LinkRenderer < ViewHelpers::LinkRenderer
+      protected
+
+      def url(page)
+        str = File.join(request.script_name.to_s, request.path_info)
+        params = request.GET.merge(param_name.to_s => page.to_s)
+        params.update @options[:params] if @options[:params]
+        str << '?' << build_query(params)
+      end
+
+      def request
+        @template.request
+      end
+
+      def build_query(params)
+        Rack::Utils.build_nested_query params
+      end
+    end
+
+    def self.registered(app)
+      app.helpers Helpers
+    end
+
+    ::Sinatra.register self
+  end
+end

data/spec/ci.rb

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+databases = %w[ sqlite3 mysql mysql2 postgres ]
+databases.delete 'mysql2' if ENV['BUNDLE_GEMFILE'].to_s.include? 'rails3.0'
+
+def announce(name, msg)
+  puts "\n\e[1;33m[#{name}] #{msg}\e[m\n"
+end
+
+def system(*args)
+  puts "$ #{args.join(' ')}"
+  super
+end
+
+if ENV['TRAVIS']
+  system "mysql -e 'create database will_paginate;' >/dev/null"
+  abort "failed to create mysql database" unless $?.success?
+  system "psql -c 'create database will_paginate;' -U postgres >/dev/null"
+  abort "failed to create postgres database" unless $?.success?
+end
+
+failed = false
+
+for db in databases
+  announce "DB", db
+  ENV['DB'] = db
+  failed = true unless system %(rake)
+end
+
+exit 1 if failed