solargraph 0.19.1 → 0.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 641234ab31a7a58d48d4f9ac92b50b7b7a648a48
-  data.tar.gz: 964eb2b062f2811e3365c3de84320996230f5ee3
+  metadata.gz: 0e1a1a75c9706d5d54ca2359b21bf336b9980bce
+  data.tar.gz: 618ae6ec9b01ddd2ee7656a34c787cc6b26bfc0b
 SHA512:
-  metadata.gz: 6042457038382e3ee2cf52af10477b25fe4c43c8dd45925aaf21bbc1c762bdfa2e39aeaf02ef7acdedf41ee5134992f887c1e63ff2a0437d10a7f4a6e11bc2e8
-  data.tar.gz: ff40baf86a70fb9e5b6359ac175610123c307f16011d8d5a2f694df9ea49e16b4a82c40cb0cec01ca3b9275399b91a9f815cbf91ecf8d5f89b05f8caec8ad68a
+  metadata.gz: 7ab817f132710bdb79f93773937cb8280dd764b07e7bd29f4b33064e097690a192afc219f6bbcf69b00d3ca1257cb8a6e90db91c9c8ee3109fa522f6ea054474
+  data.tar.gz: ccb208a618f8c891c6bfd102e45bd65a31307abc87bb51cd738ed64582eb0e1a45adbc4ba7e7248de64b5cc6760dfa68370eb6f883c63a18c340a2657e38a4b3

data/lib/solargraph.rb

@@ -1,6 +1,7 @@
 require 'solargraph/version'
 require 'rubygems/package'
 require 'yard-solargraph'
+require 'sinatra'
 
 module Solargraph
   class InvalidOffsetError <      RangeError; end

data/lib/solargraph/api_map.rb

@@ -45,13 +45,17 @@ module Solargraph
       store.pins
     end
 
+    def domains
+      @domains ||= []
+    end
+
     # An array of required paths in the workspace.
     #
     # @return [Array<String>]
     def required
       result = []
       @sources.each do |s|
-        result.concat s.required
+        result.concat s.required.map(&:name)
       end
       result.uniq
     end
@@ -84,6 +88,10 @@ module Solargraph
     # @return [Solargraph::Source]
     def virtualize source
       store.remove @virtual_source unless @virtual_source.nil?
+      domains.clear
+      domains.concat workspace.config.domains
+      domains.concat source.domains unless source.nil?
+      domains.uniq!
       if workspace.has_source?(source)
         @sources = workspace.sources
         @virtual_source = nil
@@ -158,10 +166,10 @@ module Solargraph
     # True if the namespace exists.
     #
     # @param name [String] The namespace to match
-    # @param root [String] The context to search
+    # @param context [String] The context to search
     # @return [Boolean]
-    def namespace_exists? name, root = ''
-      !qualify(name, root).nil?
+    def namespace_exists? name, context = ''
+      !qualify(name, context).nil?
     end
 
     # Get suggestions for constants in the specified namespace. The result
@@ -241,6 +249,10 @@ module Solargraph
       result = []
       skip = []
       if fqns == ''
+        domains.each do |domain|
+          namespace, scope = extract_namespace_and_scope(domain)
+          result.concat inner_get_methods(namespace, scope, [:public], deep, skip)
+        end
         result.concat inner_get_methods(fqns, :class, visibility, deep, skip)
         result.concat inner_get_methods(fqns, :instance, visibility, deep, skip)
         result.concat inner_get_methods('Kernel', :instance, visibility, deep, skip)
@@ -318,6 +330,12 @@ module Solargraph
       probe.infer_signature_type fragment.whole_signature, fragment.named_path, fragment.locals
     end
 
+    # Get an array of pins that describe the method being called by the
+    # argument list where the fragment is located. This is useful for queries
+    # that need to know what parameters the current method expects to receive.
+    #
+    # If the fragment is not inside an argument list, return an empty array.
+    #
     # @param fragment [Solargraph::Source::Fragment]
     # @return [Array<Solargraph::Pin::Base>]
     def signify fragment
@@ -373,6 +391,9 @@ module Solargraph
       docs
     end
 
+    # Get an array of all symbols in the workspace that match the query.
+    #
+    # @return [Array<Pin::Base>]
     def query_symbols query
       result = []
       @sources.each do |s|
@@ -473,6 +494,10 @@ module Solargraph
       result
     end
 
+    # Require extensions for the experimental plugin architecture. Any
+    # installed gem with a name that starts with "solargraph-" is considered
+    # an extension.
+    #
     def require_extensions
       Gem::Specification.all_names.select{|n| n.match(/^solargraph\-[a-z0-9_\-]*?\-ext\-[0-9\.]*$/)}.each do |n|
         STDERR.puts "Loading extension #{n}"

data/lib/solargraph/api_map/probe.rb

@@ -66,6 +66,7 @@ module Solargraph
         return [] if word.empty?
         lvars = locals.select{|pin| pin.name == word}
         return lvars unless lvars.empty?
+        return api_map.get_global_variable_pins.select{|pin| pin.name == word} if word.start_with?('$')
         namespace, scope = extract_namespace_and_scope_from_pin(context_pin)
         return api_map.pins.select{|pin| word_matches_context?(word, namespace, scope, pin)} if variable_name?(word)
         result = []
@@ -139,13 +140,12 @@ module Solargraph
       end
 
       # Extract a namespace and a scope from a pin. For now, the pin must
-      # be either a method or a namespace. It probably makes sense to support
-      # blocks at some point.
+      # be either a namespace, a method, or a block.
       #
       # @return [Array] The namespace (String) and scope (Symbol).
       def extract_namespace_and_scope_from_pin pin
         return [pin.namespace, pin.scope] if pin.kind == Pin::METHOD
-        return [pin.namespace, :class] if pin.kind == Pin::NAMESPACE
+        return [pin.path, :class] if pin.kind == Pin::NAMESPACE
         # @todo Is :class appropriate for blocks?
         return [pin.namespace, :class] if pin.kind == Pin::BLOCK
         raise "Unable to extract namespace and scope from #{pin.path}"

data/lib/solargraph/diagnostics.rb

@@ -1,5 +1,13 @@
 module Solargraph
   module Diagnostics
+    autoload :Base, 'solargraph/diagnostics/base'
+    autoload :Severities, 'solargraph/diagnostics/severities'
     autoload :Rubocop, 'solargraph/diagnostics/rubocop'
+    autoload :RequireNotFound, 'solargraph/diagnostics/require_not_found'
+
+    REPORTERS = {
+      'rubocop' => Rubocop,
+      'require_not_found' => RequireNotFound
+    }
   end
 end

data/lib/solargraph/diagnostics/base.rb

@@ -0,0 +1,12 @@
+module Solargraph
+  module Diagnostics
+    class Base
+      # @param source [Solargraph::Source]
+      # @param source [Solargraph::ApiMap]
+      #
+      # @return [Array<Hash>]
+      def diagnose source, api_map
+      end
+    end
+  end
+end

data/lib/solargraph/diagnostics/require_not_found.rb

@@ -0,0 +1,23 @@
+module Solargraph
+  module Diagnostics
+    class RequireNotFound < Base
+      def diagnose source, api_map
+        result = []
+        refs = {}
+        source.requires.each do |ref|
+          refs[ref.name] = ref
+        end
+        api_map.yard_map.unresolved_requires.each do |r|
+          next unless refs.has_key?(r)
+          result.push(
+            range: refs[r].location.range.to_hash,
+            severity: Diagnostics::Severities::WARNING,
+            source: 'Solargraph',
+            message: "Required path #{r} could not be resolved."
+          )
+        end
+        result
+      end
+    end
+  end
+end

data/lib/solargraph/diagnostics/rubocop.rb

@@ -2,28 +2,39 @@ require 'open3'
 require 'shellwords'
 
 module Solargraph
-
   module Diagnostics
-    class Rubocop
-      def initialize
+    class Rubocop < Base
+      # The rubocop command
+      #
+      # @return [String]
+      attr_reader :command
+
+      def initialize(command = 'rubocop')
+        @command = command
       end
 
       # @return [Array<Hash>]
-      def diagnose text, filename
+      def diagnose source, api_map
         begin
-          cmd = "rubocop -f j -s #{Shellwords.escape(filename)}"
+          text = source.code
+          filename = source.filename
+          raise DiagnosticsError, 'No command specified' if command.nil? or command.empty?
+          cmd = "#{Shellwords.escape(command)} -f j -s #{Shellwords.escape(filename)}"
           o, e, s = Open3.capture3(cmd, stdin_data: text)
-          raise DiagnosticsError, "RuboCop is not available" if e.include?('Gem::Exception')
+          raise DiagnosticsError, "Command '#{command}' is not available (gem exception)" 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 Errno::ENOENT
+          raise DiagnosticsError, "Command '#{command}' is not available"
         end
       end
 
       private
 
       def make_array resp
+        # Conversion of RuboCop severity names to LSP constants
         severities = {
           'refactor' => 4,
           'convention' => 3,

data/lib/solargraph/diagnostics/severities.rb

@@ -0,0 +1,13 @@
+module Solargraph
+  module Diagnostics
+    # These severity constants match the DiagnosticSeverity constants in the
+    # language server protocol.
+    #
+    module Severities
+      ERROR = 1
+      WARNING = 2
+      INFORMATION = 3
+      HINT = 4
+    end
+  end
+end

data/lib/solargraph/language_server.rb

@@ -4,10 +4,11 @@ require 'solargraph/language_server/symbol_kinds'
 
 module Solargraph
   module LanguageServer
-    autoload :Host, 'solargraph/language_server/host'
-    autoload :Message, 'solargraph/language_server/message'
-    autoload :Transport, 'solargraph/language_server/transport'
-    autoload :UriHelpers, 'solargraph/language_server/uri_helpers'
+    autoload :Host,         'solargraph/language_server/host'
+    autoload :Message,      'solargraph/language_server/message'
+    autoload :UriHelpers,   'solargraph/language_server/uri_helpers'
     autoload :MessageTypes, 'solargraph/language_server/message_types'
+    autoload :Request,      'solargraph/language_server/request'
+    autoload :Transport,    'solargraph/language_server/transport'
   end
 end

data/lib/solargraph/language_server/host.rb

@@ -4,7 +4,8 @@ require 'set'
 module Solargraph
   module LanguageServer
     # The language server protocol's data provider. Hosts are responsible for
-    # querying the library and processing messages.
+    # querying the library and processing messages. They also provide thread
+    # safety for multi-threaded transports.
     #
     class Host
       include Solargraph::LanguageServer::UriHelpers
@@ -18,10 +19,13 @@ module Solargraph
         @cancel = []
         @buffer = ''
         @stopped = false
+        @next_request_id = 0
         start_change_thread
         start_diagnostics_thread
       end
 
+      # Update the configuration options with the provided hash.
+      #
       # @param update [Hash]
       def configure update
         options.merge! update unless update.nil?
@@ -46,18 +50,36 @@ module Solargraph
         @cancel_semaphore.synchronize { @cancel.delete id }
       end
 
+      # Start processing a request from the client. After the message is
+      # processed, the transport is responsible for sending the response.
+      #
+      # @param request [Hash] The contents of the message.
+      # @return [Solargraph::LanguageServer::Message] The message handler.
       def start request
-        message = Message.select(request['method']).new(self, request)
-        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}"
+        if request['method']
+          message = Message.select(request['method']).new(self, request)
+          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
+        elsif request['id']
+          # @todo What if the id is invalid?
+          requests[request['id']].process(request['result'])
+          requests.delete request['id']
+        else
+          STDERR.puts "Invalid message received."
         end
-        message
       end
 
+      # Respond to a notification that a file was created in the workspace.
+      # The library will determine whether the file should be added to the
+      # workspace; see Solargraph::Library#create_from_disk.
+      #
+      # @param uri [String] The file uri.
       def create uri
         filename = uri_to_file(uri)
         @change_semaphore.synchronize do
@@ -65,6 +87,9 @@ module Solargraph
         end
       end
 
+      # Delete the specified file from the library.
+      #
+      # @param uri [String] The file uri.
       def delete uri
         @change_semaphore.synchronize do
           filename = uri_to_file(uri)
@@ -72,6 +97,11 @@ module Solargraph
         end
       end
 
+      # Open the specified file in the library.
+      #
+      # @param uri [String] The file uri.
+      # @param text [String] The contents of the file.
+      # @param version [Integer] A version number.
       def open uri, text, version
         @change_semaphore.synchronize do
           library.open uri_to_file(uri), text, version
@@ -79,6 +109,9 @@ module Solargraph
         end
       end
 
+      # True if the specified file is currently open in the library.
+      #
+      # @return [Boolean]
       def open? uri
         result = nil
         @change_semaphore.synchronize do
@@ -90,6 +123,7 @@ module Solargraph
       def close uri
         @change_semaphore.synchronize do
           library.close uri_to_file(uri)
+          @diagnostics_queue.push uri
         end
       end
 
@@ -124,12 +158,18 @@ module Solargraph
         end
       end
 
+      # Queue a message to be sent to the client.
+      #
+      # @param message [String] The message to send.
       def queue message
         @buffer_semaphore.synchronize do
           @buffer += message
         end
       end
 
+      # Clear the message buffer and return the most recent data.
+      #
+      # @return [String] The most recent data or an empty string.
       def flush
         tmp = nil
         @buffer_semaphore.synchronize do
@@ -139,6 +179,8 @@ module Solargraph
         tmp
       end
 
+      # Prepare a library for the specified directory.
+      #
       # @param directory [String]
       def prepare directory
         path = nil
@@ -156,6 +198,10 @@ module Solargraph
         end
       end
 
+      # Send a notification to the client.
+      #
+      # @param method [String] The message method
+      # @param params [Hash] The method parameters
       def send_notification method, params
         response = {
           jsonrpc: "2.0",
@@ -167,6 +213,29 @@ module Solargraph
         queue envelope
       end
 
+      # Send a request to the client and execute the provided block to process
+      # the response.
+      #
+      # @param method [String] The message method
+      # @param params [Hash] The method parameters
+      # @yieldparam [Hash] The result sent by the client
+      def send_request method, params, &block
+        message = {
+          jsonrpc: "2.0",
+          method: method,
+          params: params,
+          id: @next_request_id
+        }
+        json = message.to_json
+        requests[@next_request_id] = Request.new(@next_request_id, &block)
+        envelope = "Content-Length: #{json.bytesize}\r\n\r\n#{json}"
+        queue envelope
+        @next_request_id += 1
+      end
+
+      # True if the specified file is in the process of changing.
+      #
+      # @return [Boolean]
       def changing? file_uri
         result = false
         @change_semaphore.synchronize do
@@ -251,6 +320,29 @@ module Solargraph
         library.file_symbols(uri_to_file(uri))
       end
 
+      def show_message text, type = LanguageServer::MessageTypes::INFO
+        send_notification 'window/showMessage', {
+          type: type,
+          message: text
+        }
+      end
+
+      def show_message_request text, type, actions, &block
+        send_request 'window/showMessageRequest', {
+          type: type,
+          message: text,
+          actions: actions
+        }, &block
+      end
+
+      # Get a list of IDs for server requests that are waiting for responses
+      # from the client.
+      #
+      # @return [Array<Integer>]
+      def pending_requests
+        requests.keys
+      end
+
       private
 
       # @return [Solargraph::Library]
@@ -262,6 +354,10 @@ module Solargraph
         @change_queue.any?{|change| change['textDocument']['uri'] == file_uri}
       end
 
+      def requests
+        @requests ||= {}
+      end
+
       def start_change_thread
         Thread.new do
           until stopped?
@@ -290,7 +386,7 @@ module Solargraph
                     next true
                   elsif change['textDocument']['version'] <= source.version
                     # @todo Is deleting outdated changes correct behavior?
-                    STDERR.puts "Warning: outdated to change to #{change['textDocument']['uri']} was ignored"
+                    STDERR.puts "Warning: outdated change to #{change['textDocument']['uri']} was ignored"
                     @diagnostics_queue.push change['textDocument']['uri']
                     next true
                   else
@@ -333,8 +429,10 @@ module Solargraph
               end
               next if current.nil? or already_changing
               filename = uri_to_file(current)
-              text = library.read_text(filename)
-              results = diagnoser.diagnose text, filename
+              # text = library.read_text(filename)
+              # results = diagnoser.diagnose text, filename
+              # results.concat library.diagnose(filename)
+              results = library.diagnose(filename)
               @change_semaphore.synchronize do
                 already_changing = (unsafe_changing?(current) or @diagnostics_queue.include?(current))
                 # publish_diagnostics current, resp unless already_changing
@@ -352,13 +450,9 @@ module Solargraph
                 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"
-              }
+            rescue Exception => e
+              STDERR.puts "#{e.message}"
+              STDERR.puts "#{e.backtrace}"
             end
           end
         end