yard-sorbet 0.3.0 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f5a40a71c985d760b358e1a066b2b30b73a244ec47c43546dcbb476135217b6c
-  data.tar.gz: 74d637f5b92f95234f3feaf2ef39050bcb4379c26a735961f4f04d7a29bd7697
+  metadata.gz: abed4a7ebc07752257feab235b53a7a0162c348b3dd614fed606aa9299840115
+  data.tar.gz: 8799257d6fa6a2f24689c3e737ed484fce741c0098c60648eed4e370273bb161
 SHA512:
-  metadata.gz: f92b7ec79d46db5b9abcb3ecb294576fe02874972deeb93f23023fbfebe0bc50c9160d7f11193f93598cb07191ab4a5b3045c27ea5d0bce509fdbef5d9e99a65
-  data.tar.gz: 66ea5ef884b6867b1f4b80a28f5b4ee8ee8c557995be314513c43eb0886fb7a0697c01b9723d3f6a76607dc2108ddbabe7c398b5ceaec16e3693707f0b10b911
+  metadata.gz: ff78cce014d6d8443ac4b00fd980c6f316e9f11b091e2a031fbe6ed2b9ffc5e68657500a4d952fa9eb7f649f914f102acc509960aa5d6c6cddbc449a86d18e66
+  data.tar.gz: 201e32a5fb1de713569b8476c8acaa4634853d11a8538cad9770d06c9bc0fe396b900b50626f883cbd6dfe8ee8846703e91c50a4bee7a3a191d70fac66737b9d

data/lib/yard-sorbet.rb

@@ -4,11 +4,11 @@
 require 'sorbet-runtime'
 require 'yard'
 
-# 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'
-require_relative 'yard-sorbet/version'
+require_relative 'yard-sorbet/t_struct_prop'
+require_relative 'yard-sorbet/tag_utils'

data/lib/yard-sorbet/directives.rb

@@ -1,28 +1,30 @@
 # typed: strict
 # frozen_string_literal: true
 
-# Extract & re-add directives to a docstring
-module YARDSorbet::Directives
-  extend T::Sig
+module YARDSorbet
+  # Extract & re-add directives to a docstring
+  module 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
-    # seem to be an API to tweeze them from one node to another without
-    # managing YARD internal state. Instead, we just extract them from
-    # the raw text and re-attach them.
-    directives = parser.raw_text&.split("\n")&.select do |line|
-      line.start_with?('@!')
-    end || []
+    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
+      # seem to be an API to tweeze them from one node to another without
+      # managing YARD internal state. Instead, we just extract them from
+      # the raw text and re-attach them.
+      directives = parser.raw_text&.split("\n")&.select do |line|
+        line.start_with?('@!')
+      end || []
 
-    [parser.to_docstring, directives]
-  end
+      [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}")
+    sig { params(docstring: String, directives: T::Array[String]).void }
+    def self.add_directives(docstring, directives)
+      directives.each do |directive|
+        docstring.concat("\n#{directive}")
+      end
     end
   end
 end

data/lib/yard-sorbet/handlers.rb

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

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

@@ -0,0 +1,30 @@
+# typed: strict
+# frozen_string_literal: true
+
+module YARDSorbet
+  module Handlers
+    # Apllies an `@abstract` tag to `abstract!`/`interface!` modules (if not alerady present).
+    class 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
+  end
+end

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

@@ -0,0 +1,34 @@
+# typed: strict
+# frozen_string_literal: true
+
+module YARDSorbet
+  module Handlers
+    # Handle `enums` calls, registering enum values as constants
+    class 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
+
+      private
+
+      sig { params(node: YARD::Parser::Ruby::AstNode).returns(T::Boolean) }
+      def const_assign_node?(node)
+        node.type == :assign && node[0][0].type == :const
+      end
+    end
+  end
+end

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

@@ -0,0 +1,70 @@
+# typed: strict
+# frozen_string_literal: true
+
+module YARDSorbet
+  module Handlers
+    # A YARD Handler for Sorbet type declarations
+    class SigHandler < YARD::Handlers::Ruby::Base
+      extend T::Sig
+
+      handles method_call(:sig)
+      namespace_only
+
+      # These node types attached to sigs represent attr_* declarations
+      ATTR_NODE_TYPES = T.let(%i[command fcall], T::Array[Symbol])
+      private_constant :ATTR_NODE_TYPES
+
+      # 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 = NodeUtils.get_method_node(NodeUtils.sibling_node(statement))
+        docstring, directives = Directives.extract_directives(statement.docstring)
+        parse_sig(method_node, docstring)
+        method_node.docstring = docstring.to_raw
+        Directives.add_directives(method_node.docstring, directives)
+        statement.docstring = nil
+      end
+
+      private
+
+      sig { params(method_node: YARD::Parser::Ruby::AstNode, docstring: YARD::Docstring).void }
+      def parse_sig(method_node, docstring)
+        NodeUtils.bfs_traverse(statement) do |n|
+          case n.source
+          when 'abstract'
+            YARDSorbet::TagUtils.upsert_tag(docstring, 'abstract')
+          when 'params'
+            parse_params(method_node, n, docstring)
+          when 'returns', 'void'
+            parse_return(n, docstring)
+          end
+        end
+      end
+
+      sig do
+        params(
+          method_node: YARD::Parser::Ruby::AstNode,
+          node: YARD::Parser::Ruby::AstNode,
+          docstring: YARD::Docstring
+        ).void
+      end
+      def parse_params(method_node, node, docstring)
+        return if ATTR_NODE_TYPES.include?(method_node.type)
+
+        sibling = NodeUtils.sibling_node(node)
+        sibling[0][0].each do |p|
+          param_name = p[0][0]
+          types = SigToYARD.convert(p.last)
+          TagUtils.upsert_tag(docstring, 'param', types, param_name)
+        end
+      end
+
+      sig { params(node: YARD::Parser::Ruby::AstNode, docstring: YARD::Docstring).void }
+      def parse_return(node, docstring)
+        type = node.source == 'void' ? ['void'] : SigToYARD.convert(NodeUtils.sibling_node(node))
+        TagUtils.upsert_tag(docstring, 'return', type)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,72 @@
+# typed: strict
+# frozen_string_literal: true
+
+module YARDSorbet
+  module Handlers
+    # 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
+    #
+    # @note this module is included in `YARD::Handlers::Ruby::ClassHandler`
+    module StructClassHandler
+      extend T::Sig
+
+      sig { void }
+      def process
+        super
+        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 if props.empty?
+
+        process_t_struct_props(props, class_ns)
+      end
+
+      private
+
+      # Create a virtual `initialize` method with all the `prop`/`const` arguments
+      sig { params(props: T::Array[TStructProp], class_ns: YARD::CodeObjects::ClassObject).void }
+      def process_t_struct_props(props, class_ns)
+        # having the name :initialize & the scope :instance marks this as the constructor.
+        object = YARD::CodeObjects::MethodObject.new(class_ns, :initialize, :instance)
+        # There is a chance that there is a custom initializer, so make sure we steal the existing docstring
+        # and source
+        docstring, directives = Directives.extract_directives(object.docstring)
+        props.each do |prop|
+          docstring.add_tag(YARD::Tags::Tag.new(:param, prop.doc, prop.types, prop.prop_name))
+        end
+        docstring.add_tag(YARD::Tags::Tag.new(:return, '', class_ns))
+        decorate_t_struct_init(object, props, docstring, directives)
+        register(object)
+      end
+
+      sig do
+        params(
+          object: YARD::CodeObjects::MethodObject,
+          props: T::Array[TStructProp],
+          docstring: YARD::Docstring,
+          directives: T::Array[String]
+        ).void
+      end
+      def decorate_t_struct_init(object, props, docstring, directives)
+        # Use kwarg style arguments, with optionals being marked with a default (unless an actual default was specified)
+        object.parameters = to_object_parameters(props)
+        # The "source" of our constructor is the field declarations
+        object.source ||= props.map(&:source).join("\n")
+        object.docstring = docstring.to_raw
+        Directives.add_directives(object.docstring, directives)
+      end
+
+      sig { params(props: T::Array[TStructProp]).returns(T::Array[[String, T.nilable(String)]]) }
+      def to_object_parameters(props)
+        props.map do |prop|
+          default = prop.default || (prop.types.include?('nil') ? 'nil' : nil)
+          ["#{prop.prop_name}:", default]
+        end
+      end
+    end
+  end
+end
+
+YARD::Handlers::Ruby::ClassHandler.include YARDSorbet::Handlers::StructClassHandler

data/lib/yard-sorbet/handlers/struct_class_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/handlers/struct_prop_handler.rb

@@ -0,0 +1,72 @@
+# typed: strict
+# frozen_string_literal: true
+
+module YARDSorbet
+  module Handlers
+    # Handles all `const`/`prop` calls, creating accessor methods, and compiles them for later usage at the class level
+    # in creating a constructor
+    class StructPropHandler < YARD::Handlers::Ruby::Base
+      extend T::Sig
+
+      handles method_call(:const), method_call(:prop)
+      namespace_only
+
+      sig { void }
+      def process
+        name = statement.parameters.first.last.last.source
+        prop = make_prop(name)
+        update_state(prop)
+        object = YARD::CodeObjects::MethodObject.new(namespace, name, scope)
+        decorate_object(object, prop)
+        register_attrs(object, name)
+      end
+
+      private
+
+      # Add the source and docstring to the method object
+      sig { params(object: YARD::CodeObjects::MethodObject, prop: TStructProp).void }
+      def decorate_object(object, prop)
+        object.source = prop.source
+        # TODO: this should use `+` to delimit the attribute name when markdown is disabled
+        reader_docstring = prop.doc.empty? ? "Returns the value of attribute `#{prop.prop_name}`." : prop.doc
+        docstring = YARD::DocstringParser.new.parse(reader_docstring).to_docstring
+        docstring.add_tag(YARD::Tags::Tag.new(:return, '', prop.types))
+        object.docstring = docstring.to_raw
+      end
+
+      # Get the default prop value
+      sig { returns(T.nilable(String)) }
+      def default_value
+        default_node = statement.traverse { |n| break n if n.type == :label && n.source == 'default:' }
+        default_node.parent[1].source if default_node
+      end
+
+      sig { params(name: String).returns(TStructProp) }
+      def make_prop(name)
+        TStructProp.new(
+          default: default_value,
+          doc: statement.docstring.to_s,
+          prop_name: name,
+          source: statement.source,
+          types: SigToYARD.convert(statement.parameters[1])
+        )
+      end
+
+      # Register the field explicitly as an attribute.
+      # While `const` attributes are immutable, `prop` attributes may be reassigned.
+      sig { params(object: YARD::CodeObjects::MethodObject, name: String).void }
+      def register_attrs(object, name)
+        # Create the virtual method in our current scope
+        write = statement.method_name(true) == :prop ? object : nil
+        namespace.attributes[scope][name] ||= SymbolHash[read: object, write: write]
+      end
+
+      # Store the prop for use in the constructor definition
+      sig { params(prop: TStructProp).void }
+      def update_state(prop)
+        extra_state.prop_docs ||= Hash.new { |h, k| h[k] = [] }
+        extra_state.prop_docs[namespace] << prop
+      end
+    end
+  end
+end

data/lib/yard-sorbet/node_utils.rb

@@ -0,0 +1,62 @@
+# typed: strict
+# frozen_string_literal: true
+
+module YARDSorbet
+  # Helper methods for working with `YARD` AST Nodes
+  module 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
+    # Skip these method contents during BFS node traversal, they can have their own nested types via `T.Proc`
+    SKIP_METHOD_CONTENTS = T.let(%i[params returns], T::Array[Symbol])
+
+    private_constant :ATTRIBUTE_METHODS, :SIGABLE_NODE
+
+    # Traverese AST nodes in breadth-first order
+    # @note This will skip over some node types.
+    # @yield [YARD::Parser::Ruby::AstNode]
+    sig do
+      params(
+        node: YARD::Parser::Ruby::AstNode,
+        _blk: T.proc.params(n: YARD::Parser::Ruby::AstNode).void
+      ).void
+    end
+    def self.bfs_traverse(node, &_blk)
+      queue = [node]
+      until queue.empty?
+        n = T.must(queue.shift)
+        yield n
+        n.children.each { |c| queue.push(c) }
+        queue.pop if n.is_a?(YARD::Parser::Ruby::MethodCallNode) && SKIP_METHOD_CONTENTS.include?(n.method_name(true))
+      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|
+        return siblings.fetch(i + 1) if sibling.equal?(node)
+      end
+    end
+  end
+end

data/lib/yard-sorbet/sig_to_yard.rb

@@ -1,111 +1,130 @@
 # typed: strict
 # frozen_string_literal: true
 
-# Translate sig type syntax to YARD type syntax.
-module YARDSorbet::SigToYARD
-  extend T::Sig
-
-  IS_LEGACY_RUBY_VERSION = T.let(RUBY_VERSION.start_with?('2.5.'), T::Boolean)
-
-  # @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
+module YARDSorbet
+  # Translate `sig` type syntax to `YARD` type syntax.
+  module SigToYARD
+    extend T::Sig
+
+    # @see https://yardoc.org/types.html
+    sig { params(node: YARD::Parser::Ruby::AstNode).returns(T::Array[String]) }
+    def self.convert(node)
+      # scrub newlines, as they break the YARD parser
+      convert_node(node).map { |type| type.gsub(/\n\s*/, ' ') }
+    end
+
+    sig { params(node: YARD::Parser::Ruby::AstNode).returns(T::Array[String]) }
+    private_class_method def self.convert_node(node)
+      case node
+      when YARD::Parser::Ruby::MethodCallNode then convert_call(node)
+      when YARD::Parser::Ruby::ReferenceNode then convert_ref(node)
+      else convert_node_type(node)
+      end
+    end
+
+    sig { params(node: YARD::Parser::Ruby::AstNode).returns(T::Array[String]) }
+    private_class_method def self.convert_node_type(node)
+      case node.type
+      when :aref then convert_aref(node)
+      when :arg_paren then convert_node(node.first)
+      when :array then convert_array(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 currently unsupported.
+      when :hash then ['Hash']
+      # seen when sig methods omit parentheses
+      when :list then convert_list(node)
+      else convert_unknown(node)
+      end
+    end
+
+    sig { params(node: YARD::Parser::Ruby::AstNode).returns(String) }
+    private_class_method def self.build_generic_type(node)
+      return node.source if node.empty? || node.type != :aref
+
+      collection_type = node.first.source
+      member_type = node.last.children.map { |child| build_generic_type(child) }.join(', ')
 
-  sig { params(node: YARD::Parser::Ruby::AstNode).returns(T::Array[String]) }
-  def self.convert_type(node)
-    children = node.children
-    case node.type
-    when :aref
+      "#{collection_type}[#{member_type}]"
+    end
+
+    sig { params(node: YARD::Parser::Ruby::AstNode).returns(T::Array[String]) }
+    private_class_method def self.convert_aref(node)
       # 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}}"]
+      case node.first.source
+      when 'T::Array', 'T::Enumerable', 'T::Range', 'T::Set' then convert_collection(node)
+      when 'T::Hash' then convert_hash(node)
       else
         log.info("Unsupported sig aref node #{node.source}")
         [build_generic_type(node)]
       end
-    when :arg_paren
-      convert(children.first.children.first)
-    when :array
+    end
+
+    sig { params(node: YARD::Parser::Ruby::AstNode).returns(T::Array[String]) }
+    private_class_method def self.convert_array(node)
       # 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
+      member_types = node.first.children.map { |n| convert_node(n) }
+      sequence = member_types.map { |mt| mt.size == 1 ? mt[0] : mt.to_s.tr('"', '') }.join(', ')
+      ["Array(#{sequence})"]
+    end
+
+    sig { params(node: YARD::Parser::Ruby::MethodCallNode).returns(T::Array[String]) }
+    private_class_method def self.convert_call(node)
+      node.namespace.source == 'T' ? convert_t_method(node) : [node.source]
+    end
+
+    sig { params(node: YARD::Parser::Ruby::AstNode).returns(T::Array[String]) }
+    private_class_method def self.convert_collection(node)
+      collection_type = node.first.source.split('::').last
+      member_type = convert_node(node.last.first).join(', ')
+      ["#{collection_type}<#{member_type}>"]
+    end
+
+    sig { params(node: YARD::Parser::Ruby::AstNode).returns(T::Array[String]) }
+    private_class_method def self.convert_hash(node)
+      kv = node.last.children
+      key_type = convert_node(kv.first).join(', ')
+      value_type = convert_node(kv.last).join(', ')
+      ["Hash{#{key_type} => #{value_type}}"]
+    end
+
+    sig { params(node: YARD::Parser::Ruby::AstNode).returns(T::Array[String]) }
+    private_class_method def self.convert_list(node)
+      node.children.size == 1 ? convert_node(node.children.first) : [node.source]
+    end
+
+    sig { params(node: YARD::Parser::Ruby::AstNode).returns(T::Array[String]) }
+    private_class_method def self.convert_ref(node)
+      source = node.source
+      case source
+      when 'T::Boolean' then ['Boolean'] # YARD convention for booleans
       # 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]
+      when 'FalseClass' then ['false']
+      when 'NilClass' then ['nil']
+      when 'TrueClass' then ['true']
+      else [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)
-    else
-      log.warn("Unsupported sig #{node.type} node #{node.source}")
-      [node.source]
     end
-  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
 
-    collection_type = node.children.first.source
-    member_type = node.children.last.children
-                      .map { |child| build_generic_type(child) }
-                      .join(', ')
+    sig { params(node: YARD::Parser::Ruby::MethodCallNode).returns(T::Array[String]) }
+    private_class_method def self.convert_t_method(node)
+      case node.method_name(true)
+      when :any then node.last.first.children.map { |n| convert_node(n) }.flatten
+      # Order matters here, putting `nil` last results in a more concise
+      # return syntax in the UI (superscripted `?`)
+      # https://github.com/lsegal/yard/blob/cfa62ae/lib/yard/templates/helpers/html_helper.rb#L499-L500
+      when :nilable then convert_node(node.last) + ['nil']
+      else [node.source]
+      end
+    end
 
-    "#{collection_type}[#{member_type}]"
+    sig { params(node: YARD::Parser::Ruby::AstNode).returns(T::Array[String]) }
+    private_class_method def self.convert_unknown(node)
+      log.warn("Unsupported sig #{node.type} node #{node.source}")
+      [node.source]
+    end
   end
 end

data/lib/yard-sorbet/t_struct_prop.rb

@@ -0,0 +1,13 @@
+# typed: strict
+# frozen_string_literal: true
+
+module YARDSorbet
+  # Used to store the details of a `T::Struct` `prop` definition
+  class TStructProp < T::Struct
+    const :default, T.nilable(String)
+    const :doc, String
+    const :prop_name, String
+    const :source, String
+    const :types, T::Array[String]
+  end
+end

data/lib/yard-sorbet/tag_utils.rb

@@ -0,0 +1,41 @@
+# typed: strict
+# frozen_string_literal: true
+
+module YARDSorbet
+  # Helper methods for working with `YARD` tags
+  module TagUtils
+    extend T::Sig
+
+    # Create or update a `YARD` tag with type information
+    sig do
+      params(
+        docstring: YARD::Docstring,
+        tag_name: String,
+        types: T.nilable(T::Array[String]),
+        name: T.nilable(String)
+      ).void
+    end
+    def self.upsert_tag(docstring, tag_name, types = nil, name = nil)
+      tag = find_tag(docstring, tag_name, name)
+      if tag
+        return unless types
+
+        # Updating a tag in place doesn't seem to work, so we'll delete it, add the types, and re-add it
+        docstring.delete_tag_if { |t| t == tag }
+        # overwrite any existing type annotation (sigs should win)
+        tag.types = types
+      else
+        tag = YARD::Tags::Tag.new(tag_name, '', types, name)
+      end
+      docstring.add_tag(tag)
+    end
+
+    sig do
+      params(docstring: YARD::Docstring, tag_name: String, name: T.nilable(String))
+        .returns(T.nilable(YARD::Tags::Tag))
+    end
+    private_class_method def self.find_tag(docstring, tag_name, name)
+      docstring.tags.find { |t| t.tag_name == tag_name && t.name == name }
+    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.3.0'
+  # {https://rubygems.org/gems/yard-sorbet Version history}
+  VERSION = '0.5.2'
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: yard-sorbet
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.2
 platform: ruby
 authors:
 - Douglas Eichelberger
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-11 00:00:00.000000000 Z
+date: 2021-07-01 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
@@ -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,70 +86,70 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.11.0
+        version: 1.18.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.11.0
+        version: 1.18.0
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.10.0
+        version: 1.11.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.10.0
+        version: 1.11.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rake
   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: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: 2.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: 2.4.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
@@ -142,42 +170,42 @@ dependencies:
     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
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.5845
+        version: '0.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.5845
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.16
+        version: '0.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.16
+        version: '0.9'
 description: 'A YARD plugin that incorporates Sorbet type information
 
   '
@@ -189,17 +217,28 @@ 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_class_handler.rb
+- lib/yard-sorbet/handlers/struct_class_handler.rbi
+- lib/yard-sorbet/handlers/struct_prop_handler.rb
+- lib/yard-sorbet/node_utils.rb
 - lib/yard-sorbet/sig_to_yard.rb
-- lib/yard-sorbet/struct_handler.rb
+- lib/yard-sorbet/t_struct_prop.rb
+- lib/yard-sorbet/tag_utils.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/main/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 +254,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Create YARD docs from Sorbet type signatures

data/lib/yard-sorbet/sig_handler.rb

@@ -1,180 +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?
-
-  # 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
-
-  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 :ParsedSig, :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: ParsedSig).void }
-  private def enhance_tag(docstring, type, parsed_sig)
-    type_value = parsed_sig.public_send(type)
-    return if !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)
-    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

data/lib/yard-sorbet/struct_handler.rb

@@ -1,101 +0,0 @@
-# typed: strict
-# frozen_string_literal: true
-
-# Handle all `const` 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
-  extend T::Sig
-
-  handles method_call(:const)
-  namespace_only
-
-  sig { void }
-  def process
-    # Store the property for use in the constructor definition
-    name = statement.parameters[0].jump(:ident).source
-    doc = statement.docstring.to_s
-    source = statement.source
-    types = YARDSorbet::SigToYARD.convert(statement.parameters[1])
-    default_node = statement.traverse { |n| break n if n.source == 'default:' && n.type == :label }
-    default = default_node.parent[1].source if default_node
-
-    extra_state.prop_docs ||= Hash.new { |h, k| h[k] = [] }
-    extra_state.prop_docs[namespace] << {
-      doc: doc,
-      prop_name: name,
-      types: types,
-      source: source,
-      default: default
-    }
-
-    # Create the virtual method in our current scope
-    namespace.attributes[scope][name] ||= SymbolHash[read: nil, write: nil]
-
-    object = MethodObject.new(namespace, name, scope)
-    object.source = source
-
-    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
-    namespace.attributes[scope][name][:read] = object
-  end
-end
-
-# Class-level handler that folds all `const` 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::Sig
-
-  sig { void }
-  def process
-    ret = super
-
-    return ret if T.unsafe(self).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]
-
-    return ret 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.
-    # There is a chance that there is a custom initializer, so make sure we steal the existing docstring
-    # and source
-    object = YARD::CodeObjects::MethodObject.new(class_ns, :initialize, :instance)
-
-    docstring, directives = YARDSorbet::Directives.extract_directives(object.docstring || '')
-
-    # Annotate the parameters of the constructor with the prop docs
-    props.each do |prop|
-      docstring.add_tag(YARD::Tags::Tag.new(:param, prop[:doc], prop[:types], prop[:prop_name]))
-    end
-
-    docstring.add_tag(YARD::Tags::Tag.new(:return, '', class_ns))
-
-    # Use kwarg style arguments, with optionals being marked with a default (unless an actual default was specified)
-    object.parameters = props.map do |prop|
-      default = prop[:default] || (prop[:types].include?('nil') ? 'nil' : nil)
-      ["#{prop[:prop_name]}:", default]
-    end
-
-    # The "source" of our constructor is compromised with the props/consts
-    object.source ||= props.map { |p| p[:source] }.join("\n")
-    object.explicit ||= false # not strictly necessary
-
-    T.unsafe(self).register(object)
-
-    object.docstring = docstring.to_raw
-
-    YARDSorbet::Directives.add_directives(object.docstring, directives)
-
-    ret
-  end
-end
-
-YARD::Handlers::Ruby::ClassHandler.include YARDSorbet::StructClassHandler