page_number 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cbab3c028875b91910a0ca596802913cc1a50a5d
+  data.tar.gz: 22b82f9fca433a2369accea679b851180e1d7b8c
+SHA512:
+  metadata.gz: 5fefd1bde3f7a784d8028be219c644a55c96d45cabbddbf388715244cdcb5ee3566ebc0e7dedaf9ecf6df01f49a423162e40a3fdda0ae6563c802905a8905850
+  data.tar.gz: cd86702614121abd2b7699ce882e259e703f41aad885891c8ba3cc7ac964724055cd08ab793c9c8b24470bb7b3f0ef239ffa51575ef0bdd4ed235dbadd7ea7d9

data/README.md

@@ -0,0 +1,64 @@
+# PageNumber
+
+[![Build Status](https://travis-ci.org/sshaw/page_number.svg?branch=master)](https://travis-ci.org/sshaw/page_number)
+
+Utility methods for pagination page and per page that make sure you'll
+always have a valid number.
+
+Use them your controllers (recommended) or model or anywhere where you process page
+info.
+
+## Usage
+
+`PageNumber` provides two methods:
+
+* `page(n)`/`__page__(n)`
+* `per_page(n)`/`__per_page__(n)` (defaults to `10`)
+
+To use, `include` or `extend` the `PageNumber` module:
+
+```rb
+require "page_number"
+
+class BaseController
+  include PageNumber
+end
+
+class SubController < BaseController
+  def index
+    User.all(:page => page(params[:page]), :per_page => per_page(params[:per_page]))
+  end
+end
+
+```
+
+To have better control over how `page` and `per_page` work you can
+define one or more of the following methods:
+
+```rb
+class BaseController
+  include PageNumber
+
+  # These are all optional
+  protected
+
+  def page_sizes
+    [ 25, 50, 100 ]
+  end
+
+  def default_per_page
+    20
+  end
+
+  def max_page_number
+    # who knows!?
+  end
+```
+
+## Author
+
+Skye Shaw [skye.shaw AT gmail.com]
+
+## License
+
+Released under the MIT License: http://www.opensource.org/licenses/MIT

data/lib/page_number.rb

@@ -0,0 +1,71 @@
+# === Usage
+#
+# require "page_number"
+#
+# class BaseController
+#   include PageNumber
+#
+#   protected
+#
+#   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
+#
+
+module PageNumber
+  VERSION = "0.1.0".freeze
+
+  def page(n)
+    n = __int(n)
+    return default_page if n < 1
+
+    max_page_number && n > max_page_number ? max_page_number : n
+  end
+
+  alias :__page__ :page
+
+  def per_page(n)
+    n = __int(n)
+    return default_per_page if n < 1
+
+    page_sizes && !page_sizes.include?(n) ? default_per_page : n
+  end
+
+  alias :__per_page__ :per_page
+
+  protected
+
+  def default_per_page
+    10
+  end
+
+  def default_page
+    1
+  end
+
+  def max_page_number
+  end
+
+  def page_sizes
+  end
+
+  private
+
+  def __int(n)
+    case
+    when n.respond_to?(:to_i)
+      n.to_i
+    when n.respond_to?(:to_int)
+      n.to_int
+    else
+      -1
+    end
+  end
+end

data/test/test_page_number.rb

@@ -0,0 +1,98 @@
+require "minitest/autorun"
+require "page_number"
+
+class TestPageNumber < MiniTest::Test
+  def setup
+    @p = Object.new
+    @p.extend PageNumber
+  end
+
+  def test_page_invalid_arg_returns_default_page
+    [-1, 0, {}].each { |n| assert_equal 1, @p.page(n) }
+
+    def @p.default_page
+      100
+    end
+
+    assert_equal 100, @p.page(-1)
+  end
+
+  def test_page_valid_arg_returns_arg
+    [1, 100, 500].each { |n| assert_equal n, @p.page(n) }
+  end
+
+  def test_page_converts_arg_to_fixnum
+    assert_equal 2, @p.page("2")
+
+    o = Object.new
+    def o.to_i
+      2
+    end
+
+    assert_equal 2, @p.page(o)
+
+    o = Object.new
+    def o.to_int
+      2
+    end
+
+    assert_equal 2, @p.page(o)
+  end
+
+  def test_page_limits_arg_to_max_page_number
+    # No max by default
+    assert_equal 1_000, @p.page(1_000)
+
+    def @p.max_page_number
+      999
+    end
+
+    assert_equal 999, @p.page(1_000)
+  end
+
+  def test_per_page_invalid_arg_returns_default
+    [-1, 0, {}].each { |n| assert_equal 10, @p.per_page(n) }
+
+    def @p.default_per_page
+      100
+    end
+
+    assert_equal 100, @p.per_page(-1)
+  end
+
+  def test_per_page_valid_arg_returns_arg
+    assert_equal 2, @p.per_page(2)
+  end
+
+  def test_per_page_converts_arg_to_fixnum
+    assert_equal 2, @p.per_page("2")
+
+    o = Object.new
+    def o.to_i
+      2
+    end
+
+    assert_equal 2, @p.per_page(o)
+
+    o = Object.new
+    def o.to_int
+      2
+    end
+
+    assert_equal 2, @p.per_page(o)
+  end
+
+  def test_per_page_enforces_defined_page_sizes
+    def @p.page_sizes
+      [3, 8]
+    end
+
+    def @p.default_per_page
+      5
+    end
+
+    assert_equal 3, @p.per_page(3)
+    assert_equal 8, @p.per_page(8)
+    assert_equal 5, @p.per_page(100)
+  end
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: page_number
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Skye Shaw
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-03-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: |2
+       Utility methods for pagination page and per page that make sure you'll always have a valid number.
+       Use them your controllers or model or anywhere where you process page info.
+email: skye.shaw@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- README.md
+- lib/page_number.rb
+- test/test_page_number.rb
+homepage: https://github.com/sshaw/page_number
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Utility methods for pagination page and per page that make sure you'll always
+  have a valid number.
+test_files:
+- test/test_page_number.rb