Add tests

Author: dduugg

lib/yard-sorbet/handlers/sig_handler.rb

@@ -46,8 +46,7 @@ def process_def(def_node)
 
       sig { params(attr_node: YARD::Parser::Ruby::MethodCallNode).void }
       def process_attr(attr_node)
-        names = NodeUtils.validated_attribute_names(attr_node)
-        return if merged_into_attr?(attr_node, names)
+        return if merged_into_attr?(attr_node)
 
         parse_node(attr_node, statement.docstring, include_params: false)
         statement.docstring = nil
@@ -56,18 +55,24 @@ def process_attr(attr_node)
       # An attr* sig can be merged into a previous attr* docstring if it is the only parameter passed to the attr*
       # declaration. This is to avoid needing to rewrite the source code to separate merged and unmerged attr*
       # declarations.
-      sig { params(attr_node: YARD::Parser::Ruby::MethodCallNode, names: T::Array[String]).returns(T::Boolean) }
-      def merged_into_attr?(attr_node, names)
-        return false if names.size == 1
+      sig { params(attr_node: YARD::Parser::Ruby::MethodCallNode).returns(T::Boolean) }
+      def merged_into_attr?(attr_node)
+        names = NodeUtils.validated_attribute_names(attr_node)
+        return false if names.size != 1
 
         nodes = namespace.attributes[scope][names.fetch(0)]
         return false if nodes.nil? || nodes.empty?
 
-        nodes.each_value { parse_node(_1, _1.docstring, include_params: false) }
+        document_attr_methods(nodes.values.compact)
         attr_node.docstring = statement.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
+
       sig { params(attach_to: Documentable, docstring: T.nilable(String), include_params: T::Boolean).void }
       def parse_node(attach_to, docstring, include_params: true)
         docstring_, directives = Directives.extract_directives(docstring)

lib/yard-sorbet/node_utils.rb

@@ -60,7 +60,6 @@ def self.validated_attribute_names(attr_node)
         case obj.type
         when :symbol_literal then obj.jump(:ident, :op, :kw, :const).source
         when :string_literal then obj.jump(:string_content).source
-        else raise YARD::Parser::UndocumentableError, obj.source
         end
       end
     end

spec/data/sig_handler.txt

@@ -294,7 +294,7 @@ end
 
 class AttrSigs
   sig {returns(String)}
-  attr_accessor :my_accessor
+  attr_accessor 'my_accessor'
 
   sig {returns(Integer)}
   attr_reader :my_reader

spec/yard_sorbet/handlers/sig_handler_spec.rb

@@ -12,6 +12,30 @@
   end
 
   describe 'Merging an RBI file' do
+    it 'includes docstring from original attr_accessor' do
+      expect(YARD::Registry.at('Merge::A#a_foo').docstring).to eq('annotated attr_accessor')
+    end
+
+    it 'merges attr_accessor sig' do
+      expect(YARD::Registry.at('Merge::A#a_foo').tag(:return).types).to eq(['Numeric'])
+    end
+
+    it 'includes docstring from original attr_reader' do
+      expect(YARD::Registry.at('Merge::A#a_bar').docstring).to eq('Returns the value of attribute a_bar.')
+    end
+
+    it 'merges attr_reader sig' do
+      expect(YARD::Registry.at('Merge::A#a_bar').tag(:return).types).to eq(%w[String nil])
+    end
+
+    it 'includes docstring from original attr_writer' do
+      expect(YARD::Registry.at('Merge::A#a_baz=').docstring).to eq('Sets the attribute a_baz')
+    end
+
+    it 'merges attr_writer sig' do
+      expect(YARD::Registry.at('Merge::A#a_baz=').tag(:return).types).to eq(['Integer'])
+    end
+
     it 'includes docstring from original instance def' do
       expect(YARD::Registry.at('Merge::A#foo').docstring).to eq('The foo instance method for A')
     end