Merge pull request #9 from FriedrichWeinmann/development

1.1.5

Author: FriedrichWeinmann

changelog.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 1.1.5 (2024-03-11)
+
++ Upd: Set-String - added `-Case` parameter to allow setting the string casing
++ Fix: Add-String - throws when providing an empty array as input
+
 ## 1.1.3 (2023-01-20)
 
 + Upd: Set-String - now accepts file info objects and replaces their content

docs/Set-String.md

@@ -12,28 +12,18 @@ Implements string replacement in the pipeline.
 
 ## SYNTAX
 
-### regexString (Default)
+### regex (Default)
 ```
-Set-String [-OldValue] <String> [[-NewValue] <Object>] [-Options <RegexOptions>]
- [-InputFile <FileSystemInfo[]>] [-InputString <String[]>] [-Force] [<CommonParameters>]
+Set-String [-OldValue] <String> [[-NewValue] <Object>] [-Options <RegexOptions>] [-Case <Case>]
+ [-InputFile <FileSystemInfo[]>] [-InputString <String[]>] [-Force]
+ [<CommonParameters>]
 ```
 
-### simpleString
+### simple
 ```
-Set-String [-OldValue] <String> [[-NewValue] <Object>] [-DoNotUseRegex] [-InputFile <FileSystemInfo[]>]
- [-InputString <String[]>] [-Force] [<CommonParameters>]
-```
-
-### simpleFile
-```
-Set-String [-OldValue] <String> [[-NewValue] <Object>] [-DoNotUseRegex] [-InputFile <FileSystemInfo[]>]
- [-InputString <String[]>] [-Force] [<CommonParameters>]
-```
-
-### regexFile
-```
-Set-String [-OldValue] <String> [[-NewValue] <Object>] [-Options <RegexOptions>]
- [-InputFile <FileSystemInfo[]>] [-InputString <String[]>] [-Force] [<CommonParameters>]
+Set-String [-OldValue] <String> [[-NewValue] <Object>] [-DoNotUseRegex] [-Case <Case>]
+ [-InputFile <FileSystemInfo[]>] [-InputString <String[]>] [-Force]
+ [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -100,7 +90,7 @@ Useful when trying to not do escapes and not depending on regex.
 
 ```yaml
 Type: SwitchParameter
-Parameter Sets: simpleString, simpleFile
+Parameter Sets: simple
 Aliases: simple
 
 Required: False
@@ -163,7 +153,7 @@ Defaults to IgnoreCase, enabling the default PowerShell -replace behavior.
 
 ```yaml
 Type: RegexOptions
-Parameter Sets: regexString, regexFile
+Parameter Sets: regex
 Aliases:
 Accepted values: None, IgnoreCase, Multiline, ExplicitCapture, Compiled, Singleline, IgnorePatternWhitespace, RightToLeft, ECMAScript, CultureInvariant
 
@@ -174,6 +164,23 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
+### -Case
+What case to set the values provided to.
+Can be Lower, Upper or Title.
+Note: Be careful about using this parameter with files, as it will happily change the case of all text in a file.
+
+```yaml
+Type: Case
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ### -Force
 When replacing text in files, common binary and media files will be ignored.
 This detection is based on extension of the file.

src/StringModule/Case.cs

@@ -0,0 +1,32 @@
+using System;
+using System.Collections.Generic;
+using System.Text;
+
+namespace StringModule
+{
+    /// <summary>
+    /// The different string casings
+    /// </summary>
+    public enum Case
+    {
+        /// <summary>
+        /// No case preference was specified
+        /// </summary>
+        Unspecified = 1,
+
+        /// <summary>
+        /// All letters should be converted to uppercase
+        /// </summary>
+        Upper = 2,
+
+        /// <summary>
+        /// All letters should be converted to lowercase
+        /// </summary>
+        Lower = 3,
+
+        /// <summary>
+        /// Only the first letter of a word should be uppercase
+        /// </summary>
+        Title = 4
+    }
+}

src/StringModule/Commands/AddStringCommand.cs

@@ -57,6 +57,9 @@ public sealed class AddStringCommand : PSCmdlet
         /// </summary>
         protected override void ProcessRecord()
         {
+            if (InputString == null)
+                return;
+
             foreach (string line in InputString)
                 if (ParameterSetName == "wrap")
                     WriteObject(String.Format("{0}{1}{2}", Before, line, Behind));

src/StringModule/Commands/SetStringCommand.cs

@@ -1,4 +1,5 @@
 using System;
+using System.Globalization;
 using System.IO;
 using System.Linq;
 using System.Management.Automation;
@@ -42,6 +43,12 @@ public class SetStringCommand : PSCmdlet
         [Parameter(ParameterSetName = "regex")]
         public RegexOptions Options = RegexOptions.IgnoreCase;
 
+        /// <summary>
+        /// What case should be applied
+        /// </summary>
+        [Parameter()] 
+        public Case Case = Case.Unspecified;
+
         /// <summary>
         /// The files to replace in
         /// </summary>
@@ -119,12 +126,7 @@ protected override void ProcessRecord()
 
             foreach (string item in InputString)
             {
-                if (DoNotUseRegex.ToBool())
-                    WriteObject(item.Replace(OldValue, StringValue));
-                else if (ScriptBlockValue != null)
-                    WriteObject(Regex.Replace(item, OldValue, ScriptBlockEvaluator, Options));
-                else
-                    WriteObject(Regex.Replace(item, OldValue, StringValue, Options));
+                WriteObject(Transform(item));
             }
 
             if (InputFile == null)
@@ -149,12 +151,7 @@ protected override void ProcessRecord()
                     continue;
                 }
 
-                if (DoNotUseRegex.ToBool())
-                    content = content.Replace(OldValue, StringValue);
-                else if (ScriptBlockValue != null)
-                    content = Regex.Replace(content, OldValue, ScriptBlockEvaluator, Options);
-                else
-                    content = Regex.Replace(content, OldValue, StringValue, Options);
+                content = Transform(content);
 
                 try { File.WriteAllText(info.FullName, content, GetFileEncoding(info.FullName)); }
                 catch (Exception e)
@@ -168,6 +165,34 @@ protected override void ProcessRecord()
         #endregion Methods
 
         #region Utility
+        /// <summary>
+        /// Centralizes the input conversion, respecting the parameters specified
+        /// </summary>
+        /// <param name="Value">The value to convert</param>
+        /// <returns>The converted value</returns>
+        private string Transform(string Value)
+        {
+            string transformed = Value;
+            if (DoNotUseRegex.ToBool())
+                transformed = Value.Replace(OldValue, StringValue);
+            else if (ScriptBlockValue != null)
+                transformed = Regex.Replace(transformed, OldValue, ScriptBlockEvaluator, Options);
+            else
+                transformed = Regex.Replace(transformed, OldValue, StringValue, Options);
+
+            if (Case == Case.Unspecified)
+                return transformed;
+
+            if (Case == Case.Lower)
+                return transformed.ToLower();
+            if (Case == Case.Upper)
+                return transformed.ToUpper();
+            if (Case == Case.Title)
+                return CultureInfo.CurrentCulture.TextInfo.ToTitleCase(transformed);
+
+            return transformed;
+        }
+
         /// <summary>
         /// Returns the assumeed encoding of the file specified, defaults to UTF8.
         /// </summary>