folio-pagination-legacy 0.0.2

data/lib/folio/will_paginate/view_helpers/action_view.rb

@@ -0,0 +1,10 @@
+begin
+  require 'will_paginate/view_helpers/action_view'
+rescue LoadError
+  raise "folio-pagination's actionview support requires will_paginate"
+end
+
+require 'folio/will_paginate/view_helpers'
+
+# no overrides specific to action view necessary. just including the general
+# view_helper overrides as above is sufficient.

data/lib/folio/will_paginate/view_helpers/link_renderer.rb

@@ -0,0 +1,53 @@
+require 'active_support'
+require 'will_paginate/view_helpers'
+
+module Folio
+  module WillPaginate
+    module ViewHelpers
+      module LinkRenderer
+        def prepare_with_folio(collection, options, template)
+          # only include page_links if we're in a collection with ordinal
+          # pages; otherwise stick to just prev/next.
+          options = options.merge(page_links: false) unless collection.ordinal_pages?
+          prepare_without_folio(collection, options, template)
+        end
+
+        def windowed_links_with_folio
+          links = windowed_links_without_folio
+          unless @collection.last_page
+            # the last page is not known, so add a trailing gap
+            links << gap_marker
+          end
+          links
+        end
+
+        def total_pages_with_folio
+          # the collection may not have a known last page. if so, there must be
+          # a next page; count that as the last known page. it's ok to use
+          # these page identifiers as a page count because (after fixing
+          # LinkRenderer) it's only called when ordinal_pages is true.
+          @collection.last_page || @collection.next_page
+        end
+
+        def rel_value_with_folio(page)
+          # don't check against mathed out values, just check the values on the
+          # collection
+          rels = []
+          rels << 'prev' if page == @collection.previous_page
+          rels << 'next' if page == @collection.next_page
+          rels << 'start' if page == @collection.first_page
+          rels.empty? ? nil : rels.join(' ')
+        end
+
+        def self.included(klass)
+          [:prepare, :windowed_links, :total_pages, :rel_value].each do |method|
+            klass.send(:alias_method, :"#{method}_without_folio", method)
+            klass.send(:alias_method, method, :"#{method}_with_folio")
+          end
+        end
+
+        ::WillPaginate::LinkRenderer.send :include, self
+      end
+    end
+  end
+end

data/test/folio/core_ext/enumerable_test.rb

@@ -0,0 +1,55 @@
+require 'minitest/autorun'
+require 'folio/core_ext/enumerable'
+
+describe Array do
+  it "should be an ordinal folio" do
+    assert_respond_to [], :build_page
+    [].build_page.first_page.must_equal 1
+  end
+
+  describe "per_page" do
+    it "should have per_page attribute as expected on instances" do
+      assert_respond_to [], :per_page
+      assert_respond_to [], :per_page=
+    end
+
+    it "should not have per_page attribute on classes" do
+      Array.wont_respond_to :per_page
+      Array.wont_respond_to :per_page=
+    end
+
+    it "should default to Folio.per_page" do
+      was = Folio.per_page
+      Folio.per_page = 100
+      [].per_page.must_equal 100
+      Folio.per_page = was
+    end
+  end
+
+  describe "paginate" do
+    before do
+      @ary = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
+    end
+
+    it "should return a page" do
+      page = @ary.paginate
+      assert_respond_to page, :current_page
+    end
+
+    it "should return appropriate slice" do
+      @ary.paginate(page: 2, per_page: 4).must_equal [5, 6, 7, 8]
+    end
+
+    it "should return partial slice at end" do
+      @ary.paginate(page: 3, per_page: 4).must_equal [9, 10]
+    end
+
+    it "should raise InvalidPage after end even if size unknown" do
+      lambda{ @ary.paginate(page: 3, per_page: 5, total_entries: nil) }.must_raise Folio::InvalidPage
+    end
+
+    it "should return empty first page if empty" do
+      [].paginate.must_equal []
+    end
+  end
+end

data/test/folio/ordinal/page_test.rb

@@ -0,0 +1,173 @@
+require 'minitest/autorun'
+require 'folio/ordinal'
+
+describe Folio::Ordinal::Page do
+  before do
+    @page = Folio::Ordinal::Page.create
+    @page.current_page = 1
+    @page.per_page = 10
+    @page.total_entries = 30
+  end
+
+  it "should have ordinal_pages=true" do
+    @page.ordinal_pages.must_equal true
+    @page.ordinal_pages?.must_equal true
+  end
+
+  it "should have first_page=1" do
+    @page.first_page.must_equal 1
+  end
+
+  it "should force current_page to an integer" do
+    @page.current_page = "3"
+    @page.current_page.must_equal 3
+  end
+
+  describe "when total pages known" do
+    it "should have last_page=total_pages" do
+      @page.last_page.must_equal @page.total_pages
+
+      @page.total_entries = 0
+      @page.last_page.must_equal @page.total_pages
+
+      @page.total_entries = nil
+      @page.last_page.must_equal @page.total_pages
+    end
+
+    it "should have next_page=current_page+1 when not at end" do
+      @page.current_page = 2
+      @page.next_page.must_equal 3
+    end
+
+    it "should still have next_page=current_page+1 when not at end, despite set value" do
+      @page.current_page = 2
+      @page.next_page = nil
+      @page.next_page.must_equal 3
+    end
+
+    it "should have next_page=nil when at end" do
+      @page.current_page = 3
+      @page.next_page.must_be_nil
+    end
+
+    it "should still have next_page=nil when at end, despite set value" do
+      @page.current_page = 3
+      @page.next_page = 4
+      @page.next_page.must_be_nil
+    end
+  end
+
+  describe "when total pages not known" do
+    before do
+      @page.total_entries = nil
+    end
+
+    it "should have last_page=nil if next_page is known or assumed" do
+      # @page.next_page unset
+      @page.last_page.must_be_nil
+
+      # @page.next_page explicitly non-nil
+      @page.next_page = 2
+      @page.last_page.must_be_nil
+    end
+
+    it "should have last_page=current_page if next_page is explicitly nil" do
+      @page.next_page = nil
+      @page.last_page.must_equal @page.current_page
+    end
+
+    it "should have next_page=current_page+1 when not explicitly set" do
+      @page.current_page = 2
+      @page.next_page.must_equal 3
+    end
+
+    it "should force non-nil set next_page to an integer" do
+      @page.next_page = "4"
+      @page.next_page.must_equal 4
+    end
+
+    it "should not force nil set next_page to an integer" do
+      @page.next_page = nil
+      @page.next_page.must_be_nil
+    end
+
+    it "should have next_page=set value when explicitly set" do
+      @page.next_page = nil
+      @page.current_page = 2
+      @page.next_page.must_be_nil
+    end
+  end
+
+  it "should have previous_page=nil when at beginning" do
+    @page.current_page = 1
+    @page.previous_page.must_be_nil
+  end
+
+  it "should have previous_page=current_page-1 when not at beginning" do
+    @page.current_page = 3
+    @page.previous_page.must_equal 2
+  end
+
+  describe "out_of_bounds?" do
+    it "should be false if in first_page..last_page range" do
+      @page.current_page = 1
+      @page.out_of_bounds?.must_equal false
+
+      @page.current_page = 3
+      @page.out_of_bounds?.must_equal false
+    end
+
+    it "should be true if negative page" do
+      @page.current_page = -1
+      @page.out_of_bounds?.must_equal true
+    end
+
+    it "should be true if zero page" do
+      @page.current_page = 0
+      @page.out_of_bounds?.must_equal true
+    end
+
+    it "should be true after known last_page" do
+      @page.current_page = 4
+      @page.out_of_bounds?.must_equal true
+    end
+
+    it "should not care about large numbers when total_pages not known" do
+      @page.total_entries = nil
+      @page.current_page = 50
+      @page.out_of_bounds?.must_equal false
+    end
+  end
+
+  describe "decorate" do
+    before do
+      @page = Folio::Ordinal::Page.decorate([])
+    end
+
+    it "should add page methods to the object" do
+      assert_respond_to @page, :current_page
+    end
+
+    it "should add ordinal page methods to the object" do
+      @page.first_page.must_equal 1
+    end
+
+    it "should preserve other methods on the object" do
+      assert_respond_to @page, :each
+    end
+  end
+
+  describe "create" do
+    before do
+      @page = Folio::Ordinal::Page.create
+    end
+
+    it "should be an Array at heart" do
+      @page.must_be :is_a?, Array
+    end
+
+    it "should be decorated as an ordinal page" do
+      @page.first_page.must_equal 1
+    end
+  end
+end

data/test/folio/ordinal_test.rb

@@ -0,0 +1,57 @@
+require 'minitest/autorun'
+require 'folio/ordinal'
+
+describe Folio::Ordinal do
+  before do
+    klass = Class.new do
+      def build_page
+        Folio::Page.create
+      end
+
+      def fill_page(page)
+        page
+      end
+
+      include Folio::Ordinal
+    end
+    @folio = klass.new
+  end
+
+  describe "paginate" do
+    it "should decorate the result of build_page" do
+      @page = @folio.paginate
+      @page.is_a?(Folio::Ordinal::Page).must_equal true
+    end
+
+    describe "bounds checking" do
+      before do
+        @folio.per_page = 10
+      end
+
+      it "should raise on non-integer page" do
+        lambda{ @folio.paginate(page: "non-integer") }.must_raise Folio::InvalidPage
+      end
+
+      it "should raise on negative page" do
+        lambda{ @folio.paginate(page: -1) }.must_raise Folio::InvalidPage
+      end
+
+      it "should raise on page of 0" do
+        lambda{ @folio.paginate(page: 0) }.must_raise Folio::InvalidPage
+      end
+
+      it "should raise on page greater than known last_page" do
+        lambda{ @folio.paginate(page: 4, total_entries: 30) }.must_raise Folio::InvalidPage
+      end
+
+      it "should not raise on page number between first_page and known last_page" do
+        @folio.paginate(page: 1, total_entries: 30)
+        @folio.paginate(page: 3, total_entries: 30)
+      end
+
+      it "should not raise on large page if last_page unknown" do
+        @folio.paginate(page: 100)
+      end
+    end
+  end
+end

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