lazy_api_doc 0.2.0 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 568bfda81852a9cd4823ac786f1bfe2de01a32dc42da6c192304c954dd2d731c
-  data.tar.gz: 5d4ccbd550f9cf6b16f589b155e71f3dd120a3eb2a475aa43a7ef39e1b0f8bcf
+  metadata.gz: fa62cfe77df17307c22cb91c6a951e2820d1a4b5d9aa5abdcf2125048fe4442f
+  data.tar.gz: f9429c504ec51bd374877f5a6c2406cbd0ce03353b771136f1f3dc41877a5cb6
 SHA512:
-  metadata.gz: 7a99bee831aba3c9e8781b413ed4d53c051b47624673296dfbbe94176ae5dd8e54b1130abd767d46e2ec88a473dfc0d813297a12c2f66a9a017ada45997e1091
-  data.tar.gz: 8a05e6d6ea878f4eeba9c032a1b0533e83eafc497bd86b8a51a322b3b2f169059a3df2fb665ca9ff1c799c4df69a01d1a59d094c1d3c8ffd9985124842595770
+  metadata.gz: '08af3aec20c0c6f7b9281f51845411a9f3875aec62577a6b0eb2f7a185ea4a7c49ad95fbc87d3ae434850ced028b14f5de2f9816bfd12babd938790bc443e553'
+  data.tar.gz: a50c616f463aa585bb9afc963855e7149236a437fea129b225a204c3ee7687996d0e2d781821b358beb7473a97418fe8438f4a1eea09938dc36ba17b0cd5066f

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    lazy_api_doc (0.2.0)
+    lazy_api_doc (0.2.3)
 
 GEM
   remote: https://rubygems.org/

data/lib/generators/lazy_api_doc/install_generator.rb

@@ -44,7 +44,7 @@ module LazyApiDoc
       # This peace of code handle using ParallelTests (tests runs in independent processes).
       # Just delete this block if you don't use ParallelTests
       if ENV['TEST_ENV_NUMBER'] && defined?(ParallelTests)
-        LazyApiDoc.save_examples
+        LazyApiDoc.save_examples('rspec')
         ParallelTests.wait_for_other_processes_to_finish if ParallelTests.first_process?
         LazyApiDoc.load_examples
       end
@@ -75,7 +75,7 @@ module LazyApiDoc
                 # This peace of code handle using ParallelTests (tests runs in independent processes).
                 # Just delete this block if you don't use ParallelTests
                 if ENV['TEST_ENV_NUMBER'] && defined?(ParallelTests)
-                  LazyApiDoc.save_examples
+                  LazyApiDoc.save_examples('minitest')
                   ParallelTests.wait_for_other_processes_to_finish if ParallelTests.first_process?
                   LazyApiDoc.load_examples
                 end

data/lib/lazy_api_doc/generator.rb

@@ -39,7 +39,7 @@ module LazyApiDoc
     def example_group(example, examples, route) # rubocop:disable Metrics/AbcSize
       {
         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),
@@ -85,12 +85,10 @@ module LazyApiDoc
 
     def query_params(examples)
       query_variants = examples.map do |example|
-        full_path = example.request['full_path'].split('?')
-        next {} if full_path.size == 1
+        _path, query = example.request['full_path'].split('?')
+        next {} unless query
 
-        # TODO: simplify it
-        full_path.last.split('&').map { |part| part.split('=').map { |each| CGI.unescape(each) } }.group_by(&:first)
-                 .transform_values { |v| v.map(&:last) }.map { |k, v| [k, k.match?(/\[\]\z/) ? v : v.first] }.to_h
+        CGI.parse(query).map { |k, v| [k.gsub('[]', ''), k.match?('\[\]') ? v : v.first] }.to_h
       end
 
       parsed = ::LazyApiDoc::VariantsParser.new(query_variants).result

data/lib/lazy_api_doc/variants_parser.rb

@@ -73,10 +73,10 @@ module LazyApiDoc
       result["properties"] = variant.map do |key, val|
         [
           key.to_s,
-          parse(val, variants.compact.map { |v| v.fetch(key, OPTIONAL) })
+          parse(val, variants.select { |v| v.is_a?(Hash) }.map { |v| v.fetch(key, OPTIONAL) })
         ]
       end.to_h
-      result["required"] = variant.keys.select { |key| variants.compact.all? { |v| v.key?(key) } }
+      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.0".freeze
+  VERSION = "0.2.3".freeze
 end

data/lib/lazy_api_doc.rb

@@ -32,16 +32,16 @@ module LazyApiDoc
 
     def add_spec(rspec_example) # rubocop:disable Metrics/AbcSize
       add(
-        'controller' => rspec_example.request.params[:controller],
-        'action' => rspec_example.request.params[:action],
+        'controller' => rspec_example.instance_variable_get(:@request).params[:controller],
+        'action' => rspec_example.instance_variable_get(:@request).params[:action],
         'description' => rspec_example.class.description,
         'source_location' => [rspec_example.class.metadata[:file_path], rspec_example.class.metadata[:line_number]],
-        'verb' => rspec_example.request.method,
-        'params' => rspec_example.request.params,
-        'content_type' => rspec_example.request.content_type.to_s,
+        'verb' => rspec_example.instance_variable_get(:@request).method,
+        'params' => rspec_example.instance_variable_get(:@request).params,
+        'content_type' => rspec_example.instance_variable_get(:@request).content_type.to_s,
         'request' => {
-          'query_params' => rspec_example.request.query_parameters,
-          'full_path' => rspec_example.request.fullpath
+          'query_params' => rspec_example.instance_variable_get(:@request).query_parameters,
+          'full_path' => rspec_example.instance_variable_get(:@request).fullpath
         },
         'response' => {
           'code' => rspec_example.response.status,
@@ -53,16 +53,16 @@ module LazyApiDoc
 
     def add_test(mini_test_example) # rubocop:disable Metrics/AbcSize
       add(
-        'controller' => mini_test_example.request.params[:controller],
-        'action' => mini_test_example.request.params[:action],
+        'controller' => mini_test_example.instance_variable_get(:@request).params[:controller],
+        'action' => mini_test_example.instance_variable_get(:@request).params[:action],
         'description' => mini_test_example.name.gsub(/\Atest_/, '').humanize,
         'source_location' => mini_test_example.method(mini_test_example.name).source_location,
-        'verb' => mini_test_example.request.method,
-        'params' => mini_test_example.request.params,
-        'content_type' => mini_test_example.request.content_type.to_s,
+        'verb' => mini_test_example.instance_variable_get(:@request).method,
+        'params' => mini_test_example.instance_variable_get(:@request).params,
+        'content_type' => mini_test_example.instance_variable_get(:@request).content_type.to_s,
         'request' => {
-          'query_params' => mini_test_example.request.query_parameters,
-          'full_path' => mini_test_example.request.fullpath
+          'query_params' => mini_test_example.instance_variable_get(:@request).query_parameters,
+          'full_path' => mini_test_example.instance_variable_get(:@request).fullpath
         },
         'response' => {
           'code' => mini_test_example.response.status,
@@ -79,10 +79,10 @@ module LazyApiDoc
       File.write("#{path}/api.yml", layout.to_yaml)
     end
 
-    def save_examples
+    def save_examples(process_name)
       FileUtils.mkdir("#{path}/examples") unless File.exist?("#{path}/examples")
       File.write(
-        "#{path}/examples/rspec_#{ENV['TEST_ENV_NUMBER'] || SecureRandom.uuid}.json",
+        "#{path}/examples/#{process_name}_#{ENV['TEST_ENV_NUMBER'] || SecureRandom.uuid}.json",
         {
           created_at: Time.now.to_i,
           examples: generator.examples

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lazy_api_doc
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.3
 platform: ruby
 authors:
 - Bogdan Guban
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-05-06 00:00:00.000000000 Z
+date: 2022-06-04 00:00:00.000000000 Z
 dependencies: []
 description: The gem collects all requests and responses from your request specs and
   generates documentationbased on it