Afischbacher / Nhl.Api

The Official Unofficial .NET NHL API
MIT License
25 stars 3 forks source link

v3.3.0 #51

Closed Afischbacher closed 5 months ago

Afischbacher commented 5 months ago

Summary by CodeRabbit

coderabbitai[bot] commented 5 months ago
Walkthrough ## Walkthrough Version 3.3.0 of the NHL API brings expanded .NET framework support up to version 8.0 and introduces documentation generation. Changes include enhancements to player profiles, adjustments to game log models, and new methods for fetching player statistics. Testing upgrades encompass JSON serialization for game data and a novel string extension method. ## Changes | Files | Change Summaries | |-------------------------------------------------------------|-------------------------------------------------------------------------------------------------------| | `Nhl.Api.*/*.csproj` | Updated to v3.3.0; added .NET 6.0, 7.0, and 8.0 targets; enabled documentation generation. | | `.../Models/Game/GoalieSeasonGameLog.cs`, | Added `Nhl.Api.Models.Team` import; removed `CommonName` class and added `using` for `Nhl.Api.Models.Team`. | | `.../Models/Player/PlayerProfile.cs`, | Included `FullName` property addition. | | `.../Models/Team/CommonName.cs` | Introduced `CommonName` class with `Default` property. | | `.../Enumerations/Player/PlayerEnumFileGeneratorHelper.cs` | Enhanced functionality for generating enum entries; method signature changed to `UpdatePlayerEnumToFile`.| | `Nhl.Api.Tests/PlayerTests.cs` | Updated method signature and call to asynchronous in `PlayerEnumFileGeneratorHelper_Returns_Valid_Content`.| | `Nhl.Api.Tests/StatisticsTests.cs`, `Nhl.Api.Tests/StringTests.cs` | Added JSON serialization in `StatisticsTests.cs`; included `ReplaceNonAsciiWithAscii` method in `StringTests.cs`. | | `.../Api/NhlApi.cs`, `.../StatisticsApi/*.cs` | Added `GetAllPlayersStatisticValuesBySeasonAsync` method for fetching player statistics. | > 🐰✨ > Changes afoot, in code we trust, > Version three point three, update we must. > New stats to fetch, under .NET's sky, > With every line, our standards fly high. > Through frameworks and tests, our journey's keen, > In the world of code, we hop unseen. > 🌟🐇

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: - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit-tests for this file.` - 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 tests 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 from git and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit tests.` - `@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. - The JSON schema for the configuration file is available [here](https://coderabbit.ai/integrations/coderabbit-overrides.v2.json). - 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/coderabbit-overrides.v2.json` ### CodeRabbit Discord Community Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback.
codecov[bot] commented 5 months ago

Codecov Report

Attention: Patch coverage is 98.37398% with 2 lines in your changes are missing coverage. Please review.

Project coverage is 88.17%. Comparing base (7e7ae8b) to head (b0e9cfd). Report is 7 commits behind head on master.

Files Patch % Lines
Nhl.Api.Domain/Models/Player/PlayerProfile.cs 0.00% 1 Missing :warning:
Nhl.Api/Src/StatisticsApi/NhlStatisticsApi.cs 99.12% 0 Missing and 1 partial :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #51 +/- ## ========================================== + Coverage 87.41% 88.17% +0.75% ========================================== Files 71 72 +1 Lines 2996 3112 +116 Branches 393 419 +26 ========================================== + Hits 2619 2744 +125 + Misses 316 305 -11 - Partials 61 63 +2 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.