Add unit test

[nao1215]

Summary by CodeRabbit

• Documentation

  • Updated README with project badges
  • Clarified description of the vogen tool as a library for generating Value Objects in Go

• Tests

  • Added comprehensive test coverage for vogen package
  • Implemented tests for error handling in New and AppendValueObjects methods

• Bug Fixes

  • Updated error handling logic in validation process
  • Modified error constant from ErrInvalidFieldName to ErrInvalidField

[coderabbitai]

Walkthrough

The pull request introduces enhancements to the vogen package, a Go library for generating value objects. The changes include adding badges to the README.md, modifying error handling in the validate method, and creating comprehensive test cases in vogen_test.go. The modifications aim to improve the project's documentation, error reporting, and test coverage, ensuring more robust validation of input parameters during value object generation.

Changes

File	Changes
README.md	- Added project badges (Go reference, code coverage, review dog, unit test status) - Slightly rephrased project description
vogen.go	- Updated error constant from ErrInvalidFieldName to ErrInvalidField
vogen_test.go	- Added TestNew function with parallel tests for error handling - Added TestVogen_AppendValueObjects function with parallel tests for input validation

Sequence Diagram

sequenceDiagram
    participant User
    participant Vogen
    participant Validator
    
    User->>Vogen: New()
    Vogen->>Validator: Validate inputs
    alt Invalid FilePath
        Validator-->>User: ErrInvalidFilePath
    end
    alt Invalid PackageName
        Validator-->>User: ErrInvalidPackageName
    end
    
    User->>Vogen: AppendValueObjects()
    Vogen->>Validator: Validate ValueObject
    alt Empty StructName
        Validator-->>User: ErrStructNameEmpty
    end
    alt Invalid Fields
        Validator-->>User: ErrInvalidField
    end

Loading

Poem

🐰 A Rabbit's Ode to Validation's Grace 🔍

In Go's green fields, where value objects play,
Errors now dance with clarity's bright ray
No more ambiguous names that confuse
Our tests now guard each path we choose
Robust and strong, our code takes flight! 🚀

Tip

CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request. We would love to hear your feedback on Discord. This feature will be included in our new Pro Plan when released, so please consider upgrading your current plan.

---

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 89e9de2 and 8553dc2.

📒 Files selected for processing (3)

• README.md (1 hunks)
• vogen.go (1 hunks)
• vogen_test.go (1 hunks)

✅ Files skipped from review due to trivial changes (1)

• README.md

---

Note

🎁 Summarized by CodeRabbit Free

Your organization is on the Free plan. CodeRabbit will generate a high-level summary and a walkthrough for each pull request. For a comprehensive line-by-line review, please upgrade your subscription to CodeRabbit Pro by visiting https://app.coderabbit.ai/login.

🪧 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 generate docstrings to generate docstrings for this PR. (Beta)
• @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.

[github-actions]

Code Metrics Report

	main (89e9de2)	#4 (37ce975)	+/-
Coverage	86.5%	95.5%	+8.9%
Test Execution Time	12s	17s	+5s

Details

  |                     | main (89e9de2) | #4 (37ce975) |  +/-  |
  |---------------------|----------------|--------------|-------|
+ | Coverage            |          86.5% |        95.5% | +8.9% |
  |   Files             |              2 |            2 |     0 |
  |   Lines             |             89 |           89 |     0 |
+ |   Covered           |             77 |           85 |    +8 |
- | Test Execution Time |            12s |          17s |   +5s |

Code coverage of files in pull request scope (87.3% → 94.9%)

Files	Coverage	+/-
vogen.go	94.9%	+7.5%

---

Reported by octocov