Make consistent singlar/plural names of instances to avoid downstream…

CHANGELOG.md

@@ -24,12 +24,12 @@ Breaking Change:
 - Enabled localParams support for nested Rules
 - Made certain fields in Rule model optional allowing users to define workflow with minimal fields
 - Added option to disable Rule in workflow json
-- Added `GetAllRegisteredWorkflow` to RulesEngine to return all registeredWorkflows
+- Added `GetAllRegisteredWorkflow` to RulesEngine to return all registered workflows
 - Runtime errors for expressions will now be logged as errorMessage instead of throwing Exceptions by default
 - Fixed RuleParameter passed as null
 
 ## [3.0.2]
-- Fixed LocalParams cache not getting cleaned up when RemoveWorkflow and ClearWorkflows are called
+- Fixed LocalParams cache not getting cleaned up when RemoveWorkflows and ClearWorkflows are called
 
 ## [3.0.1]
 - Moved ActionResult and ActionRuleResult under RulesEngine.Models namespace

benchmark/RulesEngineBenchmark/Program.cs

@@ -16,7 +16,7 @@ public class REBenchmark
     {
         private readonly RulesEngine.RulesEngine rulesEngine;
         private readonly object ruleInput;
-        private readonly List<WorkflowRules> workflows;
+        private readonly List<Workflow> workflow;
 
         private class ListItem
         {
@@ -34,9 +34,9 @@ public REBenchmark()
             }
 
             var fileData = File.ReadAllText(files[0]);
-            workflows = JsonConvert.DeserializeObject<List<WorkflowRules>>(fileData);
+            workflow = JsonConvert.DeserializeObject<List<Workflow>>(fileData);
 
-            rulesEngine = new RulesEngine.RulesEngine(workflows.ToArray(), null, new ReSettings {
+            rulesEngine = new RulesEngine.RulesEngine(workflow.ToArray(), null, new ReSettings {
                 EnableFormattedErrorMessage = false,
                 EnableScopedParams = false
             });
@@ -69,7 +69,7 @@ public REBenchmark()
         [Benchmark]
         public void RuleExecutionDefault()
         {
-            foreach (var workflow in workflows)
+            foreach (var workflow in workflow)
             {
                 _ = rulesEngine.ExecuteAllRulesAsync(workflow.WorkflowName, ruleInput).Result;
             }

demo/DemoApp.EFDataExample/RulesEngineContext.cs

@@ -0,0 +1,47 @@
+using System;
+using System.Collections.Generic;
+using System.Text.Json;
+using Microsoft.EntityFrameworkCore;
+using RulesEngine.Models;
+
+namespace RulesEngine.Data
+{
+    public class RulesEngineContext : DbContext
+    {
+        public DbSet<Workflow> Workflows { get; set; }
+
+        public DbSet<Rule> Rules { get; set; }
+
+        protected override void OnModelCreating(ModelBuilder modelBuilder)
+        {
+            base.OnModelCreating(modelBuilder);
+
+            modelBuilder.Entity<ScopedParam>()
+              .HasKey(k => k.Name);
+
+            modelBuilder.Entity<Workflow>(entity => {
+                entity.HasKey(k => k.WorkflowName);
+                entity.Ignore(b => b.WorkflowRulesToInject);
+                entity.Ignore(b => b.WorkflowsToInject);
+            });
+
+            modelBuilder.Entity<Rule>(entity => {
+                entity.HasKey(k => k.RuleName);
+
+                entity.Property(b => b.Properties)
+                .HasConversion(
+                    v => JsonSerializer.Serialize(v, null),
+                    v => JsonSerializer.Deserialize<Dictionary<string, object>>(v, null));
+
+                entity.Property(p => p.Actions)
+                .HasConversion(
+                    v => JsonSerializer.Serialize(v, null),
+                   v => JsonSerializer.Deserialize<RuleActions>(v, null));
+
+                entity.Ignore(b => b.WorkflowRulesToInject);
+                entity.Ignore(b => b.WorkflowsToInject);
+            });
+        }
+    }
+
+}

demo/DemoApp.EFDataExample/RulesEngineDemoContext.cs

@@ -2,19 +2,13 @@
 using System.Collections.Generic;
 using System.Text.Json;
 using Microsoft.EntityFrameworkCore;
+using RulesEngine.Data;
 using RulesEngine.Models;
 
 namespace DemoApp.EFDataExample
 {
-    public class RulesEngineDemoContext : DbContext
+    public class RulesEngineDemoContext : RulesEngineContext
     {
-        public DbSet<WorkflowRules> WorkflowRules { get; set; }
-        public DbSet<ActionInfo> ActionInfos { get; set; }
-
-        public DbSet<RuleActions> RuleActions { get; set; }
-        public DbSet<Rule> Rules { get; set; }
-        public DbSet<ScopedParam> ScopedParams { get; set; }
-
         public string DbPath { get; private set; }
 
         public RulesEngineDemoContext()
@@ -26,48 +20,6 @@ public RulesEngineDemoContext()
         protected override void OnConfiguring(DbContextOptionsBuilder options)
           => options.UseSqlite($"Data Source={DbPath}");
 
-        protected override void OnModelCreating(ModelBuilder modelBuilder)
-        {
-            base.OnModelCreating(modelBuilder);
-
-            modelBuilder.Entity<ActionInfo>()
-                .Property(b => b.Context)
-                .HasConversion(
-                   v => JsonSerializer.Serialize(v, null),
-                   v => JsonSerializer.Deserialize<Dictionary<string, object>>(v, null));
-
-            modelBuilder.Entity<ActionInfo>()
-              .HasKey(k => k.Name);
-
-            modelBuilder.Entity<ScopedParam>()
-              .HasKey(k => k.Name);
-
-            modelBuilder.Entity<WorkflowRules>(entity => {
-                entity.HasKey(k => k.WorkflowName);
-            });
-
-            modelBuilder.Entity<RuleActions>(entity => {
-                entity.HasNoKey();
-                entity.HasOne(o => o.OnSuccess).WithMany();
-                entity.HasOne(o => o.OnFailure).WithMany();
-            });
-
-            modelBuilder.Entity<Rule>(entity => {
-                entity.HasKey(k => k.RuleName);
-
-                entity.Property(b => b.Properties)
-                .HasConversion(
-                   v => JsonSerializer.Serialize(v, null),
-                   v => JsonSerializer.Deserialize<Dictionary<string, object>>(v, null));
-                entity.Ignore(e => e.Actions);
-            });
-
-            modelBuilder.Entity<WorkflowRules>()
-               .Ignore(b => b.WorkflowRulesToInject);
-
-            modelBuilder.Entity<Rule>()
-              .Ignore(b => b.WorkflowRulesToInject);
-        }
     }
 
 }

demo/DemoApp/BasicDemo.cs

@@ -1,13 +1,10 @@
 // Copyright (c) Microsoft Corporation.
 //  Licensed under the MIT License.
 
-using Newtonsoft.Json;
-using Newtonsoft.Json.Converters;
 using RulesEngine.Models;
 using System;
 using System.Collections.Generic;
 using System.Dynamic;
-using System.IO;
 using static RulesEngine.Extensions.ListofRuleResultTreeExtension;
 
 namespace DemoApp
@@ -17,9 +14,9 @@ public class BasicDemo
         public void Run()
         {
             Console.WriteLine($"Running {nameof(BasicDemo)}....");
-            List<WorkflowRules> workFlowRules = new List<WorkflowRules>();
-            WorkflowRules workflowRule = new WorkflowRules();
-            workflowRule.WorkflowName = "Test Workflow Rule 1";
+            List<Workflow> workflows = new List<Workflow>();
+            Workflow workflow = new Workflow();
+            workflow.WorkflowName = "Test Workflow Rule 1";
 
             List<Rule> rules = new List<Rule>();
 
@@ -32,11 +29,11 @@ public void Run()
 
             rules.Add(rule);
 
-            workflowRule.Rules = rules;
+            workflow.Rules = rules;
 
-            workFlowRules.Add(workflowRule);
+            workflows.Add(workflow);
 
-            var bre = new RulesEngine.RulesEngine(workFlowRules.ToArray(), null);
+            var bre = new RulesEngine.RulesEngine(workflows.ToArray(), null);
 
             dynamic datas = new ExpandoObject();
             datas.count = 1;

demo/DemoApp/DemoApp.csproj

@@ -7,7 +7,6 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Newtonsoft.Json" Version="13.0.1" />
     <ProjectReference Include="../../src/RulesEngine/RulesEngine.csproj" />
     <ProjectReference Include="..\DemoApp.EFDataExample\DemoApp.EFDataExample.csproj" />
   </ItemGroup>

demo/DemoApp/EFDemo.cs

@@ -42,16 +42,16 @@ public void Run()
                 throw new Exception("Rules not found.");
 
             var fileData = File.ReadAllText(files[0]);
-            var workflowRules = JsonConvert.DeserializeObject<List<WorkflowRules>>(fileData);
+            var workflow = JsonConvert.DeserializeObject<List<Workflow>>(fileData);
 
             RulesEngineDemoContext db = new RulesEngineDemoContext();
             if (db.Database.EnsureCreated())
             {
-                db.WorkflowRules.AddRange(workflowRules);
+                db.Workflows.AddRange(workflow);
                 db.SaveChanges();
             }
 
-            var wfr = db.WorkflowRules.Include(i => i.Rules).ThenInclude(i => i.Rules).ToArray();
+            var wfr = db.Workflows.Include(i => i.Rules).ThenInclude(i => i.Rules).ToArray();
 
             var bre = new RulesEngine.RulesEngine(wfr, null);
 

demo/DemoApp/JSONDemo.cs

@@ -39,9 +39,9 @@ public void Run()
                 throw new Exception("Rules not found.");
 
             var fileData = File.ReadAllText(files[0]);
-            var workflowRules = JsonConvert.DeserializeObject<List<WorkflowRules>>(fileData);
+            var workflow = JsonConvert.DeserializeObject<List<Workflow>>(fileData);
 
-            var bre = new RulesEngine.RulesEngine(workflowRules.ToArray(), null);
+            var bre = new RulesEngine.RulesEngine(workflow.ToArray(), null);
 
             string discountOffered = "No discount offered.";
 

demo/DemoApp/NestedInputDemo.cs

@@ -49,10 +49,10 @@ public void Run()
             }
 
             var fileData = File.ReadAllText(files[0]);
-            var workflowRules = JsonConvert.DeserializeObject<List<WorkflowRules>>(fileData);
+            var Workflows = JsonConvert.DeserializeObject<List<Workflow>>(fileData);
 
-            var bre = new RulesEngine.RulesEngine(workflowRules.ToArray(), null);
-            foreach (var workflow in workflowRules)
+            var bre = new RulesEngine.RulesEngine(Workflows.ToArray(), null);
+            foreach (var workflow in Workflows)
             {
                 var resultList = bre.ExecuteAllRulesAsync(workflow.WorkflowName, nestedInput).Result;
 

src/RulesEngine/HelperFunctions/Constants.cs

@@ -9,7 +9,7 @@ namespace RulesEngine.HelperFunctions
     public static class Constants
     {
         public const string WORKFLOW_NAME_NULL_ERRMSG = "Workflow name can not be null or empty";
-        public const string INJECT_WORKFLOW_RULES_ERRMSG = "Atleast one of Rules or WorkflowRulesToInject must be not empty";
+        public const string INJECT_WORKFLOW_RULES_ERRMSG = "Atleast one of Rules or WorkflowsToInject must be not empty";
         public const string RULE_CATEGORY_CONFIGURED_ERRMSG = "Rule Category should be configured";
         public const string RULE_NULL_ERRMSG = "Rules can not be null or zero";
         public const string NESTED_RULE_NULL_ERRMSG = "Nested rules can not be null";

src/RulesEngine/Interfaces/IRulesEngine.cs

@@ -29,8 +29,8 @@ public interface IRulesEngine
         /// <summary>
         /// Adds new workflows to RulesEngine
         /// </summary>
-        /// <param name="workflowRules"></param>
-        void AddWorkflow(params WorkflowRules[] workflowRules);
+        /// <param name="workflow"></param>
+        void AddWorkflow(params Workflow[] Workflows);
 
         /// <summary>
         /// Removes all registered workflows from RulesEngine
@@ -48,6 +48,6 @@ public interface IRulesEngine
         /// </summary>
         /// <returns></returns>
         List<string> GetAllRegisteredWorkflowNames();
-        void AddOrUpdateWorkflow(params WorkflowRules[] workflowRules);
+        void AddOrUpdateWorkflow(params Workflow[] Workflows);
     }
 }

src/RulesEngine/Models/Rule.cs

@@ -40,7 +40,14 @@ public class Rule
 
         [JsonConverter(typeof(StringEnumConverter))]
         public RuleExpressionType RuleExpressionType { get; set; } = RuleExpressionType.LambdaExpression;
-        public IEnumerable<string> WorkflowRulesToInject { get; set; }
+
+        [Obsolete("WorkflowRulesToInject is deprecated. Use WorkflowsToInject instead.")]
+        public IEnumerable<string> WorkflowRulesToInject {
+          get { return WorkflowsToInject; }
+          set { WorkflowsToInject = value; }
+        }
+        public IEnumerable<string> WorkflowsToInject { get; set; }
+
         public IEnumerable<Rule> Rules { get; set; }
         public IEnumerable<ScopedParam> LocalParams { get; set; }
         public string Expression { get; set; }

src/RulesEngine/Models/RuleAction.cs → src/RulesEngine/Models/RuleActions.cs

@@ -1,10 +1,17 @@
 // Copyright (c) Microsoft Corporation.
 //  Licensed under the MIT License.
 
+using System;
 using System.Diagnostics.CodeAnalysis;
 
 namespace RulesEngine.Models
 {
+    [Obsolete("RuleAction class is deprecated. Use RuleActions class instead.")]
+    [ExcludeFromCodeCoverage]
+    public class RuleAction : RuleActions
+    {
+    }
+
     [ExcludeFromCodeCoverage]
     public class RuleActions
     {

src/RulesEngine/Models/WorkflowRules.cs → src/RulesEngine/Models/Workflow.cs

@@ -1,25 +1,36 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
+using System;
 using System.Collections.Generic;
 using System.Diagnostics.CodeAnalysis;
 
 namespace RulesEngine.Models
 {
+    [Obsolete("WorkflowRules class is deprecated. Use Workflow class instead.")]
+    [ExcludeFromCodeCoverage]
+    public class WorkflowRules : Workflow {
+    }
+
     /// <summary>
     /// Workflow rules class for deserialization  the json config file
     /// </summary>
     [ExcludeFromCodeCoverage]
-    public class WorkflowRules
+    public class Workflow
     {
         /// <summary>
         /// Gets the workflow name.
         /// </summary>
         public string WorkflowName { get; set; }
 
-        /// <summary>Gets or sets the workflow rules to inject.</summary>
-        /// <value>The workflow rules to inject.</value>
-        public IEnumerable<string> WorkflowRulesToInject { get; set; }
+    /// <summary>Gets or sets the workflow rules to inject.</summary>
+    /// <value>The workflow rules to inject.</value>
+    [Obsolete("WorkflowRulesToInject is deprecated. Use WorkflowsToInject instead.")]
+    public IEnumerable<string> WorkflowRulesToInject {
+      get { return WorkflowsToInject; }
+      set { WorkflowsToInject = value; }
+    }
+    public IEnumerable<string> WorkflowsToInject { get; set; }
 
         /// <summary>
         /// Gets or Sets the global params which will be applicable to all rules