soat-fiap / FIAP.TechChallenge.ByteMeBurger

Repository for FIAP SOAT post degree Tech Challenge
BSD 3-Clause "New" or "Revised" License
0 stars 1 forks source link

feat: add endpoint integration to get product by category #35

Closed italopessoa closed 1 month ago

italopessoa commented 1 month ago
coderabbitai[bot] commented 1 month ago

Walkthrough

The recent updates across various components of the ByteMeBurger project mainly enhance functionalities related to product handling and testing. New methods for setting product images and querying products by category have been introduced, alongside improvements in testing strategies with the use of AutoFixture for object creation. Additionally, a specific method in the order repository has been updated with a detailed justification for exclusion from code coverage due to current testing limitations.

Changes

File Path Changes
.../Entities/Product.cs Added public Product() constructor and public void SetImages(string[] images) method.
.../Repository/OrderRepositoryDapper.cs Updated code coverage exclusion justification for GetAllAsync().
.../Repository/ProductRepositoryDapper.cs Enhanced FindByCategory with logic for querying and setting images.
tests/.../Controllers/ProductControllerTest.cs
tests/.../Services/ProductServiceTest.cs
Imported AutoFixture.Kernel namespace; refactored product creation using ProductGenerator.
tests/.../Repository/ProductRepositoryDapperTest.cs Improved readability in _mockConnection setup; added FindByIdAsync_NotImplemented() test method.

Recent Review Details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
Commits Files that changed from the base of the PR and between a4b7feb5a4b05aa9df9eb367b0e8b28ec1edf6c6 and 0bbb6ce5f667b5463e8db0732a2082454715abb1.
Files selected for processing (6) * src/FIAP.TechChallenge.ByteMeBurger.Domain/Entities/Product.cs (2 hunks) * src/FIAP.TechChallenge.ByteMeBurger.Infrastructure/Repository/OrderRepositoryDapper.cs (1 hunks) * src/FIAP.TechChallenge.ByteMeBurger.Infrastructure/Repository/ProductRepositoryDapper.cs (2 hunks) * tests/FIAP.TechChallenge.ByteMeBurger.Api.Test/Controllers/ProductControllerTest.cs (3 hunks) * tests/FIAP.TechChallenge.ByteMeBurger.Application.Test/Services/ProductServiceTest.cs (5 hunks) * tests/FIAP.TechChallenge.ByteMeBurger.Infrastructure.Test/Repository/ProductRepositoryDapperTest.cs (3 hunks)
Additional Context Used
GitHub Check Runs (1)
build success (10)
src/FIAP.TechChallenge.ByteMeBurger.Domain/Entities/Product.cs: [warning] 22-22: Non-nullable property 'Name' must contain a non-null value when exiting constructor. Consider declaring the property as nullable. --- src/FIAP.TechChallenge.ByteMeBurger.Domain/Entities/Product.cs: [warning] 22-22: Non-nullable property 'Description' must contain a non-null value when exiting constructor. Consider declaring the property as nullable. --- src/FIAP.TechChallenge.ByteMeBurger.Domain/Entities/Product.cs: [warning] 22-22: Non-nullable property 'Images' must contain a non-null value when exiting constructor. Consider declaring the property as nullable. --- src/FIAP.TechChallenge.ByteMeBurger.Infrastructure/Repository/OrderRepositoryDapper.cs: [warning] 41-41: The variable 'e' is declared but never used
Path-based Instructions (6)
src/FIAP.TechChallenge.ByteMeBurger.Domain/Entities/Product.cs (1)
Pattern `**/*.cs`: Validate all files and structures against Domain Driven Design principles and Ports & Adapters architecture pattern.
src/FIAP.TechChallenge.ByteMeBurger.Infrastructure/Repository/ProductRepositoryDapper.cs (1)
Pattern `**/*.cs`: Validate all files and structures against Domain Driven Design principles and Ports & Adapters architecture pattern.
src/FIAP.TechChallenge.ByteMeBurger.Infrastructure/Repository/OrderRepositoryDapper.cs (1)
Pattern `**/*.cs`: Validate all files and structures against Domain Driven Design principles and Ports & Adapters architecture pattern.
tests/FIAP.TechChallenge.ByteMeBurger.Infrastructure.Test/Repository/ProductRepositoryDapperTest.cs (1)
Pattern `**/*.cs`: Validate all files and structures against Domain Driven Design principles and Ports & Adapters architecture pattern.
tests/FIAP.TechChallenge.ByteMeBurger.Application.Test/Services/ProductServiceTest.cs (1)
Pattern `**/*.cs`: Validate all files and structures against Domain Driven Design principles and Ports & Adapters architecture pattern.
tests/FIAP.TechChallenge.ByteMeBurger.Api.Test/Controllers/ProductControllerTest.cs (1)
Pattern `**/*.cs`: Validate all files and structures against Domain Driven Design principles and Ports & Adapters architecture pattern.
Additional comments not posted (7)
src/FIAP.TechChallenge.ByteMeBurger.Domain/Entities/Product.cs (1)
`49-54`: Ensure that direct state modification by `SetImages` aligns with the overall design philosophy of your domain models. Consider using immutable objects if state changes need to be tracked or undone.
src/FIAP.TechChallenge.ByteMeBurger.Infrastructure/Repository/ProductRepositoryDapper.cs (1)
`53-63`: The implementation of `FindByCategory` looks correct. However, consider adding a detailed comment explaining the reason behind excluding this method from code coverage, ensuring it's revisited when the testing framework limitations are resolved.
src/FIAP.TechChallenge.ByteMeBurger.Infrastructure/Repository/OrderRepositoryDapper.cs (1)
`58-58`: Ensure that the exclusion from code coverage for `GetAsync` is well-documented and tracked for future resolution when the testing framework limitations are addressed.
tests/FIAP.TechChallenge.ByteMeBurger.Infrastructure.Test/Repository/ProductRepositoryDapperTest.cs (2)
`60-61`: The setup for the `DeleteAsync` success test is correctly implemented. --- `76-77`: The setup for the `DeleteAsync` failure test is correctly implemented.
tests/FIAP.TechChallenge.ByteMeBurger.Application.Test/Services/ProductServiceTest.cs (1)
Line range hint `177-265`: The use of `AutoFixture` in tests is well-implemented, enhancing the setup process. Consider adding comments explaining why `AutoFixture` was chosen and how it benefits your testing strategy.
tests/FIAP.TechChallenge.ByteMeBurger.Api.Test/Controllers/ProductControllerTest.cs (1)
Line range hint `36-356`: The tests in `ProductControllerTest` are comprehensive and effectively cover the functionality of the `ProductController`. The use of `AutoFixture` is consistent and aids in simplifying the setup of test data. Consider adding more detailed comments on the use of `AutoFixture` to aid future maintainers.
--- 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.` 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 a review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@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](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.