sorbet_typed-props 1.2.25 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e3abd84c594ddc4874392dc63b3a174f880e6d9483b0710dbb22818902469efa
-  data.tar.gz: bf57501a1305b3d117f5b36e18fa0d3318d3cf816178242ae9cfba6ec7e9a1f0
+  metadata.gz: cf6255a0a1adc5c5a5aa2a793fca6040f6db8b54f8f02323de37d4ab04a0350f
+  data.tar.gz: 1cd56d60ce8a5d695673ee3c1f8070774e14465e4ed3c2cfeeaef3802bb43ace
 SHA512:
-  metadata.gz: ae2a0065e8f05c0b6e82a24783d5b388f4216f16f77f253f77e15cd629f2c884d2d8999166a561d2bd3fecfb1928dce563c91af2d5384cd05746fdb385d610bb
-  data.tar.gz: 041d7a0f7d955b82084a1f86886ed6b05c6d3507d8df6c27bc62795c9704e643ec4eb1aafd286d2662eaffa5f291e8c76eb37131c53bff56a69ccc68e3fe403b
+  metadata.gz: 56e7784fcac731992752234db265d02dfbbe005e06e65c9e411d2e8b5c603fe8a0f1bf33f0a50972b07b3b47c6d01ecfcba99bf78ae9da058be26ed159e9a235
+  data.tar.gz: e162abc3d651c77ea7a604cf13192302bba22e7fbea584a1919f49886e570eda8bf1c95fb43cce8ce828d2f7d886539a6b4db7558832f4b2a7b6ab1a42c83059

data/.cz.yaml

@@ -15,7 +15,7 @@ commitizen:
     - mise run format
   tag_format: v$version
   update_changelog_on_bump: true
-  version: 1.2.25
+  version: 1.3.0
   version_files:
     - lib/sorbet_typed/props/version.rb
   version_scheme: semver2

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+## v1.3.0 (2026-01-27)
+
+### Feat
+
+- add a way to define props that should not be part of the initializer
+
+## v1.2.26 (2026-01-24)
+
+### Fix
+
+- **deps**: update sorbet to v0.6.12897
+
 ## v1.2.25 (2026-01-17)
 
 ### Fix

data/lib/sorbet_typed/props/version.rb

@@ -5,7 +5,7 @@
 
 module SorbetTyped
   module Props
-    VERSION = '1.2.25'
+    VERSION = '1.3.0'
   end
 end
 

data/lib/sorbet_typed/props/without_init_param_and_no_default_plugin.rb

@@ -0,0 +1,70 @@
+# typed: strict
+# frozen_string_literal: true
+
+module SorbetTyped
+  module Props
+    class WithoutInitParamAndNoDefaultPlugin
+      # this overrides how T::Props::Constructor builds props without defaults.
+      # It allows defining props excluded from the initializer without setting a
+      # default.
+      module DecoratorMethods
+        extend T::Sig
+        include Kernel
+
+        sig do
+          params(
+            instance: T::Props::Decorator::DecoratedInstance,
+            prop: Symbol,
+            rules: T::Props::Decorator::Rules
+          ).
+            returns(T.untyped)
+        end
+        def prop_get(instance, prop, rules = T.unsafe(self).prop_rules(prop))
+          value = super
+
+          if rules.dig(:extra, :initializer) == false && !rules[:type_object].valid?(value)
+            raise TypeError, "Property `#{prop}` of `#{T.unsafe(instance).class.name}` was read before being set"
+          end
+
+          value
+        end
+
+        # DEBT: is there a better way to do this without duplicating so much code?
+        #
+        # source: https://github.com/sorbet/sorbet/blob/e554cf64fa404eb5ee5fdc87186968a190613759/gems/sorbet-runtime/lib/types/props/constructor.rb#L19-L39
+        sig { params(instance: T::Props::Constructor, hash: T::Hash[Symbol, T.untyped]).returns(Integer).checked(:never) }
+        # :reek:DuplicateMethodCall :reek:TooManyStatements
+        # :reek:UncommunicativeVariableName -- We ignore these smells, as they
+        # are already present in the original code and I don't want to modify
+        # it.
+        def construct_props_without_defaults(instance, hash) # rubocop:disable Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/MethodLength -- we ignore these warnings as they stem from the original implementation which we keep as much as possible
+          # Use `each_pair` rather than `count` because, as of Ruby 2.6, the latter delegates to Enumerator
+          # and therefore allocates for each entry.
+          result = 0
+
+          # :nocov: -- NOTE: There is no test covering the nil-scenario. But this
+          # code is taken straight from sorbet, so there shouldn't really be a
+          # need to retest it. I also couldn't even construct a scenario where
+          # props_without_defaults would be nil.
+          T.unsafe(self).props_without_defaults&.each_pair do |p, setter_proc|
+            # :nocov:
+
+            # NOTE: this is the only change to this method taken from T::Props::Constructor::DecoratorMethods
+            next if T.unsafe(self).props.dig(p, :extra, :initializer) == false
+
+            val = hash[p]
+            instance.instance_exec(val, &setter_proc)
+            result += 1 if val || hash.key?(p)
+          rescue TypeError, T::Props::InvalidValueError
+            unless hash.key?(p)
+              raise ArgumentError, "Missing required prop `#{p}` for class `#{T.unsafe(instance).class.name}`"
+            end
+
+            raise
+          end
+          result
+        end
+      end
+    end
+  end
+end

data/lib/sorbet_typed/props.rb

@@ -3,6 +3,7 @@
 
 require 'sorbet-runtime'
 require_relative 'props/version'
+require_relative 'props/without_init_param_and_no_default_plugin'
 
 module SorbetTyped
   # an abstraction module to be included in any class to make the sorbet props
@@ -20,10 +21,29 @@ module SorbetTyped
     include T::Props
     include T::Props::Constructor
 
-    mixes_in_class_methods(T::Props::ClassMethods)
+    include Kernel
+
+    plugin(WithoutInitParamAndNoDefaultPlugin)
+
+    # Methods injected into the including class singleton
+    module ClassMethods
+      extend T::Sig
+      include T::Props::ClassMethods
+
+      sig { returns(T::Hash[Symbol, T::Props::Decorator::Rules]) }
+      def props_in_initializer
+        props.reject do |_, prop_parameters|
+          prop_parameters.dig(:extra, :initializer) == false
+        end
+      end
+    end
+
+    mixes_in_class_methods(ClassMethods)
+
+    sig { params(hash: T::Hash[Symbol, T.untyped]).void }
+    def initialize(hash = {})
+      reject_unknown_parameters(hash)
 
-    sig { params(args: T.anything, kwargs: T.anything).void }
-    def initialize(*args, **kwargs)
       super
       post_props_initialize
     end
@@ -32,5 +52,14 @@ module SorbetTyped
 
     sig { overridable.void }
     def post_props_initialize; end
+
+    sig { params(parameters: T::Hash[Symbol, T.anything]).void }
+    # :reek:DuplicateMethodCall { allow_calls: ["self.class"] }
+    def reject_unknown_parameters(parameters)
+      unknown_parameters = parameters.keys - self.class.props_in_initializer.keys
+      return unless unknown_parameters.any?
+
+      raise ArgumentError, "#{self.class}: Unrecognized properties: #{unknown_parameters.join(', ')}"
+    end
   end
 end

data/lib/tapioca/dsl/compilers/sorbet_typed_props_constructor.rb

@@ -11,7 +11,7 @@ module Tapioca
         extend T::Sig
         extend T::Generic
 
-        ConstantType = type_member { { upper: T::Class[SorbetTyped::Props] } }
+        ConstantType = type_member { { upper: T.all(T::Class[SorbetTyped::Props], T::Props::ClassMethods) } }
 
         sig { override.returns(T::Enumerable[T::Module[T.anything]]) }
         def self.gather_constants
@@ -35,16 +35,29 @@ module Tapioca
 
         sig { returns(T::Hash[Symbol, T::Hash[Symbol, T.untyped]]) }
         def props
+          @props ||= T.let(
+            constant.props,
+            T.nilable(T::Hash[Symbol, T::Hash[Symbol, T.untyped]])
+          )
+        end
+
+        sig { returns(T::Hash[Symbol, T::Hash[Symbol, T.untyped]]) }
+        def props_in_initializer
           # NOTE: we already filtered in `::gather_constants` for classes that
           # include `SorbetTyped::Props`, so we know it must be this type and
           # has method `props`.
-          @props ||= T.let(T.unsafe(constant).props, T.nilable(T::Hash[Symbol, T::Hash[Symbol, T.untyped]]))
+          @props_in_initializer ||= T.let(
+            props.reject do |_name, rules|
+              rules.dig(:extra, :initializer) == false
+            end,
+            T.nilable(T::Hash[Symbol, T::Hash[Symbol, T.untyped]])
+          )
         end
 
         sig { returns(T::Array[RBI::TypedParam]) }
         def params
           @params ||= T.let(
-            props.map do |name, details|
+            props_in_initializer.map do |name, details|
               create_param_from_prop(name:, details:)
             end,
             T.nilable(T::Array[RBI::TypedParam])

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sorbet_typed-props
 version: !ruby/object:Gem::Version
-  version: 1.2.25
+  version: 1.3.0
 platform: ruby
 authors:
 - Richard Kramer
@@ -18,7 +18,7 @@ dependencies:
         version: 0.6.0
     - - "<="
       - !ruby/object:Gem::Version
-        version: 0.6.12894
+        version: 0.6.12897
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -28,7 +28,7 @@ dependencies:
         version: 0.6.0
     - - "<="
       - !ruby/object:Gem::Version
-        version: 0.6.12894
+        version: 0.6.12897
 - !ruby/object:Gem::Dependency
   name: tapioca
   requirement: !ruby/object:Gem::Requirement
@@ -68,6 +68,7 @@ files:
 - README.md
 - lib/sorbet_typed/props.rb
 - lib/sorbet_typed/props/version.rb
+- lib/sorbet_typed/props/without_init_param_and_no_default_plugin.rb
 - lib/tapioca/dsl/compilers/sorbet_typed_props_constructor.rb
 - lib/tapioca/dsl/compilers/sorbet_typed_props_constructor/prop_to_param_converter.rb
 homepage: https://gitlab.com/sorbet_typed/props