2.0.0 upgrade

Upgrade to use Numeral.js 2.x.  Breaking changes ahead

Author: baumandm

CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## 2.0.0
+
+* Upgrade to Numeral.js 2.x, with several breaking changes
+* $numeraljsConfigProvider's interface has been modified to better match Numeral.js
+  * `$numeraljsConfigProvider.setCurrentLanguage(lang)` has been renamed to `locale(locale)`
+  * `$numeraljsConfigProvider.setDefaultFormat(format)` has been renamed to `defaultFormat(format)`
+  * `$numeraljsConfigProvider.setFormat(name, formatString)` has been renamed to `namedFormat(name, formatString)`
+  * `$numeraljsConfigProvider.setLanguage(lang, def)` has been renamed to `register('locale', name, def)`
+* Fixed indentation to match EditorConfig settings
+* Upgraded Karma & related test dependencies
+
 ## 1.3.0
 
 * Remove the separate CommonJS build in favor of a single UMD module.

LICENSE

@@ -1,5 +1,5 @@
 The MIT License
-Copyright (c) 2013-2016 Dave Bauman
+Copyright (c) 2013-2017 Dave Bauman
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -18,4 +18,3 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
-

README.md

@@ -4,6 +4,19 @@
 
 This is an Angular.js filter that applies [Numeral.js](http://numeraljs.com/) formatting.
 
+The latest version of this library uses Numeral.js 2.x branch.  There are several breaking changes in Numeral.js, as well as breaking changes in this library. If you depend on Numeral.js 1.x and cannot upgrade, please use the latest 1.x release (and corresponding `1.x` branch).
+
+## Breaking Changes in 2.x
+
+For details on breaking changes in Numeral.js itself, please see its [changelog](https://github.com/adamwdraper/Numeral-js/tree/master#200).
+
+In addition, angular-numeraljs has the following breaking changes from in 1.3.0 to 2.0.0:
+
+* `$numeraljsConfigProvider.setCurrentLanguage(lang)` has been renamed to `locale(locale)`
+* `$numeraljsConfigProvider.setDefaultFormat(format)` has been renamed to `defaultFormat(format)`
+* `$numeraljsConfigProvider.setFormat(name, formatString)` has been renamed to `namedFormat(name, formatString)`
+* `$numeraljsConfigProvider.setLanguage(lang, def)` has been renamed to `register('locale', name, def)`
+
 ## How to Use
 
 1. Include Numeral.js in your project
@@ -43,11 +56,11 @@ Numeral.js must be already loaded in the browser prior to using `$numeraljsConfi
 
 ### Named Formats
 
-`$numeraljsConfigProvider.setFormat(name, formatString)` - defines a named format which can be used in place of the format string in the filter.
+`$numeraljsConfigProvider.namedFormat(name, formatString)` - defines a named format which can be used in place of the format string in the filter.
 
 ```js
 app.config(['$numeraljsConfigProvider', function ($numeraljsConfigProvider) {
-    $numeraljsConfigProvider.setFormat('currency', '$ 0,0.00');
+    $numeraljsConfigProvider.namedFormat('currency', '$ 0,0.00');
 }]);
 ```
 
@@ -63,11 +76,11 @@ In markup,
 
 Numeral.js defines the default format as '0,0', so this format is used if none is provided to the filter.
 
-`$numeraljsConfigProvider.setDefaultFormat(format)` - overrides the built-in default format.
+`$numeraljsConfigProvider.defaultFormat(format)` - overrides the built-in default format.
 
 ```js
 app.config(['$numeraljsConfigProvider', function ($numeraljsConfigProvider) {
-    $numeraljsConfigProvider.setDefaultFormat('0.0 $');
+    $numeraljsConfigProvider.defaultFormat('0.0 $');
 }]);
 ```
 
@@ -79,44 +92,84 @@ In markup,
 </p>
 ```
 
-### Custom Languages
+### Custom Locales and Formats
 
-`$numeraljsConfigProvider.setLanguage(langId, definition)` - adds new language definitions to Numeral.js. See the available list here: [languages](https://github.com/adamwdraper/Numeral-js/tree/master/languages).  
+`$numeraljsConfigProvider.register(type, name, definition)` - adds new locale or format definitions to Numeral.js. `type` must be either `'locale'` or `'format'`.  For complete details, please refer to the Numeral.js [documentation](http://numeraljs.com/#locales).
 
 ```js
 app.config(['$numeraljsConfigProvider', function ($numeraljsConfigProvider) {
-    var language = {
-        delimiters: {
-            thousands: ' ',
-            decimal: ','
-        },
-        abbreviations: {
-            thousand: 'k',
-            million: 'm',
-            billion: 'b',
-            trillion: 't'
-        },
-        ordinal: function (number) {
-            return '.';
-        },
-        currency: {
-            symbol: '€'
-        }
-    };
-
-    $numeraljsConfigProvider.setLanguage('de', language);
+  // Register a new Locale
+  $numeraljsConfigProvider.register('locale', 'de', {
+    delimiters: {
+      thousands: ' ',
+      decimal: ','
+    },
+    abbreviations: {
+      thousand: 'k',
+      million: 'm',
+      billion: 'b',
+      trillion: 't'
+    },
+    ordinal: function (number) {
+      return '.';
+    },
+    currency: {
+      symbol: '€'
+    }
+  });
+
+  // Register a new Format
+  $numeraljsConfigProvider.register('format', 'percentage', {
+    regexps: {
+      format: /(%)/,
+      unformat: /(%)/
+    },
+    format: function(value, format, roundingFunction) {
+      var space = numeral._.includes(format, ' %') ? ' ' : '',
+          output;
+
+      value = value * 100;
+
+      // check for space before %
+      format = format.replace(/\s?\%/, '');
+
+      output = numeral._.numberToFormat(value, format, roundingFunction);
+
+      if (numeral._.includes(output, ')')) {
+        output = output.split('');
+
+        output.splice(-1, 0, space + '%');
+
+        output = output.join('');
+      } else {
+        output = output + space + '%';
+      }
+
+      return output;
+    },
+    unformat: function(string) {
+      return numeral._.stringToNumber(string) * 0.01;
+    }
+  });
+
+  $numeraljsConfigProvider.defaultFormat('0%');
+  $numeraljsConfigProvider.locale('de');
 }]);
 ```
 
-Languages can be loaded directly into Numeral.js as well, e.g. by loading the [language files](https://github.com/adamwdraper/Numeral-js/tree/master/languages) after Numeral.js is loaded.  Angular-numeraljs can use these languages even if they are not set via this provider.
+Please note that registering a new format will add new formatting functionality, e.g. adding a new character to the format string. If you want to add a short name for a specific format string, see `namedFormat()` above.
+
+See a list of available locales here: [locale](https://github.com/adamwdraper/Numeral-js/tree/master/locales).
+
+Locales or formats can be loaded directly into Numeral.js as well, e.g. by loading the [locale files](https://github.com/adamwdraper/Numeral-js/tree/master/locales) after Numeral.js is loaded.  Angular-numeraljs can use these locales or formats even if they are not set via this provider.
 
-### Select Language
+### Select Locale
 
-`$numeraljsConfigProvider.setCurrentLanguage(langId)` - selects the current language.  The language must be loaded either by `$numeraljsConfigProvider.setLanguage()` or by loading the Numeral.js language file.
+`$numeraljsConfigProvider.locale(locale)` - selects the current locale.  The locale must be loaded either by `$numeraljsConfigProvider.register()` or by loading the Numeral.js locale file.
 
 ```js
 app.config(['$numeraljsConfigProvider', function ($numeraljsConfigProvider) {
-    $numeraljsConfigProvider.setCurrentLanguage('de');
+    $numeraljsConfigProvider.locale('de');
 }]);
 ```
 
@@ -125,7 +178,8 @@ app.config(['$numeraljsConfigProvider', function ($numeraljsConfigProvider) {
 It is possible to change all of the configurations at runtime by injecting `$numeraljsConfig`:
 
     app.controller('numeralExample', function ($scope, $numeraljsConfig) {
-        $numeraljsConfig.setCurrentLanguage($scope.language);
+      $numeraljsConfig.defaultFormat('0,0.0');
+      $numeraljsConfig.locale($scope.locale);
     });
 
 This may be useful for websites with a language switcher, saved user preferences, etc.
@@ -145,19 +199,19 @@ There are several examples in the `example/` folder which can be used for refere
 This filter can be installed via Bower with the following dependency in the `bower.json` file.
 
     "dependencies": {
-        "angular-numeraljs": "^1.0"
+        "angular-numeraljs": "^2.0"
     }
 
 ## Browserify
 
 This project is published in NPM as `angular-numeraljs`.
 
     "dependencies": {
-        "angular-numeraljs": "^1.0"
+        "angular-numeraljs": "^2.0"
     }
 
 The `example/browserify` folder has a working example with Browserify and Grunt.  To build this project, install [Grunt](http://gruntjs.com/) and [Browserify](http://browserify.org/) and run the following:
-    
+
     cd example/browserify
     npm install
     grunt build
@@ -181,4 +235,3 @@ Then open `example/browserify/dist/index.html` in a browser.
 4. Tests are automatically run during the build, but they can be run manually as well
 
         grunt test
-

dist/angular-numeraljs.js

@@ -1,6 +1,6 @@
 /**
  * AngularJS filter for Numeral.js: number formatting as a filter
- * @version v1.3.2 - 2016-12-27
+ * @version v2.0.0 - 2017-02-13
  * @link https://github.com/baumandm/angular-numeraljs
  * @author Dave Bauman <baumandm@gmail.com>
  * @license MIT License, http://www.opensource.org/licenses/MIT
@@ -23,49 +23,45 @@
 }(this, function (numeral) {
   return angular.module('ngNumeraljs', [])
     .provider('$numeraljsConfig', function () {
-        var formats = {};
+      var formats = {};
 
-        this.setFormat = function (name, format) {
-            formats[name] = format;
-        };
+      this.defaultFormat = function (format) {
+        numeral.defaultFormat(format);
+      };
 
-        this.setDefaultFormat = function (format) {
-            numeral.defaultFormat(format);
-        };
+      this.locale = function (locale) {
+        numeral.locale(locale);
+      };
 
-        this.setLanguage = function (lang, def) {
-            numeral.language(lang, def);
-        };
-
-        this.setCurrentLanguage = function (lang) {
-            numeral.language(lang);
-        };
+      this.namedFormat = function (name, format) {
+        formats[name] = format;
+      };
 
-        this.$get = function () {
-            return {
-                customFormat: function (name) {
-                    return formats[name] || name;
-                },
+      this.register = function (type, name, def) {
+        numeral.register(type, name, def);
+      };
 
-                setCurrentLanguage: this.setCurrentLanguage,
-
-                setDefaultFormat: this.setDefaultFormat,
-
-                setFormat: this.setFormat,
-
-                setLanguage: this.setLanguage,
-            };
+      this.$get = function () {
+        return {
+          customFormat: function (name) {
+            return formats[name] || name;
+          },
+          defaultFormat: this.defaultFormat,
+          locale: this.locale,
+          register: this.register,
+          namedFormat: this.namedFormat
         };
+      };
     })
     .filter('numeraljs', ['$numeraljsConfig', function ($numeraljsConfig) {
-        return function (input, format) {
-            if (input == null) {
-                return input;
-            }
+      return function (input, format) {
+        if (input == null) {
+          return input;
+        }
 
-            format = $numeraljsConfig.customFormat(format);
+        format = $numeraljsConfig.customFormat(format);
 
-            return numeral(input).format(format);
-        };
+        return numeral(input).format(format);
+      };
     }]);
 }));

dist/angular-numeraljs.min.js

@@ -7,7 +7,7 @@
     <meta name="description" content="Changing languages example for the Angular-numeraljs module">
     <meta name="viewport" content="width=device-width, initial-scale=1">
 
-    <script src="../../test/lib/numeral.js"></script>
+    <script src="../../node_modules/numeral/numeral.js"></script>
     <script src="../../test/lib/angular/angular.js"></script>
     <script src="../../src/angular-numeraljs.js"></script>
 

example/changeLanguages/index.html

@@ -2,7 +2,7 @@ var app = angular.module('exampleApp', ['ngNumeraljs']);
 
 app.config(['$numeraljsConfigProvider', function ($numeraljsConfigProvider) {
     // Load some additional languages
-    $numeraljsConfigProvider.setLanguage('fr', {
+    $numeraljsConfigProvider.register('locale', 'fr', {
         delimiters: {
             thousands: ' ',
             decimal: ','
@@ -21,7 +21,7 @@ app.config(['$numeraljsConfigProvider', function ($numeraljsConfigProvider) {
         }
     });
 
-    $numeraljsConfigProvider.setLanguage('de', {
+    $numeraljsConfigProvider.register('locale', 'de', {
         delimiters: {
             thousands: ' ',
             decimal: ','
@@ -40,7 +40,7 @@ app.config(['$numeraljsConfigProvider', function ($numeraljsConfigProvider) {
         }
     });
 
-    $numeraljsConfigProvider.setCurrentLanguage('en');
+    $numeraljsConfigProvider.locale('en');
 }]);
 
 app.controller('numeralExample', function ($scope, $numeraljsConfig) {
@@ -66,14 +66,14 @@ app.controller('numeralExample', function ($scope, $numeraljsConfig) {
     $scope.currentLanguage = 'en';
 
     $scope.$watch('currentLanguage', function (language) {
-        $numeraljsConfig.setCurrentLanguage(language);
+        $numeraljsConfig.locale(language);
     });
 
 
     $scope.defaultFormat = null;
 
     $scope.$watch('defaultFormat', function (format) {
         if (format == null) return;
-        $numeraljsConfig.setDefaultFormat(format);
+        $numeraljsConfig.defaultFormat(format);
     });
-});
+});