README.md

inflect

This is a Scala verison of Damian Conway's Inflect Perl Module (http://search.cpan.org/~dconway/Lingua-EN-Inflect-1.895/). I hope to add most of the features from that module and I want the resulting library to also be usable from Java, although maybe not supporting every feature.

Scala Usage

Pluralizing Nouns

import uk.me.chrs.inflect.Inflect_EN._

//Unconditional plural
println("I see dead " + many("person"))

//Conditional plural
val cakes = 1
val pies = 2
println("The picnic contains " + cakes + " " + plural(cakes, "cake") +
  ", " + pies + " " + plural(pies, "pie")

//Simplify the above
println("The picnic contains " + count(cakes, "sweet") + ", " + count(pies, "savoury")

I see dead people
The picnic contains 1 cake, 2 pies
The picnic contains 1 sweet, 2 savouries

Adding indefinite article

import uk.me.chrs.inflect.Inflect_EN._

val insect = "bee"
println("That is " + one(insect))
val person = "European"
println("He is " + one(person))
println("It was " + one("8 legged creature"))
println("He works for " + one("NGO"))

//Or the following:
val beers = 0
val wines = 1
val snacks = 5

println("I ordered " + some(beers,"beer") + ", " + some(wines,"wine") + " and " + some(snacks,"snack"))

That is a bee
He is a European
It was an 8 legged beast
He works for an NGO

I ordered no beers, a wine and snacks

Numbers in words

import uk.me.chrs.inflect.Inflect_EN._

println("You are customer number " + cardinal(78))
println("This year's budget is " + cardinal("89000000000") + " dollars")

You are customer number seventy-eight
This year's budget is eighty-nine billion dollars

Ordinals

import uk.me.chrs.inflect.Inflect_EN._

println("This is your " + ordinal(3) + " attempt")
println("This is your " + ordinal("five") + " attempt")
println("While this is your " + textOrdinal(8))

This is your 3rd attempt
This is your fifth attempt
While this is your eighth

Choosing the locale

The output defaults to British English, since I'm a Brit. But you can make this explicit, or use US variants by making the relevant imports

println("Your score is " + uk.me.chrs.inflect.Inflect_EN_GB.cardinal(-6007))
println("Your score is " + uk.me.chrs.inflect.Inflect_EN_US.cardinal(-6007))

Your score is minus six thousand and seven
Your score is minus six thousand seven

Using the plural builder

To simplify matters in some cases, you can use the plural builder. You will need to import Builder._ from within the given inflector.

import uk.me.chrs.inflect.Inflect_EN.Builder._

val crowdSize = 1
println("There " + using(crowdSize)(plural("is"),q(" "),count("person"),q(" with "),some("opinion"))
println("There " + using(crowdSize+1)(plural("is"),q(" "),count("person"),q(" with "),some("opinion"))

There is 1 person with an opinion
There are 2 people with opinions

Java Usage

Pluralizing Nouns

static import uk.me.chrs.inflect.Inflect_EN.*;

System.out.println("Here are your " + many("photo"));
int shocks = 1;
System.out.println("Applying electrical " + plural(shocks, "stimulus");
System.out.println("I ate " + count(7, "muffin");

Here are your photos
Applying electrical stimulus
I ate 7 muffins

Indefinite Article

static import uk.me.chrs.inflect.Inflect_EN.*;

System.out.println("That is " + one("XML document"));

int errors = 0;
System.out.println("Outcome: " + some(errors, "error")

That is an XML document
Outcome: no errors

Numbers in words

static import uk.me.chrs.inflect.Inflect_EN.*;

System.out.println("You are customer number " + cardinal(78));
System.out.println("This year's budget is " + cardinal("89000000000") + " dollars");

You are customer number seventy-eight
This year's budget is eighty-nine billion dollars

Ordinals

static import uk.me.chrs.inflect.Inflect_EN.*;

System.out.println("This is your " + ordinal(3) + " attempt");
System.out.println("This is your " + ordinal("five") + " attempt");
System.out.println("While this is your " + textOrdinal(8));

This is your 3rd attempt
This is your fifth attempt
While this is your eighth