solargraph 0.39.0 → 0.40.0

data/lib/solargraph/complex_type.rb

@@ -12,7 +12,7 @@ module Solargraph
 
     # @param types [Array<UniqueType>]
     def initialize types = [UniqueType::UNDEFINED]
-      @items = types
+      @items = types.uniq(&:to_s)
     end
 
     # @param api_map [ApiMap]
@@ -113,7 +113,7 @@ module Solargraph
       #
       # @param *strings [Array<String>] The type definitions to parse
       # @param partial [Boolean] True if the string is part of a another type
-      # @return [ComplexType]
+      # @return [ComplexType, Array, nil]
       def parse *strings, partial: false
         @cache ||= {}
         unless partial

data/lib/solargraph/convention/base.rb

@@ -2,22 +2,30 @@
 
 module Solargraph
   module Convention
+    # The base class for Conventions.
+    #
+    # A Convention provides Environs that customize ApiMaps with additional
+    # pins and other information. Subclasses should implement the `local` and
+    # `global` methods as necessary.
+    #
     class Base
       EMPTY_ENVIRON = Environ.new
 
-      # True if the source qualifies for this convention.
-      # Subclasses should override this method.
+      # The Environ for a source map.
+      # Subclasses can override this method.
       #
-      # @param source [Source]
-      def match? source
-        false
+      # @param source_map [SourceMap]
+      # @return [Environ]
+      def local source_map
+        EMPTY_ENVIRON
       end
 
-      # The Environ for this convention.
-      # Subclasses should override this method.
+      # The Environ for a YARD map.
+      # Subclasses can override this method.
       #
+      # @param yard_map [YardMap]
       # @return [Environ]
-      def environ
+      def global yard_map
         EMPTY_ENVIRON
       end
     end

data/lib/solargraph/convention/gemfile.rb

@@ -3,11 +3,8 @@
 module Solargraph
   module Convention
     class Gemfile < Base
-      def match? source
-        File.basename(source.filename) == 'Gemfile'
-      end
-
-      def environ
+      def local source_map
+        return EMPTY_ENVIRON unless File.basename(source_map.filename) == 'Gemfile'
         @environ ||= Environ.new(
           requires: ['bundler'],
           domains: ['Bundler::Dsl']

data/lib/solargraph/convention/gemspec.rb

@@ -3,14 +3,11 @@
 module Solargraph
   module Convention
     class Gemspec < Base
-      def match? source
-        File.basename(source.filename).end_with?('.gemspec')
-      end
-
-      def environ
+      def local source_map
+        return EMPTY_ENVIRON unless File.basename(source_map.filename).end_with?('.gemspec')
         @environ ||= Environ.new(
           requires: ['rubygems'],
-          overrides: [
+          pins: [
             Solargraph::Pin::Reference::Override.from_comment(
               'Gem::Specification.new',
               %(

data/lib/solargraph/convention/rspec.rb

@@ -3,18 +3,15 @@
 module Solargraph
   module Convention
     class Rspec < Base
-      def match? source
-        File.basename(source.filename) =~ /_spec\.rb$/
-      end
-
-      def environ
+      def local source_map
+        return EMPTY_ENVIRON unless File.basename(source_map.filename) =~ /_spec\.rb$/
         @environ ||= Environ.new(
           requires: ['rspec'],
           domains: ['RSpec::Matchers', 'RSpec::ExpectationGroups'],
           # This override is necessary due to an erroneous @return tag in
           # rspec's YARD documentation.
           # @todo The return types have been fixed (https://github.com/rspec/rspec-expectations/pull/1121)
-          overrides: [
+          pins: [
             Solargraph::Pin::Reference::Override.method_return('RSpec::Matchers#expect', 'RSpec::Expectations::ExpectationTarget')
           ]
         )

data/lib/solargraph/convention.rb

@@ -15,18 +15,27 @@ module Solargraph
     @@conventions = Set.new
 
     # @param convention [Class<Convention::Base>]
-    # @return [Convention::Base]
+    # @return [void]
     def self.register convention
       @@conventions.add convention.new
     end
 
-    # @param source [Source]
+    # @param source_map [SourceMap]
     # @return [Environ]
-    def self.for(source)
+    def self.for_local(source_map)
       result = Environ.new
-      return result if source.filename.nil? || source.filename.empty?
       @@conventions.each do |conv|
-        result.merge conv.environ if conv.match?(source)
+        result.merge conv.local(source_map)
+      end
+      result
+    end
+
+    # @param yard_map [YardMap]
+    # @return [Environ]
+    def self.for_global(yard_map)
+      result = Environ.new
+      @@conventions.each do |conv|
+        result.merge conv.global(yard_map)
       end
       result
     end

data/lib/solargraph/diagnostics/rubocop.rb

@@ -24,7 +24,8 @@ module Solargraph
       # @return [Array<Hash>]
       def diagnose source, _api_map
         options, paths = generate_options(source.filename, source.code)
-        runner = RuboCop::Runner.new(options, RuboCop::ConfigStore.new)
+        store = RuboCop::ConfigStore.new
+        runner = RuboCop::Runner.new(options, store)
         result = redirect_stdout{ runner.run(paths) }
         make_array JSON.parse(result)
       rescue RuboCop::ValidationError, RuboCop::ConfigNotFoundError => e

data/lib/solargraph/diagnostics/rubocop_helpers.rb

@@ -17,7 +17,8 @@ module Solargraph
         rubocop_file = find_rubocop_file(filename)
         args.push('-c', fix_drive_letter(rubocop_file)) unless rubocop_file.nil?
         args.push filename
-        options, paths = RuboCop::Options.new.parse(args)
+        base_options = RuboCop::Options.new
+        options, paths = base_options.parse(args)
         options[:stdin] = code
         [options, paths]
       end
@@ -27,6 +28,8 @@ module Solargraph
       # @param filename [String]
       # @return [String, nil]
       def find_rubocop_file filename
+        return nil unless File.exist?(filename)
+        filename = File.realpath(filename)
         dir = File.dirname(filename)
         until File.dirname(dir) == dir
           here = File.join(dir, '.rubocop.yml')

data/lib/solargraph/documentor.rb

@@ -5,6 +5,7 @@ require 'json'
 require 'open3'
 require 'shellwords'
 require 'yard'
+require 'fileutils'
 
 module Solargraph
   class Documentor
@@ -25,6 +26,7 @@ module Solargraph
       Documentor.specs_from_bundle(@directory).each_pair do |name, version|
         yd = YARD::Registry.yardoc_file_for_gem(name, "= #{version}")
         if !yd || @rebuild
+          FileUtils.safe_unlink File.join(YardMap::CoreDocs.cache_dir, 'gems', "#{name}-#{version}.ser")
           @out.puts "Documenting #{name} #{version}"
           `yard gems #{name} #{version} #{@rebuild ? '--rebuild' : ''}`
           yd = YARD::Registry.yardoc_file_for_gem(name, "= #{version}")
@@ -53,6 +55,8 @@ module Solargraph
       false
     end
 
+    # @param directory [String]
+    # @return [Hash]
     def self.specs_from_bundle directory
       Solargraph.with_clean_env do
         Dir.chdir directory do

data/lib/solargraph/environ.rb

@@ -1,6 +1,11 @@
 # frozen_string_literal: true
 
 module Solargraph
+  # A collection of additional data, such as map pins and required paths, that
+  # can be added to an ApiMap.
+  #
+  # Conventions are used to add Environs.
+  #
   class Environ
     # @return [Array<String>]
     attr_reader :requires
@@ -9,22 +14,22 @@ module Solargraph
     attr_reader :domains
 
     # @return [Array<Pin::Reference::Override>]
-    attr_reader :overrides
+    attr_reader :pins
 
     # @param requires [Array<String>]
     # @param domains [Array<String>]
-    # @param overrides [Array<Pin::Reference::Override>]
-    def initialize requires: [], domains: [], overrides: []
+    # @param pins [Array<Pin::Base>]
+    def initialize requires: [], domains: [], pins: []
       @requires = requires
       @domains = domains
-      @overrides = overrides
+      @pins = pins
     end
 
     # @return [self]
     def clear
       domains.clear
       requires.clear
-      overrides.clear
+      pins.clear
       self
     end
 
@@ -33,7 +38,7 @@ module Solargraph
     def merge other
       domains.concat other.domains
       requires.concat other.requires
-      overrides.concat other.overrides
+      pins.concat other.pins
       self
     end
   end

data/lib/solargraph/language_server/host.rb

@@ -99,7 +99,7 @@ module Solargraph
           message = Message.select(request['method']).new(self, request)
           begin
             message.process
-          rescue Exception => e
+          rescue StandardError => e
             logger.warn "Error processing request: [#{e.class}] #{e.message}"
             logger.warn e.backtrace.join("\n")
             message.set_error Solargraph::LanguageServer::ErrorCodes::INTERNAL_ERROR, "[#{e.class}] #{e.message}"

data/lib/solargraph/language_server/message/extended/check_gem_version.rb

@@ -34,7 +34,12 @@ module Solargraph
                                           LanguageServer::MessageTypes::INFO,
                                           ['Update now'] do |result|
                                             next unless result == 'Update now'
-                                            o, s = Open3.capture2("gem update solargraph")
+                                            cmd = if host.options['useBundler']
+                                              'bundle update solargraph'
+                                            else
+                                              'gem update solargraph'
+                                            end
+                                            o, s = Open3.capture2(cmd)
                                             if s == 0
                                               host.show_message 'Successfully updated the Solargraph gem.', LanguageServer::MessageTypes::INFO
                                               host.send_notification '$/solargraph/restart', {}

data/lib/solargraph/language_server/message/text_document/definition.rb

@@ -13,7 +13,7 @@ module Solargraph::LanguageServer::Message::TextDocument
     def code_location
       suggestions = host.definitions_at(params['textDocument']['uri'], @line, @column)
       return nil if suggestions.empty?
-      suggestions.reject{|pin| pin.location.nil?}.map do |pin|
+      suggestions.reject { |pin| pin.location.nil? || pin.location.filename.nil? }.map do |pin|
         {
           uri: file_to_uri(pin.location.filename),
           range: pin.location.range.to_hash

data/lib/solargraph/language_server/message/text_document/formatting.rb

@@ -16,16 +16,20 @@ module Solargraph
             # detects the correct configuration
             # the .rb extension is needed for ruby file without extension, else rubocop won't format
             tempfile = File.join(File.dirname(filename), "_tmp_#{SecureRandom.hex(8)}_#{File.basename(filename)}.rb")
+            rubocop_file = Diagnostics::RubocopHelpers.find_rubocop_file(filename)
             original = host.read_text(params['textDocument']['uri'])
             File.write tempfile, original
             begin
-              options, paths = RuboCop::Options.new.parse(['-a', '-f', 'fi', tempfile])
-              redirect_stdout { RuboCop::Runner.new(options, RuboCop::ConfigStore.new).run(paths) }
+              args = ['-a', '-f', 'fi', tempfile]
+              args.unshift('-c', fix_drive_letter(rubocop_file)) unless rubocop_file.nil?
+              options, paths = RuboCop::Options.new.parse(args)
+              store = RuboCop::ConfigStore.new
+              redirect_stdout { RuboCop::Runner.new(options, store).run(paths) }
               result = File.read(tempfile)
-              File.unlink tempfile
               format original, result
             rescue RuboCop::ValidationError, RuboCop::ConfigNotFoundError => e
               set_error(Solargraph::LanguageServer::ErrorCodes::INTERNAL_ERROR, "[#{e.class}] #{e.message}")
+            ensure
               File.unlink tempfile
             end
           end

data/lib/solargraph/language_server/uri_helpers.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'uri'
+require 'cgi'
 
 module Solargraph
   module LanguageServer
@@ -14,7 +14,7 @@ module Solargraph
       # @param uri [String]
       # @return [String]
       def uri_to_file uri
-        URI.decode(uri).sub(/^file\:\/\//, '').sub(/^\/([a-z]\:)/i, '\1')
+        decode(uri).sub(/^file\:\/\//, '').sub(/^\/([a-z]\:)/i, '\1')
       end
 
       # Convert a file path to a URI.
@@ -22,7 +22,27 @@ module Solargraph
       # @param file [String]
       # @return [String]
       def file_to_uri file
-        "file://#{URI.encode(file.gsub(/^([a-z]\:)/i, '/\1'))}"
+        "file://#{encode(file.gsub(/^([a-z]\:)/i, '/\1'))}"
+      end
+
+      # Encode text to be used as a URI path component in LSP.
+      #
+      # @param text [String]
+      # @return [String]
+      def encode text
+        CGI.escape(text)
+           .gsub('%3A', ':')
+           .gsub('%5C', '\\')
+           .gsub('%2F', '/')
+           .gsub('+', '%20')
+      end
+
+      # Decode text from a URI path component in LSP.
+      #
+      # @param text [String]
+      # @return [String]
+      def decode text
+        CGI.unescape(text)
       end
     end
   end

data/lib/solargraph/library.rb

@@ -20,7 +20,7 @@ module Solargraph
     def initialize workspace = Solargraph::Workspace.new, name = nil
       @workspace = workspace
       @name = name
-      api_map.catalog bundle
+      api_map.catalog bench
       @synchronized = true
       @catalog_mutex = Mutex.new
     end
@@ -171,7 +171,21 @@ module Solargraph
     def definitions_at filename, line, column
       position = Position.new(line, column)
       cursor = Source::Cursor.new(read(filename), position)
-      api_map.clip(cursor).define.map { |pin| pin.realize(api_map) }
+      if cursor.comment?
+        source = read(filename)
+        offset = Solargraph::Position.to_offset(source.code, Solargraph::Position.new(line, column))
+        lft = source.code[0..offset-1].match(/\[[a-z0-9_:<, ]*?([a-z0-9_:]*)\z/i)
+        rgt = source.code[offset..-1].match(/^([a-z0-9_]*)(:[a-z0-9_:]*)?[\]>, ]/i)
+        if lft && rgt
+          tag = (lft[1] + rgt[1]).sub(/:+$/, '')
+          clip = api_map.clip(cursor)
+          clip.translate tag
+        else
+          []
+        end
+      else
+        api_map.clip(cursor).define.map { |pin| pin.realize(api_map) }
+      end
     end
 
     # Get signature suggestions for the method at the specified file and
@@ -245,7 +259,7 @@ module Solargraph
     end
 
     # @param query [String]
-    # @return [Array<YARD::CodeObject::Base>]
+    # @return [Array<YARD::CodeObjects::Base>]
     def document query
       catalog
       api_map.document query
@@ -337,9 +351,9 @@ module Solargraph
       @catalog_mutex.synchronize do
         break if synchronized?
         logger.info "Cataloging #{workspace.directory.empty? ? 'generic workspace' : workspace.directory}"
-        api_map.catalog bundle
+        api_map.catalog bench
         @synchronized = true
-        logger.info "Catalog complete (#{api_map.pins.length} pins)"
+        logger.info "Catalog complete (#{api_map.source_maps.length} files, #{api_map.pins.length} pins)" if logger.info?
       end
     end
 
@@ -389,9 +403,9 @@ module Solargraph
       @api_map ||= Solargraph::ApiMap.new
     end
 
-    # @return [Bundle]
-    def bundle
-      Bundle.new(
+    # @return [Bench]
+    def bench
+      Bench.new(
         workspace: workspace,
         opened: @current ? [@current] : []
       )

data/lib/solargraph/parser/legacy/class_methods.rb

@@ -78,6 +78,10 @@ module Solargraph
           NodeChainer.chain *args
         end
 
+        def chain_string *args
+          NodeChainer.load_string *args
+        end
+
         def process_node *args
           Solargraph::Parser::NodeProcessor.process *args
         end

data/lib/solargraph/parser/legacy/node_chainer.rb

@@ -14,7 +14,7 @@ module Solargraph
         def initialize node, filename = nil, in_block = false
           @node = node
           @filename = filename
-          @in_block = in_block
+          @in_block = in_block ? 1 : 0
         end
 
         # @return [Source::Chain]
@@ -51,9 +51,9 @@ module Solargraph
           return generate_links(n.children[0]) if n.type == :splat
           result = []
           if n.type == :block
-            @in_block = true
+            @in_block += 1
             result.concat generate_links(n.children[0])
-            @in_block = false
+            @in_block -= 1
           elsif n.type == :send
             if n.children[0].is_a?(::Parser::AST::Node)
               result.concat generate_links(n.children[0])
@@ -61,20 +61,23 @@ module Solargraph
               n.children[2..-1].each do |c|
                 args.push NodeChainer.chain(c)
               end
-              result.push Chain::Call.new(n.children[1].to_s, args, @in_block || block_passed?(n))
+              result.push Chain::Call.new(n.children[1].to_s, args, @in_block > 0 || block_passed?(n))
             elsif n.children[0].nil?
               args = []
               n.children[2..-1].each do |c|
                 args.push NodeChainer.chain(c)
               end
-              result.push Chain::Call.new(n.children[1].to_s, args, @in_block || block_passed?(n))
+              result.push Chain::Call.new(n.children[1].to_s, args, @in_block > 0 || block_passed?(n))
             else
               raise "No idea what to do with #{n}"
             end
           elsif n.type == :self
             result.push Chain::Head.new('self')
-          elsif [:super, :zsuper].include?(n.type)
-            result.push Chain::Head.new('super')
+          elsif n.type == :zsuper
+            result.push Chain::ZSuper.new('super', @in_block > 0 || block_passed?(n))
+          elsif n.type == :super
+            args = n.children.map { |c| NodeChainer.chain(c) }
+            result.push Chain::Call.new('super', args, @in_block > 0 || block_passed?(n))
           elsif n.type == :const
             const = unpack_name(n)
             result.push Chain::Constant.new(const)

data/lib/solargraph/parser/legacy/node_methods.rb

@@ -124,11 +124,20 @@ module Solargraph
           result = []
           if node.type == :block
             result.push node
-            node.children[0].children[2..-1].each { |child| result.concat call_nodes_from(child) }
+            if Parser.is_ast_node?(node.children[0]) && node.children[0].children.length > 2
+              node.children[0].children[2..-1].each { |child| result.concat call_nodes_from(child) }
+            end
             node.children[1..-1].each { |child| result.concat call_nodes_from(child) }
           elsif node.type == :send
             result.push node
             node.children[2..-1].each { |child| result.concat call_nodes_from(child) }
+          elsif [:super, :zsuper].include?(node.type)
+            result.push node
+            node.children.each { |child| result.concat call_nodes_from(child) }
+          elsif node.type == :masgn
+            # @todo We're treating a mass assignment as a call node, but the
+            #   type checker still needs the logic to handle it.
+            result.push node
           else
             node.children.each { |child| result.concat call_nodes_from(child) }
           end
@@ -210,8 +219,12 @@ module Solargraph
                 result.concat get_return_nodes_only(node.children[2])
               elsif node.type == :case
                 node.children[1..-1].each do |cc|
-                  result.concat reduce_to_value_nodes(cc.children[1..-2])
-                  result.concat reduce_to_value_nodes([cc.children.last])
+                  if cc.nil?
+                    result.push NIL_NODE
+                  else
+                    result.concat reduce_to_value_nodes(cc.children[1..-2]) unless cc.children.length < 1
+                    result.concat reduce_to_value_nodes([cc.children.last])
+                  end
                 end
               else
                 result.push node

data/lib/solargraph/parser/legacy/node_processors/ivasgn_node.rb

@@ -19,7 +19,7 @@ module Solargraph
             if region.visibility == :module_function
               here = get_node_start_position(node)
               named_path = named_path_pin(here)
-              if named_path.is_a?(Pin::BaseMethod)
+              if named_path.is_a?(Pin::Method)
                 pins.push Solargraph::Pin::InstanceVariable.new(
                   location: loc,
                   closure: Pin::Namespace.new(type: :module, closure: region.closure.closure, name: region.closure.name),