captive-api 1.2.0 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e72b812dfba5731acc69f880513c4d445b6cc116ba1414769b7b2a80fe2ff059
-  data.tar.gz: 54aa16d8fef4481576db2a1b516370425028daeafdfba386ff39d59b76a554b2
+  metadata.gz: 4a01f0b4ab99a8be426c2493906cf594c2bb83b2352fa8f349a40ecd874e124e
+  data.tar.gz: c76b53de10722bbc7742407e2e0a92941575ecab744cb0151f5fdb9e1f957b8b
 SHA512:
-  metadata.gz: c6ce7a15f9fe66265869f616b720d99b8adb4b2a4050db0a8cc86e61f8c8ab44dfa5de70d201a9dbac589b8f399ad909667bf605ac210347b331474253fa728b
-  data.tar.gz: e901f2a5e2e65a91f4f5602dd8528db230d73af5bc757eeb992c2bd7b2243c3136b56485d0f790656bf1433adb5f9342a50bbfe152c80fd328d1eab6aac65713
+  metadata.gz: 7e1d3821a3ce9666244d936ceb5efac1a6cd4b3fb6f9cb9088b47143fd6a2a410be4565014c16cf487af025eb5dd8bf171ba1fa1ad3ec75541c6eea666fc9ff5
+  data.tar.gz: 6cfabdb966ab7241844caf91e2dfa78db26bf5cb7afcb126822ac8ae661c6b3bb9f6cdf89ff933f0a5460758d9f2c00287782d03c7b068e248591a9fd7568d75

data/README.md

@@ -27,6 +27,31 @@ The class `Captive::Api::ApplicationController` includes 2 concerns :
 | [pagination](https://github.com/Captive-Studio/captive-api/blob/main/app/controllers/concerns/api/pagination_concern.rb) | Logique de pagination pour les index |
 | [render error](https://github.com/Captive-Studio/captive-api/blob/main/app/controllers/concerns/api/render_error_concern.rb) | Attrape certaines erreurs pour retourner une page d'erreur en json. Permet aussi d'utiliser les méthodes pour rendre des pages d'erreur json manuellement |
 
+### PaginationConcern
+
+#### `#pagination`
+
+You can use the pagination method like this : 
+
+```ruby
+@tenues = @tenues.page(pagination[:page])
+                 .per(pagination[:per_page])
+```
+
+*The method `page` and `per` come from [will_paginate](https://github.com/mislav/will_paginate)*
+
+The pagination method return an hash like this : 
+
+```ruby
+{ page: 1, per_page: 10 }
+```
+
+⚠️ The first page is `1` and not `0` !
+
+### RenderErrorConcern
+
+TODO
+
 ## Installation
 Add this line to your application's Gemfile:
 

data/app/controllers/concerns/api/pagination_concern.rb

@@ -10,15 +10,18 @@ module Api
   module PaginationConcern
     extend ActiveSupport::Concern
 
-    included do
-      MAX_ITEMS_PAR_PAGE = 100
-      DEFAULT_NB_ITEMS_PAR_PAGE = 10
+    included do |base|
+      base.const_set :MAX_ITEMS_PAR_PAGE, 100
+      base.const_set :DEFAULT_NB_ITEMS_PAR_PAGE, 10
 
       def pagination
-        par_page = (params[:per_page] || DEFAULT_NB_ITEMS_PAR_PAGE).to_i
-        par_page = MAX_ITEMS_PAR_PAGE if par_page > MAX_ITEMS_PAR_PAGE
-        page = (params[:page] || 1).to_i
-        @pagination ||= { page: page, per_page: par_page }
+        @pagination ||=
+          begin
+            par_page = (params[:per_page] || self.class::DEFAULT_NB_ITEMS_PAR_PAGE).to_i
+            par_page = self.class::MAX_ITEMS_PAR_PAGE if par_page > self.class::MAX_ITEMS_PAR_PAGE
+            page = (params[:page] || 1).to_i
+            { page: page, per_page: par_page }
+          end
       end
     end
   end

data/lib/captive/api/version.rb

@@ -1,5 +1,5 @@
 module Captive
   module Api
-    VERSION = "1.2.0".freeze
+    VERSION = "1.2.2".freeze
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: captive-api
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.2
 platform: ruby
 authors:
 - Captive
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-07-03 00:00:00.000000000 Z
+date: 2023-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails