steep 0.42.0 → 0.43.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3bed885aa8ba3f60076879eb1ca1572c56ae59aae2a9ee3745affbbd1f3f93d2
-  data.tar.gz: 344c77c6676f8c6772d28bab9598c8fa45835100f24603985750de076ebe57f3
+  metadata.gz: '0568c96d6a39d5c6db14e2259b5cdf3cd39bfaf5f2a4368ce060de4c803c0c96'
+  data.tar.gz: d820c5f0c0d6394893a907999d4fdbd0f3a90b4821380c20598e9251d29852e6
 SHA512:
-  metadata.gz: dce04d256960ee738d029a9c66187a1ef5f11beb3fd0613cbb02dde6494eeafde8aa0bf12aadc02d07bb6a64a785444f18636df1eaa3f1be02bce1d24ad63385
-  data.tar.gz: df9772b46abe7c2acd10cf497ded086b3614016d74b26578d2da6720f26afa01a73a7b43c6a0170b67157e7615e2ec989597ed1081a3f6e4ac69553adc338589
+  metadata.gz: 8f4f17d938d9f7f462f3db8aff1e48f8bf4118ab66bf40b35abd9b38ea3585014a0d8d372277e5589e9697043946b0e646193e4d7413c55fcf490d6065494203
+  data.tar.gz: d7ece354f2e50faa86b65ed4a62c14f97dc74550fb81326142b8932f8c58deb2da40679a34e1869183e15ab4a90e939fb0041c44c63a5149b8234c82058481b0

data/CHANGELOG.md

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

data/lib/steep.rb

@@ -2,7 +2,6 @@ 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"
@@ -15,8 +14,10 @@ require "open3"
 require "stringio"
 require 'uri'
 require "yaml"
+require "securerandom"
 
 require "parallel/processor_count"
+require "terminal-table"
 
 require "rbs"
 
@@ -169,9 +170,9 @@ module Steep
   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
 

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/cli.rb

@@ -113,6 +113,7 @@ 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)

data/lib/steep/diagnostic/ruby.rb

@@ -220,10 +220,6 @@ module Steep
         def header_line
           "The method cannot be called with a block"
         end
-
-        def to_s
-          format_message "method_type=#{method_type}"
-        end
       end
 
       class RequiredBlockMissing < Base
@@ -395,8 +391,8 @@ module Steep
           @method = method
         end
 
-        def to_s
-          format_message "method=#{method}"
+        def header_line
+          "No superclass method `#{method}` defined"
         end
       end
 
@@ -614,6 +610,19 @@ module Steep
           "UnexpectedError: #{error.message}"
         end
       end
+
+      class SyntaxError < Base
+        attr_reader :message
+
+        def initialize(message: ,location:)
+          super(node: nil, location: location)
+          @message = message
+        end
+
+        def header_line
+          "SyntaxError: #{message}"
+        end
+      end
     end
   end
 end

data/lib/steep/diagnostic/signature.rb

@@ -37,19 +37,23 @@ module Steep
           @exception = exception
         end
 
+        def self.parser_syntax_error_message(exception)
+          value = if exception.error_value.is_a?(RBS::Parser::LocatedValue)
+                    exception.error_value.value
+                  else
+                    exception.error_value
+                  end
+          string = value.to_s
+          unless string.empty?
+            string = " (#{string})"
+          end
+
+          "Syntax error caused by token `#{exception.token_str}`#{string}"
+        end
+
         def header_line
           if exception.is_a?(RBS::Parser::SyntaxError)
-            value = if exception.error_value.is_a?(RBS::Parser::LocatedValue)
-                      exception.error_value.value
-                    else
-                      exception.error_value
-                    end
-            string = value.to_s
-            unless string.empty?
-              string = " (#{string})"
-            end
-
-            "Syntax error caused by token `#{exception.token_str}`#{string}"
+            SyntaxError.parser_syntax_error_message(exception)
           else
             exception.message
           end
@@ -271,6 +275,19 @@ module Steep
         end
       end
 
+      class UnexpectedError < Base
+        attr_reader :message
+
+        def initialize(message:, location:)
+          @message = message
+          @location = location
+        end
+
+        def header_line
+          "Unexpected error: #{message}"
+        end
+      end
+
       def self.from_rbs_error(error, factory:)
         case error
         when RBS::Parser::SemanticsError, RBS::Parser::LexerError

data/lib/steep/drivers/annotations.rb

@@ -4,7 +4,6 @@ module Steep
       attr_reader :command_line_patterns
       attr_reader :stdout
       attr_reader :stderr
-      attr_reader :labeling
 
       include Utils::DriverHelper
 
@@ -13,7 +12,6 @@ module Steep
         @stderr = stderr
 
         @command_line_patterns = []
-        @labeling = ASTUtils::Labeling.new
       end
 
       def run
@@ -23,7 +21,7 @@ module Steep
 
         project.targets.each do |target|
           Steep.logger.tagged "target=#{target.name}" do
-            service = Services::SignatureService.load_from(target.new_env_loader)
+            service = Services::SignatureService.load_from(target.new_env_loader(project: project))
 
             sigs = loader.load_changes(target.signature_pattern, changes: {})
             service.update(sigs)

data/lib/steep/drivers/check.rb

@@ -47,16 +47,22 @@ module Steep
           interaction_worker: nil,
           typecheck_workers: typecheck_workers
         )
+        master.typecheck_automatically = false
+        master.commandline_args.push(*command_line_patterns)
 
         main_thread = Thread.start do
           master.start()
         end
         main_thread.abort_on_exception = true
 
-        client_writer.write({ method: :initialize, id: 0 })
+        Steep.logger.info { "Initializing server" }
+        initialize_id = request_id()
+        client_writer.write({ method: :initialize, id: initialize_id, params: {} })
+        wait_for_response_id(reader: client_reader, id: initialize_id)
 
-        shutdown_id = -1
-        client_writer.write({ method: :shutdown, id: shutdown_id })
+        request_guid = SecureRandom.uuid
+        Steep.logger.info { "Starting type checking: #{request_guid}" }
+        client_writer.write({ method: "$/typecheck", params: { guid: request_guid } })
 
         diagnostic_notifications = []
         error_messages = []
@@ -77,14 +83,18 @@ module Steep
             if message[:type] == LSP::Constant::MessageType::ERROR
               error_messages << message[:message]
             end
-          when response[:id] == shutdown_id
-            break
+          when response[:method] == "$/progress"
+            if response[:params][:token] == request_guid
+              if response[:params][:value][:kind] == "end"
+                break
+              end
+            end
           end
         end
 
-        client_writer.write({ method: :exit })
-        client_writer.io.close()
+        Steep.logger.info { "Shutting down..." }
 
+        shutdown_exit(reader: client_reader, writer: client_writer)
         main_thread.join()
 
         stdout.puts

data/lib/steep/drivers/diagnostic_printer.rb

@@ -91,6 +91,10 @@ module Steep
           trailing = ""
         end
 
+        unless subject.valid_encoding?
+          subject.scrub!
+        end
+
         stdout.puts "#{prefix}└ #{leading}#{color_severity(subject, severity: diagnostic[:severity])}#{trailing}"
         stdout.puts "#{prefix}  #{" " * leading.size}#{"~" * subject.size}"
       end

data/lib/steep/drivers/langserver.rb

@@ -47,6 +47,7 @@ module Steep
           interaction_worker: interaction_worker,
           typecheck_workers: typecheck_workers
         )
+        master.typecheck_automatically = true
 
         master.start()
 

data/lib/steep/drivers/print_project.rb

@@ -49,7 +49,7 @@ module Steep
             stdout.puts "      - #{lib}"
           end
           stdout.puts "    library dirs:"
-          target.new_env_loader.tap do |loader|
+          target.new_env_loader(project: project).tap do |loader|
             loader.each_dir do |lib, path|
               case lib
               when :core

data/lib/steep/drivers/stats.rb

@@ -3,9 +3,103 @@ require "csv"
 module Steep
   module Drivers
     class Stats
+      class CSVPrinter
+        attr_reader :io
+
+        def initialize(io:)
+          @io = io
+        end
+
+        def print(stats_result)
+          io.puts(
+            CSV.generate do |csv|
+              csv << ["Target", "File", "Status", "Typed calls", "Untyped calls", "All calls", "Typed %"]
+              stats_result.each do |row|
+                if row[:type] == "success"
+                  csv << [
+                    row[:target],
+                    row[:path],
+                    row[:type],
+                    row[:typed_calls],
+                    row[:untyped_calls],
+                    row[:total_calls],
+                    if row[:total_calls].nonzero?
+                      (row[:typed_calls].to_f / row[:total_calls] * 100).to_i
+                    else
+                      100
+                    end
+                  ]
+                else
+                  csv << [
+                    row[:target],
+                    row[:path],
+                    row[:type],
+                    0,
+                    0,
+                    0,
+                    0
+                  ]
+                end
+              end
+            end
+          )
+        end
+      end
+
+      class TablePrinter
+        attr_reader :io
+
+        def initialize(io:)
+          @io = io
+        end
+
+        def print(stats_result)
+          rows = []
+          stats_result.sort_by {|row| row[:path] }.each do |row|
+            if row[:type] == "success"
+              rows << [
+                row[:target],
+                row[:path] + "  ",
+                row[:type],
+                row[:typed_calls],
+                row[:untyped_calls],
+                row[:total_calls],
+                if row[:total_calls].nonzero?
+                  "#{(row[:typed_calls].to_f / row[:total_calls] * 100).to_i}%"
+                else
+                  "100%"
+                end
+              ]
+            else
+              rows << [
+                row[:target],
+                row[:path],
+                row[:type],
+                0,
+                0,
+                0,
+                "N/A"
+              ]
+            end
+          end
+
+          table = Terminal::Table.new(
+            headings: ["Target", "File", "Status", "Typed calls", "Untyped calls", "All calls", "Typed %"],
+            rows: rows
+          )
+          table.align_column(3, :right)
+          table.align_column(4, :right)
+          table.align_column(5, :right)
+          table.align_column(6, :right)
+          table.style = { border_top: false, border_bottom: false, border_y: "", border_i: "" }
+          io.puts(table)
+        end
+      end
+
       attr_reader :stdout
       attr_reader :stderr
       attr_reader :command_line_patterns
+      attr_accessor :format
 
       include Utils::DriverHelper
       include Utils::JobsCount
@@ -45,15 +139,27 @@ module Steep
           interaction_worker: nil,
           typecheck_workers: typecheck_workers
         )
+        master.typecheck_automatically = false
+        master.commandline_args.push(*command_line_patterns)
 
         main_thread = Thread.start do
           master.start()
         end
         main_thread.abort_on_exception = true
 
-        client_writer.write({ method: :initialize, id: 0 })
+        initialize_id = request_id()
+        client_writer.write({ method: :initialize, id: initialize_id })
+        wait_for_response_id(reader: client_reader, id: initialize_id)
 
-        stats_id = -1
+        typecheck_guid = SecureRandom.uuid
+        client_writer.write({ method: "$/typecheck", params: { guid: typecheck_guid }})
+        wait_for_message(reader: client_reader) do |message|
+          message[:method] == "$/progress" &&
+            message[:params][:token] == typecheck_guid &&
+            message[:params][:value][:kind] == "end"
+        end
+
+        stats_id = request_id()
         client_writer.write(
           {
             id: stats_id,
@@ -61,116 +167,30 @@ module Steep
             params: { command: "steep/stats", arguments: [] }
           })
 
-        stats_result = []
-        client_reader.read do |response|
-          if response[:id] == stats_id
-            stats_result.push(*response[:result])
-            break
-          end
-        end
-
-        shutdown_id = -2
-        client_writer.write({ method: :shutdown, id: shutdown_id })
-
-        client_reader.read do |response|
-          if response[:id] == shutdown_id
-            break
-          end
-        end
+        stats_response = wait_for_response_id(reader: client_reader, id: stats_id)
+        stats_result = stats_response[:result]
 
-        client_writer.write({ method: "exit" })
+        shutdown_exit(reader: client_reader, writer: client_writer)
         main_thread.join()
 
-        stdout.puts(
-          CSV.generate do |csv|
-            csv << ["Target", "File", "Status", "Typed calls", "Untyped calls", "All calls", "Typed %"]
-            stats_result.each do |row|
-              if row[:type] == "success"
-                csv << [
-                  row[:target],
-                  row[:path],
-                  row[:type],
-                  row[:typed_calls],
-                  row[:untyped_calls],
-                  row[:total_calls],
-                  if row[:total_calls].nonzero?
-                    (row[:typed_calls].to_f / row[:total_calls] * 100).to_i
+        printer = case format
+                  when "csv"
+                    CSVPrinter.new(io: stdout)
+                  when "table"
+                    TablePrinter.new(io: stdout)
+                  when nil
+                    if stdout.tty?
+                      TablePrinter.new(io: stdout)
+                    else
+                      CSVPrinter.new(io: stdout)
+                    end
                   else
-                    100
+                    raise ArgumentError.new("Invalid format: #{format}")
                   end
-                ]
-              else
-                csv << [
-                  row[:target],
-                  row[:path],
-                  row[:type],
-                  0,
-                  0,
-                  0,
-                  0
-                ]
-              end
-            end
-          end
-        )
-        #
-        # type_check(project)
-        #
-        # stdout.puts(
-        #   CSV.generate do |csv|
-        #     csv << ["Target", "File", "Status", "Typed calls", "Untyped calls", "All calls", "Typed %"]
-        #
-        #     project.targets.each do |target|
-        #       case (status = target.status)
-        #       when Project::Target::TypeCheckStatus
-        #         status.type_check_sources.each do |source_file|
-        #           case source_file.status
-        #           when Project::SourceFile::TypeCheckStatus
-        #             typing = source_file.status.typing
-        #
-        #             typed = 0
-        #             untyped = 0
-        #             total = 0
-        #             typing.method_calls.each_value do |call|
-        #               case call
-        #               when TypeInference::MethodCall::Typed
-        #                 typed += 1
-        #               when TypeInference::MethodCall::Untyped
-        #                 untyped += 1
-        #               end
-        #
-        #               total += 1
-        #             end
-        #
-        #             csv << format_stats(target, source_file.path, "success", typed, untyped, total)
-        #           when Project::SourceFile::TypeCheckErrorStatus
-        #             csv << format_stats(target, source_file.path, "error", 0, 0, 0)
-        #           else
-        #             csv << format_stats(target, source_file.path, "unknown (#{source_file.status.class.to_s.split(/::/).last})", 0, 0, 0)
-        #           end
-        #         end
-        #       end
-        #     end
-        #   end
-        # )
 
-        0
-      end
+        printer.print(stats_result)
 
-      def format_stats(target, path, status, typed, untyped, total)
-        [
-          target.name,
-          path.to_s,
-          status,
-          typed,
-          untyped,
-          total,
-          if total.nonzero?
-            format("%.2f", (typed.to_f/total)*100)
-          else
-            0
-          end
-        ]
+        0
       end
     end
   end