actionpack 1.5.1 → 1.6.0

data/CHANGELOG

@@ -1,3 +1,97 @@
+*1.6.0* (22th March, 2005)
+
+* Added a JavascriptHelper and accompanying prototype.js library that opens the world of Ajax to Action Pack with a large array of options for dynamically interacting with an application without reloading the page #884 [Sam Stephenson/David]
+
+* Added pagination support through both a controller and helper add-on #817 [Sam Stephenson]
+
+* Fixed routing and helpers to make Rails work on non-vhost setups #826 [Nicholas Seckar/Tobias Luetke]
+
+* Added a much improved Flash module that allows for finer-grained control on expiration and allows you to flash the current action #839 [Caio Chassot]. Example of flash.now:
+
+    class SomethingController < ApplicationController
+      def save
+        ...
+        if @something.save
+          # will redirect, use flash
+          flash[:message] = 'Save successful'
+          redirect_to :action => 'list'
+        else
+          # no redirect, message is for current action, use flash.now
+          flash.now[:message] = 'Save failed, review'
+          render_action 'edit'
+        end
+      end    
+    end
+
+* Added to_param call for parameters when composing an url using url_for from something else than strings #812 [Sam Stephenson]. Example:
+
+    class Page
+      def initialize(number)
+        @number = number
+      end
+      # ...
+      def to_param
+        @number.to_s
+      end
+    end
+
+  You can now use instances of Page with url_for:
+
+    class BarController < ApplicationController
+      def baz
+        page = Page.new(4)
+        url = url_for :page => page # => "http://foo/bar/baz?page=4"
+      end
+    end
+
+* Fixed form helpers to query Model#id_before_type_cast instead of Model#id as a temporary workaround for Ruby 1.8.2 warnings #818 [DeLynn B]
+
+* Fixed TextHelper#markdown to use blank? instead of empty? so it can deal with nil strings passed #814 [Johan Sörensen]
+
+* Added TextHelper#simple_format as a non-dependency text presentation helper #814 [Johan Sörensen]
+
+* Added that the html options disabled, readonly, and multiple can all be treated as booleans. So specifying <tt>disabled => :true</tt> will give <tt>disabled="disabled"</tt>. #809 [mindel]
+
+* Added path collection syntax for Routes that will gobble up the rest of the url and pass it on to the controller #830 [rayners]. Example:
+
+    map.connect 'categories/*path_info', :controller => 'categories', :action => 'show'
+
+  A request for /categories/top-level-cat, would give @params[:path_info] with "top-level-cat".
+  A request for /categories/top-level-cat/level-1-cat, would give @params[:path_info] with "top-level-cat/level-1-cat" and so forth.
+  
+  The @params[:path_info] return is really an array, but where to_s has been overwritten to do join("/").
+
+* Fixed options_for_select on selected line issue #624 [Florian Weber]
+
+* Added CaptureHelper with CaptureHelper#capture and CaptureHelper#content_for. See documentation in helper #837 [Tobias Luetke]
+
+* Fixed :anchor use in url_for #821 [Nicholas Seckar]
+
+* Removed the reliance on PATH_INFO as it was causing problems for caching and inhibited the new non-vhost support #822 [Nicholas Seckar]
+
+* Added assigns shortcut for @response.template.assigns to controller test cases [bitsweat]. Example:
+
+  Before:
+
+    def test_list
+      assert_equal 5, @response.template.assigns['recipes'].size
+      assert_equal 8, @response.template.assigns['categories'].size
+    end
+
+  After:
+
+    def test_list
+      assert_equal 5, assigns(:recipes).size
+      assert_equal 8, assigns(:categories).size
+    end
+
+* Added TagHelper#image_tag and deprecated UrlHelper#link_image_to (recommended approach is to combine image_tag and link_to instead)
+
+* Fixed textilize to be resilient to getting nil parsed (by using Object#blank? instead of String#empty?)
+
+* Fixed that the :multipart option in FormTagHelper#form_tag would be ignored [Yonatan Feldman]
+
+
 *1.5.1* (7th March, 2005)
 
 * Fixed that the routes.rb file wouldn't be found on symlinked setups due to File.expand_path #793 [piotr@t-p-l.com]

data/README

@@ -168,6 +168,30 @@ A short rundown of the major features:
   {Learn more}[link:classes/ActionController/Base.html]
 
 
+* Javascript and Ajax integration.
+
+    link_to_function "Greeting", "alert('Hello world!')"
+    link_to_remote "Delete this post", :update => "posts", 
+                   :url => { :action => "destroy", :id => post.id }
+  
+  {Learn more}[link:classes/ActionView/Helpers/JavascriptHelper.html]
+
+
+* Pagination for navigating lists of results.
+
+    # controller
+    def list
+      @pages, @people =
+        paginate :people, :order_by => 'last_name, first_name'
+    end
+
+    # view
+    <%= link_to "Previous page", { :page => @pages.current.previous } if @pages.current.previous %>
+    <%= link_to "Next page", { :page => @pages.current.next } of @pages.current.next =%>
+
+  {Learn more}[link:classes/ActionController/Pagination.html]
+
+
 * Easy testing of both controller and template result through TestRequest/Response
 
     class LoginControllerTest < Test::Unit::TestCase

data/lib/action_controller.rb

@@ -39,6 +39,7 @@ require 'action_controller/layout'
 require 'action_controller/flash'
 require 'action_controller/session'
 require 'action_controller/dependencies'
+require 'action_controller/pagination'
 require 'action_controller/scaffolding'
 require 'action_controller/helpers'
 require 'action_controller/cookies'
@@ -56,6 +57,7 @@ ActionController::Base.class_eval do
   include ActionController::Benchmarking
   include ActionController::Rescue
   include ActionController::Dependencies
+  include ActionController::Pagination
   include ActionController::Scaffolding
   include ActionController::Helpers
   include ActionController::Cookies

data/lib/action_controller/assertions/action_pack_assertions.rb

@@ -137,7 +137,7 @@ module Test #:nodoc:
           if options.is_a?(Symbol)
             response.redirected_to == options
           else
-            options.keys.all? { |k| options[k] == response.redirected_to[k] }
+            options.keys.all? { |k| options[k] == ( response.redirected_to[k].respond_to?(:to_param) ? response.redirected_to[k].to_param : response.redirected_to[k] if response.redirected_to[k] ) }
           end
         end
       end

data/lib/action_controller/base.rb

@@ -96,16 +96,19 @@ module ActionController #:nodoc:
   #
   # You can place objects in the session by using the <tt>@session</tt> hash:
   #
-  #   @session["person"] = Person.authenticate(user_name, password)
+  #   @session[:person] = Person.authenticate(user_name, password)
   #
   # And retrieved again through the same hash:
   #
-  #   Hello #{@session["person"]}
+  #   Hello #{@session[:person]}
   #
   # Any object can be placed in the session (as long as it can be Marshalled). But remember that 1000 active sessions each storing a
   # 50kb object could lead to a 50MB memory overhead. In other words, think carefully about size and caching before resorting to the use
   # of the session.
   #
+  # For removing objects from the session, you can either assign a single key to nil, like <tt>@session[:person] = nil</tt>, or you can
+  # remove the entire session with reset_session.
+  #
   # == Responses
   #
   # Each action results in a response, which holds the headers and document to be sent to the user's browser. The actual response
@@ -476,6 +479,16 @@ module ActionController #:nodoc:
         add_variables_to_assigns
         @template.render_file(template_name)
       end
+      
+      def render_partial(partial_path, object = nil, local_assigns = {}) #:doc:
+        add_variables_to_assigns
+        render_text(@template.render_partial(partial_path, object, local_assigns))
+      end
+
+      def render_partial_collection(partial_name, collection, partial_spacer_template = nil, local_assigns = {})#:doc:
+        add_variables_to_assigns
+        render_text(@template.render_collection_of_partials(partial_name, collection, partial_spacer_template, local_assigns))
+      end
 
       # Sends the file by streaming it 4096 bytes at a time. This way the
       # whole file doesn't need to be read into memory at once.  This makes

data/lib/action_controller/caching.rb

@@ -292,11 +292,7 @@ module ActionController #:nodoc:
         end
 
         def read(name, options = {}) #:nodoc:
-          begin
-            @mutex.synchronize { @data[name] }
-          rescue
-            nil
-          end
+          @mutex.synchronize { @data[name] } rescue nil
         end
 
         def write(name, value, options = {}) #:nodoc:
@@ -326,20 +322,14 @@ module ActionController #:nodoc:
         end
     
         def write(name, value, options = {}) #:nodoc:
-          begin
-            ensure_cache_path(File.dirname(real_file_path(name)))
-            File.open(real_file_path(name), "w+") { |f| f.write(value) }
-          rescue => e
-            Base.logger.info "Couldn't create cache directory: #{name} (#{e.message})" unless Base.logger.nil?
-          end
+          ensure_cache_path(File.dirname(real_file_path(name)))
+          File.open(real_file_path(name), "w+") { |f| f.write(value) }
+        rescue => e
+          Base.logger.info "Couldn't create cache directory: #{name} (#{e.message})" unless Base.logger.nil?
         end
 
         def read(name, options = {}) #:nodoc:
-          begin
-            IO.read(real_file_path(name))
-          rescue
-            nil
-          end
+          IO.read(real_file_path(name)) rescue nil
         end
 
         def delete(name, options) #:nodoc:

data/lib/action_controller/components.rb

@@ -54,7 +54,7 @@ module ActionController #:nodoc:
         request_for_component = @request.dup
         request_for_component.send(
           :instance_variable_set, :@parameters, 
-          (options[:params] || {}).merge({ "controller" => options[:controller], "action" => options[:action], "id" => options[:id] })
+          (options[:params] || {}).merge({ "controller" => options[:controller], "action" => options[:action], "id" => options[:id] }).with_indifferent_access
         )
         return request_for_component
       end

data/lib/action_controller/flash.rb

@@ -21,45 +21,141 @@ module ActionController #:nodoc:
   #
   # This example just places a string in the flash, but you can put any object in there. And of course, you can put as many
   # as you like at a time too. Just remember: They'll be gone by the time the next action has been performed.
+  #
+  # See docs on the FlashHash class for more details about the flash.
   module Flash
+
     def self.append_features(base) #:nodoc:
       super
       base.before_filter(:fire_flash)
-      base.after_filter(:clear_flash)
+      base.after_filter(:sweep_flash)
     end
 
-    protected
-      # Access the contents of the flash. Use <tt>flash["notice"]</tt> to read a notice you put there or 
-      # <tt>flash["notice"] = "hello"</tt> to put a new one.
-      def flash #:doc:
-        if @session["flash"].nil?
-          @session["flash"]   = {}
-          @session["flashes"] ||= 0
+    class FlashNow #:nodoc:
+      def initialize flash
+        @flash = flash
+      end
+      
+      def []=(k, v)
+        @flash[k] = v
+        @flash.discard(k)
+        v
+      end
+    end
+    
+    class FlashHash < Hash
+    
+      def initialize #:nodoc:
+        super
+        @used = {}
+      end
+      
+      def []=(k, v) #:nodoc:
+        keep(k)
+        super
+      end
+      
+      def update h #:nodoc:
+        h.keys.each{|k| discard k }
+        super
+      end
+      
+      alias merge! update
+      
+      def replace h #:nodoc:
+        @used = {}
+        super
+      end
+    
+      # Sets a flash that will not be available to the next action, only to the current.
+      #
+      #     flash.now["message"] = "Hello current action"
+      # 
+      # This method enables you to use the flash as a central messaging system in your app.
+      # When you need to pass an object to the next action, you use the standard flash assign (<tt>[]=</tt>).
+      # When you need to pass an object to the current action, you use <tt>now</tt>, and your object will
+      # vanish when the current action is done.
+      #
+      # Entries set via <tt>now</tt> are accessed the same way as standard entries: <tt>flash['my-key']</tt>.
+      def now
+        FlashNow.new self
+      end
+    
+      # Keeps either the entire current flash or a specific flash entry available for the next action:
+      #
+      #    flash.keep            # keeps the entire flash
+      #    flash.keep("notice")  # keeps only the "notice" entry, the rest of the flash is discarded
+      def keep(k=nil)
+        use(k, false)
+      end
+    
+      # Marks the entire flash or a single flash entry to be discarded by the end of the current action
+      #
+      #     flash.keep                 # keep entire flash available for the next action
+      #     flash.discard('warning')   # discard the "warning" entry (it'll still be available for the current action)
+      def discard(k=nil)
+        use(k)
+      end
+    
+      # Mark for removal entries that were kept, and delete unkept ones.
+      #
+      # This method is called automatically by filters, so you generally don't need to care about it.
+      def sweep #:nodoc:
+        keys.each do |k| 
+          unless @used[k]
+            use(k)
+          else
+            delete(k)
+            @used.delete(k)
+          end
         end
-        @session["flash"]
-      end    
-
-      # Can be called by any action that would like to keep the current content of the flash around for one more action.
-      def keep_flash #:doc:
-        @session["flashes"] = 0
-      end    
-
-    private
-      # Records that the contents of @session["flash"] was flashed to the action
-      def fire_flash
-        if @session["flash"]
-          @session["flashes"] += 1 unless @session["flash"].empty?
-          @assigns["flash"] = @session["flash"]
+        (@used.keys - keys).each{|k| @used.delete k } # clean up after keys that could have been left over by calling reject! or shift on the flash
+      end
+    
+      private
+    
+      # Used internally by the <tt>keep</tt> and <tt>discard</tt> methods
+      #     use()               # marks the entire flash as used
+      #     use('msg')          # marks the "msg" entry as used
+      #     use(nil, false)     # marks the entire flash as unused (keeps it around for one more action)
+      #     use('msg', false)   # marks the "msg" entry as unused (keeps it around for one more action)
+      def use(k=nil, v=true)
+        unless k.nil?
+          @used[k] = v
         else
-          @assigns["flash"] = {}
+          keys.each{|key| use key, v }
         end
       end
 
-      def clear_flash
-        if @session["flash"] && (@session["flashes"].nil? || @session["flashes"] >= 1)
-          @session["flash"]   = {}
-          @session["flashes"] = 0 
-        end
-      end    
+    end
+     
+   
+    protected 
+  
+    # Access the contents of the flash. Use <tt>flash["notice"]</tt> to read a notice you put there or 
+    # <tt>flash["notice"] = "hello"</tt> to put a new one.
+    def flash #:doc:
+      @session['flash'] ||= FlashHash.new
+    end
+  
+    # deprecated. use <tt>flash.keep</tt> instead
+    def keep_flash #:doc:
+      flash.keep
+    end
+  
+  
+    private
+  
+    # marks flash entries as used and expose the flash to the view 
+    def fire_flash
+      flash.discard
+      @assigns["flash"] = flash
+    end
+  
+    # deletes the flash entries that were not marked for keeping
+    def sweep_flash
+      flash.sweep
+    end
+  
   end
 end

data/lib/action_controller/pagination.rb

@@ -0,0 +1,378 @@
+module ActionController
+  # === Action Pack pagination for Active Record collections
+  #
+  # The Pagination module aids in the process of paging large collections of
+  # Active Record objects. It offers macro-style automatic fetching of your
+  # model for multiple views, or explicit fetching for single actions. And if
+  # the magic isn't flexible enough for your needs, you can create your own
+  # paginators with a minimal amount of code.
+  #
+  # The Pagination module can handle as much or as little as you wish. In the
+  # controller, have it automatically query your model for pagination; or,
+  # if you prefer, create Paginator objects yourself.
+  #
+  # Pagination is included automatically for all controllers.
+  #
+  # For help rendering pagination links, see 
+  # ActionView::Helpers::PaginationHelper.
+  #
+  # ==== Automatic pagination for every action in a controller
+  #
+  #   class PersonController < ApplicationController   
+  #     model :person
+  #
+  #     paginate :people, :order_by => 'last_name, first_name',
+  #              :per_page => 20
+  #     
+  #     # ...
+  #   end
+  #
+  # Each action in this controller now has access to a <tt>@people</tt>
+  # instance variable, which is an ordered collection of model objects for the
+  # current page (at most 20, sorted by last name and first name), and a 
+  # <tt>@person_pages</tt> Paginator instance. The current page is determined
+  # by the <tt>@params['page']</tt> variable.
+  #
+  # ==== Pagination for a single action
+  #
+  #   def list
+  #     @person_pages, @people =
+  #       paginate :people, :order_by => 'last_name, first_name'
+  #   end
+  #
+  # Like the previous example, but explicitly creates <tt>@person_pages</tt>
+  # and <tt>@people</tt> for a single action, and uses the default of 10 items
+  # per page.
+  #
+  # ==== Custom/"classic" pagination 
+  #
+  #   def list
+  #     @person_pages = Paginator.new self, Person.count, 10, @params['page']
+  #     @people = Person.find_all nil, 'last_name, first_name', 
+  #               @person_pages.current.to_sql
+  #   end
+  # 
+  # Explicitly creates the paginator from the previous example and uses 
+  # Paginator#to_sql to retrieve <tt>@people</tt> from the model.
+  #
+  module Pagination
+    unless const_defined?(:OPTIONS)
+      # A hash holding options for controllers using macro-style pagination
+      OPTIONS = Hash.new
+  
+      # The default options for pagination
+      DEFAULT_OPTIONS = {
+        :class_name => nil,
+        :per_page   => 10,
+        :conditions => nil,
+        :order_by   => nil,
+        :join       => nil,
+        :parameter  => 'page'
+      }
+    end
+      
+    def self.included(base) #:nodoc:
+      super
+      base.extend(ClassMethods)
+    end
+  
+    def self.validate_options!(collection_id, options, in_action) #:nodoc:
+      options.merge!(DEFAULT_OPTIONS) {|key, old, new| old}
+
+      valid_options = DEFAULT_OPTIONS.keys
+      valid_options << :actions unless in_action
+    
+      unknown_option_keys = options.keys - valid_options
+      raise ActionController::ActionControllerError,
+            "Unknown options: #{unknown_option_keys.join(', ')}" unless
+              unknown_option_keys.empty?
+
+      options[:singular_name] = Inflector.singularize(collection_id.to_s)
+      options[:class_name]  ||= Inflector.camelize(options[:singular_name])
+    end
+
+    # Returns a paginator and a collection of Active Record model instances
+    # for the paginator's current page. This is designed to be used in a
+    # single action; to automatically paginate multiple actions, consider
+    # ClassMethods#paginate.
+    #
+    # +options+ are:
+    # <tt>:class_name</tt>:: the class name to use, if it can't be inferred by
+    #                        singularizing the collection name
+    # <tt>:per_page</tt>::   the maximum number of items to include in a 
+    #                        single page. Defaults to 10
+    # <tt>:conditions</tt>:: optional conditions passed to Model.find_all and
+    #                        Model.count
+    # <tt>:order_by</tt>::   optional order parameter passed to Model.find_all
+    # <tt>:join</tt>::       optional join parameter passed to Model.find_all
+    #                        and Model.count
+    def paginate(collection_id, options={})
+      Pagination.validate_options!(collection_id, options, true)
+      paginator_and_collection_for(collection_id, options)
+    end
+
+    # These methods become class methods on any controller 
+    module ClassMethods
+      # Creates a +before_filter+ which automatically paginates an Active
+      # Record model for all actions in a controller (or certain actions if
+      # specified with the <tt>:actions</tt> option).
+      #
+      # +options+ are the same as PaginationHelper#paginate, with the addition 
+      # of:
+      # <tt>:actions</tt>:: an array of actions for which the pagination is
+      #                     active. Defaults to +nil+ (i.e., every action)
+      def paginate(collection_id, options={})
+        Pagination.validate_options!(collection_id, options, false)
+        module_eval do
+          before_filter :create_paginators_and_retrieve_collections
+          OPTIONS[self] ||= Hash.new
+          OPTIONS[self][collection_id] = options
+        end
+      end
+    end
+
+    def create_paginators_and_retrieve_collections #:nodoc:
+      Pagination::OPTIONS[self.class].each do |collection_id, options|
+        next unless options[:actions].include? action_name if
+          options[:actions]
+
+        paginator, collection = 
+          paginator_and_collection_for(collection_id, options)
+
+        paginator_name = "@#{options[:singular_name]}_pages"
+        self.instance_variable_set(paginator_name, paginator)
+
+        collection_name = "@#{collection_id.to_s}"
+        self.instance_variable_set(collection_name, collection)     
+      end
+    end
+  
+    # Returns the total number of items in the collection to be paginated for
+    # the +model+ and given +conditions+. Override this method to implement a
+    # custom counter.
+    def count_collection_for_pagination(model, conditions)
+      model.count(conditions)
+    end
+  
+    # Returns a collection of items for the given +model+ and +conditions+,
+    # ordered by +order_by+, for the current page in the given +paginator+.
+    # Override this method to implement a custom finder.
+    def find_collection_for_pagination(model, conditions, order_by, join, paginator)
+      model.find_all(conditions, order_by, paginator.current.to_sql, join)
+    end
+  
+    protected :create_paginators_and_retrieve_collections,
+              :count_collection_for_pagination,
+              :find_collection_for_pagination
+
+    def paginator_and_collection_for(collection_id, options) #:nodoc:
+      klass = eval options[:class_name]
+      page  = @params[options[:parameter]]
+      count = count_collection_for_pagination(klass, options[:conditions])
+
+      paginator = Paginator.new(self, count, options[:per_page], page)
+      
+      collection = find_collection_for_pagination(klass,
+        options[:conditions], options[:order_by], options[:join], paginator)
+      
+      return paginator, collection 
+    end
+      
+    private :paginator_and_collection_for
+
+    # A class representing a paginator for an Active Record collection.
+    class Paginator
+      include Enumerable
+
+      # Creates a new Paginator on the given +controller+ for a set of items
+      # of size +item_count+ and having +items_per_page+ items per page.
+      # Raises ArgumentError if items_per_page is out of bounds (i.e., less
+      # than or equal to zero). The page CGI parameter for links defaults to
+      # "page" and can be overridden with +page_parameter+.
+      def initialize(controller, item_count, items_per_page, current_page=1)
+        raise ArgumentError, 'must have at least one item per page' if
+          items_per_page <= 0
+
+        @controller = controller
+        @item_count = item_count || 0
+        @items_per_page = items_per_page
+        
+        self.current_page = current_page
+      end
+      attr_reader :controller, :item_count, :items_per_page
+      
+      # Sets the current page number of this paginator. If +page+ is a Page
+      # object, its +number+ attribute is used as the value; if the page does 
+      # not belong to this Paginator, an ArgumentError is raised.
+      def current_page=(page)
+        if page.is_a? Page
+          raise ArgumentError, 'Page/Paginator mismatch' unless
+            page.paginator == self
+        end
+        page = page.to_i
+        @current_page = has_page_number?(page) ? page : 1
+      end
+
+      # Returns a Page object representing this paginator's current page.
+      def current_page
+        self[@current_page]
+      end
+      alias current :current_page
+
+      # Returns a new Page representing the first page in this paginator.
+      def first_page
+        self[1]
+      end
+      alias first :first_page
+
+      # Returns a new Page representing the last page in this paginator.
+      def last_page
+        self[page_count] 
+      end
+      alias last :last_page
+
+      # Returns the number of pages in this paginator.
+      def page_count
+        return 1 if @item_count.zero?
+        (@item_count / @items_per_page.to_f).ceil
+      end
+      alias length :page_count
+
+      # Returns true if this paginator contains the page of index +number+.
+      def has_page_number?(number)
+        return false unless number.is_a? Fixnum
+        number >= 1 and number <= page_count
+      end
+
+      # Returns a new Page representing the page with the given index
+      # +number+.
+      def [](number)
+        Page.new(self, number)
+      end
+
+      # Successively yields all the paginator's pages to the given block.
+      def each(&block)
+        page_count.times do |n|
+          yield self[n+1]
+        end
+      end
+
+      # A class representing a single page in a paginator.
+      class Page
+        include Comparable
+
+        # Creates a new Page for the given +paginator+ with the index
+        # +number+. If +number+ is not in the range of valid page numbers or
+        # is not a number at all, it defaults to 1.
+        def initialize(paginator, number)
+          @paginator = paginator
+          @number = number.to_i
+          @number = 1 unless @paginator.has_page_number? @number
+        end
+        attr_reader :paginator, :number
+        alias to_i :number
+
+        # Compares two Page objects and returns true when they represent the 
+        # same page (i.e., their paginators are the same and they have the
+        # same page number).
+        def ==(page)
+          return false if page.nil?
+          @paginator == page.paginator and 
+            @number == page.number
+        end
+
+        # Compares two Page objects and returns -1 if the left-hand page comes
+        # before the right-hand page, 0 if the pages are equal, and 1 if the
+        # left-hand page comes after the right-hand page. Raises ArgumentError
+        # if the pages do not belong to the same Paginator object.
+        def <=>(page)
+          raise ArgumentError unless @paginator == page.paginator
+          @number <=> page.number
+        end
+
+        # Returns the item offset for the first item in this page.
+        def offset
+          @paginator.items_per_page * (@number - 1)
+        end
+        
+        # Returns the number of the first item displayed.
+        def first_item
+          offset + 1
+        end
+        
+        # Returns the number of the last item displayed.
+        def last_item
+          [@paginator.items_per_page * @number, @paginator.item_count].min
+        end
+
+        # Returns true if this page is the first page in the paginator.
+        def first?
+          self == @paginator.first
+        end
+
+        # Returns true if this page is the last page in the paginator.
+        def last?
+          self == @paginator.last
+        end
+
+        # Returns a new Page object representing the page just before this
+        # page, or nil if this is the first page.
+        def previous
+          if first? then nil else Page.new(@paginator, @number - 1) end
+        end
+
+        # Returns a new Page object representing the page just after this
+        # page, or nil if this is the last page.
+        def next
+          if last? then nil else Page.new(@paginator, @number + 1) end
+        end
+
+        # Returns a new Window object for this page with the specified 
+        # +padding+.
+        def window(padding=2)
+          Window.new(self, padding)
+        end
+
+        # Returns the limit/offset array for this page.
+        def to_sql
+          [@paginator.items_per_page, offset]
+        end
+        
+        def to_param #:nodoc:
+          @number.to_s
+        end
+      end
+
+      # A class for representing ranges around a given page.
+      class Window
+        # Creates a new Window object for the given +page+ with the specified
+        # +padding+.
+        def initialize(page, padding=2)
+          @paginator = page.paginator
+          @page = page
+          self.padding = padding
+        end
+        attr_reader :paginator, :page
+
+        # Sets the window's padding (the number of pages on either side of the
+        # window page).
+        def padding=(padding)
+          @padding = padding < 0 ? 0 : padding
+          # Find the beginning and end pages of the window
+          @first = @paginator.has_page_number?(@page.number - @padding) ?
+            @paginator[@page.number - @padding] : @paginator.first
+          @last =  @paginator.has_page_number?(@page.number + @padding) ?
+            @paginator[@page.number + @padding] : @paginator.last
+        end
+        attr_reader :padding, :first, :last
+
+        # Returns an array of Page objects in the current window.
+        def pages
+          (@first.number..@last.number).to_a.map {|n| @paginator[n]}
+        end
+        alias to_a :pages
+      end
+    end
+
+  end
+end