rest-api-generator 0.1.4 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4873b5f52ba8ca76abbc7449e0c0398ee1d38fbfb47ebec80dabb293b3ca0cea
-  data.tar.gz: bd96d06619b7a14eb9e6b953d60bc6a2f84bb7d48b0cca5181c0a588bb066cba
+  metadata.gz: 2856805f0d16c6778be959778e29681c2e6ce306d9b3699e6e766da7f605948b
+  data.tar.gz: f9ffabaa5ee380f54ab19a8ad88ddd58de27ee968e44e4ad64794d0110b6979f
 SHA512:
-  metadata.gz: 7cd7f1d823c9b0abba38301024eefb393eb460b10a0ff92e41b7f377b401f09f37771afd039701539fd697a4612e0b0a46ef99b6eccf81d118a23e5fff63bfbb
-  data.tar.gz: dbb337a4c098fdc2b04e71456b5664be8ca670fdd277436cf05111897a7f72ac0559bd47bacf840c6248406aae0e931506e00ad6f3715d9f22da4a9a30984b90
+  metadata.gz: e92f35591532264731ac9acd69117082954c1ac342a89f298d40c60a11dfee9b02b9f2bc5f9e75251ced9937929d900bbfc8491a00b070220bed04c73f81f014
+  data.tar.gz: 5914b7f9b6eb86efbf11ffb1497db57fa9ffec03ce9d4978cfae19e3d6425c52b5ab2fdc564c7baf3ec5acad478ec9d86cbccef19be253389176aee8bb7a2a3c

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    rest-api-generator (0.1.4)
+    rest-api-generator (0.1.5)
+      anyway_config (>= 2.0.0)
       rails (>= 5.0)
 
 GEM
@@ -78,6 +79,8 @@ GEM
       activesupport (>= 3.0)
       railties (>= 3.0)
       rspec-rails (>= 2.2)
+    anyway_config (2.4.0)
+      ruby-next-core (>= 0.14.0)
     ast (2.4.2)
     builder (3.2.4)
     concurrent-ruby (1.1.10)
@@ -91,7 +94,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)
@@ -101,7 +104,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
@@ -109,6 +112,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
@@ -119,7 +123,10 @@ 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)
     parallel (1.22.1)
@@ -218,7 +225,10 @@ GEM
       rubocop (~> 1.33)
     rubocop-shopify (2.10.1)
       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)
@@ -227,7 +237,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)
@@ -237,6 +247,7 @@ GEM
     zeitwerk (2.6.6)
 
 PLATFORMS
+  ruby
   x86_64-linux
 
 DEPENDENCIES

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)
+- [Configurable](#configuration)
 
 ## Next Features
 
@@ -243,6 +244,12 @@ 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
 ```
 
+#### 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 using the (config options)[#configuration]]. :
+
+
 ### Resource Features
 
 #### Modular Error Handler
@@ -287,6 +294,20 @@ And It's done, you can filter your index end-point:
 
 - `GET /cars?color=blue or GET /cars?color=red&name=Ferrari`
 
+## 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
+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/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

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]

data/lib/generators/rest_api_generator/helpers.rb

@@ -5,7 +5,8 @@ module RestApiGenerator
     attr_accessor :options, :attributes
 
     API_CONTROLLER_DIR_PATH = "app/controllers"
-    API_TEST_DIR_PATH = "spec/requests"
+    API_TEST_DIR_PATH = RestApiGenerator.configuration.test_path
+    API_DOCS_DIR_PATH = RestApiGenerator.configuration.docs_path
 
     private
 

data/lib/generators/rest_api_generator/spec/rswag_generator.rb

@@ -39,7 +39,7 @@ module RestApiGenerator
       end
 
       def controller_test_path
-        "#{API_TEST_DIR_PATH}#{scope_path}/#{file_name.pluralize}_spec.rb"
+        "#{API_DOCS_DIR_PATH}#{scope_path}/#{file_name.pluralize}_spec.rb"
       end
 
       def spec_controller_template

data/lib/rest_api_generator/config.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+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",
+      parent_controller: "RestApiGenerator::ApplicationController"
+  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.4"
+  VERSION = "0.1.6"
 end

data/lib/rest_api_generator.rb

@@ -2,8 +2,8 @@
 
 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"
 require_relative "rest_api_generator/helpers/render"
 require_relative "rest_api_generator/filterable"
@@ -12,10 +12,13 @@ require_relative "rest_api_generator/orderable"
 module RestApiGenerator
   class Error < StandardError; end
 
-  def self.parent_controller
-    "RestApiGenerator::ApplicationController"
+  def self.configuration
+    @config ||= Config.new
+  end
+
+  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,6 +37,7 @@ 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 "rails", ">= 5.0"
 
   spec.add_development_dependency "ammeter", "~> 1.1.5"

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: rest-api-generator
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.6
 platform: ruby
 authors:
 - PedroAugustoRamalhoDuarte
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-01-06 00:00:00.000000000 Z
+date: 2023-04-11 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: anyway_config
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -106,6 +120,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
@@ -123,14 +140,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
@@ -158,7 +174,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
 summary: Build a Ruby on Rails REST API faster