roar-extensions 0.0.3 → 0.0.4

data/README.md

@@ -27,3 +27,8 @@ TODO: Write usage instructions here
 3. Commit your changes (`git commit -am 'Added some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+## License
+
+`roar-extensions` is released under the [MIT
+License](http://www.opensource.org/licenses/MIT).

data/lib/roar_extensions/kaminari_shim.rb

@@ -0,0 +1,23 @@
+module RoarExtensions
+  class KaminariShim < SimpleDelegator
+    def per_page
+      limit_value
+    end
+
+    def next_page
+      last_page? ? nil : current_page + 1
+    end
+
+    def previous_page
+      first_page? ? nil : current_page - 1
+    end
+
+    def total_pages
+      num_pages
+    end
+
+    def total_entries
+      total_count
+    end
+  end
+end

data/lib/roar_extensions/paginated_collection_presenter.rb

@@ -1,3 +1,4 @@
+require 'roar_extensions/kaminari_shim'
 module RoarExtensions
   class PaginatedCollectionPresenter
     include RoarExtensions::Presenter
@@ -16,6 +17,9 @@ module RoarExtensions
     link(:rel => "previous_page") { page_link(record.previous_page) }
 
     def initialize(record, base_path)
+      unless record.respond_to?(:next_page)
+        record = KaminariShim.new(record)
+      end
       super(record)
       @base_path = base_path
     end

data/lib/roar_extensions/version.rb

@@ -1,3 +1,3 @@
 module RoarExtensions
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/spec/paginated_collection_presenter_spec.rb

@@ -29,148 +29,172 @@ module RoarExtensions
     let(:entries) {[
       TestEntry.new("Bob", 41)
     ]}
-    let(:paginated_result) do
-      mock("Paginated Result", :total_pages   => 3,
-                               :current_page  => current_page,
-                               :next_page     => next_page,
-                               :previous_page => previous_page,
-                               :total_entries => 3,
-                               :collect       => entries,
-                               :per_page      => 1)
-    end
+
     let(:base_path) { "/things" }
     let(:json_options) {{}}
 
-    describe "#to_hash" do
-      let(:presenter)  { PaginatedCollectionPresenter.new(paginated_result,
-                                                          base_path)}
-      subject { JSON.parse(presenter.to_json(json_options))['paginated_collection'] }
-
-      it "includes the total pages" do
-        subject['total_pages'].should == 3
-      end
-
-      it "includes the total entries" do
-        subject['total_entries'].should == 3
-      end
-
-      it "includes the per page" do
-        subject['per_page'].should == 1
-      end
-
-      it "includes the self link" do
-        subject['_links']['self'].should == {"href" => "/things"}
-      end
-
-      it "includes the next_page link" do
-        subject['_links']['next_page'].should == {"href" => "/things?page=2"}
-      end
-
-      it "does not include the previous_page link on the first page" do
-        subject['_links'].should_not have_key('previous_page')
-      end
-
-      it "includes the paginated results under the entries key" do
-        subject['entries'].should == [{'name' => 'Bob',
-                                       'age' => 41,
-                                       'lowercased_name' => 'bob'}]
-      end
-
-      it "includes current_page" do
-        subject["current_page"].should == 1
-      end
+    shared_examples_for "pagination" do
+      describe "#to_hash" do
+        let(:presenter)  { PaginatedCollectionPresenter.new(paginated_result,
+                                                            base_path)}
+        subject { JSON.parse(presenter.to_json(json_options))['paginated_collection'] }
 
-      it "includes next_page" do
-        subject["next_page"].should == 2
-      end
+        it "includes the total pages" do
+          subject['total_pages'].should == 3
+        end
 
-      it "includes previous_page" do
-        subject["previous_page"].should == nil
-      end
+        it "includes the total entries" do
+          subject['total_entries'].should == 3
+        end
 
-      context "on last page" do
-        let(:previous_page) { 2 }
-        let(:current_page)  { 3 }
-        let(:next_page)     { nil }
+        it "includes the per page" do
+          subject['per_page'].should == 1
+        end
 
         it "includes the self link" do
-          subject['_links']['self'].should == {"href" => "/things?page=3"}
+          subject['_links']['self'].should == {"href" => "/things"}
+        end
+
+        it "includes the next_page link" do
+          subject['_links']['next_page'].should == {"href" => "/things?page=2"}
         end
 
-        it "does not include the next_page link" do
-          subject['_links'].should_not have_key('next_page')
+        it "does not include the previous_page link on the first page" do
+          subject['_links'].should_not have_key('previous_page')
         end
 
-        it "includes the previous_page link" do
-          subject['_links']['previous_page'].should == {"href" => "/things?page=2"}
+        it "includes the paginated results under the entries key" do
+          subject['entries'].should == [{'name' => 'Bob',
+                                         'age' => 41,
+                                         'lowercased_name' => 'bob'}]
         end
 
         it "includes current_page" do
-          subject["current_page"].should == 3
+          subject["current_page"].should == 1
         end
 
         it "includes next_page" do
-          subject["next_page"].should == nil
+          subject["next_page"].should == 2
         end
 
         it "includes previous_page" do
-          subject["previous_page"].should == 2
+          subject["previous_page"].should == nil
         end
-      end
 
-      context "middle page" do
-        let(:previous_page) { 1 }
-        let(:current_page)  { 2 }
-        let(:next_page)     { 3 }
+        context "on last page" do
+          let(:previous_page) { 2 }
+          let(:current_page)  { 3 }
+          let(:next_page)     { nil }
 
-        it "includes the self link" do
-          subject['_links']['self'].should == {"href" => "/things?page=2"}
-        end
+          it "includes the self link" do
+            subject['_links']['self'].should == {"href" => "/things?page=3"}
+          end
 
-        it "includes the next_page link" do
-          subject['_links']['next_page'].should == {"href" => "/things?page=3"}
-        end
+          it "does not include the next_page link" do
+            subject['_links'].should_not have_key('next_page')
+          end
 
-        it "includes the previous_page link" do
-          subject['_links']['previous_page'].should == {"href" => "/things"}
-        end
+          it "includes the previous_page link" do
+            subject['_links']['previous_page'].should == {"href" => "/things?page=2"}
+          end
 
-        it "includes current_page" do
-          subject["current_page"].should == 2
-        end
+          it "includes current_page" do
+            subject["current_page"].should == 3
+          end
 
-        it "includes next_page" do
-          subject["next_page"].should == 3
+          it "includes next_page" do
+            subject["next_page"].should == nil
+          end
+
+          it "includes previous_page" do
+            subject["previous_page"].should == 2
+          end
         end
 
-        it "includes previous_page" do
-          subject["previous_page"].should == 1
+        context "middle page" do
+          let(:previous_page) { 1 }
+          let(:current_page)  { 2 }
+          let(:next_page)     { 3 }
+
+          it "includes the self link" do
+            subject['_links']['self'].should == {"href" => "/things?page=2"}
+          end
+
+          it "includes the next_page link" do
+            subject['_links']['next_page'].should == {"href" => "/things?page=3"}
+          end
+
+          it "includes the previous_page link" do
+            subject['_links']['previous_page'].should == {"href" => "/things"}
+          end
+
+          it "includes current_page" do
+            subject["current_page"].should == 2
+          end
+
+          it "includes next_page" do
+            subject["next_page"].should == 3
+          end
+
+          it "includes previous_page" do
+            subject["previous_page"].should == 1
+          end
         end
-      end
 
-      context "attribute whitelisting" do
-        let(:json_options) {{:include => [:name]}}
+        context "attribute whitelisting" do
+          let(:json_options) {{:include => [:name]}}
+
+          it "the include option is passed to the entries" do
+            subject['entries'].should == [{'name' => 'Bob'}]
+          end
+
+          context "using the :from property option" do
+            let(:json_options) {{:include => ["lowercased_name"]}}
 
-        it "the include option is passed to the entries" do
-          subject['entries'].should == [{'name' => 'Bob'}]
+            it "the include option is passed to the entries" do
+              subject['entries'].should == [{'lowercased_name' => 'bob'}]
+            end
+          end
         end
 
-        context "using the :from property option" do
-          let(:json_options) {{:include => ["lowercased_name"]}}
+        context "attribute blacklisting" do
+          let(:json_options) {{:exclude => [:name]}}
 
           it "the include option is passed to the entries" do
-            subject['entries'].should == [{'lowercased_name' => 'bob'}]
+            subject['entries'].should == [{'age' => 41, 'lowercased_name' => 'bob'}]
           end
         end
       end
+    end
+
+    context "will-pagination integration" do
+      let(:paginated_result) do
+        mock("Paginated Result", :total_pages   => 3,
+                                 :current_page  => current_page,
+                                 :next_page     => next_page,
+                                 :previous_page => previous_page,
+                                 :total_entries => 3,
+                                 :collect       => entries,
+                                 :per_page      => 1)
+      end
 
-      context "attribute blacklisting" do
-        let(:json_options) {{:exclude => [:name]}}
+      it_should_behave_like "pagination"
+    end
 
-        it "the include option is passed to the entries" do
-          subject['entries'].should == [{'age' => 41, 'lowercased_name' => 'bob'}]
-        end
+    context "kaminari integration" do
+      let(:is_first_page) { current_page == 1 }
+      let(:is_last_page)  { current_page == 3 }
+      let(:paginated_result) do
+        mock("Paginated Result", :current_page  => current_page,
+                                 :collect       => entries,
+                                 :last_page?    => is_last_page,
+                                 :first_page?   => is_first_page,
+                                 :limit_value   => 1,
+                                 :total_count   => 3,
+                                 :num_pages     => 3)
       end
+
+      it_should_behave_like "pagination"
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: roar-extensions
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-27 00:00:00.000000000 Z
+date: 2012-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: roar
@@ -160,6 +160,7 @@ files:
 - lib/roar_extensions/helpers/embedded_parameter_parsing.rb
 - lib/roar_extensions/hypermedia_extensions.rb
 - lib/roar_extensions/json_hal_extensions.rb
+- lib/roar_extensions/kaminari_shim.rb
 - lib/roar_extensions/link_presenter.rb
 - lib/roar_extensions/money_presenter.rb
 - lib/roar_extensions/paginated_collection_presenter.rb