AEPRulesEngine
Overview
A simple, generic, extensible Rules Engine in Swift.
Requirements
- Xcode 14.1 (or newer)
- Swift 5.1 (or newer)
Installation
CocoaPods
# Podfile
use_frameworks!
target 'YOUR_TARGET_NAME' do
pod 'AEPRulesEngine'
end
Replace YOUR_TARGET_NAME
and then, in the Podfile
directory, type:
$ pod install
Swift Package Manager
To add the AEPRulesEngine package to your application, from the Xcode menu select:
File > Swift Packages > Add Package Dependency...
Enter the URL for the AEPRulesEngine package repository: https://github.com/adobe/aepsdk-rulesengine-ios.git
.
When prompted, input a specific version or a range of versions.
Alternatively, if your project has a Package.swift
file, you can add AEPRulesEngine directly to your dependencies:
dependencies: [
.package(url: "https://github.com/adobe/aepsdk-rulesengine-ios.git", .upToNextMajor(from: "4.0.0"))
]
Usage
Initialize the Rules Engine
To create a RulesEngine
instance, define an Evaluator
and pass it to the RulesEngine
's initializer:
let evaluator = ConditionEvaluator(options: .caseInsensitive)
let rulesEngine = RulesEngine(evaluator: evaluator)
Define Rules
Anything that conforms to the Rule
protocol can be used as rule:
public class MobileRule: Rule {
init(condition: Evaluable) { self.condition = condition }
var condition: Evaluable
}
let condition = ComparisonExpression(lhs: "abc", operationName: "equals", rhs: "abc")
let rule = MobileRule(condition: condition)
rulesEngine.addRules(rules: [rule])
A rule without the flexibility to dynamically fetch a value will always evaluate to true or false. To fetch the value for a rule at runtime, use a Mustache Token:
let mustache = Operand<String>(mustache: "{{company}}")
let condition = ComparisonExpression(lhs: mustache, operationName: "equals", rhs: "adobe")
let rule = MobileRule(condition: condition)
rulesEngine.addRules(rules: [rule])
Evaluate data
Use the evaluate
method to process Traversable
data through the RulesEngine
:
let matchedRules = rulesEngine.evaluate(data: ["company":"adobe"])
Contributing
Contributions are welcomed! Read the Contributing Guide for more information.
Licensing
This project is licensed under the Apache V2 License. See LICENSE for more information.