rest-api-generator 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2856805f0d16c6778be959778e29681c2e6ce306d9b3699e6e766da7f605948b
-  data.tar.gz: f9ffabaa5ee380f54ab19a8ad88ddd58de27ee968e44e4ad64794d0110b6979f
+  metadata.gz: f7576268dec99ae0feafe5da3a552dae8d0609ccd244f5e62a99007e2f54090b
+  data.tar.gz: 0f8a227490885ada7b83f1373c854857889e710b1d24285a81b45490308419a6
 SHA512:
-  metadata.gz: e92f35591532264731ac9acd69117082954c1ac342a89f298d40c60a11dfee9b02b9f2bc5f9e75251ced9937929d900bbfc8491a00b070220bed04c73f81f014
-  data.tar.gz: 5914b7f9b6eb86efbf11ffb1497db57fa9ffec03ce9d4978cfae19e3d6425c52b5ab2fdc564c7baf3ec5acad478ec9d86cbccef19be253389176aee8bb7a2a3c
+  metadata.gz: 19bbdd850d24d6168fda588274287ad8645b255165487261dd6413420ab395fdc150675d97ed57ac6e2d395f2bf7cc5d48632f3b43bfe2a11f06964aae71b1d7
+  data.tar.gz: 4653ea0a74f2377c9052eba66bb16230096598f5f3e5d52f42ff5ad5141b763b4054359c7bf360083d7e08b517249bf44b17a9a6e64765f51861961075068c65

data/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    rest-api-generator (0.1.5)
+    rest-api-generator (0.1.7)
       anyway_config (>= 2.0.0)
+      pagy
       rails (>= 5.0)
 
 GEM
@@ -129,6 +130,7 @@ GEM
       racc (~> 1.4)
     nokogiri (1.13.10-x86_64-linux)
       racc (~> 1.4)
+    pagy (6.0.3)
     parallel (1.22.1)
     parser (3.1.3.0)
       ast (~> 2.4.1)

data/README.md

@@ -24,6 +24,7 @@ Following [Switch Dreams's](https://www.switchdreams.com.br/]) coding practices,
 - :memo: [Automated documentation](#specsdocs)
 - [Resource ordering](#ordering)
 - [Resource filter](#filtering)
+- [Resource pagination](#pagination)
 - [Configurable](#configuration)
 
 ## Next Features
@@ -294,6 +295,34 @@ And It's done, you can filter your index end-point:
 
 - `GET /cars?color=blue or GET /cars?color=red&name=Ferrari`
 
+### Pagination
+
+For pagination, you need to create pagy initialializer file (pagy.rb) in the config directory of your project. Follow [pagy's example](https://ddnexus.github.io/pagy/quick-start/) for more information.
+
+Next, you should add some lines on top of the previously created pagy file:
+
+```ruby
+# config/initializers/pagy.rb
+require "pagy"
+require "pagy/extras/headers"
+```
+
+At last, change the pagination variable on RestApiGenerator initializer to true;
+
+```rb
+# config/initializers/rest_api_generator.rb 
+config.pagination = true # default: false
+```
+
+Note, if the parent controller is changed, it is necessary to include Pagy::Backend in the new parent.
+
+```rb
+# new_parent_controller.rb 
+class NewParentController < ActionController::Base
+  include Pagy::Backend
+end
+```
+
 ## Configuration
 
 You can override this gem configuration using the initializer or any other method from [anyway_config](https://github.com/palkan/anyway_config):
@@ -305,6 +334,7 @@ RestApiGenerator.configure do |config|
   config.test_path = "custom_test_dir/requests" # default: spec/requests
   config.docs_path = "custom_docs_dir/rswag" # default: spec/docs
   config.parent_class = "ApplicationController" # default: RestApiGenerator::ResourceController
+  config.pagination = true # default: false
 end
 ```
 

data/app/controllers/rest_api_generator/application_controller.rb

@@ -4,5 +4,6 @@ require "action_controller"
 
 module RestApiGenerator
   class ApplicationController < ActionController::Base
+    include Pagy::Backend
   end
 end

data/app/controllers/rest_api_generator/child_resource_controller.rb

@@ -11,6 +11,10 @@ module RestApiGenerator
       @resources = resources
       @resources = @resources.filter_resource(params_for_filter) if resource_class.include?(Filterable)
       @resources = @resources.order(ordering_params(params[:sort])) if params[:sort]
+      if pagination
+        @pagy, @resources = pagy(@resources)
+        pagy_headers_merge(@pagy)
+      end
       render json: @resources, status: :ok
     end
 
@@ -93,5 +97,9 @@ module RestApiGenerator
     def record_id
       params.permit(:id)[:id]
     end
+
+    def pagination
+      RestApiGenerator.configuration.pagination
+    end
   end
 end

data/app/controllers/rest_api_generator/resource_controller.rb

@@ -10,6 +10,10 @@ module RestApiGenerator
       @resources = resource_class.all
       @resources = @resources.filter_resource(params_for_filter) if resource_class.include?(Filterable)
       @resources = @resources.order(ordering_params(params[:sort])) if params[:sort]
+      if pagination
+        @pagy, @resources = pagy(@resources)
+        pagy_headers_merge(@pagy)
+      end
       render json: @resources, status: :ok
     end
 
@@ -69,5 +73,9 @@ module RestApiGenerator
     def record_id
       params.permit(:id)[:id]
     end
+
+    def pagination
+      RestApiGenerator.configuration.pagination
+    end
   end
 end

data/lib/rest_api_generator/config.rb

@@ -10,6 +10,7 @@ module RestApiGenerator
 
     attr_config test_path: "spec/requests",
       docs_path: "spec/docs",
-      parent_controller: "RestApiGenerator::ApplicationController"
+      parent_controller: "RestApiGenerator::ApplicationController",
+      pagination: false
   end
 end

data/lib/rest_api_generator/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RestApiGenerator
-  VERSION = "0.1.6"
+  VERSION = "0.1.7"
 end

data/rest-api-generator.gemspec

@@ -38,6 +38,7 @@ Gem::Specification.new do |spec|
   spec.metadata["rubygems_mfa_required"] = "true"
 
   spec.add_dependency "anyway_config", ">= 2.0.0"
+  spec.add_dependency "pagy"
   spec.add_dependency "rails", ">= 5.0"
 
   spec.add_development_dependency "ammeter", "~> 1.1.5"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rest-api-generator
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - PedroAugustoRamalhoDuarte
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-04-11 00:00:00.000000000 Z
+date: 2023-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: anyway_config
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: pagy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement