By Xmartlabs SRL.
Introduction
Ecno was inspired by Once Android library. It's a task state manager built on top of UserDefaults in pure Swift 4. This abstraction allows you to mark 'tasks' as done, 'to-do' and check for those states.
Ecno is ideal for:
- Show tutorials once within the application.
- Perform certain task periodically.
- Trigger a task based on a user action.
Usage
First you need to initialize it:
Ecno.initialize()
Note: you should initialize it when your app gets launched.
Then, you can check whether a task was done by:
if !Ecno.beenDone("task") {
//...
Ecno.markDone("task")
}
Also, you can check for specific requirements about a certain task:
if Ecno.beenDone("task", scope: .appSession, numberOfTimes: .moreThan(3)) {
// do stuff
}
or
if Ecno.beenDone("task", scope: .since(20.minutes), numberOfTimes: .lessThan(3)) {
// do stuff
}
Additionally, you can program a 'to do' task by:
Ecno.toDo("show banner", scope: .until(3.hours), info: ["name": "bannerName"])
and then query if you need to do that task:
if Ecno.needToDo("show banner") {
let info = Ecno.infoForToDo("show banner") // ["name": "bannerName"]
// ...
}
Task
Any type conforming to the Task protocol. Since it would be the most common case, the String type already conforms to Task.
public protocol Task {
var tag: String { get }
}
Scope
Scopes represents periods of time within the application.
.appInstall
This period represents all times for the application..appVersion
Period starting when the current version of the app was installed..appSession
Period starting when the application was launched..since(TimeInterval)
Period starting sinceTimeIntervaltime ago from now. For instance,.since(2.days).until(TimeInterval)
Period valid untilTimeIntervalfrom now. For instance,.until(3.hours). This should be useful to set a 'to do' task that expires.
Functions
func toDo(_ task: Task, scope: Scope? = nil, info: [AnyHashable: Any]? = nil)
Marks a task as 'to do' within a given scope, if it has already been marked as to do or been done within that scope then it will not be marked. If the scope is nil, then it will be marked as to do anyways.func needToDo(_ task: Task) -> Bool
Checks if a task is currently marked as 'to do'.func infoForToDo(_ task: Task) -> [AnyHashable: Any]?
Gets the info associated with a 'to do' task. (only if you provided it in thetoDo(...)function)func lastDone(_ task: Task) -> Date?
Last done timestamp for a given task.func beenDone(_ task: Task, scope: Scope = .appInstall, numberOfTimes: CountChecker = .moreThan(0)) -> Bool
Checks if a task has been done with the given requirements.func markDone(_ task: Task)
Marks a task as done.
Requirements
- iOS 8.0+
- Swift 4.0+
- Xcode 9.0+
Getting involved
- If you want to contribute please feel free to submit pull requests.
- If you have a feature request please open an issue.
- If you found a bug or need help please check older issues
Before contribute check the CONTRIBUTING file for more info.
If you use Ecno in your app We would love to hear about it! Drop us a line on twitter.
Examples
Follow these 3 steps to run Example project:
- Clone Ecno repository
- Open Ecno workspace and run the Example project.
Installation
CocoaPods
CocoaPods is a dependency manager for Cocoa projects.
To install Ecno, simply add the following line to your Podfile:
pod 'Ecno', '~> 3.0'
Carthage
Carthage is a simple, decentralized dependency manager for Cocoa.
To install Ecno, simply add the following line to your Cartfile:
github "xmartlabs/Ecno" ~> 3.0
Author
Change Log
This can be found in the CHANGELOG.md file.
630 Dec 13, 2022
3 Sep 16, 2021
27 Nov 17, 2022
1.6k Dec 29, 2022
1 Dec 21, 2021
508 Dec 7, 2022
4 Jul 31, 2022
21 Nov 15, 2022
2.3k Jan 3, 2023
498 Dec 24, 2022
363 Dec 26, 2022
20k Jan 3, 2023
15 Oct 11, 2019
0 Dec 6, 2021
1 Mar 29, 2022
26 Dec 10, 2022
1.1k Jan 8, 2023
6 Sep 27, 2022
8.9k Jan 6, 2023
8.3k Jan 5, 2023
7.2k Jan 3, 2023
1.3k Dec 28, 2022
1.9k Dec 27, 2022
123 Jun 29, 2022
338 Nov 29, 2022
142 Sep 9, 2022
557 Nov 22, 2022
1k Dec 2, 2022