page_number 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cbab3c028875b91910a0ca596802913cc1a50a5d
-  data.tar.gz: 22b82f9fca433a2369accea679b851180e1d7b8c
+  metadata.gz: 712172dd03a791a91e3194afd2c19eb460706fb9
+  data.tar.gz: f699670034fe3b8b841a0fb81eb879d212f6d233
 SHA512:
-  metadata.gz: 5fefd1bde3f7a784d8028be219c644a55c96d45cabbddbf388715244cdcb5ee3566ebc0e7dedaf9ecf6df01f49a423162e40a3fdda0ae6563c802905a8905850
-  data.tar.gz: cd86702614121abd2b7699ce882e259e703f41aad885891c8ba3cc7ac964724055cd08ab793c9c8b24470bb7b3f0ef239ffa51575ef0bdd4ed235dbadd7ea7d9
+  metadata.gz: 62d30c68bea957aca09b7923dbd257e0d90685a04dd750622d0406fd60b512a67a473508339394913a5597f71f5d92fcdbd8c5795ce4d914102802c8804ed02a
+  data.tar.gz: cded76c0227c21f63f66295d1bbfe9c3fb371dfe39877f26fc613a36c0a0d06001a8c29c6ee5cd026ff4cf7c9339ee6e3710cdcf6943fd0e0d2c5fdd1801f65b

data/README.md

@@ -10,9 +10,10 @@ info.
 
 ## Usage
 
-`PageNumber` provides two methods:
+`PageNumber` provides 3 methods:
 
-* `page(n)`/`__page__(n)`
+* `page(n)`/`__page__(n)` (defaults to `1`)
+* `page!(n)`/`__page__!(n)` (raises `PageNumber::PageInvalid` instead of returning default)
 * `per_page(n)`/`__per_page__(n)` (defaults to `10`)
 
 To use, `include` or `extend` the `PageNumber` module:
@@ -50,6 +51,10 @@ class BaseController
     20
   end
 
+  def default_page
+    2
+  end
+
   def max_page_number
     # who knows!?
   end

data/lib/page_number.rb

@@ -1,26 +1,45 @@
 # === Usage
 #
-# require "page_number"
+#  require "page_number"
 #
-# class BaseController
-#   include PageNumber
+#  class BaseController
+#    include PageNumber
 #
-#   protected
+#    protected
 #
-#   def page_sizes
-#     [ 25, 50, 100 ]
-#   end
-# end
+#    def page_sizes
+#      [ 25, 50, 100 ]
+#    end
+#  end
 #
-# class SubController < BaseController
-#   def action
-#     User.all(:page => page(params[:page]), :per_page => per_page(params[:per_page]))
-#   end
-# end
+#  class SubController < BaseController
+#    def action
+#      User.all(:page => page(params[:page]), :per_page => per_page(params[:per_page]))
+#    end
+#  end
 #
 
 module PageNumber
-  VERSION = "0.1.0".freeze
+  VERSION = "0.2.0".freeze
+
+  class PageInvalid < StandardError
+    attr_reader :page
+
+    def initialize(message, page)
+      super message
+      @page = page
+    end
+  end
+
+  def page!(page)
+    n = __int(page)
+    raise PageInvalid.new("page must be > 0", page) if n < 1
+    raise PageInvalid.new("page must be <= #{max_page_number}", page) if max_page_number && n > max_page_number
+
+    n
+  end
+
+  alias :__page__! :page!
 
   def page(n)
     n = __int(n)

data/test/test_page_number.rb

@@ -39,6 +39,34 @@ class TestPageNumber < MiniTest::Test
     assert_equal 2, @p.page(o)
   end
 
+  def test_page_exception_invalid_arg_raises_exception
+    [-1, 0, {}].each do |n|
+      ex = assert_raises PageNumber::PageInvalid do
+        @p.page!(n)
+      end
+
+      assert_equal n, ex.page
+    end
+
+    def @p.max_page_number
+      10
+    end
+
+    ex = assert_raises PageNumber::PageInvalid do
+      @p.page!(11)
+    end
+
+    assert_equal 11, ex.page
+  end
+
+  def test_page_exception_valid_arg_does_not_raise_exception
+    [1, 100, 500].each { |n| assert_equal n, @p.page!(n) }
+  end
+
+  def test_page_exception_converts_arg_to_fixnum
+    assert_equal 2, @p.page("2")
+  end
+
   def test_page_limits_arg_to_max_page_number
     # No max by default
     assert_equal 1_000, @p.page(1_000)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: page_number
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Skye Shaw
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-17 00:00:00.000000000 Z
+date: 2019-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -70,7 +70,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Utility methods for pagination page and per page that make sure you'll always