solargraph 0.39.17 → 0.40.0

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/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/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/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
@@ -351,7 +351,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 +403,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_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

data/lib/solargraph/parser/node_processor/base.rb

@@ -27,6 +27,7 @@ module Solargraph
           @region = region
           @pins = pins
           @locals = locals
+          @processed_children = false
         end
 
         # Subclasses should override this method to generate new pins.
@@ -41,6 +42,8 @@ module Solargraph
         # @param subregion [Region]
         # @return [void]
         def process_children subregion = region
+          return if @processed_children
+          @processed_children = true
           node.children.each do |child|
             next unless Parser.is_ast_node?(child)
             NodeProcessor.process(child, subregion, pins, locals)

data/lib/solargraph/parser/rubyvm/node_processors/args_node.rb

@@ -6,7 +6,7 @@ module Solargraph
       module NodeProcessors
         class ArgsNode < Parser::NodeProcessor::Base
           def process
-            if region.closure.is_a?(Pin::BaseMethod) || region.closure.is_a?(Pin::Block)
+            if region.closure.is_a?(Pin::Method) || region.closure.is_a?(Pin::Block)
               if region.lvars[0].nil?
                 node.children[0].times do |i|
                   locals.push Solargraph::Pin::Parameter.new(

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

@@ -19,7 +19,7 @@ module Solargraph
             if region.visibility == :module_function
               rng = Range.from_node(node)
               named_path = named_path_pin(rng.start)
-              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/rubyvm/node_processors/send_node.rb

@@ -9,21 +9,7 @@ module Solargraph
 
           def process
             if [:private, :public, :protected].include?(node.children[0])
-              if node.type == :FCALL && Parser.is_ast_node?(node.children.last)
-                node.children.last.children[0..-2].each do |child|
-                  # next unless child.is_a?(AST::Node) && (child.type == :sym || child.type == :str)
-                  next unless child.type == :LIT || 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[0])
-                  end
-                end
-              else
-                # @todo Smelly instance variable access
-                region.instance_variable_set(:@visibility, node.children[0])
-              end
+              process_visibility
             elsif node.children[0] == :module_function
               process_module_function
             elsif node.children[0] == :require
@@ -33,8 +19,7 @@ module Solargraph
             elsif node.children[0] == :alias_method
               process_alias_method
             elsif node.children[0] == :private_class_method
-              # Processing a private class can potentially handle children on its own
-              return if process_private_class_method
+              process_private_class_method
             elsif [:attr_reader, :attr_writer, :attr_accessor].include?(node.children[0])
               process_attribute
             elsif node.children[0] == :include
@@ -53,6 +38,28 @@ module Solargraph
 
           private
 
+          # @return [void]
+          def process_visibility
+            if node.type == :FCALL && Parser.is_ast_node?(node.children.last)
+              node.children.last.children[0..-2].each do |child|
+                # next unless child.is_a?(AST::Node) && (child.type == :sym || child.type == :str)
+                if child.type == :LIT || 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[0])
+                  end
+                else
+                  process_children region.update(visibility: node.children[0])
+                end
+              end
+            else
+              # @todo Smelly instance variable access
+              region.instance_variable_set(:@visibility, node.children[0])
+            end
+          end
+
           # @return [void]
           def process_attribute
             return unless Parser.is_ast_node?(node.children[1])
@@ -62,26 +69,30 @@ module Solargraph
               clos = region.closure
               cmnt = comments_for(node)
               if node.children[0] == :attr_reader || node.children[0] == :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[0] == :attr_writer || node.children[0] == :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
@@ -166,7 +177,7 @@ module Solargraph
               node.children.last.children[0..-2].each do |x|
                 next unless [:LIT, :STR].include?(x.type)
                 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(
@@ -215,6 +226,7 @@ module Solargraph
 
           # @return [void]
           def process_private_constant
+            # @todo Bare `private_constant` causes an error
             node.children.last.children[0..-2].each do |child|
               if [:LIT, :STR].include?(child.type)
                 cn = child.children[0].to_s
@@ -242,20 +254,18 @@ module Solargraph
             )
           end
 
-          # @return [Boolean]
+          # @return [void]
           def process_private_class_method
             return false unless Parser.is_ast_node?(node.children.last)
             if node.children.last.children.first.type == :DEFN
               process_children region.update(scope: :class, visibility: :private)
-              true
             else
               node.children.last.children[0..-2].each do |child|
                 if child.type == :LIT && child.children.first.is_a?(::Symbol)
                   sym_name = child.children.first.to_s
-                  ref = pins.select{|p| [Solargraph::Pin::Method, Solargraph::Pin::Attribute].include?(p.class) && p.namespace == region.closure.full_context.namespace && p.name == sym_name}.first
+                  ref = pins.select { |p| p.is_a?(Pin::Method) && p.namespace == region.closure.full_context.namespace && p.name == sym_name }.first
                   # HACK: Smelly instance variable access
                   ref.instance_variable_set(:@visibility, :private) unless ref.nil?
-                  false
                 end
               end
             end