lazy_api_doc 0.2.4 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af5749a17e1dece2e3ae5aeb8cc40d4452fc5ea09bd7574eb00e9110711a1c68
-  data.tar.gz: e921f572e2fbb00a6553c9fa29bfb902b8eec16c9178dc82ccb8f7fc770cbd23
+  metadata.gz: ef3ed91d230146fe8a9ec8848a38faaa15b74bbe9543cce9bbf9df31378b2364
+  data.tar.gz: 9a8d617d8e7ee944da9fe0d3044b38a95bc9a030be816565f6efe686ff90c84b
 SHA512:
-  metadata.gz: 01c31a46f50ecea8a0ae7b7fb27a6190640a4455e78cd0e703e61873b58bb77fdcb85206ea177b06b707ad79d2ef0191e7730c2e69d7ee2d3a056c69e2dcb9c1
-  data.tar.gz: a3e2353321040cd4720c0de6d4f1109010e8511c5555a5d76d28a17a359d566ccbce0a027cae51ab47deb18ae4782847303386f45f286a35b74038d9a2a23cdc
+  metadata.gz: 6122f584b76193d5ce943208d67a8c3e80637acf3c78f78381629fc67b468ac337dc7ffb17cefcb1cefc7b4a18b2ab6a531113c3b138e99b2bc92c1a999d07bb
+  data.tar.gz: de1c56436fb2fca419cd0a2fa25a051cc08da77820dc4c9f8da9dfe5182d125275fc041254b721376b1432d0cb251fe6111c31c4a717a4391e924a84891c61c2

data/.gitignore

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

data/Gemfile.lock

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

data/lib/lazy_api_doc/generator.rb

@@ -23,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] ||= {}
@@ -91,8 +90,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 +109,9 @@ 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 { |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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lazy_api_doc
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.5
 platform: ruby
 authors:
 - Bogdan Guban
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-03-30 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 documentation based on it