steep 1.9.0 → 1.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f7a4597973dff6192b6977a32875ed18b7da16a70d34bf5e811cb8a719b18d5
-  data.tar.gz: 8b9ec7e28728c0f6e35e962fed6dd8a43828d41763ae2ffce831b787a501b200
+  metadata.gz: 522d134347810d1fbb030d139f616077fcc197aabe079bf14453305c9c9562bd
+  data.tar.gz: bd6a1a97a815c02ba20160d6bc1bd2166c1a02cdee3901c2a84fca2fe1b22d0b
 SHA512:
-  metadata.gz: f11cb6ec05bc38e2e8130b7e6860409c63a9d1ba3ef93ca14dcc3781800c00d97e59506343e8191c97741865a1fa1895dfd9ff69928b574df423e32983a315b5
-  data.tar.gz: d6b544a988c8f0adae6705a5b7085907bb7148dde0eeb857a3aae7b9c44b2787f47ea40aa1c0b54b5d5da650f07e4f94e0a754ead23baca844cb2f21ae6c7eaa
+  metadata.gz: 254fb6ef3b682ea7866e2892755e183bcd8ed797f4209faf999f40cdcb140a67083c73684ba80273cbf2e563650a2213114c474a2e0d3e50cc6d0cdc5d05caf0
+  data.tar.gz: b5daeab25121a44e5e9ad4a353de77115f7f626c0f5ac9342c1fe0ac061eabf75cbf3fef26a3b651d0b4849a0c05d5c1eafe9027f72294af0974f7b051f9eb71

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # CHANGELOG
 
+## 1.9.1 (2024-12-09)
+
+### Type checker core
+
+* Make `implicitly-returns-nil` opt-in ([#1396](https://github.com/soutaro/steep/pull/1396))
+
 ## 1.9.0 (2024-12-06)
 
 ### Type checker core

data/lib/steep/drivers/annotations.rb

@@ -21,7 +21,7 @@ module Steep
 
         project.targets.each do |target|
           Steep.logger.tagged "target=#{target.name}" do
-            service = Services::SignatureService.load_from(target.new_env_loader())
+            service = Services::SignatureService.load_from(target.new_env_loader(), implicitly_returns_nil: target.implicitly_returns_nil)
 
             sigs = loader.load_changes(target.signature_pattern, changes: {})
             service.update(sigs)

data/lib/steep/interface/builder.rb

@@ -54,13 +54,14 @@ module Steep
         end
       end
 
-      attr_reader :factory, :object_shape_cache, :union_shape_cache, :singleton_shape_cache
+      attr_reader :factory, :object_shape_cache, :union_shape_cache, :singleton_shape_cache, :implicitly_returns_nil
 
-      def initialize(factory)
+      def initialize(factory, implicitly_returns_nil:)
         @factory = factory
         @object_shape_cache = {}
         @union_shape_cache = {}
         @singleton_shape_cache = {}
+        @implicitly_returns_nil = implicitly_returns_nil
       end
 
       def shape(type, config)
@@ -826,6 +827,8 @@ module Steep
       end
 
       def add_implicitly_returns_nil(annotations, method_type)
+        return method_type unless implicitly_returns_nil
+        
         if annotations.find { _1.string == "implicitly-returns-nil" }
           return_type = method_type.type.return_type
           method_type = method_type.with(

data/lib/steep/project/dsl.rb

@@ -119,6 +119,7 @@ module Steep
         attr_reader :project
         attr_reader :unreferenced
         attr_reader :groups
+        attr_reader :implicitly_returns_nil
 
         def initialize(name, project:)
           @name = name
@@ -127,6 +128,7 @@ module Steep
           @project = project
           @collection_config_path = collection_config_path
           @unreferenced = false
+          @implicitly_returns_nil = false
           @groups = []
         end
 
@@ -144,6 +146,7 @@ module Steep
           @project = other.project
           @collection_config_path = other.collection_config_path
           @unreferenced = other.unreferenced
+          @implicitly_returns_nil = other.implicitly_returns_nil
           @groups = other.groups.dup
         end
 
@@ -151,6 +154,10 @@ module Steep
           @unreferenced = value
         end
 
+        def implicitly_returns_nil!(value = true)
+          @implicitly_returns_nil = value
+        end
+
         def configure_code_diagnostics(hash = nil)
           if hash
             code_diagnostics_config.merge!(hash)
@@ -245,7 +252,8 @@ module Steep
           options: dsl.library_configured? ? dsl.to_library_options : nil,
           code_diagnostics_config: dsl.code_diagnostics_config,
           project: project,
-          unreferenced: dsl.unreferenced
+          unreferenced: dsl.unreferenced,
+          implicitly_returns_nil: dsl.implicitly_returns_nil
         )
 
         dsl.groups.each do

data/lib/steep/project/target.rb

@@ -10,8 +10,9 @@ module Steep
       attr_reader :project
       attr_reader :unreferenced
       attr_reader :groups
+      attr_reader :implicitly_returns_nil
 
-      def initialize(name:, options:, source_pattern:, signature_pattern:, code_diagnostics_config:, project:, unreferenced:)
+      def initialize(name:, options:, source_pattern:, signature_pattern:, code_diagnostics_config:, project:, unreferenced:, implicitly_returns_nil:)
         @name = name
         @target_options = options
         @source_pattern = source_pattern
@@ -20,6 +21,7 @@ module Steep
         @project = project
         @unreferenced = unreferenced
         @groups = []
+        @implicitly_returns_nil = implicitly_returns_nil
       end
 
       def options

data/lib/steep/server/type_check_controller.rb

@@ -185,7 +185,7 @@ module Steep
         loader = Services::FileLoader.new(base_dir: project.base_dir)
 
         project.targets.each do |target|
-          signature_service = Services::SignatureService.load_from(target.new_env_loader())
+          signature_service = Services::SignatureService.load_from(target.new_env_loader(), implicitly_returns_nil: target.implicitly_returns_nil)
           files.add_library_path(target, *signature_service.env_rbs_paths.to_a)
         end
 

data/lib/steep/services/signature_service.rb

@@ -48,17 +48,18 @@ module Steep
       end
 
       class LoadedStatus
-        attr_reader :files, :builder
+        attr_reader :files, :builder, :implicitly_returns_nil
 
-        def initialize(files:, builder:)
+        def initialize(files:, builder:, implicitly_returns_nil:)
           @files = files
           @builder = builder
+          @implicitly_returns_nil = implicitly_returns_nil
         end
 
         def subtyping
           @subtyping ||= begin
             factory = AST::Types::Factory.new(builder: builder)
-            interface_builder = Interface::Builder.new(factory)
+            interface_builder = Interface::Builder.new(factory, implicitly_returns_nil: implicitly_returns_nil)
             Subtyping::Check.new(builder: interface_builder)
           end
         end
@@ -77,14 +78,17 @@ module Steep
 
       FileStatus = _ = Struct.new(:path, :content, :signature, keyword_init: true)
 
-      def initialize(env:)
+      attr_reader :implicitly_returns_nil
+
+      def initialize(env:, implicitly_returns_nil:)
         builder = RBS::DefinitionBuilder.new(env: env)
-        @status = LoadedStatus.new(builder: builder, files: {})
+        @status = LoadedStatus.new(builder: builder, files: {}, implicitly_returns_nil: implicitly_returns_nil)
+        @implicitly_returns_nil = implicitly_returns_nil
       end
 
-      def self.load_from(loader)
+      def self.load_from(loader, implicitly_returns_nil:)
         env = RBS::Environment.from_loader(loader).resolve_type_names
-        new(env: env)
+        new(env: env, implicitly_returns_nil: implicitly_returns_nil)
       end
 
       def env_rbs_paths
@@ -222,7 +226,7 @@ module Steep
                         )
                       when RBS::DefinitionBuilder::AncestorBuilder
                         builder2 = update_builder(ancestor_builder: result, paths: paths)
-                        LoadedStatus.new(builder: builder2, files: files)
+                        LoadedStatus.new(builder: builder2, files: files, implicitly_returns_nil: implicitly_returns_nil)
                       end
           end
         end

data/lib/steep/services/type_check_service.rb

@@ -82,7 +82,7 @@ module Steep
         @source_files = {}
         @signature_services = project.targets.each.with_object({}) do |target, hash| #$ Hash[Symbol, SignatureService]
           loader = Project::Target.construct_env_loader(options: target.options, project: project)
-          hash[target.name] = SignatureService.load_from(loader)
+          hash[target.name] = SignatureService.load_from(loader, implicitly_returns_nil: target.implicitly_returns_nil)
         end
         @signature_validation_diagnostics = project.targets.each.with_object({}) do |target, hash| #$ Hash[Symbol, Hash[Pathname, Array[Diagnostic::Signature::Base]]]
           hash[target.name] = {}

data/lib/steep/version.rb

@@ -1,3 +1,3 @@
 module Steep
-  VERSION = "1.9.0"
+  VERSION = "1.9.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: steep
 version: !ruby/object:Gem::Version
-  version: 1.9.0
+  version: 1.9.1
 platform: ruby
 authors:
 - Soutaro Matsumoto
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-12-06 00:00:00.000000000 Z
+date: 2024-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser