Merge pull request #14 from adriangodong/add-fragment-extensions

Add extension methods to add URL fragments

Readme.md

@@ -19,6 +19,7 @@ new UriBuilder()
          .WithHost("awesome.com")
          .WithPathSegment("seg")
          .UseHttps()
+         .Uri
          .ToString()
 
 ```
@@ -30,6 +31,7 @@ or
 
 new UriBuilder("https://awesome.com/yo)
     .WithParameter("id", "5")
+    .Uri
     .ToString();
 
 ```
@@ -78,4 +80,4 @@ var uri = new UriBuilder("https://awesome.com")
 
 ```
 
-result: `http%3A%2F%2Fawesome.com%2F%3Fyo%3Ddawg%3C`
+result: `http%3A%2F%2Fawesome.com%2F%3Fyo%3Ddawg%3C`

src/UriBuilder.Fluent.UnitTests/ExtensionTests.cs

@@ -71,6 +71,22 @@ namespace FluentUriBuilder.Tests
             Assert.Equal("http://awesome.com/?awesome", url.Uri.ToString());
         }
 
+        [Fact]
+        public void TestAddFragmentArrayint()
+        {
+            var url = new UriBuilder("http://awesome.com")
+                    .WithFragment("awesome", new List<int>() { 1, 2 }.Cast<object>());
+            Assert.Equal("http://awesome.com/#awesome=1,2", url.Uri.ToString());
+        }
+
+        [Fact]
+        public void TestAddFragmentNoValue()
+        {
+            var url = new UriBuilder("http://awesome.com")
+                    .WithFragment("awesome");
+            Assert.Equal("http://awesome.com/#awesome", url.Uri.ToString());
+        }
+
         [Fact]
         public void WithPort()
         {

src/UriBuilder.Fluent.UnitTests/ThrowsTests.cs

@@ -13,10 +13,12 @@ namespace FluentUriBuilder.Tests
         {
             var tstObj = new UriBuilder();
             Assert.Throws<ArgumentNullException>(() => tstObj.WithParameter(string.Empty, string.Empty));
+            Assert.Throws<ArgumentNullException>(() => tstObj.WithFragment(string.Empty, string.Empty));
             Assert.Throws<ArgumentNullException>(() => tstObj.WithPathSegment(null));
             Assert.Throws<ArgumentNullException>(() => tstObj.WithScheme(null));
             Assert.Throws<ArgumentNullException>(() => tstObj.WithHost(null));
             Assert.Throws<ArgumentNullException>(() => tstObj.WithParameter(parameterDictionary: null));
+            Assert.Throws<ArgumentNullException>(() => tstObj.WithFragment(fragmentDictionary: null));
             Assert.Throws<ArgumentOutOfRangeException>(() => tstObj.WithPort(-1));
         }
     }

src/UriBuilder.Fluent.UnitTests/UriBuilder.Fluent.UnitTests.csproj

@@ -1,7 +1,6 @@
 <Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
     <TargetFrameworks>netcoreapp1.1;net461</TargetFrameworks>
-    <DebugType>full</DebugType>
   </PropertyGroup>
   <ItemGroup>
     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="15.0.0" />

src/UriBuilder.Fluent/TerribleDevUriExtensions.cs

@@ -52,18 +52,55 @@ namespace System
                 valuesEnum = new string[0];
             }
             var intitialValue = string.IsNullOrWhiteSpace(bld.Query) ? "" : $"{bld.Query.TrimStart('?')}&";
-            var sb = new StringBuilder($"{intitialValue}{key}");
-            var validValueHit = false;
-            foreach(var value in valuesEnum)
+            bld.Query = intitialValue.AppendKeyValue(key, valuesEnum);
+            return bld;
+        }
+
+        /// <summary>
+        /// Appends a fragments parameter with a key, and many values. Multiple values will be comma seperated. If only 1 value is passed and its null or value, the key will be added to the fragment.
+        /// </summary>
+        /// <param name="bld"></param>
+        /// <param name="key"></param>
+        /// <param name="values"></param>
+        /// <returns></returns>
+        public static UriBuilder WithFragment(this UriBuilder bld, string key, params string[] values) => bld.WithFragment(key, valuesEnum: values);
+
+        /// <summary>
+        /// Appends fragments from dictionary
+        /// </summary>
+        /// <param name="bld"></param>
+        /// <param name="fragmentDictionary"></param>
+        /// <exception cref="ArgumentNullException"></exception>
+        /// <returns></returns>
+        public static UriBuilder WithFragment(this UriBuilder bld, IDictionary<string, string> fragmentDictionary)
+        {
+            if(fragmentDictionary == null) throw new ArgumentNullException(nameof(fragmentDictionary));
+            foreach(var item in fragmentDictionary)
             {
-                var toSValue = value?.ToString();
-                if(string.IsNullOrWhiteSpace(toSValue)) continue;
-                // we can't just have an = sign since its valid to have query string paramters with no value;
-                if(!validValueHit) toSValue = "=" + value;
-                validValueHit = true;
-                sb.Append($"{toSValue},");
+                bld.WithFragment(item.Key, item.Value);
             }
-            bld.Query = sb.ToString().TrimEnd(',');
+            return bld;
+        }
+
+        /// <summary>
+        /// Appends a fragments with a key, and many values. Multiple values will be comma seperated. If only 1 value is passed and its null or value, the key will be added to the fragment.
+        /// </summary>
+        /// <param name="bld"></param>
+        /// <param name="key"></param>
+        /// <param name="valuesEnum"></param>
+        /// <returns></returns>
+        public static UriBuilder WithFragment(this UriBuilder bld, string key, IEnumerable<object> valuesEnum)
+        {
+            if(string.IsNullOrWhiteSpace(key))
+            {
+                throw new ArgumentNullException(nameof(key));
+            }
+            if(valuesEnum == null)
+            {
+                valuesEnum = new string[0];
+            }
+            var intitialValue = string.IsNullOrWhiteSpace(bld.Fragment) ? "" : $"{bld.Fragment.TrimStart('?')}&";
+            bld.Fragment = intitialValue.AppendKeyValue(key, valuesEnum);
             return bld;
         }
 
@@ -166,5 +203,23 @@ namespace System
         /// <returns></returns>
         public static string ToEscapeDataString(this UriBuilder bld) => Uri.EscapeDataString(bld.Uri.ToString());
 
+        /// <summary>
+        /// Appends x-www-form-urlencoded key and valuesEnum into initialValue.
+        /// </summary>
+        private static string AppendKeyValue(this string intitialValue, string key, IEnumerable<object> valuesEnum)
+        {
+            var sb = new StringBuilder($"{intitialValue}{key}");
+            var validValueHit = false;
+            foreach(var value in valuesEnum)
+            {
+                var toSValue = value?.ToString();
+                if(string.IsNullOrWhiteSpace(toSValue)) continue;
+                // we can't just have an = sign since its valid to have query string paramters with no value;
+                if(!validValueHit) toSValue = "=" + value;
+                validValueHit = true;
+                sb.Append($"{toSValue},");
+            }
+            return  sb.ToString().TrimEnd(',');
+        }
     }
 }

src/UriBuilder.Fluent/UriBuilder.Fluent.csproj

@@ -7,7 +7,6 @@
     <PackageId>UriBuilder.Fluent</PackageId>
     <PackageTags>Url building;Uri;Uri building;fluent;extension</PackageTags>
     <PackageProjectUrl>https://github.com/TerribleDev/UriBuilder.Fluent</PackageProjectUrl>
-    <DebugType>full</DebugType>
   </PropertyGroup>
 
   <ItemGroup Condition=" '$(TargetFramework)' == 'net40' ">