yard-sorbet 0.2.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e83416e1d85da291aa4d0311df2e239f14fd072f38f3f2be4ee12a008f1a89dc
-  data.tar.gz: 3fcffa38addbaa3b47b200711462847b81bd9c52095aa1dfa46d2c077f497ef4
+  metadata.gz: ca3c823cd78ea11784724185ff336604d2e7b131082945c3fc19200d1b3294cf
+  data.tar.gz: 43b2a6a38cb3161d2452eaa823ac336cbb5dcb0782fb40d0b5ddbf12afe33467
 SHA512:
-  metadata.gz: 13f13c26aff10422e1fda98016fdfd1038d14a36d084653407b7797908206cde655f1504087b7ec164d6b72de2b9ded4d5f807c9c9af36d4a77e6c296828cd3d
-  data.tar.gz: 9bb8d82770501e206ac7f1bf6f6d836c0559383b9babd0e6416180e5508bed5bd7f55e317a5c86f30231ca7cdc08b30211b722645a558d4130c4f046a39471ec
+  metadata.gz: aff435511b0e40b212c3ffcfd8194cec04a70d9e05ce82865dbbf074376cc6da7d9503a71f395aafde9615c99f524051977d9c6b9aaac971ee1c8f378ab4aa5f
+  data.tar.gz: 746934d64c6bfd728551b43b380cf6efd3da0ccbb9224cbb29bbabe065d17821530e640c3a8377e5935a05d1f9527d51f36da995c21dd0c5821903b86482017f

data/lib/yard-sorbet.rb

@@ -4,12 +4,9 @@
 require 'sorbet-runtime'
 require 'yard'
 
-T::Configuration.default_checked_level = :tests
-
-# top-level namespace
-module YARDSorbet; end
+require_relative 'yard-sorbet/version'
 
 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'

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,102 @@
+# 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
+
+  # These node types attached to sigs represent attr_* declarations
+  ATTR_NODE_TYPES = T.let(%i[command fcall], T::Array[Symbol])
+  # 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, :ATTR_NODE_TYPES, :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)
+    unless ATTR_NODE_TYPES.include?(method_node.type)
+      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,18 +1,23 @@
 # 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
+class YARDSorbet::Handlers::StructHandler < YARD::Handlers::Ruby::Base
   extend T::Sig
 
-  handles method_call(:const)
+  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])
@@ -34,34 +39,39 @@ class YARDSorbet::StructHandler < YARD::Handlers::Ruby::Base
     object = MethodObject.new(namespace, name, scope)
     object.source = source
 
-    reader_docstring = doc.empty? ? "Returns the value of attribute +#{name}+." : doc
+    # TODO: this should use `+` to delimit the attribute name when markdown is disabled
+    reader_docstring = doc.empty? ? "Returns the value of attribute `#{name}`." : doc
     docstring = YARD::DocstringParser.new.parse(reader_docstring).to_docstring
     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
+#
+# @note this module is included in `YARD::Handlers::Ruby::ClassHandler`
+module YARDSorbet::Handlers::StructClassHandler
   extend T::Sig
 
   sig { void }
   def process
-    ret = super
+    super
 
-    return ret if T.unsafe(self).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(
-      T.unsafe(self).namespace, T.unsafe(self).statement[0].source.gsub(/\s/, '')
-    )
-    props = T.unsafe(self).extra_state.prop_docs[class_ns]
+    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.
@@ -88,14 +98,12 @@ module YARDSorbet::StructClassHandler
     object.source ||= props.map { |p| p[:source] }.join("\n")
     object.explicit ||= false # not strictly necessary
 
-    T.unsafe(self).register(object)
+    register(object)
 
     object.docstring = docstring.to_raw
 
     YARDSorbet::Directives.add_directives(object.docstring, directives)
-
-    ret
   end
 end
 
-YARD::Handlers::Ruby::ClassHandler.include YARDSorbet::StructClassHandler
+YARD::Handlers::Ruby::ClassHandler.include YARDSorbet::Handlers::StructClassHandler

data/lib/yard-sorbet/handlers/struct_handler.rbi

@@ -0,0 +1,5 @@
+# typed: strict
+# This is in an rbi so the runtime doesn't depend on experimental sorbet features
+module YARDSorbet::Handlers::StructClassHandler
+  requires_ancestor YARD::Handlers::Ruby::ClassHandler
+end

data/lib/yard-sorbet/node_utils.rb

@@ -0,0 +1,69 @@
+# 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
+
+  # Traverese AST nodes in breadth-first order
+  # @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,11 +1,13 @@
 # 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
   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]) }
@@ -16,81 +18,23 @@ module YARDSorbet::SigToYARD
   end
 
   sig { params(node: YARD::Parser::Ruby::AstNode).returns(T::Array[String]) }
-  def self.convert_type(node)
-    children = node.children
+  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]
@@ -98,14 +42,94 @@ module YARDSorbet::SigToYARD
   end
 
   sig { params(node: YARD::Parser::Ruby::AstNode).returns(String) }
-  def self.build_generic_type(node)
-    return node.source if node.children.empty? || node.type != :aref
+  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

@@ -1,6 +1,8 @@
 # typed: strong
 # frozen_string_literal: true
 
+# Types are documentation
 module YARDSorbet
-  VERSION = '0.2.0'
+  # {https://rubygems.org/gems/yard-sorbet Version history}
+  VERSION = '0.5.1'
 end

metadata

@@ -1,29 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: yard-sorbet
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Douglas Eichelberger
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-14 00:00:00.000000000 Z
+date: 2021-06-08 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
@@ -38,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -58,28 +86,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.0
+        version: 1.16.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.0
+        version: 1.16.0
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.9.2
+        version: 1.11.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.9.2
+        version: 1.11.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
@@ -100,56 +128,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: 2.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.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.21'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.21'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sorbet
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.6193
+        version: 0.5.6289
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.6193
+        version: 0.5.6289
 - !ruby/object:Gem::Dependency
   name: sorbet-runtime
   requirement: !ruby/object:Gem::Requirement
@@ -170,14 +198,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.16
+        version: 0.9.21
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.16
+        version: 0.9.21
 description: 'A YARD plugin that incorporates Sorbet type information
 
   '
@@ -189,17 +217,25 @@ files:
 - LICENSE
 - 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/handlers/struct_handler.rbi
+- lib/yard-sorbet/node_utils.rb
 - lib/yard-sorbet/sig_to_yard.rb
-- lib/yard-sorbet/struct_handler.rb
 - lib/yard-sorbet/version.rb
 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:
@@ -215,7 +251,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/lib/yard-sorbet/sig_handler.rb

@@ -1,184 +0,0 @@
-# typed: strict
-# 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?
-
-  PARAM_EXCLUDES = T.let(%i[array call hash].freeze, T::Array[Symbol])
-  PROCESSABLE_NODES = T.let(%i[def defs command].freeze, T::Array[Symbol])
-  SIG_EXCLUDES = T.let(%i[array hash].freeze, T::Array[Symbol])
-  SIG_NODE_TYPES = T.let(%i[call fcall vcall].freeze, T::Array[Symbol])
-  private_constant :PARAM_EXCLUDES, :PROCESSABLE_NODES, :SIG_EXCLUDES, :SIG_NODE_TYPES
-
-  sig { void }
-  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
-
-  sig { params(class_contents: T::Array[YARD::Parser::Ruby::MethodCallNode]).void }
-  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(T.must(next_statement), child)
-    end
-  end
-
-  sig { params(next_statement: T.nilable(YARD::Parser::Ruby::AstNode)).returns(T::Boolean) }
-  private def processable_method?(next_statement)
-    PROCESSABLE_NODES.include?(next_statement&.type)
-  end
-
-  sig do
-    params(
-      method_node: YARD::Parser::Ruby::AstNode,
-      sig_node: YARD::Parser::Ruby::MethodCallNode
-    ).void
-  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
-
-  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: T::Hash[Symbol, Object]).void }
-  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
-
-  sig do
-    params(sig_node: YARD::Parser::Ruby::MethodCallNode)
-      .returns(
-        {
-          abstract: T::Boolean,
-          params: T::Hash[String, T::Array[String]],
-          return: T.nilable(T::Array[String])
-        }
-      )
-  end
-  private def parse_sig(sig_node)
-    parsed = {
-      abstract: false,
-      params: {},
-      return: nil
-    }
-    found_params = T.let(false, T::Boolean)
-    found_return = T.let(false, T::Boolean)
-    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 = T.must(sibling_node(n))
-        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(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.
-  sig { params(node: T.nilable(YARD::Parser::Ruby::AstNode)).returns(T::Boolean) }
-  private def type_signature?(node)
-    loop do
-      return false if node.nil?
-      return false unless SIG_NODE_TYPES.include?(node.type)
-      return true if T.unsafe(node).method_name(true) == :sig
-
-      node = T.let(node.children.first, T.nilable(YARD::Parser::Ruby::AstNode))
-    end
-  end
-
-  sig { params(node: YARD::Parser::Ruby::AstNode).returns(T.nilable(YARD::Parser::Ruby::AstNode)) }
-  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]
-  sig do
-    params(
-      node: YARD::Parser::Ruby::AstNode,
-      exclude: T::Array[Symbol],
-      _blk: T.proc.params(n: YARD::Parser::Ruby::AstNode).void
-    ).void
-  end
-  private def bfs_traverse(node, exclude: [], &_blk)
-    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