fix #1464: если в атрибуте не указан алиас, то им будет имя метода

Mr-Rm commented 3 weeks ago

Summary by CodeRabbit

New Features
- Enhanced error reporting in the ContextMethodAttribute class constructor for invalid identifiers.
- Added a new constructor overload in ContextMethodAttribute for improved flexibility.
Bug Fixes
- Updated alias retrieval logic in the CreateMetadata method for better accuracy.
Refactor
- Simplified method implementations in ContextMethodAttribute for cleaner code.

coderabbitai[bot] commented 3 weeks ago

Walkthrough

The changes in this pull request involve modifications to the ClassBuilder, ContextMethodAttribute, and ContextMethodMapper classes within the OneScript.Core and ScriptEngine libraries. Key updates include alterations to method constructors, specifically the handling of alias parameters and the introduction of new constructors for better error reporting. Additionally, the method for retrieving aliases has been simplified. These changes collectively enhance the clarity and functionality of the respective classes while maintaining their overall structure.

Changes

File Path	Change Summary
src/OneScript.Core/Contexts/ClassBuilder.cs	Modified `ExportClassMethod(MethodInfo nativeMethod)` to instantiate `ContextMethodAttribute` with an additional `null` alias parameter.
src/OneScript.Core/Contexts/ContextMethodAttribute.cs	Updated `ContextMethodAttribute` constructor to require a non-null `alias`, added a new constructor overload, and simplified `GetName` and `GetAlias` methods.
src/ScriptEngine/Machine/Contexts/ContextMethodMapper.cs	Changed `CreateMetadata` method to call `GetAlias()` without parameters, altering how method aliases are retrieved.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant ClassBuilder
    participant ContextMethodAttribute
    participant ContextMethodMapper

    User->>ClassBuilder: Call ExportClassMethod(nativeMethod)
    ClassBuilder->>ContextMethodAttribute: Create instance with nativeMethod.Name, null
    ContextMethodAttribute-->>ClassBuilder: Return instance
    ClassBuilder-->>User: Return method export result

    User->>ContextMethodMapper: Call CreateMetadata()
    ContextMethodMapper->>ContextMethodAttribute: Call GetAlias()
    ContextMethodAttribute-->>ContextMethodMapper: Return alias
    ContextMethodMapper-->>User: Return metadata

🐇 "In the code where rabbits hop,
New aliases now will stop!
Constructors clear, methods bright,
Contexts dance in pure delight!
With each change, we do rejoice,
Hopping high, we lift our voice!" 🐇

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 , please review it.` - `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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@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` 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](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

maximkin7 commented 2 weeks ago

Добрый день!

В период с 27.10.2024 по 10.11.2024 включительно, буду находиться в ежегодном отпуске. Почта просматриваться не будет.

EvilBeaver / OneScript