solargraph 0.47.2 → 0.50.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d35030ae56f6aaff108a24e4fb06713f911ba4366feb2223b24ad0ea4568522
-  data.tar.gz: a9eeaee16171bc762922ac55d10c61d53bcfe6ef1df0b20623c81e0978a80c7d
+  metadata.gz: 3a6e7990068e276537a53e6af24d45685d73aba32af134def16d8a66ea671f64
+  data.tar.gz: 57292437f34d43394a161fe4909eb27931d5d33e1b367276faecc7b0132525e9
 SHA512:
-  metadata.gz: 0b13ae6284def50f72c9aaed3cad6f89e879306dc8421b1c13f622e18181e6d9aaecf4f57ffa56601a00c92066557bb798d3e8ee6a397920ff0072f909e05463
-  data.tar.gz: 9a0366309ebe9a4a784c2933a8452e2084c376ff9aa3cd6c3bf555f4d6ce046f11245679c688bef43c6c1e67d94b70afb4250149c9b01b80fc525b80a80b6486
+  metadata.gz: 1d751b364593fa60cc51c3b9a67086c7a8006dcfe37107daaba4ca1db3f001da28eb289978d81fbe7e84c3a5c9add902417731479517be61269acd958456a057
+  data.tar.gz: 1c38faac70a696f81c5063d5ef64341a41a8d244c47c070ab557dbef8e4ca2180f5c22d5d0338c4b6f24598ea27850895bed2eab7c4d747b7bb2efeb71309eb2

data/.github/FUNDING.yml

@@ -0,0 +1 @@
+patreon: castwide

data/.github/workflows/rspec.yml

@@ -22,7 +22,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['2.4', '2.5', '2.6', '2.7', '3.0']
+        ruby-version: ['2.6', '2.7', '3.0', '3.1']
 
     steps:
     - uses: actions/checkout@v3

data/CHANGELOG.md

@@ -1,3 +1,43 @@
+## 0.50.0 - December 5, 2023
+- Remove .travis.yml as its not longer used (#627)
+- Fix empty string case when processing requires (#644)
+- Fix scope() method call on wrong object (#670)
+- Parse comments that start with multiple hashes (#667)
+- Use XDG_CACHE_HOME if it exists (#664)
+- Add rbs mention to readme (#693)
+- Remove Atom from the readme (#692)
+- Add more metadata to the gemspec (#691)
+- Do not deprecate clear command
+- Library#locate_ref returns nil for unresolved requires (#675)
+- Hide deprecated commands
+- List command
+- Fixes (or ignores) ffi crash (#676)
+- increase sleep time on cataloger (#677)
+- YardMap ignores absolute paths (#678)
+- Clarify macros vs. directives
+- Infer complex types from method calls
+- Default cache uses XDG_CACHE_HOME default (#664)
+
+## 0.49.0 - April 9, 2023
+- Better union type handling
+- First version of RBS support
+- Dependency updates
+- Update RuboCop config options
+- RBS core and stdlib mapping
+- Anonymous splats and multisig arity
+- Infinite loop when checking if a class is a superclass (#641)
+
+## 0.48.0 - December 19, 2022
+- Add Sublime Text to README (#604)
+- Map nested constant assignments
+- Handle rest/kwrest modifiers on overload arguments (#601)
+- Make rubocop info severity Severity::HINT (#576)
+- Process non-self singleton classes (#581)
+- Fix nest gemspec dependency (#599)
+- Strip 'file ' prefix from all filenames in RdocToYard (#585)
+- Show why rubocop fails (#605)
+- Link solargraph-rails (#611)
+
 ## 0.47.2 - September 30, 2022
 - Fix complex type inference (#578)
 - Off-by-one diagnostic (#595)

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2017-2019 by Fred Snyder for Castwide Technologies
+Copyright (c) 2017-2023 by Fred Snyder for Castwide Technologies
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -28,9 +28,10 @@ Plug-ins and extensions are available for the following editors:
     * Extension: https://marketplace.visualstudio.com/items?itemName=castwide.solargraph
     * GitHub: https://github.com/castwide/vscode-solargraph
 
-* **Atom**
-    * Package: https://atom.io/packages/ruby-solargraph
-    * GitHub: https://github.com/castwide/atom-solargraph
+* **Sublime Text**
+    * Extension: https://packagecontrol.io/packages/LSP
+    * GitHub: https://github.com/sublimelsp/LSP
+    * Instructions: https://lsp.sublimetext.io/language_servers/#solargraph
 
 * **Vim**
     * GitHub: `LanguageClient-neovim`, https://github.com/autozimu/LanguageClient-neovim
@@ -49,6 +50,9 @@ Plug-ins and extensions are available for the following editors:
 
 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.
 
+### Rails Support
+For better Rails support, please consider using [solargraph-rails](https://github.com/iftheshoefritz/solargraph-rails/)
+
 ### 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).
@@ -63,6 +67,8 @@ As of version 0.33.0, Solargraph includes a [type checker](https://github.com/ca
 
 ### Updating Core Documentation
 
+As of version 0.49.0, Solargraph uses [rbs](https://github.com/ruby/rbs) for core and stdlib documentation. The following only applies to prior versions.
+
 The Solargraph gem ships with documentation for Ruby 2.2.2. You can download documentation for other Ruby versions from the command line.
 
     $ solargraph list-cores      # List the installed documentation versions

data/SPONSORS.md

@@ -7,11 +7,11 @@ The following people and organizations provide funding or other resources. [Beco
 ## Linked Sponsors
 
 - **[Calyptix Security](https://www.calyptix.com/)**
+- **[Lightward](https://lightward.com)**
 
 ## Named Sponsors
 
-- Tom de Grunt
 - Akira Yamada
-- Erlend Finvåg
-- Matt Massicotte
-- Oscar Rivas
+- Jesus Castello
+- Joel Drapper
+- Spencer

data/lib/solargraph/api_map/store.rb

@@ -247,10 +247,22 @@ module Solargraph
           end
           ovr.tags.each do |tag|
             pin.docstring.add_tag(tag)
-            new_pin.docstring.add_tag(tag) if new_pin
+            redefine_return_type pin, tag
+            if new_pin
+              new_pin.docstring.add_tag(tag)
+              redefine_return_type new_pin, tag
+            end
           end
         end
       end
+
+      def redefine_return_type pin, tag
+        return unless pin && tag.tag_name == 'return'
+        pin.instance_variable_set(:@return_type, ComplexType.try_parse(tag.type))
+        pin.signatures.each do |sig|
+          sig.instance_variable_set(:@return_type, ComplexType.try_parse(tag.type))
+        end
+      end
     end
   end
 end

data/lib/solargraph/api_map.rb

@@ -21,6 +21,8 @@ module Solargraph
     # @return [Array<String>]
     attr_reader :unresolved_requires
 
+    @@core_map = RbsMap::CoreMap.new
+
     # @return [Array<String>]
     attr_reader :missing_docs
 
@@ -40,7 +42,7 @@ module Solargraph
       @source_map_hash = {}
       implicit.clear
       cache.clear
-      @store = Store.new(yard_map.pins + pins)
+      @store = Store.new(@@core_map.pins + pins)
       self
     end
 
@@ -68,8 +70,10 @@ module Solargraph
       end
       external_requires.merge implicit.requires
       external_requires.merge bench.workspace.config.required
-      yard_map.change(external_requires, bench.workspace.directory, bench.workspace.source_gems)
-      @store = Store.new(yard_map.pins + implicit.pins + pins)
+      @rbs_maps = external_requires.map { |r| load_rbs_map(r) }
+      unresolved_requires = @rbs_maps.reject(&:resolved?).map(&:library)
+      yard_map.change(unresolved_requires, bench.workspace.directory, bench.workspace.source_gems)
+      @store = Store.new(@@core_map.pins + @rbs_maps.flat_map(&:pins) + yard_map.pins + implicit.pins + pins)
       @unresolved_requires = yard_map.unresolved_requires
       @missing_docs = yard_map.missing_docs
       @rebindable_method_names = nil
@@ -77,6 +81,14 @@ module Solargraph
       self
     end
 
+    def core_pins
+      @@core_map.pins
+    end
+
+    def yard_map
+      @yard_map ||= YardMap.new
+    end
+
     # @param name [String]
     # @return [YARD::Tags::MacroDirective, nil]
     def named_macro name
@@ -132,7 +144,8 @@ module Solargraph
 
     def rebindable_method_names
       @rebindable_method_names ||= begin
-        result = yard_map.rebindable_method_names
+        # result = yard_map.rebindable_method_names
+        result = ['instance_eval', 'instance_exec', 'class_eval', 'class_exec', 'module_eval', 'module_exec', 'define_method'].to_set
         source_maps.each do |map|
           result.merge map.rebindable_method_names
         end
@@ -191,7 +204,7 @@ module Solargraph
     #
     # @param namespace [String, nil] The namespace to match
     # @param context [String] The context to search
-    # @return [String]
+    # @return [String, nil]
     def qualify namespace, context = ''
       return namespace if ['self', nil].include?(namespace)
       cached = cache.get_qualified_namespace(namespace, context)
@@ -447,18 +460,15 @@ module Solargraph
     def super_and_sub?(sup, sub)
       fqsup = qualify(sup)
       cls = qualify(sub)
-      until fqsup.nil? || cls.nil?
+      tested = []
+      until fqsup.nil? || cls.nil? || tested.include?(cls)
         return true if cls == fqsup
+        tested.push cls
         cls = qualify_superclass(cls)
       end
       false
     end
 
-    # @return [YardMap]
-    def yard_map
-      @yard_map ||= YardMap.new
-    end
-
     # Check if the host class includes the specified module.
     #
     # @param host [String] The class
@@ -475,6 +485,14 @@ module Solargraph
     # @return [Hash{String => SourceMap}]
     attr_reader :source_map_hash
 
+    # @param library [String]
+    # @return [RbsMap]
+    def load_rbs_map library
+      # map = RbsMap.load(library)
+      # return map if map.resolved?
+      RbsMap::StdlibMap.load(library)
+    end
+
     # @return [ApiMap::Store]
     def store
       @store ||= Store.new
@@ -677,7 +695,7 @@ module Solargraph
         comments: origin.comments,
         scope: origin.scope,
         visibility: origin.visibility,
-        parameters: origin.parameters,
+        signatures: origin.signatures,
         attribute: origin.attribute?
       }
       Pin::Method.new **args

data/lib/solargraph/cache.rb

@@ -0,0 +1,53 @@
+require 'fileutils'
+
+module Solargraph
+  module Cache
+    class << self
+      # The base directory where cached documentation is installed.
+      #
+      # @return [String]
+      def base_dir
+        # The directory is not stored in a variable so it can be overridden
+        # in specs.
+        ENV['SOLARGRAPH_CACHE'] ||
+          ENV['XDG_CACHE_HOME'] ? File.join(ENV['XDG_CACHE_HOME'], 'solargraph') :
+          File.join(Dir.home, '.cache', 'solargraph')
+      end
+
+      # The working directory for the current Ruby and Solargraph versions.
+      #
+      # @return [String]
+      def work_dir
+        # The directory is not stored in a variable so it can be overridden
+        # in specs.
+        File.join(base_dir, "ruby-#{RUBY_VERSION}", "rbs-#{RBS::VERSION}", "solargraph-#{Solargraph::VERSION}")
+      end
+
+      # @return [Array<Solargraph::Pin::Base>, nil]
+      def load *path
+        file = File.join(work_dir, *path)
+        return nil unless File.file?(file)
+        Marshal.load(File.read(file, mode: 'rb'))
+      rescue StandardError => e
+        Solargraph.logger.warn "Failed to load cached file #{file}: [#{e.class}] #{e.message}"
+        FileUtils.rm_f file
+        nil
+      end
+
+      # @return [Boolean]
+      def save *path, pins
+        return false if pins.empty?
+        file = File.join(work_dir, *path)
+        base = File.dirname(file)
+        FileUtils.mkdir_p base unless File.directory?(base)
+        ser = Marshal.dump(pins)
+        File.write file, ser, mode: 'wb'
+        true
+      end
+
+      def clear
+        FileUtils.rm_rf base_dir, secure: true
+      end
+    end
+  end
+end

data/lib/solargraph/complex_type/type_methods.rb

@@ -101,6 +101,7 @@ module Solargraph
       # @param context [String] The namespace from which to resolve names
       # @return [ComplexType] The generated ComplexType
       def qualify api_map, context = ''
+        return self if name == 'param'
         return ComplexType.new([self]) if duck_type? || void? || undefined?
         recon = (rooted? ? '' : context)
         fqns = api_map.qualify(name, recon)
@@ -109,12 +110,8 @@ module Solargraph
           return UniqueType::UNDEFINED
         end
         fqns = "::#{fqns}" # Ensure the resulting complex type is rooted
-        ltypes = key_types.map do |t|
-          t.qualify api_map, context
-        end
-        rtypes = value_types.map do |t|
-          t.qualify api_map, context
-        end
+        ltypes = key_types.map { |t| t.qualify api_map, context }.uniq
+        rtypes = value_types.map { |t| t.qualify api_map, context }.uniq
         if list_parameters?
           Solargraph::ComplexType.parse("#{fqns}<#{rtypes.map(&:tag).join(', ')}>")
         elsif fixed_parameters?
@@ -125,6 +122,13 @@ module Solargraph
           Solargraph::ComplexType.parse(fqns)
         end
       end
+
+      # @yieldparam [UniqueType]
+      # @return [Enumerator<UniqueType>]
+      def each_unique_type &block
+        return enum_for(__method__) unless block_given?
+        yield self
+      end
     end
   end
 end

data/lib/solargraph/complex_type/unique_type.rb

@@ -8,6 +8,8 @@ module Solargraph
     class UniqueType
       include TypeMethods
 
+      attr_reader :all_params
+
       # Create a UniqueType with the specified name and an optional substring.
       # The substring is the parameter section of a parametrized type, e.g.,
       # for the type `Array<String>`, the name is `Array` and the substring is
@@ -27,6 +29,7 @@ module Solargraph
         @tag = @name + substring
         @key_types = []
         @subtypes = []
+        @all_params = []
         return unless parameters?
         if @substring.start_with?('<(') && @substring.end_with?(')>')
           subs = ComplexType.parse(substring[2..-3], partial: true)
@@ -40,12 +43,66 @@ module Solargraph
         else
           @subtypes.concat subs
         end
+        @all_params.concat @key_types
+        @all_params.concat @subtypes
       end
 
       def to_s
         tag
       end
 
+      def to_rbs
+        "#{namespace}#{parameters? ? "[#{subtypes.map { |s| s.to_rbs }.join(', ')}]" : ''}"
+      end
+  
+      def parameterized?
+        name == 'param' || all_params.any?(&:parameterized?)
+      end
+
+      def resolve_parameters definitions, context
+        new_name = if name == 'param'
+          idx = definitions.parameters.index(subtypes.first.name)
+          return ComplexType::UNDEFINED if idx.nil?
+          param_type = context.return_type.all_params[idx]
+          return ComplexType::UNDEFINED unless param_type
+          param_type.to_s
+        else
+          name
+        end
+        new_key_types = if name != 'param'
+          @key_types.map { |t| t.resolve_parameters(definitions, context) }.select(&:defined?)
+        else
+          []
+        end
+        new_subtypes = if name != 'param'
+          @subtypes.map { |t| t.resolve_parameters(definitions, context) }.select(&:defined?)
+        else
+          []
+        end
+        if name != 'param' && !(new_key_types.empty? && new_subtypes.empty?)
+          if hash_parameters?
+            UniqueType.new(new_name, "{#{new_key_types.join(', ')} => #{new_subtypes.join(', ')}}")
+          elsif parameters?
+            if @substring.start_with?'<('
+              UniqueType.new(new_name, "<(#{new_subtypes.join(', ')})>")
+            else
+              UniqueType.new(new_name, "<#{new_subtypes.join(', ')}>")
+            end
+          else
+            UniqueType.new(new_name)
+          end
+        else
+          UniqueType.new(new_name)
+        end
+
+        # idx = definitions.parameters.index(subtypes.first.name)
+        # STDERR.puts "Index: #{idx}"
+        # return ComplexType::UNDEFINED if idx.nil?
+        # param_type = context.return_type.all_params[idx]
+        # return ComplexType::UNDEFINED unless param_type
+        # ComplexType.try_parse(param_type.to_s)
+      end
+
       def self_to dst
         return self unless selfy?
         new_name = (@name == 'self' ? dst : @name)

data/lib/solargraph/complex_type.rb

@@ -30,6 +30,12 @@ module Solargraph
       @items.first
     end
 
+    def to_rbs
+      ((@items.length > 1 ? '(' : '') + @items.map do |item|
+        "#{item.namespace}#{item.parameters? ? "[#{item.subtypes.map { |s| s.to_rbs }.join(', ')}]" : ''}"
+      end.join(' | ') + (@items.length > 1 ? ')' : '')).gsub(/undefined/, 'untyped')
+    end
+
     def map &block
       @items.map &block
     end
@@ -40,6 +46,16 @@ module Solargraph
       @items.each &block
     end
 
+    # @yieldparam [UniqueType]
+    # @return [Enumerator<UniqueType>]
+    def each_unique_type &block
+      return enum_for(__method__) unless block_given?
+
+      @items.each do |item|
+        item.each_unique_type &block
+      end
+    end
+
     def length
       @items.length
     end
@@ -75,26 +91,39 @@ module Solargraph
     end
 
     def any? &block
-      @items.any? &block
+      @items.compact.any? &block
     end
 
     def selfy?
       @items.any?(&:selfy?)
     end
 
+    def parameterized?
+      any?(&:parameterized?)
+    end
+
+    def resolve_parameters definitions, context
+      result = @items.map { |i| i.resolve_parameters(definitions, context) }
+      ComplexType.parse(*result.map(&:tag))
+    end
+
     # @param dst [String]
     # @return [ComplexType]
     def self_to dst
       return self unless selfy?
       red = reduce_class(dst)
       result = @items.map { |i| i.self_to red }
-      ComplexType.parse(*result.map(&:tag))
+      ComplexType.parse(*result.map(&:to_s))
     end
 
     def nullable?
       @items.any?(&:nil_type?)
     end
 
+    def all_params
+      @items.first.all_params || []
+    end
+
     private
 
     # @todo This is a quick and dirty hack that forces `self` keywords
@@ -140,7 +169,7 @@ module Solargraph
           paren_stack = 0
           base = String.new
           subtype_string = String.new
-          type_string.each_char do |char|
+          type_string&.each_char do |char|
             if char == '='
               #raise ComplexTypeError, "Invalid = in type #{type_string}" unless curly_stack > 0
             elsif char == '<'

data/lib/solargraph/convention/rakefile.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Solargraph
+  module Convention
+    class Rakefile < Base
+      def local source_map
+        basename = File.basename(source_map.filename)
+        return EMPTY_ENVIRON unless basename.end_with?('.rake') || basename == 'Rakefile'
+
+        @environ ||= Environ.new(
+          requires: ['rake'],
+          domains: ['Rake::DSL']
+        )
+      end
+    end
+  end
+end

data/lib/solargraph/convention.rb

@@ -11,6 +11,7 @@ module Solargraph
     autoload :Gemfile, 'solargraph/convention/gemfile'
     autoload :Rspec,   'solargraph/convention/rspec'
     autoload :Gemspec, 'solargraph/convention/gemspec'
+    autoload :Rakefile, 'solargraph/convention/rakefile'
 
     @@conventions = Set.new
 
@@ -43,5 +44,6 @@ module Solargraph
     register Gemfile
     register Gemspec
     register Rspec
+    register Rakefile
   end
 end

data/lib/solargraph/diagnostics/rubocop.rb

@@ -11,6 +11,7 @@ module Solargraph
 
       # Conversion of RuboCop severity names to LSP constants
       SEVERITIES = {
+        'info' => Severities::HINT,
         'refactor' => Severities::HINT,
         'convention' => Severities::INFORMATION,
         'warning' => Severities::WARNING,
@@ -22,16 +23,20 @@ module Solargraph
       # @param _api_map [Solargraph::ApiMap]
       # @return [Array<Hash>]
       def diagnose source, _api_map
+        @source = source
         require_rubocop(rubocop_version)
         options, paths = generate_options(source.filename, source.code)
         store = RuboCop::ConfigStore.new
         runner = RuboCop::Runner.new(options, store)
         result = redirect_stdout{ runner.run(paths) }
+        
+        return [] if result.empty?
+        
         make_array JSON.parse(result)
       rescue RuboCop::ValidationError, RuboCop::ConfigNotFoundError => e
         raise DiagnosticsError, "Error in RuboCop configuration: #{e.message}"
-      rescue JSON::ParserError
-        raise DiagnosticsError, 'RuboCop returned invalid data'
+      rescue JSON::ParserError => e
+        raise DiagnosticsError, "RuboCop returned invalid data: #{e.message}"
       end
 
       private
@@ -88,8 +93,17 @@ module Solargraph
         if off['location']['start_line'] != off['location']['last_line']
           Position.new(off['location']['start_line'], 0)
         else
+          start_line = off['location']['start_line'] - 1
+          last_column = off['location']['last_column']
+          line = @source.code.lines[start_line]
+          col_off = if line.nil? || line.empty?
+            1
+          else
+            0
+          end
+
           Position.new(
-            off['location']['start_line'] - 1, off['location']['last_column'] - 1
+            start_line, last_column - col_off
           )
         end
       end

data/lib/solargraph/diagnostics/rubocop_helpers.rb

@@ -10,13 +10,15 @@ module Solargraph
       # Requires a specific version of rubocop, or the latest installed version
       # if _version_ is `nil`.
       #
-      # @param version [String]
+      # @param version [String, nil]
       # @raise [InvalidRubocopVersionError] if _version_ is not installed
       def require_rubocop(version = nil)
         begin
           gem_path = Gem::Specification.find_by_name('rubocop', version).full_gem_path
           gem_lib_path = File.join(gem_path, 'lib')
           $LOAD_PATH.unshift(gem_lib_path) unless $LOAD_PATH.include?(gem_lib_path)
+        # @todo Gem::MissingSpecVersionError is undocumented for some reason
+        # @sg-ignore
         rescue Gem::MissingSpecVersionError => e
           raise InvalidRubocopVersionError,
                 "could not find '#{e.name}' (#{e.requirement}) - "\

data/lib/solargraph/language_server/host/cataloger.rb

@@ -34,7 +34,7 @@ module Solargraph
           Thread.new do
             until stopped?
               tick
-              sleep 0.01
+              sleep 0.1
             end
           end
         end