taylorbarstow-simple_pagination 0.1.1 → 0.1.2

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
-:patch: 1
+:patch: 2
 :major: 0
 :minor: 1

data/lib/simple_pagination/page.rb

@@ -7,7 +7,7 @@ module SimplePagination
     ##
     # The zero-based offset of the first record in this page
     def offset
-      (@number-1) * @collection.page_size + 1
+      (@number-1) * @collection.page_size
     end
 
     ##

data/lib/simple_pagination/page_collection.rb

@@ -3,8 +3,9 @@ module SimplePagination
     ##
     # Create a new PageCollection object.  The following options are available.
     # [:current_offset] The zero-based offset of the first record in the current page of results
-    # [:current_page]   The one-based offset of the current page of results
-    # [:total]          The total number of results across all pages
+    # [:current_page]   The one-based offset of the current page of results (alternative to :current_offset)
+    # [:total_records]  The total number of results across all pages
+    # [:total_pages]    The total number of pages (alternative to :total_records)
     # [:page_size]      The page size
     #
     # You can choose between :current_offset and :current_page based on your
@@ -17,7 +18,7 @@ module SimplePagination
     def initialize(options={})
       check_options(options)
       @pages, @page_size = {}, options[:page_size]
-      @length = options[:total_pages] || options[:total_records] / @page_size
+      @length = options[:total_pages] || (options[:total_records] / @page_size.to_f).ceil
       @current_page = options[:current_page] || (options[:current_offset]/@page_size)+1
     end
     
@@ -58,7 +59,7 @@ module SimplePagination
     def check_options(options)
       raise ArgumentError, "requires :current_offset or :current_page" unless options[:current_offset] || options[:current_page]
       raise ArgumentError, "requires :page_size" unless options[:page_size]
-      raise ArgumentError, "requires :total" unless options[:total_pages] or options[:total_records]
+      raise ArgumentError, "requires :total_pages or :total_records" unless options[:total_pages] or options[:total_records]
     end
     
     def out_of_bounds?(i)

data/test/simple_pagination/page_collection_test.rb

@@ -25,26 +25,40 @@ class PageCollectionTest < Test::Unit::TestCase
     end
   end
   
-  context "accessors" do
-    setup do
-      @collection = PageCollection.new(:total_pages => 10, :page_size => 10, :current_offset => 0)
-    end
-    
+  context "page_size" do
     should "provide page_size accessor" do
+      @collection = PageCollection.new(:total_pages => 10, :page_size => 10, :current_offset => 0)
       assert_equal 10, @collection.page_size
     end
-    
-    should "provide length accessor" do
-      assert_equal 10, @collection.length
+  end
+  
+  context "length" do
+    context "when given total_pages" do
+      should "be equal to total_pages" do
+        @collection = PageCollection.new(:total_pages => 10, :page_size => 10, :current_offset => 0)
+        assert_equal 10, @collection.length
+      end
     end
     
-    should "calculate length when given :total_records" do
-      c = PageCollection.new(:total_records => 113, :page_size => 3, :current_offset => 0)
-      assert_equal 37, c.length
+    context "when given total_records" do
+      should "be zero when total_records is zero" do
+        @collection = PageCollection.new(:total_records => 0, :page_size => 10, :current_offset => 0)
+        assert_equal 0, @collection.length
+      end
+
+      should "be one if total_records is less than page_size results" do
+        @collection = PageCollection.new(:total_records => 5, :page_size => 10, :current_offset => 0)
+        assert_equal 1, @collection.length
+      end
+
+      should "be ceil(total_records / page_size)" do
+        @collection = PageCollection.new(:total_records => 21, :page_size => 10, :current_offset => 0)
+        assert_equal 3, @collection.length
+      end
     end
   end
   
-  context "accessing a specific page" do
+  context "accessing a numbered page" do
     setup do
       @collection = PageCollection.new(:total_pages => 10, :page_size => 10, :current_page=>1)
     end
@@ -69,31 +83,50 @@ class PageCollectionTest < Test::Unit::TestCase
     end
   end
   
-  context "accessing named pages" do
-    setup do
-      @collection = PageCollection.new(:total_pages => 10, :page_size => 10, :current_page=>1)
+  context "current page" do
+    context "when given current_page" do
+      should "provide page with index == current_page" do
+        @collection = PageCollection.new(:total_pages => 10, :page_size => 10, :current_page => 3)
+        @collection.expects(:[]).with(3)
+        @collection.current
+      end
     end
     
-    should "access current page" do
-      (1..3).each do |i|
-        c = PageCollection.new(:total_pages => 10, :page_size => 10, :current_page=>i)
-        c.expects(:[]).with(i)
-        c.current
+    context "when given current_offset" do
+      should "provide page 1 if current_offset is zero" do
+        @collection = PageCollection.new(:total_pages => 10, :page_size => 10, :current_offset => 0)
+        @collection.expects(:[]).with(1)
+        @collection.current
+      end
+      
+      should "provide page with index == floor(current_offset / page_size) + 1" do
+        @collection = PageCollection.new(:total_pages => 10, :page_size => 10, :current_offset => 21)
+        @collection.expects(:[]).with(3)
+        @collection.current
       end
     end
-    
-    should "access first page" do
+  end
+  
+  context "first page" do
+    should "provide page 1" do
+      @collection = PageCollection.new(:total_pages => 10, :page_size => 10, :current_page => 5)
       @collection.expects(:[]).with(1)
       @collection.first
     end
+  end
+  
+  context "last page" do
+    # this is not an exhaustive test but I shouldn't need to make it so since
+    # the tests for length above do this...
     
-    should "access last page" do
+    should "provide page with index == length" do
+      @collection = PageCollection.new(:total_pages => 10, :page_size => 10, :current_page => 5)
       @collection.expects(:[]).with(10)
       @collection.last
       
-      c = PageCollection.new(:total_records => 113, :page_size => 3, :current_page => 1)
-      c.expects(:[]).with(37)
-      c.last
+      @collection = PageCollection.new(:total_records => 21, :page_size => 10, :current_offset => 0)
+      @collection.expects(:[]).with(3)
+      @collection.last
     end
   end
 end

data/test/simple_pagination/page_test.rb

@@ -19,7 +19,8 @@ class PageTest < Test::Unit::TestCase
     end
     
     should "provide accessor for first record offset" do
-      assert_equal 41, @page.offset
+      assert_equal 40, @page.offset
+      assert_equal 0, @collection[1].offset
     end
   end
   

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: taylorbarstow-simple_pagination
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors: 
 - Taylor Barstow