folio-pagination 0.0.2 → 0.0.3

data/README.md

@@ -152,13 +152,14 @@ methods as `Folio::Page` but with the following overrides:
 Similarly, mixing `Folio::Ordinal` into a source provides the same
 methods as `Folio`, but simplifies your `build_page` and `fill_page`
 methods by moving some responsibility into the `paginate` method.
+`build_page` also has a default implementation.
 
  * `build_page` no longer needs to configure `ordinal_page?`, `first_page`,
    or `last_page` on the instantiated page. Instead, just instantiate
-   and return a `Folio::Page` or `Folio::Ordinal::Page`. If what you
-   return is not a `Folio::Ordinal::Page`, `paginate` will decorate it
-   to be one. Then `ordinal_page?`, `first_page`, and `last_page` are
-   handled for you, as described above.
+   and return a `Folio::Page` or `Folio::Ordinal::Page`. Then
+   `ordinal_page?`, `first_page`, and `last_page` are handled for you,
+   as described above. If not provided, the default implementation just
+   returns a subclass of `Array` setup to be a `Folio::Ordinal::Page`.
 
  * `fill_page` no longer needs to configure `next_page` and
    `previous_page`; the ordinal page will handle them. (Note that if
@@ -166,31 +167,28 @@ methods by moving some responsibility into the `paginate` method.
    `paginate` will now perform ordinal bounds checking for you, so you
    can focus entirely on populating the page.
 
-### Decorations and `create`
+### `BasicPage`s and `create`
 
-Often times you just want to take a simple collection, such as an
-array, and have it act like a page. One way would be to subclass
-`Array` and mixin `Folio::Page`, then instantiate the subclass.
+Often times you just want to take the simplest collection possible. One
+way would be to subclass `Array` and mixin `Folio::Page`, then
+instantiate the subclass. When you want to add more, or `Array` isn't the
+proper superclass, you can still do this.
 
-Alternately, you can just call `Folio::Page.decorate(collection)`. This
-will decorate the collection instance in a delegate that mixes in
-`Folio::Page` for you. So, for example, a simple `build_page` method
-could just be:
+For the common case we've already done it. This is the
+`Folio::BasicPage` class. We've also provided a shortcut for
+instantiating one: `Folio::Page.create`. So, for example, a simple
+`build_page` method could just be:
 
 ```
   def build_page
-    Folio::Page.decorate([])
+    page = Folio::Page.create
+    # setup ordinal_pages?, first_page, etc.
+    page
   end
 ```
 
-For the common case where a new empty array is what you intend to
-decorate, you can simply call `Folio::Page.create`.
-
-`Folio::Page::Ordinal.decorate(collection)` and
-`Folio::Page::Ordinal.create` are also available, respectively, for the
-ordinal case. `decorate` will assume the passed in collection lacks any
-pagination and will include `Folio::Page` along with
-`Folio::Page::Ordinal`.
+`Folio::Ordinal::BasicPage` and `Folio::Ordinal::Page.create` are also
+available, respectively, for the ordinal case.
 
 ### Enumerable Extension
 
@@ -201,7 +199,8 @@ methods.
 `build_page` will simply return a basic ordinal page as from
 `Folio::Page::Ordinal.create`. `fill_page` then selects an appropriate
 range of items from the folio using standard `Enumerable` methods, then
-calls `replace` on the page (it's a decorated array) with this subset.
+calls `replace` on the page (it's a `Folio::Ordinal::BasicPage`) with
+this subset.
 
 This lets you do things like:
 

data/lib/folio/ordinal/page.rb

@@ -76,31 +76,20 @@ module Folio
         (current_page - 1) * per_page
       end
 
-      class Decorator < Folio::Page::Decorator
-        include Folio::Ordinal::Page
+      def self.create
+        Folio::Ordinal::BasicPage.new
       end
+    end
 
-      class DecoratedArray < Decorator
-        def initialize
-          super []
-        end
+    class BasicPage < Folio::BasicPage
+      include Folio::Ordinal::Page
 
-        def replace(array)
-          result = super
-          if total_entries.nil? and length < per_page and (current_page == 1 or length > 0)
-            self.total_entries = offset + length
-          end
-          result
+      def replace(array)
+        result = super
+        if total_entries.nil? and length < per_page and (current_page == 1 or length > 0)
+          self.total_entries = offset + length
         end
-      end
-
-      def self.decorate(collection)
-        collection = Folio::Ordinal::Page::Decorator.new(collection) unless collection.is_a?(Folio::Ordinal::Page)
-        collection
-      end
-
-      def self.create
-        Folio::Ordinal::Page::DecoratedArray.new
+        result
       end
     end
   end

data/lib/folio/ordinal.rb

@@ -4,12 +4,12 @@ require 'folio/invalid_page'
 
 # Mix in to a source to provide the same methods as Folio, but with simpler
 # build_page and fill_page methods required on the host (some responsibility is
-# moved into the paginate method).
+# moved into the paginate method). build_page also has a default implementation.
 #
 #  * build_page no longer needs to configure ordinal_page?, first_page,
 #    or last_page on the instantiated page. Instead, just instantiate
-#    and return a Folio::Ordinal::Page. If what you return is not a
-#    Folio::Ordinal::Page, paginate will decorate it to be one.
+#    and return a Folio::Ordinal::Page. If not provided, the default
+#    implementation just returns a Folio::Ordinal::BasicPage.
 #
 #  * fill_page no longer needs to configure next_page and previous_page; the
 #    ordinal page will handle them. (Note that if necessary, you can still set
@@ -18,10 +18,13 @@ require 'folio/invalid_page'
 #
 module Folio
   module Ordinal
-    # decorate the page before configuring, and then validate the configured
-    # current_page before returning it
+    def build_page
+      Folio::Ordinal::Page.create
+    end
+
+    # validate the configured page before returning it
     def configure_pagination(page, options)
-      page = super(::Folio::Ordinal::Page.decorate(page), options)
+      page = super(page, options)
       raise ::Folio::InvalidPage unless page.current_page.is_a?(Integer)
       raise ::Folio::InvalidPage if page.out_of_bounds?
       page

data/lib/folio/page.rb

@@ -64,23 +64,12 @@ module Folio
       (total_entries / per_page.to_f).ceil
     end
 
-    class Decorator < ::SimpleDelegator
-      include Folio::Page
-    end
-
-    class DecoratedArray < Decorator
-      def initialize
-        super []
-      end
-    end
-
-    def self.decorate(collection)
-      collection = Folio::Page::Decorator.new(collection) unless collection.is_a?(Folio::Page)
-      collection
-    end
-
     def self.create
-      Folio::Page::DecoratedArray.new
+      Folio::BasicPage.new
     end
   end
+
+  class BasicPage < Array
+    include Folio::Page
+  end
 end

data/lib/folio/version.rb

@@ -1,3 +1,3 @@
 module Folio
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/folio/will_paginate/active_record.rb

@@ -60,8 +60,6 @@ module Folio
             @target = target
           end
 
-          # needed to prevent Folio::Ordinal#configure_pagination from trying
-          # to decorate it
           include Folio::Ordinal::Page
 
           # called during Folio#configure_pagination, used to build up @rel

data/test/folio/ordinal/page_test.rb

@@ -139,21 +139,21 @@ describe Folio::Ordinal::Page do
     end
   end
 
-  describe "decorate" do
+  describe "BasicPage" do
     before do
-      @page = Folio::Ordinal::Page.decorate([])
+      @page = Folio::Ordinal::BasicPage.new
     end
 
-    it "should add page methods to the object" do
-      assert_respond_to @page, :current_page
+    it "should be an Array" do
+      (Array === @page).must_equal true
     end
 
-    it "should add ordinal page methods to the object" do
-      @page.first_page.must_equal 1
+    it "should be a folio page" do
+      assert_respond_to @page, :current_page
     end
 
-    it "should preserve other methods on the object" do
-      assert_respond_to @page, :each
+    it "should be a ordinal folio page" do
+      @page.first_page.must_equal 1
     end
   end
 
@@ -162,12 +162,8 @@ describe Folio::Ordinal::Page 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
+    it "should be a basic ordinal page" do
+      @page.class.must_equal Folio::Ordinal::BasicPage
     end
   end
 end

data/test/folio/ordinal_test.rb

@@ -5,7 +5,7 @@ describe Folio::Ordinal do
   before do
     klass = Class.new do
       def build_page
-        Folio::Page.create
+        Folio::Ordinal::Page.create
       end
 
       def fill_page(page)
@@ -18,11 +18,6 @@ describe Folio::Ordinal do
   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

data/test/folio/page_test.rb

@@ -168,17 +168,17 @@ describe Folio::Page do
     end
   end
 
-  describe "decorate" do
+  describe "BasicPage" do
     before do
-      @page = Folio::Page.decorate([])
+      @page = Folio::BasicPage.new
     end
 
-    it "should add page methods to the object" do
-      assert_respond_to @page, :current_page
+    it "should be an Array" do
+      (Array === @page).must_equal true
     end
 
-    it "should preserve other methods on the object" do
-      assert_respond_to @page, :each
+    it "should be a folio page" do
+      assert_respond_to @page, :current_page
     end
   end
 
@@ -187,12 +187,8 @@ describe Folio::Page 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
+    it "should be a basic page" do
+      @page.class.must_equal Folio::BasicPage
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: folio-pagination
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-09 00:00:00.000000000 Z
+date: 2013-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler