repres-dosser 1.4.1 → 1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1a42891d206e59f30ee7288b9081d1a89b8c305c
-  data.tar.gz: 877892ae132a390ed97c2cfd443099457e3513f9
+  metadata.gz: 232b89400fa5b292d47c11b04180d4189793a9f8
+  data.tar.gz: cd9291a3e4fb5d31850ef40896c11ea30676e6aa
 SHA512:
-  metadata.gz: 74546e080b6e2f34d26134a22aa39b376fbe78e92efb8758ade1b5d8ecfe3dd8fa2f62df656656d6c7b8ee3f3f1fd7aa669144f317035c852e78facab3510def
-  data.tar.gz: 0bef3cd90b48d02788e520eb776b1b57028559f19a00925ed3bea77fd8ab79a1f4cc91136ebe080de0f778d809becdcf203c16e640f28fdeb0bd6e16d105b471
+  metadata.gz: 3f04925a73b936ff5099bb3fe8c2fe046e64158dd408fc43461fa672ca1fa5958da6531672c260dede3c6793e312d28b6e104217fe7b356e60541868cc95288c
+  data.tar.gz: 5e162d288aa1ac41e221d26cea101ee1d4844173f2b86f1b29a04a39509e32a52e083198f7c797f81404df2c31eb7cff57d8da9211424aaf5d98a995bd0e59af

data/README.md

@@ -39,3 +39,26 @@ The following responding methods are supported:
 - 404 render_not_found
 - 409 render_conflict
 - 500 render_internal_server_error
+
+### Pagination
+```ruby
+include Repres::Dosser::Concerns::ResourcePresentation
+
+paginate total_items: 108, per_page: 10, current_page: 2
+# The pagination will be added into the meta of the response body.
+```
+
+```javascript
+onIndexResourceSuccess: function(data, textStatus, jqXHR)
+{
+  var pagination = data.meta.pagination;
+  console.info('Here are '+pagination.total_items+' items totally.');
+  console.info('Ideally '+pagination.per_page+' items on each page.');
+  console.info('The current page is '+pagination.current_page+'.');
+  // If the required current_page is greater than the total_pages, the current_page is changed to be equal the total_pages.
+  // If the required current_page is less than 1, the current_page is changed to 1. The current_page starts from 1.
+  console.info('Here are '+pagination.total_pages+' pages totally.');
+  console.info('Here are '+pagination.items_on_current_pages+' items on the current page.');
+  console.info('The item index is from '+pagination.min_item_on_current_page+' to '+pagination.max_item_on_current_page+' on the current page.');
+}
+```

data/app/controllers/repres/dosser/concerns/resource_presentation.rb

@@ -10,7 +10,7 @@ module Repres::Dosser::Concerns::ResourcePresentation
   CODE_FAILURE_WRONG_PARAMETER = 'failure-wrong-parameter'.freeze
   CODE_FAILURE_WRONG_STATE     = 'failure-wrong-state'.freeze
 
-  self.included do |includer|
+  included do |includer|
 
     attr_writer :criteria
 
@@ -201,8 +201,28 @@ module Repres::Dosser::Concerns::ResourcePresentation
         errors:     errors
     end
 
+    def paginate(total_items: 0, per_page: 0, current_page: 1)
+      total_items  = total_items.to_i
+      per_page     = per_page.to_i
+      current_page = current_page.to_i
+
+      raise ArgumentError.new('The total_items argument should be a positive integer.') if total_items<=0
+      raise ArgumentError.new('The per_page argument should be a positive integer.')    if per_page<=0
+
+      current_page = 1 if current_page<=0
+      total_pages  = total_items/per_page+(total_items%per_page>0 ? 1 : 0)
+      current_page = [ current_page, total_pages ].min
+      min_item_on_current_page = per_page*(current_page-1)+1
+      max_item_on_current_page = [ per_page*current_page, total_items ].min
+      items_on_current_page    = max_item_on_current_page-min_item_on_current_page+1
+
+      @pagination = { total_items: total_items, per_page: per_page, current_page: current_page, total_pages: total_pages, min_item_on_current_page: min_item_on_current_page, max_item_on_current_page: max_item_on_current_page, items_on_current_page: items_on_current_page }
+
+    end
+
     def respond_result(status, result)
       result[:meta] = { criteria: @criteria, request_id: request.uuid, timestamp: Time.now.to_i }
+      result[:meta][:pagination] = @pagination if @pagination.present?
       respond_to do |format|
         format.json do render status: status, json: result end
         format.xml  do render status: status, xml:  result end

data/lib/repres/dosser/version.rb

@@ -1,5 +1,5 @@
 module Repres
   module Dosser
-    VERSION = '1.4.1'.freeze
+    VERSION = '1.5'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: repres-dosser
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: '1.5'
 platform: ruby
 authors:
 - Topbit Du
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-29 00:00:00.000000000 Z
+date: 2016-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails