steep 1.6.0 → 1.7.0.dev.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c834be3917dcff04077098f89b0300f7819b0cda30499bd11d34b172627e975f
-  data.tar.gz: d48ce39f9e337ad408047b56a0bb68a133ba6e044b66381c2bdd6974fcf94a69
+  metadata.gz: 7e08a21c496335ac125c03ae833cd7a18383c3e21e963bd809c349e04b3549cb
+  data.tar.gz: 49e9eb2a8e00788bf3b5dea25617af75b51b5f9c69582dd13553e8c1f24d8ea0
 SHA512:
-  metadata.gz: 1dca3fc949d3df061bf63f913eda7553c6ecb18a8a8e7f270d81ba118ca1e852326bcee836200c377b2791902e395ac112e79961b4bc614f75e6ff6fca1e5697
-  data.tar.gz: 30cdc11cfc25432270751e3e8c492424131055062afb5d430a415a4d2000c55b9614db304b36a051e3f42da5e0cc96335296b499a7eff41ce37d6db191e1ce01
+  metadata.gz: 6a6c44532ff30efa59ba74ff506319a446333a265a43e27e0d1a39dc49ab06018b6b4feab9952d4597451b274b3033be016c505d49e5be4977c00a4350a8fd2f
+  data.tar.gz: d19406af1b45c773305a642a2da22c9a1beed54129eb1f0826385bfa895a17717cbdb351d9b2434aeec49d4324e6cd818cf9ef45ccf1c218eae21e53e15a1ab9

data/.github/dependabot.yml

@@ -7,6 +7,9 @@ updates:
       interval: daily
       time: "20:00"
     open-pull-requests-limit: 10
+    allow:
+      - dependency-type: all
+    versioning-strategy: lockfile-only
 
   - package-ecosystem: bundler
     directory: "/gemfile_steep"
@@ -14,6 +17,9 @@ updates:
       interval: daily
       time: "20:00"
     open-pull-requests-limit: 10
+    allow:
+      - dependency-type: all
+    versioning-strategy: lockfile-only
 
   - package-ecosystem: "github-actions"
     directory: "/"

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

@@ -7,13 +7,14 @@ on:
   pull_request: {}
 
 jobs:
-  test:
+  windows:
     strategy:
       matrix:
         ruby_version:
         - "3.0"
         - "3.1"
         - "3.2"
+        - "3.3"
         task:
         - test
         # - test:output  Ignored because the order of diagnostics changes somehow

data/.github/workflows/ruby.yml

@@ -9,21 +9,20 @@ on:
 jobs:
   test:
     strategy:
+      fail-fast: false
       matrix:
-        container_tag:
-        - "3.0"
-        - "3.1"
-        - "3.2"
-        # - "master-nightly-focal"
+        ruby: ['3.0', '3.1', '3.2', '3.3']
         task:
-        - test
-        - test:output
-        - build
+          - test
+          - test:output
+          - build
     runs-on: ubuntu-latest
-    container:
-      image: rubylang/ruby:${{ matrix.container_tag }}
     steps:
     - uses: actions/checkout@v4
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler: none
     - name: Run test
       run: |
         git config --global --add safe.directory /__w/steep/steep

data/.gitignore

@@ -2,7 +2,6 @@
 /.yardoc
 /_yardoc/
 /coverage/
-/doc/
 /pkg/
 /spec/reports/
 /tmp/

data/Gemfile

@@ -4,7 +4,7 @@ source 'https://rubygems.org'
 gemspec
 
 gem "rake"
-gem "minitest", "~> 5.20"
+gem "minitest", "~> 5.21"
 gem "minitest-hooks"
 group :stackprof, optional: true do
   gem "stackprof"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    steep (1.6.0)
+    steep (1.7.0.dev.1)
       activesupport (>= 5.1)
       concurrent-ruby (>= 1.1.10)
       csv (>= 3.0.9)
@@ -20,7 +20,8 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.1.1)
+    abbrev (0.1.2)
+    activesupport (7.1.3)
       base64
       bigdecimal
       concurrent-ruby (~> 1.0, >= 1.0.2)
@@ -31,40 +32,40 @@ GEM
       mutex_m
       tzinfo (~> 2.0)
     ast (2.4.2)
-    base64 (0.1.1)
-    bigdecimal (3.1.4)
-    concurrent-ruby (1.2.2)
+    base64 (0.2.0)
+    bigdecimal (3.1.6)
+    concurrent-ruby (1.2.3)
     connection_pool (2.4.1)
-    csv (3.2.7)
-    debug (1.8.0)
-      irb (>= 1.5.0)
-      reline (>= 0.3.1)
-    drb (2.1.1)
+    csv (3.2.8)
+    debug (1.9.1)
+      irb (~> 1.10)
+      reline (>= 0.3.8)
+    drb (2.2.0)
       ruby2_keywords
     ffi (1.16.3)
-    fileutils (1.7.1)
+    fileutils (1.7.2)
     i18n (1.14.1)
       concurrent-ruby (~> 1.0)
-    io-console (0.6.0)
-    irb (1.8.1)
+    io-console (0.7.2)
+    irb (1.11.1)
       rdoc
-      reline (>= 0.3.8)
-    json (2.6.3)
+      reline (>= 0.4.2)
+    json (2.7.1)
     language_server-protocol (3.17.0.3)
     listen (3.8.0)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
-    logger (1.5.3)
-    minitest (5.20.0)
+    logger (1.6.0)
+    minitest (5.21.2)
     minitest-hooks (1.5.1)
       minitest (> 5.3)
     minitest-slow_test (0.2.0)
       minitest (>= 5.0)
-    mutex_m (0.1.2)
-    parser (3.2.2.4)
+    mutex_m (0.2.0)
+    parser (3.3.0.5)
       ast (~> 2.4.1)
       racc
-    psych (5.1.0)
+    psych (5.1.2)
       stringio
     racc (1.7.3)
     rainbow (3.1.1)
@@ -72,16 +73,17 @@ GEM
     rb-fsevent (0.11.2)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
-    rbs (3.2.2)
-    rdoc (6.5.0)
+    rbs (3.4.3)
+      abbrev
+    rdoc (6.6.2)
       psych (>= 4.0.0)
-    reline (0.3.8)
+    reline (0.4.2)
       io-console (~> 0.5)
     ruby2_keywords (0.0.5)
-    securerandom (0.2.2)
-    stackprof (0.2.25)
-    stringio (3.0.8)
-    strscan (3.0.7)
+    securerandom (0.3.1)
+    stackprof (0.2.26)
+    stringio (3.1.0)
+    strscan (3.0.9)
     terminal-table (3.0.2)
       unicode-display_width (>= 1.1.1, < 3)
     tzinfo (2.0.6)
@@ -93,7 +95,7 @@ PLATFORMS
 
 DEPENDENCIES
   debug
-  minitest (~> 5.20)
+  minitest (~> 5.21)
   minitest-hooks
   minitest-slow_test
   rake

data/bin/output_test.rb

@@ -27,6 +27,7 @@ test_dirs.each do |dir|
   end
 
   command = %w(steep check --with-expectations=test_expectations.yml)
+  command << "-j2" if ENV["CI"]
   puts "  command: #{command.join(" ")}"
 
   output, status = Open3.capture2(*command, chdir: dir.to_s)

data/doc/narrowing.md

@@ -0,0 +1,195 @@
+# Narrowing Implementation
+
+> This is an internal doc for Steep developers. [Narrowing guide](../guides/narrowing/narrowing.md) is for users.
+
+The challenge is Ruby has special type predicate methods that should be supported by type checkers. `#nil?` is used instead of `unless` statement to test if a value is a `nil` or not. `#is_a?` or `#===` are used to confirm if an object is an instance of a class. Negation and equality are implemented as methods -- `#!` and `#==`.
+
+Steep supports those methods by introducing special types for those methods.
+
+```rbs
+# This is not a valid RBS type definition.
+# Steep implements a transformation from valid RBS syntax to those special types.
+module Kernel
+  def nil?: () -> RECEIVER_IS_NIL
+
+  def is_a?: (Class klass) -> RECEIVER_IS_ARG
+end
+```
+
+When type checking a conditional resulted in `RECEIVER_IS_NIL` type, the type checker overrides the type of the expressions inside the *then* and *else* clauses.
+
+```ruby
+x = [1, ""].sample      # The type of `x` is `String | Integer | nil`
+
+unless x.is_a?(String)  # 1. The condition expression has `RECEIVER_IS_NIL`
+  x.upcase              # 2. Steep overrides the type of `x` to `String` in *then* clause
+else
+                        # 3. Steep overrides the type of `x` to `Integer | nil` in *else* clause
+end
+```
+## Logical types
+
+We extend *type* with *logical types* as follows:
+
+```
+type ::= ...
+       | NOT                           # Negation of type of receiver
+       | RECEIVER_IS_NIL               # Receiver is nil when it evaluates to truthy
+       | RECEIVER_IS_NOT_NIL           # Receiver is not nil when it evaluates to truthy
+       | RECEIVER_IS_ARG               # Receiver is an instance of argument when it evaluates to truthy
+       | ARG_IS_RECEIVER               # Argument is an instance of receiver when it evaluates to truthy
+       | ARG_EQUALS_RECEIVER           # Argument is equal to receiver when it evaluates to truthy
+       | ENV(original_type, truthy_env, falsy_env)    # Two type environments for truthy and falsy
+```
+### ENV type
+
+`ENV` looks a bit different from others because it takes arguments. The type is used for `and` and `or`.
+
+Consider the example with local variables `x` and `y` where both of them have type `String?`.
+
+```ruby
+(x && y) && (x + y)   # Parens added for ease of reading
+```
+
+The type of the whole expression is `String?`. When `x` or `y` is `nil`, it evaluates to `nil`. If both of `x` and `y` is a `String`, `x + y` evaluates to `String` because of the definition of `String#+`.
+
+The type narrowing starts with the top expression.
+
+```ruby
+(...) && (x + y)
+```
+
+It immediately type checks the left hand side, but with *conditional mode*. Conditional mode is a special flag that the type checking result should keep as many of the environments as possible.
+
+```ruby
+x && y
+```
+
+Going down again, it gets a typing `x: String?` and `y: String?. It runs a type narrowing, to obtain a result both of `x` and `y` are `String` for truthy result, both of `x` and `y` are `String?` for falsy result. The two environments should be propagated to the upper node, because the parent node is also `&&` which is a subject of type narrowing. So, it returns an `ENV` type, `String?` for original type, `{ x: String, y: String }` for truthy result, and `{ x: String?, y: String? }` for falsy result.
+
+Going up to the outer `&&` expression. The left hand side has `ENV` type, and then the right hand side is type checked based on the truthy environment (because of the semantics of `&&` expression.) Both `x` and `y` are `String` and it type checks. The type of the whole expression union of `String` and the falsy part of the original type -- `nil`.
+## Union type partition
+
+We introduce *partition* function for union types. It returns a pair of two types -- truthy parts and falsy parts. We need a slightly different variant for *non-nil* partition to support safe-navigation-operator.
+
+```
+Pt(T) -> T? ⨉ T?    # Truthy partition
+Pn(T) -> T? ⨉ T?    # Non-nil partition
+```
+
+Both return a pair of optional types for non-falsy/non-nil types.
+
+```
+Pt(false?)  -> ∅ ⨉ false?
+Pn(false)   -> false ⨉ ∅
+```
+
+Note that we cannot partition non-regular recursive types, but that types are prohibited in RBS.
+## Type environment
+
+Type environment is a mapping from local variables to their types. It's extended in Steep to support overriding type of *pure* expressions.
+
+```
+E ::= ∅
+    | x : T, E       # Type of a local variable -- `x`
+    | p : T, E       # Type of a pure expression -- `p`
+```
+
+Pure expressions are defined recursively as following:
+
+* *Value expressions* are pure
+* Call expressions of *pure methods* with pure arguments are pure
+
+Note that expression purity depends on the result of type checking of the expression because it requires to detect if a method call is *pure* or not.
+## Logic type interpreter
+Logic type interpreter is an additional layer to support type narrowing. It is a function that takes an expression and it's typing, and returns a pair of type environments -- one for the case the value of the expr is *truthy* and another for the case the value is *falsy*.
+
+```
+I(expr : T) -> E ⨉ E
+```
+
+It takes account of assignments to local variables.
+
+```
+I(x = y : String?) -> { x: String, y: String } ⨉ { x: nil, y: nil }
+```
+
+It also calculates the reachability to truthy and falsy results which can be used to detect unreachable branches.
+## Narrowing syntaxes
+### Simple conditionals -- `if`, `while`, `and`, ...
+Type checking those syntaxes are simple. It type checks the condition expression with conditional mode, passes the expression to logic type interpreter, uses the type environments to type check then and else clauses.
+
+Steep also reports unreachable branch issues based on the reachability calculated by logic type interpreter.
+### `case-when`
+The easier case is if `case-when` doesn't have a node just after `case` token.
+
+```ruby
+case
+when x == 1
+  ...
+end
+```
+
+This is the same with simple conditionals.
+
+The difficult case is if `case-when` syntax has a node.
+
+```ruby
+case foo()
+when Integer
+  ...
+when String
+  ...
+end
+```
+
+Ruby uses the `===` operator to test if the value of `foo()` matches the condition, while we don't want to type check `foo()` calls every time. It may be a pure expression, and we can give better type narrowing using the *falsy* results of predecessor `when` clauses.
+
+So, we transform the condition expression given to the logic type interpreter to value form.
+
+```ruby
+__case_when:x01jg9__ = foo()
+if Integer === __case_when:x01jg9__
+  ...
+elsif String === __case_when:x01jg9__
+  ...
+end
+```
+
+It generates a fresh local variable and assigns the expression to it. Uses the variable inside the patterns.
+
+We also need to propagate the type of local variables which are included in the expression.
+
+```ruby
+case x = foo()
+when Integer
+  x.abs      # x should be Integer
+when String
+  x.upcase   # x should be String
+end
+```
+
+The local variable insertion is done at the outermost non-assignment position to support the local variable propagation.
+
+```ruby
+__case_when:x01jg9__ = foo()
+if Integer === (x = __case_when:x01jg9__)
+  ...
+elsif String === (x = __case_when:x01jg9__)
+  ...
+end
+```
+
+The last trick to type check case-when is *pure call* narrowing in the bodies.
+
+```ruby
+__case_when:x01jg9__ = foo()
+if Integer === (x = __case_when:x01jg9__)
+  foo.abs
+elsif String === (x = __case_when:x01jg9__)
+  foo.upcase
+end
+```
+
+To support this, we propagate the type of the fresh local variable to the type of right hand side expression, if it's a pure call.
+

data/gemfile_steep/Gemfile.lock

@@ -1,36 +1,50 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.7.2)
+    abbrev (0.1.2)
+    activesupport (7.1.3)
+      base64
+      bigdecimal
       concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
+      mutex_m
       tzinfo (~> 2.0)
     ast (2.4.2)
-    concurrent-ruby (1.2.2)
-    csv (3.2.7)
-    ffi (1.15.5)
-    fileutils (1.7.1)
+    base64 (0.2.0)
+    bigdecimal (3.1.6)
+    concurrent-ruby (1.2.3)
+    connection_pool (2.4.1)
+    csv (3.2.8)
+    drb (2.2.0)
+      ruby2_keywords
+    ffi (1.16.3)
+    fileutils (1.7.2)
     i18n (1.14.1)
       concurrent-ruby (~> 1.0)
-    json (2.6.3)
+    json (2.7.1)
     language_server-protocol (3.17.0.3)
     listen (3.8.0)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
-    logger (1.5.3)
-    minitest (5.19.0)
-    parser (3.2.2.3)
+    logger (1.6.0)
+    minitest (5.21.2)
+    mutex_m (0.2.0)
+    parser (3.3.0.5)
       ast (~> 2.4.1)
       racc
-    racc (1.7.1)
+    racc (1.7.3)
     rainbow (3.1.1)
     rb-fsevent (0.11.2)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
-    rbs (3.1.3)
-    securerandom (0.2.2)
-    steep (1.5.3)
+    rbs (3.4.3)
+      abbrev
+    ruby2_keywords (0.0.5)
+    securerandom (0.3.1)
+    steep (1.6.0)
       activesupport (>= 5.1)
       concurrent-ruby (>= 1.1.10)
       csv (>= 3.0.9)
@@ -45,16 +59,17 @@ GEM
       securerandom (>= 0.1)
       strscan (>= 1.0.0)
       terminal-table (>= 2, < 4)
-    strscan (3.0.6)
+    strscan (3.0.9)
     terminal-table (3.0.2)
       unicode-display_width (>= 1.1.1, < 3)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.4.2)
+    unicode-display_width (2.5.0)
 
 PLATFORMS
   arm64-darwin-21
   arm64-darwin-22
+  arm64-darwin-23
   x86_64-linux
 
 DEPENDENCIES

data/guides/src/getting-started/getting-started.md

@@ -16,7 +16,7 @@ and install the gems.
 $ bundle install
 ```
 
-You can install it with the gem command.
+Alternatively, you can install it with the gem command.
 
 ```
 $ gem install steep
@@ -26,14 +26,14 @@ Execute the following command to confirm if the command is successfully installe
 
 ```
 $ steep version
-$ bundle exec steep version         # When you install with bundler
+$ bundle exec steep version         # If you install with bundler
 ```
 
-We omit the `bundle exec` prefix from the following commands. Run commands with the prefix if you install Steep with bundler.
+We omit the `bundle exec` prefix from the following commands. Run commands with the prefix if you installed Steep with Bundler.
 
 ## Type checking your first Ruby script
 
-Run steep init command to generate the configuration file, Steepfile.
+Run the `steep init` command to generate the configuration file, `Steepfile`.
 
 ```
 $ steep init
@@ -54,7 +54,7 @@ Type the following Ruby code in your editor, and save it as `lib/hello.rb`.
 currencies = { US: "$", JP: "¥", UK: "£" }
 country = %w(US JP UK).sample()
 
-puts "Hello! The price is #{currencies[country.to_sym]}100. 💸"
+puts "Hello! The price is #{currencies[country]}100. 💸"
 ```
 
 And type check it with Steep.
@@ -84,13 +84,13 @@ lib/hello.rb:4:39: [error] Cannot pass a value of type `(::String | nil)` as an
 Detected 1 problem from 1 file
 ```
 
-The error says that the type of the country variable causes a type error. It is expected to be a Symbol, but String or nil will be given.
+The error says that the type of the country variable causes a type error. It is expected to be a symbol, but string or `nil` will be given.
 
 Let's see how we can fix the error.
 
 ## Fixing the type error
 
-The first step is converting the string value to a symbol. We can add to_sym call.
+The first step is converting the string value to a symbol. We can add a `#to_sym` call.
 
 ```rb
 currencies = { US: "$", JP: "¥", UK: "£" }
@@ -128,7 +128,7 @@ Instead, we can simply tell the type checker that the value of the country canno
 
 The underlying type system supports flow-sensitive typing similar to TypeScript and Rust. It detects conditional expressions testing the value of a variable and propagates the knowledge that the value cannot be `nil`.
 
-We can fix the type error with an or construct.
+We can fix the type error with an `or` construct.
 
 ```rb
 currencies = { US: "$", JP: "¥", UK: "£" }
@@ -137,7 +137,7 @@ country = %w(US JP UK).sample() or raise
 puts "Hello! The price is #{currencies[country.to_sym]}100. 💸"
 ```
 
-The change let the type checking succeed.
+The change lets the type checking succeed.
 
 ```
 $ steep check
@@ -145,7 +145,7 @@ $ steep check
 
 .........................................................
 
-No type error detected. 🧉
+No type error detected. 🫖
 ```
 
 The `raise` method is called when `sample()` returns `nil`. Steep can reason the possible control flow based on the semantics of or in Ruby:
@@ -161,4 +161,3 @@ There are two possibilities of the type of the result of the `sample()` call, `n
 ## Next steps
 
 This is a really quick introduction to using Steep. You may have noticed that I haven't explained anything about defining new classes or modules. See the RBS guide for more examples!
-