i18n 0.9.5 → 1.14.4

data/lib/i18n.rb

@@ -1,6 +1,10 @@
+# frozen_string_literal: true
+
 require 'concurrent/map'
+require 'concurrent/hash'
 
 require 'i18n/version'
+require 'i18n/utils'
 require 'i18n/exceptions'
 require 'i18n/interpolate/ruby'
 
@@ -12,12 +16,39 @@ module I18n
   autoload :Tests,   'i18n/tests'
   autoload :Middleware,   'i18n/middleware'
 
-  RESERVED_KEYS = [:scope, :default, :separator, :resolve, :object, :fallback, :fallback_in_progress, :format, :cascade, :throw, :raise, :deep_interpolation]
-  RESERVED_KEYS_PATTERN = /%\{(#{RESERVED_KEYS.join("|")})\}/
-
+  RESERVED_KEYS = %i[
+    cascade
+    deep_interpolation
+    default
+    exception_handler
+    fallback
+    fallback_in_progress
+    fallback_original_locale
+    format
+    object
+    raise
+    resolve
+    scope
+    separator
+    throw
+  ]
+  EMPTY_HASH = {}.freeze
 
   def self.new_double_nested_cache # :nodoc:
-    Concurrent::Map.new { |h,k| h[k] = Concurrent::Map.new }
+    Concurrent::Map.new { |h, k| h[k] = Concurrent::Map.new }
+  end
+
+  # Marks a key as reserved. Reserved keys are used internally,
+  # and can't also be used for interpolation. If you are using any
+  # extra keys as I18n options, you should call I18n.reserve_key
+  # before any I18n.translate (etc) calls are made.
+  def self.reserve_key(key)
+    RESERVED_KEYS << key.to_sym
+    @reserved_keys_pattern = nil
+  end
+
+  def self.reserved_keys_pattern # :nodoc:
+    @reserved_keys_pattern ||= /%\{(#{RESERVED_KEYS.join("|")})\}/
   end
 
   module Base
@@ -53,6 +84,13 @@ module I18n
       config.backend.reload!
     end
 
+    # Tells the backend to load translations now. Used in situations like the
+    # Rails production environment. Backends can implement whatever strategy
+    # is useful.
+    def eager_load!
+      config.backend.eager_load!
+    end
+
     # Translates, pluralizes and interpolates a given key using a given locale,
     # scope, and default, as well as interpolation values.
     #
@@ -92,7 +130,7 @@ module I18n
     # *PLURALIZATION*
     #
     # Translation data can contain pluralized translations. Pluralized translations
-    # are arrays of singluar/plural versions of translations like <tt>['Foo', 'Foos']</tt>.
+    # are arrays of singular/plural versions of translations like <tt>['Foo', 'Foos']</tt>.
     #
     # Note that <tt>I18n::Backend::Simple</tt> only supports an algorithm for English
     # pluralization rules. Other algorithms can be supported by custom backends.
@@ -150,40 +188,55 @@ module I18n
     #
     # It is recommended to use/implement lambdas in an "idempotent" way. E.g. when
     # a cache layer is put in front of I18n.translate it will generate a cache key
-    # from the argument values passed to #translate. Therefor your lambdas should
+    # from the argument values passed to #translate. Therefore your lambdas should
     # always return the same translations/values per unique combination of argument
     # values.
-    def translate(*args)
-      options  = args.last.is_a?(Hash) ? args.pop.dup : {}
-      key      = args.shift
-      backend  = config.backend
-      locale   = options.delete(:locale) || config.locale
-      handling = options.delete(:throw) && :throw || options.delete(:raise) && :raise # TODO deprecate :raise
-
+    #
+    # *Ruby 2.7+ keyword arguments warning*
+    #
+    # This method uses keyword arguments.
+    # There is a breaking change in ruby that produces warning with ruby 2.7 and won't work as expected with ruby 3.0
+    # The "hash" parameter must be passed as keyword argument.
+    #
+    # Good:
+    #  I18n.t(:salutation, :gender => 'w', :name => 'Smith')
+    #  I18n.t(:salutation, **{ :gender => 'w', :name => 'Smith' })
+    #  I18n.t(:salutation, **any_hash)
+    #
+    # Bad:
+    #  I18n.t(:salutation, { :gender => 'w', :name => 'Smith' })
+    #  I18n.t(:salutation, any_hash)
+    #
+    def translate(key = nil, throw: false, raise: false, locale: nil, **options) # TODO deprecate :raise
+      locale ||= config.locale
+      raise Disabled.new('t') if locale == false
       enforce_available_locales!(locale)
 
-      result = catch(:exception) do
-        if key.is_a?(Array)
-          key.map { |k| backend.translate(locale, k, options) }
-        else
-          backend.translate(locale, key, options)
+      backend = config.backend
+
+      if key.is_a?(Array)
+        key.map do |k|
+          translate_key(k, throw, raise, locale, backend, options)
         end
+      else
+        translate_key(key, throw, raise, locale, backend, options)
       end
-      result.is_a?(MissingTranslation) ? handle_exception(handling, result, locale, key, options) : result
     end
     alias :t :translate
 
     # Wrapper for <tt>translate</tt> that adds <tt>:raise => true</tt>. With
     # this option, if no translation is found, it will raise <tt>I18n::MissingTranslationData</tt>
-    def translate!(key, options={})
-      translate(key, options.merge(:raise => true))
+    def translate!(key, **options)
+      translate(key, **options, raise: true)
     end
     alias :t! :translate!
 
     # Returns true if a translation exists for a given key, otherwise returns false.
-    def exists?(key, locale = config.locale)
+    def exists?(key, _locale = nil, locale: _locale, **options)
+      locale ||= config.locale
+      raise Disabled.new('exists?') if locale == false
       raise I18n::ArgumentError if key.is_a?(String) && key.empty?
-      config.backend.exists?(locale, key)
+      config.backend.exists?(locale, key, options)
     end
 
     # Transliterates UTF-8 characters to ASCII. By default this method will
@@ -215,14 +268,14 @@ module I18n
     #
     # Setting a Hash using Ruby:
     #
-    #     store_translations(:de, :i18n => {
-    #       :transliterate => {
-    #         :rule => {
-    #           "ü" => "ue",
-    #           "ö" => "oe"
-    #         }
-    #       }
-    #     )
+    #     store_translations(:de, i18n: {
+    #                          transliterate: {
+    #                            rule: {
+    #                              'ü' => 'ue',
+    #                              'ö' => 'oe'
+    #                            }
+    #                          }
+    #                        })
     #
     # Setting a Proc:
     #
@@ -237,37 +290,40 @@ module I18n
     #     I18n.transliterate("Jürgen") # => "Juergen"
     #     I18n.transliterate("Jürgen", :locale => :en) # => "Jurgen"
     #     I18n.transliterate("Jürgen", :locale => :de) # => "Juergen"
-    def transliterate(*args)
-      options      = args.pop.dup if args.last.is_a?(Hash)
-      key          = args.shift
-      locale       = options && options.delete(:locale) || config.locale
-      handling     = options && (options.delete(:throw) && :throw || options.delete(:raise) && :raise)
-      replacement  = options && options.delete(:replacement)
+    def transliterate(key, throw: false, raise: false, locale: nil, replacement: nil, **options)
+      locale ||= config.locale
+      raise Disabled.new('transliterate') if locale == false
       enforce_available_locales!(locale)
+
       config.backend.transliterate(locale, key, replacement)
     rescue I18n::ArgumentError => exception
-      handle_exception(handling, exception, locale, key, options || {})
+      handle_exception((throw && :throw || raise && :raise), exception, locale, key, options)
     end
 
     # Localizes certain objects, such as dates and numbers to local formatting.
-    def localize(object, options = nil)
-      options = options ? options.dup : {}
-      locale = options.delete(:locale) || config.locale
-      format = options.delete(:format) || :default
+    def localize(object, locale: nil, format: nil, **options)
+      locale ||= config.locale
+      raise Disabled.new('l') if locale == false
       enforce_available_locales!(locale)
+
+      format ||= :default
       config.backend.localize(locale, object, format, options)
     end
     alias :l :localize
 
     # Executes block with given I18n.locale set.
     def with_locale(tmp_locale = nil)
-      if tmp_locale
+      if tmp_locale == nil
+        yield
+      else
         current_locale = self.locale
-        self.locale    = tmp_locale
+        self.locale = tmp_locale
+        begin
+          yield
+        ensure
+          self.locale = current_locale
+        end
       end
-      yield
-    ensure
-      self.locale = current_locale if tmp_locale
     end
 
     # Merges the given locale, key and scope into a single array of keys.
@@ -276,11 +332,11 @@ module I18n
     def normalize_keys(locale, key, scope, separator = nil)
       separator ||= I18n.default_separator
 
-      keys = []
-      keys.concat normalize_key(locale, separator)
-      keys.concat normalize_key(scope, separator)
-      keys.concat normalize_key(key, separator)
-      keys
+      [
+        *normalize_key(locale, separator),
+        *normalize_key(scope, separator),
+        *normalize_key(key, separator)
+      ]
     end
 
     # Returns true when the passed locale, which can be either a String or a
@@ -291,7 +347,7 @@ module I18n
 
     # Raises an InvalidLocale exception when the passed locale is not available.
     def enforce_available_locales!(locale)
-      if config.enforce_available_locales
+      if locale != false && config.enforce_available_locales
         raise I18n::InvalidLocale.new(locale) if !locale_available?(locale)
       end
     end
@@ -302,6 +358,18 @@ module I18n
 
   private
 
+    def translate_key(key, throw, raise, locale, backend, options)
+      result = catch(:exception) do
+        backend.translate(locale, key, options)
+      end
+
+      if result.is_a?(MissingTranslation)
+        handle_exception((throw && :throw || raise && :raise), result, locale, key, options)
+      else
+        result
+      end
+    end
+
     # Any exceptions thrown in translate will be sent to the @@exception_handler
     # which can be a Symbol, a Proc or any other Object unless they're forced to
     # be raised or thrown (MissingTranslation).
@@ -342,11 +410,22 @@ module I18n
       @@normalized_key_cache[separator][key] ||=
         case key
         when Array
-          key.map { |k| normalize_key(k, separator) }.flatten
+          key.flat_map { |k| normalize_key(k, separator) }
         else
           keys = key.to_s.split(separator)
           keys.delete('')
-          keys.map! { |k| k.to_sym }
+          keys.map! do |k|
+            case k
+            when /\A[-+]?([1-9]\d*|0)\z/ # integer
+              k.to_i
+            when 'true'
+              true
+            when 'false'
+              false
+            else
+              k.to_sym
+            end
+          end
           keys
         end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: i18n
 version: !ruby/object:Gem::Version
-  version: 0.9.5
+  version: 1.14.4
 platform: ruby
 authors:
 - Sven Fuchs
@@ -10,10 +10,10 @@ authors:
 - Stephan Soller
 - Saimon Moore
 - Ryan Bigg
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-02-13 00:00:00.000000000 Z
+date: 2024-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -37,17 +37,11 @@ extra_rdoc_files: []
 files:
 - MIT-LICENSE
 - README.md
-- gemfiles/Gemfile.rails-3.2.x
-- gemfiles/Gemfile.rails-4.0.x
-- gemfiles/Gemfile.rails-4.1.x
-- gemfiles/Gemfile.rails-4.2.x
-- gemfiles/Gemfile.rails-5.0.x
-- gemfiles/Gemfile.rails-5.1.x
-- gemfiles/Gemfile.rails-master
 - lib/i18n.rb
 - lib/i18n/backend.rb
 - lib/i18n/backend/base.rb
 - lib/i18n/backend/cache.rb
+- lib/i18n/backend/cache_file.rb
 - lib/i18n/backend/cascade.rb
 - lib/i18n/backend/chain.rb
 - lib/i18n/backend/fallbacks.rb
@@ -55,15 +49,13 @@ files:
 - lib/i18n/backend/gettext.rb
 - lib/i18n/backend/interpolation_compiler.rb
 - lib/i18n/backend/key_value.rb
+- lib/i18n/backend/lazy_loadable.rb
 - lib/i18n/backend/memoize.rb
 - lib/i18n/backend/metadata.rb
 - lib/i18n/backend/pluralization.rb
 - lib/i18n/backend/simple.rb
 - lib/i18n/backend/transliterator.rb
 - lib/i18n/config.rb
-- lib/i18n/core_ext/hash.rb
-- lib/i18n/core_ext/kernel/suppress_warnings.rb
-- lib/i18n/core_ext/string/interpolate.rb
 - lib/i18n/exceptions.rb
 - lib/i18n/gettext.rb
 - lib/i18n/gettext/helpers.rb
@@ -89,53 +81,17 @@ files:
 - lib/i18n/tests/lookup.rb
 - lib/i18n/tests/pluralization.rb
 - lib/i18n/tests/procs.rb
+- lib/i18n/utils.rb
 - lib/i18n/version.rb
-- test/api/all_features_test.rb
-- test/api/cascade_test.rb
-- test/api/chain_test.rb
-- test/api/fallbacks_test.rb
-- test/api/key_value_test.rb
-- test/api/memoize_test.rb
-- test/api/override_test.rb
-- test/api/pluralization_test.rb
-- test/api/simple_test.rb
-- test/backend/cache_test.rb
-- test/backend/cascade_test.rb
-- test/backend/chain_test.rb
-- test/backend/exceptions_test.rb
-- test/backend/fallbacks_test.rb
-- test/backend/interpolation_compiler_test.rb
-- test/backend/key_value_test.rb
-- test/backend/memoize_test.rb
-- test/backend/metadata_test.rb
-- test/backend/pluralization_test.rb
-- test/backend/simple_test.rb
-- test/backend/transliterator_test.rb
-- test/core_ext/hash_test.rb
-- test/gettext/api_test.rb
-- test/gettext/backend_test.rb
-- test/i18n/exceptions_test.rb
-- test/i18n/gettext_plural_keys_test.rb
-- test/i18n/interpolate_test.rb
-- test/i18n/load_path_test.rb
-- test/i18n/middleware_test.rb
-- test/i18n_test.rb
-- test/locale/fallbacks_test.rb
-- test/locale/tag/rfc4646_test.rb
-- test/locale/tag/simple_test.rb
-- test/run_all.rb
-- test/test_data/locales/de.po
-- test/test_data/locales/en.rb
-- test/test_data/locales/en.yml
-- test/test_data/locales/invalid/empty.yml
-- test/test_data/locales/invalid/syntax.yml
-- test/test_data/locales/plurals.rb
-- test/test_helper.rb
-homepage: http://github.com/svenfuchs/i18n
+homepage: https://github.com/ruby-i18n/i18n
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  bug_tracker_uri: https://github.com/ruby-i18n/i18n/issues
+  changelog_uri: https://github.com/ruby-i18n/i18n/releases
+  documentation_uri: https://guides.rubyonrails.org/i18n.html
+  source_code_uri: https://github.com/ruby-i18n/i18n
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -143,16 +99,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: 1.3.5
 requirements: []
-rubyforge_project: "[none]"
-rubygems_version: 2.7.4
-signing_key: 
+rubygems_version: 3.5.1
+signing_key:
 specification_version: 4
 summary: New wave Internationalization support for Ruby
 test_files: []

data/gemfiles/Gemfile.rails-3.2.x

@@ -1,10 +0,0 @@
-source 'https://rubygems.org'
-
-gemspec :path => '..'
-
-gem 'activesupport', '~> 3.2.0'
-gem 'mocha'
-gem 'test_declarative'
-gem 'rake'
-gem 'minitest'
-gem 'oj'

data/gemfiles/Gemfile.rails-4.0.x

@@ -1,10 +0,0 @@
-source 'https://rubygems.org'
-
-gemspec :path => '..'
-
-gem 'activesupport', '~> 4.0.0'
-gem 'mocha'
-gem 'test_declarative'
-gem 'rake'
-gem 'minitest'
-gem 'oj'

data/gemfiles/Gemfile.rails-4.1.x

@@ -1,10 +0,0 @@
-source 'https://rubygems.org'
-
-gemspec :path => '..'
-
-gem 'activesupport', '~> 4.1.0'
-gem 'mocha'
-gem 'test_declarative'
-gem 'rake'
-gem 'minitest'
-gem 'oj'

data/gemfiles/Gemfile.rails-4.2.x

@@ -1,10 +0,0 @@
-source 'https://rubygems.org'
-
-gemspec :path => '..'
-
-gem 'activesupport', '~> 4.2.0'
-gem 'mocha'
-gem 'test_declarative'
-gem 'rake'
-gem 'minitest'
-gem 'oj'

data/gemfiles/Gemfile.rails-5.0.x

@@ -1,10 +0,0 @@
-source 'https://rubygems.org'
-
-gemspec :path => '..'
-
-gem 'activesupport', '~> 5.0.0'
-gem 'mocha'
-gem 'test_declarative'
-gem 'rake'
-gem 'minitest'
-gem 'oj'

data/gemfiles/Gemfile.rails-5.1.x

@@ -1,10 +0,0 @@
-source 'https://rubygems.org'
-
-gemspec :path => '..'
-
-gem 'activesupport', '~> 5.1.0'
-gem 'mocha'
-gem 'test_declarative'
-gem 'rake'
-gem 'minitest'
-gem 'oj'

data/gemfiles/Gemfile.rails-master

@@ -1,10 +0,0 @@
-source 'https://rubygems.org'
-
-gemspec :path => '..'
-
-gem 'activesupport', github: 'rails/rails', branch: 'master'
-gem 'mocha'
-gem 'test_declarative'
-gem 'rake'
-gem 'minitest'
-gem 'oj'

data/lib/i18n/core_ext/hash.rb

@@ -1,29 +0,0 @@
-class Hash
-  def slice(*keep_keys)
-    h = {}
-    keep_keys.each { |key| h[key] = fetch(key) if has_key?(key) }
-    h
-  end unless Hash.method_defined?(:slice)
-
-  def except(*less_keys)
-    slice(*keys - less_keys)
-  end unless Hash.method_defined?(:except)
-
-  def deep_symbolize_keys
-    inject({}) { |result, (key, value)|
-      value = value.deep_symbolize_keys if value.is_a?(Hash)
-      result[(key.to_sym rescue key) || key] = value
-      result
-    }
-  end unless Hash.method_defined?(:deep_symbolize_keys)
-
-  # deep_merge_hash! 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
-  
-  def deep_merge!(data)
-    merge!(data, &MERGER)
-  end unless Hash.method_defined?(:deep_merge!)
-end
-

data/lib/i18n/core_ext/kernel/suppress_warnings.rb

@@ -1,8 +0,0 @@
-module Kernel
-  def suppress_warnings
-    original_verbosity, $VERBOSE = $VERBOSE, nil
-    yield
-  ensure
-    $VERBOSE = original_verbosity
-  end
-end

data/lib/i18n/core_ext/string/interpolate.rb

@@ -1,9 +0,0 @@
-# This file used to backport the Ruby 1.9 String interpolation syntax to Ruby 1.8.
-#
-# Since I18n has dropped support to Ruby 1.8, this file is not required anymore,
-# however, Rails 3.2 still requires it directly:
-#
-# https://github.com/rails/rails/blob/3-2-stable/activesupport/lib/active_support/core_ext/string/interpolation.rb#L2
-#
-# So we can't just drop the file entirely, which would then break Rails users
-# under Ruby 1.9. This file can be removed once Rails 3.2 support is dropped.

data/test/api/all_features_test.rb

@@ -1,58 +0,0 @@
-require 'test_helper'
-
-begin
-  require 'rubygems'
-  require 'active_support'
-rescue LoadError
-  puts "not testing with Cache enabled because active_support can not be found"
-end
-
-class I18nAllFeaturesApiTest < I18n::TestCase
-  class Backend < I18n::Backend::Simple
-    include I18n::Backend::Metadata
-    include I18n::Backend::Cache
-    include I18n::Backend::Cascade
-    include I18n::Backend::Fallbacks
-    include I18n::Backend::Pluralization
-    include I18n::Backend::Memoize
-  end
-
-  def setup
-    I18n.backend = I18n::Backend::Chain.new(Backend.new, I18n::Backend::Simple.new)
-    I18n.cache_store = cache_store
-    super
-  end
-
-  def teardown
-    I18n.cache_store.clear if I18n.cache_store
-    I18n.cache_store = nil
-    super
-  end
-
-  def cache_store
-    ActiveSupport::Cache.lookup_store(:memory_store) if cache_available?
-  end
-
-  def cache_available?
-    defined?(ActiveSupport) && defined?(ActiveSupport::Cache)
-  end
-
-  include I18n::Tests::Basics
-  include I18n::Tests::Defaults
-  include I18n::Tests::Interpolation
-  include I18n::Tests::Link
-  include I18n::Tests::Lookup
-  include I18n::Tests::Pluralization
-  include I18n::Tests::Procs
-  include I18n::Tests::Localization::Date
-  include I18n::Tests::Localization::DateTime
-  include I18n::Tests::Localization::Time
-  include I18n::Tests::Localization::Procs
-
-  test "make sure we use a Chain backend with an all features backend" do
-    assert_equal I18n::Backend::Chain, I18n.backend.class
-    assert_equal Backend, I18n.backend.backends.first.class
-  end
-
-  # links: test that keys stored on one backend can link to keys stored on another backend
-end

data/test/api/cascade_test.rb

@@ -1,28 +0,0 @@
-require 'test_helper'
-
-class I18nCascadeApiTest < I18n::TestCase
-  class Backend < I18n::Backend::Simple
-    include I18n::Backend::Cascade
-  end
-
-  def setup
-    I18n.backend = Backend.new
-    super
-  end
-
-  include I18n::Tests::Basics
-  include I18n::Tests::Defaults
-  include I18n::Tests::Interpolation
-  include I18n::Tests::Link
-  include I18n::Tests::Lookup
-  include I18n::Tests::Pluralization
-  include I18n::Tests::Procs
-  include I18n::Tests::Localization::Date
-  include I18n::Tests::Localization::DateTime
-  include I18n::Tests::Localization::Time
-  include I18n::Tests::Localization::Procs
-
-  test "make sure we use a backend with Cascade included" do
-    assert_equal Backend, I18n.backend.class
-  end
-end

data/test/api/chain_test.rb

@@ -1,24 +0,0 @@
-require 'test_helper'
-
-class I18nApiChainTest < I18n::TestCase
-  def setup
-    super
-    I18n.backend = I18n::Backend::Chain.new(I18n::Backend::Simple.new, I18n.backend)
-  end
-
-  include I18n::Tests::Basics
-  include I18n::Tests::Defaults
-  include I18n::Tests::Interpolation
-  include I18n::Tests::Link
-  include I18n::Tests::Lookup
-  include I18n::Tests::Pluralization
-  include I18n::Tests::Procs
-  include I18n::Tests::Localization::Date
-  include I18n::Tests::Localization::DateTime
-  include I18n::Tests::Localization::Time
-  include I18n::Tests::Localization::Procs
-
-  test "make sure we use the Chain backend" do
-    assert_equal I18n::Backend::Chain, I18n.backend.class
-  end
-end