steep 0.39.0 → 0.43.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 33c89b6005654ebdc947af336b1c7fa47e02c45c480d27b9f4ef0ab6d3403dd1
-  data.tar.gz: be7b7812e1ba321b91680884fccc55fd57dd5836c89bf7817624b72706490d6e
+  metadata.gz: 7af0aaa9c4c7b0dd2bae9104603131370d976133d866e3d7760c4b2fa581e694
+  data.tar.gz: eb1421e3b07c1f06e427073bb72d55138eda935e2269874f5727eecb035a00fb
 SHA512:
-  metadata.gz: 36945eb5fe4a04061c87bc76488c65ef2b009fcdb8279fd542a1249a10a223cd9571371f333e4ec29870a66dd120c4d9e65d572a9d3c90d56dba5c2c1dd95761
-  data.tar.gz: d9c2e56878f06d71edeb9a10b275c19afd7ba42b1af16ef01ef890ca3791ad4f92f903f7679fcf77b310638b0d0f5fced596e094ec225ff2f567e0f063bfc527
+  metadata.gz: 815776632903ca2679af4ae7e7b4a22fa4388956b56706b862f21d76bea6edbbb928d8423504a99a352db71bf7d777e1148a57fe803b582814f1f1526cc45358
+  data.tar.gz: 70839258fe699f8b246b66cf5e865cb33a9231b5d34e12b40f880bc6b3c50566fe53e0df74645785a3bf1091cbbe34ad4e216ac9d37fdcc3bb3ef32532ab5363

data/.github/workflows/ruby.yml

@@ -16,7 +16,7 @@ jobs:
         - 2.7.0-bionic
         task:
         - test
-        - smoke
+        - test:output
         - build
     container:
       image: rubylang/ruby:${{ matrix.container_tag }}

data/CHANGELOG.md

@@ -2,6 +2,43 @@
 
 ## master
 
+## 0.43.1 (2021-04-01)
+
+* Fix LSP `textDocument/didSave` notification handling ([#368](https://github.com/soutaro/steep/issues/368))
+
+## 0.43.0 (2021-03-30)
+
+* LSP responsiveness improvements ([\#352](https://github.com/soutaro/steep/issues/352))
+* `@implements` annotation in blocks ([#338](https://github.com/soutaro/steep/issues/338))
+* Better `steep stats` table formatting ([\#300](https://github.com/soutaro/steep/issues/300))
+* Fix retry type checking ([\#293](https://github.com/soutaro/steep/issues/293))
+* Better tuple type checking ([\#328](https://github.com/soutaro/steep/issues/328))
+* Fix unexpected `add_call` error ([\#358](https://github.com/soutaro/steep/pull/358))
+* Ignore passing nil as a block `&nil` ([\#356](https://github.com/soutaro/steep/pull/356))
+* Better type checking for non-trivial block parameters ([\#354](https://github.com/soutaro/steep/pull/354))
+* Avoid unexpected error on splat assignments ([\#330](https://github.com/soutaro/steep/pull/330))
+* Fix constraint solver ([\#343](https://github.com/soutaro/steep/pull/343))
+* Ruby 2.7 compatible private method call typing ([\#344](https://github.com/soutaro/steep/pull/344))
+
+## 0.42.0 (2021-03-08)
+
+* Type checking performance improvement ([\#309](https://github.com/soutaro/steep/pull/309), [\#311](https://github.com/soutaro/steep/pull/311), [\#312](https://github.com/soutaro/steep/pull/312), [\#313](https://github.com/soutaro/steep/pull/313), [\#314](https://github.com/soutaro/steep/pull/314), [\#315](https://github.com/soutaro/steep/pull/315), [\#316](https://github.com/soutaro/steep/pull/316), [\#320](https://github.com/soutaro/steep/pull/320), [\#322](https://github.com/soutaro/steep/pull/322))
+* Let `watch` command support files ([\#323](https://github.com/soutaro/steep/pull/323))
+* Validate _module-self-type_ constraints ([\#308](https://github.com/soutaro/steep/pull/308))
+* Add `-j` option to specify number of worker processes ([\#318](https://github.com/soutaro/steep/pull/318), [\#325](https://github.com/soutaro/steep/pull/325))
+* Fix `code` of RBS diagnostics ([\#306](https://github.com/soutaro/steep/pull/306))
+* Skip printing source code from out of date _expectations_ file ([\#305](https://github.com/soutaro/steep/pull/305))
+
+## 0.41.0 (2021-02-07)
+
+* Add `--with-expectations` and `--save-expectations` option ([#303](https://github.com/soutaro/steep/pull/303))
+
+## 0.40.0 (2021-01-31)
+
+* Report progress with dots ([#287](https://github.com/soutaro/steep/pull/287))
+* Diagnostics message improvements ([#297](https://github.com/soutaro/steep/pull/297), [#301](https://github.com/soutaro/steep/pull/301))
+* Fix error on implicit `to_proc` syntax when `untyped` is yielded ([#291](https://github.com/soutaro/steep/pull/291))
+
 ## 0.39.0 (2020-12-25)
 
 * Update RBS to 1.0.0 ([#282](https://github.com/soutaro/steep/pull/282))

data/Rakefile

@@ -9,6 +9,9 @@ end
 
 task :default => :test
 
-task :smoke do
-  sh "bundle", "exec", "bin/smoke_runner.rb", *Dir.glob("smoke/*")
+namespace :test do
+  desc "Run output test"
+  task :output do
+    sh "ruby", "bin/output_test.rb"
+  end
 end

data/bin/output_rebaseline.rb

@@ -0,0 +1,34 @@
+require "pathname"
+require "yaml"
+require "open3"
+require "tempfile"
+
+if ARGV.empty?
+  test_dirs = (Pathname(__dir__) + "../smoke").children
+else
+  test_dirs = ARGV.map {|p| Pathname.pwd + p }
+end
+
+failed_tests = []
+
+test_dirs.each do |dir|
+  puts "Rebaselining #{dir}..."
+
+  command = %w(steep check --save-expectations=test_expectations.yml)
+  puts "  command: #{command.join(" ")}"
+
+  output, status = Open3.capture2(*command, chdir: dir.to_s)
+
+  unless status.success?
+    puts "Error!!! 👺"
+    failed_tests << dir.basename
+  end
+end
+
+if failed_tests.empty?
+  puts "Successfully updated output expectations! 🤡"
+else
+  puts "Failed to update the following tests! 💀"
+  puts "  #{failed_tests.join(", ")}"
+  exit 1
+end

data/bin/output_test.rb

@@ -0,0 +1,53 @@
+require "pathname"
+require "yaml"
+require "open3"
+require "tempfile"
+require "optparse"
+
+OptionParser.new do |opts|
+  opts.on("--verbose", "-v") { @verbose = true }
+end.parse!(ARGV)
+
+if ARGV.empty?
+  test_dirs = (Pathname(__dir__) + "../smoke").children
+else
+  test_dirs = ARGV.map {|p| Pathname.pwd + p }
+end
+
+failed_tests = []
+
+test_dirs.each do |dir|
+  puts "Running test #{dir}..."
+
+  unless (dir + "test_expectations.yml").file?
+    puts "Skipped ⛹️‍♀️"
+    next
+  end
+
+  command = %w(steep check --with-expectations=test_expectations.yml)
+  puts "  command: #{command.join(" ")}"
+
+  output, status = Open3.capture2(*command, chdir: dir.to_s)
+
+  unless status.success?
+    failed_tests << dir.basename
+    puts "  Failed! 🤕"
+  else
+    puts "  Succeed! 👍"
+  end
+
+  if @verbose
+    puts "  Raw output:"
+    output.split(/\n/).each do |line|
+      puts "  > #{line.chomp}"
+    end
+  end
+end
+
+if failed_tests.empty?
+  puts "All tests ok! 👏"
+else
+  puts "Errors detected! 🤮"
+  puts "  #{failed_tests.join(", ")}"
+  exit 1
+end

data/lib/steep.rb

@@ -2,8 +2,8 @@ require "steep/version"
 
 require "pathname"
 require "parser/ruby27"
-require "ast_utils"
 require "active_support/core_ext/object/try"
+require "active_support/core_ext/string/inflections"
 require "logger"
 require "active_support/tagged_logging"
 require "rainbow"
@@ -13,6 +13,11 @@ require "etc"
 require "open3"
 require "stringio"
 require 'uri'
+require "yaml"
+require "securerandom"
+
+require "parallel/processor_count"
+require "terminal-table"
 
 require "rbs"
 
@@ -42,6 +47,8 @@ require "steep/ast/annotation/collection"
 require "steep/ast/builtin"
 require "steep/ast/types/factory"
 
+require "steep/range_extension"
+
 require "steep/interface/function"
 require "steep/interface/block"
 require "steep/interface/method_type"
@@ -56,12 +63,14 @@ require "steep/subtyping/constraints"
 require "steep/subtyping/variable_variance"
 require "steep/subtyping/variable_occurrence"
 
-require "steep/signature/errors"
+require "steep/diagnostic/helper"
+require "steep/diagnostic/ruby"
+require "steep/diagnostic/signature"
+require "steep/diagnostic/lsp_formatter"
 require "steep/signature/validator"
 require "steep/source"
 require "steep/annotation_parser"
 require "steep/typing"
-require "steep/errors"
 require "steep/module_helper"
 require "steep/type_construction"
 require "steep/type_inference/context"
@@ -80,36 +89,43 @@ require "steep/index/rbs_index"
 require "steep/index/signature_symbol_provider"
 require "steep/index/source_index"
 
-require "steep/server/utils"
+require "steep/server/change_buffer"
 require "steep/server/base_worker"
-require "steep/server/code_worker"
-require "steep/server/signature_worker"
 require "steep/server/worker_process"
 require "steep/server/interaction_worker"
+require "steep/server/type_check_worker"
 require "steep/server/master"
 
+require "steep/services/content_change"
+require "steep/services/path_assignment"
+require "steep/services/signature_service"
+require "steep/services/type_check_service"
+require "steep/services/hover_content"
+require "steep/services/completion_provider"
+require "steep/services/stats_calculator"
+require "steep/services/file_loader"
+
 require "steep/project"
-require "steep/project/signature_file"
-require "steep/project/source_file"
+require "steep/project/pattern"
 require "steep/project/options"
 require "steep/project/target"
 require "steep/project/dsl"
-require "steep/project/file_loader"
-require "steep/project/hover_content"
-require "steep/project/completion_provider"
+
+require "steep/expectations"
 require "steep/drivers/utils/driver_helper"
+require "steep/drivers/utils/jobs_count"
 require "steep/drivers/check"
 require "steep/drivers/stats"
 require "steep/drivers/validate"
 require "steep/drivers/annotations"
 require "steep/drivers/watch"
 require "steep/drivers/langserver"
-require "steep/drivers/signature_error_printer"
 require "steep/drivers/trace_printer"
 require "steep/drivers/print_project"
 require "steep/drivers/init"
 require "steep/drivers/vendor"
 require "steep/drivers/worker"
+require "steep/drivers/diagnostic_printer"
 
 if ENV["NO_COLOR"]
   Rainbow.enabled = false
@@ -125,7 +141,7 @@ module Steep
   def self.new_logger(output, prev_level)
     ActiveSupport::TaggedLogging.new(Logger.new(output)).tap do |logger|
       logger.push_tags "Steep #{VERSION}"
-      logger.level = prev_level || Logger::WARN
+      logger.level = prev_level || Logger::ERROR
     end
   end
 
@@ -142,18 +158,80 @@ module Steep
   @logger = nil
   self.log_output = STDERR
 
-  def self.measure(message)
+  def self.measure(message, level: :warn)
     start = Time.now
     yield.tap do
       time = Time.now - start
-      self.logger.info "#{message} took #{time} seconds"
+      if level.is_a?(Symbol)
+        level = Logger.const_get(level.to_s.upcase)
+      end
+      self.logger.log(level) { "#{message} took #{time} seconds" }
     end
   end
 
   def self.log_error(exn, message: "Unexpected error: #{exn.inspect}")
-    Steep.logger.error message
+    Steep.logger.fatal message
     exn.backtrace.each do |loc|
-      Steep.logger.warn "  #{loc}"
+      Steep.logger.error "  #{loc}"
+    end
+  end
+
+  class Sampler
+    def initialize()
+      @samples = []
+    end
+
+    def sample(message)
+      start = Time.now
+      yield.tap do
+        time = Time.now - start
+        @samples << [message, time]
+      end
+    end
+
+    def count
+      @samples.count
+    end
+
+    def total
+      @samples.sum(&:last)
     end
+
+    def slowests(num)
+      @samples.sort_by(&:last).reverse.take(num)
+    end
+
+    def average
+      if count > 0
+        total/count
+      else
+        0
+      end
+    end
+
+    def percentile(p)
+      slowests(count - count * p / 100r).last&.last || 0
+    end
+  end
+
+  def self.measure2(message, level: :warn)
+    sampler = Sampler.new
+    result = yield(sampler)
+
+    if level.is_a?(Symbol)
+      level = Logger.const_get(level.to_s.upcase)
+    end
+    logger.log(level) { "#{sampler.total}secs for \"#{message}\"" }
+    logger.log(level) { "  Average: #{sampler.average}secs"}
+    logger.log(level) { "  Median: #{sampler.percentile(50)}secs"}
+    logger.log(level) { "  Samples: #{sampler.count}"}
+    logger.log(level) { "  99 percentile: #{sampler.percentile(99)}secs"}
+    logger.log(level) { "  90 percentile: #{sampler.percentile(90)}secs"}
+    logger.log(level) { "  10 Slowests:"}
+    sampler.slowests(10).each do |message, time|
+      logger.log(level) { "    #{message} (#{time}secs)"}
+    end
+
+    result
   end
 end

data/lib/steep/annotation_parser.rb

@@ -23,7 +23,15 @@ module Steep
       def initialize(source:, location:, exn: nil)
         @source = source
         @location = location
-        super "Syntax error on annotation: `#{source}`, cause=#{exn.inspect}"
+
+        message = case exn
+                  when RBS::Parser::SyntaxError
+                    Diagnostic::Signature::SyntaxError.parser_syntax_error_message(exn)
+                  else
+                    exn.message
+                  end
+
+        super message
       end
     end
 
@@ -158,7 +166,7 @@ module Steep
         end
       end
 
-    rescue RBS::Parser::SyntaxError, RBS::Parser::SemanticsError => exn
+    rescue RBS::ParsingError => exn
       raise SyntaxError.new(source: src, location: location, exn: exn)
     end
   end

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

@@ -8,6 +8,10 @@ module Steep
           @location = location
         end
 
+        def to_s
+          "class"
+        end
+
         def ==(other)
           other.is_a?(Class)
         end

data/lib/steep/cli.rb

@@ -8,6 +8,8 @@ module Steep
     attr_reader :stderr
     attr_reader :command
 
+    include Parallel::ProcessorCount
+
     def initialize(stdout:, stdin:, stderr:, argv:)
       @stdout = stdout
       @stdin = stdin
@@ -51,19 +53,27 @@ module Steep
     end
 
     def handle_logging_options(opts)
-      opts.on("--log-level=[debug,info,warn,error,fatal]") do |level|
+      opts.on("--log-level=LEVEL", "Specify log level: debug, info, warn, error, fatal") do |level|
         Steep.logger.level = level
       end
 
-      opts.on("--log-output=[PATH]") do |file|
+      opts.on("--log-output=PATH", "Print logs to given path") do |file|
         Steep.log_output = file
       end
 
-      opts.on("--verbose") do
+      opts.on("--verbose", "Set log level to debug") do
         Steep.logger.level = Logger::DEBUG
       end
     end
 
+    def handle_jobs_option(command, opts, modifier = 0)
+      default = physical_processor_count + modifier
+      command.jobs_count = default
+      opts.on("-j N", "--jobs=N", "Specify the number of type check workers (defaults: #{default})") do |count|
+        command.jobs_count = Integer(count)
+      end
+    end
+
     def process_init
       Drivers::Init.new(stdout: stdout, stderr: stderr).tap do |command|
         OptionParser.new do |opts|
@@ -83,7 +93,13 @@ module Steep
           opts.banner = "Usage: steep check [options] [sources]"
 
           opts.on("--steepfile=PATH") {|path| check.steepfile = Pathname(path) }
-          opts.on("--dump-all-types") { check.dump_all_types = true }
+          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")
+          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")
+          end
+          handle_jobs_option check, opts
           handle_logging_options opts
         end.parse!(argv)
 
@@ -97,6 +113,8 @@ module Steep
           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, opts
           handle_logging_options opts
         end.parse!(argv)
 
@@ -137,10 +155,12 @@ module Steep
       Drivers::Watch.new(stdout: stdout, stderr: stderr).tap do |command|
         OptionParser.new do |opts|
           opts.banner = "Usage: steep watch [options] [dirs]"
+          handle_jobs_option command, opts
           handle_logging_options opts
         end.parse!(argv)
 
-        command.dirs.push *argv
+        dirs = argv.map {|dir| Pathname(dir) }
+        command.dirs.push(*dirs)
       end.run
     end
 
@@ -148,6 +168,7 @@ module Steep
       Drivers::Langserver.new(stdout: stdout, stderr: stderr, stdin: stdin).tap do |command|
         OptionParser.new do |opts|
           opts.on("--steepfile=PATH") {|path| command.steepfile = Pathname(path) }
+          handle_jobs_option command, opts, -1
           handle_logging_options opts
         end.parse!(argv)
       end.run
@@ -180,11 +201,15 @@ module Steep
           handle_logging_options opts
 
           opts.on("--interaction") { command.worker_type = :interaction }
-          opts.on("--code") { command.worker_type = :code }
-          opts.on("--signature") { command.worker_type = :signature }
+          opts.on("--typecheck") { command.worker_type = :typecheck }
           opts.on("--steepfile=PATH") {|path| command.steepfile = Pathname(path) }
           opts.on("--name=NAME") {|name| command.worker_name = name }
+          opts.on("--delay-shutdown") { command.delay_shutdown = true }
+          opts.on("--max-index=COUNT") {|count| command.max_index = Integer(count) }
+          opts.on("--index=INDEX") {|index| command.index = Integer(index) }
         end.parse!(argv)
+
+        command.commandline_args.push(*argv)
       end.run
     end
   end