yard-sorbet 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e83416e1d85da291aa4d0311df2e239f14fd072f38f3f2be4ee12a008f1a89dc
-  data.tar.gz: 3fcffa38addbaa3b47b200711462847b81bd9c52095aa1dfa46d2c077f497ef4
+  metadata.gz: f5a40a71c985d760b358e1a066b2b30b73a244ec47c43546dcbb476135217b6c
+  data.tar.gz: 74d637f5b92f95234f3feaf2ef39050bcb4379c26a735961f4f04d7a29bd7697
 SHA512:
-  metadata.gz: 13f13c26aff10422e1fda98016fdfd1038d14a36d084653407b7797908206cde655f1504087b7ec164d6b72de2b9ded4d5f807c9c9af36d4a77e6c296828cd3d
-  data.tar.gz: 9bb8d82770501e206ac7f1bf6f6d836c0559383b9babd0e6416180e5508bed5bd7f55e317a5c86f30231ca7cdc08b30211b722645a558d4130c4f046a39471ec
+  metadata.gz: f92b7ec79d46db5b9abcb3ecb294576fe02874972deeb93f23023fbfebe0bc50c9160d7f11193f93598cb07191ab4a5b3045c27ea5d0bce509fdbef5d9e99a65
+  data.tar.gz: 66ea5ef884b6867b1f4b80a28f5b4ee8ee8c557995be314513c43eb0886fb7a0697c01b9723d3f6a76607dc2108ddbabe7c398b5ceaec16e3693707f0b10b911

data/lib/yard-sorbet.rb

@@ -4,8 +4,6 @@
 require 'sorbet-runtime'
 require 'yard'
 
-T::Configuration.default_checked_level = :tests
-
 # top-level namespace
 module YARDSorbet; end
 
@@ -13,3 +11,4 @@ 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/sig_handler.rb

@@ -6,11 +6,19 @@ 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 :PARAM_EXCLUDES, :PROCESSABLE_NODES, :SIG_EXCLUDES, :SIG_NODE_TYPES
+
+  private_constant :ParsedSig, :PARAM_EXCLUDES, :PROCESSABLE_NODES, :SIG_EXCLUDES, :SIG_NODE_TYPES
 
   sig { void }
   def process
@@ -56,7 +64,7 @@ class YARDSorbet::SigHandler < YARD::Handlers::Ruby::Base
     enhance_tag(docstring, :abstract, parsed_sig)
     enhance_tag(docstring, :return, parsed_sig)
     if method_node.type != :command
-      parsed_sig[:params]&.each do |name, types|
+      parsed_sig.params.each do |name, types|
         enhance_param(docstring, name, types)
       end
     end
@@ -77,9 +85,10 @@ class YARDSorbet::SigHandler < YARD::Handlers::Ruby::Base
     docstring.add_tag(tag)
   end
 
-  sig { params(docstring: YARD::Docstring, type: Symbol, parsed_sig: T::Hash[Symbol, Object]).void }
+  sig { params(docstring: YARD::Docstring, type: Symbol, parsed_sig: ParsedSig).void }
   private def enhance_tag(docstring, type, parsed_sig)
-    return if !parsed_sig[type]
+    type_value = parsed_sig.public_send(type)
+    return if !type_value
 
     tag = docstring.tags.find { |t| t.tag_name == type.to_s }
     if tag
@@ -87,33 +96,20 @@ class YARDSorbet::SigHandler < YARD::Handlers::Ruby::Base
     else
       tag = YARD::Tags::Tag.new(type, '')
     end
-    if parsed_sig[type].is_a?(Array)
-      tag.types = parsed_sig[type]
+    if type_value.is_a?(Array)
+      tag.types = type_value
     end
     docstring.add_tag(tag)
   end
 
-  sig do
-    params(sig_node: YARD::Parser::Ruby::MethodCallNode)
-      .returns(
-        {
-          abstract: T::Boolean,
-          params: T::Hash[String, T::Array[String]],
-          return: T.nilable(T::Array[String])
-        }
-      )
-  end
+  sig { params(sig_node: YARD::Parser::Ruby::MethodCallNode).returns(ParsedSig) }
   private def parse_sig(sig_node)
-    parsed = {
-      abstract: false,
-      params: {},
-      return: nil
-    }
+    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
+        parsed.abstract = true
       elsif n.source == 'params' && !found_params
         found_params = true
         sibling = T.must(sibling_node(n))
@@ -121,14 +117,14 @@ class YARDSorbet::SigHandler < YARD::Handlers::Ruby::Base
           if p.type == :assoc
             param_name = p.children.first.source[0...-1]
             types = YARDSorbet::SigToYARD.convert(p.children.last)
-            parsed[:params][param_name] = types
+            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)))
+        parsed.return = YARDSorbet::SigToYARD.convert(T.must(sibling_node(n)))
       elsif n.source == 'void'
-        parsed[:return] ||= ['void']
+        parsed.return ||= ['void']
       end
     end
     parsed

data/lib/yard-sorbet/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module YARDSorbet
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: yard-sorbet
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Douglas Eichelberger
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-14 00:00:00.000000000 Z
+date: 2021-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: codecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.12
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.12
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -58,28 +58,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.0
+        version: 1.11.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.0
+        version: 1.11.0
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.9.2
+        version: 1.10.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.9.2
+        version: 1.10.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: 2.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: 2.2.0
 - !ruby/object:Gem::Dependency
   name: rubocop-sorbet
   requirement: !ruby/object:Gem::Requirement
@@ -126,16 +126,16 @@ dependencies:
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.21'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.21'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sorbet
   requirement: !ruby/object:Gem::Requirement
@@ -215,7 +215,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: Create YARD docs from Sorbet type signatures