page_up 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c5ad4acae0705e1d734bd9cdddcb60e282a29f91
-  data.tar.gz: 26f1187a297d1a4d79e2fc2872e901934d6c1dfc
+  metadata.gz: f7345295fb84db01754653b39976ffaee5765a95
+  data.tar.gz: f783bdec5654e1c50d0825d1dfe69e7460ef7e4b
 SHA512:
-  metadata.gz: 928945d37265bd686037eab1a417ffdd28b79e31af7b6a03544441dc2d4cc7114c703cf570185c6526d8f77ff2cc912e234667dcdd29c0c2409d0175d17d968c
-  data.tar.gz: e84c3c0e80972f7bed16b7691b96c98725146ea5a9f2bd56b95c4e1c39f5be523a726965b1c6af9f3876d87dbe23ace1bab97fab2ea3a4ae3dc4dd683374e67a
+  metadata.gz: a07d4689de5c566761b81fd6b4131b7df3a9a4becf56403e7459f40176a84c35706beb5179e3c9688ba6bbacc78e8e2cdc6ce77def280f95896bbd7c452be02e
+  data.tar.gz: 473bf60755ba27ec468ce343e3f798725f89146a862139947fe347348f8661c5448d1749809d9a04c734202a61d541d2a8f9f0fc571ea3a1bb3793cfd55e4314

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 1.9.3
+  - 1.9.2
+  - jruby-19mode
+  - rbx-19mode
+matrix:
+  allow_failures:
+    - ruby-head

data/README.md

@@ -1,6 +1,49 @@
 # PageUp
 
-TODO: Write a gem description
+PageUp is a simple pagination gem, the idea being to use composition and
+decoration of objects (rather than mixing into ActiveRecord) to divy up a
+collection for pagination. This allows use with data sources other than ActiveRecord.
+
+## Usage
+
+To create a paginated collection use the `PageUp[]` macro.
+
+`page_up_pages = PageUp[ collection, page_number, number_per_page ]`
+
+In addition to delegating all the original collection methods back to the
+underling object, a page up collection allows:
+
+Access to the total number of pages with `pages`
+
+`page_up_pages.pages => 3`
+
+Access to the supplied page number with `page` (defaults to 1)
+
+`page_up_pages.page => 2`
+
+Access to the supplied per page count with `per_page` (defaults to 25)
+
+`page_up_pages.per_page => 25`
+
+And provides a range indicating the current section of pages, this is intended
+for integration with output views to indicate nearby page bookmarks and as
+such returns the previous two and next two pages, but is bounded so that at the
+start or end of a collection always returns 5... e.g:
+
+```
+# page 2
+page_up_pages.current_slice => 1..5 
+
+# page 7
+page_up_pages.current_slice => 5..9 
+
+# page n-2
+page_up_pages.current_slice => n-5..n 
+```
+
+## ToDo
+
+Extract helpers for integration with Rails and ORM libraries.
 
 ## Installation
 
@@ -16,10 +59,6 @@ Or install it yourself as:
 
     $ gem install page_up
 
-## Usage
-
-TODO: Write usage instructions here
-
 ## Contributing
 
 1. Fork it

data/Rakefile

@@ -1 +1,12 @@
+#!/usr/bin/env rake
 require "bundler/gem_tasks"
+
+require 'rspec'
+require 'rspec/core/rake_task'
+
+desc "Run specs"
+RSpec::Core::RakeTask.new :spec do |task|
+  task.pattern = 'spec/**/*_spec.rb'
+end
+
+task default: :spec

data/lib/page_up/version.rb

@@ -1,3 +1,3 @@
 module PageUp
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/page_up.gemspec

@@ -6,7 +6,7 @@ require 'page_up/version'
 Gem::Specification.new do |spec|
   spec.name          = "page_up"
   spec.version       = PageUp::VERSION
-  spec.required_ruby_version = ">= 1.9.3"
+  spec.required_ruby_version = ">= 1.9.2"
   spec.authors       = ["Jon Rowe"]
   spec.email         = ["hello@jonrowe.co.uk"]
   spec.description   = %q{Simple paginator}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: page_up
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Jon Rowe
@@ -29,7 +29,7 @@ cert_chain:
   2feWfO4gCNmvfFjULOAYHq9JHEjN5SLSXvj5HdSnDcCyIfJKn5Ya3JahWQaWIsXf
   /NPE/mB57TOwj+d7XUa2NC4HUadF8R51IYEcIB0PpIEzJlKtfXFcOZxO
   -----END CERTIFICATE-----
-date: 2013-07-01 00:00:00.000000000 Z
+date: 2013-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -81,6 +81,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -102,7 +103,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - '>='
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - '>='