swagger_yard 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ef1f9c99cbcdd6a637a1d68079ba1e2a0b1cb718
-  data.tar.gz: 17849b615de17e9ec974f9905202a8097daf0eba
+  metadata.gz: 4162d53c786e05765654e3aad9162e8d765c481d
+  data.tar.gz: d7d01a44db14c45dc3e372c156a86a4440e5d313
 SHA512:
-  metadata.gz: e200703aa74c246766ec9dbeb448ab6fd7f8b036376f82bd8ae60d0c7b6abe4d1d1149ec662c45d4ab1d34af0f38ece20e909a501bcdae78ee9b038687aa1f68
-  data.tar.gz: 4877499f45c859a0d75ba2518d425a867f2dc072955c38ea49b5cbcaa13f8bd2322989a15f10cb39de1f8a6191057dfdb25333cdb6eef96bdf9aa339d54032e3
+  metadata.gz: 077fadda0f1b63175e75bbe296b3701e36d491a36f1a8becc33dee816052ef919f6b296cb44474d59e3347b15d9d8ec427b18a76958f9ffaa2702ff5e084462e
+  data.tar.gz: eda7883fc961b1d47f73e600803ea0a3fa1b1c77541b9a67c7219b36d9232904bd886dfa6b01dfbe859d988a726faa3c5e31f7808265ab4890375f9bd614b78e

data/README.md

@@ -139,7 +139,7 @@ end
 
 ```ruby
 #
-# @model Pet
+# @model
 #
 # @property id(required)    [integer]   the identifier for the pet
 # @property name  [Array<string>]    the names for the pet
@@ -160,7 +160,7 @@ To support Swagger Polymorphism, use `@discriminator` and `@inherits`:
 
 ```ruby
 #
-# @model Pet
+# @model
 #
 # @property id(required)    [integer]   the identifier for the pet
 # @property name  [Array<string>]    the names for the pet
@@ -172,7 +172,7 @@ class Pet
 end
 
 #
-# @model Dog
+# @model
 #
 # @inherits Pet
 #
@@ -182,6 +182,16 @@ class Dog < Pet
 end
 ```
 
+If you wish to name your model differently from the underlying ruby class, add the name as text to the `@model` tag. In the example here, if we did not specify `Dog` as the model name, it would have been named `Models_Dog`.
+
+```ruby
+# @model Dog
+module Models
+  class Dog
+  end
+end
+```
+
 ## Authorization ##
 ### API Key auth ###
 

data/lib/swagger_yard/model.rb

@@ -4,10 +4,11 @@ module SwaggerYard
   #   complex model object as defined by swagger schema
   #
   class Model
-    attr_reader :id, :discriminator, :inherits
+    attr_reader :id, :discriminator, :inherits, :description
 
     def self.from_yard_object(yard_object)
       new.tap do |model|
+        model.add_info(yard_object)
         model.parse_tags(yard_object.tags)
       end
     end
@@ -25,11 +26,16 @@ module SwaggerYard
       !id.nil?
     end
 
+    def add_info(yard_object)
+      @description = yard_object.docstring
+      @id = Model.mangle(yard_object.path)
+    end
+
     def parse_tags(tags)
       tags.each do |tag|
         case tag.tag_name
         when "model"
-          @id = Model.mangle(tag.text)
+          @id = Model.mangle(tag.text) unless tag.text.empty?
         when "property"
           @properties << Property.from_tag(tag)
         when "discriminator"
@@ -37,7 +43,7 @@ module SwaggerYard
           @properties << prop
           @discriminator ||= prop.name
         when "inherits"
-          @inherits << Model.mangle(tag.text)
+          @inherits << tag.text
         end
       end
 
@@ -45,11 +51,7 @@ module SwaggerYard
     end
 
     def inherits_references
-      @inherits.map do |name|
-        {
-          "$ref" => "#/definitions/#{name}"
-        }
-      end
+      @inherits.map { |name| Type.new(name).to_h }
     end
 
     def to_h
@@ -65,7 +67,7 @@ module SwaggerYard
       h = { "allOf" => inherits_references + [h] } unless @inherits.empty?
 
       # Description
-      h["description"] = @description if @description
+      h["description"] = @description unless @description.empty?
 
       h
     end

data/lib/swagger_yard/version.rb

@@ -1,3 +1,3 @@
 module SwaggerYard
-  VERSION = "0.4.0"
+  VERSION = "0.4.1"
 end

metadata

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