solargraph 0.51.1 → 0.52.0

data/lib/solargraph/source/chain/link.rb

@@ -24,7 +24,7 @@ module Solargraph
         # @param api_map [ApiMap]
         # @param name_pin [Pin::Base]
         # @param locals [Array<Pin::Base>]
-        # @return [Array<Pin::Base>]
+        # @return [::Array<Pin::Base>]
         def resolve api_map, name_pin, locals
           []
         end

data/lib/solargraph/source/chain/z_super.rb

@@ -20,7 +20,7 @@ module Solargraph
 
         # @param api_map [ApiMap]
         # @param name_pin [Pin::Base]
-        # @param locals [Array<Pin::Base>]
+        # @param locals [::Array<Pin::Base>]
         def resolve api_map, name_pin, locals
           return super_pins(api_map, name_pin)
         end

data/lib/solargraph/source/chain.rb

@@ -23,6 +23,7 @@ module Solargraph
       autoload :BlockVariable,    'solargraph/source/chain/block_variable'
       autoload :ZSuper,           'solargraph/source/chain/z_super'
       autoload :Hash,             'solargraph/source/chain/hash'
+      autoload :Array,            'solargraph/source/chain/array'
 
       @@inference_stack = []
       @@inference_depth = 0
@@ -30,12 +31,12 @@ module Solargraph
       UNDEFINED_CALL = Chain::Call.new('<undefined>')
       UNDEFINED_CONSTANT = Chain::Constant.new('<undefined>')
 
-      # @return [Array<Source::Chain::Link>]
+      # @return [::Array<Source::Chain::Link>]
       attr_reader :links
 
       attr_reader :node
 
-      # @param links [Array<Chain::Link>]
+      # @param links [::Array<Chain::Link>]
       def initialize links, node = nil, splat = false
         @links = links.clone
         @links.push UNDEFINED_CALL if @links.empty?
@@ -57,7 +58,7 @@ module Solargraph
       # @param api_map [ApiMap]
       # @param name_pin [Pin::Base]
       # @param locals [Array<Pin::Base>]
-      # @return [Array<Pin::Base>]
+      # @return [::Array<Pin::Base>]
       def define api_map, name_pin, locals
         return [] if undefined?
         working_pin = name_pin
@@ -122,17 +123,13 @@ module Solargraph
         pins.each do |pin|
           # Avoid infinite recursion
           next if @@inference_stack.include?(pin.identity)
+
           @@inference_stack.push pin.identity
           type = pin.typify(api_map)
           @@inference_stack.pop
           if type.defined?
-            if type.parameterized?
-              type = type.resolve_parameters(pin.closure, context)
-              # idx = pin.closure.parameters.index(type.subtypes.first.name)
-              # next if idx.nil?
-              # param_type = context.return_type.all_params[idx]
-              # next unless param_type
-              # type = ComplexType.try_parse(param_type.to_s)
+            if type.generic?
+              type = type.resolve_generics(pin.closure, context.return_type)
             end
             if type.defined?
               possibles.push type
@@ -143,10 +140,12 @@ module Solargraph
         if possibles.empty?
           # Limit method inference recursion
           return ComplexType::UNDEFINED if @@inference_depth >= 10 && pins.first.is_a?(Pin::Method)
+
           @@inference_depth += 1
           pins.each do |pin|
             # Avoid infinite recursion
             next if @@inference_stack.include?(pin.identity)
+
             @@inference_stack.push pin.identity
             type = pin.probe(api_map)
             @@inference_stack.pop

data/lib/solargraph/source/source_chainer.rb

@@ -47,6 +47,8 @@ module Solargraph
           elsif source.parsed? && source.repaired? && end_of_phrase == '.'
             node, parent = source.tree_at(fixed_position.line, fixed_position.column)[0..2]
             node = Parser.parse(fixed_phrase) if node.nil?
+          elsif source.repaired?
+            node = Parser.parse(fixed_phrase)
           else
             node, parent = source.tree_at(fixed_position.line, fixed_position.column)[0..2] unless source.error_ranges.any?{|r| r.nil? || r.include?(fixed_position)}
             # Exception for positions that chain literal nodes in unsynchronized sources

data/lib/solargraph/source.rb

@@ -33,7 +33,7 @@ module Solargraph
     attr_reader :version
 
     # @param code [String]
-    # @param filename [String]
+    # @param filename [String, nil]
     # @param version [Integer]
     def initialize code, filename = nil, version = 0
       @code = normalize(code)
@@ -332,7 +332,7 @@ module Solargraph
 
     # @param top [Parser::AST::Node]
     # @param result [Array<Range>]
-    # @param parent [Symbol]
+    # @param parent [Symbol, nil]
     # @return [void]
     def inner_folding_ranges top, result = [], parent = nil
       return unless Parser.is_ast_node?(top)
@@ -503,7 +503,7 @@ module Solargraph
       end
 
       # @param code [String]
-      # @param filename [String]
+      # @param filename [String, nil]
       # @param version [Integer]
       # @return [Solargraph::Source]
       def load_string code, filename = nil, version = 0

data/lib/solargraph/source_map/clip.rb

@@ -115,21 +115,6 @@ module Solargraph
         @context_pin ||= source_map.locate_named_path_pin(cursor.node_position.line, cursor.node_position.character)
       end
 
-      # @return [Array<Pin::Base>]
-      def yielded_self_pins
-        return [] unless block.is_a?(Pin::Block) && block.receiver
-        chain = Parser.chain(block.receiver, source_map.source.filename)
-        receiver_pin = chain.define(api_map, context_pin, locals).first
-        return [] if receiver_pin.nil?
-        result = []
-        ys = receiver_pin.docstring.tag(:yieldpublic)
-        unless ys.nil? || ys.types.empty?
-          ysct = ComplexType.try_parse(*ys.types).qualify(api_map, receiver_pin.context.namespace)
-          result.concat api_map.get_complex_type_methods(ysct, '', false)
-        end
-        result
-      end
-
       # @return [Array<Pin::KeywordParam]
       def complete_keyword_parameters
         return [] unless cursor.argument? && cursor.chain.links.one? && cursor.word =~ /^[a-z0-9_]*:?$/
@@ -226,7 +211,6 @@ module Solargraph
             result.concat api_map.get_methods('Kernel')
             # result.concat ApiMap.keywords
             result.concat api_map.keyword_pins.to_a
-            result.concat yielded_self_pins
           end
         end
         package_completions(result)

data/lib/solargraph/source_map/mapper.rb

@@ -107,7 +107,8 @@ module Solargraph
           begin
             src = Solargraph::Source.load_string("def #{directive.tag.name};end", @source.filename)
             region = Parser::Region.new(source: src, closure: namespace)
-            gen_pin = Parser.process_node(src.node, region).first.last
+            method_gen_pins = Parser.process_node(src.node, region).first.select { |pin| pin.is_a?(Pin::Method) }
+            gen_pin = method_gen_pins.last
             return if gen_pin.nil?
             # Move the location to the end of the line so it gets recognized
             # as originating from a comment

data/lib/solargraph/source_map.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'yard'
-require 'yard-solargraph'
+require 'solargraph/yard_tags'
 require 'set'
 
 module Solargraph
@@ -41,7 +41,7 @@ module Solargraph
 
     def rebindable_method_names
       @rebindable_method_names ||= pins_by_class(Pin::Method)
-        .select { |pin| pin.comments && pin.comments.include?('@yieldself') }
+        .select { |pin| pin.comments && pin.comments.include?('@yieldreceiver') }
         .map(&:name)
         .to_set
     end

data/lib/solargraph/type_checker.rb

@@ -22,7 +22,7 @@ module Solargraph
     attr_reader :api_map
 
     # @param filename [String]
-    # @param api_map [ApiMap]
+    # @param api_map [ApiMap, nil]
     # @param level [Symbol]
     def initialize filename, api_map: nil, level: :normal
       @filename = filename
@@ -91,7 +91,12 @@ module Solargraph
       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)
+          if pin.attribute?
+            inferred = pin.probe(api_map).self_to(pin.full_context.namespace)
+            result.push Problem.new(pin.location, "Missing @return tag for #{pin.path}", pin: pin) unless inferred.defined?
+          else
+            result.push Problem.new(pin.location, "Missing @return tag for #{pin.path}", pin: pin)
+          end
         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?
@@ -141,7 +146,14 @@ module Solargraph
           sig.parameters.each do |par|
             break if par.decl == :restarg || par.decl == :kwrestarg || par.decl == :blockarg
             unless params[par.name]
-              result.push Problem.new(pin.location, "Missing @param tag for #{par.name} on #{pin.path}", pin: pin)
+              if pin.attribute?
+                inferred = pin.probe(api_map).self_to(pin.full_context.namespace)
+                if inferred.undefined?
+                  result.push Problem.new(pin.location, "Missing @param tag for #{par.name} on #{pin.path}", pin: pin)
+                end
+              else
+                result.push Problem.new(pin.location, "Missing @param tag for #{par.name} on #{pin.path}", pin: pin)
+              end
             end
           end
         end
@@ -243,7 +255,7 @@ module Solargraph
           end
           closest = found.typify(api_map) if found
           if !found || found.is_a?(Pin::BaseVariable) || (closest.defined? && internal_or_core?(found))
-            unless closest.parameterized? || ignored_pins.include?(found)
+            unless closest.generic? || ignored_pins.include?(found)
               result.push Problem.new(location, "Unresolved call to #{missing.links.last.word}")
               @marked_ranges.push rng
             end
@@ -279,7 +291,8 @@ module Solargraph
             result.concat ap
             break
           end
-          break unless rules.validate_calls?
+          break if !rules.validate_calls? || base.links.first.is_a?(Solargraph::Source::Chain::ZSuper)
+
           params = first_param_hash(pins)
 
           all_errors = []
@@ -455,8 +468,6 @@ module Solargraph
       return [] if parameters.empty? && arguments.empty?
       return [] if pin.anon_splat?
       if parameters.empty?
-        # Functions tagged param_tuple accepts two arguments (e.g., Hash#[]=)
-        return [] if pin.docstring.tag(:param_tuple) && arguments.length == 2
         return [] if arguments.length == 1 && arguments.last.links.last.is_a?(Source::Chain::BlockVariable)
         return [Problem.new(location, "Too many arguments to #{pin.path}")]
       end

data/lib/solargraph/version.rb

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

data/lib/solargraph/workspace.rb

@@ -104,7 +104,8 @@ module Solargraph
     # @return [Boolean]
     def would_require? path
       require_paths.each do |rp|
-        return true if File.exist?(File.join(rp, "#{path}.rb"))
+        full = File.join rp, path
+        return true if File.exist?(full) or File.exist?(full << ".rb")
       end
       false
     end

data/lib/solargraph/yard_map/mapper.rb

@@ -8,7 +8,7 @@ module Solargraph
       autoload :ToConstant, 'solargraph/yard_map/mapper/to_constant'
 
       # @param code_objects [Array<YARD::CodeObjects::Base>]
-      # @param spec [Gem::Specification]
+      # @param spec [Gem::Specification, nil]
       def initialize code_objects, spec = nil
         @code_objects = code_objects
         @spec = spec

data/lib/solargraph/yard_map.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'yard'
-require 'yard-solargraph'
+require 'solargraph/yard_tags'
 require 'rubygems/package'
 require 'set'
 
@@ -66,7 +66,7 @@ module Solargraph
     # @return [Set<String>]
     def rebindable_method_names
       @rebindable_method_names ||= pins_by_class(Pin::Method)
-        .select { |pin| pin.comments && pin.comments.include?('@yieldself') }
+        .select { |pin| pin.comments && pin.comments.include?('@yieldreceiver') }
         .map(&:name)
         .concat(['instance_eval', 'instance_exec', 'class_eval', 'class_exec', 'module_eval', 'module_exec', 'define_method'])
         .to_set
@@ -120,8 +120,9 @@ module Solargraph
       # @type [Gem::Specification]
       spec = spec_for_require(path)
       spec.full_require_paths.each do |rp|
-        file = File.join(rp, "#{path}.rb")
-        next unless File.file?(file)
+        file = File.join(rp, path)
+        file = [file, file + ".rb"].find { |file| File.file?(file) }
+        next unless file
         return Solargraph::Location.new(file, Solargraph::Range.from_to(0, 0, 0, 0))
       end
       nil
@@ -144,7 +145,7 @@ module Solargraph
       @cache ||= YardMap::Cache.new
     end
 
-    # @return [Hash]
+    # @return [Hash{Class<Pin::Base> => Array<Pin::Base>}]
     def pin_class_hash
       @pin_class_hash ||= pins.to_set.classify(&:class).transform_values(&:to_a)
     end

data/lib/solargraph/yard_tags.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'yard'
+
+# Change YARD log IO to avoid sending unexpected messages to STDOUT
+YARD::Logger.instance.io = File.new(File::NULL, 'w')
+
+module Solargraph
+  # A placeholder for the @!domain directive. It doesn't need to do anything
+  # for yardocs. It's only used for Solargraph API maps.
+  class DomainDirective < YARD::Tags::Directive
+    def call; end
+  end
+end
+
+# Define a @type tag for documenting variables
+YARD::Tags::Library.define_tag("Type", :type, :with_types_and_name)
+
+# Define an @!override directive for overriding method tags
+YARD::Tags::Library.define_directive("override", :with_name, Solargraph::DomainDirective)

data/lib/solargraph.rb

@@ -2,6 +2,8 @@
 
 Encoding.default_external = 'UTF-8'
 
+require 'yard-solargraph'
+require 'solargraph/yard_tags'
 require 'solargraph/version'
 
 # The top-level namespace for the Solargraph code mapping, documentation,
@@ -44,7 +46,6 @@ module Solargraph
   autoload :Cache,            'solargraph/cache'
 
   dir = File.dirname(__FILE__)
-  YARD_EXTENSION_FILE = File.join(dir, 'yard-solargraph.rb')
   VIEWS_PATH = File.join(dir, 'solargraph', 'views')
 
   # A convenience method for Solargraph::Logging.logger.
@@ -56,8 +57,6 @@ module Solargraph
 
   # A helper method that runs Bundler.with_unbundled_env or falls back to
   # Bundler.with_clean_env for earlier versions of Bundler.
-  #
-  # @return [void]
   def self.with_clean_env &block
     meth = if Bundler.respond_to?(:with_original_env)
       :with_original_env

data/solargraph.gemspec

@@ -40,6 +40,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'thor', '~> 1.0'
   s.add_runtime_dependency 'tilt', '~> 2.0'
   s.add_runtime_dependency 'yard', '~> 0.9', '>= 0.9.24'
+  s.add_runtime_dependency 'yard-solargraph', '~> 0.1'
 
   s.add_development_dependency 'pry'
   s.add_development_dependency 'public_suffix', '~> 3.1'
@@ -47,4 +48,6 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rspec', '~> 3.5'
   s.add_development_dependency 'simplecov', '~> 0.14'
   s.add_development_dependency 'webmock', '~> 3.6'
+  # work around missing yard dependency needed as of Ruby 3.5
+  s.add_development_dependency 'irb'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solargraph
 version: !ruby/object:Gem::Version
-  version: 0.51.1
+  version: 0.52.0
 platform: ruby
 authors:
 - Fred Snyder
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-23 00:00:00.000000000 Z
+date: 2025-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: backport
@@ -260,6 +260,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.9.24
+- !ruby/object:Gem::Dependency
+  name: yard-solargraph
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -344,6 +358,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: irb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: IDE tools for code completion, inline documentation, and static analysis
 email: admin@castwide.com
 executables:
@@ -561,6 +589,7 @@ files:
 - lib/solargraph/shell.rb
 - lib/solargraph/source.rb
 - lib/solargraph/source/chain.rb
+- lib/solargraph/source/chain/array.rb
 - lib/solargraph/source/chain/block_variable.rb
 - lib/solargraph/source/chain/call.rb
 - lib/solargraph/source/chain/class_variable.rb
@@ -607,7 +636,7 @@ files:
 - lib/solargraph/yard_map/mapper/to_method.rb
 - lib/solargraph/yard_map/mapper/to_namespace.rb
 - lib/solargraph/yard_map/to_method.rb
-- lib/yard-solargraph.rb
+- lib/solargraph/yard_tags.rb
 - solargraph.gemspec
 homepage: https://solargraph.org
 licenses:

data/lib/yard-solargraph.rb

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-require 'yard'
-
-# Change YARD log IO to avoid sending unexpected messages to STDOUT
-YARD::Logger.instance.io = File.new(File::NULL, 'w')
-
-module Solargraph
-  # A placeholder for the @!domain directive. It doesn't need to do anything
-  # for yardocs. It's only used for Solargraph API maps.
-  class DomainDirective < YARD::Tags::Directive
-    def call; end
-  end
-end
-
-# Define a @type tag for documenting variables
-YARD::Tags::Library.define_tag("Type", :type, :with_types_and_name)
-# Define a @yieldself tag for documenting block contexts
-YARD::Tags::Library.define_tag("Yieldself", :yieldself, :with_types)
-# Define a @yieldpublic tag for documenting block domains
-YARD::Tags::Library.define_tag("Yieldpublic", :yieldpublic, :with_types)
-# Define a @return_single_parameter tag for returning e.g. Array parameters
-YARD::Tags::Library.define_tag('ReturnSingleParameter', :return_single_parameter)
-# Define a @yieldparam_single_parameter tag for yielding e.g. Array parameters
-YARD::Tags::Library.define_tag('YieldparamSingleParameter', :yieldparam_single_parameter)
-# Define a @return_value_parameter tag for returning e.g. Hash values
-YARD::Tags::Library.define_tag('ReturnValueParameter', :return_value_parameter)
-# Define a @param_tuple tag for e.g. Hash#[]= parameters
-YARD::Tags::Library.define_tag('ParamTuple', :param_tuple)
-# Define a @!domain directive for documenting DSLs
-YARD::Tags::Library.define_directive("domain", :with_types, Solargraph::DomainDirective)
-# Define an @!override directive for overriding method tags
-YARD::Tags::Library.define_directive("override", :with_name, Solargraph::DomainDirective)