neat-pages 0.0.1

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in neat-pages.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2012 De Marque inc.
+
+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,31 @@
+Neat Pages [![Build Status](https://secure.travis-ci.org/demarque/neat-pages.png?branch=master)](http://travis-ci.org/demarque/neat-pages)
+===============
+
+A simple pagination API to paginate Mongoid Models or any other stuff...
+
+Install
+-------
+
+```
+gem install neat-pages
+```
+
+Rails 3
+-------
+
+In your Gemfile:
+
+```ruby
+gem 'neat-pages'
+```
+
+Usage
+-----
+
+COMING SOON
+
+
+Copyright
+---------
+
+Copyright (c) 2012 De Marque inc. See LICENSE for further details.

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler"
+require "rspec/core/rake_task"
+
+Bundler::GemHelper.install_tasks
+
+desc "Run all specs in spec directory"
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = "spec/**/*_spec.rb"
+end
+
+task :default => :spec

data/lib/neat-pages.rb

@@ -0,0 +1,8 @@
+module NeatPages
+
+end
+
+require 'neat_pages/base'
+require 'neat_pages/helpers'
+require 'neat_pages/errors'
+require 'neat_pages/implants'

data/lib/neat_pages/base.rb

@@ -0,0 +1,117 @@
+module NeatPages
+  #*************************************************************************************
+  # TOCOMMENT
+  #*************************************************************************************
+  class Base
+    attr_accessor :per_page
+    attr_reader :current_page
+    attr_reader :total_items
+
+    #*************************************************************************************
+    # CONSTRUCTOR
+    #*************************************************************************************
+    def initialize(current_page, options={})
+      options = { :per_page => 10, :total_items => 0 }.merge(options)
+
+      @per_page = options[:per_page].to_i
+      @total_items = options[:total_items]
+
+      @current_page = init_current_page(current_page)
+
+      @out_of_bound = init_out_of_bound
+    end
+
+
+    #*************************************************************************************
+    # PUBLIC INSTANCE METHODS
+    #*************************************************************************************
+    def activate_helpers(base_url='', params={})
+      @helpers = NeatPages::Helpers.new(self, base_url, params)
+    end
+
+    def empty?
+      @total_items == 0
+    end
+
+    def helpers
+      if @helpers
+        @helpers
+      else
+        raise 'You must activate the helpers by calling "activate_helpers".'
+      end
+    end
+
+    alias_method :h, :helpers
+
+    def limit
+      @per_page
+    end
+
+    def next_page
+      next? ? (@current_page + 1) : total_pages
+    end
+
+    def next?
+      @current_page < total_pages and not out_of_bound?
+    end
+
+    def offset
+      if out_of_bound?
+        total_items + 1
+      else
+        (@current_page - 1) * @per_page
+      end
+    end
+
+    def out_of_bound?
+      @out_of_bound
+    end
+
+    def paginated?
+      @total_items > @per_page
+    end
+
+    def previous_page
+      previous? ? (@current_page - 1) : 1
+    end
+
+    def previous?
+      @current_page > 1 and not out_of_bound?
+    end
+
+    def response_headers
+      {
+        "X-Total-Items" => @total_items.to_s,
+        "X-Total-Pages" => total_pages.to_s,
+        "X-Per-Page" => @per_page.to_s,
+        "X-Current-Page" => @current_page.to_s
+      }
+    end
+
+    def set_total_items(qte)
+      @total_items = qte
+      @out_of_bound = init_out_of_bound
+    end
+
+    def total_pages
+      total = (@total_items.to_f / @per_page).ceil
+      total != 0 ? total : 1
+    end
+
+    private
+
+    #*************************************************************************************
+    # PRIVATE INSTANCE METHODS
+    #*************************************************************************************
+    def init_current_page(current_page)
+      current_page = current_page.to_i
+      current_page = 1 if current_page == 0
+
+      return current_page
+    end
+
+    def init_out_of_bound
+      @current_page <= 0 or @current_page > total_pages
+    end
+  end
+end

data/lib/neat_pages/errors.rb

@@ -0,0 +1,4 @@
+module NeatPages
+  class OutOfBound < StandardError
+  end
+end

data/lib/neat_pages/helpers.rb

@@ -0,0 +1,75 @@
+# encoding : utf-8
+module NeatPages
+  #*************************************************************************************
+  # TOCOMMENT
+  #*************************************************************************************
+  class Helpers
+    #*************************************************************************************
+    # CONSTRUCTOR
+    #*************************************************************************************
+    def initialize(pagination, base_url, params)
+      @pagination = pagination
+      @base_url = base_url
+      @params = params
+    end
+
+
+    #*************************************************************************************
+    # PUBLIC INSTANCE METHODS
+    #*************************************************************************************
+    def navigation
+      if paginated?
+        content = ''
+        content << navigation_link('previous') if previous?
+        content << navigation_link('next') if next?
+
+        return "<div class=\"pagination\">#{content.html_safe}</div>".html_safe
+      else
+        return ''
+      end
+    end
+
+    def status
+      return '' if empty? or out_of_bound?
+
+      from = offset
+      to = from + per_page
+      to = total_items if to > total_items
+
+      return "#{from+1} #{t('to')} #{to}/#{total_items}"
+    end
+
+    private
+
+    #*************************************************************************************
+    # PRIVATE INSTANCE METHODS
+    #*************************************************************************************
+    def navigation_link(direction)
+      label_str = direction == 'next' ? "#{t('page_next')} »" : "« #{t('page_previous')}"
+
+      link_url = path_to(send("#{direction}_page"))
+
+      return "<a href=\"#{link_url}\" class=\"#{direction}\">#{label_str}</a>".html_safe
+    end
+
+    def path_to(page)
+      qs = ["page=#{page}"]
+
+      @params.each { |k,v| qs << "#{k}=#{v}" if k != 'page' }
+
+      return @base_url + '?' + qs.join("&")
+    end
+
+    def t(text_path)
+      (defined? I18n) ? I18n.t("neat_pages.#{text_path}") : text_path
+    end
+
+    def method_missing(*args, &block)
+      if @pagination.respond_to? args.first
+        return @pagination.send *args, &block
+      else
+        raise NoMethodError.new("undefined local variable or method '#{args.first}' for #{self.class}")
+      end
+    end
+  end
+end

data/lib/neat_pages/implants.rb

@@ -0,0 +1,12 @@
+module NeatPages
+  module Implants
+  end
+end
+
+if defined? Rails::Railtie
+  require 'neat_pages/implants/railtie'
+elsif defined? Rails::Initializer
+  raise "neat-pages is not compatible with Rails 2.3 or older"
+end
+
+require 'neat_pages/implants/mongoid_implant'

data/lib/neat_pages/implants/action_controller_implant.rb

@@ -0,0 +1,36 @@
+module NeatPages::Implants::ActionControllerImplant
+  extend ActiveSupport::Concern
+
+  included do
+    append_after_filter :set_pagination_header
+    helper_method :pagination, :pagination_helpers
+    rescue_from NeatPages::OutOfBound, :with => :render_out_of_bound
+  end
+
+  def paginate(options={})
+    options.reverse_merge!(:per_page => 20)
+
+    base_current_url = request.protocol + request.host + request.path_info
+
+    neat_pages = NeatPages::Base.new(params[:page], options)
+    neat_pages.activate_helpers(base_current_url, request.env['rack.request.query_hash'])
+
+    @_env['neat_pages'] = neat_pages
+  end
+
+  def pagination
+    @_env['neat_pages']
+  end
+
+  def pagination_helpers
+    pagination.helpers
+  end
+
+  def render_out_of_bound
+    render :text => "out_of_bound", :status => 404
+  end
+
+  def set_pagination_header
+    response.headers.merge! pagination.response_headers if pagination
+  end
+end

data/lib/neat_pages/implants/mongoid_implant.rb

@@ -0,0 +1,17 @@
+module NeatPages::Implants
+  module MongoidCriteriaImplant
+    def paginate(current)
+      if current
+        current.set_total_items self.count
+
+        raise NeatPages::OutOfBound if current.out_of_bound?
+
+        return self.offset(current.offset).limit(current.limit)
+      else
+        raise 'You need to initialize the pagination'
+      end
+    end
+  end
+end
+
+Mongoid::Criteria.send :include, NeatPages::Implants::MongoidCriteriaImplant if defined? Mongoid

data/lib/neat_pages/implants/railtie.rb

@@ -0,0 +1,13 @@
+require 'neat_pages/implants/action_controller_implant'
+
+module NeatPages::Implants
+  class Railtie < Rails::Railtie
+    initializer "neat_pages" do |app|
+
+      ActiveSupport.on_load :action_controller do
+        include NeatPages::Implants::ActionControllerImplant
+      end
+
+    end
+  end
+end

data/spec/neat-pages_spec.rb

@@ -0,0 +1,4 @@
+require 'spec_helper'
+
+describe NeatPages do
+end

data/spec/neat_pages/base_spec.rb

@@ -0,0 +1,124 @@
+require 'spec_helper'
+
+describe NeatPages::Base do
+  #*************************************************************************************
+  # PUBLIC INSTANCE METHODS
+  #*************************************************************************************
+  describe "#empty?" do
+    context "with a 20 items pagination" do
+      specify { NeatPages::Base.new(0, :total_items => 20).should_not be_empty }
+    end
+
+    context "with a 0 item pagination" do
+      specify { NeatPages::Base.new(0).should be_empty }
+    end
+  end
+
+  describe "#next_page" do
+    context "with a 100 items pagination starting at 0 and having 10 items per page" do
+      specify { NeatPages::Base.new(0, :per_page => 10, :total_items => 100).next_page.should eql 2 }
+    end
+
+    context "with a 100 items pagination starting at page 3 and having 15 items per page" do
+      specify { NeatPages::Base.new(3, :per_page => 15, :total_items => 100).next_page.should eql 4 }
+    end
+
+    context "with a 5 items pagination starting at 0 and having 10 items per page" do
+      specify { NeatPages::Base.new(0, :per_page => 10, :total_items => 5).next_page.should eql 1 }
+    end
+  end
+
+  describe "#next?" do
+    context "with a 100 items pagination starting at 0 and having 10 items per page" do
+      specify { NeatPages::Base.new(0, :per_page => 10, :total_items => 100).should be_next }
+    end
+
+    context "with a 5 items pagination starting at 0 and having 10 items per page" do
+      specify { NeatPages::Base.new(0, :per_page => 10, :total_items => 5).should_not be_next }
+    end
+  end
+
+  describe "#offset" do
+    context "with a 100 items pagination starting at page 1 and having 10 items per page" do
+      specify { NeatPages::Base.new(1, :per_page => 10, :total_items => 100).offset.should eql 0 }
+    end
+
+    context "with a 100 items pagination starting at page 4 and having 15 items per page" do
+      specify { NeatPages::Base.new(4, :per_page => 15, :total_items => 100).offset.should eql 45 }
+    end
+
+    context "with a 100 items pagination starting at page 999 and having 15 items per page" do
+      specify { NeatPages::Base.new(999, :per_page => 15, :total_items => 100).offset.should eql 101 }
+    end
+  end
+
+  describe "#out_of_bound?" do
+    context "with a 100 items pagination starting at page 1 and having 10 items per page" do
+      specify { NeatPages::Base.new(1, :per_page => 10, :total_items => 100).should_not be_out_of_bound }
+    end
+
+    context "with a 100 items pagination starting at page 11 and having 10 items per page" do
+      specify { NeatPages::Base.new(11, :per_page => 10, :total_items => 100).should be_out_of_bound }
+    end
+  end
+
+  describe "#previous_page" do
+    context "with a 100 items pagination starting at page 5 and having 10 items per page" do
+      specify { NeatPages::Base.new(5, :per_page => 10, :total_items => 100).previous_page.should eql 4 }
+    end
+
+    context "with a 100 items pagination starting at page 3 and having 15 items per page" do
+      specify { NeatPages::Base.new(3, :per_page => 15, :total_items => 100).previous_page.should eql 2 }
+    end
+
+    context "with a 50 items pagination starting at 0 and having 10 items per page" do
+      specify { NeatPages::Base.new(0, :per_page => 10, :total_items => 50).previous_page.should eql 1 }
+    end
+  end
+
+  describe "#previous" do
+    context "with a 100 items pagination starting at page 5 and having 10 items per page" do
+      specify { NeatPages::Base.new(5, :per_page => 10, :total_items => 100).should be_previous }
+    end
+
+    context "with a 50 items pagination starting at 0 and having 10 items per page" do
+      specify { NeatPages::Base.new(0, :per_page => 10, :total_items => 50).should_not be_previous }
+    end
+  end
+
+  describe "#previous?" do
+    context "with a 100 items pagination starting at 0 and having 10 items per page" do
+      specify { NeatPages::Base.new(0, :per_page => 10, :total_items => 100).should_not be_previous }
+    end
+
+    context "with a 100 items pagination starting at page 2 and having 10 items per page" do
+      specify { NeatPages::Base.new(2, :per_page => 10, :total_items => 100).should be_previous }
+    end
+
+    context "with a 5 items pagination starting at 0 and having 10 items per page" do
+      specify { NeatPages::Base.new(0, :per_page => 10, :total_items => 5).should_not be_previous }
+    end
+  end
+
+  describe "#response_headers" do
+    context "with a 200 items pagination starting at page 1 and having 10 items per page" do
+      subject { NeatPages::Base.new(1, :per_page => 10, :total_items => 200).response_headers }
+
+      its(:length) { should eql 4 }
+      its(['X-Total-Items']) { should eql '200' }
+      its(['X-Total-Pages']) { should eql '20' }
+      its(['X-Per-Page']) { should eql '10' }
+      its(['X-Current-Page']) { should eql '1' }
+    end
+  end
+
+  describe "#total_pages" do
+    context "with a 100 items pagination and having 10 items per page" do
+      specify { NeatPages::Base.new(0, :per_page => 10, :total_items => 100).total_pages.should eql 10 }
+    end
+
+    context "with a 0 items pagination and having 10 items per page" do
+      specify { NeatPages::Base.new(0, :per_page => 10).total_pages.should eql 1 }
+    end
+  end
+end

data/spec/neat_pages/helpers_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe NeatPages::Helpers do
+  describe "#status" do
+    context "with a 100 items pagination starting at 0 and having 10 items per page" do
+      let(:neat_pages) { NeatPages::Base.new(0, :per_page => 10, :total_items => 100) }
+
+      before { neat_pages.activate_helpers }
+
+      specify { neat_pages.helpers.status.should eql "1 to 10/100" }
+    end
+
+    context "with a 23 items pagination starting at page 3 and having 10 items per page" do
+      let(:neat_pages) { NeatPages::Base.new(3, :per_page => 10, :total_items => 23) }
+
+      before { neat_pages.activate_helpers }
+
+      specify { neat_pages.helpers.status.should eql "21 to 23/23" }
+    end
+
+    context "with a 0 items pagination starting at 0 and having 10 items per page" do
+      let(:neat_pages) { NeatPages::Base.new(0, :per_page => 10, :total_items => 0) }
+
+      before { neat_pages.activate_helpers }
+
+      specify { neat_pages.helpers.status.should be_empty }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require "rubygems"
+require "bundler/setup"
+
+require 'rspec'
+
+require File.expand_path('../../lib/neat-pages', __FILE__)
+
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: neat-pages
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Sebastien Rosa
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &2164478480 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+  type: :development
+  prerelease: false
+  version_requirements: *2164478480
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2164477640 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: *2164477640
+description: ''
+email:
+- sebastien@demarque.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.md
+files:
+- lib/neat-pages.rb
+- lib/neat_pages/base.rb
+- lib/neat_pages/errors.rb
+- lib/neat_pages/helpers.rb
+- lib/neat_pages/implants/action_controller_implant.rb
+- lib/neat_pages/implants/mongoid_implant.rb
+- lib/neat_pages/implants/railtie.rb
+- lib/neat_pages/implants.rb
+- spec/neat-pages_spec.rb
+- spec/neat_pages/base_spec.rb
+- spec/neat_pages/helpers_spec.rb
+- spec/spec_helper.rb
+- LICENSE
+- README.md
+- Rakefile
+- Gemfile
+homepage: https://github.com/demarque/neat-pages
+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: neat-pages
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: ''
+test_files: []