i18n-js 3.0.0.rc9 → 3.0.0.rc10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6e722b7f34475d50126d5ba7556c9a517f65266f
-  data.tar.gz: 668e6660683a5eb93b2812f656af2439237299e7
+  metadata.gz: 0b54325d787e4471fabea3b33981f0b4ada0e660
+  data.tar.gz: 94c1e7e0ef79bfb984f9725453c40aef5290d3e6
 SHA512:
-  metadata.gz: c0cdc594d00611b72e9ca9327389d9f90b5b4d2990b8ecc3f144b44dfaf03aa793b01acc6a28aa57e46c492fe923eefa5b879696e654a7c689486d46258a4a84
-  data.tar.gz: 9ae2cea1e167dc49edf962a1ccb0d0ceb153a7d53e5207bd8c830deed4b1a58a9d19b41b9cdae209fefb385c68798412925fb85874ea02e8670b7081ae609095
+  metadata.gz: 63dedf3a5d8d7f144773e922ba113d5586c1eb608f5745608a363dd3b5604acd38863a4978bd1bce091bfc6b033ad85bf59915985b790d96beafa7681d739833
+  data.tar.gz: 30ee692d8f29ad98fc71014e119d41ae82490cddbd1a21a808cff54c97c25bf0c3abda5102555684c131a191e302eb93cd7fe98559dbc8aee2c8df9912d5fd79

data/.travis.yml

@@ -1,13 +1,15 @@
+# Send builds to container-based infrastructure
+# http://docs.travis-ci.com/user/workers/container-based-infrastructure/
+sudo: false
 language: ruby
+cache:
+  - bundler
 rvm:
   - 2.0
   - 2.1
   - 2.2
   - ruby-head
-script: "bundle exec rake spec"
-before_install: # Need to install npm to test js
-- sudo apt-get update
-- sudo apt-get install npm
+before_install: # Need to install something extra to test JS
 - npm install jasmine-node@1.14.2
 gemfile:
   - gemfiles/i18n_0_6.gemfile

data/CHANGELOG.md

@@ -1,6 +1,32 @@
 
 ## Unreleased
 
+### breaking changes
+
+### enhancements
+
+### bug fixes
+
+
+## 3.0.0.rc10
+
+### breaking changes
+
+- [Ruby] In `config/i18n-js.yml`, if you are using `%{locale}` in your filename and are referencing specific translations keys, please add `*.` to the beginning of those keys. ([#320](https://github.com/fnando/i18n-js/pull/320))
+- [Ruby] The `:except` option to exclude certain phrases now (only) accepts the same patterns the `:only` option accepts
+
+### enhancements
+
+- [Ruby] Make handling of per-locale and not-per-locale exporting to be more consistent ([#320](https://github.com/fnando/i18n-js/pull/320))
+- [Ruby] Add option `sort_translation_keys` to sort translation keys alphabetically ([#318](https://github.com/fnando/i18n-js/pull/318))
+
+### bug fixes
+
+- [Ruby] Fix fallback logic to work with not-per-locale files ([#320](https://github.com/fnando/i18n-js/pull/320))
+
+
+## 3.0.0.rc9
+
 ### enhancements
 
 - [JS] Force currency number sign to be at first place using `sign_first` option, default to `true`
@@ -10,13 +36,15 @@
 - [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
+  "[missing `scope`]" message when no translation is available.  
+  Combined that with `I18n.missingTranslationPrefix='SOMETHING'` and you can
   still identify those missing strings.
+  ([#304](https://github.com/fnando/i18n-js/pull/304))
 
 ### bug fixes
 
 - [JS] Fix missing translation message when scope is passed in options
+- [Ruby] Fix save cache directory verification when path is a symbolic link ([#329](https://github.com/fnando/i18n-js/pull/329))
 
 
 ## 3.0.0.rc8

data/README.md

@@ -38,6 +38,8 @@ then you must add the following line to your `app/assets/javascripts/application
 // This is optional (in case you have `I18n is not defined` error)
 // If you want to put this line, you must put it BEFORE `i18n/translations`
 //= require i18n
+// Some people even need to add the extension to make it work, see https://github.com/fnando/i18n-js/issues/283
+//= require i18n.js
 //
 // This is a must
 //= require i18n/translations
@@ -97,7 +99,7 @@ translations:
 - file: "public/javascripts/i18n/%{locale}.js"
   only: '*'
 - file: "public/javascripts/frontend/i18n/%{locale}.js"
-  only: ['frontend', 'users']
+  only: ['*.frontend', '*.users.*']
 ```
 
 You can also include ERB in your config file.
@@ -116,7 +118,7 @@ keys listed in `except` configuration param:
 
 ```yaml
 translations:
-  - except: ['active_admin', 'ransack']
+  - except: ['*.active_admin', '*.ransack', '*.activerecord.errors']
 ```
 
 
@@ -134,16 +136,25 @@ translations:
   - 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`
   - Any non-`String` (`nil`, `false`, `:none`, etc): Disable `i18n.js` exporting
 
-- You may also set `export_i18n_js` in your config file, e.g.:
+- `I18n::JS.sort_translation_keys`
+  Expected Type: `Boolean`
+  Default: `true`
+  Behaviour:
+  - Sets whether or not to deep sort all translation keys in order to generate identical output for the same translations
+  - Set to true to ensure identical asset fingerprints for the asset pipeline
+
+- You may also set `export_i18n_js` and `sort_translation_keys` in your config file, e.g.:
 
 ```yaml
 export_i18n_js_: false
 # OR
 export_i18n_js: "my/path"
 
+sort_translation_keys: false
+
 translations:
   - ...
-``
+```
 
 To find more examples on how to use the configuration file please refer to the tests.
 
@@ -358,15 +369,22 @@ becomes "what is your favorite Christmas present"
 
 In order to still detect untranslated strings, you can
 i18n.missingTranslationPrefix to something like:
-
-  I18n.missingTranslationPrefix = 'EE: '
+```javascript
+I18n.missingTranslationPrefix = 'EE: ';
+```
 
 And result will be:
-
-    "EE: what is your favorite Christmas present"
+```javascript
+"EE: what is your favorite Christmas present"
+```
 
 This will help you doing automated tests against your localisation assets.
 
+Some people prefer returning `null` for missing translation:
+```javascript
+I18n.missingTranslation = function () { return undefined; };
+```
+
 Pluralization is possible as well and by default provides English rules:
 
     I18n.t("inbox.counting", {count: 10}); // You have 10 messages

data/app/assets/javascripts/i18n.js

@@ -18,7 +18,8 @@
     module.exports = factory(this);
   } else if (typeof define === 'function' && define.amd) {
     // AMD
-    define('i18n', (function(global){ return function(){ return factory(global); }})(this));
+    var global=this;
+    define('i18n', function(){ return factory(global);});
   } else {
     // Browser globals
     this.I18n = factory(this);

data/i18n-js.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_dependency "i18n", "~> 0.6"
-  s.add_development_dependency "appraisal", "~> 1.0"
+  s.add_development_dependency "appraisal", "~> 2.0"
   s.add_development_dependency "activesupport", ">= 3"
   s.add_development_dependency "rspec", "~> 3.0"
   s.add_development_dependency "rake"

data/lib/i18n/js.rb

@@ -34,17 +34,6 @@ module I18n
       translation_segments.each(&:save!)
     end
 
-    def self.segments_per_locale(pattern, scope, exceptions, options)
-      I18n.available_locales.each_with_object([]) do |locale, segments|
-        scope = [scope] unless scope.respond_to?(:each)
-        result = scoped_translations(scope.collect{|s| "#{locale}.#{s}"}, exceptions)
-        merge_with_fallbacks!(result, locale, scope, exceptions) if use_fallbacks?
-
-        next if result.empty?
-        segments << Segment.new(::I18n.interpolate(pattern, {:locale => locale}), result, options)
-      end
-    end
-
     def self.segment_for_scope(scope, exceptions)
       if scope == "*"
         exclude(translations, exceptions)
@@ -61,23 +50,34 @@ module I18n
 
         segment_options = options.slice(:namespace, :pretty_print)
 
-        if file =~ ::I18n::INTERPOLATION_PATTERN
-          segments += segments_per_locale(file, only, exceptions, segment_options)
-        else
-          result = segment_for_scope(only, exceptions)
-          segments << Segment.new(file, result, segment_options) unless result.empty?
-        end
+        result = segment_for_scope(only, exceptions)
+
+        merge_with_fallbacks!(result) if fallbacks
+
+        segments << Segment.new(file, result, segment_options) unless result.empty?
 
         segments
       end
     end
 
+    # deep_merge! given result with result for fallback locale
+    def self.merge_with_fallbacks!(result)
+      I18n.available_locales.each do |locale|
+        fallback_locales = FallbackLocales.new(fallbacks, locale)
+        fallback_locales.each do |fallback_locale|
+          result[locale] = Utils.deep_merge(result[fallback_locale], result[locale] || {})
+        end
+      end
+    end
+
     def self.filtered_translations
-      {}.tap do |result|
+      translations = {}.tap do |result|
         translation_segments.each do |segment|
           Utils.deep_merge!(result, segment.translations)
         end
       end
+      return Utils.deep_key_sort(translations) if I18n::JS.sort_translation_keys?
+      translations
     end
 
     def self.translation_segments
@@ -109,9 +109,9 @@ module I18n
 
       [scopes].flatten.each do |scope|
         translations_without_exceptions = exclude(translations, exceptions)
-        filtered_translations = filter(translations_without_exceptions, scope)
+        filtered_translations = filter(translations_without_exceptions, scope) || {}
 
-        Utils.deep_merge! result, filtered_translations
+        Utils.deep_merge!(result, filtered_translations)
       end
 
       result
@@ -122,8 +122,9 @@ module I18n
       return translations if exceptions.empty?
 
       exceptions.inject(translations) do |memo, exception|
-        Utils.deep_reject(memo) do |key, value|
-          key.to_s == exception.to_s
+        exception_scopes = exception.to_s.split(".")
+        Utils.deep_reject(memo) do |key, value, scopes|
+          Utils.scopes_match?(scopes, exception_scopes)
         end
       end
     end
@@ -166,15 +167,14 @@ module I18n
       end
     end
 
-    # deep_merge! given result with result for fallback locale
-    def self.merge_with_fallbacks!(result, locale, scope, exceptions)
-      result[locale] ||= {}
-      fallback_locales = FallbackLocales.new(fallbacks, locale)
+    def self.sort_translation_keys?
+      @sort_translation_keys ||= (config[:sort_translation_keys]) if config.has_key?(:sort_translation_keys)
+      @sort_translation_keys = true if @sort_translation_keys.nil?
+      @sort_translation_keys
+    end
 
-      fallback_locales.each do |fallback_locale|
-        fallback_result = scoped_translations(scope.collect{|s| "#{fallback_locale}.#{s}"}, exceptions) # NOTE: Duplicated code here
-        result[locale] = Utils.deep_merge(fallback_result[fallback_locale], result[locale])
-      end
+    def self.sort_translation_keys=(value)
+      @sort_translation_keys = !!value
     end
 
     ### Export i18n.js

data/lib/i18n/js/middleware.rb

@@ -31,7 +31,8 @@ module I18n
       end
 
       def save_cache(new_cache)
-        FileUtils.mkdir_p(cache_dir)
+        # path could be a symbolic link
+        FileUtils.mkdir_p(cache_dir) unless File.exists?(cache_dir)
         File.open(cache_path, "w+") do |file|
           file << new_cache.to_yaml
         end

data/lib/i18n/js/segment.rb

@@ -5,6 +5,8 @@ module I18n
     class Segment
       attr_accessor :file, :translations, :namespace, :pretty_print
 
+      LOCALE_INTERPOLATOR = /%\{locale\}/
+
       def initialize(file, translations, options = {})
         @file         = file
         @translations = translations
@@ -14,18 +16,28 @@ module I18n
 
       # Saves JSON file containing translations
       def save!
-        FileUtils.mkdir_p File.dirname(self.file)
-
-        File.open(self.file, "w+") do |f|
-          f << %(#{self.namespace}.translations || (#{self.namespace}.translations = {});\n)
-          self.translations.each do |locale, translations|
-            f << %(#{self.namespace}.translations["#{locale}"] = #{print_json(translations)};\n);
+        if self.file =~ LOCALE_INTERPOLATOR
+          I18n.available_locales.each do |locale|
+            write_file(file_for_locale(locale), self.translations.slice(locale))
           end
+        else
+          write_file
         end
       end
 
       protected
 
+      def write_file(_file = self.file, _translations = self.translations)
+        FileUtils.mkdir_p File.dirname(_file)
+        File.open(_file, "w+") do |f|
+          f << %(#{self.namespace}.translations || (#{self.namespace}.translations = {});\n)
+          _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}"] = #{print_json(output_translations)};\n);
+          end
+        end
+      end
+
       # Outputs pretty or ugly JSON depending on :pretty_print option
       def print_json(translations)
         if pretty_print
@@ -34,6 +46,11 @@ module I18n
           translations.to_json
         end
       end
+
+      # interpolates filename
+      def file_for_locale(locale)
+        self.file.gsub(LOCALE_INTERPOLATOR, locale.to_s)
+      end
     end
   end
 end

data/lib/i18n/js/utils.rb

@@ -22,13 +22,30 @@ module I18n
         target_hash.merge!(hash, &MERGER)
       end
 
-      def self.deep_reject(hash, &block)
+      def self.deep_reject(hash, scopes = [], &block)
         hash.each_with_object({}) do |(k, v), memo|
-          unless block.call(k, v)
-            memo[k] = v.kind_of?(Hash) ? deep_reject(v, &block) : v
+          unless block.call(k, v, scopes + [k.to_s])
+            memo[k] = v.kind_of?(Hash) ? deep_reject(v, scopes + [k.to_s], &block) : v
           end
         end
       end
+
+      def self.scopes_match?(scopes1, scopes2)
+        if scopes1.length == scopes2.length
+          [scopes1, scopes2].transpose.all? do |scope1, scope2|
+            scope1.to_s == '*' || scope2.to_s == '*' || scope1.to_s == scope2.to_s
+          end
+        end
+      end
+
+      def self.deep_key_sort(hash)
+        # Avoid things like `true` or `1` from YAML which causes error
+        hash.keys.sort {|a, b| a.to_s <=> b.to_s}.
+          each_with_object({}) do |key, seed|
+          value = hash[key]
+          seed[key] = value.is_a?(Hash) ? deep_key_sort(value) : value
+        end
+      end
     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}.rc9"
+      STRING = "#{MAJOR}.#{MINOR}.#{PATCH}.rc10"
     end
   end
 end

data/lib/rails/generators/i18n/js/config/templates/i18n-js.yml

@@ -9,8 +9,7 @@
 # so.
 #
 # For more informations about the export options with this file, please
-# refer to the `Export Configuration` section in the README at :
-# https://github.com/fnando/i18n-js#export-configuration
+# refer to the README
 #
 #
 # If you're going to use the Rails 3.1 asset pipeline, change

data/spec/fixtures/custom_path.yml

@@ -1,4 +1,5 @@
-# Find more details about this configuration file at http://github.com/fnando/i18n-js
+fallbacks: false
+
 translations:
   - file: "tmp/i18n-js/all.js"
     only: "*"

data/spec/fixtures/default.yml

@@ -1,4 +1,5 @@
-# Find more details about this configuration file at http://github.com/fnando/i18n-js
+fallbacks: false
+
 translations:
   - file: "tmp/i18n-js/translations.js"
     only: "*"

data/spec/fixtures/erb.yml

@@ -1,4 +1,5 @@
-# Find more details about this configuration file at http://github.com/fnando/i18n-js
+fallbacks: false
+
 translations:
   - file: "tmp/i18n-js/translations.js"
     only: '<%= "*." + "date." + "formats" %>'

data/spec/fixtures/except_condition.yml

@@ -1,3 +1,5 @@
+fallbacks: false
+
 translations:
   - file: "tmp/i18n-js/trimmed.js"
     except:

data/spec/fixtures/js_export_dir_custom.yml

@@ -1,3 +1,4 @@
+fallbacks: false
 
 export_i18n_js: 'tmp/i18n-js/foo'
 

data/spec/fixtures/js_export_dir_none.yml

@@ -1,4 +1,4 @@
-
+fallbacks: false
 export_i18n_js: false
 
 translations:

data/spec/fixtures/js_file_per_locale.yml

@@ -1,3 +1,7 @@
+fallbacks: false
+
 translations:
   - file: "tmp/i18n-js/%{locale}.js"
-    only: '*'
+    only:
+      - '*.date.*'
+      - '*.admin.*'

data/spec/fixtures/js_file_with_namespace_and_pretty_print.yml

@@ -1,3 +1,5 @@
+fallbacks: false
+
 translations:
   - file: "tmp/i18n-js/%{locale}.js"
     only: '*'

data/spec/fixtures/js_sort_translation_keys_false.yml

@@ -0,0 +1,6 @@
+
+sort_translation_keys: false
+
+translations:
+  - file: "tmp/i18n-js/%{locale}.js"
+    only: '*'

data/spec/fixtures/js_sort_translation_keys_true.yml

@@ -0,0 +1,6 @@
+
+sort_translation_keys: true
+
+translations:
+  - file: "tmp/i18n-js/%{locale}.js"
+    only: '*'

data/spec/fixtures/multiple_conditions.yml

@@ -1,3 +1,5 @@
+fallbacks: false
+
 translations:
   - file: "tmp/i18n-js/bitsnpieces.js"
     only:

data/spec/fixtures/multiple_conditions_per_locale.yml

@@ -1,5 +1,7 @@
+fallbacks: false
+
 translations:
   - file: "tmp/i18n-js/bits.%{locale}.js"
     only:
-      - "date.formats"
-      - "number.currency"
+      - "*.date.formats.*"
+      - "*.number.currency.*"

data/spec/fixtures/multiple_files.yml

@@ -1,4 +1,5 @@
-# Find more details about this configuration file at http://github.com/fnando/i18n-js
+fallbacks: false
+
 translations:
   - file: "tmp/i18n-js/all.js"
     only: "*"

data/spec/fixtures/no_scope.yml

@@ -1,3 +1,4 @@
-# Find more details about this configuration file at http://github.com/fnando/i18n-js
+fallbacks: false
+
 translations:
   - file: "tmp/i18n-js/no_scope.js"

data/spec/fixtures/simple_scope.yml

@@ -1,4 +1,5 @@
-# Find more details about this configuration file at http://github.com/fnando/i18n-js
+fallbacks: false
+
 translations:
   - file: "tmp/i18n-js/simple_scope.js"
     only: "*.date.formats"

data/spec/i18n_js_spec.rb

@@ -1,6 +1,7 @@
 require "spec_helper"
 
 describe I18n::JS do
+
   describe '.config_file_path' do
     let(:default_path) { I18n::JS::DEFAULT_CONFIG_PATH }
     let(:new_path) { File.join("tmp", default_path) }
@@ -62,6 +63,19 @@ describe I18n::JS do
 
       file_should_exist "en.js"
       file_should_exist "fr.js"
+
+      en_output = File.read(File.join(I18n::JS.export_i18n_js_dir_path, "en.js"))
+      expect(en_output).to eq(<<EOS
+I18n.translations || (I18n.translations = {});
+I18n.translations["en"] = {"admin":{"edit":{"title":"Edit"},"show":{"note":"more details","title":"Show"}},"date":{"abbr_day_names":["Sun","Mon","Tue","Wed","Thu","Fri","Sat"],"abbr_month_names":[null,"Jan","Feb","Mar","Apr","May","Jun","Jul","Aug","Sep","Oct","Nov","Dec"],"day_names":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"],"formats":{"default":"%Y-%m-%d","long":"%B %d, %Y","short":"%b %d"},"month_names":[null,"January","February","March","April","May","June","July","August","September","October","November","December"]}};
+EOS
+)
+      fr_output = File.read(File.join(I18n::JS.export_i18n_js_dir_path, "fr.js"))
+      expect(fr_output).to eq(<<EOS
+I18n.translations || (I18n.translations = {});
+I18n.translations["fr"] = {"admin":{"edit":{"title":"Editer"},"show":{"note":"plus de détails","title":"Visualiser"}},"date":{"abbr_day_names":["dim","lun","mar","mer","jeu","ven","sam"],"abbr_month_names":[null,"jan.","fév.","mar.","avr.","mai","juin","juil.","août","sept.","oct.","nov.","déc."],"day_names":["dimanche","lundi","mardi","mercredi","jeudi","vendredi","samedi"],"formats":{"default":"%d/%m/%Y","long":"%e %B %Y","long_ordinal":"%e %B %Y","only_day":"%e","short":"%e %b"},"month_names":[null,"janvier","février","mars","avril","mai","juin","juillet","août","septembre","octobre","novembre","décembre"]}};
+EOS
+)
     end
 
     it "exports with multiple conditions" do
@@ -77,13 +91,22 @@ describe I18n::JS do
       set_config "multiple_conditions_per_locale.yml"
 
       result = I18n::JS.translation_segments
-      result.map(&:file).should eql(["tmp/i18n-js/bits.en.js", "tmp/i18n-js/bits.fr.js"])
+      result.map(&:file).should eql(["tmp/i18n-js/bits.%{locale}.js"])
 
-      %w(en fr).each do |lang|
-        segment = result.select{|s| s.file == "tmp/i18n-js/bits.#{lang}.js"}.first
-        segment.translations.keys.should eql([lang.to_sym])
-        segment.translations[lang.to_sym].keys.sort.should eql([:date, :number])
-      end
+      result.map(&:save!)
+
+      en_output = File.read(File.join(I18n::JS.export_i18n_js_dir_path, "bits.en.js"))
+      expect(en_output).to eq(<<EOS
+I18n.translations || (I18n.translations = {});
+I18n.translations["en"] = {"date":{"formats":{"default":"%Y-%m-%d","long":"%B %d, %Y","short":"%b %d"}},"number":{"currency":{"format":{"delimiter":",","format":"%u%n","precision":2,"separator":".","unit":"$"}}}};
+EOS
+)
+      fr_output = File.read(File.join(I18n::JS.export_i18n_js_dir_path, "bits.fr.js"))
+      expect(fr_output).to eq(<<EOS
+I18n.translations || (I18n.translations = {});
+I18n.translations["fr"] = {"date":{"formats":{"default":"%d/%m/%Y","long":"%e %B %Y","long_ordinal":"%e %B %Y","only_day":"%e","short":"%e %b"}},"number":{"currency":{"format":{"format":"%n %u","precision":2,"unit":"€"}}}};
+EOS
+)
     end
 
     it "exports with :except condition" do
@@ -138,69 +161,126 @@ describe I18n::JS do
       result[:en][:admin][:edit][:title].should eql("Edit")
       result[:fr][:admin][:edit][:title].should eql("Editer")
     end
+
+    describe ".filtered_translations" do
+      subject do
+        I18n::JS.filtered_translations
+      end
+
+      let!(:old_sort_translation_keys) { I18n::JS.sort_translation_keys? }
+      before { I18n::JS.sort_translation_keys = sort_translation_keys_value }
+      after { I18n::JS.sort_translation_keys = old_sort_translation_keys }
+      before { expect(I18n::JS.sort_translation_keys?).to eq(sort_translation_keys_value) }
+
+      let(:sorted_hash) do
+        {sorted: :hash}
+      end
+      before do
+        allow(I18n::JS::Utils).
+          to receive(:deep_key_sort).
+          and_return(sorted_hash)
+      end
+
+      shared_examples_for ".filtered_translations" do
+        subject do
+          I18n::JS.filtered_translations
+        end
+
+        # This example is to prevent the regression from
+        # PR https://github.com/fnando/i18n-js/pull/318
+        it {should be_a(Hash)}
+        # Might need to test the keys... or not
+      end
+
+      context "when translation keys SHOULD be sorted" do
+        let(:sort_translation_keys_value) { true }
+
+        it_behaves_like ".filtered_translations"
+        it {should eq(sorted_hash)}
+      end
+      context "when translation keys should NOT be sorted" do
+        let(:sort_translation_keys_value) { false }
+
+        it_behaves_like ".filtered_translations"
+        it {should_not eq(sorted_hash)}
+      end
+    end
   end
 
   context "exceptions" do
-    it "does not include a key listed in the exceptions list" do
-      result = I18n::JS.scoped_translations("*", ['admin'])
+    it "does not include scopes listed in the exceptions list" do
+      result = I18n::JS.scoped_translations("*", ['de.*', '*.admin', '*.*.currency'])
+
+      result[:de].should be_empty
 
       result[:en][:admin].should be_nil
       result[:fr][:admin].should be_nil
+      result[:ja][:admin].should be_nil
+
+      result[:en][:number][:currency].should be_nil
+      result[:fr][:number][:currency].should be_nil
     end
 
-    it "does not include multiple keys listed in the exceptions list" do
-      result = I18n::JS.scoped_translations("*", ['title', 'note'])
+    it "does not include scopes listed in the exceptions list and respects the 'only' option" do
+      result = I18n::JS.scoped_translations("fr.*", ['*.admin', '*.*.currency'])
+
+      result[:en].should be_nil
+      result[:de].should be_nil
+      result[:ja].should be_nil
 
-      result[:en][:admin][:show].should be_empty
-      result[:en][:admin][:edit].should be_empty
+      result[:fr][:admin].should be_nil
+      result[:fr][:number][:currency].should be_nil
 
-      result[:fr][:admin][:show].should be_empty
-      result[:fr][:admin][:show].should be_empty
-      result[:fr][:admin][:edit].should be_empty
+      result[:fr][:time][:am].should be_a(String)
     end
 
-    it "does not include a key listed in the exceptions list and respecs the 'only' option" do
-      result = I18n::JS.scoped_translations("fr.*", ['date', 'time', 'number', 'show'])
+    it "does exclude absolute scopes listed in the exceptions list" do
+      result = I18n::JS.scoped_translations("*", ['de', 'en.admin', 'fr.number.currency'])
 
-      result[:en].should be_nil
       result[:de].should be_nil
-      result[:ja].should be_nil
 
-      result[:fr][:date].should be_nil
-      result[:fr][:time].should be_nil
-      result[:fr][:number].should be_nil
-      result[:fr][:admin][:show].should be_nil
+      result[:en].should be_a(Hash)
+      result[:en][:admin].should be_nil
+
+      result[:fr][:number].should be_a(Hash)
+      result[:fr][:number][:currency].should be_nil
+    end
+
+    it "does not exclude non-absolute scopes listed in the exceptions list" do
+      result = I18n::JS.scoped_translations("*", ['admin', 'currency'])
 
-      result[:fr][:admin][:edit][:title].should be_a(String)
+      result[:en][:admin].should be_a(Hash)
+      result[:fr][:admin].should be_a(Hash)
+      result[:ja][:admin].should be_a(Hash)
+
+      result[:en][:number][:currency].should be_a(Hash)
+      result[:fr][:number][:currency].should be_a(Hash)
     end
   end
 
   context "fallbacks" do
     subject do
-      I18n::JS.translation_segments.inject({}) do |hash, segment|
-        hash[segment.file] = segment.translations
-        hash
-      end
+      I18n::JS.translation_segments.first.translations
     end
 
     it "exports without fallback when disabled" do
       set_config "js_file_per_locale_without_fallbacks.yml"
-      subject["tmp/i18n-js/fr.js"][:fr][:fallback_test].should eql(nil)
+      subject[:fr][:fallback_test].should eql(nil)
     end
 
     it "exports with default_locale as fallback when enabled" do
       set_config "js_file_per_locale_with_fallbacks_enabled.yml"
-      subject["tmp/i18n-js/fr.js"][:fr][:fallback_test].should eql("Success")
+      subject[:fr][:fallback_test].should eql("Success")
     end
 
     it "exports with default_locale as fallback when enabled with :default_locale" do
       set_config "js_file_per_locale_with_fallbacks_as_default_locale_symbol.yml"
-      subject["tmp/i18n-js/fr.js"][:fr][:fallback_test].should eql("Success")
+      subject[:fr][:fallback_test].should eql("Success")
     end
 
     it "exports with given locale as fallback" do
       set_config "js_file_per_locale_with_fallbacks_as_locale.yml"
-      subject["tmp/i18n-js/fr.js"][:fr][:fallback_test].should eql("Erfolg")
+      subject[:fr][:fallback_test].should eql("Erfolg")
     end
 
     context "with I18n::Fallbacks enabled" do
@@ -215,17 +295,17 @@ describe I18n::JS do
 
       it "exports with defined locale as fallback when enabled" do
         set_config "js_file_per_locale_with_fallbacks_enabled.yml"
-        subject["tmp/i18n-js/fr.js"][:fr][:fallback_test].should eql("Erfolg")
+        subject[:fr][:fallback_test].should eql("Erfolg")
       end
 
       it "exports with defined locale as fallback when enabled with :default_locale" do
         set_config "js_file_per_locale_with_fallbacks_as_default_locale_symbol.yml"
-        subject["tmp/i18n-js/fr.js"][:fr][:fallback_test].should eql("Success")
+        subject[:fr][:fallback_test].should eql("Success")
       end
 
       it "exports with Fallbacks as Hash" do
         set_config "js_file_per_locale_with_fallbacks_as_hash.yml"
-        subject["tmp/i18n-js/fr.js"][:fr][:fallback_test].should eql("Erfolg")
+        subject[:fr][:fallback_test].should eql("Erfolg")
       end
     end
   end
@@ -263,6 +343,7 @@ EOS
   end
 
   context "I18n.available_locales" do
+
     context "when I18n.available_locales is not set" do
       it "should allow all locales" do
         result = I18n::JS.scoped_translations("*.admin.*.title")
@@ -401,4 +482,86 @@ EOS
       end
     end
   end
+
+  describe "translation key sorting" do
+
+    describe ".sort_translation_keys?" do
+      after { described_class.send(:remove_instance_variable, :@sort_translation_keys) }
+      subject { described_class.sort_translation_keys? }
+
+
+      context "set with config" do
+
+        context 'when :sort_translation_keys is not set in config' do
+          before :each do
+            set_config "default.yml"
+          end
+
+          it { should eq true }
+        end
+
+        context 'when :sort_translation_keys set to true in config' do
+          before :each do
+            set_config "js_sort_translation_keys_true.yml"
+          end
+
+          it { should eq true }
+        end
+
+        context 'when :sort_translation_keys set to false in config' do
+          before :each do
+            set_config "js_sort_translation_keys_false.yml"
+          end
+
+          it { should eq false }
+        end
+      end
+
+      context 'set by .sort_translation_keys' do
+
+        context "when it is not set" do
+          it { should eq true }
+        end
+
+        context "when it is set to true" do
+          before { described_class.sort_translation_keys = true }
+
+          it { should eq true }
+        end
+
+        context "when it is set to false" do
+          before { described_class.sort_translation_keys = false }
+
+          it { should eq false }
+        end
+      end
+    end
+
+    context "exporting" do
+      subject do
+        I18n::JS.export
+        file_should_exist "en.js"
+        File.read(File.join(I18n::JS.export_i18n_js_dir_path, "en.js"))
+      end
+
+      before do
+        stub_const('I18n::JS::DEFAULT_EXPORT_DIR_PATH', temp_path)
+      end
+
+      context 'sort_translation_keys is true' do
+        before :each do
+          set_config "js_sort_translation_keys_true.yml"
+        end
+
+        it "exports with the keys sorted" do
+          expect(subject).to eq(<<EOS
+I18n.translations || (I18n.translations = {});
+I18n.translations["en"] = {"admin":{"edit":{"title":"Edit"},"show":{"note":"more details","title":"Show"}},"date":{"abbr_day_names":["Sun","Mon","Tue","Wed","Thu","Fri","Sat"],"abbr_month_names":[null,"Jan","Feb","Mar","Apr","May","Jun","Jul","Aug","Sep","Oct","Nov","Dec"],"day_names":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"],"formats":{"default":"%Y-%m-%d","long":"%B %d, %Y","short":"%b %d"},"month_names":[null,"January","February","March","April","May","June","July","August","September","October","November","December"]},"fallback_test":"Success","foo":"Foo","number":{"currency":{"format":{"delimiter":",","format":"%u%n","precision":2,"separator":".","unit":"$"}},"format":{"delimiter":",","precision":3,"separator":"."}},"time":{"am":"am","formats":{"default":"%a, %d %b %Y %H:%M:%S %z","long":"%B %d, %Y %H:%M","short":"%d %b %H:%M"},"pm":"pm"}};
+EOS
+)
+        end
+      end
+    end
+
+  end
 end

data/spec/segment_spec.rb

@@ -3,7 +3,7 @@ require "spec_helper"
 describe I18n::JS::Segment do
 
   let(:file)        { "tmp/i18n-js/segment.js" }
-  let(:translations){ { "en" => { "test" => "Test" }, "fr" => { "test" => "Test2" } } }
+  let(:translations){ { en: { "test" => "Test" }, fr: { "test" => "Test2" } } }
   let(:namespace)   { "MyNamespace" }
   let(:pretty_print){ nil }
   let(:options)     { {namespace: namespace, pretty_print: pretty_print} }
@@ -58,14 +58,52 @@ describe I18n::JS::Segment do
     before { allow(I18n::JS).to receive(:export_i18n_js_dir_path).and_return(temp_path) }
     before { subject.save! }
 
-    it "should write the file" do
-      file_should_exist "segment.js"
+    context "when file does not include %{locale}" do
+      it "should write the file" do
+        file_should_exist "segment.js"
 
-      File.open(File.join(temp_path, "segment.js")){|f| f.read}.should eql <<-EOF
+        File.open(File.join(temp_path, "segment.js")){|f| f.read}.should eql <<-EOF
 MyNamespace.translations || (MyNamespace.translations = {});
 MyNamespace.translations["en"] = {"test":"Test"};
 MyNamespace.translations["fr"] = {"test":"Test2"};
-EOF
+        EOF
+      end
+    end
+
+    context "when file includes %{locale}" do
+      let(:file){ "tmp/i18n-js/%{locale}.js" }
+
+      it "should write files" do
+        file_should_exist "en.js"
+        file_should_exist "fr.js"
+
+        File.open(File.join(temp_path, "en.js")){|f| f.read}.should eql <<-EOF
+MyNamespace.translations || (MyNamespace.translations = {});
+MyNamespace.translations["en"] = {"test":"Test"};
+        EOF
+
+        File.open(File.join(temp_path, "fr.js")){|f| f.read}.should eql <<-EOF
+MyNamespace.translations || (MyNamespace.translations = {});
+MyNamespace.translations["fr"] = {"test":"Test2"};
+        EOF
+      end
+    end
+
+    context "when sort_translation_keys? is true" do
+      before :each do
+        I18n::JS.sort_translation_keys = true
+      end
+
+      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
   end
 end

data/spec/utils_spec.rb

@@ -66,4 +66,41 @@ describe I18n::JS::Utils do
       hash.should eql({:a => {:b => 1, :c => 2}})
     end
   end
+
+  describe ".deep_key_sort" do
+    let(:unsorted_hash) { {:z => {:b => 1, :a => 2}, :y => 3} }
+    subject(:sorting) { described_class.deep_key_sort(unsorted_hash) }
+
+    it "performs a deep keys sort without changing the original hash" do
+      should eql({:y => 3, :z => {:a => 2, :b => 1}})
+      unsorted_hash.should eql({:z => {:b => 1, :a => 2}, :y => 3})
+    end
+
+    # Idea from gem `rails_admin`
+    context "when hash contain non-Symbol as key" do
+      let(:unsorted_hash) { {:z => {1 => 1, true => 2}, :y => 3} }
+
+      it "performs a deep keys sort without error" do
+        expect{ sorting }.to_not raise_error
+      end
+      it "converts keys to symbols" do
+        should eql({:y => 3, :z => {1 => 1, true => 2}})
+      end
+    end
+  end
+
+  describe ".scopes_match?" do
+    it "performs a comparison of literal scopes" do
+      described_class.scopes_match?([:a, :b], [:a, :b, :c]).should_not eql true
+      described_class.scopes_match?([:a, :b, :c], [:a, :b, :c]).should eql true
+      described_class.scopes_match?([:a, :b, :c], [:a, :b, :d]).should_not eql true
+    end
+
+    it "performs a comparison of wildcard scopes" do
+      described_class.scopes_match?([:a, '*'], [:a, :b, :c]).should_not eql true
+      described_class.scopes_match?([:a, '*', :c], [:a, :b, :c]).should eql true
+      described_class.scopes_match?([:a, :b, :c], [:a, '*', :c]).should eql true
+      described_class.scopes_match?([:a, :b, :c], [:a, '*', '*']).should eql true
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: i18n-js
 version: !ruby/object:Gem::Version
-  version: 3.0.0.rc9
+  version: 3.0.0.rc10
 platform: ruby
 authors:
 - Nando Vieira
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-12 00:00:00.000000000 Z
+date: 2015-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -141,6 +141,8 @@ files:
 - spec/fixtures/js_file_per_locale_with_fallbacks_enabled.yml
 - spec/fixtures/js_file_per_locale_without_fallbacks.yml
 - spec/fixtures/js_file_with_namespace_and_pretty_print.yml
+- spec/fixtures/js_sort_translation_keys_false.yml
+- spec/fixtures/js_sort_translation_keys_true.yml
 - spec/fixtures/locales.yml
 - spec/fixtures/multiple_conditions.yml
 - spec/fixtures/multiple_conditions_per_locale.yml
@@ -213,6 +215,8 @@ test_files:
 - spec/fixtures/js_file_per_locale_with_fallbacks_enabled.yml
 - spec/fixtures/js_file_per_locale_without_fallbacks.yml
 - spec/fixtures/js_file_with_namespace_and_pretty_print.yml
+- spec/fixtures/js_sort_translation_keys_false.yml
+- spec/fixtures/js_sort_translation_keys_true.yml
 - spec/fixtures/locales.yml
 - spec/fixtures/multiple_conditions.yml
 - spec/fixtures/multiple_conditions_per_locale.yml