Adds an example for a Parsley-enabled app

matzefriedrich commented 2 months ago

This PR introduces a new example demonstrating integrating the Parsley dependency injection framework into a GoFiber application. The example showcases how to wire up services and manage dependencies using Parsley, providing a clean and maintainable approach to building GoFiber-powered web applications and APIs. This addition aims to help developers streamline their service management and dependency injection patterns within the GoFiber ecosystem.

Summary by CodeRabbit

New Features
- Introduced a new application structure for Parsley, allowing for modular configuration and route handling.
- Added a greeting service that responds to HTTP requests with personalized greetings based on user input.
- Provided comprehensive documentation on integrating the Parsley framework with GoFiber applications.
Bug Fixes
- Improved error handling and response management for greeting requests.
Documentation
- Enhanced code organization and documentation for new modules and functionalities, including a new entry linking to "Dependency Injection (with Parsley)."

welcome[bot] commented 2 months ago

Thanks for opening this pull request! 🎉 Please check out our contributing guidelines.

coderabbitai[bot] commented 2 months ago

Walkthrough

The changes introduce a modular structure for the Parsley application, implementing a Fiber web framework. New files define the main application entry point, service configurations, route handlers, and the Greeter service. This architecture emphasizes separation of concerns, allowing for flexible integration and management of components, enhancing the application's extensibility and maintainability.

Changes

Files	Change Summary
`parsley/cmd/main.go`	Introduced `main` function to initialize context and invoke `RunParsleyApplication` for app setup.
`parsley/internal/application.go`	Defined `parsleyApplication` struct implementing `bootstrap.Application` interface; added `NewApp` and `Run` methods.
`parsley/internal/modules/fiber_module.go`	Created `ConfigureFiber` function for Fiber app configuration; included `newFiber` function for instantiation.
`parsley/internal/modules/greeter_module.go`	Defined `ConfigureGreeter` function to register a `Greeter` service with a greeting message.
`parsley/internal/modules/route_handlers_module.go`	Introduced `RegisterRouteHandlers` function for dynamic registration of route handlers.
`parsley/internal/route_handlers/greeter.go`	Implemented `greeterRouteHandler` for greeting functionality; added route registration and request handling methods.
`parsley/internal/route_handlers/types.go`	Introduced `RouteHandler` interface for standardizing route handler registration.
`parsley/internal/services/greeter.go`	Defined `Greeter` interface and implementation; included `NewGreeterFactory` for flexible instantiation.

Sequence Diagram(s)

sequenceDiagram
    participant Main
    participant Bootstrap
    participant FiberApp
    participant GreeterService
    participant RouteHandler

    Main->>Bootstrap: Initialize application
    Bootstrap->>FiberApp: Create Fiber instance
    Bootstrap->>GreeterService: Configure Greeter
    Bootstrap->>RouteHandler: Register route handlers
    RouteHandler->>FiberApp: Register routes
    FiberApp->>User: Respond to requests

🐰 "In the garden where bunnies play,
New features hop in, brightening the day!
With routes and greeters, all set to cheer,
Parsley blooms, bringing joy near!
Let's celebrate with a joyful dance,
For every change, a new chance!" 🐇✨

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

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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 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 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` or `@coderabbitai title` 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

[!TIP]

Early access features: enabled
We are currently testing the following features in early access: - **Anthropic `claude-3-5-sonnet` for code reviews**: Anthropic claims that the new Claude model has stronger code understanding and code generation capabilities than their previous models. Note: Our default code review model was also updated late last week. Please compare the quality of the reviews between the two models by toggling the early access feature. Note: - You can enable or disable early access features from the CodeRabbit UI or by updating the CodeRabbit configuration file. - Please join our [Discord Community](https://discord.com/invite/GsXnASn26c) to provide feedback and report issues on the [discussion post](https://discordapp.com/channels/1134356397673414807/1279579842131787838).

ReneWerner87 commented 2 months ago

@matzefriedrich thx for that

can you pls add

[x] a link in the main readme on the root level for this example with naming
[x] a readme in the example itself, which gives information about the tool itself and a short description of the use within with the “why?” and “what?”

welcome[bot] commented 2 months ago

Congrats on merging your first pull request! 🎉 We here at Fiber are proud of you!

gofiber / recipes