swagger_autogenerate 1.2.2 → 1.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: baeb0333fe686eb9c041d44e0a37f816ea1467b5eff9acb59189bf2c8ee1ca22
-  data.tar.gz: b4a9d7f8bcbacd061cc7f61058e81d3eebf31908ddb47058155ba45b8d6d0df9
+  metadata.gz: 7fbb1ab2c8c24337c43f68b09a4452cbbf5256ac31f44d1b35ea392488c43708
+  data.tar.gz: 89f43851ca840877b888e5e83217af2b42ba0fa694943885e67e76b5178e63ed
 SHA512:
-  metadata.gz: 78da25f6d4ff424ecfe162016f2f5565c4ac1f9995767f45efa4030d95df9a15132a2ebaf692620fd5bc500916b69689dac5fd8aeac6ee53ea67ee64a2764779
-  data.tar.gz: 87d783020090efc560b3ae50dc21846a7e9b3f682119fbc4c61b8610450e165dc1b7fd6c9fd64b6648a809d6a7c14c3bdb7ff0e5c34b723ea8cea86f5e39fc1d
+  metadata.gz: a8f034a350700b4b0a73e6d8b935d659c5b2c470da0a510f1652e182ba044f20eacebd1c7127b3591c37b7b18f54a599d92fbe7de4301595e3d8526a55a948c2
+  data.tar.gz: 5ec0cb3486777df804a45f8e7c0f49e2f05c0dc8906e808f6378fecacd5d3776330ab99f3d3a59a0477b1dbd7428ba8a8e51f1b6843816f7412d4f43b3a8c3d7

data/CHANGELOG.md

@@ -15,5 +15,8 @@
 ## [1.2.0] - 2024-09-08
 ## [1.2.1] - 2024-09-08
 ## [1.2.2] - 2024-09-12
+## [1.2.3] - 2024-09-12
+## [1.2.4] - 2024-09-15
+## [1.2.5] - 2024-09-15
 
 - Initial release

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    swagger_autogenerate (1.2.2)
+    swagger_autogenerate (1.2.5)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -47,8 +47,8 @@ To configure the swagger_autogenerate gem in your Rails application, follow thes
 ```
 SwaggerAutogenerate.configure do |config|
   config.with_config = true
-  config.with_example_description = true
   config.with_multiple_examples = true
+  action_for_old_examples = :append # :replace or :append
   config.with_response_description = true
 end
 
@@ -64,7 +64,7 @@ This file should contain the test scenarios for each action (e.g., index, show,
 
 3) Run the spec code using the rspec command and set the environment variable SWAGGER to the desired YAML file name. For example:
 ```
-SWAGGER_PATH='employee_apis.yaml' rspec spec/your_path/employees_controller_spec.rb
+SWAGGER_GENERATE_PATH='employee_apis.yaml' rspec spec/your_path/employees_controller_spec.rb
 ```
 4) This command runs the spec file and instructs the swagger_autogenerate gem to generate Swagger YAML documentation and save it to the file named employee_apis.yaml.
 5) Once the command finishes executing, you will have the Swagger YAML documentation generated based on the test scenarios in the employees_controller_spec.rb file.

data/lib/swagger_autogenerate/configuration.rb

@@ -2,7 +2,7 @@ module SwaggerAutogenerate
   class Configuration
     attr_accessor :with_config, :with_multiple_examples, :with_rspec_examples, :with_example_description,
                   :with_response_description, :swagger_path_environment_variable, :generate_swagger_environment_variable,
-                  :default_path, :environment_name, :security, :swagger_config, :response_status
+                  :default_path, :environment_name, :security, :swagger_config, :response_status, :action_for_old_examples
 
     def initialize
       @with_config = true
@@ -11,7 +11,8 @@ module SwaggerAutogenerate
       # remove this when we do not need it any more
       @with_example_description = true
       @with_response_description = true
-      @swagger_path_environment_variable = 'SWAGGER_PATH'
+      @action_for_old_examples = :append # :replace or :append
+      @swagger_path_environment_variable = 'SWAGGER_GENERATE_PATH'
       @generate_swagger_environment_variable = 'SWAGGER_GENERATE'
       @default_path = 'swagger'
       @environment_name = :test

data/lib/swagger_autogenerate/swagger_trace.rb

@@ -13,6 +13,7 @@ module SwaggerAutogenerate
       @default_path = ::SwaggerAutogenerate.configuration.default_path
       @request = request
       @response = response
+      @action_for_old_examples = ::SwaggerAutogenerate.configuration.action_for_old_examples
       @@paths = {}
     end
 
@@ -49,7 +50,8 @@ module SwaggerAutogenerate
 
     attr_reader :request, :response, :current_path, :yaml_file, :configuration,
                 :with_config, :with_multiple_examples, :with_rspec_examples,
-                :with_response_description, :security, :response_status, :swagger_config, :default_path
+                :with_response_description, :security, :response_status, :swagger_config,
+                :default_path, :action_for_old_examples
 
     # main methods
 
@@ -62,6 +64,9 @@ module SwaggerAutogenerate
 
       @current_path = path
       method = request.method.to_s.downcase
+
+      process_replacing_examples
+
       hash =
         {
           method => {
@@ -131,6 +136,26 @@ module SwaggerAutogenerate
 
     # Helpers
 
+    def process_replacing_examples
+      $removed_examples ||= []
+      if action_for_old_examples == :replace && !$removed_examples.include?({ @current_path => request.method.to_s.downcase })
+        current_yaml_file = YAML.load(
+          File.read(swagger_location),
+          aliases: true,
+          permitted_classes: [Symbol, Date, ActiveSupport::HashWithIndifferentAccess]
+        )
+
+        current_yaml_file["paths"][@current_path][request.method.to_s.downcase] = {}
+
+        File.open(swagger_location, 'w') do |file|
+          result = add_quotes_to_dates(YAML.dump(current_yaml_file))
+          file.write(result)
+        end
+
+        $removed_examples << { @current_path => request.method.to_s.downcase }
+      end
+    end
+
     def add_quotes_to_dates(string)
       string = remove_quotes_in_dates(string)
       string.gsub(/\b\d{4}-\d{2}-\d{2}\b/, "'\\0'")
@@ -173,6 +198,15 @@ module SwaggerAutogenerate
       hash
     end
 
+    def schema_type(value)
+      return 'integer' if number?(value)
+      return 'boolean' if (value.try(:downcase) == 'true') || (value.try(:downcase) == 'false')
+      return 'string' if value.instance_of?(String) || value.instance_of?(Symbol)
+      return 'array' if value.instance_of?(Array)
+
+      'object'
+    end
+
     def set_parameters(parameters, parameter, required: false)
       return if parameter.blank?
 
@@ -378,15 +412,6 @@ module SwaggerAutogenerate
       false
     end
 
-    def schema_type(value)
-      return 'integer' if number?(value)
-      return 'boolean' if (value.try(:downcase) == 'true') || (value.try(:downcase) == 'false')
-      return 'string' if value.instance_of?(String) || value.instance_of?(Symbol)
-      return 'array' if value.instance_of?(Array)
-
-      'object'
-    end
-
     def example(value)
       return value.to_i if number?(value)
       return convert_to_date(value) if value.instance_of?(String) && is_valid_date?(value)
@@ -396,14 +421,14 @@ module SwaggerAutogenerate
     end
 
     def is_valid_date?(string)
-      Date.parse(string)
+      Date.strptime(string)
       true
     rescue ArgumentError
       false
     end
 
     def convert_to_date(string)
-      datetime = DateTime.parse(string)
+      datetime = Date.strptime(string)
       datetime.strftime('%Y-%m-%d')
     rescue ArgumentError
       string

data/lib/swagger_autogenerate/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SwaggerAutogenerate
-  VERSION = "1.2.2"
+  VERSION = "1.2.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: swagger_autogenerate
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.2.5
 platform: ruby
 authors:
 - MohammedBuraiah
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-09-12 00:00:00.000000000 Z
+date: 2024-09-15 00:00:00.000000000 Z
 dependencies: []
 description: Generating Swagger YAML Automatically Based on Existing Test Cases in
   Ruby on Rails