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

v2, к #1424: исправлено получение свойств для Структур #1503

Merged
merged 2 commits into from
Feb 9, 2025

Conversation

Mr-Rm
Copy link
Collaborator

@Mr-Rm Mr-Rm commented Feb 7, 2025

Summary by CodeRabbit

  • New Features

    • Enabled users to retrieve a property count for fixed structures and view detailed property information for standard structures.
  • Refactor

    • Streamlined parameter handling and property insertion processes for improved clarity and efficiency.
  • Tests

    • Expanded validations to verify that property reflection accurately reflects structure attributes.

Copy link

coderabbitai bot commented Feb 7, 2025

Walkthrough

This pull request refactors the constructors in FixedStructureImpl and StructureImpl by replacing multiple conditional checks with concise switch expressions. FixedStructureImpl now includes a new method GetPropCount(), while StructureImpl introduces a new method GetPropertyInfo() and updates its property iteration and Insert logic. In addition, two new exported test procedures in tests/reflector.os validate the correct creation and introspection of both standard and fixed structure properties.

Changes

Files Change Summary
src/OneScript.StandardLibrary/.../FixedStructureImpl.cs - Added public override int GetPropCount() method
- Refactored constructor to use a switch expression for evaluating rawArgument and streamlined error handling
src/OneScript.StandardLibrary/.../StructureImpl.cs - Replaced for loop with foreach in string-based constructor
- Updated Insert method to create a new value when null is passed
- Refactored static constructor using a switch expression
- Added public override BslPropertyInfo GetPropertyInfo(int propNum) method for property introspection
tests/reflector.os - Added new procedure ТестДолжен_ПроверитьПолучитьТаблицуСвойствДляСтруктуры()
- Added new procedure ТестДолжен_ПроверитьПолучитьТаблицуСвойствДляФиксированнойСтруктуры() to verify properties table generation for both structure types

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant Struct as FixedStructureImpl/StructureImpl
    Client->>Struct: Call Constructor(rawArgument)
    Struct->>Struct: Evaluate rawArgument via switch expression
    alt Valid type (null, BslStringValue, StructureImpl)
        Struct-->>Client: Return new structure instance
    else Unsupported type
        Struct-->>Client: Throw RuntimeException
    end
Loading

Possibly related PRs

Poem

In lines of code where logic now sings,
I hop with joy on refactored wings.
Switch expressions sparkle, concise and true,
New methods shine with introspective view.
Carrots and code, a bright, happy brew! 🥕
Hop along, dear coder, and celebrate too!


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>, 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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 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

@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: 0

🧹 Nitpick comments (2)
tests/reflector.os (2)

935-941: Consider enhancing test coverage

While the test verifies basic functionality, consider adding assertions for:

  • Property types
  • Values of both fields
  • Property access rights
 Процедура ТестДолжен_ПроверитьПолучитьТаблицуСвойствДляСтруктуры() Экспорт
 	Рефлектор = Новый Рефлектор;
 	Структура = Новый Структура("Поле1, Поле2", -1, -2);
 	Таблица = Рефлектор.ПолучитьТаблицуСвойств(Структура);
 	юТест.ПроверитьРавенство(2, Таблица.Количество());
 	юТест.ПроверитьНеРавенство(Неопределено, Таблица.Найти("Поле1"));
+	юТест.ПроверитьНеРавенство(Неопределено, Таблица.Найти("Поле2"));
+	
+	Поле1 = Таблица.Найти("Поле1");
+	юТест.ПроверитьРавенство(Поле1.Значение, -1);
+	юТест.ПроверитьИстину(Поле1.Чтение);
+	юТест.ПроверитьИстину(Поле1.Запись);
+	
+	Поле2 = Таблица.Найти("Поле2");
+	юТест.ПроверитьРавенство(Поле2.Значение, -2);
+	юТест.ПроверитьИстину(Поле2.Чтение);
+	юТест.ПроверитьИстину(Поле2.Запись);
 КонецПроцедуры

943-949: Consider enhancing test coverage for FixedStructure

While the test verifies basic functionality, consider adding assertions specific to FixedStructure's read-only nature and property values.

 Процедура ТестДолжен_ПроверитьПолучитьТаблицуСвойствДляФиксированнойСтруктуры() Экспорт
 	Рефлектор = Новый Рефлектор;
 	ФиксСтруктура = Новый ФиксированнаяСтруктура("Поле1, Поле2", -1, -2);
 	Таблица = Рефлектор.ПолучитьТаблицуСвойств(ФиксСтруктура);
 	юТест.ПроверитьРавенство(2, Таблица.Количество());
 	юТест.ПроверитьНеРавенство(Неопределено, Таблица.Найти("Поле1"));
+	юТест.ПроверитьНеРавенство(Неопределено, Таблица.Найти("Поле2"));
+	
+	Поле1 = Таблица.Найти("Поле1");
+	юТест.ПроверитьРавенство(Поле1.Значение, -1);
+	юТест.ПроверитьИстину(Поле1.Чтение);
+	юТест.ПроверитьЛожь(Поле1.Запись, "FixedStructure properties should be read-only");
+	
+	Поле2 = Таблица.Найти("Поле2");
+	юТест.ПроверитьРавенство(Поле2.Значение, -2);
+	юТест.ПроверитьИстину(Поле2.Чтение);
+	юТест.ПроверитьЛожь(Поле2.Запись, "FixedStructure properties should be read-only");
 КонецПроцедуры
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 75050e7 and 7f1689d.

📒 Files selected for processing (3)
  • src/OneScript.StandardLibrary/Collections/FixedStructureImpl.cs (2 hunks)
  • src/OneScript.StandardLibrary/Collections/StructureImpl.cs (5 hunks)
  • tests/reflector.os (2 hunks)
🔇 Additional comments (5)
src/OneScript.StandardLibrary/Collections/FixedStructureImpl.cs (2)

60-63: LGTM! Clean implementation of GetPropCount()

The method correctly delegates to the underlying structure instance, maintaining consistency with the class's design pattern.


169-179: LGTM! Clean switch expression refactor

The switch expression makes the constructor logic more concise and readable while maintaining all the necessary type checks and error handling.

src/OneScript.StandardLibrary/Collections/StructureImpl.cs (3)

29-41: LGTM! Improved constructor readability

The refactored constructor uses cleaner loop syntax while maintaining the same functionality.


135-144: LGTM! Well-structured property info implementation

The GetPropertyInfo method provides comprehensive property metadata using a clean builder pattern implementation.


254-264: LGTM! Consistent switch expression refactor

The constructor refactoring matches the style used in FixedStructureImpl, providing consistency across the codebase.

@EvilBeaver EvilBeaver merged commit 7a3239d into EvilBeaver:develop Feb 9, 2025
1 of 2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants