rest-api-generator 0.1.5 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 04727c112f46dd53f0ab7b45c0e83c13ddd3ae2df45fed5b3aa89cf7fac6efa4
-  data.tar.gz: 8de60fa55662ef20a6390af3da742c5873e3a2499598790afe759e0afae00352
+  metadata.gz: f7576268dec99ae0feafe5da3a552dae8d0609ccd244f5e62a99007e2f54090b
+  data.tar.gz: 0f8a227490885ada7b83f1373c854857889e710b1d24285a81b45490308419a6
 SHA512:
-  metadata.gz: 585ad32f866f1e0374dd6051c91ee898a382ed67b1995c511536e3548ed25cc0731725980570ef814d9782d73803b94fd78183af5eee137ed8a054cfb3ab2850
-  data.tar.gz: 68aedf154d0f0b0472cc082d5cbf8ec47e2276070a60963aa8ab58cbb827221fcde13c709e4d7dcd3341ac6a7787a9373fd7564d904b0595aabd165f009ac41e
+  metadata.gz: 19bbdd850d24d6168fda588274287ad8645b255165487261dd6413420ab395fdc150675d97ed57ac6e2d395f2bf7cc5d48632f3b43bfe2a11f06964aae71b1d7
+  data.tar.gz: 4653ea0a74f2377c9052eba66bb16230096598f5f3e5d52f42ff5ad5141b763b4054359c7bf360083d7e08b517249bf44b17a9a6e64765f51861961075068c65

data/Gemfile.lock

@@ -1,7 +1,9 @@
 PATH
   remote: .
   specs:
-    rest-api-generator (0.1.4)
+    rest-api-generator (0.1.7)
+      anyway_config (>= 2.0.0)
+      pagy
       rails (>= 5.0)
 
 GEM
@@ -78,7 +80,7 @@ GEM
       activesupport (>= 3.0)
       railties (>= 3.0)
       rspec-rails (>= 2.2)
-    anyway_config (2.3.1)
+    anyway_config (2.4.0)
       ruby-next-core (>= 0.14.0)
     ast (2.4.2)
     builder (3.2.4)
@@ -93,7 +95,7 @@ GEM
     date (3.3.3)
     diff-lcs (1.5.0)
     erubi (1.12.0)
-    globalid (1.0.0)
+    globalid (1.1.0)
       activesupport (>= 5.0)
     i18n (1.12.0)
       concurrent-ruby (~> 1.0)
@@ -103,7 +105,7 @@ GEM
     loofah (2.19.1)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
-    mail (2.8.0)
+    mail (2.8.1)
       mini_mime (>= 0.1.1)
       net-imap
       net-pop
@@ -111,6 +113,7 @@ GEM
     marcel (1.0.2)
     method_source (1.0.0)
     mini_mime (1.1.2)
+    mini_portile2 (2.8.1)
     minitest (5.16.3)
     net-imap (0.3.4)
       date
@@ -121,9 +124,13 @@ GEM
       timeout
     net-smtp (0.3.3)
       net-protocol
-    nio4r (2.5.8)
+    nio4r (2.5.9)
+    nokogiri (1.13.10)
+      mini_portile2 (~> 2.8.0)
+      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)
@@ -222,6 +229,8 @@ GEM
       rubocop (~> 1.35)
     ruby-next-core (0.15.3)
     ruby-progressbar (1.11.0)
+    sqlite3 (1.5.4)
+      mini_portile2 (~> 2.8.0)
     sqlite3 (1.5.4-x86_64-linux)
     switchcop (0.1.2)
       rubocop (~> 1.40.0)
@@ -230,7 +239,7 @@ GEM
       rubocop-rspec (~> 2.16.0)
       rubocop-shopify (~> 2.10.1)
     thor (1.2.1)
-    timeout (0.3.1)
+    timeout (0.3.2)
     tzinfo (2.0.5)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.3.0)
@@ -245,7 +254,6 @@ PLATFORMS
 
 DEPENDENCIES
   ammeter (~> 1.1.5)
-  anyway_config (>= 2.0.0)
   database_cleaner
   rake (~> 13.0)
   rest-api-generator!

data/README.md

@@ -24,6 +24,8 @@ 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
 
@@ -243,19 +245,11 @@ This spec options work as generators too, so you can call them individually:
 rails g rest_api_generator:spec:rswag Car name:string color:string
 ```
 
-##### Custom paths
+#### Configuration for specs
 
 By default, the plain rspec and rswag specs are going to be generated in the _spec/requests_ and _spec/docs_
-directories, respectively. You can override this configuration with an initializer inside your project:
+directories, respectively. You can override using the (config options)[#configuration]]. :
 
-```rb
-# config/initializers/rest_api_generator.rb 
-
-RestApiGenerator.configure do |config|
-  config.test_path = "custom_test_dir/requests"
-  config.docs_path = "custom_docs_dir/rswag"
-end
-```
 
 ### Resource Features
 
@@ -301,6 +295,49 @@ 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):
+
+```rb
+# config/initializers/rest_api_generator.rb 
+
+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
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can

data/{lib → 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/{lib → app/controllers}/rest_api_generator/child_resource_controller.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module RestApiGenerator
-  class ChildResourceController < RestApiGenerator.parent_controller.constantize
+  class ChildResourceController < RestApiGenerator.configuration.parent_controller.constantize
     include Orderable
 
     before_action :set_parent_resource
@@ -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/{lib → app/controllers}/rest_api_generator/resource_controller.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module RestApiGenerator
-  class ResourceController < RestApiGenerator.parent_controller.constantize
+  class ResourceController < RestApiGenerator.configuration.parent_controller.constantize
     include Orderable
 
     before_action :set_resource, only: [:show, :update, :destroy]
@@ -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

@@ -2,10 +2,15 @@
 
 require "anyway_config"
 
+Anyway::Settings.default_config_path = ->(_name) { Rails.root ? Rails.root.join("config/rest_api_generator.yml") : "" }
+
 module RestApiGenerator
   class Config < Anyway::Config
     config_name :rest_api_generator
 
-    attr_config test_path: "spec/requests", docs_path: "spec/docs"
+    attr_config test_path: "spec/requests",
+      docs_path: "spec/docs",
+      parent_controller: "RestApiGenerator::ApplicationController",
+      pagination: false
   end
 end

data/lib/rest_api_generator/rails.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module RestApiGenerator
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/rest_api_generator/version.rb

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

data/lib/rest_api_generator.rb

@@ -2,7 +2,6 @@
 
 require "rails"
 require_relative "rest_api_generator/version"
-require_relative "rest_api_generator/application_controller"
 require_relative "rest_api_generator/error_handler"
 require_relative "rest_api_generator/config"
 require_relative "rest_api_generator/custom_error"
@@ -13,20 +12,13 @@ require_relative "rest_api_generator/orderable"
 module RestApiGenerator
   class Error < StandardError; end
 
-  class << self
-    def configuration
-      @configuration ||= Config.new
-    end
-
-    def configure
-      yield(configuration)
-    end
+  def self.configuration
+    @config ||= Config.new
   end
 
-  def self.parent_controller
-    "RestApiGenerator::ApplicationController"
+  def self.configure
+    yield(configuration) if block_given?
   end
 end
 
-require_relative "rest_api_generator/resource_controller"
-require_relative "rest_api_generator/child_resource_controller"
+require "rest_api_generator/rails" if defined?(Rails)

data/rest-api-generator.gemspec

@@ -22,8 +22,13 @@ Gem::Specification.new do |spec|
   spec.metadata["source_code_uri"] = "https://github.com/SwitchDreams/rest-api-generator"
   spec.metadata["changelog_uri"] = "https://github.com/SwitchDreams/rest-api-generator"
 
-  spec.files = Dir["{bin,sig,lib,public}/**/*", "MIT-LICENSE", "Rakefile", "README.md", "rest-api-generator.gemspec",
-    "Gemfile", "Gemfile.lock"]
+  spec.files = Dir["{bin,sig,lib,public,app}/**/*",
+    "MIT-LICENSE",
+    "Rakefile",
+    "README.md",
+    "rest-api-generator.gemspec",
+    "Gemfile",
+    "Gemfile.lock"]
   spec.bindir = "exe"
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
@@ -32,10 +37,11 @@ Gem::Specification.new do |spec|
   # guide at: https://bundler.io/guides/creating_gem.html
   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"
-  spec.add_development_dependency "anyway_config", ">= 2.0.0"
   spec.add_development_dependency "database_cleaner"
   spec.add_development_dependency "rspec-rails", "~> 6.0.0"
   spec.add_development_dependency "rswag"

metadata

@@ -1,57 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: rest-api-generator
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.7
 platform: ruby
 authors:
 - PedroAugustoRamalhoDuarte
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-03-27 00:00:00.000000000 Z
+date: 2023-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: anyway_config
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
-  name: ammeter
+  name: pagy
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.5
-  type: :development
+        version: '0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.5
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: anyway_config
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.0
-  type: :development
+        version: '5.0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: ammeter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.5
 - !ruby/object:Gem::Dependency
   name: database_cleaner
   requirement: !ruby/object:Gem::Requirement
@@ -120,6 +134,9 @@ files:
 - Gemfile.lock
 - README.md
 - Rakefile
+- app/controllers/rest_api_generator/application_controller.rb
+- app/controllers/rest_api_generator/child_resource_controller.rb
+- app/controllers/rest_api_generator/resource_controller.rb
 - bin/console
 - bin/setup
 - lib/generators/rest_api_generator/USAGE
@@ -137,15 +154,13 @@ files:
 - lib/generators/rest_api_generator/templates/rest_api_controller.rb.tt
 - lib/rest-api-generator.rb
 - lib/rest_api_generator.rb
-- lib/rest_api_generator/application_controller.rb
-- lib/rest_api_generator/child_resource_controller.rb
 - lib/rest_api_generator/config.rb
 - lib/rest_api_generator/custom_error.rb
 - lib/rest_api_generator/error_handler.rb
 - lib/rest_api_generator/filterable.rb
 - lib/rest_api_generator/helpers/render.rb
 - lib/rest_api_generator/orderable.rb
-- lib/rest_api_generator/resource_controller.rb
+- lib/rest_api_generator/rails.rb
 - lib/rest_api_generator/version.rb
 - rest-api-generator.gemspec
 - sig/rest_api_generator.rbs