lazy_api_doc 0.2.3 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa62cfe77df17307c22cb91c6a951e2820d1a4b5d9aa5abdcf2125048fe4442f
-  data.tar.gz: f9429c504ec51bd374877f5a6c2406cbd0ce03353b771136f1f3dc41877a5cb6
+  metadata.gz: ef3ed91d230146fe8a9ec8848a38faaa15b74bbe9543cce9bbf9df31378b2364
+  data.tar.gz: 9a8d617d8e7ee944da9fe0d3044b38a95bc9a030be816565f6efe686ff90c84b
 SHA512:
-  metadata.gz: '08af3aec20c0c6f7b9281f51845411a9f3875aec62577a6b0eb2f7a185ea4a7c49ad95fbc87d3ae434850ced028b14f5de2f9816bfd12babd938790bc443e553'
-  data.tar.gz: a50c616f463aa585bb9afc963855e7149236a437fea129b225a204c3ee7687996d0e2d781821b358beb7473a97418fe8438f4a1eea09938dc36ba17b0cd5066f
+  metadata.gz: 6122f584b76193d5ce943208d67a8c3e80637acf3c78f78381629fc67b468ac337dc7ffb17cefcb1cefc7b4a18b2ab6a531113c3b138e99b2bc92c1a999d07bb
+  data.tar.gz: de1c56436fb2fca419cd0a2fa25a051cc08da77820dc4c9f8da9dfe5182d125275fc041254b721376b1432d0cb251fe6111c31c4a717a4391e924a84891c61c2

data/.gitignore

@@ -10,3 +10,4 @@
 # rspec failure tracking
 .rspec_status
 coverage
+*.gem

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.3)
+    lazy_api_doc (0.2.5)
 
 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
@@ -21,11 +23,10 @@ module LazyApiDoc
     def result
       result = {}
       @examples.map { |example| OpenStruct.new(example) }.sort_by(&:source_location)
-               .group_by { |ex| [ex.controller, ex.action] }
-               .each do |_, examples|
-        first = examples.first
-        route = ::LazyApiDoc::RouteParser.new(first.controller, first.action, first.verb).route
+               .group_by { |example| ::LazyApiDoc::RouteParser.find_by(example) }
+               .each do |route, examples|
         next if route.nil? # TODO: think about adding such cases to log
+        first = examples.first
 
         doc_path = route['doc_path']
         result[doc_path] ||= {}
@@ -36,28 +37,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 || '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 +81,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 HEAD].include?(example['verb'])
+          params.merge!(example.params.except(*EXCLUDED_PARAMS, *route['path_params'], *route['defaults'].keys))
+        end
+        params
       end
 
       parsed = ::LazyApiDoc::VariantsParser.new(query_variants).result
@@ -104,9 +109,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 DELETE].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'], *route['defaults'].keys) }
       {
         'content' => {
           first.content_type => {

data/lib/lazy_api_doc/route_parser.rb

@@ -1,15 +1,9 @@
 module LazyApiDoc
   class RouteParser
-    attr_reader :controller, :action, :verb
-
-    def initialize(controller, action, verb)
-      @controller = controller
-      @action = action
-      @verb = verb
-    end
-
-    def route
-      self.class.routes.find { |r| r['action'] == action && r['controller'] == controller && r['verb'].include?(verb) }
+    def self.find_by(example)
+      r = routes.find do |r|
+        r['verb'].include?(example.verb) && example.params.slice(*r['defaults'].keys) == r['defaults']
+      end
     end
 
     def self.routes
@@ -20,13 +14,13 @@ module LazyApiDoc
 
     def self.format(route)
       route = ActionDispatch::Routing::RouteWrapper.new(route)
-
       {
         'doc_path' => route.path.gsub("(.:format)", "").gsub(/(:\w+)/, '{\1}').delete(":"),
         'path_params' => route.path.gsub("(.:format)", "").scan(/:\w+/).map { |p| p.delete(":") },
         'controller' => route.controller,
         'action' => route.action,
-        'verb' => route.verb.split('|')
+        'verb' => route.verb.split('|'),
+        'defaults' => route.defaults.transform_keys(&:to_s)
       }
     end
   end

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.3".freeze
+  VERSION = "0.2.5".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.3
+  version: 0.2.5
 platform: ruby
 authors:
 - Bogdan Guban
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-06-04 00:00:00.000000000 Z
+date: 2023-04-18 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: