Merge pull request #1 from navtech-io/develop

Develop

Author: rajeshjn

src/Simpleflow/CodeGenerator/ParserEventPublisher.cs

@@ -0,0 +1,22 @@
+// Copyright (c) navtech.io. All rights reserved. 
+// See License in the project root for license information.
+
+using System;
+
+namespace Simpleflow.CodeGenerator
+{
+    internal enum EventType
+    {
+        None,
+        VisitFunctionOnAvail
+    }
+    internal class ParserEventPublisher
+    {
+        public Action<EventType, object> OnVisit;
+
+        public void Publish(EventType eventType, object data)
+        {
+            OnVisit(eventType, data);
+        }
+    }
+}

src/Simpleflow/CodeGenerator/SimpleflowCodeVisitor.VisitFunction.cs

@@ -21,16 +21,19 @@ partial class SimpleflowCodeVisitor<TArg>
 
         public override Expression VisitFunction([NotNull] SimpleflowParser.FunctionContext context)
         {
-            var functionName = context.FunctionName().GetText();
+            var functionName = context.FunctionName().GetText().Substring(1); // Remove $ symbol
 
             // Get registered function
-            var function = FunctionRegister.GetFunction(functionName.Substring(1)); // Remove $ symbol
+            var function = FunctionRegister.GetFunction(functionName); 
 
             if (function == null)
             {
                 throw new InvalidFunctionException(functionName);
             }
 
+            // Publish event once function is available to compile
+            EventPublisher.Publish(EventType.VisitFunctionOnAvail, functionName);
+
             // Get actual method meta-data info and parameters
             var methodInfo = function.GetMethodInfo();
 

src/Simpleflow/CodeGenerator/SimpleflowCodeVisitor.cs

@@ -27,9 +27,12 @@ internal partial class SimpleflowCodeVisitor<TArg> : SimpleflowBaseVisitor<Expre
         protected readonly ParameterExpression Output; // script main function parameter 2
         protected readonly ParameterExpression ScriptHelperContext; //script main function  parameter 3
 
-        public SimpleflowCodeVisitor(IFunctionRegister functionRegister)
+        protected readonly ParserEventPublisher EventPublisher;
+
+        public SimpleflowCodeVisitor(IFunctionRegister functionRegister, ParserEventPublisher eventPublisher)
         {
             FunctionRegister = functionRegister ?? throw new ArgumentNullException(nameof(functionRegister));
+            EventPublisher = eventPublisher;
 
             /* Initialize smart variables and smart json variables */
             Variables = new List<ParameterExpression>();

src/Simpleflow/CodeGenerator/SimpleflowCompiler.cs

@@ -15,7 +15,9 @@ namespace Simpleflow.CodeGenerator
     internal class SimpleflowCompiler
     {
 
-        public static Action<FlowInput<TArg>, FlowOutput, ScriptHelperContext> Compile<TArg>(string code, IFunctionRegister activityRegister)
+        public static Action<FlowInput<TArg>, FlowOutput, ScriptHelperContext> Compile<TArg>(string code, 
+            IFunctionRegister activityRegister, 
+            ParserEventPublisher eventPublisher)
         {
             var inputStream = new AntlrInputStream(code);
 
@@ -43,8 +45,9 @@ public static Action<FlowInput<TArg>, FlowOutput, ScriptHelperContext> Compile<T
                 throw new SyntaxException(errorListener.GetAggregateMessages(), errorListener.Errors);
             }
 
+            
             // Generate code
-            var visitor = new SimpleflowCodeVisitor<TArg>(activityRegister);
+            var visitor = new SimpleflowCodeVisitor<TArg>(activityRegister, eventPublisher);
             var program = visitor.Visit(programContext);
 
             // Compile

src/Simpleflow/Exceptions/AccessDeniedException.cs

@@ -0,0 +1,13 @@
+// Copyright (c) navtech.io. All rights reserved. 
+// See License in the project root for license information.
+
+namespace Simpleflow.Exceptions
+{
+    public class AccessDeniedException : SimpleflowException
+    {
+        public AccessDeniedException(string message) : base(message)
+        {
+
+        }
+    }
+}

src/Simpleflow/FlowContext.cs

@@ -29,7 +29,7 @@ public sealed class FlowContext<TArg>
         public IFunctionRegister ActivityRegister { get; set; }
 
         /// 
-        public IOptions Options { get; set; }
+        public IContextOptions Options { get; set; }
 
         /// <summary>
         /// Gets or sets output.

src/Simpleflow/FlowContextOptions.cs

@@ -0,0 +1,21 @@
+// Copyright (c) navtech.io. All rights reserved.
+// See License in the project root for license information.
+
+using Simpleflow.Services;
+
+namespace Simpleflow
+{
+    /// <summary>
+    /// 
+    /// </summary>
+    public class FlowContextOptions : FlowOptions, IContextOptions
+    {
+        /// <summary>
+        /// Gets or sets unique id of the script
+        /// If Id is supplied, <see cref="CacheService"/> will use it to identify the compiled object
+        /// in cache otherwise it creates a hash id for that script.
+        /// </summary>
+        public string Id { get; set; }
+
+    }
+}

src/Simpleflow/FlowOptions.cs

@@ -1,18 +1,25 @@
 // Copyright (c) navtech.io. All rights reserved.
 // See License in the project root for license information.
 
+
 namespace Simpleflow
 {
     /// <inheritdoc />
     public class FlowOptions : IOptions
     {
-        /// <inheritdoc />
+        /// <summary>
+        /// Gets or sets AllowArgumentToMutate
+        /// </summary>
         public bool AllowArgumentToMutate { get; set; }
 
-        /// <inheritdoc />
+        /// <summary>
+        /// Gets or sets AllowFunctions
+        /// </summary>
         public string[] AllowFunctions { get; set; }
 
-        /// <inheritdoc />
+        /// <summary>
+        /// Gets or sets DenyFunctions
+        /// </summary>
         public string[] DenyFunctions { get; set; }
     }
 }

src/Simpleflow/IContextOptions.cs

@@ -0,0 +1,16 @@
+// Copyright (c) navtech.io. All rights reserved.
+// See License in the project root for license information.
+
+namespace Simpleflow
+{
+    /// <summary>
+    /// 
+    /// </summary>
+    public interface IContextOptions : IOptions
+    {
+        /// <summary>
+        /// Gets unique id of the script
+        /// </summary>
+        string Id { get; }
+    }
+}

src/Simpleflow/IOptions.cs

@@ -20,8 +20,7 @@ public interface IOptions
 
 
         /// <summary>
-        /// Gets or sets DenyFunctions
-        /// DenyFunctions overrides the <see cref="AllowFunctions"/>
+        /// Gets or sets DenyFunctions.
         /// </summary>
         public string[] DenyFunctions { get; set; }
     }