jbuilder_pagination 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b5e96a670102c2f927e59e21c26d90f9b4d2d070
-  data.tar.gz: ee270b6e1ebcd7ac567aa3c5a43e4f18083b5893
+  metadata.gz: d93468a455509e826177eaea7b177366e48fe053
+  data.tar.gz: c578b2e04c6de4ebe37d03a5f0d6bce262d8e305
 SHA512:
-  metadata.gz: 77db3f4d5c32df65b5c68ee9a387b3038c16571c8827d9ce8741517531d96b1302f127c391e24e452b0072660bbc39a41d800af60594e5e7ac707a4692ff48ab
-  data.tar.gz: d4474e11826257048f4261475af2bd28a370012c162c130848f5fd43fba3bc032b83072b181f70791881ae66cb0ba61f1460b911f449e71299c1c962ce38d806
+  metadata.gz: 2739aa4ae51328eb4c552c51681601c1535a99aee191d748753ebeb303910182f0516d03735a1135d282a1ded9cd8029e806ca6e26d528b24bad91a143c109f2
+  data.tar.gz: 1a7073af47cfd214cab2511d6fd375bc65b9015865e262dfe57b2cdac7cfe779bab5bf983e453b841533daad066658f1baf13706910ea1f813bb89cfcb564510

data/.rspec

@@ -1,2 +1 @@
---format documentation
 --color

data/README.md

@@ -4,7 +4,7 @@
 
 ## Requirement
 
-It is based on [will_paginate](https://github.com/mislav/will_paginate).
+`JbuilderPagination` relies on a paginated collection with the methods `current_page`, `total_pages`, and `size`, such as are supported by both [Kaminari](https://github.com/amatsuda/kaminari) or [WillPaginate](https://github.com/mislav/will_paginate).
 
 ## Installation
 
@@ -24,21 +24,42 @@ Or install it yourself as:
 
 ## Usage
 
+###### Kaminari examples
+```ruby
+#array
+@posts = Kaminari.paginate_array([1, 2, 3]).page(3).per(1)
+
+#active_record
+@posts = Post.page(3).per(1)
+```
+
+###### WillPaginate examples
+
+```ruby
+#array
+@posts = [1,2,3].paginate(page: 3, per_page: 1)
+
+#active_record
+@posts = Post.page(3).per_page(1)
+```
+
+And then in your `*.json.jbuilder`
+
 ```ruby
 json.links do
-  json.pages! @servers, url: "https://api.example.com/v1/servers"
+  json.pages! @posts, url: "http://example.com/posts", query_parameters: { additional: 'parameters' }
 end
 
 # =>
-#  "links": {
-#      "pages": {
-#          "first": "https://api.example.com/v1/servers/v1/servers?page=1&per_page=1",
-#          "prev": "https://api.example.com/v1/servers/v1/servers?page=1&per_page=1",
-#          "last": "https://api.example.com/v1/servers/v1/servers?page=3&per_page=1",
-#          "next": "https://api.example.com/v1/servers/v1/servers?page=3&per_page=1"
-#      }
-#  },
+#    "links": {
+#      "self": "http://example.com/posts?page[number]=3&page[size]=1&additional=parameters",
+#      "first": "http://example.com/posts?page[number]=1&page[size]=1&additional=parameters",
+#      "prev": "http://example.com/posts?page[number]=2&page[size]=1&additional=parameters",
+#      "next": "http://example.com/posts?page[number]=4&page[size]=1&additional=parameters",
+#      "last": "http://example.com/posts?page[number]=13&page[size]=1&additional=parameters"
+#    }
 ```
+The options `url` and  `query_parameters` are opcionals.
 
 In case there is no pagination at all, `links` will be omitted.
 

data/lib/jbuilder/pagination/pages.rb

@@ -1,29 +1,41 @@
 class Jbuilder
+  ONE_PAGE = 1
+
   def pages!(collection, options={})
-    return unless collection
+    return unless collection && is_paginated?(collection)
 
-    pages do
-      pages_from(collection).map do |k, v|
-        _set_value k, "#{options[:url]}?page=#{v}&per_page=#{collection.per_page}"
-      end
+    pages_from(collection).map do |key, value|
+      params = query_parameters(options).merge(page: { number: value, size: collection.size }).to_query
+      _set_value key, "#{options.fetch(:url, nil)}?#{params}"
     end
   end
 
   private
 
   def pages_from(collection)
-    return {} if collection.total_pages == 1
-
     {}.tap do |pages|
-      unless collection.current_page == 1
-        pages[:first] = 1
-        pages[:prev]  = collection.current_page - 1
+      pages[:self] = collection.current_page
+      return pages if collection.total_pages == ONE_PAGE
+
+      unless collection.current_page == ONE_PAGE
+        pages[:first] = ONE_PAGE
+        pages[:prev]  = collection.current_page - ONE_PAGE
       end
 
       unless collection.current_page == collection.total_pages
+        pages[:next] = collection.current_page + ONE_PAGE
         pages[:last] = collection.total_pages
-        pages[:next] = collection.current_page + 1
       end
     end
   end
+
+  def query_parameters(options)
+    @query_parameters ||= options.fetch(:query_parameters, {})
+  end
+
+  def is_paginated?(collection)
+    collection.respond_to?(:current_page) &&
+      collection.respond_to?(:total_pages) &&
+      collection.respond_to?(:size)
+  end
 end

data/lib/jbuilder/pagination/version.rb

@@ -1,5 +1,5 @@
 module Jbuilder
   class Pagination
-    VERSION = "0.0.1"
+    VERSION = "1.0.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jbuilder_pagination
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Bruno Bacarini
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-04-23 00:00:00.000000000 Z
+date: 2015-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jbuilder
@@ -122,7 +122,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Jbuilder extension to allows pagination according to JSON API format