yard-sorbet 0.5.2 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: abed4a7ebc07752257feab235b53a7a0162c348b3dd614fed606aa9299840115
-  data.tar.gz: 8799257d6fa6a2f24689c3e737ed484fce741c0098c60648eed4e370273bb161
+  metadata.gz: ee5168e45f37fe7d16db534727b57fad2a08e05acda8298ef421589aa72f0354
+  data.tar.gz: ce10ba6df63c35ba4b52eb4f7d8b02878cfb01fea7424e966aad739691d1d767
 SHA512:
-  metadata.gz: ff78cce014d6d8443ac4b00fd980c6f316e9f11b091e2a031fbe6ed2b9ffc5e68657500a4d952fa9eb7f649f914f102acc509960aa5d6c6cddbc449a86d18e66
-  data.tar.gz: 201e32a5fb1de713569b8476c8acaa4634853d11a8538cad9770d06c9bc0fe396b900b50626f883cbd6dfe8ee8846703e91c50a4bee7a3a191d70fac66737b9d
+  metadata.gz: faa0b506388d501f6567ddfd08144185b1e761a1d4d4cfec12e3256f3985f626ddbc2da1423b37896fbe132a1e729a3c44b995b957eb0391aa48ded9519978d4
+  data.tar.gz: 2afbc9875afecab271abccfd12b5023c3e7db429f23f689fdbed18ed2e0fd7f3b51137ee86b649bb501ea921c469774e2096887d1d063599ae72939951b2f719

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

@@ -33,12 +33,12 @@ 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|
-          docstring.add_tag(YARD::Tags::Tag.new(:param, prop.doc, prop.types, prop.prop_name))
+          TagUtils.upsert_tag(docstring, 'param', prop.types, prop.prop_name, prop.doc)
         end
-        docstring.add_tag(YARD::Tags::Tag.new(:return, '', class_ns))
+        TagUtils.upsert_tag(docstring, 'return', ['void'])
         decorate_t_struct_init(object, props, docstring, directives)
-        register(object)
       end
 
       sig do
@@ -54,7 +54,7 @@ module YARDSorbet
         object.parameters = to_object_parameters(props)
         # The "source" of our constructor is the field declarations
         object.source ||= props.map(&:source).join("\n")
-        object.docstring = docstring.to_raw
+        object.docstring = docstring
         Directives.add_directives(object.docstring, directives)
       end
 

data/lib/yard-sorbet/tag_utils.rb

@@ -6,16 +6,26 @@ module YARDSorbet
   module TagUtils
     extend T::Sig
 
+    # @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))
+    end
+    def self.find_tag(docstring, tag_name, name)
+      docstring.tags.find { |t| t.tag_name == tag_name && t.name == name }
+    end
+
     # Create or update a `YARD` tag with type information
     sig do
       params(
         docstring: YARD::Docstring,
         tag_name: String,
         types: T.nilable(T::Array[String]),
-        name: T.nilable(String)
+        name: T.nilable(String),
+        text: String
       ).void
     end
-    def self.upsert_tag(docstring, tag_name, types = nil, name = nil)
+    def self.upsert_tag(docstring, tag_name, types = nil, name = nil, text = '')
       tag = find_tag(docstring, tag_name, name)
       if tag
         return unless types
@@ -24,18 +34,11 @@ module YARDSorbet
         docstring.delete_tag_if { |t| t == tag }
         # overwrite any existing type annotation (sigs should win)
         tag.types = types
+        tag.text = text unless text.empty?
       else
-        tag = YARD::Tags::Tag.new(tag_name, '', types, name)
+        tag = YARD::Tags::Tag.new(tag_name, text, types, name)
       end
       docstring.add_tag(tag)
     end
-
-    sig do
-      params(docstring: YARD::Docstring, tag_name: String, name: T.nilable(String))
-        .returns(T.nilable(YARD::Tags::Tag))
-    end
-    private_class_method def self.find_tag(docstring, tag_name, name)
-      docstring.tags.find { |t| t.tag_name == tag_name && t.name == name }
-    end
   end
 end

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.2'
+  VERSION = '0.5.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yard-sorbet
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.5.3
 platform: ruby
 authors:
 - Douglas Eichelberger
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-01 00:00:00.000000000 Z
+date: 2021-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler-audit