Implemented support of delimiter options

.appveyor.yml

@@ -57,7 +57,8 @@ init:
 install:
 - ps: |
       Execute-Action "installing tools" {
-          choco install codecov msbuild-sonarqube-runner opencover.portable
+          choco install codecov opencover.portable -y
+          dotnet tool install --global dotnet-sonarscanner
       }
 
 dotnet_csproj:
@@ -74,19 +75,10 @@ before_build:
 - ps: |
       Execute-Action "beginning code analysis" {
           if ($env:APPVEYOR_PULL_REQUEST_NUMBER) {
-              # For security reasons, AppVeyor only exposes secure variables for pull requests from the same repositoy.
-              # If $env:SONARQUBE_GITHUB_TOKEN is not set, then it is a pull request from another repository and we'll
-              # skip SonarQube analysis.
-              if ($env:SONARQUBE_GITHUB_TOKEN) {
-                  MSBuild.SonarQube.Runner.exe begin /o:$env:SONARQUBE_ORGANIZATION /k:$env:APPVEYOR_PROJECT_NAME /v:$env:APPVEYOR_BUILD_VERSION /d:sonar.host.url=https://sonarcloud.io /d:sonar.login=$env:SONARQUBE_TOKEN /d:sonar.cs.opencover.reportsPaths=coverage.xml /d:sonar.coverage.exclusions=**/*Tests.cs,**/*Tests.*.cs,**/*Mock.cs /d:sonar.github.pullRequest=$env:APPVEYOR_PULL_REQUEST_NUMBER /d:sonar.github.repository=$env:APPVEYOR_REPO_NAME /d:sonar.github.oauth=$env:SONARQUBE_GITHUB_TOKEN
-
-                  $env:SONARQUBE_RUNNING = $true
-              }
+              dotnet sonarscanner begin /o:$env:SONARQUBE_ORGANIZATION /k:$env:APPVEYOR_PROJECT_NAME /v:$env:APPVEYOR_BUILD_VERSION /d:sonar.host.url=https://sonarcloud.io /d:sonar.login=$env:SONARQUBE_TOKEN /d:sonar.cs.opencover.reportsPaths=coverage.xml /d:sonar.coverage.exclusions=**/*Tests.cs /d:sonar.github.pullRequest=$env:APPVEYOR_PULL_REQUEST_NUMBER /d:sonar.github.repository=$env:APPVEYOR_REPO_NAME /d:sonar.github.oauth=$env:SONARQUBE_GITHUB_TOKEN
           }
           else {
-              MSBuild.SonarQube.Runner.exe begin /o:$env:SONARQUBE_ORGANIZATION /k:$env:APPVEYOR_PROJECT_NAME /v:$env:APPVEYOR_BUILD_VERSION /d:sonar.host.url=https://sonarcloud.io /d:sonar.login=$env:SONARQUBE_TOKEN /d:sonar.cs.opencover.reportsPaths=coverage.xml /d:sonar.coverage.exclusions=**/*Tests.cs,**/*Tests.*.cs,**/*Mock.cs
-
-              $env:SONARQUBE_RUNNING = $true
+              dotnet sonarscanner begin /o:$env:SONARQUBE_ORGANIZATION /k:$env:APPVEYOR_PROJECT_NAME /v:$env:APPVEYOR_BUILD_VERSION /d:sonar.host.url=https://sonarcloud.io /d:sonar.login=$env:SONARQUBE_TOKEN /d:sonar.cs.opencover.reportsPaths=coverage.xml /d:sonar.coverage.exclusions=**/*Tests.cs
           }
       }
 
@@ -134,9 +126,7 @@ after_test:
 
 - ps: |
       Execute-Action "ending code analysis" {
-          if ($env:SONARQUBE_RUNNING -eq $true) {
-              MSBuild.SonarQube.Runner.exe end /d:sonar.login=$env:SONARQUBE_TOKEN
-          }
+          dotnet sonarscanner end /d:sonar.login=$env:SONARQUBE_TOKEN
       }
 
 artifacts:

src/PartialResponse.Core/DelimiterOptions.cs

@@ -0,0 +1,95 @@
+// Copyright (c) Arjen Post and contributors. See LICENSE in the project root for license information.
+
+using System;
+using System.Collections.Generic;
+
+namespace PartialResponse.Core
+{
+    /// <summary>
+    /// Represents delimiter options for parser
+    /// </summary>
+    public class DelimiterOptions
+    {
+        private static DelimiterOptions defaultOptions;
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="DelimiterOptions"/> class.
+        /// </summary>
+        /// <param name="fieldsDelimiters">Characters representing field delimiters.</param>
+        /// <param name="nestedFieldDelimiters">Characters representing nested field delimiters.</param>
+        /// <param name="fieldGroupStartDelimiters">Characters representing field group start delimiters.</param>
+        /// <param name="fieldGroupEndDelimiters">Characters representing field group end delimiters.</param>
+        public DelimiterOptions(char[] fieldsDelimiters, char[] nestedFieldDelimiters, char[] fieldGroupStartDelimiters, char[] fieldGroupEndDelimiters)
+        {
+            var map = new Dictionary<char, TokenType>();
+
+            foreach (var c in fieldsDelimiters ?? throw new ArgumentNullException(nameof(fieldsDelimiters)))
+            {
+                map.Add(c, TokenType.FieldsDelimiter);
+            }
+
+            foreach (var c in nestedFieldDelimiters ?? throw new ArgumentNullException(nameof(nestedFieldDelimiters)))
+            {
+                map.Add(c, TokenType.NestedFieldDelimiter);
+            }
+
+            foreach (var c in fieldGroupStartDelimiters ?? throw new ArgumentNullException(nameof(fieldGroupStartDelimiters)))
+            {
+                map.Add(c, TokenType.FieldGroupStartDelimiter);
+            }
+
+            foreach (var c in fieldGroupEndDelimiters ?? throw new ArgumentNullException(nameof(fieldGroupEndDelimiters)))
+            {
+                map.Add(c, TokenType.FieldGroupEndDelimiter);
+            }
+
+            this.DelimiterToTokenTypeMap = map;
+
+            this.FieldsDelimiters = fieldsDelimiters;
+            this.NestedFieldDelimiters = nestedFieldDelimiters;
+            this.FieldGroupStartDelimiters = fieldGroupStartDelimiters;
+            this.FieldGroupEndDelimiters = fieldGroupEndDelimiters;
+        }
+
+        /// <summary>
+        /// Gets default options for parser. Default options are:
+        ///   field delimiters - ','
+        ///   nested field delimiters - '/'
+        ///   field group start delimiters - '('
+        ///   field group end delimiters - ')'
+        /// </summary>
+        public static DelimiterOptions DefaultOptions
+        {
+            get
+            {
+                return defaultOptions
+                    ?? (defaultOptions = new DelimiterOptions(new[] { ',' }, new[] { '/' }, new[] { '(' }, new[] { ')' }));
+            }
+        }
+
+        /// <summary>
+        /// Gets delimiter to token type map.
+        /// </summary>
+        public IReadOnlyDictionary<char, TokenType> DelimiterToTokenTypeMap { get; }
+
+        /// <summary>
+        /// Gets fields delimiters.
+        /// </summary>
+        public char[] FieldsDelimiters { get; }
+
+        /// <summary>
+        /// Gets nested field delimiters.
+        /// </summary>
+        public char[] NestedFieldDelimiters { get; }
+
+        /// <summary>
+        /// Gets nested field group start delimiters.
+        /// </summary>
+        public char[] FieldGroupStartDelimiters { get; }
+
+        /// <summary>
+        /// Gets nested field group end delimiters.
+        /// </summary>
+        public char[] FieldGroupEndDelimiters { get; }
+    }
+}

src/PartialResponse.Core/Field.cs

@@ -1,6 +1,7 @@
-// Copyright (c) Arjen Post. See LICENSE in the project root for license information.
+// Copyright (c) Arjen Post and contributors. See LICENSE in the project root for license information.
 
 using System;
+using System.Linq;
 
 namespace PartialResponse.Core
 {
@@ -16,15 +17,20 @@ public struct Field
         /// <summary>
         /// Initializes a new instance of the <see cref="Field"/> structure.
         /// </summary>
-        /// <param name="value">The value of the field.</param>
-        public Field(string value)
+        /// <param name="parts">The value of the field.</param>
+        public Field(params string[] parts)
         {
-            if (value == null)
+            if (parts == null)
+            {
+                throw new ArgumentNullException(nameof(parts));
+            }
+
+            if (parts.Length == 0 || parts.Any(string.IsNullOrEmpty))
             {
-                throw new ArgumentNullException(nameof(value));
+                throw new ArgumentException("Parts cannot be empty or null", nameof(parts));
             }
 
-            this.Parts = value.Split('/');
+            this.Parts = parts;
         }
 
         /// <summary>
@@ -77,14 +83,5 @@ public bool Matches(string[] parts, bool ignoreCase)
 
             return true;
         }
-
-        /// <summary>
-        /// Returns a string that represents the current object.
-        /// </summary>
-        /// <returns>A string that represents the current object.</returns>
-        public override string ToString()
-        {
-            return string.Join("/", this.Parts);
-        }
     }
 }

src/PartialResponse.Core/Fields.cs

@@ -1,4 +1,4 @@
-// Copyright (c) Arjen Post. See LICENSE in the project root for license information.
+// Copyright (c) Arjen Post and contributors. See LICENSE in the project root for license information.
 
 using System;
 using System.Collections.Generic;
@@ -14,7 +14,7 @@ namespace PartialResponse.Core
     /// from your code.</remarks>
     public struct Fields
     {
-        private IEnumerable<Field> values;
+        private readonly IEnumerable<Field> values;
 
         private Fields(IEnumerable<Field> values)
         {
@@ -36,8 +36,10 @@ public IEnumerable<Field> Values
         /// <param name="value">The value.</param>
         /// <param name="result">When this method returns, contains the <see cref="Fields"/> equivalent of the value,
         /// if the conversion succeeded, or null if the conversion failed.</param>
+        /// <param name="options">Optional options which allow to specify custom delimiters. If no value provided
+        /// a default options <see cref="DelimiterOptions.DefaultOptions"/> are used.</param>
         /// <returns>true if value was converted successfully; otherwise, false.</returns>
-        public static bool TryParse(string value, out Fields result)
+        public static bool TryParse(string value, out Fields result, DelimiterOptions options = null)
         {
             if (value == null)
             {
@@ -46,7 +48,7 @@ public static bool TryParse(string value, out Fields result)
 
             using (var reader = new StringReader(value))
             {
-                var context = new ParserContext(reader);
+                var context = new ParserContext(reader, options ?? DelimiterOptions.DefaultOptions);
                 var parser = new Parser(context);
 
                 parser.Parse();
@@ -68,26 +70,36 @@ public static bool TryParse(string value, out Fields result)
         /// Indicates whether a field matches the specified value.
         /// </summary>
         /// <param name="value">The value to match.</param>
+        /// <param name="delimiterOptions">Delimiter options to use when matching. If no options provided then the
+        /// default options <see cref="DelimiterOptions.DefaultOptions"/> are used.</param>
         /// <returns>true if a field matches the specified value; otherwise, false.</returns>
-        public bool Matches(string value)
+        public bool Matches(string value, DelimiterOptions delimiterOptions = null)
         {
-            return this.Matches(value, false);
+            return this.Matches(value, false, delimiterOptions);
         }
 
         /// <summary>
         /// Indicates whether a field matches the specified value.
         /// </summary>
         /// <param name="value">The value to match.</param>
         /// <param name="ignoreCase">A value which indicates whether matching should be case-insensitive.</param>
+        /// <param name="delimiterOptions">Delimiter options to use when matching. If no options provided then the
+        /// default options <see cref="DelimiterOptions.DefaultOptions"/> are used.</param>
         /// <returns>true if a field matches the specified value; otherwise, false.</returns>
-        public bool Matches(string value, bool ignoreCase)
+        public bool Matches(string value, bool ignoreCase, DelimiterOptions delimiterOptions = null)
         {
             if (value == null)
             {
                 throw new ArgumentNullException(nameof(value));
             }
 
-            var parts = value.Split('/');
+            if (!this.Values.Any())
+            {
+                return false;
+            }
+
+            var separators = (delimiterOptions ?? DelimiterOptions.DefaultOptions).NestedFieldDelimiters;
+            var parts = value.Split(separators);
 
             return this.Values.Any(field => field.Matches(parts, ignoreCase));
         }