solargraph 0.53.0 → 0.54.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ea6f4539a04d35b759acc75c97b4af772a34877adf8dba07e0a9a109a75cb545
-  data.tar.gz: 3e6945e906e693884a19e3fb2504cf8508cdb9784fa015b27dd455fb2e4ddba7
+  metadata.gz: 39ad27afe3afb59299f8701f9a7ea3f25a9f95379ef68e53ac0e22eb60f50e21
+  data.tar.gz: 1f01a9d5cdf4aec5b50c245a25b1f7d83e5d6762e5b8f65bc9ce3555654e21ed
 SHA512:
-  metadata.gz: 561c956490d3231c79cd89163c162364793baca6c1a86c0dddb3b4896b965d08e4e86e4a4766a297c7d71b5f1573336d3d9c99aa271d7fa9fbde3061a8b7d338
-  data.tar.gz: 683c8d6df19fbc1abcbc1420a4f78157d032ca91a1bbec9c2b77b3a429a88d6f2f754d0b1def057a807f90ea6e026ee11725eb22290c286e0019bc0aaba13d07
+  metadata.gz: 788f17e92a54e782ea1dcf03cb44245df823ba33b4fe866d1afa5d06c7171b40a4e1f93c97c8b26c13b58be7478b9b07cd75d6735da65ecef21ab6a4a61dbb0e
+  data.tar.gz: 742f43fcdce4a592a80ebe8e3acbd020f39f569cf323621a527e626ae8c6154f7dedb32739b8b62f38e98997ed414ec30471160332ecfb4a2fe5d5052e871333

data/CHANGELOG.md

@@ -1,3 +1,48 @@
+## 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)
+- Restore fill for Class#allocate (#848)
+- [regression] Ensure YardMap gems have return type for Class<T>.new (#850)
+- Create implicit .new pins in namespace method queries (#853)
+
+## 0.53.3 - March 29, 2025
+- Remove redundant core fills (#824, #841)
+- Resolve self type in variable assignments (#839)
+- Eliminate splat-related false-alarms in strict typechecking (#840)
+- Dynamic block binding with yieldreceiver (#842)
+- Resolve generics by descending through context type (#847)
+
+## 0.53.2 - March 27, 2025
+- Fix a self-type-related false-positive in strict typechecking (#834)
+- DocMap fetches gem dependencies (#835)
+- Use configured command path to spawn solargraph processes (#837)
+
+## 0.53.1 - March 26, 2025
+- Reject nil requires in live code (#831)
+- RbsMap adds mixins to current namespace (#832)
+
 ## 0.53.0 - March 25, 2025
 - Fix crash on generic methods (#762)
 - Add more type annotations to the codebase (#763 et al.)

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/source_to_yard.rb

@@ -6,10 +6,13 @@ module Solargraph
 
       # Get the YARD CodeObject at the specified path.
       #
+      # @generic T
       # @param path [String]
-      # @return [YARD::CodeObjects::Base]
-      def code_object_at path
-        code_object_map[path]
+      # @param klass [Class<generic<T>>]
+      # @return [generic<T>, nil]
+      def code_object_at path, klass = YARD::CodeObjects::Base
+        obj = code_object_map[path]
+        obj if obj&.is_a?(klass)
       end
 
       # @return [Array<String>]
@@ -41,11 +44,13 @@ module Solargraph
           end
           code_object_map[pin.path].docstring = pin.docstring
           store.get_includes(pin.path).each do |ref|
-            code_object_map[pin.path].instance_mixins.push code_object_map[ref] unless code_object_map[ref].nil? or code_object_map[pin.path].nil?
+            include_object = code_object_at(pin.path, YARD::CodeObjects::ClassObject)
+            include_object.instance_mixins.push code_object_map[ref] unless include_object.nil? or include_object.nil?
           end
           store.get_extends(pin.path).each do |ref|
-            code_object_map[pin.path].instance_mixins.push code_object_map[ref] unless code_object_map[ref].nil? or code_object_map[pin.path].nil?
-            code_object_map[pin.path].class_mixins.push code_object_map[ref] unless code_object_map[ref].nil? or code_object_map[pin.path].nil?
+            extend_object = code_object_at(pin.path, YARD::CodeObjects::ClassObject)
+            extend_object.instance_mixins.push code_object_map[ref] unless extend_object.nil? or extend_object.nil?
+            extend_object.class_mixins.push code_object_map[ref] unless extend_object.nil? or extend_object.nil?
           end
         end
         store.method_pins.each do |pin|
@@ -53,13 +58,15 @@ module Solargraph
             code_object_map[pin.path] ||= pin.code_object
             next
           end
-          code_object_map[pin.path] ||= YARD::CodeObjects::MethodObject.new(code_object_at(pin.namespace), pin.name, pin.scope) { |obj|
+
+          code_object_map[pin.path] ||= YARD::CodeObjects::MethodObject.new(code_object_at(pin.namespace, YARD::CodeObjects::NamespaceObject), pin.name, pin.scope) { |obj|
             next if pin.location.nil? || pin.location.filename.nil?
             obj.add_file pin.location.filename, pin.location.range.start.line
           }
-          code_object_map[pin.path].docstring = pin.docstring
-          code_object_map[pin.path].visibility = pin.visibility || :public
-          code_object_map[pin.path].parameters = pin.parameters.map do |p|
+          method_object = code_object_at(pin.path, YARD::CodeObjects::MethodObject)
+          method_object.docstring = pin.docstring
+          method_object.visibility = pin.visibility || :public
+          method_object.parameters = pin.parameters.map do |p|
             [p.name, p.asgn_code]
           end
         end

data/lib/solargraph/api_map/store.rb

@@ -65,6 +65,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>]
@@ -96,7 +100,7 @@ module Solargraph
         @namespaces ||= Set.new
       end
 
-      # @return [Enumerable<Solargraph::Pin::Base>]
+      # @return [Array<Solargraph::Pin::Base>]
       def namespace_pins
         pins_by_class(Solargraph::Pin::Namespace)
       end
@@ -140,8 +144,9 @@ module Solargraph
         to_s
       end
 
-      # @param klass [Class]
-      # @return [Enumerable<Solargraph::Pin::Base>]
+      # @generic T
+      # @param klass [Class<T>]
+      # @return [Array<T>]
       def pins_by_class klass
         # @type [Set<Solargraph::Pin::Base>]
         s = Set.new
@@ -165,7 +170,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 +183,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 +248,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

@@ -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,23 +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 dependencies
+      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
-      @rebindable_method_names = nil
-      store.block_pins.each { |blk| blk.rebind(self) }
       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 || []
@@ -135,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
@@ -154,17 +186,6 @@ module Solargraph
       store.pins
     end
 
-    # @return [Set<String>]
-    def rebindable_method_names
-      @rebindable_method_names ||= begin
-        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
-        result
-      end
-    end
-
     # An array of pins based on Ruby keywords (`if`, `end`, etc.).
     #
     # @return [Enumerable<Solargraph::Pin::Keyword>]
@@ -234,10 +255,15 @@ module Solargraph
     # @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)
+      context_type = ComplexType.try_parse(context_tag)
+      return unless context_type
+
+      type = ComplexType.try_parse(tag)
+      return unless type
+
       fqns = qualify_namespace(type.rooted_namespace, context_type.rooted_namespace)
-      return nil if fqns.nil?
+      return unless fqns
+
       fqns + type.substring
     end
 
@@ -324,8 +350,28 @@ module Solargraph
         result.concat inner_get_methods('Kernel', :instance, visibility, deep, skip)
       else
         result.concat inner_get_methods(rooted_tag, scope, visibility, deep, skip)
+        unless %w[Class Class<Class>].include?(rooted_tag)
+          result.map! do |pin|
+            next pin unless pin.path == 'Class#new'
+            init_pin = get_method_stack(rooted_tag, 'initialize').first
+            next pin unless init_pin
+
+            type = ComplexType.try_parse(ComplexType.try_parse(rooted_tag).namespace)
+            Pin::Method.new(
+              name: 'new',
+              scope: :class,
+              location: init_pin.location,
+              parameters: init_pin.parameters,
+              signatures: init_pin.signatures.map { |sig| sig.proxy(type) },
+              return_type: type,
+              comments: init_pin.comments,
+              closure: init_pin.closure
+            # @todo Hack to force TypeChecker#internal_or_core?
+            ).tap { |pin| pin.source = :rbs }
+          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)
@@ -459,9 +505,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
 
@@ -566,8 +609,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
@@ -737,23 +780,22 @@ module Solargraph
     # @param visibility [Enumerable<Symbol>]
     # @return [Array<Pin::Base>]
     def resolve_method_aliases pins, visibility = [:public, :private, :protected]
-      result = []
-      pins.each do |pin|
+      pins.map do |pin|
         resolved = resolve_method_alias(pin)
-        next if resolved.respond_to?(:visibility) && !visibility.include?(resolved.visibility)
-        result.push resolved
-      end
-      result
+        next pin if resolved.respond_to?(:visibility) && !visibility.include?(resolved.visibility)
+        resolved
+      end.compact
     end
 
     # @param pin [Pin::MethodAlias, Pin::Base]
     # @return [Pin::Method]
     def resolve_method_alias pin
-      return pin if !pin.is_a?(Pin::MethodAlias) || @method_alias_stack.include?(pin.path)
+      return pin unless pin.is_a?(Pin::MethodAlias)
+      return nil if @method_alias_stack.include?(pin.path)
       @method_alias_stack.push pin.path
       origin = get_method_stack(pin.full_context.tag, pin.original, scope: pin.scope).first
       @method_alias_stack.pop
-      return pin if origin.nil?
+      return nil if origin.nil?
       args = {
         location: pin.location,
         closure: pin.closure,

data/lib/solargraph/bench.rb

@@ -21,6 +21,7 @@ module Solargraph
       @source_maps = source_maps.to_set
       @workspace = workspace
       @external_requires = external_requires.reject { |path| workspace.would_require?(path) }
+                                            .compact
                                             .to_set
     end
   end

data/lib/solargraph/complex_type/type_methods.rb

@@ -22,14 +22,18 @@ module Solargraph
       # @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?
@@ -46,6 +50,10 @@ module Solargraph
         !substring.empty?
       end
 
+      def tuple?
+        @tuple_type ||= (name == 'Tuple') || (name == 'Array' && subtypes.length >= 1 && fixed_parameters?)
+      end
+
       def void?
         name == 'void'
       end
@@ -74,19 +82,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>]
@@ -121,6 +138,33 @@ module Solargraph
         "::#{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?
@@ -143,28 +187,16 @@ module Solargraph
       # @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