solargraph 0.39.14 → 0.40.1

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

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_chainer.rb

@@ -15,7 +15,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]
@@ -52,27 +52,27 @@ module Solargraph
           return generate_links(n.children[0]) if n.type == :SPLAT
           result = []
           if n.type == :ITER
-            @in_block = true
+            @in_block += 1
             result.concat generate_links(n.children[0])
-            @in_block = false
+            @in_block -= 1
           elsif n.type == :CALL || n.type == :OPCALL
             n.children[0..-3].each do |c|
               result.concat generate_links(c)
             end
-            result.push Chain::Call.new(n.children[-2].to_s, node_to_argchains(n.children.last), @in_block || block_passed?(n))
+            result.push Chain::Call.new(n.children[-2].to_s, node_to_argchains(n.children.last), @in_block > 0 || block_passed?(n))
           elsif n.type == :ATTRASGN
             result.concat generate_links(n.children[0])
-            result.push Chain::Call.new(n.children[1].to_s, node_to_argchains(n.children[2]), @in_block || block_passed?(n))
+            result.push Chain::Call.new(n.children[1].to_s, node_to_argchains(n.children[2]), @in_block > 0 || block_passed?(n))
           elsif n.type == :VCALL
-            result.push Chain::Call.new(n.children[0].to_s, [], @in_block || block_passed?(n))
+            result.push Chain::Call.new(n.children[0].to_s, [], @in_block > 0 || block_passed?(n))
           elsif n.type == :FCALL
-            result.push Chain::Call.new(n.children[0].to_s, node_to_argchains(n.children[1]), @in_block || block_passed?(n))
+            result.push Chain::Call.new(n.children[0].to_s, node_to_argchains(n.children[1]), @in_block > 0 || block_passed?(n))
           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
-            result.push Chain::Call.new('super', node_to_argchains(n.children.last), @in_block || block_passed?(n))
+            result.push Chain::Call.new('super', node_to_argchains(n.children.last), @in_block > 0 || block_passed?(n))
           elsif [:COLON2, :COLON3, :CONST].include?(n.type)
             const = unpack_name(n)
             result.push Chain::Constant.new(const)

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

@@ -90,7 +90,9 @@ module Solargraph
         end
 
         def convert_hash node
-          return {} unless node?(node) && node.type == :HASH && node?(node.children[0])
+          return {} unless node?(node) && node.type == :HASH
+          return convert_hash(node.children[0].children[1]) if splatted_hash?(node)
+          return {} unless node?(node.children[0])
           result = {}
           index = 0
           until index > node.children[0].children.length - 2
@@ -103,6 +105,14 @@ module Solargraph
           result
         end
 
+        def splatted_hash? node
+          node?(node.children[0]) &&
+            [:ARRAY, :LIST].include?(node.children[0].type) &&
+            node.children[0].children[0].nil? &&
+            node?(node.children[0].children[1]) &&
+            node.children[0].children[1].type == :HASH
+        end
+
         def node? node
           node.is_a?(RubyVM::AbstractSyntaxTree::Node)
         end

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
@@ -91,7 +102,8 @@ module Solargraph
             return unless Parser.is_ast_node?(node.children.last)
             node.children.last.children[0..-2].each do |i|
               next unless [:COLON2, :COLON3, :CONST].include?(i.type)
-              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: region.closure,
                 name: unpack_name(i)
@@ -165,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(
@@ -214,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
@@ -241,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

data/lib/solargraph/pin.rb

@@ -9,10 +9,8 @@ module Solargraph
     autoload :Common,           'solargraph/pin/common'
     autoload :Conversions,      'solargraph/pin/conversions'
     autoload :Base,             'solargraph/pin/base'
-    autoload :BaseMethod,       'solargraph/pin/base_method'
     autoload :Method,           'solargraph/pin/method'
     autoload :MethodAlias,      'solargraph/pin/method_alias'
-    autoload :Attribute,        'solargraph/pin/attribute'
     autoload :BaseVariable,     'solargraph/pin/base_variable'
     autoload :InstanceVariable, 'solargraph/pin/instance_variable'
     autoload :ClassVariable,    'solargraph/pin/class_variable'
@@ -30,7 +28,6 @@ module Solargraph
     autoload :Localized,        'solargraph/pin/localized'
     autoload :ProxyType,        'solargraph/pin/proxy_type'
     autoload :DuckMethod,       'solargraph/pin/duck_method'
-    autoload :YardPin,          'solargraph/pin/yard_pin'
     autoload :Singleton,        'solargraph/pin/singleton'
     autoload :KeywordParam,     'solargraph/pin/keyword_param'
 

data/lib/solargraph/pin/common.rb

@@ -54,7 +54,7 @@ module Solargraph
         until here.nil?
           if here.is_a?(Pin::Namespace)
             return here.return_type
-          elsif here.is_a?(Pin::BaseMethod)
+          elsif here.is_a?(Pin::Method)
             if here.scope == :instance
               return ComplexType.try_parse(here.context.namespace)
             else

data/lib/solargraph/pin/conversions.rb

@@ -23,16 +23,15 @@ module Solargraph
 
       # @return [Hash]
       def resolve_completion_item
-        if @resolve_completion_item.nil?
+        @resolve_completion_item ||= begin
           extra = {}
           alldoc = ''
           # alldoc += link_documentation unless link_documentation.nil?
           # alldoc += "\n\n" unless alldoc.empty?
           alldoc += documentation unless documentation.nil?
           extra[:documentation] = alldoc unless alldoc.empty?
-          @resolve_completion_item = completion_item.merge(extra)
+          completion_item.merge(extra)
         end
-        @resolve_completion_item
       end
 
       # @return [Hash]
@@ -48,7 +47,7 @@ module Solargraph
         # This property is not cached in an instance variable because it can
         # change when pins get proxied.
         detail = String.new
-        detail += "(#{parameters.map(&:full).join(', ')}) " unless !is_a?(Pin::BaseMethod) || parameters.empty?
+        detail += "(#{parameters.map(&:full).join(', ')}) " unless !is_a?(Pin::Method) || parameters.empty?
         detail += "=#{probed? ? '~' : (proxied? ? '^' : '>')} #{return_type.to_s}" unless return_type.undefined?
         detail.strip!
         return nil if detail.empty?

data/lib/solargraph/pin/documenting.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
-require 'maruku'
+require 'kramdown'
+require 'kramdown-parser-gfm'
 require 'yard'
 require 'reverse_markdown'
 require 'solargraph/converters/dl'
@@ -8,9 +9,6 @@ require 'solargraph/converters/dt'
 require 'solargraph/converters/dd'
 require 'solargraph/converters/misc'
 
-# HACK: Setting :html_parser through `Maruku.new` does not work
-MaRuKu::Globals[:html_parser] = 'nokogiri'
-
 module Solargraph
   module Pin
     # A module to add the Pin::Base#documentation method.
@@ -41,11 +39,7 @@ module Solargraph
 
         def to_s
           return "\n```ruby\n#{@plaintext}#{@plaintext.end_with?("\n") ? '' : "\n"}```\n\n" if code?
-          ReverseMarkdown.convert unescape_brackets(Maruku.new(escape_brackets(@plaintext), on_error: :raise).to_html)
-        rescue MaRuKu::Exception
-          # Maruku exceptions usually indicate that the documentation is in
-          # RDoc syntax.
-          ReverseMarkdown.convert YARD::Templates::Helpers::Markup::RDocMarkup.new(@plaintext).to_html
+          ReverseMarkdown.convert unescape_brackets(Kramdown::Document.new(escape_brackets(@plaintext), input: 'GFM').to_html)
         end
 
         private