rice 4.7.1 → 4.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c8d106501ff928ca481358d579bffe110efebbd4a98f3de141b8a4e6a853b17a
-  data.tar.gz: 900e679ee80f32d547487133911dfa1ccdd087a41414fb44a1c8b144fec15278
+  metadata.gz: 60ee7533ef1a2e8fae4a992ef2d1dc2f3dd1cd4ab260217058e9de77ead8f80b
+  data.tar.gz: 83393a7a4238d817da51eccc5392d318bb2dab00e57d9ce688867a748a50f7a5
 SHA512:
-  metadata.gz: 33837b467af9b734848a7ef09b552ed2ab25f7f86c6fdedbc8f6c85dc42137d2ca46e9fd812198b99baa4af94f1f659d15530f9ecf36a2e147d3ddfb5f3c02ff
-  data.tar.gz: 11bccd16adcb9a117a5ce80c91b219b1102a1fde56086542528a4684cedc84631261c6afb583dbebb0c25c3a2b1908c2196197f36c79cfc7db7322ab104d0388
+  metadata.gz: 26c796a5fcac6d816f9cddda0944be07a16cc93a0264221a351f4612061ed3b0e61dd4ab99eae0470ebc62e483f762820116024f6814f9f0023adccc466d66cf
+  data.tar.gz: aacb86cb9d086100650839ac2cf2cf49d60dcf4604f3539be24e0922c3f3ca3a8f06dfb0511e1e1b3281e9f475cf621218ac165b4c155e5d6e4e2083b3444823

data/CHANGELOG.md

@@ -1,3 +1,39 @@
+# Changelog 
+
+## 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.
+
+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:
+
+* Compilation times are approximately 2x faster than version 4.7
+* Compiled library sizes are about 30% smaller
+* Improved keyword argument support
+* Improved method override support
+* Improved CMake support
+* Improved rbs generation support
+* Improved api documentation generation support
+* Expanded and improved documentation
+* Enum values can now be compared against their underlying type (e.g., `Season::Red == 0`)
+* STL containers now support `==` and `eql?` for equality comparison
+* Automatic creation of `std::shared_ptr<T>` Ruby classes
+* Support for C++ references in callbacks
+* Array class now supports random iterators
+* 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:
+
+* `Return().isBuffer()` is replaced by `ReturnBuffer()`
+* `Arg("").isBuffer()` is replaced by `ArgBuffer("")`
+* `Function().noGVL()` is replaced by `NoGvL()`
+* `is_convertible` methods must now return a `double` instead of a `Convertible` enum
+* 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:
 * Update overload resolution to take into account function arguments that are tagged as buffers via Arg("").setBuffer().
@@ -217,7 +253,7 @@ There are a ton of changes, but some of the most important ones:
 	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)
+## 2.0.0 (2015-11-27)
 
 * Deprecated all versions of Ruby < 2.0
 * Removed Rice::VM.

data/CMakeLists.txt

@@ -1,27 +1,19 @@
-cmake_minimum_required (VERSION 3.26)
+cmake_minimum_required(VERSION 3.26)
 
-project(Rice)
+project(rice LANGUAGES CXX)
 
-set(CMAKE_CXX_STANDARD 17)
-set(CMAKE_CXX_STANDARD_REQUIRED ON)
+# Put actual target definitions in a separate file so the root stays tiny.
+include(${CMAKE_CURRENT_SOURCE_DIR}/Rice.cmake)
 
-# For older versions of CMake can use include("./FindRuby.cmake")
-find_package("Ruby")
-
-if (CMAKE_CXX_COMPILER_ID STREQUAL "MSVC")
-    set(CMAKE_MSVC_DEBUG_INFORMATION_FORMAT "$<IF:$<AND:$<C_COMPILER_ID:MSVC>,$<CXX_COMPILER_ID:MSVC>>,$<$<CONFIG:Debug,RelWithDebInfo>:EditAndContinue>,$<$<CONFIG:Debug,RelWithDebInfo>:ProgramDatabase>>")
-    add_compile_definitions(-D_CRT_SECURE_NO_DEPRECATE -D_CRT_NONSTDC_NO_DEPRECATE)
-    add_compile_options(/bigobj /utf-8)
-    # The default of /EHsc crashes Ruby when calling longjmp with optimizations on (/O2)
-    string(REGEX REPLACE "/EHsc" "/EHs" CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS}")
-elseif (CMAKE_CXX_COMPILER_ID STREQUAL "Clang")
-    add_compile_definitions(-D_CRT_SECURE_NO_WARNINGS)
-elseif (CMAKE_CXX_COMPILER_ID STREQUAL "GNU")
-    add_compile_options(-ftemplate-backtrace-limit=0)
-    # https://github.com/doxygen/doxygen/issues/9269#issuecomment-1094975328
-    #add_compile_options(unittest PRIVATE -Wa,-mbig-obj)
-    set(CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG} -Og")
+# Default behavior:
+# - If you're working on Rice directly (top-level), build tests by default (good for Visual Studio).
+# - If Rice is consumed via FetchContent/add_subdirectory, do NOT build tests by default.
+if (PROJECT_IS_TOP_LEVEL)
+  option(RICE_BUILD_TESTS "Build Rice tests" ON)
+else ()
+  option(RICE_BUILD_TESTS "Build Rice tests" OFF)
 endif ()
 
-# Include sub-projects.
-add_subdirectory ("test")
+if (RICE_BUILD_TESTS AND EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/test/CMakeLists.txt")
+  add_subdirectory(test)
+endif ()

data/CMakePresets.json

@@ -1,75 +1,203 @@
-{
-    "version": 3,
-    "configurePresets": [
-        {
-            "name": "windows-base",
-            "hidden": true,
-            "generator": "Ninja",
-            "binaryDir": "${sourceDir}/out/build/${presetName}",
-            "installDir": "${sourceDir}/out/install/${presetName}",
-            "cacheVariables": {
-                "CMAKE_C_COMPILER": "cl.exe",
-                "CMAKE_CXX_COMPILER": "cl.exe"
-            },
-            "condition": {
-                "type": "equals",
-                "lhs": "${hostSystemName}",
-                "rhs": "Windows"
-            }
-        },
-        {
-            "name": "x64-debug",
-            "displayName": "MSVC++ Debug",
-            "inherits": "windows-base",
-            "architecture": {
-                "value": "x64",
-                "strategy": "external"
-            },
-            "cacheVariables": {
-                "CMAKE_BUILD_TYPE": "Debug"
-            }
-        },
-      {
-        "name": "x64-release",
-        "displayName": "x64 Release",
-        "inherits": "x64-debug",
-        "cacheVariables": {
-          "CMAKE_BUILD_TYPE": "Release"
-        }
-      },
-      {
-        "name": "linux-default",
-        "displayName": "Linux Debug",
-        "description": "Sets Ninja generator, compilers, build and install directory, debug build type",
-        "generator": "Ninja",
-        "binaryDir": "${sourceDir}/out/build/${presetName}",
-        "cacheVariables": {
-          "CMAKE_BUILD_TYPE": "Debug",
-          "CMAKE_INSTALL_PREFIX": "${sourceDir}/out/install/${presetName}"
-        },
-        "vendor": {
-          "microsoft.com/VisualStudioSettings/CMake/1.0": {
-            "hostOS": [ "Linux" ]
-          },
-          "microsoft.com/VisualStudioRemoteSettings/CMake/1.0": {
-            "sourceDir": "$env{HOME}/.vs/$ms{projectDirName}"
-          }
-        }
-      },
-      {
-        "name": "x64_debug_clang",
-        "displayName": "Clang Debug",
-        "description": "Target Windows (64-bit) with the Visual Studio development environment. (Debug)",
-        "inherits": "windows-base",
-        "architecture": {
-          "value": "x64",
-          "strategy": "external"
-        },
-        "cacheVariables": {
-          "CMAKE_BUILD_TYPE": "Debug",
-          "CMAKE_C_COMPILER": "clang.exe",
-          "CMAKE_CXX_COMPILER": "clang.exe"
-        }
-      }
-    ]
-}
+{
+  "version": 6,
+  "configurePresets": [
+    {
+      "name": "base",
+      "hidden": true,
+      "generator": "Ninja",
+      "binaryDir": "${sourceDir}/build/${presetName}",
+      "installDir": "${sourceDir}/install/${presetName}"
+    },
+    {
+      "name": "linux-debug",
+      "inherits": "base",
+      "displayName": "Linux Debug",
+      "cacheVariables": {
+        "CMAKE_BUILD_TYPE": "Debug",
+        "CMAKE_CXX_FLAGS": "-Wall -ftemplate-backtrace-limit=0 -Og"
+      },
+      "condition": {
+        "type": "equals",
+        "lhs": "${hostSystemName}",
+        "rhs": "Linux"
+      }
+    },
+    {
+      "name": "linux-release",
+      "inherits": "base",
+      "displayName": "Linux Release",
+      "cacheVariables": {
+        "CMAKE_BUILD_TYPE": "Release",
+        "CMAKE_CXX_FLAGS": "-Wall -ftemplate-backtrace-limit=0 -O3 -DNDEBUG"
+      },
+      "condition": {
+        "type": "equals",
+        "lhs": "${hostSystemName}",
+        "rhs": "Linux"
+      }
+    },
+    {
+      "name": "macos-debug",
+      "inherits": "base",
+      "displayName": "macOS Debug",
+      "cacheVariables": {
+        "CMAKE_BUILD_TYPE": "Debug",
+        "CMAKE_CXX_FLAGS": "-Wall -Wno-unused-private-field -ftemplate-backtrace-limit=0 -Og"
+      },
+      "condition": {
+        "type": "equals",
+        "lhs": "${hostSystemName}",
+        "rhs": "Darwin"
+      }
+    },
+    {
+      "name": "macos-release",
+      "inherits": "base",
+      "displayName": "macOS Release",
+      "cacheVariables": {
+        "CMAKE_BUILD_TYPE": "Release",
+        "CMAKE_CXX_FLAGS": "-Wall -Wno-unused-private-field -ftemplate-backtrace-limit=0 -O3 -DNDEBUG"
+      },
+      "condition": {
+        "type": "equals",
+        "lhs": "${hostSystemName}",
+        "rhs": "Darwin"
+      }
+    },
+    {
+      "name": "windows",
+      "hidden": true,
+      "inherits": "base",
+      "condition": {
+        "type": "equals",
+        "lhs": "${hostSystemName}",
+        "rhs": "Windows"
+      },
+      "toolchainFile": "$env{VCPKG_ROOT}\\scripts\\buildsystems\\vcpkg.cmake"
+    },
+    {
+      "name": "msvc-debug",
+      "inherits": "windows",
+      "displayName": "MSVC x64 Debug",
+      "cacheVariables": {
+        "CMAKE_BUILD_TYPE": "Debug",
+        "CMAKE_CXX_COMPILER": "cl.exe",
+        "CMAKE_CXX_FLAGS": "/EHs /W4 /bigobj /utf-8 /D_CRT_SECURE_NO_DEPRECATE /D_CRT_NONSTDC_NO_DEPRECATE",
+        "CMAKE_MSVC_DEBUG_INFORMATION_FORMAT": "EditAndContinue"
+      }
+    },
+    {
+      "name": "msvc-release",
+      "inherits": "windows",
+      "displayName": "MSVC x64 Release",
+      "cacheVariables": {
+        "CMAKE_BUILD_TYPE": "Release",
+        "CMAKE_CXX_COMPILER": "cl.exe",
+        "CMAKE_CXX_FLAGS": "/EHs /W4 /bigobj /utf-8 /O2 /DNDEBUG /D_CRT_SECURE_NO_DEPRECATE /D_CRT_NONSTDC_NO_DEPRECATE",
+        "CMAKE_MSVC_DEBUG_INFORMATION_FORMAT": "ProgramDatabase"
+      }
+    },
+    {
+      "name": "clang-windows-debug",
+      "inherits": "windows",
+      "displayName": "Clang Windows Debug",
+      "cacheVariables": {
+        "CMAKE_BUILD_TYPE": "Debug",
+        "CMAKE_CXX_COMPILER": "clang-cl.exe",
+        "CMAKE_CXX_FLAGS": "/EHs /W4 /bigobj /utf-8 /D_CRT_SECURE_NO_DEPRECATE /D_CRT_NONSTDC_NO_DEPRECATE /clang:-Wno-unused-private-field"
+      }
+    },
+    {
+      "name": "clang-windows-release",
+      "inherits": "windows",
+      "displayName": "Clang Windows Release",
+      "cacheVariables": {
+        "CMAKE_BUILD_TYPE": "Release",
+        "CMAKE_CXX_COMPILER": "clang-cl.exe",
+        "CMAKE_CXX_FLAGS": "/EHs /W4 /bigobj /utf-8 /O2 /DNDEBUG /D_CRT_SECURE_NO_DEPRECATE /D_CRT_NONSTDC_NO_DEPRECATE /clang:-Wno-unused-private-field"
+      }
+    },
+    {
+      "name": "mingw-debug",
+      "inherits": "base",
+      "displayName": "Mingw x64 Debug",
+      "cacheVariables": {
+        "CMAKE_BUILD_TYPE": "Debug",
+        "CMAKE_CXX_COMPILER": "g++.exe",
+        "CMAKE_CXX_FLAGS": "-Wall -ftemplate-backtrace-limit=0 -Wa,-mbig-obj -Og"
+      },
+      "condition": {
+        "type": "equals",
+        "lhs": "${hostSystemName}",
+        "rhs": "Windows"
+      }
+    },
+    {
+      "name": "mingw-release",
+      "inherits": "base",
+      "displayName": "Mingw x64 Release",
+      "cacheVariables": {
+        "CMAKE_BUILD_TYPE": "Release",
+        "CMAKE_CXX_COMPILER": "g++.exe",
+        "CMAKE_CXX_FLAGS": "-Wall -ftemplate-backtrace-limit=0 -Wa,-mbig-obj -O3 -DNDEBUG"
+      },
+      "condition": {
+        "type": "equals",
+        "lhs": "${hostSystemName}",
+        "rhs": "Windows"
+      }
+    }
+  ],
+  "buildPresets": [
+    {
+      "name": "linux-debug",
+      "displayName": "Build Linux Debug",
+      "configurePreset": "linux-debug"
+    },
+    {
+      "name": "linux-release",
+      "displayName": "Build Linux Release",
+      "configurePreset": "linux-release"
+    },
+    {
+      "name": "macos-debug",
+      "displayName": "Build macOS Debug",
+      "configurePreset": "macos-debug"
+    },
+    {
+      "name": "macos-release",
+      "displayName": "Build macOS Release",
+      "configurePreset": "macos-release"
+    },
+    {
+      "name": "msvc-debug",
+      "displayName": "Build MSVC x64 Debug",
+      "configurePreset": "msvc-debug"
+    },
+    {
+      "name": "msvc-release",
+      "displayName": "Build MSVC x64 Release",
+      "configurePreset": "msvc-release"
+    },
+    {
+      "name": "clang-windows-debug",
+      "displayName": "Build Clang Windows Debug",
+      "configurePreset": "clang-windows-debug"
+    },
+    {
+      "name": "clang-windows-release",
+      "displayName": "Build Clang Windows Release",
+      "configurePreset": "clang-windows-release"
+    },
+    {
+      "name": "mingw-debug",
+      "displayName": "Build Mingw x64 Debug",
+      "configurePreset": "mingw-debug"
+    },
+    {
+      "name": "mingw-release",
+      "displayName": "Build Mingw x64 Release",
+      "configurePreset": "mingw-release"
+    }
+  ]
+}