Merge pull request Caliburn-Micro#937 from Caliburn-Micro/936-fix-build-warnings

vb2ae · web-flow · commit 664e2434e358 · 2024-12-15T15:53:25.000-05:00
Refactor ViewModel fields and add XML documentation
diff --git a/samples/features/Features.Avalonia/ViewModels/ShellViewModel.cs b/samples/features/Features.Avalonia/ViewModels/ShellViewModel.cs
@@ -10,7 +10,11 @@ public class ShellViewModel : Screen, IHandle<FeatureViewModel>
         private SimpleContainer _container;
         private INavigationService _navigationService;
 
+        // supressing warning for _navigationService not having a value in the constructor
+        // need NavigationFrame to be passed in from the view
+#pragma warning disable CS8618 // Non-nullable field must contain a non-null value when exiting constructor. Consider adding the 'required' modifier or declaring as nullable.
         public ShellViewModel(IEventAggregator eventAggregator, SimpleContainer container)
+#pragma warning restore CS8618 // Non-nullable field must contain a non-null value when exiting constructor. Consider adding the 'required' modifier or declaring as nullable.
         {
             _eventAggregator = eventAggregator;
             _eventAggregator.SubscribeOnPublishedThread(this);
diff --git a/samples/features/Features.CrossPlatform.Shared/ViewModels/ActionsViewModel.cs b/samples/features/Features.CrossPlatform.Shared/ViewModels/ActionsViewModel.cs
@@ -9,7 +9,7 @@ public class ActionsViewModel : Screen
         private string _output;
         public ActionsViewModel()
         {
-            Output="Caliburn Micro";
+            _output = "Caliburn Micro";
         }
 
         public void Clear() => Output = string.Empty;
diff --git a/samples/features/Features.CrossPlatform.Shared/ViewModels/Events/EventSourceViewModel.cs b/samples/features/Features.CrossPlatform.Shared/ViewModels/Events/EventSourceViewModel.cs
@@ -1,5 +1,4 @@
-﻿using System;
-using System.Threading;
+﻿using System.Threading;
 using Caliburn.Micro;
 using Features.CrossPlatform.Messages;
 
@@ -8,17 +7,18 @@ namespace Features.CrossPlatform.ViewModels.Events
     public class EventSourceViewModel : Screen
     {
         private readonly IEventAggregator eventAggregator;
-        private string text;
+        private string _text;
 
         public EventSourceViewModel(IEventAggregator eventAggregator)
         {
             this.eventAggregator = eventAggregator;
+            _text = string.Empty;
         }
 
         public string Text
         {
-            get { return text; }
-            set { Set(ref text, value); }
+            get { return _text; }
+            set { Set(ref _text, value); }
         }
 
         public async void Publish()
diff --git a/samples/features/Features.CrossPlatform.Shared/ViewModels/NavigationTargetViewModel.cs b/samples/features/Features.CrossPlatform.Shared/ViewModels/NavigationTargetViewModel.cs
@@ -6,7 +6,10 @@ public class NavigationTargetViewModel : Screen
     {
         private string _text;
         private bool _isEnabled;
-
+        public NavigationTargetViewModel()
+        {
+            _text = string.Empty;
+        }
         public string Text
         {
             get { return _text; }
diff --git a/src/Caliburn.Micro.Avalonia/Caliburn.Micro.Avalonia.csproj b/src/Caliburn.Micro.Avalonia/Caliburn.Micro.Avalonia.csproj
@@ -12,6 +12,9 @@
 
   <PropertyGroup>
     <DefineConstants>AVALONIA</DefineConstants>
+    <Title>Caliburn.Micro Avalonia UI</Title>
+    <PackageIcon>CaliburnIcon.png</PackageIcon>
+    <PackageReadmeFile>README.md</PackageReadmeFile>
   </PropertyGroup>
 
   <PropertyGroup Condition="'$(Configuration)|$(TargetFramework)|$(Platform)'=='Debug|net8.0|AnyCPU'" />
@@ -46,6 +49,17 @@
     <Compile Include="..\Caliburn.Micro.Platform\Platforms\netcore-avalonia\WindowManager.cs" Link="Platforms\netcore-avalonia\WindowManager.cs" />
  </ItemGroup>
 
+  <ItemGroup>
+    <None Include="..\..\CaliburnIcon.png">
+      <Pack>True</Pack>
+      <PackagePath>\</PackagePath>
+    </None>
+    <None Include="..\..\README.md">
+      <Pack>True</Pack>
+      <PackagePath>\</PackagePath>
+    </None>
+  </ItemGroup>
+
   <ItemGroup>
     <PackageReference Update="Microsoft.SourceLink.GitHub" Version="8.0.0" />
     <PackageReference Update="Nerdbank.GitVersioning" Version="3.6.146" />
diff --git a/src/Caliburn.Micro.Core.Tests/ConductorWithCollectionOneActiveTests.cs b/src/Caliburn.Micro.Core.Tests/ConductorWithCollectionOneActiveTests.cs
@@ -39,13 +39,22 @@ private class ActivateScreen : Screen
             public int ActivateCalledCount { get; private set; }
             public bool AutoContinue { get; set; }
 
+            [Obsolete("Please use OnActivatedAsync instead.")]
             protected override async Task OnActivateAsync(CancellationToken cancellationToken)
             {
                 ActivateCalledCount++;
                 await Task.Delay(100, cancellationToken);
                 if (AutoContinue)
                     RequestContinue?.Invoke(this, EventArgs.Empty);
             }
+
+            protected override async Task OnActivatedAsync(CancellationToken cancellationToken)
+            {
+                ActivateCalledCount++;
+                await Task.Delay(100, cancellationToken);
+                if (AutoContinue)
+                    RequestContinue?.Invoke(this, EventArgs.Empty);
+            }
         }
 
         private class ActivatedScreen : Screen
@@ -54,12 +63,12 @@ private class ActivatedScreen : Screen
 
             public int ActivateCalledCount { get; private set; }
             public bool AutoContinue { get; set; }
-            
+
             protected override async Task OnActivatedAsync(CancellationToken cancellationToken)
             {
                 ActivateCalledCount++;
                 await Task.Delay(100, cancellationToken);
-                if(AutoContinue)
+                if (AutoContinue)
                     RequestContinue?.Invoke(this, EventArgs.Empty);
             }
         }
@@ -123,7 +132,7 @@ public async Task CanCloseIsTrueWhenItemsAreClosable()
             conductor.Items.Add(conducted);
 
             await ((IActivate)conductor).ActivateAsync(CancellationToken.None);
-            var canClose =await conductor.CanCloseAsync(CancellationToken.None);
+            var canClose = await conductor.CanCloseAsync(CancellationToken.None);
 
             Assert.True(canClose);
             Assert.False(conducted.IsClosed);
@@ -141,7 +150,7 @@ public async Task CanCloseIsTrueWhenItemsAreNotClosableAndCloseStrategyCloses()
                 IsClosable = true
             };
             conductor.Items.Add(conducted);
-            await((IActivate)conductor).ActivateAsync(CancellationToken.None);
+            await ((IActivate)conductor).ActivateAsync(CancellationToken.None);
             var canClose = await conductor.CanCloseAsync(CancellationToken.None);
 
             Assert.True(canClose);
@@ -166,17 +175,17 @@ public async Task ActivateWhileActivateOneLevel()
             var conductor = new Conductor<IScreen>.Collection.OneActive();
             var viewModel1 = new ActivateScreen()
             {
-                DisplayName = "ViewModel 1", 
+                DisplayName = "ViewModel 1",
                 AutoContinue = true
             };
             conductor.Items.Add(viewModel1);
             var viewModel2 = new ActivateScreen() { DisplayName = "ViewModel 2" };
             conductor.Items.Add(viewModel2);
             viewModel1.RequestContinue += (sender, e) => { conductor.ActivateItemAsync(viewModel2).Wait(); };
-        
+
             await conductor.ActivateAsync();
             await conductor.ActivateItemAsync(viewModel1);
-        
+
             Assert.False(viewModel1.IsActive);
             Assert.Equal(1, viewModel1.ActivateCalledCount);
             Assert.True(viewModel2.IsActive);
@@ -189,17 +198,17 @@ public async Task ActivatedWhileActivatedOneLevel()
             var conductor = new Conductor<IScreen>.Collection.OneActive();
             var viewModel1 = new ActivatedScreen()
             {
-                DisplayName = "ViewModel 1", 
+                DisplayName = "ViewModel 1",
                 AutoContinue = true
             };
             conductor.Items.Add(viewModel1);
             var viewModel2 = new ActivatedScreen() { DisplayName = "ViewModel 2" };
             conductor.Items.Add(viewModel2);
             viewModel1.RequestContinue += (sender, e) => { conductor.ActivateItemAsync(viewModel2).Wait(); };
-        
+
             await conductor.ActivateAsync();
             await conductor.ActivateItemAsync(viewModel1);
-        
+
             Assert.False(viewModel1.IsActive);
             Assert.Equal(1, viewModel1.ActivateCalledCount);
             Assert.True(viewModel2.IsActive);
@@ -223,7 +232,7 @@ public async Task ActivateWhileActivateStackedLevels()
             await outerConductor.ActivateAsync();
             await outerConductor.ActivateItemAsync(innerConductor);
             await innerConductor.ActivateItemAsync(viewModel1);
-            
+
             await outerConductor.ChangeActiveItemAsyncPublic(somePage, false);
             Assert.True(somePage.IsActive);
             viewModel1.AutoContinue = true;
@@ -235,7 +244,7 @@ public async Task ActivateWhileActivateStackedLevels()
             Assert.True(viewModel2.IsActive);
             Assert.Equal(1, viewModel2.ActivateCalledCount);
         }
-        
+
         [Fact(Skip = "ActiveItem currently set regardless of IsActive value. See http://caliburnmicro.codeplex.com/discussions/276375")]
         public async Task ChildrenAreNotActivatedIfConductorIsNotActive()
         {
@@ -326,7 +335,7 @@ public async Task ActiveItemSetterShouldSetThePropertySynchronouslyWhenOnDeactiv
             conductor.Items.Add(conducted1);
             var conducted2 = new Screen();
             conductor.Items.Add(conducted2);
-            await((IActivate)conductor).ActivateAsync(CancellationToken.None);
+            await ((IActivate)conductor).ActivateAsync(CancellationToken.None);
             conductor.ActiveItem = conducted1;
             conductor.ActiveItem = conducted2;
             Assert.NotNull(conductor.ActiveItem);
diff --git a/src/Caliburn.Micro.Core.Tests/ScreenExtentionTests.cs b/src/Caliburn.Micro.Core.Tests/ScreenExtentionTests.cs
@@ -101,6 +101,7 @@ public override Task<bool> CanCloseAsync(CancellationToken cancellationToken = d
                 return Task.FromResult(IsClosable);
             }
 
+            [Obsolete("Use OnActivateAsync instead.")]
             protected override async Task OnActivateAsync(CancellationToken cancellationToken)
             {
                 if (deactivationDelay.HasValue)
@@ -110,6 +111,20 @@ protected override async Task OnActivateAsync(CancellationToken cancellationToke
 
                 await base.OnActivateAsync(cancellationToken);
 
+
+                WasActivated = true;
+                IsClosable = false;
+            }
+
+            protected override async Task OnActivatedAsync(CancellationToken cancellationToken)
+            {
+                if (deactivationDelay.HasValue)
+                {
+                    await Task.Delay(deactivationDelay.Value, cancellationToken).ConfigureAwait(false);
+                }
+
+                await base.OnActivatedAsync(cancellationToken);
+
                 WasActivated = true;
                 IsClosable = false;
             }
diff --git a/src/Caliburn.Micro.Core/SimpleContainer.cs b/src/Caliburn.Micro.Core/SimpleContainer.cs
@@ -172,14 +172,14 @@ public bool HasHandler(Type service, string key)
         /// <returns>All the instances or an empty enumerable if none are found.</returns>
         public IEnumerable<object> GetAllInstances(Type service, string key = null)
         {
-            var entries = GetEntry(service, key);
+            var currentEntry = GetEntry(service, key);
 
-            if (entries == null)
+            if (currentEntry == null)
             {
                 return new object[0];
             }
 
-            var instances = entries.Select(e => e(this));
+            var instances = currentEntry.Select(e => e(this));
 
             foreach (var instance in instances)
             {
diff --git a/src/Caliburn.Micro.Platform.Core/StringSplitter.cs b/src/Caliburn.Micro.Platform.Core/StringSplitter.cs
@@ -89,12 +89,9 @@ public static string[] SplitParameters(string parameters)
             {
                 var current = parameters[i];
 
-                if (current == '"' || current == '\'')
+                if ((current == '"' || current == '\'') && (i == 0 || parameters[i - 1] != '\\'))
                 {
-                    if (i == 0 || parameters[i - 1] != '\\')
-                    {
-                        isInString = !isInString;
-                    }
+                    isInString = !isInString;
                 }
 
                 if (!isInString)
diff --git a/src/Caliburn.Micro.Platform/BindingScope.cs b/src/Caliburn.Micro.Platform/BindingScope.cs
@@ -53,7 +53,7 @@ static BindingScope()
             AddChildResolver<CommandBar>(ResolveCommandBar);
             AddChildResolver<Button>(e => ResolveFlyoutBase(e.Flyout));
             AddChildResolver<FrameworkElement>(e => ResolveFlyoutBase(FlyoutBase.GetAttachedFlyout(e)));
-            AddChildResolver<SplitView>(e => new[] { e.Pane as DependencyObject, e.Content as DependencyObject });
+            AddChildResolver<SplitView>(e => new[] { e.Pane, e.Content });
 #endif
         }
 
diff --git a/src/Caliburn.Micro.Platform/Platforms/net46-netcore/WindowConductor.cs b/src/Caliburn.Micro.Platform/Platforms/net46-netcore/WindowConductor.cs
@@ -45,7 +45,7 @@ public async Task InitialiseAsync()
                 deactivatable.Deactivated += Deactivated;
             }
 
-            if (model is IGuardClose guard)
+            if (model is IGuardClose)
             {
                 view.Closing += Closing;
             }
diff --git a/src/Caliburn.Micro.Platform/Platforms/netcore-avalonia/BootstrapperBase.cs b/src/Caliburn.Micro.Platform/Platforms/netcore-avalonia/BootstrapperBase.cs
@@ -9,6 +9,9 @@
 
 namespace Caliburn.Micro
 {
+    /// <summary>
+    /// Base class for bootstrapping the application.
+    /// </summary>
     public class BootstrapperBase
     {
         static readonly ILog Log = LogManager.GetLog(typeof(BootstrapperBase));
@@ -33,7 +36,6 @@ public void Initialize()
 
             PlatformProvider.Current = new XamlPlatformProvider();
 
-
             var baseExtractTypes = AssemblySourceCache.ExtractTypes;
 
             AssemblySourceCache.ExtractTypes = assembly =>
@@ -90,7 +92,7 @@ protected virtual void StartRuntime()
 
             Application = Application.Current;
             PrepareApplication();
-            
+
             Configure();
             IoC.GetInstance = GetInstance;
             IoC.GetAllInstances = GetAllInstances;
@@ -105,7 +107,7 @@ protected virtual void PrepareApplication()
             if (Application.ApplicationLifetime is IControlledApplicationLifetime controlledApplicationLifetime)
             {
                 controlledApplicationLifetime.Startup += OnStartup;
-               
+
                 controlledApplicationLifetime.Exit += OnExit;
             }
         }
@@ -191,7 +193,6 @@ protected async Task DisplayRootViewForAsync(Type viewModelType, IDictionary<str
             window.Show();
         }
 
-
         /// <summary>
         /// Locates the view model, locates the associate view, binds them and shows it as the root view.
         /// </summary>
diff --git a/src/Caliburn.Micro.Platform/Platforms/netcore-avalonia/TriggerAction.cs b/src/Caliburn.Micro.Platform/Platforms/netcore-avalonia/TriggerAction.cs
@@ -1,10 +1,12 @@
-﻿using System;
-using Avalonia;
+﻿using Avalonia;
 using Avalonia.Controls;
 using Avalonia.Xaml.Interactivity;
 
 namespace Caliburn.Micro
 {
+    /// <summary>
+    /// Represents an attachable object that encapsulates a unit of functionality.
+    /// </summary>
     public abstract class TriggerAction<T> : TriggerAction
     {
     }
@@ -15,34 +17,10 @@ public abstract class TriggerAction<T> : TriggerAction
     public abstract class TriggerAction : AvaloniaObject, IAction
     {
         private Control _associatedObject;
-        /*
-        /// <summary>
-        /// The associated object property.
-        /// </summary>
-        public static readonly AvaloniaProperty AssociatedObjectProperty =
-            AvaloniaProperty.Register<TriggerAction<T>, Control>("AssociatedObject");
 
-        static TriggerAction()
-        {
-            AssociatedObjectProperty.Changed.Subscribe(OnAssociatedObjectChanged);
-        }
-        
         /// <summary>
         /// Gets or sets the object to which this <see cref="TriggerAction&lt;T&gt;"/> is attached. 
         /// </summary>
-        public Control AssociatedObject
-        {
-            get
-            {
-                return (Control)GetValue(AssociatedObjectProperty);
-            }
-            set
-            {
-                SetValue(AssociatedObjectProperty, value);
-            }
-        }
-        */
-
         public Control AssociatedObject
         {
             get => _associatedObject;
diff --git a/src/Caliburn.Micro.Platform/Platforms/netcore-avalonia/WindowConductor.cs b/src/Caliburn.Micro.Platform/Platforms/netcore-avalonia/WindowConductor.cs

Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@ public class ActionsViewModel : Screen`
`9`	`9`	`private string _output;`
`10`	`10`	`public ActionsViewModel()`
`11`	`11`	`{`
`12`		`- Output="Caliburn Micro";`
	`12`	`+ _output = "Caliburn Micro";`
`13`	`13`	`}`
`14`	`14`
`15`	`15`	`public void Clear() => Output = string.Empty;`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,4 @@`
`1`		`-using System;`
`2`		`-using System.Threading;`
	`1`	`+using System.Threading;`
`3`	`2`	`using Caliburn.Micro;`
`4`	`3`	`using Features.CrossPlatform.Messages;`
`5`	`4`
`@@ -8,17 +7,18 @@ namespace Features.CrossPlatform.ViewModels.Events`
`8`	`7`	`public class EventSourceViewModel : Screen`
`9`	`8`	`{`
`10`	`9`	`private readonly IEventAggregator eventAggregator;`
`11`		`- private string text;`
	`10`	`+ private string _text;`
`12`	`11`
`13`	`12`	`public EventSourceViewModel(IEventAggregator eventAggregator)`
`14`	`13`	`{`
`15`	`14`	`this.eventAggregator = eventAggregator;`
	`15`	`+ _text = string.Empty;`
`16`	`16`	`}`
`17`	`17`
`18`	`18`	`public string Text`
`19`	`19`	`{`
`20`		`- get { return text; }`
`21`		`- set { Set(ref text, value); }`
	`20`	`+ get { return _text; }`
	`21`	`+ set { Set(ref _text, value); }`
`22`	`22`	`}`
`23`	`23`
`24`	`24`	`public async void Publish()`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,10 @@ public class NavigationTargetViewModel : Screen`
`6`	`6`	`{`
`7`	`7`	`private string _text;`
`8`	`8`	`private bool _isEnabled;`
`9`		`-`
	`9`	`+ public NavigationTargetViewModel()`
	`10`	`+ {`
	`11`	`+ _text = string.Empty;`
	`12`	`+ }`
`10`	`13`	`public string Text`
`11`	`14`	`{`
`12`	`15`	`get { return _text; }`
Original file line number	Diff line number	Diff line change
`@@ -172,14 +172,14 @@ public bool HasHandler(Type service, string key)`
`172`	`172`	`/// <returns>All the instances or an empty enumerable if none are found.</returns>`
`173`	`173`	`public IEnumerable<object> GetAllInstances(Type service, string key = null)`
`174`	`174`	`{`
`175`		`- var entries = GetEntry(service, key);`
	`175`	`+ var currentEntry = GetEntry(service, key);`
`176`	`176`
`177`		`- if (entries == null)`
	`177`	`+ if (currentEntry == null)`
`178`	`178`	`{`
`179`	`179`	`return new object[0];`
`180`	`180`	`}`
`181`	`181`
`182`		`- var instances = entries.Select(e => e(this));`
	`182`	`+ var instances = currentEntry.Select(e => e(this));`
`183`	`183`
`184`	`184`	`foreach (var instance in instances)`
`185`	`185`	`{`
Original file line number	Diff line number	Diff line change
`@@ -89,12 +89,9 @@ public static string[] SplitParameters(string parameters)`
`89`	`89`	`{`
`90`	`90`	`var current = parameters[i];`
`91`	`91`
`92`		`- if (current == '"' \|\| current == '\'')`
	`92`	`+ if ((current == '"' \|\| current == '\'') && (i == 0 \|\| parameters[i - 1] != '\\'))`
`93`	`93`	`{`
`94`		`- if (i == 0 \|\| parameters[i - 1] != '\\')`
`95`		`- {`
`96`		`- isInString = !isInString;`
`97`		`- }`
	`94`	`+ isInString = !isInString;`
`98`	`95`	`}`
`99`	`96`
`100`	`97`	`if (!isInString)`
Original file line number	Diff line number	Diff line change
`@@ -53,7 +53,7 @@ static BindingScope()`
`53`	`53`	`AddChildResolver<CommandBar>(ResolveCommandBar);`
`54`	`54`	`AddChildResolver<Button>(e => ResolveFlyoutBase(e.Flyout));`
`55`	`55`	`AddChildResolver<FrameworkElement>(e => ResolveFlyoutBase(FlyoutBase.GetAttachedFlyout(e)));`
`56`		`- AddChildResolver<SplitView>(e => new[] { e.Pane as DependencyObject, e.Content as DependencyObject });`
	`56`	`+ AddChildResolver<SplitView>(e => new[] { e.Pane, e.Content });`
`57`	`57`	`#endif`
`58`	`58`	`}`
`59`	`59`