swagger_yard 0.4.3 → 0.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e89a490cac5cca8d1ec701e2f2a4eb973656ca23
-  data.tar.gz: ffdff3722d5835e866ae2704abd497aaa0da2f22
+  metadata.gz: 75d0e74a6ac517d09a0743edffa6ea2aa7ddf963
+  data.tar.gz: cbda242b96ac6e12646362d573f93b6becc050d9
 SHA512:
-  metadata.gz: 777a8b449750c1d03b655fe007798cf90687a5931b3e1fe43b55133beb71161b6f4d0071caa3e5e3b18f173925ffb56d30844a37cb35902300f3851750309e6f
-  data.tar.gz: 04f928e5ccbd37ee4cbab146c2ea2c1005a665674b8b10eb388e5e67046fce5257c86dcd05d4940db8ccef2e3343851ffcf824d269144c3117b6ee4d4c4fd32f
+  metadata.gz: 52ed18981ab935c658185407e57a65b70c8ecd711c844d1dcfd84dee2c21064dc98717d498f8101d169ed6bd9cf4fb9a80e4f6f442491d76919523d84f5cea90
+  data.tar.gz: ab50c39b04875a413514fda5a8ece2d021421768f97a42009f52fdc0f30f940bd910272f598efae73690cfa4054db4e3386d43622f02968c66dbc9ab8b6396ae

data/lib/swagger_yard.rb

@@ -41,6 +41,37 @@ module SwaggerYard
       YARD::Logger.instance
     end
 
+    # Validates that the tag has non-nil values for the given attribute methods.
+    # Logs a warning message and returns nil if the tag is not valid.
+    def requires_attrs(tag, *attrs)
+      valid = true
+      attrs.each do |a|
+        valid &&= tag.send(a)
+        break unless valid
+      end
+      unless valid
+        if tag.object
+          object   = " in #{tag.object.to_s}"
+          location = " near #{tag.object.files.first.join(':')}" if tag.object.files.first
+        end
+        log.warn "invalid @#{tag.tag_name} tag#{object}#{location}"
+        return nil
+      end
+      tag
+    end
+
+    def requires_name(tag)
+      requires_attrs(tag, :name)
+    end
+
+    def requires_name_and_type(tag)
+      requires_attrs(tag, :name, :types)
+    end
+
+    def requires_type(tag)
+      requires_attrs(tag, :types)
+    end
+
     #
     # Use YARD to parse object tags from a file
     #

data/lib/swagger_yard/model.rb

@@ -38,11 +38,14 @@ module SwaggerYard
           @has_model_tag = true
           @id = Model.mangle(tag.text) unless tag.text.empty?
         when "property"
-          @properties << Property.from_tag(tag)
+          prop = Property.from_tag(tag)
+          @properties << prop if prop
         when "discriminator"
           prop = Property.from_tag(tag)
-          @properties << prop
-          @discriminator ||= prop.name
+          if prop
+            @properties << prop
+            @discriminator ||= prop.name
+          end
         when "inherits"
           @inherits << tag.text
         end
@@ -56,16 +59,27 @@ module SwaggerYard
     end
 
     def to_h
-      h = {
-        "type" => "object",
-        "properties" => Hash[@properties.map {|p| [p.name, p.to_h]}]
-      }
+      h = {}
+
+      if !@properties.empty? || @inherits.empty?
+        h["type"] = "object"
+        h["properties"] = Hash[@properties.map {|p| [p.name, p.to_h]}]
+        h["required"] = @properties.select(&:required?).map(&:name) if @properties.detect(&:required?)
+      end
 
-      h["required"] = @properties.select(&:required?).map(&:name) if @properties.detect(&:required?)
       h["discriminator"] = @discriminator if @discriminator
 
       # Polymorphism
-      h = { "allOf" => inherits_references + [h] } unless @inherits.empty?
+      unless @inherits.empty?
+        all_of = inherits_references
+        all_of << h unless h.empty?
+
+        if all_of.length == 1 && @description.empty?
+          h.update(all_of.first)
+        else
+          h = { "allOf" => all_of }
+        end
+      end
 
       # Description
       h["description"] = @description unless @description.empty?

data/lib/swagger_yard/operation.rb

@@ -13,11 +13,13 @@ module SwaggerYard
         yard_object.tags.each do |tag|
           case tag.tag_name
           when "path"
-            operation.add_path_params_and_method(tag)
+            tag = SwaggerYard.requires_type(tag)
+            operation.add_path_params_and_method(tag) if tag
           when "parameter"
             operation.add_parameter(tag)
           when "response_type"
-            operation.add_response_type(Type.from_type_list(tag.types), tag.text)
+            tag = SwaggerYard.requires_type(tag)
+            operation.add_response_type(Type.from_type_list(tag.types), tag.text) if tag
           when "error_message"
             operation.add_error_message(tag)
           when "summary"
@@ -110,7 +112,8 @@ module SwaggerYard
     # Example: [Array]     status(required, body)  Filter by status. (e.g. status[]=1&status[]=2&status[]=3)
     # Example: [Integer]   media[media_type_id]                          ID of the desired media type.
     def add_parameter(tag)
-      add_or_update_parameter Parameter.from_yard_tag(tag, self)
+      param = Parameter.from_yard_tag(tag, self)
+      add_or_update_parameter param if param
     end
 
     def add_or_update_parameter(parameter)
@@ -137,6 +140,8 @@ module SwaggerYard
     end
 
     def add_error_message(tag)
+      tag = SwaggerYard.requires_name(tag)
+      return unless tag
       @error_messages << {
         "code" => Integer(tag.name),
         "message" => tag.text,

data/lib/swagger_yard/parameter.rb

@@ -3,6 +3,9 @@ module SwaggerYard
     attr_accessor :name, :type, :description, :param_type, :required, :allow_multiple
 
     def self.from_yard_tag(tag, operation)
+      tag = SwaggerYard.requires_name_and_type(tag)
+      return nil unless tag
+
       name, options_string = tag.name.split(/[\(\)]/)
       description = tag.text
       description = name if description.nil? || description.strip.empty?

data/lib/swagger_yard/property.rb

@@ -6,6 +6,9 @@ module SwaggerYard
     attr_reader :name, :description
 
     def self.from_tag(tag)
+      tag = SwaggerYard.requires_name_and_type(tag)
+      return nil unless tag
+
       name, options_string = tag.name.split(/[\(\)]/)
 
       options = options_string.to_s.split(',').map(&:strip)

data/lib/swagger_yard/version.rb

@@ -1,3 +1,3 @@
 module SwaggerYard
-  VERSION = "0.4.3"
+  VERSION = "0.4.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: swagger_yard
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.4.4
 platform: ruby
 authors:
 - chtrinh (Chris Trinh)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-20 00:00:00.000000000 Z
+date: 2018-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard