yard-sorbet 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 360c73bcd93390b21ebf0206cce339822368fca005d03fa3d08a4444a3cab367
-  data.tar.gz: 7b03b59846235fd395bca99868561eaa299b7dbe21eea7c91307c602236baec9
+  metadata.gz: ca3c823cd78ea11784724185ff336604d2e7b131082945c3fc19200d1b3294cf
+  data.tar.gz: 43b2a6a38cb3161d2452eaa823ac336cbb5dcb0782fb40d0b5ddbf12afe33467
 SHA512:
-  metadata.gz: 364ee6ff02687a3a4e2ffd3384c2eb68a848afe60ad0e94c8d675df81ae9a820e805ed07ce1537cee59eb3e979ce2488a1a2210aa19cc1b40365b9dc97368864
-  data.tar.gz: f26eb01fcad908815f27afc9a42ad72050625e5279e3b3b7576991aa1b14ba685148c12d74bbc2cdba19e69b1f416f48fa89253d34a5635259794d088ad7415f
+  metadata.gz: aff435511b0e40b212c3ffcfd8194cec04a70d9e05ce82865dbbf074376cc6da7d9503a71f395aafde9615c99f524051977d9c6b9aaac971ee1c8f378ab4aa5f
+  data.tar.gz: 746934d64c6bfd728551b43b380cf6efd3da0ccbb9224cbb29bbabe065d17821530e640c3a8377e5935a05d1f9527d51f36da995c21dd0c5821903b86482017f

data/lib/yard-sorbet.rb

@@ -4,11 +4,9 @@
 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/handlers'
 require_relative 'yard-sorbet/node_utils'
 require_relative 'yard-sorbet/sig_to_yard'
-require_relative 'yard-sorbet/version'

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

@@ -1,7 +1,7 @@
 # typed: strict
 # frozen_string_literal: true
 
-# Apllies an +@abstract+ tag to +abstract!+/+interface!+ modules (if not alerady present).
+# Apllies an `@abstract` tag to `abstract!`/`interface!` modules (if not alerady present).
 class YARDSorbet::Handlers::AbstractDSLHandler < YARD::Handlers::Ruby::Base
   extend T::Sig
 

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

@@ -1,7 +1,7 @@
 # typed: strict
 # frozen_string_literal: true
 
-# Handle +enums+ calls, registering enum values as constants
+# Handle `enums` calls, registering enum values as constants
 class YARDSorbet::Handlers::EnumsHandler < YARD::Handlers::Ruby::Base
   extend T::Sig
 

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

@@ -15,15 +15,17 @@ class YARDSorbet::Handlers::SigHandler < YARD::Handlers::Ruby::Base
     prop :return, T.nilable(T::Array[String])
   end
 
+  # These node types attached to sigs represent attr_* declarations
+  ATTR_NODE_TYPES = T.let(%i[command fcall], T::Array[Symbol])
   # Skip these node types when parsing `sig` params
   PARAM_EXCLUDES = T.let(%i[array call hash].freeze, T::Array[Symbol])
   # Skip these node types when parsing `sig`s
   SIG_EXCLUDES = T.let(%i[array hash].freeze, T::Array[Symbol])
 
-  private_constant :ParsedSig, :PARAM_EXCLUDES, :SIG_EXCLUDES
+  private_constant :ParsedSig, :ATTR_NODE_TYPES, :PARAM_EXCLUDES, :SIG_EXCLUDES
 
   # Swap the method definition docstring and the sig docstring.
-  # Parse relevant parts of the +sig+ and include them as well.
+  # Parse relevant parts of the `sig` and include them as well.
   sig { void }
   def process
     method_node = YARDSorbet::NodeUtils.get_method_node(YARDSorbet::NodeUtils.sibling_node(statement))
@@ -31,7 +33,7 @@ class YARDSorbet::Handlers::SigHandler < YARD::Handlers::Ruby::Base
     parsed_sig = parse_sig(statement)
     enhance_tag(docstring, :abstract, parsed_sig)
     enhance_tag(docstring, :return, parsed_sig)
-    if method_node.type != :command
+    unless ATTR_NODE_TYPES.include?(method_node.type)
       parsed_sig.params.each do |name, types|
         enhance_param(docstring, name, types)
       end

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

@@ -1,7 +1,7 @@
 # typed: strict
 # frozen_string_literal: true
 
-# Handles all +const+/+prop+ calls, creating accessor methods, and compiles them for later usage at the class level
+# Handles all `const`/`prop` calls, creating accessor methods, and compiles them for later usage at the class level
 # in creating a constructor
 class YARDSorbet::Handlers::StructHandler < YARD::Handlers::Ruby::Base
   extend T::Sig
@@ -39,7 +39,8 @@ class YARDSorbet::Handlers::StructHandler < YARD::Handlers::Ruby::Base
     object = MethodObject.new(namespace, name, scope)
     object.source = source
 
-    reader_docstring = doc.empty? ? "Returns the value of attribute +#{name}+." : doc
+    # TODO: this should use `+` to delimit the attribute name when markdown is disabled
+    reader_docstring = doc.empty? ? "Returns the value of attribute `#{name}`." : doc
     docstring = YARD::DocstringParser.new.parse(reader_docstring).to_docstring
     docstring.add_tag(YARD::Tags::Tag.new(:return, '', types))
     object.docstring = docstring.to_raw
@@ -53,14 +54,13 @@ class YARDSorbet::Handlers::StructHandler < YARD::Handlers::Ruby::Base
   end
 end
 
-# Class-level handler that folds all +const+ and +prop+ declarations into the constructor documentation
+# Class-level handler that folds all `const` and `prop` declarations into the constructor documentation
 # this needs to be injected as a module otherwise the default Class handler will overwrite documentation
-module YARDSorbet::StructClassHandler
-  extend T::Helpers
+#
+# @note this module is included in `YARD::Handlers::Ruby::ClassHandler`
+module YARDSorbet::Handlers::StructClassHandler
   extend T::Sig
 
-  requires_ancestor YARD::Handlers::Ruby::ClassHandler
-
   sig { void }
   def process
     super
@@ -106,4 +106,4 @@ module YARDSorbet::StructClassHandler
   end
 end
 
-YARD::Handlers::Ruby::ClassHandler.include YARDSorbet::StructClassHandler
+YARD::Handlers::Ruby::ClassHandler.include YARDSorbet::Handlers::StructClassHandler

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

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

data/lib/yard-sorbet/node_utils.rb

@@ -14,6 +14,7 @@ module YARDSorbet::NodeUtils
 
   private_constant :ATTRIBUTE_METHODS, :SIGABLE_NODE
 
+  # Traverese AST nodes in breadth-first order
   # @yield [YARD::Parser::Ruby::AstNode]
   sig do
     params(

data/lib/yard-sorbet/sig_to_yard.rb

@@ -1,7 +1,7 @@
 # typed: strict
 # frozen_string_literal: true
 
-# Translate +sig+ type syntax to +YARD+ type syntax.
+# Translate `sig` type syntax to `YARD` type syntax.
 module YARDSorbet::SigToYARD
   extend T::Sig
 

data/lib/yard-sorbet/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yard-sorbet
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Douglas Eichelberger
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-28 00:00:00.000000000 Z
+date: 2021-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler-audit
@@ -52,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
@@ -72,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.15.0
+        version: 1.16.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.15.0
+        version: 1.16.0
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
@@ -170,14 +184,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.6289
+        version: 0.5.5845
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.6289
+        version: 0.5.5845
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -208,6 +222,7 @@ files:
 - lib/yard-sorbet/handlers/enums_handler.rb
 - lib/yard-sorbet/handlers/sig_handler.rb
 - lib/yard-sorbet/handlers/struct_handler.rb
+- lib/yard-sorbet/handlers/struct_handler.rbi
 - lib/yard-sorbet/node_utils.rb
 - lib/yard-sorbet/sig_to_yard.rb
 - lib/yard-sorbet/version.rb