rest-api-generator 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf4062a70bed1e9006d96375d4110b3918f3bf5d074304c4619abfa4fe33eb03
-  data.tar.gz: ba52d11b288dd8004e68327a8db4aabac8bef8be93eea85382f3bf349406ea39
+  metadata.gz: a3c84db27490fa76b76096f10ba351092bfb42479890a2a279d725f579c4edb7
+  data.tar.gz: 25e537cd496a09eb3b5755fadf4d04bbcaad38c941bf54af60e230ed7a1ccd13
 SHA512:
-  metadata.gz: a1ef3d60ca714e5edf5db7cdcf6b0287ef22c2123c907070cb3b6608ca159ceba200642a8b45894cb88e0fab73d5abaeb728e19a05c9e2760cd0e17ccb155732
-  data.tar.gz: 9849fa88d3b3a9f5a070c7f4a4ca29fc3deb8447adb80260004aa68076cd0a27db9cbeb5d214aed2505df4a1c1a48e26378dc41b6626159eb635d1a7d2c0218e
+  metadata.gz: a0f07b832a6373ed5197f114a0bdc54c6a6c2088d712e3641b8d55d717a5d5b019bba3427907b73495ac6a97de2bfbdd68ee48de267651808cf3d6adbe9f2547
+  data.tar.gz: 565c3cc7797794a6c59008990e58727173c5fa472ef8a8a188cb2a2ba60789cf03994ba8feaff7d8d5dfcf3443333412ece5dbb926f5a44156fa71ad240531b0

data/Gemfile

@@ -10,3 +10,5 @@ gem "rake", "~> 13.0"
 gem "rspec", "~> 3.0"
 
 gem "switchcop"
+
+gem "sqlite3"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rest-api-generator (0.1.2)
+    rest-api-generator (0.1.3)
       rails (>= 5.0)
 
 GEM
@@ -72,6 +72,8 @@ GEM
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
     ammeter (1.1.5)
       activesupport (>= 3.0)
       railties (>= 3.0)
@@ -94,6 +96,8 @@ GEM
     i18n (1.12.0)
       concurrent-ruby (~> 1.0)
     json (2.6.3)
+    json-schema (3.0.0)
+      addressable (>= 2.8)
     loofah (2.19.1)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
@@ -121,6 +125,7 @@ GEM
     parallel (1.22.1)
     parser (3.1.3.0)
       ast (~> 2.4.1)
+    public_suffix (5.0.1)
     racc (1.6.2)
     rack (2.2.4)
     rack-test (2.0.2)
@@ -176,6 +181,20 @@ GEM
       rspec-mocks (~> 3.11)
       rspec-support (~> 3.11)
     rspec-support (3.12.0)
+    rswag (2.8.0)
+      rswag-api (= 2.8.0)
+      rswag-specs (= 2.8.0)
+      rswag-ui (= 2.8.0)
+    rswag-api (2.8.0)
+      railties (>= 3.1, < 7.1)
+    rswag-specs (2.8.0)
+      activesupport (>= 3.1, < 7.1)
+      json-schema (>= 2.2, < 4.0)
+      railties (>= 3.1, < 7.1)
+      rspec-core (>= 2.14)
+    rswag-ui (2.8.0)
+      actionpack (>= 3.1, < 7.1)
+      railties (>= 3.1, < 7.1)
     rubocop (1.40.0)
       json (~> 2.3)
       parallel (~> 1.10)
@@ -227,6 +246,8 @@ DEPENDENCIES
   rest-api-generator!
   rspec (~> 3.0)
   rspec-rails (~> 6.0.0)
+  rswag
+  rswag-specs
   sqlite3
   switchcop
 

data/README.md

@@ -20,14 +20,13 @@ Following [Switch Dreams's](https://www.switchdreams.com.br/]) coding practices,
 
 - [Automatic rest api crud generation](#example)
 - [Nested Resource](#nested-resource)
-- [Modular error handler](#modular-error-handler)
+- :goal_net: [Modular error handler](#modular-error-handler)
+- :memo: [Automated documentation](#specsdocs)
 - [Resource ordering](#ordering)
 - [Resource filter](#filtering)
 
 ## Next Features
 
-- Generate nested resource end-points 🚧
-- Automated documentation 🚧 https://github.com/SwitchDreams/rest-api-generator/issues/12
 - Serialization https://github.com/SwitchDreams/rest-api-generator/issues/14
   https://github.com/SwitchDreams/rest-api-generator/issues/11
 - Pagination https://github.com/SwitchDreams/rest-api-generator/issues/15
@@ -116,6 +115,7 @@ For a better experience you can override some methods from the
 | father | Generate nested resource                                     | nil     | --father Users  |
 | scope  | Scope the resource for other route or namespace organization | nil     | --scope Api::V1 |
 | eject  | Eject the controller to high customization                   | false   | true            |
+| spec   | Choose the spec format. Current options: "rspec" or "rswag"  | rspec   | --spec rswag    |
 
 #### Scope
 
@@ -225,6 +225,24 @@ class CarsController < ApplicationController
 end
 ```
 
+#### Specs/Docs
+
+The default generated spec for this gem is using plain rspec, but you can choose rswag, for scaffold you specs and docs
+at the same time:
+
+For this you need to setup https://github.com/rswag/rswag and you the following flag when generating resources.
+
+```shell
+rails g rest_api_generator:resource Car name:string color:string --spec rswag
+```
+
+This spec options work as generators too, so you can call them individually:
+
+```shell
+# rest_api_generator:spec:rswag or rest_api_generator:spec:rspec
+rails g rest_api_generator:spec:rswag Car name:string color:string
+```
+
 ### Resource Features
 
 #### Modular Error Handler

data/lib/generators/rest_api_generator/helpers.rb

@@ -4,8 +4,12 @@ module RestApiGenerator
   module Helpers
     attr_accessor :options, :attributes
 
+    API_CONTROLLER_DIR_PATH = "app/controllers"
+    API_TEST_DIR_PATH = "spec/requests"
+
     private
 
+    # Columns handlers
     def model_columns_for_attributes
       class_name.singularize.constantize.columns.reject do |column|
         column.name.to_s =~ /^(id|user_id|created_at|updated_at)$/
@@ -18,6 +22,42 @@ module RestApiGenerator
       end
     end
 
+    # Namespace scope
+
+    def scope_namespacing(&block)
+      content = capture(&block)
+      content = wrap_with_scope(content) if options["scope"].present? || options["father"].present?
+      concat(content)
+    end
+
+    def module_namespace
+      if options["scope"].present? && options["father"].present?
+        options["scope"] + "::" + options["father"]
+      else
+        options["scope"] + options["father"]
+      end
+    end
+
+    def wrap_with_scope(content)
+      content = indent(content).chomp
+      "module #{module_namespace}\n#{content}\nend\n"
+    end
+
+    # Paths handlers
+    def controller_path
+      "#{API_CONTROLLER_DIR_PATH}#{scope_path}/#{file_name.pluralize}_controller.rb"
+    end
+
+    def scope_path
+      return "" if options["scope"].blank? && options["father"].blank?
+
+      if options["scope"].present? && options["father"].present?
+        "/" + option_to_path(options["scope"]) + "/" + option_to_path(options["father"])
+      else
+        "/" + option_to_path(options["scope"]) + option_to_path(options["father"])
+      end
+    end
+
     def option_to_path(option)
       option.downcase.split("::").join("/")
     end
@@ -35,6 +75,8 @@ module RestApiGenerator
     end
 
     def initial_route
+      return "/#{plural_name}" if options["father"].blank? && options["scope"].blank?
+
       scope_route_path + "/" + nested_routes
     end
 

data/lib/generators/rest_api_generator/resource_generator.rb

@@ -13,20 +13,14 @@ module RestApiGenerator
     class_option :eject, type: :boolean, default: false
     class_option :scope, type: :string, default: ""
     class_option :father, type: :string, default: ""
-
-    API_CONTROLLER_DIR_PATH = "app/controllers"
-    API_TEST_DIR_PATH = "spec/requests"
+    hook_for :spec, in: "rest_api_generator:spec", default: "rspec"
 
     def create_service_file
       create_model_files
 
-      # Create controller and specs
-      controller_path = "#{API_CONTROLLER_DIR_PATH}#{scope_path}/#{file_name.pluralize}_controller.rb"
-      controller_test_path = "#{API_TEST_DIR_PATH}#{scope_path}/#{file_name.pluralize}_controller_spec.rb"
-
       template controller_template, controller_path
-      template spec_controller_template, controller_test_path
 
+      # Routes
       if options["scope"].blank? && options["father"].blank?
         route "resources :#{file_name.pluralize}"
       else
@@ -36,35 +30,6 @@ module RestApiGenerator
 
     private
 
-    def scope_path
-      return "" if options["scope"].blank? && options["father"].blank?
-
-      if options["scope"].present? && options["father"].present?
-        "/" + option_to_path(options["scope"]) + "/" + option_to_path(options["father"])
-      else
-        "/" + option_to_path(options["scope"]) + option_to_path(options["father"])
-      end
-    end
-
-    def scope_namespacing(&block)
-      content = capture(&block)
-      content = wrap_with_scope(content) if options["scope"].present? || options["father"].present?
-      concat(content)
-    end
-
-    def module_namespace
-      if options["scope"].present? && options["father"].present?
-        options["scope"] + "::" + options["father"]
-      else
-        options["scope"] + options["father"]
-      end
-    end
-
-    def wrap_with_scope(content)
-      content = indent(content).chomp
-      "module #{module_namespace}\n#{content}\nend\n"
-    end
-
     def controller_template
       if options["eject"]
         if options["father"].present?
@@ -79,14 +44,6 @@ module RestApiGenerator
       end
     end
 
-    def spec_controller_template
-      if options["father"].present?
-        "child_api_spec.rb"
-      else
-        "rest_api_spec.rb"
-      end
-    end
-
     def create_model_files
       g = Rails::Generators::ModelGenerator.new([file_name, build_model_attributes])
       g.destination_root = destination_root

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+require "generators/rest_api_generator/helpers"
+
+module RestApiGenerator
+  module Spec
+    class RspecGenerator < Rails::Generators::NamedBase
+      include Helpers
+      source_root File.expand_path("templates", __dir__)
+
+      argument :attributes, type: :array, default: [], banner: "field[:type][:index] field[:type][:index]"
+      class_option :eject, type: :boolean, default: false
+      class_option :scope, type: :string, default: ""
+      class_option :father, type: :string, default: ""
+
+      def create_service_file
+        template spec_controller_template, controller_test_path
+      end
+
+      private
+
+      def controller_test_path
+        "#{API_TEST_DIR_PATH}#{scope_path}/#{file_name.pluralize}_controller_spec.rb"
+      end
+
+      def spec_controller_template
+        if options["father"].present?
+          "rspec/resource_controller_spec.rb"
+        else
+          "rspec/nested_resource_controller_spec.rb"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+require "generators/rest_api_generator/helpers"
+
+module RestApiGenerator
+  module Spec
+    class RswagGenerator < Rails::Generators::NamedBase
+      include Helpers
+      source_root File.expand_path("templates", __dir__)
+
+      argument :attributes, type: :array, default: [], banner: "field[:type][:index] field[:type][:index]"
+      class_option :eject, type: :boolean, default: false
+      class_option :scope, type: :string, default: ""
+      class_option :father, type: :string, default: ""
+
+      def create_service_file
+        template spec_controller_template, controller_test_path
+      end
+
+      private
+
+      # Changes nested routes for rswag format
+      # Example: /cars/{car.id}/drivers/{id}
+      def nested_routes
+        return "" if options["father"].blank?
+
+        "#{options["father"].downcase.pluralize}/{#{options["father"].singularize.downcase}_id}/#{plural_name}"
+      end
+
+      def spec_routes
+        {
+          index: initial_route,
+          show: initial_route + "/{id}",
+          create: initial_route,
+          update: initial_route + "/{id}",
+          delete: initial_route + "/{id}",
+        }
+      end
+
+      def controller_test_path
+        "#{API_TEST_DIR_PATH}#{scope_path}/#{file_name.pluralize}_spec.rb"
+      end
+
+      def spec_controller_template
+        if options["father"].present?
+          "rswag/nested_resource_controller_spec.rb"
+        else
+          "rswag/resource_controller_spec.rb"
+        end
+      end
+    end
+  end
+end

data/lib/generators/rest_api_generator/spec/templates/rswag/nested_resource_controller_spec.rb.tt

@@ -0,0 +1,116 @@
+require "rails_helper"
+
+RSpec.describe "<%= spec_routes[:index] %>", type: :request do
+  let(:resource) { create(:<%= singular_table_name %>, <%= options['father'].downcase.singularize %>: parent_resource) }
+  let(:parent_resource ) { create(:<%= options['father'].downcase.singularize %>) }
+
+  path "<%= spec_routes[:index] %>" do
+    parameter name: "<%= options['father'].downcase.singularize %>_id", in: :path, type: :string, description: "<%= options['father'].downcase.singularize %> id"
+    let(:<%= options['father'].downcase.singularize %>_id) { parent_resource.id }
+
+    get("list <%= plural_name %>") do
+      consumes "application/json"
+
+      response(200, "successful") do
+        after do |example|
+          example.metadata[:response][:content] = {
+            "application/json" => {
+              example: JSON.parse(response.body, symbolize_names: true)
+            }
+          }
+        end
+
+        run_test!
+      end
+    end
+
+    post("create <%= singular_table_name %>") do
+      consumes "application/json"
+
+      # You'll want to customize the parameter types...
+      parameter name: :<%= singular_table_name %>, in: :body, schema: {
+        type: :object,
+        properties: {
+          <% attributes.each do |attribute| -%>
+<%= attribute.name %>: { type: :string },
+<% end -%>
+        }
+      }
+      response(201, "successful") do
+        let(:<%= singular_table_name %>) { attributes_for(:<%= singular_table_name %>) }
+
+        after do |example|
+          example.metadata[:response][:content] = {
+            "application/json" => {
+              example: JSON.parse(response.body, symbolize_names: true)
+            }
+          }
+        end
+
+        run_test!
+      end
+    end
+  end
+
+  path "<%= spec_routes[:show] %>" do
+    parameter name: "id", in: :path, type: :string, description: "id"
+    parameter name: "<%= options['father'].downcase.singularize %>_id", in: :path, type: :string, description: "<%= options['father'].downcase.singularize %> id"
+
+    let(:id) { resource.id }
+    let(:<%= options['father'].downcase.singularize %>_id) { parent_resource.id }
+
+    get("show <%= singular_table_name %>") do
+      consumes "application/json"
+
+      response(200, "successful") do
+
+        after do |example|
+          example.metadata[:response][:content] = {
+            "application/json" => {
+              example: JSON.parse(response.body, symbolize_names: true)
+          }
+        }
+        end
+        run_test!
+      end
+    end
+
+
+    patch("update <%= singular_table_name %>") do
+      consumes "application/json"
+
+      # You'll want to customize the parameter types...
+      parameter name: :<%= singular_table_name %>, in: :body, schema: {
+        type: :object,
+        properties: {
+          <% attributes.each do |attribute| -%>
+<%= attribute.name %>: { type: :string },
+<% end -%>
+        }
+      }
+
+      response(200, "successful") do
+        let(:<%= singular_table_name %>) { attributes_for(:<%= singular_table_name %>) }
+
+        after do |example|
+          example.metadata[:response][:content] = {
+            "application/json" => {
+              example: JSON.parse(response.body, symbolize_names: true)
+            }
+          }
+        end
+
+        run_test!
+      end
+    end
+
+    delete("delete plan") do
+      consumes "application/json"
+
+      response(204, "successful") do
+
+        run_test!
+      end
+    end
+  end
+end

data/lib/generators/rest_api_generator/spec/templates/rswag/resource_controller_spec.rb.tt

@@ -0,0 +1,111 @@
+require "rails_helper"
+
+RSpec.describe "<%= spec_routes[:index] %>", type: :request do
+  let(:resource) { create(:<%= singular_table_name %>) }
+
+  path "<%= spec_routes[:index] %>" do
+    get("list <%= plural_name %>") do
+      consumes "application/json"
+
+      response(200, "successful") do
+        after do |example|
+          example.metadata[:response][:content] = {
+            "application/json" => {
+              example: JSON.parse(response.body, symbolize_names: true)
+            }
+          }
+        end
+
+        run_test!
+      end
+    end
+
+    post("create <%= singular_table_name %>") do
+      consumes "application/json"
+
+      # You'll want to customize the parameter types...
+      parameter name: :<%= singular_table_name %>, in: :body, schema: {
+        type: :object,
+        properties: {
+          <% attributes.each do |attribute| -%>
+<%= attribute.name %>: { type: :string },
+<% end -%>
+        }
+      }
+      response(201, "successful") do
+        let(:<%= singular_table_name %>) { attributes_for(:<%= singular_table_name %>) }
+
+        after do |example|
+          example.metadata[:response][:content] = {
+            "application/json" => {
+              example: JSON.parse(response.body, symbolize_names: true)
+            }
+          }
+        end
+
+        run_test!
+      end
+    end
+  end
+
+  path "<%= spec_routes[:show] %>" do
+    parameter name: "id", in: :path, type: :string, description: "id"
+
+    get("show <%= singular_table_name %>") do
+      consumes "application/json"
+
+      response(200, "successful") do
+        let(:id) { resource.id }
+
+        after do |example|
+          example.metadata[:response][:content] = {
+            "application/json" => {
+              example: JSON.parse(response.body, symbolize_names: true)
+          }
+        }
+        end
+        run_test!
+      end
+    end
+
+
+    patch("update <%= singular_table_name %>") do
+      consumes "application/json"
+
+      # You'll want to customize the parameter types...
+      parameter name: :<%= singular_table_name %>, in: :body, schema: {
+        type: :object,
+        properties: {
+          <% attributes.each do |attribute| -%>
+<%= attribute.name %>: { type: :string },
+<% end -%>
+        }
+      }
+
+      response(200, "successful") do
+        let(:id) { resource.id }
+        let(:<%= singular_table_name %>) { attributes_for(:<%= singular_table_name %>) }
+
+        after do |example|
+          example.metadata[:response][:content] = {
+            "application/json" => {
+              example: JSON.parse(response.body, symbolize_names: true)
+            }
+          }
+        end
+
+        run_test!
+      end
+    end
+
+    delete("delete plan") do
+      consumes "application/json"
+
+      response(204, "successful") do
+        let(:id) { resource.id }
+
+        run_test!
+      end
+    end
+  end
+end

data/lib/rest_api_generator/version.rb

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

data/rest-api-generator.gemspec

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
-$:.push File.expand_path("../lib", __FILE__)
+
+$LOAD_PATH.push File.expand_path("../lib", __FILE__)
 
 require_relative "lib/rest_api_generator/version"
 
@@ -22,7 +23,7 @@ Gem::Specification.new do |spec|
   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"]
+    "Gemfile", "Gemfile.lock"]
   spec.bindir = "exe"
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
@@ -33,9 +34,9 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "rails", ">= 5.0"
 
-  spec.add_development_dependency 'ammeter', '~> 1.1.5'
-  spec.add_development_dependency 'rspec-rails', '~> 6.0.0'
-  spec.add_development_dependency 'sqlite3'
-  spec.add_development_dependency 'database_cleaner'
-
+  spec.add_development_dependency "ammeter", "~> 1.1.5"
+  spec.add_development_dependency "database_cleaner"
+  spec.add_development_dependency "rspec-rails", "~> 6.0.0"
+  spec.add_development_dependency "rswag"
+  spec.add_development_dependency "rswag-specs"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rest-api-generator
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - PedroAugustoRamalhoDuarte
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-12-29 00:00:00.000000000 Z
+date: 2023-01-06 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: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -53,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 6.0.0
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: rswag
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: database_cleaner
+  name: rswag-specs
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -97,12 +111,16 @@ files:
 - lib/generators/rest_api_generator/USAGE
 - lib/generators/rest_api_generator/helpers.rb
 - lib/generators/rest_api_generator/resource_generator.rb
+- lib/generators/rest_api_generator/spec/rspec_generator.rb
+- lib/generators/rest_api_generator/spec/rswag_generator.rb
+- lib/generators/rest_api_generator/spec/templates/rspec/nested_resource_controller_spec.rb.tt
+- lib/generators/rest_api_generator/spec/templates/rspec/resource_controller_spec.rb.tt
+- lib/generators/rest_api_generator/spec/templates/rswag/nested_resource_controller_spec.rb.tt
+- lib/generators/rest_api_generator/spec/templates/rswag/resource_controller_spec.rb.tt
 - lib/generators/rest_api_generator/templates/child_api_controller.rb.tt
-- lib/generators/rest_api_generator/templates/child_api_spec.rb.tt
 - lib/generators/rest_api_generator/templates/implicit_child_resource_controller.rb.tt
 - lib/generators/rest_api_generator/templates/implicit_resource_controller.rb.tt
 - lib/generators/rest_api_generator/templates/rest_api_controller.rb.tt
-- lib/generators/rest_api_generator/templates/rest_api_spec.rb.tt
 - lib/rest-api-generator.rb
 - lib/rest_api_generator.rb
 - lib/rest_api_generator/application_controller.rb