rice 4.10.0 → 4.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bfec1a3dda6cae1e2a2e4ead3b3d6d856487a6d214ec89a2aa7c32cab9debf24
-  data.tar.gz: 2bb3f7480a0ffcaee70ccc15ea7410c764a67b0b6d229300264570b1e58f8b59
+  metadata.gz: 935f187922d58bf0dc585e30ae66b5454bb8f87ac8c640ca38d9445371991dff
+  data.tar.gz: d00d336620c52f7e3a56941d6402109bcc20d3a73dc4090fd3d49395cbbdc7e7
 SHA512:
-  metadata.gz: a6e7edb4a1332104c7e2a0bf616919ceef92fb4d87bbca650898c1a8e705df20f54a02a78372a1a9b66b499c6d1e4a47ed75e8a2e20ebbe57cbfa0c6cd9a953d
-  data.tar.gz: 9ea2f5c76ccbb2d4a8e62ead7a796ad700ef77d07cf0c2fbc59b8c7626068225900009a861a654b95dd8476c80ba1e041c46b43f2969318479a28b12f7dc8678
+  metadata.gz: 9c006c97da6e586d836a08b51c2d1ed37e8921e11f0dc30f45d3fcfeb5166ae5172610b958e0b9fe35a8eddb199af05b88eec1bf272541b7a39d890b0856bacf
+  data.tar.gz: 7795809caf1d34330279d5fb454cb935b08422b531522d721d4ba3185442426d51fd1f8795dfbbbb34daff9a19d586e0e5554925d69eed7d57aebcbba9017a6a

data/CHANGELOG.md

@@ -1,8 +1,36 @@
 # Changelog
 
+## 4.11.1 (2026-02-18)
+
+### Enhancements
+
+* Be more lenient on wrapp Qnil values in the C++ API
+
+
+## 4.11.0 (2026-02-17)
+
+This release focuses on improving memory management.
+
+### Enhancements
+
+* C++ API is now GC safe
+* C++ API wrappers no longer default to rb_cObject, avoiding unintended Object changes
+* Enable Instance Registry for Ruby owned C++ objects to avoid double frees
+
+### Breaking Changes
+
+* `InstanceRegistry.isEnabled` (boolean) has been replaced by an `InstanceRegistry.isEnabled` which is an enum (`Off`, `Owned`, `All`).
+* `InstanceRegistry` now defaults to `Owned` - previously it was disabled. The goal of this change is to ensure C++ objects owned by Ruby are only wrapped once to avoid double free errors.
+* `Object()` now defaults to `Qnil` instead of `rb_cObject`. This avoids accidentally manipulating `rb_cObject` when a wrapper is not explicitly initialized. Calling methods on wrappers that point to `Qnil` will generally raise an exception. Use `object.is_nil()` to check for `nil` before using a wrapper as a receiver.
+* C++ API wrappers now store their Ruby `VALUE` in a `Pin` instead of a raw `VALUE` field. Previously, wrappers were not GC-safe and Ruby could reclaim wrapped objects while C++ still referenced them. This is now fixed, and wrappers such as `Object` can be stored safely in containers like `std::vector`.
+* The global `Object` constants (`Rice::Nil`, `Rice::True`, `Rice::False`, `Rice::Undef`) have been removed.
+* `Object::test()` has been removed. Use `operator bool()` or `is_nil()` depending on the desired semantics.
+* Remove `Builtin_Object` since it didn't serve a useful purpose
+
 ## 4.10.0 (2026-02-07)
 
-Enhancements:
+### Enhancements
+
 * Ruby 4.0 support
 * Support incomplete types (PIMPL/opaque handle patterns). Rice now uses `typeid(T*)` for forward-declared types that are never fully defined.
 * Support `noexcept` functions, static members, and static member functions
@@ -11,12 +39,11 @@ Enhancements:
 * Add `std::ostream`, `std::ostringstream`, and `std::ofstream`. Ruby can write to C++ streams and pass them to C++ functions. Standard streams are exposed as `Std::COUT` and `Std::CERR`.
 * Support verifying arrays of non-fundamental types (e.g., `MyClass[2]`)
 * Delegate method calls for smart pointers to their wrapped objects via method_missing?
-
-Internal:
 * Refactor type handling by merging `TypeMapper` into `TypeDetail` and simplifying class hierarchy
 * Greatly simplify define_attr
 
-Incompatible Changes:
+### Breaking Changes
+
 * `Address_Registration_Guard` has been replaced by `Pin`. If you are using `Address_Registration_Guard`
   to protect Ruby VALUEs from garbage collection, update your code to use `Pin` instead:
 
@@ -50,15 +77,18 @@ Incompatible Changes:
 * The `Data_Type<T>::define()` method has been removed. See the [Class Templates](bindings/class_templates.md) documentation for the recommended approach.
 
 ## 4.9.1 (2026-01-04)
+
 This release focuses on improving memory management for STL containers and attribute setters.
 
-Enhancements:
+### Enhancements
+
 * Support `takeOwnership` and `keepAlive` when setting attributes via `Arg("value").takeOwnership()` and `Arg("value").keepAlive()`
 * Add `Arg` parameter names to all STL container methods for keyword argument support
 * Add `keepAlive` support for STL container operations (vector push/insert, set insert, map/multimap store)
 * Add `keepAlive` for map/unordered_map/multimap keys to prevent GC of pointer-type keys
 
-Bug Fixes:
+### Fixes
+
 * Fix error when multiple overloaded methods take different types of vectors
 * Fix type unknown errors when using `std::shared_ptr` with g++
 * Fix CMake `_Ruby_DLEXT` variable type (string, not path)
@@ -66,6 +96,7 @@ Bug Fixes:
 * Fix incorrect attribute overloading behavior
 
 ## 4.9.0 (2026-01-01)
+
 This release revamps smart pointer support for `std::shared_ptr` and `std::unique_ptr`.
 
 Rice now always creates wrapper classes for smart pointers under the `Std` module (e.g., `Std::SharedPtr≺MyClass≻`, `Std::UniquePtr≺MyClass≻`). These wrapper classes expose methods like `empty?`, `get`, `swap`, and for shared_ptr, `use_count`. Methods defined on the managed type are automatically forwarded to the wrapper class using Ruby's `Forwardable` module.
@@ -73,7 +104,10 @@ Rice now always creates wrapper classes for smart pointers under the `Std` modul
 This change is backwards compatible for Ruby code but not C++ code. If you have implemented your own Smart Pointer wrapper then please read the Smart Pointer documentation for more information on how to update it.
 
 ## 4.8.0 (2025-12-29)
-This release focuses on making Rice easier to use:
+
+This release focuses on making Rice easier to use.
+
+### Enhancements
 
 * Compilation times are approximately 2x faster than version 4.7
 * Compiled library sizes are about 30% smaller
@@ -91,7 +125,7 @@ This release focuses on making Rice easier to use:
 * Fixed Ruby detection for Homebrew installations on macOS
 * Added support for references to fundamental types
 
-However, these changes did require some breaking changes, which include:
+### Breaking Changes
 
 * `Return().isBuffer()` is replaced by `ReturnBuffer()`
 * `Arg("").isBuffer()` is replaced by `ArgBuffer("")`
@@ -100,13 +134,17 @@ However, these changes did require some breaking changes, which include:
 * All function/method parameter default values are verified. You may see errors like "ArgumentError: Type is not registered with Rice" or "Invalid AnyCast". In either case, make sure to check that specified default values are correct.
 
 ## 4.7.1 (2025-10-28)
-Updates:
+
+### Enhancements
+
 * Update overload resolution to take into account function arguments that are tagged as buffers via Arg("").setBuffer().
 * Make second parameter optional for Array#push and update docs
 * Remove ostruct runtime dependency
 
 ## 4.7.0 (2025-10-22)
-Updates:
+
+### Enhancements
+
 * Refactor Native wrappers - functions, methods, attributes and procs - to enable introspection API
 * Introduce Pointer<T> class to wrap pointers to fundamental types and arrays.
 * Add new methods Arg#setBuffer and Return#setBuffer to indicate that a C++ pointer references an array of objects versus a single object
@@ -124,13 +162,14 @@ Updates:
 * Correctly encode UTF8 Ruby class names in exception messages
 * Add support for disabling Ruby's global interpreter lock (GIL) when calling native functions
 
-Breaking Changes:
+### Breaking Changes
+
 * Custom implementations of From_Ruby must include a custom constructor:
-    ```
+    ```cpp
     explicit From_Ruby(Arg* arg)
    ```
 * Custom implementations of To_Ruby must include a custom constructor:
-    ```
+    ```cpp
     explicit To_Ruby(Return* returnInfo)
    ```
 * You can no longer pass a Buffer<T> to an API that takes a pointer. Instead use Buffer<T>#data or Buffer<T>::release
@@ -138,6 +177,7 @@ Breaking Changes:
 * Array#push requires a second argument.
 
 ## 4.6.1 (2025-06-25)
+
 * Improve attribute handling. Correctly deal with non-copyable/assignable attributes and return references instead of copies of objects
 * Improve Buffer implementation to deal with 4 cases:
 	- array of fundamental types (int*)
@@ -148,6 +188,7 @@ Breaking Changes:
 * Fix header check on Ubuntu 22.04
 
 ## 4.6.0 (2025-06-09)
+
 Rice 4.6 is a major release that adds significant new functionality based on wrapping the OpenCV library, including:
 
 * Add a new Buffer class to provide Ruby API support for pointers sent to or returned by C++
@@ -171,6 +212,7 @@ Rice 4.6 is a major release that adds significant new functionality based on wra
 * Make Enums more useful by adding coerce method to enable stringing together bitwise operators - for example Season::Winter | Season::Spring | Season::Summer.
 
 ## 4.5 (2025-02-09)
+
 Rice 4.5 is a major release that adds significant new functionality, including:
 
 * Support method overloading
@@ -178,7 +220,7 @@ Rice 4.5 is a major release that adds significant new functionality, including:
 * Support rvalues
 * Support using keyword arguments in Ruby to call C++ methods
 * Support C style callbacks, including adding a new define_callback method
-* Support wrapping C/C++ functions as Ruby procs 
+* Support wrapping C/C++ functions as Ruby procs
 * Support calling methods that take pointers
 * Add Data_Type#define method to more easily support C++ template classes
 * Adds #define_constant method
@@ -244,7 +286,7 @@ Rice 4.1 builds on the 4.0 release and has a number of improvements that both po
 
 * Exception handlers are now registered globally versus per module. This requires updating code that calls Class#add_handler to use register_handler instead.
 * Rename Arg#isValue to Arg#setValue and then Arg#getIsValue to Arg#isValue
-* Rename Return#isValue to Return#setValue and Return#getIsValue to Return#isValue 
+* Rename Return#isValue to Return#setValue and Return#getIsValue to Return#isValue
 
 New or improved functionality includes:
 
@@ -267,7 +309,6 @@ New or improved functionality includes:
 
 Rice also includes experimental support for instance tracking so that Rice maps the same C++ instance to the same Ruby instance each time it is passed to Ruby. See the documentation for more information.
 
-
 ## 4.0 (2021-4-8)
 
 Rice 4.0 is a significant change from 3.0 and has multiple backwards-incompatible
@@ -313,10 +354,10 @@ There are a ton of changes, but some of the most important ones:
 
 ## 2.1.0 (2016-1-1)
 
-* Fix compliation issues related to g++ and Ruby 2.3.0
+* Fix compliation issues related to g++ and Ruby 2.3.0.
   To do this, I had to remove Array::to_c_array which was exposing the internals of a
-	Ruby RArray type to the system. This is not something that we should support going forward
-	as these internals are going to change.
+  Ruby RArray type to the system. This is not something that we should support going forward
+  as these internals are going to change.
 
 ## 2.0.0 (2015-11-27)
 
@@ -333,7 +374,7 @@ There are a ton of changes, but some of the most important ones:
 
 ## 1.7.0 (2015-1-6)
 
-* Ruby 2.2 support
+* Ruby 2.2 support.
   Potential breaking changes. Ruby 2.2 removed RHash as a public accessible struct
   and as such I changed all of the Builtin_Objects to work directly off of RObject
   instead of the specifics (RArray, RStruct, RString, etc). If you've been using these