swagger_yard 0.4.4 → 1.0.0

data/lib/swagger_yard/type.rb

@@ -4,31 +4,39 @@ module SwaggerYard
       new(types.first)
     end
 
-    attr_reader :name, :source, :schema
+    # Default model location path
+    MODEL_PATH = '#/definitions/'.freeze
+
+    attr_reader :source
 
     def initialize(string)
       @source  = string
-      @schema  = TypeParser.new.json_schema(string)
-      @name    = name_for(@schema)
-      @name    = name_for(@schema['items']) if @name == 'array'
+      @name    = nil
     end
 
-    # TODO: have this look at resource listing?
-    def ref?
-      schema["$ref"]
+    def name
+      return @name if @name
+      @name = name_for(schema)
+      @name = name_for(schema['items']) if @name == 'array'
+      @name
     end
 
-    def model_name
-      ref? ? name : nil
+    def schema
+      @schema ||= TypeParser.new.json_schema(source)
     end
 
-    def to_h
-      schema
+    def schema_with(options = {})
+      model_path = options && options[:model_path] || MODEL_PATH
+      if model_path != MODEL_PATH
+        TypeParser.new(model_path).json_schema(source)
+      else
+        schema
+      end
     end
 
     private
     def name_for(schema)
-      schema["type"] || schema["$ref"][%r'#/definitions/(.*)', 1]
+      schema["type"] || schema["$ref"][%r'.*/([^/]*)$', 1]
     end
   end
 end

data/lib/swagger_yard/type.rb.~master~

@@ -0,0 +1,34 @@
+module SwaggerYard
+  class Type
+    def self.from_type_list(types)
+      new(types.first)
+    end
+
+    attr_reader :name, :source, :schema
+
+    def initialize(string)
+      @source  = string
+      @schema  = TypeParser.new.json_schema(string)
+      @name    = name_for(@schema)
+      @name    = name_for(@schema['items']) if @name == 'array'
+    end
+
+    # TODO: have this look at resource listing?
+    def ref?
+      schema["$ref"]
+    end
+
+    def model_name
+      ref? ? name : nil
+    end
+
+    def to_h
+      schema
+    end
+
+    private
+    def name_for(schema)
+      schema["type"] || schema["$ref"][%r'#/definitions/(.*)', 1]
+    end
+  end
+end

data/lib/swagger_yard/type_parser.rb

@@ -69,7 +69,7 @@ module SwaggerYard
         else
           name = Model.mangle(v)
           if /[[:upper:]]/.match(name)
-            { '$ref' => "#/definitions/#{name}" }
+            { '$ref' => "#{model_path}#{name}" }
           else
             { 'type' => name }
           end
@@ -81,7 +81,12 @@ module SwaggerYard
         unless url = SwaggerYard.config.external_schema[prefix]
           raise UndefinedSchemaError, "unknown prefix #{prefix} for #{name}"
         end
-        { '$ref' => "#{url}#/definitions/#{Model.mangle(name)}"}
+        uri = URI(url)
+        fragment = uri.fragment ? "##{uri.fragment}" : model_path
+        uri.fragment = nil
+        fragment += '/' unless fragment.end_with?('/')
+        url = uri.to_s
+        { '$ref' => "#{url}#{fragment}#{Model.mangle(name)}"}
       end
 
       rule(formatted: { name: simple(:name), format: simple(:format) }) do
@@ -122,9 +127,10 @@ module SwaggerYard
       end
     end
 
-    def initialize
+    def initialize(model_path = Type::MODEL_PATH)
       @parser = Parser.new
       @xform  = Transform.new
+      @model_path = model_path
     end
 
     def parse(str)
@@ -132,7 +138,7 @@ module SwaggerYard
     end
 
     def json_schema(str)
-      @xform.apply(parse(str))
+      @xform.apply(parse(str), model_path: @model_path)
     rescue Parslet::ParseFailed => e
       raise InvalidTypeError, "'#{str}': #{e.message}"
     end

data/lib/swagger_yard/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: swagger_yard
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 1.0.0
 platform: ruby
 authors:
 - chtrinh (Chris Trinh)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-25 00:00:00.000000000 Z
+date: 2018-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
@@ -190,17 +190,21 @@ files:
 - README.md
 - Rakefile
 - lib/swagger_yard.rb
-- lib/swagger_yard/api.rb
-- lib/swagger_yard/api_declaration.rb
+- lib/swagger_yard/api_group.rb
 - lib/swagger_yard/authorization.rb
 - lib/swagger_yard/configuration.rb
+- lib/swagger_yard/example.rb
 - lib/swagger_yard/model.rb
+- lib/swagger_yard/openapi.rb
 - lib/swagger_yard/operation.rb
+- lib/swagger_yard/operation.rb.~9b471577ebed4e4ba6ed266566355dbe5990787d~
 - lib/swagger_yard/parameter.rb
+- lib/swagger_yard/path_item.rb
 - lib/swagger_yard/property.rb
-- lib/swagger_yard/resource_listing.rb
+- lib/swagger_yard/specification.rb
 - lib/swagger_yard/swagger.rb
 - lib/swagger_yard/type.rb
+- lib/swagger_yard/type.rb.~master~
 - lib/swagger_yard/type_parser.rb
 - lib/swagger_yard/version.rb
 homepage: http://www.synctv.com

data/lib/swagger_yard/api.rb

@@ -1,39 +0,0 @@
-module SwaggerYard
-  class Api
-    attr_accessor :path, :operations, :api_declaration
-
-    def self.path_from_yard_object(yard_object)
-      if tag = yard_object.tags.detect {|t| t.tag_name == "path"}
-        tag.text
-      elsif fn = SwaggerYard.config.path_discovery_function
-        begin
-          method, path = fn[yard_object]
-          yard_object.add_tag YARD::Tags::Tag.new("path", path, [method]) if path
-          path
-        rescue => e
-          SwaggerYard.log.warn e.message
-          nil
-        end
-      end
-    end
-
-    def self.from_yard_object(yard_object, api_declaration)
-      path = path_from_yard_object(yard_object)
-      new(path, api_declaration)
-    end
-
-    def initialize(path, api_declaration)
-      @api_declaration = api_declaration
-      @path = path
-      @operations = []
-    end
-
-    def add_operation(yard_object)
-      @operations << Operation.from_yard_object(yard_object, self)
-    end
-
-    def operations_hash
-      Hash[@operations.map {|op| [op.http_method.downcase, op.to_h]}]
-    end
-  end
-end

data/lib/swagger_yard/api_declaration.rb

@@ -1,72 +0,0 @@
-module SwaggerYard
-  class ApiDeclaration
-    attr_accessor :description, :resource
-    attr_reader :apis, :authorizations, :class_name
-
-    def self.from_yard_object(yard_object)
-      new.add_yard_object(yard_object)
-    end
-
-    def initialize
-      @resource         = nil
-      @apis             = {}
-      @authorizations   = {}
-    end
-
-    def valid?
-      !@resource.nil?
-    end
-
-    def add_yard_object(yard_object)
-      case yard_object.type
-      when :class # controller
-        add_info(yard_object)
-        if valid?
-          yard_object.children.each do |child_object|
-            add_yard_object(child_object)
-          end
-        end
-      when :method # actions
-        add_api(yard_object)
-      end
-      self
-    end
-
-    def add_info(yard_object)
-      @description = yard_object.docstring
-      @class_name  = yard_object.path
-
-      if tag = yard_object.tags.detect {|t| t.tag_name == "resource"}
-        @resource = tag.text
-      end
-
-      if tag = yard_object.tags.detect {|t| t.tag_name == "resource_path"}
-        SwaggerYard.log.warn "DEPRECATED: @resource_path tag is obsolete."
-      end
-
-      # we only have api_key auth, the value for now is always empty array
-      @authorizations = Hash[yard_object.tags.
-                             select {|t| t.tag_name == "authorize_with"}.
-                             map(&:text).uniq.
-                             map {|k| [k, []]}]
-    end
-
-    def add_api(yard_object)
-      path = Api.path_from_yard_object(yard_object)
-
-      return if path.nil?
-
-      api = (apis[path] ||= Api.from_yard_object(yard_object, self))
-      api.add_operation(yard_object)
-    end
-
-    def apis_hash
-      Hash[apis.map {|path, api| [path, api.operations_hash]}]
-    end
-
-    def to_tag
-      { "name"        => resource,
-        "description" => description }
-    end
-  end
-end