will_paginate 3.0.pre4 → 3.0.0

data/spec/view_helpers/view_example_group.rb

@@ -1,5 +1,6 @@
 require 'active_support'
 require 'action_dispatch/testing/assertions'
+require 'will_paginate/array'
 
 module ViewExampleGroup
   

metadata

@@ -1,8 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: will_paginate
 version: !ruby/object:Gem::Version 
-  prerelease: 4
-  version: 3.0.pre4
+  prerelease: 
+  version: 3.0.0
 platform: ruby
 authors: 
 - "Mislav Marohni\xC4\x87"
@@ -10,52 +10,50 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-05 00:00:00 Z
+date: 2011-08-09 00:00:00 Z
 dependencies: []
 
-description: The will_paginate library provides a simple, yet powerful and extensible API for pagination and rendering of page links in web application templates.
+description: will_paginate provides a simple API for performing paginated queries with Active Record, DataMapper and Sequel, and includes helpers for rendering pagination links in Rails, Sinatra and Merb web apps.
 email: mislav.marohnic@gmail.com
 executables: []
 
 extensions: []
 
 extra_rdoc_files: 
-- README.rdoc
+- README.md
 - LICENSE
-- CHANGELOG.rdoc
 files: 
 - Rakefile
+- lib/will_paginate/active_record.rb
 - lib/will_paginate/array.rb
 - lib/will_paginate/collection.rb
 - lib/will_paginate/core_ext.rb
-- lib/will_paginate/deprecation.rb
-- lib/will_paginate/finders/active_record.rb
-- lib/will_paginate/finders/active_resource.rb
-- lib/will_paginate/finders/base.rb
-- lib/will_paginate/finders/data_mapper.rb
-- lib/will_paginate/finders/sequel.rb
-- lib/will_paginate/finders.rb
+- lib/will_paginate/data_mapper.rb
+- lib/will_paginate/i18n.rb
+- lib/will_paginate/locale/en.yml
+- lib/will_paginate/page_number.rb
+- lib/will_paginate/per_page.rb
 - lib/will_paginate/railtie.rb
+- lib/will_paginate/sequel.rb
 - lib/will_paginate/version.rb
 - lib/will_paginate/view_helpers/action_view.rb
-- lib/will_paginate/view_helpers/base.rb
 - lib/will_paginate/view_helpers/link_renderer.rb
 - lib/will_paginate/view_helpers/link_renderer_base.rb
 - lib/will_paginate/view_helpers/merb.rb
+- lib/will_paginate/view_helpers/sinatra.rb
 - lib/will_paginate/view_helpers.rb
 - lib/will_paginate.rb
+- spec/ci.rb
 - spec/collection_spec.rb
 - spec/console
 - spec/console_fixtures.rb
 - spec/database.yml
 - spec/finders/active_record_spec.rb
-- spec/finders/active_resource_spec.rb
 - spec/finders/activerecord_test_connector.rb
 - spec/finders/data_mapper_spec.rb
 - spec/finders/data_mapper_test_connector.rb
 - spec/finders/sequel_spec.rb
 - spec/finders/sequel_test_connector.rb
-- spec/finders_spec.rb
 - spec/fixtures/admin.rb
 - spec/fixtures/developer.rb
 - spec/fixtures/developers_projects.yml
@@ -68,21 +66,22 @@ files:
 - spec/fixtures/topics.yml
 - spec/fixtures/user.rb
 - spec/fixtures/users.yml
+- spec/page_number_spec.rb
+- spec/per_page_spec.rb
 - spec/spec_helper.rb
 - spec/view_helpers/action_view_spec.rb
 - spec/view_helpers/base_spec.rb
 - spec/view_helpers/link_renderer_base_spec.rb
 - spec/view_helpers/view_example_group.rb
-- README.rdoc
+- README.md
 - LICENSE
-- CHANGELOG.rdoc
-homepage: http://github.com/mislav/will_paginate/wikis
+homepage: https://github.com/mislav/will_paginate/wiki
 licenses: []
 
 post_install_message: 
 rdoc_options: 
 - --main
-- README.rdoc
+- README.md
 - --charset=UTF-8
 require_paths: 
 - lib
@@ -95,15 +94,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version 
-      version: 1.3.1
+      version: "0"
 requirements: []
 
 rubyforge_project: 
 rubygems_version: 1.8.5
 signing_key: 
 specification_version: 3
-summary: Adaptive pagination plugin for web frameworks and other applications
+summary: Pagination plugin for web frameworks and other apps
 test_files: []
 

data/CHANGELOG.rdoc

@@ -1,105 +0,0 @@
-== "agnostic" branch
-
-* added Sequel support
-* added an initialization hook for Merb
-* refactored URL generation
-* BACKWARDS INCOMPATIBLE: refactored LinkRenderer; also markup changes
-    <span class="current">1</span> is now <em>1</em>
-    a.prev_page -> a.previous_page (for consistency)
-* "prev_label" -> "previous_label"
-* ported view tests to specs
-* setup Autotest
-* added per_page=(limit) attribute writer to set default per_page
-* Remove :include option from count_all query when possible (Rails 2.1)
-* added WP::ViewHelpers::ActionView and LinkRenderer
-* specs for ViewHelpers::Base and LinkRendererBase
-* created LinkRendererBase that implements windowed visible page numbers logic
-* created WP::ViewHelpers::Base abstract module that implements generic view helpers
-* ported finder tests to specs
-* added WP::Finders::DataMapper
-* added WP::Finders::ActiveRecord mixin for ActiveRecord::Base
-* created WP::Finders::Base abstract module that implements generic pagination logic
-* removed dependency to ActiveSupport
-
-== 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 mechanism 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 erroneous
-  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

@@ -1,111 +0,0 @@
-= The will_paginate Ruby library
-
-Pagination is just limiting the number of records loaded and 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'
-
-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:
-
-* The {will_paginate project page}[http://mislav.github.com/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.
-
-== I'm not using Rails; can I still use will_paginate?
-
-Absolutely -- although will_paginate started off as a Rails plugin, now it is a <em>completely
-framework-agnostic</em> library with support for Rails and Merb built-in. The core library doesn't
-have any dependences and you can safely use it in any Ruby code.
-
-When will_paginate is loaded in an environment where ActiveRecord and ActionView are present, it
-automatically hooks into these frameworks to provide easy pagination on your models and in your
-views. The same mechanism works for Merb applications, too. But, if no known framework is present
-then you have absolute control over what parts of will_paginate do you want to load and where you want
-them mixed in.
-
-
-== Installation
-
-In your Gemfile (if using Bundler):
-
-  gem 'will_paginate', '~> 3.0.beta'
-
-<i>There are extensive {installation
-instructions}[http://github.com/mislav/will_paginate/wikis/installation] on {the
-wiki}[http://github.com/mislav/will_paginate/wikis].</i>
-
-
-== Example usage
-
-Typical usage involves a paginating find in the controller:
-  
-  @posts = Post.paginate :page => params[:page], :order => 'updated_at DESC'
-
-It's true: +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 in WillPaginate::Finders.
-
-Render the posts in your view like you would normally do, and when you need to render pagination,
-just stick this in:
-
-  <%= will_paginate @posts %>
-
-You're done. Read more in WillPaginate::ViewHelpers::Base.
-
-How does it know how much items to fetch per page? It asks your model by calling its
-+per_page+ class method. You can define it like this:
-
-  class Post < ActiveRecord::Base
-    self.per_page = 50
-  end
-
-... or don't worry about it at all. WillPaginate defines it to be <strong>30</strong> by default. You can
-always specify the count explicitly when calling +paginate+:
-
-  Post.paginate :page => params[:page], :per_page => 50
-
-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 collection object to be able to render pagination:
-
-  <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 %>
-
-
-== Authors and credits
-
-The original author of will_paginate was PJ Hyett, who later handed over development to Mislav
-Marohnić. (The library was completely rewritten since then.)
-
-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, Brandon Arbini, Denis Barushev, Paul Barry, Ben Pickles, Ken Collins, Lida Tang and Pieter
-Noordhuis.
-
-
-== Usable pagination in the UI
-
-There are example CSS styles to get you started on the will_paginate project page.
-
-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/] 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].

data/lib/will_paginate/deprecation.rb

@@ -1,50 +0,0 @@
-# borrowed from ActiveSupport::Deprecation
-module WillPaginate
-  module Deprecation
-    def self.debug() @debug; end
-    def self.debug=(value) @debug = value; end
-    self.debug = false
-
-    # Choose the default warn behavior according to Rails.env.
-    # Ignore deprecation warnings in production.
-    BEHAVIORS = {
-      'test'        => Proc.new { |message, callstack|
-                         $stderr.puts(message)
-                         $stderr.puts callstack.join("\n  ") if debug
-                       },
-      'development' => Proc.new { |message, callstack|
-                         logger = defined?(::RAILS_DEFAULT_LOGGER) ? ::RAILS_DEFAULT_LOGGER : Logger.new($stderr)
-                         logger.warn message
-                         logger.debug callstack.join("\n  ") if debug
-                       }
-    }
-
-    def self.warn(message, callstack = caller)
-      if behavior
-        message = 'WillPaginate: ' + message.strip.gsub(/\s+/, ' ')
-        behavior.call(message, callstack)
-      end
-    end
-
-    def self.default_behavior
-      if defined?(::Rails)
-        BEHAVIORS[::Rails.env.to_s]
-      else
-        BEHAVIORS['test']
-      end
-    end
-
-    # Behavior is a block that takes a message argument.
-    def self.behavior() @behavior; end
-    def self.behavior=(value) @behavior = value; end
-    self.behavior = default_behavior
-
-    def self.silence
-      old_behavior = self.behavior
-      self.behavior = nil
-      yield
-    ensure
-      self.behavior = old_behavior
-    end
-  end
-end

data/lib/will_paginate/finders.rb

@@ -1,9 +0,0 @@
-require 'will_paginate/core_ext'
-
-module WillPaginate
-  # Database logic for different ORMs
-  #
-  # See WillPaginate::Finders::Base
-  module Finders
-  end
-end

data/lib/will_paginate/finders/active_resource.rb

@@ -1,51 +0,0 @@
-require 'will_paginate/finders/base'
-require 'active_resource'
-
-module WillPaginate::Finders
-  # Paginate your ActiveResource models.
-  # 
-  #   @posts = Post.paginate :all, :params => {
-  #              :page => params[:page], :order => 'created_at DESC'
-  #            }
-  # 
-  module ActiveResource
-    include WillPaginate::Finders::Base
-    
-  protected
-  
-    def wp_query(options, pager, args, &block) #:nodoc:
-      unless args.empty? or args.first == :all
-        raise ArgumentError, "finder arguments other than :all are not supported for pagination (#{args.inspect} given)"
-      end
-      params = (options[:params] ||= {})
-      params[:page] = pager.current_page
-      params[:per_page] = pager.per_page
-      
-      pager.replace find_every(options, &block)
-    end
-    
-    # Takes the format that Hash.from_xml produces out of an unknown type
-    # (produced by WillPaginate::Collection#to_xml_with_collection_type), 
-    # parses it into a WillPaginate::Collection,
-    # and forwards the result to the former +instantiate_collection+ method.
-    # It only does this for hashes that have a :type => "collection".
-    def instantiate_collection_with_collection(collection, prefix_options = {}) #:nodoc:
-      if collection.is_a?(Hash) && collection["type"] == "collection"
-        collectables = collection.values.find{ |c| c.is_a?(Hash) || c.is_a?(Array) }
-        collectables = [collectables].compact unless collectables.kind_of?(Array)
-        instantiated_collection = WillPaginate::Collection.create(collection["current_page"], collection["per_page"], collection["total_entries"]) do |pager|
-          pager.replace instantiate_collection_without_collection(collectables, prefix_options)
-        end
-      else
-        instantiate_collection_without_collection(collection, prefix_options)
-      end
-    end
-  end
-end
-
-ActiveResource::Base.class_eval do
-  extend WillPaginate::Finders::ActiveResource
-  class << self
-    # alias_method_chain :instantiate_collection, :collection
-  end
-end