swagger_yard 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 83e1c4a1e03bfda00de8186e1c4ff6295cd80cc48d1053cd50f7f334ffe328fb
-  data.tar.gz: f0c8fd6215987665d201f921ccc4421a4f623c4c527867b01328f3279147b123
+  metadata.gz: 756c19df66b9851bc539daa6a77ba78b00814a73e514411c03ed036aaa0c2921
+  data.tar.gz: fa7b4ca209d1654df04d659f57c4e38803ce90c4c0a65d45c1aef7f19f655978
 SHA512:
-  metadata.gz: 8589dd0a10c513d877c27efcae067cebc61fcc7855c2a12c0a85c84db42007e63860f284afce8b63e7afb3f3372a1c035c806eb98d004a3ac9284c32b07324ff
-  data.tar.gz: 3d9d1203cea5812416f6838207e3f114f009653d8e1f787baea890260180652d5f337ce2cf6dcadb213a58e0503a674098fad98c841b41ecf366db08b5bfb8eb
+  metadata.gz: e00185e0b6e4d36c9933f3567b6223a7918ec47fe3a31f54a08d87442306efa3b6398a83cb820e4e04839f0b475102463963df580a75fd3918f974c014269993
+  data.tar.gz: ef4cdc1187050861e1bc4bfe6a23c223473e86def53ada9d65320c853a79e71c1d7ddcfb62eb9f9d69b5fab34a68f04503bda6f7825881a12021d9fb985d5e0f

data/README.md

@@ -41,6 +41,9 @@ Then start to annotate controllers and models as described below.
 To generate a Swagger or OpenAPI specification, use one of the `SwaggerYard::Swagger` or `SwaggerYard::OpenAPI` classes as follows in a script or Rake task (or use [swagger_yard-rails](/livingsocial/swagger_yard-rails)):
 
 ```
+# Register the yard tags
+SwaggerYard.register_custom_yard_tags!
+
 spec = SwaggerYard::OpenAPI.new
 # Generate YAML
 File.open("openapi.yml", "w") { |f| f << YAML.dump(spec.to_h) }
@@ -258,6 +261,24 @@ class Person
 end
 ```
 
+### Standalone Model ###
+
+Types can be specified without being associated to an existing model with the `@!model` directive. It is useful when documenting a create and an update of the same class:
+
+```ruby
+# @!model CreatePet
+# @property id(required)    [integer]
+# @property name(required)  [string]
+#
+# @!model UpdatePet
+# @property id(required)    [integer]
+# @property name            [string]
+```
+
+It can also be needed when the body parameter of a path is not totally matching a model.
+
+Note that a model name must be given to the directive.
+
 
 ### External Schema ###
 

data/lib/swagger_yard.rb

@@ -15,6 +15,7 @@ require "swagger_yard/path_item"
 require "swagger_yard/swagger"
 require "swagger_yard/openapi"
 require "swagger_yard/handlers"
+require "swagger_yard/directives"
 
 module SwaggerYard
   class Error < StandardError; end
@@ -115,6 +116,7 @@ module SwaggerYard
       ::YARD::Tags::Library.define_tag("Authorization Use", :authorize_with)
       # @example is a core YARD tag, let's use it
       # ::YARD::Tags::Library.define_tag("Example", :example, :with_title_and_text)
+      ::YARD::Tags::Library.define_directive(:model, :with_title_and_text, Directives::ParamClassDirective)
     end
   end
 end

data/lib/swagger_yard/directives.rb

@@ -0,0 +1,32 @@
+module SwaggerYard::Directives
+  
+  # A directive used to create a model tag with a dummy class.
+  # based on https://github.com/lsegal/yard/blob/master/lib/yard/tags/directives.rb#L361
+  class ParamClassDirective < YARD::Tags::Directive
+
+    def call; end
+
+    def after_parse
+      return unless handler
+
+      create_object
+    end
+
+    def create_object
+      name = tag.name
+      obj = YARD::CodeObjects::ClassObject.new(handler.namespace, tag.name)
+      handler.register_file_info(obj)
+      handler.register_source(obj)
+      handler.register_group(obj)
+      obj.docstring = YARD::Docstring.new!(parser.text,
+                                           parser.tags,
+                                           obj,
+                                           nil,
+                                           parser.reference)
+      obj.add_tag(YARD::Tags::Tag.new(:model, name))
+      parser.object = obj
+      parser.post_process
+      obj
+    end
+  end
+end

data/lib/swagger_yard/version.rb

@@ -1,3 +1,3 @@
 module SwaggerYard
-  VERSION = "1.0.2"
+  VERSION = "1.0.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: swagger_yard
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - chtrinh (Chris Trinh)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-04 00:00:00.000000000 Z
+date: 2020-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
@@ -193,6 +193,7 @@ files:
 - lib/swagger_yard/api_group.rb
 - lib/swagger_yard/authorization.rb
 - lib/swagger_yard/configuration.rb
+- lib/swagger_yard/directives.rb
 - lib/swagger_yard/example.rb
 - lib/swagger_yard/handlers.rb
 - lib/swagger_yard/model.rb
@@ -227,8 +228,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.4
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: SwaggerYard API doc through YARD