socialcast-i18n-js 4.0.0.rc1

data/lib/i18n/js/engine.rb

@@ -0,0 +1,6 @@
+module I18n
+  module Js
+    class Engine < ::Rails::Engine
+    end
+  end
+end

data/lib/i18n/js/file_dependency_processor.rb

@@ -0,0 +1,17 @@
+#encoding: utf-8
+require 'sprockets'
+module I18n
+  module Js
+    class FileDependencyProcessor < Sprockets::Processor
+      def self.asset_path_regexp
+        @@asset_path_regexp ||= %r{#{I18n::Js.config[:asset_path]}}
+      end
+      def evaluate(context, locals)
+        return data unless context.logical_path =~ self.class.asset_path_regexp
+        ::I18n.load_path.each {|path| context.depend_on(path)}
+        context.depend_on(I18n::Js.config_path)
+        data
+      end
+    end
+  end
+end

data/lib/i18n/js/railtie.rb

@@ -0,0 +1,17 @@
+require 'i18n/js/engine'
+
+module I18n
+  module Js
+    autoload :Translator, "i18n/js/translator"
+    autoload :FileDependencyProcessor, "i18n/js/file_dependency_processor"
+
+    class Railtie < ::Rails::Railtie
+      rake_tasks do
+        load "tasks/i18n-js.rake"
+      end
+      initializer "i18n-js.assetpipeline.environment", :after => "sprockets.environment" do |app|
+        app.assets.register_preprocessor("application/javascript", FileDependencyProcessor) if app.config.assets.enabled
+      end
+    end
+  end
+end

data/lib/i18n/js/translator.rb

@@ -0,0 +1,56 @@
+module I18n
+  module Js
+    class Translator
+      attr_accessor :scopes, :translations
+      def initialize(scopes)
+        @scopes = scopes
+        @translations = self.class.segment_for_scope(@scopes)
+      end
+
+      def self.segment_for_scope(scope)
+        if scope == "*"
+          translations
+        else
+          scoped_translations(scope)
+        end
+      end
+
+      def self.scoped_translations(scopes) # :nodoc:
+        result = {}
+
+        [scopes].flatten.each do |scope|
+          result.deep_merge!(filter(translations, scope))
+        end
+
+        result
+      end
+
+      # Filter translations according to the specified scope.
+      def self.filter(filter_translations, scopes)
+        scopes = scopes.split(".") if scopes.is_a?(String)
+        scopes = scopes.clone
+        scope = scopes.shift
+
+        if scope == "*"
+          results = {}
+          filter_translations.each do |filter_scope, filter_translation|
+            tmp = scopes.empty? ? filter_translation : filter(filter_translation, scopes)
+            results[filter_scope.to_sym] = tmp unless tmp.nil?
+          end
+          return results
+        elsif filter_translations.has_key?(scope.to_sym)
+          return {scope.to_sym => scopes.empty? ? filter_translations[scope.to_sym] : filter(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
+    end
+  end
+end

data/lib/i18n/js/version.rb

@@ -0,0 +1,10 @@
+module I18n
+  module Js
+    module Version
+      MAJOR = 4
+      MINOR = 0
+      PATCH = 0
+      STRING = "#{MAJOR}.#{MINOR}.#{PATCH}.rc1"
+    end
+  end
+end

data/lib/i18n-js/engine.rb

@@ -0,0 +1,63 @@
+module SimplesIdeias
+  module I18n
+    class Engine < ::Rails::Engine
+      I18N_TRANSLATIONS_ASSET = "i18n/translations"
+
+      initializer "i18n-js.asset_dependencies", :after => "sprockets.environment",
+                                                :before => "i18n-js.initialize" do
+        next unless SimplesIdeias::I18n.has_asset_pipeline?
+
+        config = I18n.config_file
+        cache_file = I18n::Engine.load_path_hash_cache
+
+        Rails.application.assets.register_preprocessor "application/javascript", :"i18n-js_dependencies" do |context, data|
+          if context.logical_path == I18N_TRANSLATIONS_ASSET
+            context.depend_on(config) if I18n.config?
+            # also set up dependencies on every locale file
+            ::I18n.load_path.each {|path| context.depend_on(path)}
+
+            # Set up a dependency on the contents of the load path
+            # itself. In some situations it is possible to get here
+            # before the path hash cache file has been written; in
+            # this situation, write it now.
+            I18n::Engine.write_hash! unless File.exists?(cache_file)
+            context.depend_on(cache_file)
+          end
+
+          data
+        end
+      end
+
+      # rewrite path cache hash at startup and before each request in development
+      config.to_prepare do
+        next unless SimplesIdeias::I18n.has_asset_pipeline?
+        SimplesIdeias::I18n::Engine.write_hash_if_changed unless Rails.env.production?
+      end
+
+      def self.load_path_hash_cache
+        @load_path_hash_cache ||= Rails.root.join("tmp/i18n-js.cache")
+      end
+
+      def self.write_hash_if_changed
+        load_path_hash = ::I18n.load_path.hash
+
+        if load_path_hash != cached_load_path_hash
+          self.cached_load_path_hash = load_path_hash
+          write_hash!
+        end
+      end
+
+      def self.write_hash!
+        FileUtils.mkdir_p Rails.root.join("tmp")
+
+        File.open(load_path_hash_cache, "w+") do |f|
+          f.write(cached_load_path_hash)
+        end
+      end
+
+      class << self
+        attr_accessor :cached_load_path_hash
+      end
+    end
+  end
+end

data/lib/i18n-js/middleware.rb

@@ -0,0 +1,59 @@
+module SimplesIdeias
+  module I18n
+    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
+
+        unless valid_cache.all?
+          File.open(cache_path, "w+") do |file|
+            file << new_cache.to_yaml
+          end
+
+          SimplesIdeias::I18n.export!
+        end
+      end
+    end
+  end
+end

data/lib/i18n-js/railtie.rb

@@ -0,0 +1,13 @@
+module SimplesIdeias
+  module I18n
+    class Railtie < Rails::Railtie
+      rake_tasks do
+        require "i18n-js/rake"
+      end
+
+      initializer "i18n-js.initialize" do |app|
+        app.config.middleware.use(Middleware) if Rails.env.development? && !SimplesIdeias::I18n.has_asset_pipeline?
+      end
+    end
+  end
+end

data/lib/i18n-js/rake.rb

@@ -0,0 +1,16 @@
+namespace "i18n:js" do
+  desc "Copy i18n.js and configuration file"
+  task :setup => :environment do
+    SimplesIdeias::I18n.setup!
+  end
+
+  desc "Export the messages files"
+  task :export => :environment do
+    SimplesIdeias::I18n.export!
+  end
+
+  desc "Update the JavaScript library"
+  task :update => :environment do
+    SimplesIdeias::I18n.update!
+  end
+end

data/lib/i18n-js/version.rb

@@ -0,0 +1,10 @@
+module SimplesIdeias
+  module I18n
+    module Version
+      MAJOR = 2
+      MINOR = 1
+      PATCH = 2
+      STRING = "#{MAJOR}.#{MINOR}.#{PATCH}"
+    end
+  end
+end

data/lib/i18n-js.rb

@@ -0,0 +1,22 @@
+require 'active_support/core_ext/hash'
+
+require 'i18n'
+require 'i18n/js/railtie' if defined?(Rails)
+
+module I18n
+  module Js
+    def self.config_path
+      Rails.root.join("config", "i18n-js.yml")
+    end
+    def self.config?
+      File.exists?(config_path)
+    end
+    def self.config
+      @@config ||= if config?
+        YAML.load_file(config_path).with_indifferent_access
+      else
+        {}.with_indifferent_access
+      end.reverse_merge!(:asset_path => "i18n/translation", :only => "*")
+    end
+  end
+end

data/lib/tasks/i18n-js.rake

@@ -0,0 +1,17 @@
+namespace :i18n do
+  namespace :js do
+    namespace :export do
+      task :assets => [:environment] do
+        require 'fileutils'
+        Dir.glob(Rails.application.assets.paths.map { |path| File.join(path, "#{I18n::Js.config[:asset_path]}*") }) do |asset_path|
+          asset = Rails.application.assets[asset_path]
+          export_path = Rails.root.join('public', asset.logical_path)
+          FileUtils.mkdir_p File.dirname(export_path)
+          File.open(export_path, 'w') do |file|
+            file.write(asset.to_a.map { |x| x.body }.join("\n"))
+          end
+        end
+      end
+    end
+  end
+end

data/spec/file_dependency_processor_spec.rb

@@ -0,0 +1,32 @@
+require "spec_helper"
+require 'i18n/js/file_dependency_processor'
+
+describe I18n::Js::FileDependencyProcessor do
+  context "#evaluate" do
+    let(:dependency_processor) { I18n::Js::FileDependencyProcessor.new { @js } }
+    it "sets dependencies on the I18n load_paths and the I18n::Js config file" do
+      ::I18n.stub(:load_path => ["/path/to/en.yml", "/path/to/es.yml"])
+      I18n::Js.stub(:config_path => "/path/to/i18n/js/config.yml")
+      context = double("context")
+      context.should_receive(:logical_path).and_return("i18n/translation-en.js")
+      context.should_receive(:depend_on).with("/path/to/en.yml")
+      context.should_receive(:depend_on).with("/path/to/es.yml")
+      context.should_receive(:depend_on).with("/path/to/i18n/js/config.yml")
+      locals = double("locals")
+      dependency_processor.evaluate(context, locals)
+    end
+    it "skips setting dependencies when the logical path doesn't match the asset_path_regexp" do
+      I18n::Js.stub(:config_path => "/path/to/i18n/js/config.yml")
+      context = double("context")
+      context.should_receive(:logical_path).and_return("not_i18n_translation.js")
+      context.should_not_receive(:depend_on)
+      locals = double("locals")
+      dependency_processor.evaluate(context, locals)
+    end
+  end
+  context "#asset_path_regexp" do
+    it "returns a regex of asset_path" do
+      I18n::Js::FileDependencyProcessor.asset_path_regexp.should eql(%r{i18n/translation})
+    end
+  end
+end

data/spec/fixtures/custom_path.yml

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

data/spec/fixtures/default.yml

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

data/spec/fixtures/js_file_per_locale.yml

@@ -0,0 +1 @@
+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,3 @@
+only:
+  - "*.date.formats"
+  - "*.number.currency"

data/spec/fixtures/no_config.yml

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

data/spec/fixtures/simple_scope.yml

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

data/spec/i18n_js_spec.rb

@@ -0,0 +1,11 @@
+require "spec_helper"
+
+describe I18n::Js do
+  context "general" do
+    it "sets empty hash as configuration when no file is found" do
+      I18n::Js.stub(:config_path => "/path/to/config/config.yml")
+      I18n::Js.config?.should be_false
+      I18n::Js.config.should eql({"asset_path" => "i18n/translation", "only" => "*"})
+    end
+  end
+end