inflection - npm Package Compare versions

Comparing version 1.3.8 to 1.4.0

bower.json

 {
   "name": "inflection",
-  "version": "1.3.8",
+  "version": "1.4.0",
   "homepage": "https://github.com/dreamerslab/node.inflection",
@@ -20,3 +20,4 @@ "description": "JavaScript Inflection Support",
     { "name": "Kane Cohen", "email": "[e-mail]" },
-    { "name": "Gianni Chiappetta", "email": "[e-mail]" }
+    { "name": "Gianni Chiappetta", "email": "[e-mail]" },
+    { "name": "Eric Brody" }
   ],
@@ -30,2 +31,3 @@ "main": "inflection.min.js",
     "singularize",
+    "inflect",
     "camelize",
@@ -32,0 +34,0 @@ "underscore",

component.json

 {
   "name": "inflection",
-  "version": "1.3.8",
+  "version": "1.4.0",
   "repo": "dreamerslab/node.inflection",
@@ -23,3 +23,4 @@ "description": "A port of inflection-js to node.js module",
     { "name": "Kane Cohen", "email": "[e-mail]" },
-    { "name": "Gianni Chiappetta", "email": "[e-mail]" }
+    { "name": "Gianni Chiappetta", "email": "[e-mail]" },
+    { "name": "Eric Brody" }
   ],
@@ -26,0 +27,0 @@ "dependencies": {},

inflection.min.js

@@ -17,3 +17,4 @@ /*!
 }break;}}}}return p;},indexOf:function(k,q,p,l){if(!p){p=-1;}var n=-1;var o=p;var m=k.length;for(;o<m;o++){if(k[o]===q||l&&l(k[o],q)){n=o;break;}}return n;
-},pluralize:function(l,k){return b._apply_rules(l,g,d,k);},singularize:function(l,k){return b._apply_rules(l,a,d,k);},camelize:function(t,o){var v=t.split("/");
+},pluralize:function(l,k){return b._apply_rules(l,g,d,k);},singularize:function(l,k){return b._apply_rules(l,a,d,k);},inflect:function(n,m,l,k){m=parseInt(m,10);
+if(isNaN(m)){return n;}if(m===0||m>1){return b._apply_rules(n,g,d,k);}else{return b._apply_rules(n,a,d,l);}},camelize:function(t,o){var v=t.split("/");
 var r=0;var q=v.length;var u,m,p,n,s;for(;r<q;r++){u=v[r].split("_");p=0;n=u.length;for(;p<n;p++){if(p!==0){u[p]=u[p].toLowerCase();}s=u[p].charAt(0);s=o&&r===0&&p===0?s.toLowerCase():s.toUpperCase();
@@ -29,3 +30,3 @@ u[p]=s+u[p].substring(1);}v[r]=u.join("");}return v.join("::");},underscore:function(n,o){if(o&&n===n.toUpperCase()){return n;}var k=n.split("::");var m=0;
 var p=q[o].substring(q[o].length-1);var l="th";if(r!="11"&&r!="12"&&r!="13"){if(p==="1"){l="st";}else{if(p==="2"){l="nd";}else{if(p==="3"){l="rd";}}}}q[o]+=l;
-}}return q.join(" ");},transform:function(n,k){var m=0;var l=k.length;for(;m<l;m++){var o=k[m];if(this.hasOwnProperty(o)){n=this[o](n);}}return n;}};b.version="1.3.8";
+}}return q.join(" ");},transform:function(n,k){var m=0;var l=k.length;for(;m<l;m++){var o=k[m];if(this.hasOwnProperty(o)){n=this[o](n);}}return n;}};b.version="1.4.0";
 return b;}));

lib/inflection.js

@@ -283,3 +283,38 @@ /*!
 
+  /**
+   * This function will pluralize or singularlize a String appropriately based on an integer value
+   * @public
+   * @function
+   * @param {String} str The subject string.
+   * @param {Number} count The number to base pluralization off of.
+   * @param {String} singular Overrides normal output with said String.(optional)
+   * @param {String} plural Overrides normal output with said String.(optional)
+   * @returns {String} English language nouns are returned in the plural or singular form based on the count.
+   * @example
+   *
+   *     var inflection = require( 'inflection' );
+   *
+   *     inflection.inflect( 'people' 1 ); // === 'person'
+   *     inflection.inflect( 'octopi' 1 ); // === 'octopus'
+   *     inflection.inflect( 'Hats' 1 ); // === 'Hat'
+   *     inflection.inflect( 'guys', 1 , 'person' ); // === 'person'
+   *     inflection.inflect( 'person', 2 ); // === 'people'
+   *     inflection.inflect( 'octopus', 2 ); // === 'octopi'
+   *     inflection.inflect( 'Hat', 2 ); // === 'Hats'
+   *     inflection.inflect( 'person', 2, null, 'guys' ); // === 'guys'
+   */
+    inflect : function ( str, count, singular, plural ){
+      count = parseInt( count, 10 );
 
+      if( isNaN( count )) return str;
+
+      if( count === 0 || count > 1 ){
+        return inflector._apply_rules( str, plural_rules, uncountable_words, plural );
+      }else{
+        return inflector._apply_rules( str, singular_rules, uncountable_words, singular );
+      }
+    },
+
+
+
   /**
@@ -636,5 +671,5 @@ * This function adds camelization support to every String object.
  */
-  inflector.version = '1.3.8';
+  inflector.version = '1.4.0';
 
   return inflector;
 }));

package.json

 {
   "name"       : "inflection",
-  "version"    : "1.3.8",
+  "version"    : "1.4.0",
   "description": "A port of inflection-js to node.js module",
@@ -22,7 +22,8 @@ "keywords"   : [
     { "name": "Kane Cohen", "email": "[e-mail]" },
-    { "name": "Gianni Chiappetta", "email": "[e-mail]" }
+    { "name": "Gianni Chiappetta", "email": "[e-mail]" },
+    { "name": "Eric Brody" }
   ],
   "dependencies"   : {},
   "devDependencies": {
-    "mocha" : "1.20.1",
+    "mocha" : "1.21.4",
     "should": "4.0.4"
@@ -29,0 +30,0 @@ },

Readme.md

@@ -37,2 +37,3 @@ # inflection
 - inflection.singularize( str, singular );
+- inflection.inflect( str, count, singular, plural );
 - inflection.camelize( str, low_first_letter );
@@ -150,5 +151,45 @@ - inflection.underscore( str, all_upper_case );
 
+### inflection.inflect( str, count, singular, plural );
+
+This function will pluralize or singularlize a String appropriately based on an integer value.
+
+#### Arguments
+
+> str
+
+	type: String
+	desc: The subject string.
+
+> count
+	type: Number
+	desc: The number to base pluralization off of.
+
+> singular
+
+	type: String
+	desc: Overrides normal output with said String.(optional)
+
+> plural
+
+	type: String
+	desc: Overrides normal output with said String.(optional)
+
+#### Example code
+
+		var inflection = require( 'inflection' );
+
+		inflection.inflect( 'people' 1 ); // === 'person'
+		inflection.inflect( 'octopi' 1 ); // === 'octopus'
+		inflection.inflect( 'Hats' 1 ); // === 'Hat'
+		inflection.inflect( 'guys', 1 , 'person' ); // === 'person'
+		inflection.inflect( 'person', 2 ); // === 'people'
+		inflection.inflect( 'octopus', 2 ); // === 'octopi'
+		inflection.inflect( 'Hat', 2 ); // === 'Hats'
+		inflection.inflect( 'person', 2, null, 'guys' ); // === 'guys'
+
+
+
 ### inflection.camelize( str, low_first_letter );
 
-This function adds camelization support to every String object.
+This function transforms String object from underscore to camelcase.
 
@@ -178,3 +219,3 @@ #### Arguments
 
-This function adds underscore support to every String object.
+This function transforms String object from camelcase to underscore.
 
@@ -427,4 +468,6 @@ #### Arguments
 - Gianni Chiappetta <[e-mail]>
+- Eric Brody
 
 
+
 ## License
@@ -431,0 +474,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

46923

increased by6.27%

Lines of code

699

increased by5.27%

Number of lines in readme file

493

increased by9.56%

No dependency changes