Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/T-Pham/NoOptionalInterpolation
✍️ No "Optional(...)" in string interpolation + Easy pluralization
https://github.com/T-Pham/NoOptionalInterpolation
cartfile carthage cocoapods ios optional osx plural-form pluralization podfile quantity string-interpolation swift tvos watchos
Last synced: 3 months ago
JSON representation
✍️ No "Optional(...)" in string interpolation + Easy pluralization
- Host: GitHub
- URL: https://github.com/T-Pham/NoOptionalInterpolation
- Owner: T-Pham
- License: mit
- Created: 2016-05-27T09:14:18.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-10-24T09:02:25.000Z (about 7 years ago)
- Last Synced: 2024-04-29T03:40:42.110Z (6 months ago)
- Topics: cartfile, carthage, cocoapods, ios, optional, osx, plural-form, pluralization, podfile, quantity, string-interpolation, swift, tvos, watchos
- Language: Swift
- Homepage:
- Size: 75.2 KB
- Stars: 51
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-swift - NoOptionalInterpolation - Get rid of "Optional(...)" and "nil" in string interpolation. Easy pluralization. (Libs / Localization)
- awesome-ios-star - NoOptionalInterpolation - Get rid of "Optional(...)" and "nil" in string interpolation. Easy pluralization. (Text / Other Testing)
- awesome-ios - NoOptionalInterpolation - Get rid of "Optional(...)" and "nil" in string interpolation. Easy pluralization. (Text / Other Testing)
- awesome-swift - NoOptionalInterpolation - No 'Optional(...)' in string interpolation + Easy pluralization ` 📝 4 years ago ` (Localization [🔝](#readme))
README
```
' ____ ___
' | \ / \
' | _ || |
' | | || O |
' | | || |
' | | || |
' |__|__| \___/
'
' ___ ____ ______ ____ ___ ____ ____ _
' / \ | \| || |/ \ | \ / || |
' | || o ) | | || || _ || o || |
' | O || _/|_| |_| | || O || | || || |___
' | || | | | | || || | || _ || |
' | || | | | | || || | || | || |
' \___/ |__| |__| |____|\___/ |__|__||__|__||_____|
'
' ____ ____ ______ ___ ____ ____ ___ _ ____ ______ ____ ___ ____
' | || \ | | / _]| \ | \ / \ | | / || || |/ \ | \
' | | | _ || | / [_ | D )| o ) || | | o || | | || || _ |
' | | | | ||_| |_|| _]| / | _/| O || |___ | ||_| |_| | || O || | |
' | | | | | | | | [_ | \ | | | || || _ | | | | || || | |
' | | | | | | | | || . \| | | || || | | | | | || || | |
' |____||__|__| |__| |_____||__|\_||__| \___/ |_____||__|__| |__| |____|\___/ |__|__|
'
```
# NoOptionalInterpolation
[](https://travis-ci.org/T-Pham/NoOptionalInterpolation)
[](https://github.com/T-Pham/NoOptionalInterpolation/issues)
[](https://codecov.io/gh/T-Pham/NoOptionalInterpolation)
[](http://cocoadocs.org/docsets/NoOptionalInterpolation)
[](https://github.com/T-Pham/NoOptionalInterpolation/releases)
[](https://github.com/T-Pham/NoOptionalInterpolation)
[](LICENSE)
[](https://github.com/Carthage/Carthage)
[](https://cocoapods.org/pods/NoOptionalInterpolation)
[](https://cocoapods.org/pods/NoOptionalInterpolation)
## Description
NoOptionalInterpolation gets rid of "Optional(...)" and "nil" in Swift's string interpolation. This is particularly helpful when you set text to UI elements such as `UILabel` or `UIButton`. Since XCode currently, as of the time this is written, does not show any warnings when interpolating `Optional`s, and you might sometimes need to change your variables' type between `Optional` and non-`Optional`, this library ensures that the text you set never ever includes that annoying additional "Optional(...)". You can also revert to the default behavior when needed.
Besides, the library makes pluralizing your text easier with custom operators.
## Usage
### Remove "Optional(...)" and "nil":
Just import NoOptionalInterpolation and everything is done for you.
```swift
import NoOptionalInterpolation
let n: Int? = 1
let t: String? = nil
let s: String? = "string1"
let o: String?? = "string2"
let i = "\(n) \(t) \(s) \(o)"
print(i) // 1 string1 string2
```
Also, please note that this does not affect the `print` function. Hence, `print(o)` (as opposed to `print("\(o)")`, `o` as in the example above) would still print out `Optional(Optional("string2"))`.
### Revert to the default behavior:
Use the `*` operator for your `Optional`s.
```swift
...
let i = "\(n*) \(t*) \(s*) \(o*)"
print(i) // Optional(1) nil Optional("string1") Optional(Optional("string2"))
```
### Pluralization:
Use the `~` operator to pluralize words.
```swift
let age = 42
let text = "I am \(age ~ "year") old" // "I am 42 years old" // actually not // for now
```
Use the `/` operator to provide the plural form.
```swift
let memberCount = 42
let text = "The team consists of \(memberCount ~ "person" / "people")" // "The team consists of 42 people"
```
To omit the quantity, swap the position of the quantity and the word.
```swift
let listenerCount = 42
let text = "Do it \("yourself" / "yourselves" ~ listenerCount)" // "Do it yourselves"
```
It also works with `Optional`s.
```swift
let count: Int?? = 42
let fruit: String?? = "apple"
let text = "I have \(count ~ fruit)" // "I have 42 apples"
```
By default, if you don't provide a plural form using the `/` operator, an "s" is appended to your word to make the plural form. To make the pluralization smarter, you can specify a custom `PluralizerType`. You can find one [here](https://github.com/joshualat/Pluralize.swift).
In your Podfile:
```ruby
pod 'Pluralize.swift', :git => "https://github.com/joshualat/Pluralize.swift.git"
```
NOTE: `Pluralize.swift` pod is not yet compatible with Swift 3.
Then:
```swift
import NoOptionalInterpolation
import Pluralize_swift
extension Pluralize: NoOptionalInterpolation.Pluralizer {}
...
NoOptionalInterpolation.PluralizerType = Pluralize.self
assert(42 ~ "oasis" == "42 oases")
```
## Installation
### [Carthage](https://github.com/Carthage/Carthage)
Add the line below to your Cartfile:
```ruby
github "T-Pham/NoOptionalInterpolation"
```
### [CocoaPods](https://cocoapods.org/pods/NoOptionalInterpolation)
Add the line below to your Podfile:
```ruby
pod 'NoOptionalInterpolation'
```
### [Manually](https://google.com)
Add all the files in [`/NoOptionalInterpolation/Classes/`](/NoOptionalInterpolation/Classes/) to your project. You are all set.
## Compatibility
From version 3.0.0, Swift 3 syntax is used. If your project is still using earlier versions of Swift, please use a NoOptionalInterpolation version prior to 3.0.0.
Podfile
```ruby
pod 'NoOptionalInterpolation', '~> 2.0.6'
```
or Cartfile
```ruby
github "T-Pham/NoOptionalInterpolation" ~> 2.0.6
```
## License
NoOptionalInterpolation is available under the MIT license. See the [LICENSE](LICENSE) file for more info.