Merge pull request #6 from navtech-io/develop

Develop

Author: rajeshjn

README.md

@@ -16,7 +16,7 @@ Install package via Nuget. Using the NuGet package manager console within Visual
 Install-Package Simpleflow	
 ```
 
-**Try following Simpleflow script:**
+**Try the following Simpleflow script:**
 
 ```csharp
 using Simpleflow;

build/Build.cs

@@ -2,6 +2,7 @@
 using System.Linq;
 using Nuke.Common;
 using Nuke.Common.CI.AppVeyor;
+using Nuke.Common.CI.GitHubActions;
 using Nuke.Common.Execution;
 using Nuke.Common.Git;
 using Nuke.Common.IO;
@@ -10,6 +11,7 @@
 using Nuke.Common.Tools.DotNet;
 using Nuke.Common.Tools.GitVersion;
 using Nuke.Common.Utilities.Collections;
+using Serilog;
 using static Nuke.Common.EnvironmentInfo;
 using static Nuke.Common.IO.FileSystemTasks;
 using static Nuke.Common.IO.PathConstruction;
@@ -40,6 +42,15 @@ class Build : NukeBuild
     AbsolutePath TestsDirectory => RootDirectory / "test";
     AbsolutePath ArtifactsDirectory => RootDirectory / "artifacts";
     AbsolutePath NugetDirectory => ArtifactsDirectory / "nuget";
+    GitHubActions GitHubActions => GitHubActions.Instance;
+    
+
+    Target Print => _ => _
+        .Executes(() =>
+        {
+            Log.Information("Branch = {Branch}", GitHubActions.Ref);
+            Log.Information("Commit = {Commit}", GitHubActions.Sha);
+        });
 
     Target Clean => _ => _
         .Before(Restore)
@@ -114,14 +125,14 @@ class Build : NukeBuild
                 .AddProperty("PackageLicenseExpression", "Apache-2.0")
                 .AddProperty("PackageIcon", @"PackageIcon.png")
                 .SetIncludeSymbols(true)
-                .SetVersion("0.1.0-beta05" /*NuGetVersionCustom*/)
-                .SetDescription("Lightweight rule engine")
+                .SetVersion("0.1.0-beta06")
+                .SetDescription("Build dynamic rules and workflows using script")
                 .SetPackageTags("Simpleflow.NET Workflow RuleEngine DynamicExpressionEvaluator")
                 .SetNoDependencies(true)
                 .SetOutputDirectory(ArtifactsDirectory / "nuget"));
         });
 
-    Target Push => _ => _
+    Target Publish => _ => _
         .Requires(() => NugetApiUrl)
         .Requires(() => NugetApiKey)
         .Requires(() => Configuration.Equals(Configuration.Release))
@@ -141,12 +152,5 @@ class Build : NukeBuild
                 });
         });
 
-    // Target PullRequest 
-
-    //Target Print => _ => _
-    //    .Executes(() =>
-    //    {
-    //        Log.Information("Branch = {Branch}", GitHubActions.Ref);
-    //        Log.Information("Commit = {Commit}", GitHubActions.Sha);
-    //    });
+    
 }

src/Simpleflow/CacheOptions.cs

@@ -0,0 +1,28 @@
+// Copyright (c) navtech.io. All rights reserved.
+// See License in the project root for license information.
+
+namespace Simpleflow
+{
+    /// <summary>
+    /// Represents the cache options that applied to <see cref="Services.CacheService"/>
+    /// </summary>
+    public class CacheOptions
+    {
+        /// <summary>
+        /// Gets or sets how long a cache entry can be inactive (e.g. not accessed) before it will be removed.
+        /// This will not extend the entry lifetime beyond the absolute expiration (if set).
+        /// </summary>
+        public System.TimeSpan? SlidingExpiration { get; set; } = System.TimeSpan.FromMinutes(3);
+
+        /// <summary>
+        /// Gets or sets an absolute expiration date for the cache entry.
+        /// </summary>
+        public System.DateTimeOffset? AbsoluteExpiration { get; set; }
+
+        /// <summary>
+        /// Gets or sets hashing algorithm to identify script compiled object uniquely
+        /// Check available hash algorithms and names here: https://docs.microsoft.com/en-us/dotnet/api/system.security.cryptography.hashalgorithm.create?view=net-6.0
+        /// </summary>
+        public string HashingAlgToIdentifyScriptUniquely { get; set; } = "MD5";
+    }
+}

src/Simpleflow/CodeGenerator/SimpleflowCodeVisitor.VisitArithmeticExpression.cs

@@ -69,8 +69,17 @@ public override Expression VisitArithmeticExpression(SimpleflowParser.Arithmetic
                 return Expression.Divide(left, right);
             }
 
-            // TODO InvalidArithmeticExpression
-            throw new Exception("Invalid operator or expression");
+            if (context.ModuloOp() != null)
+            {
+                var left = Visit(context.arithmeticExpression()[0]);
+                var right = Visit(context.arithmeticExpression()[1]);
+
+                (left, right) = ConvertToBiggerNumberType(left, right);
+
+                return Expression.Modulo(left, right);
+            }
+
+            throw new Exceptions.SimpleflowException("Invalid operator or expression");
         }
 
         private (Expression left, Expression right) ConvertToBiggerNumberType(Expression left, Expression right)

src/Simpleflow/CodeGenerator/SimpleflowCodeVisitor.VisitFunction.cs

@@ -97,14 +97,14 @@ private Expression CreateFunctionParameterExpression(ParameterInfo methodParamet
 
         private void CheckRepeatedParameters(SimpleflowParser.FunctionParameterContext[] parameters)
         {
-            var repeatedParameter = (from parameter in parameters
+            var repeatedParameters = (from parameter in parameters
                                      group parameter by parameter.Identifier().GetText() into g
                                      where g.Count() > 1
                                      select g.Key).ToList();
 
-            if (repeatedParameter.Count > 0)
+            if (repeatedParameters.Count > 0)
             {
-                throw new DuplicateParametersException(string.Join(',', repeatedParameter));
+                throw new DuplicateParametersException(repeatedParameters);
             }
         }
 

src/Simpleflow/CodeGenerator/SimpleflowCodeVisitor.cs

@@ -126,7 +126,6 @@ private void CreateUserDefinedVariableExpressions(List<Expression> statementExpr
 
         private void InjectSmartVariables(List<Expression> statementExpressions)
         {
-            // TODO write comments
             int index = 0;
             while (index < SmartJsonVariables.Count)
             {

src/Simpleflow/Exceptions/AccessDeniedException.cs

@@ -3,11 +3,19 @@
 
 namespace Simpleflow.Exceptions
 {
+
+    /// <summary>
+    /// This exception is thrown when a script uses a denied function.
+    /// </summary>
     public class AccessDeniedException : SimpleflowException
     {
+        /// <summary>
+        /// Initializes a new instance of the <see cref="AccessDeniedException"/> class with
+        /// a specified error message.
+        /// </summary>
+        /// <param name="message">The message that describes the error</param>
         public AccessDeniedException(string message) : base(message)
         {
-
         }
     }
 }

src/Simpleflow/Exceptions/DuplicateActivityException.cs

@@ -0,0 +1,26 @@
+// Copyright (c) navtech.io. All rights reserved.
+// See License in the project root for license information.
+
+namespace Simpleflow.Exceptions
+{
+    /// <summary>
+    /// The exception is thrown when a function with a name is already registered.
+    /// </summary>
+    public class DuplicateFunctionException : SimpleflowException
+    {
+        /// <summary>
+        /// Initializes a new instance of the <see cref="DuplicateFunctionException"/> class with
+        /// a specified function name.
+        /// </summary>
+        /// <param name="functionName">The name of the function that caused the exception</param>
+        /// <param name="message">The message describes the exception</param>
+        public DuplicateFunctionException(string functionName, string message=null) : base(message ?? $"Function '{functionName}' is already registered, cannot be duplicated.") {
+            FunctionName = functionName;
+        }
+
+        /// <summary>
+        /// Gets name of the function that has been re-registered.
+        /// </summary>
+        public string FunctionName { get; }
+    }
+}

src/Simpleflow/Exceptions/DuplicateFunctionException.cs

@@ -1,18 +1,21 @@
 // Copyright (c) navtech.io. All rights reserved.
 // See License in the project root for license information.
 
-using System;
+using System.Collections.Generic;
 
 namespace Simpleflow.Exceptions
 {
+    /// <summary>
+    /// The exception is thrown when same parameters are specified multiple times
+    /// while invoking a function in script
+    /// </summary>
     public class DuplicateParametersException : SimpleflowException
     {
-        // TODO
-
         /// <summary>
-        /// 
+        /// Initializes a new instance of the <see cref="DuplicateParametersException"/> class with
+        /// a specified function name.
         /// </summary>
-        /// <param name="name"></param>
-        public DuplicateParametersException(string message) : base(message) { }
+        /// <param name="repeatedParameters">The repeated parameters that caused the exception.</param>
+        public DuplicateParametersException(IEnumerable<string> repeatedParameters) : base($"Duplicate parameters '{string.Join(',', repeatedParameters)}' cannot be allowed." ) { }
     }
 }