steep 1.5.3 → 1.6.0.pre.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c6fac293e42dfa305b98aa0f8dbf49acdad88f0794a6081f7c6e548ccab49f4b
-  data.tar.gz: 2824c6289d92fadc1d062571d9652d759fc7774531d532d2bcf846ce20240bec
+  metadata.gz: d8a5efa97a65add83ffc658ddfbdf9a436accc8dd4472969610b2224140543ea
+  data.tar.gz: 537d28e28ae6b3bc47392170948db46d3d7fa50d61f6f274182b922a253394ea
 SHA512:
-  metadata.gz: 800d77371db9fcc77688a30c442355d84f31cbbf21ccc7fda46155e394b011887b98b1c47f3f9a9a117087c4790a3fecfee9ac4bdbfb4dea096deafa959e2d96
-  data.tar.gz: 2d1eed9a3397eeeb1c5675a7038acbf5cdab173aec3285d8c88df925f9fe7d07bf4ef0f248ae7df5895bef21509bc0e2156883c84a7bdb4a53598b1608041864
+  metadata.gz: 386ddbecc785a37748b8a6d9dcf514af55cec3bcafca945e363d5e76e56fd266cd91238183b3c99635595168b0049e93b065f3154569d10909c2ecd6ccdd9519
+  data.tar.gz: 15a3baf8009e78767015a4529f71b20300edc221aaf0b218efdee5a894f73d619d2c3078c68f4e3511bec4dbb67aece479e9a95c6b1ae1fb9066da86094fc810

data/.github/workflows/ruby-windows.yml

@@ -11,7 +11,6 @@ jobs:
     strategy:
       matrix:
         ruby_version:
-        - "2.7"
         - "3.0"
         - "3.1"
         - "3.2"
@@ -21,7 +20,7 @@ jobs:
         - build
     runs-on: windows-latest
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby_version }}

data/.github/workflows/ruby.yml

@@ -11,7 +11,6 @@ jobs:
     strategy:
       matrix:
         container_tag:
-        - "2.7"
         - "3.0"
         - "3.1"
         - "3.2"
@@ -24,7 +23,7 @@ jobs:
     container:
       image: rubylang/ruby:${{ matrix.container_tag }}
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Run test
       run: |
         git config --global --add safe.directory /__w/steep/steep

data/CHANGELOG.md

@@ -2,6 +2,41 @@
 
 ## master
 
+## 1.6.0.pre.1 (2023-10-27)
+
+### Type checker core
+
+* Test if a parameter is `_` ([#946](https://github.com/soutaro/steep/pull/946))
+* Let `[]=` call have correct type ([#945](https://github.com/soutaro/steep/pull/945))
+* Support type narrowing by `Module#<` ([#877](https://github.com/soutaro/steep/pull/877))
+* Fewer `UnresolvedOverloading` ([#941](https://github.com/soutaro/steep/pull/941))
+* Fix ArgumentTypeMismatch for PublishDiagnosticsParams ([#895](https://github.com/soutaro/steep/pull/895))
+* Add types for LSP::Constant::MessageType ([#894](https://github.com/soutaro/steep/pull/894))
+* `nil` is not a `NilClass` ([#920](https://github.com/soutaro/steep/pull/920))
+* Fix unexpected error when DifferentMethodParameterKind ([#917](https://github.com/soutaro/steep/pull/917))
+
+### Commandline tool
+
+* Fix space in file path crash ([#944](https://github.com/soutaro/steep/pull/944))
+* refactor: Rename driver objects to command ([#893](https://github.com/soutaro/steep/pull/893))
+* Run with `--jobs=2` automatically on CI ([#924](https://github.com/soutaro/steep/pull/924))
+* Fix type alias validation ([#922](https://github.com/soutaro/steep/pull/922))
+
+### Language server
+
+* Let goto definition work from `UnresolvedOverloading` error calls ([#943](https://github.com/soutaro/steep/pull/943))
+* Let label be whole method type in SignatureHelp ([#942](https://github.com/soutaro/steep/pull/942))
+* Set up file watcher ([#936](https://github.com/soutaro/steep/pull/936))
+* Reset file content on `didOpen` notification ([#935](https://github.com/soutaro/steep/pull/935))
+* Start type check on change ([#934](https://github.com/soutaro/steep/pull/934))
+* Better completion with module alias and `use` directives ([#923](https://github.com/soutaro/steep/pull/923))
+
+### Miscellaneous
+
+* Drop 2.7 support ([#928](https://github.com/soutaro/steep/pull/928))
+* Type check `subtyping/check.rb` ([#921](https://github.com/soutaro/steep/pull/921))
+* Type check constant under `self` ([#908](https://github.com/soutaro/steep/pull/908))
+
 ## 1.5.3 (2023-08-10)
 
 ### Type checker core

data/Gemfile

@@ -4,9 +4,11 @@ source 'https://rubygems.org'
 gemspec
 
 gem "rake"
-gem "minitest", "~> 5.19"
+gem "minitest", "~> 5.20"
 gem "minitest-hooks"
 group :stackprof, optional: true do
   gem "stackprof"
 end
 gem 'minitest-slow_test'
+
+gem "debug", require: false, platform: :mri

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    steep (1.5.3)
+    steep (1.6.0.pre.1)
       activesupport (>= 5.1)
       concurrent-ruby (>= 1.1.10)
       csv (>= 3.0.9)
@@ -20,53 +20,80 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.7)
+    activesupport (7.1.1)
+      base64
+      bigdecimal
       concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
+      mutex_m
       tzinfo (~> 2.0)
     ast (2.4.2)
+    base64 (0.1.1)
+    bigdecimal (3.1.4)
     concurrent-ruby (1.2.2)
+    connection_pool (2.4.1)
     csv (3.2.7)
-    ffi (1.15.5)
+    debug (1.8.0)
+      irb (>= 1.5.0)
+      reline (>= 0.3.1)
+    drb (2.1.1)
+      ruby2_keywords
+    ffi (1.16.3)
     fileutils (1.7.1)
     i18n (1.14.1)
       concurrent-ruby (~> 1.0)
+    io-console (0.6.0)
+    irb (1.8.1)
+      rdoc
+      reline (>= 0.3.8)
     json (2.6.3)
     language_server-protocol (3.17.0.3)
     listen (3.8.0)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
     logger (1.5.3)
-    minitest (5.19.0)
+    minitest (5.20.0)
     minitest-hooks (1.5.1)
       minitest (> 5.3)
     minitest-slow_test (0.2.0)
       minitest (>= 5.0)
-    parser (3.2.2.3)
+    mutex_m (0.1.2)
+    parser (3.2.2.4)
       ast (~> 2.4.1)
       racc
+    psych (5.1.0)
+      stringio
     racc (1.7.1)
     rainbow (3.1.1)
     rake (13.0.6)
     rb-fsevent (0.11.2)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
-    rbs (3.1.3)
+    rbs (3.2.2)
+    rdoc (6.5.0)
+      psych (>= 4.0.0)
+    reline (0.3.8)
+      io-console (~> 0.5)
+    ruby2_keywords (0.0.5)
     securerandom (0.2.2)
     stackprof (0.2.25)
-    strscan (3.0.6)
+    stringio (3.0.8)
+    strscan (3.0.7)
     terminal-table (3.0.2)
       unicode-display_width (>= 1.1.1, < 3)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.4.2)
+    unicode-display_width (2.5.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  minitest (~> 5.19)
+  debug
+  minitest (~> 5.20)
   minitest-hooks
   minitest-slow_test
   rake

data/gemfile_steep/Gemfile.lock

@@ -1,7 +1,7 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.6)
+    activesupport (7.0.7.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -28,9 +28,9 @@ GEM
     rb-fsevent (0.11.2)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
-    rbs (3.1.2)
+    rbs (3.1.3)
     securerandom (0.2.2)
-    steep (1.5.2)
+    steep (1.5.3)
       activesupport (>= 5.1)
       concurrent-ruby (>= 1.1.10)
       csv (>= 3.0.9)

data/lib/steep/ast/types/logic.rb

@@ -68,6 +68,12 @@ module Steep
           end
         end
 
+        class ArgIsAncestor < Base
+          def initialize(location: nil)
+            @location = location
+          end
+        end
+
         class Env < Base
           attr_reader :truthy, :falsy, :type
 

data/lib/steep/cli.rb

@@ -84,6 +84,18 @@ module Steep
       end
     end
 
+    def setup_jobs_for_ci(jobs_option)
+      if ENV["CI"]
+        unless jobs_option.jobs_count
+          stderr.puts Rainbow("CI environment is detected but no `--jobs` option is given.").yellow
+          stderr.puts "  Using `[2, #{jobs_option.default_jobs_count} (# or processors)].min` to avoid hitting memory limit."
+          stderr.puts "  Specify `--jobs` option to increase the number of jobs."
+
+          jobs_option.jobs_count = [2, jobs_option.default_jobs_count].min
+        end
+      end
+    end
+
     def process_init
       Drivers::Init.new(stdout: stdout, stderr: stderr).tap do |command|
         OptionParser.new do |opts|
@@ -98,63 +110,69 @@ module Steep
     end
 
     def process_check
-      Drivers::Check.new(stdout: stdout, stderr: stderr).tap do |check|
+      Drivers::Check.new(stdout: stdout, stderr: stderr).tap do |command|
         OptionParser.new do |opts|
           opts.banner = "Usage: steep check [options] [sources]"
 
-          opts.on("--steepfile=PATH") {|path| check.steepfile = Pathname(path) }
+          opts.on("--steepfile=PATH") {|path| command.steepfile = Pathname(path) }
           opts.on("--with-expectations[=PATH]", "Type check with expectations saved in PATH (or steep_expectations.yml)") do |path|
-            check.with_expectations_path = Pathname(path || "steep_expectations.yml")
+            command.with_expectations_path = Pathname(path || "steep_expectations.yml")
           end
           opts.on("--save-expectations[=PATH]", "Save expectations with current type check result to PATH (or steep_expectations.yml)") do |path|
-            check.save_expectations_path = Pathname(path || "steep_expectations.yml")
+            command.save_expectations_path = Pathname(path || "steep_expectations.yml")
           end
           opts.on("--severity-level=LEVEL", /^error|warning|information|hint$/, "Specify the minimum diagnostic severity to be recognized as an error (defaults: warning): error, warning, information, or hint") do |level|
-            check.severity_level = level.to_sym
+            command.severity_level = level.to_sym
           end
-          handle_jobs_option check.jobs_option, opts
+          handle_jobs_option command.jobs_option, opts
           handle_logging_options opts
         end.parse!(argv)
 
-        check.command_line_patterns.push *argv
+        setup_jobs_for_ci(command.jobs_option)
+        
+        command.command_line_patterns.push *argv
       end.run
     end
 
     def process_checkfile
-      Drivers::Checkfile.new(stdout: stdout, stderr: stderr).tap do |check|
+      Drivers::Checkfile.new(stdout: stdout, stderr: stderr).tap do |command|
         OptionParser.new do |opts|
           opts.banner = "Usage: steep checkfile [options] [files]"
 
-          opts.on("--steepfile=PATH") {|path| check.steepfile = Pathname(path) }
-          opts.on("--all-rbs", "Type check all RBS files") { check.all_rbs = true }
-          opts.on("--all-ruby", "Type check all Ruby files") { check.all_ruby = true }
+          opts.on("--steepfile=PATH") {|path| command.steepfile = Pathname(path) }
+          opts.on("--all-rbs", "Type check all RBS files") { command.all_rbs = true }
+          opts.on("--all-ruby", "Type check all Ruby files") { command.all_ruby = true }
           opts.on("--stdin", "Read files to type check from stdin") do
             while line = stdin.gets()
               object = JSON.parse(line, symbolize_names: true)
               Steep.logger.info { "Loading content of `#{object[:path]}` from stdin: #{object[:content].lines[0].chomp}" }
-              check.stdin_input[Pathname(object[:path])] = object[:content]
+              command.stdin_input[Pathname(object[:path])] = object[:content]
             end
           end
-          handle_jobs_option check.jobs_option, opts
+          handle_jobs_option command.jobs_option, opts
           handle_logging_options opts
         end.parse!(argv)
 
-        check.command_line_args.push *argv
+        setup_jobs_for_ci(command.jobs_option)
+
+        command.command_line_args.push *argv
       end.run
     end
 
     def process_stats
-      Drivers::Stats.new(stdout: stdout, stderr: stderr).tap do |check|
+      Drivers::Stats.new(stdout: stdout, stderr: stderr).tap do |command|
         OptionParser.new do |opts|
           opts.banner = "Usage: steep stats [options] [sources]"
 
-          opts.on("--steepfile=PATH") {|path| check.steepfile = Pathname(path) }
-          opts.on("--format=FORMAT", "Specify output format: csv, table") {|format| check.format = format }
-          handle_jobs_option check.jobs_option, opts
+          opts.on("--steepfile=PATH") {|path| command.steepfile = Pathname(path) }
+          opts.on("--format=FORMAT", "Specify output format: csv, table") {|format| command.format = format }
+          handle_jobs_option command.jobs_option, opts
           handle_logging_options opts
         end.parse!(argv)
 
-        check.command_line_patterns.push *argv
+        setup_jobs_for_ci(command.jobs_option)
+
+        command.command_line_patterns.push *argv
       end.run
     end
 
@@ -199,6 +217,8 @@ module Steep
           handle_logging_options opts
         end.parse!(argv)
 
+        setup_jobs_for_ci(command.jobs_option)
+
         dirs = argv.map {|dir| Pathname(dir) }
         command.dirs.push(*dirs)
       end.run

data/lib/steep/interface/builder.rb

@@ -766,6 +766,15 @@ module Steep
                 )
               )
             end
+          when :<, :<=
+            case defined_in
+            when RBS::BuiltinNames::Module.name
+              return method_type.with(
+                type: method_type.type.with(
+                  return_type: AST::Types::Logic::ArgIsAncestor.new(location: method_type.type.return_type.location)
+                )
+              )
+            end
           end
         end
 

data/lib/steep/path_helper.rb

@@ -7,6 +7,7 @@ module Steep
       if uri.scheme == "file"
         path = uri.path or raise
         path.sub!(%r{^/([a-zA-Z])(:|%3A)//?}i, '\1:/') if dosish
+        path = URI::DEFAULT_PARSER.unescape(path)
         Pathname(path)
       end
     end
@@ -20,6 +21,7 @@ module Steep
       if dosish
         str_path.insert(0, "/") if str_path[0] != "/"
       end
+      str_path = URI::DEFAULT_PARSER.escape(str_path)
       URI::File.build(path: str_path)
     end
   end

data/lib/steep/server/change_buffer.rb

@@ -61,6 +61,15 @@ module Steep
           end
         end
       end
+
+      def reset_change(uri:, text:)
+        push_buffer do |changes|
+          if path = Steep::PathHelper.to_pathname(uri)
+            path = project.relative_path(path)
+            changes[path] = [Services::ContentChange.new(text: text)]
+          end
+        end
+      end
     end
   end
 end

data/lib/steep/server/delay_queue.rb

@@ -0,0 +1,41 @@
+module Steep
+  module Server
+    class DelayQueue
+      attr_reader :delay, :thread, :queue, :last_task
+
+      def initialize(delay:)
+        @delay = delay
+
+        @queue = Thread::Queue.new
+
+        @thread = Thread.new do
+          while (scheduled_at, proc = queue.pop)
+            # @type var scheduled_at: Time
+            # @type var proc: ^() -> void
+
+            diff = scheduled_at - Time.now
+            case
+            when diff > 0.1
+              sleep diff
+            when diff > 0
+              while Time.now < scheduled_at
+                # nop
+                sleep 0
+              end
+            end
+
+            if proc.equal?(last_task)
+              proc[]
+            end
+          end
+        end
+      end
+
+      def execute(&block)
+        @last_task = block
+        scheduled_at = Time.now + delay
+        queue << [scheduled_at, block]
+      end
+    end
+  end
+end

data/lib/steep/server/interaction_worker.rb

@@ -227,9 +227,11 @@ module Steep
           )
         )
 
+        type_name = sig_service.latest_env.normalize_type_name(type_name)
+
         case type_name.kind
         when :class
-          env = sig_service.latest_env #: RBS::Environment
+          env = sig_service.latest_env
           class_entry = env.module_class_entry(type_name) or raise
 
           case class_entry
@@ -407,7 +409,7 @@ module Steep
             if (items, index = provider.run(line: job.line, column: job.column))
               signatures = items.map do |item|
                 LSP::Interface::SignatureInformation.new(
-                  label: "(#{item.method_type.type.param_to_s})",
+                  label: item.method_type.to_s,
                   parameters: item.parameters.map { |param| LSP::Interface::ParameterInformation.new(label: param)},
                   active_parameter: item.active_parameter,
                   documentation: item.comment&.yield_self do |comment|

data/lib/steep/server/master.rb

@@ -402,6 +402,7 @@ module Steep
 
       attr_reader :initialize_params
       attr_accessor :typecheck_automatically
+      attr_reader :start_type_checking_queue
 
       def initialize(project:, reader:, writer:, interaction_worker:, typecheck_workers:, queue: Queue.new)
         @project = project
@@ -416,6 +417,7 @@ module Steep
 
         @controller = TypeCheckController.new(project: project)
         @result_controller = ResultController.new()
+        @start_type_checking_queue = DelayQueue.new(delay: 0.1)
       end
 
       def start
@@ -488,6 +490,8 @@ module Steep
                     Steep.logger.info { "Processing SendMessageJob: dest=#{job.dest.name}, method=#{job.message[:method] || "-"}, id=#{job.message[:id] || "-"}" }
                     job.dest << job.message
                   end
+                when Proc
+                  job.call()
                 end
               end
             end
@@ -529,6 +533,10 @@ module Steep
         initialize_params&.dig(:capabilities, :window, :workDoneProgress) ? true : false
       end
 
+      def file_system_watcher_supported?
+        initialize_params&.dig(:capabilities, :workspace, :didChangeWatchedFiles, :dynamicRegistration) || false
+      end
+
       def process_message_from_client(message)
         Steep.logger.info "Processing message from client: method=#{message[:method]}, id=#{message[:id]}"
         id = message[:id]
@@ -551,7 +559,6 @@ module Steep
                     capabilities: LSP::Interface::ServerCapabilities.new(
                       text_document_sync: LSP::Interface::TextDocumentSyncOptions.new(
                         change: LSP::Constant::TextDocumentSyncKind::INCREMENTAL,
-                        save: LSP::Interface::SaveOptions.new(include_text: false),
                         open_close: true
                       ),
                       hover_provider: {
@@ -575,6 +582,52 @@ module Steep
                   )
                 }
               )
+
+              if file_system_watcher_supported?
+                patterns = [] #: Array[String]
+                project.targets.each do |target|
+                  target.source_pattern.patterns.each do |pat|
+                    path = project.base_dir + pat
+                    patterns << path.to_s unless path.directory?
+                  end
+                  target.source_pattern.prefixes.each do |pat|
+                    path = project.base_dir + pat
+                    patterns << (path + "**/*.rb").to_s unless path.file?
+                  end
+                  target.signature_pattern.patterns.each do |pat|
+                    path = project.base_dir + pat
+                    patterns << path.to_s unless path.directory?
+                  end
+                  target.signature_pattern.prefixes.each do |pat|
+                    path = project.base_dir + pat
+                    patterns << (path + "**/*.rbs").to_s unless path.file?
+                  end
+                end
+                patterns.sort!
+                patterns.uniq!
+
+                Steep.logger.info { "Setting up didChangeWatchedFiles with pattern: #{patterns.inspect}" }
+
+                job_queue << SendMessageJob.to_client(
+                  message: {
+                    id: SecureRandom.uuid,
+                    method: "client/registerCapability",
+                    params: {
+                      registrations: [
+                        {
+                          id: SecureRandom.uuid,
+                          method: "workspace/didChangeWatchedFiles",
+                          registerOptions: {
+                            watchers: patterns.map do |pattern|
+                              { globPattern: pattern }
+                            end
+                          }
+                        }
+                      ]
+                    }
+                  }
+                )
+              end
             end
           end
 
@@ -585,28 +638,71 @@ module Steep
             end
           end
 
+        when "workspace/didChangeWatchedFiles"
+          message[:params][:changes].each do |change|
+            uri = change[:uri]
+            type = change[:type]
+
+            path = PathHelper.to_pathname(uri) or next
+
+            controller.push_changes(path)
+
+            case type
+            when 1, 2
+              content = path.read
+            when 4
+              # Deleted
+              content = ""
+            end
+
+            broadcast_notification({
+              method: "$/file/reset",
+              params: { uri: uri, content: content }
+            })
+          end
+
+          if typecheck_automatically
+            start_type_checking_queue.execute do
+              job_queue.push(
+                -> do
+                  last_request = current_type_check_request
+                  if request = controller.make_request(last_request: last_request)
+                    start_type_check(request, last_request: last_request, start_progress: request.total > 10)
+                  end
+                end
+              )
+            end
+          end
+
         when "textDocument/didChange"
           if path = pathname(message[:params][:textDocument][:uri])
             broadcast_notification(message)
             controller.push_changes(path)
-          end
 
-        when "textDocument/didSave"
-          if path = pathname(message[:params][:textDocument][:uri])
             if typecheck_automatically
-              if request = controller.make_request(last_request: current_type_check_request)
-                start_type_check(
-                  request,
-                  last_request: current_type_check_request,
-                  start_progress: request.total > 10
+              start_type_checking_queue.execute do
+                job_queue.push(
+                  -> do
+                    last_request = current_type_check_request
+                    if request = controller.make_request(last_request: last_request)
+                      start_type_check(request, last_request: last_request, start_progress: request.total > 10)
+                    end
+                  end
                 )
               end
             end
           end
 
         when "textDocument/didOpen"
-          if path = pathname(message[:params][:textDocument][:uri])
+          uri = message[:params][:textDocument][:uri]
+          text = message[:params][:textDocument][:text]
+
+          if path = pathname(uri)
             controller.update_priority(open: path)
+            broadcast_notification({
+              method: "$/file/reset",
+              params: { uri: uri, content: text }
+            })
           end
 
         when "textDocument/didClose"