swagger_yard 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9e95fe3850f449db0d3234e6b314bf76c3570f7d
-  data.tar.gz: 9f2e1c1a9d2a3731431e6d606a4023d7ae692326
+  metadata.gz: e69ba8fc51e7c39ca9291c1e2917f28b5ed794fe
+  data.tar.gz: f00801cc7268c6faf6d1fdc22c8d9b14ccf55756
 SHA512:
-  metadata.gz: 3609ee174c38e70038f0358b735c9c1ffdf73ca76c634d9e2f93f1d42f497d6f752b3cf0b1c9f18d58ce68ff426d8f254b09fb76da748dc8f2a5e87d3ea85b38
-  data.tar.gz: de11893ad4b1293ad2955617ebd967c2030d7347beb15ea6ac486de6769f0a12fa2e334822dae4c2790b2c83b95abe8f251f12cce897209bab2106d9d1217bd5
+  metadata.gz: baa76a8eccd08176c057fb6d6969001899350d7f0ce8b5cf25ab00cd29d42bf81e554440e5517a1dd517c1bb4952f8deb6143127442e208f91c181825fec6faa
+  data.tar.gz: 7ddf6347f3a340ab921f0f576146fcd3709f8adbcbe049319ab63137fc156779998369f68b1612b97138434fccf9ae8198dde34b19e6463bc713df9d6038d375

data/lib/swagger_yard/configuration.rb

@@ -28,5 +28,9 @@ module SwaggerYard
       end if mappings
       @external_schema
     end
+
+    def register_dsl_method(meth, options = {})
+      SwaggerYard::Handlers::DSLHandler.register_dsl_method(meth, options)
+    end
   end
 end

data/lib/swagger_yard/handlers.rb

@@ -0,0 +1,35 @@
+module SwaggerYard::Handlers
+  class DSLHandler < YARD::Handlers::Ruby::Base
+    include YARD::CodeObjects
+    namespace_only
+
+    def self.method_options
+      @method_options ||= {}
+    end
+
+    def self.reset
+      method_options.keys.each do |m|
+        handler = handlers.detect { |h| h.respond_to?(:name) && h.send(:name).to_s == m.to_s }
+        handlers.delete handler if handler
+      end
+      method_options.clear
+    end
+
+    def self.register_dsl_method(name, options = {})
+      return if self.method_options[name.to_s]
+      options[:args] ||= 0..-1
+      self.method_options[name.to_s] = options
+      handles method_call(name)
+    end
+
+    def process
+      options = self.class.method_options[caller_method]
+      return unless options
+      call_params[options[:args]].each do |method_name|
+        object = MethodObject.new(namespace, method_name, scope)
+        object.signature = "def #{method_name}"
+        register(object)
+      end
+    end
+  end
+end

data/lib/swagger_yard/model.rb

@@ -11,6 +11,11 @@ module SwaggerYard
       new.tap do |model|
         model.add_info(yard_object)
         model.parse_tags(yard_object.tags)
+        yard_object.children.each do |child|
+          next unless child.is_a?(YARD::CodeObjects::MethodObject)
+          prop = Property.from_method(child)
+          model.properties << prop if prop
+        end
       end
     end
 

data/lib/swagger_yard/property.rb

@@ -4,17 +4,56 @@ module SwaggerYard
   #
   class Property
     include Example
-    attr_reader :name, :description, :required, :type, :nullable
+    attr_reader :name, :required, :type, :nullable
+    attr_accessor :description
+
+    NAME_OPTIONS_REGEXP = /[\(\)]/
+
+    def self.tag_name(tag)
+      if tag.object.is_a?(YARD::CodeObjects::MethodObject)
+        tag.object.name.to_s
+      else
+        tag = SwaggerYard.requires_name(tag)
+        return nil unless tag
+        tag.name.split(NAME_OPTIONS_REGEXP).first
+      end
+    end
+
+    def self.from_method(yard_method)
+      return nil unless yard_method.explicit || yard_method.parameters.empty?
+      tags = (yard_method.tags ||[]).dup
+      prop_tag = tags.detect { |t| t.tag_name == 'property' }
+      return nil unless prop_tag
+      tags.reject { |t| t.tag_name == 'property' }
+      from_tag(prop_tag).tap do |prop|
+        ex = tags.detect { |t| t.tag_name == 'example' }
+        prop.example = ex.text.empty? ? ex.name : ex.text if ex
+        prop.description = yard_method.docstring unless prop.description
+      end
+    end
 
     def self.from_tag(tag)
-      tag = SwaggerYard.requires_name_and_type(tag)
+      tag = SwaggerYard.requires_type(tag)
       return nil unless tag
 
-      name, options_string = tag.name.split(/[\(\)]/)
+      name = tag_name(tag)
+      return nil unless name
+
+      text = tag.text
+
+      if (options_src = (tag.name || '')) =~ NAME_OPTIONS_REGEXP
+        _, options_string = options_src.split(NAME_OPTIONS_REGEXP)
+      elsif tag.name && tag.object.is_a?(YARD::CodeObjects::MethodObject)
+        if text
+          text = tag.name + ' ' + text
+        else
+          text = tag.name
+        end
+      end
 
       options = options_string.to_s.split(',').map(&:strip)
 
-      new(name, tag.types, tag.text, options)
+      new(name, tag.types, text, options)
     end
 
     def initialize(name, types, description, options)

data/lib/swagger_yard/version.rb

@@ -1,3 +1,3 @@
 module SwaggerYard
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

data/lib/swagger_yard.rb

@@ -14,6 +14,7 @@ require "swagger_yard/model"
 require "swagger_yard/path_item"
 require "swagger_yard/swagger"
 require "swagger_yard/openapi"
+require "swagger_yard/handlers"
 
 module SwaggerYard
   class Error < StandardError; end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: swagger_yard
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - chtrinh (Chris Trinh)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-28 00:00:00.000000000 Z
+date: 2018-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
@@ -194,6 +194,7 @@ files:
 - lib/swagger_yard/authorization.rb
 - lib/swagger_yard/configuration.rb
 - lib/swagger_yard/example.rb
+- lib/swagger_yard/handlers.rb
 - lib/swagger_yard/model.rb
 - lib/swagger_yard/openapi.rb
 - lib/swagger_yard/operation.rb