Merge pull request #14 from TechNobre/develop

Deploy nuget version 2.1.0 - Added extension `string.ToSnakeCase()`;

Author: NelsonBN

.github/workflows/publish-nuget.yml

@@ -16,9 +16,9 @@ jobs:
     - uses: actions/checkout@main
 
     - name: Setup .NET
-      uses: actions/setup-dotnet@v1
+      uses: actions/setup-dotnet@v2
       with:
-        dotnet-version: '6.0.x'
+        dotnet-version: '6.0.200'
 
     - name: Restore dependencies
       run: dotnet restore

.github/workflows/sonarcloud.yml

@@ -18,29 +18,30 @@ jobs:
     steps:
 
     - name: Setup .NET
-      uses: actions/setup-dotnet@v1
+      uses: actions/setup-dotnet@v2
       with:
-        dotnet-version: '6.0.x'
+        dotnet-version: '6.0.200'
 
     - name: Set up JDK 11
-      uses: actions/setup-java@v1
+      uses: actions/setup-java@v3.0.0
       with:
-        java-version: 1.11
+        distribution: 'adopt'
+        java-version: '11'
 
     - uses: actions/checkout@v2
       with:
         fetch-depth: 0  # Shallow clones should be disabled for a better relevancy of analysis
 
     - name: Cache SonarCloud packages
-      uses: actions/cache@v1
+      uses: actions/cache@v2.1.7
       with:
         path: ~\sonar\cache
         key: ${{ runner.os }}-sonar
         restore-keys: ${{ runner.os }}-sonar
 
     - name: Cache SonarCloud scanner
       id: cache-sonar-scanner
-      uses: actions/cache@v1
+      uses: actions/cache@v2.1.7
       with:
         path: .\.sonar\scanner
         key: ${{ runner.os }}-sonar-scanner

.github/workflows/test-project.yml

@@ -20,9 +20,9 @@ jobs:
     - uses: actions/checkout@v2
 
     - name: Setup .NET
-      uses: actions/setup-dotnet@v1
+      uses: actions/setup-dotnet@v2
       with:
-        dotnet-version: '6.0.x'
+        dotnet-version: '6.0.200'
 
     - name: Restore dependencies
       run: dotnet restore

CHANGELOG.md

@@ -3,6 +3,22 @@
 
 
 
+## [2.1.0] - 2022-03-04
+[Full Changelog](https://github.com/TechNobre/PowerUtils.Text/compare/v2.0.0...v2.1.0)
+
+
+### New Features
+
+- Added extension `string.ToSnakeCase()`;
+
+
+#### Enhancements
+
+- Simplified code;
+
+
+
+
 ## [2.0.0] - 2022-02-10
 [Full Changelog](https://github.com/TechNobre/PowerUtils.Text/compare/v1.2.0...v2.0.0)
 

README.md

@@ -31,6 +31,7 @@ Helpers, extensions and utilities for manipulating
   - [CleanSpecialCharacters](#string.CleanSpecialCharacters)
   - [UppercaseFirst](#string.UppercaseFirst)
   - [LowercaseFirst](#string.LowercaseFirst)
+  - [ToSnakeCase](#string.ToSnakeCase)
 - [NetworkExtensions](#NetworkExtensions)
   - [IsEmail](#string.IsEmail)
   - [CombineURL](#string.CombineURL)
@@ -142,6 +143,14 @@ Uppercase the first character
 var result = "Hello world!!!".UppercaseFirst();
 ```
 
+#### string.ToSnakeCase(); <a name="string.ToSnakeCase"></a>
+Convert a text to snake case format
+
+```csharp
+// result = "test_snake_case"
+var result = "TestSnakeCase".ToSnakeCase();
+```
+
 
 
 ### TextExtensions <a name="TextExtensions"></a>

global.json

@@ -1,5 +1,5 @@
 {
   "sdk": {
-    "version": "6.0.100"
+    "version": "6.0.200"
   }
 }

src/PowerUtils.Text.csproj

@@ -14,21 +14,18 @@
     <PackageId>PowerUtils.Text</PackageId>
     <title>PowerUtils.Text</title>
     <Product>PowerUtils.Text</Product>
-    <Version>2.0.0</Version>
+    <Version>2.1.0</Version>
 
     <Authors>Nelson Nobre</Authors>
     <Company>TechNobre</Company>
 
     <License>MIT</License>
     <PackageLicenseFile>LICENSE</PackageLicenseFile>
-    <Copyright>Copyright © 2018 by TechNobre</Copyright>
+    <Copyright>Copyright © 2022 by TechNobre</Copyright>
 
     <Description>Helpers, extensions and utilities for manipulating strings</Description>
     <PackageReleaseNotes>
-      Added extension `string.IsEmail()`;
-      Added extension `string.CombineURL()`;
-      Added extension `object.ToQueryString()`;
-      Discontinued the extension `string.EmptyOrWhiteSpace()`. New method `string.EmptyOrWhiteSpaceToNull()`;
+      Added extension `string.ToSnakeCase()`;
     </PackageReleaseNotes>
     <Summary>Helpers, extensions and utilities for manipulating strings</Summary>
     <PackageTags>PowerUtils;Utils;Helpers;Text;Formatting;Extension;Extensions;String</PackageTags>

src/TextExtensions.cs

@@ -1,4 +1,5 @@
 using System;
+using System.Globalization;
 using System.Linq;
 using System.Text;
 using System.Text.RegularExpressions;
@@ -142,14 +143,9 @@ public static string Truncate(this string input, int maxLength)
         /// <returns>Capitalized name</returns>
         public static string CapitalizeName(this string input)
         {
-            if(input == null)
-            {
-                return null;
-            }
-
-            if(input == "")
+            if(string.IsNullOrEmpty(input))
             {
-                return "";
+                return input;
             }
 
             var splitedText = string
@@ -225,14 +221,9 @@ public static string CleanSpecialCharacters(this string input, string substitute
         /// <returns>New string</returns>
         public static string UppercaseFirst(this string input)
         {
-            if(input == null)
-            {
-                return null;
-            }
-
-            if(input == "")
+            if(string.IsNullOrEmpty(input))
             {
-                return "";
+                return input;
             }
 
             var charArray = input.ToCharArray();
@@ -247,19 +238,92 @@ public static string UppercaseFirst(this string input)
         /// <returns>Text transformed</returns>
         public static string LowercaseFirst(this string input)
         {
-            if(input == null)
-            {
-                return null;
-            }
-
-            if(input == "")
+            if(string.IsNullOrEmpty(input))
             {
-                return "";
+                return input;
             }
 
             var charArray = input.ToCharArray();
             charArray[0] = char.ToLower(charArray[0]);
             return new string(charArray);
         }
+
+        /// <summary>
+        /// Convert a text to snake case format
+        /// </summary>
+        /// <param name="input">Text to be transformed</param>
+        /// <returns>Text transformed</returns>
+        public static string ToSnakeCase(this string input)
+        { // Reference1: https://stackoverflow.com/questions/63055621/how-to-convert-camel-case-to-snake-case-with-two-capitals-next-to-each-other
+          // Reference1: https://github.com/efcore/EFCore.NamingConventions/blob/main/EFCore.NamingConventions/Internal/SnakeCaseNameRewriter.cs
+            if(string.IsNullOrEmpty(input))
+            {
+                return input;
+            }
+
+            var builder = new StringBuilder(input.Length + Math.Min(2, input.Length / 5));
+            var previousCategory = default(UnicodeCategory?);
+
+            for(var currentIndex = 0; currentIndex < input.Length; currentIndex++)
+            {
+                var currentChar = input[currentIndex];
+                if(currentChar == '_')
+                {
+                    builder.Append('_');
+                    previousCategory = null;
+                    continue;
+                }
+
+                var currentCategory = char.GetUnicodeCategory(currentChar);
+                switch(currentCategory)
+                {
+                    case UnicodeCategory.UppercaseLetter:
+                    case UnicodeCategory.TitlecaseLetter:
+                        _snakeCaseHandleUppercaseLetterAndTitlecaseLetter(
+                            input,
+                            currentIndex,
+                            previousCategory,
+                            builder
+                        );
+
+                        currentChar = char.ToLower(currentChar, CultureInfo.InvariantCulture);
+                        break;
+
+                    case UnicodeCategory.LowercaseLetter:
+                    case UnicodeCategory.DecimalDigitNumber:
+                        if(previousCategory == UnicodeCategory.SpaceSeparator)
+                        {
+                            builder.Append('_');
+                        }
+                        break;
+
+                    default:
+                        if(previousCategory != null)
+                        {
+                            previousCategory = UnicodeCategory.SpaceSeparator;
+                        }
+                        continue;
+                }
+
+                builder.Append(currentChar);
+                previousCategory = currentCategory;
+            }
+
+            return builder.ToString();
+        }
+
+        private static void _snakeCaseHandleUppercaseLetterAndTitlecaseLetter(string input, int currentIndex, UnicodeCategory? previousCategory, StringBuilder builder)
+        {
+            if(previousCategory == UnicodeCategory.SpaceSeparator ||
+                previousCategory == UnicodeCategory.LowercaseLetter ||
+                (previousCategory != UnicodeCategory.DecimalDigitNumber &&
+                previousCategory != null &&
+                currentIndex > 0 &&
+                currentIndex + 1 < input.Length &&
+                char.IsLower(input[currentIndex + 1])))
+            {
+                builder.Append('_');
+            }
+        }
     }
 }

tests/PowerUtils.Text.Tests/PowerUtils.Text.Tests.csproj

@@ -20,8 +20,8 @@
 
 
   <ItemGroup>
-    <PackageReference Include="FluentAssertions" Version="6.4.0" />
-    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.0.0" />
+    <PackageReference Include="FluentAssertions" Version="6.5.1" />
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.1.0" />
     <PackageReference Include="xunit" Version="2.4.1" />
     <PackageReference Include="xunit.runner.visualstudio" Version="2.4.3">
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>

tests/PowerUtils.Text.Tests/TextExtensionsTests/ToSnakeCaseTests.cs

@@ -0,0 +1,40 @@
+namespace PowerUtils.Text.Tests.TextExtensionsTests;
+
+[Trait("Extension", "ToSnakeCase")]
+public class ToSnakeCaseTests
+{
+    [Theory(DisplayName = "Converto a text to snake case")]
+    [InlineData(null, null)]
+    [InlineData("", "")]
+    [InlineData("TestSC", "test_sc")]
+    [InlineData("testSC", "test_sc")]
+    [InlineData("TestSnakeCase", "test_snake_case")]
+    [InlineData("testSnakeCase", "test_snake_case")]
+    [InlineData("TestSnakeCase123", "test_snake_case123")]
+    [InlineData("_testSnakeCase123", "_test_snake_case123")]
+    [InlineData("test_SC", "test_sc")]
+    [InlineData("Test", "test")]
+    [InlineData("TEST", "test")]
+    [InlineData("Test Snake Case", "test_snake_case")]
+    [InlineData("TEST SNAKE CASE", "test_snake_case")]
+    [InlineData("Test  Snake Case", "test_snake_case")]
+    [InlineData("Test SnakeCase", "test_snake_case")]
+    [InlineData("Test Snake111 Case", "test_snake111_case")]
+    [InlineData("TEST SNAKE111 CASE", "test_snake111_case")]
+    [InlineData("Test Snake Case 111", "test_snake_case_111")]
+    [InlineData("Test 123 Case 111", "test_123_case_111")]
+    [InlineData("Test123 Case 111", "test123_case_111")]
+    [InlineData("Test 123Case 111", "test_123case_111")]
+    [InlineData("Test 123Case__", "test_123case__")]
+    [InlineData("Test 123Case1__", "test_123case1__")]
+    public void ToSnakeCase(string input, string expected)
+    {
+        // Arrange &&  Act
+        var act = input.ToSnakeCase();
+
+
+        // Assert
+        act.Should()
+            .Be(expected);
+    }
+}