pb-will_paginate 2.3.12

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (51) hide show
  1. data/.gitignore +4 -0
  2. data/.manifest +43 -0
  3. data/CHANGELOG.rdoc +139 -0
  4. data/LICENSE +18 -0
  5. data/README.rdoc +107 -0
  6. data/Rakefile +71 -0
  7. data/VERSION +1 -0
  8. data/examples/apple-circle.gif +0 -0
  9. data/examples/index.haml +69 -0
  10. data/examples/index.html +92 -0
  11. data/examples/pagination.css +90 -0
  12. data/examples/pagination.sass +91 -0
  13. data/init.rb +2 -0
  14. data/lib/will_paginate.rb +90 -0
  15. data/lib/will_paginate/array.rb +16 -0
  16. data/lib/will_paginate/collection.rb +144 -0
  17. data/lib/will_paginate/core_ext.rb +43 -0
  18. data/lib/will_paginate/finder.rb +264 -0
  19. data/lib/will_paginate/i18n.rb +178 -0
  20. data/lib/will_paginate/named_scope.rb +170 -0
  21. data/lib/will_paginate/named_scope_patch.rb +37 -0
  22. data/lib/will_paginate/version.rb +9 -0
  23. data/lib/will_paginate/view_helpers.rb +397 -0
  24. data/locales/en.yml +11 -0
  25. data/pb-will_paginate.gemspec +106 -0
  26. data/test/boot.rb +21 -0
  27. data/test/collection_test.rb +143 -0
  28. data/test/console +8 -0
  29. data/test/database.yml +22 -0
  30. data/test/finder_test.rb +473 -0
  31. data/test/fixtures/admin.rb +3 -0
  32. data/test/fixtures/developer.rb +14 -0
  33. data/test/fixtures/developers_projects.yml +13 -0
  34. data/test/fixtures/project.rb +15 -0
  35. data/test/fixtures/projects.yml +6 -0
  36. data/test/fixtures/replies.yml +29 -0
  37. data/test/fixtures/reply.rb +7 -0
  38. data/test/fixtures/schema.rb +38 -0
  39. data/test/fixtures/topic.rb +10 -0
  40. data/test/fixtures/topics.yml +30 -0
  41. data/test/fixtures/user.rb +2 -0
  42. data/test/fixtures/users.yml +35 -0
  43. data/test/helper.rb +37 -0
  44. data/test/i18n_test.rb +194 -0
  45. data/test/lib/activerecord_test_case.rb +43 -0
  46. data/test/lib/activerecord_test_connector.rb +75 -0
  47. data/test/lib/load_fixtures.rb +11 -0
  48. data/test/lib/view_test_process.rb +179 -0
  49. data/test/tasks.rake +59 -0
  50. data/test/view_test.rb +289 -0
  51. metadata +122 -0
@@ -0,0 +1,4 @@
1
+ /doc
2
+ /rails
3
+ *.gem
4
+ /coverage
@@ -0,0 +1,43 @@
1
+ CHANGELOG.rdoc
2
+ LICENSE
3
+ README.rdoc
4
+ Rakefile
5
+ examples/apple-circle.gif
6
+ examples/index.haml
7
+ examples/index.html
8
+ examples/pagination.css
9
+ examples/pagination.sass
10
+ init.rb
11
+ lib/will_paginate.rb
12
+ lib/will_paginate/array.rb
13
+ lib/will_paginate/collection.rb
14
+ lib/will_paginate/core_ext.rb
15
+ lib/will_paginate/finder.rb
16
+ lib/will_paginate/named_scope.rb
17
+ lib/will_paginate/named_scope_patch.rb
18
+ lib/will_paginate/version.rb
19
+ lib/will_paginate/view_helpers.rb
20
+ test/boot.rb
21
+ test/collection_test.rb
22
+ test/console
23
+ test/database.yml
24
+ test/finder_test.rb
25
+ test/fixtures/admin.rb
26
+ test/fixtures/developer.rb
27
+ test/fixtures/developers_projects.yml
28
+ test/fixtures/project.rb
29
+ test/fixtures/projects.yml
30
+ test/fixtures/replies.yml
31
+ test/fixtures/reply.rb
32
+ test/fixtures/schema.rb
33
+ test/fixtures/topic.rb
34
+ test/fixtures/topics.yml
35
+ test/fixtures/user.rb
36
+ test/fixtures/users.yml
37
+ test/helper.rb
38
+ test/lib/activerecord_test_case.rb
39
+ test/lib/activerecord_test_connector.rb
40
+ test/lib/load_fixtures.rb
41
+ test/lib/view_test_process.rb
42
+ test/tasks.rake
43
+ test/view_test.rb
@@ -0,0 +1,139 @@
1
+ = 2.3.12, released 2009-12-01
2
+
3
+ * make view helpers "HTML safe" for Rails 2.3.5 with rails_xss plugin
4
+
5
+ = 2.3.11, released 2009-06-02
6
+
7
+ * fix `enable_actionpack`
8
+
9
+ = 2.3.10, released 2009-05-21
10
+
11
+ * count_by_sql: don't use table alias with any adapters starting with "oracle"
12
+ * Add back "AS count_table" alias to `paginate_by_sql` counter SQL
13
+
14
+ = 2.3.9, released 2009-05-29
15
+
16
+ * remove "AS count_table" alias from `paginate_by_sql` counter SQL
17
+ * Rails 2.3.2 compat: monkeypatch Rails issue #2189 (count breaks has_many :through)
18
+ * fix generation of page URLs that contain the "@" character
19
+ * check for method existance in a ruby 1.8- and 1.9-compatible way
20
+ * load will_paginate view helpers even if ActiveRecord is not loaded
21
+
22
+ == 2.3.8, released 2009-03-09
23
+
24
+ * Rails 2.3 compat: query parameter parsing with Rack
25
+
26
+ == 2.3.7, released 2009-02-09
27
+
28
+ * Removed all unnecessary &block variables since they cause serious memory damage and lots of subsequent gc runs.
29
+
30
+ == 2.3.6, released 2008-10-26
31
+
32
+ * Rails 2.2 fix: stop using `extract_attribute_names_from_match` inernal AR method, it no longer exists
33
+
34
+ == 2.3.5, released 2008-10-07
35
+
36
+ * update the backported named_scope implementation for Rails versions older than 2.1
37
+ * break out of scope of paginated_each() yielded block when used on named scopes
38
+ * fix paginate(:from)
39
+
40
+ == 2.3.4, released 2008-09-16
41
+
42
+ * Removed gem dependency to Active Support (causes trouble with vendored rails).
43
+ * Rails 2.1: fix a failing test and a deprecation warning.
44
+ * Cope with scoped :select when counting.
45
+
46
+ == 2.3.3, released 2008-08-29
47
+
48
+ * Ensure that paginate_by_sql doesn't change the original SQL query.
49
+ * RDoc love (now live at http://gitrdoc.com/mislav/will_paginate/tree/master)
50
+ * Rename :prev_label to :previous_label for consistency. old name still functions but is deprecated
51
+ * ActiveRecord 2.1: Remove :include option from count_all query when it's possible.
52
+
53
+ == 2.3.2, released 2008-05-16
54
+
55
+ * Fixed LinkRenderer#stringified_merge by removing "return" from iterator block
56
+ * Ensure that 'href' values in pagination links are escaped URLs
57
+
58
+ == 2.3.1, released 2008-05-04
59
+
60
+ * Fixed page numbers not showing with custom routes and implicit first page
61
+ * Try to use Hanna for documentation (falls back to default RDoc template if not)
62
+
63
+ == 2.3.0, released 2008-04-29
64
+
65
+ * Changed LinkRenderer to receive collection, options and reference to view template NOT in
66
+ constructor, but with the #prepare method. This is a step towards supporting passing of
67
+ LinkRenderer (or subclass) instances that may be preconfigured in some way
68
+ * LinkRenderer now has #page_link and #page_span methods for easier customization of output in
69
+ subclasses
70
+ * Changed page_entries_info() method to adjust its output according to humanized class name of
71
+ collection items. Override this with :entry_name parameter (singular).
72
+
73
+ page_entries_info(@posts)
74
+ #-> "Displaying all 12 posts"
75
+ page_entries_info(@posts, :entry_name => 'item')
76
+ #-> "Displaying all 12 items"
77
+
78
+ == 2.2.3, released 2008-04-26
79
+
80
+ * will_paginate gem is no longer published on RubyForge, but on
81
+ gems.github.com:
82
+
83
+ gem sources -a http://gems.github.com/ (you only need to do this once)
84
+ gem install mislav-will_paginate
85
+
86
+ * extract reusable pagination testing stuff into WillPaginate::View
87
+ * rethink the page URL construction mechanizm to be more bulletproof when
88
+ combined with custom routing for page parameter
89
+ * test that anchor parameter can be used in pagination links
90
+
91
+ == 2.2.2, released 2008-04-21
92
+
93
+ * Add support for page parameter in custom routes like "/foo/page/2"
94
+ * Change output of "page_entries_info" on single-page collection and erraneous
95
+ output with empty collection as reported by Tim Chater
96
+
97
+ == 2.2.1, released 2008-04-08
98
+
99
+ * take less risky path when monkeypatching named_scope; fix that it no longer
100
+ requires ActiveRecord::VERSION
101
+ * use strings in "respond_to?" calls to work around a bug in acts_as_ferret
102
+ stable (ugh)
103
+ * add rake release task
104
+
105
+
106
+ == 2.2.0, released 2008-04-07
107
+
108
+ === API changes
109
+ * Rename WillPaginate::Collection#page_count to "total_pages" for consistency.
110
+ If you implemented this interface, change your implementation accordingly.
111
+ * Remove old, deprecated style of calling Array#paginate as "paginate(page,
112
+ per_page)". If you want to specify :page, :per_page or :total_entries, use a
113
+ parameter hash.
114
+ * Rename LinkRenderer#url_options to "url_for" and drastically optimize it
115
+
116
+ === View changes
117
+ * Added "prev_page" and "next_page" CSS classes on previous/next page buttons
118
+ * Add examples of pagination links styling in "examples/index.html"
119
+ * Change gap in pagination links from "..." to
120
+ "<span class="gap">&hellip;</span>".
121
+ * Add "paginated_section", a block helper that renders pagination both above and
122
+ below content in the block
123
+ * Add rel="prev|next|start" to page links
124
+
125
+ === Other
126
+
127
+ * Add ability to opt-in for Rails 2.1 feature "named_scope" by calling
128
+ WillPaginate.enable_named_scope (tested in Rails 1.2.6 and 2.0.2)
129
+ * Support complex page parameters like "developers[page]"
130
+ * Move Array#paginate definition to will_paginate/array.rb. You can now easily
131
+ use pagination on arrays outside of Rails:
132
+
133
+ gem 'will_paginate'
134
+ require 'will_paginate/array'
135
+
136
+ * Add "paginated_each" method for iterating through every record by loading only
137
+ one page of records at the time
138
+ * Rails 2: Rescue from WillPaginate::InvalidPage error with 404 Not Found by
139
+ default
data/LICENSE ADDED
@@ -0,0 +1,18 @@
1
+ Copyright (c) 2007 PJ Hyett and Mislav Marohnić
2
+
3
+ Permission is hereby granted, free of charge, to any person obtaining a copy of
4
+ this software and associated documentation files (the "Software"), to deal in
5
+ the Software without restriction, including without limitation the rights to
6
+ use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
7
+ the Software, and to permit persons to whom the Software is furnished to do so,
8
+ subject to the following conditions:
9
+
10
+ The above copyright notice and this permission notice shall be included in all
11
+ copies or substantial portions of the Software.
12
+
13
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
15
+ FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
16
+ COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
17
+ IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
18
+ CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
@@ -0,0 +1,107 @@
1
+ = WillPaginate
2
+
3
+ Pagination is just limiting the number of records displayed. Why should you let
4
+ it get in your way while developing, then? This plugin makes magic happen. Did
5
+ you ever want to be able to do just this on a model:
6
+
7
+ Post.paginate :page => 1, :order => 'created_at DESC'
8
+
9
+ ... and then render the page links with a single view helper? Well, now you
10
+ can.
11
+
12
+ Some resources to get you started:
13
+
14
+ * {Installation instructions}[http://github.com/mislav/will_paginate/wikis/installation]
15
+ on {the wiki}[http://github.com/mislav/will_paginate/wikis]
16
+ * Your mind reels with questions? Join our
17
+ {Google group}[http://groups.google.com/group/will_paginate].
18
+ * {How to report bugs}[http://github.com/mislav/will_paginate/wikis/report-bugs]
19
+
20
+
21
+ == Example usage
22
+
23
+ Use a paginate finder in the controller:
24
+
25
+ @posts = Post.paginate_by_board_id @board.id, :page => params[:page], :order => 'updated_at DESC'
26
+
27
+ Yeah, +paginate+ works just like +find+ -- it just doesn't fetch all the
28
+ records. Don't forget to tell it which page you want, or it will complain!
29
+ Read more on WillPaginate::Finder::ClassMethods.
30
+
31
+ Render the posts in your view like you would normally do. When you need to render
32
+ pagination, just stick this in:
33
+
34
+ <%= will_paginate @posts %>
35
+
36
+ You're done. (You can find the option list at WillPaginate::ViewHelpers.)
37
+
38
+ How does it know how much items to fetch per page? It asks your model by calling
39
+ its <tt>per_page</tt> class method. You can define it like this:
40
+
41
+ class Post < ActiveRecord::Base
42
+ cattr_reader :per_page
43
+ @@per_page = 50
44
+ end
45
+
46
+ ... or like this:
47
+
48
+ class Post < ActiveRecord::Base
49
+ def self.per_page
50
+ 50
51
+ end
52
+ end
53
+
54
+ ... or don't worry about it at all. WillPaginate defines it to be <b>30</b> by default.
55
+ But you can always specify the count explicitly when calling +paginate+:
56
+
57
+ @posts = Post.paginate :page => params[:page], :per_page => 50
58
+
59
+ The +paginate+ finder wraps the original finder and returns your resultset that now has
60
+ some new properties. You can use the collection as you would with any ActiveRecord
61
+ resultset. WillPaginate view helpers also need that object to be able to render pagination:
62
+
63
+ <ol>
64
+ <% for post in @posts -%>
65
+ <li>Render `post` in some nice way.</li>
66
+ <% end -%>
67
+ </ol>
68
+
69
+ <p>Now let's render us some pagination!</p>
70
+ <%= will_paginate @posts %>
71
+
72
+ More detailed documentation:
73
+
74
+ * WillPaginate::Finder::ClassMethods for pagination on your models;
75
+ * WillPaginate::ViewHelpers for your views.
76
+
77
+
78
+ == Authors and credits
79
+
80
+ Authors:: Mislav Marohnić, PJ Hyett
81
+ Original announcement:: http://errtheblog.com/post/929
82
+ Original PHP source:: http://www.strangerstudios.com/sandbox/pagination/diggstyle.php
83
+
84
+ All these people helped making will_paginate what it is now with their code
85
+ contributions or just simply awesome ideas:
86
+
87
+ Chris Wanstrath, Dr. Nic Williams, K. Adam Christensen, Mike Garey, Bence
88
+ Golda, Matt Aimonetti, Charles Brian Quinn, Desi McAdam, James Coglan, Matijs
89
+ van Zuijlen, Maria, Brendan Ribera, Todd Willey, Bryan Helmkamp, Jan Berkel,
90
+ Lourens Naudé, Rick Olson, Russell Norris, Piotr Usewicz, Chris Eppstein,
91
+ Denis Barushev, Ben Pickles.
92
+
93
+
94
+ == Usable pagination in the UI
95
+
96
+ There are some CSS styles to get you started in the "examples/" directory. They
97
+ are {showcased online here}[http://mislav.caboo.se/static/will_paginate/].
98
+
99
+ More reading about pagination as design pattern:
100
+
101
+ * {Pagination 101}[http://kurafire.net/log/archive/2007/06/22/pagination-101]
102
+ * {Pagination gallery}[http://www.smashingmagazine.com/2007/11/16/pagination-gallery-examples-and-good-practices/]
103
+ * {Pagination on Yahoo Design Pattern Library}[http://developer.yahoo.com/ypatterns/parent.php?pattern=pagination]
104
+
105
+ Want to discuss, request features, ask questions? Join the
106
+ {Google group}[http://groups.google.com/group/will_paginate].
107
+
@@ -0,0 +1,71 @@
1
+ require 'rubygems'
2
+
3
+
4
+ begin
5
+ require 'jeweler'
6
+ Jeweler::Tasks.new do |gemspec|
7
+ gemspec.name = "pb-will_paginate"
8
+ gemspec.summary = "Most awesome pagination solution for Rails"
9
+ gemspec.description = "The will_paginate library provides a simple, yet powerful and extensible API for ActiveRecord pagination and rendering of pagination links in ActionView templates."
10
+ gemspec.email = "mislav.marohnic@gmail.com"
11
+ gemspec.homepage = "http://github.com/mislav/will_paginate/wikis"
12
+ gemspec.authors = ["Mislav Marohnić", "PJ Hyett"]
13
+ end
14
+ Jeweler::GemcutterTasks.new
15
+ rescue LoadError
16
+ puts "Jeweler not available. Install it with: gem install jeweler"
17
+ end
18
+
19
+
20
+ begin
21
+ hanna_dir = '/Users/mislav/Projects/Hanna/lib'
22
+ $:.unshift hanna_dir if File.exists? hanna_dir
23
+ require 'hanna/rdoctask'
24
+ rescue LoadError
25
+ require 'rake'
26
+ require 'rake/rdoctask'
27
+ end
28
+ load 'test/tasks.rake'
29
+
30
+ desc 'Default: run unit tests.'
31
+ task :default => :test
32
+
33
+ desc 'Generate RDoc documentation for the will_paginate plugin.'
34
+ Rake::RDocTask.new(:rdoc) do |rdoc|
35
+ rdoc.rdoc_files.include('README.rdoc', 'LICENSE', 'CHANGELOG.rdoc').
36
+ include('lib/**/*.rb').
37
+ exclude('lib/will_paginate/named_scope*').
38
+ exclude('lib/will_paginate/array.rb').
39
+ exclude('lib/will_paginate/version.rb')
40
+
41
+ rdoc.main = "README.rdoc" # page to start on
42
+ rdoc.title = "will_paginate documentation"
43
+
44
+ rdoc.rdoc_dir = 'doc' # rdoc output folder
45
+ rdoc.options << '--inline-source' << '--charset=UTF-8'
46
+ rdoc.options << '--webcvs=http://github.com/mislav/will_paginate/tree/master/'
47
+ end
48
+
49
+ desc %{Update ".manifest" with the latest list of project filenames. Respect\
50
+ .gitignore by excluding everything that git ignores. Update `files` and\
51
+ `test_files` arrays in "*.gemspec" file if it's present.}
52
+ task :manifest do
53
+ list = `git ls-files --full-name --exclude=*.gemspec --exclude=.*`.chomp.split("\n")
54
+
55
+ if spec_file = Dir['*.gemspec'].first
56
+ spec = File.read spec_file
57
+ spec.gsub! /^(\s* s.(test_)?files \s* = \s* )( \[ [^\]]* \] | %w\( [^)]* \) )/mx do
58
+ assignment = $1
59
+ bunch = $2 ? list.grep(/^test\//) : list
60
+ '%s%%w(%s)' % [assignment, bunch.join(' ')]
61
+ end
62
+
63
+ File.open(spec_file, 'w') { |f| f << spec }
64
+ end
65
+ File.open('.manifest', 'w') { |f| f << list.join("\n") }
66
+ end
67
+
68
+ task :examples do
69
+ %x(haml examples/index.haml examples/index.html)
70
+ %x(sass examples/pagination.sass examples/pagination.css)
71
+ end
data/VERSION ADDED
@@ -0,0 +1 @@
1
+ 2.3.12
Binary file
@@ -0,0 +1,69 @@
1
+ !!!
2
+ %html
3
+ %head
4
+ %title Samples of pagination styling for will_paginate
5
+ %link{ :rel => 'stylesheet', :type => 'text/css', :href => 'pagination.css' }
6
+ %style{ :type => 'text/css' }
7
+ :sass
8
+ html
9
+ :margin 0
10
+ :padding 0
11
+ :background #999
12
+ :font normal 76% "Lucida Grande", Verdana, Helvetica, sans-serif
13
+ body
14
+ :margin 2em
15
+ :padding 2em
16
+ :border 2px solid gray
17
+ :background white
18
+ :color #222
19
+ h1
20
+ :font-size 2em
21
+ :font-weight normal
22
+ :margin 0 0 1em 0
23
+ h2
24
+ :font-size 1.4em
25
+ :margin 1em 0 .5em 0
26
+ pre
27
+ :font-size 13px
28
+ :font-family Monaco, "DejaVu Sans Mono", "Bitstream Vera Mono", "Courier New", monospace
29
+
30
+ - pagination = '<span class="disabled prev_page">&laquo; Previous</span> <span class="current">1</span> <a href="./?page=2" rel="next">2</a> <a href="./?page=3">3</a> <a href="./?page=4">4</a> <a href="./?page=5">5</a> <a href="./?page=6">6</a> <a href="./?page=7">7</a> <a href="./?page=8">8</a> <a href="./?page=9">9</a> <span class="gap">&hellip;</span> <a href="./?page=29">29</a> <a href="./?page=30">30</a> <a href="./?page=2" rel="next" class="next_page">Next &raquo;</a>'
31
+ - pagination_no_page_links = '<span class="disabled prev_page">&laquo; Previous</span> <a href="./?page=2" rel="next" class="next_page">Next &raquo;</a>'
32
+
33
+ %body
34
+ %h1 Samples of pagination styling for will_paginate
35
+ %p
36
+ Find these styles in <b>"examples/pagination.css"</b> of <i>will_paginate</i> library.
37
+ There is a Sass version of it for all you sassy people.
38
+ %p
39
+ Read about good rules for pagination:
40
+ %a{ :href => 'http://kurafire.net/log/archive/2007/06/22/pagination-101' } Pagination 101
41
+ %p
42
+ %em Warning:
43
+ page links below don't lead anywhere (so don't click on them).
44
+
45
+ %h2 Unstyled pagination <span style="font-weight:normal">(<i>ewww!</i>)</span>
46
+ %div= pagination
47
+
48
+ %h2 Digg.com
49
+ .digg_pagination= pagination
50
+
51
+ %h2 Digg-style, no page links
52
+ .digg_pagination= pagination_no_page_links
53
+ %p Code that renders this:
54
+ %pre= '<code>%s</code>' % %[<%= will_paginate @posts, :page_links => false %>].gsub('<', '&lt;').gsub('>', '&gt;')
55
+
56
+ %h2 Digg-style, extra content
57
+ .digg_pagination
58
+ .page_info Displaying entries <b>1&nbsp;-&nbsp;6</b> of <b>180</b> in total
59
+ = pagination
60
+ %p Code that renders this:
61
+ %pre= '<code>%s</code>' % %[<div class="digg_pagination">\n <div clas="page_info">\n <%= page_entries_info @posts %>\n </div>\n <%= will_paginate @posts, :container => false %>\n</div>].gsub('<', '&lt;').gsub('>', '&gt;')
62
+
63
+ %h2 Apple.com store
64
+ .apple_pagination= pagination
65
+
66
+ %h2 Flickr.com
67
+ .flickr_pagination
68
+ = pagination
69
+ .page_info (118 photos)