solargraph 0.51.2 → 0.53.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c031e57a0f9eb482a517ed584966ecfff9fd431aaee66d6c97d624393b56fb99
-  data.tar.gz: d6cc56999dc9da2073584a54f5b2ed045e24e573c84408359a9c7f94f8bd8571
+  metadata.gz: ea6f4539a04d35b759acc75c97b4af772a34877adf8dba07e0a9a109a75cb545
+  data.tar.gz: 3e6945e906e693884a19e3fb2504cf8508cdb9784fa015b27dd455fb2e4ddba7
 SHA512:
-  metadata.gz: aa5be8998891287e3a92429f2317c3bc64235d71977476248cbf3ba1167842b2e65c666b7f1bb49254bcc9c1ad67b2f4ea7f4cd1c50ef3c16723bdbd5286049a
-  data.tar.gz: 30b453fc424796b8b776d2c79b014d19645dd2f091fb6cb6822a6f373e1df719809d845bef66fc3146c821c42a7268f60ff65e034a93f5d51708e5a0028f7fb1
+  metadata.gz: 561c956490d3231c79cd89163c162364793baca6c1a86c0dddb3b4896b965d08e4e86e4a4766a297c7d71b5f1573336d3d9c99aa271d7fa9fbde3061a8b7d338
+  data.tar.gz: 683c8d6df19fbc1abcbc1420a4f78157d032ca91a1bbec9c2b77b3a429a88d6f2f754d0b1def057a807f90ea6e026ee11725eb22290c286e0019bc0aaba13d07

data/.github/workflows/plugins.yml

@@ -0,0 +1,40 @@
+name: Plugin Backwards Compatibility Tests
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: '3.0'
+        bundler-cache: false
+    - uses: awalsh128/cache-apt-pkgs-action@latest
+      with:
+        packages: yq
+        version: 1.0
+    - name: Install gems
+      run: |
+        echo 'gem "solargraph-rails"' > .Gemfile
+        echo 'gem "solargraph-rspec"' >> .Gemfile
+        bundle install
+    - name: Configure to use plugins
+      run: |
+        bundle exec solargraph config
+        yq -yi '.plugins += ["solargraph-rails"]' .solargraph.yml
+        yq -yi '.plugins += ["solargraph-rspec"]' .solargraph.yml
+    - name: Ensure typechecking still works
+      run: bundle exec solargraph typecheck --level typed
+    - name: Ensure specs still run
+      run: bundle exec rake spec

data/.github/workflows/rspec.yml

@@ -22,7 +22,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['2.6', '2.7', '3.0', '3.1', '3.2', '3.3', '3.4', 'head']
+        ruby-version: ['3.0', '3.1', '3.2', '3.3', '3.4', 'head']
 
     steps:
     - uses: actions/checkout@v3
@@ -33,7 +33,5 @@ jobs:
         bundler-cache: false
     - name: Install gems
       run: bundle install
-    - name: Set up yardocs
-      run: bundle exec yard gems
     - name: Run tests
       run: bundle exec rspec

data/.github/workflows/typecheck.yml

@@ -0,0 +1,34 @@
+# 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: Typecheck
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.4
+        bundler-cache: false
+    - name: Install gems
+      run: bundle install
+    - name: Typecheck self
+      run: bundle exec solargraph typecheck --level typed

data/.yardopts

@@ -1,2 +1,2 @@
-lib/**/*.rb
--e lib/yard-solargraph.rb
+lib/**/*.rb
+--plugin yard-solargraph

data/CHANGELOG.md

@@ -1,3 +1,53 @@
+## 0.53.0 - March 25, 2025
+- Fix crash on generic methods (#762)
+- Add more type annotations to the codebase (#763 et al.)
+- Address remaining typecheck issues at 'typed' level and add CI task (#764)
+- Fix crash during strict typechecking (#766)
+- DeepInference: Fix some bugs, add docs, refactor (#767)
+- Include "self type" methods like Enumerable#each from RBS files (#769)
+- Handle RBS global, module alias, class variable and class instance variable declarations (#770)
+- Add support for generic includes via RBS (#773)
+- Handle parsing tuples of tuples in tags (#775)
+- Retire the RubyVM parser (#776)
+- Improve block handling in signature selection (#780)
+- Require Ruby >= 3 (#791)
+- Cache YARD and RBS (#781)
+  - Language server generates gem documentation in the background
+- Fix bug handling Array(A, B) syntax while resolving generics (#784)
+- Fix typeDefinitions for neovim (#792)
+- Infer block-pass symbols (#793)
+- Add #to_rbs methods to pins, use for better .inspect() output (#789)
+- Remove deprecated commands (#790)
+- Add :if support to NodeChainer for if statements as lvalues (#805)
+- Fix ApiMap::Cache (#806)
+- Map mixins from RBS (#808)
+- Fix issue with wrong signature selection by call with block node (#815)
+- Keep gem pins in memory (#811)
+- Refactor gems command (#816)
+- Use return type of literal blocks in inference (#818)
+- Insert Module methods (#820)
+- Revise documentation formatting (#823)
+
+## 0.52.0 - February 28, 2025
+- Chains resolve identical names with different contexts (#679)
+- Handle symbol tags in method tag values (#744)
+- Infer more specific Array types when possible (#745)
+- Handle interpolated symbol literals (#747)
+- Handle combined conditions, else clauses in case statements (#746)
+- fix: support find require xxx.rb in local workspace. (#722)
+- Don't require redundant attribute @return and @param tags (#748)
+- Use @yieldreturn tags for type inference (#749)
+- Fix type annotations identified at 'typed' level (#750)
+- Support RBS class aliases (#751)
+- Better support for generics via Class @param tags (#743)
+- Generic module support through RBS (#757)
+- Fix inference of begin expression types (#754)
+- Add argument to satisfy typechecker on which signature to use (#755)
+- Fix RBS ingestion implicit initializer issues, missing param types (#756)
+- Validate zsuper arity
+- Use yard-solargraph plugin (#759)
+- Add missing RBS types
+
 ## 0.51.2 - February 1, 2025
 - Fix exception from parser when anonymous block forwarding is used (#740)
 - Parameterized Object types
@@ -5,10 +55,10 @@
 
 ## 0.51.1 - January 23, 2025
 - Format example code
-- Block infers yieldself from chain
+- Block infers yieldreceiver from chain
 
 ## 0.51.0 - January 19, 2025
-- Resolve self in yieldself tags
+- Resolve self in yieldreceiver tags
 - Include absolute paths in config (#674)
 - Enable diagnostics by default
 - Fix cache resolution (#704)
@@ -597,7 +647,7 @@
 ## 0.31.2 - January 27, 2019
 - Use YARD documentation rules to associate directives with namespaces
 - Handle non-unique pin locations in completionItem/resolve
-- Clip#complete handles @yieldself and @yieldpublic contexts
+- Clip#complete handles @yieldreceiver and @yieldpublic contexts
 - Host::Dispatch filters library updates (castwide/vscode-solargraph#99)
 - Qualify included namespaces (#148)
 
@@ -953,7 +1003,7 @@
 
 ## 0.17.0 - February 1, 2018
 - Support Solargraph configurations in workspace folders.
-- Use @yieldself tag to change block contexts.
+- Use @yieldreceiver tag to change block contexts.
 - Handle whitespace in signatures.
 - Convert 'self' when inferring signature types.
 - Handle bare periods without signatures.
@@ -996,7 +1046,7 @@
 - Map pins to code objects.
 - Infer return types from domain (DSL) methods.
 - Fixed visibility and results for superclasses.
-- Experimental @yieldself tag.
+- Experimental @yieldreceiver tag.
 - Improved syntax error handling in Source.fix.
 - Gem ships with Ruby 2.2.2 yardocs.
 - Experimental plugin architecture and Runtime plugin.

data/README.md

@@ -34,6 +34,7 @@ Plug-ins and extensions are available for the following editors:
     * Instructions: https://lsp.sublimetext.io/language_servers/#solargraph
 
 * **Vim**
+    * Github: `nvim-lspconfig`, https://github.com/neovim/nvim-lspconfig/blob/master/doc/configs.md#solargraph
     * 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
@@ -50,12 +51,19 @@ 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
+### Plugins
+
+Solargraph supports [plugins](https://solargraph.org/guides/plugins) that implements their own Solargraph features, such as diagnostics reporters and conventions to provide LSP features and type-checking, e.g. for frameworks which use metaprogramming and/or DSLs.
+
 For better Rails support, please consider using [solargraph-rails](https://github.com/iftheshoefritz/solargraph-rails/)
 
+The RSpec framework is supported via [solargraph-rspec](https://github.com/lekemula/solargraph-rspec/)
+
 ### 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).
+**Note: Before version 0.53.0, it was recommended to run `yard gems` periodically or automate it with `yard config` to ensure that Solargraph had access to gem documentation. These steps are no longer necessary. Solargraph maintains its own gem documentation cache independent of the yardocs in your gem installations.**
+
+Solargraph automatically generates code maps from installed gems. You can also manage your cached gem documentation with the `solargraph gems` command.
 
 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.
 
@@ -65,22 +73,11 @@ If your project automatically requires bundled gems (e.g., `require 'bundler/req
 
 As of version 0.33.0, Solargraph includes a [type checker](https://github.com/castwide/solargraph/issues/192) that uses a combination of YARD tags and code analysis to report missing type definitions. In strict mode, it performs type inference to determine whether the tags match the types it detects from code.
 
-### 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
-    $ solargraph available-cores # List the versions available for download
-    $ 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.
+Solargraph uses a cache directory to store documentation for the Ruby core and gems. The default location is `~/.cache/solargraph`, e.g., `/home/<username>/.cache/solargraph` on Linux or `C:\Users\<username>\.cache\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.
+You can change the location of the cache directory with the `SOLARGRAPH_CACHE` environment variable.
 
 ### Solargraph and Bundler
 
@@ -90,7 +87,7 @@ In the Gemfile:
 
     gem 'solargraph', group: :development
 
-Run `bundle install` and use `bundle exec yard gems` to generate the documentation. This process documents cached or vendored gems, or even gems that are installed from a local path.
+Run `bundle install` and optionally use `bundle exec solargraph gems` to generate the documentation. This process documents cached or vendored gems, or even gems that are installed from a local path.
 
 In order to make sure you're using the correct dependencies, you can start the language server with Bundler. In VS Code, there's a `solargraph.useBundler` option. Other clients will vary, but the command you probably want to run is `bundle exec solargraph socket` or `bundle exec solargraph stdio`.
 

data/SPONSORS.md

@@ -4,13 +4,7 @@ Solargraph is developed and maintained by [Castwide Technologies](https://castwi
 
 The following people and organizations provide funding or other resources. [Become a sponsor](https://patreon.com/castwide)
 
-## Linked Sponsors
-
-- **[Calyptix Security](https://www.calyptix.com/)**
-
 ## Named Sponsors
 
-- Akira Yamada
-- Joel Drapper
-- Spencer
+- Juan Carlos
 - Vince Broz

data/lib/solargraph/api_map/cache.rb

@@ -4,66 +4,106 @@ module Solargraph
   class ApiMap
     class Cache
       def initialize
+        # @type [Hash{Array => Array<Pin::Method>}]
         @methods = {}
+        # @type [Hash{(String, Array<String>) => Array<Pin::Base>}]
         @constants = {}
+        # @type [Hash{(String, String) => String}]
         @qualified_namespaces = {}
+        # @type [Hash{String => Pin::Method}]
         @receiver_definitions = {}
+        # @type [Hash{String => SourceMap::Clip}]
+        @clips = {}
       end
 
+      # @param fqns [String]
+      # @param scope [Symbol]
+      # @param visibility [Array<Symbol>]
+      # @param deep [Boolean]
       # @return [Array<Pin::Method>]
       def get_methods fqns, scope, visibility, deep
-        @methods[[fqns, scope, visibility.sort, deep]]
+        @methods["#{fqns}|#{scope}|#{visibility}|#{deep}"]
       end
 
+      # @param fqns [String]
+      # @param scope [Symbol]
+      # @param visibility [Array<Symbol>]
+      # @param deep [Boolean]
+      # @param value [Array<Pin::Method>]
+      # @return [void]
       def set_methods fqns, scope, visibility, deep, value
-        @methods[[fqns, scope, visibility.sort, deep]] = value
+        @methods["#{fqns}|#{scope}|#{visibility}|#{deep}"] = value
       end
 
+      # @param namespace [String]
+      # @param contexts [Array<String>]
       # @return [Array<Pin::Base>]
-      def get_constants namespace, context
-        @constants[[namespace, context]]
+      def get_constants namespace, contexts
+        @constants["#{namespace}|#{contexts}"]
       end
 
-      def set_constants namespace, context, value
-        @constants[[namespace, context]] = value
+      # @param namespace [String]
+      # @param contexts [Array<String>]
+      # @param value [Array<Pin::Base>]
+      # @return [void]
+      def set_constants namespace, contexts, value
+        @constants["#{namespace}|#{contexts}"] = value
       end
 
+      # @param name [String]
+      # @param context [String]
       # @return [String]
       def get_qualified_namespace name, context
-        @qualified_namespaces[[name, context]]
+        @qualified_namespaces["#{name}|#{context}"]
       end
 
+      # @param name [String]
+      # @param context [String]
+      # @param value [String]
+      # @return [void]
       def set_qualified_namespace name, context, value
-        @qualified_namespaces[[name, context]] = value
-      end
-
-      def receiver_defined? path
-        @receiver_definitions.key? path
+        @qualified_namespaces["#{name}|#{context}"] = value
       end
 
+      # @param path [String]
       # @return [Pin::Method]
       def get_receiver_definition path
         @receiver_definitions[path]
       end
 
+      # @param path [String]
+      # @param pin [Pin::Method]
+      # @return [void]
       def set_receiver_definition path, pin
         @receiver_definitions[path] = pin
       end
 
+      # @param cursor [Source::Cursor]
+      # @return [SourceMap::Clip, nil]
+      def get_clip(cursor)
+        @clips["#{cursor.filename}|#{cursor.range.inspect}|#{cursor.node&.to_sexp}"]
+      end
+
+      # @param cursor [Source::Cursor]
+      # @param clip [SourceMap::Clip]
+      def set_clip(cursor, clip)
+        @clips["#{cursor.filename}|#{cursor.range.inspect}|#{cursor.node&.to_sexp}"] = clip
+      end
+
       # @return [void]
       def clear
-        @methods.clear
-        @constants.clear
-        @qualified_namespaces.clear
-        @receiver_definitions.clear
+        all_caches.each(&:clear)
       end
 
       # @return [Boolean]
       def empty?
-        @methods.empty? &&
-          @constants.empty? &&
-          @qualified_namespaces.empty? &&
-          @receiver_definitions.empty?
+        all_caches.all?(&:empty?)
+      end
+
+      private
+
+      def all_caches
+        [@methods, @constants, @qualified_namespaces, @receiver_definitions, @clips]
       end
     end
   end

data/lib/solargraph/api_map/store.rb

@@ -1,11 +1,10 @@
 # frozen_string_literal: true
 
-require 'set'
 
 module Solargraph
   class ApiMap
     class Store
-      # @return [Enumerable<Solargraph::Pin::Base>]
+      # @return [Array<Solargraph::Pin::Base>]
       attr_reader :pins
 
       # @param pins [Enumerable<Solargraph::Pin::Base>]
@@ -26,7 +25,7 @@ module Solargraph
       # @param fqns [String]
       # @param scope [Symbol]
       # @param visibility [Array<Symbol>]
-      # @return [Enumerable<Solargraph::Pin::Base>]
+      # @return [Enumerable<Solargraph::Pin::Method>]
       def get_methods fqns, scope: :instance, visibility: [:public]
         namespace_children(fqns).select do |pin|
           pin.is_a?(Pin::Method) && pin.scope == scope && visibility.include?(pin.visibility)
@@ -61,7 +60,7 @@ module Solargraph
       end
 
       # @param path [String]
-      # @return [Enumerable<Solargraph::Pin::Base>]
+      # @return [Array<Solargraph::Pin::Base>]
       def get_path_pins path
         path_pin_hash[path] || []
       end
@@ -117,7 +116,7 @@ module Solargraph
         result
       end
 
-      # @return [Hash]
+      # @return [Hash{String => YARD::Tags::MacroDirective}]
       def named_macros
         @named_macros ||= begin
           result = {}
@@ -144,11 +143,11 @@ module Solargraph
       # @param klass [Class]
       # @return [Enumerable<Solargraph::Pin::Base>]
       def pins_by_class klass
-        @pin_select_cache[klass] ||= @pin_class_hash.each_with_object(Set.new) { |(key, o), n| n.merge(o) if key <= klass }
+        # @type [Set<Solargraph::Pin::Base>]
+        s = Set.new
+        @pin_select_cache[klass] ||= @pin_class_hash.each_with_object(s) { |(key, o), n| n.merge(o) if key <= klass }
       end
 
-      private
-
       # @param fqns [String]
       # @return [Array<Solargraph::Pin::Namespace>]
       def fqns_pins fqns
@@ -164,6 +163,9 @@ module Solargraph
         fqns_pins_map[[base, name]]
       end
 
+      private
+
+      # @return [Hash{Array(String, String) => Array<Pin::Namespace>}]
       def fqns_pins_map
         @fqns_pins_map ||= Hash.new do |h, (base, name)|
           value = namespace_children(base).select { |pin| pin.name == name && pin.is_a?(Pin::Namespace) }
@@ -176,18 +178,22 @@ module Solargraph
         pins_by_class(Pin::Symbol)
       end
 
+      # @return [Hash{String => Enumerable<String>}]
       def superclass_references
         @superclass_references ||= {}
       end
 
+      # @return [Hash{String => Array<String>}]
       def include_references
         @include_references ||= {}
       end
 
+      # @return [Hash{String => Array<String>}]
       def prepend_references
         @prepend_references ||= {}
       end
 
+      # @return [Hash{String => Array<String>}]
       def extend_references
         @extend_references ||= {}
       end
@@ -198,31 +204,58 @@ module Solargraph
         namespace_map[name] || []
       end
 
-      # @return [Hash]
+      # @return [Hash{String => Enumerable<Pin::Base>}
       def namespace_map
         @namespace_map ||= {}
       end
 
+      # @return [Enumerable<Pin::InstanceVariable>]
       def all_instance_variables
         pins_by_class(Pin::InstanceVariable)
       end
 
+      # @return [Hash{String => Array<Pin::Base>}]
       def path_pin_hash
         @path_pin_hash ||= {}
       end
 
+      # Add references to a map
+      #
+      # @param h [Hash{String => Pin:Base}]
+      # @param reference_pin [Pin::Reference]
+      #
+      # @return [void]
+      def store_parametric_reference(h, reference_pin)
+        referenced_ns = reference_pin.name
+        referenced_tag_params = reference_pin.generic_values
+        referenced_tag = referenced_ns +
+                         if referenced_tag_params && referenced_tag_params.length > 0
+                           "<" + referenced_tag_params.join(', ') + ">"
+                         else
+                           ''
+                         end
+        referencing_ns = reference_pin.namespace
+        h[referencing_ns] ||= []
+        h[referencing_ns].push referenced_tag
+      end
+
       # @return [void]
       def index
         set = pins.to_set
         @pin_class_hash = set.classify(&:class).transform_values(&:to_a)
+        # @type [Hash{Class => Enumerable<Solargraph::Pin::Base>}]
         @pin_select_cache = {}
         @namespace_map = set.classify(&:namespace)
         @path_pin_hash = set.classify(&:path)
         @namespaces = @path_pin_hash.keys.compact.to_set
         pins_by_class(Pin::Reference::Include).each do |pin|
-          include_references[pin.namespace] ||= []
-          include_references[pin.namespace].push pin.name
+          store_parametric_reference(include_references, pin)
         end
+        # @todo move the rest of these reference pins over to use
+        #   generic types, adding rbs_map/conversions.rb code to
+        #   populate type parameters and adding related specs ensuring
+        #   the generics get resolved, along with any api_map.rb
+        #   changes needed in
         pins_by_class(Pin::Reference::Prepend).each do |pin|
           prepend_references[pin.namespace] ||= []
           prepend_references[pin.namespace].push pin.name
@@ -256,6 +289,9 @@ module Solargraph
         end
       end
 
+      # @param pin [Pin::Base]
+      # @param tag [String]
+      # @return [void]
       def redefine_return_type pin, tag
         return unless pin && tag.tag_name == 'return'
         pin.instance_variable_set(:@return_type, ComplexType.try_parse(tag.type))