Ignore malformed mixins and overloads (castwide#862)

* Ignore malformed mixins

* Ignore malformed overload tags

Author: apiology

lib/solargraph/api_map.rb

@@ -249,9 +249,16 @@ def qualify tag, context_tag = ''
       return tag if ['Boolean', 'self', nil].include?(tag)
       type = ComplexType.parse(tag)
       return tag if type.literal?
-      context_type = ComplexType.parse(context_tag)
+
+      context_type = ComplexType.try_parse(context_tag)
+      return unless context_type
+
+      type = ComplexType.try_parse(tag)
+      return unless type
+
       fqns = qualify_namespace(type.rooted_namespace, context_type.rooted_namespace)
-      return nil if fqns.nil?
+      return unless fqns
+
       fqns + type.substring
     end
 

lib/solargraph/complex_type.rb

@@ -218,21 +218,6 @@ def bottom?
       @items.all?(&:bot?)
     end
 
-    private
-
-    # @todo This is a quick and dirty hack that forces `self` keywords
-    #   to reference an instance of their class and never the class itself.
-    #   This behavior may change depending on which result is expected
-    #   from YARD conventions. See https://github.com/lsegal/yard/issues/1257
-    # @param dst [String]
-    # @return [String]
-    def reduce_class dst
-      while dst =~ /^(Class|Module)\<(.*?)\>$/
-        dst = dst.sub(/^(Class|Module)\</, '').sub(/\>$/, '')
-      end
-      dst
-    end
-
     class << self
       # Parse type strings into a ComplexType.
       #
@@ -343,7 +328,7 @@ def parse *strings, partial: false
       def try_parse *strings
         parse *strings
       rescue ComplexTypeError => e
-        Solargraph.logger.info "Error parsing complex type: #{e.message}"
+        Solargraph.logger.info "Error parsing complex type `#{strings.join(', ')}`: #{e.message}"
         ComplexType::UNDEFINED
       end
     end
@@ -356,5 +341,20 @@ def try_parse *strings
     SELF = ComplexType.parse('self')
     BOOLEAN = ComplexType.parse('::Boolean')
     BOT = ComplexType.parse('bot')
+
+    private
+
+    # @todo This is a quick and dirty hack that forces `self` keywords
+    #   to reference an instance of their class and never the class itself.
+    #   This behavior may change depending on which result is expected
+    #   from YARD conventions. See https://github.com/lsegal/yard/issues/1257
+    # @param dst [String]
+    # @return [String]
+    def reduce_class dst
+      while dst =~ /^(Class|Module)\<(.*?)\>$/
+        dst = dst.sub(/^(Class|Module)\</, '').sub(/\>$/, '')
+      end
+      dst
+    end
   end
 end

lib/solargraph/pin/method.rb

@@ -288,7 +288,9 @@ def try_merge! pin
 
       # @return [::Array<Pin::Method>]
       def overloads
-        @overloads ||= docstring.tags(:overload).map do |tag|
+        # Ignore overload tags with nil parameters. If it's not an array, the
+        # tag's source is likely malformed.
+        @overloads ||= docstring.tags(:overload).select(&:parameters).map do |tag|
           Pin::Signature.new(
             generics,
             tag.parameters.map do |src|

spec/api_map_spec.rb

@@ -777,4 +777,11 @@ class Foo
     expect(baz).to be_a(Solargraph::Pin::Method)
     expect(baz.path).to eq('Foo#baz')
   end
+
+  it 'ignores malformed mixins' do
+    closure = Solargraph::Pin::Namespace.new(name: 'Foo', closure: Solargraph::Pin::ROOT_PIN, type: :class)
+    mixin = Solargraph::Pin::Reference::Include.new(name: 'defined?(DidYouMean::SpellChecker) && defined?(DidYouMean::Correctable)', closure: closure)
+    api_map = Solargraph::ApiMap.new(pins: [closure, mixin])
+    expect(api_map.get_method_stack('Foo', 'foo')).to be_empty
+  end
 end

spec/pin/method_spec.rb

@@ -569,5 +569,10 @@ def bar
       expect(pin.typify(api_map)).to be_undefined
       expect(pin.probe(api_map).simple_tags).to eq('Symbol, Float, String, Integer')
     end
+
+    it 'ignores malformed overload tags' do
+      pin = Solargraph::Pin::Method.new(name: 'example', comments: "@overload\n  @param")
+      expect(pin.overloads).to be_empty
+    end
   end
 end