swagger_autogenerate 1.2.1 → 1.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f6f642d29cd299f7f2e7b32b7e87a89f6a6b0f037f11bd5c7bcabbfd56d34de1
-  data.tar.gz: 624631c39528ce4d096325dc638e2031363424124cc9922032005a44e26a2fd8
+  metadata.gz: 4d62d2b3204e47e668408ea353aa7f5015a9f1a8f86e727e635b1030e999f587
+  data.tar.gz: 7cbcbfc449684fe35db3c76c7c8bb0ae357ebabf8585ba7289c3b6d58abec9a9
 SHA512:
-  metadata.gz: 2208abc4d89eac17e33f02f3c8a541ee9f68c6b1590ed93a7785ee941b9cc31e3b7fe3f74ad16689cf93639329fe85a30334651449ce7ace10699ef3ef4e1760
-  data.tar.gz: 8ef10a7cd712aa5114ac38395b189d84f7ec83fa9b05b64ac5ce0c8b5f7632d4cb33dea35d4cc4211c66471dae5f7ee6e15810fe7394951d1afd07ef0cd17154
+  metadata.gz: f9dea5813fe7a651d4fa59d618b86a02a2e909a23bdcb8744aa56bd96ff667143482d52316b70f78868c2cbbf3de5e2e6104b9cdb8f13e00e6a2483f15ac2da7
+  data.tar.gz: a7fa27d728d65a7e8d2fb58dcb052c81d1486a1d3c89b3326851797419cff037e28322eec8284a19f81be1c4121ed9dd33a83605a31ee1606bdccfa61b30c813

data/CHANGELOG.md

@@ -14,5 +14,8 @@
 ## [1.1.2] - 2024-08-17
 ## [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
 
 - Initial release

data/Gemfile.lock

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

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
@@ -82,9 +83,4 @@ module SwaggerAutogenerate
   def self.configure
     yield(configuration)
   end
-
-  def self.extract_description(full_rspec_description)
-    parts = full_rspec_description.split(' ')
-    parts&.length > 1 ? parts[2..-1].join(" ") : full_rspec_description
-  end
 end

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'")
@@ -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 = DateTime.strptime(string)
       datetime.strftime('%Y-%m-%d')
     rescue ArgumentError
       string
@@ -528,9 +553,11 @@ module SwaggerAutogenerate
     end
 
     def handel_name_last_example(old_examples)
-      last_example = old_examples.keys.last
-      last_example += '-1' if json_example_plus_one(last_example) == last_example
-      json_example_plus_one(last_example)
+      last_example = full_rspec_description || old_examples.keys.last
+      if old_examples.keys.include?(last_example)
+        last_example += '-1'
+        json_example_plus_one(last_example)
+      end
     end
 
     def add_properties_to_schema(last_example, main_path = yaml_file['paths'][current_path])

data/lib/swagger_autogenerate/version.rb

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

data/lib/swagger_autogenerate.rb

@@ -25,7 +25,7 @@ if defined?(RSpec) && SwaggerAutogenerate.allow_swagger?
 
   RSpec.configure do |config|
     config.before(:each) do |example|
-      SwaggerAutogenerate::SwaggerTrace.rspec_description = SwaggerAutogenerate.extract_description(example.metadata[:full_description])
+      SwaggerAutogenerate::SwaggerTrace.rspec_description = example&.metadata.dig(:example_group, :description)
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: swagger_autogenerate
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.4
 platform: ruby
 authors:
 - MohammedBuraiah
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-09-10 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