steep 1.0.0 → 1.1.0.pre.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 899bca0fd211114d52e015acc844ee4648eadb6b739af911f7ac73560cedef83
-  data.tar.gz: 2fe5b52342a6b932d5ce08f5b78c417e43cda38db378c35d1b31891ca7c79465
+  metadata.gz: d1094b2c84b950883393bb887dbc8476ba59d911ebee1d358c605e9110bfae8f
+  data.tar.gz: 54fbfd4ea0120bcc45766f530a4c381c9b79c78929a7aa749059d03e69bf7eae
 SHA512:
-  metadata.gz: 20e09462ddef35a3aa00a19d6f7cb86f2862c9ab700131bf439fc7750b088d43d1f2bb3380dfdf57a0c881d58c885b789d47eba35d7e146156809511e4e1c64c
-  data.tar.gz: dfa20a13b3b25575419ad1c9ac2417b1b873a0732eded5fa643e6e5768b644e27ea07c8d83bf9ae5e333b872d8f039aba111bee4d7ae2a48034dc06047265fee
+  metadata.gz: 3b4d09f5d02029a75099f541e27194f88fcb0eb50fa69fbc6cfa030b7b6ee83873cfff9478a781ff7a12ea94c45ea5c4ca31aed10bf065ce960dbdbf11ebd918
+  data.tar.gz: 8ddfdbdab223a916a6b42715f16df891aed80f107f96c19aa8a53ce8bafa8172888fd992a52bf5d4bba38e2ae8ff7484f1a823586d89e2e267854e84d8fd0222

data/.github/workflows/ruby-windows.yml

@@ -0,0 +1,34 @@
+name: Run test on Windows
+
+on:
+  push:
+    branches:
+      - master
+  pull_request: {}
+
+jobs:
+  test:
+    strategy:
+      matrix:
+        ruby_version:
+        - "2.7"
+        - "3.0"
+        - "3.1"
+        task:
+        - test
+        # - test:output  Ignored because the order of diagnostics changes somehow
+        - build
+    runs-on: windows-latest
+    steps:
+    - uses: actions/checkout@v3
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby_version }}
+    - name: Run test
+      run: |
+        git config --global --add safe.directory /__w/steep/steep
+        ruby -v
+        gem install bundler
+        bundle install --jobs 4 --retry 3
+        bin/setup
+        bundle exec rake ${{matrix.task}}

data/.github/workflows/ruby.yml

@@ -1,4 +1,4 @@
-name: Ruby
+name: Run test on container
 
 on:
   push:
@@ -8,10 +8,10 @@ on:
 
 jobs:
   test:
-    runs-on: "ubuntu-latest"
     strategy:
       matrix:
         container_tag:
+        - "2.6"
         - "2.7"
         - "3.0"
         - "3.1"
@@ -20,10 +20,15 @@ jobs:
         - test
         - test:output
         - build
+    runs-on: ubuntu-latest
     container:
       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,6 +2,65 @@
 
 ## master
 
+## 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 core
+
+* Fix type application validation ([#607](https://github.com/soutaro/steep/pull/607))
+
+## 1.0.1 (2022-06-16)
+
+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 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))
+* Apply logic-type evaluation only if the node is `:send` ([\#569](https://github.com/soutaro/steep/pull/569))
+* Add support for `Hash#compact` ([\#570](https://github.com/soutaro/steep/pull/570))
+* Use given `const_env` when making a new `ModuleContext` ([\#575](https://github.com/soutaro/steep/pull/575))
+* Graceful, hopefully, error handling with undefined outer module ([\#576](https://github.com/soutaro/steep/pull/576))
+* Type check anonymous block forwarding ([\#577](https://github.com/soutaro/steep/pull/577))
+* Incompatible default value is a type error ([\#578](https://github.com/soutaro/steep/pull/578))
+* Load `ChildrenLevel` helper in `AST::Types::Proc` ([\#584](https://github.com/soutaro/steep/pull/584))
+* 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))
+
+### 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))
+* Fix typo ([\#564](https://github.com/soutaro/steep/pull/564))
+* Ignore `untitled:` URIs in LSP ([\#580](https://github.com/soutaro/steep/pull/580))
+
+### Miscellaneous
+
+* Fix test name ([\#565](https://github.com/soutaro/steep/pull/565), [\#566](https://github.com/soutaro/steep/pull/566), [\#585](https://github.com/soutaro/steep/pull/585))
+* Remove some unused code except tests ([\#587](https://github.com/soutaro/steep/pull/587))
+
 ## 1.0.0 (2022-05-20)
 
 * Add special typing rule for `Array#compact` ([\#555](https://github.com/soutaro/steep/pull/555))

data/Gemfile

@@ -3,13 +3,16 @@ 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.15"
+gem "minitest", "~> 5.16"
 gem "minitest-hooks"
 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,44 +1,37 @@
 PATH
   remote: .
   specs:
-    steep (1.0.0)
+    steep (1.1.0.pre.1)
       activesupport (>= 5.1)
       language_server-protocol (>= 3.15, < 4.0)
       listen (~> 3.0)
       parallel (>= 1.0.0)
-      parser (>= 3.0)
+      parser (>= 3.1)
       rainbow (>= 2.2.2, < 4.0)
       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:
-    activesupport (7.0.3)
+    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)
+    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.10.0)
+    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.15.0)
+    minitest (5.16.2)
     minitest-hooks (1.5.0)
       minitest (> 5.3)
     minitest-slow_test (0.2.0)
@@ -51,26 +44,29 @@ GEM
     rb-fsevent (0.11.1)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
-    rbs (2.4.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.1.0)
+    unicode-display_width (2.2.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  minitest (~> 5.15)
+  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,3 @@
+source "https://rubygems.org"
+
+gem "steep"

data/Gemfile.steep.lock

@@ -0,0 +1,49 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (7.0.3)
+      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.10.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.6.0)
+    steep (1.0.1)
+      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.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.2.0)
+
+PLATFORMS
+  arm64-darwin-21
+
+DEPENDENCIES
+  steep
+
+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/builtin.rb

@@ -16,7 +16,7 @@ module Steep
               args << Builtin.any_type
             end
           end
-          arity == args.size or raise "Mulformed instance type: name=#{module_name}, args=#{args}"
+          arity == args.size or raise "Malformed instance type: name=#{module_name}, args=#{args}"
 
           Types::Name::Instance.new(name: module_name, args: args)
         end
@@ -28,7 +28,7 @@ module Steep
         def instance_type?(type, args: nil)
           if type.is_a?(Types::Name::Instance)
             if args
-              arity == args.size or raise "Mulformed instance type: name=#{module_name}, args=#{args}"
+              arity == args.size or raise "Malformed instance type: name=#{module_name}, args=#{args}"
               type.name == module_name && type.args == args
             else
               type.name == module_name && type.args.size == arity

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

@@ -9,6 +9,12 @@ module Steep
 
         attr_reader :type_interface_cache
 
+        def inspect
+          s = "#<%s:%#018x " % [self.class, object_id]
+          s << "@definition_builder=#<%s:%#018x>" % [definition_builder.class, definition_builder.object_id]
+          s + ">"
+        end
+
         def initialize(builder:)
           @definition_builder = builder
 
@@ -282,8 +288,6 @@ module Steep
           fvs = self_type.free_variables()
 
           type_params = []
-          alpha_vars = []
-          alpha_types = []
 
           conflicting_names = method_type.type_params.each.with_object([]) do |param, names|
             names << params.name if fvs.include?(param.name)
@@ -395,7 +399,7 @@ module Steep
           when AST::Types::Boolean
             [type, type]
           else
-            [type, nil]
+            [type, AST::Types::Bot.new()]
           end
         end
 

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

@@ -45,6 +45,8 @@ module Steep
           end
         end
 
+        include Helper::ChildrenLevel
+
         def level
           children = type.params.each_type.to_a + [type.return_type]
           if block

data/lib/steep/cli.rb

@@ -271,7 +271,9 @@ 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}"
+    if [ -e ${ROOT_DIR}/.ruby-version ]; then
+      STEEP="rvm ${ROOT_DIR} do ${STEEP}"
+    fi
   fi
 fi
 

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"
@@ -296,7 +298,7 @@ module Steep
         attr_reader :method_type
 
         def initialize(node:, method_type:)
-          super(node: node, location: node.loc.selector)
+          super(node: node, location: (node.type == :super || node.type == :zsuper) ? node.loc.keyword : node.loc.selector)
           @method_type = method_type
         end
 
@@ -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/check.rb

@@ -139,7 +139,7 @@ module Steep
         missing_count = 0
 
         ns = notifications.each.with_object({}) do |notification, hash|
-          path = project.relative_path(Pathname(URI.parse(notification[:uri]).path))
+          path = project.relative_path(Steep::PathHelper.to_pathname(notification[:uri]))
           hash[path] = notification[:diagnostics]
         end
 
@@ -186,7 +186,7 @@ module Steep
                        end
 
         ns = notifications.each.with_object({}) do |notification, hash|
-          path = project.relative_path(Pathname(URI.parse(notification[:uri]).path))
+          path = project.relative_path(Steep::PathHelper.to_pathname(notification[:uri]))
           hash[path] = notification[:diagnostics]
         end
 
@@ -215,7 +215,7 @@ module Steep
           total = errors.sum {|notification| notification[:diagnostics].size }
 
           errors.each do |notification|
-            path = Pathname(URI.parse(notification[:uri]).path)
+            path = Steep::PathHelper.to_pathname(notification[:uri])
             buffer = RBS::Buffer.new(name: project.relative_path(path), content: path.read)
             printer = DiagnosticPrinter.new(buffer: buffer, stdout: stdout)
 

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}"