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

Restore unsaved airport conditions & NOTAM free text on dialog close #135

Merged
merged 1 commit into from
Feb 15, 2025

Conversation

justinshannon
Copy link
Contributor

@justinshannon justinshannon commented Feb 15, 2025

Summary by CodeRabbit

  • Bug Fixes
    • Enhanced handling of free-text inputs in ATIS settings. User-entered details for notices and airport conditions are now preserved when no preset change occurs and updated appropriately when a change is made, ensuring a smoother and more reliable experience.

Copy link
Contributor

coderabbitai bot commented Feb 15, 2025

Walkthrough

This update modifies the AtisStationViewModel class to better handle unsaved free-text entries for NOTAMs and airport conditions. Two new private fields have been introduced to store previous free-text inputs. The methods PopulateNotams and PopulateAirportConditions now accept a boolean parameter presetChanged that determines whether to restore unsaved user text or to insert saved data. Additionally, HandleSelectedAtisPresetChanged has been updated to pass true for presetChanged.

Changes

File Path Change Summary
vATIS.Desktop/Ui/ViewModels/AtisStationViewModel.cs - Added private fields _previousFreeTextNotams and _previousFreeTextAirportConditions.
- Updated PopulateNotams and PopulateAirportConditions method signatures to accept a bool presetChanged parameter.
- Modified logic to restore or insert free-text based on preset change.
- Updated HandleSelectedAtisPresetChanged to pass true.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant VM as AtisStationViewModel
    User->>VM: Change ATIS preset
    VM->>VM: HandleSelectedAtisPresetChanged(presetChanged=true)
    VM->>VM: PopulateNotams(true)
    VM-->>VM: Restore or insert NOTAMs free-text
    VM->>VM: PopulateAirportConditions(true)
    VM-->>VM: Restore or insert airport conditions text
    VM->>User: Update text display
Loading

Possibly related PRs

Poem

I'm a rabbit in the code, so free,
Hoping through changes with joyful glee.
Fields now store the texts we miss,
With presets changed, they won’t dismiss.
In AtisStationViewModel, magic's in the air—
Happy hops as code grows fair! 🐇


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
Contributor

@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)
vATIS.Desktop/Ui/ViewModels/AtisStationViewModel.cs (2)

1383-1432: LGTM! Well-implemented text preservation logic.

The implementation correctly handles both scenarios:

  1. When preset changes: Uses the saved NOTAMs
  2. When dialog closes: Restores the user's unsaved text

Fix comment to accurately describe the text type.

-        // Always append the free-form NOTAM text after any predefined content.
+        // Always append the free-form text after any predefined content.

1449-1501: LGTM! Well-implemented text preservation logic.

The implementation correctly handles both scenarios:

  1. When preset changes: Uses the saved airport conditions
  2. When dialog closes: Restores the user's unsaved text

Fix comment to accurately describe the text type.

-        // Always append the free-form NOTAM text after any static content.
+        // Always append the free-form text after any static content.
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 4f201a6 and 6eedccd.

📒 Files selected for processing (1)
  • vATIS.Desktop/Ui/ViewModels/AtisStationViewModel.cs (7 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: build (macos-latest)
🔇 Additional comments (3)
vATIS.Desktop/Ui/ViewModels/AtisStationViewModel.cs (3)

95-96: LGTM! Well-structured field declarations.

The new fields are appropriately named and correctly marked as nullable, following the codebase's conventions.


1369-1369: LGTM! Well-designed method signature changes.

The addition of the presetChanged parameter with a default value of false maintains backward compatibility while enabling the new functionality to handle unsaved text.

Also applies to: 1435-1435


1306-1307: LGTM! Correct usage of the modified methods.

The methods are called with presetChanged: true when handling preset changes, which is the appropriate behavior.

@justinshannon justinshannon added this pull request to the merge queue Feb 15, 2025
Merged via the queue into main with commit 3f2a69b Feb 15, 2025
9 checks passed
@justinshannon justinshannon deleted the fix/free-text-notam-airport-conditions branch February 15, 2025 19:06
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.

1 participant