Skip to content
This repository was archived by the owner on May 1, 2024. It is now read-only.

Deprecate LocalizationResourceManager.SetCulture #766

Merged
merged 10 commits into from
Jan 29, 2021
Merged

Deprecate LocalizationResourceManager.SetCulture #766

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
bf01d6b
Deprecate SetCulture
maxkoshevoi Jan 16, 2021
3ccc288
Add EditorBrowsableState.Never
maxkoshevoi Jan 22, 2021
0f77e70
Update src/CommunityToolkit/Xamarin.CommunityToolkit/Helpers/Localiza…
pictos Jan 23, 2021
cac87cf
Merge branch 'develop' into issue757
maxkoshevoi Jan 23, 2021
3d09b0e
Fix obsolete warning in tests
maxkoshevoi Jan 23, 2021
68dc2d8
Remove unneeded line
maxkoshevoi Jan 23, 2021
7ef57e9
Use new LocalizationResourceManager for tests
maxkoshevoi Jan 23, 2021
bb42757
Siplify impicit conversion test to test only conversion itself
maxkoshevoi Jan 23, 2021
771c9b5
Return Invalidate mathod
maxkoshevoi Jan 26, 2021
d603431
Merge branch 'develop' into issue757
maxkoshevoi Jan 29, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion samples/XCT.Sample/ViewModels/SettingViewModel.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ public SettingViewModel()

ChangeLanguageCommand = CommandFactory.Create(() =>
{
LocalizationResourceManager.Current.SetCulture(CultureInfo.GetCultureInfo(SelectedLanguage.CI));
LocalizationResourceManager.Current.CurrentCulture = CultureInfo.GetCultureInfo(SelectedLanguage.CI);
LoadLanguages();
});
}
Expand Down
9 changes: 5 additions & 4 deletions ...it.UnitTests/Helpers/LocalizationResourceManagerTests/LocalizationResourceManagerTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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()
Expand All @@ -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);
Expand Down
28 changes: 10 additions & 18 deletions ...t/Xamarin.CommunityToolkit.UnitTests/Helpers/LocalizedStringTests/LocalizedStringTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand All @@ -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);

Expand All @@ -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]
Expand Down
2 changes: 1 addition & 1 deletion src/CommunityToolkit/Xamarin.CommunityToolkit/Converters/TextCaseConverter.shared.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
22 changes: 12 additions & 10 deletions src/CommunityToolkit/Xamarin.CommunityToolkit/Helpers/LocalizationResourceManager.shared.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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();
Expand Down Expand Up @@ -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));
Comment on lines -50 to -51
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jfversluis can we just remove it? Or we should mark it as obsolete and editorbrowsablestate.never

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This method doesn't make sense anymore. Culture is stored in the private field, and when we change it, we always call PropertyChanged ourselves. So public Invalidate method will just needlessly send an event.

It was needed earlier since culture was stored in Thread.CurrentThread.CurrentUICulture that could be changed outside of LocalizationResourceManager

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see what you're saying, I think it would make sense to first release a version where it's deprecated though. That way people will get a heads up that it is going away and gives them the opportunity to change their code at their pace instead of just dropping a breaking change over the fence that they have to deal with without any notice upfront.

Does that make sense?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Makes sense, returned the method. When are we planning to remove everything that is marked as Obsolete?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would say 1 version obsolete, next version it's gone :)

[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
}