solargraph 0.38.0 → 0.38.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b51cc5aaad5a07e4b7a5f6d2678b3fa42ffba42e7eb5aef0a9dca1834fe3b32
-  data.tar.gz: eef096fe46ea782d8d1b747f4bf1faa80c3cac9caf80b6f212face3ae8d45392
+  metadata.gz: 0dbf36f40f7b87b541abe48c7e624999b44730cd5165f53ca8e7878311da7dcd
+  data.tar.gz: 0c12fa0cc1008eaf172fb964e6fac8fbc0b46333247b273b0e4ea9d840a81862
 SHA512:
-  metadata.gz: 47f9cdd2ef911ab8ace7de207503c53bc518aaa1b303bb2bc097b86cca229d73886ad8fa0bd7d502794cc8ec67c4c9a9077bd75b2c06e9e9bb39e3879a102eef
-  data.tar.gz: 698d1343b2843767c9a51d7330f0af2c4202018b1e9cd3e78179f3dd709d1a4a48b5b01ada8d867b8107c4b297a5bc34305989f4adaa7e9057732f1298b54975
+  metadata.gz: b7d4bb938698bf682bbb418a6489b4544451ad91039d0fe0e0720339d8b2f9e6c394cc7d8354cc1b2cf6b5505867e93ca26071c177ecae69eab2cf5c1e2e601d
+  data.tar.gz: 368ad36e47cc109a9e3c428a743617771a69e14ce7730e4889bb7bab44c3c3aa13643608d6286497f7ea38b99c1f6da130a3401ae0a167a31cf07fb96197fac0

data/.travis.yml

@@ -6,6 +6,7 @@ rvm:
   - 2.4
   - 2.5
   - 2.6
+  - 2.7
   - jruby-head
 matrix:
   include:

data/README.md

@@ -61,6 +61,12 @@ The Solargraph gem ships with documentation for Ruby 2.2.2. You can download doc
     $ solargraph download-core   # Install the best match for your Ruby version
     $ solargraph clear           # Reset the documentation cache
 
+### The Documentation Cache
+
+Solargraph uses a cache directory to store documentation for the Ruby core and customized documentation for certain gems. The default location is `~/.solargraph/cache`, e.g., `/home/<username>/.solargraph/cache` on Linux or `C:\Users\<username>\.solargraph` on Windows.
+
+You can change the location of the cache directory with the `SOLARGRAPH_CACHE` environment variable. This can be useful if you want the cache to comply with the XDG Base Directory Specification.
+
 ### Solargraph and Bundler
 
 If you're using the language server with a project that uses Bundler, the most comprehensive way to use your bundled gems is to bundle Solargraph.

data/lib/solargraph/api_map.rb

@@ -138,7 +138,7 @@ module Solargraph
       @implicit ||= Environ.new
     end
 
-    # @return [Hash]
+    # @return [Hash{String => String}]
     def local_path_hash
       @local_paths ||= {}
     end
@@ -189,7 +189,7 @@ module Solargraph
 
     # An array of namespace names defined in the ApiMap.
     #
-    # @return [Array<String>]
+    # @return [Set<String>]
     def namespaces
       store.namespaces
     end
@@ -513,9 +513,11 @@ module Solargraph
     # @return [Boolean]
     def super_and_sub?(sup, sub)
       fqsup = qualify(sup)
-      cls = qualify(store.get_superclass(sub), sub)
-      until cls.nil?
-        return true if cls == fqsup
+      cls = qualify(sub)
+      until fqsup.nil? || cls.nil?
+        # @todo Classes in the workspace are not detected as subclasses of
+        #   Object. The quick and dirty fix is to hardcode it here.
+        return true if fqsup == 'Object' || cls == fqsup
         cls = qualify(store.get_superclass(cls), cls)
       end
       false
@@ -627,7 +629,7 @@ module Solargraph
     # @param name [String]
     # @param root [String]
     # @param skip [Array<String>]
-    # @return [String]
+    # @return [String, nil]
     def inner_qualify name, root, skip
       return nil if name.nil?
       return nil if skip.include?(root)
@@ -663,7 +665,7 @@ module Solargraph
     # Get the namespace's type (Class or Module).
     #
     # @param fqns [String] A fully qualified namespace
-    # @return [Symbol] :class, :module, or nil
+    # @return [Symbol, nil] :class, :module, or nil
     def get_namespace_type fqns
       return nil if fqns.nil?
       # @type [Pin::Namespace, nil]

data/lib/solargraph/core_fills.rb

@@ -62,6 +62,11 @@ module Solargraph
 @return_single_parameter
       )),
 
+      Override.from_comment('BasicObject#==', %(
+@param other [BasicObject]
+@return [Boolean]
+      )),
+
       Override.method_return('Class#new', 'self'),
       Override.method_return('Class.new', 'Class<Object>'),
       Override.method_return('Class#allocate', 'self'),
@@ -75,10 +80,16 @@ module Solargraph
 @return_value_parameter
       )),
 
+      # @todo This override isn't robust enough. It needs to allow for
+      #   parameterized Hash types, e.g., [Hash{Symbol => String}].
+      Override.from_comment('Hash#[]=', %(
+@param_tuple
+      )),
+
       Override.method_return('Object#!', 'Boolean'),
       Override.method_return('Object#clone', 'self', delete: [:overload]),
       Override.method_return('Object#dup', 'self'),
-      Override.method_return('Object#freeze', 'self'),
+      Override.method_return('Object#freeze', 'self', delete: [:overload]),
       Override.method_return('Object#taint', 'self'),
       Override.method_return('Object#to_s', 'String'),
       Override.method_return('Object#untaint', 'self'),
@@ -99,3 +110,4 @@ module Solargraph
       )
   end
 end
+

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

@@ -12,16 +12,23 @@ module Solargraph
 
         # @param word [String]
         # @param arguments [Array<Chain>]
-        def initialize word, arguments = [], with_block = false
+        # @param with_block [Boolean] True if the chain is inside a block
+        # @param head [Boolean] True if the call is the start of its chain
+        def initialize word, arguments = [], with_block = false, head = false
           @word = word
           @arguments = arguments
           @with_block = with_block
+          @head = head
         end
 
         def with_block?
           @with_block
         end
 
+        def head?
+          @head
+        end
+
         # @param api_map [ApiMap]
         # @param name_pin [Pin::Base]
         # @param locals [Array<Pin::Base>]
@@ -29,6 +36,7 @@ module Solargraph
           found = locals.select{|p| p.name == word}
           return inferred_pins(found, api_map, name_pin.context, locals) unless found.empty?
           pins = api_map.get_method_stack(name_pin.binder.namespace, word, scope: name_pin.binder.scope)
+          pins.concat api_map.get_method_stack('Kernel', word, scope: :instance) if head?
           return [] if pins.empty?
           inferred_pins(pins, api_map, name_pin.context, locals)
         end
@@ -108,6 +116,7 @@ module Solargraph
         # @param pin [Pin::Method]
         # @param api_map [ApiMap]
         # @param context [ComplexType]
+        # @param locals [Pin::Base]
         # @return [Pin::Base]
         def process_macro pin, api_map, context, locals
           pin.macros.each do |macro|
@@ -117,6 +126,11 @@ module Solargraph
           Pin::ProxyType.anonymous(ComplexType::UNDEFINED)
         end
 
+        # @param pin [Pin::Method]
+        # @param api_map [ApiMap]
+        # @param context [ComplexType]
+        # @param locals [Pin::Base]
+        # @return [Pin::ProxyType]
         def process_directive pin, api_map, context, locals
           pin.directives.each do |dir|
             macro = api_map.named_macro(dir.tag.name)
@@ -127,8 +141,12 @@ module Solargraph
           Pin::ProxyType.anonymous ComplexType::UNDEFINED
         end
 
-        # @param api_map [ApiMap]
+        # @param pin [Pin]
         # @param macro [YARD::Tags::MacroDirective]
+        # @param api_map [ApiMap]
+        # @param context [ComplexType]
+        # @param locals [Array<Pin::Base>]
+        # @return [Pin::ProxyType]
         def inner_process_macro pin, macro, api_map, context, locals
           vals = arguments.map{ |c| Pin::ProxyType.anonymous(c.infer(api_map, pin, locals)) }
           txt = macro.tag.text.clone
@@ -151,17 +169,19 @@ module Solargraph
 
         # @param docstring [YARD::Docstring]
         # @param context [ComplexType]
+        # @return [ComplexType]
         def extra_return_type docstring, context
           if docstring.has_tag?(:return_single_parameter) && context.subtypes.one?
             return context.subtypes.first
           elsif docstring.has_tag?(:return_value_parameter) && context.value_types.one?
             return context.value_types.first
-          # elsif docstring.has_tag?(:return) && docstring.tag(:return).types && !docstring.tag(:return).types.empty?
-          #   return ComplexType.try_parse(*docstring.tag(:return).types)
           end
           nil
         end
 
+        # @param arguments [Array<Chain>]
+        # @param parameters [Array<String>]
+        # @return [Boolean]
         def arguments_match arguments, parameters
           argcount = arguments.length
           # argcount -= 1 if !arguments.empty? && arguments.last.links.first.word.start_with?('&')

data/lib/solargraph/source/node_chainer.rb

@@ -58,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 || block_passed?(n))
+            result.push Chain::Call.new(n.children[1].to_s, args, @in_block || block_passed?(n), result.length.zero?)
           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 || block_passed?(n), result.length.zero?)
           else
             raise "No idea what to do with #{n}"
           end

data/lib/solargraph/source/node_methods.rb

@@ -70,6 +70,8 @@ module Solargraph
           return '::Regexp'
         elsif node.type == :irange
           return '::Range'
+        elsif node.type == :true || node.type == :false
+          return '::Boolean'
         # @todo Support `nil` keyword in types
         # elsif node.type == :nil
         #   return 'NilClass'

data/lib/solargraph/type_checker.rb

@@ -177,9 +177,33 @@ module Solargraph
         else
           pin = pins.first
           ptypes = ParamDef.from(pin)
-          params = param_tags_from(pin)
+          params = first_param_tags_from(pins)
           cursor = 0
           curtype = nil
+          # The @param_tuple tag marks exceptional cases for handling, e.g., the Hash#[]= method.
+          if pin.docstring.tag(:param_tuple)
+            if node.children[2..-1].length > 2
+              result.push Problem.new(Solargraph::Location.new(filename, Solargraph::Range.from_node(node)), "Wrong number of arguments to #{pin.path}")
+            else
+              base = chain.base.infer(api_map, block, locals)
+              # @todo Don't just use the first key/value type
+              k = base.key_types.first || ComplexType.parse('Object')
+              v = base.value_types.first || ComplexType.parse('Object')
+              tuple = [
+                ParamDef.new('key', k),
+                ParamDef.new('value', v)
+              ]
+              node.children[2..-1].each_with_index do |arg, index|
+                chain = Solargraph::Source::NodeChainer.chain(arg, filename)
+                argtype = chain.infer(api_map, block, locals)
+                partype = tuple[index].type
+                if argtype.tag != partype.tag && !api_map.super_and_sub?(partype.tag.to_s, argtype.tag.to_s)
+                  result.push Problem.new(Solargraph::Location.new(filename, Solargraph::Range.from_node(node)), "Wrong parameter type for #{pin.path}: #{tuple[index].name} expected #{partype.tag}, received #{argtype.tag}")
+                end
+              end
+            end
+            return result
+          end
           node.children[2..-1].each_with_index do |arg, index|
             if pin.is_a?(Pin::Attribute)
               curtype = ParamDef.new('value', :arg)
@@ -188,8 +212,20 @@ module Solargraph
             end
             if curtype.nil?
               if pin.parameters[index].nil?
-                result.push Problem.new(Solargraph::Location.new(filename, Solargraph::Range.from_node(node)), "Not enough arguments sent to #{pin.path}")
-                break
+                if params.values[index]
+                  # Allow for methods that have named parameters but no
+                  # arguments in their definitions. This is common in the Ruby
+                  # core, e.g., the Hash#[]= method.
+                  chain = Solargraph::Source::NodeChainer.chain(arg, filename)
+                  argtype = chain.infer(api_map, block, locals)
+                  partype = params.values[index]
+                  if argtype.tag != partype.tag && !api_map.super_and_sub?(partype.tag.to_s, argtype.tag.to_s)
+                    result.push Problem.new(Solargraph::Location.new(filename, Solargraph::Range.from_node(node)), "Wrong parameter type for #{pin.path}: #{params.keys[index]} expected #{partype.tag}, received #{argtype.tag}")
+                  end
+                else
+                  result.push Problem.new(Solargraph::Location.new(filename, Solargraph::Range.from_node(node)), "Not enough arguments sent to #{pin.path}")
+                  break
+                end
               end
             else
               # @todo This should also detect when the last parameter is a hash
@@ -300,6 +336,14 @@ module Solargraph
       result
     end
 
+    def first_param_tags_from pins
+      pins.each do |pin|
+        result = param_tags_from(pin)
+        return result unless result.empty?
+      end
+      {}
+    end
+
     # @param location [Location, nil]
     def report_location? location
       return false if location.nil?

data/lib/solargraph/version.rb

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

data/lib/yard-solargraph.rb

@@ -22,6 +22,8 @@ YARD::Tags::Library.define_tag('ReturnSingleParameter', :return_single_parameter
 YARD::Tags::Library.define_tag('YieldparamSingleParameter', :yieldparam_single_parameter)
 # Define a @return_value_parameter tag for returning e.g. Hash values
 YARD::Tags::Library.define_tag('ReturnValueParameter', :return_value_parameter)
+# Define a @param_tuple tag for e.g. Hash#[]= parameters
+YARD::Tags::Library.define_tag('ParamTuple', :param_tuple)
 # Define a @!domain directive for documenting DSLs
 YARD::Tags::Library.define_directive("domain", :with_types, Solargraph::DomainDirective)
 # Define an @!override directive for overriding method tags

data/solargraph.gemspec

@@ -27,9 +27,12 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'parser', '~> 2.3'
   s.add_runtime_dependency 'reverse_markdown', '~> 1.0', '>= 1.0.5'
   s.add_runtime_dependency 'rubocop', '~> 0.52'
-  s.add_runtime_dependency 'thor', '~> 0.19', '>= 0.19.4'
+  s.add_runtime_dependency 'thor', '~> 1.0'
   s.add_runtime_dependency 'tilt', '~> 2.0'
   s.add_runtime_dependency 'yard', '~> 0.9'
+  s.add_runtime_dependency 'e2mmap'
+  s.add_runtime_dependency 'irb', '<= 1.1.0'
+  s.add_runtime_dependency 'benchmark'
 
   s.add_development_dependency 'pry', '~> 0.11.3'
   s.add_development_dependency 'rspec', '~> 3.5', '>= 3.5.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solargraph
 version: !ruby/object:Gem::Version
-  version: 0.38.0
+  version: 0.38.1
 platform: ruby
 authors:
 - Fred Snyder
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-22 00:00:00.000000000 Z
+date: 2020-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: backport
@@ -146,20 +146,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.19'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.19.4
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.19'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.19.4
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: tilt
   requirement: !ruby/object:Gem::Requirement
@@ -188,6 +182,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: e2mmap
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: irb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: benchmark
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement