Merge branch 'beta'

Author: Petr Šrámek

docs/docfx.json

@@ -0,0 +1,2 @@
+{
+}

src/Cloudikka.PolylineAlgorithm/Cloudikka.PolylineAlgorithm.sln

@@ -14,7 +14,12 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "nuget", "nuget", "{7F9807A1
 		..\..\nuget\Cloudikka.PolylineAlgorithm.nuspec = ..\..\nuget\Cloudikka.PolylineAlgorithm.nuspec
 	EndProjectSection
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Cloudikka.PolylineAlgorithm.Tests", "..\..\tests\Cloudikka.PolylineAlgorithm.Tests\Cloudikka.PolylineAlgorithm.Tests.csproj", "{10B555A6-E4C9-4828-B4A6-64E248CC1D14}"
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "docs", "docs", "{B9F2E949-4493-4131-84B1-C6AB372B62F5}"
+	ProjectSection(SolutionItems) = preProject
+		..\..\docs\docfx.json = ..\..\docs\docfx.json
+	EndProjectSection
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Cloudikka.PolylineAlgorithm.Tests", "..\..\tests\Cloudikka.PolylineAlgorithm.Tests\Cloudikka.PolylineAlgorithm.Tests.csproj", "{30324A08-AA42-425D-87DA-8F9C6AF60454}"
 EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
@@ -26,17 +31,17 @@ Global
 		{882322A6-E758-4662-8D1C-7C555C8FC3F2}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{882322A6-E758-4662-8D1C-7C555C8FC3F2}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{882322A6-E758-4662-8D1C-7C555C8FC3F2}.Release|Any CPU.Build.0 = Release|Any CPU
-		{10B555A6-E4C9-4828-B4A6-64E248CC1D14}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
-		{10B555A6-E4C9-4828-B4A6-64E248CC1D14}.Debug|Any CPU.Build.0 = Debug|Any CPU
-		{10B555A6-E4C9-4828-B4A6-64E248CC1D14}.Release|Any CPU.ActiveCfg = Release|Any CPU
-		{10B555A6-E4C9-4828-B4A6-64E248CC1D14}.Release|Any CPU.Build.0 = Release|Any CPU
+		{30324A08-AA42-425D-87DA-8F9C6AF60454}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{30324A08-AA42-425D-87DA-8F9C6AF60454}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{30324A08-AA42-425D-87DA-8F9C6AF60454}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{30324A08-AA42-425D-87DA-8F9C6AF60454}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
 	EndGlobalSection
 	GlobalSection(NestedProjects) = preSolution
 		{882322A6-E758-4662-8D1C-7C555C8FC3F2} = {51C886AF-D610-48A4-9D73-2DEB38742801}
-		{10B555A6-E4C9-4828-B4A6-64E248CC1D14} = {576FEFFC-B624-40C3-A8AF-4E5233802EA0}
+		{30324A08-AA42-425D-87DA-8F9C6AF60454} = {576FEFFC-B624-40C3-A8AF-4E5233802EA0}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {93A268DC-0947-4FBB-B495-DDAD4B013D82}

src/Cloudikka.PolylineAlgorithm/Cloudikka.PolylineAlgorithm/Constants.cs

@@ -5,9 +5,9 @@
 
 namespace Cloudikka.PolylineAlgorithm {
 	/// <summary>
-	/// Defines the <see cref="Constants" />
+	/// Defines global constant values
 	/// </summary>
-	public static class Constants {
+	internal static class Constants {
 		#region Constants
 
 		/// <summary>
@@ -23,13 +23,13 @@ public static class Constants {
 		#endregion
 
 		/// <summary>
-		/// Defines the <see cref="ASCII" />
+		/// Defines ASCII characters constant values
 		/// </summary>
-		public static class ASCII {
+		internal static class ASCII {
 			#region Constants
 
 			/// <summary>
-			/// Defines the ASCII QuestionMark
+			/// Defines the ASCII Question Mark
 			/// </summary>
 			public const int QuestionMark = 63;
 
@@ -39,21 +39,21 @@ public static class ASCII {
 			public const int Space = 32;
 
 			/// <summary>
-			/// Defines the ASCII UnitSeparator
+			/// Defines the ASCII Unit Separator
 			/// </summary>
 			public const int UnitSeparator = 31;
 
 			#endregion
 		}
 
 		/// <summary>
-		/// Defines the <see cref="Coordinate" />
+		/// Defines coordinates constant values
 		/// </summary>
-		public static class Coordinate {
+		internal static class Coordinate {
 			#region Constants
 
 			/// <summary>
-			/// Defines the maximum value for Latitude
+			/// Defines the maximum value for latitude
 			/// </summary>
 			public const int MaxLatitude = 90;
 

src/Cloudikka.PolylineAlgorithm/Cloudikka.PolylineAlgorithm/Encoding/IPolylineEncoding.cs

@@ -9,24 +9,24 @@ namespace Cloudikka.PolylineAlgorithm.Encoding {
 	#region Interfaces
 
 	/// <summary>
-	/// Defines the <see cref="IPolylineEncoding{T}" />
+	/// Defines base interface for all polyline encodings
 	/// </summary>
-	/// <typeparam name="T"></typeparam>
+	/// <typeparam name="T">Desired type used to decode to and encode from</typeparam>
 	public interface IPolylineEncoding<T> {
 		#region Methods
 
 		/// <summary>
-		/// The Decode
+		/// Method performs decoding from polyline encoded <see cref="System.String"/> to <see cref="IEnumerable{T}"/>
 		/// </summary>
-		/// <param name="source">The <see cref="string"/></param>
+		/// <param name="source">The <see cref="string"/> as polyline encoded source</param>
 		/// <returns>The <see cref="IEnumerable{T}"/></returns>
 		IEnumerable<T> Decode(string source);
 
 		/// <summary>
-		/// The Encode
+		/// Method performs encoding from generic type to polyline encoded <see cref="System.String"/>
 		/// </summary>
-		/// <param name="source">The <see cref="IEnumerable{T}"/></param>
-		/// <returns>The <see cref="string"/></returns>
+		/// <param name="source">Coordinates to encode</param>
+		/// <returns>Polyline encoded result</returns>
 		string Encode(IEnumerable<T> source);
 
 		#endregion

src/Cloudikka.PolylineAlgorithm/Cloudikka.PolylineAlgorithm/Encoding/PolylineEncoding.cs

@@ -4,63 +4,31 @@
 //
 
 namespace Cloudikka.PolylineAlgorithm.Encoding {
-	using System;
-	using System.Collections.Generic;
-	using System.Linq;
-
 	/// <summary>
-	/// Defines the <see cref="PolylineEncoding{T}" />
+	/// Defines default polyline encoding with generic <see cref="System.ValueTuple[double, double]"/> 
 	/// </summary>
-	/// <typeparam name="T"></typeparam>
-	public abstract class PolylineEncoding<T> : IPolylineEncoding<T> {
+	public class PolylineEncoding : PolylineEncodingBase<(double Latitude, double Longitude)> {
 		#region Methods
 
 		/// <summary>
-		/// The Decode
+		/// Method creates <see cref="System.ValueTuple[double, double]"/> result from passed latitude and longitude arguments
 		/// </summary>
-		/// <param name="source">The <see cref="string"/></param>
-		/// <returns>The <see cref="IEnumerable{T}"/></returns>
-		public IEnumerable<T> Decode(string source) {
-			if (String.IsNullOrEmpty(source)) {
-				throw new ArgumentException(ExceptionMessageResource.SourcePolylineStringCannotBeNullOrEmpty, nameof(source));
-			}
-
-			char[] polyline = source.ToCharArray();
-
-			return PolylineAlgorithm.Decode(polyline)
-				.Select(c => CreateResult(c.Latitude, c.Longitude));
+		/// <param name="latitude">Latitude value</param>
+		/// <param name="longitude">Longitude value</param>
+		/// <returns>Returns created instance of <see cref="System.ValueTuple[double, double]"/></returns>
+		protected override (double Latitude, double Longitude) CreateResult(double latitude, double longitude) {
+			return (latitude, longitude);
 		}
 
 		/// <summary>
-		/// The Encode
+		/// Method creates <see cref="System.ValueTuple[double, double]"/>
 		/// </summary>
-		/// <param name="source">The <see cref="IEnumerable{T}"/></param>
-		/// <returns>The <see cref="string"/></returns>
-		public string Encode(IEnumerable<T> source) {
-			if (source == null || !source.Any()) {
-				throw new ArgumentException(ExceptionMessageResource.SourceCharArrayCannotBeNullOrEmpty, nameof(source));
-			}
-
-			var coordinates = source.Select(s => GetCoordinate(s));
-
-			return PolylineAlgorithm.Encode(coordinates);
+		/// <param name="source">The <see cref="(double Latitude, double Longitude)"/></param>
+		/// <returns>Returns created coordinate <see cref="System.ValueTuple[double, double]"/></returns>
+		protected override (double Latitude, double Longitude) GetCoordinate((double Latitude, double Longitude) source) {
+			return source;
 		}
 
-		/// <summary>
-		/// The CreateResult
-		/// </summary>
-		/// <param name="latitude">The <see cref="double"/></param>
-		/// <param name="longitude">The <see cref="double"/></param>
-		/// <returns>The <see cref="T"/></returns>
-		protected abstract T CreateResult(double latitude, double longitude);
-
-		/// <summary>
-		/// The GetCoordinates
-		/// </summary>
-		/// <param name="source">The <see cref="IEnumerable{T}"/></param>
-		/// <returns>The <see cref="IEnumerable{(double Latitude, double Longitude)}"/></returns>
-		protected abstract (double Latitude, double Longitude) GetCoordinate(T source);
-
 		#endregion
 	}
 }

src/Cloudikka.PolylineAlgorithm/Cloudikka.PolylineAlgorithm/Encoding/PolylineEncodingBase.cs

@@ -0,0 +1,66 @@
+//  
+// Copyright (c) Petr Šrámek. All rights reserved.  
+// Licensed under the MIT License. See LICENSE file in the project root for full license information.  
+//
+
+namespace Cloudikka.PolylineAlgorithm.Encoding {
+	using System;
+	using System.Collections.Generic;
+	using System.Linq;
+
+	/// /// <summary>
+	/// Defines base class for all polyline encodings
+	/// </summary>
+	/// <typeparam name="T"></typeparam>
+	public abstract class PolylineEncodingBase<T> : IPolylineEncoding<T> {
+		#region Methods
+
+		/// <summary>
+		/// Method performs decode operation and coversion to desired type
+		/// </summary>
+		/// <param name="source">The <see cref="string"/></param>
+		/// <returns>The <see cref="IEnumerable{T}"/></returns>
+		public IEnumerable<T> Decode(string source) {
+			if (String.IsNullOrEmpty(source)) {
+				throw new ArgumentException(ExceptionMessageResource.ArgumentCannotBeNullOrEmpty, nameof(source));
+			}
+
+			char[] polyline = source.ToCharArray();
+
+			return PolylineAlgorithm.Decode(polyline)
+				.Select(c => CreateResult(c.Latitude, c.Longitude));
+		}
+
+		/// <summary>
+		/// Method performs conversion to coordinate tuple and encode operation.
+		/// </summary>
+		/// <param name="source">The <see cref="IEnumerable{T}"/></param>
+		/// <returns>The <see cref="string"/></returns>
+		public string Encode(IEnumerable<T> source) {
+			if (source == null || !source.Any()) {
+				throw new ArgumentException(ExceptionMessageResource.ArgumentCannotBeNullOrEmpty, nameof(source));
+			}
+
+			var coordinates = source.Select(s => GetCoordinate(s));
+
+			return PolylineAlgorithm.Encode(coordinates);
+		}
+
+		/// <summary>
+		/// Method creates <see cref="T"/> result from passed latitude and longitude arguments
+		/// </summary>
+		/// <param name="latitude">Latitude value</param>
+		/// <param name="longitude">Longitude value</param>
+		/// <returns>Returns created instance of <see cref="T"/></returns>
+		protected abstract T CreateResult(double latitude, double longitude);
+
+		/// <summary>
+		/// The GetCoordinates
+		/// </summary>
+		/// <param name="source">The <see cref="IEnumerable{T}"/></param>
+		/// <returns>The <see cref="IEnumerable{(double Latitude, double Longitude)}"/></returns>
+		protected abstract (double Latitude, double Longitude) GetCoordinate(T source);
+
+		#endregion
+	}
+}