solargraph 0.39.0 → 0.40.0

data/lib/solargraph/type_checker.rb

@@ -73,15 +73,15 @@ module Solargraph
     # @return [Array<Problem>]
     def method_tag_problems
       result = []
-      # @param pin [Pin::BaseMethod]
-      source_map.pins.select { |pin| pin.is_a?(Pin::BaseMethod) }.each do |pin|
+      # @param pin [Pin::Method]
+      source_map.pins_by_class(Pin::Method).each do |pin|
         result.concat method_return_type_problems_for(pin)
         result.concat method_param_type_problems_for(pin)
       end
       result
     end
 
-    # @param pin [Pin::BaseMethod]
+    # @param pin [Pin::Method]
     # @return [Array<Problem>]
     def method_return_type_problems_for pin
       result = []
@@ -115,7 +115,7 @@ module Solargraph
       pin.location && source_map.source.comment_at?(pin.location.range.ending)
     end
 
-    # @param pin [Pin::BaseMethod]
+    # @param pin [Pin::Method]
     # @return [Array<Problem>]
     def method_param_type_problems_for pin
       stack = api_map.get_method_stack(pin.namespace, pin.name, scope: pin.scope)
@@ -147,14 +147,12 @@ module Solargraph
       result = []
       all_variables.each do |pin|
         if pin.return_type.defined?
-          # @todo Somwhere in here we still need to determine if the variable is defined by an external call
           declared = pin.typify(api_map)
           if declared.defined?
             if rules.validate_tags?
               inferred = pin.probe(api_map)
               if inferred.undefined?
                 next if rules.ignore_all_undefined?
-                # next unless internal?(pin) # @todo This might be redundant for variables
                 if declared_externally?(pin)
                   ignored_pins.push pin
                 else
@@ -172,7 +170,6 @@ module Solargraph
             result.push Problem.new(pin.location, "Unresolved type #{pin.return_type} for variable #{pin.name}", pin: pin)
           end
         else
-          # @todo Check if the variable is defined by an external call
           inferred = pin.probe(api_map)
           if inferred.undefined? && declared_externally?(pin)
             ignored_pins.push pin
@@ -184,8 +181,7 @@ module Solargraph
 
     # @return [Array<Pin::BaseVariable>]
     def all_variables
-      source_map.pins.select { |pin| pin.is_a?(Pin::BaseVariable) } +
-        source_map.locals.select { |pin| pin.is_a?(Pin::LocalVariable) }
+      source_map.pins_by_class(Pin::BaseVariable) + source_map.locals.select { |pin| pin.is_a?(Pin::LocalVariable) }
     end
 
     def const_problems
@@ -228,7 +224,7 @@ module Solargraph
             base = base.base
           end
           closest = found.typify(api_map) if found
-          if !found || closest.defined? || internal?(found)
+          if !found || (closest.defined? && internal_or_core?(found))
             unless ignored_pins.include?(found)
               result.push Problem.new(location, "Unresolved call to #{missing.links.last.word}")
               @marked_ranges.push rng
@@ -245,10 +241,14 @@ module Solargraph
       base = chain
       until base.links.length == 1 && base.undefined?
         pins = base.define(api_map, block_pin, locals)
-        if pins.first.is_a?(Pin::BaseMethod)
-          # @type [Pin::BaseMethod]
+        if pins.first.is_a?(Pin::Method)
+          # @type [Pin::Method]
           pin = pins.first
-          ap = arity_problems_for(pin, base.links.last.arguments, location)
+          ap = if base.links.last.is_a?(Solargraph::Source::Chain::ZSuper)
+            arity_problems_for(pin, fake_args_for(block_pin), location)
+          else
+            arity_problems_for(pin, base.links.last.arguments, location)
+          end
           unless ap.empty?
             result.concat ap
             break
@@ -310,7 +310,6 @@ module Solargraph
             end
           else
             if par.decl == :kwarg
-              # @todo Problem: missing required keyword argument
               result.push Problem.new(location, "Call to #{pin.path} is missing keyword argument #{par.name}")
             end
           end
@@ -357,9 +356,14 @@ module Solargraph
 
     # @param pin [Pin::Base]
     def internal? pin
+      return false if pin.nil?
       pin.location && api_map.bundled?(pin.location.filename)
     end
 
+    def internal_or_core? pin
+      internal?(pin) || api_map.yard_map.core_pins.include?(pin) || api_map.yard_map.stdlib_pins.include?(pin)
+    end
+
     # @param pin [Pin::Base]
     def external? pin
       !internal? pin
@@ -392,7 +396,7 @@ module Solargraph
       true
     end
 
-    # @param pin [Pin::BaseMethod]
+    # @param pin [Pin::Method]
     def arity_problems_for(pin, arguments, location)
       return [] unless pin.explicit?
       return [] if pin.parameters.empty? && arguments.empty?
@@ -407,29 +411,29 @@ module Solargraph
       if unchecked.empty? && pin.parameters.any? { |param| param.decl == :kwarg }
         return [Problem.new(location, "Missing keyword arguments to #{pin.path}")]
       end
+      settled_kwargs = 0
       unless unchecked.empty?
         kwargs = convert_hash(unchecked.last.node)
-        # unless kwargs.empty?
-          if pin.parameters.any? { |param| [:kwarg, :kwoptarg].include?(param.decl) || param.kwrestarg? }
-            if kwargs.empty?
-              add_params += 1
-            else
-              unchecked.pop
-              pin.parameters.each do |param|
-                next unless param.keyword?
-                if kwargs.key?(param.name.to_sym)
-                  kwargs.delete param.name.to_sym
-                elsif param.decl == :kwarg
-                  return [Problem.new(location, "Missing keyword argument #{param.name} to #{pin.path}")]
-                end
-              end
-              kwargs.clear if pin.parameters.any?(&:kwrestarg?)
-              unless kwargs.empty?
-                return [Problem.new(location, "Unrecognized keyword argument #{kwargs.keys.first} to #{pin.path}")]
+        if pin.parameters.any? { |param| [:kwarg, :kwoptarg].include?(param.decl) || param.kwrestarg? }
+          if kwargs.empty?
+            add_params += 1
+          else
+            unchecked.pop
+            pin.parameters.each do |param|
+              next unless param.keyword?
+              if kwargs.key?(param.name.to_sym)
+                kwargs.delete param.name.to_sym
+                settled_kwargs += 1
+              elsif param.decl == :kwarg
+                return [Problem.new(location, "Missing keyword argument #{param.name} to #{pin.path}")]
               end
             end
+            kwargs.clear if pin.parameters.any?(&:kwrestarg?)
+            unless kwargs.empty?
+              return [Problem.new(location, "Unrecognized keyword argument #{kwargs.keys.first} to #{pin.path}")]
+            end
           end
-        # end
+        end
       end
       req = required_param_count(pin)
       if req + add_params < unchecked.length
@@ -440,23 +444,18 @@ module Solargraph
           return []
         end
         return [Problem.new(location, "Too many arguments to #{pin.path}")]
-      elsif unchecked.length < req && (arguments.empty? || !arguments.last.splat?)
+      elsif unchecked.length < req - settled_kwargs && (arguments.empty? || !arguments.last.splat?)
         return [Problem.new(location, "Not enough arguments to #{pin.path}")]
       end
       []
     end
 
-    # @param pin [Pin::BaseMethod]
+    # @param pin [Pin::Method]
     def required_param_count(pin)
-      count = 0
-      pin.parameters.each do |param|
-        break unless param.decl == :arg
-        count += 1
-      end
-      count
+      pin.parameters.sum { |param| %i[arg kwarg].include?(param.decl) ? 1 : 0 }
     end
 
-    # @param pin [Pin::BaseMethod]
+    # @param pin [Pin::Method]
     def optional_param_count(pin)
       count = 0
       pin.parameters.each do |param|
@@ -470,5 +469,25 @@ module Solargraph
       pin.docstring.has_tag?(:abstract) ||
         (pin.closure && pin.closure.docstring.has_tag?(:abstract))
     end
+
+    def fake_args_for(pin)
+      args = []
+      with_opts = false
+      with_block = false
+      pin.parameters.each do |pin|
+        if [:kwarg, :kwoptarg, :kwrestarg].include?(pin.decl)
+          with_opts = true
+        elsif pin.decl == :block
+          with_block = true
+        elsif pin.decl == :restarg
+          args.push Solargraph::Source::Chain.new([Solargraph::Source::Chain::Variable.new(pin.name)], nil, true)
+        else
+          args.push Solargraph::Source::Chain.new([Solargraph::Source::Chain::Variable.new(pin.name)])
+        end
+      end
+      args.push Solargraph::Parser.chain_string('{}') if with_opts
+      args.push Solargraph::Parser.chain_string('&') if with_block
+      args
+    end
   end
 end

data/lib/solargraph/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Solargraph
-  VERSION = '0.39.0'
+  VERSION = '0.40.0'
 end

data/lib/solargraph/views/_name_type_tag.erb

@@ -2,7 +2,7 @@
 <% unless tag.types.nil? or tag.types.empty? %>
 	[<%= escape(tag.types.join(', ')) %>]
 <% end %>
-<% unless tag.text.empty? %>
+<% unless tag.text.nil? || tag.text.empty? %>
 	<% unless (tag.name.nil? or tag.name.empty?) and (tag.types.nil? or tag.types.empty?) %>
 		-
 	<% end %>

data/lib/solargraph/workspace.rb

@@ -170,7 +170,7 @@ module Solargraph
         Dir.chdir base do
           begin
             # @type [Gem::Specification]
-            spec = eval(File.read(file), binding, file)
+            spec = eval(File.read(file), TOPLEVEL_BINDING, file)
             next unless Gem::Specification === spec
             @gemnames.push spec.name
             result.concat(spec.require_paths.map { |path| File.join(base, path) })

data/lib/solargraph/yard_map/core_fills.rb

@@ -0,0 +1,185 @@
+module Solargraph
+  class YardMap
+    module CoreFills
+      Override = Pin::Reference::Override
+
+      KEYWORDS = [
+        '__ENCODING__', '__LINE__', '__FILE__', 'BEGIN', 'END', 'alias', 'and',
+        'begin', 'break', 'case', 'class', 'def', 'defined?', 'do', 'else',
+        'elsif', 'end', 'ensure', 'false', 'for', 'if', 'in', 'module', 'next',
+        'nil', 'not', 'or', 'redo', 'rescue', 'retry', 'return', 'self', 'super',
+        'then', 'true', 'undef', 'unless', 'until', 'when', 'while', 'yield'
+      ].map { |k| Pin::Keyword.new(k) }
+
+      methods_with_yieldparam_subtypes = %w[
+        Array#each Array#map Array#map! Array#any? Array#all? Array#index
+        Array#keep_if Array#delete_if
+        Enumerable#each_entry Enumerable#map Enumerable#any? Enumerable#all?
+        Enumerable#select Enumerable#reject
+        Set#each
+      ]
+
+      OVERRIDES = [
+        Override.method_return('Array#concat', 'Array'),
+        Override.method_return('Array#keep_if', 'self'),
+        Override.method_return('Array#delete_if', 'self'),
+        Override.from_comment('Array#map', %(
+@overload map(&block)
+  @return [Array]
+@overload map()
+  @return [Enumerator]
+        )),
+        Override.from_comment('Array#reject', %(
+@overload reject(&block)
+  @return [self]
+@overload reject()
+  @return [Enumerator]
+        )),
+        Override.method_return('Array#reverse', 'self', delete: ['overload']),
+        Override.from_comment('Array#select', %(
+@overload select(&block)
+  @return [self]
+@overload select()
+  @return [Enumerator]
+        )),
+        Override.from_comment('Array#[]', %(
+@overload [](range)
+  @param range [Range]
+  @return [self]
+@overload [](num1, num2)
+  @param num1 [Integer]
+  @param num2 [Integer]
+  @return [self]
+@overload [](num)
+  @param num [Integer]
+  @return_single_parameter
+@return_single_parameter
+        )),
+        Override.from_comment('Array#first', %(
+@overload first(num)
+  @param num [Integer]
+  @return [self]
+@return_single_parameter
+        )),
+        Override.from_comment('Array#last', %(
+@overload last(num)
+  @param num [Integer]
+  @return [self]
+@return_single_parameter
+        )),
+        Override.method_return('Array#map', 'Array'),
+        Override.method_return('Array#uniq', 'self'),
+        Override.method_return('Array#zip', 'Array, nil'),
+
+        Override.from_comment('BasicObject#==', %(
+@param other [BasicObject]
+@return [Boolean]
+        )),
+        Override.method_return('BasicObject#initialize', 'void'),
+
+        Override.method_return('Class#new', 'self'),
+        Override.method_return('Class.new', 'Class<Object>'),
+        Override.method_return('Class#allocate', 'self'),
+        Override.method_return('Class.allocate', 'Class<Object>'),
+
+        Override.method_return('Enumerable#select', 'self'),
+
+        Override.method_return('File.absolute_path', 'String'),
+        Override.method_return('File.basename', 'String'),
+        Override.method_return('File.dirname', 'String'),
+        Override.method_return('File.extname', 'String'),
+        Override.method_return('File.join', 'String'),
+
+        Override.from_comment('Float#+', %(
+@param y [Numeric]
+@return [Numeric]
+        )),
+
+        Override.from_comment('Hash#[]', %(
+@return_value_parameter
+        )),
+
+        # @todo This override isn't robust enough. It needs to allow for
+        #   parameterized Hash types, e.g., [Hash{Symbol => String}].
+        Override.from_comment('Hash#[]=', %(
+@param_tuple
+        )),
+
+        Override.method_return('Hash#merge', 'Hash'),
+
+        Override.from_comment('Integer#+', %(
+@param y [Numeric]
+@return [Numeric]
+        )),
+
+        Override.method_return('Kernel#puts', 'nil'),
+
+        Override.from_comment('Numeric#+', %(
+@param y [Numeric]
+@return [Numeric]
+        )),
+
+        Override.method_return('Object#!', 'Boolean'),
+        Override.method_return('Object#clone', 'self', delete: [:overload]),
+        Override.method_return('Object#dup', 'self', delete: [:overload]),
+        Override.method_return('Object#freeze', 'self', delete: [:overload]),
+        Override.method_return('Object#inspect', 'String'),
+        Override.method_return('Object#taint', 'self'),
+        Override.method_return('Object#to_s', 'String'),
+        Override.method_return('Object#untaint', 'self'),
+        Override.from_comment('Object#tap', %(
+@return [self]
+@yieldparam [self]
+        )),
+
+        Override.from_comment('STDERR', %(
+@type [IO]
+        )),
+
+        Override.from_comment('STDIN', %(
+@type [IO]
+        )),
+
+        Override.from_comment('STDOUT', %(
+@type [IO]
+        )),
+
+        Override.method_return('String#freeze', 'self'),
+        Override.method_return('String#split', 'Array<String>'),
+        Override.method_return('String#lines', 'Array<String>'),
+        Override.from_comment('String#each_line', %(
+@yieldparam [String]
+        )),
+        Override.from_comment('String.new', %(
+@overload new(*)
+  @return [self]
+      ))
+      ].concat(
+        methods_with_yieldparam_subtypes.map do |path|
+          Override.from_comment(path, %(
+@yieldparam_single_parameter
+            ))
+        end
+      )
+
+      PINS = [
+        Pin::Reference::Superclass.new(closure: Pin::Namespace.new(name: 'File'), name: 'IO'),
+        Pin::Reference::Superclass.new(closure: Pin::Namespace.new(name: 'Integer'), name: 'Numeric'),
+        Pin::Reference::Superclass.new(closure: Pin::Namespace.new(name: 'Float'), name: 'Numeric')
+      ].concat(
+        # HACK: Add Errno exception classes
+        begin
+          errno = Solargraph::Pin::Namespace.new(name: 'Errno')
+          result = []
+          Errno.constants.each do |const|
+            result.push Solargraph::Pin::Namespace.new(type: :class, name: const.to_s, closure: errno)
+            result.push Solargraph::Pin::Reference::Superclass.new(closure: result.last, name: 'SystemCallError')
+          end
+          result
+        end
+      )
+
+      ALL = KEYWORDS + PINS + OVERRIDES
+    end
+  end
+end

data/lib/solargraph/yard_map/helpers.rb

@@ -0,0 +1,16 @@
+module Solargraph
+  class YardMap
+    module Helpers
+      module_function
+
+      # @param code_object [YARD::CodeObjects::Base]
+      # @param spec [Gem::Specification]
+      # @return [Solargraph::Location, nil]
+      def object_location code_object, spec
+        return nil if spec.nil? || code_object.nil? || code_object.file.nil? || code_object.line.nil?
+        file = File.join(spec.full_gem_path, code_object.file)
+        Solargraph::Location.new(file, Solargraph::Range.from_to(code_object.line - 1, 0, code_object.line - 1, 0))
+      end
+    end
+  end
+end

data/lib/solargraph/{pin/yard_pin/constant.rb → yard_map/mapper/to_constant.rb}

@@ -1,17 +1,17 @@
 # frozen_string_literal: true
 
 module Solargraph
-  module Pin
-    module YardPin
-      class Constant < Pin::Constant
-        include YardMixin
+  class YardMap
+    class Mapper
+      module ToConstant
+        extend YardMap::Helpers
 
-        def initialize code_object, closure = nil, spec = nil
+        def self.make code_object, closure = nil, spec = nil
           closure ||= Solargraph::Pin::Namespace.new(
             name: code_object.namespace.to_s,
             gates: [code_object.namespace.to_s]
           )
-          super(
+          Pin::Constant.new(
             location: object_location(code_object, spec),
             closure: closure,
             name: code_object.name.to_s,

data/lib/solargraph/yard_map/mapper/to_method.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module Solargraph
+  class YardMap
+    class Mapper
+      module ToMethod
+        extend YardMap::Helpers
+
+        def self.make code_object, name = nil, scope = nil, visibility = nil, closure = nil, spec = nil
+          closure ||= Solargraph::Pin::Namespace.new(
+            name: code_object.namespace.to_s,
+            gates: [code_object.namespace.to_s]
+          )
+          location = object_location(code_object, spec)
+          comments = code_object.docstring ? code_object.docstring.all.to_s : ''
+          Pin::Method.new(
+            location: location,
+            closure: closure,
+            name: name || code_object.name.to_s,
+            comments: comments,
+            scope: scope || code_object.scope,
+            visibility: visibility || code_object.visibility,
+            parameters: get_parameters(code_object, location, comments),
+            explicit: code_object.is_explicit?
+          )
+        end
+
+        class << self
+          private
+
+          # @param code_object [YARD::CodeObjects::Base]
+          # @return [Array<Solargraph::Pin::Parameter>]
+          def get_parameters code_object, location, comments
+            return [] unless code_object.is_a?(YARD::CodeObjects::MethodObject)
+            # HACK: Skip `nil` and `self` parameters that are sometimes emitted
+            # for methods defined in C
+            # See https://github.com/castwide/solargraph/issues/345
+            code_object.parameters.select { |a| a[0] && a[0] != 'self' }.map do |a|
+              Solargraph::Pin::Parameter.new(
+                location: location,
+                closure: self,
+                comments: comments,
+                name: arg_name(a),
+                presence: nil,
+                decl: arg_type(a),
+                asgn_code: a[1]
+              )
+            end
+          end
+
+          # @param a [Array]
+          # @return [String]
+          def arg_name a
+            a[0].gsub(/[^a-z0-9_]/i, '')
+          end
+
+          # @param a [Array]
+          # @return [::Symbol]
+          def arg_type a
+            if a[0].start_with?('**')
+              :kwrestarg
+            elsif a[0].start_with?('*')
+              :restarg
+            elsif a[0].start_with?('&')
+              :blockarg
+            elsif a[0].end_with?(':')
+              a[1] ? :kwoptarg : :kwarg
+            elsif a[1]
+              :optarg
+            else
+              :arg
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/solargraph/{pin/yard_pin/namespace.rb → yard_map/mapper/to_namespace.rb}

@@ -1,18 +1,18 @@
 # frozen_string_literal: true
 
 module Solargraph
-  module Pin
-    module YardPin
-      class Namespace < Pin::Namespace
-        include YardMixin
+  class YardMap
+    class Mapper
+      module ToNamespace
+        extend YardMap::Helpers
 
-        def initialize code_object, spec, closure = nil
+        def self.make code_object, spec, closure = nil
           closure ||= Solargraph::Pin::Namespace.new(
             name: code_object.namespace.to_s,
             closure: Pin::ROOT_PIN,
             gates: [code_object.namespace.to_s]
           )
-          super(
+          Pin::Namespace.new(
             location: object_location(code_object, spec),
             name: code_object.name.to_s,
             comments: code_object.docstring ? code_object.docstring.all.to_s : '',

data/lib/solargraph/yard_map/mapper.rb

@@ -3,6 +3,10 @@
 module Solargraph
   class YardMap
     class Mapper
+      autoload :ToMethod, 'solargraph/yard_map/mapper/to_method'
+      autoload :ToNamespace, 'solargraph/yard_map/mapper/to_namespace'
+      autoload :ToConstant, 'solargraph/yard_map/mapper/to_constant'
+
       # @param code_objects [Array<YARD::CodeObjects::Base>]
       # @param spec [Gem::Specification]
       def initialize code_objects, spec = nil
@@ -17,25 +21,30 @@ module Solargraph
         @code_objects.each do |co|
           @pins.concat generate_pins co
         end
+        # Some yardocs contain documentation for dependencies that can be
+        # ignored here. The YardMap will load dependencies separately.
+        @pins.keep_if { |pin| pin.location.nil? || File.file?(pin.location.filename) } if @spec
         @pins
       end
 
+      private
+
       # @param code_object [YARD::CodeObjects::Base]
       # @return [Array<Pin::Base>]
       def generate_pins code_object
         result = []
         if code_object.is_a?(YARD::CodeObjects::NamespaceObject)
-          nspin = Solargraph::Pin::YardPin::Namespace.new(code_object, @spec, @namespace_pins[code_object.namespace.to_s])
+          nspin = ToNamespace.make(code_object, @spec, @namespace_pins[code_object.namespace.to_s])
           @namespace_pins[code_object.path] = nspin
           result.push nspin
           if code_object.is_a?(YARD::CodeObjects::ClassObject) and !code_object.superclass.nil?
             # This method of superclass detection is a bit of a hack. If
             # the superclass is a Proxy, it is assumed to be undefined in its
             # yardoc and converted to a fully qualified namespace.
-            if code_object.superclass.is_a?(YARD::CodeObjects::Proxy)
-              superclass = "::#{code_object.superclass}"
+            superclass = if code_object.superclass.is_a?(YARD::CodeObjects::Proxy)
+              "::#{code_object.superclass}"
             else
-              superclass = code_object.superclass.to_s
+              code_object.superclass.to_s
             end
             result.push Solargraph::Pin::Reference::Superclass.new(name: superclass, closure: nspin)
           end
@@ -52,14 +61,14 @@ module Solargraph
           closure = @namespace_pins[code_object.namespace.to_s]
           if code_object.name == :initialize && code_object.scope == :instance
             # @todo Check the visibility of <Class>.new
-            result.push Solargraph::Pin::YardPin::Method.new(code_object, 'new', :class, :public, closure, @spec)
-            result.push Solargraph::Pin::YardPin::Method.new(code_object, 'initialize', :instance, :private, closure, @spec)
+            result.push ToMethod.make(code_object, 'new', :class, :public, closure, @spec)
+            result.push ToMethod.make(code_object, 'initialize', :instance, :private, closure, @spec)
           else
-            result.push Solargraph::Pin::YardPin::Method.new(code_object, nil, nil, nil, closure, @spec)
+            result.push ToMethod.make(code_object, nil, nil, nil, closure, @spec)
           end
         elsif code_object.is_a?(YARD::CodeObjects::ConstantObject)
           closure = @namespace_pins[code_object.namespace]
-          result.push Solargraph::Pin::YardPin::Constant.new(code_object, closure, @spec)
+          result.push ToConstant.make(code_object, closure, @spec)
         end
         result
       end