just_paginate 0.1.1 → 0.2.1

data/README.md

@@ -6,7 +6,7 @@ just_paginate is a framework-agnostic approach to creating paginated
 webpages. It has no external dependencies and works with any web
 framework.
 
-Consists of two main methods, paginate and page_navigation. 
+Consists of two main methods, paginate and page_navigation.
 
 JustPaginate.paginate helps you slice up your collections and, given a
 page number, entities per page and totoal entity count, gives you the
@@ -37,21 +37,26 @@ Say we have a Rails app, with an index page of paginated Projects. You
 could do this in the controller, to select the 20 projects for the
 current page:
 
-    @page = JustPaginate.page_value(params[:page])
-    @project_count = Project.count
-    @projects, @total_pages = JustPaginate.paginate(@page, 20, @project_count) do |index_range|
-      Project.all.slice(index_range)
-    end
+```rb
+page = JustPaginate.page_value(params[:page])
+project_count = Project.count
+projects, total_pages = JustPaginate.paginate(page, 20, project_count) do |index_range|
+  Project.all.slice(index_range)
+end
+```
 
 And in the index.html.erb file, to generate the page navigation:
 
-    <%= JustPaginate.page_navigation(@page, @total_pages) { |page_no| "/projects/?page=#{page_no}" } -%>
-
+```erb
+<%= JustPaginate.page_navigation(page, total_pages) { |page_no| "/projects/?page=#{page_no}" } -%>
+```
 
 INSTALL:
 ========
 
-`sudo gem install just_paginate` 
+```sh
+sudo gem install just_paginate
+```
 
 Or simply stick just_paginate into your Gemfile and use Bundler to
 pull it down.

data/lib/just_paginate.rb

@@ -23,8 +23,7 @@
 # SOFTWARE.
 #++
 module JustPaginate
-
-  VERSION = "0.1.1"
+  VERSION = "0.2.1"
 
   # TODO make sure negative numbers, non-integers etc are just converted to page 1.
   def self.page_value(page)
@@ -49,17 +48,19 @@ module JustPaginate
   def self.index_range(curr_page, per_page, total_entry_count)
     start_index = ((curr_page-1)*per_page)
     end_index = (start_index+per_page)-1
+    error_prefix = "Page #{curr_page} out of bounds"
 
     if total_entry_count == 0
+      raise RangeError.new("#{error_prefix}, collection has 0 entries") if start_index != 0
       return 0..0
     end
 
-    if(start_index>(total_entry_count-1))
-      start_index = total_entry_count-per_page
-      end_index = total_entry_count-1
+    if curr_page < 1 || start_index > (total_entry_count - 1)
+      page_count = (total_entry_count.to_f / per_page).ceil
+      raise RangeError.new("#{error_prefix} from #{page_count} pages")
     end
 
-    if end_index>total_entry_count
+    if end_index > total_entry_count
       end_index = total_entry_count
     end
 

data/test/just_paginate_test.rb

@@ -94,14 +94,16 @@ describe JustPaginate do
     end
   end
 
-  it "just falls back to largest possible page if given page extends past collection bounds" do
+  it "raises exception when out of bounds" do
     assert_equal 2..3, JustPaginate.index_range(2,2,4)
-    assert_equal 2..3, JustPaginate.index_range(3,2,4)
-    assert_equal 2..3, JustPaginate.index_range(4,2,4)
+    assert_raises(RangeError) { JustPaginate.index_range(3,2,4) }
+    assert_raises(RangeError) { JustPaginate.index_range(4,2,4) }
+    assert_raises(RangeError) { JustPaginate.index_range(0,2,4) }
+    assert_raises(RangeError) { JustPaginate.index_range(10,30,0) }
   end
 
-  it "returns 0-0 range for empty collection" do
-     assert_equal 0..0, JustPaginate.index_range(2,2,0)
+  it "returns 0-0 range for first page in empty collection" do
+     assert_equal 0..0, JustPaginate.index_range(1,2,0)
   end
 
   describe "The frontend pagination html helper" do

metadata

@@ -1,61 +1,56 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: just_paginate
-version: !ruby/object:Gem::Version 
-  hash: 25
+version: !ruby/object:Gem::Version
+  version: 0.2.1
   prerelease: 
-  segments: 
-  - 0
-  - 1
-  - 1
-  version: 0.1.1
 platform: ruby
-authors: 
+authors:
 - Gitorious AS
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2013-08-27 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2013-09-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: minitest
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 2
-        - 0
-        version: "2.0"
+      - !ruby/object:Gem::Version
+        version: '2.0'
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id002
-description: Framework-agnostic support for paginating collections of things, and linking to paginated things in your webpage
-email: 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Framework-agnostic support for paginating collections of things, and
+  linking to paginated things in your webpage
+email:
 - support@gitorious.org
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - Gemfile
 - README.md
@@ -66,36 +61,30 @@ files:
 - test/test_helper.rb
 homepage: https://gitorious.org/gitorious/just_paginate
 licenses: []
-
 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: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+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: just_paginate
 rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
-summary: Framework-agnostic support for paginating collections of things, and linking to paginated things in your webpage
-test_files: []
-
+summary: Framework-agnostic support for paginating collections of things, and linking
+  to paginated things in your webpage
+test_files:
+- test/just_paginate_test.rb
+- test/test_helper.rb
+has_rdoc: