yard-sorbet 0.5.3 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ee5168e45f37fe7d16db534727b57fad2a08e05acda8298ef421589aa72f0354
-  data.tar.gz: ce10ba6df63c35ba4b52eb4f7d8b02878cfb01fea7424e966aad739691d1d767
+  metadata.gz: 50408c1c7ce4b8fe04219273c326e3ac432fe8eaee9c02fe7ba243c204202ff3
+  data.tar.gz: e01aabf41806def071f4807d5b4bd45e49c82cdb24360b9e3b9920361505b690
 SHA512:
-  metadata.gz: faa0b506388d501f6567ddfd08144185b1e761a1d4d4cfec12e3256f3985f626ddbc2da1423b37896fbe132a1e729a3c44b995b957eb0391aa48ded9519978d4
-  data.tar.gz: 2afbc9875afecab271abccfd12b5023c3e7db429f23f689fdbed18ed2e0fd7f3b51137ee86b649bb501ea921c469774e2096887d1d063599ae72939951b2f719
+  metadata.gz: fa3a9a39d00923dd39824b553900dc12d30cebb3f3770580bbf6400272f52c1bd55905211de9372d7e1bd80ff26d3d2ddaa0c56c437c9a65bb41c24d53e60b08
+  data.tar.gz: e322305cd757bb65135a90e9f9bf166161a98756449110714a4ce6dc7f47657cc539d72175c303114e67de7ac5c750c8216c31d8a1d8c818dacdeb5b404cbe1f

data/lib/yard-sorbet/directives.rb

@@ -13,18 +13,13 @@ module YARDSorbet
       # 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 || []
-
+      directives = parser.raw_text&.split("\n")&.select { _1.start_with?('@!') } || []
       [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
+      directives.each { docstring.concat("\n#{_1}") }
     end
   end
 end

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

@@ -15,7 +15,7 @@ module YARDSorbet
       #   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)
+      CLASS_TAG_TEXT = T.let("It cannot be directly instantiated. #{TAG_TEXT}", String)
 
       sig { void }
       def process

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

@@ -0,0 +1,35 @@
+# typed: strict
+# frozen_string_literal: true
+
+module YARDSorbet
+  module Handlers
+    # Extends any modules included via `mixes_in_class_methods`
+    # @see https://sorbet.org/docs/abstract#interfaces-and-the-included-hook
+    #   Sorbet `mixes_in_class_methods` documentation
+    class IncludeHandler < YARD::Handlers::Ruby::Base
+      extend T::Sig
+
+      handles method_call(:include)
+      namespace_only
+
+      sig { void }
+      def process
+        statement.parameters(false).each do |mixin|
+          obj = YARD::CodeObjects::Proxy.new(namespace, mixin.source)
+          class_methods_namespace = MixesInClassMethodsHandler.mixed_in_class_methods(obj.to_s)
+          next unless class_methods_namespace
+
+          included_in.mixins(:class) << YARD::CodeObjects::Proxy.new(obj, class_methods_namespace)
+        end
+      end
+
+      private
+
+      # @return the namespace object that is including the module
+      sig { returns(YARD::CodeObjects::NamespaceObject) }
+      def included_in
+        statement.namespace ? YARD::CodeObjects::Proxy.new(namespace, statement.namespace.source) : namespace
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# typed: strict
+# frozen_string_literal: true
+
+module YARDSorbet
+  module Handlers
+    # Tracks modules that invoke `mixes_in_class_methods` for use in {IncludeHandler}
+    # @see https://sorbet.org/docs/abstract#interfaces-and-the-included-hook
+    #   Sorbet `mixes_in_class_methods` documentation
+    class MixesInClassMethodsHandler < YARD::Handlers::Ruby::Base
+      extend T::Sig
+
+      handles method_call(:mixes_in_class_methods)
+      namespace_only
+
+      @@mix_in_class_methods = T.let({}, T::Hash[String, String]) # rubocop:disable Style/ClassVars
+
+      sig { params(code_obj: String).returns(T.nilable(String)) }
+      def self.mixed_in_class_methods(code_obj)
+        @@mix_in_class_methods[code_obj]
+      end
+
+      sig { void }
+      def process
+        @@mix_in_class_methods[namespace.to_s] = statement.parameters(false)[0].source
+      end
+    end
+  end
+end

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

@@ -11,7 +11,7 @@ module YARDSorbet
       namespace_only
 
       # These node types attached to sigs represent attr_* declarations
-      ATTR_NODE_TYPES = T.let(%i[command fcall], T::Array[Symbol])
+      ATTR_NODE_TYPES = T.let(%i[command fcall].freeze, T::Array[Symbol])
       private_constant :ATTR_NODE_TYPES
 
       # Swap the method definition docstring and the sig docstring.

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

@@ -33,10 +33,8 @@ module YARDSorbet
         # 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)
-        object.tags.each { |tag| docstring.add_tag(tag) }
-        props.each do |prop|
-          TagUtils.upsert_tag(docstring, 'param', prop.types, prop.prop_name, prop.doc)
-        end
+        object.tags.each { docstring.add_tag(_1) }
+        props.each { TagUtils.upsert_tag(docstring, 'param', _1.types, _1.prop_name, _1.doc) }
         TagUtils.upsert_tag(docstring, 'return', ['void'])
         decorate_t_struct_init(object, props, docstring, directives)
       end

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

@@ -1,5 +1,7 @@
 # typed: strict
+# frozen_string_literal: true
+
 # 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
+  requires_ancestor { YARD::Handlers::Ruby::ClassHandler }
 end

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

@@ -37,8 +37,7 @@ module YARDSorbet
       # 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
+        statement.traverse { break _1 if _1.type == :label && _1.source == 'default:' }&.parent&.[](1)&.source
       end
 
       sig { params(name: String).returns(TStructProp) }

data/lib/yard-sorbet/handlers.rb

@@ -9,6 +9,8 @@ end
 
 require_relative 'handlers/abstract_dsl_handler'
 require_relative 'handlers/enums_handler'
+require_relative 'handlers/include_handler'
+require_relative 'handlers/mixes_in_class_methods_handler'
 require_relative 'handlers/sig_handler'
 require_relative 'handlers/struct_class_handler'
 require_relative 'handlers/struct_prop_handler'

data/lib/yard-sorbet/node_utils.rb

@@ -8,36 +8,29 @@ module YARDSorbet
 
     # 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])
+    SKIP_METHOD_CONTENTS = T.let(%i[params returns].freeze, T::Array[Symbol])
+    # Node types that can have type signatures
+    SigableNode = T.type_alias { T.any(YARD::Parser::Ruby::MethodDefinitionNode, YARD::Parser::Ruby::MethodCallNode) }
 
-    private_constant :ATTRIBUTE_METHODS, :SIGABLE_NODE
+    private_constant :ATTRIBUTE_METHODS, :SKIP_METHOD_CONTENTS, :SigableNode
 
-    # Traverese AST nodes in breadth-first order
+    # Traverse 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
+    sig { params(node: YARD::Parser::Ruby::AstNode, _blk: T.proc.params(n: YARD::Parser::Ruby::AstNode).void).void }
     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) }
+        n.children.each { queue.push(_1) }
         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) }
+    sig { params(node: YARD::Parser::Ruby::AstNode).returns(SigableNode) }
     def self.get_method_node(node)
       case node
       when YARD::Parser::Ruby::MethodDefinitionNode
@@ -54,9 +47,8 @@ module YARDSorbet
     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
+      node_index = siblings.find_index { _1.equal?(node) }
+      siblings.fetch(node_index + 1)
     end
   end
 end

data/lib/yard-sorbet/sig_to_yard.rb

@@ -6,18 +6,28 @@ module YARDSorbet
   module SigToYARD
     extend T::Sig
 
+    REF_TYPES = T.let({
+      'T::Boolean' => ['Boolean'].freeze, # YARD convention for booleans
+      # YARD convention is use singleton objects when applicable:
+      # https://www.rubydoc.info/gems/yard/file/docs/Tags.md#Literals
+      'FalseClass' => ['false'].freeze,
+      'NilClass' => ['nil'].freeze,
+      'TrueClass' => ['true'].freeze
+    }.freeze, T::Hash[String, [String]])
+    private_constant :REF_TYPES
+
     # @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*/, ' ') }
+      convert_node(node).map { _1.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)
+      when YARD::Parser::Ruby::ReferenceNode then convert_ref(node.source)
       else convert_node_type(node)
       end
     end
@@ -45,8 +55,7 @@ module YARDSorbet
       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(', ')
-
+      member_type = node.last.children.map { build_generic_type(_1) }.join(', ')
       "#{collection_type}[#{member_type}]"
     end
 
@@ -62,11 +71,11 @@ module YARDSorbet
       end
     end
 
-    sig { params(node: YARD::Parser::Ruby::AstNode).returns(T::Array[String]) }
+    sig { params(node: YARD::Parser::Ruby::AstNode).returns([String]) }
     private_class_method def self.convert_array(node)
       # https://www.rubydoc.info/gems/yard/file/docs/Tags.md#Order-Dependent_Lists
-      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(', ')
+      member_types = node.first.children.map { convert_node(_1) }
+      sequence = member_types.map { _1.size == 1 ? _1[0] : _1.to_s.tr('"', '') }.join(', ')
       ["Array(#{sequence})"]
     end
 
@@ -75,14 +84,14 @@ module YARDSorbet
       node.namespace.source == 'T' ? convert_t_method(node) : [node.source]
     end
 
-    sig { params(node: YARD::Parser::Ruby::AstNode).returns(T::Array[String]) }
+    sig { params(node: YARD::Parser::Ruby::AstNode).returns([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]) }
+    sig { params(node: YARD::Parser::Ruby::AstNode).returns([String]) }
     private_class_method def self.convert_hash(node)
       kv = node.last.children
       key_type = convert_node(kv.first).join(', ')
@@ -95,24 +104,15 @@ module YARDSorbet
       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
-      when 'FalseClass' then ['false']
-      when 'NilClass' then ['nil']
-      when 'TrueClass' then ['true']
-      else [source]
-      end
+    sig { params(node_source: String).returns([String]) }
+    private_class_method def self.convert_ref(node_source)
+      REF_TYPES.fetch(node_source, [node_source])
     end
 
     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
+      when :any then node.last.first.children.flat_map { convert_node(_1) }
       # 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
@@ -121,7 +121,7 @@ module YARDSorbet
       end
     end
 
-    sig { params(node: YARD::Parser::Ruby::AstNode).returns(T::Array[String]) }
+    sig { params(node: YARD::Parser::Ruby::AstNode).returns([String]) }
     private_class_method def self.convert_unknown(node)
       log.warn("Unsupported sig #{node.type} node #{node.source}")
       [node.source]

data/lib/yard-sorbet/t_struct_prop.rb

@@ -1,4 +1,4 @@
-# typed: strict
+# typed: strong
 # frozen_string_literal: true
 
 module YARDSorbet

data/lib/yard-sorbet/tag_utils.rb

@@ -8,11 +8,10 @@ module YARDSorbet
 
     # @return the tag with the matching `tag_name` and `name`, or `nil`
     sig do
-      params(docstring: YARD::Docstring, tag_name: String, name: T.nilable(String))
-        .returns(T.nilable(YARD::Tags::Tag))
+      params(docstring: YARD::Docstring, tag_name: String, name: T.nilable(String)).returns(T.nilable(YARD::Tags::Tag))
     end
     def self.find_tag(docstring, tag_name, name)
-      docstring.tags.find { |t| t.tag_name == tag_name && t.name == name }
+      docstring.tags.find { _1.tag_name == tag_name && _1.name == name }
     end
 
     # Create or update a `YARD` tag with type information
@@ -31,7 +30,7 @@ module YARDSorbet
         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 }
+        docstring.delete_tag_if { _1 == tag }
         # overwrite any existing type annotation (sigs should win)
         tag.types = types
         tag.text = text unless text.empty?

data/lib/yard-sorbet/version.rb

@@ -4,5 +4,5 @@
 # Types are documentation
 module YARDSorbet
   # {https://rubygems.org/gems/yard-sorbet Version history}
-  VERSION = '0.5.3'
+  VERSION = '0.7.0'
 end

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: yard-sorbet
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.7.0
 platform: ruby
 authors:
 - Douglas Eichelberger
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-01 00:00:00.000000000 Z
+date: 2022-08-24 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'
+        version: 0.9.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.1
 - !ruby/object:Gem::Dependency
   name: codecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -86,28 +86,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.18.0
+        version: 1.35.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.18.0
+        version: 1.35.0
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.11.0
+        version: 1.14.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.11.0
+        version: 1.14.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
@@ -128,14 +128,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.0
+        version: 2.12.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.0
+        version: 2.12.1
 - !ruby/object:Gem::Dependency
   name: rubocop-sorbet
   requirement: !ruby/object:Gem::Requirement
@@ -151,33 +151,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.6.0
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: sorbet
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.5.9204
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.5.9204
 - !ruby/object:Gem::Dependency
-  name: sorbet
+  name: tapioca
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.6289
+        version: 0.9.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.6289
+        version: 0.9.4
 - !ruby/object:Gem::Dependency
   name: sorbet-runtime
   requirement: !ruby/object:Gem::Requirement
@@ -220,6 +220,8 @@ files:
 - lib/yard-sorbet/handlers.rb
 - lib/yard-sorbet/handlers/abstract_dsl_handler.rb
 - lib/yard-sorbet/handlers/enums_handler.rb
+- lib/yard-sorbet/handlers/include_handler.rb
+- lib/yard-sorbet/handlers/mixes_in_class_methods_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
@@ -237,6 +239,7 @@ metadata:
   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
+  rubygems_mfa_required: 'true'
   source_code_uri: https://github.com/dduugg/yard-sorbet
   wiki_uri: https://github.com/dduugg/yard-sorbet/wiki
 post_install_message:
@@ -247,14 +250,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.2.33
 signing_key:
 specification_version: 4
 summary: Create YARD docs from Sorbet type signatures