solargraph 0.24.1 → 0.25.0

data/lib/solargraph/api_map/source_to_yard.rb

@@ -24,7 +24,7 @@ module Solargraph
             else
               code_object_map[pin.path] ||= YARD::CodeObjects::ModuleObject.new(root_code_object, pin.path)
             end
-            code_object_map[pin.path].docstring = pin.docstring unless pin.docstring.nil?
+            code_object_map[pin.path].docstring = pin.docstring
             code_object_map[pin.path].files.push pin.location.filename
           end
           s.namespace_pins.each do |pin|
@@ -34,7 +34,7 @@ module Solargraph
           end
           s.method_pins.each do |pin|
             code_object_map[pin.path] ||= YARD::CodeObjects::MethodObject.new(code_object_at(pin.namespace), pin.name, pin.scope)
-            code_object_map[pin.path].docstring = pin.docstring unless pin.docstring.nil?
+            code_object_map[pin.path].docstring = pin.docstring
             code_object_map[pin.path].visibility = pin.visibility || :public
             code_object_map[pin.path].files.push pin.location.filename
             code_object_map[pin.path].parameters = pin.parameters.map do |p|

data/lib/solargraph/api_map/store.rb

@@ -4,8 +4,9 @@ module Solargraph
   class ApiMap
     class Store
       # @param sources [Array<Solargraph::Source>]
-      def initialize sources
-        update *sources
+      def initialize sources, yard_pins
+        inner_update *sources
+        pins.concat yard_pins
         index
       end
 
@@ -16,19 +17,20 @@ module Solargraph
 
       def remove *sources
         sources.each do |source|
-          pins.delete_if { |pin| pin.filename == source.filename }
+          pins.delete_if { |pin| !pin.yard_pin? and pin.filename == source.filename }
           symbols.delete_if { |pin| pin.filename == source.filename }
         end
         index
       end
 
       def update *sources
-        sources.each do |source|
-          pins.delete_if { |pin| pin.filename == source.filename }
-          symbols.delete_if { |pin| pin.filename == source.filename }
-          pins.concat source.pins
-          symbols.concat source.symbols
-        end
+        inner_update *sources
+        index
+      end
+
+      def update_yard yard_pins
+        pins.delete_if(&:yard_pin?)
+        pins.concat yard_pins
         index
       end
 
@@ -154,6 +156,15 @@ module Solargraph
           namespaces.add pin.path if pin.kind == Pin::NAMESPACE and !pin.path.empty?
         end
       end
+
+      def inner_update *sources
+        sources.each do |source|
+          pins.delete_if { |pin| !pin.yard_pin? and pin.filename == source.filename }
+          symbols.delete_if { |pin| pin.filename == source.filename }
+          pins.concat source.pins
+          symbols.concat source.symbols
+        end
+      end
     end
   end
 end

data/lib/solargraph/complex_type.rb

@@ -50,6 +50,11 @@ module Solargraph
       @scope ||= ((name == 'Class' or name == 'Module') and !subtypes.empty?) ? :class : :instance
     end
 
+    def == other
+      return false unless self.class == other.class
+      tag == other.tag
+    end
+
     class << self
       # @param *strings [Array<String>] The type definitions to parse
       # @return [Array<ComplexType>]
@@ -57,6 +62,7 @@ module Solargraph
         types = []
         strings.each do |type_string|
           point_stack = 0
+          curly_stack = 0
           base = ''
           subtype_string = ''
           type_string.each_char do |char|
@@ -65,7 +71,10 @@ module Solargraph
               next if point_stack == 1
             elsif char == '>'
               point_stack -= 1
-              raise 'Invalid close in type' if point_stack < 0
+              raise "Invalid close in type #{type_string}" if point_stack < 0
+            elsif char == '{'
+              # @todo Temporarily short-circuiting types with {}
+              break
             elsif char == ',' and point_stack == 0
               types.push ComplexType.new base.strip, subtype_string.strip
               base = ''

data/lib/solargraph/diagnostics/require_not_found.rb

@@ -10,7 +10,7 @@ module Solargraph
         source.requires.each do |ref|
           refs[ref.name] = ref
         end
-        api_map.yard_map.unresolved_requires.each do |r|
+        api_map.unresolved_requires.each do |r|
           next unless refs.has_key?(r)
           result.push(
             range: refs[r].location.range.to_hash,

data/lib/solargraph/diagnostics/rubocop.rb

@@ -1,5 +1,5 @@
-require 'open3'
-require 'shellwords'
+require 'rubocop'
+require 'stringio'
 
 module Solargraph
   module Diagnostics
@@ -15,43 +15,51 @@ module Solargraph
         'fatal' => Severities::ERROR
       }
 
-      # The rubocop command
-      #
-      # @return [String]
-      attr_reader :command
-
-      def initialize(command = 'rubocop')
-        @command = command
-      end
-
       # @param source [Solargraph::Source]
       # @param api_map [Solargraph::ApiMap]
       # @return [Array<Hash>]
       def diagnose source, api_map
         begin
-          text = source.code
-          filename = source.filename
-          raise DiagnosticsError, 'No command specified' if command.nil? or command.empty?
-          cmd = "#{Shellwords.escape(command)} -f j"
-          unless api_map.workspace.nil? or api_map.workspace.directory.nil?
-            rc = File.join(api_map.workspace.directory, '.rubocop.yml')
-            cmd += " -c #{Shellwords.escape(fix_drive_letter(rc))}" if File.file?(rc)
-          end
-          cmd += " -s #{Shellwords.escape(fix_drive_letter(filename))}"
-          o, e, s = Open3.capture3(cmd, stdin_data: text)
-          STDERR.puts e unless e.empty?
-          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)
+          options, paths = generate_options(api_map.workspace, source.filename, source.code)
+          runner = RuboCop::Runner.new(options, RuboCop::ConfigStore.new)
+          result = redirect_stdout{ runner.run(paths) }
+          make_array JSON.parse(result)
         rescue JSON::ParserError
           raise DiagnosticsError, 'RuboCop returned invalid data'
-        rescue Errno::ENOENT
-          raise DiagnosticsError, "Command '#{command}' is not available"
         end
       end
 
       private
 
+      # @param workspace [Solargraph::Workspace]
+      # @param filename [String]
+      # @param code [String]
+      # @return [Array]
+      def generate_options workspace, filename, code
+        args = ['-f', 'j']
+        unless workspace.nil? or workspace.directory.nil?
+          rc = File.join(workspace.directory, '.rubocop.yml')
+          args.push('-c', fix_drive_letter(rc)) if File.file?(rc)
+        end
+        args.push filename
+        options, paths = RuboCop::Options.new.parse(args)
+        options[:stdin] = code
+        [options, paths]
+      end
+
+      # @todo This is a smelly way to redirect output, but the RuboCop specs do the
+      #   same thing.
+      # @return [String]
+      def redirect_stdout
+        redir = StringIO.new
+        $stdout = redir
+        yield if block_given?
+        $stdout = STDOUT
+        redir.string
+      end
+
+      # @param resp [Hash]
+      # @return [Array<Hash>]
       def make_array resp
         diagnostics = []
         resp['files'].each do |file|

data/lib/solargraph/diagnostics/type_not_defined.rb

@@ -47,16 +47,14 @@ module Solargraph
 
       def check_param_tags pin, api_map, source
         result = []
-        unless pin.docstring.nil?
-          pin.docstring.tags(:param).each do |par|
-            next if pin.parameter_names.include?(par.name)
-            result.push(
-              range: extract_first_line(pin, source),
-              severity: Diagnostics::Severities::WARNING,
-              source: 'Solargraph',
-              message: "Method `#{pin.name}` has mistagged param `#{par.name}`."
-            )
-          end
+        pin.docstring.tags(:param).each do |par|
+          next if pin.parameter_names.include?(par.name)
+          result.push(
+            range: extract_first_line(pin, source),
+            severity: Diagnostics::Severities::WARNING,
+            source: 'Solargraph',
+            message: "Method `#{pin.name}` has mistagged param `#{par.name}`."
+          )
         end
         result
       end
@@ -76,14 +74,14 @@ module Solargraph
 
       def defined_return_type? pin, api_map
         return true unless pin.return_type.nil?
-        matches = api_map.get_methods(pin.namespace, scope: pin.scope, visibility: [:public, :private, :protected]).select{|p| p.name == pin.name}
+        matches = api_map.get_method_stack(pin.namespace, pin.name, scope: pin.scope)
         matches.shift
         matches.any?{|m| !m.return_type.nil?}
       end
 
       def defined_param_type? pin, param, api_map
         return true if param_in_docstring?(param, pin.docstring)
-        matches = api_map.get_methods(pin.namespace, scope: pin.scope, visibility: [:public, :private, :protected]).select{|p| p.name == pin.name}
+        matches = api_map.get_method_stack(pin.namespace, pin.name, scope: pin.scope)
         matches.shift
         matches.each do |m|
           next unless pin.parameter_names == m.parameter_names
@@ -93,7 +91,6 @@ module Solargraph
       end
 
       def param_in_docstring? param, docstring
-        return false if docstring.nil?
         tags = docstring.tags(:param)
         tags.any?{|t| t.name == param}
       end

data/lib/solargraph/language_server/host.rb

@@ -492,17 +492,17 @@ module Solargraph
                     @diagnostics_queue.push change['textDocument']['uri']
                     changed = true
                     next true
-                  elsif change['textDocument']['version'] == source.version + 1 #and change['contentChanges'].length == 0
-                    # HACK: This condition fixes the fact that formatting
-                    # increments the version by one regardless of the number
-                    # of changes
-                    STDERR.puts "Warning: change applied to #{uri_to_file(change['textDocument']['uri'])} is possibly out of sync"
-                    pending[change['textDocument']['uri']] -= 1
-                    updater = generate_updater(change)
-                    library.synchronize updater, pending[change['textDocument']['uri']] == 0
-                    @diagnostics_queue.push change['textDocument']['uri']
-                    changed = true
-                    next true
+                  # elsif change['textDocument']['version'] == source.version + 1 #and change['contentChanges'].length == 0
+                  #   # HACK: This condition fixes the fact that formatting
+                  #   # increments the version by one regardless of the number
+                  #   # of changes
+                  #   STDERR.puts "Warning: change applied to #{uri_to_file(change['textDocument']['uri'])} is possibly out of sync"
+                  #   pending[change['textDocument']['uri']] -= 1
+                  #   updater = generate_updater(change)
+                  #   library.synchronize updater, pending[change['textDocument']['uri']] == 0
+                  #   @diagnostics_queue.push change['textDocument']['uri']
+                  #   changed = true
+                  #   next true
                   elsif change['textDocument']['version'] <= source.version
                     # @todo Is deleting outdated changes correct behavior?
                     STDERR.puts "Warning: outdated change to #{change['textDocument']['uri']} was ignored"

data/lib/solargraph/language_server/message.rb

@@ -1,6 +1,5 @@
 require 'solargraph'
 require 'uri'
-require 'thread'
 
 module Solargraph
   module LanguageServer

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

@@ -4,13 +4,27 @@ module Solargraph
       class Base
         # @return [Solargraph::LanguageServer::Host]
         attr_reader :host
+
+        # @return [Integer]
         attr_reader :id
+
+        # @return [Hash]
         attr_reader :request
+
+        # @return [String]
         attr_reader :method
+
+        # @return [Hash]
         attr_reader :params
+
+        # @return [Hash, Array, nil]
         attr_reader :result
+
+        # @return [Hash, nil]
         attr_reader :error
 
+        # @param host [Solargraph::LanguageServer::Host]
+        # @param request [Hash]
         def initialize host, request
           @host = host
           @id = request['id'].freeze
@@ -20,16 +34,21 @@ module Solargraph
           post_initialize
         end
 
-        def post_initialize
-        end
+        # @return [void]
+        def post_initialize; end
 
-        def process
-        end
+        # @return [void]
+        def process; end
 
+        # @param data [Hash, Array, nil]
+        # @return [void]
         def set_result data
           @result = data
         end
 
+        # @param code [Integer] See Solargraph::LanguageServer::ErrorCodes
+        # @param message [String]
+        # @return [void]
         def set_error code, message
           @error = {
             code: code,
@@ -37,6 +56,7 @@ module Solargraph
           }
         end
 
+        # @return [void]
         def send_response
           unless id.nil? or host.cancel?(id)
             response = {

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

@@ -6,25 +6,16 @@ module Solargraph
       module TextDocument
         class Completion < Base
           def process
-            start = Time.now
-            processed = false
-            until processed
-              if host.changing?(params['textDocument']['uri'])
-                if Time.now - start > 1
-                  # set_error Solargraph::LanguageServer::ErrorCodes::INTERNAL_ERROR, 'Completion request timed out'
-                  set_result empty_result
-                  processed = true
-                end
-              else
-                inner_process
-                processed = true
-              end
-              sleep 0.1 unless processed
+            if host.changing?(params['textDocument']['uri'])
+              set_result empty_result(true)
+            else
+              inner_process
             end
           end
 
           private
 
+          # @return [void]
           def inner_process
             filename = uri_to_file(params['textDocument']['uri'])
             line = params['position']['line']
@@ -56,9 +47,11 @@ module Solargraph
             end
           end
 
-          def empty_result
+          # @param incomplete [Boolean]
+          # @return [Hash]
+          def empty_result incomplete = false
             {
-              isIncomplete: false,
+              isIncomplete: incomplete,
               items: []
             }
           end

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

@@ -1,5 +1,3 @@
-require 'thread'
-
 module Solargraph
   module LanguageServer
     module Message

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

@@ -17,16 +17,7 @@ module Solargraph
             set_result(
               [
                 {
-                  range: {
-                    start: {
-                      line: 0,
-                      character: 0
-                    },
-                    end: {
-                      line: original.lines.length,
-                      character: 0
-                    }
-                  },
+                  range: nil,
                   newText: formatted
                 }
               ]

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

@@ -21,7 +21,6 @@ module Solargraph
             message.send_response
             tmp = @host.flush
             send_data tmp unless tmp.empty?
-            GC.start unless request['method'] == 'textDocument/didChange'
           end
         end
 

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

@@ -49,7 +49,6 @@ module Solargraph
             message.send_response
             tmp = @host.flush
             send_data tmp unless tmp.empty?
-            GC.start unless request['method'] == 'textDocument/didChange'
           end
         end
 

data/lib/solargraph/pin.rb

@@ -13,7 +13,6 @@ module Solargraph
     autoload :Constant,         'solargraph/pin/constant'
     autoload :Symbol,           'solargraph/pin/symbol'
     autoload :Namespace,        'solargraph/pin/namespace'
-    autoload :YardObject,       'solargraph/pin/yard_object'
     autoload :Keyword,          'solargraph/pin/keyword'
     autoload :MethodParameter,  'solargraph/pin/method_parameter'
     autoload :BlockParameter,   'solargraph/pin/block_parameter'
@@ -23,6 +22,7 @@ module Solargraph
     autoload :Localized,        'solargraph/pin/localized'
     autoload :ProxyMethod,      'solargraph/pin/proxy_method'
     autoload :DuckMethod,       'solargraph/pin/duck_method'
+    autoload :YardPin,          'solargraph/pin/yard_pin'
 
     ATTRIBUTE = 1
     CLASS_VARIABLE = 2