Obsolete ResourceManagerWithCultureStringLocalizer and WithCulture (dotnet/extensions#1133)

Obsolete ResourceManagerWithCultureStringLocalizer and WithCulture
\n\nCommit migrated from 924015e98b

src/Localization/Abstractions/ref/Microsoft.Extensions.Localization.Abstractions.netstandard2.0.cs

@@ -8,6 +8,7 @@ namespace Microsoft.Extensions.Localization
         Microsoft.Extensions.Localization.LocalizedString this[string name] { get; }
         Microsoft.Extensions.Localization.LocalizedString this[string name, params object[] arguments] { get; }
         System.Collections.Generic.IEnumerable<Microsoft.Extensions.Localization.LocalizedString> GetAllStrings(bool includeParentCultures);
+        [System.ObsoleteAttribute("This method is obsolete. Use `CurrentCulture` and `CurrentUICulture` instead.")]
         Microsoft.Extensions.Localization.IStringLocalizer WithCulture(System.Globalization.CultureInfo culture);
     }
     public partial interface IStringLocalizerFactory
@@ -42,6 +43,7 @@ namespace Microsoft.Extensions.Localization
         public virtual Microsoft.Extensions.Localization.LocalizedString this[string name] { get { throw null; } }
         public virtual Microsoft.Extensions.Localization.LocalizedString this[string name, params object[] arguments] { get { throw null; } }
         public System.Collections.Generic.IEnumerable<Microsoft.Extensions.Localization.LocalizedString> GetAllStrings(bool includeParentCultures) { throw null; }
+        [System.ObsoleteAttribute("This method is obsolete. Use `CurrentCulture` and `CurrentUICulture` instead.")]
         public virtual Microsoft.Extensions.Localization.IStringLocalizer WithCulture(System.Globalization.CultureInfo culture) { throw null; }
     }
 }

src/Localization/Abstractions/src/IStringLocalizer.cs

@@ -1,6 +1,7 @@
-// Copyright (c) .NET Foundation. All rights reserved. 
+// Copyright (c) .NET Foundation. All rights reserved.
-// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information. 
+// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
 
+using System;
 using System.Collections.Generic;
 using System.Globalization;
 
@@ -40,6 +41,7 @@ namespace Microsoft.Extensions.Localization
         /// </summary>
         /// <param name="culture">The <see cref="CultureInfo"/> to use.</param>
         /// <returns>A culture-specific <see cref="IStringLocalizer"/>.</returns>
+        [Obsolete("This method is obsolete. Use `CurrentCulture` and `CurrentUICulture` instead.")]
         IStringLocalizer WithCulture(CultureInfo culture);
     }
-}
+}

src/Localization/Abstractions/src/StringLocalizerOfT.cs

@@ -1,5 +1,5 @@
-// Copyright (c) .NET Foundation. All rights reserved. 
+// Copyright (c) .NET Foundation. All rights reserved.
-// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information. 
+// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
 
 using System;
 using System.Collections.Generic;
@@ -30,6 +30,7 @@ namespace Microsoft.Extensions.Localization
         }
 
         /// <inheritdoc />
+        [Obsolete("This method is obsolete. Use `CurrentCulture` and `CurrentUICulture` instead.")]
         public virtual IStringLocalizer WithCulture(CultureInfo culture) => _localizer.WithCulture(culture);
 
         /// <inheritdoc />
@@ -64,4 +65,4 @@ namespace Microsoft.Extensions.Localization
         public IEnumerable<LocalizedString> GetAllStrings(bool includeParentCultures) =>
             _localizer.GetAllStrings(includeParentCultures);
     }
-}
+}

src/Localization/Localization/ref/Microsoft.Extensions.Localization.netstandard2.0.cs

@@ -36,6 +36,7 @@ namespace Microsoft.Extensions.Localization
         public virtual System.Collections.Generic.IEnumerable<Microsoft.Extensions.Localization.LocalizedString> GetAllStrings(bool includeParentCultures) { throw null; }
         protected System.Collections.Generic.IEnumerable<Microsoft.Extensions.Localization.LocalizedString> GetAllStrings(bool includeParentCultures, System.Globalization.CultureInfo culture) { throw null; }
         protected string GetStringSafely(string name, System.Globalization.CultureInfo culture) { throw null; }
+        [System.ObsoleteAttribute("This method is obsolete. Use `CurrentCulture` and `CurrentUICulture` instead.")]
         public Microsoft.Extensions.Localization.IStringLocalizer WithCulture(System.Globalization.CultureInfo culture) { throw null; }
     }
     public partial class ResourceManagerStringLocalizerFactory : Microsoft.Extensions.Localization.IStringLocalizerFactory
@@ -51,6 +52,7 @@ namespace Microsoft.Extensions.Localization
         protected virtual string GetResourcePrefix(string location, string baseName, string resourceLocation) { throw null; }
         protected virtual Microsoft.Extensions.Localization.RootNamespaceAttribute GetRootNamespaceAttribute(System.Reflection.Assembly assembly) { throw null; }
     }
+    [System.ObsoleteAttribute("This method is obsolete. Use `CurrentCulture` and `CurrentUICulture` instead.")]
     public partial class ResourceManagerWithCultureStringLocalizer : Microsoft.Extensions.Localization.ResourceManagerStringLocalizer
     {
         public ResourceManagerWithCultureStringLocalizer(System.Resources.ResourceManager resourceManager, System.Reflection.Assembly resourceAssembly, string baseName, Microsoft.Extensions.Localization.IResourceNamesCache resourceNamesCache, System.Globalization.CultureInfo culture, Microsoft.Extensions.Logging.ILogger logger) : base (default(System.Resources.ResourceManager), default(System.Reflection.Assembly), default(string), default(Microsoft.Extensions.Localization.IResourceNamesCache), default(Microsoft.Extensions.Logging.ILogger)) { }

src/Localization/Localization/src/ResourceManagerStringLocalizer.cs

@@ -1,5 +1,5 @@
-// Copyright (c) .NET Foundation. All rights reserved. 
+// Copyright (c) .NET Foundation. All rights reserved.
-// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information. 
+// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
 
 using System;
 using System.Collections.Concurrent;
@@ -151,6 +151,7 @@ namespace Microsoft.Extensions.Localization
         /// </summary>
         /// <param name="culture">The <see cref="CultureInfo"/> to use.</param>
         /// <returns>A culture-specific <see cref="ResourceManagerStringLocalizer"/>.</returns>
+        [Obsolete("This method is obsolete. Use `CurrentCulture` and `CurrentUICulture` instead.")]
         public IStringLocalizer WithCulture(CultureInfo culture)
         {
             return culture == null
@@ -271,4 +272,4 @@ namespace Microsoft.Extensions.Localization
             return resourceNames;
         }
     }
-}
+}

src/Localization/Localization/src/ResourceManagerWithCultureStringLocalizer.cs

@@ -1,5 +1,5 @@
-// Copyright (c) .NET Foundation. All rights reserved. 
+// Copyright (c) .NET Foundation. All rights reserved.
-// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information. 
+// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
 
 using System;
 using System.Collections.Generic;
@@ -15,6 +15,7 @@ namespace Microsoft.Extensions.Localization
     /// An <see cref="IStringLocalizer"/> that uses the <see cref="ResourceManager"/> and
     /// <see cref="ResourceReader"/> to provide localized strings for a specific <see cref="CultureInfo"/>.
     /// </summary>
+    [Obsolete("This method is obsolete. Use `CurrentCulture` and `CurrentUICulture` instead.")]
     public class ResourceManagerWithCultureStringLocalizer : ResourceManagerStringLocalizer
     {
         private readonly string _resourceBaseName;
@@ -161,4 +162,4 @@ namespace Microsoft.Extensions.Localization
         public override IEnumerable<LocalizedString> GetAllStrings(bool includeParentCultures) =>
             GetAllStrings(includeParentCultures, _culture);
     }
-}
+}

src/Localization/Localization/test/ResourceManagerStringLocalizerTest.cs

@@ -182,12 +182,11 @@ namespace Microsoft.Extensions.Localization
             var resourceManager = new TestResourceManager(baseName, resourceAssembly);
             var logger = Logger;
 
-            var localizer = new ResourceManagerWithCultureStringLocalizer(
+            var localizer = new ResourceManagerStringLocalizer(
                 resourceManager,
                 resourceAssembly.Assembly,
                 baseName,
                 resourceNamesCache,
-                CultureInfo.CurrentCulture,
                 logger);
 
             // Act & Assert
@@ -291,7 +290,7 @@ namespace Microsoft.Extensions.Localization
             public override Stream GetManifestResourceStream(string name)
             {
                 ManifestResourceStreamCallCount++;
-                
+
                 return HasResources ? MakeResourceStream() : null;
             }
         }