https://github.com/christopherkarani/sukari
🍯 Sweet Syntactical Sugar For Swift
https://github.com/christopherkarani/sukari
coregraphics foundation swift syntactic syntactic-sugar
Last synced: 6 months ago
JSON representation
🍯 Sweet Syntactical Sugar For Swift
- Host: GitHub
- URL: https://github.com/christopherkarani/sukari
- Owner: christopherkarani
- License: mit
- Created: 2017-12-19T14:12:10.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2020-10-20T20:59:52.000Z (almost 5 years ago)
- Last Synced: 2024-03-20T13:21:01.824Z (over 1 year ago)
- Topics: coregraphics, foundation, swift, syntactic, syntactic-sugar
- Language: Swift
- Homepage:
- Size: 47.9 KB
- Stars: 30
- Watchers: 2
- Forks: 6
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Sukari
🍯 Powerful, Elegant Syntactical Sugar for Swift 🍯
# Description
Enjoy Beutiful Syntactic Enhancements to your swift code base
## Simply add Sukari to your initializers
#### Use `.this{}` to Initialize Swiftly! 🌈
```swift
let fileManager = FileManager().this {
$0.urls(for: .applicationDirectory, in: .userDomainMask)
}
```
#### Clean up your initialization Code! ✨
```swift
let tableView : UITableView = {
let table = UITableView()
table.backgroundColor = .white
table.register(UserCell.self, forCellReuseIdentifier: "CellID")
table.separatorStyle = .none
table.allowsSelection = false
return table
}()
```
#### Initialize in **this** way. and and stop repeating yourself! 🚦
```swift
let tableView = UITableView().this {
$0.backgroundColor = .white
$0.register(UserCell.self, forCellReuseIdentifier: "CellID")
$0.separatorStyle = .none
$0.allowsSelection = false
}
```
#### Easily Create and Set Value Types 🛠
```swift
let point = CGPoint().set {
$0.x = 100
$0.y = 200
}
```
### Add Sugar to your own Types with a little Extension 🔌
```swift
extension CustomType: Sukari {}
let instance = CustomType().this {
$0.color = .blue
$0.label.text = "Custom Type"
}
```
### Make your code base a little Sweeter 🍭
```swift
class LoginViewController : UIViewController {
var loginButton = UIButton().this {
$0.setTitle("Login", for: .normal)
$0.backgroundColor = . yellow
$0.layer.masksToBounds = true
$0.layer.cornerRadius = 5
}
let emailTextField = UITextField().this {
$0.placeholder = "Email"
$0.borderStyle = .roundedRect
$0.font = UIFont.systemFont(ofSize: 14)
$0.backgroundColor = UIColor(white: 0, alpha: 0.03)
}
override func viewDidLoad() {
super.viewDidLoad()
view.addSubview(loginButton)
view.addSubview(emailTextField)
}
}
```
## Unwrap
Unwrap lets you easily require `Optional` values.
Use unwrap() on any optional that you expect to always be non-nil, or else crash your App with a more (optional) descriptive debug message with `.unwrap(debug:)`
On top of that, unwrap also provides a sytactic enhancement to easily `unwrap` optionals through an under-the-hood `Guard` Statement.
1. No More `if` `let` pyramids and `Guard` `let` Towers. only a clean and simple extension to your optionals `unwrap`
2. Recieve Rich Debug Information with `unwrap(debug:)` 
#### Adopt this simple but effective enhancment to your code base Now!
#### `Guard` `let` tower spotted.
#### Clean, Succinct, and with more descriptive crashes!
### Usage
Call `unwrap()` on any `Optional`, optionally giving a `debugMessage` for debugging purposes:
```swift
struct Person {
let name: String
let email: String
init(dictionary: [String: Any]) {
name = dictionary["name"].unwrap(debug: "Unable to find json Element Name") as! String
email = dictionary["email"].unwrap(debug: "Unable to find json Element Email") as! String
}
}
let dictionary = ["ame": "Chris", "email": "chrisbkarani@gmail.com"]
let chris = Person(dictionary: dictionary)
print(chris.name) //Chris
print(chris.email) // chrisbkarani@gmail.com
```
## Another Real-World Example
#### Without Using Unwrap
```swift
class LoginController: UIViewController {
var token: Token?
override func viewDidLoad() {
super.viewDidLoad()
// more code is more bugs
guard let unwrappedToken = token else {
// if this crashes we enter a 'nil' state in our app with no debug information
return
}
LoginService.login(unwrappedToken)
}
}
```
#### With Unwrap
```swift
class LoginController: UIViewController {
var token: Token?
override func viewDidLoad() {
super.viewDidLoad()
LoginService.login(token.unwrap())
}
}
```
### Installing
- **For iOS 8+ projects** with [CocoaPods](https://cocoapods.org):
```ruby
pod 'Sukari'
```
### Contributing
Please read [CONTRIBUTING.md](https://github.com/chrisbkarani/Sugar/blob/master/Contribution.md) for details on our code of conduct, and the process for submitting pull requests to us.
### Authors
#### Chris Karani
### License
This project is licensed under the MIT License - see the [LICENSE.md](https://github.com/chrisbkarani/Sugar/blob/master/LICENSE) file for details
