solargraph 0.40.3 → 0.42.0

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

@@ -17,7 +17,7 @@ module Solargraph
               if !this_link.nil? && this_link != last_link
                 parts.push this_link
               end
-              parts.push pin.detail.gsub(':', '\\:') unless pin.is_a?(Pin::Namespace) || pin.detail.nil?
+              parts.push "`#{pin.detail}`" unless pin.is_a?(Pin::Namespace) || pin.detail.nil?
               parts.push pin.documentation unless pin.documentation.nil? || pin.documentation.empty?
               unless parts.empty?
                 data = parts.join("\n\n")

data/lib/solargraph/library.rb

@@ -20,9 +20,7 @@ module Solargraph
     def initialize workspace = Solargraph::Workspace.new, name = nil
       @workspace = workspace
       @name = name
-      api_map.catalog bench
-      @synchronized = true
-      @catalog_mutex = Mutex.new
+      @synchronized = false
     end
 
     def inspect
@@ -48,9 +46,15 @@ module Solargraph
     # @return [void]
     def attach source
       mutex.synchronize do
-        @synchronized = (@current == source) if synchronized?
+        if @current && @current.filename != source.filename && source_map_hash.key?(@current.filename) && !workspace.has_file?(@current.filename)
+          source_map_hash.delete @current.filename
+          source_map_external_require_hash.delete @current.filename
+          @external_requires = nil
+          @synchronized = false
+        end
         @current = source
-        catalog
+        maybe_map @current
+        api_map.catalog bench unless synchronized?
       end
     end
 
@@ -110,9 +114,9 @@ module Solargraph
       mutex.synchronize do
         next if File.directory?(filename) || !File.exist?(filename)
         next unless contain?(filename) || open?(filename) || workspace.would_merge?(filename)
-        @synchronized = false
         source = Solargraph::Source.load_string(File.read(filename), filename)
         workspace.merge(source)
+        maybe_map source
         result = true
       end
       result
@@ -158,6 +162,8 @@ module Solargraph
       position = Position.new(line, column)
       cursor = Source::Cursor.new(read(filename), position)
       api_map.clip(cursor).complete
+    rescue FileNotFoundError => e
+      handle_file_not_found filename, e
     end
 
     # Get definition suggestions for the expression at the specified file and
@@ -186,6 +192,8 @@ module Solargraph
       else
         api_map.clip(cursor).define.map { |pin| pin.realize(api_map) }
       end
+    rescue FileNotFoundError => e
+      handle_file_not_found(filename, e)
     end
 
     # Get signature suggestions for the method at the specified file and
@@ -246,7 +254,18 @@ module Solargraph
     end
 
     def locate_ref location
-      api_map.require_reference_at location
+      map = source_map_hash[location.filename]
+      return if map.nil?
+      pin = map.requires.select { |p| p.location.range.contain?(location.range.start) }.first
+      return nil if pin.nil?
+      workspace.require_paths.each do |path|
+        full = Pathname.new(path).join("#{pin.name}.rb").to_s
+        next unless source_map_hash.key?(full)
+        return Location.new(full, Solargraph::Range.from_to(0, 0, 0, 0))
+      end
+      api_map.yard_map.require_reference(pin.name)
+    rescue FileNotFoundError
+      nil
     end
 
     # Get an array of pins that match a path.
@@ -260,14 +279,12 @@ module Solargraph
     # @param query [String]
     # @return [Array<YARD::CodeObjects::Base>]
     def document query
-      catalog
       api_map.document query
     end
 
     # @param query [String]
     # @return [Array<String>]
     def search query
-      catalog
       api_map.search query
     end
 
@@ -276,7 +293,6 @@ module Solargraph
     # @param query [String]
     # @return [Array<Pin::Base>]
     def query_symbols query
-      catalog
       api_map.query_symbols query
     end
 
@@ -295,10 +311,13 @@ module Solargraph
     # @param path [String]
     # @return [Array<Solargraph::Pin::Base>]
     def path_pins path
-      catalog
       api_map.get_path_suggestions(path)
     end
 
+    def source_maps
+      source_map_hash.values
+    end
+
     # Get the current text of a file in the library.
     #
     # @param filename [String]
@@ -318,9 +337,9 @@ module Solargraph
       #   be an option to do so.
       #
       return [] unless open?(filename)
-      catalog
       result = []
       source = read(filename)
+      catalog
       repargs = {}
       workspace.config.reporters.each do |line|
         if line == 'all!'
@@ -346,7 +365,7 @@ module Solargraph
     #
     # @return [void]
     def catalog
-      @catalog_mutex.synchronize do
+      mutex.synchronize do
         break if synchronized?
         logger.info "Cataloging #{workspace.directory.empty? ? 'generic workspace' : workspace.directory}"
         api_map.catalog bench
@@ -355,6 +374,14 @@ module Solargraph
       end
     end
 
+    def bench
+      Bench.new(
+        source_maps: source_map_hash.values,
+        workspace: workspace,
+        external_requires: external_requires
+      )
+    end
+
     # Get an array of foldable ranges for the specified file.
     #
     # @deprecated The library should not need to handle folding ranges. The
@@ -381,16 +408,75 @@ module Solargraph
     # @param source [Source]
     # @return [Boolean] True if the source was merged into the workspace.
     def merge source
+      Logging.logger.debug "Merging source: #{source.filename}"
       result = false
       mutex.synchronize do
         result = workspace.merge(source)
-        @synchronized = !result if synchronized?
+        maybe_map source
       end
+      # catalog
       result
     end
 
+    def source_map_hash
+      @source_map_hash ||= {}
+    end
+
+    def mapped?
+      (workspace.filenames - source_map_hash.keys).empty?
+    end
+
+    def next_map
+      return false if mapped?
+      mutex.synchronize do
+        @synchronized = false
+        src = workspace.sources.find { |s| !source_map_hash.key?(s.filename) }
+        if src
+          Logging.logger.debug "Mapping #{src.filename}"
+          source_map_hash[src.filename] = Solargraph::SourceMap.map(src)
+          find_external_requires(source_map_hash[src.filename])
+          source_map_hash[src.filename]
+        else
+          false
+        end
+      end
+    end
+
+    def map!
+      workspace.sources.each do |src|
+        source_map_hash[src.filename] = Solargraph::SourceMap.map(src)
+        find_external_requires(source_map_hash[src.filename])
+      end
+      self
+    end
+
+    def pins
+      @pins ||= []
+    end
+
+    def external_requires
+      @external_requires ||= source_map_external_require_hash.values.flatten.to_set
+    end
+
     private
 
+    def source_map_external_require_hash
+      @source_map_external_require_hash ||= {}
+    end
+
+    # @param source_map [SourceMap]
+    def find_external_requires source_map
+      new_set = source_map.requires.map(&:name).to_set
+      # return if new_set == source_map_external_require_hash[source_map.filename]
+      source_map_external_require_hash[source_map.filename] = new_set.reject do |path|
+        workspace.require_paths.any? do |base|
+          full = Pathname.new(base).join("#{path}.rb").to_s
+          workspace.filenames.include?(full)
+        end
+      end
+      @external_requires = nil
+    end
+
     # @return [Mutex]
     def mutex
       @mutex ||= Mutex.new
@@ -401,14 +487,6 @@ module Solargraph
       @api_map ||= Solargraph::ApiMap.new
     end
 
-    # @return [Bench]
-    def bench
-      Bench.new(
-        workspace: workspace,
-        opened: @current ? [@current] : []
-      )
-    end
-
     # Get the source for an open file or create a new source if the file
     # exists on disk. Sources created from disk are not added to the open
     # workspace files, i.e., the version on disk remains the authoritative
@@ -422,5 +500,37 @@ module Solargraph
       raise FileNotFoundError, "File not found: #{filename}" unless workspace.has_file?(filename)
       workspace.source(filename)
     end
+
+    def handle_file_not_found filename, error
+      if workspace.source(filename)
+        Solargraph.logger.debug "#{filename} is not cataloged in the ApiMap"
+        nil
+      else
+        raise error
+      end
+    end
+
+    def maybe_map source
+      if source_map_hash.key?(source.filename)
+        return if source_map_hash[source.filename].code == source.code && 
+          source_map_hash[source.filename].source.synchronized? &&
+          source.synchronized?
+        if source.synchronized?
+          new_map = Solargraph::SourceMap.map(source)
+          unless source_map_hash[source.filename].try_merge!(new_map)
+            source_map_hash[source.filename] = new_map
+            find_external_requires(source_map_hash[source.filename])
+            @synchronized = false
+          end
+        else
+          # @todo Smelly instance variable access
+          source_map_hash[source.filename].instance_variable_set(:@source, source)
+        end
+      else
+        source_map_hash[source.filename] = Solargraph::SourceMap.map(source)
+        find_external_requires(source_map_hash[source.filename])
+        @synchronized = false
+      end
+    end
   end
 end

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

@@ -109,7 +109,6 @@ module Solargraph
         end
 
         def node_to_argchains node
-          # @todo Process array, splat, argscat
           return [] unless Parser.is_ast_node?(node)
           if [:ZARRAY, :ARRAY, :LIST].include?(node.type)
             node.children[0..-2].map { |c| NodeChainer.chain(c) }

data/lib/solargraph/parser/rubyvm/node_processors/args_node.rb

@@ -32,7 +32,6 @@ module Solargraph
                   region.closure.parameters.push locals.last
                 end
               end
-              # @todo Optional args, keyword args, etc.
               if node.children[6]
                 locals.push Solargraph::Pin::Parameter.new(
                   location: region.closure.location,
@@ -55,19 +54,19 @@ module Solargraph
                 )
                 region.closure.parameters.push locals.last
               end
-              if node.children.last
-                locals.push Solargraph::Pin::Parameter.new(
-                  location: region.closure.location,
-                  closure: region.closure,
-                  comments: comments_for(node),
-                  name: node.children.last.to_s,
-                  presence: region.closure.location.range,
-                  decl: :blockarg
-                )
-                region.closure.parameters.push locals.last
-              end
             end
             process_children
+            if node.children.last
+              locals.push Solargraph::Pin::Parameter.new(
+                location: region.closure.location,
+                closure: region.closure,
+                comments: comments_for(node),
+                name: node.children.last.to_s,
+                presence: region.closure.location.range,
+                decl: :blockarg
+              )
+              region.closure.parameters.push locals.last
+            end
           end
 
           private

data/lib/solargraph/parser/rubyvm/node_processors/opt_arg_node.rb

@@ -16,12 +16,7 @@ module Solargraph
               presence: region.closure.location.range,
               decl: :optarg
             )
-            idx = region.closure.parameters.find_index { |par| par.decl != :arg }
-            if idx
-              region.closure.parameters.insert idx, locals.last
-            else
-              region.closure.parameters.push locals.last
-            end
+            region.closure.parameters.push locals.last
             node.children[1] && NodeProcessor.process(node.children[1], region, pins, locals)
           end
         end

data/lib/solargraph/shell.rb

@@ -74,7 +74,11 @@ module Solargraph
     desc 'download-core [VERSION]', 'Download core documentation'
     def download_core version = nil
       ver = version || Solargraph::YardMap::CoreDocs.best_download
-      puts "Downloading docs for #{ver}..."
+      if RUBY_VERSION != ver
+        puts "Documentation for #{RUBY_VERSION} is not available. Reverting to closest match..."
+      else
+        puts "Downloading docs for #{ver}..."
+      end
       Solargraph::YardMap::CoreDocs.download ver
       # Clear cached documentation if it exists
       FileUtils.rm_rf Dir.glob(File.join(Solargraph::YardMap::CoreDocs.cache_dir, ver, '*.ser'))

data/lib/solargraph/source.rb

@@ -175,7 +175,7 @@ module Solargraph
       synced
     end
 
-    # @param position [Position]
+    # @param position [Position, Array(Integer, Integer)]
     # @return [Source::Cursor]
     def cursor_at position
       Cursor.new(self, position)

data/lib/solargraph/source/chain/head.rb

@@ -13,22 +13,6 @@ module Solargraph
           # return super_pins(api_map, name_pin) if word == 'super'
           []
         end
-
-        # @todo This is temporary. Chain heads need to handle arguments to
-        #   `super`.
-        # def arguments
-        #   []
-        # end
-
-        private
-
-        # # @param api_map [ApiMap]
-        # # @param name_pin [Pin::Base]
-        # # @return [Array<Pin::Base>]
-        # def super_pins api_map, name_pin
-        #   pins = api_map.get_method_stack(name_pin.namespace, name_pin.name, scope: name_pin.scope)
-        #   pins.reject{|p| p.path == name_pin.path}
-        # end
       end
     end
   end

data/lib/solargraph/source/source_chainer.rb

@@ -34,6 +34,7 @@ module Solargraph
         # Special handling for files that end with an integer and a period
         return Chain.new([Chain::Literal.new('Integer'), Chain::UNDEFINED_CALL]) if phrase =~ /^[0-9]+\.$/
         return Chain.new([Chain::Literal.new('Symbol')]) if phrase.start_with?(':') && !phrase.start_with?('::')
+        return SourceChainer.chain(source, Position.new(position.line, position.character + 1)) if end_of_phrase.strip == '::' && source.code[Position.to_offset(source.code, position)].to_s.match?(/[a-z]/i)
         begin
           return Chain.new([]) if phrase.end_with?('..')
           node = nil

data/lib/solargraph/source_map/mapper.rb

@@ -71,11 +71,6 @@ module Solargraph
           pos = Solargraph::Position.new(comment_position.line + line_num - 1, comment_position.column)
           process_directive(source_position, pos, d)
           last_line = line_num + 1
-          # @todo The below call assumes the topmost comment line. The above
-          #   process occasionally emits incorrect comment positions due to
-          #   blank lines in comment blocks, but at least it processes all the
-          #   directives.
-          # process_directive(source_position, comment_position, d)
         end
       end
 

data/lib/solargraph/type_checker.rb

@@ -95,7 +95,7 @@ module Solargraph
           result.push Problem.new(pin.location, "Untyped method #{pin.path} could not be inferred")
         end
       elsif rules.validate_tags?
-        unless pin.node.nil? || declared.void? || macro_pin?(pin) || abstract?(pin)
+        unless pin.node.nil? || declared.void? || virtual_pin?(pin) || abstract?(pin)
           inferred = pin.probe(api_map).self_to(pin.full_context.namespace)
           if inferred.undefined?
             unless rules.ignore_all_undefined? || external?(pin)
@@ -111,7 +111,7 @@ module Solargraph
       result
     end
 
-    def macro_pin? pin
+    def virtual_pin? pin
       pin.location && source_map.source.comment_at?(pin.location.range.ending)
     end
 

data/lib/solargraph/type_checker/checks.rb

@@ -75,7 +75,7 @@ module Solargraph
         true
       end
 
-      # @param type [ComplexType]
+      # @param type [ComplexType::UniqueType]
       # @return [String]
       def fuzz type
         if type.parameters?
@@ -86,13 +86,13 @@ module Solargraph
       end
 
       # @param api_map [ApiMap]
-      # @param cls1 [ComplexType]
-      # @param cls2 [ComplexType]
+      # @param cls1 [ComplexType::UniqueType]
+      # @param cls2 [ComplexType::UniqueType]
       # @return [Boolean]
       def either_way?(api_map, cls1, cls2)
         f1 = fuzz(cls1)
         f2 = fuzz(cls2)
-        api_map.super_and_sub?(f1, f2) || api_map.super_and_sub?(f2, f1)
+        api_map.type_include?(f1, f2) || api_map.super_and_sub?(f1, f2) || api_map.super_and_sub?(f2, f1)
       end
     end
   end