solargraph 0.34.3 → 0.35.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 19d601d06fae9aedf33e93d09172bb9257757aaf7323f6f6a355c82fc7b67223
-  data.tar.gz: 5a5d073284cd8034b710dbb22169a30478e490e8561b4e2be56b59a52c79b757
+  metadata.gz: 02a0b8dd485332480c292f17a1cae69217cf9cb4e5f3aa9c29bd94ac55d57ab8
+  data.tar.gz: f74891d9e13561d6a1ece0fb64fd014af2b1504e412e9d51b4e83d8d6a9aa089
 SHA512:
-  metadata.gz: 0071a0c809fae4043ea2ffa35ef811f575d1c9027f199c47d344692ce0e7a641a10f94af240220959a5ef924f92985511afebd8b502cc35ed023bbffe2b27a62
-  data.tar.gz: 0076f43c9ae828ead40ec6d64a6409fa96d3631a290673baf026aa65e8f72fbdc8103cd073a7f5919945cd8a7f598f233889ef38ea173f3e58cd27cbb03f8812
+  metadata.gz: f3c8574a741707ef88be3f6ec1e1287b4a67b091d0c12634e65d563e93510ba135c193b55f9f4d05af5a5f8b1d9a6c661f691e571811281cd523c6a62eec5513
+  data.tar.gz: 13a013bcc7738c449696207a3622e1b3d3b7bed626fd2e39fe2a89c08eb42776fd19a32c7d65642b4ada6535a94af0f3f0a6ea3aee303eba1c2407daff9d4ad9

data/lib/solargraph/complex_type.rb

@@ -73,6 +73,8 @@ module Solargraph
       @items.any?(&:selfy?)
     end
 
+    # @param dst [String]
+    # @return [ComplexType]
     def self_to dst
       return self unless selfy?
       red = reduce_class(dst)
@@ -86,6 +88,8 @@ module Solargraph
     #   to reference an instance of their class and never the class itself.
     #   This behavior may change depending on which result is expected
     #   from YARD conventions. See https://github.com/lsegal/yard/issues/1257
+    # @param dst [String]
+    # @return [String]
     def reduce_class dst
       while dst =~ /^(Class|Module)\<(.*?)\>$/
         dst = dst.sub(/^(Class|Module)\</, '').sub(/\>$/, '')

data/lib/solargraph/core_fills.rb

@@ -21,10 +21,14 @@ module Solargraph
     ]
 
     OVERRIDES = [
-      Override.method_return('Array#select', 'self'),
-      Override.method_return('Array#reject', 'self'),
       Override.method_return('Array#keep_if', 'self'),
       Override.method_return('Array#delete_if', 'self'),
+      Override.from_comment('Array#reject', %(
+@overload reject(&block)
+  @return [self]
+@overload reject()
+  @return [Enumerator]
+              )),
       Override.method_return('Array#reverse', 'self', delete: ['overload']),
       Override.from_comment('Array#select', %(
 @overload select(&block)
@@ -76,6 +80,7 @@ module Solargraph
       Override.method_return('Object#dup', 'self'),
       Override.method_return('Object#freeze', 'self'),
       Override.method_return('Object#taint', 'self'),
+      Override.method_return('Object#to_s', 'String'),
       Override.method_return('Object#untaint', 'self'),
       Override.from_comment('Object#tap', %(
 @return [self]

data/lib/solargraph/page.rb

@@ -9,6 +9,8 @@ require 'cgi'
 module Solargraph
   class Page
     class Binder < OpenStruct
+      # @param locals [Hash]
+      # @param render_method [Proc]
       def initialize locals, render_method
         super(locals)
         define_singleton_method :render do |template, layout: false, locals: {}|
@@ -19,6 +21,8 @@ module Solargraph
         end
       end
 
+      # @param text [String]
+      # @return [String]
       def htmlify text
         Kramdown::Document.new(
           text.to_s.lines.map{|l| l.gsub(/^  /, "\t")}.join,
@@ -33,16 +37,23 @@ module Solargraph
         ).to_html
       end
 
+      # @param code [String]
+      # @return [String]
       def ruby_to_html code
         code
       end
     end
     private_constant :Binder
 
+    # @param directory [String]
     def initialize directory = VIEWS_PATH
       directory = VIEWS_PATH if directory.nil? or !File.directory?(directory)
       directories = [directory]
       directories.push VIEWS_PATH if directory != VIEWS_PATH
+      # @type [Proc]
+      # @param template [String]
+      # @param layout [Boolean]
+      # @param locals [Hash]
       @render_method = proc { |template, layout: false, locals: {}|
         binder = Binder.new(locals, @render_method)
         if layout
@@ -55,10 +66,17 @@ module Solargraph
       }
     end
 
+    # @param template [String]
+    # @param layout [Boolean]
+    # @param locals [Hash]
+    # @return [String]
     def render template, layout: true, locals: {}
       @render_method.call(template, layout: layout, locals: locals)
     end
 
+    # @param directories [Array<String>]
+    # @param name [String]
+    # @return [String]
     def self.select_template directories, name
       directories.each do |dir|
         path = File.join(dir, "#{name}.erb")

data/lib/solargraph/pin/base.rb

@@ -236,7 +236,8 @@ module Solargraph
 
       # @return [void]
       def parse_comments
-        if comments.empty?
+        # HACK: Avoid a NoMethodError on nil with empty overload tags
+        if comments.empty? || comments.strip.end_with?('@overload')
           @docstring = nil
           @directives = []
         else

data/lib/solargraph/pin/base_variable.rb

@@ -5,8 +5,10 @@ module Solargraph
     class BaseVariable < Base
       include Solargraph::Source::NodeMethods
 
+      # @return [Parser::AST::Node, nil]
       attr_reader :assignment
 
+      # @param assignment [Parser::AST::Node, nil]
       def initialize assignment: nil, **splat
         super(splat)
         @assignment = assignment
@@ -41,11 +43,9 @@ module Solargraph
         return ComplexType::UNDEFINED if @assignment.nil?
         types = []
         returns_from(@assignment).each do |node|
-          chain = Source::NodeChainer.chain(node, filename)
-          next if chain.links.first.word == name
-          clip = api_map.clip_at(location.filename, location.range.start)
-          locals = clip.locals - [self]
-          result = chain.infer(api_map, closure, locals)
+          pos = Solargraph::Position.new(node.loc.expression.last_line, node.loc.expression.last_column)
+          clip = api_map.clip_at(location.filename, pos)
+          result = clip.infer
           types.push result unless result.undefined?
         end
         return ComplexType::UNDEFINED if types.empty?
@@ -66,6 +66,7 @@ module Solargraph
 
       private
 
+      # @return [ComplexType]
       def generate_complex_type
         tag = docstring.tag(:type)
         return ComplexType.try_parse(*tag.types) unless tag.nil? || tag.types.nil? || tag.types.empty?

data/lib/solargraph/pin/parameter.rb

@@ -26,13 +26,6 @@ module Solargraph
         closure.is_a?(Pin::Block) ? typify_block_param(api_map) : typify_method_param(api_map)
       end
 
-      def try_merge! pin
-        return false unless super && closure.nearly?(pin.closure)
-        @return_type = pin.return_type
-        reset_conversions
-        true
-      end
-
       def documentation
         tag = param_tag
         return '' if tag.nil? || tag.text.nil?
@@ -118,7 +111,7 @@ module Solargraph
       # @param heredoc [YARD::Docstring]
       # @param api_map [ApiMap]
       # @param skip [Array]
-      # @return [ComplexType]
+      # @return [Array<YARD::Tags::Tag>]
       def see_reference heredoc, api_map, skip = []
         heredoc.ref_tags.each do |ref|
           next unless ref.tag_name == 'param' && ref.owner
@@ -131,7 +124,7 @@ module Solargraph
       # @param ref [String]
       # @param api_map [ApiMap]
       # @param skip [Array]
-      # @return [ComplexType]
+      # @return [Array<YARD::Tags::Tag>, nil]
       def resolve_reference ref, api_map, skip
         return nil if skip.include?(ref)
         skip.push ref
@@ -140,7 +133,7 @@ module Solargraph
           path = "#{namespace}#{ref}"
         else
           fqns = api_map.qualify(parts.first, namespace)
-          return ComplexType::UNDEFINED if fqns.nil?
+          return nil if fqns.nil?
           path = fqns + ref[parts.first.length] + parts.last
         end
         pins = api_map.get_path_pins(path)

data/lib/solargraph/source/chain.rb

@@ -19,6 +19,7 @@ module Solargraph
       autoload :Literal,          'solargraph/source/chain/literal'
       autoload :Head,             'solargraph/source/chain/head'
       autoload :Or,               'solargraph/source/chain/or'
+      autoload :BlockVariable,    'solargraph/source/chain/block_variable'
 
       @@inference_stack = []
       @@inference_depth = 0

data/lib/solargraph/source/chain/block_variable.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Solargraph
+  class Source
+    class Chain
+      class BlockVariable < Link
+        def resolve api_map, name_pin, locals
+          Pin::ProxyType.anonymous('Proc')
+        end
+      end
+    end
+  end
+end

data/lib/solargraph/source/node_chainer.rb

@@ -48,7 +48,9 @@ module Solargraph
         return generate_links(n.children[0]) if n.type == :begin
         result = []
         if n.type == :block
+          @in_block = true
           result.concat generate_links(n.children[0])
+          @in_block = false
         elsif n.type == :send
           if n.children[0].is_a?(Parser::AST::Node)
             result.concat generate_links(n.children[0])
@@ -56,13 +58,13 @@ 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)
+            result.push Chain::Call.new(n.children[1].to_s, args, @in_block || 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)
+            result.push Chain::Call.new(n.children[1].to_s, args, @in_block || block_passed?(n))
           else
             raise "No idea what to do with #{n}"
           end
@@ -92,12 +94,18 @@ module Solargraph
           result.push Chain::Or.new([NodeChainer.chain(n.children[0], @filename), NodeChainer.chain(n.children[1], @filename)])
         elsif [:begin, :kwbegin].include?(n.type)
           result.concat generate_links(n.children[0])
+        elsif n.type == :block_pass
+          result.push Chain::BlockVariable.new("&#{n.children[0].children[0].to_s}")
         else
           lit = infer_literal_node_type(n)
           result.push (lit ? Chain::Literal.new(lit) : Chain::Link.new)
         end
         result
       end
+
+      def block_passed? node
+        node.children.last.is_a?(Parser::AST::Node) && node.children.last.type == :block_pass
+      end
     end
   end
 end

data/lib/solargraph/source/node_methods.rb

@@ -122,6 +122,8 @@ module Solargraph
         signature
       end
 
+      NIL_NODE = Parser::AST::Node.new(:nil)
+
       # Find all the nodes within the provided node that potentially return a
       # value.
       #
@@ -129,24 +131,20 @@ module Solargraph
       # second child (after the :args node) of a :def node. A simple one-line
       # method would typically return itself, while a node with conditions
       # would return the resulting node from each conditional branch. Nodes
-      # that follow a :return node are assumed to be unreachable. Implicit nil
-      # values are ignored.
-      #
-      # @todo Maybe this method should include implicit nil values in results.
-      #   For example, a bare `return` would return a :nil node instead of an
-      #   empty array.
+      # that follow a :return node are assumed to be unreachable. Nil values
+      # are converted to nil node types.
       #
-      # @param node [AST::Node]
-      # @return [Array<AST::Node>]
+      # @param node [Parser::AST::Node]
+      # @return [Array<Parser::AST::Node>]
       def returns_from node
-        DeepInference.get_return_nodes(node)
+        DeepInference.get_return_nodes(node).map { |n| n || NIL_NODE }
       end
 
       module DeepInference
         class << self
           CONDITIONAL = [:if, :unless]
           REDUCEABLE = [:begin, :kwbegin]
-          SKIPPABLE = [:def, :defs, :class, :sclass, :module, :block]
+          SKIPPABLE = [:def, :defs, :class, :sclass, :module]
 
           # @param node [Parser::AST::Node]
           # @return [Array<Parser::AST::Node>]
@@ -162,7 +160,8 @@ module Solargraph
             elsif node.type == :return
               result.concat reduce_to_value_nodes([node.children[0]])
             elsif node.type == :block
-              result.concat reduce_to_value_nodes(node.children[0..-2])
+              result.concat reduce_to_value_nodes([node.children[0]])
+              result.concat get_return_nodes_only(node.children[2])
             else
               result.push node
             end
@@ -174,9 +173,12 @@ module Solargraph
           def get_return_nodes_from_children parent
             result = []
             nodes = parent.children.select{|n| n.is_a?(AST::Node)}
-            nodes[0..-2].each do |node|
-              next if SKIPPABLE.include?(node.type)
-              if node.type == :return
+            nodes.each_with_index do |node, idx|
+              if node.type == :block
+                result.concat get_return_nodes_only(node.children[2])
+              elsif SKIPPABLE.include?(node.type)
+                next
+              elsif node.type == :return
                 result.concat reduce_to_value_nodes([node.children[0]])
                 # Return the result here because the rest of the code is
                 # unreachable
@@ -184,8 +186,8 @@ module Solargraph
               else
                 result.concat get_return_nodes_only(node)
               end
+              result.concat reduce_to_value_nodes([nodes.last]) if idx == nodes.length - 1
             end
-            result.concat reduce_to_value_nodes([nodes.last]) unless nodes.last.nil?
             result
           end
 

data/lib/solargraph/source/source_chainer.rb

@@ -41,6 +41,7 @@ module Solargraph
             node, parent = source.tree_at(position.line, position.column)[0..2]
           elsif source.parsed? && source.repaired? && end_of_phrase == '.'
             node, parent = source.tree_at(fixed_position.line, fixed_position.column)[0..2]
+            node = Source.parse(fixed_phrase) if node.nil?
           else
             node, parent = source.tree_at(fixed_position.line, fixed_position.column)[0..2] unless source.error_ranges.any?{|r| r.nil? || r.include?(fixed_position)}
             # Exception for positions that chain literal nodes in unsynchronized sources

data/lib/solargraph/type_checker.rb

@@ -53,9 +53,9 @@ module Solargraph
         type = par.typify(api_map)
         pdefs = ParamDef.from(par.closure)
         if type.undefined?
-          if par.return_type.undefined? && !pdefs.any? { |pd| pd.name == par.name && [:restarg, :kwrestarg].include?(pd.type) }
+          if par.return_type.undefined? && !pdefs.any? { |pd| pd.name == par.name && [:restarg, :kwrestarg, :blockarg].include?(pd.type) }
             result.push Problem.new(par.location, "#{par.closure.name} has undefined @param type for #{par.name}")
-          elsif !pdefs.any? { |pd| [:restarg, :kwrestarg].include?(pd.type) }
+          elsif !pdefs.any? { |pd| [:restarg, :kwrestarg, :blockarg].include?(pd.type) }
             result.push Problem.new(par.location, "#{par.closure.name} has unresolved @param type for #{par.name}")
           end
         end

data/lib/solargraph/type_checker/param_def.rb

@@ -40,6 +40,7 @@ module Solargraph
           return :optarg if string.include?('=')
           return :kwoptarg if string.end_with?(':')
           return :kwarg if string =~ /^[a-z0-9_]*?:/
+          return :blockarg if string.start_with?('&')
           :arg
         end
       end

data/lib/solargraph/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Solargraph
-  VERSION = '0.34.3'
+  VERSION = '0.35.0'
 end

data/lib/solargraph/workspace/config.rb

@@ -10,7 +10,7 @@ module Solargraph
       # The maximum number of files that can be added to a workspace.
       # The workspace's .solargraph.yml can override this value.
       MAX_FILES = 5000
-
+        
       # @return [String]
       attr_reader :directory
 
@@ -20,24 +20,7 @@ module Solargraph
       # @param directory [String]
       def initialize directory = ''
         @directory = directory
-        include_globs = ['**/*.rb']
-        exclude_globs = ['spec/**/*', 'test/**/*', 'vendor/**/*', '.bundle/**/*']
-        unless @directory.empty?
-          sfile = File.join(@directory, '.solargraph.yml')
-          if File.file?(sfile)
-            @raw_data = YAML.safe_load(File.read(sfile))
-            include_globs = @raw_data['include'] || include_globs
-            exclude_globs = @raw_data['exclude'] || []
-          end
-        end
-        @raw_data ||= {}
-        @raw_data['include'] ||= include_globs
-        @raw_data['exclude'] ||= exclude_globs
-        @raw_data['require'] ||= []
-        @raw_data['domains'] ||= []
-        @raw_data['reporters'] ||= %w[rubocop require_not_found]
-        @raw_data['require_paths'] ||= []
-        @raw_data['max_files'] ||= MAX_FILES
+        @raw_data = config_data
         included
         excluded
       end
@@ -110,6 +93,54 @@ module Solargraph
       end
 
       private
+      
+      # @return [String]
+      def global_config_path
+        ENV['SOLARGRAPH_GLOBAL_CONFIG'] || 
+          File.join(Dir.home, '.config', 'solargraph', 'config.yml')
+      end
+
+      # @return [String]
+      def workspace_config_path
+        return '' if @directory.empty?
+        File.join(@directory, '.solargraph.yml')
+      end
+
+      # @return [Hash]
+      def config_data
+        workspace_config = read_config(workspace_config_path)
+        global_config = read_config(global_config_path)
+        
+        defaults = default_config
+        defaults.merge({'exclude' => []}) unless workspace_config.nil?
+
+        defaults
+          .merge(global_config || {})
+          .merge(workspace_config || {})
+      end
+      
+      # Read a .solargraph yaml config
+      #
+      # @param directory [String]
+      # @return [Hash]
+      def read_config config_path = ''
+        return nil if config_path.empty?
+        return nil unless File.file?(config_path)
+        YAML.safe_load(File.read(config_path))
+      end
+      
+      # @return [Hash]
+      def default_config
+        {
+          'include' => ['**/*.rb'],
+          'exclude' => ['spec/**/*', 'test/**/*', 'vendor/**/*', '.bundle/**/*'],
+          'require' => [],
+          'domains' => [],
+          'reporters' => %w[rubocop require_not_found],
+          'require_paths' => [],
+          'max_files' => MAX_FILES,
+        }
+      end
 
       # Get an array of files from the provided globs.
       #

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solargraph
 version: !ruby/object:Gem::Version
-  version: 0.34.3
+  version: 0.35.0
 platform: ruby
 authors:
 - Fred Snyder
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-15 00:00:00.000000000 Z
+date: 2019-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: backport
@@ -381,6 +381,7 @@ files:
 - lib/solargraph/shell.rb
 - lib/solargraph/source.rb
 - lib/solargraph/source/chain.rb
+- lib/solargraph/source/chain/block_variable.rb
 - lib/solargraph/source/chain/call.rb
 - lib/solargraph/source/chain/class_variable.rb
 - lib/solargraph/source/chain/constant.rb