steep 0.50.0 → 0.52.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ff552f6d8f112693dc9969f20d851ddbc6d7d2f16cebd45f802a5d703618b58
-  data.tar.gz: 723464fe34c81c3e83b66338dfc6fd3e7c3da2aaf30c1fc48116c7de794ca961
+  metadata.gz: c373c6a4366397b2b014850a8993ce6d8a0c27bcdd8bc8c5135bb64b4132b162
+  data.tar.gz: '097245d5e3745ceb634a2f2bcd007cca0c549449c835b644feb62c23c3c6e3ed'
 SHA512:
-  metadata.gz: bf9f83791cfb636c65a26f404fb164fa7fc3906376e36a79a1ca4ae7eeab8020e23c5b9ce5e649a38ed79080d0aa2c00fe53a5cce8a1c76c259237f38880bbf2
-  data.tar.gz: 25bd9e11db283acdfc957682860e674d544b82be1b5a68bc87ca96888907966b721301c937cdaa3e06bf0226ec82fa8c78eacfaf4987637a601f75ca8d8e950c
+  metadata.gz: eadc49c7c81bce14e4e4c5f9adbcb0411669cd1f78eb290029953e26ea3997d15a65db53329124812e841f3fbe486d30f25bbf89d7bce74d528692176250c795
+  data.tar.gz: 3257fa14e2888e68afd6266e1c1d28dc95b8ef7e1ec499393994f35cb715abfc133f005d0ce79962fc6642f7fdeb0b28c35fa0d3bb5687972ea1b31d0a9d6c38

data/.github/dependabot.yml

@@ -1,8 +1,15 @@
 version: 2
+
 updates:
-- package-ecosystem: bundler
-  directory: "/"
-  schedule:
-    interval: daily
-    time: "20:00"
-  open-pull-requests-limit: 10
+  - package-ecosystem: bundler
+    directory: "/"
+    schedule:
+      interval: daily
+      time: "20:00"
+    open-pull-requests-limit: 10
+
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      # Check for updates to GitHub Actions every weekday
+      interval: "daily"

data/.github/workflows/ruby.yml

@@ -14,6 +14,7 @@ jobs:
         container_tag:
         - "2.7"
         - "3.0"
+        - "3.1"
         - "master-nightly-focal"
         task:
         - test
@@ -22,9 +23,10 @@ jobs:
     container:
       image: rubylang/ruby:${{ matrix.container_tag }}
     steps:
-    - uses: actions/checkout@v1
+    - uses: actions/checkout@v3
     - name: Run test
       run: |
+        git config --global --add safe.directory /__w/steep/steep
         ruby -v
         gem install bundler
         bundle install --jobs 4 --retry 3

data/CHANGELOG.md

@@ -2,7 +2,26 @@
 
 ## master
 
-# 0.50.0 (2022-03-22)
+## 0.52.1 (2022-04-25)
+
+* Better union type inference (it type checks `Array#filter_map` now!) ([\#531](https://github.com/soutaro/steep/pull/531))
+* Improve method call hover message ([\#537](https://github.com/soutaro/steep/pull/537), [\#538](https://github.com/soutaro/steep/pull/538))
+* Make `NilClass#!` a special method to improve flow-sensitive typing ([\#539](https://github.com/soutaro/steep/pull/539))
+* Fix `steep binstub` ([\#540](https://github.com/soutaro/steep/pull/540), [\#541](https://github.com/soutaro/steep/pull/541))
+
+## 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))

data/Gemfile

@@ -12,3 +12,4 @@ gem "minitest-hooks"
 group :stackprof, optional: true do
   gem "stackprof"
 end
+gem 'minitest-slow_test'

data/Gemfile.lock

@@ -1,14 +1,14 @@
 PATH
   remote: .
   specs:
-    steep (0.50.0)
+    steep (0.52.1)
       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.2)
       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,15 +41,17 @@ GEM
     minitest (5.15.0)
     minitest-hooks (1.5.0)
       minitest (> 5.3)
-    parallel (1.22.0)
-    parser (3.1.1.0)
+    minitest-slow_test (0.2.0)
+      minitest (>= 5.0)
+    parallel (1.22.1)
+    parser (3.1.2.0)
       ast (~> 2.4.1)
     rainbow (3.1.1)
     rake (13.0.6)
     rb-fsevent (0.11.1)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
-    rbs (2.2.2)
+    rbs (2.3.2)
     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)
@@ -431,7 +431,8 @@ module Steep
               case defined_in
               when RBS::BuiltinNames::BasicObject.name,
                 RBS::BuiltinNames::TrueClass.name,
-                RBS::BuiltinNames::FalseClass.name
+                RBS::BuiltinNames::FalseClass.name,
+                AST::Builtin::NilClass.module_name
                 return method_type.with(
                   type: method_type.type.with(
                     return_type: AST::Types::Logic::Not.new(location: method_type.type.return_type.location)
@@ -810,15 +811,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
@@ -200,6 +208,84 @@ module Steep
       end.run
     end
 
+    def process_binstub
+      path = Pathname("bin/steep")
+      root_path = Pathname.pwd
+      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("--root=PATH", "The repository root path (defaults to `.`)") do |v|
+          root_path = (Pathname.pwd + v).cleanpath
+        end
+
+        opts.on("--[no-]force", "Overwrite file (defaults to false)") do
+          force = true
+        end
+      end.parse!(argv)
+
+      binstub_path = (Pathname.pwd + path).cleanpath
+      bindir_path = binstub_path.parent
+
+      bindir_path.mkpath
+
+      gemfile_path =
+        if defined?(Bundler)
+          Bundler.default_gemfile.relative_path_from(bindir_path)
+        else
+          Pathname("../Gemfile")
+        end
+
+      if binstub_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=$(readlink -f ${BINSTUB_DIR}/#{gemfile_path})
+ROOT_DIR=$(readlink -f ${BINSTUB_DIR}/#{root_path.relative_path_from(bindir_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 ${ROOT_DIR} do ${STEEP}"
+  fi
+fi
+
+exec $STEEP $@
+TEMPLATE
+
+      binstub_path.write(template)
+      binstub_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/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/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)