solargraph 0.39.13 → 0.40.0

data/lib/solargraph/{bundle.rb → bench.rb}

@@ -4,18 +4,22 @@ module Solargraph
   # An aggregation of a workspace and additional sources to be cataloged in an
   # ApiMap.
   #
-  class Bundle
+  class Bench
     # @return [Workspace]
     attr_reader :workspace
 
     # @return [Array<Source>]
     attr_reader :opened
 
+    # @return [Array<Pin::Base>]
+    attr_reader :pins
+
     # @param workspace [Workspace]
     # @param opened [Array<Source>]
-    def initialize workspace: Workspace.new, opened: []
+    def initialize workspace: Workspace.new, opened: [], pins: []
       @workspace = workspace
       @opened = opened
+      @pins = pins
     end
 
     # @return [Array<Source>]

data/lib/solargraph/compat.rb

@@ -7,3 +7,17 @@ unless Hash.method_defined?(:transform_values)
     end
   end
 end
+
+unless Array.method_defined?(:sum)
+  class Array
+    def sum &block
+      inject(0) do |s, x|
+        if block
+          s + block.call(x)
+        else
+          s + x
+        end
+      end
+    end
+  end
+end

data/lib/solargraph/complex_type.rb

@@ -12,7 +12,7 @@ module Solargraph
 
     # @param types [Array<UniqueType>]
     def initialize types = [UniqueType::UNDEFINED]
-      @items = types
+      @items = types.uniq(&:to_s)
     end
 
     # @param api_map [ApiMap]
@@ -113,7 +113,7 @@ module Solargraph
       #
       # @param *strings [Array<String>] The type definitions to parse
       # @param partial [Boolean] True if the string is part of a another type
-      # @return [ComplexType]
+      # @return [ComplexType, Array, nil]
       def parse *strings, partial: false
         @cache ||= {}
         unless partial

data/lib/solargraph/convention.rb

@@ -15,18 +15,27 @@ module Solargraph
     @@conventions = Set.new
 
     # @param convention [Class<Convention::Base>]
-    # @return [Convention::Base]
+    # @return [void]
     def self.register convention
       @@conventions.add convention.new
     end
 
-    # @param source [Source]
+    # @param source_map [SourceMap]
     # @return [Environ]
-    def self.for(source)
+    def self.for_local(source_map)
       result = Environ.new
-      return result if source.filename.nil? || source.filename.empty?
       @@conventions.each do |conv|
-        result.merge conv.environ if conv.match?(source)
+        result.merge conv.local(source_map)
+      end
+      result
+    end
+
+    # @param yard_map [YardMap]
+    # @return [Environ]
+    def self.for_global(yard_map)
+      result = Environ.new
+      @@conventions.each do |conv|
+        result.merge conv.global(yard_map)
       end
       result
     end

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/documentor.rb

@@ -55,6 +55,8 @@ module Solargraph
       false
     end
 
+    # @param directory [String]
+    # @return [Hash]
     def self.specs_from_bundle directory
       Solargraph.with_clean_env do
         Dir.chdir directory do

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
@@ -174,10 +174,10 @@ module Solargraph
       if cursor.comment?
         source = read(filename)
         offset = Solargraph::Position.to_offset(source.code, Solargraph::Position.new(line, column))
-        lft = source.code[0..offset-1].match(/[\[<, ]([a-z0-9_:]*)\z/i)
+        lft = source.code[0..offset-1].match(/\[[a-z0-9_:<, ]*?([a-z0-9_:]*)\z/i)
         rgt = source.code[offset..-1].match(/^([a-z0-9_]*)(:[a-z0-9_:]*)?[\]>, ]/i)
         if lft && rgt
-          tag = lft[1] + rgt[1]
+          tag = (lft[1] + rgt[1]).sub(/:+$/, '')
           clip = api_map.clip(cursor)
           clip.translate tag
         else
@@ -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_chainer.rb

@@ -14,7 +14,7 @@ module Solargraph
         def initialize node, filename = nil, in_block = false
           @node = node
           @filename = filename
-          @in_block = in_block
+          @in_block = in_block ? 1 : 0
         end
 
         # @return [Source::Chain]
@@ -51,9 +51,9 @@ module Solargraph
           return generate_links(n.children[0]) if n.type == :splat
           result = []
           if n.type == :block
-            @in_block = true
+            @in_block += 1
             result.concat generate_links(n.children[0])
-            @in_block = false
+            @in_block -= 1
           elsif n.type == :send
             if n.children[0].is_a?(::Parser::AST::Node)
               result.concat generate_links(n.children[0])
@@ -61,23 +61,23 @@ module Solargraph
               n.children[2..-1].each do |c|
                 args.push NodeChainer.chain(c)
               end
-              result.push Chain::Call.new(n.children[1].to_s, args, @in_block || block_passed?(n))
+              result.push Chain::Call.new(n.children[1].to_s, args, @in_block > 0 || block_passed?(n))
             elsif n.children[0].nil?
               args = []
               n.children[2..-1].each do |c|
                 args.push NodeChainer.chain(c)
               end
-              result.push Chain::Call.new(n.children[1].to_s, args, @in_block || block_passed?(n))
+              result.push Chain::Call.new(n.children[1].to_s, args, @in_block > 0 || block_passed?(n))
             else
               raise "No idea what to do with #{n}"
             end
           elsif n.type == :self
             result.push Chain::Head.new('self')
           elsif n.type == :zsuper
-            result.push Chain::ZSuper.new('super', @in_block || block_passed?(n))
+            result.push Chain::ZSuper.new('super', @in_block > 0 || block_passed?(n))
           elsif n.type == :super
             args = n.children.map { |c| NodeChainer.chain(c) }
-            result.push Chain::Call.new('super', args, @in_block || block_passed?(n))
+            result.push Chain::Call.new('super', args, @in_block > 0 || block_passed?(n))
           elsif n.type == :const
             const = unpack_name(n)
             result.push Chain::Constant.new(const)

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
@@ -90,7 +102,8 @@ module Solargraph
             if node.children[2].is_a?(AST::Node) && node.children[2].type == :const
               cp = region.closure
               node.children[2..-1].each do |i|
-                pins.push Pin::Reference::Include.new(
+                type = region.scope == :class ? Pin::Reference::Extend : Pin::Reference::Include
+                pins.push type.new(
                   location: get_node_location(i),
                   closure: cp,
                   name: unpack_name(i)
@@ -156,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(
@@ -228,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