Merge pull request #21 from draconware-dev/dev

Version 1.4

Author: dragon7307

.editorconfig

@@ -51,7 +51,7 @@ csharp_style_var_elsewhere = false:suggestion
 dotnet_diagnostic.CA1001.severity = warning
 dotnet_diagnostic.CA1309.severity = warning
 dotnet_diagnostic.CA1510.severity = none
-csharp_style_prefer_primary_constructors = false:error
+csharp_style_prefer_primary_constructors = false:suggestion
 dotnet_diagnostic.CA1311.severity = warning
 dotnet_diagnostic.SYSLIB1054.severity = warning
 dotnet_diagnostic.CA1805.severity = suggestion
@@ -115,7 +115,7 @@ dotnet_style_object_initializer = true:suggestion
 dotnet_style_collection_initializer = true:suggestion
 dotnet_style_prefer_simplified_boolean_expressions = true:suggestion
 dotnet_style_prefer_conditional_expression_over_assignment = true:suggestion
-dotnet_style_prefer_conditional_expression_over_return = true:suggestion
+dotnet_style_prefer_conditional_expression_over_return = false:suggestion
 dotnet_style_operator_placement_when_wrapping = beginning_of_line
 tab_width = 4
 indent_size = 4

.gitattributes

@@ -0,0 +1,6 @@
+* text=auto
+
+*.cs text diff=csharp
+
+*.sln text eol=crlf merge=binary
+*.csproj merge=binary

.github/workflows/format.yml

@@ -0,0 +1,33 @@
+
+name: Format
+
+on:
+  push:
+    branches: [ "dev" ]
+
+permissions:
+  contents: write
+
+jobs:
+  format:
+
+    runs-on: ubuntu-latest
+        
+    steps:
+    - uses: actions/checkout@v4
+    - name: Setup .NET
+      uses: actions/setup-dotnet@v4
+      with:
+        dotnet-version: 8.0.x
+    - name: Restore dependencies
+      run: dotnet restore
+    - name: Build
+      run: dotnet build --no-restore
+    - name: Format
+      run: dotnet format style
+    - name: Commit & Push
+      run: |
+        git config --global user.name "github-actions[bot]"
+        git config --global user.email "github-actions[bot]@user.noreply.github.com"
+        git commit -a -m"formatted code" || true
+        git push

.github/workflows/publish.yml

@@ -0,0 +1,58 @@
+
+name: .NET
+
+on:
+  push:
+    branches: [ "main" ]
+
+jobs:
+  publish:
+
+    runs-on: ubuntu-latest
+        
+    steps:
+    - uses: actions/checkout@v4
+    - name: Setup .NET
+      uses: actions/setup-dotnet@v4
+      with:
+        dotnet-version: 8.0.x
+    - name: Restore dependencies
+      run: dotnet restore
+    - name: Build
+      run: dotnet build --no-restore
+    - name: Pack
+      run: dotnet pack --no-build --include-symbols -c Release  -p:SymbolPackageFormat=snupkg -o ${{github.workspace}}/Packages
+    - name: Upload Artifact
+      uses: actions/upload-artifact@v4
+      with:
+        name: nupkg
+        path: |
+          ${{github.workspace}}/Packages/*.nupkg
+          ${{github.workspace}}/Packages/*.snupkg   ,.
+    - name: Download Artifact
+      uses: actions/download-artifact@v4
+      with:
+        name: nupkg
+        path: |
+          ${{github.workspace}}/Packages/*.nupkg
+          ${{github.workspace}}/Packages/*.snupkg
+    - name: Extract Version
+      id: extract_version
+      uses: mavrosxristoforos/[email protected]
+      with:
+       xml-file: '{{github.workspace}}/src/SpanExtensions.csproj'
+       xpath: '/Project//PropertyGroup//Version'
+    - name: Store Environment Variable
+      run: echo "VERSION=v${{ steps.extract_version.outputs.info }}" >> $GITHUB_ENV
+    - name: Download release notes
+      run: curl -o release-notes.md https://drive.google.com/uc?export=download&id=1LdP8rvPZ9ra4mc4vmv3smcDwVD96Zwn8
+    - name: Create Tag
+      run: |
+        git tag -a ${{ env.VERSION }} -m"${{ env.VERSION }}"
+        git push origin ${{ env.VERSION }}
+    - name: Create Release
+      run: gh release create ${{ env.VERSION }} --title ${{ env.VERSION }} --notes-file release-notes.md ${{github.workspace}}/Packages/*.nupkg ${{github.workspace}}/Packages/*.snupkg
+      env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+    - name: Push To Nuget
+      run: dotnet nuget push "${{github.workspace}}/Packages/*.nupkg" -k ${{secrets.NUGET_API_KEY_SPANEXTENSIONS}} -s https://api.nuget.org/v3/index.json --skip-duplicate

.github/workflows/dotnet.yml renamed to .github/workflows/test.yml

@@ -5,13 +5,13 @@ on:
   push:
     branches: [ "main" ]
   pull_request:
-    branches: [ "dev" ]
+    branches: [ "dev", "main" ]
     paths:
     - '**.cs'
     - '**.csproj'
 
 jobs:
-  build:
+  test:
 
     runs-on: ubuntu-latest
 
@@ -26,4 +26,4 @@ jobs:
     - name: Build
       run: dotnet build --no-restore
     - name: Test
-      run: dotnet test --no-build --verbosity normal
+      run: dotnet test --no-build --verbosity normal --filter FullyQualifiedName!~SpanExtensions.Tests.Fuzzing

Changelog.md

@@ -3,7 +3,27 @@
 All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
-and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+and this project adheres not (yet) to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+ 
+
+## [1.4] - 2024-9-3
+
+### Added 
+
+- `(Readonly-)Span<T>.Count()`
+- `(Readonly-)Span<T>.Count(Predicate<T> predicate)`
+
+### Changed 
+
+- `Split` to throw an `ArgumentException` instead of an `InvalidCountExceedingBehaviourException`
+
+### Removed 
+
+- `InvalidCountExceedingBehaviourException`
+
+### Fixed 
+
+- various issues with `Split` (https://github.com/draconware-dev/SpanExtensions.Net/pull/11) 
 
 ## [1.3] - 2024-3-19
 

SpanExtensions.sln

@@ -5,6 +5,10 @@ VisualStudioVersion = 17.5.33627.172
 MinimumVisualStudioVersion = 10.0.40219.1
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "SpanExtensions", "src\SpanExtensions.csproj", "{75DE5AFD-663E-415D-9B95-6BC513BD4A07}"
 EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "UnitTests", "tests\unit-tests\UnitTests.csproj", "{B48A0293-A7FF-4E39-8F8D-57B6F824D70F}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "PerformanceTests", "tests\Performance\PerformanceTests.csproj", "{CE74F420-1038-4E51-AC31-00DA964CC4F5}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -15,6 +19,14 @@ Global
 		{75DE5AFD-663E-415D-9B95-6BC513BD4A07}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{75DE5AFD-663E-415D-9B95-6BC513BD4A07}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{75DE5AFD-663E-415D-9B95-6BC513BD4A07}.Release|Any CPU.Build.0 = Release|Any CPU
+		{B48A0293-A7FF-4E39-8F8D-57B6F824D70F}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{B48A0293-A7FF-4E39-8F8D-57B6F824D70F}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{B48A0293-A7FF-4E39-8F8D-57B6F824D70F}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{B48A0293-A7FF-4E39-8F8D-57B6F824D70F}.Release|Any CPU.Build.0 = Release|Any CPU
+		{CE74F420-1038-4E51-AC31-00DA964CC4F5}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{CE74F420-1038-4E51-AC31-00DA964CC4F5}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{CE74F420-1038-4E51-AC31-00DA964CC4F5}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{CE74F420-1038-4E51-AC31-00DA964CC4F5}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE

src/CountExceedingBehaviour.cs

@@ -1,16 +1,16 @@
 namespace SpanExtensions
 {
     /// <summary>
-    /// Defines the behaviour of a split operation when there are more split instances than there may be. 
+    /// Defines the behaviour of a split operation when there are more split instances than there may be.
     /// </summary>
     public enum CountExceedingBehaviour
     {
         /// <summary>
-        /// The last element returned will be all the remaining elements appended as one.
+        /// The last split returned will include all the remaining elements.
         /// </summary>
         AppendRemainingElements,
         /// <summary>
-        /// Every split instance more than permitted will not be returned. 
+        /// Splits after the desired split count will be cut.
         /// </summary>
         CutRemainingElements
     }

src/Enumerators/Split/SpanSplitEnumerator.cs

@@ -10,7 +10,8 @@ namespace SpanExtensions.Enumerators
     {
         ReadOnlySpan<T> Span;
         readonly T Delimiter;
-        bool enumerationDone;
+        const int DelimiterLength = 1;
+        bool EnumerationDone;
 
         /// <summary>
         /// Gets the element in the collection at the current position of the enumerator.
@@ -26,8 +27,8 @@ public SpanSplitEnumerator(ReadOnlySpan<T> source, T delimiter)
         {
             Span = source;
             Delimiter = delimiter;
+            EnumerationDone = false;
             Current = default;
-            enumerationDone = false;
         }
 
         /// <summary>
@@ -44,22 +45,25 @@ public readonly SpanSplitEnumerator<T> GetEnumerator()
         /// <returns><see langword="true"/> if the enumerator was successfully advanced to the next element; <see langword="false"/> if the enumerator has passed the end of the collection.</returns>
         public bool MoveNext()
         {
-            if(enumerationDone)
+            if(EnumerationDone)
             {
                 return false;
             }
 
-            ReadOnlySpan<T> span = Span;
-            int index = span.IndexOf(Delimiter);
+            int delimiterIndex = Span.IndexOf(Delimiter);
 
-            if(index == -1 || index >= span.Length)
+            if(delimiterIndex == -1)
             {
-                enumerationDone = true;
-                Current = span;
+                EnumerationDone = true;
+
+                Current = Span;
+
                 return true;
             }
-            Current = span[..index];
-            Span = span[(index + 1)..];
+
+            Current = Span[..delimiterIndex];
+            Span = Span[(delimiterIndex + DelimiterLength)..];
+
             return true;
         }
     }

src/Enumerators/Split/SpanSplitStringSplitOptionsEnumerator.cs

@@ -9,8 +9,10 @@ public ref struct SpanSplitStringSplitOptionsEnumerator
     {
         ReadOnlySpan<char> Span;
         readonly char Delimiter;
-        readonly StringSplitOptions Options;
-        bool enumerationDone;
+        const int DelimiterLength = 1;
+        readonly bool TrimEntries;
+        readonly bool RemoveEmptyEntries;
+        bool EnumerationDone;
 
         /// <summary>
         /// Gets the element in the collection at the current position of the enumerator.
@@ -25,11 +27,14 @@ public ref struct SpanSplitStringSplitOptionsEnumerator
         /// <param name="options">A bitwise combination of the enumeration values that specifies whether to trim results and include empty results.</param>
         public SpanSplitStringSplitOptionsEnumerator(ReadOnlySpan<char> source, char delimiter, StringSplitOptions options)
         {
+            ExceptionHelpers.ThrowIfInvalid(options, nameof(options));
+
             Span = source;
             Delimiter = delimiter;
-            Options = options;
+            TrimEntries = options.HasFlag((StringSplitOptions)2); // StringSplitOptions.TrimEntries
+            RemoveEmptyEntries = options.HasFlag(StringSplitOptions.RemoveEmptyEntries);
+            EnumerationDone = false;
             Current = default;
-            enumerationDone = false;
         }
 
         /// <summary>
@@ -46,49 +51,44 @@ public readonly SpanSplitStringSplitOptionsEnumerator GetEnumerator()
         /// <returns><see langword="true"/> if the enumerator was successfully advanced to the next element; <see langword="false"/> if the enumerator has passed the end of the collection.</returns>
         public bool MoveNext()
         {
-            if(enumerationDone)
+            if(EnumerationDone)
             {
                 return false;
             }
 
-            ReadOnlySpan<char> span = Span;
-            int index = span.IndexOf(Delimiter);
-
-            if(index == -1 || index >= span.Length)
-            {
-                enumerationDone = true;
-                Current = span;
-                return true;
-            }
-            Current = span[..index];
-#if NET5_0_OR_GREATER
-            if(Options.HasFlag(StringSplitOptions.TrimEntries))
-            {
-                Current = Current.Trim();
-            }
-#endif
-            if(Options.HasFlag(StringSplitOptions.RemoveEmptyEntries))
+            while(true) // if RemoveEmptyEntries options flag is set, repeat until a non-empty span is found, or the end is reached
             {
-                if(Current.IsEmpty)
+                int delimiterIndex = Span.IndexOf(Delimiter);
+
+                if(delimiterIndex == -1)
                 {
-                    Span = span[(index + 1)..];
-                    if(Span.IsEmpty)
+                    EnumerationDone = true;
+
+                    Current = Span;
+
+                    if(TrimEntries)
                     {
-                        enumerationDone = true;
-                        return false;
+                        Current = Current.Trim();
                     }
-                    return MoveNext();
+
+                    return !(RemoveEmptyEntries && Current.IsEmpty);
+                }
+
+                Current = Span[..delimiterIndex];
+                Span = Span[(delimiterIndex + DelimiterLength)..];
+
+                if(TrimEntries)
+                {
+                    Current = Current.Trim();
                 }
 
-                Span = span[(index + 1)..];
-                if(Span.IsEmpty)
+                if(RemoveEmptyEntries && Current.IsEmpty)
                 {
-                    enumerationDone = true;
+                    continue;
                 }
+
                 return true;
             }
-            Span = span[(index + 1)..];
-            return true;
         }
     }
 }