simply_paginate 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in simply_paginate.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Álvaro Lara
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,60 @@
+# SimplyPaginate
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'simply_paginate'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simply_paginate
+
+## Motivation
+When dealing with pagination most known gems come bundled with lots of extra functionality I usually don't need (like html boilerplate), this is my attempt to create just the pagination logic, as simple as that.
+
+## Usage
+
+```ruby
+require 'simply_paginate'
+
+collection = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
+
+paginator = SimplyPaginate::Paginator.new(collection)
+
+# create pages with max of 5 elements
+paginator.paginate 3
+
+# retrieve a certain page
+paginator[0]
+
+#move through the pages freely
+paginator[0].next
+paginator[0].previous
+
+#you might want the first element on the 2nd page
+paginator[0].next.next.next.previous[0]
+
+#or maybe all of them
+paginator[0].next.next.next.previous.elements
+```
+
+## Currently working on:
+
+* Moving from a copy algorithm to a more performant pagination using offsets.
+* Adding support for common ORMs like: ActiveRecord, Sequel and DataMapper.
+* Testing...
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new :spec do |test|
+  test.libs = ['lib', 'spec']
+  test.verbose = true
+  test.test_files = FileList['spec/*_spec.rb']
+end

data/lib/simply_paginate.rb

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

data/lib/simply_paginate/page.rb

@@ -0,0 +1,39 @@
+module SimplyPaginate
+  class Page
+    attr_reader :next_page, :previous_page
+    
+    def initialize(collection, previous_page = nil, next_page = nil)
+      @collection = collection
+      @next_page = next_page
+      @previous_page = previous_page
+    end
+    
+    def [](pos)
+      @collection[pos]
+    end
+    
+    def current
+      self
+    end
+    
+    def next
+      @next_page
+    end
+    
+    def previous
+      @previous_page
+    end
+    
+    def next=(v)
+      @next_page = v
+    end
+    
+    def previous=(v)
+      @previous_page = v
+    end
+    
+    def elements
+      @collection
+    end
+  end
+end

data/lib/simply_paginate/paginator.rb

@@ -0,0 +1,28 @@
+module SimplyPaginate
+  class Paginator
+    attr_reader :pages
+    
+    def initialize(collection)
+      @collection = collection
+      @pages = []
+    end
+    
+    def paginate(limit)
+      @pages = []
+            
+      @collection.each_slice(limit) do |slice|
+        page = Page.new(slice, @pages[@pages.count - 1])
+        
+        @pages[@pages.count - 1].next = page unless @pages[@pages.count - 1].nil?
+        
+        @pages << page
+      end
+      
+      self
+    end
+    
+    def [](pos)
+      @pages[pos]
+    end
+  end
+end

data/lib/simply_paginate/version.rb

@@ -0,0 +1,3 @@
+module SimplyPaginate
+  VERSION = "0.0.1"
+end

data/simply_paginate.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'simply_paginate/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "simply_paginate"
+  spec.version       = SimplyPaginate::VERSION
+  spec.authors       = ["Álvaro F. Lara"]
+  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.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "rake"
+end

data/spec/page_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe SimplyPaginate::Page do
+
+end

data/spec/paginator_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+describe SimplyPaginate::Paginator do
+  before do
+    @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 []
+    end
+  end
+  
+  describe 'after paginating' do
+    before do
+      @paginator.paginate(5)
+      
+      @first_page = SimplyPaginate::Page.new([1, 2, 3, 4, 5], nil)
+      @last_page = SimplyPaginate::Page.new([6, 7, 8, 9, 10], @first_page, nil)
+      @first_page.next = @last_page
+      
+      @pages = [@first_page, @last_page]
+    end
+    
+    it 'must be able to paginate' do
+      @paginator.paginate(3).pages.count.must_equal 4
+    end
+    
+    it 'must be able to retrieve a certain page' do
+      @paginator[0].elements.must_equal @first_page.elements
+      @paginator[0].previous.must_be_nil
+      @paginator[0].next.wont_be_nil
+    end
+    
+    it 'must be able to retrieve all pages' do
+      @paginator.pages.count 2 
+      
+      #test first element
+      @paginator[0].elements.must_equal @first_page.elements
+      @paginator[0].previous.must_be_nil
+      @paginator[0].next.wont_be_nil
+      
+      #test second element
+      @paginator[1].elements.must_equal @last_page.elements
+      @paginator[1].previous.wont_be_nil
+      @paginator[1].next.must_be_nil
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'bundler'
+require 'minitest/autorun'
+Bundler.require

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: simply_paginate
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Álvaro F. Lara
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This gem is a simple paginator for Enumerable collections
+email:
+- alvarola@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/simply_paginate.rb
+- lib/simply_paginate/page.rb
+- lib/simply_paginate/paginator.rb
+- lib/simply_paginate/version.rb
+- simply_paginate.gemspec
+- spec/page_spec.rb
+- spec/paginator_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: You enumerate it we will simply paginate it
+test_files:
+- spec/page_spec.rb
+- spec/paginator_spec.rb
+- spec/spec_helper.rb
+has_rdoc: