rice 4.11.0 → 4.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f1cb911ca5d8bdd05beb12475ede38818ab53bf0af2724fb2268c7df15b10a8d
-  data.tar.gz: dd9c953afcee173cfe9970b34dc9b91d8de5e5adf29efb262805edadad850fdb
+  metadata.gz: 935f187922d58bf0dc585e30ae66b5454bb8f87ac8c640ca38d9445371991dff
+  data.tar.gz: d00d336620c52f7e3a56941d6402109bcc20d3a73dc4090fd3d49395cbbdc7e7
 SHA512:
-  metadata.gz: cb66c85d175f289facdf8058d3e87cc7be957082e11cf769f2328cd175b83263733b52b8f0b5378bfb43a2244db6bf7507875bd616adacc772c317aeedd6a53a
-  data.tar.gz: a70fe6bdfe219aac33d3645987f1bfc9bb9e1eb6dea3dc5daa6e525a4835ac0622d460518f41c46585bd5afabceb5096a027f68b1584193aded8e54995892f37
+  metadata.gz: 9c006c97da6e586d836a08b51c2d1ed37e8921e11f0dc30f45d3fcfeb5166ae5172610b958e0b9fe35a8eddb199af05b88eec1bf272541b7a39d890b0856bacf
+  data.tar.gz: 7795809caf1d34330279d5fb454cb935b08422b531522d721d4ba3185442426d51fd1f8795dfbbbb34daff9a19d586e0e5554925d69eed7d57aebcbba9017a6a

data/CHANGELOG.md

@@ -1,14 +1,24 @@
 # 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)
 
-Enhancements:
-This release focuses on improving memory management:
+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 
+* Enable Instance Registry for Ruby owned C++ objects to avoid double frees
+
+### Breaking Changes
 
-Incompatible 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.
@@ -19,7 +29,8 @@ Incompatible Changes:
 
 ## 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
@@ -28,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:
 
@@ -67,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)
@@ -83,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.
@@ -90,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
@@ -108,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("")`
@@ -117,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
@@ -141,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
@@ -155,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*)
@@ -165,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++
@@ -188,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
@@ -195,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
@@ -261,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:
 
@@ -284,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
@@ -330,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)
 
@@ -350,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

data/include/rice/rice.hpp

@@ -1859,6 +1859,12 @@ namespace Rice
     Object(Object&& other) = default;
     Object& operator=(Object&& other) = default;
 
+    //! Implicit conversion to VALUE.
+    operator VALUE() const;
+
+    //! Explicitly get the encapsulated VALUE.
+    VALUE value() const;
+
     //! Returns false if the object is nil or false; returns true
     //! otherwise.
     explicit operator bool() const;
@@ -1866,11 +1872,6 @@ namespace Rice
     //! Returns true if the object is nil, false otherwise.
     bool is_nil() const;
 
-    //! Implicit conversion to VALUE.
-    operator VALUE() const;
-
-    //! Explicitly get the encapsulated VALUE.
-    VALUE value() const;
 
     //! Get the class of an object.
     /*! \return the object's Class.
@@ -2071,6 +2072,10 @@ namespace Rice
     void remove_const(Identifier name);
 
   protected:
+    //! Checks the encapsulated VALUE is not nil and returns it. If it is nil 
+    //! an exception is thrown.
+    VALUE validated_value() const;
+
     //! Set the encapsulated value.
     void set_value(VALUE value);
 
@@ -2700,7 +2705,7 @@ namespace Rice
 */
 inline auto& include_module(Module const& inc)
 {
-  detail::protect(rb_include_module, this->value(), inc.value());
+  detail::protect(rb_include_module, this->validated_value(), inc.value());
   return *this;
 }
 
@@ -2724,7 +2729,7 @@ inline auto& include_module(Module const& inc)
 template<typename Method_T, typename...Arg_Ts>
 inline auto& define_method(std::string name, Method_T&& method, const Arg_Ts&...args)
 {
-  this->wrap_native_method(this->value(), name, std::forward<Method_T>(method), args...);
+  this->wrap_native_method(this->validated_value(), name, std::forward<Method_T>(method), args...);
   return *this;
 }
 
@@ -2742,7 +2747,7 @@ inline auto& define_method(std::string name, Method_T&& method, const Arg_Ts&...
 template<typename Function_T, typename...Arg_Ts>
 inline auto& define_function(std::string name, Function_T&& func, const Arg_Ts&...args)
 {
-  this->wrap_native_function(this->value(), name, std::forward<Function_T>(func), args...);
+  this->wrap_native_function(this->validated_value(), name, std::forward<Function_T>(func), args...);
   return *this;
 }
 
@@ -2816,7 +2821,7 @@ template<typename Constant_T>
 inline auto& define_constant(std::string name, Constant_T value)
 {
   using Base_T = detail::remove_cv_recursive_t<Constant_T>;
-  detail::protect(rb_define_const, this->value(), name.c_str(), detail::To_Ruby<Base_T>().convert(value));
+  detail::protect(rb_define_const, this->validated_value(), name.c_str(), detail::To_Ruby<Base_T>().convert(value));
   return *this;
 }
   protected:
@@ -2898,7 +2903,7 @@ namespace Rice
 */
 inline auto& include_module(Module const& inc)
 {
-  detail::protect(rb_include_module, this->value(), inc.value());
+  detail::protect(rb_include_module, this->validated_value(), inc.value());
   return *this;
 }
 
@@ -2922,7 +2927,7 @@ inline auto& include_module(Module const& inc)
 template<typename Method_T, typename...Arg_Ts>
 inline auto& define_method(std::string name, Method_T&& method, const Arg_Ts&...args)
 {
-  this->wrap_native_method(this->value(), name, std::forward<Method_T>(method), args...);
+  this->wrap_native_method(this->validated_value(), name, std::forward<Method_T>(method), args...);
   return *this;
 }
 
@@ -2940,7 +2945,7 @@ inline auto& define_method(std::string name, Method_T&& method, const Arg_Ts&...
 template<typename Function_T, typename...Arg_Ts>
 inline auto& define_function(std::string name, Function_T&& func, const Arg_Ts&...args)
 {
-  this->wrap_native_function(this->value(), name, std::forward<Function_T>(func), args...);
+  this->wrap_native_function(this->validated_value(), name, std::forward<Function_T>(func), args...);
   return *this;
 }
 
@@ -3014,7 +3019,7 @@ template<typename Constant_T>
 inline auto& define_constant(std::string name, Constant_T value)
 {
   using Base_T = detail::remove_cv_recursive_t<Constant_T>;
-  detail::protect(rb_define_const, this->value(), name.c_str(), detail::To_Ruby<Base_T>().convert(value));
+  detail::protect(rb_define_const, this->validated_value(), name.c_str(), detail::To_Ruby<Base_T>().convert(value));
   return *this;
 }
   };
@@ -3363,7 +3368,7 @@ namespace Rice
 */
 inline auto& include_module(Module const& inc)
 {
-  detail::protect(rb_include_module, this->value(), inc.value());
+  detail::protect(rb_include_module, this->validated_value(), inc.value());
   return *this;
 }
 
@@ -3387,7 +3392,7 @@ inline auto& include_module(Module const& inc)
 template<typename Method_T, typename...Arg_Ts>
 inline auto& define_method(std::string name, Method_T&& method, const Arg_Ts&...args)
 {
-  this->wrap_native_method(this->value(), name, std::forward<Method_T>(method), args...);
+  this->wrap_native_method(this->validated_value(), name, std::forward<Method_T>(method), args...);
   return *this;
 }
 
@@ -3405,7 +3410,7 @@ inline auto& define_method(std::string name, Method_T&& method, const Arg_Ts&...
 template<typename Function_T, typename...Arg_Ts>
 inline auto& define_function(std::string name, Function_T&& func, const Arg_Ts&...args)
 {
-  this->wrap_native_function(this->value(), name, std::forward<Function_T>(func), args...);
+  this->wrap_native_function(this->validated_value(), name, std::forward<Function_T>(func), args...);
   return *this;
 }
 
@@ -3479,7 +3484,7 @@ template<typename Constant_T>
 inline auto& define_constant(std::string name, Constant_T value)
 {
   using Base_T = detail::remove_cv_recursive_t<Constant_T>;
-  detail::protect(rb_define_const, this->value(), name.c_str(), detail::To_Ruby<Base_T>().convert(value));
+  detail::protect(rb_define_const, this->validated_value(), name.c_str(), detail::To_Ruby<Base_T>().convert(value));
   return *this;
 }
   protected:
@@ -4527,6 +4532,10 @@ namespace Rice::detail
           T defaultValue = this->arg()->template defaultValue<T>();
           return this->toRuby_.convert(defaultValue);
         }
+        else
+        {
+          throw std::runtime_error("Default value not allowed for parameter " + this->arg()->name);
+        }
       }
       else
       {
@@ -12568,16 +12577,9 @@ namespace Rice
   {
   }
 
-  inline Object::operator bool() const
-  {
-    // Bypass getter to not raise exception
-    return RTEST(this->value_.value());
-  }
-
-  inline bool Object::is_nil() const
+  inline VALUE Object::value() const
   {
-    // Bypass getter to not raise exception
-    return NIL_P(this->value_.value());
+    return this->value_.value();
   }
 
   inline Object::operator VALUE() const
@@ -12585,9 +12587,9 @@ namespace Rice
     return this->value();
   }
 
-  inline VALUE Object::value() const
+  inline VALUE Object::validated_value() const
   {
-    VALUE result = this->value_.value();
+    VALUE result = this->value();
 
     if (result == Qnil)
     {
@@ -12598,6 +12600,16 @@ namespace Rice
     return result;
   }
 
+  inline Object::operator bool() const
+  {
+    return RTEST(this->value());
+  }
+
+  inline bool Object::is_nil() const
+  {
+    return NIL_P(this->value());
+  }
+
   template<typename ...Parameter_Ts>
   inline Object Object::call(Identifier id, Parameter_Ts... args) const
   {
@@ -12609,7 +12621,7 @@ namespace Rice
        easy to duplicate by setting GC.stress to true and calling a constructor
        that takes multiple values like a std::pair wrapper. */
     std::array<VALUE, sizeof...(Parameter_Ts)> values = { detail::To_Ruby<detail::remove_cv_recursive_t<Parameter_Ts>>().convert(std::forward<Parameter_Ts>(args))... };
-    return detail::protect(rb_funcallv, value(), id.id(), (int)values.size(), (const VALUE*)values.data());
+    return detail::protect(rb_funcallv, this->validated_value(), id.id(), (int)values.size(), (const VALUE*)values.data());
   }
 
   template<typename ...Parameter_Ts>
@@ -12617,13 +12629,13 @@ namespace Rice
   {
     /* IMPORTANT - See call() above */
     std::array<VALUE, sizeof...(Parameter_Ts)> values = { detail::To_Ruby<detail::remove_cv_recursive_t<Parameter_Ts>>().convert(args)... };
-    return detail::protect(rb_funcallv_kw, value(), id.id(), (int)values.size(), (const VALUE*)values.data(), RB_PASS_KEYWORDS);
+    return detail::protect(rb_funcallv_kw, this->validated_value(), id.id(), (int)values.size(), (const VALUE*)values.data(), RB_PASS_KEYWORDS);
   }
 
   template<typename T>
   inline void Object::iv_set(Identifier name, T const& value)
   {
-    detail::protect(rb_ivar_set, this->value(), name.id(), detail::To_Ruby<T>().convert(value));
+    detail::protect(rb_ivar_set, this->validated_value(), name.id(), detail::To_Ruby<T>().convert(value));
   }
 
   inline int Object::compare(Object const& other) const
@@ -12639,66 +12651,71 @@ namespace Rice
       return this->is_nil() && other.is_nil();
     }
 
-    VALUE result = detail::protect(rb_equal, this->value(), other.value());
+    VALUE result = detail::protect(rb_equal, this->validated_value(), other.validated_value());
     return RB_TEST(result);
   }
 
   inline bool Object::is_eql(const Object& other) const
   {
-    VALUE result = detail::protect(rb_eql, this->value(), other.value());
+    if (this->is_nil() || other.is_nil())
+    {
+      return this->is_nil() && other.is_nil();
+    }
+
+    VALUE result = detail::protect(rb_eql, this->validated_value(), other.validated_value());
     return RB_TEST(result);
   }
 
   inline void Object::freeze()
   {
-    detail::protect(rb_obj_freeze, value());
+    detail::protect(rb_obj_freeze, this->validated_value());
   }
 
   inline bool Object::is_frozen() const
   {
-    return RB_OBJ_FROZEN(value());
+    return RB_OBJ_FROZEN(this->validated_value());
   }
 
   inline int Object::rb_type() const
   {
-    return ::rb_type(this->value());
+    return ::rb_type(this->validated_value());
   }
 
   inline VALUE Object::object_id() const
   {
-    return detail::protect(rb_obj_id, this->value());
+    return detail::protect(rb_obj_id, this->validated_value());
   }
 
   inline bool Object::is_a(Object klass) const
   {
-    VALUE result = detail::protect(rb_obj_is_kind_of, this->value(), klass.value());
+    VALUE result = detail::protect(rb_obj_is_kind_of, this->validated_value(), klass.validated_value());
     return RB_TEST(result);
   }
 
   inline void Object::extend(Module const& mod)
   {
-    detail::protect(rb_extend_object, this->value(), mod.value());
+    detail::protect(rb_extend_object, this->validated_value(), mod.validated_value());
   }
 
   inline bool Object::respond_to(Identifier id) const
   {
-    return bool(rb_respond_to(this->value(), id.id()));
+    return bool(rb_respond_to(this->validated_value(), id.id()));
   }
 
   inline bool Object::is_instance_of(Object klass) const
   {
-    VALUE result = detail::protect(rb_obj_is_instance_of, this->value(), klass.value());
+    VALUE result = detail::protect(rb_obj_is_instance_of, this->validated_value(), klass.validated_value());
     return RB_TEST(result);
   }
 
   inline Object Object::iv_get(Identifier name) const
   {
-    return detail::protect(rb_ivar_get, this->value(), name.id());
+    return detail::protect(rb_ivar_get, this->validated_value(), name.id());
   }
 
   inline Object Object::attr_get(Identifier name) const
   {
-    return detail::protect(rb_attr_get, this->value(), name.id());
+    return detail::protect(rb_attr_get, this->validated_value(), name.id());
   }
 
   inline void Object::set_value(VALUE value)
@@ -12708,20 +12725,20 @@ namespace Rice
 
   inline Object Object::const_get(Identifier name) const
   {
-    return detail::protect(rb_const_get, this->value(), name.id());
+    return detail::protect(rb_const_get, this->validated_value(), name.id());
   }
 
   inline bool Object::const_defined(Identifier name) const
   {
-    size_t result = detail::protect(rb_const_defined, this->value(), name.id());
+    size_t result = detail::protect(rb_const_defined, this->validated_value(), name.id());
     return bool(result);
   }
 
   inline Object Object::const_set(Identifier name, Object value)
   {
     // We will allow setting constants to Qnil, or the decimal value of 4. This happens
-    // in C++ libraries with enums. Thus skip the value() method that raises excptions
-    detail::protect(rb_const_set, this->value(), name.id(), value.value_.value());
+    // in C++ libraries with enums. Thus use value() instead of validated_value
+    detail::protect(rb_const_set, this->validated_value(), name.id(), value.value());
     return value;
   }
 
@@ -12736,7 +12753,7 @@ namespace Rice
 
   inline void Object::remove_const(Identifier name)
   {
-    detail::protect(rb_mod_remove_const, this->value(), name.to_sym());
+    detail::protect(rb_mod_remove_const, this->validated_value(), name.to_sym());
   }
 
   inline bool operator==(Object const& lhs, Object const& rhs)
@@ -12898,22 +12915,22 @@ namespace Rice
 
   inline size_t String::length() const
   {
-    return RSTRING_LEN(value());
+    return RSTRING_LEN(this->value());
   }
 
   inline char String::operator[](ptrdiff_t index) const
   {
-    return RSTRING_PTR(value())[index];
+    return RSTRING_PTR(this->value())[index];
   }
 
   inline char const* String::c_str() const
   {
-    return RSTRING_PTR(value());
+    return RSTRING_PTR(this->value());
   }
 
   inline std::string String::str() const
   {
-    return std::string(RSTRING_PTR(value()), length());
+    return std::string(RSTRING_PTR(this->value()), length());
   }
 
   template<typename T>
@@ -14820,7 +14837,7 @@ namespace Rice
   template <typename Attribute_T, typename Access_T, typename...Arg_Ts>
   inline Data_Type<T>& Data_Type<T>::define_singleton_attr(std::string name, Attribute_T attribute, Access_T access, const Arg_Ts&...args)
   {
-    VALUE singleton = detail::protect(rb_singleton_class, this->value());
+    VALUE singleton = detail::protect(rb_singleton_class, this->validated_value());
     return this->define_attr_internal<Attribute_T, Access_T>(singleton, name, std::forward<Attribute_T>(attribute), access, args...);
   }
 

data/lib/rice/version.rb

@@ -1,3 +1,3 @@
 module Rice
-  VERSION = "4.11.0"
+  VERSION = "4.11.1"
 end

data/rice/Data_Type.ipp

@@ -368,7 +368,7 @@ namespace Rice
   template <typename Attribute_T, typename Access_T, typename...Arg_Ts>
   inline Data_Type<T>& Data_Type<T>::define_singleton_attr(std::string name, Attribute_T attribute, Access_T access, const Arg_Ts&...args)
   {
-    VALUE singleton = detail::protect(rb_singleton_class, this->value());
+    VALUE singleton = detail::protect(rb_singleton_class, this->validated_value());
     return this->define_attr_internal<Attribute_T, Access_T>(singleton, name, std::forward<Attribute_T>(attribute), access, args...);
   }
 

data/rice/cpp_api/Object.hpp

@@ -37,6 +37,12 @@ namespace Rice
     Object(Object&& other) = default;
     Object& operator=(Object&& other) = default;
 
+    //! Implicit conversion to VALUE.
+    operator VALUE() const;
+
+    //! Explicitly get the encapsulated VALUE.
+    VALUE value() const;
+
     //! Returns false if the object is nil or false; returns true
     //! otherwise.
     explicit operator bool() const;
@@ -44,11 +50,6 @@ namespace Rice
     //! Returns true if the object is nil, false otherwise.
     bool is_nil() const;
 
-    //! Implicit conversion to VALUE.
-    operator VALUE() const;
-
-    //! Explicitly get the encapsulated VALUE.
-    VALUE value() const;
 
     //! Get the class of an object.
     /*! \return the object's Class.
@@ -249,6 +250,10 @@ namespace Rice
     void remove_const(Identifier name);
 
   protected:
+    //! Checks the encapsulated VALUE is not nil and returns it. If it is nil 
+    //! an exception is thrown.
+    VALUE validated_value() const;
+
     //! Set the encapsulated value.
     void set_value(VALUE value);
 

data/rice/cpp_api/Object.ipp

@@ -8,16 +8,9 @@ namespace Rice
   {
   }
 
-  inline Object::operator bool() const
-  {
-    // Bypass getter to not raise exception
-    return RTEST(this->value_.value());
-  }
-
-  inline bool Object::is_nil() const
+  inline VALUE Object::value() const
   {
-    // Bypass getter to not raise exception
-    return NIL_P(this->value_.value());
+    return this->value_.value();
   }
 
   inline Object::operator VALUE() const
@@ -25,9 +18,9 @@ namespace Rice
     return this->value();
   }
 
-  inline VALUE Object::value() const
+  inline VALUE Object::validated_value() const
   {
-    VALUE result = this->value_.value();
+    VALUE result = this->value();
 
     if (result == Qnil)
     {
@@ -38,6 +31,16 @@ namespace Rice
     return result;
   }
 
+  inline Object::operator bool() const
+  {
+    return RTEST(this->value());
+  }
+
+  inline bool Object::is_nil() const
+  {
+    return NIL_P(this->value());
+  }
+
   template<typename ...Parameter_Ts>
   inline Object Object::call(Identifier id, Parameter_Ts... args) const
   {
@@ -49,7 +52,7 @@ namespace Rice
        easy to duplicate by setting GC.stress to true and calling a constructor
        that takes multiple values like a std::pair wrapper. */
     std::array<VALUE, sizeof...(Parameter_Ts)> values = { detail::To_Ruby<detail::remove_cv_recursive_t<Parameter_Ts>>().convert(std::forward<Parameter_Ts>(args))... };
-    return detail::protect(rb_funcallv, value(), id.id(), (int)values.size(), (const VALUE*)values.data());
+    return detail::protect(rb_funcallv, this->validated_value(), id.id(), (int)values.size(), (const VALUE*)values.data());
   }
 
   template<typename ...Parameter_Ts>
@@ -57,13 +60,13 @@ namespace Rice
   {
     /* IMPORTANT - See call() above */
     std::array<VALUE, sizeof...(Parameter_Ts)> values = { detail::To_Ruby<detail::remove_cv_recursive_t<Parameter_Ts>>().convert(args)... };
-    return detail::protect(rb_funcallv_kw, value(), id.id(), (int)values.size(), (const VALUE*)values.data(), RB_PASS_KEYWORDS);
+    return detail::protect(rb_funcallv_kw, this->validated_value(), id.id(), (int)values.size(), (const VALUE*)values.data(), RB_PASS_KEYWORDS);
   }
 
   template<typename T>
   inline void Object::iv_set(Identifier name, T const& value)
   {
-    detail::protect(rb_ivar_set, this->value(), name.id(), detail::To_Ruby<T>().convert(value));
+    detail::protect(rb_ivar_set, this->validated_value(), name.id(), detail::To_Ruby<T>().convert(value));
   }
 
   inline int Object::compare(Object const& other) const
@@ -79,66 +82,71 @@ namespace Rice
       return this->is_nil() && other.is_nil();
     }
 
-    VALUE result = detail::protect(rb_equal, this->value(), other.value());
+    VALUE result = detail::protect(rb_equal, this->validated_value(), other.validated_value());
     return RB_TEST(result);
   }
 
   inline bool Object::is_eql(const Object& other) const
   {
-    VALUE result = detail::protect(rb_eql, this->value(), other.value());
+    if (this->is_nil() || other.is_nil())
+    {
+      return this->is_nil() && other.is_nil();
+    }
+
+    VALUE result = detail::protect(rb_eql, this->validated_value(), other.validated_value());
     return RB_TEST(result);
   }
 
   inline void Object::freeze()
   {
-    detail::protect(rb_obj_freeze, value());
+    detail::protect(rb_obj_freeze, this->validated_value());
   }
 
   inline bool Object::is_frozen() const
   {
-    return RB_OBJ_FROZEN(value());
+    return RB_OBJ_FROZEN(this->validated_value());
   }
 
   inline int Object::rb_type() const
   {
-    return ::rb_type(this->value());
+    return ::rb_type(this->validated_value());
   }
 
   inline VALUE Object::object_id() const
   {
-    return detail::protect(rb_obj_id, this->value());
+    return detail::protect(rb_obj_id, this->validated_value());
   }
 
   inline bool Object::is_a(Object klass) const
   {
-    VALUE result = detail::protect(rb_obj_is_kind_of, this->value(), klass.value());
+    VALUE result = detail::protect(rb_obj_is_kind_of, this->validated_value(), klass.validated_value());
     return RB_TEST(result);
   }
 
   inline void Object::extend(Module const& mod)
   {
-    detail::protect(rb_extend_object, this->value(), mod.value());
+    detail::protect(rb_extend_object, this->validated_value(), mod.validated_value());
   }
 
   inline bool Object::respond_to(Identifier id) const
   {
-    return bool(rb_respond_to(this->value(), id.id()));
+    return bool(rb_respond_to(this->validated_value(), id.id()));
   }
 
   inline bool Object::is_instance_of(Object klass) const
   {
-    VALUE result = detail::protect(rb_obj_is_instance_of, this->value(), klass.value());
+    VALUE result = detail::protect(rb_obj_is_instance_of, this->validated_value(), klass.validated_value());
     return RB_TEST(result);
   }
 
   inline Object Object::iv_get(Identifier name) const
   {
-    return detail::protect(rb_ivar_get, this->value(), name.id());
+    return detail::protect(rb_ivar_get, this->validated_value(), name.id());
   }
 
   inline Object Object::attr_get(Identifier name) const
   {
-    return detail::protect(rb_attr_get, this->value(), name.id());
+    return detail::protect(rb_attr_get, this->validated_value(), name.id());
   }
 
   inline void Object::set_value(VALUE value)
@@ -148,20 +156,20 @@ namespace Rice
 
   inline Object Object::const_get(Identifier name) const
   {
-    return detail::protect(rb_const_get, this->value(), name.id());
+    return detail::protect(rb_const_get, this->validated_value(), name.id());
   }
 
   inline bool Object::const_defined(Identifier name) const
   {
-    size_t result = detail::protect(rb_const_defined, this->value(), name.id());
+    size_t result = detail::protect(rb_const_defined, this->validated_value(), name.id());
     return bool(result);
   }
 
   inline Object Object::const_set(Identifier name, Object value)
   {
     // We will allow setting constants to Qnil, or the decimal value of 4. This happens
-    // in C++ libraries with enums. Thus skip the value() method that raises excptions
-    detail::protect(rb_const_set, this->value(), name.id(), value.value_.value());
+    // in C++ libraries with enums. Thus use value() instead of validated_value
+    detail::protect(rb_const_set, this->validated_value(), name.id(), value.value());
     return value;
   }
 
@@ -176,7 +184,7 @@ namespace Rice
 
   inline void Object::remove_const(Identifier name)
   {
-    detail::protect(rb_mod_remove_const, this->value(), name.to_sym());
+    detail::protect(rb_mod_remove_const, this->validated_value(), name.to_sym());
   }
 
   inline bool operator==(Object const& lhs, Object const& rhs)

data/rice/cpp_api/String.ipp

@@ -47,22 +47,22 @@ namespace Rice
 
   inline size_t String::length() const
   {
-    return RSTRING_LEN(value());
+    return RSTRING_LEN(this->value());
   }
 
   inline char String::operator[](ptrdiff_t index) const
   {
-    return RSTRING_PTR(value())[index];
+    return RSTRING_PTR(this->value())[index];
   }
 
   inline char const* String::c_str() const
   {
-    return RSTRING_PTR(value());
+    return RSTRING_PTR(this->value());
   }
 
   inline std::string String::str() const
   {
-    return std::string(RSTRING_PTR(value()), length());
+    return std::string(RSTRING_PTR(this->value()), length());
   }
 
   template<typename T>

data/rice/cpp_api/shared_methods.hpp

@@ -9,7 +9,7 @@
 */
 inline auto& include_module(Module const& inc)
 {
-  detail::protect(rb_include_module, this->value(), inc.value());
+  detail::protect(rb_include_module, this->validated_value(), inc.value());
   return *this;
 }
 
@@ -33,7 +33,7 @@ inline auto& include_module(Module const& inc)
 template<typename Method_T, typename...Arg_Ts>
 inline auto& define_method(std::string name, Method_T&& method, const Arg_Ts&...args)
 {
-  this->wrap_native_method(this->value(), name, std::forward<Method_T>(method), args...);
+  this->wrap_native_method(this->validated_value(), name, std::forward<Method_T>(method), args...);
   return *this;
 }
 
@@ -51,7 +51,7 @@ inline auto& define_method(std::string name, Method_T&& method, const Arg_Ts&...
 template<typename Function_T, typename...Arg_Ts>
 inline auto& define_function(std::string name, Function_T&& func, const Arg_Ts&...args)
 {
-  this->wrap_native_function(this->value(), name, std::forward<Function_T>(func), args...);
+  this->wrap_native_function(this->validated_value(), name, std::forward<Function_T>(func), args...);
   return *this;
 }
 
@@ -125,6 +125,6 @@ template<typename Constant_T>
 inline auto& define_constant(std::string name, Constant_T value)
 {
   using Base_T = detail::remove_cv_recursive_t<Constant_T>;
-  detail::protect(rb_define_const, this->value(), name.c_str(), detail::To_Ruby<Base_T>().convert(value));
+  detail::protect(rb_define_const, this->validated_value(), name.c_str(), detail::To_Ruby<Base_T>().convert(value));
   return *this;
 }

data/rice/detail/Parameter.ipp

@@ -165,6 +165,10 @@ namespace Rice::detail
           T defaultValue = this->arg()->template defaultValue<T>();
           return this->toRuby_.convert(defaultValue);
         }
+        else
+        {
+          throw std::runtime_error("Default value not allowed for parameter " + this->arg()->name);
+        }
       }
       else
       {

data/test/test_Object.cpp

@@ -97,12 +97,7 @@ TESTCASE(implicit_conversion_to_value)
   ASSERT_EQUAL(INT2NUM(42), (VALUE)Object(INT2NUM(42)));
   ASSERT_EQUAL(Qfalse, (VALUE)Object(Qfalse));
   ASSERT_EQUAL(Qundef, (VALUE)Object(Qundef));
-
-  ASSERT_EXCEPTION_CHECK(
-    std::runtime_error,
-    (VALUE)Object(Qnil),
-    ASSERT_EQUAL("Rice Object does not wrap a Ruby object", ex.what())
-  );
+  ASSERT_EQUAL(Qnil, (VALUE)Object(Qnil));
 }
 
 TESTCASE(explicit_conversion_to_value)
@@ -111,12 +106,7 @@ TESTCASE(explicit_conversion_to_value)
   ASSERT_EQUAL(INT2NUM(42), Object(INT2NUM(42)).value());
   ASSERT_EQUAL(Qfalse, Object(Qfalse).value());
   ASSERT_EQUAL(Qundef, Object(Qundef).value());
-
-  ASSERT_EXCEPTION_CHECK(
-    std::runtime_error,
-    Object(Qnil).value(),
-    ASSERT_EQUAL("Rice Object does not wrap a Ruby object", ex.what())
-  );
+  ASSERT_EQUAL(Qnil, Object(Qnil).value());
 }
 
 TESTCASE(class_of)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rice
 version: !ruby/object:Gem::Version
-  version: 4.11.0
+  version: 4.11.1
 platform: ruby
 authors:
 - Paul Brannan