i18n-js-pika 3.0.0.rc6

data/lib/i18n/js/engine.rb

@@ -0,0 +1,22 @@
+require "i18n/js"
+
+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
+
+          registry = Sprockets.respond_to?("register_preprocessor") ? Sprockets : Rails.application.assets
+
+          registry.register_preprocessor "application/javascript", :"i18n-js_dependencies" do |context, source|
+            next source unless context.logical_path == "i18n/filtered"
+            ::I18n.load_path.each {|path| context.depend_on(File.expand_path(path))}
+            source
+          end
+        end
+      end
+    end
+  end
+end

data/lib/i18n/js/middleware.rb

@@ -0,0 +1,59 @@
+module I18n
+  module JS
+    class Middleware
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        @cache = nil
+        verify_locale_files!
+        @app.call(env)
+      end
+
+      private
+      def cache_path
+        @cache_path ||= Rails.root.join("tmp/cache/i18n-js.yml")
+      end
+
+      def cache
+        @cache ||= begin
+          if cache_path.exist?
+            YAML.load_file(cache_path) || {}
+          else
+            {}
+          end
+        end
+      end
+
+      # Check if translations should be regenerated.
+      # ONLY REGENERATE when these conditions are met:
+      #
+      # # Cache file doesn't exist
+      # # Translations and cache size are different (files were removed/added)
+      # # Translation file has been updated
+      #
+      def verify_locale_files!
+        valid_cache = []
+        new_cache = {}
+
+        valid_cache.push cache_path.exist?
+        valid_cache.push ::I18n.load_path.uniq.size == cache.size
+
+        ::I18n.load_path.each do |path|
+          changed_at = File.mtime(path).to_i
+          valid_cache.push changed_at == cache[path]
+          new_cache[path] = changed_at
+        end
+
+        return if valid_cache.all?
+
+        File.open(cache_path, "w+") do |file|
+          file << new_cache.to_yaml
+        end
+
+        ::I18n::JS.export
+      end
+    end
+  end
+end

data/lib/i18n/js/version.rb

@@ -0,0 +1,12 @@
+module I18n
+  module JS
+    module Version
+      MAJOR = 3
+      MINOR = 0
+      PATCH = 0
+      # Set to nil for stable release
+      BUILD = 'rc6'.freeze
+      STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.')
+    end
+  end
+end

data/lib/i18n/js.rb

@@ -0,0 +1,162 @@
+require "i18n"
+require "FileUtils" unless defined?(FileUtils)
+
+module I18n
+  module JS
+    if defined?(Rails)
+      require "i18n/js/middleware"
+      require "i18n/js/engine"
+    end
+
+    # deep_merge by Stefan Rusterholz, see <http://www.ruby-forum.com/topic/142809>.
+    MERGER = proc do |key, v1, v2|
+      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
+      @config_file ||= "config/i18n-js.yml"
+    end
+
+    # Export translations to JavaScript, considering settings
+    # from configuration file
+    def self.export
+      translation_segments.each do |filename, translations|
+        save(translations, filename)
+      end
+    end
+
+    def self.segments_per_locale(pattern, scope)
+      I18n.available_locales.each_with_object({}) do |locale, segments|
+        result = scoped_translations("#{locale}.#{scope}")
+        next if result.empty?
+
+        segment_name = ::I18n.interpolate(pattern,{:locale => locale})
+        segments[segment_name] = result
+      end
+    end
+
+    def self.segment_for_scope(scope)
+      if scope == "*"
+        translations
+      else
+        scoped_translations(scope)
+      end
+    end
+
+    def self.configured_segments
+      config[:translations].each_with_object({}) do |options, segments|
+        options.reverse_merge!(:only => "*")
+        if options[:file] =~ ::I18n::INTERPOLATION_PATTERN
+          segments.merge!(segments_per_locale(options[:file], options[:only]))
+        else
+          result = segment_for_scope(options[:only])
+          segments[options[:file]] = result unless result.empty?
+        end
+      end
+    end
+
+    def self.export_dir
+      "public/javascripts"
+    end
+
+    def self.filtered_translations
+      {}.tap do |result|
+        translation_segments.each do |filename, translations|
+          deep_merge!(result, translations)
+        end
+      end
+    end
+
+    def self.translation_segments
+      segments = if config? && config[:translations]
+        configured_segments
+      else
+        {"#{export_dir}/translations.js" => translations}
+      end
+      segments.inject({}) do |hash, (filename, translations)|
+        hash[filename] = translations.nil? ? nil : translations.select{|locale,_| I18n.available_locales.include?(locale) }
+        hash
+      end
+    end
+
+    # Load configuration file for partial exporting and
+    # custom output directory
+    def self.config
+      if config?
+        (YAML.load_file(config_file) || {}).with_indifferent_access
+      else
+        {}
+      end
+    end
+
+    # Check if configuration file exist
+    def self.config?
+      File.file? config_file
+    end
+
+    # Convert translations to JSON string and save file.
+    def self.save(translations, file)
+      FileUtils.mkdir_p File.dirname(file)
+
+      File.open(file, "w+") do |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
+
+    def self.scoped_translations(scopes) # :nodoc:
+      result = {}
+
+      [scopes].flatten.each do |scope|
+        deep_merge! result, filter(translations, scope)
+      end
+
+      result
+    end
+
+    # Filter translations according to the specified scope.
+    def self.filter(translations, scopes)
+      scopes = scopes.split(".") if scopes.is_a?(String)
+      scopes = scopes.clone
+      scope = scopes.shift
+
+      if scope == "*"
+        results = {}
+        translations.each do |scope, translations|
+          tmp = scopes.empty? ? translations : filter(translations, scopes)
+          results[scope.to_sym] = tmp unless tmp.nil?
+        end
+        return results
+      elsif translations.has_key?(scope.to_sym)
+        return {scope.to_sym => scopes.empty? ? translations[scope.to_sym] : filter(translations[scope.to_sym], scopes)}
+      end
+      nil
+    end
+
+    # Initialize and return translations
+    def self.translations
+      ::I18n.backend.instance_eval do
+        init_translations unless initialized?
+        translations
+      end
+    end
+
+    def self.deep_merge(target, hash) # :nodoc:
+      target.merge(hash, &MERGER)
+    end
+
+    def self.deep_merge!(target, hash) # :nodoc:
+      target.merge!(hash, &MERGER)
+    end
+  end
+end

data/lib/i18n-js.rb

@@ -0,0 +1 @@
+require "i18n/js"

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/package.json

@@ -0,0 +1,11 @@
+{
+  "name": "i18n-js",
+  "version": "0.0.0",
+  "devDependencies": {
+    "jasmine-node": "*"
+  },
+
+  "scripts": {
+    "test": "./node_modules/.bin/jasmine-node spec/js"
+  }
+}

data/spec/fixtures/custom_path.yml

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

data/spec/fixtures/default.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: "*"

data/spec/fixtures/js_file_per_locale.yml

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

data/spec/fixtures/locales.yml

@@ -0,0 +1,76 @@
+en:
+  number:
+    format:
+      separator: "."
+      delimiter: ","
+      precision: 3
+    currency:
+      format:
+        format: "%u%n"
+        unit: "$"
+        separator: "."
+        delimiter: ","
+        precision: 2
+  date:
+    formats:
+      default: "%Y-%m-%d"
+      short: "%b %d"
+      long: "%B %d, %Y"
+    day_names: [Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday]
+    abbr_day_names: [Sun, Mon, Tue, Wed, Thu, Fri, Sat]
+    month_names: [~, January, February, March, April, May, June, July, August, September, October, November, December]
+    abbr_month_names: [~, Jan, Feb, Mar, Apr, May, Jun, Jul, Aug, Sep, Oct, Nov, Dec]
+    # order: [ :year, :month, :day ]
+  time:
+    formats:
+      default: "%a, %d %b %Y %H:%M:%S %z"
+      short: "%d %b %H:%M"
+      long: "%B %d, %Y %H:%M"
+    am: "am"
+    pm: "pm"
+  admin:
+    show:
+      title: "Show"
+      note: "more details"
+    edit:
+      title: "Edit"
+
+fr:
+  date:
+    formats:
+      default: "%d/%m/%Y"
+      short: "%e %b"
+      long: "%e %B %Y"
+      long_ordinal: "%e %B %Y"
+      only_day: "%e"
+    day_names: [dimanche, lundi, mardi, mercredi, jeudi, vendredi, samedi]
+    abbr_day_names: [dim, lun, mar, mer, jeu, ven, sam]
+    month_names: [~, janvier, février, mars, avril, mai, juin, juillet, août, septembre, octobre, novembre, décembre]
+    abbr_month_names: [~, jan., fév., mar., avr., mai, juin, juil., août, sept., oct., nov., déc.]
+    # order: [ :day, :month, :year ]
+  time:
+    formats:
+      default: "%d %B %Y %H:%M"
+      time: "%H:%M"
+      short: "%d %b %H:%M"
+      long: "%A %d %B %Y %H:%M:%S %Z"
+      long_ordinal: "%A %d %B %Y %H:%M:%S %Z"
+      only_second: "%S"
+    am: 'am'
+    pm: 'pm'
+  number:
+    format:
+      precision: 3
+      separator: ','
+      delimiter: ' '
+    currency:
+      format:
+        unit: '€'
+        precision: 2
+        format: '%n %u'
+  admin:
+    show:
+      title: "Visualiser"
+      note: "plus de détails"
+    edit:
+      title: "Editer"

data/spec/fixtures/multiple_conditions.yml

@@ -0,0 +1,5 @@
+translations:
+  - file: "tmp/i18n-js/bitsnpieces.js"
+    only:
+      - "*.date.formats"
+      - "*.number.currency"

data/spec/fixtures/multiple_files.yml

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

data/spec/fixtures/no_config.yml

@@ -0,0 +1,2 @@
+#This file has no config
+

data/spec/fixtures/no_scope.yml

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

data/spec/fixtures/simple_scope.yml

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

data/spec/i18n_js_spec.rb

@@ -0,0 +1,139 @@
+require "spec_helper"
+
+describe I18n::JS do
+  context "exporting" do
+    before do
+      I18n::JS.stub :export_dir => temp_path
+    end
+
+    it "exports messages to default path when configuration file doesn't exist" do
+      I18n::JS.export
+      file_should_exist "translations.js"
+    end
+
+    it "exports messages using custom output path" do
+      set_config "custom_path.yml"
+      I18n::JS.should_receive(:save).with(translations, "tmp/i18n-js/all.js")
+      I18n::JS.export
+    end
+
+    it "sets default scope to * when not specified" do
+      set_config "no_scope.yml"
+      I18n::JS.should_receive(:save).with(translations, "tmp/i18n-js/no_scope.js")
+      I18n::JS.export
+    end
+
+    it "exports to multiple files" do
+      set_config "multiple_files.yml"
+      I18n::JS.export
+
+      file_should_exist "all.js"
+      file_should_exist "tudo.js"
+    end
+
+    it "ignores an empty config file" do
+      set_config "no_config.yml"
+      I18n::JS.export
+
+      file_should_exist "translations.js"
+    end
+
+    it "exports to a JS file per available locale" do
+      set_config "js_file_per_locale.yml"
+      I18n::JS.export
+
+      file_should_exist "en.js"
+    end
+
+    it "exports with multiple conditions" do
+      set_config "multiple_conditions.yml"
+      I18n::JS.export
+
+      file_should_exist "bitsnpieces.js"
+    end
+  end
+
+  context "filters" do
+    it "filters translations using scope *.date.formats" do
+      result = I18n::JS.filter(translations, "*.date.formats")
+      result[:en][:date].keys.should eql([:formats])
+      result[:fr][:date].keys.should eql([:formats])
+    end
+
+    it "filters translations using scope [*.date.formats, *.number.currency.format]" do
+      result = I18n::JS.scoped_translations(["*.date.formats", "*.number.currency.format"])
+      result[:en].keys.collect(&:to_s).sort.should eql(%w[ date number ])
+      result[:fr].keys.collect(&:to_s).sort.should eql(%w[ date number ])
+    end
+
+    it "filters translations using multi-star scope" do
+      result = I18n::JS.scoped_translations("*.*.formats")
+
+      result[:en].keys.collect(&:to_s).sort.should eql(%w[ date time ])
+      result[:fr].keys.collect(&:to_s).sort.should eql(%w[ date time ])
+
+      result[:en][:date].keys.should eql([:formats])
+      result[:en][:time].keys.should eql([:formats])
+
+      result[:fr][:date].keys.should eql([:formats])
+      result[:fr][:time].keys.should eql([:formats])
+    end
+
+    it "filters translations using alternated stars" do
+      result = I18n::JS.scoped_translations("*.admin.*.title")
+
+      result[:en][:admin].keys.collect(&:to_s).sort.should eql(%w[ edit show ])
+      result[:fr][:admin].keys.collect(&:to_s).sort.should eql(%w[ edit show ])
+
+      result[:en][:admin][:show][:title].should eql("Show")
+      result[:fr][:admin][:show][:title].should eql("Visualiser")
+
+      result[:en][:admin][:edit][:title].should eql("Edit")
+      result[:fr][:admin][:edit][:title].should eql("Editer")
+    end
+
+    context "with available_locales set" do
+      before do
+        I18n.stub :available_locales => [:fr]
+      end
+
+      context 'when without config' do
+        let(:result){ I18n::JS.translation_segments.values.first }
+        it "limits the translations to the available locales" do
+          result[:en].should be_nil
+          result[:fr].should be_present
+        end
+      end
+
+      # Don't know how to test this yet
+      context 'when with config'
+    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({})
+    end
+  end
+
+  context "hash merging" do
+    it "performs a deep merge" do
+      target = {:a => {:b => 1}}
+      result = I18n::JS.deep_merge(target, {:a => {:c => 2}})
+
+      result[:a].should eql({:b => 1, :c => 2})
+    end
+
+    it "performs a banged deep merge" do
+      target = {:a => {:b => 1}}
+      I18n::JS.deep_merge!(target, {:a => {:c => 2}})
+
+      target[:a].should eql({:b => 1, :c => 2})
+    end
+  end
+end

data/spec/js/currency.spec.js

@@ -0,0 +1,60 @@
+var I18n = require("../../app/assets/javascripts/i18n")
+  , Translations = require("./translations")
+;
+
+describe("Currency", function(){
+  var actual, expected;
+
+  beforeEach(function() {
+    I18n.reset();
+    I18n.translations = Translations();
+  });
+
+  it("formats currency with default settings", function(){
+    expect(I18n.toCurrency(100.99)).toEqual("$100.99");
+    expect(I18n.toCurrency(1000.99)).toEqual("$1,000.99");
+  });
+
+  it("formats currency with custom settings", function(){
+    I18n.translations.en.number = {
+      currency: {
+        format: {
+          format: "%n %u",
+          unit: "USD",
+          delimiter: ".",
+          separator: ",",
+          precision: 2
+        }
+      }
+    };
+
+    expect(I18n.toCurrency(12)).toEqual("12,00 USD");
+    expect(I18n.toCurrency(123)).toEqual("123,00 USD");
+    expect(I18n.toCurrency(1234.56)).toEqual("1.234,56 USD");
+  });
+
+  it("formats currency with custom settings and partial overriding", function(){
+    I18n.translations.en.number = {
+      currency: {
+        format: {
+          format: "%n %u",
+          unit: "USD",
+          delimiter: ".",
+          separator: ",",
+          precision: 2
+        }
+      }
+    };
+
+    expect(I18n.toCurrency(12, {precision: 0})).toEqual("12 USD");
+    expect(I18n.toCurrency(123, {unit: "bucks"})).toEqual("123,00 bucks");
+  });
+
+  it("formats currency with some custom options that should be merged with default options", function(){
+    expect(I18n.toCurrency(1234, {precision: 0})).toEqual("$1,234");
+    expect(I18n.toCurrency(1234, {unit: "º"})).toEqual("º1,234.00");
+    expect(I18n.toCurrency(1234, {separator: "-"})).toEqual("$1,234-00");
+    expect(I18n.toCurrency(1234, {delimiter: "-"})).toEqual("$1-234.00");
+    expect(I18n.toCurrency(1234, {format: "%u %n"})).toEqual("$ 1,234.00");
+  });
+});

data/spec/js/current_locale.spec.js

@@ -0,0 +1,19 @@
+var I18n = require("../../app/assets/javascripts/i18n");
+
+describe("Current locale", function(){
+  beforeEach(function(){
+    I18n.reset();
+  });
+
+  it("returns I18n.locale", function(){
+    I18n.locale = "pt-BR";
+    expect(I18n.currentLocale()).toEqual("pt-BR");
+  });
+
+  it("returns I18n.defaultLocale", function(){
+    I18n.locale = null;
+    I18n.defaultLocale = "pt-BR";
+
+    expect(I18n.currentLocale()).toEqual("pt-BR");
+  });
+});