@@ -1,90 +1,82 @@ = WillPaginate -Pagination is just limiting the number of records displayed. Why should you let -it get in your way while developing, then? This plugin makes magic happen. Did -you ever want to be able to do just this on a model: +Pagination is just limiting the number of records displayed. Why should you let it get in your way +while developing? + +This is how you paginate on an ActiveRecord model: Post.paginate :page => 1, :order => 'created_at DESC' -... and then render the page links with a single view helper? Well, now you -can. +Most of the time it's as simple as replacing "find" with "paginate" and specifying the page you want. 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. +* The {will_paginate project page}[http://github.com/mislav/will_paginate]; +* 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]; +* {Watch the will_paginate screencast}[http://railscasts.com/episodes/51] by Ryan Bates. + == Installation The recommended way is that you get the gem: - # add GitHub to your local list of gem sources: - gem sources -a http://gems.github.com/ - - # install the gem: - gem install mislav-will_paginate + gem install --source=http://gems.github.com/ mislav-will_paginate + +After that you don't need the will_paginate plugin in your Rails application anymore. In +Rails 2.1, add a gem dependency: -After that you don't need the will_paginate plugin in your Rails -application anymore. Just add a simple require to the end of -"config/environment.rb": + config.gem 'mislav-will_paginate', :lib => 'will_paginate', :version => '~> 2.5' - gem 'mislav-will_paginate', '~> 2.2' +If you're using Rails 2.0 or older, just add a simple require to the end of your +"config/environment.rb" instead: + + gem 'mislav-will_paginate', '~> 2.5' require 'will_paginate' -That's it. Remember to install the gem on all machines that you are -deploying to. +That's it. Remember to install the gem on all machines that you are deploying to. -There are extensive -{installation instructions}[http://github.com/mislav/will_paginate/wikis/installation] -on {the wiki}[http://github.com/mislav/will_paginate/wikis]. +There are extensive {installation +instructions}[http://github.com/mislav/will_paginate/wikis/installation] on {the +wiki}[http://github.com/mislav/will_paginate/wikis]. == 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! -Read more on WillPaginate::Finder::ClassMethods. +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! Read more about WillPaginate::Finders. -Render the posts in your view like you would normally do. When you need to render -pagination, just stick this in: +Render the posts in your view like you would normally do. When you need to render pagination, just +stick this in: <%= 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. (Copy and paste the example fancy CSS styles from the bottom.) 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: +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 + def self.per_page() 50 end end -... or like this: - - class Post < ActiveRecord::Base - def self.per_page - 50 - end - end - -... or don't worry about it at all. WillPaginate defines it to be 30 by default. -But you can always specify the count explicitly when calling +paginate+: +... or don't worry about it at all. WillPaginate defines it to be 30 by default. You can +always specify the count explicitly when calling +paginate+: @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: +The +paginate+ finder wraps the original finder and returns your result set that now has some new +properties. You can use the collection as you would use any other array. WillPaginate view helpers +also need that object to be able to render pagination: <ol> <% for post in @posts -%> @@ -97,7 +89,7 @@ resultset. WillPaginate view helpers also need that object to be able to render More detailed documentation: -* WillPaginate::Finder::ClassMethods for pagination on your models; +* WillPaginate::Finders for pagination on your models; * WillPaginate::ViewHelpers for your views. @@ -107,29 +99,25 @@ Authors:: Mislav Marohnić, PJ Hyett Original announcement:: http://errtheblog.com/post/929 Original PHP source:: http://www.strangerstudios.com/sandbox/pagination/diggstyle.php -All these people helped making will_paginate what it is now with their code -contributions or just simply awesome ideas: +All these people helped making will_paginate what it is now with their code 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, Piotr Usewicz, Chris Eppstein. +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, Piotr Usewicz, Chris +Eppstein. == Usable pagination in the UI -There are some CSS styles to get you started in the "examples/" directory. They -are showcased in the "examples/index.html" file. +There are some CSS styles to get you started in the "examples/" directory. They are showcased in the +"examples/index.html" file. 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 - -Want to discuss, request features, ask questions? Join the -{Google group}[http://groups.google.com/group/will_paginate]. +* {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/] featured on Smashing Magazine; +* {Pagination design pattern}[http://developer.yahoo.com/ypatterns/parent.php?pattern=pagination] on Yahoo Design Pattern Library. +Want to discuss, request features, ask questions? Join the {Google +group}[http://groups.google.com/group/will_paginate]. \ No newline at end of file README.rdoc @@ -1,8 +1,8 @@ module WillPaginate #:nodoc: module VERSION #:nodoc: MAJOR = 2 - MINOR = 3 - TINY = 1 + MINOR = 5 + TINY = 0 STRING = [MAJOR, MINOR, TINY].join('.') end lib/will_paginate/version.rb @@ -1,10 +1,10 @@ Gem::Specification.new do |s| s.name = 'will_paginate' - s.version = '2.3.1' - s.date = '2008-05-04' + s.version = '2.5.0' + # s.date = '2008-05-04' - s.summary = "Most awesome pagination solution for Rails" - s.description = "The will_paginate library provides a simple, yet powerful and extensible API for ActiveRecord pagination and rendering of pagination links in ActionView templates." + s.summary = "Most awesome pagination solution for every web app" + s.description = "The will_paginate library provides a simple, yet powerful and extensible API for pagination and rendering of page links in templates." s.authors = ['Mislav Marohnić', 'PJ Hyett'] s.email = 'mislav.marohnic@gmail.com' @@ -14,8 +14,7 @@ Gem::Specification.new do |s| s.rdoc_options = ['--main', 'README.rdoc'] s.rdoc_options << '--inline-source' << '--charset=UTF-8' s.extra_rdoc_files = ['README.rdoc', 'LICENSE', 'CHANGELOG'] - # s.add_dependency 'actionpack', ['>= 1.13.6'] s.files = %w(CHANGELOG LICENSE README.rdoc Rakefile examples examples/apple-circle.gif examples/index.haml examples/index.html examples/pagination.css examples/pagination.sass init.rb lib lib/will_paginate lib/will_paginate.rb lib/will_paginate/array.rb lib/will_paginate/collection.rb lib/will_paginate/core_ext.rb lib/will_paginate/finder.rb lib/will_paginate/named_scope.rb lib/will_paginate/named_scope_patch.rb lib/will_paginate/version.rb lib/will_paginate/view_helpers.rb test test/boot.rb test/collection_test.rb test/console test/database.yml test/finder_test.rb test/fixtures test/fixtures/admin.rb test/fixtures/developer.rb test/fixtures/developers_projects.yml test/fixtures/project.rb test/fixtures/projects.yml test/fixtures/replies.yml test/fixtures/reply.rb test/fixtures/schema.rb test/fixtures/topic.rb test/fixtures/topics.yml test/fixtures/user.rb test/fixtures/users.yml test/helper.rb test/lib test/lib/activerecord_test_case.rb test/lib/activerecord_test_connector.rb test/lib/load_fixtures.rb test/lib/view_test_process.rb test/view_test.rb) s.test_files = %w(test/boot.rb test/collection_test.rb test/console test/database.yml test/finder_test.rb test/fixtures test/fixtures/admin.rb test/fixtures/developer.rb test/fixtures/developers_projects.yml test/fixtures/project.rb test/fixtures/projects.yml test/fixtures/replies.yml test/fixtures/reply.rb test/fixtures/schema.rb test/fixtures/topic.rb test/fixtures/topics.yml test/fixtures/user.rb test/fixtures/users.yml test/helper.rb test/lib test/lib/activerecord_test_case.rb test/lib/activerecord_test_connector.rb test/lib/load_fixtures.rb test/lib/view_test_process.rb test/view_test.rb) -end +end \ No newline at end of file will_paginate.gemspec c1856887318e69daf001f39c642dfda429ff20c9 Mislav Marohnić mislav.marohnic@gmail.com http://github.com/mattetti/will_paginate/commit/c5db3e43a530a4da64ac40118e06eb9a63634812 c5db3e43a530a4da64ac40118e06eb9a63634812

2008-06-07T19:44:23-07:00

2008-06-07T19:33:15-07:00

bump version number to 2.5.0 and update README 31015dacb9c213d3d17e9623f7e130dc4eb51cfb Mislav Marohnić mislav.marohnic@gmail.com