steep 0.52.2 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3c9d5eb873780b31a2431d2e6c4efdc558fbb3a4a42c08cbe2580bb191db5bc8
-  data.tar.gz: dee794e9cb098309b9875396ed1dc9904a4c6882aeadb27c83c26604ebcbc87d
+  metadata.gz: 8317c379e5b7e85cca4a22c9133248a77a112e7687c3cf553ddb90f96ab31236
+  data.tar.gz: cd9c06372e29c009b4af99a5f0c252dcdbdcc9d2905cbd601cffb7210f809c93
 SHA512:
-  metadata.gz: ba05f88c28a78414ffcd41744558bdea978b72621f422571cb1450b7b0d56fb77c2b65329064226863db2517d4769a6f54e7c47ce92eef59d97f0403bb9e9425
-  data.tar.gz: 6e260b48940214b7c0910bf2678c587b469e163e70265f197ef8fd17a1703a68fd9488c77c3d1f8254939c074281717593e49812875fb705615189cd3ec4cdf0
+  metadata.gz: 7b0cfaee1dac3cdc8a69d9ef50714615647c1049783d6406d6ee3246c11a5cb2b5e4287f42a896d13e9ed6411e092acf15406199a0f6f0e3bad412f0ae12e250
+  data.tar.gz: a8b8192a8e6217eff958d30ac12c9aa1cbf9608626c892c9ae9585e33c9241d5a75e760060271e15f60f9869ceab41e9ff2fab38920db9692aa4f1ec296d1257

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,7 +8,6 @@ on:
 
 jobs:
   test:
-    runs-on: "ubuntu-latest"
     strategy:
       matrix:
         container_tag:
@@ -20,6 +19,7 @@ jobs:
         - test
         - test:output
         - build
+    runs-on: ubuntu-latest
     container:
       image: rubylang/ruby:${{ matrix.container_tag }}
     steps:

data/CHANGELOG.md

@@ -2,6 +2,53 @@
 
 ## master
 
+## 1.0.2 (2022-07-19)
+
+This is another patch release for Steep 1.0.
+
+### Type checker
+
+* 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
+
+* 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))
+
+### 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))
+* Add custom method type of `#fetch` on tuples and records ([\#554](https://github.com/soutaro/steep/pull/554))
+* Better `masgn` ([\#553](https://github.com/soutaro/steep/pull/553))
+* Fix method parameter type checking ([\#552](https://github.com/soutaro/steep/pull/552))
+
 ## 0.52.2 (2022-05-02)
 
 * Handle class declaration with non-const super class ([\#546](https://github.com/soutaro/steep/pull/546))

data/Gemfile

@@ -7,7 +7,7 @@ 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"

data/Gemfile.lock

@@ -1,12 +1,12 @@
 PATH
   remote: .
   specs:
-    steep (0.52.2)
+    steep (1.0.2)
       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)
@@ -24,7 +24,7 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.2.4)
+    activesupport (7.0.3.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -32,13 +32,13 @@ GEM
     ast (2.4.2)
     concurrent-ruby (1.1.10)
     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.1)
     minitest-hooks (1.5.0)
       minitest (> 5.3)
     minitest-slow_test (0.2.0)
@@ -51,19 +51,19 @@ GEM
     rb-fsevent (0.11.1)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
-    rbs (2.3.2)
+    rbs (2.6.0)
     stackprof (0.2.19)
     terminal-table (3.0.2)
       unicode-display_width (>= 1.1.1, < 3)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.1.0)
+    unicode-display_width (2.2.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  minitest (~> 5.15)
+  minitest (~> 5.16)
   minitest-hooks
   minitest-slow_test
   rake

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)
@@ -674,6 +678,57 @@ module Steep
                   )
                 end
 
+                array_interface.methods[:fetch] = array_interface.methods[:fetch].yield_self do |fetch|
+                  Interface::Interface::Entry.new(
+                    method_types: type.types.flat_map.with_index {|elem_type, index|
+                      [
+                        Interface::MethodType.new(
+                          type_params: [],
+                          type: Interface::Function.new(
+                            params: Interface::Function::Params.build(required: [AST::Types::Literal.new(value: index)]),
+                            return_type: elem_type,
+                            location: nil
+                          ),
+                          block: nil,
+                          method_decls: Set[]
+                        ),
+                        Interface::MethodType.new(
+                          type_params: [Interface::TypeParam.new(name: :T, upper_bound: nil, variance: :invariant, unchecked: false)],
+                          type: Interface::Function.new(
+                            params: Interface::Function::Params.build(
+                              required: [
+                                AST::Types::Literal.new(value: index),
+                                AST::Types::Var.new(name: :T)
+                              ]
+                            ),
+                            return_type: AST::Types::Union.build(types: [elem_type, AST::Types::Var.new(name: :T)]),
+                            location: nil
+                          ),
+                          block: nil,
+                          method_decls: Set[]
+                        ),
+                        Interface::MethodType.new(
+                          type_params: [Interface::TypeParam.new(name: :T, upper_bound: nil, variance: :invariant, unchecked: false)],
+                          type: Interface::Function.new(
+                            params: Interface::Function::Params.build(required: [AST::Types::Literal.new(value: index)]),
+                            return_type: AST::Types::Union.build(types: [elem_type, AST::Types::Var.new(name: :T)]),
+                            location: nil
+                          ),
+                          block: Interface::Block.new(
+                            type: Interface::Function.new(
+                              params: Interface::Function::Params.build(required: [AST::Builtin::Integer.instance_type]),
+                              return_type: AST::Types::Var.new(name: :T),
+                              location: nil
+                            ),
+                            optional: false
+                          ),
+                          method_decls: Set[]
+                        )
+                      ]
+                    } + fetch.method_types
+                  )
+                end
+
                 array_interface.methods[:first] = array_interface.methods[:first].yield_self do |first|
                   Interface::Interface::Entry.new(
                     method_types: [
@@ -712,11 +767,11 @@ module Steep
 
           when Record
             yield_self do
-              key_type = type.elements.keys.map {|value| Literal.new(value: value, location: nil) }.yield_self do |types|
+              all_key_type = type.elements.keys.map {|value| Literal.new(value: value, location: nil) }.yield_self do |types|
                 Union.build(types: types, location: nil)
               end
-              value_type = Union.build(types: type.elements.values, location: nil)
-              hash_type = Builtin::Hash.instance_type(key_type, value_type)
+              all_value_type = Union.build(types: type.elements.values, location: nil)
+              hash_type = Builtin::Hash.instance_type(all_key_type, all_value_type)
 
               interface(hash_type, private: private, self_type: self_type).tap do |hash_interface|
                 hash_interface.methods[:[]] = hash_interface.methods[:[]].yield_self do |ref|
@@ -768,6 +823,54 @@ module Steep
                     } + update.method_types
                   )
                 end
+
+                hash_interface.methods[:fetch] = hash_interface.methods[:fetch].yield_self do |update|
+                  Interface::Interface::Entry.new(
+                    method_types: type.elements.flat_map {|key_value, value_type|
+                      key_type = Literal.new(value: key_value, location: nil)
+
+                      [
+                        Interface::MethodType.new(
+                          type_params: [],
+                          type: Interface::Function.new(
+                            params: Interface::Function::Params.build(required: [key_type]),
+                            return_type: value_type,
+                            location: nil
+                          ),
+                          block: nil,
+                          method_decls: Set[]
+                        ),
+                        Interface::MethodType.new(
+                          type_params: [Interface::TypeParam.new(name: :T, upper_bound: nil, variance: :invariant, unchecked: false)],
+                          type: Interface::Function.new(
+                            params: Interface::Function::Params.build(required: [key_type, AST::Types::Var.new(name: :T)]),
+                            return_type: AST::Types::Union.build(types: [value_type, AST::Types::Var.new(name: :T)]),
+                            location: nil
+                          ),
+                          block: nil,
+                          method_decls: Set[]
+                        ),
+                        Interface::MethodType.new(
+                          type_params: [Interface::TypeParam.new(name: :T, upper_bound: nil, variance: :invariant, unchecked: false)],
+                          type: Interface::Function.new(
+                            params: Interface::Function::Params.build(required: [key_type]),
+                            return_type: AST::Types::Union.build(types: [value_type, AST::Types::Var.new(name: :T)]),
+                            location: nil
+                          ),
+                          block: Interface::Block.new(
+                            type: Interface::Function.new(
+                              params: Interface::Function::Params.build(required: [all_key_type]),
+                              return_type: AST::Types::Var.new(name: :T),
+                              location: nil
+                            ),
+                            optional: false
+                          ),
+                          method_decls: Set[]
+                        )
+                      ]
+                    } + update.method_types
+                  )
+                end
               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

@@ -296,7 +296,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
 

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

@@ -0,0 +1,22 @@
+module Steep
+  module PathHelper
+    module_function
+
+    def to_pathname(uri, dosish: Gem.win_platform?)
+      uri = URI.parse(uri)
+      if uri.scheme == "file"
+        path = uri.path
+        path.sub!(%r{^/([a-zA-Z])(:|%3A)//?}i, '\1:/') if dosish
+        Pathname(path)
+      end
+    end
+
+    def to_uri(path, dosish: Gem.win_platform?)
+      str_path = path.to_s
+      if dosish
+        str_path.insert(0, "/") if str_path[0] != "/"
+      end
+      URI::File.build(path: str_path)
+    end
+  end
+end

data/lib/steep/project.rb

@@ -16,22 +16,10 @@ module Steep
       steepfile_path.parent
     end
 
-    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
+    def relative_path(path)
       path.relative_path_from(base_dir)
+    rescue ArgumentError
+      path
     end
 
     def absolute_path(path)

data/lib/steep/server/base_worker.rb

@@ -69,6 +69,7 @@ module Steep
             end
           end
         end
+        thread.abort_on_exception = true
 
         Steep.logger.tagged "frontend" do
           begin

data/lib/steep/server/change_buffer.rb

@@ -40,7 +40,7 @@ module Steep
 
       def collect_changes(request)
         push_buffer do |changes|
-          path = project.relative_path(Pathname(URI.parse(request[:params][:textDocument][:uri]).path))
+          path = project.relative_path(Steep::PathHelper.to_pathname(request[:params][:textDocument][:uri]))
           version = request[:params][:textDocument][:version]
           Steep.logger.info { "Updating source: path=#{path}, version=#{version}..." }
 

data/lib/steep/server/interaction_worker.rb

@@ -53,8 +53,7 @@ module Steep
         when "textDocument/hover"
           id = request[:id]
 
-          uri = URI.parse(request[:params][:textDocument][:uri])
-          path = project.relative_path(Pathname(uri.path))
+          path = project.relative_path(Steep::PathHelper.to_pathname(request[:params][:textDocument][:uri]))
           line = request[:params][:position][:line]+1
           column = request[:params][:position][:character]
 
@@ -64,8 +63,7 @@ module Steep
           id = request[:id]
 
           params = request[:params]
-          uri = URI.parse(params[:textDocument][:uri])
-          path = project.relative_path(Pathname(uri.path))
+          path = project.relative_path(Steep::PathHelper.to_pathname(params[:textDocument][:uri]))
           line, column = params[:position].yield_self {|hash| [hash[:line]+1, hash[:character]] }
           trigger = params.dig(:context, :triggerCharacter)
 
@@ -144,7 +142,7 @@ module Steep
               decls = sig_service.files[relative_path].decls
               locator = RBS::Locator.new(decls: decls)
 
-              hd, tail = locator.find2(line: job.line, column: job.column)
+              _hd, tail = locator.find2(line: job.line, column: job.column)
 
               namespace = []
               tail.each do |t|

data/lib/steep/server/lsp_formatter.rb

@@ -48,6 +48,18 @@ module Steep
             call = content.method_call
             builder.push do |s|
               case call
+              when TypeInference::MethodCall::Special
+                mt = call.actual_method_type.with(
+                  type: call.actual_method_type.type.with(return_type: call.return_type)
+                )
+                s << <<-EOM
+**💡 Custom typing rule applies**
+
+```rbs
+#{mt.to_s}
+```
+
+                EOM
               when TypeInference::MethodCall::Typed
                 mt = call.actual_method_type.with(
                   type: call.actual_method_type.type.with(return_type: call.return_type)