Deprecate LocalizationResourceManager.SetCulture (#766)

* Deprecate SetCulture

* Add EditorBrowsableState.Never

* Update src/CommunityToolkit/Xamarin.CommunityToolkit/Helpers/LocalizationResourceManager.shared.cs

* Fix obsolete warning in tests

* Remove unneeded line

* Use new LocalizationResourceManager for tests

Tests were failing from time to time because the same instance of LRM was used for all of them. And since tests are executed in parallel, this caused some issues

* Siplify impicit conversion test to test only conversion itself

* Return Invalidate mathod

Co-authored-by: Pedro Jesus <[email protected]>

Author: maxkoshevoi

samples/XCT.Sample/ViewModels/SettingViewModel.cs

@@ -38,7 +38,7 @@ public SettingViewModel()
 
 			ChangeLanguageCommand = CommandFactory.Create(() =>
 			{
-				LocalizationResourceManager.Current.SetCulture(CultureInfo.GetCultureInfo(SelectedLanguage.CI));
+				LocalizationResourceManager.Current.CurrentCulture = CultureInfo.GetCultureInfo(SelectedLanguage.CI);
 				LoadLanguages();
 			});
 		}

src/CommunityToolkit/Xamarin.CommunityToolkit.UnitTests/Helpers/LocalizationResourceManagerTests/LocalizationResourceManagerTests.cs

@@ -11,13 +11,15 @@ public class LocalizationResourceManagerTests
 		public LocalizationResourceManagerTests()
 		{
 			resourceManager = new MockResourceManager();
-			localizationManager = LocalizationResourceManager.Current;
+#pragma warning disable CS0618 // Type or member is obsolete
+			localizationManager = new LocalizationResourceManager();
+#pragma warning restore CS0618 // Type or member is obsolete
 			localizationManager.Init(resourceManager, initialCulture);
 		}
 
 		readonly LocalizationResourceManager localizationManager;
-		readonly ResourceManager resourceManager;
 		readonly CultureInfo initialCulture = CultureInfo.InvariantCulture;
+		readonly ResourceManager resourceManager;
 
 		[Fact]
 		public void LocalizationResourceManager_GetCulture_Equal_Indexer()
@@ -30,11 +32,10 @@ public void LocalizationResourceManager_GetCulture_Equal_Indexer()
 			var responceIndexerCulture1 = localizationManager[testString];
 			var responceGetValueCulture1 = localizationManager.GetValue(testString);
 			var responceResourceManagerCulture1 = resourceManager.GetString(testString, initialCulture);
-			localizationManager.SetCulture(culture2);
+			localizationManager.CurrentCulture = culture2;
 			var responceIndexerCulture2 = localizationManager[testString];
 			var responceGetValueCulture2 = localizationManager.GetValue(testString);
 			var responceResourceManagerCulture2 = resourceManager.GetString(testString, culture2);
-			resourceManager.GetString(testString, culture2);
 
 			// Assert
 			Assert.Equal(responceResourceManagerCulture1, responceIndexerCulture1);

src/CommunityToolkit/Xamarin.CommunityToolkit.UnitTests/Helpers/LocalizedStringTests/LocalizedStringTests.cs

@@ -12,11 +12,13 @@ public class LocalizedStringTests
 		public LocalizedStringTests()
 		{
 			resourceManager = new MockResourceManager();
-			localizationManager.Init(resourceManager);
-			localizationManager.SetCulture(initialCulture);
+#pragma warning disable CS0618 // Type or member is obsolete
+			localizationManager = new LocalizationResourceManager();
+#pragma warning restore CS0618 // Type or member is obsolete
+			localizationManager.Init(resourceManager, initialCulture);
 		}
 
-		readonly LocalizationResourceManager localizationManager = LocalizationResourceManager.Current;
+		readonly LocalizationResourceManager localizationManager;
 		readonly CultureInfo initialCulture = CultureInfo.InvariantCulture;
 		readonly ResourceManager resourceManager;
 		LocalizedString localizedString;
@@ -35,7 +37,7 @@ public void LocalizedStringTests_Localized_ValidImplementation()
 			// Act
 			var responceCulture1 = localizedString.Localized;
 			var responceResourceManagerCulture1 = resourceManager.GetString(testString, initialCulture);
-			localizationManager.SetCulture(culture2);
+			localizationManager.CurrentCulture = culture2;
 			var responceCulture2 = localizedString.Localized;
 			var responceResourceManagerCulture2 = resourceManager.GetString(testString, culture2);
 
@@ -46,27 +48,17 @@ public void LocalizedStringTests_Localized_ValidImplementation()
 		}
 
 		[Fact]
-		public void LocalizedStringTests_Localized_ValidImplementation_With_Func()
+		public void LocalizedStringTests_ImplicitConversion_ValidImplementation()
 		{
 			// Arrange
 			var testString = "test";
-			var culture2 = new CultureInfo("en");
-			localizedString = (Func<string>)(() => localizationManager[testString]);
-
-			string responceOnCultureChanged = null;
-			localizedString.PropertyChanged += (sender, args) => responceOnCultureChanged = localizedString.Localized;
+			Func<string> generator = () => testString;
 
 			// Act
-			var responceCulture1 = localizedString.Localized;
-			var responceResourceManagerCulture1 = resourceManager.GetString(testString, initialCulture);
-			localizationManager.SetCulture(culture2);
-			var responceCulture2 = localizedString.Localized;
-			var responceResourceManagerCulture2 = resourceManager.GetString(testString, culture2);
+			localizedString = generator;
 
 			// Assert
-			Assert.Equal(responceResourceManagerCulture1, responceCulture1);
-			Assert.Equal(responceResourceManagerCulture2, responceOnCultureChanged);
-			Assert.Equal(responceResourceManagerCulture2, responceResourceManagerCulture2);
+			Assert.NotNull(localizedString);
 		}
 
 		[Fact]

src/CommunityToolkit/Xamarin.CommunityToolkit/Converters/TextCaseConverter.shared.cs

@@ -37,7 +37,7 @@ object Convert(string value, object parameter)
 			{
 				TextCaseType.Lower => value?.ToLowerInvariant(),
 				TextCaseType.Upper => value?.ToUpperInvariant(),
-				TextCaseType.FirstUpperRestLower => !string.IsNullOrWhiteSpace(value) 
+				TextCaseType.FirstUpperRestLower => !string.IsNullOrWhiteSpace(value)
 					? value.Substring(0, 1).ToUpperInvariant() + value.Substring(1).ToLowerInvariant()
 					: value,
 				_ => value

src/CommunityToolkit/Xamarin.CommunityToolkit/Helpers/LocalizationResourceManager.shared.cs

@@ -3,11 +3,12 @@
 using System.Globalization;
 using System.Resources;
 using System.Threading;
+using Xamarin.CommunityToolkit.ObjectModel;
 
 namespace Xamarin.CommunityToolkit.Helpers
 {
 #if !NETSTANDARD1_0
-	public class LocalizationResourceManager : INotifyPropertyChanged
+	public class LocalizationResourceManager : ObservableObject
 	{
 #pragma warning disable CS0618 // Type or member is obsolete
 		public static LocalizationResourceManager Current { get; } = new LocalizationResourceManager();
@@ -37,18 +38,19 @@ public string GetValue(string text) =>
 		public string this[string text] =>
 			GetValue(text);
 
-		public void SetCulture(CultureInfo language)
+		[Obsolete("Please, use " + nameof(CurrentCulture) + " to set culture")]
+		[EditorBrowsable(EditorBrowsableState.Never)]
+		public void SetCulture(CultureInfo language) => CurrentCulture = language;
+
+		public CultureInfo CurrentCulture
 		{
-			currentCulture = language;
-			Invalidate();
+			get => currentCulture;
+			set => SetProperty(ref currentCulture, value, null);
 		}
 
-		public CultureInfo CurrentCulture => currentCulture;
-
-		public event PropertyChangedEventHandler PropertyChanged;
-
-		public void Invalidate() =>
-			PropertyChanged?.Invoke(this, new PropertyChangedEventArgs(null));
+		[Obsolete("This method is no longer needed with new implementation of " + nameof(LocalizationResourceManager) + ". Please, remove all references to it.")]
+		[EditorBrowsable(EditorBrowsableState.Never)]
+		public void Invalidate() => OnPropertyChanged(null);
 	}
 #endif
 }