solargraph 0.20.0 → 0.21.0

data/lib/solargraph/language_server/request.rb

@@ -7,7 +7,7 @@ module Solargraph
       end
 
       def process result
-        @block.call(result)
+        @block.call(result) unless @block.nil?
       end
     end
   end

data/lib/solargraph/language_server/transport.rb

@@ -1,6 +1,7 @@
 module Solargraph
   module LanguageServer
     module Transport
+      autoload :DataReader, 'solargraph/language_server/transport/data_reader'
       autoload :Socket, 'solargraph/language_server/transport/socket'
     end
   end

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

@@ -0,0 +1,66 @@
+module Solargraph
+  module LanguageServer
+    module Transport
+      class DataReader
+        def initialize
+          @in_header = true
+          @content_length = 0
+          @buffer = ''
+        end
+
+        # Declare a block to be executed for each message received from the
+        # client.
+        #
+        # @yieldparam [Hash] The message received from the client
+        def set_message_handler &block
+          @message_handler = block
+        end
+
+        # Process raw data received from the client. The data will be parsed
+        # into messages based on the JSON-RPC protocol. Each message will be
+        # passed to the block declared via set_message_handler. Incomplete data
+        # will be buffered and subsequent data will be appended to the buffer.
+        #
+        # @param data [String]
+        def receive data
+          data.each_char do |char|
+            @buffer.concat char
+            if @in_header
+              prepare_to_parse_message if @buffer.end_with?("\r\n\r\n")
+            else
+              parse_message_from_buffer if @buffer.bytesize == @content_length
+            end
+          end
+        end
+
+        private
+
+        def prepare_to_parse_message
+          @in_header = false
+          @buffer.each_line do |line|
+            parts = line.split(':').map(&:strip)
+            if parts[0] == 'Content-Length'
+              @content_length = parts[1].to_i
+              break
+            end
+          end
+          @buffer.clear
+        end
+
+        def parse_message_from_buffer
+          begin
+            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}"
+          ensure
+            @buffer.clear
+            @in_header = true
+            @content_length = 0
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -11,50 +11,26 @@ module Solargraph
           @content_length = 0
           @buffer = ''
           @host = Solargraph::LanguageServer::Host.new
+          @data_reader = Solargraph::LanguageServer::Transport::DataReader.new
+          @data_reader.set_message_handler do |message|
+            process message
+          end
           start_timers
         end
 
-        def process request
+        def process message
           Thread.new do
-            message = @host.start(request)
+            message = @host.start(message)
             message.send
             tmp = @host.flush
             send_data tmp unless tmp.empty?
-            GC.start unless request['method'] == 'textDocument/didChange'
+            GC.start unless message['method'] == 'textDocument/didChange'
           end
         end
 
         # @param data [String]
         def receive_data data
-          data.each_char do |char|
-            @buffer.concat char
-            if @in_header
-              if @buffer.end_with?("\r\n\r\n")
-                @in_header = false
-                @buffer.each_line do |line|
-                  parts = line.split(':').map(&:strip)
-                  if parts[0] == 'Content-Length'
-                    @content_length = parts[1].to_i
-                    break
-                  end
-                end
-                @buffer.clear
-              end
-            else
-              if @buffer.bytesize == @content_length
-                begin
-                  process JSON.parse(@buffer)
-                rescue JSON::ParserError => e
-                  STDERR.puts "Failed to parse request: #{e.message}"
-                  STDERR.puts "Buffer: #{@buffer}"
-                ensure
-                  @buffer.clear
-                  @in_header = true
-                  @content_length = 0
-                end
-              end
-            end
-          end
+          @data_reader.receive data
         end
 
         private

data/lib/solargraph/library.rb

@@ -162,7 +162,7 @@ module Solargraph
     # will be removed from the ApiMap. Only one file can be checked out
     # (virtualized) at a time.
     #
-    # @raise [FileNotFoundError] if the file is not in the library.
+    # @raise [FileNotFoundError] if the file does not exist.
     #
     # @param filename [String]
     # @return [Source]
@@ -256,14 +256,19 @@ module Solargraph
       @workspace
     end
 
-    # @raise [FileNotFoundError] if the file is not open
+    # 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
+    # version.
+    #
+    # @raise [FileNotFoundError] if the file does not exist
     # @param filename [String]
     # @return [Solargraph::Source]
     def read filename
-      source = source_hash[filename]
-      raise FileNotFoundError, "Source not found for #{filename}" if source.nil?
-      # api_map.virtualize source
-      source
+      return source_hash[filename] if open?(filename)
+      return workspace.source(filename) if workspace.has_file?(filename)
+      raise FileNotFoundError, "File not found: #{filename}" unless File.file?(filename)
+      Solargraph::Source.load(filename)
     end
   end
 end

data/lib/solargraph/page.rb

@@ -14,7 +14,7 @@ module Solargraph
         end
         define_singleton_method :erb do |template, layout: false, locals: {}|
           render_method.call(template, layout: layout, locals: locals)
-        end        
+        end
       end
 
       def htmlify text

data/lib/solargraph/pin/base.rb

@@ -6,20 +6,25 @@ module Solargraph
       include Conversions
       include Documenting
 
+      # @return [Solargraph::Source::Location]
       attr_reader :location
 
       # @return [String]
       attr_reader :namespace
 
+      # @return [String]
       attr_reader :name
 
+      # @return [YARD::Docstring]
       attr_reader :docstring
 
       # @return [String]
       attr_reader :return_type
 
+      # @return [Integer]
       attr_reader :kind
 
+      # @return [String]
       attr_reader :path
 
       def initialize location, namespace, name, docstring
@@ -29,18 +34,12 @@ module Solargraph
         @docstring = docstring
       end
 
+      # @return [String]
       def filename
         location.filename
       end
 
-      # @return [String]
-      def path
-      end
-
       # @return [Integer]
-      def kind
-      end
-
       def completion_item_kind
         LanguageServer::CompletionItemKinds::KEYWORD
       end
@@ -49,6 +48,7 @@ module Solargraph
         name.to_s
       end
 
+      # @return [String]
       def identifier
         @identifier ||= "#{path}|#{name}"
       end
@@ -57,6 +57,7 @@ module Solargraph
         false
       end
 
+      # @return [String]
       def named_context
         namespace
       end

data/lib/solargraph/pin/method_parameter.rb

@@ -1,20 +1,6 @@
 module Solargraph
   module Pin
-    class MethodParameter < Base
-      include Localized
-
-      attr_reader :block
-
-      def initialize location, namespace, name, docstring, block
-        super(location, namespace, name, docstring)
-        @block = block
-        @presence = block.location.range
-      end
-
-      def completion_item_kind
-        Solargraph::LanguageServer::CompletionItemKinds::VARIABLE
-      end
-
+    class MethodParameter < LocalVariable
       def return_type
         if @return_type.nil? and !block.docstring.nil?
           found = nil
@@ -25,6 +11,7 @@ module Solargraph
           end
           @return_type = found.types[0] unless found.nil? or found.types.nil?
         end
+        super
         @return_type
       end
     end

data/lib/solargraph/pin/yard_object.rb

@@ -88,7 +88,7 @@ module Solargraph
       end
 
       def visibility
-        :public #@todo Resolve this
+        @visibility ||= (code_object.respond_to?(:visibility) ? code_object.visibility : :public)
       end
 
       def scope

data/lib/solargraph/plugin/runtime.rb

@@ -44,7 +44,6 @@ module Solargraph
           false
         else
           if @current_required != api_map.required
-            STDERR.puts "Restarting #{self.class} process"
             @io.close unless @io.nil? or @io.closed?
             start_process
             true
@@ -70,7 +69,6 @@ module Solargraph
         unless api_map.nil? or api_map.workspace.nil?
           dir = api_map.workspace
         end
-        STDERR.puts "Starting #{self.class} process in #{dir}"
         Dir.chdir(dir) do
           @io = IO.popen(executable, 'r+')
         end

data/lib/solargraph/shell.rb

@@ -16,30 +16,6 @@ module Solargraph
       puts Solargraph::VERSION
     end
 
-    desc 'server', 'Start a Solargraph server'
-    option :port, type: :numeric, aliases: :p, desc: 'The server port', default: 7657
-    option :views, type: :string, aliases: :v, desc: 'The view template directory', default: nil
-    option :files, type: :string, aliases: :f, desc: 'The public files directory', default: nil
-    def server
-      port = options[:port]
-      port = available_port if port.zero?
-      Solargraph::Server.set :port, port
-      Solargraph::Server.set :views, options[:views] unless options[:views].nil?
-      Solargraph::Server.set :public_folder, options[:files] unless options[:files].nil?
-      my_pid = nil
-      Solargraph::Server.run! do
-        # This line should not be necessary with WEBrick
-        #STDERR.puts "Solargraph server pid=#{Process.pid} port=#{port}"
-        my_pid = Process.pid
-        Signal.trap("INT") do
-          Solargraph::Server.stop!
-        end
-        Signal.trap("TERM") do
-          Solargraph::Server.stop!
-        end
-      end
-    end
-
     desc 'socket', 'Run a Solargraph socket server'
     option :host, type: :string, aliases: :h, desc: 'The server host', default: '127.0.0.1'
     option :port, type: :numeric, aliases: :p, desc: 'The server port', default: 7658

data/lib/solargraph/source.rb

@@ -58,7 +58,7 @@ module Solargraph
       @version = 0
       begin
         parse
-      rescue Parser::SyntaxError
+      rescue Parser::SyntaxError, EncodingError
         hard_fix_node
       end
     end
@@ -79,7 +79,6 @@ module Solargraph
 
     # @return [Array<String>]
     def namespaces
-      # @namespaces ||= namespace_pin_map.keys
       @namespaces ||= pins.select{|pin| pin.kind == Pin::NAMESPACE}.map(&:path)
     end
 
@@ -156,25 +155,6 @@ module Solargraph
       found || pins.first
     end
 
-    # @return [YARD::Docstring]
-    def docstring_for node
-      return @docstring_hash[node.loc] if node.respond_to?(:loc)
-      nil
-    end
-
-    # @return [String]
-    def code_for node
-      b = node.location.expression.begin.begin_pos
-      e = node.location.expression.end.end_pos
-      frag = code[b..e-1].to_s
-      frag.strip.gsub(/,$/, '')
-    end
-
-    # @param node [Parser::AST::Node]
-    def tree_for node
-      @node_tree[node.object_id] || []
-    end
-
     # Get the nearest node that contains the specified index.
     #
     # @param index [Integer]
@@ -203,6 +183,7 @@ module Solargraph
     end
 
     def inner_tree_at node, offset, stack
+      return if node.nil?
       stack.unshift node
       node.children.each do |c|
         next unless c.is_a?(AST::Node)
@@ -214,47 +195,6 @@ module Solargraph
       end
     end
 
-    # Find the nearest parent node from the specified index. If one or more
-    # types are provided, find the nearest node whose type is in the list.
-    #
-    # @param index [Integer]
-    # @param types [Array<Symbol>]
-    # @return [AST::Node]
-    def parent_node_from(line, column, *types)
-      arr = tree_at(line, column)
-      arr.each { |a|
-        if a.kind_of?(AST::Node) and (types.empty? or types.include?(a.type))
-          return a
-        end
-      }
-      nil
-    end
-
-    # @return [String]
-    def namespace_for node
-      parts = []
-      ([node] + (@node_tree[node.object_id] || [])).each do |n|
-        next unless n.kind_of?(AST::Node)
-        if n.type == :class or n.type == :module
-          parts.unshift unpack_name(n.children[0])
-        end
-      end
-      parts.join('::')
-    end
-
-    def path_for node
-      path = namespace_for(node) || ''
-      mp = (method_pins + attribute_pins).select{|p| p.node == node}.first
-      unless mp.nil?
-        path += (mp.scope == :instance ? '#' : '.') + mp.name
-      end
-      path
-    end
-
-    def include? node
-      node_object_ids.include? node.object_id
-    end
-
     def synchronize updater
       raise 'Invalid synchronization' unless updater.filename == filename
       original_code = @code
@@ -266,11 +206,11 @@ module Solargraph
       begin
         parse
         @fixed = @code
-      rescue Parser::SyntaxError => e
+      rescue Parser::SyntaxError, EncodingError => e
         @fixed = updater.repair(original_fixed)
         begin
           parse
-        rescue Parser::SyntaxError => e
+        rescue Parser::SyntaxError, EncodingError => e
           hard_fix_node
         end
       end
@@ -284,7 +224,6 @@ module Solargraph
 
     def all_symbols
       result = []
-      # result.concat namespace_pin_map.values.flatten
       result.concat namespace_pins.reject{ |pin| pin.name.empty? }
       result.concat method_pins
       result.concat constant_pins
@@ -301,14 +240,6 @@ module Solargraph
       Fragment.new(self, line, column)
     end
 
-    def fragment_for node
-      inside = tree_for(node)
-      return nil if inside.empty?
-      line = node.loc.expression.last_line - 1
-      column = node.loc.expression.last_column
-      Fragment.new(self, line, column, inside)
-    end
-
     def parsed?
       @parsed
     end
@@ -337,7 +268,7 @@ module Solargraph
       parser.diagnostics.all_errors_are_fatal = true
       parser.diagnostics.ignore_warnings      = true
       buffer = Parser::Source::Buffer.new(filename, 1)
-      buffer.source = code.force_encoding(Encoding::UTF_8)
+      buffer.source = code.encode('UTF-8', 'binary', invalid: :replace, undef: :replace, replace: ' ')
       parser.parse_with_comments(buffer)
     end
 
@@ -346,59 +277,6 @@ module Solargraph
       @stime = Time.now
     end
 
-    def associate_comments node, comments
-      return nil if comments.nil?
-      comment_hash = Parser::Source::Comment.associate_locations(node, comments)
-      yard_hash = {}
-      comment_hash.each_pair { |k, v|
-        ctxt = ''
-        num = nil
-        started = false
-        v.each { |l|
-          # Trim the comment and minimum leading whitespace
-          p = l.text.gsub(/^#/, '')
-          if num.nil? and !p.strip.empty?
-            num = p.index(/[^ ]/)
-            started = true
-          elsif started and !p.strip.empty?
-            cur = p.index(/[^ ]/)
-            num = cur if cur < num
-          end
-          if started
-            ctxt += "#{p[num..-1]}\n"
-          end
-        }
-        parse = YARD::Docstring.parser.parse(ctxt)
-        unless parse.directives.empty?
-          @directives[k] ||= []
-          @directives[k].concat parse.directives
-        end
-        yard_hash[k] = parse.to_docstring
-      }
-      yard_hash
-    end
-
-    def find_parent(stack, *types)
-      stack.reverse.each { |p|
-        return p if types.include?(p.type)
-      }
-      nil
-    end
-
-    def node_object_ids
-      @node_object_ids ||= @all_nodes.map(&:object_id)
-    end
-
-    # @return [Hash<String, Solargraph::Pin::Namespace>]
-    def namespace_pin_map
-      @namespace_pin_map ||= {}
-    end
-
-    # @return [Hash<String, Solargraph::Pin::Namespace>]
-    def method_pin_map
-      @method_pin_map ||= {}
-    end
-
     class << self
       # @return [Solargraph::Source]
       def load filename
@@ -410,48 +288,6 @@ module Solargraph
       def load_string code, filename = nil
         Source.new code, filename
       end
-
-      def fix code, filename = nil, offset = nil
-        tries = 0
-        offset = Source.get_offset(code, offset[0], offset[1]) if offset.kind_of?(Array)
-        pos = nil
-        pos = get_position_at(code, offset) unless offset.nil?
-        stubs = []
-        fixed_position = false
-        tmp = code.sub(/\.(\s*\z)$/, ' \1')
-        begin
-          node, comments = Source.parse(tmp, filename)
-          Source.new(code, node, comments, filename, stubs)
-        rescue Parser::SyntaxError => e
-          if tries < 10
-            tries += 1
-            # Stub periods before the offset to retain the expected node tree
-            if !offset.nil? and ['.', '{', '('].include?(tmp[offset-1])
-              tmp = tmp[0, offset-1] + ';' + tmp[offset..-1]
-            elsif !fixed_position and !offset.nil?
-              fixed_position = true
-              beg = beginning_of_line_from(tmp, offset)
-              tmp = "#{tmp[0, beg]}##{tmp[beg+1..-1]}"
-              stubs.push(pos[0])
-            elsif e.message.include?('token $end')
-              tmp += "\nend"
-            elsif e.message.include?("unexpected `@'")
-              tmp = tmp[0, e.diagnostic.location.begin_pos] + '_' + tmp[e.diagnostic.location.begin_pos+1..-1]
-            end
-            retry
-          end
-          STDERR.puts "Unable to parse file #{filename.nil? ? 'undefined' : filename}: #{e.message}"
-          node, comments = parse(code.gsub(/[^\s]/, ' '), filename)
-          Source.new(code, node, comments, filename)
-        end
-      end
-
-      def beginning_of_line_from str, i
-        while i > 0 and str[i-1] != "\n"
-          i -= 1
-        end
-        i
-      end
     end
   end
 end