Merge pull request #27 from pfpack/release/v2.0.0-rc.2.0.0

pmosk · web-flow · commit ac54189e598b · 2021-11-15T22:37:37.000+03:00
release/v2.0.0-rc.2.0.0
diff --git a/src/primitives-linq/Primitives.Linq/Primitives.Linq.csproj b/src/primitives-linq/Primitives.Linq/Primitives.Linq.csproj
@@ -17,7 +17,7 @@
     <Description>PrimeFuncPack Primitives.Linq is a core library for .NET consisting of useful extensions making work with Linq easier.</Description>
     <RootNamespace>System</RootNamespace>
     <AssemblyName>PrimeFuncPack.Primitives.Linq</AssemblyName>
-    <Version>2.0.0-rc.1.0.1</Version>
+    <Version>2.0.0-rc.1.0.2</Version>
   </PropertyGroup>
 
   <ItemGroup>
diff --git a/src/primitives-pipeline/Primitives.Pipeline/Primitives.Pipeline.csproj b/src/primitives-pipeline/Primitives.Pipeline/Primitives.Pipeline.csproj
@@ -17,7 +17,7 @@
     <Description>PrimeFuncPack Primitives.Pipeline is a core library for .NET consisting of useful extensions making work with functional pipelines easier.</Description>
     <RootNamespace>System</RootNamespace>
     <AssemblyName>PrimeFuncPack.Primitives.Pipeline</AssemblyName>
-    <Version>2.0.0-rc.1.0.1</Version>
+    <Version>2.0.0-rc.1.0.2</Version>
   </PropertyGroup>
 
   <ItemGroup>
diff --git a/src/primitives-predicates/Primitives.Predicates/Primitives.Predicates.csproj b/src/primitives-predicates/Primitives.Predicates/Primitives.Predicates.csproj
@@ -17,7 +17,7 @@
     <Description>PrimeFuncPack Primitives.Predicates is a core library for .NET consisting of useful extensions and predicates making work with the nullable feature easier.</Description>
     <RootNamespace>System</RootNamespace>
     <AssemblyName>PrimeFuncPack.Primitives.Predicates</AssemblyName>
-    <Version>2.0.0-rc.1.0.1</Version>
+    <Version>2.0.0-rc.1.0.2</Version>
   </PropertyGroup>
 
   <ItemGroup>
diff --git a/src/primitives-strings/Primitives.Strings.Tests/StringExtensions.Tests/ToStringOrEmpty_Obsolete.cs b/src/primitives-strings/Primitives.Strings.Tests/StringExtensions.Tests/ToStringOrEmpty_Obsolete.cs
@@ -0,0 +1,35 @@
+﻿using NUnit.Framework;
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Reflection;
+
+namespace PrimeFuncPack.Primitives.Tests;
+
+partial class StringExtensionsTests
+{
+    [Test]
+    public void ToStringOrEmpty_ExpectIsObsoleteWithError()
+    {
+        const string expectedObsoleteMessage = "This method is obsolete. Consider to call obj?.ToString().OrEmpty() instead.";
+
+        IReadOnlyCollection<MethodInfo> methods = typeof(StringExtensions)
+            .GetMethods(BindingFlags.Public | BindingFlags.Static)
+            .Where(method => method.Name == nameof(StringExtensions.ToStringOrEmpty))
+            .ToArray();
+
+        Assert.AreEqual(2, methods.Count);
+
+        Assert.IsTrue(
+            methods.All(
+                method => method.CustomAttributes.Any(
+                    attr
+                    =>
+                    attr.AttributeType == typeof(ObsoleteAttribute) &&
+                    attr.ConstructorArguments.Count == 2 &&
+                    attr.ConstructorArguments[0].ArgumentType == typeof(string) &&
+                    attr.ConstructorArguments[0].Value is expectedObsoleteMessage &&
+                    attr.ConstructorArguments[1].ArgumentType == typeof(bool) &&
+                    attr.ConstructorArguments[1].Value is true)));
+    }
+}
diff --git a/src/primitives-strings/Primitives.Strings.Tests/StringExtensions.Tests/ToStringOrEmpty_Ref.cs b/src/primitives-strings/Primitives.Strings.Tests/StringExtensions.Tests/ToStringOrEmpty_Ref.cs
@@ -6,6 +6,7 @@ namespace PrimeFuncPack.Primitives.Tests;
 
 partial class StringExtensionsTests
 {
+    [Obsolete]
     [Test]
     public void ToStringOrEmpty_Ref_SourceIsNull_ExpectEmpty()
     {
@@ -15,6 +16,7 @@ public void ToStringOrEmpty_Ref_SourceIsNull_ExpectEmpty()
         Assert.IsEmpty(actual);
     }
 
+    [Obsolete]
     [Test]
     public void ToStringOrEmpty_Ref_SourceToStringIsNull_ExpectEmpty()
     {
@@ -24,6 +26,7 @@ public void ToStringOrEmpty_Ref_SourceToStringIsNull_ExpectEmpty()
         Assert.IsEmpty(actual);
     }
 
+    [Obsolete]
     [Test]
     [TestCase(EmptyString)]
     [TestCase(WhiteSpaceString)]
diff --git a/src/primitives-strings/Primitives.Strings.Tests/StringExtensions.Tests/ToStringOrEmpty_StructNullable.cs b/src/primitives-strings/Primitives.Strings.Tests/StringExtensions.Tests/ToStringOrEmpty_StructNullable.cs
@@ -6,6 +6,7 @@ namespace PrimeFuncPack.Primitives.Tests;
 
 partial class StringExtensionsTests
 {
+    [Obsolete]
     [Test]
     public void ToStringOrEmpty_StructNullable_SourceIsNull_ExpectEmpty()
     {
@@ -15,6 +16,7 @@ public void ToStringOrEmpty_StructNullable_SourceIsNull_ExpectEmpty()
         Assert.IsEmpty(actual);
     }
 
+    [Obsolete]
     [Test]
     public void ToStringOrEmpty_StructNullable_SourceToStringIsNull_ExpectEmpty()
     {
@@ -24,6 +26,7 @@ public void ToStringOrEmpty_StructNullable_SourceToStringIsNull_ExpectEmpty()
         Assert.IsEmpty(actual);
     }
 
+    [Obsolete]
     [Test]
     [TestCase(EmptyString)]
     [TestCase(WhiteSpaceString)]
diff --git a/src/primitives-strings/Primitives.Strings.Tests/Strings.Tests/ToStringOrEmpty_Obsolete.cs b/src/primitives-strings/Primitives.Strings.Tests/Strings.Tests/ToStringOrEmpty_Obsolete.cs
@@ -0,0 +1,35 @@
+﻿using NUnit.Framework;
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Reflection;
+
+namespace PrimeFuncPack.Primitives.Tests;
+
+partial class StringsTests
+{
+    [Test]
+    public void ToStringOrEmpty_ExpectIsObsoleteWithError()
+    {
+        const string expectedObsoleteMessage = "This method is obsolete. Consider to call obj?.ToString().OrEmpty() instead.";
+
+        IReadOnlyCollection<MethodInfo> methods = typeof(Strings)
+            .GetMethods(BindingFlags.Public | BindingFlags.Static)
+            .Where(method => method.Name == nameof(Strings.ToStringOrEmpty))
+            .ToArray();
+
+        Assert.AreEqual(2, methods.Count);
+
+        Assert.IsTrue(
+            methods.All(
+                method => method.CustomAttributes.Any(
+                    attr
+                    =>
+                    attr.AttributeType == typeof(ObsoleteAttribute) &&
+                    attr.ConstructorArguments.Count == 2 &&
+                    attr.ConstructorArguments[0].ArgumentType == typeof(string) &&
+                    attr.ConstructorArguments[0].Value is expectedObsoleteMessage &&
+                    attr.ConstructorArguments[1].ArgumentType == typeof(bool) &&
+                    attr.ConstructorArguments[1].Value is true)));
+    }
+}
diff --git a/src/primitives-strings/Primitives.Strings.Tests/Strings.Tests/ToStringOrEmpty_Ref.cs b/src/primitives-strings/Primitives.Strings.Tests/Strings.Tests/ToStringOrEmpty_Ref.cs
@@ -6,6 +6,7 @@ namespace PrimeFuncPack.Primitives.Tests;
 
 partial class StringsTests
 {
+    [Obsolete]
     [Test]
     public void ToStringOrEmpty_Ref_SourceIsNull_ExpectEmpty()
     {
@@ -15,6 +16,7 @@ public void ToStringOrEmpty_Ref_SourceIsNull_ExpectEmpty()
         Assert.IsEmpty(actual);
     }
 
+    [Obsolete]
     [Test]
     public void ToStringOrEmpty_Ref_SourceToStringIsNull_ExpectEmpty()
     {
@@ -24,6 +26,7 @@ public void ToStringOrEmpty_Ref_SourceToStringIsNull_ExpectEmpty()
         Assert.IsEmpty(actual);
     }
 
+    [Obsolete]
     [Test]
     [TestCase(EmptyString)]
     [TestCase(WhiteSpaceString)]
diff --git a/src/primitives-strings/Primitives.Strings.Tests/Strings.Tests/ToStringOrEmpty_StructNullable.cs b/src/primitives-strings/Primitives.Strings.Tests/Strings.Tests/ToStringOrEmpty_StructNullable.cs
@@ -6,6 +6,7 @@ namespace PrimeFuncPack.Primitives.Tests;
 
 partial class StringsTests
 {
+    [Obsolete]
     [Test]
     public void ToStringOrEmpty_StructNullable_SourceIsNull_ExpectEmpty()
     {
@@ -15,6 +16,7 @@ public void ToStringOrEmpty_StructNullable_SourceIsNull_ExpectEmpty()
         Assert.IsEmpty(actual);
     }
 
+    [Obsolete]
     [Test]
     public void ToStringOrEmpty_StructNullable_SourceToStringIsNull_ExpectEmpty()
     {
@@ -24,6 +26,7 @@ public void ToStringOrEmpty_StructNullable_SourceToStringIsNull_ExpectEmpty()
         Assert.IsEmpty(actual);
     }
 
+    [Obsolete]
     [Test]
     [TestCase(EmptyString)]
     [TestCase(WhiteSpaceString)]
diff --git a/src/primitives-strings/Primitives.Strings/InternalObsolete/InternalObsoleteErrors.cs b/src/primitives-strings/Primitives.Strings/InternalObsolete/InternalObsoleteErrors.cs
@@ -0,0 +1,6 @@
+﻿namespace System;
+
+internal static class InternalObsoleteErrors
+{
+    public const bool ToStringOrEmpty = true;
+}
diff --git a/src/primitives-strings/Primitives.Strings/InternalObsolete/InternalObsoleteMessages.cs b/src/primitives-strings/Primitives.Strings/InternalObsolete/InternalObsoleteMessages.cs
@@ -0,0 +1,6 @@
+﻿namespace System;
+
+internal static class InternalObsoleteMessages
+{
+    public const string ToStringOrEmpty = "This method is obsolete. Consider to call obj?.ToString().OrEmpty() instead.";
+}
diff --git a/src/primitives-strings/Primitives.Strings/Primitives.Strings.csproj b/src/primitives-strings/Primitives.Strings/Primitives.Strings.csproj
@@ -17,7 +17,7 @@
     <Description>PrimeFuncPack Primitives.Strings is a core library for .NET consisting of useful extensions making work with strings easier.</Description>
     <RootNamespace>System</RootNamespace>
     <AssemblyName>PrimeFuncPack.Primitives.Strings</AssemblyName>
-    <Version>2.0.0-rc.1.0.1</Version>
+    <Version>2.0.0-rc.2.0.0</Version>
   </PropertyGroup>
 
   <ItemGroup>
diff --git a/src/primitives-strings/Primitives.Strings/StringExtensions.cs b/src/primitives-strings/Primitives.Strings/StringExtensions.cs
@@ -19,11 +19,15 @@ public static string OrEmpty(this string? value)
         =>
         Strings.OrNullIfWhiteSpace(value);
 
+    // TODO: Consider to delete the method in v3.0
+    [Obsolete(InternalObsoleteMessages.ToStringOrEmpty, error: InternalObsoleteErrors.ToStringOrEmpty)]
     [MethodImpl(MethodImplOptions.AggressiveInlining)]
     public static string ToStringOrEmpty<T>(this T? value)
         =>
         Strings.ToStringOrEmpty(value);
 
+    // TODO: Consider to delete the method in v3.0
+    [Obsolete(InternalObsoleteMessages.ToStringOrEmpty, error: InternalObsoleteErrors.ToStringOrEmpty)]
     [MethodImpl(MethodImplOptions.AggressiveInlining)]
     public static string ToStringOrEmpty<T>(this T? value) where T : struct
         =>
diff --git a/src/primitives-strings/Primitives.Strings/Strings.cs b/src/primitives-strings/Primitives.Strings/Strings.cs
@@ -28,11 +28,15 @@ public static string OrEmpty(string? value)
             ? null
             : value;
 
+    // TODO: Consider to delete the method in v3.0
+    [Obsolete(InternalObsoleteMessages.ToStringOrEmpty, error: InternalObsoleteErrors.ToStringOrEmpty)]
     [MethodImpl(MethodImplOptions.AggressiveInlining)]
     public static string ToStringOrEmpty<T>(T? value)
         =>
         value?.ToString() ?? Empty;
 
+    // TODO: Consider to delete the method in v3.0
+    [Obsolete(InternalObsoleteMessages.ToStringOrEmpty, error: InternalObsoleteErrors.ToStringOrEmpty)]
     [MethodImpl(MethodImplOptions.AggressiveInlining)]
     public static string ToStringOrEmpty<T>(T? value) where T : struct
         =>
diff --git a/src/primitives/Primitives/Primitives.csproj b/src/primitives/Primitives/Primitives.csproj
@@ -17,7 +17,7 @@
     <Description>PrimeFuncPack Primitives is a core library for .NET consisting of useful extensions and predicates making work with functional pipelines, Linq, strings, the nullable feature, etc. easier.</Description>
     <RootNamespace>System</RootNamespace>
     <AssemblyName>PrimeFuncPack.Primitives</AssemblyName>
-    <Version>2.0.0-rc.1.0.1</Version>
+    <Version>2.0.0-rc.2.0.0</Version>
   </PropertyGroup>
 
   <ItemGroup>
@@ -32,10 +32,10 @@
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Include="PrimeFuncPack.Primitives.Linq" Version="2.0.0-rc.1.0.1" />
-    <PackageReference Include="PrimeFuncPack.Primitives.Pipeline" Version="2.0.0-rc.1.0.1" />
-    <PackageReference Include="PrimeFuncPack.Primitives.Predicates" Version="2.0.0-rc.1.0.1" />
-    <PackageReference Include="PrimeFuncPack.Primitives.Strings" Version="2.0.0-rc.1.0.1" />
+    <PackageReference Include="PrimeFuncPack.Primitives.Linq" Version="2.0.0-rc.1.0.2" />
+    <PackageReference Include="PrimeFuncPack.Primitives.Pipeline" Version="2.0.0-rc.1.0.2" />
+    <PackageReference Include="PrimeFuncPack.Primitives.Predicates" Version="2.0.0-rc.1.0.2" />
+    <PackageReference Include="PrimeFuncPack.Primitives.Strings" Version="2.0.0-rc.2.0.0" />
   </ItemGroup>
 
 </Project>

Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,7 @@ namespace PrimeFuncPack.Primitives.Tests;`
`6`	`6`
`7`	`7`	`partial class StringExtensionsTests`
`8`	`8`	`{`
	`9`	`+ [Obsolete]`
`9`	`10`	`[Test]`
`10`	`11`	`public void ToStringOrEmpty_Ref_SourceIsNull_ExpectEmpty()`
`11`	`12`	`{`
`@@ -15,6 +16,7 @@ public void ToStringOrEmpty_Ref_SourceIsNull_ExpectEmpty()`
`15`	`16`	`Assert.IsEmpty(actual);`
`16`	`17`	`}`
`17`	`18`
	`19`	`+ [Obsolete]`
`18`	`20`	`[Test]`
`19`	`21`	`public void ToStringOrEmpty_Ref_SourceToStringIsNull_ExpectEmpty()`
`20`	`22`	`{`
`@@ -24,6 +26,7 @@ public void ToStringOrEmpty_Ref_SourceToStringIsNull_ExpectEmpty()`
`24`	`26`	`Assert.IsEmpty(actual);`
`25`	`27`	`}`
`26`	`28`
	`29`	`+ [Obsolete]`
`27`	`30`	`[Test]`
`28`	`31`	`[TestCase(EmptyString)]`
`29`	`32`	`[TestCase(WhiteSpaceString)]`
Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,7 @@ namespace PrimeFuncPack.Primitives.Tests;`
`6`	`6`
`7`	`7`	`partial class StringsTests`
`8`	`8`	`{`
	`9`	`+ [Obsolete]`
`9`	`10`	`[Test]`
`10`	`11`	`public void ToStringOrEmpty_Ref_SourceIsNull_ExpectEmpty()`
`11`	`12`	`{`
`@@ -15,6 +16,7 @@ public void ToStringOrEmpty_Ref_SourceIsNull_ExpectEmpty()`
`15`	`16`	`Assert.IsEmpty(actual);`
`16`	`17`	`}`
`17`	`18`
	`19`	`+ [Obsolete]`
`18`	`20`	`[Test]`
`19`	`21`	`public void ToStringOrEmpty_Ref_SourceToStringIsNull_ExpectEmpty()`
`20`	`22`	`{`
`@@ -24,6 +26,7 @@ public void ToStringOrEmpty_Ref_SourceToStringIsNull_ExpectEmpty()`
`24`	`26`	`Assert.IsEmpty(actual);`
`25`	`27`	`}`
`26`	`28`
	`29`	`+ [Obsolete]`
`27`	`30`	`[Test]`
`28`	`31`	`[TestCase(EmptyString)]`
`29`	`32`	`[TestCase(WhiteSpaceString)]`