Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/joshualat/Pluralize.swift

Great Swift String Pluralize Extension
https://github.com/joshualat/Pluralize.swift

Last synced: 3 months ago
JSON representation

Great Swift String Pluralize Extension

Awesome Lists containing this project

README

        

Pluralize.swift
===============

Great Swift String Pluralize Extension

- case-insensitive
- tons of rules for irregular nouns (plural form)
- supports uncountable nouns
- allows dynamic addition of rules

Read [this post](http://joshualat.com/posts/pluralize-swift/) for more information.

Basic usage
-----------
~~~ swift
import Pluralize

"Person".pluralize()
// People

"Wolf".pluralize(count: 1)
// Wolf

"Person".pluralize(with: "Persons")
// Persons
~~~

Examples
-------------------------
| Irregular Nouns | | Always Singular in Form | |
| ------------------------ | ------------- | ------------------------- | ---------------- |
| "Amnesty".pluralize() | Amnesties | "Coffee".pluralize() | Coffee |
| "Dwarf".pluralize() | Dwarves | "Compassion".pluralize() | Compassion |
| "Hypothesis".pluralize() | Hypotheses | "Deer".pluralize() | Deer |
| "Oasis".pluralize() | Oases | "Food".pluralize() | Food |
| "Scarf".pluralize() | Scarves | "Happiness".pluralize() | Happiness |
| "Tableau".pluralize() | Tableaux | "Species".pluralize() | Species |
| "Vertebra".pluralize() | Vertebrae | "Stuff".pluralize() | Stuff |

Adding Custom Rules: Singular = Plural
--------------------------------------
~~~ swift
"Shrimp".pluralize()
// Shrimps

Pluralize.unchanging("shrimp")

"Shrimp".pluralize()
// Shrimp
~~~

Adding Custom Rules: Uncountable
--------------------------------
~~~ swift
"Water".pluralize()
// Waters

Pluralize.uncountable("water")
"Water".pluralize()
// Water
~~~

Adding Custom Rules: New Regex Rule
-----------------------------------
~~~ swift
"Person".pluralize()
// People

Pluralize.rule("(p)erson$", with: "$1ersons")
"Person".pluralize()
// Persons
"Spokesperson".pluralize()
// Spokespersons
~~~

Example Regex Rules:
--------------------
~~~ swift
Pluralize.rule("(criteri|phenomen)on$", with:"$1a")
Pluralize.rule("(potat|tomat|volcan)o$", with:"$1oes")
Pluralize.rule("^(|wo|work)man$", with: "$1men")
Pluralize.rule("(f)oot$", with: "$1eet")
Pluralize.rule("lf$", with: "$1lves")
Pluralize.rule("(t)ooth$", with: "$1eeth")
Pluralize.rule("(g)oose$", with: "$1eese")
Pluralize.rule("^(c)hild$", with: "$1hildren")
Pluralize.rule("^(o)x$", with: "$1xen")
~~~

Adding Custom Rules: Whole Words
--------------------
~~~ swift
Pluralize.rule("were", with: "was")
~~~

Installation
------------

**Cocoapods**

pod 'Pluralize.swift'

in code then

import Pluralize_swift

**Manual Installation**

1. _git clone https://github.com/joshualat/Pluralize.swift.git_ inside your project folder
2. Drag the **Pluralize.xcodeproj** file into the file navigator of your project.
3. Ensure that the deployment target of **Pluralize.framework** matches that of the application target.
4. In your target’s **Build Phases**, add **Pluralize**
to the **Target Dependencies** build phase.
5. Add the appropriate **Pluralize.framework** product to the
**Link Binary With Libraries** build phase.
6. Add the same **Pluralize.framework** to a **Copy Files** build phase with a
**Frameworks** destination.

License
-------
Copyright (c) 2014 Joshua Arvin Lat

MIT License

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.