Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nurugger07/inflex
An Inflector library for Elixir
https://github.com/nurugger07/inflex
Last synced: 9 days ago
JSON representation
An Inflector library for Elixir
- Host: GitHub
- URL: https://github.com/nurugger07/inflex
- Owner: nurugger07
- License: apache-2.0
- Created: 2013-12-09T18:22:04.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2024-04-12T20:25:20.000Z (7 months ago)
- Last Synced: 2024-10-19T19:24:31.720Z (20 days ago)
- Language: Elixir
- Size: 111 KB
- Stars: 379
- Watchers: 6
- Forks: 56
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- freaking_awesome_elixir - Elixir - An Inflector library for Elixir. (Text and Numbers)
- fucking-awesome-elixir - inflex - An Inflector library for Elixir. (Text and Numbers)
- awesome-elixir - inflex - An Inflector library for Elixir. (Text and Numbers)
README
# Inflex
[](https://travis-ci.org/nurugger07/inflex)
[](https://hex.pm/packages/inflex)
[](https://hexdocs.pm/inflex/)
[](https://hex.pm/packages/inflex)
[](https://github.com/nurugger07/inflex/blob/master/LICENSE)
[](https://github.com/nurugger07/inflex/commits/master)
An Elixir library for handling word inflections.
## Getting Started
You can add Inflex as a dependency in your `mix.exs` file. Since it only requires Elixir and Erlang there are no other dependencies.
```elixir
def deps do
[
{:inflex, "~> 2.0.0"}
]
end
```
If you are not using [hex](http://hex.pm) you can add the dependency using the GitHub repository.
```elixir
def deps do
[
{:inflex, github: "nurugger07/inflex"}
]
end
```
Then run `mix deps.get` in the shell to fetch and compile the dependencies.
### Requirements
Although Inflex supports Elixir 1.6, which is [compatible](https://hexdocs.pm/elixir/compatibility-and-deprecations.html#compatibility-between-elixir-and-erlang-otp) with Erlang/OTP 19–20, [Inflex requires Erlang/OTP 20+](https://github.com/nurugger07/inflex/blob/master/lib/inflex/parameterize.ex#L21).
To incorporate Inflex in your modules, use `import`.
```elixir
defmodule Blog do
import Inflex
def greeting(count), do: "You are the #{ordinalize(count)} visitor!"
end
```
## Examples
### Singularize & Pluralize
Here are some basic examples from `iex`:
```elixir
iex(1)> Inflex.singularize("dogs")
"dog"
iex(2)> Inflex.pluralize("dog")
"dogs"
iex(3)> Inflex.singularize("people")
"person"
iex(4)> Inflex.pluralize("person")
"people"
```
Some other special cases are handled for nouns ending in -o and -y
```elixir
iex(1)> Inflex.pluralize("piano")
"pianos"
iex(2)> Inflex.pluralize("hero")
"heroes"
iex(3)> Inflex.pluralize("butterfly")
"butterflies"
iex(4)> Inflex.pluralize("monkey")
"monkeys"
```
### Inflect
```elixir
iex(1)> Inflex.inflect("child", 1)
"child"
iex(2)> Inflex.inflect("child", 2)
"children"
```
### Camelize & Pascalize
Inflex also camelizes or pascalizes strings and atoms.
```elixir
iex(1)> Inflex.camelize(:upper_camel_case)
"UpperCamelCase"
iex(2)> Inflex.camelize("pascal-case", :lower)
"pascalCase"
```
### Parameterize
Strings can be parameterized easily.
```elixir
iex(1)> Inflex.parameterize("String for parameter")
"string-for-parameter"
iex(2)> Inflex.parameterize("String with underscore", "_")
"string_with_underscore"
```
### Underscore
Makes an underscored, lowercase form from a string or atom.
```elixir
iex(1)> Inflex.underscore("UpperCamelCase")
"upper_camel_case"
iex(2)> Inflex.underscore("pascalCase")
"pascal_case"
iex(3)> Inflex.underscore(UpperCamelCase)
"upper_camel_case"
iex(4)> Inflex.underscore(:pascalCase)
"pascal_case"
```
## Contributing
All pull requests will be reviewed for inclusion but must include tests.
## License
Copyright (c) 2013 Johnny Winn
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at [http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.