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

Fix undetermined cloud layer, add automatic CB detection #131

Merged
merged 3 commits into from
Feb 14, 2025

Conversation

justinshannon
Copy link
Contributor

@justinshannon justinshannon commented Feb 14, 2025

Summary by CodeRabbit

  • New Features
    • Added improved automatic CB (Cumulonimbus) detection featuring customizable text and voice outputs.
    • Updated the user interface to include new input controls for setting detection preferences.
    • Integrated robust view model support for efficiently managing and applying these configuration options.
  • Refactor
    • Streamlined cloud formatting logic to deliver standardized responses for targeted cloud conditions.

Copy link
Contributor

coderabbitai bot commented Feb 14, 2025

Walkthrough

This pull request refines the handling of cloud formatting by modifying the FormatCloudsText and FormatCloudsVoice methods to implement a simplified check for Cumulonimbus conditions. A new AutomaticCbDetection class is introduced and integrated into the Clouds class via an added property. Additionally, the UI has been updated by replacing a DataGrid with a StackPanel containing new text boxes for automatic CB detection, with corresponding changes in the ViewModel to support these new settings.

Changes

File(s) Change Summary
vATIS.Desktop/Atis/Nodes/CloudNode.cs Modified FormatCloudsText and FormatCloudsVoice to replace complex cloud type checks with a condition for non-FAA ATIS stations and specific CloudLayer attributes, returning predefined strings for Cumulonimbus detection.
vATIS.Desktop/Profiles/AtisFormat/Nodes/AutomaticCbDetection.cs
vATIS.Desktop/Profiles/AtisFormat/Nodes/Clouds.cs
Introduced new AutomaticCbDetection class with properties for text and voice values; added an AutomaticCbDetection property into the Clouds class with initialized values.
vATIS.Desktop/Ui/AtisConfiguration/FormattingView.axaml
vATIS.Desktop/Ui/ViewModels/AtisConfiguration/FormattingViewModel.cs
Replaced a DataGrid in the "Convective Cloud Types" tab with a StackPanel that includes two TextBox controls bound to new properties (AutomaticCbDetectionText and AutomaticCbDetectionVoice); updated the ViewModel to initialize and apply these properties when station changes occur.

Sequence Diagram(s)

sequenceDiagram
    participant U as User
    participant FV as FormattingView
    participant VM as FormattingViewModel
    participant S as SelectedStation

    U->>FV: Input/update Automatic CB Detection values
    FV->>VM: Bind and update properties (Text & Voice)
    VM->>S: Apply changes (via ApplyChanges / HandleAtisStationChanged)
    S-->>VM: Updated ATIS format returned
    VM-->>FV: UI refresh with new values
Loading
sequenceDiagram
    participant CN as CloudNode
    participant L as CloudLayer
    participant S as SelectedStation

    CN->>CN: Call FormatCloudsText/Voice
    alt Special Cumulonimbus Condition
        CN->>CN: Check (Station is not FAA ATIS, layer.Amount is None, BaseHeight is null, Type is Cumulonimbus)
        CN-->>Caller: Return predefined automatic detection string
    else Standard Cloud Handling
        CN->>CN: Validate cloud amount via AmountToString(layer.Amount)
        alt Cloud amount not valid
            CN-->>Caller: Return empty string
        else
            CN->>CN: Build template string with regex replacements
            CN-->>Caller: Return formatted cloud string
        end
    end
Loading

Possibly related PRs

Suggested labels

breaking

Poem

I'm a bunny hopping through our code so fine,
Clouds now detected in a more automated design.
With Cumulonimbus in check and UI anew, 🐰
The ATIS config sings with a streamlined view.
Hop along, code critters, let our changes shine!

Happy codes and carrot dreams all around!


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/Profiles/AtisFormat/Nodes/AutomaticCbDetection.cs (1)

11-33: Consider making properties immutable and adding validation.

The class looks good but could be improved:

  1. Consider making properties immutable (init-only) since they represent configuration values
  2. Add null validation in constructor using ArgumentNullException.ThrowIfNull()
 public class AutomaticCbDetection
 {
     public AutomaticCbDetection(string? text, string? voice)
     {
+        ArgumentNullException.ThrowIfNull(text);
+        ArgumentNullException.ThrowIfNull(voice);
         Text = text;
         Voice = voice;
     }

-    public string? Text { get; set; }
+    public string Text { get; init; }

-    public string? Voice { get; set; }
+    public string Voice { get; init; }
 }
vATIS.Desktop/Atis/Nodes/CloudNode.cs (1)

161-165: Consider extracting duplicate CB detection logic.

The CB detection logic is duplicated between FormatCloudsText and FormatCloudsVoice methods.

+private bool IsAutomaticCbDetection(CloudLayer layer)
+{
+    return !Station.IsFaaAtis && layer is
+        { Amount: CloudLayer.CloudAmount.None, BaseHeight: null, Type: CloudLayer.CloudType.Cumulonimbus };
+}

 private string FormatCloudsText(CloudLayer layer)
 {
     ArgumentNullException.ThrowIfNull(Station);

-    if (!Station.IsFaaAtis && layer is
-            { Amount: CloudLayer.CloudAmount.None, BaseHeight: null, Type: CloudLayer.CloudType.Cumulonimbus })
+    if (IsAutomaticCbDetection(layer))
     {
         return Station.AtisFormat.Clouds.AutomaticCbDetection.Text ?? "//////CB";
     }
     // ... rest of the method
 }

 private string FormatCloudsVoice(CloudLayer layer, CloudLayer? ceiling)
 {
     ArgumentNullException.ThrowIfNull(Station);

-    if (!Station.IsFaaAtis && layer is
-            { Amount: CloudLayer.CloudAmount.None, BaseHeight: null, Type: CloudLayer.CloudType.Cumulonimbus })
+    if (IsAutomaticCbDetection(layer))
     {
         return Station.AtisFormat.Clouds.AutomaticCbDetection.Voice ?? "RADAR DETECTED C-B CLOUDS.";
     }
     // ... rest of the method
 }
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 834564c and 9c8d213.

📒 Files selected for processing (5)
  • vATIS.Desktop/Atis/Nodes/CloudNode.cs (1 hunks)
  • vATIS.Desktop/Profiles/AtisFormat/Nodes/AutomaticCbDetection.cs (1 hunks)
  • vATIS.Desktop/Profiles/AtisFormat/Nodes/Clouds.cs (1 hunks)
  • vATIS.Desktop/Ui/AtisConfiguration/FormattingView.axaml (1 hunks)
  • vATIS.Desktop/Ui/ViewModels/AtisConfiguration/FormattingViewModel.cs (4 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (7)
  • GitHub Check: build (macos-latest)
  • GitHub Check: Analyze (cpp)
  • GitHub Check: build (windows-latest)
  • GitHub Check: Analyze (csharp)
  • GitHub Check: build (ubuntu-latest)
  • GitHub Check: Analyze (cpp)
  • GitHub Check: Analyze (csharp)
🔇 Additional comments (8)
vATIS.Desktop/Profiles/AtisFormat/Nodes/Clouds.cs (1)

49-52: LGTM!

The AutomaticCbDetection property is well-integrated with appropriate default values.

vATIS.Desktop/Atis/Nodes/CloudNode.cs (2)

104-108: LGTM! Clear condition for automatic CB detection.

The condition correctly checks for non-FAA ATIS and CB detection.


110-113: Good error handling with early return.

Early return pattern improves code readability.

vATIS.Desktop/Ui/AtisConfiguration/FormattingView.axaml (1)

583-589: LGTM! Well-structured UI controls.

The automatic CB detection UI controls are:

  • Well-organized in a logical section
  • Have informative tooltips
  • Use consistent styling
  • Properly bound to view model properties
vATIS.Desktop/Ui/ViewModels/AtisConfiguration/FormattingViewModel.cs (4)

97-98: LGTM!

The private backing fields for automatic CB detection follow the established pattern and are properly declared as nullable strings.


1064-1094: LGTM!

The properties for automatic CB detection are well-implemented with:

  • Clear XML documentation
  • Proper use of ReactiveUI's RaiseAndSetIfChanged
  • Consistent tracking of initialization state
  • Consistent naming with other properties

1699-1707: LGTM!

The ApplyChanges method updates for automatic CB detection follow the established pattern and properly handle the synchronization of text and voice values with the selected station's format.


1888-1889: LGTM!

The HandleAtisStationChanged method updates for automatic CB detection properly initialize both text and voice values from the station's format, maintaining consistency with other property initializations.

@justinshannon justinshannon added this pull request to the merge queue Feb 14, 2025
Merged via the queue into main with commit 6d00fa6 Feb 14, 2025
9 checks passed
@justinshannon justinshannon deleted the fix/undetermined-cloud-layer branch February 14, 2025 18:35
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