simple_page 3.0.4 → 3.1.0

data/README.rdoc

@@ -1,19 +1,90 @@
 = simple_page
 
-Description goes here.
-
-== Contributing to simple_page
- 
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
-* Fork the project
-* Start a feature/bugfix branch
-* Commit and push until you are happy with your contribution
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
-
-== Copyright
-
-Copyright (c) 2011 David Monagle. See LICENSE.txt for
-further details.
+Adds simple but flexible pagination to ActiveRecord as well as the appropriate helpers to render page links.
+
+Part of the core of this works was adapted from the github project paged_scopes.
+
+Install the gem and you are ready to go. In your Gemfile:
+
+    gem 'simple_page'
+
+== In the Controllers
+
+Use the simple_page helpers - this is only needed if you want to use the standard helpers and are not writing your own.
+
+    helper :simple_page
+
+Modify your action to get the current page and set the page size:
+
+    def index
+      @products = Product.where({})
+      @products.page_size = 10
+      @page = params[:page] || 1
+      respond_with(@products)
+    end
+
+Note the following: Instead of the standard Product.all - which returns an array - I have used Product.where({}) which returns a scope. The following line sets the pagination size, then we set a variable to select the current page (or page 1) depending on the parameters passed to the action.
+
+Lastly we do a normal respond with the @products scope. Very little change to a normal controller method really.
+
+=== Finding the page number for a known object
+
+Something that I need to do from time to time. Especially when somebody direct links to an object and the pages are displayed within the "show" action
+
+     @product = Product.find(params[:id])
+     @products = Product.where({})
+     @products.page_size = 10
+     @page = @products.find_page_number(@product)
+
+This is probably not the most wonderfully efficient thing to do, but it works. Feel free to contact me if you have a better method for implementing this than the one I've used.
+
+== In the Views
+
+In a view where all of the products would normally be displayed, we now only want to display the products from the selected page. This can be achieved as follows:
+
+    <% @products.page(@page).each do |product| %>
+    ...
+    <% end %>
+
+Then at the bottom we put in page links:
+
+    <%= page_links(@products, @page) %>
+
+=== Extras
+
+As well as having a simple list of page numbers, there are four special or extra tags that can be used in the links: :first, :preview, :next, :last. The function of these should be reasonably self explanitory or you probably wouldn't be here.
+
+So the standard page_links function could be used like this:
+
+    <%= page_links(@products, @page, [:first, :previous, :next, :last]) %>
+
+== In the Helpers
+
+=== Built in Helpers
+
+These helpers should be fairly self explanitory. Better yet you can easily implement your own if you have formatting requirements. This way if you need pagination to appear differently in different parts of your applicaiton, it's very straight forward to implement your own helpers.
+
+  def simple_page_marker(page)
+    case page
+        when :previous
+            return "Previous"
+        when :next
+            return "Next"
+        when :first
+            return "First"
+        when :last
+            return "Last"
+        else
+            return page
+    end
+  end
+
+  def page_links(collection, selected_page, extras = [ :previous, :next ], page_tag_helper = lambda {|page| simple_page_marker(page)})
+    content_tag :ul, :class => "page_select" do
+      collection.page_links_generator(selected_page, :inner => 2, :outer => 1, :extras => extras) do |tag, page_number, classes|
+        content_tag :li, link_to(page_tag_helper.call(tag), params.merge(:page => page_number)), :class => (classes << :page).join(" ")
+      end
+    end
+  end
+
 

data/VERSION

@@ -1 +1 @@
-3.0.4
+3.1.0

data/lib/simple_page/active_record_extension.rb

@@ -54,7 +54,7 @@ module SimplePageExtension
       numbers.uniq!
       numbers.sort!
       numbers.reject! { |number| !number.between?(1, self.page_count) }
-      returning [] do |results|
+      [].tap do |results|
         results << yield(:first, 1, []) if extras.include?(:first)
         results << yield(:previous, prev_page, []) if extras.include?(:previous)
         numbers.zip([nil]+numbers, numbers[1..-1]) do |number, prev_number, next_number|

data/simple_page.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{simple_page}
-  s.version = "3.0.4"
+  s.version = "3.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["David Monagle"]
-  s.date = %q{2011-05-09}
+  s.authors = [%q{David Monagle}]
+  s.date = %q{2012-01-19}
   s.description = %q{Extends Active Record to give pagination functions. Also supplies view helpers and generators to create customised pagination links.}
   s.email = %q{david.monagle@intrica.com.au}
   s.extra_rdoc_files = [
@@ -32,9 +32,9 @@ Gem::Specification.new do |s|
     "test/test_simple_page.rb"
   ]
   s.homepage = %q{http://github.com/intrica/simple_page}
-  s.licenses = ["MIT"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.5.3}
+  s.licenses = [%q{MIT}]
+  s.require_paths = [%q{lib}]
+  s.rubygems_version = %q{1.8.6}
   s.summary = %q{Active Record extension  and view helpers to give pagination abilities}
   s.test_files = [
     "test/helper.rb",

metadata

@@ -1,65 +1,47 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: simple_page
-version: !ruby/object:Gem::Version 
-  hash: 15
+version: !ruby/object:Gem::Version
+  version: 3.1.0
   prerelease: 
-  segments: 
-  - 3
-  - 0
-  - 4
-  version: 3.0.4
 platform: ruby
-authors: 
+authors:
 - David Monagle
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-05-09 00:00:00 +10:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-01-19 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: bundler
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
+  requirement: &70258976506900 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 23
-        segments: 
-        - 1
-        - 0
-        - 0
+      - !ruby/object:Gem::Version
         version: 1.0.0
-  prerelease: false
   type: :development
-  requirement: *id001
-- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: *70258976506900
+- !ruby/object:Gem::Dependency
   name: jeweler
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
+  requirement: &70258976506420 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 1
-        - 5
-        - 2
+      - !ruby/object:Gem::Version
         version: 1.5.2
-  prerelease: false
   type: :development
-  requirement: *id002
-description: Extends Active Record to give pagination functions. Also supplies view helpers and generators to create customised pagination links.
+  prerelease: false
+  version_requirements: *70258976506420
+description: Extends Active Record to give pagination functions. Also supplies view
+  helpers and generators to create customised pagination links.
 email: david.monagle@intrica.com.au
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - LICENSE.txt
 - README.rdoc
-files: 
+files:
 - .document
 - Gemfile
 - LICENSE.txt
@@ -73,40 +55,34 @@ files:
 - simple_page.gemspec
 - test/helper.rb
 - test/test_simple_page.rb
-has_rdoc: true
 homepage: http://github.com/intrica/simple_page
-licenses: 
+licenses:
 - MIT
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: -2462150418988594274
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.5.3
+rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
 summary: Active Record extension  and view helpers to give pagination abilities
-test_files: 
+test_files:
 - test/helper.rb
 - test/test_simple_page.rb