steep 0.40.0 → 0.41.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 725a6432404ca94fa643ba89ed2028d7b3923ece4031512ebea88ebbdc4fd01e
-  data.tar.gz: 957a95acbda38474f1a796f829f8cf098b69484a8ddf42bd39e2c2be935a961e
+  metadata.gz: 7fe01659cf0cfc1c7063fede02ec238b5772bb6c6fdf44cf501ca555c719c47c
+  data.tar.gz: d74ebe84a911514eef46cd92a14dfedc0b90e491aa9bf284f82325a9c4a9c2b4
 SHA512:
-  metadata.gz: 363a04610a81d4652541c9e5856705f7317a8b4e92a2074dc460b5f34e19f8eb5bfd080826c3a61a41414668d22d0352e4b300d1ce09c659243ef8c06492fc22
-  data.tar.gz: 33b8d47d5290acea68f1f07ee74a6129ad0a2568fff2ddc783b7910f2ed55ae2d6d6b6f0b1b90b8dea773bfab0c9cc7ccc70723ab5aee75db3e3a0f997b93fe9
+  metadata.gz: cd2459353ab367c913f0308b1cb0dd95d297cce18ea3bb4ff537612edc0b8adc2ef4530d4bf8203c6c777fe57b8bccfbf8a8714ebc0ede67400a030e6ea1348f
+  data.tar.gz: b3ee38f5e340f05420783dc3f8a31ac662f475ec7bcef82222e5f07360faac1235249fa903c721a1d322b7999034b74e7f812fa47c3d3dec8a9f5763fa2693fb

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## master
 
+## 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))

data/bin/output_rebaseline.rb

@@ -9,41 +9,26 @@ else
   test_dirs = ARGV.map {|p| Pathname.pwd + p }
 end
 
-test_dirs.each do |dir|
-  test = dir + "test.yaml"
-
-  if test.file?
-    content = YAML.load_file(test)
-  else
-    content = { "test" => {} }
-  end
+failed_tests = []
 
+test_dirs.each do |dir|
   puts "Rebaselining #{dir}..."
 
-  command = content["command"] || "steep check"
-  puts "  command: #{command}"
-
-  output, _ = Open3.capture2(command, chdir: dir.to_s)
+  command = %w(steep check --save-expectations=test_expectations.yml)
+  puts "  command: #{command.join(" ")}"
 
-  diagnostics = output.split(/\n\n/).each.with_object({}) do |message, hash|
-    if message =~ /\A([^:]+):\d+:\d+:/
-      path = $1
-      hash[path] ||= { "diagnostics" => [] }
-      hash[path]["diagnostics"] << message.chomp + "\n"
-    end
-  end
+  output, status = Open3.capture2(*command, chdir: dir.to_s)
 
-  content["test"].each_key do |path|
-    unless diagnostics.key?(path)
-      diagnostics[path] = { "diagnostics" => [] }
-    end
-  end
-
-  content["test"] = diagnostics.keys.sort.each.with_object({}) do |key, hash|
-    hash[key] = diagnostics[key]
+  unless status.success?
+    puts "Error!!! 👺"
+    failed_tests << dir.basename
   end
+end
 
-  test.open("w") do |io|
-    YAML.dump(content, io, header: false)
-  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

@@ -14,21 +14,27 @@ else
   test_dirs = ARGV.map {|p| Pathname.pwd + p }
 end
 
-success = true
+failed_tests = []
 
 test_dirs.each do |dir|
-  test = dir + "test.yaml"
-
-  next unless test.file?
-
   puts "Running test #{dir}..."
 
-  content = YAML.load_file(test)
+  unless (dir + "test_expectations.yml").file?
+    puts "Skipped ⛹️‍♀️"
+    next
+  end
 
-  command = content["command"] || "steep check"
-  puts "  command: #{command}"
+  command = %w(steep check --with-expectations=test_expectations.yml)
+  puts "  command: #{command.join(" ")}"
 
-  output, _ = Open3.capture2(command, chdir: dir.to_s)
+  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:"
@@ -36,58 +42,12 @@ test_dirs.each do |dir|
       puts "  > #{line.chomp}"
     end
   end
-
-  diagnostics = output.split(/\n\n/).each.with_object({}) do |d, hash|
-    if d =~ /\A([^:]+):\d+:\d+:/
-      path = $1
-      hash[path] ||= []
-      hash[path] << (d.chomp + "\n")
-    end
-  end
-
-  content["test"].each do |path, test|
-    puts "  Checking: #{path}..."
-
-    fail_expected = test["fail"] || false
-
-    expected_diagnostics = test["diagnostics"]
-    reported_diagnostics = (diagnostics[path] || [])
-
-    puts "    # of expected: #{expected_diagnostics.size}, # of reported: #{reported_diagnostics.size}"
-
-    unexpected_diagnostics = reported_diagnostics.reject {|d| expected_diagnostics.include?(d) }
-    missing_diagnostics = expected_diagnostics.reject {|d| reported_diagnostics.include?(d) }
-
-    unexpected_diagnostics.each do |d|
-      puts "    Unexpected diagnostics:"
-      d.split(/\n/).each do |line|
-        puts "      + #{line.chomp}"
-      end
-    end
-
-    missing_diagnostics.each do |d|
-      puts "    Missing diagnostics:"
-      d.split(/\n/).each do |line|
-        puts "      - #{line.chomp}"
-      end
-    end
-
-    if unexpected_diagnostics.empty? && missing_diagnostics.empty?
-      puts "    👍"
-    else
-      if fail_expected
-        puts "    🚨 (expected failure)"
-      else
-        puts "    🚨"
-        success = false
-      end
-    end
-  end
 end
 
-if success
+if failed_tests.empty?
   puts "All tests ok! 👏"
 else
   puts "Errors detected! 🤮"
+  puts "  #{failed_tests.join(", ")}"
   exit 1
 end

data/lib/steep.rb

@@ -4,6 +4,7 @@ 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 +14,7 @@ require "etc"
 require "open3"
 require "stringio"
 require 'uri'
+require "yaml"
 
 require "rbs"
 
@@ -102,6 +104,8 @@ require "steep/project/file_loader"
 require "steep/project/hover_content"
 require "steep/project/completion_provider"
 require "steep/project/stats_calculator"
+
+require "steep/expectations"
 require "steep/drivers/utils/driver_helper"
 require "steep/drivers/check"
 require "steep/drivers/stats"

data/lib/steep/cli.rb

@@ -51,15 +51,15 @@ 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
@@ -83,6 +83,12 @@ module Steep
           opts.banner = "Usage: steep check [options] [sources]"
 
           opts.on("--steepfile=PATH") {|path| check.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")
+          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_logging_options opts
         end.parse!(argv)
 

data/lib/steep/drivers/check.rb

@@ -6,6 +6,8 @@ module Steep
       attr_reader :stdout
       attr_reader :stderr
       attr_reader :command_line_patterns
+      attr_accessor :with_expectations_path
+      attr_accessor :save_expectations_path
 
       include Utils::DriverHelper
 
@@ -57,7 +59,7 @@ module Steep
         shutdown_id = -1
         client_writer.write({ method: :shutdown, id: shutdown_id })
 
-        responses = []
+        diagnostic_notifications = []
         error_messages = []
         client_reader.read do |response|
           case
@@ -68,7 +70,7 @@ module Steep
             else
               stdout.print "F"
             end
-            responses << response[:params]
+            diagnostic_notifications << response[:params]
             stdout.flush
           when response[:method] == "window/showMessage"
             # Assuming ERROR message means unrecoverable error.
@@ -89,30 +91,120 @@ module Steep
         stdout.puts
         stdout.puts
 
-        case
-        when responses.all? {|res| res[:diagnostics].empty? } && error_messages.empty?
+        if error_messages.empty?
+          case
+          when with_expectations_path
+            print_expectations(project: project,
+                               expectations_path: with_expectations_path,
+                               notifications: diagnostic_notifications)
+          when save_expectations_path
+            save_expectations(project: project,
+                              expectations_path: save_expectations_path,
+                              notifications: diagnostic_notifications)
+          else
+            print_result(project: project, notifications: diagnostic_notifications)
+          end
+        else
+          stdout.puts Rainbow("Unexpected error reported. 🚨").red.bold
+          1
+        end
+      end
+
+      def print_expectations(project:, expectations_path:, notifications:)
+        expectations = Expectations.load(path: expectations_path, content: expectations_path.read)
+
+        expected_count = 0
+        unexpected_count = 0
+        missing_count = 0
+
+        ns = notifications.each.with_object({}) do |notification, hash|
+          path = project.relative_path(Pathname(URI.parse(notification[:uri]).path))
+          hash[path] = notification[:diagnostics]
+        end
+
+        (project.all_source_files + project.all_signature_files).sort.each do |path|
+          test = expectations.test(path: path, diagnostics: ns[path] || [])
+
+          buffer = RBS::Buffer.new(name: path, content: path.read)
+          printer = DiagnosticPrinter.new(buffer: buffer, stdout: stdout)
+
+          test.each_diagnostics.each do |type, diag|
+            case type
+            when :expected
+              expected_count += 1
+            when :unexpected
+              unexpected_count += 1
+              printer.print(diag, prefix: Rainbow("+ ").green)
+            when :missing
+              missing_count += 1
+              printer.print(diag, prefix: Rainbow("- ").red)
+            end
+          end
+        end
+
+        if unexpected_count > 0 || missing_count > 0
+          stdout.puts
+
+          stdout.puts Rainbow("Expectations unsatisfied:").bold.red
+          stdout.puts "  #{expected_count} expected #{"diagnostic".pluralize(expected_count)}"
+          stdout.puts Rainbow("  + #{unexpected_count} unexpected #{"diagnostic".pluralize(unexpected_count)}").green
+          stdout.puts Rainbow("  - #{missing_count} missing #{"diagnostic".pluralize(missing_count)}").red
+          1
+        else
+          stdout.puts Rainbow("Expectations satisfied:").bold.green
+          stdout.puts "  #{expected_count} expected #{"diagnostic".pluralize(expected_count)}"
+          0
+        end
+      end
+
+      def save_expectations(project:, expectations_path:, notifications:)
+        expectations = if expectations_path.file?
+                         Expectations.load(path: expectations_path, content: expectations_path.read)
+                       else
+                         Expectations.empty()
+                       end
+
+        ns = notifications.each.with_object({}) do |notification, hash|
+          path = project.relative_path(Pathname(URI.parse(notification[:uri]).path))
+          hash[path] = notification[:diagnostics]
+        end
+
+        (project.all_source_files + project.all_signature_files).sort.each do |path|
+          ds = ns[path] || []
+
+          if ds.empty?
+            expectations.diagnostics.delete(path)
+          else
+            expectations.diagnostics[path] = ds
+          end
+        end
+
+        expectations_path.write(expectations.to_yaml)
+        stdout.puts Rainbow("Saved expectations in #{expectations_path}...").bold
+        0
+      end
+
+      def print_result(project:, notifications:)
+        if notifications.all? {|notification| notification[:diagnostics].empty? }
           emoji = %w(🫖 🫖 🫖 🫖 🫖 🫖 🫖 🫖 🍵 🧋 🧉).sample
           stdout.puts Rainbow("No type error detected. #{emoji}").green.bold
           0
-        when !error_messages.empty?
-          stdout.puts Rainbow("Unexpected error reported. 🚨").red.bold
-          1
         else
-          errors = responses.reject {|res| res[:diagnostics].empty? }
-          total = errors.sum {|res| res[:diagnostics].size }
-          stdout.puts Rainbow("Detected #{total} problems from #{errors.size} files").red.bold
-          stdout.puts
+          errors = notifications.reject {|notification| notification[:diagnostics].empty? }
+          total = errors.sum {|notification| notification[:diagnostics].size }
 
-          errors.each do |resp|
-            path = project.relative_path(Pathname(URI.parse(resp[:uri]).path))
+          errors.each do |notification|
+            path = project.relative_path(Pathname(URI.parse(notification[:uri]).path))
             buffer = RBS::Buffer.new(name: path, content: path.read)
             printer = DiagnosticPrinter.new(buffer: buffer, stdout: stdout)
 
-            resp[:diagnostics].each do |diag|
+            notification[:diagnostics].each do |diag|
               printer.print(diag)
               stdout.puts
             end
           end
+
+          stdout.puts Rainbow("Detected #{total} #{"problem".pluralize(total)} from #{errors.size} #{"file".pluralize(errors.size)}").red.bold
           1
         end
       end

data/lib/steep/drivers/diagnostic_printer.rb

@@ -50,28 +50,28 @@ module Steep
         Rainbow("#{path}:#{start[:line]+1}:#{start[:character]}").magenta
       end
 
-      def print(diagnostic)
+      def print(diagnostic, prefix: "")
         header, *rest = diagnostic[:message].split(/\n/)
 
-        stdout.puts "#{location(diagnostic)}: [#{severity_message(diagnostic[:severity])}] #{Rainbow(header).underline}"
+        stdout.puts "#{prefix}#{location(diagnostic)}: [#{severity_message(diagnostic[:severity])}] #{Rainbow(header).underline}"
 
         unless rest.empty?
           rest.each do |message|
-            stdout.puts "│ #{message}"
+            stdout.puts "#{prefix}│ #{message}"
           end
         end
 
         if diagnostic[:code]
-          stdout.puts "│" unless rest.empty?
-          stdout.puts "│ Diagnostic ID: #{diagnostic[:code]}"
+          stdout.puts "#{prefix}│" unless rest.empty?
+          stdout.puts "#{prefix}│ Diagnostic ID: #{diagnostic[:code]}"
         end
 
-        stdout.puts "│"
+        stdout.puts "#{prefix}│"
 
-        print_source_line(diagnostic)
+        print_source_line(diagnostic, prefix: prefix)
       end
 
-      def print_source_line(diagnostic)
+      def print_source_line(diagnostic, prefix: "")
         start_pos = diagnostic[:range][:start]
         end_pos = diagnostic[:range][:end]
 
@@ -80,14 +80,14 @@ module Steep
         leading = line[0...start_pos[:character]]
         if start_pos[:line] == end_pos[:line]
           subject = line[start_pos[:character]...end_pos[:character]]
-          trailing = line[end_pos[:character]...].chomp
+          trailing = (line[end_pos[:character]...] || "").chomp
         else
           subject = line[start_pos[:character]...].chomp
           trailing = ""
         end
 
-        stdout.puts "└ #{leading}#{color_severity(subject, severity: diagnostic[:severity])}#{trailing}"
-        stdout.puts "  #{" " * leading.size}#{"~" * subject.size}"
+        stdout.puts "#{prefix}└ #{leading}#{color_severity(subject, severity: diagnostic[:severity])}#{trailing}"
+        stdout.puts "#{prefix}  #{" " * leading.size}#{"~" * subject.size}"
       end
     end
   end