RubyGems - lazy_api_doc - Versions diffs - 0.2.4 → 0.2.6 - Mend

lazy_api_doc 0.2.4 → 0.2.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (12) hide show

checksums.yaml +4 -4
data/.gitignore +1 -0
data/.ruby-version +1 -1
data/Gemfile.lock +47 -36
data/docs/example/index.html +1 -1
data/lazy_api_doc.gemspec +2 -0
data/lib/generators/lazy_api_doc/templates/public/index.html +1 -1
data/lib/lazy_api_doc/generator.rb +11 -8
data/lib/lazy_api_doc/route_parser.rb +6 -12
data/lib/lazy_api_doc/variants_parser.rb +4 -4
data/lib/lazy_api_doc/version.rb +1 -1
metadata +18 -7

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af5749a17e1dece2e3ae5aeb8cc40d4452fc5ea09bd7574eb00e9110711a1c68
-  data.tar.gz: e921f572e2fbb00a6553c9fa29bfb902b8eec16c9178dc82ccb8f7fc770cbd23
+  metadata.gz: 3089fde7c5d3c9cce883fe8d92e2a945b35971e70d6ab7cdd6271dfd517ba642
+  data.tar.gz: 68b995f02c1057ae7bdc07eaf933640655804a947f49033b61e583e7f1e49ef8
 SHA512:
-  metadata.gz: 01c31a46f50ecea8a0ae7b7fb27a6190640a4455e78cd0e703e61873b58bb77fdcb85206ea177b06b707ad79d2ef0191e7730c2e69d7ee2d3a056c69e2dcb9c1
-  data.tar.gz: a3e2353321040cd4720c0de6d4f1109010e8511c5555a5d76d28a17a359d566ccbce0a027cae51ab47deb18ae4782847303386f45f286a35b74038d9a2a23cdc
+  metadata.gz: 9902d226187a5f4c2f3680f3585684adc7ca928dd6bd60b2971b71a901d7e27a874628a49b7c532cdf0d1f2bd8fb12f4d82119b5a7abb1adc65c4fe46e4bc819
+  data.tar.gz: 45d352415cdb5b57e7f21d6dba8d8c3275a8b7c3e305fb7029564ab54726c7f360d1483d6f38119b4af8badaf5d8a971162d3e513b0bf6a490c9987b09c7b30e

data/.gitignore CHANGED Viewed

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

data/.ruby-version CHANGED Viewed

	@@ -1 +1 @@
1	- ruby-3.0.3
1	+ ruby-3.4.4

data/Gemfile.lock CHANGED Viewed

@@ -1,57 +1,68 @@
 PATH
   remote: .
   specs:
-    lazy_api_doc (0.2.4)
+    lazy_api_doc (0.2.6)
+      ostruct
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.2)
-    diff-lcs (1.3)
-    docile (1.4.0)
-    json (2.6.3)
-    parallel (1.22.1)
-    parser (3.2.1.1)
+    ast (2.4.3)
+    diff-lcs (1.6.2)
+    docile (1.4.1)
+    json (2.19.5)
+    language_server-protocol (3.17.0.5)
+    lint_roller (1.1.0)
+    ostruct (0.6.3)
+    parallel (1.28.0)
+    parser (3.3.11.1)
       ast (~> 2.4.1)
+      racc
+    prism (1.9.0)
+    racc (1.8.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)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.0)
-      rspec-support (~> 3.9.0)
-    rspec-expectations (3.9.0)
+    regexp_parser (2.12.0)
+    rspec (3.13.2)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.6)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.8)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.0)
-    rubocop (1.48.1)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.7)
+    rubocop (1.86.1)
       json (~> 2.3)
-      parallel (~> 1.10)
-      parser (>= 3.2.0.0)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
+      parallel (>= 1.10)
+      parser (>= 3.3.0.2)
       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)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.49.0, < 2.0)
       ruby-progressbar (~> 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)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.49.1)
+      parser (>= 3.3.7.2)
+      prism (~> 1.7)
+    rubocop-rspec (3.9.0)
+      lint_roller (~> 1.1)
+      rubocop (~> 1.81)
     ruby-progressbar (1.13.0)
-    simplecov (0.21.2)
+    simplecov (0.22.0)
       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 (2.4.2)
+    simplecov-html (0.13.2)
+    simplecov_json_formatter (0.1.4)
+    unicode-display_width (3.2.0)
+      unicode-emoji (~> 4.1)
+    unicode-emoji (4.2.0)
 PLATFORMS
   ruby
@@ -65,4 +76,4 @@ DEPENDENCIES
   simplecov
 BUNDLED WITH
-   2.2.32
+  4.0.11

data/docs/example/index.html CHANGED Viewed

@@ -19,6 +19,6 @@
 </head>
 <body>
 <redoc spec-url='./api.yml'></redoc>
-<script src="https://cdn.jsdelivr.net/npm/redoc@next/bundles/redoc.standalone.js"></script>
+<script src="https://cdn.redoc.ly/redoc/latest/bundles/redoc.standalone.js"></script>
 </body>
 </html>

data/lazy_api_doc.gemspec CHANGED Viewed

@@ -29,4 +29,6 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
   spec.metadata['rubygems_mfa_required'] = 'true'
+  spec.add_dependency "ostruct"
 end

data/lib/generators/lazy_api_doc/templates/public/index.html CHANGED Viewed

@@ -19,6 +19,6 @@
 </head>
 <body>
 <redoc spec-url='./api.yml'></redoc>
-<script src="https://cdn.jsdelivr.net/npm/redoc@next/bundles/redoc.standalone.js"></script>
+<script src="https://cdn.redoc.ly/redoc/latest/bundles/redoc.standalone.js"></script>
 </body>
 </html>

data/lib/lazy_api_doc/generator.rb CHANGED Viewed

@@ -1,4 +1,5 @@
 require 'cgi'
+require 'ostruct'
 module LazyApiDoc
   class Generator
@@ -23,12 +24,12 @@ 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] ||= {}
         result[doc_path].merge!(example_group(first, examples, route))
@@ -91,8 +92,8 @@ module LazyApiDoc
                  else
                    {}
                  end
-        if %w[GET DELETE HEAD].include?(example['verb'])
-          params.merge!(example.params.except(*EXCLUDED_PARAMS, *route['path_params']))
+        if %w[GET HEAD].include?(example['verb'])
+          params.merge!(example.params.except(*EXCLUDED_PARAMS, *route['path_params'], *route['defaults'].keys))
         end
         params
       end
@@ -110,9 +111,11 @@ module LazyApiDoc
     def body_params(route, examples)
       first = examples.first
-      return unless %w[POST PATCH PUT].include?(first['verb'])
+      return unless %w[POST PATCH PUT DELETE].include?(first['verb'])
-      variants = examples.map { |example| example.params.except(*EXCLUDED_PARAMS, *route['path_params']) }
+      variants = examples.map do |example|
+        example.params.except(*EXCLUDED_PARAMS, *route['path_params'], *route['defaults'].keys)
+      end
       {
         'content' => {
           first.content_type => {

data/lib/lazy_api_doc/route_parser.rb CHANGED Viewed

@@ -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)
+      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 CHANGED Viewed

@@ -26,7 +26,7 @@ module LazyApiDoc
     def types_template(variants)
       types = types_of(variants)
-      if types.count == 1
+      if types.one?
         {
           "type" => types.first
         }
@@ -69,15 +69,15 @@ module LazyApiDoc
     def parse_hash(variants)
       result = types_template(variants)
-      variant = variants.select { |v| v.is_a?(Hash) }.reverse_each
+      variant = variants.grep(Hash).reverse_each
                         .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) })
+          parse(val, variants.grep(Hash).map { |v| v.fetch(key, OPTIONAL) })
         ]
       end
-      result["required"] = variant.keys.select { |key| variants.select { |v| v.is_a?(Hash) }.all? { |v| v.key?(key) } }
+      result["required"] = variant.keys.select { |key| variants.grep(Hash).all? { |v| v.key?(key) } }
       result
     end

data/lib/lazy_api_doc/version.rb CHANGED Viewed

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

metadata CHANGED Viewed

@@ -1,15 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: lazy_api_doc
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.6
 platform: ruby
 authors:
 - Bogdan Guban
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-03-30 00:00:00.000000000 Z
-dependencies: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ostruct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 'The gem collects all requests and responses from your request specs
   and generates documentation based on it
@@ -58,7 +71,6 @@ metadata:
   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:
 - lib
@@ -73,8 +85,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
-signing_key:
+rubygems_version: 3.6.7
 specification_version: 4
 summary: Creates openapi v3 documentation based on rspec request tests
 test_files: []