yard-sorbet 0.0.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '01297d9a9e47af3e48b7aef782f9ffd60fe41476567ef1e7e986ae38a1b24880'
-  data.tar.gz: e612bbdc440d264051f58c95c744a48753d31b6ec6ea94dec928101c9612c54b
+  metadata.gz: 24bbf6faf77f9a54ad0c74bacef4828729c182352464734bb587ef6f1a035e9a
+  data.tar.gz: c68e0b16d0f7cd81f1f03dac293aa7fd7f87504c134c1de34c3cf2e2600ff6d2
 SHA512:
-  metadata.gz: 391fb61ef58440411978c3508666fa7accd43d5987b0f80f91506bb01991aef4e1801b40c428cb2fc7bad8e1ae55dd4a13ac7a02d90a603e007aee8f306a8c86
-  data.tar.gz: 5b4749046bc5d4da734d81924de6f46de540aa2d750ad1d53e3c50723da36241aa905d75e0e888d34c3322ee15f0df8f7ea2565ef8ab249010b4d2b6b0583a24
+  metadata.gz: 65bbdc49da863973cd60926c8b898a789d4b740009453a698dfa0531eaa742805d81e72eb95e1411625a6ecf25029c85b6dc863bcf67928035aeacaa4766fb55
+  data.tar.gz: 4aba39bc2d129e99910d421f47fa01fb9178078da6bb1ba5b1e8da3c847e39b96927342e5c774db1ec71a46475a2eeed0ae12be4eb729bb278bfbf2fcd79e720

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/lib/yard-sorbet.rb

@@ -0,0 +1,14 @@
+# typed: strong
+# frozen_string_literal: true
+
+require 'sorbet-runtime'
+require 'yard'
+
+# top-level namespace
+module YARDSorbet; end
+
+require_relative 'yard-sorbet/directives'
+require_relative 'yard-sorbet/sig_handler'
+require_relative 'yard-sorbet/sig_to_yard'
+require_relative 'yard-sorbet/struct_handler'
+require_relative 'yard-sorbet/version'

data/lib/yard-sorbet/directives.rb

@@ -0,0 +1,28 @@
+# 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
+    # 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
+
+  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

data/lib/yard-sorbet/sig_handler.rb

@@ -0,0 +1,180 @@
+# 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/sig_to_yard.rb

@@ -0,0 +1,111 @@
+# 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
+
+  sig { params(node: YARD::Parser::Ruby::AstNode).returns(T::Array[String]) }
+  def self.convert_type(node)
+    children = node.children
+    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)
+    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(', ')
+
+    "#{collection_type}[#{member_type}]"
+  end
+end

data/lib/yard-sorbet/struct_handler.rb

@@ -0,0 +1,105 @@
+# typed: strict
+# frozen_string_literal: true
+
+# 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
+  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
+    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.
+    # 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` 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::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

data/lib/yard-sorbet/version.rb

@@ -0,0 +1,6 @@
+# typed: strong
+# frozen_string_literal: true
+
+module YARDSorbet
+  VERSION = '0.4.0'
+end

metadata

@@ -1,43 +1,183 @@
 --- !ruby/object:Gem::Specification
 name: yard-sorbet
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Douglas Eichelberger
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-01-05 00:00:00.000000000 Z
+date: 2021-04-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: codecov
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.78.0
+        version: 1.12.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.78.0
+        version: 1.12.0
 - !ruby/object:Gem::Dependency
-  name: yard
+  name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
-  type: :runtime
+        version: 1.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.10.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-sorbet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: sorbet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.6193
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: 0.5.6193
+- !ruby/object:Gem::Dependency
+  name: sorbet-runtime
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.5845
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.5845
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.16
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.16
 description: 'A YARD plugin that incorporates Sorbet type information
 
   '
@@ -45,12 +185,22 @@ email: dduugg@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- LICENSE
+- lib/yard-sorbet.rb
+- lib/yard-sorbet/directives.rb
+- lib/yard-sorbet/sig_handler.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: {}
-post_install_message: 
+metadata:
+  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
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -58,15 +208,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Create YARD docs from Sorbet type signatures
 test_files: []