yard-sorbet 0.1.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 47fca84744393f88777d1cb1355df3ffb693e4b5edb982a5497903da1c86daf7
-  data.tar.gz: 6cd24b1d8796de8def62dcbc02383b8de27aa60a32a00b82c9d974332e1f8e36
+  metadata.gz: 360c73bcd93390b21ebf0206cce339822368fca005d03fa3d08a4444a3cab367
+  data.tar.gz: 7b03b59846235fd395bca99868561eaa299b7dbe21eea7c91307c602236baec9
 SHA512:
-  metadata.gz: d666a9079c7190e905c1c190b014037d3bf4b0bd4fa75aa74b9c2221878f82cc88b6523b5ac14af5de981e1b157452341a196145bcc28f8ebc567fae3f10eee8
-  data.tar.gz: 7635542b9b48b775050ec0e417a23fc0700326bd733ba46293592c156a9c49cb7dc2a1800e3909c1c5ae10aacb15e03142dda44e589a8a5e9fc706388da1827c
+  metadata.gz: 364ee6ff02687a3a4e2ffd3384c2eb68a848afe60ad0e94c8d675df81ae9a820e805ed07ce1537cee59eb3e979ce2488a1a2210aa19cc1b40365b9dc97368864
+  data.tar.gz: f26eb01fcad908815f27afc9a42ad72050625e5279e3b3b7576991aa1b14ba685148c12d74bbc2cdba19e69b1f416f48fa89253d34a5635259794d088ad7415f

data/lib/yard-sorbet.rb

@@ -8,6 +8,7 @@ require 'yard'
 module YARDSorbet; end
 
 require_relative 'yard-sorbet/directives'
-require_relative 'yard-sorbet/sig_handler'
+require_relative 'yard-sorbet/handlers'
+require_relative 'yard-sorbet/node_utils'
 require_relative 'yard-sorbet/sig_to_yard'
-require_relative 'yard-sorbet/struct_handler'
+require_relative 'yard-sorbet/version'

data/lib/yard-sorbet/directives.rb

@@ -1,8 +1,11 @@
-# typed: true
+# typed: strict
 # frozen_string_literal: true
 
 # Extract & re-add directives to a docstring
 module YARDSorbet::Directives
+  extend T::Sig
+
+  sig { params(docstring: T.nilable(String)).returns([YARD::Docstring, T::Array[String]]) }
   def self.extract_directives(docstring)
     parser = YARD::DocstringParser.new.parse(docstring)
     # Directives are already parsed at this point, and there doesn't
@@ -16,6 +19,7 @@ module YARDSorbet::Directives
     [parser.to_docstring, directives]
   end
 
+  sig { params(docstring: String, directives: T::Array[String]).void }
   def self.add_directives(docstring, directives)
     directives.each do |directive|
       docstring.concat("\n#{directive}")

data/lib/yard-sorbet/handlers.rb

@@ -0,0 +1,11 @@
+# typed: strong
+# frozen_string_literal: true
+
+# Custom YARD Handlers
+# @see https://rubydoc.info/gems/yard/YARD/Handlers/Base YARD Base Handler documentation
+module YARDSorbet::Handlers; end
+
+require_relative 'handlers/abstract_dsl_handler'
+require_relative 'handlers/enums_handler'
+require_relative 'handlers/sig_handler'
+require_relative 'handlers/struct_handler'

data/lib/yard-sorbet/handlers/abstract_dsl_handler.rb

@@ -0,0 +1,26 @@
+# typed: strict
+# frozen_string_literal: true
+
+# Apllies an +@abstract+ tag to +abstract!+/+interface!+ modules (if not alerady present).
+class YARDSorbet::Handlers::AbstractDSLHandler < YARD::Handlers::Ruby::Base
+  extend T::Sig
+
+  handles method_call(:abstract!), method_call(:interface!)
+  namespace_only
+
+  # The text accompanying the `@abstract` tag.
+  # @see https://github.com/lsegal/yard/blob/main/templates/default/docstring/html/abstract.erb
+  #   The `@abstract` tag template
+  TAG_TEXT = 'Subclasses must implement the `abstract` methods below.'
+  # Extra text for class namespaces
+  CLASS_TAG_TEXT = T.let("It cannont be directly instantiated. #{TAG_TEXT}", String)
+
+  sig { void }
+  def process
+    return if namespace.has_tag?(:abstract)
+
+    text = namespace.is_a?(YARD::CodeObjects::ClassObject) ? CLASS_TAG_TEXT : TAG_TEXT
+    tag = YARD::Tags::Tag.new(:abstract, text)
+    namespace.add_tag(tag)
+  end
+end

data/lib/yard-sorbet/handlers/enums_handler.rb

@@ -0,0 +1,28 @@
+# typed: strict
+# frozen_string_literal: true
+
+# Handle +enums+ calls, registering enum values as constants
+class YARDSorbet::Handlers::EnumsHandler < YARD::Handlers::Ruby::Base
+  extend T::Sig
+
+  handles method_call(:enums)
+  namespace_only
+
+  sig { void }
+  def process
+    statement.traverse do |node|
+      if const_assign_node?(node)
+        register YARD::CodeObjects::ConstantObject.new(namespace, node.first.source) do |obj|
+          obj.docstring = node.docstring
+          obj.source = node
+          obj.value = node.last.source
+        end
+      end
+    end
+  end
+
+  sig { params(node: YARD::Parser::Ruby::AstNode).returns(T::Boolean) }
+  private def const_assign_node?(node)
+    node.type == :assign && node.children.first.children.first.type == :const
+  end
+end

data/lib/yard-sorbet/handlers/sig_handler.rb

@@ -0,0 +1,100 @@
+# typed: strict
+# frozen_string_literal: true
+
+# A YARD Handler for Sorbet type declarations
+class YARDSorbet::Handlers::SigHandler < YARD::Handlers::Ruby::Base
+  extend T::Sig
+
+  handles method_call(:sig)
+  namespace_only
+
+  # A struct that holds the parsed contents of a Sorbet type signature
+  class ParsedSig < T::Struct
+    prop :abstract, T::Boolean, default: false
+    prop :params, T::Hash[String, T::Array[String]], default: {}
+    prop :return, T.nilable(T::Array[String])
+  end
+
+  # Skip these node types when parsing `sig` params
+  PARAM_EXCLUDES = T.let(%i[array call hash].freeze, T::Array[Symbol])
+  # Skip these node types when parsing `sig`s
+  SIG_EXCLUDES = T.let(%i[array hash].freeze, T::Array[Symbol])
+
+  private_constant :ParsedSig, :PARAM_EXCLUDES, :SIG_EXCLUDES
+
+  # Swap the method definition docstring and the sig docstring.
+  # Parse relevant parts of the +sig+ and include them as well.
+  sig { void }
+  def process
+    method_node = YARDSorbet::NodeUtils.get_method_node(YARDSorbet::NodeUtils.sibling_node(statement))
+    docstring, directives = YARDSorbet::Directives.extract_directives(statement.docstring)
+    parsed_sig = parse_sig(statement)
+    enhance_tag(docstring, :abstract, parsed_sig)
+    enhance_tag(docstring, :return, parsed_sig)
+    if method_node.type != :command
+      parsed_sig.params.each do |name, types|
+        enhance_param(docstring, name, types)
+      end
+    end
+    method_node.docstring = docstring.to_raw
+    YARDSorbet::Directives.add_directives(method_node.docstring, directives)
+    statement.docstring = nil
+  end
+
+  sig { params(docstring: YARD::Docstring, name: String, types: T::Array[String]).void }
+  private def enhance_param(docstring, name, types)
+    tag = docstring.tags.find { |t| t.tag_name == 'param' && t.name == name }
+    if tag
+      docstring.delete_tag_if { |t| t == tag }
+      tag.types = types
+    else
+      tag = YARD::Tags::Tag.new(:param, '', types, name)
+    end
+    docstring.add_tag(tag)
+  end
+
+  sig { params(docstring: YARD::Docstring, type: Symbol, parsed_sig: ParsedSig).void }
+  private def enhance_tag(docstring, type, parsed_sig)
+    type_value = parsed_sig.public_send(type)
+    return unless type_value
+
+    tag = docstring.tags.find { |t| t.tag_name == type.to_s }
+    if tag
+      docstring.delete_tags(type)
+    else
+      tag = YARD::Tags::Tag.new(type, '')
+    end
+    if type_value.is_a?(Array)
+      tag.types = type_value
+    end
+    docstring.add_tag(tag)
+  end
+
+  sig { params(sig_node: YARD::Parser::Ruby::MethodCallNode).returns(ParsedSig) }
+  private def parse_sig(sig_node)
+    parsed = ParsedSig.new
+    found_params = T.let(false, T::Boolean)
+    found_return = T.let(false, T::Boolean)
+    YARDSorbet::NodeUtils.bfs_traverse(sig_node, exclude: SIG_EXCLUDES) do |n|
+      if n.source == 'abstract'
+        parsed.abstract = true
+      elsif n.source == 'params' && !found_params
+        found_params = true
+        sibling = YARDSorbet::NodeUtils.sibling_node(n)
+        YARDSorbet::NodeUtils.bfs_traverse(sibling, exclude: PARAM_EXCLUDES) do |p|
+          if p.type == :assoc
+            param_name = p.children.first.source[0...-1]
+            types = YARDSorbet::SigToYARD.convert(p.children.last)
+            parsed.params[param_name] = types
+          end
+        end
+      elsif n.source == 'returns' && !found_return
+        found_return = true
+        parsed.return = YARDSorbet::SigToYARD.convert(YARDSorbet::NodeUtils.sibling_node(n))
+      elsif n.source == 'void'
+        parsed.return ||= ['void']
+      end
+    end
+    parsed
+  end
+end

data/lib/yard-sorbet/{struct_handler.rb → handlers/struct_handler.rb}

@@ -1,15 +1,23 @@
-# typed: false
+# typed: strict
 # frozen_string_literal: true
 
-# Handle all `const` calls, creating accessor methods, and compiles them for later usage at the class level
+# Handles all +const+/+prop+ calls, creating accessor methods, and compiles them for later usage at the class level
 # in creating a constructor
-class YARDSorbet::StructHandler < YARD::Handlers::Ruby::Base
-  handles method_call(:const)
+class YARDSorbet::Handlers::StructHandler < YARD::Handlers::Ruby::Base
+  extend T::Sig
+
+  handles method_call(:const), method_call(:prop)
   namespace_only
 
+  sig { void }
   def process
     # Store the property for use in the constructor definition
-    name = statement.parameters[0].jump(:ident).source
+    name = statement.parameters[0].jump(
+      :ident, # handles most "normal" identifiers
+      :kw,    # handles prop names using reserved words like `end` or `def`
+      :const  # handles capitalized prop names like Foo
+    ).source
+
     doc = statement.docstring.to_s
     source = statement.source
     types = YARDSorbet::SigToYARD.convert(statement.parameters[1])
@@ -36,24 +44,34 @@ class YARDSorbet::StructHandler < YARD::Handlers::Ruby::Base
     docstring.add_tag(YARD::Tags::Tag.new(:return, '', types))
     object.docstring = docstring.to_raw
 
-    # Register the object explicitly as an attribute
+    # Register the object explicitly as an attribute.
+    # While `const` attributes are immutable, `prop` attributes may be reassigned.
+    if statement.method_name.source == 'prop'
+      namespace.attributes[scope][name][:write] = object
+    end
     namespace.attributes[scope][name][:read] = object
   end
 end
 
-# Class-level handler that folds all `const` declarations into the constructor documentation
+# Class-level handler that folds all +const+ and +prop+ declarations into the constructor documentation
 # this needs to be injected as a module otherwise the default Class handler will overwrite documentation
 module YARDSorbet::StructClassHandler
+  extend T::Helpers
+  extend T::Sig
+
+  requires_ancestor YARD::Handlers::Ruby::ClassHandler
+
+  sig { void }
   def process
-    ret = super
+    super
 
-    return ret if extra_state.prop_docs.nil?
+    return if extra_state.prop_docs.nil?
 
     # lookup the full YARD path for the current class
     class_ns = YARD::CodeObjects::ClassObject.new(namespace, statement[0].source.gsub(/\s/, ''))
     props = extra_state.prop_docs[class_ns]
 
-    return ret if props.empty?
+    return if props.empty?
 
     # Create a virtual `initialize` method with all the `prop`/`const` arguments
     # having the name :initialize & the scope :instance marks this as the constructor.
@@ -85,8 +103,6 @@ module YARDSorbet::StructClassHandler
     object.docstring = docstring.to_raw
 
     YARDSorbet::Directives.add_directives(object.docstring, directives)
-
-    ret
   end
 end
 

data/lib/yard-sorbet/node_utils.rb

@@ -0,0 +1,68 @@
+# typed: strict
+# frozen_string_literal: true
+
+# Helper methods for working with YARD AST Nodes
+module YARDSorbet::NodeUtils
+  extend T::Sig
+
+  # Command node types that can have type signatures
+  ATTRIBUTE_METHODS = T.let(%i[attr attr_accessor attr_reader attr_writer].freeze, T::Array[Symbol])
+  # Node types that can have type signatures
+  SIGABLE_NODE = T.type_alias do
+    T.any(YARD::Parser::Ruby::MethodDefinitionNode, YARD::Parser::Ruby::MethodCallNode)
+  end
+
+  private_constant :ATTRIBUTE_METHODS, :SIGABLE_NODE
+
+  # @yield [YARD::Parser::Ruby::AstNode]
+  sig do
+    params(
+      node: YARD::Parser::Ruby::AstNode,
+      exclude: T::Array[Symbol],
+      _blk: T.proc.params(n: YARD::Parser::Ruby::AstNode).void
+    ).void
+  end
+  def self.bfs_traverse(node, exclude: [], &_blk)
+    queue = [node]
+    until queue.empty?
+      n = T.must(queue.shift)
+      yield n
+      n.children.each do |c|
+        unless exclude.include?(c.type)
+          queue.push(c)
+        end
+      end
+    end
+  end
+
+  # Gets the node that a sorbet `sig` can be attached do, bypassing visisbility modifiers and the like
+  sig { params(node: YARD::Parser::Ruby::AstNode).returns(SIGABLE_NODE) }
+  def self.get_method_node(node)
+    case node
+    when YARD::Parser::Ruby::MethodDefinitionNode
+      return node
+    when YARD::Parser::Ruby::MethodCallNode
+      return node if ATTRIBUTE_METHODS.include?(node.method_name(true))
+    end
+
+    node.jump(:def, :defs)
+  end
+
+  # Find and return the adjacent node (ascending)
+  # @raise [IndexError] if the node does not have an adjacent sibling (ascending)
+  sig { params(node: YARD::Parser::Ruby::AstNode).returns(YARD::Parser::Ruby::AstNode) }
+  def self.sibling_node(node)
+    siblings = node.parent.children
+    siblings.each_with_index.find do |sibling, i|
+      if sibling.equal?(node)
+        return siblings.fetch(i + 1)
+      end
+    end
+  end
+
+  # Returns true if the given node represents a type signature.
+  sig { params(node: YARD::Parser::Ruby::AstNode).returns(T::Boolean) }
+  def self.type_signature?(node)
+    node.is_a?(YARD::Parser::Ruby::MethodCallNode) && node.method_name(true) == :sig
+  end
+end

data/lib/yard-sorbet/sig_to_yard.rb

@@ -1,106 +1,135 @@
-# typed: true
+# typed: strict
 # frozen_string_literal: true
 
-# Translate sig type syntax to YARD type syntax.
+# Translate +sig+ type syntax to +YARD+ type syntax.
 module YARDSorbet::SigToYARD
-  IS_LEGACY_RUBY_VERSION = RUBY_VERSION.match?(/\A2\.[45]\./)
+  extend T::Sig
+
+  # Ruby 2.5 parsed call nodes slightly differently
+  IS_LEGACY_RUBY_VERSION = T.let(RUBY_VERSION.start_with?('2.5.'), T::Boolean)
+  private_constant :IS_LEGACY_RUBY_VERSION
 
   # @see https://yardoc.org/types.html
+  sig { params(node: YARD::Parser::Ruby::AstNode).returns(T::Array[String]) }
   def self.convert(node)
     types = convert_type(node)
     # scrub newlines, as they break the YARD parser
     types.map { |type| type.gsub(/\n\s*/, ' ') }
   end
 
-  def self.convert_type(node)
-    children = node.children
+  sig { params(node: YARD::Parser::Ruby::AstNode).returns(T::Array[String]) }
+  private_class_method def self.convert_type(node)
     case node.type
-    when :aref
-      # https://www.rubydoc.info/gems/yard/file/docs/Tags.md#Parametrized_Types
-      case children.first.source
-      when 'T::Array', 'T::Enumerable', 'T::Range', 'T::Set'
-        collection_type = children.first.source.split('::').last
-        member_type = convert(children.last.children.first).join(', ')
-        ["#{collection_type}<#{member_type}>"]
-      when 'T::Hash'
-        key_type = convert(children.last.children.first).join(', ')
-        value_type = convert(children.last.children.last).join(', ')
-        ["Hash{#{key_type} => #{value_type}}"]
-      else
-        log.info("Unsupported sig aref node #{node.source}")
-        [build_generic_type(node)]
-      end
-    when :arg_paren
-      convert(children.first.children.first)
-    when :array
-      # https://www.rubydoc.info/gems/yard/file/docs/Tags.md#Order-Dependent_Lists
-      member_types = children.first.children.map { |n| convert(n) }.join(', ')
-      ["Array(#{member_types})"]
-    when :call
-      if children[0].source == 'T'
-        t_method = IS_LEGACY_RUBY_VERSION ? children[1].source : children[2].source
-        case t_method
-        when 'all', 'attached_class', 'class_of', 'enum', 'noreturn', 'self_type', 'type_parameter', 'untyped'
-          # YARD doesn't have equivalent notions, so we just use the raw source
-          [node.source]
-        when 'any'
-          children.last.children.first.children.map { |n| convert(n) }.flatten
-        when 'nilable'
-          # Order matters here, putting `nil` last results in a more concise
-          # return syntax in the UI (superscripted `?`)
-          convert(children.last) + ['nil']
-        else
-          log.warn("Unsupported T method #{node.source}")
-          [node.source]
-        end
-      else
-        [node.source]
-      end
-    when :const_path_ref, :const
-      case node.source
-      when 'T::Boolean'
-        ['Boolean'] # YARD convention for booleans
-      else
-        [node.source]
-      end
-    when :hash, :list
-      # Fixed hashes as return values are unsupported:
-      # https://github.com/lsegal/yard/issues/425
-      #
-      # Hash key params can be individually documented with `@option`, but
-      # sig translation is unsupported.
-      ['Hash']
-    when :var_ref
-      # YARD convention is use singleton objects when applicable:
-      # https://www.rubydoc.info/gems/yard/file/docs/Tags.md#Literals
-      case node.source
-      when 'FalseClass'
-        ['false']
-      when 'NilClass'
-        ['nil']
-      when 'TrueClass'
-        ['true']
-      else
-        [node.source]
-      end
-    when :top_const_ref
-      # A top-level constant reference, such as ::Klass
-      # It contains a child node of type :const
-      convert(children.first)
+    when :aref then handle_aref(node)
+    when :arg_paren then handle_arg_paren(node)
+    when :array then handle_array(node)
+    when :call then handle_call(node)
+    when :const_path_ref, :const then handle_const(node)
+    # Fixed hashes as return values are unsupported:
+    # https://github.com/lsegal/yard/issues/425
+    #
+    # Hash key params can be individually documented with `@option`, but
+    # sig translation is unsupported.
+    when :hash, :list then ['Hash']
+    when :var_ref then handle_var_ref(node)
+    # A top-level constant reference, such as ::Klass
+    # It contains a child node of type :const
+    when :top_const_ref then convert(node.children.first)
     else
       log.warn("Unsupported sig #{node.type} node #{node.source}")
       [node.source]
     end
   end
 
-  def self.build_generic_type(node)
-    return node.source if node.children.empty? || node.type != :aref
+  sig { params(node: YARD::Parser::Ruby::AstNode).returns(String) }
+  private_class_method def self.build_generic_type(node)
+    children = node.children
+    return node.source if children.empty? || node.type != :aref
 
-    collection_type = node.children.first.source
-    member_type = node.children.last.children
-                      .map { |child| build_generic_type(child) }
-                      .join(', ')
+    collection_type = children.first.source
+    member_type = children.last.children.map { |child| build_generic_type(child) }.join(', ')
 
     "#{collection_type}[#{member_type}]"
   end
+
+  sig { params(node: YARD::Parser::Ruby::AstNode).returns(T::Array[String]) }
+  private_class_method def self.handle_aref(node)
+    children = node.children
+    # https://www.rubydoc.info/gems/yard/file/docs/Tags.md#Parametrized_Types
+    case children.first.source
+    when 'T::Array', 'T::Enumerable', 'T::Range', 'T::Set'
+      collection_type = children.first.source.split('::').last
+      member_type = convert(children.last.children.first).join(', ')
+      ["#{collection_type}<#{member_type}>"]
+    when 'T::Hash'
+      kv = children.last.children
+      key_type = convert(kv.first).join(', ')
+      value_type = convert(kv.last).join(', ')
+      ["Hash{#{key_type} => #{value_type}}"]
+    else
+      log.info("Unsupported sig aref node #{node.source}")
+      [build_generic_type(node)]
+    end
+  end
+
+  sig { params(node: YARD::Parser::Ruby::AstNode).returns(T::Array[String]) }
+  private_class_method def self.handle_arg_paren(node)
+    convert(node.children.first.children.first)
+  end
+
+  sig { params(node: YARD::Parser::Ruby::AstNode).returns(T::Array[String]) }
+  private_class_method def self.handle_array(node)
+    # https://www.rubydoc.info/gems/yard/file/docs/Tags.md#Order-Dependent_Lists
+    member_types = node.children.first.children.map { |n| convert(n) }.join(', ')
+    ["Array(#{member_types})"]
+  end
+
+  sig { params(node: YARD::Parser::Ruby::AstNode).returns(T::Array[String]) }
+  private_class_method def self.handle_const(node)
+    source = node.source
+    case source
+    # YARD convention for booleans
+    when 'T::Boolean' then ['Boolean']
+    else [source]
+    end
+  end
+
+  sig { params(node: YARD::Parser::Ruby::AstNode).returns(T::Array[String]) }
+  private_class_method def self.handle_call(node)
+    children = node.children
+    if children[0].source == 'T'
+      t_method = IS_LEGACY_RUBY_VERSION ? children[1].source : children[2].source
+      handle_t_method(t_method, node)
+    else
+      [node.source]
+    end
+  end
+
+  sig { params(method_name: String, node: YARD::Parser::Ruby::AstNode).returns(T::Array[String]) }
+  private_class_method def self.handle_t_method(method_name, node)
+    case method_name
+    # YARD doesn't have equivalent notions, so we just use the raw source
+    when 'all', 'attached_class', 'class_of', 'enum', 'noreturn', 'self_type', 'type_parameter', 'untyped'
+      [node.source]
+    when 'any' then node.children.last.children.first.children.map { |n| convert(n) }.flatten
+    # Order matters here, putting `nil` last results in a more concise
+    # return syntax in the UI (superscripted `?`)
+    when 'nilable' then convert(node.children.last) + ['nil']
+    else
+      log.warn("Unsupported T method #{node.source}")
+      [node.source]
+    end
+  end
+
+  sig { params(node: YARD::Parser::Ruby::AstNode).returns(T::Array[String]) }
+  private_class_method def self.handle_var_ref(node)
+    # YARD convention is use singleton objects when applicable:
+    # https://www.rubydoc.info/gems/yard/file/docs/Tags.md#Literals
+    case node.source
+    when 'FalseClass' then ['false']
+    when 'NilClass' then ['nil']
+    when 'TrueClass' then ['true']
+    else [node.source]
+    end
+  end
 end

data/lib/yard-sorbet/version.rb

@@ -2,5 +2,6 @@
 # frozen_string_literal: true
 
 module YARDSorbet
-  VERSION = '0.1.0'
+  # {https://rubygems.org/gems/yard-sorbet Version history}
+  VERSION = '0.5.0'
 end

metadata

@@ -1,29 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: yard-sorbet
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Douglas Eichelberger
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-01 00:00:00.000000000 Z
+date: 2021-05-28 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler-audit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: codecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.12
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.12
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +72,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: 1.15.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.15.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.11.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: 1.11.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
@@ -86,84 +114,84 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 2.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 2.3.0
 - !ruby/object:Gem::Dependency
   name: rubocop-sorbet
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.1
+        version: 0.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.1
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.20.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.20.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sorbet
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.6083
+        version: 0.5.6289
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.6083
+        version: 0.5.6289
 - !ruby/object:Gem::Dependency
   name: sorbet-runtime
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: 0.5.6289
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: 0.5.6289
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: 0.9.21
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: 0.9.21
 description: 'A YARD plugin that incorporates Sorbet type information
 
   '
@@ -172,31 +200,27 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".editorconfig"
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
-- ".travis.yml"
-- ".yardopts"
-- CHANGELOG.md
-- Gemfile
 - LICENSE
-- README.md
-- Rakefile
 - lib/yard-sorbet.rb
 - lib/yard-sorbet/directives.rb
-- lib/yard-sorbet/sig_handler.rb
+- lib/yard-sorbet/handlers.rb
+- lib/yard-sorbet/handlers/abstract_dsl_handler.rb
+- lib/yard-sorbet/handlers/enums_handler.rb
+- lib/yard-sorbet/handlers/sig_handler.rb
+- lib/yard-sorbet/handlers/struct_handler.rb
+- lib/yard-sorbet/node_utils.rb
 - lib/yard-sorbet/sig_to_yard.rb
-- lib/yard-sorbet/struct_handler.rb
 - lib/yard-sorbet/version.rb
-- yard-sorbet.gemspec
 homepage: https://github.com/dduugg/yard-sorbet
 licenses:
 - Apache-2.0
 metadata:
+  bug_tracker_uri: https://github.com/dduugg/yard-sorbet/issues
+  changelog_uri: https://github.com/dduugg/yard-sorbet/blob/master/CHANGELOG.md
+  documentation_uri: https://dduugg.github.io/yard-sorbet/
   homepage_uri: https://github.com/dduugg/yard-sorbet
   source_code_uri: https://github.com/dduugg/yard-sorbet
-  changelog_uri: https://github.com/dduugg/yard-sorbet/blob/master/CHANGELOG.md
+  wiki_uri: https://github.com/dduugg/yard-sorbet/wiki
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -212,7 +236,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: Create YARD docs from Sorbet type signatures

data/.editorconfig

@@ -1,9 +0,0 @@
-root = true
-
-[*]
-indent_style = space
-indent_size = 2
-end_of_line = lf
-charset = utf-8
-trim_trailing_whitespace = true
-insert_final_newline = true

data/.gitignore

@@ -1,40 +0,0 @@
-*.gem
-*.rbc
-/.config
-/coverage/
-/InstalledFiles
-/pkg/
-/spec/reports/
-/spec/examples.txt
-/test/tmp/
-/test/version_tmp/
-/tmp/
-
-# Used by dotenv library to load environment variables.
-# .env
-
-# Ignore Byebug command history file.
-.byebug_history
-
-## Documentation cache and generated files:
-/.yardoc/
-/_yardoc/
-/doc/
-/rdoc/
-
-## Environment normalization:
-/.bundle/
-/vendor/bundle
-/lib/bundler/man/
-
-# for a library or gem, you might want to ignore these files since the code is
-# intended to run in multiple environments; otherwise, check them in:
-Gemfile.lock
-.ruby-version
-.ruby-gemset
-
-# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
-.rvmrc
-
-# Used by RuboCop. Remote config files pulled in from inherit_from directive.
-# .rubocop-https?--*

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper

data/.rubocop.yml

@@ -1,62 +0,0 @@
----
-require:
-  - rubocop-rake
-  - rubocop-rspec
-  - rubocop-sorbet
-
-AllCops:
-  NewCops: enable
-  TargetRubyVersion: 2.5
-
-Layout/ClassStructure:
-  Enabled: true
-# doesn't recognize sorbet magic comments
-Layout/EmptyLineAfterMagicComment:
-  Enabled: false
-Layout/LineLength:
-  Enabled: false
-Metrics/AbcSize:
-  Enabled: false
-Metrics/BlockLength:
-  Enabled: false
-Metrics/BlockNesting:
-  Enabled: false
-Metrics/ClassLength:
-  Enabled: false
-Metrics/CyclomaticComplexity:
-  Enabled: false
-Metrics/MethodLength:
-  Enabled: false
-Metrics/PerceivedComplexity:
-  Enabled: false
-Naming/FileName:
-  Exclude:
-    - lib/yard-sorbet.rb
-RSpec/EmptyExampleGroup:
-  Enabled: false
-RSpec/ExampleLength:
-  Enabled: false
-RSpec/MultipleExpectations:
-  Enabled: false
-Sorbet/EnforceSignatures:
-  Enabled: false
-Sorbet/StrictSigil:
-  Enabled: false
-Sorbet/StrongSigil:
-  Enabled: false
-Sorbet/TrueSigil:
-  Exclude:
-    - lib/yard-sorbet/struct_handler.rb
-    - spec/**/*
-Style/AccessModifierDeclarations:
-  EnforcedStyle: inline
-Style/ClassAndModuleChildren:
-  EnforcedStyle: compact
-Style/NegatedIf:
-  Enabled: false
-Style/NegatedWhile:
-  Enabled: false
-Style/Next:
-  Enabled: false
-Style/IfUnlessModifier:
-  Enabled: false

data/.travis.yml

@@ -1,8 +0,0 @@
----
-language: ruby
-cache: bundler
-rvm:
-  - 2.5
-  - 2.6
-  - 2.7
-before_install: gem install bundler -v 2.1.4

data/.yardopts

@@ -1,2 +0,0 @@
---plugin sorbet
-

data/CHANGELOG.md

@@ -1,30 +0,0 @@
-# Change log
-
-## master (unreleased)
-
-## 0.1.0 (2020-12-01)
-
-### New features
-
-* [#8](https://github.com/dduugg/yard-sorbet/pull/8): Add support for singleton class syntax.
-* [#7](https://github.com/dduugg/yard-sorbet/pull/7): Add support for top-level constants in sigs.
-
-### Bug fixes
-
-* [#9](https://github.com/dduugg/yard-sorbet/pull/9): Remove warning for use of `T.attached_class`.
-* [#11](https://github.com/dduugg/yard-sorbet/pull/11): Fix parsing of custom parameterized types.
-* [#12](https://github.com/dduugg/yard-sorbet/pull/12): Fix parsing of recursive custom parameterized types.
-
-### Changes
-
-* [#10](https://github.com/dduugg/yard-sorbet/pull/10): Downgrade log level of unsupported `sig` `aref` nodes.
-* Drop Ruby 2.4 support
-
-## 0.0.1 (2020-01-24)
-
-* [#1](https://github.com/dduugg/yard-sorbet/pull/1): Add `T::Struct` support.
-* [#3](https://github.com/dduugg/yard-sorbet/pull/3): Rename require path to be conistent with gem name.
-
-## 0.0.0 (2020-01-05)
-
-* Initial Release

data/Gemfile

@@ -1,8 +0,0 @@
-# typed: strong
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-
-gemspec
-
-gem 'pry-byebug'

data/README.md

@@ -1,17 +0,0 @@
-# yard-sorbet
-[![Gem Version](https://badge.fury.io/rb/yard-sorbet.svg)](https://badge.fury.io/rb/yard-sorbet)
-[![Build Status](https://travis-ci.com/dduugg/yard-sorbet.svg?branch=master)](https://travis-ci.com/dduugg/yard-sorbet)
-[![codecov](https://codecov.io/gh/dduugg/yard-sorbet/branch/master/graph/badge.svg)](https://codecov.io/gh/dduugg/yard-sorbet)
-
-A YARD [plugin](https://rubydoc.info/gems/yard/file/docs/GettingStarted.md#Plugin_Support) that parses Sorbet type annotations
-
-## Install
-
-```shell
-gem install yard-sorbet
-```
-
-## Usage
-```bash
-yard doc --plugin sorbet
-```

data/Rakefile

@@ -1,19 +0,0 @@
-# typed: strong
-# frozen_string_literal: true
-
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-
-RSpec::Core::RakeTask.new(:spec)
-
-desc 'Lint files with Rubocop'
-task :lint do
-  sh 'rubocop'
-end
-
-desc 'Typecheck files with Sorbet'
-task :typecheck do
-  sh 'srb tc --ignore=vendor/'
-end
-
-task default: %i[lint spec typecheck]

data/lib/yard-sorbet/sig_handler.rb

@@ -1,147 +0,0 @@
-# typed: true
-# frozen_string_literal: true
-
-# A YARD Handler for Sorbet type declarations
-class YARDSorbet::SigHandler < YARD::Handlers::Ruby::Base
-  extend T::Sig
-  handles :class, :module, :singleton_class?
-
-  sig { returns(String).checked(:never) }
-  def process
-    # Find the list of declarations inside the class
-    class_def = statement.children.find { |c| c.type == :list }
-    class_contents = class_def.children
-
-    process_class_contents(class_contents)
-  end
-
-  private def process_class_contents(class_contents)
-    class_contents.each_with_index do |child, i|
-      if child.type == :sclass && child.children.size == 2 && child.children[1].type == :list
-        singleton_class_contents = child.children[1]
-        process_class_contents(singleton_class_contents)
-      end
-      next unless type_signature?(child)
-
-      next_statement = class_contents[i + 1]
-      next unless processable_method?(next_statement)
-
-      process_method_definition(next_statement, child)
-    end
-  end
-
-  private def processable_method?(next_statement)
-    %i[def defs command].include?(next_statement&.type) && !next_statement.docstring
-  end
-
-  private def process_method_definition(method_node, sig_node)
-    # Swap the method definition docstring and the sig docstring.
-    # Parse relevant parts of the `sig` and include them as well.
-    docstring, directives = YARDSorbet::Directives.extract_directives(sig_node.docstring)
-    parsed_sig = parse_sig(sig_node)
-    enhance_tag(docstring, :abstract, parsed_sig)
-    enhance_tag(docstring, :return, parsed_sig)
-    if method_node.type != :command
-      parsed_sig[:params]&.each do |name, types|
-        enhance_param(docstring, name, types)
-      end
-    end
-    method_node.docstring = docstring.to_raw
-    YARDSorbet::Directives.add_directives(method_node.docstring, directives)
-    sig_node.docstring = nil
-  end
-
-  private def enhance_param(docstring, name, types)
-    tag = docstring.tags.find { |t| t.tag_name == 'param' && t.name == name }
-    if tag
-      docstring.delete_tag_if { |t| t == tag }
-      tag.types = types
-    else
-      tag = YARD::Tags::Tag.new(:param, '', types, name)
-    end
-    docstring.add_tag(tag)
-  end
-
-  private def enhance_tag(docstring, type, parsed_sig)
-    return if !parsed_sig[type]
-
-    tag = docstring.tags.find { |t| t.tag_name == type.to_s }
-    if tag
-      docstring.delete_tags(type)
-    else
-      tag = YARD::Tags::Tag.new(type, '')
-    end
-    if parsed_sig[type].is_a?(Array)
-      tag.types = parsed_sig[type]
-    end
-    docstring.add_tag(tag)
-  end
-
-  private def parse_sig(sig_node)
-    parsed = {}
-    parsed[:abstract] = false
-    parsed[:params] = {}
-    found_params = T.let(false, T::Boolean)
-    found_return = T.let(false, T::Boolean)
-    bfs_traverse(sig_node, exclude: %i[array hash]) do |n|
-      if n.source == 'abstract'
-        parsed[:abstract] = true
-      elsif n.source == 'params' && !found_params
-        found_params = true
-        sibling = T.must(sibling_node(n))
-        bfs_traverse(sibling, exclude: %i[array call hash]) do |p|
-          if p.type == :assoc
-            param_name = p.children.first.source[0...-1]
-            types = YARDSorbet::SigToYARD.convert(p.children.last)
-            parsed[:params][param_name] = types
-          end
-        end
-      elsif n.source == 'returns' && !found_return
-        found_return = true
-        parsed[:return] = YARDSorbet::SigToYARD.convert(T.must(sibling_node(n)))
-      elsif n.source == 'void'
-        parsed[:return] ||= ['void']
-      end
-    end
-    parsed
-  end
-
-  # Returns true if the given node is part of a type signature.
-  private def type_signature?(node)
-    loop do
-      return false if node.nil?
-      return false unless %i[call vcall fcall].include?(node.type)
-      return true if T.unsafe(node).method_name(true) == :sig
-
-      node = node.children.first
-    end
-  end
-
-  private def sibling_node(node)
-    found_sibling = T.let(false, T::Boolean)
-    node.parent.children.each do |n|
-      if found_sibling
-        return n
-      end
-
-      if n == node
-        found_sibling = true
-      end
-    end
-    nil
-  end
-
-  # @yield [YARD::Parser::Ruby::AstNode]
-  private def bfs_traverse(node, exclude: [])
-    queue = [node]
-    while !queue.empty?
-      n = T.must(queue.shift)
-      yield n
-      n.children.each do |c|
-        if !exclude.include?(c.type)
-          queue.push(c)
-        end
-      end
-    end
-  end
-end

data/yard-sorbet.gemspec

@@ -1,39 +0,0 @@
-# typed: strong
-# frozen_string_literal: true
-
-require_relative 'lib/yard-sorbet/version'
-
-Gem::Specification.new do |spec|
-  spec.name = 'yard-sorbet'
-  spec.version = YARDSorbet::VERSION
-  spec.author = 'Douglas Eichelberger'
-  spec.email = 'dduugg@gmail.com'
-  spec.license = 'Apache-2.0'
-
-  spec.summary = 'Create YARD docs from Sorbet type signatures'
-  spec.description = <<~DESC
-    A YARD plugin that incorporates Sorbet type information
-  DESC
-  spec.homepage = 'https://github.com/dduugg/yard-sorbet'
-  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
-
-  spec.metadata['homepage_uri'] = spec.homepage
-  spec.metadata['source_code_uri'] = spec.homepage
-  spec.metadata['changelog_uri'] = 'https://github.com/dduugg/yard-sorbet/blob/master/CHANGELOG.md'
-
-  spec.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(sorbet|spec)/}) }
-  end
-
-  spec.add_development_dependency 'codecov', '~> 0.2.12'
-  spec.add_development_dependency 'rake', '~> 13.0'
-  spec.add_development_dependency 'rspec', '~> 3.10'
-  spec.add_development_dependency 'rubocop', '~> 1.5.0'
-  spec.add_development_dependency 'rubocop-rake', '~> 0.5.1'
-  spec.add_development_dependency 'rubocop-rspec', '~> 2.0.0'
-  spec.add_development_dependency 'rubocop-sorbet', '~> 0.5.1'
-  spec.add_development_dependency 'simplecov', '~> 0.20.0'
-  spec.add_development_dependency 'sorbet', '~> 0.5.6083'
-  spec.add_runtime_dependency 'sorbet-runtime', '>= 0.5'
-  spec.add_runtime_dependency 'yard', '>= 0.9'
-end