paginate-simple 0.1.0 → 0.1.1

data/README.rdoc

@@ -1,6 +1,77 @@
 = paginate-simple
+The idea for building this gem came up when i was looking for a way to paginate my posts
+in a simple sinatra blog that i was building. I needed some kind of pagination that was 
+not coupled with any of the existing ORM's.
+The abstraction of a paginator should be simple.
 
-Description goes here.
+It should be able to paginate some collection of data by providing a 
+1. total number of items
+2. the page
+3. and number of items per page
+
+It should be able to answer on the following
+1. How many items should i skip (offset)
+2. How many items should i get (per_page)
+3. Is there a next page and if there is give me the next page.
+4. Is there a previous page and if there is give me the previous page.
+5. It should be able to give you the first page and the last page.
+6. It should be able to provide you a way to iterate over the existing pages.
+
+In the previous version of the gem i have created a PaginateSimple module to work as a
+singleton but in this version since it should be a pagination logic i have changed that 
+behavior in order to provide a way to extend and change the functionality of the module
+and its usage.
+
+Usage:
+In order to create a singleton pagination object we need to create a class Paginator that
+will extend this module and change some of its built in logic like this:
+class Paginator
+  extend PaginateSimple
+  
+  def self.current_page(page)
+    super page.to_i # allow strings to be passed like "1" as well
+  end
+end
+
+If we need to have more than one Paginator we will include the module instead and
+then instantiate the object as needed. 
+class Paginator
+  include PaginateSimple
+  
+  def current_page(page)
+    super page.to_i # allow strings to be passed like "1" as well
+  end
+end
+
+@paginator = Paginator.new
+@paginator.config :total => 100 , :page => 1, :per_page => 10
+
+@another_paginator = Paginator.new 
+@another_paginator.config :total => 100 , :page => 1, :per_page => 3
+
+By default no helper for the paginator exists. But to write one is quite simple.
+Here is the example of a paginator helper that i use in my blog.
+
+require 'sinatra/base'
+
+module Sinatra
+  module PaginationHelper
+    def paginate(resource)
+      data = []
+      data << '<div class="pagination">'
+        data << "<a href =\"/#{resource}/?page=#{Paginator.previous_page}\">Prev</a>" if Paginator.has_previous_page?
+        data << ' | ' if Paginator.has_previous_page? and Paginator.has_next_page?
+        data << "<a href =\"/#{resource}/?page=#{Paginator.next_page}\">Next</a>" if Paginator.has_next_page?
+      data << '</div>'
+      data.join(' ')
+    end
+  end
+  
+  helpers PaginationHelper
+end
+
+and i use it like this in my haml file
+= paginate 'posts'
 
 == Contributing to paginate-simple
  

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/lib/paginate-simple.rb

@@ -1,5 +1,4 @@
 module PaginateSimple
-  class << self 
     attr_accessor :current_page, :total, :per_page
   
     def config(args = {})
@@ -54,6 +53,5 @@ module PaginateSimple
       raise ArgumentError if total_results < 0
       @total = total_results
     end
-  
-  end
+
 end

data/paginate-simple.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{paginate-simple}
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["filip"]

data/test/paginate_simple.spec

@@ -1,80 +1,84 @@
 require './helper'
 
+class Paginator
+  extend PaginateSimple
+end
+
 describe PaginateSimple do
   before do
-    PaginateSimple.config :total => 100 , :page => 1, :per_page => 10
+    Paginator.config :total => 100 , :page => 1, :per_page => 10
   end
   
   it "should be configured properly" do
-    PaginateSimple.total.should eql(100)
-    PaginateSimple.current_page.should eql(1)
-    PaginateSimple.per_page.should eql(10)
+    Paginator.total.should eql(100)
+    Paginator.current_page.should eql(1)
+    Paginator.per_page.should eql(10)
   end
 
   it "should provide the correct number of pages" do
-    PaginateSimple.num_of_pages.should eql(10)
+    Paginator.num_of_pages.should eql(10)
   end
   
   it "should answer to has_next_page? correctly" do
-    PaginateSimple.should have_next_page
-    PaginateSimple.current_page = 10
-    PaginateSimple.should_not have_next_page
+    Paginator.should have_next_page
+    Paginator.current_page = 10
+    Paginator.should_not have_next_page
   end
   
   it "should answer to has_previous_page? correctly" do
-    PaginateSimple.should_not have_previous_page
-    PaginateSimple.current_page = 2
-    PaginateSimple.should have_next_page
+    Paginator.should_not have_previous_page
+    Paginator.current_page = 2
+    Paginator.should have_next_page
   end
   
   it "should return pages as iterator" do
-    PaginateSimple.pages.should respond_to(:each)
-    PaginateSimple.current_page = 1
-    PaginateSimple.total = 0
-    PaginateSimple.pages.should respond_to(:each)
+    Paginator.pages.should respond_to(:each)
+    Paginator.current_page = 1
+    Paginator.total = 0
+    Paginator.pages.should respond_to(:each)
   end
   
   it "should return correct num of pages" do
-    PaginateSimple.per_page = 3
-    PaginateSimple.total = 10
-    PaginateSimple.should have(4).pages
+    Paginator.per_page = 3
+    Paginator.total = 10
+    Paginator.should have(4).pages
     
-    PaginateSimple.current_page = 1
-    PaginateSimple.total = 0
-    PaginateSimple.should have(0).pages
+    Paginator.current_page = 1
+    Paginator.total = 0
+    Paginator.should have(0).pages
   end
   
   it "should provide offset" do
-    PaginateSimple.current_page = 2
-    PaginateSimple.offset.should eql(10)
+    Paginator.current_page = 2
+    Paginator.offset.should eql(10)
   end
   
   it "should return next page or nil otherwise" do
-    PaginateSimple.current_page = 4
-    PaginateSimple.should have_next_page
-    PaginateSimple.next_page.should  eql(5)
+    Paginator.current_page = 4
+    Paginator.should have_next_page
+    Paginator.next_page.should  eql(5)
     
-    PaginateSimple.current_page = 10
-    PaginateSimple.should_not have_next_page
-    PaginateSimple.next_page.should be_nil
+    Paginator.current_page = 10
+    Paginator.should_not have_next_page
+    Paginator.next_page.should be_nil
   end
   
   it "should return previous page or nil otherwise" do
-    PaginateSimple.current_page = 2
-    PaginateSimple.should have_previous_page
-    PaginateSimple.previous_page.should eql(1)
+    Paginator.current_page = 2
+    Paginator.should have_previous_page
+    Paginator.previous_page.should eql(1)
     
-    PaginateSimple.current_page = 1
-    PaginateSimple.should_not have_previous_page
-    PaginateSimple.previous_page.should be_nil
+    Paginator.current_page = 1
+    Paginator.should_not have_previous_page
+    Paginator.previous_page.should be_nil
   end
   
   it "should raise ArgumentError on negative current_page" do
-    lambda { PaginateSimple.current_page = -1 }.should raise_error(ArgumentError)
+    lambda { Paginator.current_page = -1 }.should raise_error(ArgumentError)
   end
   
   it "should raise ArgumentError on negative total" do
-    lambda { PaginateSimple.total = -1 }.should raise_error(ArgumentError)
+    lambda { Paginator.total = -1 }.should raise_error(ArgumentError)
   end
 
 end

metadata

@@ -2,7 +2,7 @@
 name: paginate-simple
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - filip
@@ -103,7 +103,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -1273603786278675498
+      hash: -3688072682752233478
       segments: 
       - 0
       version: "0"