Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add get yaml #307

Open
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

weihubeats
Copy link

@weihubeats weihubeats commented Apr 26, 2024

#306

Summary by CodeRabbit

  • New Features

    • Introduced functionality to convert properties to YAML format and vice versa.
  • Tests

    • Added unit tests to validate property mapping, value parsing, and YAML generation functionalities.

Copy link

coderabbitai bot commented Apr 26, 2024

Walkthrough

The changes introduce methods in storage/repository.go for converting properties to YAML format and parsing property values, alongside corresponding tests in storage/repository_test.go. These additions allow the repository to handle YAML data and ensure functionality through testing.

Changes

Files Change Summary
storage/repository.go Updated to add methods for converting properties to a map, parsing property values, and generating YAML.
storage/repository_test.go Added tests for property mapping, value parsing, and YAML generation functionalities.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant Config
    participant YAMLGenerator
    participant PropertyParser
    
    Client->>Config: Call GetYaml()
    Config->>PropertyParser: Parse properties
    PropertyParser-->>Config: Return parsed properties as map
    Config->>YAMLGenerator: Generate YAML from map
    YAMLGenerator-->>Config: Return YAML
    Config-->>Client: Return YAML
Loading

Poem

🌟 In the code's deep, data flows,
To YAML land, where magic grows.
Parsing values, map to byte,
Turning properties into light.
Tests ensure our path is true,
Bravo, coder, cheers to you! 🍀


Tip

Early access features
  • OpenAI gpt-4o model for reviews and chat.

Note:

  • You can disable early access features from the CodeRabbit UI or by setting early_access: false in the CodeRabbit configuration file.
  • Please join our Discord Community to provide feedback and report issues.
  • OSS projects are always opted into early access features.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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 configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

Copy link
Contributor

mergify bot commented Apr 26, 2024

感谢您提出Pull Request,我会尽快Review。我会在1-2日内进行查看或者回复,如果遇到节假日可能会处理较慢,敬请谅解。

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 3

storage/repository.go Outdated Show resolved Hide resolved
storage/repository.go Outdated Show resolved Hide resolved
storage/repository.go Outdated Show resolved Hide resolved
@coveralls
Copy link

Pull Request Test Coverage Report for Build 8844714119

Details

  • 0 of 52 (0.0%) changed or added relevant lines in 1 file are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage decreased (-2.2%) to 72.306%

Changes Missing Coverage Covered Lines Changed/Added Lines %
storage/repository.go 0 52 0.0%
Totals Coverage Status
Change from base Build 8181144278: -2.2%
Covered Lines: 1295
Relevant Lines: 1791

💛 - Coveralls

Copy link

stale bot commented Jun 26, 2024

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the stale label Jun 26, 2024
@weihubeats
Copy link
Author

Can anyone review this pr?

@nobodyiam
Copy link
Member

@weihubeats would you please help to add some unit tests for this new feature?

@stale stale bot removed the stale label Jun 29, 2024
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 3be6668 and c76fc8d.

Files selected for processing (1)
  • storage/repository_test.go (1 hunks)
Additional comments not posted (2)
storage/repository_test.go (2)

335-345: LGTM!

The test for propertiesToMap is well-structured and covers the expected functionality.


347-364: LGTM!

The test for parseValue is well-structured and covers various data types.

storage/repository_test.go Show resolved Hide resolved
@weihubeats
Copy link
Author

add unit tests completed

@nobodyiam
Copy link
Member

Upon reviewing feature request #306, it appears that the original intention was to support these namespaces in YAML format rather than transforming properties into YAML format, e.g.

screenshot

For reference, a similar feature has been implemented in the Java SDK as demonstrated below:

Config config = ConfigService.getConfig("application.yml");
String someKey = "someKeyFromYmlNamespace";
String someDefaultValue = "someDefaultValueForTheKey";
String value = config.getProperty(someKey, someDefaultValue);

@qq2161811
Copy link

这个还没合并吗?急需要用T_T

Copy link

stale bot commented Sep 8, 2024

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the stale label Sep 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants