feat: adding public method

[ascandone]

No description provided.

[coderabbitai]

Walkthrough

The changes add a new method GetNeededVariables to the ParseResult struct in numscript.go. This method iterates over variable declarations stored in p.parseResult.Value.Vars, checking for non-nil declarations with a nil origin before adding them to a map keyed by variable names with their types as values. Additionally, a new test function TestGetVars in numscript_test.go verifies that the method correctly returns the expected mapping and that there are no parsing errors.

Changes

File(s)	Change Summary
numscript.go	Added GetNeededVariables method to ParseResult struct that returns a map[string]string mapping variable names to types by iterating over Vars.
numscript_test.go	Added TestGetVars test function to parse a vars block, verify no parsing errors, and confirm that GetNeededVariables returns the expected map.

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant ParseResult
    participant VarDeclaration
    Caller->>ParseResult: GetNeededVariables()
    ParseResult->>VarDeclaration: Iterate over Vars
    alt Valid variable (non-nil, nil origin)
        ParseResult->>ParseResult: Add (name, type) to map
    else
        ParseResult->>ParseResult: Skip variable
    end
    ParseResult->>Caller: Return variables map

Loading

sequenceDiagram
    participant Test as TestGetVars
    participant Parser
    participant ParseResult
    Test->>Parser: Parse(raw vars script)
    Parser->>ParseResult: Create parseResult object
    Test->>ParseResult: Call GetParsingErrors()
    Test->>ParseResult: Call GetNeededVariables()
    Test->>Test: Validate output against expected map

Loading

Poem

A little rabbit hops in code delight,
Mapping variables by day and night,
With each line and every test so neat,
Bugs and errors gracefully meet defeat.
A happy code garden, a tale to unfold—
Hoppy coding, brave and bold! 🐇

---

📜 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 12977d3 and d1ee8a8.

📒 Files selected for processing (2)

• numscript.go (1 hunks)
• numscript_test.go (1 hunks)

🔇 Additional comments (2)

numscript.go (1)

15-30: Well-implemented method for extracting variable requirements.

The implementation of GetNeededVariables() is clean and follows the documented behavior. It correctly identifies variables that need external values by checking for nil origins, and the map structure provides a clear interface for consumers of this API.

numscript_test.go (1)

14-36: Test provides good coverage for the new method.

The test effectively validates that:

1. Variables without initialization ($mon, $acc, $acc2) are included in the output map
2. Variables with initialization ($do_not_include_in_output) are excluded
3. Only the variable names (without the $ prefix) are mapped to their types

This ensures the GetNeededVariables() method behaves as expected.

✨ 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.
  • 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.
• @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.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 63.60%. Comparing base (12977d3) to head (d1ee8a8).
Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main      #46      +/-   ##
==========================================
+ Coverage   63.48%   63.60%   +0.12%     
==========================================
  Files          31       31              
  Lines        7101     7100       -1     
==========================================
+ Hits         4508     4516       +8     
+ Misses       2384     2375       -9     
  Partials      209      209              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.