i18n-js 3.0.0.rc5 → 3.0.0.rc6

data/app/assets/javascripts/i18n/{translations.js.erb → filtered.js.erb}

@@ -1,4 +1,2 @@
-//= require i18n/shims
-//= require i18n
-//= require_self
+<%# encoding: utf-8 %>
 ;I18n.translations = <%= I18n::JS.filtered_translations.to_json %>;

data/app/assets/javascripts/i18n/shims.js

@@ -91,3 +91,29 @@ if ( !Array.prototype.forEach ) {
     // 8. return undefined
   };
 }
+
+// https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/some
+if (!Array.prototype.some)
+{
+  Array.prototype.some = function(fun /*, thisArg */)
+  {
+    'use strict';
+
+    if (this === void 0 || this === null)
+      throw new TypeError();
+
+    var t = Object(this);
+    var len = t.length >>> 0;
+    if (typeof fun !== 'function')
+      throw new TypeError();
+
+    var thisArg = arguments.length >= 2 ? arguments[1] : void 0;
+    for (var i = 0; i < len; i++)
+    {
+      if (i in t && fun.call(thisArg, t[i], i, t))
+        return true;
+    }
+
+    return false;
+  };
+}

data/app/assets/javascripts/i18n/translations.js

@@ -0,0 +1,3 @@
+//= require i18n/shims
+//= require i18n
+//= require i18n/filtered

data/gemfiles/i18n_0_6.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "i18n", "0.6.9"
+
+gemspec :path => "../"

data/i18n-js.gemspec

@@ -17,9 +17,11 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_dependency "i18n"
-  s.add_development_dependency "activesupport"
-  s.add_development_dependency "rspec"
+  s.add_dependency "i18n", "~> 0.6"
+  s.add_development_dependency "appraisal", "~> 1.0"
+  s.add_development_dependency "activesupport", ">= 3"
+  s.add_development_dependency "rspec", "~> 3.0"
   s.add_development_dependency "rake"
   s.add_development_dependency "pry-meta"
+  s.add_development_dependency "gem-release", ">= 0.7"
 end

data/lib/i18n/js.rb

@@ -1,9 +1,10 @@
 require "i18n"
-require "FileUtils" unless defined?(FileUtils)
+require "fileutils"
 
 module I18n
   module JS
-    if defined?(Rails)
+    require "i18n/js/dependencies"
+    if JS::Dependencies.rails?
       require "i18n/js/middleware"
       require "i18n/js/engine"
     end
@@ -13,12 +14,6 @@ module I18n
       Hash === v1 && Hash === v2 ? v1.merge(v2, &MERGER) : v2
     end
 
-    # Detect if Rails app has asset pipeline support.
-    #
-    def self.has_asset_pipeline?
-      Rails.configuration.respond_to?(:assets) && Rails.configuration.assets.enabled
-    end
-
     # The configuration file. This defaults to the `config/i18n-js.yml` file.
     #
     def self.config_file
@@ -35,7 +30,8 @@ module I18n
 
     def self.segments_per_locale(pattern, scope)
       I18n.available_locales.each_with_object({}) do |locale, segments|
-        result = scoped_translations("#{locale}.#{scope}")
+        scope = [scope] unless scope.respond_to?(:each)
+        result = scoped_translations(scope.collect{|s| "#{locale}.#{s}"})
         next if result.empty?
 
         segment_name = ::I18n.interpolate(pattern,{:locale => locale})
@@ -87,7 +83,8 @@ module I18n
     # custom output directory
     def self.config
       if config?
-        (YAML.load_file(config_file) || {}).with_indifferent_access
+        erb = ERB.new(File.read(config_file)).result
+        (YAML.load(erb) || {}).with_indifferent_access
       else
         {}
       end
@@ -103,9 +100,10 @@ module I18n
       FileUtils.mkdir_p File.dirname(file)
 
       File.open(file, "w+") do |f|
-        f << %(I18n.translations = );
-        f << translations.to_json
-        f << %(;)
+        f << %(I18n.translations || (I18n.translations = {});\n)
+        translations.each do |locale, translations_for_locale|
+          f << %(I18n.translations["#{locale}"] = #{translations_for_locale.to_json};\n);
+        end
       end
     end
 
@@ -132,7 +130,7 @@ module I18n
           results[scope.to_sym] = tmp unless tmp.nil?
         end
         return results
-      elsif translations.has_key?(scope.to_sym)
+      elsif translations.respond_to?(:has_key?) && translations.has_key?(scope.to_sym)
         return {scope.to_sym => scopes.empty? ? translations[scope.to_sym] : filter(translations[scope.to_sym], scopes)}
       end
       nil
@@ -142,7 +140,7 @@ module I18n
     def self.translations
       ::I18n.backend.instance_eval do
         init_translations unless initialized?
-        translations
+        translations.slice(*::I18n.available_locales)
       end
     end
 

data/lib/i18n/js/dependencies.rb

@@ -0,0 +1,61 @@
+module I18n
+  module JS
+    module Dependencies
+      class << self
+        def rails3?
+          safe_gem_check("rails", "~> 3") && running_rails3?
+        end
+
+        def rails4?
+          safe_gem_check("rails", "~> 4") && running_rails4?
+        end
+
+        def rails?
+          rails_available? && running_rails?
+        end
+
+        def rails_available?
+          safe_gem_check("rails", '>= 3')
+        end
+
+        def using_asset_pipeline?
+          assets_pipeline_available =
+            (rails3? || rails4?) &&
+            Rails.respond_to?(:application) &&
+            Rails.application.respond_to?(:assets)
+          rails3_assets_enabled =
+            rails3? &&
+            assets_pipeline_available &&
+            Rails.application.config.assets.enabled != false
+
+          assets_pipeline_available && (rails4? || rails3_assets_enabled)
+        end
+
+        private
+
+        def running_rails3?
+          running_rails? && Rails.version.to_i == 3
+        end
+
+        def running_rails4?
+          running_rails? && Rails.version.to_i == 4
+        end
+
+        def running_rails?
+          defined?(Rails) && Rails.respond_to?(:version)
+        end
+
+        def safe_gem_check(gem_name, version_string)
+          if Gem::Specification.respond_to?(:find_by_name)
+            Gem::Specification.find_by_name(gem_name, version_string)
+          elsif Gem.respond_to?(:available?)
+            Gem.available?(gem_name, version_string)
+          end
+        rescue Gem::LoadError
+          false
+        end
+
+      end
+    end
+  end
+end

data/lib/i18n/js/engine.rb

@@ -4,15 +4,14 @@ module I18n
   module JS
     class Engine < ::Rails::Engine
       initializer :after => "sprockets.environment" do
-        ActiveSupport.on_load(:after_initialize, :yield => true) do
-          next unless JS.has_asset_pipeline?
-          next unless Rails.configuration.assets.compile
+        next unless JS::Dependencies.using_asset_pipeline?
+        next unless Rails.configuration.assets.compile
 
-          Rails.application.assets.register_preprocessor "application/javascript", :"i18n-js_dependencies" do |context, source|
-            next source unless context.logical_path == "i18n/translations"
-            ::I18n.load_path.each {|path| context.depend_on(path)}
-            source
+        Rails.application.assets.register_preprocessor "application/javascript", :"i18n-js_dependencies" do |context, source|
+          if context.logical_path == "i18n/filtered"
+            ::I18n.load_path.each {|path| context.depend_on(File.expand_path(path))}
           end
+          source
         end
       end
     end

data/lib/i18n/js/middleware.rb

@@ -13,7 +13,11 @@ module I18n
 
       private
       def cache_path
-        @cache_path ||= Rails.root.join("tmp/cache/i18n-js.yml")
+        @cache_path ||= cache_dir.join("i18n-js.yml")
+      end
+
+      def cache_dir
+        @cache_dir ||= Rails.root.join("tmp/cache")
       end
 
       def cache
@@ -26,6 +30,13 @@ module I18n
         end
       end
 
+      def save_cache(new_cache)
+        FileUtils.mkdir_p(cache_dir)
+        File.open(cache_path, "w+") do |file|
+          file << new_cache.to_yaml
+        end
+      end
+
       # Check if translations should be regenerated.
       # ONLY REGENERATE when these conditions are met:
       #
@@ -48,9 +59,7 @@ module I18n
 
         return if valid_cache.all?
 
-        File.open(cache_path, "w+") do |file|
-          file << new_cache.to_yaml
-        end
+        save_cache(new_cache)
 
         ::I18n::JS.export
       end

data/lib/i18n/js/version.rb

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

data/lib/rails/generators/i18n/js/config/config_generator.rb

@@ -0,0 +1,19 @@
+module I18n
+  module Js
+    class ConfigGenerator < Rails::Generators::Base
+      # Copied files come from templates folder
+      source_root File.expand_path('../templates', __FILE__)
+
+      # Generator desc
+      desc <<-DESC
+        Creates a default i18n-js.yml configuration file in your app's config
+        folder. This file allows you to customize i18n:js:export rake task
+        outputted files.
+      DESC
+
+      def copy_initializer_file
+        copy_file "i18n-js.yml", "config/i18n-js.yml"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# Split context in several files.
+#
+# By default only one file with all translations is exported and
+# no configuration is required. Your settings for asset pipeline
+# are automatically recognized.
+#
+# If you want to split translations into several files or specify
+# locale contexts that will be exported, just use this file to do
+# 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
+#
+#
+# If you're going to use the Rails 3.1 asset pipeline, change
+# the following configuration to something like this:
+#
+# translations:
+#   - file: "app/assets/javascripts/i18n/translations.js"
+#
+# If you're running an old version, you can use something
+# like this:
+#
+# translations:
+#   - file: "app/assets/javascripts/i18n/translations.js"
+#     only: "*"
+#

data/lib/tasks/export.rake

@@ -0,0 +1,8 @@
+namespace :i18n do
+  namespace :js do
+    desc "Export translations to JS file(s)"
+    task :export => :environment do
+      I18n::JS.export
+    end
+  end
+end

data/spec/fixtures/erb.yml

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

data/spec/fixtures/locales.yml

@@ -34,6 +34,7 @@ en:
       note: "more details"
     edit:
       title: "Edit"
+  foo: "Foo"
 
 fr:
   date:
@@ -74,3 +75,8 @@ fr:
       note: "plus de détails"
     edit:
       title: "Editer"
+
+ja:
+  admin:
+    show:
+      title: "Ignore me"

data/spec/fixtures/multiple_conditions_per_locale.yml

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

data/spec/i18n_js_spec.rb

@@ -51,6 +51,20 @@ describe I18n::JS do
 
       file_should_exist "bitsnpieces.js"
     end
+
+    it "exports with multiple conditions to a JS file per available locale" do
+      allow(::I18n).to receive(:available_locales){ [:en, :fr] }
+
+      set_config "multiple_conditions_per_locale.yml"
+
+      result = I18n::JS.translation_segments
+      result.keys.should eql(["tmp/i18n-js/bits.en.js", "tmp/i18n-js/bits.fr.js"])
+
+      %w{en fr}.each do |lang|
+        result["tmp/i18n-js/bits.#{lang}.js"].keys.should eql([lang.to_sym])
+        result["tmp/i18n-js/bits.#{lang}.js"][lang.to_sym].keys.sort.should eql([:date, :number])
+      end
+    end
   end
 
   context "filters" do
@@ -93,15 +107,46 @@ describe I18n::JS do
     end
   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")
+
+        result[:en][:admin][:show][:title].should eql("Show")
+        result[:fr][:admin][:show][:title].should eql("Visualiser")
+        result[:ja][:admin][:show][:title].should eql("Ignore me")
+      end
+    end
+
+    context "when I18n.available_locales is set" do
+      before { allow(::I18n).to receive(:available_locales){ [:en, :fr] } }
+
+      it "should ignore non-valid locales" do
+        result = I18n::JS.scoped_translations("*.admin.*.title")
+
+        result[:en][:admin][:show][:title].should eql("Show")
+        result[:fr][:admin][:show][:title].should eql("Visualiser")
+        result.keys.include?(:ja).should eql(false)
+      end
+    end
+  end
+
   context "general" do
     it "sets export directory" do
       I18n::JS.export_dir.should eql("public/javascripts")
     end
 
     it "sets empty hash as configuration when no file is found" do
-      I18n::JS.config?.should be_false
+      I18n::JS.config?.should eql(false)
       I18n::JS.config.should eql({})
     end
+
+    it "executes erb in config file" do
+      set_config "erb.yml"
+
+      config_entry = I18n::JS.config["translations"].first
+      config_entry["only"].should eq("*.date.formats")
+    end
   end
 
   context "hash merging" do

data/spec/js/dates.spec.js

@@ -47,6 +47,10 @@ describe("Dates", function(){
     actual = I18n.parseDate("2011-07-20T12:51:55+0000");
     expect(actual.toString()).toEqual(expected.toString());
 
+    expected = new Date(Date.UTC(2011, 6, 20, 12, 51, 55));
+    actual = I18n.parseDate("2011-07-20T12:51:55+00:00");
+    expect(actual.toString()).toEqual(expected.toString());
+
     expected = new Date(Date.UTC(2011, 6, 20, 13, 03, 39));
     actual = I18n.parseDate("Wed Jul 20 13:03:39 +0000 2011");
     expect(actual.toString()).toEqual(expected.toString());
@@ -54,6 +58,21 @@ describe("Dates", function(){
     expected = new Date(Date.UTC(2009, 0, 24, 15, 33, 44));
     actual = I18n.parseDate("2009-01-24T15:33:44Z");
     expect(actual.toString()).toEqual(expected.toString());
+
+    expected = new Date(Date.UTC(2009, 0, 24, 15, 34, 44, 200));
+    actual = I18n.parseDate("2009-01-24T15:34:44.200Z");
+    expect(actual.toString()).toEqual(expected.toString());
+    expect(actual.getMilliseconds()).toEqual(expected.getMilliseconds())
+
+    expected = new Date(Date.UTC(2009, 0, 24, 15, 34, 45, 200));
+    actual = I18n.parseDate("2009-01-24T15:34:45.200+0000");
+    expect(actual.toString()).toEqual(expected.toString());
+    expect(actual.getMilliseconds()).toEqual(expected.getMilliseconds())
+
+    expected = new Date(Date.UTC(2009, 0, 24, 15, 34, 46, 200));
+    actual = I18n.parseDate("2009-01-24T15:34:46.200+00:00");
+    expect(actual.toString()).toEqual(expected.toString());
+    expect(actual.getMilliseconds()).toEqual(expected.getMilliseconds())
   });
 
   it("formats date", function(){
@@ -215,4 +234,25 @@ describe("Dates", function(){
     var date = new Date(2009, 3, 26, 19, 35, 44);
     expect(I18n.strftime(date, "%a")).toEqual("Sun");
   });
+
+  it("applies locale fallback", function(){
+    I18n.defaultLocale = "en-US";
+    I18n.locale = "de";
+
+    var date = new Date(2009, 3, 26, 19, 35, 44);
+    expect(I18n.strftime(date, "%A")).toEqual("Sonntag");
+
+    date = new Date(2009, 3, 26, 19, 35, 44);
+    expect(I18n.strftime(date, "%a")).toEqual("Sun");
+  });
+
+  it("uses time as the meridian scope", function(){
+    I18n.locale = "de";
+
+    var date = new Date(2009, 3, 26, 19, 35, 44);
+    expect(I18n.strftime(date, "%p")).toEqual("de:PM");
+
+    date = new Date(2009, 3, 26, 7, 35, 44);
+    expect(I18n.strftime(date, "%p")).toEqual("de:AM");
+  });
 });