steep 0.49.1 → 0.52.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 44df04a21f7dc9d7514ad6acb34549f40fe0b4d962840c29ced4ceca926fd000
-  data.tar.gz: 15ac298575e8af8d29c1b1ab5e2894f3e62677dedd58b166d147d3d1649026d3
+  metadata.gz: f6846cc048d7515ef655b81cf7f399e5852a96c390d90c7f859c07cc6a5c0f94
+  data.tar.gz: fecb8b0b0be4e338f3ccf0375064f39167693c0b25b68e3b4ea2f103f117260f
 SHA512:
-  metadata.gz: cdc1e1dea1ef2aa9cebd6d40a850894340e2d0ed26f8a982c81c80d384522712c442a499ef12419b0b224cd1bb659944198b8dc897eea692e4d6c06284c86381
-  data.tar.gz: 22a8d55bd324e3527ffd2a8886bbf7fe28e766ab2dab1e175c43a08b37d256c647f39a05e7890ed5b2726934428bb303c1fe98c45ad07166df2fb2698cc835af
+  metadata.gz: 9c08fa692eda8915ef4ce4fe725aecb2a9823c2da188900a3811fdf1d02c6b0369dae8755aed83fe9cc80a376c3309df29efcf849681cd2a9a249559ff6c3ae2
+  data.tar.gz: 77953f34eb6ab001dfee4f03e0ec1250f1128fedae9e5b427e0037b97b6b809c5bb8ae4c94d9d93f3af3a702de7dd33a182399fe2b7a81ba8ac0d2708c422579

data/CHANGELOG.md

@@ -2,6 +2,28 @@
 
 ## master
 
+## 0.52.0 (2022-04-05)
+
+* Add `steep binstub` command ([\#527](https://github.com/soutaro/steep/pull/527))
+* Let hover and completion work in heredoc ([\#528](https://github.com/soutaro/steep/pull/528))
+* Better constant typing ([\#529](https://github.com/soutaro/steep/pull/529))
+
+## 0.51.0 (2022-04-01)
+
+* Completion for constant ([\#524](https://github.com/soutaro/steep/pull/524))
+* Better hover/completion message ([\#525](https://github.com/soutaro/steep/pull/525))
+* Show available commands when using `--help` ([\#523](https://github.com/soutaro/steep/pull/523))
+
+## 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,7 @@ 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
+gem 'minitest-slow_test'

data/Gemfile.lock

@@ -1,14 +1,14 @@
 PATH
   remote: .
   specs:
-    steep (0.49.1)
+    steep (0.52.0)
       activesupport (>= 5.1)
       language_server-protocol (>= 3.15, < 4.0)
       listen (~> 3.0)
       parallel (>= 1.0.0)
       parser (>= 3.0)
       rainbow (>= 2.2.2, < 4.0)
-      rbs (>= 2.2.0)
+      rbs (>= 2.3.0)
       terminal-table (>= 2, < 4)
 
 PATH
@@ -30,7 +30,7 @@ GEM
       minitest (>= 5.1)
       tzinfo (~> 2.0)
     ast (2.4.2)
-    concurrent-ruby (1.1.9)
+    concurrent-ruby (1.1.10)
     ffi (1.15.5)
     i18n (1.10.0)
       concurrent-ruby (~> 1.0)
@@ -41,7 +41,9 @@ GEM
     minitest (5.15.0)
     minitest-hooks (1.5.0)
       minitest (> 5.3)
-    parallel (1.21.0)
+    minitest-slow_test (0.2.0)
+      minitest (>= 5.0)
+    parallel (1.22.1)
     parser (3.1.1.0)
       ast (~> 2.4.1)
     rainbow (3.1.1)
@@ -49,7 +51,7 @@ GEM
     rb-fsevent (0.11.1)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
-    rbs (2.2.2)
+    rbs (2.3.1)
     stackprof (0.2.19)
     terminal-table (3.0.2)
       unicode-display_width (>= 1.1.1, < 3)
@@ -63,6 +65,7 @@ PLATFORMS
 DEPENDENCIES
   minitest (~> 5.15)
   minitest-hooks
+  minitest-slow_test
   rake
   stackprof
   steep!

data/lib/steep/ast/annotation/collection.rb

@@ -4,7 +4,7 @@ module Steep
       class Collection
         attr_reader :annotations
         attr_reader :factory
-        attr_reader :current_module
+        attr_reader :context
 
         attr_reader :var_type_annotations
         attr_reader :const_type_annotations
@@ -19,10 +19,10 @@ module Steep
         attr_reader :dynamic_annotations
         attr_reader :break_type_annotation
 
-        def initialize(annotations:, factory:, current_module:)
+        def initialize(annotations:, factory:, context:)
           @annotations = annotations
           @factory = factory
-          @current_module = current_module
+          @context = context
 
           @var_type_annotations = {}
           @method_type_annotations = {}
@@ -64,7 +64,7 @@ module Steep
 
         def absolute_type(type)
           if type
-            factory.absolute_type(type, namespace: current_module)
+            factory.absolute_type(type, context: context)
           end
         end
 
@@ -140,7 +140,7 @@ module Steep
         end
 
         def merge_block_annotations(annotations)
-          if annotations.current_module != current_module || annotations.factory != factory
+          if annotations.context != context || annotations.factory != factory
             raise "Cannot merge another annotation: self=#{self}, other=#{annotations}"
           end
 
@@ -148,9 +148,11 @@ module Steep
             annotation.is_a?(BlockType) || annotation.is_a?(BreakType)
           end
 
-          self.class.new(annotations: retained_annotations + annotations.annotations,
-                         factory: factory,
-                         current_module: current_module)
+          self.class.new(
+            annotations: retained_annotations + annotations.annotations,
+            factory: factory,
+            context: context
+          )
         end
 
         def any?(&block)

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

@@ -18,7 +18,7 @@ module Steep
         end
 
         def type_name_resolver
-          @type_name_resolver ||= RBS::TypeNameResolver.from_env(definition_builder.env)
+          @type_name_resolver ||= RBS::Resolver::TypeNameResolver.new(definition_builder.env)
         end
 
         def type_opt(type)
@@ -810,15 +810,15 @@ module Steep
           @env ||= definition_builder.env
         end
 
-        def absolute_type(type, namespace:)
+        def absolute_type(type, context:)
           absolute_type = type_1(type).map_type_name do |name|
-            absolute_type_name(name, namespace: namespace) || name.absolute!
+            absolute_type_name(name, context: context) || name.absolute!
           end
           type(absolute_type)
         end
 
-        def absolute_type_name(type_name, namespace:)
-          type_name_resolver.resolve(type_name, context: namespace.ascend)
+        def absolute_type_name(type_name, context:)
+          type_name_resolver.resolve(type_name, context: context)
         end
 
         def instance_type(type_name, args: nil, location: nil)

data/lib/steep/cli.rb

@@ -18,11 +18,19 @@ module Steep
     end
 
     def self.available_commands
-      [:init, :check, :validate, :annotations, :version, :project, :watch, :langserver, :stats]
+      [:init, :check, :validate, :annotations, :version, :project, :watch, :langserver, :stats, :binstub]
     end
 
     def process_global_options
       OptionParser.new do |opts|
+        opts.banner = <<~USAGE
+          Usage: steep [options]
+
+          available commands: #{CLI.available_commands.join(', ')}
+
+          Options:
+        USAGE
+
         opts.on("--version") do
           process_version
           exit 0
@@ -72,6 +80,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
@@ -195,6 +208,75 @@ module Steep
       end.run
     end
 
+    def process_binstub
+      path = Pathname("bin/steep")
+      force = false
+
+      OptionParser.new do |opts|
+        opts.banner = <<BANNER
+Usage: steep binstub [options]
+
+Generate a binstub to execute Steep with setting up Bundler and rbenv/rvm.
+Use the executable for LSP integration setup.
+
+Options:
+BANNER
+        handle_logging_options opts
+
+        opts.on("-o PATH", "--output=PATH", "The path of the executable file (defaults to `bin/steep`)") do |v|
+          path = Pathname(v)
+        end
+
+        opts.on("--[no-]force", "Overwrite file (defaults to false)") do
+          force = true
+        end
+      end.parse!(argv)
+
+      path.parent.mkpath
+
+      gemfile_path =
+        if defined?(Bundler)
+          Bundler.default_gemfile.relative_path_from(Pathname.pwd + path.parent)
+        else
+          Pathname("../Gemfile")
+        end
+
+      if path.file?
+        if force
+          stdout.puts Rainbow("#{path} already exists. Overwriting...").yellow
+        else
+          stdout.puts Rainbow(''"⚠️ #{path} already exists. Bye! 👋").red
+          return 0
+        end
+      end
+
+      template = <<TEMPLATE
+#!/usr/bin/env bash
+
+BINSTUB_DIR=$(cd $(dirname $0); pwd)
+GEMFILE=${BINSTUB_DIR}/#{gemfile_path}
+
+STEEP="bundle exec --gemfile=${GEMFILE} steep"
+
+if type "rbenv" > /dev/null 2>&1; then
+  STEEP="rbenv exec ${STEEP}"
+else
+  if type "rvm" > /dev/null 2>&1; then
+    STEEP="rvm ${REPO_ROOT} do ${STEEP}"
+  fi
+fi
+
+exec $STEEP $@
+TEMPLATE
+
+      path.write(template)
+      path.chmod(0755)
+
+      stdout.puts Rainbow("Successfully generated executable #{path} 🎉").blue
+
+      0
+    end
+
     def process_version
       stdout.puts Steep::VERSION
       0

data/lib/steep/diagnostic/deprecated/unknown_constant_assigned.rb

@@ -0,0 +1,28 @@
+Steep.logger.error "Diagnostic `Ruby::UnknownConstantAssigned` is deprecated. Use `Ruby::UnknownConstant` instead."
+
+module Steep
+  module Diagnostic
+    module Ruby
+      class UnknownConstantAssigned < Base
+        attr_reader :context
+        attr_reader :name
+
+        def initialize(node:, context:, name:)
+          const = node.children[0]
+          loc = if const
+                  const.loc.expression.join(node.loc.name)
+                else
+                  node.loc.name
+                end
+          super(node: node, location: loc)
+          @context = context
+          @name = name
+        end
+
+        def header_line
+          "Cannot find the declaration of constant `#{name}`"
+        end
+      end
+    end
+  end
+end

data/lib/steep/diagnostic/ruby.rb

@@ -551,27 +551,33 @@ module Steep
         end
       end
 
-      class UnknownConstantAssigned < Base
-        attr_reader :context
+      class UnknownConstant < Base
         attr_reader :name
+        attr_reader :kind
 
-        def initialize(node:, context:, name:)
-          const = node.children[0]
-          loc = if const
-                  const.loc.expression.join(node.loc.name)
-                else
-                  node.loc.name
-                end
-          super(node: node, location: loc)
-          @context = context
+        def initialize(node:, name:)
+          super(node: node, location: node.loc.name)
           @name = name
+          @kind = :constant
+        end
+
+        def class!
+          @kind = :class
+          self
+        end
+
+        def module!
+          @kind = :module
+          self
         end
 
         def header_line
-          "Cannot find the declaration of constant `#{name}`"
+          "Cannot find the declaration of #{kind}: `#{name}`"
         end
       end
 
+      autoload :UnknownConstantAssigned, "steep/diagnostic/deprecated/unknown_constant_assigned"
+
       class FallbackAny < Base
         def initialize(node:)
           super(node: node)
@@ -744,7 +750,7 @@ module Steep
             ImplicitBreakValueMismatch => :warning,
             FallbackAny => :information,
             ElseOnExhaustiveCase => :warning,
-            UnknownConstantAssigned => :warning,
+            UnknownConstant => :warning,
             MethodDefinitionMissing => :information
           }
         ).freeze
@@ -757,7 +763,7 @@ module Steep
             ImplicitBreakValueMismatch => nil,
             FallbackAny => nil,
             ElseOnExhaustiveCase => nil,
-            UnknownConstantAssigned => nil,
+            UnknownConstant => nil,
             MethodDefinitionMissing => nil
           }
         ).freeze
@@ -770,7 +776,7 @@ module Steep
             ImplicitBreakValueMismatch => nil,
             FallbackAny => nil,
             ElseOnExhaustiveCase => nil,
-            UnknownConstantAssigned => nil,
+            UnknownConstant => nil,
             MethodDefinitionMissing => nil,
             UnexpectedJump => nil
           }

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/index/source_index.rb

@@ -16,7 +16,7 @@ module Steep
 
         def add_definition(node)
           case node.type
-          when :casgn, :class, :module
+          when :casgn, :const
             @definitions << node
           else
             raise "Unexpected constant definition: #{node.type}"
@@ -145,6 +145,23 @@ module Steep
           raise
         end
       end
+
+      def reference(constant_node: nil)
+        case
+        when constant_node
+          constant_index.each do |name, entry|
+            if entry.references.include?(constant_node)
+              return name
+            end
+
+            if entry.definitions.include?(constant_node)
+              return name
+            end
+          end
+
+          nil
+        end
+      end
     end
   end
 end

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

@@ -1,12 +1,9 @@
 module Steep
   module ModuleHelper
-    def module_name_from_node(node)
-      case node.type
-      when :const, :casgn
-        namespace = namespace_from_node(node.children[0]) or return
-        name = node.children[1]
-        RBS::TypeName.new(name: name, namespace: namespace)
-      end
+    def module_name_from_node(parent_node, constant_name)
+      namespace = namespace_from_node(parent_node) or return
+      name = constant_name
+      RBS::TypeName.new(name: name, namespace: namespace)
     end
 
     def namespace_from_node(node)

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
@@ -175,6 +175,21 @@ HOVER
           end
 
           string
+        when Services::HoverContent::ConstantContent
+          ss = []
+          if content.class_or_module?
+            ss << ["```rbs", retrieve_decl_information(content.decl.primary.decl), "```"].join("\n")
+          end
+
+          if content.constant?
+            ss << ["```rbs", "#{content.full_name}: #{content.type}", "```"].join("\n")
+          end
+
+          if s = content.comment_string
+            ss << s
+          end
+
+          ss.join("\n\n----\n\n")
         when Services::HoverContent::TypeContent
           "`#{content.type}`"
         end
@@ -271,7 +286,7 @@ HOVER
           ),
           end: LanguageServer::Protocol::Interface::Position.new(
             line: job.line - 1,
-            character: job.column - prefix.size
+            character: job.column
           )
         )
 
@@ -327,7 +342,16 @@ HOVER
         if comment
           LSP::Interface::MarkupContent.new(
             kind: LSP::Constant::MarkupKind::MARKDOWN,
-            value: comment.string
+            value: comment.string.gsub(/<!--(?~-->)-->/, "")
+          )
+        end
+      end
+
+      def format_comments(comments)
+        unless comments.empty?
+          LSP::Interface::MarkupContent.new(
+            kind: LSP::Constant::MarkupKind::MARKDOWN,
+            value: comments.map(&:string).join("\n----\n").gsub(/<!--(?~-->)-->/, "")
           )
         end
       end
@@ -408,6 +432,25 @@ HOVER
               new_text: item.identifier
             )
           )
+        when Services::CompletionProvider::ConstantItem
+          case
+          when item.class? || item.module?
+            kind = LanguageServer::Protocol::Constant::CompletionItemKind::CLASS
+            detail = item.full_name.to_s
+          else
+            kind = LanguageServer::Protocol::Constant::CompletionItemKind::CONSTANT
+            detail = item.type.to_s
+          end
+          LanguageServer::Protocol::Interface::CompletionItem.new(
+            label: item.identifier,
+            kind: kind,
+            detail: detail,
+            documentation: format_comments(item.comments),
+            text_edit: LanguageServer::Protocol::Interface::TextEdit.new(
+              range: range,
+              new_text: item.identifier
+            )
+          )
         when Services::CompletionProvider::MethodNameItem
           method_type_snippet = method_type_to_snippet(item.method_type)
           LanguageServer::Protocol::Interface::CompletionItem.new(
@@ -418,7 +461,7 @@ HOVER
               new_text: "#{item.identifier}#{method_type_snippet}",
               range: range
             ),
-            documentation: item.comment&.string,
+            documentation: format_comment(item.comment),
             insert_text_format: LanguageServer::Protocol::Constant::InsertTextFormat::SNIPPET,
             sort_text: item.inherited? ? 'z' : 'a' # Ensure language server puts non-inherited methods before inherited methods
           )

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)
@@ -496,7 +501,7 @@ module Steep
                         partialResult: true
                       },
                       completion_provider: LSP::Interface::CompletionOptions.new(
-                        trigger_characters: [".", "@"],
+                        trigger_characters: [".", "@", ":"],
                         work_done_progress: true
                       ),
                       workspace_symbol_provider: true,
@@ -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(