mirror of
https://github.com/ethauvin/kotlin-pluralizer.git
synced 2025-04-24 16:27:12 -07:00
73 lines
2.9 KiB
Markdown
73 lines
2.9 KiB
Markdown
|
||
# kotlin-pluralizer
|
||
|
||
**kotlin extension** to **pluralize** and **singularize** strings
|
||
|
||
[](https://travis-ci.org/cesarferreira/kotlin-pluralizer) [](https://jitpack.io/#cesarferreira/kotlin-pluralizer)
|
||
|
||
### Show some love
|
||
[](https://github.com/cesarferreira/kotlin-pluralizer) [](https://twitter.com/cesarmcferreira)
|
||
|
||
## Usage
|
||
|
||
|
||
**Pluralization:**
|
||
|
||
```kotlin
|
||
"person".pluralize() # => "people"
|
||
"post".pluralize() # => "posts"
|
||
"sheep".pluralize() # => "sheep"
|
||
"foot".pluralize() # => "feet"
|
||
```
|
||
|
||
**Singuralization:**
|
||
|
||
```kotlin
|
||
"words".singularize() # => "word"
|
||
"octopi".singularize() # => "octopus"
|
||
"people".singularize() # => "person"
|
||
"feet".singularize() # => "foot"
|
||
```
|
||
|
||
**Quantities:**
|
||
```kotlin
|
||
"person".pluralize(1) # => "person"
|
||
"person".pluralize(2) # => "people"
|
||
```
|
||
|
||
## Install
|
||
|
||
```groovy
|
||
repositories {
|
||
jcenter()
|
||
maven { url "https://jitpack.io" }
|
||
}
|
||
dependencies {
|
||
compile 'com.github.cesarferreira:kotlin-pluralizer:0.2.9'
|
||
}
|
||
```
|
||
|
||
## Contributing
|
||
|
||
I welcome and encourage all pull requests. It usually will take me within 24-48 hours to respond to any issue or request. Here are some basic rules to follow to ensure timely addition of your request:
|
||
1. Match coding style (braces, spacing, etc.) This is best achieved using `CMD`+`Option`+`L` (Reformat code) on Mac (not sure for Windows) with Android Studio defaults.
|
||
2. If its a feature, bugfix, or anything please only change code to what you specify.
|
||
3. Please keep PR titles easy to read and descriptive of changes, this will make them easier to merge :)
|
||
4. Pull requests _must_ be made against `develop` branch. Any other branch (unless specified by the maintainers) will get rejected.
|
||
5. Check for existing [issues](https://github.com/cesarferreira/kotlin-pluralizer/issues) first, before filing an issue.
|
||
6. Have fun!
|
||
|
||
|
||
## Credits
|
||
|
||
The pluralize and singularize methods are based on the code found in the following places.
|
||
|
||
- https://github.com/rails/rails/blob/26698fb91d88dca0f860adcb80528d8d3f0f6285/activesupport/lib/active_support/inflector/inflections.rb
|
||
|
||
- https://github.com/atteo/evo-inflector/blob/master/src/main/java/org/atteo/evo/inflector/English.java
|
||
- http://www.java2s.com/Tutorial/Java/0040__Data-Type/Transformswordstosingularpluralhumanizedhumanreadableunderscorecamelcaseorordinalform.htm
|
||
- https://github.com/MehdiK/Humanizer.jvm
|
||
|
||
|
||
### Created & Maintained By
|
||
[Cesar Ferreira](https://github.com/cesarferreira) ([@cesarmcferreira](https://www.twitter.com/cesarmcferreira))
|