underscore.inflections

<!DOCTYPE html> <html> <head> <title>underscore.inflections.coffee</title> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> <link rel="stylesheet" media="all" href="docco.css" /> </head> <body> <div id="container"> <div id="background"></div> <table cellpadding="0" cellspacing="0"> <thead> <tr> <th class="docs"> <h1> underscore.inflections.coffee </h1> </th> <th class="code"> </th> </tr> </thead> <tbody> <tr id="section-1"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-1">¶</a> </div> underscore.inflections is an <a href="http://underscorejs.org">underscore.js</a> mixin that provides methods for inflection of words. </td> <td class="code"> <div class="highlight"><pre>class Inflections</pre></div> </td> </tr> <tr id="section-2"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-2">¶</a> </div> Common uncountable words </td> <td class="code"> <div class="highlight"><pre> defaultUncountables: [ 'equipment', 'information', 'rice', 'money', 'species', 'series', 'fish', 'sheep', 'jeans', 'moose', 'deer', 'news' ]</pre></div> </td> </tr> <tr id="section-3"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-3">¶</a> </div> Plural rules </td> <td class="code"> <div class="highlight"><pre> defaultPluralRules: [ [/$/, 's'] [/s$/i, 's'] [/^(ax|test)is$/i, '$1es'] [/(octop|vir)us$/i, '$1i'] [/(octop|vir)i$/i, '$1i'] [/(alias|status)$/i, '$1es'] [/(bu)s$/i, '$1ses'] [/(buffal|tomat)o$/i, '$1oes'] [/([ti])um$/i, '$1a'] [/([ti])a$/i, '$1a'] [/sis$/i, 'ses'] [/(?:([^f])fe|([lr])f)$/i, '$1$2ves'] [/(hive)$/i, '$1s'] [/([^aeiouy]|qu)y$/i, '$1ies'] [/(x|ch|ss|sh)$/i, '$1es'] [/(matr|vert|ind)(?:ix|ex)$/i, '$1ices'] [/(m|l)ouse$/i, '$1ice'] [/(m|l)ice$/i, '$1ice'] [/^(ox)$/i, '$1en'] [/^(oxen)$/i, '$1'] [/(quiz)$/i, '$1zes'] ]</pre></div> </td> </tr> <tr id="section-4"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-4">¶</a> </div> Singular rules </td> <td class="code"> <div class="highlight"><pre> defaultSingularRules: [ [/s$/i, ''] [/(ss)$/i, '$1'] [/(n)ews$/i, '$1ews'] [/([ti])a$/i, '$1um'] [/((a)naly|(b)a|(d)iagno|(p)arenthe|(p)rogno|(s)ynop|(t)he)(sis|ses)$/i, '$1$2sis'] [/(^analy)(sis|ses)$/i, '$1sis'] [/([^f])ves$/i, '$1fe'] [/(hive)s$/i, '$1'] [/(tive)s$/i, '$1'] [/([lr])ves$/i, '$1f'] [/([^aeiouy]|qu)ies$/i, '$1y'] [/(s)eries$/i, '$1eries'] [/(m)ovies$/i, '$1ovie'] [/(x|ch|ss|sh)es$/i, '$1'] [/(m|l)ice$/i, '$1ouse'] [/(bus)(es)?$/i, '$1'] [/(o)es$/i, '$1'] [/(shoe)s$/i, '$1'] [/(cris|test)(is|es)$/i, '$1is'] [/^(a)x[ie]s$/i, '$1xis'] [/(octop|vir)(us|i)$/i, '$1us'] [/(alias|status)(es)?$/i, '$1'] [/^(ox)en/i, '$1'] [/(vert|ind)ices$/i, '$1ex'] [/(matr)ices$/i, '$1ix'] [/(quiz)zes$/i, '$1'] [/(database)s$/i, '$1'] ]</pre></div> </td> </tr> <tr id="section-5"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-5">¶</a> </div> Irregular rules </td> <td class="code"> <div class="highlight"><pre> defaultIrregularRules: [ ['person', 'people'] ['man', 'men'] ['child', 'children'] ['sex', 'sexes'] ['move', 'moves'] ['cow', 'kine'] ['zombie', 'zombies'] ]</pre></div> </td> </tr> <tr id="section-6"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-6">¶</a> </div> Set up arrays and apply default rules </td> <td class="code"> <div class="highlight"><pre> constructor: -> @plurals = [] @singulars = [] @uncountables = [] @applyDefaultRules()</pre></div> </td> </tr> <tr id="section-7"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-7">¶</a> </div> Apply all default rules </td> <td class="code"> <div class="highlight"><pre> applyDefaultRules: => @applyDefaultUncountables() @applyDefaultPlurals() @applyDefaultSingulars() @applyDefaultIrregulars()</pre></div> </td> </tr> <tr id="section-8"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-8">¶</a> </div> Apply rules for list of uncountables </td> <td class="code"> <div class="highlight"><pre> applyDefaultUncountables: => @uncountable @defaultUncountables</pre></div> </td> </tr> <tr id="section-9"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-9">¶</a> </div> Apply rules for list of default plurals </td> <td class="code"> <div class="highlight"><pre> applyDefaultPlurals: => _.each @defaultPluralRules, (rule) => [regex, capture] = rule @plural regex, capture</pre></div> </td> </tr> <tr id="section-10"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-10">¶</a> </div> Apply rules for list of default singulars </td> <td class="code"> <div class="highlight"><pre> applyDefaultSingulars: -> _.each @defaultSingularRules, (rule) => [regex, capture] = rule @singular regex, capture</pre></div> </td> </tr> <tr id="section-11"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-11">¶</a> </div> Apply rules for list of default irregulars </td> <td class="code"> <div class="highlight"><pre> applyDefaultIrregulars: -> _.each @defaultIrregularRules, (rule) => [singular, plural] = rule @irregular singular, plural</pre></div> </td> </tr> <tr id="section-12"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-12">¶</a> </div> Specifies a new pluralization rule and its replacement. The rule can either be a string or a regular expression. The replacement should always be a string that may include references to the matched data from the rule. </td> <td class="code"> <div class="highlight"><pre> plural: (rule, replacement) => delete @uncountables[_.indexOf(@uncountables, rule)] if typeof rule is 'string' delete @uncountables[_.indexOf(@uncountables, replacement)] @plurals.unshift [rule, replacement]</pre></div> </td> </tr> <tr id="section-13"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-13">¶</a> </div> Specifies a new singularization rule and its replacement. The rule can either be a string or a regular expression. The replacement should always be a string that may include references to the matched data from the rule. </td> <td class="code"> <div class="highlight"><pre> singular: (rule, replacement) => delete @uncountables[_.indexOf(@uncountables, rule)] if typeof rule is 'string' delete @uncountables[_.indexOf(@uncountables, replacement)] @singulars.unshift [rule, replacement]</pre></div> </td> </tr> <tr id="section-14"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-14">¶</a> </div> Specifies a new irregular that applies to both pluralization and singularization at the same time. This can only be used for strings, not regular expressions. You simply pass the irregular in singular and plural form. Examples: <pre><code>_.irregular('octopus', 'octopi') _.irregular('person', 'people') </code></pre> </td> <td class="code"> <div class="highlight"><pre> irregular: (singular, plural) => delete @uncountables[_.indexOf(@uncountables, singular)] delete @uncountables[_.indexOf(@uncountables, plural)] if singular.substring(0,1).toUpperCase() is plural.substring(0,1).toUpperCase() @plural(new RegExp("(#{singular.substring(0,1)})#{singular.substring(1,plural.length)}$", "i"), '$1' + plural.substring(1, plural.length)) @plural(new RegExp("(#{plural.substring(0,1)})#{plural.substring(1,plural.length)}$", "i"), '$1' + plural.substring(1, plural.length)) @singular(new RegExp("(#{plural.substring(0,1)})#{plural.substring(1,plural.length)}$", "i"), '$1' + singular.substring(1, plural.length)) else @plural(new RegExp("#{singular.substring(0,1)}#{singular.substring(1,plural.length)}$", "i"), plural.substring(0,1) + plural.substring(1,plural.length)) @plural(new RegExp("#{singular.substring(0,1)}#{singular.substring(1,plural.length)}$", "i"), plural.substring(0,1) + plural.substring(1,plural.length)) @plural(new RegExp("#{plural.substring(0,1)}#{plural.substring(1,plural.length)}$", "i"), plural.substring(0,1) + plural.substring(1,plural.length)) @plural(new RegExp("#{plural.substring(0,1)}#{plural.substring(1,plural.length)}$", "i"), plural.substring(0,1) + plural.substring(1,plural.length)) @singular(new RegExp("#{plural.substring(0,1)}#{plural.substring(1,plural.length)}$", "i"), singular.substring(0,1) + singular.substring(1,plural.length)) @singular(new RegExp("#{plural.substring(0,1)}#{plural.substring(1,plural.length)}$", "i"), singular.substring(0,1) + singular.substring(1,plural.length))</pre></div> </td> </tr> <tr id="section-15"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-15">¶</a> </div> Add uncountable words that shouldn't be attempted inflected. Examples: <pre><code>_.uncountable("money") _.uncountable("money", "information") _.uncountable(["money", "information", "rice"]) </code></pre> </td> <td class="code"> <div class="highlight"><pre> uncountable: (words...) => @uncountables.push(words) @uncountables = _.flatten @uncountables</pre></div> </td> </tr> <tr id="section-16"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-16">¶</a> </div> Clears the loaded inflections within a given scope (default is <code>'all'</code>). Give the scope as a symbol of the inflection type, the options are: <code>'plurals'</code>, <code>'singulars'</code>, <code>'uncountables'</code>, <code>'humans'</code>. Examples: <pre><code>_.clearInflections('all') _.clearInflections('plurals') </code></pre> </td> <td class="code"> <div class="highlight"><pre> clearInflections: (scope = 'all') => @[scope] = []</pre></div> </td> </tr> <tr id="section-17"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-17">¶</a> </div> Pluralizes a word Examples: <pre><code>_.pluralize('') </code></pre> </td> <td class="code"> <div class="highlight"><pre> pluralize: (word, count, options = {}) => options = _.extend { plural: undefined, showNumber: true }, options if count isnt undefined result = "" result += "#{count ? 0} " if options.showNumber is true result += if count is 1 or count?.toString?().match(/^1(\.0+)?$/) then word else (options.plural ? @pluralize(word)) else @apply_inflections(word, @plurals)</pre></div> </td> </tr> <tr id="section-18"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-18">¶</a> </div> Singularizes a word </td> <td class="code"> <div class="highlight"><pre> singularize: (word) => @apply_inflections(word, @singulars)</pre></div> </td> </tr> <tr id="section-19"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-19">¶</a> </div> Apple rules to a given word. If the last word fo the string is uncountable, just return it. Otherwise, make the replacement and return that. </td> <td class="code"> <div class="highlight"><pre> apply_inflections: (word, rules) => result = word if !word or _.indexOf(@uncountables, result.toLowerCase().match(/\b\w+$/)[0]) isnt -1 result else for rule in rules [regex, capture] = rule if result.match regex result = result.replace regex, capture break result</pre></div> </td> </tr> <tr id="section-20"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-20">¶</a> </div> Export to window or exports </td> <td class="code"> <div class="highlight"><pre>root = exports ? @</pre></div> </td> </tr> <tr id="section-21"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-21">¶</a> </div> Require underscore </td> <td class="code"> <div class="highlight"><pre>_ = root._ or require 'underscore'</pre></div> </td> </tr> <tr id="section-22"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-22">¶</a> </div> Include Inflections as a mixin to underscore </td> <td class="code"> <div class="highlight"><pre>if typeof exports is 'undefined' _.mixin new Inflections else module.exports = new Inflections </pre></div> </td> </tr> </tbody> </table> </div> </body> </html>