lazy_api_doc 0.1.2 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6a399e710f96856c2fb1763fb625647a60b089096c58a42bfecdda84ed9c199a
-  data.tar.gz: 842381548c69be6d6aea07a31aff8db2a26eb9c2b8e8c074390ae01a9a50b980
+  metadata.gz: 31368d253e80c44fce567ac28d48de2e4ade297e3b4801633d5a71d3256da89a
+  data.tar.gz: d1030d418b1a8097be35afc5a0d6bb86242da3e7b59e84f8fbdc49bac383fd34
 SHA512:
-  metadata.gz: 49e6405242909d210c727775d862dbce8c6afddbb744ab69a037530bebbc72be88a4da83c44b2f8402b76f8eec7acee498710640ba694de479c1067b6834a40e
-  data.tar.gz: 7e80fd689eaa7e7f3493d0e07d31d63229daa2b82b5a9039663358a19c7a58fa9432db2672c91ee19da062a12136f66a595d20d931d6278606e06b2c54623b31
+  metadata.gz: f223f1e4133df068b6587aa0e2cecdede3dec1c1f52e4af2946573927745aac3787fc98168ebeb149b3a2d2cef751179def7c345069abf2ce43d5f9b8b76c40d
+  data.tar.gz: 62281755d82ec9ac3de295d24bc108f4c462e5c08ebd8507690896dfae276acceffeff9768338ef536dc76d0907407e501c182e13b823414151c2c462961b4b7

data/.ruby-version

@@ -1 +1 @@
-ruby-2.6.4
+ruby-3.0.3

data/Gemfile.lock

@@ -1,14 +1,14 @@
 PATH
   remote: .
   specs:
-    lazy_api_doc (0.1.2)
+    lazy_api_doc (0.1.6)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.0)
     diff-lcs (1.3)
-    docile (1.3.2)
+    docile (1.4.0)
     jaro_winkler (1.5.4)
     parallel (1.19.0)
     parser (2.6.5.0)
@@ -38,10 +38,12 @@ GEM
     rubocop-rspec (1.38.1)
       rubocop (>= 0.68.1)
     ruby-progressbar (1.10.1)
-    simplecov (0.18.5)
+    simplecov (0.21.2)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
-    simplecov-html (0.12.2)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.3)
     unicode-display_width (1.6.0)
 
 PLATFORMS
@@ -56,4 +58,4 @@ DEPENDENCIES
   simplecov
 
 BUNDLED WITH
-   2.1.2
+   2.2.32

data/README.md

@@ -45,6 +45,18 @@ The documentation will be placed `public/lazy_api_doc/api.yml`. To see it just r
     
 and navigate to http://localhost:3000/lazy_api_doc/
 
+## How does it work under the hood?
+
+LazyApiDoc gathers your test requests and responses, group them by controllers and actions that were affected, and tries to guess the type of every field.
+```json
+user: {
+ id: 1, // Integer
+ name: "John Doe", // String,
+ created_at: "2020-05-17 20:15:47Z -0400" // DateTime
+}
+``` 
+After that, it just builds an OpenAPI specification based on it.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/bguban/lazy_api_doc. This project is intended 

data/lib/generators/lazy_api_doc/templates/support/minitest_interceptor.rb

@@ -3,8 +3,8 @@ module LazyApiDocInterceptor
 
   included do
     %w[get post patch put head delete].each do |method|
-      define_method(method) do |*args|
-        result = super(*args)
+      define_method(method) do |*args, **kwargs|
+        result = super(*args, **kwargs)
         # self.class.metadata[:doc]
         LazyApiDoc.add_test(self)
         result

data/lib/generators/lazy_api_doc/templates/support/rspec_interceptor.rb

@@ -3,8 +3,8 @@ module LazyApiDocInterceptor
 
   included do
     %w[get post patch put head delete].each do |method|
-      define_method(method) do |*args|
-        result = super(*args)
+      define_method(method) do |*args, **kwargs|
+        result = super(*args, **kwargs)
         # self.class.metadata[:doc] can be used to document only tests with doc: true metadata
         LazyApiDoc.add_spec(self)
         result

data/lib/lazy_api_doc/generator.rb

@@ -11,12 +11,13 @@ module LazyApiDoc
     def add(example)
       return if example[:controller] == "anonymous" # don't handle virtual controllers
 
-      @examples << OpenStruct.new(example)
+      @examples << example
     end
 
     def result
       result = {}
-      @examples.sort_by(&:source_location).group_by { |ex| [ex.controller, ex.action] }.map do |_, examples|
+      @examples.map { |example| OpenStruct.new(example) }.sort_by(&:source_location)
+               .group_by { |ex| [ex.controller, ex.action] }.map do |_, examples|
         first = examples.first
         route = ::LazyApiDoc::RouteParser.new(first.controller, first.action, first.verb).route
         doc_path = route[:doc_path]
@@ -28,7 +29,7 @@ module LazyApiDoc
 
     def example_group(example, examples, route) # rubocop:disable Metrics/AbcSize
       {
-        route[:verb].downcase => {
+        example['verb'].downcase => {
           "tags" => [example.controller],
           "description" => example["description"].capitalize,
           "summary" => example.action,
@@ -95,9 +96,9 @@ module LazyApiDoc
     end
 
     def body_params(route, examples)
-      return if route[:verb] == "GET"
-
       first = examples.first
+      return unless %w[POST PATCH].include?(first['verb'])
+
       variants = examples.map { |example| example.params.except("controller", "action", *route[:path_params]) }
       {
         'content' => {

data/lib/lazy_api_doc/route_parser.rb

@@ -15,34 +15,19 @@ module LazyApiDoc
     def self.routes
       return @routes if defined?(@routes)
 
-      all_routes = Rails.application.routes.routes
-      require "action_dispatch/routing/inspector"
-      inspector = ActionDispatch::Routing::RoutesInspector.new(all_routes)
-      @routes = inspector.format(JsonRoutesFormatter.new, ENV["CONTROLLER"])
+      @routes = Rails.application.routes.routes.map { |route| format(route) }
     end
-  end
-end
 
-class JsonRoutesFormatter
-  def initialize
-    @buffer = []
-  end
+    def self.format(route)
+      route = ActionDispatch::Routing::RouteWrapper.new(route)
 
-  def result
-    @buffer
-  end
-
-  def section_title(_title); end
-
-  def section(routes)
-    @buffer = routes.map do |r|
-      r[:doc_path] = r[:path].gsub("(.:format)", "").gsub(/(:\w+)/, '{\1}').delete(":")
-      r[:path_params] = r[:path].gsub("(.:format)", "").scan(/:\w+/).map { |p| p.delete(":").to_sym }
-      r[:controller] = r[:reqs].split("#").first
-      r[:action] = r[:reqs].split("#").last.split(" ").first
-      r
+      {
+        doc_path: route.path.gsub("(.:format)", "").gsub(/(:\w+)/, '{\1}').delete(":"),
+        path_params: route.path.gsub("(.:format)", "").scan(/:\w+/).map { |p| p.delete(":").to_sym },
+        controller: route.controller,
+        action: route.action,
+        verb: route.verb.split('|')
+      }
     end
   end
-
-  def header(_routes); end
 end

data/lib/lazy_api_doc/variants_parser.rb

@@ -83,7 +83,7 @@ module LazyApiDoc
     def parse_array(variant, variants)
       first = variant.first
       types_template(variants).merge(
-        "items"   => parse(first, variants.map(&:first).compact),
+        "items"   => parse(first, variants.compact.map(&:first).compact),
         "example" => variant
       )
     end

data/lib/lazy_api_doc/version.rb

@@ -1,3 +1,3 @@
 module LazyApiDoc
-  VERSION = "0.1.2".freeze
+  VERSION = "0.1.6".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lazy_api_doc
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.6
 platform: ruby
 authors:
 - Bogdan Guban
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-04-10 00:00:00.000000000 Z
+date: 2022-02-08 00:00:00.000000000 Z
 dependencies: []
 description: The gem collects all requests and responses from your request specs and
   generates documentationbased on it
@@ -51,7 +51,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
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -66,8 +66,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.2.32
+signing_key:
 specification_version: 4
 summary: Creates openapi v3 documentation based on rspec request tests
 test_files: []