i18n-js 2.1.2 → 3.8.3

data/lib/i18n/js/formatters/base.rb

@@ -0,0 +1,25 @@
+module I18n
+  module JS
+    module Formatters
+      class Base
+        def initialize(js_extend: false, namespace: nil, pretty_print: false, prefix: nil, suffix: nil)
+          @js_extend    = js_extend
+          @namespace    = namespace
+          @pretty_print = pretty_print
+          @prefix = prefix
+          @suffix = suffix
+        end
+
+        protected
+
+        def format_json(translations)
+          if @pretty_print
+            ::JSON.pretty_generate(translations)
+          else
+            translations.to_json
+          end
+        end
+      end
+    end
+  end
+end

data/lib/i18n/js/formatters/js.rb

@@ -0,0 +1,39 @@
+require "i18n/js/formatters/base"
+
+module I18n
+  module JS
+    module Formatters
+      class JS < Base
+        JSON_ESCAPE_MAP = {
+          "'" => "\\'",
+          "\\" => "\\\\"
+        }.freeze
+        private_constant :JSON_ESCAPE_MAP
+
+        def format(translations)
+          contents = header
+          translations.each do |locale, translations_for_locale|
+            contents << line(locale, format_json(translations_for_locale))
+          end
+          contents << (@suffix || '')
+        end
+
+        protected
+
+        def header
+          text = @prefix || ''
+          text + %(#{@namespace}.translations || (#{@namespace}.translations = {});\n)
+        end
+
+        def line(locale, translations)
+          json_literal = @pretty_print ? translations : %(JSON.parse('#{translations.gsub(/#{Regexp.union(JSON_ESCAPE_MAP.keys)}/){|match| JSON_ESCAPE_MAP.fetch(match) }}'))
+          if @js_extend
+            %(#{@namespace}.translations["#{locale}"] = I18n.extend((#{@namespace}.translations["#{locale}"] || {}), #{json_literal});\n)
+          else
+            %(#{@namespace}.translations["#{locale}"] = #{json_literal};\n)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/i18n/js/formatters/json.rb

@@ -0,0 +1,13 @@
+require "i18n/js/formatters/base"
+
+module I18n
+  module JS
+    module Formatters
+      class JSON < Base
+        def format(translations)
+          format_json(translations)
+        end
+      end
+    end
+  end
+end

data/lib/{i18n-js → i18n/js}/middleware.rb

@@ -1,8 +1,11 @@
-module SimplesIdeias
-  module I18n
+require "fileutils"
+
+module I18n
+  module JS
     class Middleware
       def initialize(app)
         @app = app
+        clear_cache
       end
 
       def call(env)
@@ -13,7 +16,11 @@ module SimplesIdeias
 
       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 +33,24 @@ module SimplesIdeias
         end
       end
 
+      def clear_cache
+        # `File.delete` will raise error when "multiple worker"
+        # Are running at the same time, like in a parallel test
+        #
+        # `FileUtils.rm_f` is tested manually
+        #
+        # See https://github.com/fnando/i18n-js/issues/436
+        FileUtils.rm_f(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.exist?(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:
       #
@@ -46,13 +71,11 @@ module SimplesIdeias
           new_cache[path] = changed_at
         end
 
-        unless valid_cache.all?
-          File.open(cache_path, "w+") do |file|
-            file << new_cache.to_yaml
-          end
+        return if valid_cache.all?
 
-          SimplesIdeias::I18n.export!
-        end
+        save_cache(new_cache)
+
+        ::I18n::JS.export
       end
     end
   end

data/lib/i18n/js/private/config_store.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "singleton"
+
+module I18n
+  module JS
+    # @api private
+    module Private
+      # Caching implementation for I18n::JS.config
+      #
+      # @api private
+      class ConfigStore
+        include Singleton
+
+        def fetch
+          return @config if @config
+
+          yield.tap do |obj|
+            raise ArgumentError, "unexpected falsy object from block" unless obj
+
+            @config = obj
+          end
+        end
+
+        def flush_cache
+          @config = nil
+        end
+      end
+    end
+  end
+end

data/lib/i18n/js/private/hash_with_symbol_keys.rb

@@ -0,0 +1,36 @@
+module I18n
+  module JS
+    # @api private
+    module Private
+      # Hash with string keys converted to symbol keys
+      # Used for handling values read on YAML
+      #
+      # @api private
+      class HashWithSymbolKeys < ::Hash
+        # An instance can only be created by passing in another hash
+        def initialize(hash)
+          raise TypeError unless hash.is_a?(::Hash)
+
+          hash.each_key do |key|
+            # Objects like `Integer` does not have `to_sym`
+            new_key = key.respond_to?(:to_sym) ? key.to_sym : key
+            self[new_key] = hash[key]
+          end
+
+          self.default = hash.default if hash.default
+          self.default_proc = hash.default_proc if hash.default_proc
+
+          freeze
+        end
+
+        # From AS Core extension
+        def slice(*keys)
+          hash = keys.each_with_object(Hash.new) do |k, hash|
+            hash[k] = self[k] if has_key?(k)
+          end
+          self.class.new(hash)
+        end
+      end
+    end
+  end
+end

data/lib/i18n/js/segment.rb

@@ -0,0 +1,80 @@
+require "i18n/js/private/hash_with_symbol_keys"
+require "i18n/js/formatters/js"
+require "i18n/js/formatters/json"
+
+module I18n
+  module JS
+
+    # Class which enscapulates a translations hash and outputs a single JSON translation file
+    class Segment
+      OPTIONS = [:namespace, :pretty_print, :js_extend, :prefix, :suffix, :sort_translation_keys, :json_only].freeze
+      LOCALE_INTERPOLATOR = /%\{locale\}/
+
+      attr_reader *([:file, :translations] | OPTIONS)
+
+      def initialize(file, translations, options = {})
+        @file         = file
+        # `#slice` will be used
+        # But when activesupport is absent,
+        # the core extension from `i18n` gem will be used instead
+        # And it's causing errors (at least in test)
+        #
+        # So the input is wrapped by our class for better `#slice`
+        @translations = Private::HashWithSymbolKeys.new(translations)
+        @namespace    = options[:namespace] || 'I18n'
+        @pretty_print = !!options[:pretty_print]
+        @js_extend    = options.key?(:js_extend) ? !!options[:js_extend] : true
+        @prefix       = options.key?(:prefix) ? options[:prefix] : nil
+        @suffix       = options.key?(:suffix) ? options[:suffix] : nil
+        @sort_translation_keys = options.key?(:sort_translation_keys) ? !!options[:sort_translation_keys] : true
+        @json_only = options.key?(:json_only) ? !!options[:json_only] : false
+      end
+
+      # Saves JSON file containing translations
+      def save!
+        if @file =~ LOCALE_INTERPOLATOR
+          I18n.available_locales.each do |locale|
+            write_file(file_for_locale(locale), @translations.slice(locale))
+          end
+        else
+          write_file
+        end
+      end
+
+      protected
+
+      def file_for_locale(locale)
+        @file.gsub(LOCALE_INTERPOLATOR, locale.to_s)
+      end
+
+      def write_file(_file = @file, _translations = @translations)
+        FileUtils.mkdir_p File.dirname(_file)
+        _translations = Utils.deep_key_sort(_translations) if @sort_translation_keys
+        contents = formatter.format(_translations)
+
+        return if File.exist?(_file) && File.read(_file) == contents
+
+        File.open(_file, "w+") do |f|
+          f << contents
+        end
+      end
+
+      def formatter
+        if @json_only
+          Formatters::JSON.new(**formatter_options)
+        else
+          Formatters::JS.new(**formatter_options)
+        end
+      end
+
+      def formatter_options
+        { js_extend: @js_extend,
+          namespace: @namespace,
+          pretty_print: @pretty_print,
+          prefix: @prefix,
+          suffix: @suffix
+        }
+      end
+    end
+  end
+end

data/lib/i18n/js/utils.rb

@@ -0,0 +1,78 @@
+module I18n
+  module JS
+    module Utils
+      PLURAL_KEYS = %i[zero one two few many other].freeze
+
+      # Based on deep_merge by Stefan Rusterholz, see <http://www.ruby-forum.com/topic/142809>.
+      # This method is used to handle I18n fallbacks. Given two equivalent path nodes in two locale trees:
+      # 1. If the node in the current locale appears to be an I18n pluralization (:one, :other, etc.),
+      #    use the node, but merge in any missing/non-nil keys from the fallback (default) locale.
+      # 2. Else if both nodes are Hashes, combine (merge) the key-value pairs of the two nodes into one,
+      #    prioritizing the current locale.
+      # 3. Else if either node is nil, use the other node.
+      PLURAL_MERGER = proc do |_key, v1, v2|
+        v1 || v2
+      end
+      MERGER = proc do |_key, v1, v2|
+        if Hash === v1 && Hash === v2
+          if (v2.keys - PLURAL_KEYS).empty?
+            slice(v2.merge(v1, &PLURAL_MERGER), v2.keys)
+          else
+            v1.merge(v2, &MERGER)
+          end
+        else
+          v2 || v1
+        end
+      end
+
+      HASH_NIL_VALUE_CLEANER_PROC = proc do |k, v|
+        v.kind_of?(Hash) ? (v.delete_if(&HASH_NIL_VALUE_CLEANER_PROC); false) : v.nil?
+      end
+
+      def self.slice(hash, keys)
+        if hash.respond_to?(:slice) # ruby 2.5 onwards
+          hash.slice(*keys)
+        else
+          hash.select {|key, _| keys.include?(key)}
+        end
+      end
+
+      def self.strip_keys_with_nil_values(hash)
+        hash.dup.delete_if(&HASH_NIL_VALUE_CLEANER_PROC)
+      end
+
+      def self.deep_merge(target_hash, hash) # :nodoc:
+        target_hash.merge(hash, &MERGER)
+      end
+
+      def self.deep_merge!(target_hash, hash) # :nodoc:
+        target_hash.merge!(hash, &MERGER)
+      end
+
+      def self.deep_reject(hash, scopes = [], &block)
+        hash.each_with_object({}) do |(k, v), memo|
+          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

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module I18n
+  module JS
+    VERSION = "3.8.3"
+  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/{config → lib/rails/generators/i18n/js/config/templates}/i18n-js.yml

@@ -1,4 +1,5 @@
 # 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.
@@ -7,16 +8,20 @@
 # 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 README
+#
+#
 # 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"
+# translations:
+#   - file: "app/assets/javascripts/i18n/translations.js"
 #
 # If you're running an old version, you can use something
 # like this:
 #
-#   translations:
-#     - file: "public/javascripts/translations.js"
-#       only: "*"
-#
+# 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