steep 0.41.0 → 0.42.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7fe01659cf0cfc1c7063fede02ec238b5772bb6c6fdf44cf501ca555c719c47c
-  data.tar.gz: d74ebe84a911514eef46cd92a14dfedc0b90e491aa9bf284f82325a9c4a9c2b4
+  metadata.gz: 3bed885aa8ba3f60076879eb1ca1572c56ae59aae2a9ee3745affbbd1f3f93d2
+  data.tar.gz: 344c77c6676f8c6772d28bab9598c8fa45835100f24603985750de076ebe57f3
 SHA512:
-  metadata.gz: cd2459353ab367c913f0308b1cb0dd95d297cce18ea3bb4ff537612edc0b8adc2ef4530d4bf8203c6c777fe57b8bccfbf8a8714ebc0ede67400a030e6ea1348f
-  data.tar.gz: b3ee38f5e340f05420783dc3f8a31ac662f475ec7bcef82222e5f07360faac1235249fa903c721a1d322b7999034b74e7f812fa47c3d3dec8a9f5763fa2693fb
+  metadata.gz: dce04d256960ee738d029a9c66187a1ef5f11beb3fd0613cbb02dde6494eeafde8aa0bf12aadc02d07bb6a64a785444f18636df1eaa3f1be02bce1d24ad63385
+  data.tar.gz: df9772b46abe7c2acd10cf497ded086b3614016d74b26578d2da6720f26afa01a73a7b43c6a0170b67157e7615e2ec989597ed1081a3f6e4ac69553adc338589

data/CHANGELOG.md

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

data/lib/steep.rb

@@ -16,6 +16,8 @@ require "stringio"
 require 'uri'
 require "yaml"
 
+require "parallel/processor_count"
+
 require "rbs"
 
 require "steep/method_name"
@@ -86,27 +88,31 @@ 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/project/stats_calculator"
 
 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"
@@ -134,7 +140,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
 
@@ -151,11 +157,14 @@ 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
 
@@ -165,4 +174,63 @@ module Steep
       Steep.logger.warn "  #{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/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
@@ -64,6 +66,14 @@ module Steep
       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|
@@ -89,6 +99,7 @@ module Steep
           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)
 
@@ -102,6 +113,7 @@ module Steep
           opts.banner = "Usage: steep stats [options] [sources]"
 
           opts.on("--steepfile=PATH") {|path| check.steepfile = Pathname(path) }
+          handle_jobs_option check, opts
           handle_logging_options opts
         end.parse!(argv)
 
@@ -142,10 +154,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
 
@@ -153,6 +167,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
@@ -185,12 +200,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

data/lib/steep/diagnostic/ruby.rb

@@ -613,10 +613,6 @@ module Steep
         def header_line
           "UnexpectedError: #{error.message}"
         end
-
-        def detail_lines
-          error.backtrace.join("\n")
-        end
       end
     end
   end

data/lib/steep/diagnostic/signature.rb

@@ -21,7 +21,7 @@ module Steep
         end
 
         def diagnostic_code
-          "Ruby::#{error_name}"
+          "RBS::#{error_name}"
         end
 
         def path
@@ -38,7 +38,21 @@ module Steep
         end
 
         def header_line
-          "Syntax error: #{exception.message}"
+          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}"
+          else
+            exception.message
+          end
         end
       end
 
@@ -219,6 +233,125 @@ module Steep
           "The variance of type parameter `#{param.name}` is #{param.variance}, but used in incompatible position here"
         end
       end
+
+      class ModuleSelfTypeError < Base
+        attr_reader :name
+        attr_reader :ancestor
+        attr_reader :relation
+
+        def initialize(name:, ancestor:, relation:, location:)
+          super(location: location)
+
+          @name = name
+          @ancestor = ancestor
+          @relation = relation
+        end
+
+        def header_line
+          "Module self type constraint in type `#{name}` doesn't satisfy: `#{relation}`"
+        end
+      end
+
+      class InstanceVariableTypeError < Base
+        attr_reader :name
+        attr_reader :variable
+        attr_reader :var_type
+        attr_reader :parent_type
+
+        def initialize(name:, location:, var_type:, parent_type:)
+          super(location: location)
+
+          @name = name
+          @var_type = var_type
+          @parent_type = parent_type
+        end
+
+        def header_line
+          "Instance variable cannot have different type with parents: #{var_type} <=> #{parent_type}"
+        end
+      end
+
+      def self.from_rbs_error(error, factory:)
+        case error
+        when RBS::Parser::SemanticsError, RBS::Parser::LexerError
+          Diagnostic::Signature::SyntaxError.new(error, location: error.location)
+        when RBS::Parser::SyntaxError
+          Diagnostic::Signature::SyntaxError.new(error, location: error.error_value.location)
+        when RBS::DuplicatedDeclarationError
+          Diagnostic::Signature::DuplicatedDeclaration.new(
+            type_name: error.name,
+            location: error.decls[0].location
+          )
+        when RBS::GenericParameterMismatchError
+          Diagnostic::Signature::GenericParameterMismatch.new(
+            name: error.name,
+            location: error.decl.location
+          )
+        when RBS::InvalidTypeApplicationError
+          Diagnostic::Signature::InvalidTypeApplication.new(
+            name: error.type_name,
+            args: error.args.map {|ty| factory.type(ty) },
+            params: error.params,
+            location: error.location
+          )
+        when RBS::NoTypeFoundError,
+          RBS::NoSuperclassFoundError,
+          RBS::NoMixinFoundError,
+          RBS::NoSelfTypeFoundError
+          Diagnostic::Signature::UnknownTypeName.new(
+            name: error.type_name,
+            location: error.location
+          )
+        when RBS::InvalidOverloadMethodError
+          Diagnostic::Signature::InvalidMethodOverload.new(
+            class_name: error.type_name,
+            method_name: error.method_name,
+            location: error.members[0].location
+          )
+        when RBS::DuplicatedMethodDefinitionError
+          Diagnostic::Signature::DuplicatedMethodDefinition.new(
+            class_name: error.type_name,
+            method_name: error.method_name,
+            location: error.location
+          )
+        when RBS::DuplicatedInterfaceMethodDefinitionError
+          Diagnostic::Signature::DuplicatedMethodDefinition.new(
+            class_name: error.type_name,
+            method_name: error.method_name,
+            location: error.member.location
+          )
+        when RBS::UnknownMethodAliasError
+          Diagnostic::Signature::UnknownMethodAlias.new(
+            class_name: error.type_name,
+            method_name: error.original_name,
+            location: error.location
+          )
+        when RBS::RecursiveAliasDefinitionError
+          Diagnostic::Signature::RecursiveAlias.new(
+            class_name: error.type.name,
+            names: error.defs.map(&:name),
+            location: error.defs[0].original.location
+          )
+        when RBS::RecursiveAncestorError
+          Diagnostic::Signature::RecursiveAncestor.new(
+            ancestors: error.ancestors,
+            location: error.location
+          )
+        when RBS::SuperclassMismatchError
+          Diagnostic::Signature::SuperclassMismatch.new(
+            name: error.name,
+            location: error.entry.primary.decl.location
+          )
+        when RBS::InvalidVarianceAnnotationError
+          Diagnostic::Signature::InvalidVarianceAnnotation.new(
+            name: error.type_name,
+            param: error.param,
+            location: error.location
+          )
+        else
+          raise error
+        end
+      end
     end
   end
 end

data/lib/steep/drivers/annotations.rb

@@ -19,50 +19,34 @@ module Steep
       def run
         project = load_config()
 
-        loader = Project::FileLoader.new(project: project)
-        loader.load_sources(command_line_patterns)
-        loader.load_signatures()
+        loader = Services::FileLoader.new(base_dir: project.base_dir)
 
         project.targets.each do |target|
           Steep.logger.tagged "target=#{target.name}" do
-            target.load_signatures(validate: false) do |_, subtyping, _|
-              case (status = target.status)
-              when nil     # status set on error cases
-                target.source_files.each_value do |file|
-                  file.parse(subtyping.factory) do |source|
-                    source.each_annotation.sort_by {|node, _| [node.loc.expression.begin_pos, node.loc.expression.end_pos] }.each do |node, annotations|
-                      loc = node.loc
-                      stdout.puts "#{file.path}:#{loc.line}:#{loc.column}:#{node.type}:\t#{node.loc.expression.source.lines.first}"
-                      annotations.each do |annotation|
-                        stdout.puts "  #{annotation.location.source}"
-                      end
-                    end
-                  end
-                end
-              when Project::Target::SignatureErrorStatus
-                formatter = Diagnostic::LSPFormatter.new
-                diagnostics = status.errors.group_by {|e| e.location.buffer }.transform_values do |errors|
-                  errors.map {|error| formatter.format(error) }
-                end
+            service = Services::SignatureService.load_from(target.new_env_loader)
+
+            sigs = loader.load_changes(target.signature_pattern, changes: {})
+            service.update(sigs)
+
+            factory = AST::Types::Factory.new(builder: service.latest_builder)
+
+            srcs = loader.load_changes(target.source_pattern, command_line_patterns, changes: {})
+            srcs.each do |path, changes|
+              text = changes.inject("") {|text, change| change.apply_to(text) }
+              source = Source.parse(text, path: path, factory: factory)
 
-                diagnostics.each do |buffer, ds|
-                  printer = DiagnosticPrinter.new(stdout: stdout, buffer: buffer)
-                  ds.each do |d|
-                    printer.print(d)
-                    stdout.puts
-                  end
+              source.each_annotation.sort_by {|node, _| [node.loc.expression.begin_pos, node.loc.expression.end_pos] }.each do |node, annotations|
+                loc = node.loc
+                stdout.puts "#{path}:#{loc.line}:#{loc.column}:#{node.type}:\t#{node.loc.expression.source.lines.first}"
+                annotations.each do |annotation|
+                  stdout.puts "  #{annotation.location.source}"
                 end
               end
             end
           end
         end
 
-        project.targets.each do |target|
-          Steep.logger.tagged "target=#{target.name}" do
-          end
-        end
-
-        project.targets.all? {|target| !target.status } ? 0 : 1
+        0
       end
     end
   end