Merge pull request #10 from guibranco/develop

Develop

Author: guibranco

README.md

@@ -18,10 +18,32 @@ The CrispyWaffle project - a toolkit for dotNet (framework & core) projects
 
 ---
 
+## Installation
+
+Download the latest zip file from the [Release](https://github.com/GuiBranco/CrispyWaffle/Releases) pages or simple install from [NuGet](https://www.nuget.org/packages/CrispyWaffle) package manager
+
+---
+
 NuGet package: https://www.nuget.org/packages/CrispyWaffle
 
 ```ps
 Install-Package CrispyWaffle
 ```
+---
+
+## Changelog
+
+Version 1.1 (2019-09-27) [@guibranco](https://github.com/guibranco)
+- Add Math Extensions (CrispyWaffle.Extensions.MathExtensions namespace)
+- Add Personal Data Validations (CrispyWaffle.Validations.PersonalDataValidations)
+- Rename method *FormatDocument* to *FormatBrazilianDocument* (CrispyWaffle.Extensions.ConversionExtensions)
+- Rename method *ParsePhoneNumber* to *arseBrazilianPhoneNumber* (CrispyWaffle.Extensions.ConversionExtensions)
+- Removed *CleanListItems* (CrispyWaffle.Extensions.ConversionExtensions)
+- Rename method *TryParsePhoneNumber* to *TryParseBrazilianPhoneNumber* (CrispyWaffle.Extensions.ConversionExtensions)
+- Removed *CleanListItems* and *ToListString* (CrispyWaffle.Extensions.ConversionExtensions) **(Specific to application patterns)**
+
+---
+
+## TODO
 
----
+- Add tests

Src/CrispyWaffle/Extensions/ConversionExtensions.cs

@@ -11,7 +11,6 @@
     using System.Text.RegularExpressions;
     using System.Xml;
     using Utilities;
-    using Validations;
 
     /// <summary>
     /// Helper class for generic conversions
@@ -225,25 +224,26 @@ public static DateTime FromUnixTimeStamp(this int epochTime)
         }
 
         /// <summary>
-        /// Parses the phone number.
+        /// Parses the brazilian phone number.
         /// </summary>
         /// <param name="number">The number.</param>
         /// <returns></returns>
-        public static PhoneNumber ParsePhoneNumber(this string number)
+        /// <exception cref="InvalidTelephoneNumberException"></exception>
+        public static PhoneNumber ParseBrazilianPhoneNumber(this string number)
         {
             var result = new PhoneNumber(0, 0, 0);
-            if (number.TryParsePhoneNumber(ref result))
+            if (number.TryParseBrazilianPhoneNumber(ref result))
                 return result;
             throw new InvalidTelephoneNumberException(number.RemoveNonNumeric());
         }
 
         /// <summary>
-        /// Tries the parse phone number.
+        /// Tries the parse brazilian phone number.
         /// </summary>
-        /// <param name="number">The phone number as string.</param>
-        /// <param name="result">The phone number as PhoneNumber struct.</param>
-        /// <returns><b>True</b> if succeed, <b>false</b> otherwise</returns>
-        public static bool TryParsePhoneNumber(this string number, ref PhoneNumber result)
+        /// <param name="number">The number.</param>
+        /// <param name="result">The result.</param>
+        /// <returns></returns>
+        public static bool TryParseBrazilianPhoneNumber(this string number, ref PhoneNumber result)
         {
             var dirty = number.RemoveNonNumeric();
             var dirtyLength = dirty.Length;
@@ -269,70 +269,6 @@ public static bool TryParsePhoneNumber(this string number, ref PhoneNumber resul
             return true;
         }
 
-        /// <summary>
-        /// To HTML list string.
-        /// </summary>
-        /// <param name="exception">The exception.</param>
-        /// <param name="includeListTag">Includes the UL tags in the return string.</param>
-        /// <returns>System.String.</returns>
-        public static string ToListString(this Exception exception, bool includeListTag = true)
-        {
-            var builder = new StringBuilder();
-            if (includeListTag)
-                builder.Append(@"<ul>");
-
-            var inner = exception;
-            while (inner != null)
-            {
-                var stackTrace = inner.StackTrace ?? string.Empty;
-                if (ExceptionValidations.StackTracePattern.IsMatch(stackTrace))
-                    stackTrace =
-                        ExceptionValidations
-                            .StackTracePattern
-                            .Matches(stackTrace)
-                            .Cast<Match>()
-                            .Aggregate(string.Empty,
-                                       (current, match) =>
-                                           current + $@"<li> {match.Groups["method"].Value}</li>");
-                builder.AppendFormat(@"<li><b>{0}</b> (<u>{1}</u>)</li>{2}",
-                                     inner.Message,
-                                     inner.GetType().FullName,
-                                     stackTrace);
-                inner = inner.InnerException;
-            }
-
-            if (includeListTag)
-                builder.AppendLine(@"</ul>");
-            return builder.ToString();
-        }
-
-        /// <summary>
-        /// Cleans the list items.
-        /// </summary>
-        /// <param name="input">The input.</param>
-        /// <param name="maxItems">The maximum items.</param>
-        /// <returns></returns>
-        public static string CleanListItems(this string input, int maxItems = 15)
-        {
-            input = input?.Replace(@"<ul>", string.Empty).Replace(@"</ul>", string.Empty) ??
-                             string.Empty;
-
-            var pattern = new Regex(@"<li class='operation'>(?<operation>.+?)</li>(?:\s+<li>(?:.+?)</li>)*",
-                                    RegexOptions.IgnoreCase |
-                                    RegexOptions.CultureInvariant |
-                                    RegexOptions.Multiline);
-            if (!pattern.IsMatch(input) || maxItems <= 0)
-                return input;
-            var matches = pattern.Matches(input);
-            var max = matches.Count > maxItems
-                          ? maxItems
-                          : matches.Count;
-            input = string.Empty;
-            for (var i = 1; i <= max; i++)
-                input += matches[matches.Count - i];
-            return input;
-        }
-
         /// <summary>
         /// To the pretty string.
         /// </summary>
@@ -436,7 +372,7 @@ public static string ToOrdinal(this int number)
         /// </summary>
         /// <param name="document">The document.</param>
         /// <returns></returns>
-        public static string FormatDocument(this string document)
+        public static string FormatBrazilianDocument(this string document)
         {
             if (string.IsNullOrWhiteSpace(document))
                 return "Invalid document";

Src/CrispyWaffle/Extensions/MathExtensions.cs

@@ -0,0 +1,57 @@
+namespace CrispyWaffle.Extensions
+{
+    /// <summary>
+    /// The math extensions class.
+    /// </summary>
+    public static class MathExtensions
+    {
+        /// <summary>
+        /// Rounds down.
+        /// </summary>
+        /// <param name="currentValue">The current value.</param>
+        /// <param name="multipleOf">The multiple of.</param>
+        /// <returns>Int32.</returns>
+        public static int RoundDown(this int currentValue, int multipleOf = 10)
+        {
+            return currentValue - currentValue % multipleOf;
+        }
+
+        /// <summary>
+        /// Rounds up.
+        /// </summary>
+        /// <param name="currentValue">The current value.</param>
+        /// <param name="multipleOf">The multiple of.</param>
+        /// <param name="forceDifferentValue">The force different value.</param>
+        /// <returns>Int32.</returns>
+        public static int RoundUp(this int currentValue, int multipleOf = 10, bool forceDifferentValue = false)
+        {
+            return !forceDifferentValue &&
+                currentValue % multipleOf == 0
+                ? currentValue
+                : multipleOf - currentValue % multipleOf + currentValue;
+        }
+
+        /// <summary>
+        /// Rounds the best.
+        /// </summary>
+        /// <param name="currentValue">The current value.</param>
+        /// <param name="multipleOf">The multiple of.</param>
+        /// <param name="forceDifferentValue">The force different value.</param>
+        /// <returns>Int32.</returns>
+        public static int RoundBest(
+            this int currentValue,
+            int multipleOf = 10,
+            bool forceDifferentValue = false)
+        {
+            if (!forceDifferentValue &&
+                currentValue % multipleOf == 0)
+                return currentValue;
+            var left = currentValue % multipleOf;
+            var half = multipleOf / 2;
+
+            return left > half
+                       ? currentValue - left + multipleOf
+                       : currentValue + left;
+        }
+    }
+}

Src/CrispyWaffle/Log/Handlers/DefaultExceptionHandler.cs

@@ -66,14 +66,14 @@ private string GetCategory()
             {
                 var method = stack.GetFrame(counter++).GetMethod();
                 if (method == null)
-                    return @"IntegracaoService";
+                    return @"CrispyWaffle";
                 var ns = method.DeclaringType?.FullName;
                 if (string.IsNullOrWhiteSpace(ns))
                     return method.Name;
-                if (ns.StartsWith(@"IntegracaoService.Commons.Log"))
+                if (ns.StartsWith(@"CrispyWaffle.Log"))
                     continue;
-                if (ns.StartsWith(@"IntegracaoService.", StringExtensions.Comparison))
-                    ns = ns.Substring(18);
+                if (ns.StartsWith(@"CrispyWaffle.", StringExtensions.Comparison))
+                    ns = ns.Substring(13);
                 return ns;
             }
         }

Src/CrispyWaffle/Validations/ExceptionValidations.cs

@@ -0,0 +1,30 @@
+namespace CrispyWaffle.Validations
+{
+    using System;
+    using System.Runtime.Serialization;
+
+    /// <summary>
+    /// Class InvalidDocumentException. This class cannot be inherited.
+    /// </summary>
+    /// <seealso cref="Exception" />
+    [Serializable]
+    public class InvalidDocumentException : Exception
+    {
+        /// <summary>
+        /// Initializes a new instance of the <see cref="InvalidDocumentException"/> class.
+        /// </summary>
+        /// <param name="documentType">Type of the document.</param>
+        /// <param name="value">The value.</param>
+        public InvalidDocumentException(string documentType, string value)
+            : base($"The value '{value}' isn't a valid value for a document of type {documentType} ")
+        { }
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="InvalidDocumentException"/> class.
+        /// </summary>
+        /// <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo" /> that holds the serialized object data about the exception being thrown.</param>
+        /// <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext" /> that contains contextual information about the source or destination.</param>
+        protected InvalidDocumentException(SerializationInfo info, StreamingContext context) : base(info, context)
+        { }
+    }
+}

Src/CrispyWaffle/Validations/InvalidDocumentException.cs

@@ -0,0 +1,31 @@
+namespace CrispyWaffle.Validations
+{
+    using System;
+    using System.Runtime.Serialization;
+
+    /// <summary>
+    /// Class InvalidEmailAddressException. This class cannot be inherited.
+    /// </summary>
+    /// <seealso cref="Exception" />
+    [Serializable]
+    public class InvalidEmailAddressException : Exception
+    {
+        /// <summary>
+        /// Initializes a new instance of the <see cref="InvalidEmailAddressException"/> class.
+        /// </summary>
+        /// <param name="emailAddress">The email address.</param>
+        public InvalidEmailAddressException(string emailAddress)
+            : base($"The e-mail address '{emailAddress}' isn't in a valid e-mail address format")
+        {
+        }
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="InvalidEmailAddressException"/> class.
+        /// </summary>
+        /// <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo" /> that holds the serialized object data about the exception being thrown.</param>
+        /// <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext" /> that contains contextual information about the source or destination.</param>
+        protected InvalidEmailAddressException(SerializationInfo info, StreamingContext context) : base(info, context)
+        {
+        }
+    }
+}