solargraph 0.39.16 → 0.40.3

data/lib/solargraph/convention/base.rb

@@ -2,22 +2,30 @@
 
 module Solargraph
   module Convention
+    # The base class for Conventions.
+    #
+    # A Convention provides Environs that customize ApiMaps with additional
+    # pins and other information. Subclasses should implement the `local` and
+    # `global` methods as necessary.
+    #
     class Base
       EMPTY_ENVIRON = Environ.new
 
-      # True if the source qualifies for this convention.
-      # Subclasses should override this method.
+      # The Environ for a source map.
+      # Subclasses can override this method.
       #
-      # @param source [Source]
-      def match? source
-        false
+      # @param source_map [SourceMap]
+      # @return [Environ]
+      def local source_map
+        EMPTY_ENVIRON
       end
 
-      # The Environ for this convention.
-      # Subclasses should override this method.
+      # The Environ for a YARD map.
+      # Subclasses can override this method.
       #
+      # @param yard_map [YardMap]
       # @return [Environ]
-      def environ
+      def global yard_map
         EMPTY_ENVIRON
       end
     end

data/lib/solargraph/convention/gemfile.rb

@@ -3,11 +3,8 @@
 module Solargraph
   module Convention
     class Gemfile < Base
-      def match? source
-        File.basename(source.filename) == 'Gemfile'
-      end
-
-      def environ
+      def local source_map
+        return EMPTY_ENVIRON unless File.basename(source_map.filename) == 'Gemfile'
         @environ ||= Environ.new(
           requires: ['bundler'],
           domains: ['Bundler::Dsl']

data/lib/solargraph/convention/gemspec.rb

@@ -3,14 +3,11 @@
 module Solargraph
   module Convention
     class Gemspec < Base
-      def match? source
-        File.basename(source.filename).end_with?('.gemspec')
-      end
-
-      def environ
+      def local source_map
+        return EMPTY_ENVIRON unless File.basename(source_map.filename).end_with?('.gemspec')
         @environ ||= Environ.new(
           requires: ['rubygems'],
-          overrides: [
+          pins: [
             Solargraph::Pin::Reference::Override.from_comment(
               'Gem::Specification.new',
               %(

data/lib/solargraph/convention/rspec.rb

@@ -3,18 +3,15 @@
 module Solargraph
   module Convention
     class Rspec < Base
-      def match? source
-        File.basename(source.filename) =~ /_spec\.rb$/
-      end
-
-      def environ
+      def local source_map
+        return EMPTY_ENVIRON unless File.basename(source_map.filename) =~ /_spec\.rb$/
         @environ ||= Environ.new(
           requires: ['rspec'],
           domains: ['RSpec::Matchers', 'RSpec::ExpectationGroups'],
           # This override is necessary due to an erroneous @return tag in
           # rspec's YARD documentation.
           # @todo The return types have been fixed (https://github.com/rspec/rspec-expectations/pull/1121)
-          overrides: [
+          pins: [
             Solargraph::Pin::Reference::Override.method_return('RSpec::Matchers#expect', 'RSpec::Expectations::ExpectationTarget')
           ]
         )

data/lib/solargraph/diagnostics/rubocop_helpers.rb

@@ -13,32 +13,13 @@ module Solargraph
       # @param code [String]
       # @return [Array(Array<String>, Array<String>)]
       def generate_options filename, code
-        args = ['-f', 'j']
-        rubocop_file = find_rubocop_file(filename)
-        args.push('-c', fix_drive_letter(rubocop_file)) unless rubocop_file.nil?
-        args.push filename
+        args = ['-f', 'j', filename]
         base_options = RuboCop::Options.new
         options, paths = base_options.parse(args)
         options[:stdin] = code
         [options, paths]
       end
 
-      # Find a RuboCop configuration file in a file's directory tree.
-      #
-      # @param filename [String]
-      # @return [String, nil]
-      def find_rubocop_file filename
-        return nil unless File.exist?(filename)
-        filename = File.realpath(filename)
-        dir = File.dirname(filename)
-        until File.dirname(dir) == dir
-          here = File.join(dir, '.rubocop.yml')
-          return here if File.exist?(here)
-          dir = File.dirname(dir)
-        end
-        nil
-      end
-
       # RuboCop internally uses capitalized drive letters for Windows paths,
       # so we need to convert the paths provided to the command.
       #

data/lib/solargraph/environ.rb

@@ -1,6 +1,11 @@
 # frozen_string_literal: true
 
 module Solargraph
+  # A collection of additional data, such as map pins and required paths, that
+  # can be added to an ApiMap.
+  #
+  # Conventions are used to add Environs.
+  #
   class Environ
     # @return [Array<String>]
     attr_reader :requires
@@ -9,22 +14,22 @@ module Solargraph
     attr_reader :domains
 
     # @return [Array<Pin::Reference::Override>]
-    attr_reader :overrides
+    attr_reader :pins
 
     # @param requires [Array<String>]
     # @param domains [Array<String>]
-    # @param overrides [Array<Pin::Reference::Override>]
-    def initialize requires: [], domains: [], overrides: []
+    # @param pins [Array<Pin::Base>]
+    def initialize requires: [], domains: [], pins: []
       @requires = requires
       @domains = domains
-      @overrides = overrides
+      @pins = pins
     end
 
     # @return [self]
     def clear
       domains.clear
       requires.clear
-      overrides.clear
+      pins.clear
       self
     end
 
@@ -33,7 +38,7 @@ module Solargraph
     def merge other
       domains.concat other.domains
       requires.concat other.requires
-      overrides.concat other.overrides
+      pins.concat other.pins
       self
     end
   end

data/lib/solargraph/language_server/host.rb

@@ -494,6 +494,11 @@ module Solargraph
         library.read_text(filename)
       end
 
+      def formatter_config uri
+        library = library_for(uri)
+        library.workspace.config.formatter
+      end
+
       # @param uri [String]
       # @param line [Integer]
       # @param column [Integer]

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

@@ -34,7 +34,12 @@ module Solargraph
                                           LanguageServer::MessageTypes::INFO,
                                           ['Update now'] do |result|
                                             next unless result == 'Update now'
-                                            o, s = Open3.capture2("gem update solargraph")
+                                            cmd = if host.options['useBundler']
+                                              'bundle update solargraph'
+                                            else
+                                              'gem update solargraph'
+                                            end
+                                            o, s = Open3.capture2(cmd)
                                             if s == 0
                                               host.show_message 'Successfully updated the Solargraph gem.', LanguageServer::MessageTypes::INFO
                                               host.send_notification '$/solargraph/restart', {}

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

@@ -13,7 +13,7 @@ module Solargraph::LanguageServer::Message::TextDocument
     def code_location
       suggestions = host.definitions_at(params['textDocument']['uri'], @line, @column)
       return nil if suggestions.empty?
-      suggestions.reject{|pin| pin.location.nil?}.map do |pin|
+      suggestions.reject { |pin| pin.location.nil? || pin.location.filename.nil? }.map do |pin|
         {
           uri: file_to_uri(pin.location.filename),
           range: pin.location.range.to_hash

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

@@ -2,6 +2,7 @@
 
 require 'rubocop'
 require 'securerandom'
+require 'tmpdir'
 
 module Solargraph
   module LanguageServer
@@ -10,32 +11,58 @@ module Solargraph
         class Formatting < Base
           include Solargraph::Diagnostics::RubocopHelpers
 
+          class BlankRubocopFormatter < ::RuboCop::Formatter::BaseFormatter; end
+
           def process
-            filename = uri_to_file(params['textDocument']['uri'])
-            # Make the temp file in the original file's directory so RuboCop
-            # detects the correct configuration
-            # the .rb extension is needed for ruby file without extension, else rubocop won't format
-            tempfile = File.join(File.dirname(filename), "_tmp_#{SecureRandom.hex(8)}_#{File.basename(filename)}.rb")
-            rubocop_file = Diagnostics::RubocopHelpers.find_rubocop_file(filename)
-            original = host.read_text(params['textDocument']['uri'])
-            File.write tempfile, original
-            begin
-              args = ['-a', '-f', 'fi', tempfile]
-              args.unshift('-c', fix_drive_letter(rubocop_file)) unless rubocop_file.nil?
-              options, paths = RuboCop::Options.new.parse(args)
-              store = RuboCop::ConfigStore.new
-              redirect_stdout { RuboCop::Runner.new(options, store).run(paths) }
-              result = File.read(tempfile)
-              format original, result
-            rescue RuboCop::ValidationError, RuboCop::ConfigNotFoundError => e
-              set_error(Solargraph::LanguageServer::ErrorCodes::INTERNAL_ERROR, "[#{e.class}] #{e.message}")
-            ensure
-              File.unlink tempfile
+            file_uri = params['textDocument']['uri']
+            config = config_for(file_uri)
+            original = host.read_text(file_uri)
+            args = cli_args(file_uri, config)
+
+            options, paths = RuboCop::Options.new.parse(args)
+            options[:stdin] = original
+            redirect_stdout do
+              RuboCop::Runner.new(options, RuboCop::ConfigStore.new).run(paths)
             end
+            result = options[:stdin]
+
+            format original, result
+          rescue RuboCop::ValidationError, RuboCop::ConfigNotFoundError => e
+            set_error(Solargraph::LanguageServer::ErrorCodes::INTERNAL_ERROR, "[#{e.class}] #{e.message}")
           end
 
           private
 
+          def config_for(file_uri)
+            conf = host.formatter_config(file_uri)
+            return {} unless conf.is_a?(Hash)
+
+            conf['rubocop'] || {}
+          end
+
+          def cli_args file, config
+            args = [
+              config['cops'] == 'all' ? '--auto-correct-all' : '--auto-correct',
+              '--cache', 'false',
+              '--format', 'Solargraph::LanguageServer::Message::' \
+                          'TextDocument::Formatting::BlankRubocopFormatter',
+            ]
+
+            ['except', 'only'].each do |arg|
+              cops = cop_list(config[arg])
+              args += ["--#{arg}", cops] if cops
+            end
+
+            args += config['extra_args'] if config['extra_args']
+            args + [file]
+          end
+
+          def cop_list(value)
+            value = value.join(',') if value.respond_to?(:join)
+            return nil if value == '' || !value.is_a?(String)
+            value
+          end
+
           # @param original [String]
           # @param result [String]
           # @return [void]

data/lib/solargraph/library.rb

@@ -20,7 +20,7 @@ module Solargraph
     def initialize workspace = Solargraph::Workspace.new, name = nil
       @workspace = workspace
       @name = name
-      api_map.catalog bundle
+      api_map.catalog bench
       @synchronized = true
       @catalog_mutex = Mutex.new
     end
@@ -209,7 +209,6 @@ module Solargraph
     # @return [Array<Solargraph::Range>]
     # @todo Take a Location instead of filename/line/column
     def references_from filename, line, column, strip: false
-      # checkout filename
       cursor = api_map.cursor_at(filename, Position.new(line, column))
       clip = api_map.clip(cursor)
       pins = clip.define
@@ -222,7 +221,7 @@ module Solargraph
             referenced = definitions_at(loc.filename, loc.range.ending.line, loc.range.ending.character)
             # HACK: The additional location comparison is necessary because
             # Clip#define can return proxies for parameter pins
-            referenced.any?{|r| r == pin || r.location == pin.location}
+            referenced.any? { |r| r == pin || r.location == pin.location }
           end
           # HACK: for language clients that exclude special characters from the start of variable names
           if strip && match = cursor.word.match(/^[^a-z0-9_]+/i)
@@ -290,7 +289,6 @@ module Solargraph
     # @param filename [String]
     # @return [Array<Solargraph::Pin::Base>]
     def document_symbols filename
-      # checkout filename
       api_map.document_symbols(filename)
     end
 
@@ -351,7 +349,7 @@ module Solargraph
       @catalog_mutex.synchronize do
         break if synchronized?
         logger.info "Cataloging #{workspace.directory.empty? ? 'generic workspace' : workspace.directory}"
-        api_map.catalog bundle
+        api_map.catalog bench
         @synchronized = true
         logger.info "Catalog complete (#{api_map.source_maps.length} files, #{api_map.pins.length} pins)" if logger.info?
       end
@@ -403,9 +401,9 @@ module Solargraph
       @api_map ||= Solargraph::ApiMap.new
     end
 
-    # @return [Bundle]
-    def bundle
-      Bundle.new(
+    # @return [Bench]
+    def bench
+      Bench.new(
         workspace: workspace,
         opened: @current ? [@current] : []
       )

data/lib/solargraph/parser/legacy/node_methods.rb

@@ -98,6 +98,7 @@ module Solargraph
 
         def convert_hash node
           return {} unless Parser.is_ast_node?(node) && node.type == :hash
+          return convert_hash(node.children[0].children[0]) if splatted_hash?(node)
           result = {}
           node.children.each do |pair|
             result[pair.children[0].children[0]] = Solargraph::Parser.chain(pair.children[1])
@@ -118,6 +119,14 @@ module Solargraph
           result
         end
 
+        def splatted_hash? node
+          Parser.is_ast_node?(node.children[0]) && node.children[0].type == :kwsplat
+        end
+
+        def splatted_call? node
+          Parser.is_ast_node?(node.children[0]) && node.children[0].type == :kwsplat && node.children[0].children[0].type != :hash
+        end
+
         # @todo Temporarily here for testing. Move to Solargraph::Parser.
         def call_nodes_from node
           return [] unless node.is_a?(::Parser::AST::Node)

data/lib/solargraph/parser/legacy/node_processors/ivasgn_node.rb

@@ -19,7 +19,7 @@ module Solargraph
             if region.visibility == :module_function
               here = get_node_start_position(node)
               named_path = named_path_pin(here)
-              if named_path.is_a?(Pin::BaseMethod)
+              if named_path.is_a?(Pin::Method)
                 pins.push Solargraph::Pin::InstanceVariable.new(
                   location: loc,
                   closure: Pin::Namespace.new(type: :module, closure: region.closure.closure, name: region.closure.name),

data/lib/solargraph/parser/legacy/node_processors/send_node.rb

@@ -10,20 +10,7 @@ module Solargraph
           def process
             if node.children[0].nil?
               if [:private, :public, :protected].include?(node.children[1])
-                if (node.children.length > 2)
-                  node.children[2..-1].each do |child|
-                    next unless child.is_a?(AST::Node) && (child.type == :sym || child.type == :str)
-                    name = child.children[0].to_s
-                    matches = pins.select{ |pin| pin.is_a?(Pin::BaseMethod) && pin.name == name && pin.namespace == region.closure.full_context.namespace && pin.context.scope == (region.scope || :instance)}
-                    matches.each do |pin|
-                      # @todo Smelly instance variable access
-                      pin.instance_variable_set(:@visibility, node.children[1])
-                    end
-                  end
-                else
-                  # @todo Smelly instance variable access
-                  region.instance_variable_set(:@visibility, node.children[1])
-                end
+                process_visibility
               elsif node.children[1] == :module_function
                 process_module_function
               elsif [:attr_reader, :attr_writer, :attr_accessor].include?(node.children[1])
@@ -54,6 +41,27 @@ module Solargraph
 
           private
 
+          # @return [void]
+          def process_visibility
+            if (node.children.length > 2)
+              node.children[2..-1].each do |child|
+                if child.is_a?(AST::Node) && (child.type == :sym || child.type == :str)
+                  name = child.children[0].to_s
+                  matches = pins.select{ |pin| pin.is_a?(Pin::Method) && pin.name == name && pin.namespace == region.closure.full_context.namespace && pin.context.scope == (region.scope || :instance)}
+                  matches.each do |pin|
+                    # @todo Smelly instance variable access
+                    pin.instance_variable_set(:@visibility, node.children[1])
+                  end
+                else
+                  process_children region.update(visibility: node.children[1])
+                end
+              end
+            else
+              # @todo Smelly instance variable access
+              region.instance_variable_set(:@visibility, node.children[1])
+            end
+          end
+
           # @return [void]
           def process_attribute
             node.children[2..-1].each do |a|
@@ -61,26 +69,30 @@ module Solargraph
               clos = region.closure
               cmnt = comments_for(node)
               if node.children[1] == :attr_reader || node.children[1] == :attr_accessor
-                pins.push Solargraph::Pin::Attribute.new(
+                pins.push Solargraph::Pin::Method.new(
                   location: loc,
                   closure: clos,
                   name: a.children[0].to_s,
                   comments: cmnt,
-                  access: :reader,
                   scope: region.scope || :instance,
-                  visibility: region.visibility
+                  visibility: region.visibility,
+                  attribute: true
                 )
               end
               if node.children[1] == :attr_writer || node.children[1] == :attr_accessor
-                pins.push Solargraph::Pin::Attribute.new(
+                pins.push Solargraph::Pin::Method.new(
                   location: loc,
                   closure: clos,
                   name: "#{a.children[0]}=",
                   comments: cmnt,
-                  access: :writer,
                   scope: region.scope || :instance,
-                  visibility: region.visibility
+                  visibility: region.visibility,
+                  attribute: true
                 )
+                pins.last.parameters.push Pin::Parameter.new(name: 'value', decl: :arg, closure: pins.last)
+                if pins.last.return_type.defined?
+                  pins.last.docstring.add_tag YARD::Tags::Tag.new(:param, '', pins.last.return_type.to_s.split(', '), 'value')
+                end
               end
             end
           end
@@ -157,7 +169,7 @@ module Solargraph
             elsif node.children[2].type == :sym || node.children[2].type == :str
               node.children[2..-1].each do |x|
                 cn = x.children[0].to_s
-                ref = pins.select{|p| [Solargraph::Pin::Method, Solargraph::Pin::Attribute].include?(p.class) && p.namespace == region.closure.full_context.namespace && p.name == cn}.first
+                ref = pins.select{ |p| p.is_a?(Pin::Method) && p.namespace == region.closure.full_context.namespace && p.name == cn }.first
                 unless ref.nil?
                   pins.delete ref
                   mm = Solargraph::Pin::Method.new(
@@ -229,7 +241,7 @@ module Solargraph
           # @return [Boolean]
           def process_private_class_method
             if node.children[2].type == :sym || node.children[2].type == :str
-              ref = pins.select{|p| [Solargraph::Pin::Method, Solargraph::Pin::Attribute].include?(p.class) && p.namespace == region.closure.full_context.namespace && p.name == node.children[2].children[0].to_s}.first
+              ref = pins.select { |p| p.is_a?(Pin::Method) && p.namespace == region.closure.full_context.namespace && p.name == node.children[2].children[0].to_s }.first
               # HACK: Smelly instance variable access
               ref.instance_variable_set(:@visibility, :private) unless ref.nil?
               false