solargraph 0.30.2 → 0.31.0

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

@@ -4,13 +4,6 @@ module Solargraph
       module TextDocument
         class Completion < Base
           def process
-            inner_process
-          end
-
-          private
-
-          # @return [void]
-          def inner_process
             filename = uri_to_file(params['textDocument']['uri'])
             line = params['position']['line']
             col = params['position']['character']
@@ -39,7 +32,7 @@ module Solargraph
                 items: items
               )
             rescue InvalidOffsetError => e
-              STDERR.puts "Skipping invalid offset: #{filename}, line #{line}, character #{col}"
+              Logging.logger.info "Completion ignored invalid offset: #{filename}, line #{line}, character #{col}"
               set_result empty_result
             end
           end

data/lib/solargraph/language_server/transport/adapter.rb

@@ -4,20 +4,20 @@ module Solargraph
       # A common module for running language servers in Backport.
       #
       module Adapter
+        @@timer_is_running = false
+
         def opening
           @host = Solargraph::LanguageServer::Host.new
+          @host.start
           @data_reader = Solargraph::LanguageServer::Transport::DataReader.new
           @data_reader.set_message_handler do |message|
             process message
           end
-          start_timers
+          start_timer
         end
 
-        def process request
-          message = @host.start(request)
-          message.send_response
-          tmp = @host.flush
-          write tmp unless tmp.empty?
+        def closing
+          @host.stop
         end
 
         # @param data [String]
@@ -27,19 +27,30 @@ module Solargraph
 
         private
 
-        def start_timers
-          Backport.prepare_interval 0.1 do
-            tmp = @host.flush
-            write tmp unless tmp.empty?
+        # @param request [String]
+        # @return [void]
+        def process request
+          message = @host.receive(request)
+          message.send_response
+          tmp = @host.flush
+          write tmp unless tmp.empty?
+        end
+
+        def start_timer
+          Backport.prepare_interval 0.1 do |server|
             if @host.stopped?
-              if @host.options['transport'] == 'external'
-                @host = Solargraph::LanguageServer::Host.new
-              else
-                Backport.stop
-              end
+              server.stop
+              shutdown
+            else
+              tmp = @host.flush
+              write tmp unless tmp.empty?
             end
           end
         end
+
+        def shutdown
+          Backport.stop unless @host.options['transport'] == 'external'
+        end
       end
     end
   end

data/lib/solargraph/language_server/transport/data_reader.rb

@@ -52,8 +52,8 @@ module Solargraph
             msg = JSON.parse(@buffer)
             @message_handler.call msg unless @message_handler.nil?
           rescue JSON::ParserError => e
-            STDERR.puts "Failed to parse request: #{e.message}"
-            STDERR.puts "Buffer: #{@buffer}"
+            Solargraph::Logging.logger.info "Failed to parse request: #{e.message}"
+            Solargraph::Logging.logger.debug "Buffer: #{@buffer}"
           ensure
             @buffer.clear
             @in_header = true

data/lib/solargraph/library.rb

@@ -20,6 +20,11 @@ module Solargraph
       @catalog_mutex = Mutex.new
     end
 
+    def inspect
+      # Let's not deal with insane data dumps in spec failures
+      to_s
+    end
+
     # True if the ApiMap is up to date with the library's workspace and open
     # files.
     #
@@ -28,23 +33,6 @@ module Solargraph
       @synchronized
     end
 
-    # Open a file in the library. Opening a file will make it available for
-    # checkout and merge it into the workspace if applicable.
-    #
-    # @deprecated The library should not be responsible for this. Instead, it
-    #   should accept a source and determine whether or not to merge it.
-    #
-    # @param filename [String]
-    # @param text [String]
-    # @param version [Integer]
-    # @return [void]
-    def open filename, text, version
-      logger.warn "Library#open is deprecated"
-      source = Solargraph::Source.load_string(text, filename, version)
-      merge source
-      attach source
-    end
-
     # Open a file from disk and try to merge it into the workspace.
     #
     # @param filename [String]
@@ -60,7 +48,7 @@ module Solargraph
     # library will include it in the ApiMap while it's attached. Only one
     # source can be attached to the library at a time.
     #
-    # @param source [Source]
+    # @param source [Source, nil]
     # @return [void]
     def attach source
       mutex.synchronize do
@@ -78,6 +66,16 @@ module Solargraph
     end
     alias open? attached?
 
+    # Detach the specified file if it is currently attached to the library.
+    #
+    # @param filename [String]
+    # @return [Boolean] True if the specified file was detached
+    def detach filename
+      return false if @current.nil? || @current.filename != filename
+      attach nil
+      true
+    end
+
     # True if the specified file is included in the workspace (but not
     # necessarily open).
     #
@@ -130,11 +128,10 @@ module Solargraph
     # @param filename [String]
     # @return [void]
     def delete filename
+      detach filename
       mutex.synchronize do
-        @synchronized = false
-        @current = nil if @current && @current.filename == filename
-        workspace.remove filename
-        # catalog
+        result = workspace.remove(filename)
+        @synchronized = !result if synchronized?
       end
     end
 
@@ -206,7 +203,7 @@ module Solargraph
       return [] if pins.empty?
       result = []
       pins.uniq.each do |pin|
-        (workspace.sources + (@current ? [@current] : [])).uniq.each do |source|
+        (workspace.sources + (@current ? [@current] : [])).uniq(&:filename).each do |source|
           found = source.references(pin.name)
           found.select! do |loc|
             referenced = definitions_at(loc.filename, loc.range.ending.line, loc.range.ending.character)
@@ -223,7 +220,7 @@ module Solargraph
           end)
         end
       end
-      result
+      result.uniq
     end
 
     # Get the pin at the specified location or nil if the pin does not exist.
@@ -256,7 +253,10 @@ module Solargraph
       checked = read(filename)
       @synchronized = (checked == @current) if synchronized?
       @current = checked
-      catalog
+      # Cataloging is necessary to avoid FileNotFoundErrors when the file is
+      # not in the workspace. Otherwise it should be safe to defer
+      # synchronization.
+      catalog unless workspace.has_file?(filename)
       @current
     end
 
@@ -303,30 +303,6 @@ module Solargraph
       api_map.get_path_suggestions(path)
     end
 
-    # Update a source in the library from the provided updater.
-    #
-    # @note This method will not update the library's ApiMap. See
-    #   Library#synchronized? and Library#catalog for more information.
-    #
-    # @deprecated The library should not be responsible for this. Instead, it
-    #   should accept a source and determine whether or not to merge it.
-    #
-    # @raise [FileNotFoundError] if the updater's file is not available.
-    # @param updater [Solargraph::Source::Updater]
-    # @return [void]
-    def update updater
-      logger.warn 'Library#update is deprecated'
-      mutex.synchronize do
-        if workspace.has_file?(updater.filename)
-          workspace.synchronize!(updater)
-          @current = workspace.source(updater.filename) if @current && @current.filename == updater.filename
-        elsif @current && @current.filename == updater.filename
-          @current = @current.synchronize(updater)
-        end
-        @synchronized = false
-      end
-    end
-
     # Get the current text of a file in the library.
     #
     # @param filename [String]
@@ -366,25 +342,21 @@ module Solargraph
         logger.info "Cataloging #{workspace.directory.empty? ? 'generic workspace' : workspace.directory}"
         api_map.catalog bundle
         @synchronized = true
+        logger.info "Catalog complete (#{api_map.pins.length} pins)"
       end
     end
 
     # Get an array of foldable ranges for the specified file.
     #
+    # @deprecated The library should not need to handle folding ranges. The
+    #   source itself has all the information it needs.
+    #
     # @param filename [String]
     # @return [Array<Range>]
     def folding_ranges filename
       read(filename).folding_ranges
     end
 
-    # @deprecated Libraries are no longer responsible for tracking open files.
-    #
-    # @return [Array<Source>]
-    def open_sources
-      logger.warn 'Library#open_sources is deprecated'
-      @current ? [@current] : []
-    end
-
     # Create a library from a directory.
     #
     # @param directory [String] The path to be used for the workspace
@@ -403,7 +375,7 @@ module Solargraph
       result = nil
       mutex.synchronize do
         result = workspace.merge(source)
-        @synchronized = result if synchronized?
+        @synchronized = !result if synchronized?
       end
       result
     end

data/lib/solargraph/live_map.rb

@@ -89,7 +89,7 @@ module Solargraph
         changed ||= p.refresh
       end
       if changed
-        STDERR.puts "Resetting LiveMap cache"
+        Solargraph::Logging.logger.debug "Resetting LiveMap cache"
         cache.clear
         get_constants('')
         get_methods('', '', 'class')

data/lib/solargraph/pin.rb

@@ -43,6 +43,7 @@ module Solargraph
     SUPERCLASS_REFERENCE = 14
     INCLUDE_REFERENCE = 15
     EXTEND_REFERENCE = 16
+    METHOD_ALIAS = 17
 
     ROOT_PIN = Pin::Namespace.new(nil, '', '', '', :class, :public)
   end

data/lib/solargraph/pin/base.rb

@@ -167,7 +167,7 @@ module Solargraph
       # @param api_map [ApiMap]
       # @return [ComplexType]
       def infer api_map
-        STDERR.puts "WARNING: Pin #infer methods are deprecated. Use #typify or #probe instead."
+        Solargraph::Logging.logger.warn "WARNING: Pin #infer methods are deprecated. Use #typify or #probe instead."
         type = typify(api_map)
         return type unless type.undefined?
         probe api_map

data/lib/solargraph/pin/base_method.rb

@@ -34,7 +34,7 @@ module Solargraph
         begin
           ComplexType.parse *tag.types
         rescue Solargraph::ComplexTypeError => e
-          STDERR.puts e.message
+          Solargraph::Logging.logger.warn e.message
           ComplexType::UNDEFINED
         end
       end

data/lib/solargraph/pin/method.rb

@@ -82,7 +82,7 @@ module Solargraph
 
       # @deprecated Use #typify and/or #probe instead
       def infer api_map
-        STDERR.puts 'WARNING: Pin #infer methods are deprecated. Use #typify or #probe instead.'
+        Solargraph::Logging.logger.warn 'WARNING: Pin #infer methods are deprecated. Use #typify or #probe instead.'
         type = typify(api_map)
         return type unless type.undefined?
         probe api_map

data/lib/solargraph/pin/method_alias.rb

@@ -1,19 +1,30 @@
 module Solargraph
   module Pin
     # Use this class to track method aliases for later remapping. Common
-    # examples are aliases for superclass methods or methods from included
-    # modules.
+    # examples that defer mapping are aliases for superclass methods or
+    # methods from included modules.
     #
-    class MethodAlias < Method
+    class MethodAlias < Base
+      attr_reader :scope
+
       attr_reader :original
 
       def initialize location, namespace, name, scope, original
         # @todo Determine how to handle these parameters. Among other things,
         #   determine if the visibility is defined by the location of the
         #   alias call or the original method.
-        super(location, namespace, name, '', scope, :public, [])
+        super(location, namespace, name, '')
+        @scope = scope
         @original = original
       end
+
+      def kind
+        Pin::METHOD_ALIAS
+      end
+
+      def path
+        @path ||= namespace + (scope == :instance ? '#' : '.') + name
+      end
     end
   end
 end

data/lib/solargraph/plugin/process.rb

@@ -48,7 +48,7 @@ module Solargraph
             require p
             @required.push p
           rescue Exception => e
-            STDERR.puts "Failed to require #{p}: #{e.message}"
+            Solargraph::Logging.logger.info "Failed to require #{p}: #{e.message}"
             errors.push "Failed to require #{p}: #{e.class} #{e.message}"
           end
         end

data/lib/solargraph/position.rb

@@ -44,7 +44,6 @@ module Solargraph
       column = position.character
       text.lines.each do |l|
         line_length = l.length
-        char_length = l.chomp.length
         if feed == line
           result += column
           break
@@ -85,7 +84,7 @@ module Solargraph
         cursor += line_length
         line += 1
       end
-      character = 0 if character.nil? and offset == cursor
+      character = 0 if character.nil? and (cursor - offset).between?(0, 1)
       raise InvalidOffsetError if character.nil?
       Position.new(line, character)
     end

data/lib/solargraph/server_methods.rb

@@ -2,6 +2,7 @@ require 'socket'
 
 module Solargraph
   module ServerMethods
+    # @return [Integer]
     def available_port
       socket = Socket.new(:INET, :STREAM, 0)
       socket.bind(Addrinfo.tcp("127.0.0.1", 0))

data/lib/solargraph/shell.rb

@@ -48,34 +48,6 @@ module Solargraph
       end
     end
 
-    desc 'suggest', 'Get code suggestions for the provided input'
-    long_desc <<-LONGDESC
-      Analyze a Ruby file and output a list of code suggestions in JSON format.
-    LONGDESC
-    option :line, type: :numeric, aliases: :l, desc: 'Zero-based line number', required: true
-    option :column, type: :numeric, aliases: [:c, :col], desc: 'Zero-based column number', required: true
-    option :filename, type: :string, aliases: :f, desc: 'File name', required: false
-    def suggest(*filenames)
-      STDERR.puts "WARNING: The `solargraph suggest` command is a candidate for deprecation. It will either change drastically or not exist in a future version."
-      # HACK: The ARGV array needs to be manipulated for ARGF.read to work
-      ARGV.clear
-      ARGV.concat filenames
-      text = ARGF.read
-      filename = options[:filename] || filenames[0]
-      begin
-        code_map = CodeMap.new(code: text, filename: filename)
-        offset = code_map.get_offset(options[:line], options[:column])
-        sugg = code_map.suggest_at(offset, filtered: true)
-        result = { "status" => "ok", "suggestions" => sugg }.to_json
-        STDOUT.puts result
-      rescue Exception => e
-        STDERR.puts e
-        STDERR.puts e.backtrace.join("\n")
-        result = { "status" => "err", "message" => e.message + "\n" + e.backtrace.join("\n") }.to_json
-        STDOUT.puts result
-      end
-    end
-
     desc 'config [DIRECTORY]', 'Create or overwrite a default configuration file'
     option :extensions, type: :boolean, aliases: :e, desc: 'Add installed extensions', default: true
     def config(directory = '.')

data/lib/solargraph/source.rb

@@ -18,6 +18,9 @@ module Solargraph
     include EncodingFixes
     include NodeMethods
 
+    # @return [String]
+    attr_reader :filename
+
     # @return [String]
     attr_reader :code
 
@@ -27,9 +30,6 @@ module Solargraph
     # @return [Array<Parser::Source::Comment>]
     attr_reader :comments
 
-    # @return [String]
-    attr_reader :filename
-
     # @todo Deprecate?
     # @return [Integer]
     attr_reader :version
@@ -64,10 +64,16 @@ module Solargraph
     end
 
     # @param range [Solargraph::Range]
+    # @return [String]
     def at range
       from_to range.start.line, range.start.character, range.ending.line, range.ending.character
     end
 
+    # @param l1 [Integer]
+    # @param c1 [Integer]
+    # @param l2 [Integer]
+    # @param c2 [Integer]
+    # @return [String]
     def from_to l1, c1, l2, c2
       b = Solargraph::Position.line_char_to_offset(@code, l1, c1)
       e = Solargraph::Position.line_char_to_offset(@code, l2, c2)
@@ -97,8 +103,53 @@ module Solargraph
       stack
     end
 
+    # Start synchronizing the source. This method updates the code without
+    # parsing a new AST. The resulting Source object will be marked not
+    # synchronized (#synchronized? == false).
+    #
+    # @param updater [Source::Updater]
+    # @return [Source]
+    def start_synchronize updater
+      raise 'Invalid synchronization' unless updater.filename == filename
+      real_code = updater.write(@code)
+      src = Source.allocate
+      src.filename = filename
+      src.code = real_code
+      src.version = updater.version
+      src.parsed = parsed?
+      src.repaired = updater.repair(@repaired)
+      src.synchronized = false
+      src.node = @node
+      src.comments = @comments
+      src.error_ranges = error_ranges
+      src.last_updater = updater
+      src
+    end
+
+    # Finish synchronizing a source that was updated via #start_synchronize.
+    # This method returns self if the source is already synchronized. Otherwise
+    # it parses the AST and returns a new synchronized Source.
+    #
+    # @return [Source]
+    def finish_synchronize
+      return self if synchronized?
+      synced = Source.new(@code, filename)
+      if synced.parsed?
+        synced.version = version
+        return synced
+      end
+      synced = Source.new(@repaired, filename)
+      synced.error_ranges.concat (error_ranges + last_updater.changes.map(&:range))
+      synced.code = @code
+      synced.synchronized = true
+      synced.version = version
+      synced
+    end
+
+    # Synchronize the Source with an update. This method applies changes to the
+    # code, parses the new code's AST, and returns the resulting Source object.
+    #
     # @param updater [Source::Updater]
-    # @param reparse [Boolean]
     # @return [Source]
     def synchronize updater
       raise 'Invalid synchronization' unless updater.filename == filename
@@ -177,11 +228,9 @@ module Solargraph
       @error_ranges ||= []
     end
 
+    # @param node [Parser::AST::Node]
+    # @return [String]
     def code_for(node)
-      # @todo Using node locations on code with converted EOLs seems
-      #   slightly more efficient than calculating offsets.
-      # b = node.location.expression.begin.begin_pos
-      # e = node.location.expression.end.end_pos
       b = Position.line_char_to_offset(@code, node.location.line, node.location.column)
       e = Position.line_char_to_offset(@code, node.location.last_line, node.location.last_column)
       frag = code[b..e-1].to_s
@@ -191,8 +240,10 @@ module Solargraph
     # @param node [Parser::AST::Node]
     # @return [String]
     def comments_for node
-      arr = associated_comments[node.loc.line]
-      arr ? stringify_comment_array(arr) : nil
+      stringified_comments[node.loc.line] ||= begin
+        arr = associated_comments[node.loc.line]
+        arr ? stringify_comment_array(arr) : nil
+      end
     end
 
     # A location representing the file in its entirety.
@@ -219,11 +270,16 @@ module Solargraph
       @folding_ranges ||= begin
         result = []
         inner_folding_ranges node, result
-        result.concat comment_block_ranges
+        result.concat foldable_comment_block_ranges
         result
       end
     end
 
+    def synchronized?
+      @synchronized = true if @synchronized.nil?
+      @synchronized
+    end
+
     private
 
     # @param top [Parser::AST::Node]
@@ -249,7 +305,7 @@ module Solargraph
       @associated_comments ||= begin
         result = {}
         Parser::Source::Comment.associate_locations(node, comments).each_pair do |loc, all|
-          block = all.select{ |l| l.document? || code.lines[l.loc.line].strip.start_with?('#')}
+          block = all #.select{ |l| l.document? || code.lines[l.loc.line].strip.start_with?('#')}
           next if block.empty?
           result[loc.line] ||= []
           result[loc.line].concat block
@@ -266,6 +322,7 @@ module Solargraph
       ctxt = ''
       num = nil
       started = false
+      last_line = nil
       comments.each { |l|
         # Trim the comment and minimum leading whitespace
         p = l.text.gsub(/^#/, '')
@@ -276,11 +333,21 @@ module Solargraph
           cur = p.index(/[^ ]/)
           num = cur if cur < num
         end
+        # Include blank lines between comments
+        ctxt += ("\n" * (l.loc.first_line - last_line - 1)) unless last_line.nil?
         ctxt += "#{p[num..-1]}\n" if started
+        last_line = l.loc.last_line
       }
       ctxt
     end
 
+    # A hash of line numbers and their associated comments.
+    #
+    # @return [Hash{Integer => Array<String>}]
+    def stringified_comments
+      @stringified_comments ||= {}
+    end
+
     # @return [Array<Range>]
     def string_ranges
       @string_ranges ||= string_ranges_in(@node)
@@ -293,7 +360,12 @@ module Solargraph
       end
     end
 
-    def comment_block_ranges
+    # Get an array of foldable comment block ranges. Blocks are excluded if
+    # they are less than 3 lines long.
+    #
+    # @return [Array<Range>]
+    def foldable_comment_block_ranges
+      return [] unless synchronized?
       result = []
       grouped = []
       # @param cmnt [Parser::Source::Comment]
@@ -304,13 +376,17 @@ module Solargraph
           if grouped.empty? || cmnt.loc.expression.line == grouped.last.loc.expression.line + 1
             grouped.push cmnt
           else
-            result.push Range.from_to(grouped.first.loc.expression.line, 0, grouped.last.loc.expression.line, 0) unless grouped.empty?
+            result.push Range.from_to(grouped.first.loc.expression.line, 0, grouped.last.loc.expression.line, 0) unless grouped.length < 3
             grouped = [cmnt]
           end
         else
-          result.push Range.from_to(grouped.first.loc.expression.line, 0, grouped.last.loc.expression.line, 0) unless grouped.empty?
+          unless grouped.length < 3
+            result.push Range.from_to(grouped.first.loc.expression.line, 0, grouped.last.loc.expression.line, 0)
+          end
+          grouped.clear
         end
       end
+      result.push Range.from_to(grouped.first.loc.expression.line, 0, grouped.last.loc.expression.line, 0) unless grouped.length < 3
       result
     end
 
@@ -339,12 +415,13 @@ module Solargraph
       end
     end
 
+    # @param name [String]
+    # @param top [AST::Node]
+    # @return [Array<AST::Node>]
     def inner_node_references name, top
       result = []
-      if top.kind_of?(AST::Node)
-        if top.children.any?{|c| c.to_s == name}
-          result.push top
-        end
+      if top.is_a?(AST::Node)
+        result.push top if top.children.any? { |c| c.to_s == name }
         top.children.each { |c| result.concat inner_node_references(name, c) }
       end
       result
@@ -352,18 +429,36 @@ module Solargraph
 
     protected
 
+    # @return [String]
+    attr_writer :filename
+
     # @return [Integer]
     attr_writer :version
 
     # @return [String]
     attr_writer :code
 
+    # @return [Parser::AST::Node]
+    attr_writer :node
+
+    # @return [Array<Range>]
+    attr_writer :error_ranges
+
     # @return [String]
     attr_accessor :repaired
 
     # @return [Boolean]
     attr_writer :parsed
 
+    # @return [Array<Parser::Source::Comment>]
+    attr_writer :comments
+
+    # @return [Boolean]
+    attr_writer :synchronized
+
+    # @return [Source::Updater]
+    attr_accessor :last_updater
+
     class << self
       # @param filename [String]
       # @return [Solargraph::Source]
@@ -392,7 +487,8 @@ module Solargraph
       end
 
       # @param code [String]
-      # @param filename [String]
+      # @param filename [String, nil]
+      # @param line [Integer]
       # @return [Parser::AST::Node]
       def parse code, filename = nil, line = 0
         buffer = Parser::Source::Buffer.new(filename, line)