yard-sorbet 0.8.1 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9b9dcb968aabdaa21a4f1eb74d7a0800e156fda50609b9e4df209795fe4f353f
-  data.tar.gz: bd98ccbde56a8fbb8a3d1058c64047b3ff0111912684dd454cf71f016abc5c88
+  metadata.gz: 1421bf5c36984eb95f6d05e83900bdc9599a052fa51edb2939cf9dc656f5722b
+  data.tar.gz: 3922ad972509e1bfb185903ff40dfce5952fca881ea4196f7c8c2f37a572ae24
 SHA512:
-  metadata.gz: c42c6277c2ebe6eac00e8bad6c68528d23aa1066ce23d79276a8dce062a064f8dcda87c77eff00ace7d125685a503b17c62357c50b59212b1507cb5880db5d26
-  data.tar.gz: 8209d82a15513c42d1d3371be854a7d2d63989e0c1552eb53e34b87aba6578cca8caf4f46a439474df193dd28951872fbed2af72ff63065a8b17adf8d4969614
+  metadata.gz: 2a7531bf6292ee4d37d5257ce851d62a9738c8f9319595f5c638b30e9a0cb324980b5fa3608b6b45da1e7fa9940323e7e31cbab9621957e8b0addab86020f11c
+  data.tar.gz: 365dac401f8792a0841496ccb07a3b08ee5d88d5f1de29a38312094eddc659f6fc6b9b087032e11fa862a482c6d30dc2069244aa060719eb81666d5358b7d5d3

data/lib/yard-sorbet/directives.rb

@@ -18,8 +18,6 @@ module YARDSorbet
     end
 
     sig { params(docstring: String, directives: T::Array[String]).void }
-    def self.add_directives(docstring, directives)
-      directives.each { docstring.concat("\n#{_1}") }
-    end
+    def self.add_directives(docstring, directives) = directives.each { docstring.concat("\n#{_1}") }
   end
 end

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

@@ -3,7 +3,7 @@
 
 module YARDSorbet
   module Handlers
-    # Apllies an `@abstract` tag to `abstract!`/`interface!` modules (if not alerady present).
+    # Applies an `@abstract` tag to `abstract!`/`interface!` modules (if not alerady present).
     class AbstractDSLHandler < YARD::Handlers::Ruby::Base
       extend T::Sig
 
@@ -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 cannot be directly instantiated. #{TAG_TEXT}", String)
+      CLASS_TAG_TEXT = T.let("It cannot be directly instantiated. #{TAG_TEXT}".freeze, String)
 
       sig { void }
       def process

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

@@ -26,9 +26,7 @@ module YARDSorbet
       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
+      def const_assign_node?(node) = node.type == :assign && node[0][0].type == :const
     end
   end
 end

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

@@ -15,9 +15,7 @@ module YARDSorbet
       @@mix_in_class_methods = T.let({}, T::Hash[String, T::Array[String]]) # rubocop:disable Style/ClassVars
 
       sig { params(code_obj: String).returns(T.nilable(T::Array[String])) }
-      def self.mixed_in_class_methods(code_obj)
-        @@mix_in_class_methods[code_obj]
-      end
+      def self.mixed_in_class_methods(code_obj) = @@mix_in_class_methods[code_obj]
 
       sig { void }
       def process

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

@@ -64,21 +64,19 @@ module YARDSorbet
         attrs = namespace.attributes[scope][names[0]]
         return false if attrs.nil? || attrs.empty?
 
-        document_attr_methods(attrs.values.compact)
+        document_attrs(attrs.values.compact)
         attr_node.docstring = nil
         true
       end
 
       sig { params(method_objects: T::Array[YARD::CodeObjects::MethodObject]).void }
-      def document_attr_methods(method_objects)
-        method_objects.each { parse_node(_1, _1.docstring, include_params: false) }
-      end
+      def document_attrs(method_objects) =  method_objects.each { parse_node(_1, _1.docstring, include_params: false) }
 
       sig { params(attach_to: Documentable, docstring: T.nilable(String), include_params: T::Boolean).void }
       def parse_node(attach_to, docstring, include_params: true)
         existing_docstring = docstring.is_a?(YARD::Docstring)
         docstring, directives = Directives.extract_directives(docstring) unless existing_docstring
-        parse_sig(docstring, include_params: include_params)
+        parse_sig(docstring, include_params:)
         attach_to.docstring = docstring.to_raw
         Directives.add_directives(attach_to.docstring, directives) unless existing_docstring
       end

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

@@ -35,15 +35,11 @@ module YARDSorbet
       end
 
       sig { returns(T::Boolean) }
-      def immutable?
-        statement.method_name(true) == :const || kw_arg('immutable:') == 'true'
-      end
+      def immutable? = statement.method_name(true) == :const || kw_arg('immutable:') == 'true'
 
       # @return the value passed to the keyword argument, or nil
       sig { params(kwd: String).returns(T.nilable(String)) }
-      def kw_arg(kwd)
-        params[2]&.find { _1[0].source == kwd }&.[](1)&.source
-      end
+      def kw_arg(kwd) = params[2]&.find { _1[0].source == kwd }&.[](1)&.source
 
       sig { params(name: String).returns(TStructProp) }
       def make_prop(name)
@@ -57,16 +53,14 @@ module YARDSorbet
       end
 
       sig { returns(T::Array[YARD::Parser::Ruby::AstNode]) }
-      def params
-        @params ||= T.let(statement.parameters(false), T.nilable(T::Array[YARD::Parser::Ruby::AstNode]))
-      end
+      def params = @params ||= T.let(statement.parameters(false), T.nilable(T::Array[YARD::Parser::Ruby::AstNode]))
 
       # Register the field explicitly as an attribute.
       sig { params(object: YARD::CodeObjects::MethodObject, name: String).void }
       def register_attrs(object, name)
         write = immutable? ? nil : object
         # Create the virtual attribute in our current scope
-        namespace.attributes[scope][name] ||= SymbolHash[read: object, write: write]
+        namespace.attributes[scope][name] ||= SymbolHash[read: object, write:]
       end
 
       # Store the prop for use in the constructor definition

data/lib/yard-sorbet/node_utils.rb

@@ -19,25 +19,33 @@ module YARDSorbet
     # @yield [YARD::Parser::Ruby::AstNode]
     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]
+      queue = Queue.new << node
       until queue.empty?
-        n = T.must(queue.shift)
+        n = queue.deq(true)
         yield n
-        n.children.each { queue.push(_1) }
-        queue.pop if n.is_a?(YARD::Parser::Ruby::MethodCallNode) && SKIP_METHOD_CONTENTS.include?(n.method_name(true))
+        enqueue_children(queue, n)
       end
     end
 
     sig { params(node: YARD::Parser::Ruby::AstNode).void }
-    def self.delete_node(node)
-      node.parent.children.delete(node)
+    def self.delete_node(node) = node.parent.children.delete(node)
+
+    # Enqueue the eligible children of a node in the BFS queue
+    sig { params(queue: Queue, node: YARD::Parser::Ruby::AstNode).void }
+    def self.enqueue_children(queue, node)
+      last_child = node.children.last
+      node.children.each do |child|
+        next if child == last_child &&
+                node.is_a?(YARD::Parser::Ruby::MethodCallNode) &&
+                SKIP_METHOD_CONTENTS.include?(node.method_name(true))
+
+        queue.enq(child)
+      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(SigableNode) }
-    def self.get_method_node(node)
-      sigable_node?(node) ? node : node.jump(:def, :defs)
-    end
+    def self.get_method_node(node) = sigable_node?(node) ? node : node.jump(:def, :defs)
 
     # Find and return the adjacent node (ascending)
     # @raise [IndexError] if the node does not have an adjacent sibling (ascending)

data/lib/yard-sorbet/sig_to_yard.rb

@@ -10,8 +10,8 @@ module YARDSorbet
       # Map of common types to YARD conventions (in order to reduce allocations)
       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
+        # YARD convention is to 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
@@ -20,10 +20,7 @@ module YARDSorbet
 
       # @see https://yardoc.org/types.html
       sig { params(node: YARD::Parser::Ruby::AstNode).returns(T::Array[String]) }
-      def convert(node)
-        # scrub newlines, as they break the YARD parser
-        convert_node(node).map { _1.gsub(/\n\s*/, ' ') }
-      end
+      def convert(node) = convert_node(node).map { _1.gsub(/\n\s*/, ' ') }
 
       private
 
@@ -68,7 +65,7 @@ module YARDSorbet
 
       sig { params(node: YARD::Parser::Ruby::AstNode).returns(T::Array[String]) }
       def convert_aref(node)
-        # https://www.rubydoc.info/gems/yard/file/docs/Tags.md#Parametrized_Types
+        # https://www.rubydoc.info/gems/yard/file/docs/Tags.md#parametrized-types
         case node.first.source
         when 'T::Array', 'T::Enumerable', 'T::Range', 'T::Set' then convert_collection(node)
         when 'T::Hash' then convert_hash(node)
@@ -80,10 +77,10 @@ module YARDSorbet
 
       sig { params(node: YARD::Parser::Ruby::AstNode).returns([String]) }
       def convert_array(node)
-        # https://www.rubydoc.info/gems/yard/file/docs/Tags.md#Order-Dependent_Lists
+        # https://www.rubydoc.info/gems/yard/file/docs/Tags.md#order-dependent-lists
         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})"]
+        ["Array<(#{sequence})>"]
       end
 
       sig { params(node: YARD::Parser::Ruby::AstNode).returns([String]) }

data/lib/yard-sorbet/tag_utils.rb

@@ -13,9 +13,7 @@ module YARDSorbet
     sig do
       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 { _1.tag_name == tag_name && _1.name == name }
-    end
+    def self.find_tag(docstring, tag_name, name) = docstring.tags.find { _1.tag_name == tag_name && _1.name == name }
 
     # Create or update a `YARD` tag with type information
     sig do

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.8.1'
+  VERSION = '0.9.0'
 end

metadata

@@ -1,211 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: yard-sorbet
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.9.0
 platform: ruby
 authors:
 - Douglas Eichelberger
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-03 00:00:00.000000000 Z
+date: 2024-06-30 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.9.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.9.1
-- !ruby/object:Gem::Dependency
-  name: codecov
-  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: 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: 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
-    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: 1.49.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.49.0
-- !ruby/object:Gem::Dependency
-  name: rubocop-performance
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.16.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.16.0
-- !ruby/object:Gem::Dependency
-  name: rubocop-rake
-  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: rubocop-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.19.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.19.0
-- !ruby/object:Gem::Dependency
-  name: rubocop-sorbet
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.7.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.7.0
-- !ruby/object:Gem::Dependency
-  name: sorbet
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.5.9204
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.5.9204
-- !ruby/object:Gem::Dependency
-  name: tapioca
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.11.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.11.1
 - !ruby/object:Gem::Dependency
   name: sorbet-runtime
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0'
 description: A YARD plugin that incorporates Sorbet type information
 email: dduugg@gmail.com
 executables: []
@@ -248,14 +80,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Create YARD docs from Sorbet type signatures