sorbet_typed-props 1.0.4 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a592ea589b670f5f15dc36a4b00d0d5e659190b9a442be66acb9007c6f0e4f5
-  data.tar.gz: b0ac757e59aaeb2abc27b98b96dbc2fcfff6409c450e248923c021c341acc869
+  metadata.gz: 2c457e7b60e68c291d4b327324fb3a252f8eda2b2aff2387d4673f351cb3b7fb
+  data.tar.gz: e39071b28288af5469881d35b5872997b988c63b4161ca75561ca8e58f178ef6
 SHA512:
-  metadata.gz: ce94fa3dcd6bb3dcaf18272236a4c2be10681a461e6482c0730a5242d4e47b50f202797fa179d04fd33e51f5e6b01de9f42be9ef184d1f914b334ff4a5836b34
-  data.tar.gz: 90ed51e7e0b3209c005e4c6222c7a84c24414e03dab4f98ff248c737c27668e88d9fa5459951b33568a6ae5d61df9ff2ea0b77db37095801be9b68bba5bc8560
+  metadata.gz: 907229513f1e616e0e7b5421485fcb02e20c62d8ae053615fbfafbbfca28c6afa63fedc5dd980c6e7e30f1a697eb38402a1b76944359c8b1038c7db1b685e388
+  data.tar.gz: 0e7eca8bf03774d1504603435c581b9cf40940bd04fcf602e310a7fa105cc61b34ac63d09d6f2330fb5a13f64572c057211400308042aa816a8b9eb9d2a35ee5

data/.cz.yaml

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

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+## v1.1.0 (2025-11-22)
+
+### Feat
+
+- add `post_props_initialize` hook to extend initializer logic
+
+### Fix
+
+- **deps**: update sorbet to v0.6.12784
+- **deps**: update sorbet to v0.6.12783
+
 ## v1.0.4 (2025-11-20)
 
 ### Fix

data/README.md

@@ -17,6 +17,8 @@ in parallel).
 - [Installation](#installation)
 - [Usage](#usage)
   - [Phlex Example](#phlex-example)
+  - [Instance Variables](#instance-variables)
+  - [Extending initializer logic](#extending-initializer-logic)
   - [Method Visibility](#method-visibility)
 - [Development](#development)
 - [Contributing](#contributing)
@@ -68,6 +70,54 @@ class Components::HelloWorld < Phlex::HTML
 end
 ```
 
+### Instance Variables
+
+If you need more instance variables beside defined props, define them within the class body, not the initializer.
+
+```ruby
+class MyClass
+  extend T::Sig
+  include SorbetTyped::Props
+
+  prop :my_prop, Integer
+
+  @my_var = T.let(nil, T.nilable(String))
+
+  sig { void }
+  def foo
+    T.reveal_type(my_prop) # => Integer
+    T.reveal_type(@my_var) # => T.nilable(String)
+  end
+end
+```
+
+### Extending initializer logic
+
+If you want to implement some logic on instance initialization, implementing a custom `initializer` method would require
+you to write a lot of boilerplate code to redefine the method signature and instance variable initialization normally
+done by `SorbetTyped::Props`.
+
+To allow you to nonetheless extend initialization, `SorbetTyped::Props` implements the overridable method
+`post_props_initialize`. It gets called right after prop initialization and has access to all props to do validation or
+whatever you like. Override this method in your own class to implement whatever custom logic you need.
+
+```ruby
+class MyClass
+  extend T::Sig
+  include SorbetTyped::Props
+
+  prop :my_prop, Integer
+
+  sig { override.void }
+  def post_props_initialize
+    raise 'invalid' if my_prop.negative?
+  end
+end
+```
+
+**Note:** you cannot do instance variable initialization here. Define them [within the class body](#instance-variables)
+instead.
+
 ### Method Visibility
 
 If you want attributes in your initializer but not be part of your public class interface, you can use ruby's visibility

data/lib/sorbet_typed/props/version.rb

@@ -5,7 +5,7 @@
 
 module SorbetTyped
   module Props
-    VERSION = '1.0.4'
+    VERSION = '1.1.0'
   end
 end
 

data/lib/sorbet_typed/props.rb

@@ -9,12 +9,28 @@ module SorbetTyped
   # interface usable. It's just a wrapper around T::Props and
   # T::Props::Constructor. It's also the ancestor the custom tapioca compiler
   # looks for when generating initializer type annotation rbis.
+  #
+  # :reek:ModuleInitialize -- we accept this here. This module defines an
+  # initialize method via T::Props::Constructor nonetheless, we only extend it.
+  # It shouldn't really be used with other initializers anyway.
   module Props
+    extend T::Sig
     extend T::Helpers
 
     include T::Props
     include T::Props::Constructor
 
     mixes_in_class_methods(T::Props::ClassMethods)
+
+    sig { params(args: T.anything, kwargs: T.anything).void }
+    def initialize(*args, **kwargs)
+      super
+      post_props_initialize
+    end
+
+    private
+
+    sig { overridable.void }
+    def post_props_initialize; end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sorbet_typed-props
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.1.0
 platform: ruby
 authors:
 - Richard Kramer
@@ -18,7 +18,7 @@ dependencies:
         version: 0.6.0
     - - "<="
       - !ruby/object:Gem::Version
-        version: 0.6.12780
+        version: 0.6.12784
   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.12780
+        version: 0.6.12784
 - !ruby/object:Gem::Dependency
   name: tapioca
   requirement: !ruby/object:Gem::Requirement
@@ -75,6 +75,7 @@ metadata:
   homepage_uri: https://gitlab.com/sorbet_typed/props
   source_code_uri: https://gitlab.com/sorbet_typed/props
   rubygems_mfa_required: 'true'
+  changelog_uri: https://gitlab.com/sorbet_typed/props/-/blob/main/CHANGELOG.md
 rdoc_options: []
 require_paths:
 - lib