i18n-js 3.0.0.rc12 → 3.0.0.rc13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 38feae5eaf2de86fcedd5ebaa0eaf008a1a33f8d
-  data.tar.gz: fe63577ccdbce4f49d6f998f68fad0d58791eaf4
+  metadata.gz: 8d618c24aafbe01dfc9573cf7a3df0c214b9b48a
+  data.tar.gz: 22bbc551ae4ba0d927c4d8b61fbf54996f51de4f
 SHA512:
-  metadata.gz: 00405a7c557557f13effc0088a9f13c56fe1fd9105d2cfd87951e8b9df1f55089f4610206a39dce7fed0b2d1780da36b1819f0fa4aed8c24d21875e538044cd2
-  data.tar.gz: 76240818ad36435dd3dfdf99324bb336c9832de408bd0c02104e5255e399d241f941a7d65bf903f2e505b1b311b39611fb34504884ebf0eeb14ba0caf35609d9
+  metadata.gz: f8ada8c660b2185867aa9c5ed68627aaee251c164032e39cf1b3fd0e9f0690f161defe732055f9eb97945084665208237252174ebf60131e66e6589fdf666506
+  data.tar.gz: aabf496875397c179606adf78bba0bee468e5d923a7d3c6d21d36494b03aab55cc650fdf8a672eea0da410a9c57c18ea07ae7c377129aa275cea6254c260a073

data/.travis.yml

@@ -8,6 +8,9 @@ rvm:
   - 2.0
   - 2.1
   - 2.2
+  # Since the Travis Build Env does not recognize `2.3` alias yet
+  # We need to specify the version precisely
+  - 2.3.0
   - ruby-head
 before_install: # Need to install something extra to test JS
 - npm install jasmine-node@1.14.2

data/CHANGELOG.md

@@ -16,6 +16,24 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 - Nothing
 
+## [3.0.0.rc13] - 2016-06-29
+
+### Added
+
+- [Ruby] Added option `js_extend` to not generate JS code for translations with usage of `I18n.extend` ([#397](https://github.com/fnando/i18n-js/pull/397))
+
+### Changed
+
+- Nothing
+
+### Fixed
+
+- [JS] Initialize option `missingBehaviour` & `missingTranslationPrefix` with default values ([#398](https://github.com/fnando/i18n-js/pull/398))
+- [JS] Throw an error when `I18n.strftime()` takes an invalid date ([#383](https://github.com/fnando/i18n-js/pull/383))
+- [JS] Fix default error message when translation missing to consider locale passed in options
+- [Ruby] Reset middleware cache on rails startup 
+([#402](https://github.com/fnando/i18n-js/pull/402))
+
 
 ## [3.0.0.rc12] - 2015-12-30
 
@@ -158,5 +176,6 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 
 
-[Unreleased]: https://github.com/fnando/i18n-js/compare/v3.0.0.rc12...HEAD
+[Unreleased]: https://github.com/fnando/i18n-js/compare/v3.0.0.rc13...HEAD
+[3.0.0.rc13]: https://github.com/fnando/i18n-js/compare/v3.0.0.rc12...v3.0.0.rc13
 [3.0.0.rc12]: https://github.com/fnando/i18n-js/compare/v3.0.0.rc11...v3.0.0.rc12

data/README.md

@@ -15,6 +15,10 @@ Features:
 - Asset pipeline support
 - Lots more! :)
 
+## Version Notice
+The `master` branch (including this README) is for latest `3.0.0.rc` instead of `2.x`.
+
+
 ## Usage
 
 ### Installation
@@ -252,6 +256,20 @@ translations:
 ```
 
 
+#### Javscript Merge (:js_extend option)
+
+By default, the output file Javascript will call the `I18n.extend` method to ensure that newly loaded locale
+files are shallow-merged with any locale data already in memory. To disable this either globally or per-file,
+set the `js_extend` option to false
+
+```yaml
+js_extend: false  # this will disable Javascript I18n.extend globally
+translations:
+- file: "public/javascripts/i18n/translations.js"
+  js_extend: false  # this will disable Javascript I18n.extend for this file
+```
+
+
 #### Vanilla JavaScript
 
 Just add the `i18n.js` file to your page. You'll have to build the translations object
@@ -262,7 +280,7 @@ by hand or using your favorite programming language. More info below.
 
 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"
+"i18n-js": "http://github.com/fnando/i18n-js/archive/v3.0.0.rc12.tar.gz"
 ```
 Run npm install then use via
 ```javascript

data/app/assets/javascripts/i18n.js

@@ -191,6 +191,12 @@
 
     if (typeof(this.translations) === "undefined" && this.translations !== null)
       this.translations = DEFAULT_OPTIONS.translations;
+
+    if (typeof(this.missingBehaviour) === "undefined" && this.missingBehaviour !== null)
+      this.missingBehaviour = DEFAULT_OPTIONS.missingBehaviour;
+
+    if (typeof(this.missingTranslationPrefix) === "undefined" && this.missingTranslationPrefix !== null)
+      this.missingTranslationPrefix = DEFAULT_OPTIONS.missingTranslationPrefix;
   };
   I18n.initializeOptions();
 
@@ -536,8 +542,9 @@
           function(match, p1, p2) {return p1 + ' ' + p2.toLowerCase()} );
     }
 
+    var localeForTranslation = (options != null && options.locale != null) ? options.locale : this.currentLocale();
     var fullScope           = this.getFullScope(scope, options);
-    var fullScopeWithLocale = [this.currentLocale(), fullScope].join(this.defaultSeparator);
+    var fullScopeWithLocale = [localeForTranslation, fullScope].join(this.defaultSeparator);
 
     return '[missing "' + fullScopeWithLocale + '" translation]';
   };
@@ -772,6 +779,10 @@
 
     options = this.prepareOptions(options, DATE);
 
+    if (isNaN(date.getTime())) {
+      throw new Error('I18n.strftime() requires a valid date object, but received an invalid date.');
+    }
+
     var weekDay = date.getDay()
       , day = date.getDate()
       , year = date.getFullYear()

data/lib/i18n/js.rb

@@ -48,13 +48,11 @@ module I18n
         only = options[:only] || '*'
         exceptions = [options[:except] || []].flatten
 
-        segment_options = options.slice(:namespace, :pretty_print)
-
         result = segment_for_scope(only, exceptions)
 
         merge_with_fallbacks!(result) if fallbacks
 
-        segments << Segment.new(file, result, segment_options) unless result.empty?
+        segments << Segment.new(file, result, extract_segment_options(options)) unless result.empty?
 
         segments
       end
@@ -143,7 +141,7 @@ module I18n
           results[scope.to_sym] = tmp unless tmp.nil?
         end
         return results
-      elsif translations.respond_to?(:has_key?) && translations.has_key?(scope.to_sym)
+      elsif translations.respond_to?(:key?) && translations.key?(scope.to_sym)
         return {scope.to_sym => scopes.empty? ? translations[scope.to_sym] : filter(translations[scope.to_sym], scopes)}
       end
       nil
@@ -168,8 +166,15 @@ module I18n
       end
     end
 
+    def self.js_extend
+      config.fetch(:js_extend) do
+        # default value
+        true
+      end
+    end
+
     def self.sort_translation_keys?
-      @sort_translation_keys ||= (config[:sort_translation_keys]) if config.has_key?(:sort_translation_keys)
+      @sort_translation_keys ||= (config[:sort_translation_keys]) if config.key?(:sort_translation_keys)
       @sort_translation_keys = true if @sort_translation_keys.nil?
       @sort_translation_keys
     end
@@ -178,6 +183,11 @@ module I18n
       @sort_translation_keys = !!value
     end
 
+    def self.extract_segment_options(options)
+      segment_options = {js_extend: js_extend, sort_translation_keys: sort_translation_keys?}.with_indifferent_access
+      segment_options.merge(options.slice(*Segment::OPTIONS))
+    end
+
     ### Export i18n.js
     begin
 
@@ -192,7 +202,7 @@ module I18n
       end
 
       def self.export_i18n_js_dir_path
-        @export_i18n_js_dir_path ||= (config[:export_i18n_js] || :none) if config.has_key?(:export_i18n_js)
+        @export_i18n_js_dir_path ||= (config[:export_i18n_js] || :none) if config.key?(:export_i18n_js)
         @export_i18n_js_dir_path ||= DEFAULT_EXPORT_DIR_PATH
         @export_i18n_js_dir_path
       end

data/lib/i18n/js/middleware.rb

@@ -3,6 +3,7 @@ module I18n
     class Middleware
       def initialize(app)
         @app = app
+        clear_cache
       end
 
       def call(env)
@@ -30,6 +31,10 @@ module I18n
         end
       end
 
+      def clear_cache
+        File.delete(cache_path) if File.exist?(cache_path)
+      end
+
       def save_cache(new_cache)
         # path could be a symbolic link
         FileUtils.mkdir_p(cache_dir) unless File.exists?(cache_dir)

data/lib/i18n/js/segment.rb

@@ -3,22 +3,25 @@ module I18n
 
     # Class which enscapulates a translations hash and outputs a single JSON translation file
     class Segment
-      attr_accessor :file, :translations, :namespace, :pretty_print
-
+      OPTIONS = [:namespace, :pretty_print, :js_extend, :sort_translation_keys].freeze
       LOCALE_INTERPOLATOR = /%\{locale\}/
 
+      attr_reader *([:file, :translations] | OPTIONS)
+
       def initialize(file, translations, options = {})
         @file         = file
         @translations = translations
         @namespace    = options[:namespace] || 'I18n'
         @pretty_print = !!options[:pretty_print]
+        @js_extend    = options.key?(:js_extend) ? !!options[:js_extend] : true
+        @sort_translation_keys = options.key?(:sort_translation_keys) ? !!options[:sort_translation_keys] : true
       end
 
       # Saves JSON file containing translations
       def save!
-        if self.file =~ LOCALE_INTERPOLATOR
+        if @file =~ LOCALE_INTERPOLATOR
           I18n.available_locales.each do |locale|
-            write_file(file_for_locale(locale), self.translations.slice(locale))
+            write_file(file_for_locale(locale), @translations.slice(locale))
           end
         else
           write_file
@@ -27,20 +30,37 @@ module I18n
 
       protected
 
-      def write_file(_file = self.file, _translations = self.translations)
+      def write_file(_file = @file, _translations = @translations)
         FileUtils.mkdir_p File.dirname(_file)
         File.open(_file, "w+") do |f|
-          f << %(#{self.namespace}.translations || (#{self.namespace}.translations = {});\n)
+          f << js_header
           _translations.each do |locale, translations_for_locale|
-            output_translations = I18n::JS.sort_translation_keys? ? Utils.deep_key_sort(translations_for_locale) : translations_for_locale
-            f << %(#{self.namespace}.translations["#{locale}"] = I18n.extend((#{self.namespace}.translations["#{locale}"] || {}), #{print_json(output_translations)});\n)
+            f << js_translations(locale, translations_for_locale)
           end
         end
       end
 
+      def js_header
+        %(#{@namespace}.translations || (#{@namespace}.translations = {});\n)
+      end
+
+      def js_translations(locale, translations)
+        translations = Utils.deep_key_sort(translations) if @sort_translation_keys
+        translations = print_json(translations)
+        js_translations_line(locale, translations)
+      end
+
+      def js_translations_line(locale, translations)
+        if @js_extend
+          %(#{@namespace}.translations["#{locale}"] = I18n.extend((#{@namespace}.translations["#{locale}"] || {}), #{translations});\n)
+        else
+          %(#{@namespace}.translations["#{locale}"] = #{translations};\n)
+        end
+      end
+
       # Outputs pretty or ugly JSON depending on :pretty_print option
       def print_json(translations)
-        if pretty_print
+        if @pretty_print
           JSON.pretty_generate(translations)
         else
           translations.to_json
@@ -49,7 +69,7 @@ module I18n
 
       # interpolates filename
       def file_for_locale(locale)
-        self.file.gsub(LOCALE_INTERPOLATOR, locale.to_s)
+        @file.gsub(LOCALE_INTERPOLATOR, locale.to_s)
       end
     end
   end

data/lib/i18n/js/version.rb

@@ -4,7 +4,7 @@ module I18n
       MAJOR = 3
       MINOR = 0
       PATCH = 0
-      STRING = "#{MAJOR}.#{MINOR}.#{PATCH}.rc12"
+      STRING = "#{MAJOR}.#{MINOR}.#{PATCH}.rc13"
     end
   end
 end

data/spec/fixtures/js_extend_parent.yml

@@ -0,0 +1,6 @@
+fallbacks: false
+js_extend: false
+
+translations:
+  - file: "tmp/i18n-js/js_extend_parent.js"
+    only: "*.date.formats"

data/spec/fixtures/js_extend_segment.yml

@@ -0,0 +1,6 @@
+fallbacks: false
+
+translations:
+  - file: "tmp/i18n-js/js_extend_segment.js"
+    js_extend: false
+    only: "*.date.formats"

data/spec/js/dates.spec.js

@@ -255,4 +255,11 @@ describe("Dates", function(){
     date = new Date(2009, 3, 26, 7, 35, 44);
     expect(I18n.strftime(date, "%p")).toEqual("de:AM");
   });
+
+  it("fails to format invalid date", function(){
+    var date = new Date('foo');
+    expect(function() {
+      I18n.strftime(date, "%a");
+    }).toThrow('I18n.strftime() requires a valid date object, but received an invalid date.');
+  });
 });

data/spec/js/translate.spec.js

@@ -24,6 +24,12 @@ describe("Translate", function(){
     expect(actual).toEqual(expected);
   });
 
+  it("returns missing message translation with provided locale for invalid scope", function(){
+    actual = I18n.t("invalid.scope", { locale: "ja" });
+    expected = '[missing "ja.invalid.scope" translation]';
+    expect(actual).toEqual(expected);
+  });
+
   it("returns guessed translation if missingBehaviour is set to guess", function(){
     I18n.missingBehaviour = 'guess'
     actual = I18n.t("invalid.thisIsAutomaticallyGeneratedTranslation");
@@ -180,6 +186,7 @@ describe("Translate", function(){
   it("escapes $ when doing substitution (IE)", function(){
     I18n.locale = "en";
 
+    expect(I18n.t("paid", {price: "$0"})).toEqual("You were paid $0");
     expect(I18n.t("paid", {price: "$0.12"})).toEqual("You were paid $0.12");
     expect(I18n.t("paid", {price: "$1.35"})).toEqual("You were paid $1.35");
   });

data/spec/ruby/i18n/js/segment_spec.rb

@@ -6,7 +6,12 @@ describe I18n::JS::Segment do
   let(:translations){ { en: { "test" => "Test" }, fr: { "test" => "Test2" } } }
   let(:namespace)   { "MyNamespace" }
   let(:pretty_print){ nil }
-  let(:options)     { {namespace: namespace, pretty_print: pretty_print} }
+  let(:js_extend)  { nil }
+  let(:sort_translation_keys){ nil }
+  let(:options)     { { namespace: namespace,
+                        pretty_print: pretty_print,
+                        js_extend: js_extend,
+                        sort_translation_keys: sort_translation_keys }.delete_if{|k,v| v.nil?} }
   subject { I18n::JS::Segment.new(file, translations, options) }
 
   describe ".new" do
@@ -89,10 +94,38 @@ MyNamespace.translations["fr"] = I18n.extend((MyNamespace.translations["fr"] ||
       end
     end
 
-    context "when sort_translation_keys? is true" do
-      before :each do
-        I18n::JS.sort_translation_keys = true
+    context "when js_extend is true" do
+      let(:js_extend){ true }
+
+      let(:translations){ { en: { "b" => "Test", "a" => "Test" } } }
+
+      it 'should output the keys as sorted' do
+        file_should_exist "segment.js"
+
+        File.open(File.join(temp_path, "segment.js")){|f| f.read}.should eql <<-EOF
+MyNamespace.translations || (MyNamespace.translations = {});
+MyNamespace.translations["en"] = I18n.extend((MyNamespace.translations["en"] || {}), {"a":"Test","b":"Test"});
+        EOF
+      end
+    end
+
+    context "when js_extend is false" do
+      let(:js_extend){ false }
+
+      let(:translations){ { en: { "b" => "Test", "a" => "Test" } } }
+
+      it 'should output the keys as sorted' do
+        file_should_exist "segment.js"
+
+        File.open(File.join(temp_path, "segment.js")){|f| f.read}.should eql <<-EOF
+MyNamespace.translations || (MyNamespace.translations = {});
+MyNamespace.translations["en"] = {"a":"Test","b":"Test"};
+        EOF
       end
+    end
+
+    context "when sort_translation_keys is true" do
+      let(:sort_translation_keys){ true }
 
       let(:translations){ { en: { "b" => "Test", "a" => "Test" } } }
 
@@ -105,5 +138,20 @@ MyNamespace.translations["en"] = I18n.extend((MyNamespace.translations["en"] ||
         EOF
       end
     end
+
+    context "when sort_translation_keys is false" do
+      let(:sort_translation_keys){ false }
+
+      let(:translations){ { en: { "b" => "Test", "a" => "Test" } } }
+
+      it 'should output the keys as sorted' do
+        file_should_exist "segment.js"
+
+        File.open(File.join(temp_path, "segment.js")){|f| f.read}.should eql <<-EOF
+MyNamespace.translations || (MyNamespace.translations = {});
+MyNamespace.translations["en"] = I18n.extend((MyNamespace.translations["en"] || {}), {"b":"Test","a":"Test"});
+        EOF
+      end
+    end
   end
 end

data/spec/ruby/i18n/js_spec.rb

@@ -30,14 +30,14 @@ describe I18n::JS do
 
     it "exports messages using custom output path" do
       set_config "custom_path.yml"
-      I18n::JS::Segment.should_receive(:new).with("tmp/i18n-js/all.js", translations, {}).and_call_original
+      I18n::JS::Segment.should_receive(:new).with("tmp/i18n-js/all.js", translations, {js_extend: true, sort_translation_keys: true}).and_call_original
       I18n::JS::Segment.any_instance.should_receive(:save!).with(no_args)
       I18n::JS.export
     end
 
     it "sets default scope to * when not specified" do
       set_config "no_scope.yml"
-      I18n::JS::Segment.should_receive(:new).with("tmp/i18n-js/no_scope.js", translations, {}).and_call_original
+      I18n::JS::Segment.should_receive(:new).with("tmp/i18n-js/no_scope.js", translations, {js_extend: true, sort_translation_keys: true}).and_call_original
       I18n::JS::Segment.any_instance.should_receive(:save!).with(no_args)
       I18n::JS.export
     end
@@ -587,6 +587,41 @@ EOS
         end
       end
     end
+  end
+
+  describe "js_extend option" do
+    before do
+      stub_const('I18n::JS::DEFAULT_EXPORT_DIR_PATH', temp_path)
+    end
+
+    it "exports with js_extend option at parent level" do
+      set_config "js_extend_parent.yml"
+      I18n::JS.export
+
+      file_should_exist "js_extend_parent.js"
+
+      output = File.read(File.join(I18n::JS.export_i18n_js_dir_path, "js_extend_parent.js"))
+      expect(output).to eq(<<EOS
+I18n.translations || (I18n.translations = {});
+I18n.translations[\"en\"] = {\"date\":{\"formats\":{\"default\":\"%Y-%m-%d\",\"long\":\"%B %d, %Y\",\"short\":\"%b %d\"}}};
+I18n.translations[\"fr\"] = {\"date\":{\"formats\":{\"default\":\"%d/%m/%Y\",\"long\":\"%e %B %Y\",\"long_ordinal\":\"%e %B %Y\",\"only_day\":\"%e\",\"short\":\"%e %b\"}}};
+EOS
+)
+    end
+
+    it "exports with js_extend option at segment level" do
+      set_config "js_extend_segment.yml"
+      I18n::JS.export
 
+      file_should_exist "js_extend_segment.js"
+
+      output = File.read(File.join(I18n::JS.export_i18n_js_dir_path, "js_extend_segment.js"))
+      expect(output).to eq(<<EOS
+I18n.translations || (I18n.translations = {});
+I18n.translations[\"en\"] = {\"date\":{\"formats\":{\"default\":\"%Y-%m-%d\",\"long\":\"%B %d, %Y\",\"short\":\"%b %d\"}}};
+I18n.translations[\"fr\"] = {\"date\":{\"formats\":{\"default\":\"%d/%m/%Y\",\"long\":\"%e %B %Y\",\"long_ordinal\":\"%e %B %Y\",\"only_day\":\"%e\",\"short\":\"%e %b\"}}};
+EOS
+)
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: i18n-js
 version: !ruby/object:Gem::Version
-  version: 3.0.0.rc12
+  version: 3.0.0.rc13
 platform: ruby
 authors:
 - Nando Vieira
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-30 00:00:00.000000000 Z
+date: 2016-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -140,6 +140,8 @@ files:
 - spec/fixtures/except_condition.yml
 - spec/fixtures/js_export_dir_custom.yml
 - spec/fixtures/js_export_dir_none.yml
+- spec/fixtures/js_extend_parent.yml
+- spec/fixtures/js_extend_segment.yml
 - spec/fixtures/js_file_per_locale.yml
 - spec/fixtures/js_file_per_locale_with_fallbacks_as_default_locale_symbol.yml
 - spec/fixtures/js_file_per_locale_with_fallbacks_as_hash.yml
@@ -206,7 +208,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.0
+rubygems_version: 2.6.4
 signing_key: 
 specification_version: 4
 summary: It's a small library to provide the Rails I18n translations on the Javascript.
@@ -217,6 +219,8 @@ test_files:
 - spec/fixtures/except_condition.yml
 - spec/fixtures/js_export_dir_custom.yml
 - spec/fixtures/js_export_dir_none.yml
+- spec/fixtures/js_extend_parent.yml
+- spec/fixtures/js_extend_segment.yml
 - spec/fixtures/js_file_per_locale.yml
 - spec/fixtures/js_file_per_locale_with_fallbacks_as_default_locale_symbol.yml
 - spec/fixtures/js_file_per_locale_with_fallbacks_as_hash.yml