steep 1.0.2 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8317c379e5b7e85cca4a22c9133248a77a112e7687c3cf553ddb90f96ab31236
-  data.tar.gz: cd9c06372e29c009b4af99a5f0c252dcdbdcc9d2905cbd601cffb7210f809c93
+  metadata.gz: a82e5deea68aec9ddc24d1ff5c4872ea0c2fd1d00a6098056e144bc932fba5bf
+  data.tar.gz: 2e55a0e505ab5ff267c911b53828f7de2159ae1ac443401a962c1d77c8cda294
 SHA512:
-  metadata.gz: 7b0cfaee1dac3cdc8a69d9ef50714615647c1049783d6406d6ee3246c11a5cb2b5e4287f42a896d13e9ed6411e092acf15406199a0f6f0e3bad412f0ae12e250
-  data.tar.gz: a8b8192a8e6217eff958d30ac12c9aa1cbf9608626c892c9ae9585e33c9241d5a75e760060271e15f60f9869ceab41e9ff2fab38920db9692aa4f1ec296d1257
+  metadata.gz: 3d572d7d6f4908286a5714cfe029930a749a0437d5f88663b3c85f86bf14a60f2de0f53320177b6749d235ed384576cfbfc21f6954873fa4fcc29d4132a24880
+  data.tar.gz: 7319b4110d5f5ad465f0a84a4052c7c542ed5c0f2da5bd8e378247a75883ecc62fecfb16d3da215f9e017ade5045cffa56cff3d5eaaaeeb59c602035113af370

data/.github/workflows/ruby.yml

@@ -11,6 +11,7 @@ jobs:
     strategy:
       matrix:
         container_tag:
+        - "2.6"
         - "2.7"
         - "3.0"
         - "3.1"
@@ -24,6 +25,10 @@ jobs:
       image: rubylang/ruby:${{ matrix.container_tag }}
     steps:
     - uses: actions/checkout@v3
+    - name: Reset bundler
+      run: |
+        rm Gemfile.lock Gemfile.steep.lock
+      if: contains(matrix.container_tag, '2.6')
     - name: Run test
       run: |
         git config --global --add safe.directory /__w/steep/steep

data/.gitignore

@@ -9,3 +9,4 @@
 /lib/steep/parser.output
 /lib/steep/parser.rb
 /log
+/.gem_rbs_collection

data/CHANGELOG.md

@@ -2,11 +2,43 @@
 
 ## master
 
+## 1.1.1 (2022-07-31)
+
+### Type checker core
+
+* Ignore special local variables -- `_`, `__any__` and `__skip__` ([#617](https://github.com/soutaro/steep/pull/617), [#627](https://github.com/soutaro/steep/pull/627))
+* Fix type narrowing on assignments ([#622](https://github.com/soutaro/steep/pull/622))
+
+## 1.1.0 (2022-07-27)
+
+### Type checker core
+
+* Fix `#each_child_node` ([#612](https://github.com/soutaro/steep/pull/612))
+
+## 1.1.0.pre.1 (2022-07-26)
+
+### Type checker core
+
+* Type refinement with method calls ([#590](https://github.com/soutaro/steep/issues/590))
+* Better multiple assignment type checking ([\#605](https://github.com/soutaro/steep/pull/605))
+* Fix generics issues around proc types ([\#609](https://github.com/soutaro/steep/pull/609), [\#611](https://github.com/soutaro/steep/pull/611))
+* Fix type application validation ([#607](https://github.com/soutaro/steep/pull/607); backport from 1.0.2)
+* Add class variable validation ([\#593](https://github.com/soutaro/steep/pull/593))
+* Fix type application validation ([\#607](https://github.com/soutaro/steep/pull/607))
+
+### Commandline tool
+
+* Appends "done!" to the watch output when the type check is complete ([\#596](https://github.com/soutaro/steep/pull/596))
+
+### Language server
+
+* Fix hover on multiple assignment ([\#606](https://github.com/soutaro/steep/pull/606))
+
 ## 1.0.2 (2022-07-19)
 
 This is another patch release for Steep 1.0.
 
-### Type checker
+### Type checker core
 
 * Fix type application validation ([#607](https://github.com/soutaro/steep/pull/607))
 
@@ -16,7 +48,7 @@ This is the first patch release for Steep 1.0.
 However, this release includes one non-trivial type system update, [\#570](https://github.com/soutaro/steep/pull/570), which adds a special typing rule for `Hash#compact` like `Array#compact`.
 The change will make type checking more permissive and precise, so no new error won't be reported with the fix.
 
-### Type checker
+### Type checker core
 
 * Support shorthand hash for Ruby 3.1 ([\#567](https://github.com/soutaro/steep/pull/567))
 * Fix super and zsuper with block ([\#568](https://github.com/soutaro/steep/pull/568))
@@ -30,7 +62,7 @@ The change will make type checking more permissive and precise, so no new error
 * Type check `gvar` and `gvasgn` in methods([\#579](https://github.com/soutaro/steep/pull/579))
 * Avoid `UnexpectedError` when assigning untyped singleton class ([\#586](https://github.com/soutaro/steep/pull/586))
 
-### Tool
+### Commandline tool
 
 * Improve Windows support ([\#561](https://github.com/soutaro/steep/pull/561), [\#573](https://github.com/soutaro/steep/pull/573))
 * Test if `.ruby-version` exists before `rvm do` in binstub ([\#558](https://github.com/soutaro/steep/pull/558))

data/Gemfile

@@ -3,9 +3,6 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in steep.gemspec
 gemspec
 
-gem "with_steep_types", path: "test/gems/with_steep_types"
-gem "without_steep_types", path: "test/gems/without_steep_types"
-
 gem "rake"
 gem "minitest", "~> 5.16"
 gem "minitest-hooks"
@@ -13,3 +10,9 @@ group :stackprof, optional: true do
   gem "stackprof"
 end
 gem 'minitest-slow_test'
+gem "rbs", "~> 2.5.1"
+
+group :ide, optional: true do
+  gem "ruby-debug-ide"
+  gem "debase", ">= 0.2.5.beta2"
+end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    steep (1.0.2)
+    steep (1.1.1)
       activesupport (>= 5.1)
       language_server-protocol (>= 3.15, < 4.0)
       listen (~> 3.0)
@@ -11,16 +11,6 @@ PATH
       rbs (>= 2.3.2)
       terminal-table (>= 2, < 4)
 
-PATH
-  remote: test/gems/with_steep_types
-  specs:
-    with_steep_types (1.0.0)
-
-PATH
-  remote: test/gems/without_steep_types
-  specs:
-    without_steep_types (1.0.0)
-
 GEM
   remote: https://rubygems.org/
   specs:
@@ -31,6 +21,9 @@ GEM
       tzinfo (~> 2.0)
     ast (2.4.2)
     concurrent-ruby (1.1.10)
+    debase (0.2.5.beta2)
+      debase-ruby_core_source (>= 0.10.12)
+    debase-ruby_core_source (0.10.16)
     ffi (1.15.5)
     i18n (1.12.0)
       concurrent-ruby (~> 1.0)
@@ -38,7 +31,7 @@ GEM
     listen (3.7.1)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
-    minitest (5.16.1)
+    minitest (5.16.2)
     minitest-hooks (1.5.0)
       minitest (> 5.3)
     minitest-slow_test (0.2.0)
@@ -51,11 +44,13 @@ GEM
     rb-fsevent (0.11.1)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
-    rbs (2.6.0)
+    rbs (2.5.1)
+    ruby-debug-ide (0.7.3)
+      rake (>= 0.8.1)
     stackprof (0.2.19)
     terminal-table (3.0.2)
       unicode-display_width (>= 1.1.1, < 3)
-    tzinfo (2.0.4)
+    tzinfo (2.0.5)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.2.0)
 
@@ -63,14 +58,15 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  debase (>= 0.2.5.beta2)
   minitest (~> 5.16)
   minitest-hooks
   minitest-slow_test
   rake
+  rbs (~> 2.5.1)
+  ruby-debug-ide
   stackprof
   steep!
-  with_steep_types!
-  without_steep_types!
 
 BUNDLED WITH
    2.3.8

data/Gemfile.steep

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+gem 'steep', '~> 1.1.0'
+gem "rbs", "~> 2.5.0"

data/Gemfile.steep.lock

@@ -0,0 +1,50 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (7.0.3.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    concurrent-ruby (1.1.10)
+    ffi (1.15.5)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    language_server-protocol (3.16.0.3)
+    listen (3.7.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    minitest (5.16.2)
+    parallel (1.22.1)
+    parser (3.1.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rb-fsevent (0.11.1)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rbs (2.5.1)
+    steep (1.1.0)
+      activesupport (>= 5.1)
+      language_server-protocol (>= 3.15, < 4.0)
+      listen (~> 3.0)
+      parallel (>= 1.0.0)
+      parser (>= 3.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rbs (>= 2.3.2)
+      terminal-table (>= 2, < 4)
+    terminal-table (3.0.2)
+      unicode-display_width (>= 1.1.1, < 3)
+    tzinfo (2.0.5)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.2.0)
+
+PLATFORMS
+  arm64-darwin-21
+
+DEPENDENCIES
+  rbs (~> 2.5.0)
+  steep (~> 1.1.0)
+
+BUNDLED WITH
+   2.3.15

data/Rakefile

@@ -1,6 +1,11 @@
 require "bundler/gem_tasks"
 require "rake/testtask"
 
+if ENV["VSCODE_CWD"]
+  require "minitest"
+  Minitest.seed = Time.now.to_i
+end
+
 Rake::TestTask.new(:test) do |t|
   t.libs << "test"
   t.libs << "lib"

data/Steepfile

@@ -1 +1,6 @@
-target :app do end
+target :app do
+  check "lib"
+  signature "sig"
+
+  collection_config "rbs_collection.steep.yaml"
+end

data/bin/setup

@@ -5,3 +5,5 @@ set -vx
 
 bundle install
 
+bundle install --gemfile=Gemfile.steep
+bundle exec --gemfile=Gemfile.steep rbs --collection=rbs_collection.steep.yaml collection install

data/bin/steep

@@ -0,0 +1,19 @@
+#!/usr/bin/env bash
+
+BINSTUB_DIR=$(cd $(dirname $0); pwd)
+GEMFILE=$(readlink -f ${BINSTUB_DIR}/../Gemfile.steep)
+ROOT_DIR=$(readlink -f ${BINSTUB_DIR}/..)
+
+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
+    if [ -e ${ROOT_DIR}/.ruby-version ]; then
+      STEEP="rvm ${ROOT_DIR} do ${STEEP}"
+    fi
+  fi
+fi
+
+exec $STEEP $@

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

@@ -399,7 +399,7 @@ module Steep
           when AST::Types::Boolean
             [type, type]
           else
-            [type, nil]
+            [type, AST::Types::Bot.new()]
           end
         end
 

data/lib/steep/diagnostic/ruby.rb

@@ -7,7 +7,7 @@ module Steep
         attr_reader :node
         attr_reader :location
 
-        def initialize(node:, location: node.location.expression)
+        def initialize(node:, location: node&.location&.expression)
           @node = node
           @location = location
         end
@@ -71,6 +71,8 @@ module Steep
         end
 
         def header_line
+          node = node() or raise
+
           element = case node.type
                     when :ivasgn, :lvasgn, :gvasgn, :cvasgn
                       "a variable"
@@ -387,6 +389,7 @@ module Steep
 
       class UnexpectedJumpValue < Base
         def header_line
+          node = node() or raise
           "The value given to #{node.type} will be ignored"
         end
       end
@@ -452,7 +455,7 @@ module Steep
           super(node: node)
           @interface_method = interface_method
           @annotation_method = annotation_method
-          @result = relation
+          @result = result
         end
       end
 
@@ -578,6 +581,32 @@ module Steep
 
       autoload :UnknownConstantAssigned, "steep/diagnostic/deprecated/unknown_constant_assigned"
 
+      class UnknownInstanceVariable < Base
+        attr_reader :name
+
+        def initialize(node:, name:)
+          super(node: node, location: node.loc.name)
+          @name = name
+        end
+
+        def header_line
+          "Cannot find the declaration of instance variable: `#{name}`"
+        end
+      end
+
+      class UnknownGlobalVariable < Base
+        attr_reader :name
+
+        def initialize(node:, name:)
+          super(node: node, location: node.loc.name)
+          @name = name
+        end
+
+        def header_line
+          "Cannot find the declaration of global variable: `#{name}`"
+        end
+      end
+
       class FallbackAny < Base
         def initialize(node:)
           super(node: node)
@@ -617,7 +646,7 @@ module Steep
         attr_reader :relation
 
         def initialize(node:, var_name:, result:, relation:)
-          super(node: node)
+          super(node: node, location: node.location.expression)
           @var_name = var_name
           @result = result
           @relation = relation
@@ -688,6 +717,22 @@ module Steep
         end
       end
 
+      class MultipleAssignmentConversionError < Base
+        attr_reader :original_type, :returned_type
+
+        def initialize(node:, original_type:, returned_type:)
+          super(node: node)
+
+          @node = node
+          @original_type = original_type
+          @returned_type = returned_type
+        end
+
+        def header_line
+          "Cannot convert `#{original_type}` to Array or tuple (`#to_ary` returns `#{returned_type}`)"
+        end
+      end
+
       class UnsupportedSyntax < Base
         attr_reader :message
 
@@ -700,6 +745,7 @@ module Steep
           if message
             message
           else
+            node = node() or raise
             "Syntax `#{node.type}` is not supported in Steep"
           end
         end

data/lib/steep/diagnostic/signature.rb

@@ -264,6 +264,24 @@ module Steep
         end
       end
 
+      class ClassVariableDuplicationError < Base
+        attr_reader :class_name
+        attr_reader :other_class_name
+        attr_reader :variable_name
+
+        def initialize(class_name:, other_class_name:, variable_name:, location:)
+          super(location: location)
+
+          @class_name = class_name
+          @other_class_name = other_class_name
+          @variable_name = variable_name
+        end
+
+        def header_line
+          "Class variable definition `#{variable_name}` in `#{class_name}` may be overtaken by `#{other_class_name}`"
+        end
+      end
+
       class InstanceVariableTypeError < Base
         attr_reader :name
         attr_reader :variable

data/lib/steep/drivers/watch.rb

@@ -79,7 +79,7 @@ module Steep
         file_paths = Set.new(dirs.select(&:file?).map(&:realpath))
 
         listener = Listen.to(*watch_paths.map(&:to_s)) do |modified, added, removed|
-          stdout.puts Rainbow("🔬 Type checking updated files...").bold
+          stdout.print Rainbow("🔬 Type checking updated files...").bold
 
           version = Time.now.to_i
           Steep.logger.tagged "watch" do
@@ -112,6 +112,8 @@ module Steep
           end
 
           client_writer.write(method: "$/typecheck", params: { guid: nil })
+          
+          stdout.puts Rainbow("done!").bold
         end.tap(&:start)
 
         begin

data/lib/steep/method_name.rb

@@ -1,24 +1,30 @@
 module Steep
-  InstanceMethodName = Struct.new(:type_name, :method_name, keyword_init: true) do
+  InstanceMethodName = _ = Struct.new(:type_name, :method_name, keyword_init: true) do
+    # @implements InstanceMethodName
     def to_s
       "#{type_name}##{method_name}"
     end
   end
 
-  SingletonMethodName = Struct.new(:type_name, :method_name, keyword_init: true) do
+  SingletonMethodName = _ = Struct.new(:type_name, :method_name, keyword_init: true) do
+    # @implements SingletonMethodName
     def to_s
       "#{type_name}.#{method_name}"
     end
   end
 
-  module ::Kernel
+  class ::Object
     def MethodName(string)
       case string
       when /#/
         type_name, method_name = string.split(/#/, 2)
+        type_name or raise
+        method_name or raise
         InstanceMethodName.new(type_name: TypeName(type_name), method_name: method_name.to_sym)
       when /\./
         type_name, method_name = string.split(/\./, 2)
+        type_name or raise
+        method_name or raise
         SingletonMethodName.new(type_name: TypeName(type_name), method_name: method_name.to_sym)
       else
         raise "Unexpected method name: #{string}"

data/lib/steep/node_helper.rb

@@ -0,0 +1,49 @@
+module Steep
+  module NodeHelper
+    def each_child_node(node, &block)
+      if block
+        node.children.each do |child|
+          if child.is_a?(Parser::AST::Node)
+            yield child
+          end
+        end
+      else
+        enum_for :each_child_node, node
+      end
+    end
+
+    def each_descendant_node(node, &block)
+      if block
+        each_child_node(node) do |child|
+          yield child
+          each_descendant_node(child, &block)
+        end
+      else
+        enum_for :each_descendant_node, node
+      end
+    end
+
+    def value_node?(node)
+      case node.type
+      when :true, :false, :str, :sym, :int, :float, :nil
+        true
+      when :lvar
+        true
+      when :const
+        each_child_node(node).all? {|child| child.type == :cbase || value_node?(child) }
+      when :array
+        each_child_node(node).all? {|child| value_node?(child) }
+      when :hash
+        each_child_node(node).all? do |pair|
+          each_child_node(pair).all? {|child| value_node?(child) }
+        end
+      when :dstr
+        each_child_node(node).all? {|child| value_node?(child)}
+      when :begin
+        each_child_node(node).all? {|child| value_node?(child) }
+      else
+        false
+      end
+    end
+  end
+end

data/lib/steep/services/completion_provider.rb

@@ -1,16 +1,20 @@
 module Steep
   module Services
     class CompletionProvider
-      Position = Struct.new(:line, :column, keyword_init: true) do
+      Position = _ = Struct.new(:line, :column, keyword_init: true) do
+        # @implements Position
         def -(size)
           Position.new(line: line, column: column - size)
         end
       end
-      Range = Struct.new(:start, :end, keyword_init: true)
 
-      InstanceVariableItem = Struct.new(:identifier, :range, :type, keyword_init: true)
-      LocalVariableItem = Struct.new(:identifier, :range, :type, keyword_init: true)
-      ConstantItem = Struct.new(:env, :identifier, :range, :type, :full_name, keyword_init: true) do
+      Range = _ = Struct.new(:start, :end, keyword_init: true)
+
+      InstanceVariableItem = _ = Struct.new(:identifier, :range, :type, keyword_init: true)
+      LocalVariableItem = _ = Struct.new(:identifier, :range, :type, keyword_init: true)
+      ConstantItem = _ = Struct.new(:env, :identifier, :range, :type, :full_name, keyword_init: true) do
+        # @implements ConstantItem
+
         def class?
           if decl = env.class_decls[full_name]
             decl.primary.decl.is_a?(RBS::AST::Declarations::Class)
@@ -34,20 +38,23 @@ module Steep
           end
         end
       end
-      MethodNameItem = Struct.new(:identifier, :range, :receiver_type, :method_type, :method_decls, keyword_init: true) do
+      MethodNameItem = _ = Struct.new(:identifier, :range, :receiver_type, :method_type, :method_decls, keyword_init: true) do
+        # @implements MethodNameItem
+
         def comment
           case method_decls.size
           when 0
             nil
           when 1
-            method_decls.to_a.first.method_def&.comment
+            method = method_decls.to_a.first or raise
+            method.method_def&.comment
           else
             nil
           end
         end
 
         def inherited?
-          case receiver_type
+          case receiver_type = receiver_type()
           when AST::Types::Name::Instance, AST::Types::Name::Singleton, AST::Types::Name::Interface
             method_decls.any? do |decl|
               decl.method_name.type_name != receiver_type.name
@@ -365,11 +372,11 @@ module Steep
 
       def local_variable_items_for_context(context, position:, prefix:, items:)
         range = range_for(position, prefix: prefix)
-        context.lvar_env.each do |name, type|
+        context.type_env.local_variable_types.each do |name, pair|
+          type, _ = pair
+
           if name.to_s.start_with?(prefix)
-            items << LocalVariableItem.new(identifier: name,
-                                           range: range,
-                                           type: type)
+            items << LocalVariableItem.new(identifier: name, range: range, type: type)
           end
         end
       end
@@ -381,10 +388,10 @@ module Steep
           case parent.type
           when :const
             const_name = typing.source_index.reference(constant_node: parent)
-            consts = context.module_context.const_env.children(const_name)
+            consts = context.type_env.constant_env.children(const_name)
           end
         else
-          consts = context.module_context.const_env.constants
+          consts = context.type_env.constant_env.constants
         end
 
         if consts
@@ -400,7 +407,7 @@ module Steep
 
       def instance_variable_items_for_context(context, position:, prefix:, items:)
         range = range_for(position, prefix: prefix)
-        context.type_env.ivar_types.map do |name, type|
+        context.type_env.instance_variable_types.each do |name, type|
           if name.to_s.start_with?(prefix)
             items << InstanceVariableItem.new(identifier: name,
                                               range: range,