folio-pagination 0.0.2

data/test/folio/page_test.rb

@@ -0,0 +1,198 @@
+require 'minitest/autorun'
+require 'folio/page'
+require 'folio'
+
+describe Folio::Page do
+  before do
+    @page = Folio::Page.create
+  end
+
+  describe "ordinal_pages" do
+    it "should have ordinal_pages accessors" do
+      assert_respond_to @page, :ordinal_pages
+      assert_respond_to @page, :ordinal_pages=
+      assert_respond_to @page, :ordinal_pages?
+    end
+
+    it "should mutate with ordinal_pages=" do
+      @page.ordinal_pages = true
+      @page.ordinal_pages.must_equal true
+    end
+
+    it "should alias reader as predicate" do
+      @page.ordinal_pages = true
+      @page.ordinal_pages?.must_equal true
+    end
+  end
+
+  describe "current_page" do
+    it "should have current_page accessors" do
+      assert_respond_to @page, :current_page
+      assert_respond_to @page, :current_page=
+    end
+
+    it "should mutate with current_page=" do
+      @page.current_page = 3
+      @page.current_page.must_equal 3
+    end
+  end
+
+  describe "per_page" do
+    it "should have per_page accessors" do
+      assert_respond_to @page, :per_page
+      assert_respond_to @page, :per_page=
+    end
+
+    it "should mutate with per_page=" do
+      @page.per_page = 3
+      @page.per_page.must_equal 3
+    end
+
+    it "should default to Folio.per_page" do
+      was = Folio.per_page
+      Folio.per_page = 100
+      @page.per_page.must_equal Folio.per_page
+      Folio.per_page = was
+    end
+  end
+
+  describe "first_page" do
+    it "should have first_page accessors" do
+      assert_respond_to @page, :first_page
+      assert_respond_to @page, :first_page=
+    end
+
+    it "should mutate with first_page=" do
+      @page.first_page = 3
+      @page.first_page.must_equal 3
+    end
+  end
+
+  describe "last_page" do
+    it "should have last_page accessors" do
+      assert_respond_to @page, :last_page
+      assert_respond_to @page, :last_page=
+    end
+
+    it "should mutate with last_page= when next_page is non-nil" do
+      @page.next_page = 3
+      @page.last_page = 5
+      @page.last_page.must_equal 5
+    end
+
+    it "should default last_page=nil if unset and next_page is non-nil" do
+      @page.current_page = 2
+      @page.next_page = 3
+      @page.last_page.must_be_nil
+    end
+
+    it "should default last_page=current_page if unset and next_page is nil" do
+    end
+
+    it "should have last_page=current_page if next_page is nil, even if explicitly set" do
+      @page.current_page = 2
+      @page.last_page.must_equal 2
+
+      @page.last_page = 4
+      @page.last_page.must_equal 2
+
+      @page.last_page = nil
+      @page.last_page.must_equal 2
+    end
+  end
+
+  describe "next_page" do
+    it "should have next_page accessors" do
+      assert_respond_to @page, :next_page
+      assert_respond_to @page, :next_page=
+    end
+
+    it "should mutate with next_page=" do
+      @page.next_page = 3
+      @page.next_page.must_equal 3
+    end
+  end
+
+  describe "previous_page" do
+    it "should have previous_page accessors" do
+      assert_respond_to @page, :previous_page
+      assert_respond_to @page, :previous_page=
+    end
+
+    it "should mutate with previous_page=" do
+      @page.previous_page = 3
+      @page.previous_page.must_equal 3
+    end
+  end
+
+  describe "total_entries" do
+    it "should have total_entries accessors" do
+      assert_respond_to @page, :total_entries
+      assert_respond_to @page, :total_entries=
+    end
+
+    it "should mutate with total_entries=" do
+      @page.total_entries = 3
+      @page.total_entries.must_equal 3
+    end
+  end
+
+  describe "total_pages" do
+    before do
+      @page.total_entries = 10
+      @page.per_page = 5
+    end
+
+    it "should be nil if total_entries is nil" do
+      @page.total_entries = nil
+      @page.total_pages.must_be_nil
+    end
+
+    it "should be nil if per_page is 0" do
+      @page.per_page = 0
+      @page.total_pages.must_be_nil
+    end
+
+    it "should be 1 if total_entries is 0" do
+      @page.total_entries = 0
+      @page.total_pages.must_equal 1
+    end
+
+    it "should be total_entries/per_page if evenly divisible" do
+      @page.total_pages.must_equal 2
+    end
+
+    it "should round up if not evenly divisible" do
+      @page.per_page = 3
+      @page.total_pages.must_equal 4
+    end
+  end
+
+  describe "decorate" do
+    before do
+      @page = Folio::Page.decorate([])
+    end
+
+    it "should add page methods to the object" do
+      assert_respond_to @page, :current_page
+    end
+
+    it "should preserve other methods on the object" do
+      assert_respond_to @page, :each
+    end
+  end
+
+  describe "create" do
+    before do
+      @page = Folio::Page.create
+    end
+
+    it "should be an Array at heart" do
+      @page.must_be :is_a?, Array
+    end
+
+    it "should be decorated as a page" do
+      assert_respond_to @page, :current_page
+    end
+  end
+end

data/test/folio/per_page_test.rb

@@ -0,0 +1,49 @@
+require 'minitest/autorun'
+require 'folio/per_page'
+require 'folio'
+
+describe Folio::PerPage do
+  before do
+    @klass = Class.new{ include Folio::PerPage }
+    @object = @klass.new
+  end
+
+  describe "default_per_page" do
+    it "should be Folio.per_page" do
+      was = Folio.per_page
+      Folio.per_page = 100
+      @object.default_per_page.must_equal 100
+      Folio.per_page = was
+    end
+  end
+
+  describe "per_page" do
+    it "should return default_per_page if nil" do
+      @klass.send(:define_method, :default_per_page) { 100 }
+      @object.per_page = nil
+      @object.per_page.must_equal 100
+    end
+
+    it "should return set value if non-nil" do
+      @object.per_page = 100
+      @object.per_page.must_equal 100
+    end
+
+    it "should allow setting through argument" do
+      @object.per_page(100)
+      @object.per_page.must_equal 100
+    end
+
+    it "should cast to integer when setting non-nil through argument" do
+      @object.per_page("100")
+      @object.per_page.must_equal 100
+    end
+
+    it "should allow setting to nil through argument" do
+      @klass.send(:define_method, :default_per_page) { 100 }
+      @object.per_page(30)
+      @object.per_page(nil)
+      @object.per_page.must_equal 100
+    end
+  end
+end

data/test/folio/rails_test.rb

@@ -0,0 +1,15 @@
+require 'folio/rails'
+require 'folio/invalid_page'
+
+describe ActionDispatch::ExceptionWrapper do
+  before do
+    # stolen from ActionDispatch::Railtie's initializer
+    config = ActionDispatch::Railtie.config
+    ActionDispatch::ExceptionWrapper.rescue_responses.merge!(config.action_dispatch.rescue_responses)
+  end
+
+  it "should translate Folio::InvalidPage to a 404" do
+    wrapper = ActionDispatch::ExceptionWrapper.new({}, Folio::InvalidPage.new)
+    wrapper.status_code.must_equal 404
+  end
+end

data/test/folio/version_test.rb

@@ -0,0 +1,8 @@
+require 'minitest/autorun'
+require 'folio/version'
+
+describe Folio::VERSION do
+  it "should have a version" do
+    Folio::VERSION.wont_be_nil
+  end
+end

data/test/folio/will_paginate/active_record_test.rb

@@ -0,0 +1,118 @@
+require 'minitest/autorun'
+require 'folio/will_paginate/active_record'
+require_relative '../../setup/active_record'
+
+describe ActiveRecord do
+  TestSetup::ActiveRecord.migrate do |m|
+    m.create_table(:items) do |t|
+      t.boolean :filter
+    end
+
+    m.create_table(:related_things) do |t|
+      t.integer :item_id
+    end
+  end
+
+  class Item < ::ActiveRecord::Base
+    has_many :related_things
+  end
+
+  class RelatedThing < ::ActiveRecord::Base; end
+
+  before do
+    RelatedThing.delete_all
+    Item.delete_all
+    24.times{ |i| Item.create(filter: (i % 2).zero?) }
+  end
+
+  describe "per_page" do
+    it "should default to Folio.per_page" do
+      was = Folio.per_page
+      Folio.per_page = 10
+      ActiveRecord::Base.per_page.must_equal 10
+      Folio.per_page = was
+    end
+  end
+
+  describe "paginate" do
+    it "should return an ordinal folio page" do
+      page = Item.paginate
+      page.is_a?(Folio::Ordinal::Page).must_equal true
+    end
+
+    it "should still return a relation" do
+      page = Item.paginate
+      page.is_a?(ActiveRecord::Relation).must_equal true
+    end
+
+    it "should set limit_value according to per_page" do
+      page = Item.paginate(per_page: 10)
+      page.limit_value.must_equal 10
+    end
+
+    it "should use that limit_value as per_page attribute" do
+      page = Item.paginate(per_page: 10)
+      page.per_page.must_equal 10
+    end
+
+    it "should default limit_value/per_page to model's per_page" do
+      was = Item.per_page
+      Item.per_page = 10
+      page = Item.paginate
+      page.limit_value.must_equal 10
+      page.per_page.must_equal 10
+      Item.per_page = was
+    end
+
+    it "should set offset from page and per_page" do
+      page = Item.paginate(page: 3, per_page: 10)
+      page.offset_value.must_equal 20
+    end
+
+    it "should set current_page" do
+      page = Item.paginate(page: 3, per_page: 10)
+      page.current_page.must_equal 3
+    end
+
+    it "should have the right count on the unloaded page" do
+      page = Item.paginate(page: 3, per_page: 10)
+      page.count.must_equal 4
+    end
+
+    it "should have the right size on the unloaded page" do
+      page = Item.paginate(page: 3, per_page: 10)
+      page.size.must_equal 4
+    end
+
+    it "should return the expected items" do
+      page = Item.paginate(page: 3, per_page: 10)
+      page.to_a.must_equal Item.offset(20).all
+    end
+
+    it "should auto-count total_entries unless specified as nil" do
+      page = Item.paginate
+      page.total_entries.must_equal 24
+    end
+
+    it "should work with total_entries nil" do
+      page = Item.paginate(page: 3, total_entries: nil)
+      page.current_page.must_equal 3
+    end
+
+    it "should validate page number against auto-counted total_entries" do
+      lambda{ Item.paginate(page: 4, per_page: 10) }.must_raise Folio::InvalidPage
+    end
+
+    it "should work on relations" do
+      page = Item.where(filter: true).paginate(page: 2, per_page: 10)
+      page.count.must_equal 2
+    end
+
+    it "should work on associations" do
+      item = Item.first
+      12.times{ |i| item.related_things.create! }
+      page = item.related_things.paginate(page: 2, per_page: 10)
+      page.count.must_equal 2
+    end
+  end
+end

data/test/folio/will_paginate/collection_test.rb

@@ -0,0 +1,43 @@
+require 'minitest/autorun'
+require 'folio/will_paginate/collection'
+
+describe WillPaginate::Collection do
+  describe "create" do
+    it "should create an ordinal page" do
+      page = WillPaginate::Collection.create(1)
+      page.is_a?(Folio::Ordinal::Page).must_equal true
+    end
+
+    it "should set current_page on the created page" do
+      page = WillPaginate::Collection.create(4)
+      page.current_page.must_equal 4
+    end
+
+    it "should set per_page on the created page if given" do
+      page = WillPaginate::Collection.create(4, 10)
+      page.per_page.must_equal 10
+    end
+
+    it "should set total_entries on the created page if given" do
+      page = WillPaginate::Collection.create(4, 10, 50)
+      page.total_entries.must_equal 50
+    end
+
+    it "should yield the page to block if given" do
+      page = WillPaginate::Collection.create(1) { |p| p.replace [1, 2, 3] }
+      page.must_equal [1, 2, 3]
+    end
+
+    it "created page should have offset method like WillPaginate::Collection" do
+      page = WillPaginate::Collection.create(4, 10)
+      page.offset.must_equal 30
+    end
+
+    it "created should set total_entries on replace like WillPaginate::Collection" do
+      page = WillPaginate::Collection.create(4, 10)
+      page.total_entries.must_be_nil
+      page.replace [1, 2, 3]
+      page.total_entries.must_equal 33
+    end
+  end
+end

data/test/folio/will_paginate/view_helpers/link_renderer_base_test.rb

@@ -0,0 +1,58 @@
+require 'minitest/autorun'
+require 'folio/will_paginate/view_helpers/link_renderer_base'
+require 'folio/page'
+
+describe WillPaginate::ViewHelpers::LinkRendererBase do
+  before do
+    @renderer = WillPaginate::ViewHelpers::LinkRendererBase.new
+
+    # looks just like a standard WillPaginate collection would
+    @collection = Folio::Page.create
+    @collection.ordinal_pages = true
+    @collection.first_page = 1
+    @collection.total_entries = 200
+    @collection.per_page = 10
+    @collection.last_page = 20
+    @collection.current_page = 10
+    @collection.next_page = 11
+    @collection.previous_page = 9
+  end
+
+  it "should ignore page_links parameter with non-ordinal pages" do
+    @collection.ordinal_pages = false
+    @renderer.prepare(@collection, page_links: true)
+    @renderer.pagination.must_equal [:previous_page, :next_page]
+  end
+
+  it "should still honor page_links parameter with ordinal pages" do
+    @renderer.prepare(@collection, page_links: false)
+    @renderer.pagination.must_equal [:previous_page, :next_page]
+
+    @renderer.prepare(@collection, page_links: true)
+    @renderer.pagination.must_equal [:previous_page, 1, :gap, 10, :gap, 20, :next_page]
+  end
+
+  it "should treat last_page as total_pages when known" do
+    @collection.last_page = 15
+    @renderer.prepare(@collection, {})
+    @renderer.total_pages.must_equal @collection.last_page
+  end
+
+  it "should treat next_page as total_pages when last_page unknown" do
+    @collection.last_page = nil
+    @renderer.prepare(@collection, {})
+    @renderer.total_pages.must_equal @collection.next_page
+  end
+
+  it "should add :gap after page links when last_page unknown" do
+    @collection.last_page = nil
+    @renderer.prepare(@collection, page_links: true, inner_window: 1)
+    @renderer.pagination.must_equal [:previous_page, 1, :gap, 9, 10, 11, :gap, :next_page]
+  end
+
+  it "should end inner window at next_page when last_page unknown" do
+    @collection.last_page = nil
+    @renderer.prepare(@collection, page_links: true, inner_window: 2)
+    @renderer.pagination.must_equal [:previous_page, 1, :gap, 7, 8, 9, 10, 11, :gap, :next_page]
+  end
+end

data/test/folio/will_paginate/view_helpers/link_renderer_test.rb

@@ -0,0 +1,58 @@
+require 'minitest/autorun'
+require 'folio/will_paginate/view_helpers/link_renderer'
+require 'folio/page'
+
+describe WillPaginate::ViewHelpers::LinkRenderer do
+  before do
+    klass = Class.new(WillPaginate::ViewHelpers::LinkRenderer) { def url(page); "url://#{page}"; end }
+    @renderer = klass.new
+    @collection = Folio::Page.create
+  end
+
+  describe "previous_page" do
+    it "should respect collection.previous_page" do
+      @collection.previous_page = 5
+      @renderer.prepare(@collection, {}, nil)
+      @renderer.previous_page.must_match %r{url://5}
+    end
+
+    it "should produce link for non-numeric value" do
+      @collection.previous_page = "abcdef"
+      @renderer.prepare(@collection, {}, nil)
+      @renderer.previous_page.must_match %r{url://abcdef}
+    end
+
+    it "should have rel=previous in the html for non-numeric value" do
+      @collection.previous_page = "abcdef"
+      @renderer.prepare(@collection, {}, nil)
+      @renderer.previous_page.must_match %r{rel="prev"}
+    end
+
+    it "should have rel=start in the html for non-numeric value matching first_page" do
+      @collection.first_page = "abcdef"
+      @collection.previous_page = "abcdef"
+      @renderer.prepare(@collection, {}, nil)
+      @renderer.previous_page.must_match %r{rel="prev start"}
+    end
+  end
+
+  describe "next_page" do
+    it "should respect collection.next_page" do
+      @collection.next_page = 15
+      @renderer.prepare(@collection, {}, nil)
+      @renderer.next_page.must_match %r{url://15}
+    end
+
+    it "should produce link for non-numeric value" do
+      @collection.next_page = "abcdef"
+      @renderer.prepare(@collection, {}, nil)
+      @renderer.next_page.must_match %r{url://abcdef}
+    end
+
+    it "should have rel=next in the html for non-numeric value" do
+      @collection.next_page = "abcdef"
+      @renderer.prepare(@collection, {}, nil)
+      @renderer.next_page.must_match %r{rel="next"}
+    end
+  end
+end

data/test/folio/will_paginate/view_helpers_test.rb

@@ -0,0 +1,49 @@
+require 'minitest/autorun'
+require 'folio/will_paginate/view_helpers'
+
+# for I18n in page_entries_info
+require 'active_support/core_ext/string/inflections'
+
+describe WillPaginate::ViewHelpers do
+  include WillPaginate::ViewHelpers
+
+  before do
+    @collection = Folio::Ordinal::Page.create
+  end
+
+  describe "will_paginate" do
+    before do
+      @renderer = Minitest::Mock.new
+      @renderer.expect(:prepare, nil, [@collection, Hash, self])
+      @renderer.expect(:to_html, '<PAGES>')
+    end
+
+    it "should return nil if total_pages is 1" do
+      @collection.total_entries = @collection.per_page
+      will_paginate(@collection, :renderer => @renderer).must_be_nil
+    end
+
+    it "should not error if total_entries is unknown" do
+      @collection.total_entries = nil
+      will_paginate(@collection, :renderer => @renderer).must_equal '<PAGES>'
+    end
+  end
+
+  describe "page_entries_info" do
+    it "should return nominally if collection is ordinal with total_entries known" do
+      @collection.total_entries = 20
+      page_entries_info(@collection).wont_be_nil
+    end
+
+    it "should return nil if total_entries is unknown" do
+      @collection.total_entries = nil
+      page_entries_info(@collection).must_be_nil
+    end
+
+    it "should return nil if collection is non-ordinal" do
+      @collection = Folio::Page.create
+      @collection.total_entries = 20
+      page_entries_info(@collection).must_be_nil
+    end
+  end
+end