feat: add support for decoding into []any types

[shogo82148]

Summary by CodeRabbit

• New Features
  • Improved CSV decoding flexibility, allowing dynamic conversion of interface types into map structures.
• Tests
  • Expanded test coverage with additional scenarios to validate proper handling of diverse input types and error conditions, including new error handling tests.

[coderabbitai]

Walkthrough

This pull request enhances the CSV decoding functionality by adding a new branch in the decodeRecord method to handle values of type reflect.Interface. When such a type is encountered, the method creates a map[string]string using keys from the header and values from the record and assigns it to the interface. In addition, the tests have been extended with a helper function ptrany and new test cases to validate the decoding of any types and proper error handling when inputs are incorrect.

Changes

File(s) Changed	Change Summary
decode.go	Added a new case in decodeRecord to handle reflect.Interface by constructing a map[string]string from CSV headers and record values while preserving existing logic.
decode_test.go	Introduced the ptrany helper function to obtain pointers from any types; added test cases in TestDecodeRecord, TestDecodeAll, and a new TestDecodeAll_error function to check decoding behavior and error handling.

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant Decoder
    Caller->>Decoder: Call decodeRecord with CSV record & target interface
    Decoder->>Decoder: Check type with reflect (is interface?)
    Decoder->>Decoder: Create map[string]string from header & record values
    Decoder->>Caller: Return populated interface with map value

Loading

Possibly related PRs

• add DecodeError type for improved error handling in decoding #37: Modifications in the decodeRecord method to return a new DecodeError type for error handling, indicating a direct relationship with the current changes.
• Add field to decode error #42: Enhancements to the decodeRecord method that focus on improved error reporting, closely related due to the structural changes in decoding logic.

Poem

I'm a coding rabbit, hopping in delight,
New decoding tricks make my day so bright.
With maps and tests in a neat little row,
I cheer as my code starts to glow.
ASCII carrots and bunny smiles, oh what a sight!
Hoppin' through code, everything's just right.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro (Legacy)

📥 Commits

Reviewing files that changed from the base of the PR and between e4875d5 and 32545fb.

📒 Files selected for processing (2)

• decode.go (2 hunks)
• decode_test.go (5 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• decode.go

🧰 Additional context used

🧬 Code Definitions (1)

decode_test.go (1)

decode.go (1)

• NewDecoder (45-47)

🔇 Additional comments (6)

decode_test.go (6)

49-51: Good addition of SomeInterface for testing non-empty interfaces

The SomeInterface interface will be useful for testing how the decoder handles non-empty interfaces, providing better test coverage for error cases.

---

54-54: Clean implementation of ptrany helper function

The ptrany function follows the same pattern as the existing ptrstr function, maintaining code consistency while supporting the new feature for decoding into any types.

---

310-315: Well-structured test case for decoding into any type

This test case properly validates that a CSV record can be decoded into an any type, which is a map with the header as keys and values from the record. The test uses the new ptrany helper function correctly.

---

591-598: Thorough error case testing for non-empty interfaces

This test correctly verifies that the decoder will fail when attempting to decode into a non-empty interface type (SomeInterface), as the decoder cannot determine which concrete type to instantiate.

---

691-696: Good test coverage for decoding into []any

This test case properly validates that a CSV file can be decoded into a slice of any types, with each element becoming a map of header keys to values.

---

710-743: Comprehensive error testing for DecodeAll

The test function covers all essential error cases:

1. Input not being a pointer
2. Input being neither a slice nor an array
3. Non-empty interfaces used for records or fields

This thorough error testing ensures the decoder fails gracefully with appropriate error messages in invalid scenarios.

---

🪧 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.
  • Generate unit testing code for this file.
  • 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 generate unit testing code for this file.
  • @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 generate unit testing code.
  • @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.

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 resolve resolve all the CodeRabbit review comments.
• @coderabbitai plan to trigger planning for file edits and PR creation.
• @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.

[coveralls]

Pull Request Test Coverage Report for Build 14101965148

Details

• 14 of 15 (93.33%) changed or added relevant lines in 1 file are covered.
• No unchanged relevant lines lost coverage.
• Overall coverage increased (+1.8%) to 84.44%

---

Changes Missing Coverage	Covered Lines	Changed/Added Lines	%
decode.go	14	15	93.33%

Totals
Change from base Build 14100815426:	1.8%
Covered Lines:	445
Relevant Lines:	527

---

💛 - Coveralls

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

decode.go (1)

267-277: Nice implementation for interface decoding!

The added code effectively handles the case where v is of kind reflect.Interface by creating a map[string]string and populating it with key-value pairs from the header and record. This enhancement allows for more flexible data handling in CSV decoding.

Consider adding a doc comment explaining this behavior of always decoding interfaces to map[string]string to help users understand the expected behavior.

 // DecodeRecord reads the next CSV record from its input and stores it in the value pointed to by v.
+// When v is an interface, it will be populated with a map[string]string containing the CSV header fields as keys.
 func (dec *Decoder) DecodeRecord(v any) error {

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 706c93f and e4875d5.

📒 Files selected for processing (2)

• decode.go (1 hunks)
• decode_test.go (4 hunks)

🔇 Additional comments (4)

decode_test.go (4)

50-50: LGTM: Helper function for testing interface pointers

This helper function is a good complement to the existing ptrstr function, making it easier to test the new interface decoding capability.

---

306-311: Good test coverage for the new interface decoding

The test case verifies that the CSV content can be properly decoded into an interface value that contains a map[string]string. This directly tests the new functionality added to the decodeRecord method.

---

678-683: Comprehensive test for interface slices

This test case nicely complements the individual interface test by verifying that decoding into a slice of interfaces works correctly, ensuring the functionality is properly integrated with the collection-handling logic.

---

697-713: Good error handling coverage

These error tests ensure that DecodeAll properly validates its inputs, rejecting non-pointer values and values that are neither slices nor arrays. This improves the robustness of the error handling and test coverage.