swagalicious 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 941a558739b2079027c117ccea67ffc90c7a21f682811ab817a739ef0ea93d82
-  data.tar.gz: 275cce80dedbfcaa5b5e76d01499fe18babcc7e30a948806ad95df1cea46d475
+  metadata.gz: 5067242694dc59e20ef8dd3c3c3a22456cd22b1b905be4805721f73c5239036c
+  data.tar.gz: eac425366e51b211629753cb3ca7eeaa896688beafa44a75de75ab591aac3246
 SHA512:
-  metadata.gz: 2e8f90a288217b8e27e85411194a73a7f5d1bbe7bd8881a1f086c11319b8ee9a832143bc9c610a8398fb11051484be70f828f3a1625d5c2180d5e1d1194e5121
-  data.tar.gz: 181ff6d1a9dcab5b13499f648b75299f4ab6321c2ea4d65956a94d4bd8b62f90d8e049c771629ed457ca828635f7f90ab35f9bba630b437d0ebb11136d0cdb19
+  metadata.gz: 1b89eaa63682085fa323a27b268b2b7255d5ac453040e0c2e0c988d8378c62b986514056eaf062b76737424623c36743fd56ca1f71ee1c6116e1b991bb1082b8
+  data.tar.gz: 9ab0b21f31c7ec3e845ae58be31db0d006855ce717ca1a1f1f596ee480ddad44904d4fa43ea7f47801cd7014e480d0673af177b601b95ec761cc1e66274db8dc

data/README.md

@@ -27,13 +27,11 @@ Add the following to your `spec_helper.rb` or add a new `swagger_helper.rb`
 ```ruby
 require 'swagalicious`
 
-DEFINITIONS = Oj.load(File.read(File.expand_path("docs/definitions.json", __dir__))).freeze
-
 RSpec.configure do |c|
   c.swagger_root = "public/swagger_docs" # This is the relative path where the swagger docs will be output
   c.swagger_docs = {
     "path/to/swagger_doc.json" => {
-      swagger:  "3.0",
+      openapi:  "3.0.3",
       basePath: "/api/",
       version:  "v1",
       info:     {
@@ -57,7 +55,7 @@ end
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/eugene@xtreme-computers.net/swagalicious.
+Bug reports and pull requests are welcome on GitHub at https://github.com/ehowe/swagalicious.
 
 
 ## License

data/lib/core/ext/hash.rb

@@ -1,9 +1,17 @@
 class Hash
-  def deep_merge!(other_hash)
-    self.merge(other_hash) do |key, oldval, newval|
-      oldval = oldval.to_hash if oldval.respond_to?(:to_hash)
-      newval = newval.to_hash if newval.respond_to?(:to_hash)
-      oldval.class.to_s == "Hash" && newval.class.to_s == "Hash" ? oldval.deep_merge(newval) : newval
+  def deep_merge(other_hash, &block)
+    dup.deep_merge!(other_hash)
+  end
+
+  def deep_merge!(other_hash, &block)
+    merge!(other_hash) do |key, this_val, other_val|
+      if this_val.is_a?(Hash) && other_val.is_a?(Hash)
+        this_val.deep_merge(other_val, &block)
+      elsif block_given?
+        block.call(key, this_val, other_val)
+      else
+        other_val
+      end
     end
   end
 

data/lib/swagalicious.rb

@@ -2,9 +2,13 @@ require "rspec/core"
 
 require_relative "swagalicious/version"
 
-module Swagalicious
+class Swagalicious
   class Error < StandardError; end
 
+  def self.config
+    @config ||= Swagalicious::Configuration.new(RSpec.configuration)
+  end
+
   require_relative "swagalicious/configuration"
   require_relative "swagalicious/example_group_helpers"
   require_relative "swagalicious/example_helpers"
@@ -23,8 +27,4 @@ module Swagalicious
     c.extend Swagalicious::ExampleGroupHelpers, type: :doc
     c.include Swagalicious::ExampleHelpers, type: :doc
   end
-
-  def self.config
-    @config ||= Swagalicious::Configuration.new(RSpec.configuration)
-  end
 end

data/lib/swagalicious/configuration.rb

@@ -1,4 +1,4 @@
-module Swagalicious
+class Swagalicious
   class ConfigurationError < StandardError; end
 
   class Configuration

data/lib/swagalicious/example_group_helpers.rb

@@ -1,4 +1,4 @@
-module Swagalicious
+class Swagalicious
   module ExampleGroupHelpers
     def path(template, metadata={}, &block)
       metadata[:path_item] = { template: template }

data/lib/swagalicious/example_helpers.rb

@@ -5,7 +5,7 @@ require "oj"
 
 require_relative "response_validator"
 
-module Swagalicious
+class Swagalicious
   module ExampleHelpers
     include Rack::Test::Methods
 

data/lib/swagalicious/extended_schema.rb

@@ -1,6 +1,6 @@
 require "json-schema"
 
-module Swagalicious
+class Swagalicious
   class ExtendedSchema < JSON::Schema::Draft4
     def initialize
       super

data/lib/swagalicious/request_factory.rb

@@ -1,7 +1,7 @@
 require "faraday"
 require "faraday/adapter/rack"
 
-module Swagalicious
+class Swagalicious
   class RequestFactory
     def initialize(config = ::Swagalicious.config)
       @config = config

data/lib/swagalicious/response_validator.rb

@@ -1,6 +1,6 @@
 require "json"
 
-module Swagalicious
+class Swagalicious
   class UnexpectedResponse < StandardError; end
 
   class ResponseValidator

data/lib/swagalicious/swagger_formatter.rb

@@ -2,67 +2,71 @@
 
 require_relative "../core/ext/hash"
 
-module Swagalicious
+class Swagalicious
   class SwaggerFormatter
-    RSpec::Core::Formatters.register self, :example_group_finished, :stop
+    RSpec::Core::Formatters.register self, :stop
 
-    def initialize(output, config = Swagalicious.config)
+    def config
+      @config ||= Swagalicious.config
+    end
+
+    def initialize(output, config = nil)
       @output = output
       @config = config
 
       @output.puts "Generating Swagger docs ..."
     end
 
-    def example_group_finished(notification)
-      metadata = notification.group.metadata
-
-      # !metadata[:document] won"t work, since nil means we should generate
-      # docs.
-      return if metadata[:document] == false
-      return unless metadata.key?(:response)
-
-      swagger_doc = @config.get_swagger_doc(metadata[:swagger_doc])
-
-      # This is called multiple times per file!
-      # metadata[:operation] is also re-used between examples within file
-      # therefore be careful NOT to modify its content here.
-      upgrade_request_type!(metadata)
-      upgrade_servers!(swagger_doc)
-      upgrade_oauth!(swagger_doc)
-      upgrade_response_produces!(swagger_doc, metadata)
-
-      swagger_doc.deep_merge!(metadata_to_swagger(metadata))
+    def merge_metadata_to_document(doc, example)
+       metadata = example.metadata
+       # !metadata[:document] won"t work, since nil means we should generate
+       # docs.
+       return {} if metadata[:document] == false
+       return {} unless metadata.key?(:response)
+       # This is called multiple times per file!
+       # metadata[:operation] is also re-used between examples within file
+       # therefore be careful NOT to modify its content here.
+       upgrade_servers!(doc)
+       upgrade_oauth!(doc)
+       upgrade_response_produces!(doc, metadata)
+       upgrade_request_type!(metadata)
+
+       unless doc_version(doc).start_with?("2")
+         doc[:paths]&.each_pair do |_k, v|
+           v.each_pair do |_verb, value|
+             is_hash = value.is_a?(Hash)
+             if is_hash && value.dig(:parameters)
+               schema_param = value.dig(:parameters)&.find { |p| (p[:in] == :body || p[:in] == :formData) && p[:schema] }
+               mime_list    = value.dig(:consumes)
+               if value && schema_param && mime_list
+                 value[:requestBody] = { content: {} } unless value.dig(:requestBody, :content)
+                 mime_list.each do |mime|
+                   value[:requestBody][:content][mime] = { schema: schema_param[:schema] }
+                 end
+               end
+
+               value[:parameters].reject! { |p| p[:in] == :body || p[:in] == :formData }
+             end
+             remove_invalid_operation_keys!(value)
+           end
+         end
+       end
+
+       doc.deep_merge!(metadata_to_swagger(metadata))
     end
 
-    def stop(_notification = nil)
-      @config.swagger_docs.each do |url_path, doc|
-        unless doc_version(doc).start_with?("2")
-          doc[:paths]&.each_pair do |_k, v|
-            v.each_pair do |_verb, value|
-              is_hash = value.is_a?(Hash)
-              if is_hash && value.dig(:parameters)
-                schema_param = value.dig(:parameters)&.find { |p| (p[:in] == :body || p[:in] == :formData) && p[:schema] }
-                mime_list    = value.dig(:consumes)
-                if value && schema_param && mime_list
-                  value[:requestBody] = { content: {} } unless value.dig(:requestBody, :content)
-                  mime_list.each do |mime|
-                    value[:requestBody][:content][mime] = { schema: schema_param[:schema] }
-                  end
-                end
-
-                value[:parameters].reject! { |p| p[:in] == :body || p[:in] == :formData }
-              end
-              remove_invalid_operation_keys!(value)
-            end
-          end
-        end
+    def stop(notification = nil)
+      config.swagger_docs.each do |url_path, doc|
+        examples = notification.examples.select { |e| e.metadata[:swagger_doc] == url_path }
+
+        merged_doc = examples.each_with_object(doc) { |e, doc| doc = doc.deep_merge!(merge_metadata_to_document(doc, e)) }
 
-        file_path = File.join(@config.swagger_root, url_path)
+        file_path = File.join(config.swagger_root, url_path)
         dirname   = File.dirname(file_path)
         FileUtils.mkdir_p dirname unless File.exist?(dirname)
 
         File.open(file_path, "w") do |file|
-          file.write(pretty_generate(doc))
+          file.write(pretty_generate(merged_doc))
         end
 
         @output.puts "Swagger doc generated at #{file_path}"
@@ -72,7 +76,7 @@ module Swagalicious
     private
 
     def pretty_generate(doc)
-      if @config.swagger_format == :yaml
+      if config.swagger_format == :yaml
         clean_doc = yaml_prepare(doc)
         YAML.dump(clean_doc)
       else # config errors are thrown in "def swagger_format", no throw needed here
@@ -103,7 +107,7 @@ module Swagalicious
     end
 
     def doc_version(doc)
-      doc[:openapi] || doc[:swagger] || "3"
+      doc[:openapi] || doc[:swagger] || "3.0.0"
     end
 
     def upgrade_response_produces!(swagger_doc, metadata)

data/lib/swagalicious/version.rb

@@ -1,3 +1,3 @@
-module Swagalicious
-  VERSION = "0.1.0"
+class Swagalicious
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: swagalicious
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Eugene Howe
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-10 00:00:00.000000000 Z
+date: 2020-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -133,7 +133,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: RSwag without Rails