lazy_api_doc 0.2.2 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f0e518996dd248ab2ae4db3fff35867c58ef74810786fa49f7de71218cb45bf
-  data.tar.gz: 3885d2a3adbc40da030de0647ab19f5afb0b8d5268f7076988e65f300b2b75a6
+  metadata.gz: af5749a17e1dece2e3ae5aeb8cc40d4452fc5ea09bd7574eb00e9110711a1c68
+  data.tar.gz: e921f572e2fbb00a6553c9fa29bfb902b8eec16c9178dc82ccb8f7fc770cbd23
 SHA512:
-  metadata.gz: dc95af1ff9d2fa9f593e8198d6b7909e1ae6d9ab364ceee1e33cad60687eac8b4543a9385e700bd3ba5858236f087f94830b863c6d0e9999ffd8065ae510296d
-  data.tar.gz: 442a7d980e4b867eaa7f880452058ff9f95754a76c42e3704b59e75d07fd06bf68bf2809c7ed879704ad87120391c24d8d0dd766af0584601e8fb0615737c724
+  metadata.gz: 01c31a46f50ecea8a0ae7b7fb27a6190640a4455e78cd0e703e61873b58bb77fdcb85206ea177b06b707ad79d2ef0191e7730c2e69d7ee2d3a056c69e2dcb9c1
+  data.tar.gz: a3e2353321040cd4720c0de6d4f1109010e8511c5555a5d76d28a17a359d566ccbce0a027cae51ab47deb18ae4782847303386f45f286a35b74038d9a2a23cdc

data/.rubocop.yml

@@ -1,10 +1,14 @@
 # Rubocop rules explanation:
 #  https://github.com/rubocop-hq/rubocop/blob/master/config/default.yml
-#
-# Rubocop-Rspec rules explanation:
-#  https://github.com/rubocop-hq/rubocop-rspec/blob/master/config/default.yml
 
-require: rubocop-rspec
+AllCops:
+  DisplayCopNames: true
+  TargetRubyVersion: 2.3.0
+  NewCops: enable
+  SuggestExtensions: false
+  Exclude:
+    - bin/bundle
+    - spec
 
 Style/StringLiterals:
   Enabled: false
@@ -12,15 +16,13 @@ Style/StringLiterals:
 Style/FrozenStringLiteralComment:
   Enabled: false
 
-Metrics/LineLength:
-  Exclude:
-    - lazy_api_doc.gemspec
+Layout/LineLength:
   Max: 120
 
 Style/ExpandPathArguments:
   Enabled: false
 
-Layout/AlignHash:
+Layout/HashAlignment:
   Enabled: false
 
 Metrics/BlockLength:
@@ -34,12 +36,19 @@ Style/Documentation:
   Enabled: false
 
 Metrics/AbcSize:
-  Max: 25
-
-
+  Max: 30
 
-RSpec/ExampleLength:
+Style/WordArray:
   Enabled: false
 
-RSpec/DescribedClass:
+Style/OpenStructUse:
   Enabled: false
+
+Metrics/PerceivedComplexity:
+  Max: 10
+
+Metrics/CyclomaticComplexity:
+  Max: 10
+
+Metrics/ClassLength:
+  Max: 150

data/Gemfile.lock

@@ -1,20 +1,22 @@
 PATH
   remote: .
   specs:
-    lazy_api_doc (0.2.2)
+    lazy_api_doc (0.2.4)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.0)
+    ast (2.4.2)
     diff-lcs (1.3)
     docile (1.4.0)
-    jaro_winkler (1.5.4)
-    parallel (1.19.0)
-    parser (2.6.5.0)
-      ast (~> 2.4.0)
-    rainbow (3.0.0)
+    json (2.6.3)
+    parallel (1.22.1)
+    parser (3.2.1.1)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
     rake (12.3.3)
+    regexp_parser (2.7.0)
+    rexml (3.2.5)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
@@ -28,23 +30,28 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.0)
-    rubocop (0.76.0)
-      jaro_winkler (~> 1.5.1)
+    rubocop (1.48.1)
+      json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 2.6)
+      parser (>= 3.2.0.0)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.26.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.27.0)
+      parser (>= 3.2.1.0)
     rubocop-rspec (1.38.1)
       rubocop (>= 0.68.1)
-    ruby-progressbar (1.10.1)
+    ruby-progressbar (1.13.0)
     simplecov (0.21.2)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.3)
-    unicode-display_width (1.6.0)
+    unicode-display_width (2.4.2)
 
 PLATFORMS
   ruby

data/lazy_api_doc.gemspec

@@ -7,7 +7,9 @@ Gem::Specification.new do |spec|
   spec.email         = ["biguban@gmail.com"]
 
   spec.summary       = "Creates openapi v3 documentation based on rspec request tests"
-  spec.description   = "The gem collects all requests and responses from your request specs and generates documentationbased on it"
+  spec.description   = <<~EODOC
+    The gem collects all requests and responses from your request specs and generates documentation based on it
+  EODOC
   spec.homepage      = "https://github.com/bguban/lazy_api_doc"
   spec.license       = "MIT"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
@@ -26,4 +28,5 @@ Gem::Specification.new do |spec|
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
+  spec.metadata['rubygems_mfa_required'] = 'true'
 end

data/lib/generators/lazy_api_doc/install_generator.rb

@@ -14,9 +14,9 @@ module LazyApiDoc
         append_to_file '.gitignore' do
           <<~TXT
 
-          # LazyApiDoc
-          #{LazyApiDoc.path}/api.yml
-          #{LazyApiDoc.path}/examples/*.json
+            # LazyApiDoc
+            #{LazyApiDoc.path}/api.yml
+            #{LazyApiDoc.path}/examples/*.json
           TXT
         end
 

data/lib/lazy_api_doc/generator.rb

@@ -2,6 +2,8 @@ require 'cgi'
 
 module LazyApiDoc
   class Generator
+    EXCLUDED_PARAMS = ["controller", "action", "format"].freeze
+
     attr_reader :examples
 
     def initialize
@@ -36,28 +38,25 @@ module LazyApiDoc
 
     private
 
-    def example_group(example, examples, route) # rubocop:disable Metrics/AbcSize
+    def example_group(example, examples, route)
       {
         example['verb'].downcase => {
-          "tags" => [example.controller],
+          "tags" => [example.controller || 'Ungrouped'],
           "description" => example["description"].capitalize,
           "summary" => example.action,
-          "parameters" => path_params(route, examples) + query_params(examples),
+          "parameters" => path_params(route, examples) + query_params(route, examples),
           "requestBody" => body_params(route, examples),
-          "responses" => examples.group_by { |ex| ex.response['code'] }.map do |code, variants|
-            [
-              code,
-              {
-                "description" => variants.first["description"].capitalize,
+          "responses" => examples.group_by { |ex| ex.response['code'] }.transform_values do |variants|
+            {
+              "description" => variants.first["description"].capitalize,
                 "content" => {
                   example.response['content_type'] => {
                     "schema" => ::LazyApiDoc::VariantsParser.new(variants.map { |v| parse_body(v.response) }).result
                   }
                 }
-              }
-            ]
-          end.to_h # rubocop:disable Style/MultilineBlockChain
-        }.reject { |_, v| v.nil? }
+            }
+          end
+        }.compact
       }
     end
 
@@ -83,12 +82,19 @@ module LazyApiDoc
       end
     end
 
-    def query_params(examples)
+    def query_params(route, examples)
       query_variants = examples.map do |example|
         _path, query = example.request['full_path'].split('?')
-        next {} unless query
 
-        CGI.parse(query).map { |k, v| [k.gsub('[]', ''), k.match?('\[\]') ? v : v.first] }.to_h
+        params = if query
+                   CGI.parse(query).to_h { |k, v| [k.gsub('[]', ''), k.match?('\[\]') ? v : v.first] }
+                 else
+                   {}
+                 end
+        if %w[GET DELETE HEAD].include?(example['verb'])
+          params.merge!(example.params.except(*EXCLUDED_PARAMS, *route['path_params']))
+        end
+        params
       end
 
       parsed = ::LazyApiDoc::VariantsParser.new(query_variants).result
@@ -104,9 +110,9 @@ module LazyApiDoc
 
     def body_params(route, examples)
       first = examples.first
-      return unless %w[POST PATCH].include?(first['verb'])
+      return unless %w[POST PATCH PUT].include?(first['verb'])
 
-      variants = examples.map { |example| example.params.except("controller", "action", "format", *route['path_params']) }
+      variants = examples.map { |example| example.params.except(*EXCLUDED_PARAMS, *route['path_params']) }
       {
         'content' => {
           first.content_type => {

data/lib/lazy_api_doc/variants_parser.rb

@@ -15,6 +15,7 @@ module LazyApiDoc
       variants.delete(OPTIONAL)
       case variant
       when Array
+        variant = variants.find(&:any?) || variants.first
         parse_array(variant, variants)
       when Hash
         parse_hash(variants)
@@ -69,13 +70,13 @@ module LazyApiDoc
     def parse_hash(variants)
       result = types_template(variants)
       variant = variants.select { |v| v.is_a?(Hash) }.reverse_each
-                        .each_with_object({}) { |v, res| res.merge!(v) }
-      result["properties"] = variant.map do |key, val|
+                        .with_object({}) { |v, res| res.merge!(v) }
+      result["properties"] = variant.to_h do |key, val|
         [
           key.to_s,
           parse(val, variants.select { |v| v.is_a?(Hash) }.map { |v| v.fetch(key, OPTIONAL) })
         ]
-      end.to_h
+      end
       result["required"] = variant.keys.select { |key| variants.select { |v| v.is_a?(Hash) }.all? { |v| v.key?(key) } }
       result
     end

data/lib/lazy_api_doc/version.rb

@@ -1,3 +1,3 @@
 module LazyApiDoc
-  VERSION = "0.2.2".freeze
+  VERSION = "0.2.4".freeze
 end

data/lib/lazy_api_doc.rb

@@ -80,7 +80,7 @@ module LazyApiDoc
     end
 
     def save_examples(process_name)
-      FileUtils.mkdir("#{path}/examples") unless File.exist?("#{path}/examples")
+      FileUtils.mkdir_p("#{path}/examples")
       File.write(
         "#{path}/examples/#{process_name}_#{ENV['TEST_ENV_NUMBER'] || SecureRandom.uuid}.json",
         {

metadata

@@ -1,17 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: lazy_api_doc
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.4
 platform: ruby
 authors:
 - Bogdan Guban
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-06-02 00:00:00.000000000 Z
+date: 2023-03-30 00:00:00.000000000 Z
 dependencies: []
-description: The gem collects all requests and responses from your request specs and
-  generates documentationbased on it
+description: 'The gem collects all requests and responses from your request specs
+  and generates documentation based on it
+
+  '
 email:
 - biguban@gmail.com
 executables: []
@@ -55,6 +57,7 @@ metadata:
   homepage_uri: https://github.com/bguban/lazy_api_doc
   source_code_uri: https://github.com/bguban/lazy_api_doc
   changelog_uri: https://github.com/bguban/lazy_api_doc
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths: