solargraph 0.18.3 → 0.19.0

data/lib/solargraph/diagnostics/rubocop.rb

@@ -13,17 +13,17 @@ module Solargraph
         begin
           cmd = "rubocop -f j -s #{Shellwords.escape(filename)}"
           o, e, s = Open3.capture3(cmd, stdin_data: text)
-          make_array text, JSON.parse(o)
+          raise DiagnosticsError, "RuboCop is not available" if e.include?('Gem::Exception')
+          raise DiagnosticsError, "RuboCop returned empty data" if o.empty?
+          make_array JSON.parse(o)
         rescue JSON::ParserError
           raise DiagnosticsError, 'RuboCop returned invalid data'
-        rescue Exception => e
-          raise DiagnosticsError, 'An internal error occurred while running diagnostics'
         end
       end
 
       private
 
-      def make_array text, resp
+      def make_array resp
         severities = {
           'refactor' => 4,
           'convention' => 3,

data/lib/solargraph/language_server/host.rb

@@ -24,7 +24,7 @@ module Solargraph
 
       # @param update [Hash]
       def configure update
-        options.merge! update
+        options.merge! update unless update.nil?
       end
 
       # @return [Hash]
@@ -51,15 +51,17 @@ module Solargraph
         begin
           message.process
         rescue Exception => e
+          STDERR.puts e.message
+          STDERR.puts e.backtrace
           message.set_error Solargraph::LanguageServer::ErrorCodes::INTERNAL_ERROR, "[#{e.class}] #{e.message}"
         end
         message
       end
 
       def create uri
+        filename = uri_to_file(uri)
         @change_semaphore.synchronize do
-          filename = uri_to_file(uri)
-          library.create filename, File.read(filename)
+          library.create_from_disk filename
         end
       end
 
@@ -142,7 +144,15 @@ module Solargraph
         path = nil
         path = normalize_separators(directory) unless directory.nil?
         @change_semaphore.synchronize do
-          @library = Solargraph::Library.load(path)
+          begin
+            @library = Solargraph::Library.load(path)
+          rescue WorkspaceTooLargeError => e
+            send_notification 'window/showMessage', {
+              'type' => Solargraph::LanguageServer::MessageTypes::WARNING,
+              'message' => "The workspace is too large to index (#{e.size} files, max #{Workspace::MAX_WORKSPACE_SIZE})"
+            }
+            @library = Solargraph::Library.load(nil)
+          end
         end
       end
 
@@ -195,34 +205,46 @@ module Solargraph
       end
 
       def completions_at filename, line, column
-        results = nil
+        result = nil
         @change_semaphore.synchronize do
-          results = library.completions_at filename, line, column
+          result = library.completions_at filename, line, column
         end
-        results
+        result
       end
 
       # @return [Array<Solargraph::Pin::Base>]
       def definitions_at filename, line, column
-        results = []
+        result = []
         @change_semaphore.synchronize do
-          results = library.definitions_at(filename, line, column)
+          result = library.definitions_at(filename, line, column)
         end
-        results
+        result
       end
 
       def signatures_at filename, line, column
-        results = nil
+        result = nil
         @change_semaphore.synchronize do
-          results = library.signatures_at(filename, line, column)
+          result = library.signatures_at(filename, line, column)
         end
-        results
+        result
       end
 
       def query_symbols query
-        results = nil
-        @change_semaphore.synchronize { results = library.query_symbols(query) }
-        results
+        result = nil
+        @change_semaphore.synchronize { result = library.query_symbols(query) }
+        result
+      end
+
+      def search query
+        result = nil
+        @change_semaphore.synchronize { result = library.search(query) }
+        result
+      end
+
+      def document query
+        result = nil
+        @change_semaphore.synchronize { result = library.document(query) }
+        result
       end
 
       def file_symbols uri
@@ -323,8 +345,20 @@ module Solargraph
                   }
                 end
               end
-            rescue Exception => e
-              STDERR.puts "Error in diagnostics: #{e.class}"
+            rescue DiagnosticsError => e
+              STDERR.puts "Error in diagnostics: #{e.message}"
+              options['diagnostics'] = false
+              send_notification 'window/showMessage', {
+                type: LanguageServer::MessageTypes::ERROR,
+                message: "Error in diagnostics: #{e.message}"
+              }
+            rescue Errno::ENOENT => e
+              STDERR.puts "Error in diagnostics: RuboCop could not be found"
+              options['diagnostics'] = false
+              send_notification 'window/showMessage', {
+                type: LanguageServer::MessageTypes::ERROR,
+                message: "Error in diagnostics: RuboCop could not be found"
+              }
             end
           end
         end
@@ -340,7 +374,7 @@ module Solargraph
         params['contentChanges'].each do |chng|
           changes.push Solargraph::Source::Change.new(
             (chng['range'].nil? ? 
-              nil : 
+              nil :
               Solargraph::Source::Range.from_to(chng['range']['start']['line'], chng['range']['start']['character'], chng['range']['end']['line'], chng['range']['end']['character'])
             ),
             chng['text']

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

@@ -4,7 +4,7 @@ module Solargraph
       module Extended
         class Document < Base
           def process
-            objects = host.library.document(params['query'])
+            objects = host.document(params['query'])
             page = Solargraph::Page.new(host.options['viewsPath'])
             content = page.render('document', locals: {objects: objects})
             set_result(

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

@@ -4,7 +4,7 @@ module Solargraph
       module Extended
         class Search < Base
           def process
-            results = host.library.search(params['query'])
+            results = host.search(params['query'])
             page = Solargraph::Page.new(host.options['viewsPath'])
             content = page.render('search', locals: {query: params['query'], results: results})
             set_result(

data/lib/solargraph/language_server/message/method_not_found.rb

@@ -5,7 +5,7 @@ module Solargraph
         def process
           set_error(
             Solargraph::LanguageServer::ErrorCodes::METHOD_NOT_FOUND,
-            "Method not found: #{request['message']}"
+            "Method not found: #{request['method']}"
           )
         end
       end

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

@@ -13,22 +13,9 @@ module Solargraph::LanguageServer::Message::TextDocument
       suggestions = host.definitions_at(filename, line, col)
       locations = suggestions.map do |pin|
         unless pin.location.nil?
-          parts = pin.location.split(':')
-          char = parts.pop.to_i
-          line = parts.pop.to_i
-          filename = parts.join(':')
           {
-            uri: file_to_uri(filename),
-            range: {
-              start: {
-                line: line,
-                character: char
-              },
-              end: {
-                line: line,
-                character: char
-              }
-            }
+            uri: file_to_uri(pin.location.filename),
+            range: pin.location.range.to_hash
           }
         end
       end

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

@@ -4,25 +4,12 @@ class Solargraph::LanguageServer::Message::TextDocument::DocumentSymbol < Solarg
   def process
     pins = host.file_symbols params['textDocument']['uri']
     info = pins.map do |pin|
-      parts = pin.location.split(':')
-      char = parts.pop.to_i
-      line = parts.pop.to_i
-      filename = parts.join(':')
       {
         name: pin.path,
         kind: Solargraph::LanguageServer::SymbolKinds::NAMESPACE,
         location: {
-          uri: file_to_uri(filename),
-          range: {
-            start: {
-              line: line,
-              character: char
-            },
-            end: {
-              line: line,
-              character: char
-            }
-          }
+          uri: file_to_uri(pin.location.filename),
+          range: pin.location.range.to_hash
         }
       }
     end

data/lib/solargraph/language_server/message/workspace/workspace_symbol.rb

@@ -4,25 +4,13 @@ class Solargraph::LanguageServer::Message::Workspace::WorkspaceSymbol < Solargra
   def process
     pins = host.query_symbols(params['query'])
     info = pins.map do |pin|
-      parts = pin.location.split(':')
-      char = parts.pop.to_i
-      line = parts.pop.to_i
-      filename = parts.join(':')
+      uri = file_to_uri(pin.location.filename)
       {
         name: pin.path,
         kind: Solargraph::LanguageServer::SymbolKinds::NAMESPACE,
         location: {
-          uri: file_to_uri(filename),
-          range: {
-            start: {
-              line: line,
-              character: char
-            },
-            end: {
-              line: line,
-              character: char
-            }
-          }
+          uri: uri,
+          range: pin.location.range.to_hash
         }
       }
     end

data/lib/solargraph/language_server/message_types.rb

@@ -0,0 +1,10 @@
+module Solargraph
+  module LanguageServer
+    module MessageTypes
+      ERROR = 1
+      WARNING = 2
+      INFO = 3
+      LOG = 4
+    end
+  end
+end

data/lib/solargraph/language_server.rb

@@ -8,5 +8,6 @@ module Solargraph
     autoload :Message, 'solargraph/language_server/message'
     autoload :Transport, 'solargraph/language_server/transport'
     autoload :UriHelpers, 'solargraph/language_server/uri_helpers'
+    autoload :MessageTypes, 'solargraph/language_server/message_types'
   end
 end

data/lib/solargraph/library.rb

@@ -45,6 +45,14 @@ module Solargraph
       true
     end
 
+    def create_from_disk filename
+      return if File.directory?(filename) or !File.exist?(filename)
+      return unless workspace.would_merge?(filename)
+      source = Solargraph::Source.load_string(File.read(filename), filename)
+      workspace.merge(source)
+      api_map.refresh
+    end
+
     # Delete a file from the library. Deleting a file will make it unavailable
     # for checkout and optionally remove it from the workspace unless the
     # workspace configuration determines that it should still exist.

data/lib/solargraph/node_methods.rb

@@ -57,6 +57,9 @@ module Solargraph
         return 'Float'
       elsif node.type == :sym
         return 'Symbol'
+      # @todo Maybe ignore nils
+      # elsif node.type == :nil
+      #   return 'NilClass'
       end
       nil
     end
@@ -67,7 +70,9 @@ module Solargraph
     #
     # @return [String]
     def resolve_node_signature node
-      drill_signature node, ''
+      result = drill_signature node, ''
+      return nil if result.empty?
+      result
     end
 
     private

data/lib/solargraph/page.rb

@@ -41,7 +41,8 @@ module Solargraph
     end
     private_constant :Binder
 
-    def initialize directory
+    def initialize directory = VIEWS_PATH
+      directory = VIEWS_PATH if directory.nil? or !File.directory?(directory)
       @render_method = proc { |template, layout: false, locals: {}|
         binder = Binder.new(locals, @render_method)
         if layout

data/lib/solargraph/pin/attribute.rb

@@ -4,14 +4,18 @@ module Solargraph
       # @return [Symbol] :reader or :writer
       attr_reader :access
 
-      def initialize source, node, namespace, access, docstring
-        super(source, node, namespace)
+      def initialize location, namespace, name, docstring, access
+        super(location, namespace, name, docstring)
         @access = access
         @docstring = docstring
       end
 
-      def name
-        @name ||= "#{node.children[0]}#{access == :writer ? '=' : ''}"
+      def kind
+        Solargraph::Pin::ATTRIBUTE
+      end
+
+      def completion_item_kind
+        Solargraph::LanguageServer::CompletionItemKinds::PROPERTY
       end
 
       def path
@@ -25,14 +29,6 @@ module Solargraph
         end
         @return_type
       end
-
-      def completion_item_kind
-        Solargraph::LanguageServer::CompletionItemKinds::PROPERTY
-      end
-
-      def method?
-        true
-      end
     end
   end
 end

data/lib/solargraph/pin/base.rb

@@ -4,126 +4,51 @@ module Solargraph
   module Pin
     class Base
       include Conversions
+      include Documenting
 
-      # @return [Solargraph::Source]
-      attr_reader :source
-
-      # @return [Parser::AST::Node]
-      attr_reader :node
+      attr_reader :location
 
       # @return [String]
       attr_reader :namespace
 
-      def initialize source, node, namespace
-        @source = source
-        @node = node
-        @namespace = namespace
-      end
+      attr_reader :name
 
-      def contain?(index)
-        if index >= node.loc.expression.begin_pos
-          if node.respond_to?(:end)
-            if index < node.end.end_pos
-              return true
-            end
-          elsif index < node.loc.expression.end_pos
-            return true
-          end
-        end
-        false
-      end
-
-      # @return [YARD::Docstring]
-      def docstring
-        @docstring ||= source.docstring_for(node) unless source.nil?
-        @docstring
-      end
+      attr_reader :docstring
 
       # @return [String]
-      def name
-        nil
-      end
-
-      # @return [String]
-      def path
-        nil
-      end
+      attr_reader :return_type
 
-      # @return [Integer]
-      def completion_item_kind
-      end
+      attr_reader :kind
 
-      # @return [Integer]
-      def symbol_kind
-      end
+      attr_reader :path
 
-      # @return [Integer]
-      def kind
-        completion_item_kind
-      end
-
-      # @return [String]
-      def return_type
-        nil
-      end
-
-      # @return [String]
-      def signature
-        nil
-      end
-
-      # @return [String]
-      def value
-        nil
-      end
-
-      # @return [Array<String>]
-      def parameters
-        []
-      end
-
-      def arguments
-        parameters
+      def initialize location, namespace, name, docstring
+        @location = location
+        @namespace = namespace
+        @name = name
+        @docstring = docstring
       end
 
-      # @return [String]
       def filename
-        source.filename unless source.nil?
-      end
-
-      def location
-        "#{source.filename}:#{node.location.expression.line - 1}:#{node.location.expression.column}" unless source.nil? or node.nil?
+        location.filename
       end
 
       # @return [String]
-      def documentation
-        if @documentation.nil? and !docstring.nil?
-          @documentation = ReverseMarkdown.convert(helper.html_markup_rdoc(docstring), github_flavored: true)
-          @documentation.strip!
-        end
-        @documentation
+      def path
       end
 
-      # True if the suggestion has documentation.
-      # Useful for determining whether a client should resolve a suggestion's
-      # path to retrieve more information about it.
-      #
-      # @return [Boolean]
-      def has_doc?
-        !docstring.nil? and !docstring.all.empty?
+      # @return [Integer]
+      def kind
       end
 
-      def helper
-        @helper ||= Solargraph::Pin::Helper.new
+      def completion_item_kind
+        LanguageServer::CompletionItemKinds::KEYWORD
       end
 
       def to_s
         name.to_s
       end
 
-      def resolve api_map
-      end
-
       def identifier
         @identifier ||= "#{path}|#{name}"
       end
@@ -132,8 +57,8 @@ module Solargraph
         false
       end
 
-      def method?
-        false
+      def named_context
+        namespace
       end
     end
   end

data/lib/solargraph/pin/base_variable.rb

@@ -1,16 +1,19 @@
 module Solargraph
   module Pin
     class BaseVariable < Base
-      include NodeMethods
+      attr_reader :signature
 
-      def initialize source, node, namespace
-        super
-        @tried_to_detect_return_type = false
-        @tried_to_resolve_return_type = false
+      attr_reader :context
+
+      def initialize location, namespace, name, docstring, signature, literal, context
+        super(location, namespace, name, docstring)
+        @signature = signature
+        @literal = literal
+        @context = context
       end
 
-      def name
-        node.children[0].to_s
+      def scope
+        @scope ||= (context.kind == Pin::METHOD and context.scope == :instance ? :instance : :class)
       end
 
       def completion_item_kind
@@ -18,86 +21,24 @@ module Solargraph
       end
 
       def return_type
-        if @return_type.nil? and !@tried_to_detect_return_type
-          @tried_to_detect_return_type = true
-          if docstring.nil?
-            @return_type ||= infer_literal_node_type(assignment_node)
-          else
+        if @return_type.nil?
+          if !docstring.nil?
             tag = docstring.tag(:type)
             @return_type = tag.types[0] unless tag.nil?
+          else
+            @return_type = @literal
           end
         end
         @return_type
       end
 
-      def assignment_node
-        @assignment_node ||= node.children[(node.type == :casgn ? 2 : 1)]
-      end
-
       def nil_assignment?
-        assignment_node.nil? or assignment_node.type == :nil
-      end
-
-      def signature
-        @signature ||= resolve_node_signature(assignment_node)
-      end
-
-      def calculated_signature
-        if @calculated_signature.nil?
-          if signature.empty?
-            type = infer_literal_node_type(assignment_node)
-            @calculated_signature = "#{type}.new" unless type.nil?
-          end
-          @calculated_signature ||= signature
-        end
-        @calculated_signature
-      end
-
-      # @param api_map [Solargraph::ApiMap]
-      def resolve api_map
-        if return_type.nil? and !@tried_to_resolve_return_type
-          @tried_to_detect_return_type = true
-          return nil if signature.nil? or signature.empty? or signature == name or signature.split('.').first.strip == name
-          # @todo This should be able to resolve signatures that start with local variables
-          macro_type = nil
-          # pin = api_map.tail_pin(signature, namespace, :class, [:public, :private, :protected])
-          # unless pin.nil? or !pin.method?
-          #   macro_type = get_return_type_from_macro(pin, assignment_node)
-          # end
-          @return_type = macro_type || api_map.infer_type(signature, namespace, scope: :class)
-        end
+        return_type == 'NilClass'
       end
 
       def variable?
         true
       end
-
-      private
-
-      def get_call_arguments node
-        return get_call_arguments(node.children[1]) if [:ivasgn, :cvasgn, :lvasgn].include?(node.type)
-        return [] unless node.type == :send
-        result = []
-        node.children[2..-1].each do |c|
-          result.push unpack_name(c)
-        end
-        result
-      end
-
-      def get_return_type_from_macro method_pin, call_node
-        return nil if method_pin.docstring.nil?
-        type = nil
-        all = YARD::Docstring.parser.parse(method_pin.docstring.all).directives
-        macro = all.select{|m| m.tag.tag_name == 'macro'}.first
-        return nil if macro.nil?
-        macstring = YARD::Docstring.parser.parse(macro.tag.text).to_docstring
-        rt = macstring.tag(:return)
-        unless rt.nil? or rt.types.nil?
-          args = get_call_arguments(call_node)
-          type = "#{args[rt.types[0][1..-1].to_i-1]}"
-        end
-        type
-      end
     end
   end
 end

data/lib/solargraph/pin/block.rb

@@ -0,0 +1,21 @@
+module Solargraph
+  module Pin
+    class Block < Base
+      attr_reader :receiver
+      attr_reader :parameters
+
+      def initialize location, namespace, name, docstring, receiver
+        super(location, namespace, name, docstring)
+        @receiver = receiver
+      end
+
+      def kind
+        Pin::BLOCK
+      end
+
+      def parameters
+        @parameters ||= []
+      end
+    end
+  end
+end