steep 1.5.0 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 77aea7baf36285cf4a5b0941e63cc8f5f95d52132d3a5d4933a396a79b949721
-  data.tar.gz: 2506370595dde6633abbab74b1e370d435579415a154b4a82b4da3bb1b065627
+  metadata.gz: d7775c9db83acf70b19f27b4983923ee40e8d1a39043c981726573b0c06eb1c8
+  data.tar.gz: 1d9f2753a19a577cce778f6ec1ee924534523812764c0350c21280d82a0e1c69
 SHA512:
-  metadata.gz: 6f3190f0ca65a931f9c88d99cbd67836478d754439b5630b1b68f89e9fa6d84a84cc8bde32335d4bdb38b3f13aefaeaf93a75b53722a0b6841eab27e9b689ed8
-  data.tar.gz: 94576f1eedcb8c46ca8228e84e4100e860c0e3ed2a28dc209afa80abdeeed188118f1589dcb15d0a8edb0cd8c751f611035a15b613d284113c8cbebcce42dc6e
+  metadata.gz: 6bd6340dfecc114df47a959d25a4201a87ccccbc0b1e59238962de51c28218b01aa25499ae8a760e678481192131dfdd3c99b6c89412ce4b6e0b3fad2bf34ca5
+  data.tar.gz: 87437181a053c65f297192eb9e339c0b58ad074d4c6716eef2a1019116d3ed06d0525eebcc49855ae99a8393bffac82640d77f608479b98f67e158b42c54d327

data/CHANGELOG.md

@@ -2,6 +2,18 @@
 
 ## master
 
+## 1.5.1 (2023-07-20)
+
+### Type checker core
+
+* Support unreachable branch detection with `elsif` ([#879](https://github.com/soutaro/steep/pull/879))
+* Give an optional type hint to lhs of `||` ([#874](https://github.com/soutaro/steep/pull/874))
+
+### Miscellaneous
+
+* Update steep ([#878](https://github.com/soutaro/steep/pull/878))
+* Update inline type comments ([#875](https://github.com/soutaro/steep/pull/875))
+
 ## 1.5.0 (2023-07-13)
 
 ### Type checker core

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    steep (1.5.0)
+    steep (1.5.1)
       activesupport (>= 5.1)
       concurrent-ruby (>= 1.1.10)
       csv (>= 3.0.9)
@@ -53,7 +53,7 @@ GEM
     rb-fsevent (0.11.2)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
-    rbs (3.1.0)
+    rbs (3.1.1)
     ruby-lsp (0.5.1)
       language_server-protocol (~> 3.17.0)
       sorbet-runtime

data/Gemfile.steep.lock

@@ -1,17 +1,17 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.5)
+    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)
+    csv (3.2.7)
     ffi (1.15.5)
     fileutils (1.7.1)
-    i18n (1.13.0)
+    i18n (1.14.1)
       concurrent-ruby (~> 1.0)
     json (2.6.3)
     language_server-protocol (3.17.0.3)
@@ -19,18 +19,20 @@ GEM
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
     logger (1.5.3)
-    minitest (5.18.0)
-    parser (3.2.2.1)
+    minitest (5.18.1)
+    parser (3.2.2.3)
       ast (~> 2.4.1)
+      racc
+    racc (1.7.1)
     rainbow (3.1.1)
     rb-fsevent (0.11.2)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
-    rbs (3.1.0)
+    rbs (3.1.1)
     securerandom (0.2.2)
-    steep (1.4.0)
+    steep (1.5.0)
       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)
@@ -39,7 +41,7 @@ GEM
       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)

data/Steepfile

@@ -3,13 +3,12 @@ D = Steep::Diagnostic
 target :app do
   check "lib"
   ignore "lib/steep/shims"
-  
+
   signature "sig"
 
   collection_config "rbs_collection.steep.yaml"
 
-  configure_code_diagnostics do |hash|             # You can setup everything yourself
-    hash[D::Ruby::MethodDefinitionMissing] = :hint
+  configure_code_diagnostics(D::Ruby.strict) do |hash|
   end
 
   FileUtils.mkpath("tmp")

data/lib/steep/ast/annotation/collection.rb

@@ -110,20 +110,20 @@ module Steep
         end
 
         def lvar_types
-          var_type_annotations.each_key.with_object({}) do |name, hash|
-            hash[name] = var_type(lvar: name)
+          var_type_annotations.each_key.with_object({}) do |name, hash| #$ Hash[Symbol, Types::t]
+            hash[name] = var_type(lvar: name) || raise
           end
         end
 
         def ivar_types
-          ivar_type_annotations.each_key.with_object({}) do |name, hash|
-            hash[name] = var_type(ivar: name)
+          ivar_type_annotations.each_key.with_object({}) do |name, hash| #$ Hash[Symbol, Types::t]
+            hash[name] = var_type(ivar: name) || raise
           end
         end
 
         def const_types
-          const_type_annotations.each_key.with_object({}) do |name, hash|
-            hash[name] = var_type(const: name)
+          const_type_annotations.each_key.with_object({}) do |name, hash| #$ Hash[RBS::TypeName, Types::t]
+            hash[name] = var_type(const: name) || raise
           end
         end
 

data/lib/steep/diagnostic/ruby.rb

@@ -841,7 +841,6 @@ module Steep
       end
 
       class UnexpectedError < Base
-        attr_reader :message
         attr_reader :error
 
         def initialize(node:, error:)
@@ -850,7 +849,28 @@ module Steep
         end
 
         def header_line
-          "UnexpectedError: #{error.message}"
+          "UnexpectedError: #{error.message}(#{error.class})"
+        end
+
+        def detail_lines
+          if trace = error.backtrace
+            io = StringIO.new
+
+            total = trace.size
+            if total > 30
+              trace = trace.take(15)
+            end
+
+            trace.each.with_index do |line, index|
+              io.puts "#{index+1}. #{line}"
+            end
+
+            if trace.size != total
+              io.puts "  (#{total - trace.size} more backtrace)"
+            end
+
+            io.string
+          end
         end
       end
 

data/lib/steep/drivers/checkfile.rb

@@ -168,8 +168,7 @@ module Steep
 
         Steep.logger.info { "Starting type checking: #{request_guid}" }
 
-        diagnostic_notifications = []
-        error_messages = []
+        error_messages = [] #: Array[String]
         client_reader.read do |response|
           case
           when response[:method] == "textDocument/publishDiagnostics"

data/lib/steep/drivers/stats.rb

@@ -54,7 +54,7 @@ module Steep
         end
 
         def print(stats_result)
-          rows = []
+          rows = [] #: Array[Array[untyped]]
           stats_result.sort_by {|row| row[:path] }.each do |row|
             if row[:type] == "success"
               rows << [

data/lib/steep/interface/function.rb

@@ -471,8 +471,8 @@ module Steep
 
           # For overloading
           def +(other)
-            requireds = {}
-            optionals = {}
+            requireds = {} #: Hash[Symbol, AST::Types::t]
+            optionals = {} #: Hash[Symbol, AST::Types::t]
 
             all_keys = Set[] + self.requireds.keys + self.optionals.keys + other.requireds.keys + other.optionals.keys
             all_keys.each do |key|
@@ -535,8 +535,8 @@ module Steep
 
           # For union
           def |(other)
-            requireds = {}
-            optionals = {}
+            requireds = {} #: Hash[Symbol, AST::Types::t]
+            optionals = {} #: Hash[Symbol, AST::Types::t]
 
             all_keys = Set[] + self.requireds.keys + self.optionals.keys + other.requireds.keys + other.optionals.keys
             all_keys.each do |key|
@@ -600,8 +600,8 @@ module Steep
 
           # For intersection
           def &(other)
-            requireds = {}
-            optionals = {}
+            requireds = {} #: Hash[Symbol, AST::Types::t]
+            optionals = {} #: Hash[Symbol, AST::Types::t]
 
             all_keys = Set[] + self.requireds.keys + self.optionals.keys + other.requireds.keys + other.optionals.keys
             all_keys.each do |key|
@@ -665,7 +665,7 @@ module Steep
         end
 
         def required
-          array = []
+          array = [] #: Array[AST::Types::t]
 
           positional_params&.each do |param|
             case param
@@ -680,7 +680,7 @@ module Steep
         end
 
         def optional
-          array = []
+          array = [] #: Array[AST::Types::t]
 
           positional_params&.each do |param|
             case param

data/lib/steep/project/dsl.rb

@@ -66,7 +66,7 @@ module Steep
         def typing_options(level = nil, **hash)
           Steep.logger.error "#typing_options is deprecated and has no effect as of version 0.46.0. Update your Steepfile as follows for (almost) equivalent setting:"
 
-          messages = []
+          messages = [] #: Array[String]
 
           messages << "# D = Steep::Diagnostic                          # Define a constant to shorten namespace"
 
@@ -83,7 +83,7 @@ module Steep
             Steep.logger.error "  #{msg}"
           end
 
-          config = []
+          config = [] #: Array[String]
 
           if hash[:allow_missing_definitions]
             config << "hash[D::Ruby::MethodDefinitionMissing] = nil   # allow_missing_definitions"

data/lib/steep/server/interaction_worker.rb

@@ -122,7 +122,7 @@ module Steep
               items = begin
                         provider.run(line: job.line, column: job.column)
                       rescue Parser::SyntaxError
-                        []
+                        [] #: Array[Services::CompletionProvider::item]
                       end
 
               completion_items = items.map do |item|
@@ -157,7 +157,7 @@ module Steep
                 locator = RBS::Locator.new(buffer: buffer, dirs: dirs, decls: decls)
 
                 _hd, tail = locator.find2(line: job.line, column: job.column)
-                tail ||= []
+                tail ||= [] #: Array[RBS::Locator::component]
 
                 tail.reverse_each do |t|
                   case t

data/lib/steep/subtyping/check.rb

@@ -430,7 +430,7 @@ module Steep
               when AST::Types::Name::Singleton
                 singleton_super_types(relation.sub_type.name)
               else
-                []
+                [] #: Array[super_type]
               end
 
             unless possible_sub_types.empty?
@@ -743,7 +743,7 @@ module Steep
             args.each {|arg| constraints.unknown!(arg.name) }
 
             upper_bounds = {}
-            relations = []
+            relations = [] #: Array[Relation]
 
             args.zip(sub_type.type_params, super_type.type_params).each do |arg, sub_param, sup_param|
               sub_ub = sub_param.upper_bound

data/lib/steep/subtyping/constraints.rb

@@ -249,8 +249,8 @@ module Steep
           class_type = context.class_type
         end
 
-        vars = []
-        types = []
+        vars = [] #: Array[Symbol]
+        types = [] #: Array[AST::Types::t]
 
         dictionary.each_key do |var|
           if variables.include?(var)

data/lib/steep/type_construction.rb

@@ -1778,7 +1778,10 @@ module Steep
           yield_self do
             left_node, right_node = node.children
 
-            left_type, constr, left_context = synthesize(left_node, hint: hint, condition: true).to_ary
+            if hint
+              left_hint = union_type_unify(hint, AST::Builtin.nil_type, AST::Builtin.false_type)
+            end
+            left_type, constr, left_context = synthesize(left_node, hint: left_hint, condition: true).to_ary
 
             interpreter = TypeInference::LogicTypeInterpreter.new(subtyping: checker, typing: typing, config: builder_config)
             left_truthy, left_falsy = interpreter.eval(env: left_context.type_env, node: left_node)
@@ -1888,7 +1891,7 @@ module Steep
                 if loc.respond_to?(:keyword)
                   condition_loc = loc #: NodeHelper::condition_loc
                   case condition_loc.keyword.source
-                  when "if"
+                  when "if", "elsif"
                     location = condition_loc.begin || condition_loc.keyword
                   when "unless"
                     # `else` token always exists
@@ -1913,8 +1916,9 @@ module Steep
 
                 if loc.respond_to?(:keyword)
                   condition_loc = loc #: NodeHelper::condition_loc
+
                   case condition_loc.keyword.source
-                  when "if"
+                  when "if", "elsif"
                     # `else` token always exists
                     location = condition_loc.else || raise
                   when "unless"

data/lib/steep/type_inference/type_env.rb

@@ -9,7 +9,7 @@ module Steep
       attr_reader :pure_method_calls
 
       def to_s
-        array = []
+        array = [] #: Array[String]
 
         local_variable_types.each do |name, entry|
           if enforced_type = entry[1]
@@ -108,7 +108,7 @@ module Steep
       end
 
       def assign_local_variables(assignments)
-        local_variable_types = {}
+        local_variable_types = {} #: Hash[Symbol, local_variable_entry]
         invalidated_nodes = Set[]
 
         assignments.each do |name, new_type|
@@ -135,7 +135,7 @@ module Steep
       end
 
       def refine_types(local_variable_types: {}, pure_call_types: {})
-        local_variable_updates = {}
+        local_variable_updates = {} #: Hash[Symbol, local_variable_entry]
 
         local_variable_types.each do |name, type|
           local_variable_name!(name)

data/lib/steep/version.rb

@@ -1,3 +1,3 @@
 module Steep
-  VERSION = "1.5.0"
+  VERSION = "1.5.1"
 end

data/sample/lib/conference.rb

@@ -32,3 +32,8 @@ class HogeHoge
     bar(self, ...).to_s
   end
 end
+
+
+
+conference = nil #: Conference?
+

data/sig/steep/ast/annotation/collection.rbs

@@ -2,7 +2,7 @@ module Steep
   module AST
     module Annotation
       class Collection
-        attr_reader annotations: untyped
+        attr_reader annotations: Array[Annotation::t]
 
         attr_reader factory: Types::Factory
 
@@ -14,31 +14,34 @@ module Steep
 
         attr_reader ivar_type_annotations: Hash[Symbol, IvarType]
 
-        attr_reader method_type_annotations: untyped
+        attr_reader method_type_annotations: Hash[Symbol, MethodType?]
 
-        attr_reader block_type_annotation: untyped
+        attr_reader block_type_annotation: BlockType?
 
-        attr_reader return_type_annotation: untyped
+        attr_reader return_type_annotation: ReturnType?
 
-        attr_reader self_type_annotation: untyped
+        attr_reader self_type_annotation: SelfType?
 
-        attr_reader instance_type_annotation: untyped
+        attr_reader instance_type_annotation: InstanceType?
 
-        attr_reader module_type_annotation: untyped
+        attr_reader module_type_annotation: ModuleType?
 
         attr_reader implement_module_annotation: Implements?
 
-        attr_reader dynamic_annotations: untyped
+        attr_reader dynamic_annotations: Array[Dynamic]
 
-        attr_reader break_type_annotation: untyped
+        attr_reader break_type_annotation: BreakType?
 
-        def initialize: (annotations: untyped, factory: untyped, context: untyped) -> void
+        def initialize: (annotations: Array[Annotation::t], factory: Types::Factory, context: RBS::Resolver::context) -> void
 
-        def absolute_type: (untyped `type`) -> (untyped | nil)
+        def absolute_type: (Types::t) -> Types::t
+                         | (Types::t?) -> Types::t?
 
-        def var_type: (?lvar: untyped?, ?ivar: untyped?, ?const: untyped?) -> untyped
+        def var_type: (lvar: Symbol) -> Types::t?
+                    | (ivar: Symbol) -> Types::t?
+                    | (const: RBS::TypeName) -> Types::t?
 
-        def method_type: (untyped name) -> (untyped | nil)
+        def method_type: (Symbol name) -> Interface::MethodType?
 
         %a{pure} def block_type: () -> Types::t?
 
@@ -52,23 +55,23 @@ module Steep
 
         %a{pure} def break_type: () -> Types::t?
 
-        def lvar_types: () -> untyped
+        def lvar_types: () -> Hash[Symbol, Types::t]
 
-        def ivar_types: () -> untyped
+        def ivar_types: () -> Hash[Symbol, Types::t]
 
-        def const_types: () -> untyped
+        def const_types: () -> Hash[RBS::TypeName, Types::t]
 
-        def instance_dynamics: () -> untyped
+        def instance_dynamics: () -> Array[Symbol]
 
-        def module_dynamics: () -> untyped
+        def module_dynamics: () -> Array[Symbol]
 
-        def merge_block_annotations: (untyped annotations) -> untyped
+        def merge_block_annotations: (Collection annotations) -> Collection
 
-        def any?: () { () -> untyped } -> untyped
+        def any?: () { (Annotation::t) -> boolish } -> bool
 
-        def size: () -> untyped
+        def size: () -> Integer
 
-        def include?: (untyped obj) -> untyped
+        def include?: (Annotation::t obj) -> bool
       end
     end
   end

data/sig/steep/diagnostic/ruby.rbs

@@ -546,11 +546,9 @@ module Steep
       end
 
       class UnexpectedError < Base
-        attr_reader message: untyped
-
-        attr_reader error: untyped
+        attr_reader error: Exception
 
-        def initialize: (node: untyped, error: untyped) -> void
+        def initialize: (node: Parser::AST::Node, error: Exception) -> void
 
         def header_line: () -> ::String
       end

data/smoke/unexpected/test_expectations.yml

@@ -1,16 +1,4 @@
 ---
-- file: unexpected.rb
-  diagnostics:
-  - range:
-      start:
-        line: 1
-        character: 0
-      end:
-        line: 1
-        character: 14
-    severity: ERROR
-    message: 'UnexpectedError: unexpected.rbs:2:17...2:24: Could not find String1'
-    code: Ruby::UnexpectedError
 - file: unexpected.rbs
   diagnostics:
   - range:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: steep
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.5.1
 platform: ruby
 authors:
 - Soutaro Matsumoto
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-07-13 00:00:00.000000000 Z
+date: 2023-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser
@@ -266,7 +266,6 @@ files:
 - lib/steep/ast/builtin.rb
 - lib/steep/ast/node/type_application.rb
 - lib/steep/ast/node/type_assertion.rb
-- lib/steep/ast/type_params.rb
 - lib/steep/ast/types/any.rb
 - lib/steep/ast/types/boolean.rb
 - lib/steep/ast/types/bot.rb
@@ -401,7 +400,6 @@ files:
 - sig/steep/ast/builtin.rbs
 - sig/steep/ast/node/type_application.rbs
 - sig/steep/ast/node/type_assertion.rbs
-- sig/steep/ast/type_params.rbs
 - sig/steep/ast/types.rbs
 - sig/steep/ast/types/any.rbs
 - sig/steep/ast/types/boolean.rbs
@@ -757,7 +755,6 @@ files:
 - smoke/type_case/test_expectations.yml
 - smoke/unexpected/Steepfile
 - smoke/unexpected/test_expectations.yml
-- smoke/unexpected/unexpected.rb
 - smoke/unexpected/unexpected.rbs
 - smoke/yield/Steepfile
 - smoke/yield/a.rb

data/lib/steep/ast/type_params.rb

@@ -1,13 +0,0 @@
-module Steep
-  module AST
-    class TypeParams
-      attr_reader :location
-      attr_reader :variables
-
-      def initialize(location: nil, variables:)
-        @location = location
-        @variables = variables
-      end
-    end
-  end
-end

data/sig/steep/ast/type_params.rbs

@@ -1,11 +0,0 @@
-# module Steep
-#   module AST
-#     class TypeParams
-#       attr_reader location: untyped
-
-#       attr_reader variables: untyped
-
-#       def initialize: (variables: untyped, ?location: untyped?) -> void
-#     end
-#   end
-# end

data/smoke/unexpected/unexpected.rb

@@ -1 +0,0 @@
-Unexpected.new.foo().bar