add DuckDB::ValueImpl class

[suketa]

Summary by CodeRabbit

• New Features

  • Introduced a new internal class, DuckDB::ValueImpl, as part of the DuckDB Ruby extension. This class is currently under construction and not intended for direct user interaction.

• Documentation

  • Updated the changelog to reflect the addition of DuckDB::ValueImpl.

[coderabbitai]

Walkthrough

A new internal Ruby class, DuckDB::ValueImpl, was introduced in the DuckDB Ruby extension to encapsulate DuckDB value objects. Supporting C source and header files were added, with appropriate initialization and memory management routines. The main extension initialization function and header files were updated to register and reference this new class. The changelog was updated to reflect these changes.

Changes

File(s)	Change Summary
CHANGELOG.md	Added entry for new DuckDB::ValueImpl class, marked as under construction and not for user use.
ext/duckdb/duckdb.c	Added call to initialize the new duckdb_value_impl component in the extension init function.
ext/duckdb/ruby-duckdb.h	Included value_impl.h and declared external cDuckDBValueImpl symbol.
ext/duckdb/value_impl.c, ext/duckdb/value_impl.h	Introduced implementation and header for DuckDB::ValueImpl, including struct, memory management, and init routine.

Sequence Diagram(s)

sequenceDiagram
    participant RubyApp as Ruby Application
    participant DuckDBExt as DuckDB Ruby Extension
    participant ValueImpl as DuckDB::ValueImpl

    RubyApp->>DuckDBExt: require 'duckdb'
    DuckDBExt->>DuckDBExt: Init_duckdb_native()
    DuckDBExt->>DuckDBExt: rbduckdb_init_duckdb_value_impl()
    DuckDBExt->>ValueImpl: Define DuckDB::ValueImpl class
    Note right of ValueImpl: Class registered (internal use)

Loading

Poem

In the garden of code where the ducklings dwell,
A ValueImpl sprouts, in Ruby’s shell.
With careful memory and structs anew,
It’s hidden from users, but not from the crew.
Changelog whispers, “It’s under construction!”
🦆✨—A rabbit’s ode to careful instruction.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between cd4b0a3 and a48acd3.

📒 Files selected for processing (5)

• CHANGELOG.md (1 hunks)
• ext/duckdb/duckdb.c (1 hunks)
• ext/duckdb/ruby-duckdb.h (2 hunks)
• ext/duckdb/value_impl.c (1 hunks)
• ext/duckdb/value_impl.h (1 hunks)

🧰 Additional context used

🧠 Learnings (6)

📓 Common learnings

Learnt from: suketa
PR: suketa/ruby-duckdb#0
File: :0-0
Timestamp: 2025-01-24T22:37:32.786Z
Learning: In Ruby-DuckDB C extensions, when initializing resources like prepared statements, store them directly in the context structure instead of using temporary variables to prevent memory leaks, especially when exceptions might be thrown.

Learnt from: suketa
PR: suketa/ruby-duckdb#871
File: ext/duckdb/appender.c:170-178
Timestamp: 2025-01-26T00:37:44.001Z
Learning: In ruby-duckdb's DuckDB::Appender#append_uint8, values larger than uint8 max (255) are silently truncated to maintain backward compatibility, following C's implicit truncation behavior. Range checking is intentionally omitted to avoid breaking changes.

Learnt from: suketa
PR: suketa/ruby-duckdb#0
File: :0-0
Timestamp: 2025-01-24T22:18:24.630Z
Learning: When using ruby-asan (AddressSanitizer), avoid letting DuckDB throw C++ exceptions by checking conditions (like table existence) beforehand and raising Ruby exceptions directly to prevent ASAN from intercepting the C++ exceptions.

Learnt from: suketa
PR: suketa/ruby-duckdb#0
File: :0-0
Timestamp: 2025-01-25T05:20:48.677Z
Learning: In Ruby C extensions, prefer using Ruby's string functions (like rb_str_new2) over C string functions (like strdup) to avoid manual memory management and potential memory leaks.

ext/duckdb/ruby-duckdb.h (3)

Learnt from: suketa
PR: suketa/ruby-duckdb#0
File: :0-0
Timestamp: 2025-01-24T22:37:32.786Z
Learning: In Ruby-DuckDB C extensions, when initializing resources like prepared statements, store them directly in the context structure instead of using temporary variables to prevent memory leaks, especially when exceptions might be thrown.

Learnt from: suketa
PR: suketa/ruby-duckdb#0
File: :0-0
Timestamp: 2025-01-24T22:18:24.630Z
Learning: When using ruby-asan (AddressSanitizer), avoid letting DuckDB throw C++ exceptions by checking conditions (like table existence) beforehand and raising Ruby exceptions directly to prevent ASAN from intercepting the C++ exceptions.

Learnt from: suketa
PR: suketa/ruby-duckdb#871
File: ext/duckdb/appender.c:170-178
Timestamp: 2025-01-26T00:37:44.001Z
Learning: In ruby-duckdb's DuckDB::Appender#append_uint8, values larger than uint8 max (255) are silently truncated to maintain backward compatibility, following C's implicit truncation behavior. Range checking is intentionally omitted to avoid breaking changes.

CHANGELOG.md (3)

Learnt from: suketa
PR: suketa/ruby-duckdb#871
File: ext/duckdb/appender.c:170-178
Timestamp: 2025-01-26T00:37:44.001Z
Learning: In ruby-duckdb's DuckDB::Appender#append_uint8, values larger than uint8 max (255) are silently truncated to maintain backward compatibility, following C's implicit truncation behavior. Range checking is intentionally omitted to avoid breaking changes.

Learnt from: suketa
PR: suketa/ruby-duckdb#0
File: :0-0
Timestamp: 2025-01-24T22:18:24.630Z
Learning: When using ruby-asan (AddressSanitizer), avoid letting DuckDB throw C++ exceptions by checking conditions (like table existence) beforehand and raising Ruby exceptions directly to prevent ASAN from intercepting the C++ exceptions.

Learnt from: suketa
PR: suketa/ruby-duckdb#0
File: :0-0
Timestamp: 2025-01-24T22:37:32.786Z
Learning: In Ruby-DuckDB C extensions, when initializing resources like prepared statements, store them directly in the context structure instead of using temporary variables to prevent memory leaks, especially when exceptions might be thrown.

ext/duckdb/duckdb.c (3)

Learnt from: suketa
PR: suketa/ruby-duckdb#0
File: :0-0
Timestamp: 2025-01-24T22:37:32.786Z
Learning: In Ruby-DuckDB C extensions, when initializing resources like prepared statements, store them directly in the context structure instead of using temporary variables to prevent memory leaks, especially when exceptions might be thrown.

Learnt from: suketa
PR: suketa/ruby-duckdb#0
File: :0-0
Timestamp: 2025-01-24T22:18:24.630Z
Learning: When using ruby-asan (AddressSanitizer), avoid letting DuckDB throw C++ exceptions by checking conditions (like table existence) beforehand and raising Ruby exceptions directly to prevent ASAN from intercepting the C++ exceptions.

Learnt from: suketa
PR: suketa/ruby-duckdb#871
File: ext/duckdb/appender.c:170-178
Timestamp: 2025-01-26T00:37:44.001Z
Learning: In ruby-duckdb's DuckDB::Appender#append_uint8, values larger than uint8 max (255) are silently truncated to maintain backward compatibility, following C's implicit truncation behavior. Range checking is intentionally omitted to avoid breaking changes.

ext/duckdb/value_impl.h (3)

Learnt from: suketa
PR: suketa/ruby-duckdb#0
File: :0-0
Timestamp: 2025-01-24T22:37:32.786Z
Learning: In Ruby-DuckDB C extensions, when initializing resources like prepared statements, store them directly in the context structure instead of using temporary variables to prevent memory leaks, especially when exceptions might be thrown.

Learnt from: suketa
PR: suketa/ruby-duckdb#0
File: :0-0
Timestamp: 2025-01-24T22:18:24.630Z
Learning: When using ruby-asan (AddressSanitizer), avoid letting DuckDB throw C++ exceptions by checking conditions (like table existence) beforehand and raising Ruby exceptions directly to prevent ASAN from intercepting the C++ exceptions.

Learnt from: suketa
PR: suketa/ruby-duckdb#871
File: ext/duckdb/appender.c:170-178
Timestamp: 2025-01-26T00:37:44.001Z
Learning: In ruby-duckdb's DuckDB::Appender#append_uint8, values larger than uint8 max (255) are silently truncated to maintain backward compatibility, following C's implicit truncation behavior. Range checking is intentionally omitted to avoid breaking changes.

ext/duckdb/value_impl.c (5)

Learnt from: suketa
PR: suketa/ruby-duckdb#0
File: :0-0
Timestamp: 2025-01-24T22:37:32.786Z
Learning: In Ruby-DuckDB C extensions, when initializing resources like prepared statements, store them directly in the context structure instead of using temporary variables to prevent memory leaks, especially when exceptions might be thrown.

Learnt from: suketa
PR: suketa/ruby-duckdb#0
File: :0-0
Timestamp: 2025-01-25T05:20:48.677Z
Learning: In Ruby C extensions, prefer using Ruby's string functions (like rb_str_new2) over C string functions (like strdup) to avoid manual memory management and potential memory leaks.

Learnt from: suketa
PR: suketa/ruby-duckdb#0
File: :0-0
Timestamp: 2025-01-25T05:11:42.406Z
Learning: In Ruby C extensions, when raising exceptions with dynamically allocated error messages, ensure to free the memory after rb_exc_raise as the code continues execution if the exception is caught with rescue.

Learnt from: suketa
PR: suketa/ruby-duckdb#0
File: :0-0
Timestamp: 2025-01-24T22:18:24.630Z
Learning: When using ruby-asan (AddressSanitizer), avoid letting DuckDB throw C++ exceptions by checking conditions (like table existence) beforehand and raising Ruby exceptions directly to prevent ASAN from intercepting the C++ exceptions.

Learnt from: suketa
PR: suketa/ruby-duckdb#871
File: ext/duckdb/appender.c:170-178
Timestamp: 2025-01-26T00:37:44.001Z
Learning: In ruby-duckdb's DuckDB::Appender#append_uint8, values larger than uint8 max (255) are silently truncated to maintain backward compatibility, following C's implicit truncation behavior. Range checking is intentionally omitted to avoid breaking changes.

🧬 Code Graph Analysis (2)

ext/duckdb/duckdb.c (2)

ext/duckdb/value_impl.h (1)

• rbduckdb_init_duckdb_value_impl (10-10)

ext/duckdb/value_impl.c (1)

• rbduckdb_init_duckdb_value_impl (31-37)

ext/duckdb/value_impl.c (1)

ext/duckdb/value_impl.h (1)

• rbduckdb_init_duckdb_value_impl (10-10)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (12)

• GitHub Check: test (3.5.0-preview1, 1.2.2)
• GitHub Check: test (3.5.0-preview1, 1.3.2)
• GitHub Check: test (3.2.6, 1.3.2)
• GitHub Check: test (3.5.0-preview1, 1.2.2)
• GitHub Check: test (mingw, 1.2.2)
• GitHub Check: test (mingw, 1.3.2)
• GitHub Check: test (ucrt, 1.2.2)
• GitHub Check: test (3.3.8, 1.3.2)
• GitHub Check: test (3.4.1, 1.3.2)
• GitHub Check: test (3.4.1, 1.2.2)
• GitHub Check: test (3.3.8, 1.2.2)
• GitHub Check: test (3.2.6, 1.2.2)

🔇 Additional comments (10)

ext/duckdb/ruby-duckdb.h (2)

31-31: LGTM - Header include follows established pattern.

The include placement is consistent with other component headers in the file.

---

44-44: LGTM - External declaration follows convention.

The external VALUE declaration is properly placed with other similar declarations.

CHANGELOG.md (1)

8-8: LGTM - Appropriate changelog entry with important user guidance.

The entry correctly documents the new class and includes the important caveat that it's under construction and not for direct use.

ext/duckdb/duckdb.c (1)

43-43: LGTM - Proper initialization call placement.

The initialization function call follows the established pattern and is appropriately placed with other component initializations.

ext/duckdb/value_impl.h (1)

1-13: LGTM - Clean and minimal header design.

The header file follows best practices with:

• Proper include guards
• Simple struct design with single duckdb_value member
• Clear typedef and function declaration
• Minimal interface appropriate for a wrapper class

ext/duckdb/value_impl.c (5)

9-13: LGTM - Proper typed data configuration.

The data type descriptor correctly implements Ruby's typed data API with appropriate flags:

• RUBY_TYPED_FREE_IMMEDIATELY is suitable for simple wrapper structs
• All required function pointers are properly set

---

15-20: LGTM - Proper resource cleanup in deallocate.

The deallocate function correctly:

• Calls duckdb_destroy_value to clean up DuckDB resources
• Uses xfree for memory deallocation
• Follows the pattern established in other components

Since xcalloc zero-initializes the struct in allocate, duckdb_destroy_value should safely handle the zero-initialized duckdb_value.

---

22-25: LGTM - Safe allocation with zero-initialization.

The allocate function properly:

• Uses xcalloc to zero-initialize the struct (preventing issues with uninitialized values)
• Returns a properly wrapped TypedData object
• Follows Ruby C extension best practices from the retrieved learnings

---

27-29: LGTM - Correct memory size reporting.

The memsize function correctly returns the size of the struct for Ruby's garbage collector.

---

31-37: LGTM - Proper class initialization.

The initialization function correctly:

• Defines the class under the existing mDuckDB module (the commented code confirms this dependency)
• Sets the allocation function
• Follows the established pattern from other components

The commented mDuckDB definition indicates proper dependency on the module being defined elsewhere (in duckdb.c).

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.