Add Function to Retrieve Currency Code by Numeric Code

[rbenatti8]

This PR adds a static function, GetCurrencyCodeByNumericCode, to allow retrieval of a currency code based on its ISO-4217 numeric code.

Purpose:

Simplifies the process of finding a currency code without manually iterating through the currency list.
Provides a more efficient and straightforward method for users needing to convert numeric codes to currency codes.
This function will help streamline workflows that rely on numeric codes for currency identification

Summary by Sourcery

Add a new function GetCurrencyByNumericCode to facilitate retrieving currency codes by their numeric ISO-4217 codes, and include a corresponding test to verify its functionality.

New Features:

• Introduce a static function GetCurrencyByNumericCode to retrieve a currency code using its ISO-4217 numeric code.

Tests:

• Add a test case for the GetCurrencyByNumericCode function to ensure it returns the correct currency for a given numeric code.

[sourcery-ai]

Reviewer's Guide by Sourcery

This PR introduces a new function GetCurrencyByNumericCode that allows retrieving currency information using ISO-4217 numeric codes. The implementation adds a simple wrapper function that delegates to the existing currencies package functionality, along with corresponding test coverage.

Class diagram for the new GetCurrencyByNumericCode function

classDiagram
    class Currency {
        +Formatter() *Formatter
    }
    class Currencies {
        +CurrencyByCode(code string) *Currency
        +CurrencyByNumericCode(code string) *Currency
    }
    class CurrencyUtils {
        +GetCurrency(code string) *Currency
        +GetCurrencyByNumericCode(code string) *Currency
    }
    CurrencyUtils --> Currencies: uses
    Currency --> Formatter

Loading

File-Level Changes

Change	Details	Files
Added new function to retrieve currency by numeric code	Added GetCurrencyByNumericCode function that wraps currencies.CurrencyByNumericCode Function accepts a string parameter for the numeric code and returns a Currency pointer	currency.go
Added test coverage for the new numeric code lookup function	Created test case using Brazilian Real (BRL/986) as an example Verifies that currency lookup by numeric code matches the expected currency object	currency_test.go

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time. You can also use
  this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey @rbenatti8 - I've reviewed your changes - here's some feedback:

Overall Comments:

• Consider adding error handling tests for invalid numeric codes (e.g., non-existent codes, malformed inputs)
• Please document the expected format of the numeric code parameter (number of digits, zero-padding requirements, etc.)

Here's what I looked at during the review

• 🟢 General issues: all looks good
• 🟢 Security: all looks good
• 🟢 Testing: all looks good
• 🟢 Complexity: all looks good
• 🟢 Documentation: all looks good

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[rbenatti8]

@Rhymond please take a look on that when you have time.