swagger_autogenerate 1.1.2 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa0e0d56334a728cbd835bf8ecf0cf4b2c330eb62aeb92e6b9bc20d1251ed5cd
-  data.tar.gz: c5869ad74ec90bffdb1a58bdfbb52645849b14f88e81e876f5b856d280dab536
+  metadata.gz: '08b276dd458b54318a75f32c666d40840602065d89a8fa26e7ffac44341e0f15'
+  data.tar.gz: bacd1e78fe71a2909d112901a9e6ba2900117b7e2a45522b1d25f11b542aa624
 SHA512:
-  metadata.gz: 7766553dbaa81ee1506f36727411a24e36d9dd7c73bc4733a2bc034be406b2c94e4526f7c73467e1d383cf3e566fecaa6ea592a06627f4a5778dba61cd5f142e
-  data.tar.gz: ab857ce41cc465f94b961c61d2f3bbeb48195c8bf5472152c43524384caa57313325b852df8417e2c07489fed8ae0e656c941d9c91a395ea6e16895ace7a990c
+  metadata.gz: 9f6c2c1c285f982a2677daf6d90040bed5682595fd65ee690ac2e01d188a37bc4afca6f4531fc4e8daad142dd5098a54d4dcb336c58ebc97e2ec305afba9eff7
+  data.tar.gz: 4c5d8642ac585f043cab7193e3eb9fb7fbe3c027c41d6bcdae6b17b5f6b905a4559469db54f166a9014a4283f9c1d798968a30f18c1ee38160c4579985d5626a

data/CHANGELOG.md

@@ -12,5 +12,6 @@
 ## [1.1.0] - 2024-06-23
 ## [1.1.1] - 2024-06-26
 ## [1.1.2] - 2024-08-17
+## [1.2.0] - 2024-09-08
 
 - Initial release

data/Gemfile.lock

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

data/README.md

@@ -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='employee_apis.yaml' rspec spec/your_path/employees_controller_spec.rb
+SWAGGER_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

@@ -1,8 +1,8 @@
 module SwaggerAutogenerate
   class Configuration
     attr_accessor :with_config, :with_multiple_examples, :with_rspec_examples, :with_example_description,
-                  :with_response_description, :swagger_environment_variable,
-                  :environment_name, :security, :swagger_config, :response_status
+                  :with_response_description, :swagger_path_environment_variable, :generate_swagger_environment_variable,
+                  :default_path, :environment_name, :security, :swagger_config, :response_status
 
     def initialize
       @with_config = true
@@ -11,7 +11,9 @@ module SwaggerAutogenerate
       # remove this when we do not need it any more
       @with_example_description = true
       @with_response_description = true
-      @swagger_environment_variable = 'SWAGGER'
+      @swagger_path_environment_variable = 'SWAGGER_PATH'
+      @generate_swagger_environment_variable = 'SWAGGER_GENERATE'
+      @default_path = 'swagger'
       @environment_name = :test
       @security = default_security
       @swagger_config = default_swagger_config

data/lib/swagger_autogenerate/swagger_trace.rb

@@ -10,6 +10,7 @@ module SwaggerAutogenerate
       @security = ::SwaggerAutogenerate.configuration.security
       @swagger_config = ::SwaggerAutogenerate.configuration.swagger_config
       @response_status = ::SwaggerAutogenerate.configuration.response_status
+      @default_path = ::SwaggerAutogenerate.configuration.default_path
       @request = request
       @response = response
       @@paths = {}
@@ -20,12 +21,20 @@ module SwaggerAutogenerate
       write_swagger_trace
     end
 
-    def self.swagger_environment_variable
-      ::SwaggerAutogenerate.configuration.swagger_environment_variable
+    def self.swagger_path_environment_variable
+      ::SwaggerAutogenerate.configuration.swagger_path_environment_variable
     end
 
-    def swagger_environment_variable
-      SwaggerTrace.swagger_environment_variable
+    def swagger_path_environment_variable
+      SwaggerTrace.swagger_path_environment_variable
+    end
+
+    def self.generate_swagger_environment_variable
+      ::SwaggerAutogenerate.configuration.generate_swagger_environment_variable
+    end
+
+    def generate_swagger_environment_variable
+      SwaggerTrace.generate_swagger_environment_variable
     end
 
     def self.environment_name
@@ -40,7 +49,7 @@ 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
+                :with_response_description, :security, :response_status, :swagger_config, :default_path
 
     # main methods
 
@@ -431,10 +440,14 @@ module SwaggerAutogenerate
     def swagger_location
       return @swagger_location if instance_variable_defined?(:@swagger_location)
 
-      if ENV[swagger_environment_variable].include?('.yaml') || ENV[swagger_environment_variable].include?('.yml')
-        @swagger_location = Rails.root.join(ENV.fetch(swagger_environment_variable, nil).to_s).to_s
+      if ENV[generate_swagger_environment_variable].present?
+        directory_path = Rails.root.join(default_path).to_s
+        FileUtils.mkdir_p(directory_path) unless File.directory?(directory_path)
+        @swagger_location = "#{directory_path}/#{tags.first}.yaml"
+      elsif ENV[swagger_path_environment_variable].include?('.yaml') || ENV[swagger_path_environment_variable].include?('.yml')
+        @swagger_location = Rails.root.join(ENV.fetch(swagger_path_environment_variable, nil).to_s).to_s
       else
-        directory_path = Rails.root.join(ENV.fetch(swagger_environment_variable, nil).to_s).to_s
+        directory_path = Rails.root.join(ENV.fetch(swagger_path_environment_variable, nil).to_s).to_s
         FileUtils.mkdir_p(directory_path) unless File.directory?(directory_path)
         @swagger_location = "#{directory_path}/#{tags.first}.yaml"
       end

data/lib/swagger_autogenerate/version.rb

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

data/lib/swagger_autogenerate.rb

@@ -15,7 +15,8 @@ module SwaggerAutogenerate
   end
 
   def self.allow_swagger?
-    ENV[SwaggerTrace.swagger_environment_variable].present? && Rails.env.send("#{SwaggerTrace.environment_name.to_s}?")
+    (ENV[SwaggerTrace.swagger_path_environment_variable].present? || ENV[SwaggerTrace.generate_swagger_environment_variable].present?) &&
+    Rails.env.send("#{SwaggerTrace.environment_name.to_s}?")
   end
 end
 

metadata

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