i18n-js 3.9.2 → 4.0.0.alpha1

data/lib/i18n/js/utils.rb

@@ -1,91 +0,0 @@
-module I18n
-  module JS
-    module Utils
-      PLURAL_KEYS = %i[zero one two few many other].freeze
-
-      # Based on deep_merge by Stefan Rusterholz, see <https://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
-
-      def self.deep_remove_procs(hash)
-        # procs exist in `i18n.plural.rule` as pluralizer
-        # But having it in translation causes the exported JS/JSON changes every time
-        # https://github.com/ruby-i18n/i18n/blob/v1.8.7/lib/i18n/backend/pluralization.rb#L51
-        hash.keys.
-          each_with_object({}) do |key, seed|
-          value = hash[key]
-          next if value.is_a?(Proc)
-
-          seed[key] = value.is_a?(Hash) ? deep_remove_procs(value) : value
-        end
-      end
-    end
-  end
-end

data/lib/i18n/js/version.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-module I18n
-  module JS
-    VERSION = "3.9.2"
-  end
-end

data/lib/i18n/js.rb

@@ -1,274 +0,0 @@
-require "yaml"
-require "fileutils"
-require "i18n"
-
-require "i18n/js/utils"
-require "i18n/js/private/hash_with_symbol_keys"
-require "i18n/js/private/config_store"
-
-module I18n
-  module JS
-    require "i18n/js/dependencies"
-    require "i18n/js/fallback_locales"
-    require "i18n/js/segment"
-    if JS::Dependencies.rails?
-      require "i18n/js/middleware"
-      require "i18n/js/engine"
-    end
-
-    DEFAULT_CONFIG_PATH = "config/i18n-js.yml"
-    DEFAULT_EXPORT_DIR_PATH = "public/javascripts"
-
-    # The configuration file. This defaults to the `config/i18n-js.yml` file.
-    #
-    def self.config_file_path
-      @config_file_path ||= DEFAULT_CONFIG_PATH
-    end
-
-    def self.config_file_path=(new_path)
-      @config_file_path = new_path
-      # new config file path = need to re-read config from new file
-      Private::ConfigStore.instance.flush_cache
-    end
-
-    # Allow using a different backend than the one globally configured
-    def self.backend
-      @backend ||= I18n.backend
-    end
-
-    def self.backend=(alternative_backend)
-      @backend = alternative_backend
-    end
-
-    # Export translations to JavaScript, considering settings
-    # from configuration file
-    def self.export
-      export_i18n_js
-
-      translation_segments.each(&:save!)
-    end
-
-    def self.segment_for_scope(scope, exceptions)
-      if scope == "*"
-        exclude(translations, exceptions)
-      else
-        scoped_translations(scope, exceptions)
-      end
-    end
-
-    def self.configured_segments
-      config[:translations].inject([]) do |segments, options_hash|
-        options_hash_with_symbol_keys = Private::HashWithSymbolKeys.new(options_hash)
-        file = options_hash_with_symbol_keys[:file]
-        only = options_hash_with_symbol_keys[:only] || '*'
-        exceptions = [options_hash_with_symbol_keys[:except] || []].flatten
-
-        result = segment_for_scope(only, exceptions)
-
-        merge_with_fallbacks!(result) if fallbacks
-
-        unless result.empty?
-          segments << Segment.new(
-            file,
-            result,
-            extract_segment_options(options_hash_with_symbol_keys),
-          )
-        end
-
-        segments
-      end
-    end
-
-    # deep_merge! given result with result for fallback locale
-    def self.merge_with_fallbacks!(result)
-      js_available_locales.each do |locale|
-        fallback_locales = FallbackLocales.new(fallbacks, locale)
-        fallback_locales.each do |fallback_locale|
-          # `result[fallback_locale]` could be missing
-          result[locale] = Utils.deep_merge(result[fallback_locale] || {}, result[locale] || {})
-        end
-      end
-    end
-
-    def self.filtered_translations
-      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
-      if config_file_exists? && config[:translations]
-        configured_segments
-      else
-        [Segment.new("#{DEFAULT_EXPORT_DIR_PATH}/translations.js", translations)]
-      end
-    end
-
-    # Load configuration file for partial exporting and
-    # custom output directory
-    def self.config
-      Private::ConfigStore.instance.fetch do
-        if config_file_exists?
-          erb_result_from_yaml_file = ERB.new(File.read(config_file_path)).result
-          Private::HashWithSymbolKeys.new(
-            (::YAML.load(erb_result_from_yaml_file) || {})
-          )
-        else
-          Private::HashWithSymbolKeys.new({})
-        end.freeze
-      end
-    end
-
-    # @api private
-    # Check if configuration file exist
-    def self.config_file_exists?
-      File.file? config_file_path
-    end
-
-    def self.scoped_translations(scopes, exceptions = []) # :nodoc:
-      result = {}
-
-      [scopes].flatten.each do |scope|
-        translations_without_exceptions = exclude(translations, exceptions)
-        filtered_translations = filter(translations_without_exceptions, scope) || {}
-
-        Utils.deep_merge!(result, filtered_translations)
-      end
-
-      result
-    end
-
-    # Exclude keys from translations listed in the `except:` section in the config file
-    def self.exclude(translations, exceptions)
-      return translations if exceptions.empty?
-
-      exceptions.inject(translations) do |memo, exception|
-        exception_scopes = exception.to_s.split(".")
-        Utils.deep_reject(memo) do |key, value, scopes|
-          Utils.scopes_match?(scopes, exception_scopes)
-        end
-      end
-    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.respond_to?(:key?) && translations.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
-      self.backend.instance_eval do
-        init_translations unless initialized?
-        # When activesupport is absent,
-        # the core extension (`#slice`) 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`
-        Private::HashWithSymbolKeys.new(translations).
-          slice(*::I18n::JS.js_available_locales).
-          to_h
-      end
-    end
-
-    def self.use_fallbacks?
-      fallbacks != false
-    end
-
-    def self.json_only
-      config.fetch(:json_only) do
-        # default value
-        false
-      end
-    end
-
-    def self.fallbacks
-      config.fetch(:fallbacks) do
-        # default value
-        true
-      end
-    end
-
-    def self.js_extend
-      config.fetch(:js_extend) do
-        # default value
-        true
-      end
-    end
-
-    # Get all available locales.
-    #
-    # @return [Array<Symbol>] the locales.
-    def self.js_available_locales
-      config.fetch(:js_available_locales) do
-        # default value
-        I18n.available_locales
-      end.map(&:to_sym)
-    end
-
-    def self.sort_translation_keys?
-      @sort_translation_keys ||= (config[:sort_translation_keys]) if config.key?(:sort_translation_keys)
-      @sort_translation_keys = true if @sort_translation_keys.nil?
-      @sort_translation_keys
-    end
-
-    def self.sort_translation_keys=(value)
-      @sort_translation_keys = !!value
-    end
-
-    def self.extract_segment_options(options)
-      segment_options = Private::HashWithSymbolKeys.new({
-        js_extend: js_extend,
-        sort_translation_keys: sort_translation_keys?,
-        json_only: json_only
-      }).freeze
-      segment_options.merge(options.slice(*Segment::OPTIONS))
-    end
-
-    ### Export i18n.js
-    begin
-
-      # Copy i18n.js
-      def self.export_i18n_js
-        return unless export_i18n_js_dir_path.is_a? String
-
-        FileUtils.mkdir_p(export_i18n_js_dir_path)
-
-        i18n_js_path = File.expand_path('../../../app/assets/javascripts/i18n.js', __FILE__)
-        destination_path = File.expand_path("i18n.js", export_i18n_js_dir_path)
-        return if File.exist?(destination_path) && FileUtils.identical?(i18n_js_path, destination_path)
-
-        FileUtils.cp(i18n_js_path, export_i18n_js_dir_path)
-      end
-
-      def self.export_i18n_js_dir_path
-        @export_i18n_js_dir_path ||= (config[:export_i18n_js] || :none) if config.key?(:export_i18n_js)
-        @export_i18n_js_dir_path ||= DEFAULT_EXPORT_DIR_PATH
-        @export_i18n_js_dir_path
-      end
-
-      # Setting this to nil would disable i18n.js exporting
-      def self.export_i18n_js_dir_path=(new_path)
-        new_path = :none unless new_path.is_a? String
-        @export_i18n_js_dir_path = new_path
-      end
-    end
-  end
-end

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

@@ -1,19 +0,0 @@
-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

@@ -1,27 +0,0 @@
-# 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 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"
-#
-# 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

@@ -1,8 +0,0 @@
-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

@@ -1,25 +0,0 @@
-{
-  "name": "i18n-js",
-  "version": "3.9.2",
-  "description": "A javascript library similar to Ruby on Rails i18n gem",
-  "author": "Nando Vieira",
-  "license": "MIT",
-  "keywords": [
-    "i18n"
-  ],
-  "devDependencies": {
-    "jasmine-node": "^3.0.0"
-  },
-  "main": "app/assets/javascripts/i18n.js",
-  "scripts": {
-    "test": "./node_modules/.bin/jasmine-node spec/js"
-  },
-  "homepage": "https://github.com/fnando/i18n-js",
-  "bugs": {
-    "url": "https://github.com/fnando/i18n-js/issues"
-  },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/fnando/i18n-js.git"
-  }
-}

data/spec/fixtures/custom_path.yml

@@ -1,5 +0,0 @@
-fallbacks: false
-
-translations:
-  - file: "tmp/i18n-js/all.js"
-    only: "*"

data/spec/fixtures/default.yml

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

data/spec/fixtures/erb.yml

@@ -1,5 +0,0 @@
-fallbacks: false
-
-translations:
-  - file: "tmp/i18n-js/translations.js"
-    only: '<%= "*." + "date." + "formats" %>'

data/spec/fixtures/except_condition.yml

@@ -1,7 +0,0 @@
-fallbacks: false
-
-translations:
-  - file: "tmp/i18n-js/trimmed.js"
-    except:
-      - "active_admin"
-      - "mailers"

data/spec/fixtures/js_available_locales_custom.yml

@@ -1 +0,0 @@
-js_available_locales: ["en", "foo"]

data/spec/fixtures/js_export_dir_custom.yml

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

data/spec/fixtures/js_export_dir_none.yml

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

data/spec/fixtures/js_extend_parent.yml

@@ -1,6 +0,0 @@
-fallbacks: false
-js_extend: false
-
-translations:
-  - file: "tmp/i18n-js/js_extend_parent.js"
-    only: "*.date.formats"

data/spec/fixtures/js_extend_segment.yml

@@ -1,6 +0,0 @@
-fallbacks: false
-
-translations:
-  - file: "tmp/i18n-js/js_extend_segment.js"
-    js_extend: false
-    only: "*.date.formats"

data/spec/fixtures/js_file_per_locale.yml

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

data/spec/fixtures/js_file_per_locale_with_fallbacks_as_default_locale_symbol.yml

@@ -1,4 +0,0 @@
-fallbacks: :default_locale
-
-translations:
-- file: "tmp/i18n-js/%{locale}.js"

data/spec/fixtures/js_file_per_locale_with_fallbacks_as_hash.yml

@@ -1,6 +0,0 @@
-fallbacks:
-  fr: ["de", "en"]
-  de: "en"
-
-translations:
-  - file: "tmp/i18n-js/%{locale}.js"

data/spec/fixtures/js_file_per_locale_with_fallbacks_as_locale.yml

@@ -1,4 +0,0 @@
-fallbacks: :de
-
-translations:
-- file: "tmp/i18n-js/%{locale}.js"

data/spec/fixtures/js_file_per_locale_with_fallbacks_as_locale_without_fallback_translations.yml

@@ -1,4 +0,0 @@
-fallbacks: :pirate
-
-translations:
-- file: "tmp/i18n-js/%{locale}.js"

data/spec/fixtures/js_file_per_locale_with_fallbacks_enabled.yml

@@ -1,4 +0,0 @@
-fallbacks: true
-
-translations:
-- file: "tmp/i18n-js/%{locale}.js"

data/spec/fixtures/js_file_per_locale_without_fallbacks.yml

@@ -1,4 +0,0 @@
-fallbacks: false
-
-translations:
-- file: "tmp/i18n-js/%{locale}.js"

data/spec/fixtures/js_file_with_namespace_prefix_and_pretty_print.yml

@@ -1,9 +0,0 @@
-fallbacks: false
-
-translations:
-  - file: "tmp/i18n-js/%{locale}.js"
-    only: '*'
-    namespace: "Foo"
-    pretty_print: true
-    prefix: "import random from 'random-library';\n"
-    suffix: "//test"

data/spec/fixtures/js_sort_translation_keys_false.yml

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

data/spec/fixtures/js_sort_translation_keys_true.yml

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

data/spec/fixtures/json_only.yml

@@ -1,18 +0,0 @@
-fallbacks: false
-json_only: true
-
-translations:
-  - file: "tmp/i18n-js/json_only.%{locale}.js"
-    only:
-      - "*.date.formats.*"
-      - "*.number.currency.*"
-
-  - file: "tmp/i18n-js/json_only_multi.js"
-    only:
-      - "*.date.formats.*"
-      - "*.number.currency.*"
-
-  - file: "tmp/i18n-js/json_only_multi_pretty.js"
-    only:
-      - "*.date.formats.*"
-      - "*.number.currency.*"