steep 0.49.1 → 0.50.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 44df04a21f7dc9d7514ad6acb34549f40fe0b4d962840c29ced4ceca926fd000
-  data.tar.gz: 15ac298575e8af8d29c1b1ab5e2894f3e62677dedd58b166d147d3d1649026d3
+  metadata.gz: 6ff552f6d8f112693dc9969f20d851ddbc6d7d2f16cebd45f802a5d703618b58
+  data.tar.gz: 723464fe34c81c3e83b66338dfc6fd3e7c3da2aaf30c1fc48116c7de794ca961
 SHA512:
-  metadata.gz: cdc1e1dea1ef2aa9cebd6d40a850894340e2d0ed26f8a982c81c80d384522712c442a499ef12419b0b224cd1bb659944198b8dc897eea692e4d6c06284c86381
-  data.tar.gz: 22a8d55bd324e3527ffd2a8886bbf7fe28e766ab2dab1e175c43a08b37d256c647f39a05e7890ed5b2726934428bb303c1fe98c45ad07166df2fb2698cc835af
+  metadata.gz: bf9f83791cfb636c65a26f404fb164fa7fc3906376e36a79a1ca4ae7eeab8020e23c5b9ce5e649a38ed79080d0aa2c00fe53a5cce8a1c76c259237f38880bbf2
+  data.tar.gz: 25bd9e11db283acdfc957682860e674d544b82be1b5a68bc87ca96888907966b721301c937cdaa3e06bf0226ec82fa8c78eacfaf4987637a601f75ca8d8e950c

data/CHANGELOG.md

@@ -2,6 +2,16 @@
 
 ## master
 
+# 0.50.0 (2022-03-22)
+
+* CLI option for override steep command at spawn worker ([\#511](https://github.com/soutaro/steep/pull/511))
+* LSP related improvements for Sublime LSP ([\#513](https://github.com/soutaro/steep/pull/513))
+* Support Windows environment ([\#514](https://github.com/soutaro/steep/pull/514))
+* Let `&:foo` proc work with methods with optional parameters ([\#516](https://github.com/soutaro/steep/pull/516))
+* Fix unexpected error when or-asgn/and-asgn ([\#517](https://github.com/soutaro/steep/pull/517))
+* Fix goto-definition from method call inside block ([\#518](https://github.com/soutaro/steep/pull/518))
+* Better splat in array typing ([\#519](https://github.com/soutaro/steep/pull/519))
+
 ## 0.49.1 (2022-03-11)
 
 * Fix lambda typing ([\#506](https://github.com/soutaro/steep/pull/506))

data/Gemfile

@@ -9,4 +9,6 @@ gem "without_steep_types", path: "test/gems/without_steep_types"
 gem "rake"
 gem "minitest", "~> 5.15"
 gem "minitest-hooks"
-gem "stackprof"
+group :stackprof, optional: true do
+  gem "stackprof"
+end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    steep (0.49.1)
+    steep (0.50.0)
       activesupport (>= 5.1)
       language_server-protocol (>= 3.15, < 4.0)
       listen (~> 3.0)
@@ -41,7 +41,7 @@ GEM
     minitest (5.15.0)
     minitest-hooks (1.5.0)
       minitest (> 5.3)
-    parallel (1.21.0)
+    parallel (1.22.0)
     parser (3.1.1.0)
       ast (~> 2.4.1)
     rainbow (3.1.1)

data/lib/steep/cli.rb

@@ -72,6 +72,11 @@ module Steep
       opts.on("-j N", "--jobs=N", "Specify the number of type check workers (defaults: #{default})") do |count|
         command.jobs_count = Integer(count) if Integer(count) > 0
       end
+
+      command.steep_command = "steep"
+      opts.on("--steep-command=COMMAND", "Specify command to exec Steep CLI for worker (defaults: steep)") do |cmd|
+        command.steep_command = cmd
+      end
     end
 
     def process_init

data/lib/steep/drivers/check.rb

@@ -39,6 +39,7 @@ module Steep
           steepfile: project.steepfile_path,
           args: command_line_patterns,
           delay_shutdown: true,
+          steep_command: steep_command,
           count: jobs_count
         )
 

data/lib/steep/drivers/langserver.rb

@@ -37,8 +37,8 @@ module Steep
       def run
         @project = load_config()
 
-        interaction_worker = Server::WorkerProcess.spawn_worker(:interaction, name: "interaction", steepfile: project.steepfile_path)
-        typecheck_workers = Server::WorkerProcess.spawn_typecheck_workers(steepfile: project.steepfile_path, args: [], count: jobs_count)
+        interaction_worker = Server::WorkerProcess.spawn_worker(:interaction, name: "interaction", steepfile: project.steepfile_path, steep_command: steep_command)
+        typecheck_workers = Server::WorkerProcess.spawn_typecheck_workers(steepfile: project.steepfile_path, args: [], steep_command: steep_command, count: jobs_count)
 
         master = Server::Master.new(
           project: project,

data/lib/steep/drivers/stats.rb

@@ -129,6 +129,7 @@ module Steep
           steepfile: project.steepfile_path,
           delay_shutdown: true,
           args: command_line_patterns,
+          steep_command: steep_command,
           count: jobs_count
         )
 

data/lib/steep/drivers/utils/jobs_count.rb

@@ -2,7 +2,7 @@ module Steep
   module Drivers
     module Utils
       module JobsCount
-        attr_accessor :jobs_count
+        attr_accessor :jobs_count, :steep_command
       end
     end
   end

data/lib/steep/drivers/watch.rb

@@ -41,7 +41,7 @@ module Steep
         server_reader = LanguageServer::Protocol::Transport::Io::Reader.new(server_read)
         server_writer = LanguageServer::Protocol::Transport::Io::Writer.new(server_write)
 
-        typecheck_workers = Server::WorkerProcess.spawn_typecheck_workers(steepfile: project.steepfile_path, args: dirs.map(&:to_s), count: jobs_count)
+        typecheck_workers = Server::WorkerProcess.spawn_typecheck_workers(steepfile: project.steepfile_path, args: dirs.map(&:to_s), steep_command: steep_command, count: jobs_count)
 
         master = Server::Master.new(
           project: project,

data/lib/steep/interface/function.rb

@@ -879,6 +879,11 @@ module Steep
           !has_positional? && !has_keywords?
         end
 
+        # Returns true if all arguments are non-required.
+        def optional?
+          required.empty? && required_keywords.empty?
+        end
+
         # self + params returns a new params for overloading.
         #
         def +(other)

data/lib/steep/project.rb

@@ -16,7 +16,21 @@ module Steep
       steepfile_path.parent
     end
 
-    def relative_path(path)
+    def relative_path(orig_path)
+      path = if Gem.win_platform?
+               path_str = URI.decode_www_form_component(
+                 orig_path.to_s.delete_prefix("/")
+               )
+               unless path_str.start_with?(%r{[a-z]:/}i)
+                 # FIXME: Sometimes drive letter is missing, taking from base_dir
+                 path_str = base_dir.to_s.split("/")[0] + "/" + path_str
+               end
+               Pathname.new(
+                 path_str
+               )
+             else
+               orig_path
+             end
       path.relative_path_from(base_dir)
     end
 

data/lib/steep/server/interaction_worker.rb

@@ -89,7 +89,7 @@ module Steep
               end
 
               LSP::Interface::Hover.new(
-                contents: { kind: "markdown", value: format_hover(content) },
+                contents: { kind: "markdown", value: format_hover(content)&.gsub(/<!--(?~-->)-->/, "") },
                 range: range
               )
             end
@@ -271,7 +271,7 @@ HOVER
           ),
           end: LanguageServer::Protocol::Interface::Position.new(
             line: job.line - 1,
-            character: job.column - prefix.size
+            character: job.column
           )
         )
 

data/lib/steep/server/master.rb

@@ -49,9 +49,14 @@ module Steep
         end
 
         def checking_path?(path)
-          library_paths.include?(path) ||
-            signature_paths.include?(path) ||
-            code_paths.include?(path)
+          [library_paths, signature_paths, code_paths].any? do |paths|
+            if Gem.win_platform?
+              # FIXME: Sometimes drive letter is missing, so comparing without drive letter.
+              paths.any? {|p| p.to_s.split("/", 2)[1] == path.to_s.split("/", 2)[1]}
+            else
+              paths.include?(path)
+            end
+          end
         end
 
         def checked(path)
@@ -739,7 +744,7 @@ module Steep
                       { kind: "end" }
                     else
                       progress_string = ("▮"*(percentage/5)) + ("▯"*(20 - percentage/5))
-                      { kind: "report", percentage: percentage, message: "#{progress_string} (#{percentage}%)" }
+                      { kind: "report", percentage: percentage, message: "#{progress_string}" }
                     end
 
             job_queue << SendMessageJob.to_client(

data/lib/steep/server/type_check_worker.rb

@@ -135,6 +135,21 @@ module Steep
       end
 
       def handle_job(job)
+        job_path = if job.respond_to?(:path)
+                     if Gem.win_platform?
+                       # FIXME: Sometimes drive letter is missing, using base_dir
+                       if job.path.to_s.start_with?(%r{/[a-z](:|%3A)/}i)
+                         job.path.to_s
+                       else
+                         "/#{project.base_dir.to_s.split("/").first}/#{job.path}"
+                       end
+                     else
+                       job.path.to_s
+                     end
+                   else
+                     nil
+                   end
+
         case job
         when StartTypeCheckJob
           Steep.logger.info { "Processing StartTypeCheckJob for guid=#{job.guid}" }
@@ -149,7 +164,7 @@ module Steep
               writer.write(
                 method: :"textDocument/publishDiagnostics",
                 params: LSP::Interface::PublishDiagnosticsParams.new(
-                  uri: URI.parse(job.path.to_s).tap {|uri| uri.scheme = "file"},
+                  uri: URI.parse(job_path).tap {|uri| uri.scheme = "file"},
                   diagnostics: diagnostics.map {|diagnostic| formatter.format(diagnostic) }.uniq
                 )
               )
@@ -167,7 +182,7 @@ module Steep
               writer.write(
                 method: :"textDocument/publishDiagnostics",
                 params: LSP::Interface::PublishDiagnosticsParams.new(
-                  uri: URI.parse(job.path.to_s).tap {|uri| uri.scheme = "file"},
+                  uri: URI.parse(job_path).tap {|uri| uri.scheme = "file"},
                   diagnostics: diagnostics.map {|diagnostic| formatter.format(diagnostic) }.uniq.compact
                 )
               )
@@ -186,7 +201,7 @@ module Steep
               writer.write(
                 method: :"textDocument/publishDiagnostics",
                 params: LSP::Interface::PublishDiagnosticsParams.new(
-                  uri: URI.parse(job.path.to_s).tap {|uri| uri.scheme = "file"},
+                  uri: URI.parse(job_path).tap {|uri| uri.scheme = "file"},
                   diagnostics: diagnostics.map {|diagnostic| formatter.format(diagnostic) }.uniq.compact
                 )
               )
@@ -268,7 +283,7 @@ module Steep
         line = job.params[:position][:line] + 1
         column = job.params[:position][:character]
 
-        goto_service = Services::GotoService.new(type_check: service)
+        goto_service = Services::GotoService.new(type_check: service, assignment: assignment)
         locations =
           case
           when job.definition?

data/lib/steep/server/worker_process.rb

@@ -18,13 +18,17 @@ module Steep
         @index = index
       end
 
-      def self.spawn_worker(type, name:, steepfile:, options: [], delay_shutdown: false, index: nil)
-        log_level = %w(debug info warn error fatal unknown)[Steep.logger.level]
+      def self.spawn_worker(type, name:, steepfile:, steep_command: "steep", options: [], delay_shutdown: false, index: nil)
+        args = ["--name=#{name}", "--steepfile=#{steepfile}"]
+        args << (%w(debug info warn error fatal unknown)[Steep.logger.level].yield_self {|log_level| "--log-level=#{log_level}" })
+        if Steep.log_output.is_a?(String)
+          args << "--log-output=#{Steep.log_output}"
+        end
         command = case type
                   when :interaction
-                    ["steep", "worker", "--interaction", "--name=#{name}", "--log-level=#{log_level}", "--steepfile=#{steepfile}", *options]
+                    [steep_command, "worker", "--interaction", *args, *options]
                   when :typecheck
-                    ["steep", "worker", "--typecheck", "--name=#{name}", "--log-level=#{log_level}", "--steepfile=#{steepfile}", *options]
+                    [steep_command, "worker", "--typecheck", *args, *options]
                   else
                     raise "Unknown type: #{type}"
                   end
@@ -33,7 +37,11 @@ module Steep
           command << "--delay-shutdown"
         end
 
-        stdin, stdout, thread = Open3.popen2(*command, pgroup: true)
+        stdin, stdout, thread = if Gem.win_platform?
+                                  Open3.popen2(*command, new_pgroup: true)
+                                else
+                                  Open3.popen2(*command, pgroup: true)
+                                end
         stderr = nil
 
         writer = LanguageServer::Protocol::Transport::Io::Writer.new(stdin)
@@ -42,11 +50,12 @@ module Steep
         new(reader: reader, writer: writer, stderr: stderr, wait_thread: thread, name: name, index: index)
       end
 
-      def self.spawn_typecheck_workers(steepfile:, args:, count: [Etc.nprocessors - 1, 1].max, delay_shutdown: false)
+      def self.spawn_typecheck_workers(steepfile:, args:, steep_command: "steep", count: [Etc.nprocessors - 1, 1].max, delay_shutdown: false)
         count.times.map do |i|
           spawn_worker(:typecheck,
                        name: "typecheck@#{i}",
                        steepfile: steepfile,
+                       steep_command: steep_command,
                        options: ["--max-index=#{count}", "--index=#{i}", *args],
                        delay_shutdown: delay_shutdown,
                        index: i)

data/lib/steep/services/goto_service.rb

@@ -21,10 +21,11 @@ module Steep
       end
       TypeNameQuery = Struct.new(:name, keyword_init: true)
 
-      attr_reader :type_check
+      attr_reader :type_check, :assignment
 
-      def initialize(type_check:)
+      def initialize(type_check:, assignment:)
         @type_check = type_check
+        @assignment = assignment
       end
 
       def project
@@ -78,7 +79,17 @@ module Steep
           end
         end
 
-        locations.uniq
+        # Drop un-assigned paths here.
+        # The path assignment makes sense only for `.rbs` files, because un-assigned `.rb` files are already skipped since they are not type checked.
+        #
+        locations.uniq.select do |loc|
+          case loc
+          when RBS::Location
+            assignment =~ loc.name
+          else
+            true
+          end
+        end
       end
 
       def test_ast_location(loc, line:, column:)
@@ -100,6 +111,7 @@ module Steep
           typing, signature = type_check_path(target: target, path: relative_path, content: source.content, line: line, column: column)
           if typing
             node, *parents = typing.source.find_nodes(line: line, column: column)
+
             if node
               case node.type
               when :const, :casgn
@@ -125,7 +137,10 @@ module Steep
                 end
               when :send
                 if test_ast_location(node.location.selector, line: line, column: column)
-                  node = parents[0] if parents[0]&.type == :block
+                  if (parent = parents[0]) && parent.type == :block && parent.children[0] == node
+                    node = parents[0]
+                  end
+
                   case call = typing.call_of(node: node)
                   when TypeInference::MethodCall::Typed, TypeInference::MethodCall::Error
                     call.method_decls.each do |decl|

data/lib/steep/type_construction.rb

@@ -2275,13 +2275,10 @@ module Steep
               type, constr = synthesize(rhs, hint: hint)
               constr.ivasgn(asgn, type)
             when :send
-              rhs_ = node.updated(:send,
-                                  [
-                                    asgn.children[0],
-                                    :"#{asgn.children[1]}=",
-                                    asgn.children[2],
-                                    rhs
-                                  ])
+              children = asgn.children.dup
+              children[1] = :"#{children[1]}="
+              send_arg_nodes = [*children, rhs]
+              rhs_ = node.updated(:send, send_arg_nodes)
               node_type = case node.type
                           when :or_asgn
                             :or
@@ -2348,11 +2345,11 @@ module Steep
                   interface = calculate_interface(param_type, private: true)
                   method = interface.methods[value.children[0]]
                   if method
-                    return_types = method.method_types.select {|method_type|
-                      method_type.type.params.empty?
-                    }.map {|method_type|
-                      method_type.type.return_type
-                    }
+                    return_types = method.method_types.filter_map do |method_type|
+                      if method_type.type.params.optional?
+                        method_type.type.return_type
+                      end
+                    end
 
                     unless return_types.empty?
                       type = AST::Types::Proc.new(
@@ -2360,7 +2357,7 @@ module Steep
                           params: Interface::Function::Params.empty.with_first_param(
                             Interface::Function::Params::PositionalParams::Required.new(param_type)
                           ),
-                          return_type: AST::Types::Union.build(types: return_types),
+                          return_type: return_types[0],
                           location: nil
                         ),
                         block: nil
@@ -3948,6 +3945,20 @@ module Steep
       constr.add_typing(node, type: AST::Types::Tuple.new(types: element_types))
     end
 
+    def try_convert(type, method)
+      interface = checker.factory.interface(type, private: false)
+      if entry = interface.methods[method]
+        method_type = entry.method_types.find do |method_type|
+          method_type.type.params.optional?
+        end
+
+        method_type.type.return_type
+      end
+    rescue => exn
+      Steep.log_error(exn, message: "Unexpected error when converting #{type.to_s} with #{method}")
+      nil
+    end
+
     def try_array_type(node, hint)
       element_hint = hint ? hint.args[0] : nil
 
@@ -3958,8 +3969,14 @@ module Steep
         case child.type
         when :splat
           type, constr = constr.synthesize(child.children[0], hint: hint)
-          if AST::Builtin::Array.instance_type?(type)
+
+          type = try_convert(type, :to_a) || type
+
+          case
+          when AST::Builtin::Array.instance_type?(type)
             element_types << type.args[0]
+          when type.is_a?(AST::Types::Tuple)
+            element_types.push(*type.types)
           else
             element_types.push(*flatten_array_elements(type))
           end

data/lib/steep/version.rb

@@ -1,3 +1,3 @@
 module Steep
-  VERSION = "0.49.1"
+  VERSION = "0.50.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: steep
 version: !ruby/object:Gem::Version
-  version: 0.49.1
+  version: 0.50.0
 platform: ruby
 authors:
 - Soutaro Matsumoto
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-03-11 00:00:00.000000000 Z
+date: 2022-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser