will_paginate 2.2.2 → 2.3.11

data/CHANGELOG.rdoc

@@ -0,0 +1,110 @@
+== 2.3.6, released 2008-10-26
+
+* Rails 2.2 fix: stop using `extract_attribute_names_from_match` inernal AR method, it no longer exists
+
+== 2.3.5, released 2008-10-07
+
+* update the backported named_scope implementation for Rails versions older than 2.1
+* break out of scope of paginated_each() yielded block when used on named scopes
+* fix paginate(:from)
+
+== 2.3.4, released 2008-09-16
+
+* Removed gem dependency to Active Support (causes trouble with vendored rails).
+* Rails 2.1: fix a failing test and a deprecation warning.
+* Cope with scoped :select when counting.
+
+== 2.3.3, released 2008-08-29
+
+* Ensure that paginate_by_sql doesn't change the original SQL query.
+* RDoc love (now live at http://mislav.caboo.se/static/will_paginate/doc/)
+* Rename :prev_label to :previous_label for consistency. old name still functions but is deprecated
+* ActiveRecord 2.1: Remove :include option from count_all query when it's possible.
+
+== 2.3.2, released 2008-05-16
+
+* Fixed LinkRenderer#stringified_merge by removing "return" from iterator block
+* Ensure that 'href' values in pagination links are escaped URLs
+
+== 2.3.1, released 2008-05-04
+
+* Fixed page numbers not showing with custom routes and implicit first page
+* Try to use Hanna for documentation (falls back to default RDoc template if not)
+
+== 2.3.0, released 2008-04-29
+
+* Changed LinkRenderer to receive collection, options and reference to view template NOT in
+  constructor, but with the #prepare method. This is a step towards supporting passing of
+  LinkRenderer (or subclass) instances that may be preconfigured in some way
+* LinkRenderer now has #page_link and #page_span methods for easier customization of output in
+  subclasses
+* Changed page_entries_info() method to adjust its output according to humanized class name of
+  collection items. Override this with :entry_name parameter (singular).
+    
+    page_entries_info(@posts)
+    #-> "Displaying all 12 posts"
+    page_entries_info(@posts, :entry_name => 'item')
+    #-> "Displaying all 12 items"
+    
+== 2.2.3, released 2008-04-26
+
+* will_paginate gem is no longer published on RubyForge, but on
+  gems.github.com:
+  
+    gem sources -a http://gems.github.com/  (you only need to do this once)
+    gem install mislav-will_paginate
+    
+* extract reusable pagination testing stuff into WillPaginate::View
+* rethink the page URL construction mechanizm to be more bulletproof when
+  combined with custom routing for page parameter
+* test that anchor parameter can be used in pagination links
+
+== 2.2.2, released 2008-04-21
+
+* Add support for page parameter in custom routes like "/foo/page/2"
+* Change output of "page_entries_info" on single-page collection and erraneous
+  output with empty collection as reported by Tim Chater
+  
+== 2.2.1, released 2008-04-08
+
+* take less risky path when monkeypatching named_scope; fix that it no longer
+  requires ActiveRecord::VERSION
+* use strings in "respond_to?" calls to work around a bug in acts_as_ferret
+  stable (ugh)
+* add rake release task
+
+
+== 2.2.0, released 2008-04-07
+
+=== API changes
+* Rename WillPaginate::Collection#page_count to "total_pages" for consistency.
+  If you implemented this interface, change your implementation accordingly.
+* Remove old, deprecated style of calling Array#paginate as "paginate(page,
+  per_page)". If you want to specify :page, :per_page or :total_entries, use a
+  parameter hash.
+* Rename LinkRenderer#url_options to "url_for" and drastically optimize it
+
+=== View changes
+* Added "prev_page" and "next_page" CSS classes on previous/next page buttons
+* Add examples of pagination links styling in "examples/index.html"
+* Change gap in pagination links from "..." to
+  "<span class="gap">&hellip;</span>".
+* Add "paginated_section", a block helper that renders pagination both above and
+  below content in the block
+* Add rel="prev|next|start" to page links
+
+=== Other
+
+* Add ability to opt-in for Rails 2.1 feature "named_scope" by calling
+  WillPaginate.enable_named_scope (tested in Rails 1.2.6 and 2.0.2)
+* Support complex page parameters like "developers[page]"
+* Move Array#paginate definition to will_paginate/array.rb. You can now easily
+  use pagination on arrays outside of Rails:
+
+    gem 'will_paginate'
+    require 'will_paginate/array'
+    
+* Add "paginated_each" method for iterating through every record by loading only
+  one page of records at the time
+* Rails 2: Rescue from WillPaginate::InvalidPage error with 404 Not Found by
+  default

data/README.rdoc

@@ -11,44 +11,18 @@ can.
 
 Some resources to get you started:
 
-* Your mind reels with questions? Join our Google
-  group[http://groups.google.com/group/will_paginate].
-* The will_paginate project page: http://github.com/mislav/will_paginate
-* How to report bugs: http://github.com/mislav/will_paginate/wikis/report-bugs
-* Ryan Bates made an awesome screencast[http://railscasts.com/episodes/51],
-  check it out.
-
-== Installation
-
-Previously, the plugin was available on the following SVN location:
-
-  svn://errtheblog.com/svn/plugins/will_paginate
-
-In February 2008, it moved to GitHub to be tracked with git version control.
-The SVN repo continued to have updates for some time, but now it doesn't.
-
-You should switch to using the gem:
-
-  gem install will_paginate
-
-After that, you can remove the plugin from your application and add
-a simple require to the end of config/environment.rb:
-
-  require 'will_paginate'
-
-That's it, just remember to install the gem on all machines that
-you are deploying to.
-
-<i>There are extensive
-installation[http://github.com/mislav/will_paginate/wikis/installation]
-instructions on the wiki[http://github.com/mislav/will_paginate/wikis].</i>
+* {Installation instructions}[http://github.com/mislav/will_paginate/wikis/installation]
+  on {the wiki}[http://github.com/mislav/will_paginate/wikis]
+* Your mind reels with questions? Join our
+  {Google group}[http://groups.google.com/group/will_paginate].
+* {How to report bugs}[http://github.com/mislav/will_paginate/wikis/report-bugs]
 
 
 == Example usage
 
 Use a paginate finder in the controller:
 
-    @posts = Post.paginate_by_board_id @board.id, :page => params[:page], :order => 'updated_at DESC'
+  @posts = Post.paginate_by_board_id @board.id, :page => params[:page], :order => 'updated_at DESC'
 
 Yeah, +paginate+ works just like +find+ -- it just doesn't fetch all the
 records.  Don't forget to tell it which page you want, or it will complain!
@@ -57,44 +31,43 @@ Read more on WillPaginate::Finder::ClassMethods.
 Render the posts in your view like you would normally do. When you need to render
 pagination, just stick this in:
 
-    <%= will_paginate @posts %>
+  <%= will_paginate @posts %>
 
-You're done. (Copy and paste the example fancy CSS styles from the bottom.) You
-can find the option list at WillPaginate::ViewHelpers.
+You're done. (You can find the option list at WillPaginate::ViewHelpers.)
 
 How does it know how much items to fetch per page? It asks your model by calling
 its <tt>per_page</tt> class method. You can define it like this:
 
-    class Post < ActiveRecord::Base
-      cattr_reader :per_page
-      @@per_page = 50
-    end
+  class Post < ActiveRecord::Base
+    cattr_reader :per_page
+    @@per_page = 50
+  end
 
 ... or like this:
 
-    class Post < ActiveRecord::Base
-      def self.per_page
-        50
-      end
+  class Post < ActiveRecord::Base
+    def self.per_page
+      50
     end
+  end
 
 ... or don't worry about it at all. WillPaginate defines it to be <b>30</b> by default.
 But you can always specify the count explicitly when calling +paginate+:
 
-    @posts = Post.paginate :page => params[:page], :per_page => 50
+  @posts = Post.paginate :page => params[:page], :per_page => 50
 
 The +paginate+ finder wraps the original finder and returns your resultset that now has
 some new properties. You can use the collection as you would with any ActiveRecord
 resultset. WillPaginate view helpers also need that object to be able to render pagination:
 
-    <ol>
-      <% for post in @posts -%>
-        <li>Render `post` in some nice way.</li>
-      <% end -%>
-    </ol>
+  <ol>
+    <% for post in @posts -%>
+      <li>Render `post` in some nice way.</li>
+    <% end -%>
+  </ol>
 
-    <p>Now let's render us some pagination!</p>
-    <%= will_paginate @posts %>
+  <p>Now let's render us some pagination!</p>
+  <%= will_paginate @posts %>
 
 More detailed documentation:
 
@@ -114,22 +87,21 @@ contributions or just simply awesome ideas:
 Chris Wanstrath, Dr. Nic Williams, K. Adam Christensen, Mike Garey, Bence
 Golda, Matt Aimonetti, Charles Brian Quinn, Desi McAdam, James Coglan, Matijs
 van Zuijlen, Maria, Brendan Ribera, Todd Willey, Bryan Helmkamp, Jan Berkel,
-Lourens Naudé, Rick Olson, Russell Norris.
+Lourens Naudé, Rick Olson, Russell Norris, Piotr Usewicz, Chris Eppstein,
+Denis Barushev, Ben Pickles.
 
 
 == Usable pagination in the UI
 
 There are some CSS styles to get you started in the "examples/" directory. They
-are showcased in the <b>"examples/index.html"</b> file.
+are {showcased online here}[http://mislav.caboo.se/static/will_paginate/].
 
 More reading about pagination as design pattern:
 
-* Pagination 101:
-  http://kurafire.net/log/archive/2007/06/22/pagination-101
-* Pagination gallery:
-  http://www.smashingmagazine.com/2007/11/16/pagination-gallery-examples-and-good-practices/
-* Pagination on Yahoo Design Pattern Library:
-  http://developer.yahoo.com/ypatterns/parent.php?pattern=pagination
+* {Pagination 101}[http://kurafire.net/log/archive/2007/06/22/pagination-101]
+* {Pagination gallery}[http://www.smashingmagazine.com/2007/11/16/pagination-gallery-examples-and-good-practices/]
+* {Pagination on Yahoo Design Pattern Library}[http://developer.yahoo.com/ypatterns/parent.php?pattern=pagination]
+
+Want to discuss, request features, ask questions? Join the
+{Google group}[http://groups.google.com/group/will_paginate].
 
-Want to discuss, request features, ask questions? Join the Google group:
-http://groups.google.com/group/will_paginate

data/Rakefile

@@ -1,116 +1,53 @@
-require File.dirname(__FILE__) + '/lib/rake_hacks'
+require 'rubygems'
+begin
+  hanna_dir = '/Users/mislav/Projects/Hanna/lib'
+  $:.unshift hanna_dir if File.exists? hanna_dir
+  require 'hanna/rdoctask'
+rescue LoadError
+  require 'rake'
+  require 'rake/rdoctask'
+end
+load 'test/tasks.rake'
 
 desc 'Default: run unit tests.'
 task :default => :test
 
-desc 'Test the will_paginate plugin.'
-Rake::TestTask.new(:test) do |t|
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = true
-  t.libs << 'test'
-end
-
-for configuration in %w( sqlite3 mysql postgres )
-  EnvTestTask.new("test_#{configuration}") do |t|
-    t.pattern = 'test/finder_test.rb'
-    t.verbose = true
-    t.env = { 'DB' => configuration }
-    t.libs << 'test'
-  end
-end
-
-task :test_databases => %w(test_mysql test_sqlite3 test_postgres)
-
-desc %{Test everything on SQLite3, MySQL and PostgreSQL}
-task :test_full => %w(test test_mysql test_postgres)
-
-desc %{Test everything with Rails 1.2.x and 2.0.x gems}
-task :test_all do
-  all = Rake::Task['test_full']
-  ENV['RAILS_VERSION'] = '~>1.2.6'
-  all.invoke 
-  # reset the invoked flag
-  %w( test_full test test_mysql test_postgres ).each do |name|
-    Rake::Task[name].instance_variable_set '@already_invoked', false
-  end
-  # do it again
-  ENV['RAILS_VERSION'] = '~>2.0.2'
-  all.invoke 
-end
-
 desc 'Generate RDoc documentation for the will_paginate plugin.'
-Rake::RDocTask.new(:doc) do |rdoc|
-  files = ['README.rdoc', 'LICENSE', 'CHANGELOG']
-  files << FileList.new('lib/**/*.rb').
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_files.include('README.rdoc', 'LICENSE', 'CHANGELOG.rdoc').
+    include('lib/**/*.rb').
     exclude('lib/will_paginate/named_scope*').
     exclude('lib/will_paginate/array.rb').
     exclude('lib/will_paginate/version.rb')
-    
-  rdoc.rdoc_files.add(files)
+  
   rdoc.main = "README.rdoc" # page to start on
   rdoc.title = "will_paginate documentation"
   
-  my_template = '/home/mislav/projects/rdoc_template/mislav.rb'
-  rdoc.template = my_template if File.exists? my_template
-  
   rdoc.rdoc_dir = 'doc' # rdoc output folder
-  rdoc.options << '--inline-source'
-  rdoc.options << '--charset=UTF-8'
+  rdoc.options << '--inline-source' << '--charset=UTF-8'
   rdoc.options << '--webcvs=http://github.com/mislav/will_paginate/tree/master/'
 end
 
+desc %{Update ".manifest" with the latest list of project filenames. Respect\
+.gitignore by excluding everything that git ignores. Update `files` and\
+`test_files` arrays in "*.gemspec" file if it's present.}
 task :manifest do
-  list = Dir['**/*']
-  
-  File.read('.gitignore').each_line do |glob|
-    glob = glob.chomp.sub(/^\//, '')
-    list -= Dir[glob]
-    list -= Dir["#{glob}/**/*"] if File.directory?(glob) and !File.symlink?(glob)
-    puts "excluding #{glob}"
-  end
-  
-  File.open('.manifest', 'w') do |file|
-    file.write list.sort.join("\n")
+  list = `git ls-files --full-name --exclude=*.gemspec --exclude=.*`.chomp.split("\n")
+  
+  if spec_file = Dir['*.gemspec'].first
+    spec = File.read spec_file
+    spec.gsub! /^(\s* s.(test_)?files \s* = \s* )( \[ [^\]]* \] | %w\( [^)]* \) )/mx do
+      assignment = $1
+      bunch = $2 ? list.grep(/^test\//) : list
+      '%s%%w(%s)' % [assignment, bunch.join(' ')]
+    end
+      
+    File.open(spec_file, 'w') { |f| f << spec }
   end
-end
-
-desc 'Package and upload the release to rubyforge.'
-task :release do
-  require 'yaml'
-  require 'rubyforge'
-  
-  meta = YAML::load open('.gemified')
-  version = meta[:version]
-  
-  v = ENV['VERSION'] or abort "Must supply VERSION=x.y.z"
-  abort "Version doesn't match #{version}" if v != version
-  
-  gem = "#{meta[:name]}-#{version}.gem"
-  project = meta[:rubyforge_project]
- 
-  rf = RubyForge.new
-  puts "Logging in to RubyForge"
-  rf.login
- 
-  c = rf.userconfig
-  c['release_notes'] = meta[:summary]
-  c['release_changes'] = File.read('CHANGELOG').split(/^== .+\n/)[1].strip
-  c['preformatted'] = true
- 
-  puts "Releasing #{meta[:name]} #{version}"
-  rf.add_release project, project, version, gem
+  File.open('.manifest', 'w') { |f| f << list.join("\n") }
 end
 
 task :examples do
   %x(haml examples/index.haml examples/index.html)
   %x(sass examples/pagination.sass examples/pagination.css)
 end
-
-task :rcov do
-  excludes = %w( lib/will_paginate/named_scope*
-                 lib/will_paginate/core_ext.rb
-                 lib/will_paginate.rb
-                 rails* )
-  
-  system %[rcov -Itest:lib test/*.rb -x #{excludes.join(',')}]
-end

data/lib/will_paginate.rb

@@ -1,4 +1,5 @@
 require 'active_support'
+require 'will_paginate/core_ext'
 
 # = You *will* paginate!
 #
@@ -9,29 +10,29 @@ require 'active_support'
 # Happy paginating!
 module WillPaginate
   class << self
-    # shortcut for <tt>enable_actionpack; enable_activerecord</tt>
+    # shortcut for <tt>enable_actionpack</tt> and <tt>enable_activerecord</tt> combined
     def enable
       enable_actionpack
       enable_activerecord
     end
     
-    # mixes in WillPaginate::ViewHelpers in ActionView::Base
+    # hooks WillPaginate::ViewHelpers into ActionView::Base
     def enable_actionpack
-      return if ActionView::Base.instance_methods.include? 'will_paginate'
+      return if ActionView::Base.instance_methods.include_method? :will_paginate
       require 'will_paginate/view_helpers'
-      ActionView::Base.class_eval { include ViewHelpers }
+      ActionView::Base.send :include, ViewHelpers
 
       if defined?(ActionController::Base) and ActionController::Base.respond_to? :rescue_responses
         ActionController::Base.rescue_responses['WillPaginate::InvalidPage'] = :not_found
       end
     end
     
-    # mixes in WillPaginate::Finder in ActiveRecord::Base and classes that deal
+    # hooks WillPaginate::Finder into ActiveRecord::Base and classes that deal
     # with associations
     def enable_activerecord
       return if ActiveRecord::Base.respond_to? :paginate
       require 'will_paginate/finder'
-      ActiveRecord::Base.class_eval { include Finder }
+      ActiveRecord::Base.send :include, Finder
 
       # support pagination on associations
       a = ActiveRecord::Associations
@@ -41,9 +42,17 @@ module WillPaginate
           classes << a::HasManyThroughAssociation
         end
       }.each do |klass|
-        klass.class_eval do
-          include Finder::ClassMethods
-          alias_method_chain :method_missing, :paginate
+        klass.send :include, Finder::ClassMethods
+        klass.class_eval { alias_method_chain :method_missing, :paginate }
+      end
+      
+      # monkeypatch Rails ticket #2189: "count breaks has_many :through"
+      ActiveRecord::Base.class_eval do
+        protected
+        def self.construct_count_options_from_args(*args)
+          result = super
+          result[0] = '*' if result[0].is_a?(String) and result[0] =~ /\.\*$/
+          result
         end
       end
     end
@@ -61,26 +70,21 @@ module WillPaginate
       require 'will_paginate/named_scope'
       require 'will_paginate/named_scope_patch' if patch
 
-      ActiveRecord::Base.class_eval do
-        include WillPaginate::NamedScope
-      end
+      ActiveRecord::Base.send :include, WillPaginate::NamedScope
     end
   end
 
-  module Deprecation #:nodoc:
+  module Deprecation # :nodoc:
     extend ActiveSupport::Deprecation
 
     def self.warn(message, callstack = caller)
       message = 'WillPaginate: ' + message.strip.gsub(/\s+/, ' ')
-      behavior.call(message, callstack) if behavior && !silenced?
-    end
-
-    def self.silenced?
-      ActiveSupport::Deprecation.silenced?
+      ActiveSupport::Deprecation.warn(message, callstack)
     end
   end
 end
 
-if defined?(Rails) and defined?(ActiveRecord) and defined?(ActionController)
-  WillPaginate.enable
+if defined? Rails
+  WillPaginate.enable_activerecord if defined? ActiveRecord
+  WillPaginate.enable_actionpack if defined? ActionController
 end