steep 1.4.0 → 1.5.0.pre.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d0c3f3309cc8169ca1616f43b6bfcaf977339107d6e6e14f7c256d71921b9455
-  data.tar.gz: 0a85c1429383a0321fe2932befbd880942c00df1e788913a4f5c2e3d8abd9479
+  metadata.gz: 18cb0e6ad22037ae5eef2ace2a587c6a11bd3ce8bf4b7a151783fe26155f81ad
+  data.tar.gz: ecdcae004ee4b0c55b0cb7253011bee234cd5a521c8aa70735454ecd1f08137b
 SHA512:
-  metadata.gz: 8ce071dd59d2a6e4c21c9c2114d33603e4628052074b7a6f8500f8e4380ca53dfdd77baac210c1ced711eeccc7da94257baceefdafe5633cbd3932687dab6e8c
-  data.tar.gz: db71a9ab6ca415b266e62b7ef17a34e88dd4135326bae512fcf8fe8051610a6c2259bcf11773f09ebb8192958d96f03154a5a1be955beddc7088f2bfc0bf57a5
+  metadata.gz: cd262e3d39a04dd6a728cbecaa5bd09af17094b8db23877a84e99c2b0a101cb2d78562988779a08c04db3518e653abfe59673a5463b317c0bec948f618ae64c8
+  data.tar.gz: fce4bb70eefb5dc1c7bc86f2b82cbd898f5bf1a90b0342f19e8af1540d387cc67bc6fd299fb7494c0a69cd15953eaa17f7e1ae631f51358f6f87b95a1296b183

data/.gitignore

@@ -10,3 +10,5 @@
 /lib/steep/parser.rb
 /log
 /.gem_rbs_collection
+/.vscode/*
+!/.vscode/steep-shared.code-snippets

data/.vscode/steep-shared.code-snippets

@@ -0,0 +1,41 @@
+{
+	// Place your steep workspace snippets here. Each snippet is defined under a snippet name and has a scope, prefix, body and
+	// description. Add comma separated ids of the languages where the snippet is applicable in the scope field. If scope
+	// is left empty or omitted, the snippet gets applied to all languages. The prefix is what is
+	// used to trigger the snippet and the body will be expanded and inserted. Possible variables are:
+	// $1, $2 for tab stops, $0 for the final cursor position, and ${1:label}, ${2:another} for placeholders.
+	// Placeholders with the same ids are connected.
+	// Example:
+	// "Print to console": {
+	// 	"scope": "javascript,typescript",
+	// 	"prefix": "log",
+	// 	"body": [
+	// 		"console.log('$1');",
+	// 		"$2"
+	// 	],
+	// 	"description": "Log output to console"
+	// }
+
+	"Add type_check_test case": {
+		"scope": "ruby",
+		"body": [
+			"def test_${1:name}",
+			"  run_type_check_test(",
+			"    signatures: {",
+			"      \"a.rbs\" => <<~RBS",
+			"        ${2:rbs}",
+			"      RBS",
+			"    },",
+			"    code: {",
+			"      \"a.rb\" => <<~RUBY",
+      "        ${3:ruby code}",
+			"      RUBY",
+			"    },",
+			"    expectations: <<~YAML",
+			"    YAML",
+			"  )",
+			"end",
+		],
+		"description": "Insert a new test case"
+	}
+}

data/CHANGELOG.md

@@ -2,6 +2,43 @@
 
 ## master
 
+## 1.5.0.pre.1 (2023-07-05)
+
+### Type checker core
+
+* Refactor occurrence typing ([#831](https://github.com/soutaro/steep/pull/831))
+* Better flow-sensitive typing ([#825](https://github.com/soutaro/steep/pull/825))
+* Fix interface type inference ([#816](https://github.com/soutaro/steep/pull/816))
+* Make `nth_ref` and `:back_ref` nodes optional ([#815](https://github.com/soutaro/steep/pull/815))
+* Add new diagnostic for setter methods ([#809](https://github.com/soutaro/steep/pull/809))
+* Better hint type handling given to lambda ([#807](https://github.com/soutaro/steep/pull/807))
+* Fix type assertion parsing error ([#805](https://github.com/soutaro/steep/pull/805))
+* Distribute `untyped` to block params ([#798](https://github.com/soutaro/steep/pull/798))
+* Should escape underscore for method name ([#770](https://github.com/soutaro/steep/pull/770))
+
+### Commandline tool
+
+* Ensure at least one type check worker runs ([#814](https://github.com/soutaro/steep/pull/814))
+* Improve worker process handling ([#801](https://github.com/soutaro/steep/pull/801))
+* Add `Steep::Diagnostic::Ruby.silent` template to suppress all warnings ([#800](https://github.com/soutaro/steep/pull/800))
+* Suppress `UnsupportedSyntax` warnings by default ([#799](https://github.com/soutaro/steep/pull/799))
+* Infer method return types using hint ([#789](https://github.com/soutaro/steep/pull/789))
+* Handling splat nodes in `super` ([#788](https://github.com/soutaro/steep/pull/788))
+* Add handling splat node in tuple type checking ([#786](https://github.com/soutaro/steep/pull/786))
+* Let `return` have multiple values ([#785](https://github.com/soutaro/steep/pull/785))
+* Remove trailing extra space from Steepfile generated by steep init ([#774](https://github.com/soutaro/steep/pull/774))
+
+### Language server
+
+* Fix signature help is not shown for the optional chaining (&.) ([#832](https://github.com/soutaro/steep/pull/832))
+* Completion in annotations ([#818](https://github.com/soutaro/steep/pull/818))
+* Implement *go to type definition* ([#784](https://github.com/soutaro/steep/pull/784))
+
+### Miscellaneous
+
+* Typecheck sources ([#820](https://github.com/soutaro/steep/pull/820))
+* Relax concurrent-ruby requirement ([#812](https://github.com/soutaro/steep/pull/812))
+
 ## 1.4.0 (2023-04-25)
 
 ### Type checker core

data/Gemfile

@@ -3,8 +3,6 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in steep.gemspec
 gemspec
 
-gem "rbs", "~> 3.0.0"
-
 gem "rake"
 gem "minitest", "~> 5.18"
 gem "minitest-hooks"
@@ -13,7 +11,6 @@ group :stackprof, optional: true do
 end
 gem 'minitest-slow_test'
 
-group :ide, optional: true do
-  gem "ruby-debug-ide"
-  gem "debase", ">= 0.2.5.beta2"
+group :development do
+  gem "ruby-lsp", require: false
 end

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    steep (1.4.0)
+    steep (1.5.0.pre.1)
       activesupport (>= 5.1)
-      concurrent-ruby (>= 1.2.2)
+      concurrent-ruby (>= 1.1.10)
       csv (>= 3.0.9)
       fileutils (>= 1.1.0)
       json (>= 2.1.0)
@@ -12,7 +12,7 @@ PATH
       logger (>= 1.3.0)
       parser (>= 3.1)
       rainbow (>= 2.2.2, < 4.0)
-      rbs (>= 2.8.0)
+      rbs (>= 3.1.0)
       securerandom (>= 0.1)
       strscan (>= 1.0.0)
       terminal-table (>= 2, < 4)
@@ -20,20 +20,17 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.4.3)
+    activesupport (7.0.6)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
     ast (2.4.2)
     concurrent-ruby (1.2.2)
-    csv (3.2.6)
-    debase (0.2.5.beta2)
-      debase-ruby_core_source (>= 0.10.12)
-    debase-ruby_core_source (3.2.0)
+    csv (3.2.7)
     ffi (1.15.5)
     fileutils (1.7.1)
-    i18n (1.12.0)
+    i18n (1.14.1)
       concurrent-ruby (~> 1.0)
     json (2.6.3)
     language_server-protocol (3.17.0.3)
@@ -41,24 +38,32 @@ GEM
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
     logger (1.5.3)
-    minitest (5.18.0)
+    minitest (5.18.1)
     minitest-hooks (1.5.0)
       minitest (> 5.3)
     minitest-slow_test (0.2.0)
       minitest (>= 5.0)
-    parser (3.2.2.1)
+    parser (3.2.2.3)
       ast (~> 2.4.1)
+      racc
+    prettier_print (1.2.1)
+    racc (1.7.1)
     rainbow (3.1.1)
     rake (13.0.6)
     rb-fsevent (0.11.2)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
-    rbs (3.0.4)
-    ruby-debug-ide (0.7.3)
-      rake (>= 0.8.1)
+    rbs (3.1.0)
+    ruby-lsp (0.5.1)
+      language_server-protocol (~> 3.17.0)
+      sorbet-runtime
+      syntax_tree (>= 6.1.1, < 7)
     securerandom (0.2.2)
+    sorbet-runtime (0.5.10832)
     stackprof (0.2.25)
     strscan (3.0.6)
+    syntax_tree (6.1.1)
+      prettier_print (>= 1.2.0)
     terminal-table (3.0.2)
       unicode-display_width (>= 1.1.1, < 3)
     tzinfo (2.0.6)
@@ -69,13 +74,11 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  debase (>= 0.2.5.beta2)
   minitest (~> 5.18)
   minitest-hooks
   minitest-slow_test
   rake
-  rbs (~> 3.0.0)
-  ruby-debug-ide
+  ruby-lsp
   stackprof
   steep!
 

data/Gemfile.steep

@@ -1,3 +1,3 @@
 source "https://rubygems.org"
 
-gem 'steep', '~> 1.4.0.dev', require: false
+gem 'steep', require: false

data/Gemfile.steep.lock

@@ -1,7 +1,7 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.4.3)
+    activesupport (7.0.5)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -11,7 +11,7 @@ GEM
     csv (3.2.6)
     ffi (1.15.5)
     fileutils (1.7.1)
-    i18n (1.12.0)
+    i18n (1.13.0)
       concurrent-ruby (~> 1.0)
     json (2.6.3)
     language_server-protocol (3.17.0.3)
@@ -20,15 +20,15 @@ GEM
       rb-inotify (~> 0.9, >= 0.9.10)
     logger (1.5.3)
     minitest (5.18.0)
-    parser (3.2.2.0)
+    parser (3.2.2.1)
       ast (~> 2.4.1)
     rainbow (3.1.1)
     rb-fsevent (0.11.2)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
-    rbs (3.0.4)
+    rbs (3.1.0)
     securerandom (0.2.2)
-    steep (1.4.0.dev.5)
+    steep (1.4.0)
       activesupport (>= 5.1)
       concurrent-ruby (>= 1.2.2)
       csv (>= 3.0.9)
@@ -55,7 +55,7 @@ PLATFORMS
   arm64-darwin-22
 
 DEPENDENCIES
-  steep (~> 1.4.0.dev)
+  steep
 
 BUNDLED WITH
    2.3.15

data/Rakefile

@@ -20,3 +20,201 @@ namespace :test do
     sh "ruby", "bin/output_test.rb"
   end
 end
+
+Rake::Task[:release].enhance do
+  Rake::Task[:"release:note"].invoke
+  Rake::Task[:"release:github"].invoke
+  Rake::Task[:"release:release-prs"].invoke
+end
+
+desc "Generate changelog template from GH pull requests"
+task :changelog do
+  major, minor, patch, pre = Steep::VERSION.split(".", 4)
+  major = major.to_i
+  minor = minor.to_i
+  patch = patch.to_i
+
+  if patch == 0
+    milestone = "Steep #{major}.#{minor}"
+  else
+    milestone = "Steep #{major}.#{minor}.x"
+  end
+
+  puts "🔍 Finding pull requests that is associated to milestone `#{milestone}`..."
+
+  command = [
+    "gh",
+    "pr",
+    "list",
+    "--json",
+    "url,title,number",
+    "--search" ,
+    "milestone:\"#{milestone}\" is:merged sort:updated-desc -label:Released"
+  ]
+
+  require "open3"
+  output, status = Open3.capture2(*command)
+  raise status.inspect unless status.success?
+
+  require "json"
+  json = JSON.parse(output, symbolize_names: true)
+
+  unless json.empty?
+    puts
+    json.each do |line|
+      puts "* #{line[:title]} ([##{line[:number]}](#{line[:url]}))"
+    end
+  else
+    puts "  (🤑 There is no *unreleased* pull request associated to the milestone.)"
+  end
+end
+
+namespace :release do
+  desc "Ensure release note"
+  task :note do
+    version = Gem::Version.new(Steep::VERSION)
+    major, minor, patch, pre = Steep::VERSION.split(".", 4)
+    major = major.to_i
+    minor = minor.to_i
+    patch = patch.to_i
+
+    wiki_url = "https://github.com/soutaro/steep/wiki/Release-Note-#{major}.#{minor}"
+
+    puts "🧐 Checking if Release note page already exists..."
+
+    unless `curl --silent -o/dev/null --head #{wiki_url} -w '%{http_code}'` == "200"
+      pre_flag = version.prerelease? ? " --pre" : ""
+      pre_requirement = version.prerelease? ? ", '~> #{major}.#{minor}.#{patch}.#{pre}'" : ""
+
+      puts "----"
+
+      puts <<~PREFIX if patch
+        **The latest version of Steep #{major}.#{minor} is `#{pre}`.**
+
+      PREFIX
+
+      puts <<~TEMPLATE
+        Some of the highlights in Steep #{major}.#{minor} are:
+
+        * New feature 1 (URL)
+        * New feature 2 (URL)
+        * New feature 3 (URL)
+
+        You can install it with `$ gem install steep#{pre_flag}` or using Bundler.
+
+        ```rb
+        gem 'steep', require: false#{pre_requirement}
+        ```
+
+        See the [CHANGELOG](https://github.com/soutaro/steep/blob/master/CHANGELOG.md) for the details.
+
+        ## New feature 1
+
+        ## New feature 2
+
+        ## New feature 3
+
+        ## Diagnostics updates
+
+        ## Updating Steep
+
+      TEMPLATE
+      puts "----"
+      puts
+
+      puts "  ⏩️ Create the release note with the template: #{wiki_url}"
+    else
+      if patch == 0 || version.prerelease?
+        puts "  ⏩️ Open the release note and update it at: #{wiki_url}"
+      else
+        puts "  ✅ Release note is ready!"
+      end
+    end
+    puts
+  end
+
+  desc "Create GitHub release automatically"
+  task :github do
+    version = Gem::Version.new(Steep::VERSION)
+    major, minor, patch, *_ = Steep::VERSION.split(".")
+    major = major.to_i
+    minor = minor.to_i
+    patch = patch.to_i
+
+    puts "✏️ Making a draft release on GitHub..."
+
+    content = File.read(File.join(__dir__, "CHANGELOG.md"))
+    changelog = content.scan(/^## \d.*?(?=^## \d)/m)[0]
+    changelog = changelog.sub(/^.*\n^.*\n/, "").rstrip
+
+    notes = <<NOTES
+[Release note](https://github.com/soutaro/steep/wiki/Release-Note-#{major}.#{minor})
+
+#{changelog}
+NOTES
+
+    command = [
+      "gh",
+      "release",
+      "create",
+      "--draft",
+      "v#{Steep::VERSION}",
+      "--title=#{Steep::VERSION}",
+      "--notes=#{notes}"
+    ]
+
+    if version.prerelease?
+      command << "--prerelease"
+    end
+
+    require "open3"
+    output, status = Open3.capture2(*command)
+    if status.success?
+      puts "  ⏩️ Done! Open #{output.chomp} and publish the release!"
+      puts
+    end
+  end
+
+  desc "Add `Released` labels to pull requests associated to the version"
+  task "release-prs" do
+    major, minor, patch, pre = Steep::VERSION.split(".", 4)
+    major = major.to_i
+    minor = minor.to_i
+    patch = patch.to_i
+
+    if patch == 0
+      milestone = "Steep #{major}.#{minor}"
+    else
+      milestone = "Steep #{major}.#{minor}.x"
+    end
+
+    puts "🔍 Finding pull requests that is associated to milestone `#{milestone}`..."
+
+    command = [
+      "gh",
+      "pr",
+      "list",
+      "--json",
+      "url,title,number",
+      "--search" ,
+      "milestone:\"#{milestone}\" is:merged sort:updated-desc -label:Released"
+    ]
+
+    require "open3"
+    output, status = Open3.capture2(*command)
+    raise status.inspect unless status.success?
+
+    require "json"
+    json = JSON.parse(output, symbolize_names: true)
+
+    puts "  ✅ Found #{json.size} PRs..."
+
+    json.each do |pr|
+      puts "🧐 Updating #{pr[:url]}..."
+      output, status = Open3.capture2("gh", "pr", "edit", pr[:number].to_s, "--add-label", "Released")
+      raise status.inspect unless status.success?
+      puts "  ✅ Done!"
+      sleep 0.5
+    end
+  end
+end

data/Steepfile

@@ -2,6 +2,8 @@ D = Steep::Diagnostic
 
 target :app do
   check "lib"
+  ignore "lib/steep/shims"
+  
   signature "sig"
 
   collection_config "rbs_collection.steep.yaml"
@@ -15,7 +17,7 @@ target :app do
 
   definition = Bundler::Definition.build(Pathname("Gemfile"), Pathname("Gemfile.lock"), nil)
   rbs_dep = definition.dependencies.find {|dep| dep.name == "rbs" }
-  if (source = rbs_dep.source).is_a?(Bundler::Source::Path)
+  if (source = rbs_dep&.source).is_a?(Bundler::Source::Path)
     unless Pathname(tmp_rbs_dir).exist?
       FileUtils.ln_s(Pathname.pwd + source.path + "sig", tmp_rbs_dir, force: true)
     end

data/lib/steep/ast/builtin.rb

@@ -29,20 +29,22 @@ module Steep
           if type.is_a?(Types::Name::Instance)
             if args
               arity == args.size or raise "Malformed instance type: name=#{module_name}, args=#{args}"
-              type.name == module_name && type.args == args
+              if type.name == module_name && type.args == args
+                type
+              end
             else
-              type.name == module_name && type.args.size == arity
+              if type.name == module_name && type.args.size == arity
+                type
+              end
             end
-          else
-            false
           end
         end
 
         def module_type?(type)
           if type.is_a?(Types::Name::Singleton)
-            type.name == module_name
-          else
-            false
+            if type.name == module_name
+              type
+            end
           end
         end
       end

data/lib/steep/ast/node/type_application.rb

@@ -24,7 +24,7 @@ module Steep
           location.source
         end
 
-        def types(context, factory, type_vars)
+        def types(context, subtyping, type_vars)
           # @type var types: Array[Types::t]
           types = []
 
@@ -32,8 +32,16 @@ module Steep
 
           while true
             ty = RBS::Parser.parse_type(loc.buffer, range: loc.range, variables: type_vars) or break
-            ty = factory.type(ty)
-            types << factory.absolute_type(ty, context: context)
+
+            validator = Signature::Validator.new(checker: subtyping)
+            validator.validate_type(ty)
+
+            if validator.has_error?
+              return
+            end
+
+            ty = subtyping.factory.type(ty)
+            types << subtyping.factory.absolute_type(ty, context: context)
 
             match = RBS::Location.new(loc.buffer, ty.location.end_pos, type_location.end_pos).source.match(/\A\s*,\s*/) or break
             offset = match.length
@@ -45,8 +53,8 @@ module Steep
           exn
         end
 
-        def types?(context, factory, type_vars)
-          case types = types(context, factory, type_vars)
+        def types?(context, subtyping, type_vars)
+          case types = types(context, subtyping, type_vars)
           when RBS::ParsingError
             nil
           else

data/lib/steep/ast/node/type_assertion.rb

@@ -16,10 +16,15 @@ module Steep
           location.start_line
         end
 
-        def type(context, factory, type_vars)
-          if ty = RBS::Parser.parse_type(type_location.buffer, range: type_location.range, variables: type_vars)
-            ty = factory.type(ty)
-            factory.absolute_type(ty, context: context)
+        def type(context, subtyping, type_vars)
+          if ty = RBS::Parser.parse_type(type_location.buffer, range: type_location.range, variables: type_vars, require_eof: true)
+            validator = Signature::Validator.new(checker: subtyping)
+            validator.validate_type(ty)
+
+            unless validator.has_error?
+              ty = subtyping.factory.type(ty)
+              subtyping.factory.absolute_type(ty, context: context)
+            end
           else
             nil
           end
@@ -27,9 +32,18 @@ module Steep
           exn
         end
 
-        def type?(context, factory, type_vars)
-          case type = type(context, factory, type_vars)
-          when RBS::ParsingError
+        def type_syntax?
+          RBS::Parser.parse_type(type_location.buffer, range: type_location.range, variables: [], require_eof: true)
+          true
+        rescue::RBS::ParsingError
+          false
+        end
+
+        def type?(context, subtyping, type_vars)
+          type = type(context, subtyping, type_vars)
+
+          case type
+          when RBS::ParsingError, nil
             nil
           else
             type
@@ -46,8 +60,13 @@ module Steep
         end
 
         def self.parse(location)
-          if location.source =~/\A:\s*(.+)/
-            TypeAssertion.new(location)
+          source = location.source.strip
+
+          if source =~/\A:\s*(.+)/
+            assertion = TypeAssertion.new(location)
+            if assertion.type_syntax?
+              assertion
+            end
           end
         end
       end

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

@@ -348,8 +348,15 @@ module Steep
           acc
         end
 
-        def unwrap_optional(type)
+        def partition_union(type)
           case type
+          when AST::Types::Name::Alias
+            unfold = expand_alias(type)
+            if unfold == type
+              [type, type]
+            else
+              partition_union(unfold)
+            end
           when AST::Types::Union
             falsy_types, truthy_types = type.types.partition do |type|
               (type.is_a?(AST::Types::Literal) && type.value == false) ||
@@ -357,15 +364,40 @@ module Steep
             end
 
             [
-              AST::Types::Union.build(types: truthy_types),
-              AST::Types::Union.build(types: falsy_types)
+              truthy_types.empty? ? nil : AST::Types::Union.build(types: truthy_types),
+              falsy_types.empty? ? nil : AST::Types::Union.build(types: falsy_types)
             ]
-          when AST::Types::Name::Alias
-            unwrap_optional(expand_alias(type))
-          when AST::Types::Boolean
+          when AST::Types::Any, AST::Types::Boolean
             [type, type]
+          when AST::Types::Nil
+            [nil, type]
+          when AST::Types::Literal
+            if type.value == false
+              [nil, type]
+            else
+              [type, nil]
+            end
+          else
+            [type, nil]
+          end
+        end
+
+        def unwrap_optional(type)
+          case type
+          when AST::Types::Union
+            unwrap = type.types.filter_map do |type|
+              unless type.is_a?(AST::Types::Nil)
+                type
+              end
+            end
+
+            unless unwrap.empty?
+              AST::Types::Union.build(types: unwrap)
+            end
+          when AST::Types::Nil
+            nil
           else
-            [type, AST::Types::Bot.new()]
+            type
           end
         end