pagelux 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: feafcc5a8a3b091d53e9deb825a65ba75a88fe81
-  data.tar.gz: d421ad5c0a551e62686fa0a7569f98ff8ecf370f
+  metadata.gz: dbeb5f2ff84c4cd8b9cb8455a173e0a025dfa721
+  data.tar.gz: ca7386b257dde68a6dc9fde359362ed9767e363d
 SHA512:
-  metadata.gz: 1afbc2a396018eecbaf43967a19cfcfa8274b96e34c68dfb492a7399328d120a0cba1b9bb9dc565e20a4de286312d5474cfc30ed2e945886ea66ce4b775264af
-  data.tar.gz: e780f9048e4df2b67527396be0b3502c46defc1f21992277aedc37c127ac03e6cc59a4b53ac75d0bb95525a3c84af099bbc5dbab4e0d41cb1bc68952428225ea
+  metadata.gz: c88f8c3b298e9c218cd6f72ca2225bde9e88fbd5f84f9db189f33ffbd9a58dcfa610bd3380821d8ad44b6a4fffa762796b2879e470cdcbf6444423a86d1e99e3
+  data.tar.gz: bd1bf24b25af0a785770f6bac1e76aeb36a07cfc0e7a5952aac469f61d4e98adf15f718654495b66b1dd7970baad1b9b72ca95287bebbd3c85bc56a11fe9e60f

data/.rspec

@@ -0,0 +1 @@
+--color

data/lib/pagelux.rb

@@ -1,5 +1,11 @@
+require 'forwardable'
+
 require "pagelux/query"
+require "pagelux/query_paginator"
 require "pagelux/version"
 
 module Pagelux
+  def self.paginate(query, params)
+    QueryPaginator.new(query).paginate(params)
+  end
 end

data/lib/pagelux/query.rb

@@ -2,9 +2,23 @@ module Pagelux
   class Query
     attr_accessor :page, :limit
 
-    def initialize(page, limit=100)
-      @page = page.to_i
-      @limit = limit.to_i
+    def initialize(page=nil, limit=nil)
+      @limit = (limit || self.class.default_limit).to_i
+      @page =  normalize_page(page)
+    end
+
+    def self.default_page
+      1
+    end
+
+    def self.default_limit
+      100
+    end
+
+    def normalize_page(n)
+      n = (n  || self.class.default_page).to_i
+      n = self.class.default_page if n < self.class.default_page
+      n
     end
 
     def perform(query)

data/lib/pagelux/query_paginator.rb

@@ -0,0 +1,51 @@
+module Pagelux
+  class QueryPaginator
+    extend Forwardable
+
+    attr_reader :base_query
+
+    def initialize(base_query)
+      @base_query = base_query
+    end
+
+    def paginate(params)
+      @pagination_data = PaginationData.new(params[:page], params[:limit], base_query.count)
+      limit_query
+    end
+
+    def limit_query
+      base_query.offset((page-1) * limit).limit(limit)
+    end
+
+    def_delegators :@pagination_data, :page, :limit
+
+    class PaginationData
+      attr_reader :page, :limit, :total
+
+      def initialize(page=nil, limit=nil, query_total)
+        @total = query_total
+        @limit = (limit || self.class.default_limit).to_i
+        @page =  normalize_page(page)
+      end
+
+      def self.default_page
+        1
+      end
+
+      def self.default_limit
+        100
+      end
+
+      def normalize_page(n)
+        n = (n  || self.class.default_page).to_i
+        n = self.class.default_page if n < self.class.default_page
+        n = n > last_page ? last_page : n
+        n
+      end
+
+      def last_page
+        (total/limit.to_f).ceil
+      end
+    end
+  end
+end

data/lib/pagelux/version.rb

@@ -1,3 +1,3 @@
 module Pagelux
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/pagelux.gemspec

@@ -6,8 +6,8 @@ require 'pagelux/version'
 Gem::Specification.new do |spec|
   spec.name          = "pagelux"
   spec.version       = Pagelux::VERSION
-  spec.authors       = ["Rae Bonfanti & Ryan Buckley"]
-  spec.email         = ["rae.bonfanti+ryan.buckley@socialchorus.com"]
+  spec.authors       = ["Rae Bonfanti", "Ryan Buckley", "Kane Baccigalupi", "Sowjanya Mudunuri"]
+  spec.email         = ["developers@socialchorus.com"]
   spec.description   = %q{Basic pagination for ActiveRecord::Relation objects}
   spec.summary       = %q{Usage: Pagelux::Query.new(page, limit).perform(the_ar_query)}
   spec.homepage      = ""
@@ -18,6 +18,9 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  # spec.add_dependency ''
+
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency 'rspec'
 end

data/spec/pagelux_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe Pagelux, 'facade' do
+  describe '.paginate(query, params)' do
+    it "wraps the QueryPaginator" do
+      params = double('params')
+      query = double('query')
+      paginator = double('paginator')
+
+      Pagelux::QueryPaginator.should_receive(:new).with(query).and_return(paginator)
+      paginator.should_receive(:paginate).with(params)
+      
+      Pagelux.paginate(query, params)
+    end
+  end
+end

data/spec/query_paginator_spec.rb

@@ -0,0 +1,76 @@
+require 'spec_helper'
+
+describe Pagelux::QueryPaginator do
+  let(:query) { Query.new(('a'..'m').to_a) }
+  let(:paginator) { Pagelux::QueryPaginator.new(query) }
+  # let(:results) { paginator.paginate(params) }
+
+  describe 'normalizing pagination values' do
+    let(:params) { {} }
+
+    context 'when nothing is passed in' do
+      it 'uses defaults' do
+        paginator.paginate(params)
+
+        paginator.page.should == 1
+        paginator.limit.should == 100
+      end
+    end
+
+    context 'when page is less than 1' do
+      let(:params) { 
+        {
+          page: 0
+        }
+      }
+
+      it "uses first page" do
+        paginator.paginate(params)
+
+        paginator.page.should == 1
+      end
+    end
+
+    context 'when the page is greater than what is available' do
+      let(:params) {
+        {
+          page: 4,
+          limit: 5
+        }
+      }
+
+      it 'gets the last page' do
+        paginator.paginate(params)
+
+        paginator.page.should == 3
+      end
+    end
+  end
+
+  describe 'query pagination' do
+    let(:results) { paginator.paginate({page: page, limit: 5}) }
+
+    context 'when on first page' do
+      let(:page) { 1 }
+
+      it "will return the right records" do
+        results.should == ('a'..'e').to_a
+      end
+    end
+
+    context 'when on middle page' do
+      let(:page) { 2 }
+      it "will return the right records for a middle page" do
+        results.should == ('f'..'j').to_a
+      end
+    end
+
+    context 'when on last page' do
+      let(:page) { 3 }
+
+      it "will return the right records no the last page" do
+        results.should == ('k'..'m').to_a
+      end
+    end
+  end
+end

data/spec/query_spec.rb

@@ -1,35 +1,64 @@
-require 'minitest/autorun'
-require 'fixtures/query'
-require File.expand_path('../../lib/pagelux/query', __FILE__)
+require 'spec_helper'
 
-class TestPagelux < MiniTest::Unit::TestCase
+describe Pagelux::Query do
+  let(:paginator) { Pagelux::Query.new(page, limit) }
 
-  def setup
-    @pagelux = Pagelux::Query.new(1)
-  end
+  describe 'normalizing pagination values' do
+    context 'when nothing is passed in' do
+      let(:paginator) { Pagelux::Query.new  }
 
-  def test_defaults
-    assert_equal 100,  @pagelux.limit
-    assert_equal 1,  @pagelux.page
-  end
+      it 'uses defaults' do
+        paginator.page.should == 1
+        paginator.limit.should == 100
+      end
+    end
+
+    context 'when nils are passed in (a real case with params)' do
+      let(:page) { nil }
+      let(:limit) { nil }
+
+      it 'uses defaults' do
+        paginator.page.should == 1
+        paginator.limit.should == 100
+      end
+    end
+
+    context 'when page is less than 1' do
+      let(:page) { 0 }
+      let(:limit) { 100 }
 
-  def test_perform
-    @pagelux.limit = 5
-    query = @pagelux.perform(sample_query)
-    assert_equal 5, query.length
-    assert_equal ('a'..'e').to_a, query
-    @pagelux.page += 1
-    query = @pagelux.perform(sample_query)
-    assert_equal 5, query.length
-    assert_equal ('f'..'j').to_a, query
-    @pagelux.page += 1
-    query = @pagelux.perform(sample_query)
-    assert_equal 3, query.length
-    assert_equal ('k'..'m').to_a, query
+      it "uses first page" do
+        paginator.page.should == 1
+      end
+    end
   end
 
-  # query size is 13
-  def sample_query
-    @sample_query ||= Query.new(('a'..'m').to_a)
+  describe 'query pagination' do
+    let(:limit) { 5 }
+    let(:sample_query) { Query.new(('a'..'m').to_a) }
+    let(:results) { paginator.perform(sample_query) }
+
+    context 'when on first page' do
+      let(:page) { 1 }
+
+      it "will return the right records" do
+        results.should == ('a'..'e').to_a
+      end
+    end
+
+    context 'when on middle page' do
+      let(:page) { 2 }
+      it "will return the right records for a middle page" do
+        results.should == ('f'..'j').to_a
+      end
+    end
+
+    context 'when on last page' do
+      let(:page) { 3 }
+
+      it "will return the right records no the last page" do
+        results.should == ('k'..'m').to_a
+      end
+    end
   end
 end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+Dir[File.dirname(__FILE__) + "/support/**/*.rb"].each {|f| require f}
+
+$: << File.dirname(__FILE__) + "/../lib"
+require 'pagelux'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/spec/{fixtures → support}/query.rb

@@ -9,4 +9,8 @@ class Query < Struct.new(:items, :index)
   def limit(num)
     items.slice(index, num)
   end
+
+  def count
+    items.length
+  end
 end

metadata

@@ -1,14 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: pagelux
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
-- Rae Bonfanti & Ryan Buckley
+- Rae Bonfanti
+- Ryan Buckley
+- Kane Baccigalupi
+- Sowjanya Mudunuri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-06 00:00:00.000000000 Z
+date: 2013-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,24 +41,43 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Basic pagination for ActiveRecord::Relation objects
 email:
-- rae.bonfanti+ryan.buckley@socialchorus.com
+- developers@socialchorus.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/pagelux.rb
 - lib/pagelux/query.rb
+- lib/pagelux/query_paginator.rb
 - lib/pagelux/version.rb
 - pagelux.gemspec
-- spec/fixtures/query.rb
+- spec/pagelux_spec.rb
+- spec/query_paginator_spec.rb
 - spec/query_spec.rb
+- spec/spec_helper.rb
+- spec/support/query.rb
 homepage: ''
 licenses:
 - MIT
@@ -76,10 +98,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.6
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: 'Usage: Pagelux::Query.new(page, limit).perform(the_ar_query)'
 test_files:
-- spec/fixtures/query.rb
+- spec/pagelux_spec.rb
+- spec/query_paginator_spec.rb
 - spec/query_spec.rb
+- spec/spec_helper.rb
+- spec/support/query.rb