simply_paginate 0.0.2 → 0.0.3

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 1.9.2
+  - jruby-18mode
+  - jruby-19mode
+  - rbx-18mode
+  - rbx-19mode
+  - jruby-head
+  - 1.8.7
+  - ree

data/README.md

@@ -1,4 +1,5 @@
 # SimplyPaginate
+[![Build Status](https://travis-ci.org/guiman/simply_paginate.png)](https://travis-ci.org/guiman/simply_paginate)
 
 Simply paginate will do just that, give me a collection and you will be able to use a pagination logic (no extra html boilerplate or dependecies).
 
@@ -29,7 +30,7 @@ collection = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
 paginator = SimplyPaginate::Paginator.new(collection)
 
 # create pages with max of 3 elements
-paginator.paginate 3
+SimplyPaginate::Paginator.per_page 3
 
 # retrieve a certain page
 paginator[0]
@@ -45,11 +46,29 @@ paginator[0].next.next.next.previous.elements[0]
 paginator[0].next.next.next.previous.elements
 ```
 
+There is also the possibility to use a DataMapper::Collection as the collection to be paginated (right out of the box, not extensions needed):
+
+```ruby
+# I will guess you have a model called Post
+# By default Paginator.per_page is 10
+
+paginator = SimplyPaginate::Paginator.new(Post.all)
+
+paginator[0].elements # this will return a DataMapper::Collection with the first 10 elements
+```
+
 ## Currently working on:
 
 * Adding support for common ORMs like: ActiveRecord, Sequel and DataMapper.
 * Testing...
 
+## Alternative branch
+This branch contains a different implementation on the paging algorithm. This one creates pages on the fly and calculating offsets,
+so when you call ```previous``` or ```next``` or ```[]```page object representing is created on that moment, thus saving memory.
+
+Another modification is that the ```per_page``` value has moved up to the class, and there is no need on calling ```paginate``` anymore,
+also the ```pages``` has been dropped.
+
 ## Release 0.0.2 features:
 * Dropping the each_slice in order to use a more memory efficient index algorithm for paging.
 * Adding more tests to the page object.

data/Rakefile

@@ -1,6 +1,8 @@
 require 'bundler/gem_tasks'
 require 'rake/testtask'
 
+task :default => [:spec]
+
 Rake::TestTask.new :spec do |test|
   test.libs = ['lib', 'spec']
   test.verbose = true

data/lib/simply_paginate.rb

@@ -1,3 +1,4 @@
 require "simply_paginate/version"
 require "simply_paginate/paginator"
 require "simply_paginate/page"
+require "simply_paginate/not_in_range_error"

data/lib/simply_paginate/not_in_range_error.rb

@@ -0,0 +1,3 @@
+module SimplyPaginate
+  class NotInRangeError < StandardError; end
+end

data/lib/simply_paginate/page.rb

@@ -1,33 +1,29 @@
 module SimplyPaginate
   class Page
-    attr_reader :next_page, :previous_page
+    attr_reader :first, :last
 
     def initialize(first, last, paginator, previous_page = nil, next_page = nil)
       @first = first
       @last = last
       @paginator = paginator
-      @next_page = next_page
-      @previous_page = previous_page
-    end
-
-    def current
-      self
     end
 
     def next
-      @next_page
+      first = @last + 1
+      last = first + Paginator.per_page - 1
+
+      (first >= @paginator.collection.count) ? nil : @paginator.current = Page.new(first, last, @paginator)
     end
 
     def previous
-      @previous_page
-    end
+      first = @first - Paginator.per_page
+      last = @first - 1
 
-    def next=(v)
-      @next_page = v
+      (first < 0) ? nil : @paginator.current = Page.new(first, last, @paginator)
     end
 
-    def previous=(v)
-      @previous_page = v
+    def current?
+      !@paginator.current.nil? && @paginator.current.first == @first && @paginator.current.last == @last
     end
 
     def elements

data/lib/simply_paginate/paginator.rb

@@ -1,33 +1,34 @@
 module SimplyPaginate
   class Paginator
-    attr_reader :pages, :collection
+    attr_reader :collection
+    attr_accessor :current
 
-    def initialize(collection)
-      @collection = collection
-      @pages = []
-    end
+    def self.per_page=(amount_per_page)
+      raise NotInRangeError.new("Amount per page should be greater than 0") unless amount_per_page > 0
 
-    def paginate(limit)
-      @pages = []
-      first = last = 0
-      count = limit - 1
-      final_index = @collection.count - 1
+      @@per_page = amount_per_page
+    end
 
-      (@collection.count.to_f / limit.to_f).ceil.times do
-        last = (last <= final_index) ? first + count : final_index
+    def self.per_page
+      @@per_page
+    end
 
-        page = Page.new(first, last, self, @pages[@pages.count - 1])
-        @pages[@pages.count - 1].next = page unless @pages[@pages.count - 1].nil?
+    def initialize(collection)
+      @collection = collection
+      @current = nil
+    end
 
-        @pages << page
-        first = last + 1
-      end
+    def [](pos)
+      first = pos * @@per_page
+      last = first + @@per_page - 1
 
-      self
+      ((first < 0) || (first >= self.collection.count)) ? nil : Page.new(first, last, self)
     end
 
-    def [](pos)
-      @pages[pos]
+    def total_pages
+      (@collection.count.to_f / @@per_page.to_f).ceil
     end
+
+    Paginator.per_page = 10
   end
 end

data/lib/simply_paginate/version.rb

@@ -1,3 +1,3 @@
 module SimplyPaginate
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/simply_paginate.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["alvarola@gmail.com"]
   spec.description   = %q{This gem is a simple paginator for Enumerable collections}
   spec.summary       = %q{You enumerate it we will simply paginate it}
-  spec.homepage      = ""
+  spec.homepage      = "https://github.com/guiman/simply_paginate"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)

data/spec/page_spec.rb

@@ -2,10 +2,11 @@ require 'spec_helper'
 
 describe SimplyPaginate::Page do
   before do
-    @paginator = SimplyPaginate::Paginator.new([1, 2, 3, 4, 5, 6, 7, 8, 9, 10]).paginate 5
+    SimplyPaginate::Paginator.per_page = 5
+
+    @paginator = SimplyPaginate::Paginator.new([1, 2, 3, 4, 5, 6, 7, 8, 9, 10])
     @first_page = SimplyPaginate::Page.new(0, 4, @paginator)
-    @last_page = SimplyPaginate::Page.new(5, 9, @paginator, @first_page)
-    @first_page.next = @last_page
+    @last_page = SimplyPaginate::Page.new(5, 9, @paginator)
 
     class SimplyPaginate::Page
       def paginator
@@ -32,27 +33,42 @@ describe SimplyPaginate::Page do
 
   describe "when having next and previous pages" do
     before do
-      @paginator.paginate 2
+      SimplyPaginate::Paginator.per_page = 2
     end
 
     it "must be able to go back and foward" do
-      @paginator[1].next.must_equal @paginator[2]
-      @paginator[1].previous.must_equal @paginator[0]
+      @paginator[1].next.elements.must_equal @paginator[2].elements
+      @paginator[1].previous.elements.must_equal @paginator[0].elements
     end
   end
 
   describe "when having previous and no next" do
     it "must be able to go back " do
       @last_page.next.must_be_nil
-      @last_page.previous.must_equal @first_page
+      @last_page.previous.elements.must_equal @first_page.elements
     end
   end
 
   describe "when having next and no previous" do
     it "must be able to go back " do
-      @first_page.next.must_equal @last_page
+      @first_page.next.elements.must_equal @last_page.elements
       @first_page.previous.must_be_nil
     end
   end
 
+  describe "when moving to previous or next" do
+    it "must be setted as current when landed after next" do
+      @paginator[0].next
+      @paginator[0].current?.must_equal false
+      @paginator[1].current?.must_equal true
+    end
+
+    it "must be setted as current when landed after previous" do
+      @paginator[1].previous
+      @paginator[1].current?.must_equal false
+      @paginator[0].current?.must_equal true
+    end
+
+  end
+
 end

data/spec/paginator_spec.rb

@@ -1,37 +1,30 @@
 require 'spec_helper'
 
+
 describe SimplyPaginate::Paginator do
   before do
+    SimplyPaginate::Paginator.per_page = 3
     @paginator = SimplyPaginate::Paginator.new [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
   end
 
   describe 'before paginating' do
     it 'must be able to paginate' do
-      @paginator.paginate(3).pages.count.must_equal 4
-    end
-
-    it 'must not be able to retrieve a certain page' do
-      @paginator[0].must_be_nil
-    end
-
-    it 'must not be able to retrieve all pages' do
-      @paginator.pages.must_equal []
+      @paginator.total_pages.must_equal 4
     end
   end
 
   describe 'after paginating' do
     before do
-      @paginator.paginate(5)
+      SimplyPaginate::Paginator.per_page = 5
 
       @first_page = SimplyPaginate::Page.new(0, 4, @paginator)
-      @last_page = SimplyPaginate::Page.new(5, 9, @paginator, @first_page, nil)
-      @first_page.next = @last_page
+      @last_page = SimplyPaginate::Page.new(5, 9, @paginator)
 
       @pages = [@first_page, @last_page]
     end
 
     it 'must be able to paginate' do
-      @paginator.paginate(3).pages.count.must_equal 4
+      @paginator.total_pages.must_equal 2
     end
 
     it 'must be able to retrieve a certain page' do
@@ -41,7 +34,7 @@ describe SimplyPaginate::Paginator do
     end
 
     it 'must be able to retrieve all pages' do
-      @paginator.pages.count 2
+      @paginator.total_pages.must_equal 2
 
       #test first element
       @paginator[0].elements.must_equal @first_page.elements

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simply_paginate
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-23 00:00:00.000000000 Z
+date: 2013-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -67,11 +67,13 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/simply_paginate.rb
+- lib/simply_paginate/not_in_range_error.rb
 - lib/simply_paginate/page.rb
 - lib/simply_paginate/paginator.rb
 - lib/simply_paginate/version.rb
@@ -79,7 +81,7 @@ files:
 - spec/page_spec.rb
 - spec/paginator_spec.rb
 - spec/spec_helper.rb
-homepage: ''
+homepage: https://github.com/guiman/simply_paginate
 licenses:
 - MIT
 post_install_message: