rest-api-generator 0.1.3 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a3c84db27490fa76b76096f10ba351092bfb42479890a2a279d725f579c4edb7
-  data.tar.gz: 25e537cd496a09eb3b5755fadf4d04bbcaad38c941bf54af60e230ed7a1ccd13
+  metadata.gz: 04727c112f46dd53f0ab7b45c0e83c13ddd3ae2df45fed5b3aa89cf7fac6efa4
+  data.tar.gz: 8de60fa55662ef20a6390af3da742c5873e3a2499598790afe759e0afae00352
 SHA512:
-  metadata.gz: a0f07b832a6373ed5197f114a0bdc54c6a6c2088d712e3641b8d55d717a5d5b019bba3427907b73495ac6a97de2bfbdd68ee48de267651808cf3d6adbe9f2547
-  data.tar.gz: 565c3cc7797794a6c59008990e58727173c5fa472ef8a8a188cb2a2ba60789cf03994ba8feaff7d8d5dfcf3443333412ece5dbb926f5a44156fa71ad240531b0
+  metadata.gz: 585ad32f866f1e0374dd6051c91ee898a382ed67b1995c511536e3548ed25cc0731725980570ef814d9782d73803b94fd78183af5eee137ed8a054cfb3ab2850
+  data.tar.gz: 68aedf154d0f0b0472cc082d5cbf8ec47e2276070a60963aa8ab58cbb827221fcde13c709e4d7dcd3341ac6a7787a9373fd7564d904b0595aabd165f009ac41e

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rest-api-generator (0.1.3)
+    rest-api-generator (0.1.4)
       rails (>= 5.0)
 
 GEM
@@ -78,6 +78,8 @@ GEM
       activesupport (>= 3.0)
       railties (>= 3.0)
       rspec-rails (>= 2.2)
+    anyway_config (2.3.1)
+      ruby-next-core (>= 0.14.0)
     ast (2.4.2)
     builder (3.2.4)
     concurrent-ruby (1.1.10)
@@ -218,6 +220,7 @@ 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-x86_64-linux)
     switchcop (0.1.2)
@@ -237,10 +240,12 @@ GEM
     zeitwerk (2.6.6)
 
 PLATFORMS
+  ruby
   x86_64-linux
 
 DEPENDENCIES
   ammeter (~> 1.1.5)
+  anyway_config (>= 2.0.0)
   database_cleaner
   rake (~> 13.0)
   rest-api-generator!

data/README.md

@@ -243,6 +243,20 @@ 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
+
+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:
+
+```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
 
 #### Modular Error Handler

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
 
@@ -71,22 +72,24 @@ module RestApiGenerator
     def nested_routes
       return "" if options["father"].blank?
 
-      "#{options["father"].downcase.pluralize}/\#{#{options["father"].singularize.downcase}.id}/#{plural_name}"
+      "#{options["father"].downcase.pluralize}/\#{#{options["father"].singularize.downcase}.id}"
     end
 
     def initial_route
-      return "/#{plural_name}" if options["father"].blank? && options["scope"].blank?
-
-      scope_route_path + "/" + nested_routes
+      route = ""
+      route += scope_route_path if options["scope"].present?
+      route += options["father"].present? && route.present? ? "/#{nested_routes}" : nested_routes
+      route += "/#{plural_name}"
+      route[0] == "/" ? route : "/#{route}"
     end
 
     def spec_routes
       {
         index: initial_route,
-        show: initial_route + "\#{#{singular_name}.id}",
+        show: initial_route + "/\#{#{singular_name}.id}",
         create: initial_route,
-        update: initial_route + "\#{#{singular_name}.id}",
-        delete: initial_route + "\#{#{singular_name}.id}",
+        update: initial_route + "/\#{#{singular_name}.id}",
+        delete: initial_route + "/\#{#{singular_name}.id}",
       }
     end
   end

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

@@ -26,9 +26,9 @@ module RestApiGenerator
 
       def spec_controller_template
         if options["father"].present?
-          "rspec/resource_controller_spec.rb"
-        else
           "rspec/nested_resource_controller_spec.rb"
+        else
+          "rspec/resource_controller_spec.rb"
         end
       end
     end

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

@@ -25,7 +25,7 @@ module RestApiGenerator
       def nested_routes
         return "" if options["father"].blank?
 
-        "#{options["father"].downcase.pluralize}/{#{options["father"].singularize.downcase}_id}/#{plural_name}"
+        "#{options["father"].downcase.pluralize}/{#{options["father"].singularize.downcase}_id}"
       end
 
       def spec_routes
@@ -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/generators/rest_api_generator/spec/templates/rspec/resource_controller_spec.rb.tt

@@ -38,7 +38,7 @@ RSpec.describe "<%= class_name %>", type: :request do
 
   describe "DELETE /<%= plural_name %>/:id" do
     it "deletes an <%= plural_name %>" do
-      item = create(:<%= singular_name %>)
+      <%= singular_name %> = create(:<%= singular_name %>)
       expect do
         delete "<%= spec_routes[:delete] %>"
       end.to change(<%= class_name %>, :count).by(-1)

data/lib/rest_api_generator/config.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "anyway_config"
+
+module RestApiGenerator
+  class Config < Anyway::Config
+    config_name :rest_api_generator
+
+    attr_config test_path: "spec/requests", docs_path: "spec/docs"
+  end
+end

data/lib/rest_api_generator/version.rb

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

data/lib/rest_api_generator.rb

@@ -4,6 +4,7 @@ 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,6 +13,16 @@ 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
+  end
+
   def self.parent_controller
     "RestApiGenerator::ApplicationController"
   end

data/rest-api-generator.gemspec

@@ -35,6 +35,7 @@ Gem::Specification.new do |spec|
   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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rest-api-generator
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.5
 platform: ruby
 authors:
 - PedroAugustoRamalhoDuarte
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-01-06 00:00:00.000000000 Z
+date: 2023-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.1.5
+- !ruby/object:Gem::Dependency
+  name: anyway_config
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: database_cleaner
   requirement: !ruby/object:Gem::Requirement
@@ -125,6 +139,7 @@ files:
 - 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
@@ -158,7 +173,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