banjo-mongoid-pagination 1.0.0

data/.gitignore

@@ -0,0 +1,2 @@
+.rspec
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,6 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - ree
+  - ruby-head
+  - rbx

data/Gemfile

@@ -0,0 +1,11 @@
+source :rubygems
+
+gemspec
+
+gem 'bson_ext'
+gem 'rake'
+
+group :test do
+  gem 'rspec'
+  gem 'rspec-rails-mocha'
+end

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2012 Alex Sharp
+
+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,18 @@
+## What
+
+Adds pagination scopes to your mongoid models.
+
+## Usage
+
+```ruby
+class Person
+  include Mongoid::Document
+  include Mongoid::Pagination
+
+  default_page_size 20
+end
+
+Person.paginate(:page => 2, :limit => 25) # limit and page
+Person.paginate(:offset => 20, :limit => 25) # limit and offset
+Person.per_page(25) # just does a limit
+```

data/Rakefile

@@ -0,0 +1,5 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/mongoid-pagination.rb

@@ -0,0 +1,2 @@
+require 'mongoid'
+require 'mongoid/pagination'

data/lib/mongoid/pagination.rb

@@ -0,0 +1,95 @@
+module Mongoid
+  module Pagination
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+
+      def page_size
+        @page_size || 25
+      end
+
+      def page_size=(page_size)
+        @page_size = page_size
+      end
+
+      # Paginate the results
+      #
+      # @param [Hash] opts
+      # @option [Integer] :page (default: 1)
+      # @option [Integer] :offset (default: 0)
+      # @option [Integer] :limit (default: 25)
+      #
+      # @return [Mongoid::Criteria]
+      def paginated_criteria(opts = {})
+        limit = (opts[:limit] || page_size).to_i
+        offset = paginate_offset(opts)
+
+        per_page(limit).offset(offset)
+      end
+
+      def paginate(opts = {})
+
+        criteria = paginated_criteria(opts)
+        limit = criteria.options[:limit]
+        criteria.options[:limit] += 1
+
+        over_fetched_collection = criteria.to_a
+        has_more_results = over_fetched_collection.size > limit
+
+        over_fetched_collection.pop if has_more_results
+
+        @paginated_collection = ::Mongoid::Pagination::Collection.new(over_fetched_collection)
+        @paginated_collection.current_offset = criteria.options[:skip]
+        @paginated_collection.current_page_size = limit
+        @paginated_collection.has_more_results = has_more_results
+
+        preload(opts[:eager_load]) if opts[:eager_load].present?
+
+        @paginated_collection
+      end
+
+      def preload(args)
+        return unless args.present? && @paginated_collection.present?
+
+        relations.select { |k,v| args.map(&:to_s).include?(k) }.each_pair do |name,meta|
+          field_key = meta.key
+          ids = @paginated_collection.map { |c| c.send(field_key.to_sym) }.compact
+          meta.class_name.constantize.any_in(_id: ids).to_a if ids.present?
+        end
+      end
+
+      # Limit the result set
+      #
+      # @param [Integer] page_limit the max number of results to return
+      # @return [Mongoid::Criteria]
+      def per_page(page_limit = page_size)
+        limit(page_limit.to_i)
+      end
+
+      def paginate_offset(opts = {})
+        case
+          when opts[:page] && (page = opts[:page].to_i) > 0 then (page - 1) * (opts[:limit] || page_size).to_i
+          when opts[:offset] && (offset = opts[:offset].to_i) >= 0 then offset
+          else 0
+        end
+      end
+
+      def paginated_collection
+        @paginated_collection
+      end
+    end
+
+    class Collection < Array
+      attr_accessor :current_offset, :current_page_size, :has_more_results
+
+      def next_offset_at
+        current_offset + current_page_size
+      end
+
+      def next_offset
+        has_more_results ? next_offset_at : nil
+      end
+    end
+  end
+end
+

data/lib/mongoid/pagination/version.rb

@@ -0,0 +1,5 @@
+module Mongoid
+  module Pagination
+    VERSION = '1.0.0'
+  end
+end

data/mongoid-pagination.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "mongoid/pagination/version"
+
+Gem::Specification.new do |s|
+  s.name        = "banjo-mongoid-pagination"
+  s.version     = Mongoid::Pagination::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Alex Sharp", "KW Justin Leung"]
+  s.email       = ["ajsharp@gmail.com", "justin@teambanjo.com"]
+  s.homepage    = "https://github.com/BanjoInc/mongoid-pagination"
+  s.summary     = %q{A simple pagination module for Mongoid}
+  s.description = %q{A simple pagination module for Mongoid}
+
+  s.rubyforge_project = s.name
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency 'mongoid'
+end

data/spec/pagination_spec.rb

@@ -0,0 +1,245 @@
+require 'spec_helper'
+
+describe Mongoid::Pagination do
+  class Group
+    include Mongoid::Document
+
+    has_many :persons
+  end
+
+  class Person
+    include Mongoid::Document
+    include Mongoid::Pagination
+
+    belongs_to :group
+  end
+
+  describe ".page_size" do
+    class Person_50
+      include Mongoid::Document
+      include Mongoid::Pagination
+
+      self.page_size = 50
+    end
+
+    it 'returns configured default page size' do
+      Person.page_size.should == 25
+      Person_50.page_size.should == 50
+    end
+  end
+
+  describe ".paginate" do
+    let!(:group) { Group.create! }
+    let!(:one)   { Person.create!(group: group) }
+    let!(:two)   { Person.create!(group: group) }
+
+    context 'without eager loading' do
+      subject { Person.paginate(offset: 0, limit: 2) }
+
+      it 'is an paginated array' do
+        subject.should be_kind_of(Mongoid::Pagination::Collection)
+      end
+
+      context 'for less than a page' do
+        it 'returns page size' do
+          subject.size.should == 2
+          subject.has_more_results.should == false
+          subject.next_offset.should be_nil
+          subject.next_offset_at.should == 2
+        end
+      end
+    end
+
+    context 'with eager loading' do
+      subject { Person.paginate(offset: 0, limit: 2, eager_load: [ :group ]) }
+
+      it 'is an paginated array' do
+        subject.should be_kind_of(Mongoid::Pagination::Collection)
+      end
+
+      context 'for less than a page' do
+        it 'returns page size' do
+          Group.expects(:any_in).once.returns([group])
+          subject.size.should == 2
+          subject.has_more_results.should == false
+          subject.next_offset.should be_nil
+          subject.next_offset_at.should == 2
+        end
+      end
+
+      context 'for more than a page' do
+        let!(:three) { Person.create!(group: group) }
+        let!(:four)  { Person.create!(group: group) }
+
+        it 'overfetched by 1' do
+          Group.expects(:any_in).once.returns([group])
+          subject.size.should == 2
+          subject.has_more_results.should == true
+          subject.next_offset.should == 2
+          subject.next_offset_at.should == 2
+        end
+      end
+    end
+  end
+
+  describe ".paginated_criteria" do
+    let!(:one)   { Person.create! }
+    let!(:two)   { Person.create! }
+    let!(:three) { Person.create! }
+    let!(:four)  { Person.create! }
+
+    context "parameter defaults and massaging" do
+      describe "when no params are passed in" do
+        subject { Person.paginated_criteria }
+
+        it "does not set the skip param by default" do
+          subject.options[:skip].should == 0
+        end
+
+        it "defaults the limit param to 25" do
+          subject.options[:limit].should == 25
+        end
+
+        it "returns the criteria unmodified if the limit param is not passed in" do
+          criteria = Person.where(:name => 'someone')
+          expect {
+            criteria.paginated_criteria
+          }.not_to change { criteria.options }
+        end
+      end
+
+      describe "when passed a page param but no limit" do
+        subject { Person.paginated_criteria(:page => 1) }
+
+        it "defaults the limit to 25" do
+          subject.options[:limit].should == 25
+        end
+
+        it "sets the offset to 0" do
+          subject.options[:skip].should == 0
+        end
+      end
+
+      describe "when passed an offset param but no limit" do
+        subject { Person.paginated_criteria(:offset => 0) }
+
+        it "defaults the limit to 25" do
+          subject.options[:limit].should == 25
+        end
+
+        it "sets the offset to 0" do
+          subject.options[:skip].should == 0
+        end
+      end
+
+      describe "when passed a limit param but no page nor offset" do
+        subject { Person.paginated_criteria(:limit => 100) }
+
+        it "defaults the offset to 0" do
+          subject.options[:skip].should == 0
+        end
+
+        it "sets the limit to 100" do
+          subject.options[:limit].should == 100
+        end
+      end
+
+      describe "when passed both page and offset, offset is ignored" do
+        subject { Person.paginated_criteria(:page => 2, :offset => 1) }
+
+        it "sets the skip to 25" do
+          subject.options[:skip].should == 25
+        end
+      end
+
+      context 'with page param' do
+        it "sets the skip param to 0 if passed 0" do
+          Person.paginated_criteria(:page => 0).options[:skip].should == 0
+        end
+
+        it "sets the skip param to 0 if passed a string of 0" do
+          Person.paginated_criteria(:page => '0').options[:skip].should == 0
+        end
+
+        it "sets the skip param to 0 if the passed a string of 1" do
+          Person.paginated_criteria(:page => '1').options[:skip].should == 0
+        end
+
+        it "limits when passed a string param" do
+          Person.paginated_criteria(:limit => '1').to_a.size.should == 1
+        end
+
+        it "correctly sets criteria options" do
+          Person.paginated_criteria(:limit => 10, :page => 3).options.should == {:limit => 10, :skip => 20}
+        end
+      end
+
+      context 'with offset param' do
+        it "sets the skip param to 0 if passed 0" do
+          Person.paginated_criteria(:offset => 0).options[:skip].should == 0
+        end
+
+        it "sets the skip param to 0 if passed a string of 0" do
+          Person.paginated_criteria(:offset=> '0').options[:skip].should == 0
+        end
+
+        it "sets the skip param to 1 if the passed a string of 1" do
+          Person.paginated_criteria(:offset => '1').options[:skip].should == 1
+        end
+
+        it "sets the skip param with page even if offset is passed as 1" do
+          Person.paginated_criteria(:offset => '1', :page => '2').options[:skip].should == 25 
+        end
+
+        it "correctly sets criteria options" do
+          Person.paginated_criteria(:limit => 10, :offset => 3).options.should == {:limit => 10, :skip => 3}
+        end
+      end
+    end
+
+    context "results" do
+      context "with page param" do
+        it "paginates correctly on the first page" do
+          Person.paginated_criteria(:page => 1, :limit => 2).to_a.should == [one, two]
+        end
+
+        it "paginates correctly on the second page" do
+          Person.paginated_criteria(:page => 2, :limit => 2).to_a.should == [three, four]
+        end
+      end
+
+      context "with offset param" do
+        it "paginates correctly on the first page" do
+          Person.paginated_criteria(:offset => 0, :limit => 2).to_a.should == [one, two]
+        end
+
+        it "paginates correctly on the second page" do
+          Person.paginated_criteria(:offset => 2, :limit => 2).to_a.should == [three, four]
+        end
+      end
+    end
+
+    it "paginates the result set based on the limit and page params" do
+      # Person.
+    end
+  end
+
+  describe ".per_page" do
+    before do
+      2.times { Person.create! }
+    end
+
+    it "limits the results by the per page param" do
+      Person.per_page(1).to_a.size.should == 1
+    end
+
+    it "works for string params" do
+      Person.per_page('1').to_a.size.should == 1
+    end
+
+    it "defaults to 25" do
+      Person.per_page.options[:limit].should == 25
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+require 'rubygems'
+require 'bundler'
+
+Bundler.setup :default, :test
+Bundler.require :default, :test
+
+$:.push(File.expand_path(File.dirname(__FILE__)))
+require './lib/mongoid-pagination'
+
+Mongoid.database = Mongo::Connection.new.db('mongoid-pagination_test')
+
+RSpec.configure do |c|
+  c.before(:each) do
+    Mongoid.database.collections.each { |c| c.drop unless c.name =~ /system\.indexes$/}
+  end
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: banjo-mongoid-pagination
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Alex Sharp
+- KW Justin Leung
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A simple pagination module for Mongoid
+email:
+- ajsharp@gmail.com
+- justin@teambanjo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/mongoid-pagination.rb
+- lib/mongoid/pagination.rb
+- lib/mongoid/pagination/version.rb
+- mongoid-pagination.gemspec
+- spec/pagination_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/BanjoInc/mongoid-pagination
+licenses: []
+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: banjo-mongoid-pagination
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A simple pagination module for Mongoid
+test_files:
+- spec/pagination_spec.rb
+- spec/spec_helper.rb