auto-rswag 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7bd7f5d1bb6327a80a89497075356aafd2cdcba798b8d7258f2d31c682666a95
-  data.tar.gz: b509baea5844020859126427811398fa40e79496a0d5e66ef3a881c08c841c39
+  metadata.gz: 06f50ff94bb14438b211685cdb3d54144978cef3a42379c02ca1b5a954337a8a
+  data.tar.gz: 43b6f985bf697b4944a6e018c71ce1bd4daeb8072984205c731d76e650fd2930
 SHA512:
-  metadata.gz: db3929e25c816dcd3710c081eed70c089112149d1befb1570de3a84b9306dd4897191b6643a1c47e4c74e9391a4d1b150195172be6d2fbf05f50e33bbc5fdc2e
-  data.tar.gz: 4ba7b0c799057de66e6ed2c8cc852cd67e8c15053344da60a453c0aa3dfeae861e4bacf14e07161cfd876d8f2a138145234afff7efc31cec7d741afc000992ef
+  metadata.gz: 3c405a46499c9984ab08e2eb17fba5cf5f89bd307c539f65c96edcc52f4b7041886ea01cf99047cbdb4cd8568f8475f71febc41742c0b264085d17b4c1ab82de
+  data.tar.gz: 84cdad3bde8f9fac167a492321fd41047d97f5c17f581efdccde57b77f9e823f14a6280dec652acb1e40fce6db6fbe6cc580b6e4d8aebba5fe5dfb2c6f183325

data/lib/auto_rswag.rb

@@ -1,21 +1,24 @@
 # frozen_string_literal: true
 
 require 'json'
-require_relative 'printer.rb'
-require_relative 'auto_rswag_helper.rb'
-require_relative 'doc_writer.rb'
+require 'printer.rb'
+require 'auto_rswag_helper.rb'
+require 'doc_writer.rb'
 
 # This module hooks into the Rspec test to retrieve useful
 # metadata and submit it to AutoRswagHelper for conversion.
 module AutoRswag
   def update_documentation
-    $title = metadata[:response][:schema]['$ref'].split('/').last
-
-    after do
+    after do |example|
+      title = example.metadata[:response][:schema]['$ref'].split('/').last
       payload = AutoRswagHelper.convert_response(response)
       AutoRswagHelper.map_fields(payload)
-      docs = SwaggerPrinter.print_swagger(payload, $title)
-      DocWriter.write_docs(docs, $title)
+      docs = SwaggerPrinter.print_swagger(payload, title)
+      DocWriter.new.write_docs(docs, title)
     end
   end
 end
+
+Rswag::Specs::ExampleGroupHelpers.module_eval do
+  include AutoRswag
+end

data/lib/doc_writer.rb

@@ -2,37 +2,46 @@
 
 # This class writes the parsed documenation to the swagger_helper file.
 class DocWriter
-  class << self
-    def default_docs_path
-      Rails.root.join('spec', 'swagger_helper.rb').to_s
-    end
+  def docs_path
+    Rails.root.join('spec', 'swagger_helper.rb').to_s
+  end
 
-    def write_docs(docs, fragment_title)
-      old_documentation = File.read(default_docs_path)
-      new_documentation_fragment = example_hash(fragment_title, old_documentation)
-      return if new_documentation_fragment.nil?
+  def write_docs(docs, fragment_title)
+    old_documentation = File.read(docs_path)
+    old_documentation_fragment = example_hash(fragment_title, old_documentation)
+    return if old_documentation_fragment.nil?
 
-      new_documentation = old_documentation.sub(new_documentation_fragment, docs)
-      File.open(default_docs_path, 'w') { |f| f.write(new_documentation) }
-    end
+    new_documentation_fragment = apply_original_indentation(docs, fragment_title)
+    new_documentation = old_documentation.sub(old_documentation_fragment, new_documentation_fragment)
+    File.open(docs_path, 'w') { |f| f.write(new_documentation) }
+  end
+
+  def example_hash(fragment_title, old_documentation)
+    match = ''
+    iterator = 1
+    loop do
+      regex = /(#{fragment_title})(.*?\}){#{iterator}}/
+      new_match_data = old_documentation.match(regex)
+      new_match = new_match_data.present? ? new_match_data[0] : nil
+      return unless new_match != match
 
-    def example_hash(fragment_title, old_documentation)
-      match = ''
-      iterator = 1
-      while true do
-        regex = /(#{fragment_title})(.*?\}){#{iterator}}/
-        new_match_data = old_documentation.match(regex)
-        new_match = new_match_data.present? ? new_match_data[0] : nil
-        return unless new_match != match
-
-        match = new_match
-        begin
-          return match if eval("{#{match}}")
-        rescue SyntaxError
-        end
-
-        iterator += 1
+      match = new_match
+      begin
+        return match if eval("{#{match}}")
+      rescue SyntaxError
       end
+
+      iterator += 1
     end
   end
+
+  def apply_original_indentation(new_documentation, fragment_title)
+    indentation = ' ' * original_indent_level(fragment_title)
+    new_documentation.split("\n").join("\n" + indentation)
+  end
+
+  def original_indent_level(fragment_title)
+    file = File.read(docs_path)
+    file.match(/\s+(?=#{fragment_title})/)[0].size - 1
+  end
 end

data/lib/printer.rb

@@ -39,13 +39,13 @@ class SwaggerPrinter
 
       output = wrap_hash
       object.each_with_index do |(key, val), i|
-        line = if val[:type] == :object
-                 print_hash(key, val)
-               elsif val[:type] == :array
-                 print_array(key, val)
-               else
-                 print_line(key, val)
-               end
+        line =  if val[:type] == :object
+                  print_hash(key, val)
+                elsif val[:type] == :array
+                  print_array(key, val)
+                else
+                  print_line(key, val)
+                end
         comma = i == object.keys.size - 1 ? '' : ','
         line += "#{comma}\n"
         output += line
@@ -79,7 +79,8 @@ class SwaggerPrinter
     def print_line(key, val)
       line = ' ' * @indent + "#{key}: { "
       val.each_with_index do |(val_key, val_val), j|
-        next if val_key == :type && val.any? { |k, v| k == :example && v == nil }
+        next if val_key == :type && val.any? { |k, v| k == :example && v.nil? }
+
         val_comma = j == val.keys.size - 1 ? '' : ','
         line += "#{escape_key(val_key)}: #{prettify_value(val, val_key, val_val)}#{val_comma} "
       end
@@ -88,8 +89,8 @@ class SwaggerPrinter
 
     def escape_key(key)
       return key unless key.to_s.include?('-')
-      
-      "'#{key.to_s}'"
+
+      "'#{key}'"
     end
 
     def prettify_value(type, key, val)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: auto-rswag
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Tyler Porter