solargraph 0.44.1 → 0.45.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 346926f891270e103d6c7170fe5897587c1d5da45ea33b2a7f4238914b38b236
-  data.tar.gz: 451b09bf70dc9d760ebfdeb726821e6e653f196bd867da8c7638888803e33a72
+  metadata.gz: 99cf1c663bb1a93324ff9c860b82e60d47988a4c48e9c0e977176cb94852f29c
+  data.tar.gz: 9b10324bcf7493f9ed5f8a67a8d47e4f0a379b76ed2aeb31514d1fa06b88dbf6
 SHA512:
-  metadata.gz: 624d1de49ef2762477d7a413adf282a058143a71689ea8cdfcc91177db94c765b997fca00fefd8d0d4915e44e6cd4ae1867297671611ba6d119d610116c5b80a
-  data.tar.gz: 9f146a371e075407cb8be7b96de08ff24583cf18eb1a29310c1a711c1bd347715d07b0ff6603e9a98b71be7406148e17c907abdcf3bd1a2aba58bd5aeff14685
+  metadata.gz: a981e45a500d2469972d0fab1e4bcfdbde99dc46de7ef7b377d486a9a027ce617b8806790ed3565a673fbf3d3fd206d246408b5ce744a0b575e02ee3a3a9b699
+  data.tar.gz: 0bcb7a9957581cac9c066076938dbbdcbcc596bf7ddc8f4cd4539d71dadabab68cfdbc18f59df8daedd02dcff8f45b671a0a742c6ec1afbd39ede15fb3db381b

data/.github/workflows/rspec.yml

@@ -0,0 +1,41 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with rspec.
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: RSpec
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.4', '2.5', '2.6', '2.7', '3.0']
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@2b019609e2b0f1ea1a2bc8ca11cb82ab46ada124
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: false
+    - run: bundle install
+    - name: Set up yardocs
+      run: bundle exec yard gems
+    - name: Run tests
+      run: bundle exec rspec

data/CHANGELOG.md

@@ -1,3 +1,28 @@
+## 0.45.0 - May 23, 2022
+- Basic support for RSpec #describe and #it
+- fix: domain can complete private method (#490)
+- Update README.md (#533)
+- Doc: update readme.md for add solargraph support (#536)
+- Process DASGN node in Ruby 3
+- File.open core fill
+- replace with_unbundled_env with with_original_env (#489)
+- Require specific version of gem (#509)
+- Support URIs prefixed with single slashed file scheme (#529)
+- Fix typo in README.md (#549)
+- details on config behavior (#556)
+- Consider overloads in arity checks
+- ENV core fill for Hash-like methods (#537)
+- Fix string ranges with substitutions (#463)
+
+## 0.44.3 - January 22, 2022
+- TypeChecker validates aliased namespaces (#497)
+- Always use reference YARD tags when resolving param types (#515) (#516)
+- Skip method aliases in strict type checking
+
+## 0.44.2 - November 23, 2021
+- Scope local variables in class_eval blocks (#503)
+- Fix invalid UTF-8 in node comments (#504)
+
 ## 0.44.1 - November 18, 2021
 - Chain nil safety navigation operator (#420)
 - Update closure and context for class_eval receiver (#487)

data/README.md

@@ -1,5 +1,7 @@
 # Solargraph
 
+[![RSpec](https://github.com/castwide/solargraph/actions/workflows/rspec.yml/badge.svg)](https://github.com/castwide/solargraph/actions/workflows/rspec.yml)
+
 ## A Ruby Language Server
 
 Solargraph provides a comprehensive suite of tools for Ruby programming: intellisense, diagnostics, inline documentation, and type checking.
@@ -31,7 +33,9 @@ Plug-ins and extensions are available for the following editors:
     * GitHub: https://github.com/castwide/atom-solargraph
 
 * **Vim**
-    * GitHub: https://github.com/autozimu/LanguageClient-neovim
+    * GitHub: `LanguageClient-neovim`, https://github.com/autozimu/LanguageClient-neovim
+    * GitHub: `coc`, https://github.com/neoclide/coc-solargraph
+    * GitHub: `Vim-EasyComplete`, https://github.com/jayli/vim-easycomplete
 
 * **Emacs**
     * GitHub: `eglot.el`, https://github.com/joaotavora/eglot
@@ -41,13 +45,17 @@ Plug-ins and extensions are available for the following editors:
     * Plugin: https://marketplace.eclipse.org/content/ruby-solargraph
     * GitHub: https://github.com/PyvesB/eclipse-solargraph
 
+### Configuration
+
+Solargraph's behavior can be controlled via optional [configuration](https://solargraph.org/guides/configuration) files. The highest priority file is a `.solargraph.yml` file at the root of the project. If not present, any global configuration at `~/.config/solargraph/config.yml` will apply. The path to the global configuration can be overridden with the `SOLARGRAPH_GLOBAL_CONFIG` environment variable.
+
 ### Gem Support
 
 Solargraph is capable of providing code completion and documentation for gems that have YARD documentation. You can make sure your gems are documented by running `yard gems` from the command line. (YARD is included as one of Solargraph's gem dependencies. The first time you run it might take a while if you have a lot of gems installed).
 
 When editing code, a `require` call that references a gem will pull the documentation into the code maps and include the gem's API in code completion and intellisense.
 
-If your project automatically requires bundled gems (e.g., `require 'bundler/require'`), Solargraph will add all of the Gemfile's default dependecies to the map.
+If your project automatically requires bundled gems (e.g., `require 'bundler/require'`), Solargraph will add all of the Gemfile's default dependencies to the map.
 
 ### Type Checking
 

data/SPONSORS.md

@@ -13,3 +13,5 @@ The following people and organizations provide funding or other resources. [Beco
 - Emily Strickland
 - Tom de Grunt
 - Akira Yamada
+- Erlend Finvåg
+- Matt Massicotte

data/lib/solargraph/api_map.rb

@@ -255,7 +255,7 @@ module Solargraph
         implicit.domains.each do |domain|
           type = ComplexType.try_parse(domain)
           next if type.undefined?
-          result.concat inner_get_methods(type.name, type.scope, [:public], deep, skip)
+          result.concat inner_get_methods(type.name, type.scope, visibility, deep, skip)
         end
         result.concat inner_get_methods(fqns, :class, visibility, deep, skip)
         result.concat inner_get_methods(fqns, :instance, visibility, deep, skip)
@@ -525,7 +525,7 @@ module Solargraph
         end
         store.domains(fqns).each do |d|
           dt = ComplexType.try_parse(d)
-          result.concat inner_get_methods(dt.namespace, dt.scope, [:public], deep, skip)
+          result.concat inner_get_methods(dt.namespace, dt.scope, visibility, deep, skip)
         end
       end
       result

data/lib/solargraph/convention/rspec.rb

@@ -8,14 +8,23 @@ module Solargraph
         @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)
           pins: [
+            # 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)
             Solargraph::Pin::Reference::Override.method_return('RSpec::Matchers#expect', 'RSpec::Expectations::ExpectationTarget')
-          ]
+          ].concat(extras)
         )
       end
+
+      private
+
+      def extras
+        @@extras ||= SourceMap.load_string(%(
+          def describe(*args); end
+          def it(*args); end
+        )).pins
+      end
     end
   end
 end

data/lib/solargraph/language_server/uri_helpers.rb

@@ -14,7 +14,7 @@ module Solargraph
       # @param uri [String]
       # @return [String]
       def uri_to_file uri
-        decode(uri).sub(/^file\:\/\//, '').sub(/^\/([a-z]\:)/i, '\1')
+        decode(uri).sub(/^file\:(?:\/\/)?/, '').sub(/^\/([a-z]\:)/i, '\1')
       end
 
       # Convert a file path to a URI.

data/lib/solargraph/parser/legacy/class_methods.rb

@@ -48,10 +48,16 @@ module Solargraph
         end
 
         def references source, name
+          if name.end_with?("=")
+            reg = /#{Regexp.escape name[0..-2]}\s*=/
+            extract_offset = ->(code, offset) { reg.match(code, offset).offset(0) }
+          else
+            extract_offset = ->(code, offset) { [soff = code.index(name, offset), soff + name.length] }
+          end
           inner_node_references(name, source.node).map do |n|
-            offset = Position.to_offset(source.code, NodeMethods.get_node_start_position(n))
-            soff = source.code.index(name, offset)
-            eoff = soff + name.length
+            rng = Range.from_node(n)
+            offset = Position.to_offset(source.code, rng.start)
+            soff, eoff = extract_offset[source.code, offset]
             Location.new(
               source.filename,
               Range.new(
@@ -109,16 +115,11 @@ module Solargraph
           result = []
           if node.type == :str
             result.push Range.from_node(node)
-          elsif node.type == :dstr
-            here = Range.from_node(node)
-            there = Range.from_node(node.children[1])
-            result.push Range.new(here.start, there.start)
           end
           node.children.each do |child|
             result.concat string_ranges(child)
           end
           if node.type == :dstr && node.children.last.nil?
-            # result.push Range.new(result.last.ending, result.last.ending)
             last = node.children[-2]
             unless last.nil?
               rng = Range.from_node(last)

data/lib/solargraph/parser/legacy/node_processors/block_node.rb

@@ -8,17 +8,24 @@ module Solargraph
           include Legacy::NodeMethods
 
           def process
-            if other_class_eval?
-              other_class = Solargraph::Pin::Namespace.new(
+            location = get_node_location(node)
+            parent = if other_class_eval?
+              Solargraph::Pin::Namespace.new(
+                location: location,
                 type: :class,
                 name: unpack_name(node.children[0].children[0])
               )
-              make_block_in other_class.context
-              process_children region.update(closure: other_class)
             else
-              make_block_in nil
-              process_children region.update(closure: pins.last)
+              region.closure
             end
+            pins.push Solargraph::Pin::Block.new(
+              location: location,
+              closure: parent,
+              receiver: node.children[0],
+              comments: comments_for(node),
+              scope: region.scope || region.closure.context.scope
+            )
+            process_children region.update(closure: pins.last)
           end
 
           private
@@ -28,17 +35,6 @@ module Solargraph
               node.children[0].children[1] == :class_eval &&
               [:cbase, :const].include?(node.children[0].children[0]&.type)
           end
-
-          def make_block_in context
-            pins.push Solargraph::Pin::Block.new(
-              location: get_node_location(node),
-              context: context,
-              closure: region.closure,
-              receiver: node.children[0],
-              comments: comments_for(node),
-              scope: region.scope || region.closure.context.scope
-            )
-          end
         end
       end
     end

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

@@ -29,16 +29,6 @@ module Solargraph
           NodeProcessor.process(source.node, Region.new(source: source))
         end
 
-        # def returns_from node
-        #   return [] unless Parser.is_ast_node?(node)
-        #   if node.type == :SCOPE
-        #     # node.children.select { |n| n.is_a?(RubyVM::AbstractSyntaxTree::Node) }.map { |n| DeepInference.get_return_nodes(n) }.flatten
-        #     DeepInference.get_return_nodes(node.children[2])
-        #   else
-        #     DeepInference.get_return_nodes(node)
-        #   end
-        # end
-
         def references source, name
           if name.end_with?("=")
             reg = /#{Regexp.escape name[0..-2]}\s*=/
@@ -133,13 +123,12 @@ module Solargraph
           elsif node.type == :DSTR
             here = Range.from_node(node)
             there = Range.from_node(node.children[1])
-            result.push Range.new(here.start, there.start)
+            result.push Range.new(here.start, there&.start || here.ending)
           end
           node.children.each do |child|
             result.concat string_ranges(child)
           end
           if node.type == :DSTR && node.children.last.nil?
-            # result.push Range.new(result.last.ending, result.last.ending)
             last = node.children[-2]
             unless last.nil?
               rng = Range.from_node(last)

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

@@ -8,17 +8,24 @@ module Solargraph
           include NodeMethods
 
           def process
-            if other_class_eval?
-              other_class = Solargraph::Pin::Namespace.new(
+            location = get_node_location(node)
+            parent = if other_class_eval?
+              Solargraph::Pin::Namespace.new(
+                location: location,
                 type: :class,
                 name: unpack_name(node.children[0].children[0])
               )
-              make_block_in other_class.context
-              process_children region.update(closure: other_class)
             else
-              make_block_in nil
-              process_children region.update(closure: pins.last)
+              region.closure
             end
+            pins.push Solargraph::Pin::Block.new(
+              location: location,
+              closure: parent,
+              receiver: node.children[0],
+              comments: comments_for(node),
+              scope: region.scope || region.closure.context.scope
+            )
+            process_children region.update(closure: pins.last)
           end
 
           private
@@ -28,17 +35,6 @@ module Solargraph
               node.children[0].children[1] == :class_eval &&
               [:COLON2, :CONST].include?(node.children[0].children[0].type)
           end
-
-          def make_block_in context
-            pins.push Solargraph::Pin::Block.new(
-              location: get_node_location(node),
-              context: context,
-              closure: region.closure,
-              receiver: node.children[0],
-              comments: comments_for(node),
-              scope: region.scope || region.closure.context.scope
-            )
-          end
         end
       end
     end

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

@@ -45,6 +45,7 @@ module Solargraph
       register :IASGN,      Rubyvm::NodeProcessors::IvasgnNode
       register :CVASGN,     Rubyvm::NodeProcessors::CvasgnNode
       register :LASGN,      Rubyvm::NodeProcessors::LvasgnNode
+      register :DASGN,      Rubyvm::NodeProcessors::LvasgnNode
       register :DASGN_CURR, Rubyvm::NodeProcessors::LvasgnNode
       register :GASGN,      Rubyvm::NodeProcessors::GvasgnNode
       register :CDECL,      Rubyvm::NodeProcessors::CasgnNode

data/lib/solargraph/pin/local_variable.rb

@@ -41,7 +41,7 @@ module Solargraph
       end
 
       def match_named_closure needle, haystack
-        return true if needle == haystack
+        return true if needle == haystack || haystack.is_a?(Pin::Block)
         cursor = haystack
         until cursor.nil?
           return true if needle.path == cursor.path

data/lib/solargraph/pin/namespace.rb

@@ -9,8 +9,8 @@ module Solargraph
       # @return [::Symbol] :class or :module
       attr_reader :type
 
-      # @param type [Symbol] :class or :module
-      # @param visibility [Symbol] :public or :private
+      # @param type [::Symbol] :class or :module
+      # @param visibility [::Symbol] :public or :private
       # @param gates [Array<String>]
       def initialize type: :class, visibility: :public, gates: [''], **splat
         # super(location, namespace, name, comments)

data/lib/solargraph/pin/parameter.rb

@@ -145,10 +145,7 @@ module Solargraph
         # meths.shift # Ignore the first one
         meths.each do |meth|
           found = nil
-          params = meth.docstring.tags(:param)
-          if params.empty?
-            params = see_reference(docstring, api_map)
-          end
+          params = meth.docstring.tags(:param) + see_reference(docstring, api_map)
           params.each do |p|
             next unless p.name == name
             found = p

data/lib/solargraph/range.rb

@@ -69,7 +69,7 @@ module Solargraph
         if node.is_a?(RubyVM::AbstractSyntaxTree::Node)
           Solargraph::Range.from_to(node.first_lineno - 1, node.first_column, node.last_lineno - 1, node.last_column)
         end
-      elsif node.loc && node.loc.expression
+      elsif node&.loc && node.loc.expression
         from_expr(node.loc.expression)
       end
     end

data/lib/solargraph/source.rb

@@ -360,7 +360,7 @@ module Solargraph
       skip = nil
       comments.lines.each { |l|
         # Trim the comment and minimum leading whitespace
-        p = l.gsub(/^#+/, '')
+        p = l.encode('UTF-8', invalid: :replace, replace: '?').gsub(/^#+/, '')
         if p.strip.empty?
           next unless started
           ctxt.concat p

data/lib/solargraph/type_checker.rb

@@ -84,12 +84,13 @@ module Solargraph
     # @param pin [Pin::Method]
     # @return [Array<Problem>]
     def method_return_type_problems_for pin
+      return [] if pin.is_a?(Pin::MethodAlias)
       result = []
       declared = pin.typify(api_map).self_to(pin.full_context.namespace)
       if declared.undefined?
         if pin.return_type.undefined? && rules.require_type_tags?
           result.push Problem.new(pin.location, "Missing @return tag for #{pin.path}", pin: pin)
-        elsif pin.return_type.defined?
+        elsif pin.return_type.defined? && !resolved_constant?(pin)
           result.push Problem.new(pin.location, "Unresolved return type #{pin.return_type} for #{pin.path}", pin: pin)
         elsif rules.must_tag_or_infer? && pin.probe(api_map).undefined?
           result.push Problem.new(pin.location, "Untyped method #{pin.path} could not be inferred")
@@ -111,6 +112,15 @@ module Solargraph
       result
     end
 
+    # @todo This is not optimal. A better solution would probably be to mix
+    #   namespace alias into types at the ApiMap level.
+    #
+    # @param pin [Pin::Base]
+    # @return [Boolean]
+    def resolved_constant? pin
+      api_map.get_constants('', pin.binder.tag).any? { |pin| pin.name == pin.return_type.namespace && ['Class', 'Module'].include?(pin.return_type.name) }
+    end
+
     def virtual_pin? pin
       pin.location && source_map.source.comment_at?(pin.location.range.ending)
     end
@@ -402,6 +412,15 @@ module Solargraph
 
     # @param pin [Pin::Method]
     def arity_problems_for(pin, arguments, location)
+      ([pin] + pin.overloads).map do |p|
+        result = pin_arity_problems_for(p, arguments, location)
+        return [] if result.empty?
+        result
+      end.flatten.uniq(&:message)
+    end
+
+    # @param pin [Pin::Method]
+    def pin_arity_problems_for(pin, arguments, location)
       return [] unless pin.explicit?
       return [] if pin.parameters.empty? && arguments.empty?
       if pin.parameters.empty?

data/lib/solargraph/version.rb

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

data/lib/solargraph/yard_map/core_fills.rb

@@ -101,6 +101,7 @@ module Solargraph
         Override.method_return('File.dirname', 'String'),
         Override.method_return('File.extname', 'String'),
         Override.method_return('File.join', 'String'),
+        Override.method_return('File.open', 'File'),
 
         Override.from_comment('Float#+', %(
 @param y [Numeric]
@@ -110,14 +111,15 @@ module Solargraph
         Override.from_comment('Hash#[]', %(
 @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('Hash#merge', 'Hash'),
+        Override.from_comment('Hash#store', %{
+@overload store(key, value)
+        }),
 
         Override.from_comment('Integer#+', %(
 @param y [Numeric]
@@ -181,6 +183,9 @@ module Solargraph
       )
 
       PINS = [
+        # HACK: Extending Hash is not accurate to the implementation, but
+        # accurate enough to the behavior
+        Pin::Reference::Extend.new(closure: Pin::Namespace.new(name: 'ENV'), name: 'Hash'),
         Pin::Reference::Superclass.new(closure: Pin::Namespace.new(name: 'File'), name: 'IO'),
         Pin::Reference::Superclass.new(closure: Pin::Namespace.new(name: 'Integer'), name: 'Numeric'),
         Pin::Reference::Superclass.new(closure: Pin::Namespace.new(name: 'Float'), name: 'Numeric')

data/lib/solargraph/yard_map.rb

@@ -343,7 +343,9 @@ module Solargraph
     # @param path [String]
     # @return [Gem::Specification]
     def spec_for_require path
-      spec = Gem::Specification.find_by_path(path) || Gem::Specification.find_by_name(path.split('/').first)
+      name = path.split('/').first
+      spec = Gem::Specification.find_by_name(name, @gemset[name])
+
       # Avoid loading the spec again if it's going to be skipped anyway
       return spec if @source_gems.include?(spec.name)
       # Avoid loading the spec again if it's already the correct version

data/lib/solargraph.rb

@@ -59,8 +59,8 @@ module Solargraph
   #
   # @return [void]
   def self.with_clean_env &block
-    meth = if Bundler.respond_to?(:with_unbundled_env)
-      :with_unbundled_env
+    meth = if Bundler.respond_to?(:with_original_env)
+      :with_original_env
     else
       :with_clean_env
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solargraph
 version: !ruby/object:Gem::Version
-  version: 0.44.1
+  version: 0.45.0
 platform: ruby
 authors:
 - Fred Snyder
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-18 00:00:00.000000000 Z
+date: 2022-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: backport
@@ -301,6 +301,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/rspec.yml"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -572,7 +573,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: A Ruby language server