solargraph 0.33.2 → 0.34.0

data/lib/solargraph/source_map/node_processor/block_node.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Solargraph
   class SourceMap
     module NodeProcessor

data/lib/solargraph/source_map/node_processor/casgn_node.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Solargraph
   class SourceMap
     module NodeProcessor

data/lib/solargraph/source_map/node_processor/cvasgn_node.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Solargraph
   class SourceMap
     module NodeProcessor

data/lib/solargraph/source_map/node_processor/def_node.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Solargraph
   class SourceMap
     module NodeProcessor

data/lib/solargraph/source_map/node_processor/defs_node.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Solargraph
   class SourceMap
     module NodeProcessor

data/lib/solargraph/source_map/node_processor/gvasgn_node.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Solargraph
   class SourceMap
     module NodeProcessor

data/lib/solargraph/source_map/node_processor/ivasgn_node.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Solargraph
   class SourceMap
     module NodeProcessor
@@ -14,7 +16,7 @@ module Solargraph
           if region.visibility == :module_function
             here = get_node_start_position(node)
             named_path = named_path_pin(here)
-            if named_path.kind == Pin::METHOD
+            if named_path.is_a?(Pin::BaseMethod)
               pins.push Solargraph::Pin::InstanceVariable.new(
                 location: loc,
                 closure: Pin::Namespace.new(type: :module, closure: region.closure.closure, name: region.closure.name),

data/lib/solargraph/source_map/node_processor/lvasgn_node.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Solargraph
   class SourceMap
     module NodeProcessor

data/lib/solargraph/source_map/node_processor/namespace_node.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Solargraph
   class SourceMap
     module NodeProcessor
@@ -14,7 +16,8 @@ module Solargraph
             closure: region.closure,
             name: unpack_name(node.children[0]),
             comments: comments_for(node),
-            visibility: :public
+            visibility: :public,
+            gates: region.closure.gates.freeze
           )
           pins.push nspin
           unless sc.nil?

data/lib/solargraph/source_map/node_processor/orasgn_node.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Solargraph
   class SourceMap
     module NodeProcessor

data/lib/solargraph/source_map/node_processor/resbody_node.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Solargraph
   class SourceMap
     module NodeProcessor

data/lib/solargraph/source_map/node_processor/sclass_node.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Solargraph
   class SourceMap
     module NodeProcessor

data/lib/solargraph/source_map/node_processor/send_node.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Solargraph
   class SourceMap
     module NodeProcessor
@@ -9,7 +11,7 @@ module Solargraph
                 node.children[2..-1].each do |child|
                   next unless child.is_a?(AST::Node) && (child.type == :sym || child.type == :str)
                   name = child.children[0].to_s
-                  matches = pins.select{ |pin| [Pin::METHOD, Pin::ATTRIBUTE].include?(pin.kind) && pin.name == name && pin.namespace == region.closure.full_context.namespace && pin.context.scope == (region.scope || :instance)}
+                  matches = pins.select{ |pin| pin.is_a?(Pin::BaseMethod) && pin.name == name && pin.namespace == region.closure.full_context.namespace && pin.context.scope == (region.scope || :instance)}
                   matches.each do |pin|
                     # @todo Smelly instance variable access
                     pin.instance_variable_set(:@visibility, node.children[1])
@@ -33,10 +35,12 @@ module Solargraph
               process_private_constant
             elsif node.children[1] == :alias_method && node.children[2] && node.children[2] && node.children[2].type == :sym && node.children[3] && node.children[3].type == :sym
               process_alias_method
-            elsif node.children[1] == :private_class_method && node.children[2].kind_of?(AST::Node)
+            elsif node.children[1] == :private_class_method && node.children[2].is_a?(AST::Node)
               # Processing a private class can potentially handle children on its own
               return if process_private_class_method
             end
+          elsif node.children[1] == :require && node.children[0].to_s == '(const nil :Bundler)'
+            pins.push Pin::Reference::Require.new(Solargraph::Location.new(region.filename, Solargraph::Range.from_to(0, 0, 0, 0)), 'bundler/require')
           end
           process_children
         end
@@ -76,7 +80,7 @@ module Solargraph
 
         # @return [void]
         def process_include
-          if node.children[2].kind_of?(AST::Node) && node.children[2].type == :const
+          if node.children[2].is_a?(AST::Node) && node.children[2].type == :const
             cp = region.closure
             node.children[2..-1].each do |i|
               pins.push Pin::Reference::Include.new(
@@ -110,8 +114,9 @@ module Solargraph
 
         # @return [void]
         def process_require
-          if node.children[2].kind_of?(AST::Node) && node.children[2].type == :str
-            pins.push Pin::Reference::Require.new(get_node_location(node), node.children[2].children[0].to_s)
+          if node.children[2].is_a?(AST::Node) && node.children[2].type == :str
+            path = node.children[2].children[0].to_s
+            pins.push Pin::Reference::Require.new(get_node_location(node), path)
           end
         end
 
@@ -146,7 +151,7 @@ module Solargraph
                   args: ref.parameters,
                   node: ref.node)
                 pins.push mm, cm
-                pins.select{|pin| pin.kind == Pin::INSTANCE_VARIABLE && pin.closure.path == ref.path}.each do |ivar|
+                pins.select{|pin| pin.is_a?(Pin::InstanceVariable) && pin.closure.path == ref.path}.each do |ivar|
                   pins.delete ivar
                   pins.push Solargraph::Pin::InstanceVariable.new(
                     location: ivar.location,

data/lib/solargraph/source_map/node_processor/sym_node.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Solargraph
   class SourceMap
     module NodeProcessor

data/lib/solargraph/source_map/region.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Solargraph
   class SourceMap
     # Data used by the NodeProcessor library to track context at various

data/lib/solargraph/type_checker.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Solargraph
   # A static analysis tool for validating data types.
   #
@@ -38,6 +40,13 @@ module Solargraph
     def param_type_problems
       result = []
       smap = api_map.source_map(filename)
+      smap.pins.select { |pin| pin.is_a?(Pin::Method) }.each do |pin|
+        if pin.parameters.empty?
+          pin.docstring.tags(:param).each do |tag|
+            result.push Problem.new(pin.location, "#{pin.name} has unknown @param #{tag.name}", pin: pin)
+          end
+        end
+      end
       smap.locals.select { |pin| pin.is_a?(Solargraph::Pin::Parameter) }.each do |par|
         next unless par.closure.is_a?(Solargraph::Pin::Method)
         result.concat check_param_tags(par.closure)
@@ -106,7 +115,7 @@ module Solargraph
     # @param pin [Solargraph::Pin::Base]
     # @return [Array<Problem>]
     def confirm_return_type pin
-      tagged = pin.typify(api_map)
+      tagged = pin.typify(api_map).self_to(pin.namespace)
       return [] if tagged.void? || tagged.undefined? || pin.is_a?(Pin::Attribute)
       probed = pin.probe(api_map)
       return [] if probed.undefined?
@@ -172,7 +181,11 @@ module Solargraph
           cursor = 0
           curtype = nil
           node.children[2..-1].each_with_index do |arg, index|
-            curtype = ptypes[cursor] if curtype.nil? || curtype == :arg
+            if pin.is_a?(Pin::Attribute)
+              curtype = ParamDef.new('value', :arg)
+            else
+              curtype = ptypes[cursor] if curtype.nil? || curtype == :arg
+            end
             if curtype.nil?
               if pin.parameters[index].nil?
                 result.push Problem.new(Solargraph::Location.new(filename, Solargraph::Range.from_node(node)), "Not enough arguments sent to #{pin.path}")
@@ -185,16 +198,10 @@ module Solargraph
                 arg.children.each do |pair|
                   sym = pair.children[0].children[0].to_s
                   partype = params[pin.parameter_names[index]]
-                  if partype.nil?
-                    if report_location?(pin.location)
-                      unless ptypes.map(&:type).include?(:kwrestarg)
-                        result.push Problem.new(Solargraph::Location.new(filename, Solargraph::Range.from_node(node)), "No @param type for #{pin.parameter_names[index]} in #{pin.path}")
-                      end
-                    end
-                  else
+                  if partype
                     chain = Solargraph::Source::NodeChainer.chain(pair.children[1], filename)
                     argtype = chain.infer(api_map, block, locals)
-                    if argtype.tag != partype.tag
+                    if argtype.tag != partype.tag && !api_map.super_and_sub?(partype.tag.to_s, argtype.tag.to_s)
                       result.push Problem.new(Solargraph::Location.new(filename, Solargraph::Range.from_node(node)), "Wrong parameter type for #{pin.path}: #{pin.parameter_names[index]} expected #{partype.tag}, received #{argtype.tag}")
                     end
                   end
@@ -203,19 +210,21 @@ module Solargraph
                 result.push Problem.new(Solargraph::Location.new(filename, Solargraph::Range.from_node(node)), "Can't handle splat in #{pin.parameter_names[index]} #{pin.path}")
                 break if curtype != :arg && ptypes.map(&:type).include?(:restarg)
               else
-                partype = params[pin.parameter_names[index]]
-                if partype.nil?
-                  if report_location?(pin.location)
-                    result.push Problem.new(Solargraph::Location.new(filename, Solargraph::Range.from_node(node)), "No @param type for #{pin.parameter_names[index]} in #{pin.path}")
-                  end
+                if pin.is_a?(Pin::Attribute)
+                  partype = pin.return_type
                 else
+                  partype = params[pin.parameter_names[index]]
+                end
+                if partype
                   arg = chain.links.last.arguments[index]
                   if arg.nil?
                     result.push Problem.new(Solargraph::Location.new(filename, Solargraph::Range.from_node(node)), "Wrong number of arguments to #{pin.path}")
                   else
                     argtype = arg.infer(api_map, block, locals)
-                    if argtype.tag != partype.tag
-                      result.push Problem.new(Solargraph::Location.new(filename, Solargraph::Range.from_node(node)), "Wrong parameter type for #{pin.path}: #{pin.parameter_names[index]} expected #{partype.tag}, received #{argtype.tag}")
+                    if !arg_to_duck(argtype, partype)
+                      if argtype.tag != partype.tag && !api_map.super_and_sub?(partype.tag.to_s, argtype.tag.to_s)
+                        result.push Problem.new(Solargraph::Location.new(filename, Solargraph::Range.from_node(node)), "Wrong parameter type for #{pin.path}: #{pin.parameter_names[index]} expected #{partype.tag}, received #{argtype.tag}")
+                      end
                     end
                   end
                 end
@@ -233,6 +242,15 @@ module Solargraph
       result
     end
 
+    def arg_to_duck arg, par
+      return false unless par.duck_type?
+      meths = api_map.get_complex_type_methods(arg).map(&:name)
+      par.each do |quack|
+        return false unless meths.include?(quack.to_s[1..-1])
+      end
+      true
+    end
+
     # @param pin [Pin::Base]
     # @return [Hash]
     def param_tags_from pin

data/lib/solargraph/type_checker/param_def.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Solargraph
   class TypeChecker
     # Data about a method parameter definition. This is the information from

data/lib/solargraph/type_checker/problem.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Solargraph
   class TypeChecker
     # A problem reported by TypeChecker.

data/lib/solargraph/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Solargraph
-  VERSION = '0.33.2'
+  VERSION = '0.34.0'
 end

data/lib/solargraph/views/document.erb

@@ -1,7 +1,7 @@
 <% objects.reverse.each do |object| %>
     <h1>
         <%= object.name %>
-        <% if object.kind_of?(YARD::CodeObjects::MethodObject) and !object.parameters.empty? %>
+        <% if object.is_a?(YARD::CodeObjects::MethodObject) and !object.parameters.empty? %>
             <small>(<%= object.parameters.map {|p| "#{p[0]}#{p[1] and p[0].end_with?(':') ? ' ' : (p[1] ? ' = ' : '')}#{p[1]}"}.join(', ') %>)</small>
         <% end %>
     </h1>
@@ -15,9 +15,9 @@
             <% end %>
         </ul>
     <% end %>
-    <% if object.kind_of?(YARD::CodeObjects::NamespaceObject) %>
+    <% if object.is_a?(YARD::CodeObjects::NamespaceObject) %>
         <%= erb :_namespace, layout: false, locals: {object: object} %>
-    <% elsif object.kind_of?(YARD::CodeObjects::MethodObject) %>
+    <% elsif object.is_a?(YARD::CodeObjects::MethodObject) %>
         <%= erb :_method, layout: false, locals: {object: object} %>
     <% end %>
 <% end %>

data/lib/solargraph/views/environment.erb

@@ -18,6 +18,9 @@
     <li>
       Ruby Version: <%= RUBY_VERSION %>
     </li>
+    <li>
+      RuboCop Version: <%= RuboCop::Version::STRING %>
+    </li>
   </ul>
   <h2>
     Solargraph

data/lib/solargraph/workspace.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Solargraph
   # A workspace consists of the files in a project's directory and the
   # project's configuration. It provides a Source for each file to be used
@@ -113,7 +115,9 @@ module Solargraph
     # @return [Array<String>]
     def gemspecs
       return [] if directory.empty? || directory == '*'
-      @gemspecs ||= Dir[File.join(directory, '**/*.gemspec')]
+      @gemspecs ||= Dir[File.join(directory, '**/*.gemspec')].select do |gs|
+        config.allow? gs
+      end
     end
 
     # Synchronize the workspace from the provided updater.

data/lib/solargraph/workspace/config.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'yaml'
 
 module Solargraph
@@ -56,6 +58,12 @@ module Solargraph
         @excluded ||= process_exclusions(@raw_data['exclude'])
       end
 
+      def allow? filename
+        filename.start_with?(directory) && 
+          !excluded.include?(filename) &&
+          excluded_directories.none? { |d| filename.start_with?(d) }
+      end
+
       # The calculated array of (included - excluded) files in the workspace.
       #
       # @return [Array<String>]
@@ -157,6 +165,12 @@ module Solargraph
       def glob_to_directory glob
         glob.gsub(/(\/\*|\/\*\*\/\*\*?)$/, '')
       end
+
+      def excluded_directories
+        @raw_data['exclude']
+          .select { |g| glob_is_directory?(g) }
+          .map { |g| File.join(directory, glob_to_directory(g)) }
+      end
     end
   end
 end

data/lib/solargraph/yard_map.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 require 'yard'
+require 'bundler'
 
 module Solargraph
   # The YardMap provides access to YARD documentation for the Ruby core, the
@@ -9,6 +12,7 @@ module Solargraph
     autoload :CoreDocs, 'solargraph/yard_map/core_docs'
     autoload :CoreGen,  'solargraph/yard_map/core_gen'
     autoload :Mapper,   'solargraph/yard_map/mapper'
+    autoload :RdocToYard, 'solargraph/yard_map/rdoc_to_yard'
 
     CoreDocs.require_minimum
     @@stdlib_yardoc = CoreDocs.yardoc_stdlib_file
@@ -29,7 +33,8 @@ module Solargraph
 
     # @param required [Array<String>]
     # @param with_dependencies [Boolean]
-    def initialize(required: [], with_dependencies: true)
+    def initialize(directory: '.', required: [], with_dependencies: true)
+      @directory = directory
       # HACK: YardMap needs its own copy of this array
       @required = required.clone
       @with_dependencies = with_dependencies
@@ -75,7 +80,7 @@ module Solargraph
     # @param y [String]
     # @return [YARD::Registry]
     def load_yardoc y
-      if y.kind_of?(Array)
+      if y.is_a?(Array)
         YARD::Registry.load y, true
       else
         YARD::Registry.load! y
@@ -90,7 +95,18 @@ module Solargraph
     def core_pins
       @@core_pins ||= begin
         load_yardoc CoreDocs.yardoc_file
-        Mapper.new(YARD::Registry.all).map
+        result = Mapper.new(YARD::Registry.all).map
+        CoreFills::OVERRIDES.each do |ovr|
+          pin = result.select { |p| p.path == ovr.name }.first
+          next if pin.nil?
+          (ovr.tags.map(&:tag_name) + ovr.delete).uniq.each do |tag|
+            pin.docstring.delete_tags tag.to_sym
+          end
+          ovr.tags.each do |tag|
+            pin.docstring.add_tag(tag)
+          end
+        end
+        result
       end
     end
 
@@ -141,6 +157,7 @@ module Solargraph
       unresolved_requires.clear
       stdnames = {}
       done = []
+      pins.concat(bundler_require) if required.include?('bundler/require')
       required.each do |r|
         next if r.nil? || r.empty? || done.include?(r)
         done.push r
@@ -154,7 +171,7 @@ module Solargraph
           spec = Gem::Specification.find_by_path(r) || Gem::Specification.find_by_name(r.split('/').first)
           ver = spec.version.to_s
           ver = ">= 0" if ver.empty?
-          yd = YARD::Registry.yardoc_file_for_gem(spec.name, ver)
+          yd = yardoc_file_for_spec(spec)
           # YARD detects gems for certain libraries that do not have a yardoc
           # but exist in the stdlib. `fileutils` is an example. Treat those
           # cases as errors and check the stdlib yardoc.
@@ -219,7 +236,7 @@ module Solargraph
           depspec = Gem::Specification.find_by_name(dep.name)
           next if depspec.nil? || @gem_paths.key?(depspec.name)
           @gem_paths[depspec.name] = depspec.full_gem_path
-          gy = YARD::Registry.yardoc_file_for_gem(dep.name)
+          gy = yardoc_file_for_spec(depspec)
           if gy.nil?
             unresolved_requires.push dep.name
           else
@@ -250,5 +267,47 @@ module Solargraph
       load_yardoc y
       Mapper.new(YARD::Registry.all, spec).map
     end
+
+    def bundler_require
+      Solargraph.logger.debug "Using bundler/require"
+      result = []
+      Dir.chdir @directory do
+        # @type [Array<Gem::Specification>]
+        specs = Bundler.with_original_env do
+          Bundler.reset!
+          Bundler.definition.specs_for([:default])
+        end
+        specs.each do |spec|
+          ver = spec.version.to_s
+          ver = ">= 0" if ver.empty?
+          yd = yardoc_file_for_spec(spec)
+          # YARD detects gems for certain libraries that do not have a yardoc
+          # but exist in the stdlib. `fileutils` is an example. Treat those
+          # cases as errors and check the stdlib yardoc.
+          if yd.nil?
+            Solargraph.logger.warn "Failed to load gem #{spec.name} #{ver} via bundler/require"
+            next
+          end
+          @gem_paths[spec.name] = spec.full_gem_path
+          unless yardocs.include?(yd)
+            yardocs.unshift yd
+            result.concat process_yardoc yd, spec
+            result.concat add_gem_dependencies(spec) if with_dependencies?
+          end
+        end
+      end
+      Bundler.reset!
+      result.reject(&:nil?)
+    end
+
+    def yardoc_file_for_spec spec
+      cache_dir = File.join(Solargraph::YardMap::CoreDocs.cache_dir, 'gems', "#{spec.name}-#{spec.version}", 'yardoc')
+      if File.exist?(cache_dir)
+        Solargraph.logger.info "Using cached documentation for #{spec.name} at #{cache_dir}"
+        cache_dir
+      else
+        YARD::Registry.yardoc_file_for_gem(spec.name, spec.version)
+      end
+    end
   end
 end