Inflector.cfc

<cfcomponent displayname="Inflector" output="no">

	<!--- SETUP --->

	<cfset variables.plurals      = arraynew(1)>
	<cfset variables.pronouns     = arraynew(1)>
	<cfset variables.singulars    = arraynew(1)>
	<cfset variables.irregulars   = arraynew(1)>
	<cfset variables.uncountables = "">

	<cfscript>

		 // Pronouns.
		 pronoun('I', 'we');
		 pronoun('me', 'us');
		 pronoun('he', 'they');
		 pronoun('she', 'they');
		 pronoun('them', 'them');
		 pronoun('myself', 'ourselves');
		 pronoun('yourself', 'yourselves');
		 pronoun('itself', 'themselves');
		 pronoun('herself', 'themselves');
		 pronoun('himself', 'themselves');
		 pronoun('themself', 'themselves');
		 pronoun('is', 'are');
		 pronoun('was', 'were');
		 pronoun('has', 'have');
		 pronoun('this', 'these');
		 pronoun('that', 'those');

		// singular -> plural rules (most generic first)
		plural('$', 's');
		plural('s$', 's');
		plural('(ax|test)is$', '\1es');
		plural('(octop|vir)us$', '\1i');
		plural('(octop|vir)i$', '\1i');
		plural('(alias|status)$', '\1es');
		plural('(bu)s$', '\1ses');
		plural('(buffal|tomat)o$', '\1oes');
		plural('([ti])um$', '\1a');
		plural('([ti])a$', '\1a');
		plural('s[ei]s$', 'ses');
		plural('(?:([^f])fe|([lr])f)$', '\1\2ves');
		plural('(hive)$', '\1s');
		plural('([^aeiouy]|qu)y$', '\1ies');
		plural('(x|ch|ss|sh)$', '\1es');
		plural('(matr|vert|ind)(?:ix|ex)$', '\1ices');
		plural('([m|l])ouse$', '\1ice');
		plural('([m|l])ice$', '\1ice');
		plural('^(ox)(en)?$', '\1en');
		plural('(quiz)$', '\1zes');
		plural('(r|m|wom)en$', '\1en');
		plural('(people)$', '\1');
		
		plural('deer$','\1');
		plural('[^aeiou]ese$','\1');
		plural('fish$','\1');
		plural('pox$','\1');
		plural('sheep$','\1');

		// plural -> singular rules (most generic first)
		singular('s$', '');
		singular('(n)ews$', '\1ews');
		singular('([ti])a$', '\1um');
		singular('((a)naly|(b)a|(d)iagno|(p)arenthe|(p)rogno|(s)ynop|(t)he)s[ei]s$', '\1\2sis');
		singular('(^analy)s[ei]s$', '\1sis');
		singular('([^f])ves$', '\1fe');
		singular('([dht]ive)s$', '\1');
		singular('([lr])ves$', '\1f');
		singular('([lr])ives$', '\1');
		singular('([^aeiouy]|qu)ies$', '\1y');
		singular('(s)eries$', '\1eries');
		singular('(m)ovies$', '\1ovie');
		singular('(x|ch|ss|sh)es$', '\1');
		singular('([m|l])ice$', '\1ouse');
		singular('(bus)(es)?$', '\1');
		singular('(o)es$', '\1');
		singular('(shoe)s$', '\1');
		singular('(f)eet$','\1oot');
		singular('(analys|ax|cris|test|thes)[ei]s$', '\1is');
		singular('(alumn|bacill|cact|foc|fung|octop|nucle|radi|stimul|syllab|termin|viri)(i|us)$', '\1us');
		singular('(alias|status)(es)?$', '\1');
		singular('^(ox)en', '\1');
		singular('(vert|ind)ices$', '\1ex');
		singular('(matr)ices$', '\1ix');
		singular('(quiz)zes$', '\1');
		singular('(database)s$', '\1');
		singular('(ess)$', '\1');

		// irregulars (singular, plural)
		irregular('person', 'people');
		irregular('man', 'men');
		irregular('woman', 'women');
		irregular('child', 'children');
		irregular('sex', 'sexes');
		irregular('move', 'moves');
		irregular('zombie', 'zombies');
		irregular('safe', 'safes');
		irregular('me','us');
		irregular('he','they');
		irregular('she','they');
		irregular('is','are');
		irregular('stigma','stigmata');
		
	// Singular words with no plurals.
		uncountable('adulthood');
		uncountable('advice');
		uncountable('agenda');
		uncountable('aid');
		uncountable('aircraft');
		uncountable('alcohol');
		uncountable('ammo');
		uncountable('analytics');
		uncountable('anime');
		uncountable('athletics');
		uncountable('audio');
		uncountable('bison');
		uncountable('blood');
		uncountable('bream');
		uncountable('buffalo');
		uncountable('butter');
		uncountable('carp');
		uncountable('cash');
		uncountable('chassis');
		uncountable('chess');
		uncountable('clothing');
		uncountable('coal');
		uncountable('cod');
		uncountable('coitus')
		uncountable('commerce');
		uncountable('compensation')
		uncountable('cooperation');
		uncountable('corps');
		uncountable('cotton');
		uncountable('data');
		uncountable('debris');
		uncountable('deer');
		uncountable('diabetes');
		uncountable('digestion');
		uncountable('education');
		uncountable('elk');
		uncountable('emoji');
		uncountable('energy');
		uncountable('equipment');
		uncountable('evidence');
		uncountable('excretion');
		uncountable('expertise');
		uncountable('feedback');
		uncountable('firmware');
		uncountable('flounder');
		uncountable('flour');
		uncountable('fun');
		uncountable('furniture');
		uncountable('gallows');
		uncountable('garbage');
		uncountable('gold');
		uncountable('graffiti');
		uncountable('hardware');
		uncountable('headquarters');
		uncountable('health');
		uncountable('herpes');
		uncountable('highjinks');
		uncountable('homework');
		uncountable('housework');
		uncountable('impatience');
		uncountable('information');
		uncountable('innings');
		uncountable('jeans');
		uncountable('jedi');
		uncountable('justice');
		uncountable('knowledge');
		uncountable('kudos');
		uncountable('labour');
		uncountable('leather');
		uncountable('love');
		uncountable('literature');
		uncountable('luggage');
		uncountable('machinery');
		uncountable('mackerel');
		uncountable('mail');
		uncountable('media');
		uncountable('metadata');
		uncountable('mews');
		uncountable('moose');
		uncountable('mud');
		uncountable('manga');
		uncountable('music');
		uncountable('news');
		uncountable('nutrition');
		uncountable('offspring');
		uncountable('oil');
		uncountable('only');
		uncountable('patience');
		uncountable('personnel');
		uncountable('pike');
		uncountable('plankton');
		uncountable('pliers');
		uncountable('police');
		uncountable('pollution');
		uncountable('premises');
		uncountable('rain');
		uncountable('research');
		uncountable('rice');
		uncountable('rinoceros');
		uncountable('salmon');
		uncountable('scissors');
		uncountable('series');
		uncountable('sewage');
		uncountable('shambles');
		uncountable('sheep');
		uncountable('shrimp');
		uncountable('software');
		uncountable('staff');
		uncountable('swine');
		uncountable('talent');
		uncountable('tennis');
		uncountable('toothpaste');
		uncountable('traffic');
		uncountable('transportation');
		uncountable('trout');
		uncountable('tuna');
		uncountable('wealth');
		uncountable('welfare');
		uncountable('whiting');
		uncountable('wildebeest');
		uncountable('wildlife');
		uncountable('you');
	</cfscript>

	<!--- PUBLIC callable functions --->

	<!--- function for returning the plural form of a word --->
	<cffunction name="pluralize" access="public" returntype="string" output="no" hint="Returns the plural form of a word">
		<cfargument name="word" type="string" required="yes" hint="The word to get the plural for">
		<cfset var i = 0>
		<cfset var pluralsandpronouns = variables.plurals.append(variables.pronouns) />
		<cfif NOT listfind(variables.uncountables, lcase(arguments.word))>
			<cfloop from="1" to="#arraylen(pluralsandpronouns)#" index="i">
				<cfif refindnocase(pluralsandpronouns[i]['rule'], arguments.word)>
					<cfset arguments.word = rereplacenocase(arguments.word, pluralsandpronouns[i]['rule'], pluralsandpronouns[i]['replacement'])>
					<cfbreak>
				</cfif>
			</cfloop>
		</cfif>
		<cfreturn arguments.word>
	</cffunction>
    <cfset pluralise = duplicate(pluralize) />

	<!--- function for returning the singular form of a word --->
	<cffunction name="singularize" access="public" returntype="string" output="no" hint="Returns the singular form of a word">
		<cfargument name="word" type="string" required="yes" hint="The word to get the singular for">
		<cfset var i = 0>
		<cfif NOT listfind(variables.uncountables, lcase(arguments.word))>
			<cfloop from="1" to="#arraylen(variables.singulars)#" index="i">
				<cfif refindnocase(variables.singulars[i]['rule'], arguments.word)>
					<cfset arguments.word = rereplacenocase(arguments.word, variables.singulars[i]['rule'], variables.singulars[i]['replacement'])>
					<cfbreak>
				</cfif>
			</cfloop>
		</cfif>
		<cfreturn arguments.word>
	</cffunction>
    <cfset singularise = duplicate(singularize) />

	<!--- function for capitalising the first character of a string --->
	<cffunction name="capitalize" access="public" returntype="string" output="no" hint="Capitalises the first character in a string">
		<cfargument name="string" type="string" required="yes" hint="The string to capitalise">
		<cfif len(arguments.string) LT 2><cfreturn ucase(arguments.string)></cfif>
		<cfreturn ucase(left(arguments.string, 1)) & right(arguments.string, len(arguments.string)-1)>
	</cffunction>
    <cfset capitalise = duplicate(capitalize) />

	<!--- function for PascalCasing a string --->
	<cffunction name="PascalCase" access="public" returntype="string" output="no" hint="Returns a given string, converted to PascalCase.  All non-alphanum characters are stripped.">
		<cfargument name="string" type="string" required="yes" hint="The string to PascalCase">
		<cfset var str = "">
		<cfset var i = 0>
		<!--- split the string into tokens based on non-alphanum characters --->
		<cfset var tokens = trim(arguments.string).split("[^a-zA-Z0-9]")>
		<cfloop from="1" to="#arraylen(tokens)#" index="i">
			<!--- loop through each token and capitalise it --->
			<cfif len(tokens[i])><cfset str = str & capitalise(tokens[i])></cfif>
		</cfloop>
		<cfreturn str>
	</cffunction>

	<!--- function for CamelCasing a string --->
	<cffunction name="camelCase" access="public" returntype="string" output="no" hint="Returns a given string, converted to camelCase.  All non-alphanum characters are stripped.">
		<cfargument name="string" type="string" required="yes" hint="The string to camelCase">
		<cfset var str = "">
		<cfset var i = 0>
		<!--- split the string into tokens based on non-alphanum characters --->
		<cfset var tokens = trim(arguments.string).split("[^a-zA-Z0-9]")>
		<cfloop from="1" to="#arraylen(tokens)#" index="i">
			<!--- loop through each token and capitalise it --->
			<cfif len(tokens[i])>
				<cfif index === 1>
					<cfset str = str & capitalise(tokens[i])>
				<cfelse>
					<cfset str = str & capitalise(tokens[i])>
				</cfif>
			</cfif>
		</cfloop>
		<cfreturn str>
	</cffunction>

	<!--- function for variablising a string --->
	<cffunction name="variablize" access="public" returntype="string" output="no" hint="Converts a string to a variable name, e.g. PascalCase or camelCase becomes camel_case, 'big CSSDogThing' becomes big_css_dog_thing etc.">
		<cfargument name="string" type="string" required="yes" hint="The string to variablise">
		<cfset arguments.string = replace(trim(rereplace(arguments.string, "([^[:alnum:]_-]+)", " ", "ALL")), " ", "-", "ALL")>
		<cfset arguments.string = rereplace(arguments.string, "([A-Z]+)([A-Z][a-z])", "\1_\2", "ALL")>
		<cfset arguments.string = rereplace(arguments.string, "([a-z\d])([A-Z])", "\1_\2", "ALL")>
		<cfreturn lcase(replace(arguments.string, "-", "_", "ALL"))>
	</cffunction>
    <cfset variablise = duplicate(variablize) />

	<!--- function for humanising a string --->
	<cffunction name="humanize" access="public" returntype="string" output="no" hint="Converts a string to a human-readable string, e.g. PascalCase or camelCase becomes Camel Case, my_field_id becomes my_field etc.">
		<cfargument name="string" type="string" required="yes" hint="The string to humanise">
		<cfset arguments.string = replace(trim(rereplace(rereplace(arguments.string, "_id$", ""), "([^[:alnum:]_-]+)", " ", "ALL")), "_", " ", "ALL")>
		<cfset arguments.string = rereplace(arguments.string, "([A-Z]+)([A-Z][a-z])", "\1 \2", "ALL")>
		<cfreturn rereplace(arguments.string, "([a-z\d])([A-Z])", "\1 \2", "ALL")>
	</cffunction>
    <cfset humanise = duplicate(humanize) />

	<!--- function for working out if a given character is upper-case --->
	<cffunction name="isCapital" access="public" returntype="boolean" output="no" hint="Is a given character upper-case?">
		<cfargument name="char" type="string" required="yes" hint="">
		<cfreturn asc(char) GTE 65 AND asc(char) LTE 90>
	</cffunction>

	<!--- function to pad a string with spaces --->
	<cffunction name="pad" access="public" returntype="string" output="no" hint="Pads a string with spaces up to a given length">
		<cfargument name="str" type="string" required="yes" hint="The string to pad">
		<cfargument name="minlen" type="numeric" required="yes" hint="The length to pad to">
		<cfif len(str) GTE arguments.minlen><cfreturn arguments.str></cfif>
		<cfreturn str & repeatstring(" ", arguments.minlen-len(arguments.str))>
	</cffunction>

	<!--- PRIVATE functions for component setup --->

	<!--- function for specifying a new pluralisation rule and its replacement --->
	<cffunction name="plural" access="private" returntype="void" output="no" hint="Specifies a new pluralisation rule and its replacement">
		<cfargument name="rule" type="string" required="yes" hint="The regex rule to match">
		<cfargument name="replacement" type="string" required="yes" hint="The replacement value to use for this rule">
		<cfset var pl = structnew()>
		<cfset pl.rule = arguments.rule>
		<cfset pl.replacement = arguments.replacement>
		<cfset arrayprepend(variables.plurals, pl)>
	</cffunction>

	<!--- function for specifying a new pluralisation rule and its replacement --->
	<cffunction name="pronoun" access="private" returntype="void" output="no" hint="Specifies a new pluralisation rule and its replacement">
		<cfargument name="rule" type="string" required="yes" hint="The regex rule to match">
		<cfargument name="replacement" type="string" required="yes" hint="The replacement value to use for this rule">
		<cfset var pr = structnew()>
		<cfset pr.rule = arguments.rule>
		<cfset pr.replacement = arguments.replacement>
		<cfset arrayprepend(variables.pronouns, pr)>
	</cffunction>


	<!--- function for specifying a new singularisation rule and its replacement --->
	<cffunction name="singular" access="private" returntype="void" output="no" hint="Specifies a new singularisation rule and its replacement">
		<cfargument name="rule" type="string" required="yes" hint="The regex rule to match">
		<cfargument name="replacement" type="string" required="yes" hint="The replacement value to use for this rule">
		<cfset var pl = structnew()>
		<cfset pl.rule = arguments.rule>
		<cfset pl.replacement = arguments.replacement>
		<cfset arrayprepend(variables.singulars, pl)>
	</cffunction>

	<!--- function for adding irregular words that don't fit any norms --->
	<cffunction name="irregular" access="private" returntype="void" output="no" hint="Adds irregular words to the inflector that don't conform to any norms">
		<cfargument name="sin" type="string" required="yes" hint="The singular form of the word">
		<cfargument name="plu" type="string" required="yes" hint="The plrual form of the word">
		<cfset plural('(#left(arguments.sin, 1)#)#right(arguments.sin, len(arguments.sin) - 1)#$', '\1' & right(arguments.plu, len(arguments.plu) - 1))>
		<cfset singular('(#left(arguments.plu, 1)#)#right(arguments.plu, len(arguments.plu) - 1)#$', '\1' & right(arguments.sin, len(arguments.sin) - 1))>
	</cffunction>

	<!--- function for adding uncountable words that shouldn't be inflected --->
	<cffunction name="uncountable" access="private" returntype="void" output="no" hint="Adds uncountable words that shouldn't be inflected">
		<cfargument name="word" type="string" required="yes" hint="The word to add to the uncountable list">
		<cfset variables.uncountables = listappend(variables.uncountables, arguments.word)>
	</cffunction>
	
	<cffunction name="isSingular" access="public" returntype="boolean" output="no" hint="Checks if word is singular form">
		<cfargument name="word" type="string" required="yes" hint="The word to get the plural for">
		<cfset var i = 0>
		<cfset var pluralsandpronouns = variables.plural.append(variables.pronouns) />
		<cfif NOT listfind(variables.uncountables, lcase(arguments.word))>
			<cfloop from="1" to="#arraylen(pluralsandpronouns)#" index="i">
				<cfif refindnocase(pluralsandpronouns[i]['rule'], arguments.word)>
					<cfreturn true/>
				</cfif>
			</cfloop>
		</cfif>
		<cfreturn false>
	</cffunction>
	
	<cffunction name="isPlural" access="public" returntype="boolean" output="no" hint="">
		<cfargument name="word" type="string" required="yes" hint="Checks to see if word is in plural form">
		<cfset var i = 0>
		<cfif NOT listfind(variables.uncountables, lcase(arguments.word))>
			<cfloop from="1" to="#arraylen(variables.singulars)#" index="i">
				<cfif refindnocase(variables.singulars[i]['rule'], arguments.word)>
					<cfreturn true />
				</cfif>
			</cfloop>
		</cfif>
		<cfreturn false>
	</cffunction>
	
	<cffunction name="isPronoun">
		@TODO add isPronoun
	</cffunction>

</cfcomponent>