solargraph 0.53.4 → 0.54.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 82af0b18d57296a8eef96680e60f131bad23268e4043d49407d197fc378dd3d2
-  data.tar.gz: 10c5622ac74f0feef06033ed0b851268c876a68581d846b2874fe61a29612acb
+  metadata.gz: d6619265fc1ba2cab9154e70c5f4a6626999b685d58e26a805ec606d6804f17b
+  data.tar.gz: cfac32a13734ba9b392d27fcb8da7c76b180f0bf64189d17698b2246ce6e3773
 SHA512:
-  metadata.gz: 1671b54ae2c314d5c566629706b6de94ca5de0902d1d56e7b96853a889d54b0caef084a5c416222f6fe9f4d40387ea3b56d34b6af917a36855ae902f0b8acf0d
-  data.tar.gz: e7b24e7c08164da0a0b60fc8f04281bfceef59e95470d3f3e78193b024d615da2ae62f94712222ffac722623f7de8207f7af29013bdad6787c63716556ecaf43
+  metadata.gz: 8d1d40bf5d19b37f6a2ee8cce73e36027140ae402d27326c15e39a961217153e8b269722503ca0a8a3b592bee50cb6227fffcd812f62a1ec8a1bf94219270eea
+  data.tar.gz: 627df7fb0bd23b641f0b1a40434a6384def8f32bf318b4f92d243266ee0c3145059adc29ea487dcdc30c914045e5737bca92bff6bd67fd06527f97c2e4690fb8

data/CHANGELOG.md

@@ -1,3 +1,44 @@
+## 0.54.1 - April 26, 2025
+- Retire more RubyVM-specific code (#797)
+- Add additional docs for key classes, modules and methods (#802)
+- Populate location information from RBS files (#768)
+- Consolidate parameter handling into Pin::Callable (#844)
+- Adjust local variable presence to start after assignment, not before (#864)
+- Resolve params from ref tags (#872)
+- Reduce use of ComplexType.parse() to preserve rooted? information (#870)
+- Ensure yield return types are qualified (#886)
+- Understand type of 'def foo; @foo ||= bar; end' reader methods (#888)
+- Improvements to #inspect output on pins and chains (#895)
+- Block method resolution improvements (#885)
+- Understand mass assignment into instance variables (#893)
+- Library sync and cache invalidation (#903)
+- Handle super and yield scenarios from blocks (#891)
+- Allow core and stdlib documentation to be uncached (#899)
+- Surface variable names in LSP, e.g., textDocument/hover (#910)
+- Keep idle progress notifications alive (#911)
+
+## 0.54.0 - April 14, 2025
+- Add support for simple block argument destructuring (#821)
+- Benchmark the typecheck command (#852)
+- Send Gem Caching Progress Notifications to LSP Clients (#855)
+- [breaking] Fix more complex_type_spec.rb cases (#813)
+- Mass assignment support - e.g., a, b = ['1', '2'] (#843)
+- Memoize result of Chain#infer (#857)
+- Ignore malformed mixins and overloads (#862)
+- Drop Parser::ParserGem::ClassMethods#returns_from_node (#866)
+- Refactor TypeChecker#argument_problems_for for type safety (#867)
+- Specify more type behavior for variable reassignment (#863)
+- One-step source synchronization (#871)
+- Show cache progress in shell commands (#874)
+- Fix miscellaneous scan errors (#875)
+- Synchronous libraries (#876)
+- Fix parsing of Set#classify method signature from RBS (#878)
+- Sync Library#diagnose (#882)
+- Doesn't false-alarm over splatted non-final args in typechecking (#883)
+- Remove accidental inclusion of Module's methods in objects (#884)
+- Remove another splat-related false alarm in strict typechecking (#889)
+- Change require path `warn` to `debug` (#897)
+
 ## 0.53.4 - March 30, 2025
 - [regression] Restore 'Unresolved call' typecheck for stdlib objects (#849)
 - Lazy dynamic rebinding (#851)

data/lib/solargraph/api_map/cache.rb

@@ -78,20 +78,10 @@ module Solargraph
         @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
+        return if empty?
+
         all_caches.each(&:clear)
       end
 

data/lib/solargraph/api_map/store.rb

@@ -3,6 +3,9 @@
 
 module Solargraph
   class ApiMap
+    # Queryable collection of Pins representing a Workspace, gems and the Ruby
+    # core.
+    #
     class Store
       # @return [Array<Solargraph::Pin::Base>]
       attr_reader :pins
@@ -35,6 +38,7 @@ module Solargraph
       # @param fqns [String]
       # @return [String, nil]
       def get_superclass fqns
+        raise "Do not prefix fully qualified namespaces with '::' - #{fqns.inspect}" if fqns.start_with?('::')
         return superclass_references[fqns].first if superclass_references.key?(fqns)
         return 'Object' if fqns != 'BasicObject' && namespace_exists?(fqns)
         return 'Object' if fqns == 'Boolean'
@@ -65,6 +69,10 @@ module Solargraph
         path_pin_hash[path] || []
       end
 
+      def cacheable_pins
+        @cacheable_pins ||= pins_by_class(Pin::Namespace) + pins_by_class(Pin::Constant) + pins_by_class(Pin::Method) + pins_by_class(Pin::Reference)
+      end
+
       # @param fqns [String]
       # @param scope [Symbol] :class or :instance
       # @return [Enumerable<Solargraph::Pin::Base>]
@@ -140,8 +148,9 @@ module Solargraph
         to_s
       end
 
-      # @param klass [Class]
-      # @return [Enumerable<Solargraph::Pin::Base>]
+      # @generic T
+      # @param klass [Class<T>]
+      # @return [Set<T>]
       def pins_by_class klass
         # @type [Set<Solargraph::Pin::Base>]
         s = Set.new
@@ -165,7 +174,7 @@ module Solargraph
 
       private
 
-      # @return [Hash{Array(String, String) => Array<Pin::Namespace>}]
+      # @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) }
@@ -178,7 +187,7 @@ module Solargraph
         pins_by_class(Pin::Symbol)
       end
 
-      # @return [Hash{String => Enumerable<String>}]
+      # @return [Hash{String => Array<String>}]
       def superclass_references
         @superclass_references ||= {}
       end
@@ -243,7 +252,7 @@ module Solargraph
       def index
         set = pins.to_set
         @pin_class_hash = set.classify(&:class).transform_values(&:to_a)
-        # @type [Hash{Class => Enumerable<Solargraph::Pin::Base>}]
+        # @type [Hash{Class => ::Array<Solargraph::Pin::Base>}]
         @pin_select_cache = {}
         @namespace_map = set.classify(&:namespace)
         @path_pin_hash = set.classify(&:path)

data/lib/solargraph/api_map.rb

@@ -5,7 +5,7 @@ require 'yard'
 require 'solargraph/yard_tags'
 
 module Solargraph
-  # An aggregate provider for information about workspaces, sources, gems, and
+  # An aggregate provider for information about Workspaces, Sources, gems, and
   # the Ruby core.
   #
   class ApiMap
@@ -29,6 +29,25 @@ module Solargraph
       index pins
     end
 
+    #
+    # This is a mutable object, which is cached in the Chain class -
+    # if you add any fields which change the results of calls (not
+    # just caches), please also change `equality_fields` below.
+    #
+
+    def eql?(other)
+      self.class == other.class &&
+        equality_fields == other.equality_fields
+    end
+
+    def ==(other)
+      self.eql?(other)
+    end
+
+    def hash
+      equality_fields.hash
+    end
+
     # @param pins [Array<Pin::Base>]
     # @return [self]
     def index pins
@@ -56,21 +75,31 @@ module Solargraph
     # @param bench [Bench]
     # @return [self]
     def catalog bench
-      implicit.clear
-      @cache.clear
+      old_api_hash = @source_map_hash&.values&.map(&:api_hash)
+      need_to_uncache = (old_api_hash != bench.source_maps.map(&:api_hash))
       @source_map_hash = bench.source_maps.map { |s| [s.filename, s] }.to_h
-      pins = bench.source_maps.map(&:pins).flatten
+      pins = bench.source_maps.flat_map(&:pins).flatten
+      implicit.clear
       source_map_hash.each_value do |map|
         implicit.merge map.environ
       end
-      unresolved_requires = (bench.external_requires + implicit.requires + bench.workspace.config.required).uniq
-      @doc_map = DocMap.new(unresolved_requires, []) # @todo Implement gem preferences
+      unresolved_requires = (bench.external_requires + implicit.requires + bench.workspace.config.required).to_a.compact.uniq
+      if @unresolved_requires != unresolved_requires || @doc_map&.uncached_gemspecs&.any?
+        @doc_map = DocMap.new(unresolved_requires, [], bench.workspace.rbs_collection_path) # @todo Implement gem preferences
+        @unresolved_requires = unresolved_requires
+        need_to_uncache = true
+      end
       @store = Store.new(@@core_map.pins + @doc_map.pins + implicit.pins + pins)
-      @unresolved_requires = @doc_map.unresolved_requires
+      @cache.clear if need_to_uncache
+
       @missing_docs = [] # @todo Implement missing docs
       self
     end
 
+    protected def equality_fields
+      [self.class, @source_map_hash, implicit, @doc_map, @unresolved_requires, @missing_docs]
+    end
+
     # @return [::Array<Gem::Specification>]
     def uncached_gemspecs
       @doc_map&.uncached_gemspecs || []
@@ -133,14 +162,19 @@ module Solargraph
     # Create an ApiMap with a workspace in the specified directory and cache
     # any missing gems.
     #
+    #
+    # @todo IO::NULL is incorrectly inferred to be a String.
+    # @sg-ignore
+    #
     # @param directory [String]
+    # @param out [IO] The output stream for messages
     # @return [ApiMap]
-    def self.load_with_cache directory
+    def self.load_with_cache directory, out = IO::NULL
       api_map = load(directory)
       return api_map if api_map.uncached_gemspecs.empty?
 
       api_map.uncached_gemspecs.each do |gemspec|
-        Solargraph.logger.info "Caching #{gemspec.name} #{gemspec.version}..."
+        out.puts "Caching gem #{gemspec.name} #{gemspec.version}"
         pins = GemPins.build(gemspec)
         Solargraph::Cache.save('gems', "#{gemspec.name}-#{gemspec.version}.ser", pins)
       end
@@ -216,15 +250,22 @@ module Solargraph
     # @param tag [String, nil] The namespace to
     #   match, complete with generic parameters set to appropriate
     #   values if available
-    # @param context_tag [String] The context in which the tag was
-    #   referenced; start from here to resolve the name
+    # @param context_tag [String] The fully qualified context in which
+    #   the tag was referenced; start from here to resolve the name.
+    #   Should not be prefixed with '::'.
     # @return [String, nil] fully qualified tag
     def qualify tag, context_tag = ''
       return tag if ['self', nil].include?(tag)
-      context_type = ComplexType.parse(context_tag)
-      type = ComplexType.parse(tag)
-      fqns = qualify_namespace(type.rooted_namespace, context_type.rooted_namespace)
-      return nil if fqns.nil?
+
+      context_type = ComplexType.parse(context_tag).force_rooted
+      return unless context_type
+
+      type = ComplexType.try_parse(tag)
+      return unless type
+
+      fqns = qualify_namespace(type.rooted_namespace, context_type.namespace)
+      return unless fqns
+
       fqns + type.substring
     end
 
@@ -287,6 +328,11 @@ module Solargraph
       store.pins_by_class(Pin::GlobalVariable)
     end
 
+    # @return [Enumerable<Solargraph::Pin::Block>]
+    def get_block_pins
+      store.pins_by_class(Pin::Block)
+    end
+
     # Get an array of methods available in a particular context.
     #
     # @param rooted_tag [String] The fully qualified namespace to search for methods
@@ -332,7 +378,7 @@ module Solargraph
           end
         end
         result.concat inner_get_methods('Kernel', :instance, [:public], deep, skip) if visibility.include?(:private)
-        result.concat inner_get_methods('Module', scope, visibility, deep, skip)
+        result.concat inner_get_methods('Module', scope, visibility, deep, skip) if scope == :module
       end
       resolved = resolve_method_aliases(result, visibility)
       cache.set_methods(rooted_tag, scope, visibility, deep, resolved)
@@ -466,9 +512,6 @@ module Solargraph
     def clip cursor
       raise FileNotFoundError, "ApiMap did not catalog #{cursor.filename}" unless source_map_hash.key?(cursor.filename)
 
-      # @todo Clip caches are disabled pending resolution of a stale cache bug
-      # cache.get_clip(cursor) ||
-      #   SourceMap::Clip.new(self, cursor).tap { |clip| cache.set_clip(cursor, clip) }
       SourceMap::Clip.new(self, cursor)
     end
 
@@ -555,7 +598,7 @@ module Solargraph
     # @param no_core [Boolean] Skip core classes if true
     # @return [Array<Pin::Base>]
     def inner_get_methods rooted_tag, scope, visibility, deep, skip, no_core = false
-      rooted_type = ComplexType.parse(rooted_tag)
+      rooted_type = ComplexType.parse(rooted_tag).force_rooted
       fqns = rooted_type.namespace
       fqns_generic_params = rooted_type.all_params
       return [] if no_core && fqns =~ /^(Object|BasicObject|Class|Module)$/
@@ -573,8 +616,8 @@ module Solargraph
       # namespaces; resolving the generics in the method pins is this
       # class' responsibility
       raw_methods = store.get_methods(fqns, scope: scope, visibility: visibility).sort{ |a, b| a.name <=> b.name }
-      namespace_pin = store.get_path_pins(fqns).select{|p| p.is_a?(Pin::Namespace)}.first
-      methods = if rooted_tag != fqns
+      namespace_pin = store.get_path_pins(fqns).select { |p| p.is_a?(Pin::Namespace) }.first
+      methods = if namespace_pin && rooted_tag != fqns
                   methods = raw_methods.map do |method_pin|
                     method_pin.resolve_generics(namespace_pin, rooted_type)
                   end
@@ -593,7 +636,7 @@ module Solargraph
             # @todo perform the same translation in the other areas
             #  here after adding a spec and handling things correctly
             #  in ApiMap::Store and RbsMap::Conversions
-            resolved_include_type = ComplexType.parse(rooted_include_tag).resolve_generics(namespace_pin, rooted_type)
+            resolved_include_type = ComplexType.parse(rooted_include_tag).force_rooted.resolve_generics(namespace_pin, rooted_type)
             methods = inner_get_methods(resolved_include_type.tag, scope, visibility, deep, skip, true)
             result.concat methods
           end
@@ -654,7 +697,7 @@ module Solargraph
 
     # @param namespace [String]
     # @param context [String]
-    # @return [String]
+    # @return [String, nil]
     def qualify_lower namespace, context
       qualify namespace, context.split('::')[0..-2].join('::')
     end

data/lib/solargraph/complex_type/type_methods.rb

@@ -12,24 +12,36 @@ module Solargraph
     #     @rooted: boolish
     #   methods:
     #     transform()
+    #     all_params()
+    #     rooted?()
+    #     can_root_name?()
     module TypeMethods
       # @!method transform(new_name = nil, &transform_type)
       #   @param new_name [String, nil]
       #   @yieldparam t [UniqueType]
       #   @yieldreturn [UniqueType]
       #   @return [UniqueType, nil]
+      # @!method all_params
+      #   @return [Array<ComplexType>]
+      # @!method rooted?
+      # @!method can_root_name?(name_to_check = nil)
+      #   @param name_to_check [String, nil]
 
       # @return [String]
       attr_reader :name
 
-      # @return [String]
-      attr_reader :substring
+      # @return [Array<ComplexType>]
+      attr_reader :subtypes
 
       # @return [String]
-      attr_reader :tag
+      def tag
+        @tag ||= "#{name}#{substring}"
+      end
 
-      # @return [Array<ComplexType>]
-      attr_reader :subtypes
+      # @return [String]
+      def rooted_tag
+        @rooted_tag ||= rooted_name + rooted_substring
+      end
 
       # @return [Boolean]
       def duck_type?
@@ -41,9 +53,8 @@ module Solargraph
         @nil_type ||= (name.casecmp('nil') == 0)
       end
 
-      # @return [Boolean]
-      def parameters?
-        !substring.empty?
+      def tuple?
+        @tuple_type ||= (name == 'Tuple') || (name == 'Array' && subtypes.length >= 1 && fixed_parameters?)
       end
 
       def void?
@@ -74,19 +85,28 @@ module Solargraph
         end
       end
 
+      # @return [Symbol, nil]
+      attr_reader :parameters_type
+
+      PARAMETERS_TYPE_BY_STARTING_TAG = {
+        '{' => :hash,
+        '(' => :fixed,
+        '<' => :list
+      }.freeze
+
       # @return [Boolean]
       def list_parameters?
-        substring.start_with?('<')
+        parameters_type == :list
       end
 
       # @return [Boolean]
       def fixed_parameters?
-        substring.start_with?('(')
+        parameters_type == :fixed
       end
 
       # @return [Boolean]
       def hash_parameters?
-        substring.start_with?('{')
+        parameters_type == :hash
       end
 
       # @return [Array<ComplexType>]
@@ -111,16 +131,43 @@ module Solargraph
 
       # @return [String]
       def rooted_namespace
-        return namespace unless rooted?
+        return namespace unless rooted? && can_root_name?(namespace)
         "::#{namespace}"
       end
 
       # @return [String]
       def rooted_name
-        return name unless rooted?
+        return name unless @rooted && can_root_name?
         "::#{name}"
       end
 
+      # @return [String]
+      def substring
+        @substring ||= generate_substring_from(&:tags)
+      end
+
+      # @return [String]
+      def rooted_substring
+        @rooted_substring = generate_substring_from(&:rooted_tags)
+      end
+
+      # @return [String]
+      def generate_substring_from(&to_str)
+        key_types_str = key_types.map(&to_str).join(', ')
+        subtypes_str = subtypes.map(&to_str).join(', ')
+        if key_types.none?(&:defined?) && subtypes.none?(&:defined?)
+          ''
+        elsif key_types.empty? && subtypes.empty?
+          ''
+        elsif hash_parameters?
+          "{#{key_types_str} => #{subtypes_str}}"
+        elsif fixed_parameters?
+          "(#{subtypes_str})"
+        else
+          "<#{subtypes_str}>"
+        end
+      end
+
       # @return [::Symbol] :class or :instance
       def scope
         @scope ||= :instance if duck_type? || nil_type?
@@ -133,38 +180,22 @@ module Solargraph
         tag == other.tag
       end
 
-      def rooted?
-        @rooted
-      end
-
       # Generate a ComplexType that fully qualifies this type's namespaces.
       #
       # @param api_map [ApiMap] The ApiMap that performs qualification
       # @param context [String] The namespace from which to resolve names
       # @return [self, ComplexType, UniqueType] The generated ComplexType
       def qualify api_map, context = ''
-        return self if name == GENERIC_TAG_NAME
-        return ComplexType.new([self]) if duck_type? || void? || undefined?
-        recon = (rooted? ? '' : context)
-        fqns = api_map.qualify(name, recon)
-        if fqns.nil?
-          return UniqueType::BOOLEAN if tag == 'Boolean'
-          return UniqueType::UNDEFINED
-        end
-        fqns = "::#{fqns}" # Ensure the resulting complex type is rooted
-        all_ltypes = key_types.map { |t| t.qualify api_map, context }.uniq
-        all_rtypes = value_types.map { |t| t.qualify api_map, context }
-        if list_parameters?
-          rtypes = all_rtypes.uniq
-          Solargraph::ComplexType.parse("#{fqns}<#{rtypes.map(&:tag).join(', ')}>")
-        elsif fixed_parameters?
-          Solargraph::ComplexType.parse("#{fqns}(#{all_rtypes.map(&:tag).join(', ')})")
-        elsif hash_parameters?
-          ltypes = all_ltypes.uniq
-          rtypes = all_rtypes.uniq
-          Solargraph::ComplexType.parse("#{fqns}{#{ltypes.map(&:tag).join(', ')} => #{rtypes.map(&:tag).join(', ')}}")
-        else
-          Solargraph::ComplexType.parse(fqns)
+        transform do |t|
+          next t if t.name == GENERIC_TAG_NAME
+          next t if t.duck_type? || t.void? || t.undefined?
+          recon = (t.rooted? ? '' : context)
+          fqns = api_map.qualify(t.name, recon)
+          if fqns.nil?
+            next UniqueType::BOOLEAN if t.tag == 'Boolean'
+            next UniqueType::UNDEFINED
+          end
+          t.recreate(new_name: fqns, make_rooted: true)
         end
       end