Warn on undocumentable attrs

Author: dduugg

lib/yard-sorbet/handlers/sig_handler.rb

@@ -88,7 +88,7 @@ def parse_sig(docstring, include_params: true)
         NodeUtils.bfs_traverse(statement) do |node|
           case node.source
           when 'returns' then parse_return(node, docstring)
-          when 'params' then include_params && parse_params(node, docstring)
+          when 'params' then parse_params(node, docstring) if include_params
           when 'void' then TagUtils.upsert_tag(docstring, 'return', TagUtils::VOID_RETURN_TYPE)
           when 'abstract' then TagUtils.upsert_tag(docstring, 'abstract')
           end

lib/yard-sorbet/node_utils.rb

@@ -62,9 +62,9 @@ def self.sigable_node?(node)
     sig { params(attr_node: YARD::Parser::Ruby::MethodCallNode).returns(T::Array[String]) }
     def self.validated_attribute_names(attr_node)
       attr_node.parameters(false).map do |obj|
-        case obj.type
-        when :symbol_literal then obj.jump(:ident, :op, :kw, :const).source
-        when :string_literal then obj.jump(:string_content).source
+        case obj
+        when YARD::Parser::Ruby::LiteralNode then obj[0][0].source
+        else raise YARD::Parser::UndocumentableError, obj.source
         end
       end
     end

spec/yard_sorbet/handlers/sig_handler_spec.rb

@@ -496,4 +496,21 @@
       end
     end
   end
+
+  describe 'Unparsable sigs' do
+    before do
+      allow(log).to receive(:warn)
+      YARD::Parser::SourceParser.parse_string(<<~RUBY)
+        class Test
+          CONST = :foo
+          sig { returns(Integer) }
+          attr_reader CONST
+        end
+      RUBY
+    end
+
+    it 'warn when parsing an attr* with a constant param' do
+      expect(log).to have_received(:warn).with(/Undocumentable CONST/).twice
+    end
+  end
 end