i18n-js 3.0.0.rc8 → 3.0.0.rc9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f5f7d877f8e94243760d5e3c4c3bbe232badc99d
-  data.tar.gz: 0d2cf27dc10c17acc846c457ec48573ae9832413
+  metadata.gz: 6e722b7f34475d50126d5ba7556c9a517f65266f
+  data.tar.gz: 668e6660683a5eb93b2812f656af2439237299e7
 SHA512:
-  metadata.gz: 6ebf38bdbc12665767e0c7c3806fd02221204b26e8b1f82dda78c3f07534ec5cedd18b4b6bc133c2820effc6ddb0f3c6902318a76b78563ceb232e99272213b8
-  data.tar.gz: c505d9671c59b80c51c28a033b03c8cac3bdc4174621789f7f9e48e5257324c37803f4e1f084cc337c3512894c193bbbf8a820e78c6495f570872dee4ff50f28
+  metadata.gz: c0cdc594d00611b72e9ca9327389d9f90b5b4d2990b8ecc3f144b44dfaf03aa793b01acc6a28aa57e46c492fe923eefa5b879696e654a7c689486d46258a4a84
+  data.tar.gz: 9ae2cea1e167dc49edf962a1ccb0d0ceb153a7d53e5207bd8c830deed4b1a58a9d19b41b9cdae209fefb385c68798412925fb85874ea02e8670b7081ae609095

data/.travis.yml

@@ -1,6 +1,5 @@
 language: ruby
 rvm:
-  - 1.9.3
   - 2.0
   - 2.1
   - 2.2
@@ -12,8 +11,8 @@ before_install: # Need to install npm to test js
 - npm install jasmine-node@1.14.2
 gemfile:
   - gemfiles/i18n_0_6.gemfile
+  - gemfiles/i18n_0_7.gemfile
 matrix:
   fast_finish: true
   allow_failures:
-    - rvm: 2.2
     - rvm: ruby-head

data/Appraisals

@@ -1,4 +1,8 @@
 
-appraise "i18n-0-6" do
+appraise "i18n_0_6" do
   gem 'i18n', '0.6.11'
 end
+
+appraise "i18n_0_7" do
+  gem 'i18n', '0.7.0'
+end

data/CHANGELOG.md

@@ -3,8 +3,21 @@
 
 ### enhancements
 
+- [JS] Force currency number sign to be at first place using `sign_first` option, default to `true`
+- [Ruby] Add option `namespace` & `pretty_print` ([#300](https://github.com/fnando/i18n-js/pull/300))
+- [Ruby] Add option `export_i18n_js` ([#301](https://github.com/fnando/i18n-js/pull/301))
+- [Ruby] Now the gem also detects pre-release versions of `rails`
+- [Ruby] Add `:except` option to exclude certain phrases or groups of phrases from the
+  outputted translations ([#312](https://github.com/fnando/i18n-js/pull/312))
+- [JS] You can now set `I18n.missingBehavior='guess'` to have the scope string output as text instead of of the
+  "[missing `scope`]" message when no translation is available.
+- [JS] Combined that with `I18n.missingTranslationPrefix='SOMETHING'` and you can
+  still identify those missing strings.
+
 ### bug fixes
 
+- [JS] Fix missing translation message when scope is passed in options
+
 
 ## 3.0.0.rc8
 

data/README.md

@@ -23,8 +23,10 @@ Features:
 Add the gem to your Gemfile.
 
     source "https://rubygems.org"
-    gem "rails", "3.2.3"
-    gem "i18n-js"
+    gem "rails", "your_rails_version"
+    # You only need this RC version constraint during the development of `3.0.0`, once stable version is released you can remove `rc8` suffix
+    # `3.0.0.rc8` is the latest version of released RC version when this entry is changed, you might want to change it later
+    gem "i18n-js", ">= 3.0.0.rc8" 
 
 #### Rails app with [Asset Pipeline](http://guides.rubyonrails.org/asset_pipeline.html)
 
@@ -107,21 +109,45 @@ translations:
 <% end %>
 ```
 
+You are able to exclude certain phrases or whole groups of phrases by
+specifying the YAML key(s) in the `except` configuration option. The outputted
+JS translations file (exported or generated by the middleware) will omit any
+keys listed in `except` configuration param:
+
+```yaml
+translations:
+  - except: ['active_admin', 'ransack']
+```
+
+
 #### Export Configuration (For other things)
-- `I18n::JS.config_file_path`  
+
+- `I18n::JS.config_file_path`
   Expected Type: `String`  
   Default: `config/i18n-js.yml`  
   Behaviour: Try to read the config file from that location  
-- `I18n::JS.export_i18n_js_dir_path`  
+
+- `I18n::JS.export_i18n_js_dir_path`
   Expected Type: `String`  
   Default: `public/javascripts`  
   Behaviour:  
   - Any `String`: considered as a relative path for a folder to `Rails.root` and export `i18n.js` to that folder for `rake i18n:js:export`
-  - `nil`: Disable `i18n.js` exporting
+  - Any non-`String` (`nil`, `false`, `:none`, etc): Disable `i18n.js` exporting
+
+- You may also set `export_i18n_js` in your config file, e.g.:
+
+```yaml
+export_i18n_js_: false
+# OR
+export_i18n_js: "my/path"
+
+translations:
+  - ...
+``
 
 To find more examples on how to use the configuration file please refer to the tests.
 
-##### Fallbacks
+#### Fallbacks
 
 If you specify the `fallbacks` option, you will be able to fill missing translations with those inside fallback locale(s).  
 Default value is `true`.
@@ -180,11 +206,54 @@ You must disable this feature by setting the option to `false`.
 To find more examples on how to use the configuration file please refer to the tests.
 
 
+#### Namespace
+
+Setting the `namespace` option will change the namespace of the output Javascript file to something other than `I18n`.
+This can be useful in no-conflict scenarios. Example:
+
+```yaml
+translations:
+- file: "public/javascripts/i18n/translations.js"
+  namespace: "MyNamespace"
+```
+
+will create:
+
+```
+MyNamespace.translations || (MyNamespace.translations = {});
+MyNamespace.translations["en"] = { ... }
+```
+
+
+#### Pretty Print
+
+Set the `pretty_print` option if you would like whitespace and indentation in your output file (default: false)
+
+```yaml
+translations:
+- file: "public/javascripts/i18n/translations.js"
+  pretty_print: true
+```
+
+
 #### Vanilla JavaScript
 
 Just add the `i18n.js` file to your page. You'll have to build the translations object
 by hand or using your favorite programming language. More info below.
 
+
+#### Via NPM with webpack and CommonJS
+
+Add the following line to your package.json dependencies (where version is the version you want - n.b. npm install requires it to be the gzipped tarball, see [npm install](https://www.npmjs.org/doc/cli/npm-install.html))
+```javascript
+"i18n-js": "http://github.com/fnando/i18n-js/archive/v3.0.0.rc8.tar.gz"
+```
+Run npm install then use via
+```javascript
+var i18n = require("i18n-js");
+```
+
+
 ### Setting up
 
 You **don't** need to set up a thing. The default settings will work just okay. But if you want to split translations into several files or specify specific contexts, you can follow the rest of this setting up section.
@@ -240,7 +309,7 @@ You can also provide a list of default fallbacks for missing scopes:
     I18n.t("some.missing.scope", {defaults: [{scope: "some.existing.scope"}]});
 
     // As a simple translation
-    I18n.t("some.missing.scope", {defaults: [{message: "some.existing.scope"}]});
+    I18n.t("some.missing.scope", {defaults: [{message: "Some message"}]});
 
     Default values must be provided as an array of hashs where the key is the
     type of translation desired, a `scope` or a `message`. The translation returned
@@ -271,6 +340,33 @@ are three different ways of doing it so:
     I18n.locales.no = "nb";
     I18n.locales.no = function(locale){ return ["nb"]; };
 
+By default a missing translation will be displayed as
+
+    [missing "name of scope" translation]
+
+While you are developing or if you do not want to provide a translation
+in the default language you can set
+
+    I18n.missingBehaviour='guess';
+
+this will take the last section of your scope and guess the intended value.
+Camel case becomes lower cased text and underscores are replaced with space
+
+    questionnaire.whatIsYourFavorite_ChristmasPresent
+
+becomes "what is your favorite Christmas present"
+
+In order to still detect untranslated strings, you can
+i18n.missingTranslationPrefix to something like:
+
+  I18n.missingTranslationPrefix = 'EE: '
+
+And result will be:
+
+    "EE: what is your favorite Christmas present"
+
+This will help you doing automated tests against your localisation assets.
+
 Pluralization is possible as well and by default provides English rules:
 
     I18n.t("inbox.counting", {count: 10}); // You have 10 messages
@@ -350,6 +446,7 @@ The `toCurrency` function accepts the following options:
 - `format`: sets the format of the output string
 - `unit`: sets the denomination of the currency
 - `strip_insignificant_zeros`: defaults to `false`
+- `sign_first`: defaults to `true`
 
 You can provide only the options you want to override:
 

data/app/assets/javascripts/i18n.js

@@ -16,11 +16,9 @@
   if (typeof module !== 'undefined' && module.exports) {
     // Node/CommonJS
     module.exports = factory(this);
-
   } else if (typeof define === 'function' && define.amd) {
     // AMD
-    define((function(global){ return function(){ factory(global); }})(this));
-
+    define('i18n', (function(global){ return function(){ return factory(global); }})(this));
   } else {
     // Browser globals
     this.I18n = factory(this);
@@ -61,13 +59,16 @@
       unit: "$"
     , precision: 2
     , format: "%u%n"
+    , sign_first: true
     , delimiter: ","
     , separator: "."
   };
 
   // Set default percentage format.
   var PERCENTAGE_FORMAT = {
-      precision: 3
+      unit: "%"
+    , precision: 3
+    , format: "%n%u"
     , separator: "."
     , delimiter: ""
   };
@@ -77,12 +78,27 @@
 
   // Other default options
   var DEFAULT_OPTIONS = {
-    defaultLocale: "en",
-    locale: "en",
-    defaultSeparator: ".",
-    placeholder: /(?:\{\{|%\{)(.*?)(?:\}\}?)/gm,
-    fallbacks: false,
-    translations: {}
+    // Set default locale. This locale will be used when fallback is enabled and
+    // the translation doesn't exist in a particular locale.
+      defaultLocale: "en"
+    // Set the current locale to `en`.
+    , locale: "en"
+    // Set the translation key separator.
+    , defaultSeparator: "."
+    // Set the placeholder format. Accepts `{placeholder}}` and `%{placeholder}`.}
+    , placeholder: /(?:\{\{|%\{)(.*?)(?:\}\}?)/gm
+    // Set if engine should fallback to the default locale when a translation
+    // is missing.
+    , fallbacks: false
+    // Set the default translation object.
+    , translations: {}
+    // Set missing translation behavior. 'message' will display a message
+    // that the translation is missing, 'guess' will try to guess the string
+    , missingBehaviour: 'message'
+    // if you use missingBehaviour with 'message', but want to know that the
+    // string is actually missing for testing purposes, you can prefix the
+    // guessed string by setting the value here. By default, no prefix!
+    , missingTranslationPrefix: ''
   };
 
   I18n.reset = function() {
@@ -105,6 +121,13 @@
 
     // Set the default translation object.
     this.translations = DEFAULT_OPTIONS.translations;
+
+    // Set the default missing behaviour
+    this.missingBehaviour = DEFAULT_OPTIONS.missingBehaviour;
+
+    // Set the default missing string prefix for guess behaviour
+    this.missingTranslationPrefix = DEFAULT_OPTIONS.missingTranslationPrefix;
+
   };
 
   // Much like `reset`, but only assign options if not already assigned
@@ -252,18 +275,7 @@
       , translations
     ;
 
-    // Deal with the scope as an array.
-    if (scope.constructor === Array) {
-      scope = scope.join(this.defaultSeparator);
-    }
-
-    // Deal with the scope option provided through the second argument.
-    //
-    //    I18n.t('hello', {scope: 'greetings'});
-    //
-    if (options.scope) {
-      scope = [options.scope, scope].join(this.defaultSeparator);
-    }
+    scope = this.getFullScope(scope, options);
 
     while (locales.length) {
       locale = locales.shift();
@@ -390,7 +402,7 @@
       }, this);
 
     if (!translationFound) {
-      return this.missingTranslation(scope);
+      return this.missingTranslation(scope, options);
     }
 
     if (typeof(translation) === "string") {
@@ -451,7 +463,7 @@
     }
 
     if (!translations) {
-      return this.missingTranslation(scope);
+      return this.missingTranslation(scope, options);
     }
 
     pluralizer = this.pluralization.get(options.locale);
@@ -471,14 +483,21 @@
   };
 
   // Return a missing translation message for the given parameters.
-  I18n.missingTranslation = function(scope) {
-    var message = '[missing "';
+  I18n.missingTranslation = function(scope, options) {
+    //guess intended string
+    if(this.missingBehaviour == 'guess'){
+      //get only the last portion of the scope
+      var s = scope.split('.').slice(-1)[0];
+      //replace underscore with space && camelcase with space and lowercase letter
+      return (this.missingTranslationPrefix.length > 0 ? this.missingTranslationPrefix : '') +
+          s.replace('_',' ').replace(/([a-z])([A-Z])/g,
+          function(match, p1, p2) {return p1 + ' ' + p2.toLowerCase()} );
+    }
 
-    message += this.currentLocale() + ".";
-    message += slice.call(arguments).join(".");
-    message += '" translation]';
+    var fullScope           = this.getFullScope(scope, options);
+    var fullScopeWithLocale = [this.currentLocale(), fullScope].join(this.defaultSeparator);
 
-    return message;
+    return '[missing "' + fullScopeWithLocale + '" translation]';
   };
 
   // Return a missing placeholder message for given parameters
@@ -514,6 +533,8 @@
       , precision
       , buffer = []
       , formattedNumber
+      , format = options.format || "%n"
+      , sign = negative ? "-" : ""
     ;
 
     number = parts[0];
@@ -534,9 +555,18 @@
       formattedNumber += options.separator + precision;
     }
 
-    if (negative) {
-      formattedNumber = "-" + formattedNumber;
+    if (options.sign_first) {
+      format = "%s" + format;
     }
+    else {
+      format = format.replace("%n", "%s%n");
+    }
+
+    formattedNumber = format
+      .replace("%u", options.unit)
+      .replace("%n", formattedNumber)
+      .replace("%s", sign)
+    ;
 
     return formattedNumber;
   };
@@ -564,13 +594,7 @@
       , CURRENCY_FORMAT
     );
 
-    number = this.toNumber(number, options);
-    number = options.format
-      .replace("%u", options.unit)
-      .replace("%n", number)
-    ;
-
-    return number;
+    return this.toNumber(number, options);
   };
 
   // Localize several values.
@@ -782,8 +806,7 @@
       , PERCENTAGE_FORMAT
     );
 
-    number = this.toNumber(number, options);
-    return number + "%";
+    return this.toNumber(number, options);
   };
 
   // Convert a number into a readable size representation.
@@ -810,18 +833,31 @@
 
     options = this.prepareOptions(
         options
-      , {precision: precision, format: "%n%u", delimiter: ""}
+      , {unit: unit, precision: precision, format: "%n%u", delimiter: ""}
     );
 
-    number = this.toNumber(size, options);
-    number = options.format
-      .replace("%u", unit)
-      .replace("%n", number)
-    ;
-
-    return number;
+    return this.toNumber(size, options);
   };
 
+  I18n.getFullScope = function(scope, options) {
+    options = this.prepareOptions(options);
+
+    // Deal with the scope as an array.
+    if (scope.constructor === Array) {
+      scope = scope.join(this.defaultSeparator);
+    }
+
+    // Deal with the scope option provided through the second argument.
+    //
+    //    I18n.t('hello', {scope: 'greetings'});
+    //
+    if (options.scope) {
+      scope = [options.scope, scope].join(this.defaultSeparator);
+    }
+
+    return scope;
+  }
+
   // Set aliases, so we can save some typing.
   I18n.t = I18n.translate;
   I18n.l = I18n.localize;