steep 1.8.0.dev.1 → 1.8.0.dev.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 635cc7b37608055562fc399845485f40c065e7300072a2ca194ea15137a0ac11
-  data.tar.gz: c16be740c2d1a8a11ece00fc3abbca6b33a715ddbbfb0a210bc8e09287e2c7d5
+  metadata.gz: eff62e36ae34f76bafc5eb5ec8425ba373dd9ab64ae880537d65b96b4581970c
+  data.tar.gz: b0dc7b3d10b83a0e188a211f40c3a91eb3e146138da328079c84639b92c87bb8
 SHA512:
-  metadata.gz: 164e5369654bc6ef2bd0ef355b796f3b9ee2c43a1887501cfc0282c8cccedc84a2d3a61a4ca257c51ea2500f342f5ad7c9496e03b29d1433aee81c020bae18db
-  data.tar.gz: 03ba49762f19dda444ff5a73a08eca0417ef02d89bed4039ccbc01c07cb1d59e05714583cfaa654dff5597e55ebc55844a038483ec1a46068cd8613f9d575c78
+  metadata.gz: 6e5d7e9e19bf782a8a03842eed077030a9f72eeb5f570ef23110658916f2d4c93c1090e3f3f6017957c80ef1a74c4c7a33bbc295316fe4afb47309cf47c2bcac
+  data.tar.gz: 66a14f3ec60c294a90e85bde099eb40224f22a99493f121bd8378e288affd7ad32a7ee8e1aff23915dd373768c4a35657fd92e14c7afe9e9cbe244c18d36d96c

data/README.md

@@ -214,8 +214,9 @@ You can find examples in `smoke` directory.
 ## IDEs
 
 Steep implements some of the Language Server Protocol features.
-- For **VSCode** please install [the plugin](https://github.com/soutaro/steep-vscode)
-- For **SublimeText** please install [LSP](https://github.com/sublimelsp/LSP) package and follow [instructions](https://lsp.sublimetext.io/language_servers/#steep)
+- For **VSCode** please install [the plugin](https://github.com/soutaro/steep-vscode).
+- For **SublimeText** please install [LSP](https://github.com/sublimelsp/LSP) package and follow [instructions](https://lsp.sublimetext.io/language_servers/#steep).
+- For **Vim** or **Neovim** please install [ALE](https://github.com/dense-analysis/ale?tab=readme-ov-file#asynchronous-lint-engine). You may want to `let g:ale_ruby_steep_executable = 'bundle'` to use your bundled `steep` version.
 
 Other LSP supporting tools may work with Steep where it starts the server as `steep langserver`.
 

data/guides/src/gem-rbs-collection/gem-rbs-collection.md

@@ -16,7 +16,7 @@ You have to edit your `Gemfile`. Specify `require: false` for gems for which you
 
 ```ruby
 gem 'rbs', require: false
-gem 'steep, require: false
+gem 'steep', require: false
 gem 'rbs_rails', require: false
 gem 'rbs_protobuf', require: false
 ```

data/lib/steep/diagnostic/ruby.rb

@@ -162,7 +162,7 @@ module Steep
                  end
 
           loc = if send
-                  send.loc.selector.with(end_pos: send.loc.expression.end_pos)
+                  send.loc.selector.with(end_pos: send.loc.expression.end_pos) # steep:ignore NoMethod
                 else
                   node.loc.expression
                 end
@@ -213,7 +213,7 @@ module Steep
                  end
 
           loc = if send
-                  send.loc.selector.with(end_pos: send.loc.expression.end_pos)
+                  send.loc.selector.with(end_pos: send.loc.expression.end_pos) # steep:ignore NoMethod
                 else
                   node.loc.expression
                 end
@@ -287,8 +287,8 @@ module Steep
           loc = case node.type
                 when :send
                   loc = _ = nil
-                  loc ||= node.loc.operator if node.loc.respond_to?(:operator)
-                  loc ||= node.loc.selector if node.loc.respond_to?(:selector)
+                  loc ||= node.loc.operator if node.loc.respond_to?(:operator) # steep:ignore NoMethod
+                  loc ||= node.loc.selector if node.loc.respond_to?(:selector) # steep:ignore NoMethod
                   loc
                 when :block
                   node.children[0].loc.selector
@@ -463,7 +463,7 @@ module Steep
                    node.children[1]
                  when :defs
                    node.children[2]
-                 end
+                 end #: Parser::AST::Node?
           super(node: node, location: args&.loc&.expression || node.loc.name)
           @method_type = method_type
         end
@@ -668,7 +668,7 @@ module Steep
         attr_reader :name
 
         def initialize(node:, name:)
-          super(node: node, location: node.loc.name)
+          super(node: node, location: node.loc.name)  # steep:ignore NoMethod
           @name = name
         end
 

data/lib/steep/server/interaction_worker.rb

@@ -464,9 +464,11 @@ module Steep
 
             if (items, index = provider.run(line: job.line, column: job.column))
               signatures = items.map do |item|
+                params = item.parameters or raise
+
                 LSP::Interface::SignatureInformation.new(
                   label: item.method_type.to_s,
-                  parameters: item.parameters.map { |param| LSP::Interface::ParameterInformation.new(label: param)},
+                  parameters: params.map { |param| LSP::Interface::ParameterInformation.new(label: param)},
                   active_parameter: item.active_parameter,
                   documentation: item.comment&.yield_self do |comment|
                     LSP::Interface::MarkupContent.new(

data/lib/steep/server/master.rb

@@ -39,7 +39,7 @@ module Steep
         end
 
         def percentage
-          checked_paths.size * 100 / all_paths.size
+          checked_paths.size * 100 / total
         end
 
         def all_paths
@@ -58,7 +58,7 @@ module Steep
         end
 
         def finished?
-          unchecked_paths.empty?
+          total <= checked_paths.size
         end
 
         def unchecked_paths

data/lib/steep/server/type_check_worker.rb

@@ -173,7 +173,9 @@ module Steep
                 method: :"textDocument/publishDiagnostics",
                 params: LSP::Interface::PublishDiagnosticsParams.new(
                   uri: Steep::PathHelper.to_uri(job.path).to_s,
-                  diagnostics: diagnostics.map {|diagnostic| formatter.format(diagnostic) }.uniq
+                  diagnostics: diagnostics.map {|diagnostic|
+                    _ = formatter.format(diagnostic)
+                  }.uniq
                 )
               )
             end
@@ -191,7 +193,7 @@ module Steep
                 method: :"textDocument/publishDiagnostics",
                 params: LSP::Interface::PublishDiagnosticsParams.new(
                   uri: Steep::PathHelper.to_uri(job.path).to_s,
-                  diagnostics: diagnostics.map {|diagnostic| formatter.format(diagnostic) }.uniq.compact
+                  diagnostics: diagnostics.map {|diagnostic| _ = formatter.format(diagnostic) }.uniq.compact
                 )
               )
             end
@@ -210,7 +212,9 @@ module Steep
                 method: :"textDocument/publishDiagnostics",
                 params: LSP::Interface::PublishDiagnosticsParams.new(
                   uri: Steep::PathHelper.to_uri(job.path).to_s,
-                  diagnostics: diagnostics.map {|diagnostic| formatter.format(diagnostic) }.uniq.compact
+                  diagnostics: diagnostics.map {|diagnostic|
+                    _ = formatter.format(diagnostic)
+                  }.uniq.compact
                 )
               )
             end

data/lib/steep/server/worker_process.rb

@@ -132,7 +132,7 @@ module Steep
         new(reader: reader, writer: writer, stderr: stderr, wait_thread: thread, name: name, index: index&.[](1))
       end
 
-      def self.start_typecheck_workers(steepfile:, args:, steep_command:, count: [Etc.nprocessors - 1, 1].max, delay_shutdown: false)
+      def self.start_typecheck_workers(steepfile:, args:, steep_command:, count: [Etc.nprocessors - 1, 1].max || raise, delay_shutdown: false)
         count.times.map do |i|
           start_worker(
             :typecheck,

data/lib/steep/services/completion_provider.rb

@@ -725,7 +725,7 @@ module Steep
       end
 
       def keyword_argument_items_for_method(call_node:, send_node:, position:, prefix:, items:)
-        receiver_node, method_name, argument_nodes = deconstruct_send_node!(send_node)
+        _receiver_node, _method_name, argument_nodes = deconstruct_send_node!(send_node)
 
         call = typing.call_of(node: call_node)
 
@@ -733,6 +733,7 @@ module Steep
         when TypeInference::MethodCall::Typed, TypeInference::MethodCall::Error
           context = typing.context_at(line: position.line, column: position.column)
           type = call.receiver_type
+          type = type.subst(Interface::Substitution.build([], self_type: context.self_type, module_type: context.module_context&.module_type, instance_type: context.module_context&.instance_type))
 
           config = Interface::Builder::Config.new(self_type: type, variable_bounds: context.variable_context.upper_bounds)
           if shape = subtyping.builder.shape(type, config)
@@ -745,7 +746,12 @@ module Steep
                   kwargs = argument_nodes.find { |arg| arg.type == :kwargs }&.children || []
                   used_kwargs = kwargs.filter_map { |arg| arg.type == :pair && arg.children.first.children.first }
 
-                  kwargs = defn.type.type.required_keywords.keys + defn.type.type.optional_keywords.keys
+                  if defn.type.type.is_a?(RBS::Types::UntypedFunction)
+                    kwargs = [] #: Array[Symbol]
+                  else
+                    kwargs = defn.type.type.required_keywords.keys + defn.type.type.optional_keywords.keys
+                  end
+
                   kwargs.each do |name|
                     if name.to_s.start_with?(prefix) && !used_kwargs.include?(name)
                       items << KeywordArgumentItem.new(identifier: "#{name}:", range: range)

data/lib/steep/services/hover_provider/ruby.rb

@@ -121,14 +121,24 @@ module Steep
               context = typing.context_at(line: line, column: column)
               var_type = context.type_env[var_name] || AST::Types::Any.new(location: nil)
 
-              return VariableContent.new(node: node, name: var_name, type: var_type, location: node.location.name)
+              return VariableContent.new(
+                node: node,
+                name: var_name,
+                type: var_type,
+                location: node.location.name # steep:ignore NoMethod
+              )
 
             when :lvasgn
               var_name, rhs = node.children
               context = typing.context_at(line: line, column: column)
               type = context.type_env[var_name] || typing.type_of(node: node)
 
-              return VariableContent.new(node: node, name: var_name, type: type, location: node.location.name)
+              return VariableContent.new(
+                node: node,
+                name: var_name,
+                type: type,
+                location: node.location.name # steep:ignore NoMethod
+              )
 
             when :send, :csend
               result_node =
@@ -149,7 +159,7 @@ module Steep
                   return MethodCallContent.new(
                     node: result_node,
                     method_call: call,
-                    location: node.location.selector
+                    location: node.location.selector # steep:ignore NoMethod
                   )
                 end
               end
@@ -159,13 +169,15 @@ module Steep
               method_context = context.method_context
 
               if method_context && method_context.method
-                return DefinitionContent.new(
-                  node: node,
-                  method_name: method_name_from_method(method_context, builder: context.factory.definition_builder),
-                  method_type: method_context.method_type,
-                  definition: method_context.method,
-                  location: node.loc.name
-                )
+                if method_context.method_type
+                  return DefinitionContent.new(
+                    node: node,
+                    method_name: method_name_from_method(method_context, builder: context.factory.definition_builder),
+                    method_type: method_context.method_type,
+                    definition: method_context.method,
+                    location: node.loc.name # steep:ignore NoMethod
+                  )
+                end
               end
 
             when :const, :casgn
@@ -178,7 +190,7 @@ module Steep
                 entry = context.env.constant_entry(const_name) or return
 
                 return ConstantContent.new(
-                  location: node.location.name,
+                  location: node.location.name, # steep:ignore NoMethod
                   full_name: const_name,
                   type: type,
                   decl: entry

data/lib/steep/services/signature_help_provider.rb

@@ -11,7 +11,7 @@ module Steep
             arguments = [] #: Array[String]
             arguments.push(*method_type.type.required_positionals.map(&:to_s))
             arguments.push(*method_type.type.optional_positionals.map {|p| "?#{p}"})
-            arguments.push("*#{self.method_type.type.rest_positionals}") if method_type.type.rest_positionals
+            arguments.push("*#{method_type.type.rest_positionals}") if method_type.type.rest_positionals
             arguments.push(*method_type.type.trailing_positionals.map(&:to_s))
             arguments.push(*method_type.type.required_keywords.map {|name, param| "#{name}: #{param}" })
             arguments.push(*method_type.type.optional_keywords.map {|name, param| "?#{name}: #{param}" })
@@ -136,6 +136,7 @@ module Steep
 
       def active_parameter_for(method_type, argument_nodes, last_argument_nodes, node)
         return unless method_type
+        return unless method_type.type.is_a?(RBS::Types::Function)
 
         positionals = method_type.type.required_positionals.size + method_type.type.optional_positionals.size + (method_type.type.rest_positionals ? 1 : 0) + method_type.type.trailing_positionals.size
 

data/lib/steep/services/type_check_service.rb

@@ -139,8 +139,11 @@ module Steep
 
           case service.status
           when SignatureService::SyntaxErrorStatus, SignatureService::AncestorErrorStatus
-            service.status.diagnostics.group_by {|diag| Pathname(diag.location.buffer.name) }.each do |path, diagnostics|
-              signature_diagnostics[path].push(*diagnostics)
+            service.status.diagnostics.group_by {|diag| diag.location&.buffer&.name&.to_s }.each do |path_string, diagnostics|
+              if path_string
+                path = Pathname(path_string)
+                signature_diagnostics[path].push(*diagnostics)
+              end
             end
           when SignatureService::LoadedStatus
             validation_diagnostics = signature_validation_diagnostics[target.name] || {}
@@ -230,6 +233,7 @@ module Steep
               case service.status
               when SignatureService::SyntaxErrorStatus
                 diagnostics = service.status.diagnostics.select do |diag|
+                  diag.location or raise
                   Pathname(diag.location.buffer.name) == path &&
                     (diag.is_a?(Diagnostic::Signature::SyntaxError) || diag.is_a?(Diagnostic::Signature::UnexpectedError))
                 end
@@ -239,12 +243,15 @@ module Steep
                 end
 
               when SignatureService::AncestorErrorStatus
-                diagnostics = service.status.diagnostics.select {|diag| Pathname(diag.location.buffer.name) == path }
+                diagnostics = service.status.diagnostics.select do |diag|
+                  diag.location or raise
+                  Pathname(diag.location.buffer.name) == path
+                end
                 accumulated_diagnostics.push(*diagnostics)
                 yield [path, accumulated_diagnostics]
 
               when SignatureService::LoadedStatus
-                validator = Signature::Validator.new(checker: service.current_subtyping)
+                validator = Signature::Validator.new(checker: service.current_subtyping || raise)
                 type_names = service.type_names(paths: Set[path], env: service.latest_env).to_set
 
                 unless type_names.empty?
@@ -286,7 +293,10 @@ module Steep
                   end
                 end
 
-                diagnostics = validator.each_error.select {|error| Pathname(error.location.buffer.name) == path }
+                diagnostics = validator.each_error.select do |error|
+                  error.location or raise
+                  Pathname(error.location.buffer.name) == path
+                end
                 accumulated_diagnostics.push(*diagnostics)
                 yield [path, accumulated_diagnostics]
               end
@@ -361,7 +371,7 @@ module Steep
         error = Diagnostic::Ruby::SyntaxError.new(message: exn.message, location: exn.location)
         SourceFile.with_syntax_error(path: path, content: text, error: error)
       rescue ::Parser::SyntaxError => exn
-        error = Diagnostic::Ruby::SyntaxError.new(message: exn.message, location: exn.diagnostic.location)
+        error = Diagnostic::Ruby::SyntaxError.new(message: exn.message, location: (_ = exn).diagnostic.location)
         SourceFile.with_syntax_error(path: path, content: text, error: error)
       rescue EncodingError => exn
         SourceFile.no_data(path: path, content: "")

data/lib/steep/source.rb

@@ -8,6 +8,7 @@ module Steep
     attr_reader :ignores
 
     extend NodeHelper
+    extend ModuleHelper
 
     def initialize(buffer:, path:, node:, mapping:, comments:, ignores:)
       @buffer = buffer
@@ -295,8 +296,14 @@ module Steep
     end
 
     def annotations(block:, factory:, context:)
+      annotations =
+        if block
+          mapping.fetch(block, [])
+        else
+          []
+        end #: Array[AST::Annotation::t]
       AST::Annotation::Collection.new(
-        annotations: (mapping[block] || []),
+        annotations: annotations,
         factory: factory,
         context: context
       )
@@ -444,6 +451,32 @@ module Steep
       end
     end
 
+    def self.skip_arg_assertions(node)
+      send_node, _ = deconstruct_sendish_and_block_nodes(node)
+      return false unless send_node
+
+      if send_node.type == :send
+        receiver, method, args = deconstruct_send_node!(send_node)
+
+        return false unless receiver
+
+        if receiver.type == :const
+          if type_name = module_name_from_node(receiver.children[0], receiver.children[1])
+            if type_name.namespace.empty?
+              if type_name.name == :Data && method == :define
+                return true
+              end
+              if type_name.name == :Struct && method == :new
+                return true
+              end
+            end
+          end
+        end
+      end
+
+      false
+    end
+
     def self.insert_type_node(node, comments)
       if node.location.expression
         first_line = node.location.expression.first_line
@@ -567,6 +600,19 @@ module Steep
         body = insert_type_node(body, comments) if body
         return adjust_location(node.updated(nil, [object, name, args, body]))
       else
+        if skip_arg_assertions(node)
+          # Data.define, Struct.new, ...??
+          if node.location.expression
+            first_line = node.location.expression.first_line
+            last_line = node.location.expression.last_line
+
+            child_assertions = comments.delete_if {|line, _ | first_line < line && line < last_line }
+            node = map_child_node(node) {|child| insert_type_node(child, child_assertions) }
+
+            return adjust_location(node)
+          end
+        end
+
         adjust_location(
           map_child_node(node, nil) {|child| insert_type_node(child, comments) }
         )

data/lib/steep/subtyping/constraints.rb

@@ -28,7 +28,7 @@ module Steep
           attr_reader :lower_bound
           attr_reader :upper_bound
 
-          def initialize(var: nil, lower_bound: nil, upper_bound: nil)
+          def initialize(var:, lower_bound:, upper_bound:)
             @var = var
             @lower_bound = lower_bound
             @upper_bound = upper_bound
@@ -96,7 +96,7 @@ module Steep
         unless Set.new(vars).disjoint?(unknowns)
           raise UnsatisfiedInvariantError.new(
             reason: UnsatisfiedInvariantError::VariablesUnknownsNotDisjoint.new(vars: vars),
-            constraints: constraints
+            constraints: self
           )
         end
       end

data/lib/steep/type_construction.rb

@@ -1375,6 +1375,12 @@ module Steep
         when :float
           add_typing(node, type: AST::Builtin::Float.instance_type)
 
+        when :rational
+          add_typing(node, type: AST::Types::Name::Instance.new(name: TypeName("::Rational"), args: []))
+
+        when :complex
+          add_typing(node, type: AST::Types::Name::Instance.new(name: TypeName("::Complex"), args: []))
+
         when :nil
           add_typing(node, type: AST::Builtin.nil_type)
 

data/lib/steep/type_inference/block_params.rb

@@ -172,6 +172,9 @@ module Steep
       end
 
       def params_type0(hint:)
+        # @type var leadings: Array[AST::Types::t]
+        # @type var optionals: Array[AST::Types::t]
+        
         if hint
           case
           when leading_params.size == hint.required.size

data/lib/steep/typing.rb

@@ -110,13 +110,13 @@ module Steep
         begin_pos = if send_node.type != :lambda && args_node.loc.expression
                       args_node.loc.expression.end_pos
                     else
-                      node.loc.begin.end_pos
+                      node.loc.begin.end_pos # steep:ignore NoMethod
                     end
-        end_pos = node.loc.end.begin_pos
+        end_pos = node.loc.end.begin_pos # steep:ignore NoMethod
       when :numblock
         send_node, _ = node.children
-        begin_pos = node.loc.begin.end_pos
-        end_pos = node.loc.end.begin_pos
+        begin_pos = node.loc.begin.end_pos # steep:ignore NoMethod
+        end_pos = node.loc.end.begin_pos # steep:ignore NoMethod
       end
 
       begin_pos..end_pos
@@ -131,20 +131,20 @@ module Steep
                     else
                       name_node.loc.expression.end_pos
                     end
-        end_pos = node.loc.end.begin_pos
+        end_pos = node.loc.end.begin_pos # steep:ignore NoMethod
 
         add_context(begin_pos..end_pos, context: context)
 
       when :module
         name_node = node.children[0]
         begin_pos = name_node.loc.expression.end_pos
-        end_pos = node.loc.end.begin_pos
+        end_pos = node.loc.end.begin_pos # steep:ignore NoMethod
         add_context(begin_pos..end_pos, context: context)
 
       when :sclass
         name_node = node.children[0]
         begin_pos = name_node.loc.expression.end_pos
-        end_pos = node.loc.end.begin_pos
+        end_pos = node.loc.end.begin_pos # steep:ignore NoMethod
         add_context(begin_pos..end_pos, context: context)
 
       when :def, :defs
@@ -159,20 +159,20 @@ module Steep
 
           body_begin_pos =
             case
-            when node.loc.assignment
+            when node.loc.assignment # steep:ignore NoMethod
               # endless def
-              node.loc.assignment.end_pos
+              node.loc.assignment.end_pos # steep:ignore NoMethod
             when args_node.loc.expression
               # with args
               args_node.loc.expression.end_pos
             else
               # without args
-              node.loc.name.end_pos
+              node.loc.name.end_pos # steep:ignore NoMethod
             end
 
           body_end_pos =
-            if node.loc.end
-              node.loc.end.begin_pos
+            if node.loc.end # steep:ignore NoMethod
+              node.loc.end.begin_pos # steep:ignore NoMethod
             else
               node.loc.expression.end_pos
             end
@@ -188,7 +188,7 @@ module Steep
         _, collection, _ = node.children
 
         begin_pos = collection.loc.expression.end_pos
-        end_pos = node.loc.end.begin_pos
+        end_pos = node.loc.end.begin_pos # steep:ignore NoMethod
 
         add_context(begin_pos..end_pos, context: context)
       else
@@ -202,6 +202,7 @@ module Steep
     end
 
     def dump(io)
+      # steep:ignore:start
       io.puts "Typing: "
       nodes.each_value do |node|
         io.puts "  #{Typing.summary(node)} => #{type_of(node: node).inspect}"
@@ -211,6 +212,7 @@ module Steep
       errors.each do |error|
         io.puts "  #{Typing.summary(error.node)} => #{error.inspect}"
       end
+      # steep:ignore:end
     end
 
     def self.summary(node)

data/lib/steep/version.rb

@@ -1,3 +1,3 @@
 module Steep
-  VERSION = "1.8.0.dev.1"
+  VERSION = "1.8.0.dev.2"
 end

data/lib/steep.rb

@@ -76,11 +76,11 @@ require "steep/diagnostic/ruby"
 require "steep/diagnostic/signature"
 require "steep/diagnostic/lsp_formatter"
 require "steep/signature/validator"
+require "steep/module_helper"
 require "steep/source"
 require "steep/source/ignore_ranges"
 require "steep/annotation_parser"
 require "steep/typing"
-require "steep/module_helper"
 require "steep/type_construction"
 require "steep/type_inference/context"
 require "steep/type_inference/context_array"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: steep
 version: !ruby/object:Gem::Version
-  version: 1.8.0.dev.1
+  version: 1.8.0.dev.2
 platform: ruby
 authors:
 - Soutaro Matsumoto
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-06-24 00:00:00.000000000 Z
+date: 2024-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser
@@ -401,7 +401,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: Gradual Typing for Ruby