underscore_extensions 0.0.6 → 0.0.7

data/config/jshint.yml

@@ -54,6 +54,7 @@ passfail: false     # true if the scan should stop on first error (per file)
 # following are relevant only if undef = true
 predef:
   - _
+  - InflectionJS
 browser:  true      # true if the standard browser globals should be predefined
 rhino:    false     # true if the Rhino environment globals should be predefined
 windows:  false     # true if Windows-specific globals should be predefined

data/lib/assets/javascripts/underscore.extensions.js

@@ -60,11 +60,21 @@
       } else {
         return only.apply(_, Array.prototype.slice.call(arguments, 1));
       }
-    },
-    pluralize: function(string, number, options) {
-      options = options || {};
-      var result = parseInt(number, 10);
-      return result + (options.includeSpace ? ' ' : '') + string + (result === 1 ? '' : 's');
     }
   });
+
+  if (InflectionJS) {
+    _.mixin({
+      pluralize: function(obj, options) {
+        options = options || {};
+        options.skip = options.skip || '';
+        return InflectionJS.apply_rules(obj, InflectionJS.plural_rules, options.skip);
+      },
+      singularize: function(obj, options) {
+        options = options || {};
+        options.skip = options.skip || '';
+        return InflectionJS.apply_rules(obj, InflectionJS.singular_rules, options.skip);
+      }
+    });
+  }
 })(_);

data/lib/underscore_extensions/version.rb

@@ -1,5 +1,5 @@
 module UnderscoreExtensions
-  VERSION = '0.0.6'
+  VERSION = '0.0.7'
   UNDERSCORE_VERSION = '1.3.3'
   UNDERSCORE_STRING_VERSION  = '2.0.0'
 end

data/spec/javascripts/support/jasmine.yml

@@ -1,6 +1,7 @@
 src_files:
   - vendor/assets/javascripts/underscore.js
   - vendor/assets/javascripts/underscore.string.js
+  - lib/assets/javascripts/inflection.js
   - lib/assets/javascripts/underscore.extensions.js
 stylesheets:
 helpers:

data/spec/javascripts/underscore.extensions_spec.js

@@ -91,14 +91,24 @@ describe('_', function() {
   });
 
   describe('#pluralize', function() {
-    it('should use a space when includeSpace is passed in the options', function() {
-      expect(_('point').pluralize(2, {includeSpace: true})).toEqual('2 points');
+    it("should pluralize a model name", function() {
+      expect(_('point').pluralize()).toEqual('points');
+      expect(_('story').pluralize()).toEqual('stories');
     });
 
-    it('should return a pluralized string based on the number', function() {
-      expect(_('point').pluralize(0)).toEqual('0points');
-      expect(_('point').pluralize(1)).toEqual('1point');
-      expect(_('point').pluralize(2)).toEqual('2points');
+    it("should pass the skip option", function() {
+      expect(_('foo').pluralize({skip: 'foo'})).toEqual('foo');
+    });
+  });
+
+  describe('#singularize', function() {
+    it("should singularize a model name", function() {
+      expect(_('octopi').singularize()).toEqual('octopus');
+      expect(_('stories').singularize()).toEqual('story');
+    });
+
+    it("should pass the skip option", function() {
+      expect(_('foos').singularize({skip: 'foos'})).toEqual('foos');
     });
   });
 });

data/vendor/assets/javascripts/inflection.js

@@ -0,0 +1,139 @@
+/*
+  This sets up a container for some constants in its own namespace
+  We use the window (if available) to enable dynamic loading of this script
+  Window won't necessarily exist for non-browsers.
+*/
+if (window && !window.InflectionJS)
+{
+    window.InflectionJS = null;
+}
+
+/*
+  This sets up some constants for later use
+  This should use the window namespace variable if available
+*/
+InflectionJS =
+{
+    /*
+      This is a list of nouns that use the same form for both singular and plural.
+      This list should remain entirely in lower case to correctly match Strings.
+    */
+    uncountable_words: [
+        'equipment', 'information', 'rice', 'money', 'species', 'series',
+        'fish', 'sheep', 'moose', 'deer', 'news'
+    ],
+
+    /*
+      These rules translate from the singular form of a noun to its plural form.
+    */
+    plural_rules: [
+        [new RegExp('(m)an$', 'gi'),                 '$1en'],
+        [new RegExp('(pe)rson$', 'gi'),              '$1ople'],
+        [new RegExp('(child)$', 'gi'),               '$1ren'],
+        [new RegExp('^(ox)$', 'gi'),                 '$1en'],
+        [new RegExp('(ax|test)is$', 'gi'),           '$1es'],
+        [new RegExp('(octop|vir)us$', 'gi'),         '$1i'],
+        [new RegExp('(alias|status)$', 'gi'),        '$1es'],
+        [new RegExp('(bu)s$', 'gi'),                 '$1ses'],
+        [new RegExp('(buffal|tomat|potat)o$', 'gi'), '$1oes'],
+        [new RegExp('([ti])um$', 'gi'),              '$1a'],
+        [new RegExp('sis$', 'gi'),                   'ses'],
+        [new RegExp('(?:([^f])fe|([lr])f)$', 'gi'),  '$1$2ves'],
+        [new RegExp('(hive)$', 'gi'),                '$1s'],
+        [new RegExp('([^aeiouy]|qu)y$', 'gi'),       '$1ies'],
+        [new RegExp('(x|ch|ss|sh)$', 'gi'),          '$1es'],
+        [new RegExp('(matr|vert|ind)ix|ex$', 'gi'),  '$1ices'],
+        [new RegExp('([m|l])ouse$', 'gi'),           '$1ice'],
+        [new RegExp('(quiz)$', 'gi'),                '$1zes'],
+        [new RegExp('s$', 'gi'),                     's'],
+        [new RegExp('$', 'gi'),                      's']
+    ],
+
+    /*
+      These rules translate from the plural form of a noun to its singular form.
+    */
+    singular_rules: [
+        [new RegExp('(m)en$', 'gi'),                                                       '$1an'],
+        [new RegExp('(pe)ople$', 'gi'),                                                    '$1rson'],
+        [new RegExp('(child)ren$', 'gi'),                                                  '$1'],
+        [new RegExp('([ti])a$', 'gi'),                                                     '$1um'],
+        [new RegExp('((a)naly|(b)a|(d)iagno|(p)arenthe|(p)rogno|(s)ynop|(t)he)ses$','gi'), '$1$2sis'],
+        [new RegExp('(hive)s$', 'gi'),                                                     '$1'],
+        [new RegExp('(tive)s$', 'gi'),                                                     '$1'],
+        [new RegExp('(curve)s$', 'gi'),                                                    '$1'],
+        [new RegExp('([lr])ves$', 'gi'),                                                   '$1f'],
+        [new RegExp('([^fo])ves$', 'gi'),                                                  '$1fe'],
+        [new RegExp('([^aeiouy]|qu)ies$', 'gi'),                                           '$1y'],
+        [new RegExp('(s)eries$', 'gi'),                                                    '$1eries'],
+        [new RegExp('(m)ovies$', 'gi'),                                                    '$1ovie'],
+        [new RegExp('(x|ch|ss|sh)es$', 'gi'),                                              '$1'],
+        [new RegExp('([m|l])ice$', 'gi'),                                                  '$1ouse'],
+        [new RegExp('(bus)es$', 'gi'),                                                     '$1'],
+        [new RegExp('(o)es$', 'gi'),                                                       '$1'],
+        [new RegExp('(shoe)s$', 'gi'),                                                     '$1'],
+        [new RegExp('(cris|ax|test)es$', 'gi'),                                            '$1is'],
+        [new RegExp('(octop|vir)i$', 'gi'),                                                '$1us'],
+        [new RegExp('(alias|status)es$', 'gi'),                                            '$1'],
+        [new RegExp('^(ox)en', 'gi'),                                                      '$1'],
+        [new RegExp('(vert|ind)ices$', 'gi'),                                              '$1ex'],
+        [new RegExp('(matr)ices$', 'gi'),                                                  '$1ix'],
+        [new RegExp('(quiz)zes$', 'gi'),                                                   '$1'],
+        [new RegExp('s$', 'gi'),                                                           '']
+    ],
+
+    /*
+      This is a list of words that should not be capitalized for title case
+    */
+    non_titlecased_words: [
+        'and', 'or', 'nor', 'a', 'an', 'the', 'so', 'but', 'to', 'of', 'at',
+        'by', 'from', 'into', 'on', 'onto', 'off', 'out', 'in', 'over',
+        'with', 'for'
+    ],
+
+    /*
+      These are regular expressions used for converting between String formats
+    */
+    id_suffix: new RegExp('(_ids|_id)$', 'g'),
+    underbar: new RegExp('_', 'g'),
+    space_or_underbar: new RegExp('[\ _]', 'g'),
+    uppercase: new RegExp('([A-Z])', 'g'),
+    underbar_prefix: new RegExp('^_'),
+    
+    /*
+      This is a helper method that applies rules based replacement to a String
+      Signature:
+        InflectionJS.apply_rules(str, rules, skip, override) == String
+      Arguments:
+        str - String - String to modify and return based on the passed rules
+        rules - Array: [RegExp, String] - Regexp to match paired with String to use for replacement
+        skip - Array: [String] - Strings to skip if they match
+        override - String (optional) - String to return as though this method succeeded (used to conform to APIs)
+      Returns:
+        String - passed String modified by passed rules
+      Examples:
+        InflectionJS.apply_rules("cows", InflectionJs.singular_rules) === 'cow'
+    */
+    apply_rules: function(str, rules, skip, override)
+    {
+        if (override)
+        {
+            str = override;
+        }
+        else
+        {
+            var ignore = (skip.indexOf(str.toLowerCase()) > -1);
+            if (!ignore)
+            {
+                for (var x = 0; x < rules.length; x++)
+                {
+                    if (str.match(rules[x][0]))
+                    {
+                        str = str.replace(rules[x][0], rules[x][1]);
+                        break;
+                    }
+                }
+            }
+        }
+        return str;
+    }
+};

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: underscore_extensions
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-20 00:00:00.000000000 Z
+date: 2012-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fuubar
@@ -130,6 +130,7 @@ files:
 - spec/javascripts/support/spec_helper.js
 - spec/javascripts/underscore.extensions_spec.js
 - underscore_extensions.gemspec
+- vendor/assets/javascripts/inflection.js
 - vendor/assets/javascripts/underscore.js
 - vendor/assets/javascripts/underscore.string.js
 homepage: http://github.com/rdy/underscore_extensions