i18n 0.9.5 → 1.6.0

data/lib/i18n.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'concurrent/map'
 
 require 'i18n/version'
@@ -12,9 +14,23 @@ 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 = %i[
+    cascade
+    deep_interpolation
+    default
+    exception_handler
+    fallback
+    fallback_in_progress
+    format
+    object
+    raise
+    resolve
+    scope
+    separator
+    throw
+  ].freeze
   RESERVED_KEYS_PATTERN = /%\{(#{RESERVED_KEYS.join("|")})\}/
-
+  EMPTY_HASH = {}.freeze
 
   def self.new_double_nested_cache # :nodoc:
     Concurrent::Map.new { |h,k| h[k] = Concurrent::Map.new }
@@ -53,6 +69,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.
     #
@@ -153,15 +176,13 @@ module I18n
     # from the argument values passed to #translate. Therefor 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
-
+    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)
 
+      backend = config.backend
+
       result = catch(:exception) do
         if key.is_a?(Array)
           key.map { |k| backend.translate(locale, k, options) }
@@ -169,19 +190,26 @@ module I18n
           backend.translate(locale, key, options)
         end
       end
-      result.is_a?(MissingTranslation) ? handle_exception(handling, result, locale, key, options) : result
+
+      if result.is_a?(MissingTranslation)
+        handle_exception((throw && :throw || raise && :raise), result, locale, key, options)
+      else
+        result
+      end
     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={})
+    def translate!(key, options = EMPTY_HASH)
       translate(key, options.merge(: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)
+      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)
     end
@@ -237,37 +265,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.
@@ -291,7 +322,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
@@ -346,7 +377,18 @@ module I18n
         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*\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.6.0
 platform: ruby
 authors:
 - Sven Fuchs
@@ -13,7 +13,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-13 00:00:00.000000000 Z
+date: 2019-03-03 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
@@ -62,8 +56,6 @@ files:
 - 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
@@ -90,52 +82,27 @@ files:
 - lib/i18n/tests/pluralization.rb
 - lib/i18n/tests/procs.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: http://github.com/ruby-i18n/i18n
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  bug_tracker_uri: https://github.com/svenfuchs/i18n/issues
+  changelog_uri: https://github.com/svenfuchs/i18n/releases
+  documentation_uri: https://guides.rubyonrails.org/i18n.html
+  source_code_uri: https://github.com/svenfuchs/i18n
+post_install_message: |2+
+
+  HEADS UP! i18n 1.1 changed fallbacks to exclude default locale.
+  But that may break your application.
+
+  Please check your Rails app for 'config.i18n.fallbacks = true'.
+  If you're using I18n (>= 1.1.0) and Rails (< 5.2.2), this should be
+  'config.i18n.fallbacks = [I18n.default_locale]'.
+  If not, fallbacks will be broken in your app by I18n 1.1.x.
+
+  For more info see:
+  https://github.com/svenfuchs/i18n/releases/tag/v1.1.0
+
 rdoc_options: []
 require_paths:
 - lib
@@ -143,15 +110,14 @@ 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
+rubygems_version: 3.0.2
 signing_key: 
 specification_version: 4
 summary: New wave Internationalization support for Ruby

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/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

data/test/api/fallbacks_test.rb

@@ -1,30 +0,0 @@
-require 'test_helper'
-
-class I18nFallbacksApiTest < I18n::TestCase
-  class Backend < I18n::Backend::Simple
-    include I18n::Backend::Fallbacks
-  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 Fallbacks included" do
-    assert_equal Backend, I18n.backend.class
-  end
-
-  # links: test that keys stored on one backend can link to keys stored on another backend
-end

data/test/api/key_value_test.rb

@@ -1,24 +0,0 @@
-require 'test_helper'
-
-class I18nKeyValueApiTest < I18n::TestCase
-  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 Tests::Api::Procs
-  include I18n::Tests::Localization::Date
-  include I18n::Tests::Localization::DateTime
-  include I18n::Tests::Localization::Time
-  # include Tests::Api::Localization::Procs
-
-  def setup
-    I18n.backend = I18n::Backend::KeyValue.new({})
-    super
-  end
-
-  test "make sure we use the KeyValue backend" do
-    assert_equal I18n::Backend::KeyValue, I18n.backend.class
-  end
-end if I18n::TestCase.key_value?

data/test/api/memoize_test.rb

@@ -1,56 +0,0 @@
-require 'test_helper'
-
-class I18nMemoizeBackendWithSimpleApiTest < I18n::TestCase
-  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
-
-  class MemoizeBackend < I18n::Backend::Simple
-    include I18n::Backend::Memoize
-  end
-
-  def setup
-    I18n.backend = MemoizeBackend.new
-    super
-  end
-
-  test "make sure we use the MemoizeBackend backend" do
-    assert_equal MemoizeBackend, I18n.backend.class
-  end
-end
-
-class I18nMemoizeBackendWithKeyValueApiTest < I18n::TestCase
-  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::Localization::Date
-  include I18n::Tests::Localization::DateTime
-  include I18n::Tests::Localization::Time
-
-  # include I18n::Tests::Procs
-  # include I18n::Tests::Localization::Procs
-
-  class MemoizeBackend < I18n::Backend::KeyValue
-    include I18n::Backend::Memoize
-  end
-
-  def setup
-    I18n.backend = MemoizeBackend.new({})
-    super
-  end
-
-  test "make sure we use the MemoizeBackend backend" do
-    assert_equal MemoizeBackend, I18n.backend.class
-  end
-end if I18n::TestCase.key_value?

data/test/api/override_test.rb

@@ -1,42 +0,0 @@
-require 'test_helper'
-
-class I18nOverrideTest < I18n::TestCase
-  module OverrideInverse
-    def translate(*args)
-      super(*args).reverse
-    end
-    alias :t :translate
-  end
-
-  module OverrideSignature
-    def translate(*args)
-      args.first + args[1]
-    end
-    alias :t :translate
-  end
-
-  def setup
-    super
-    @I18n = I18n.dup
-    @I18n.backend = I18n::Backend::Simple.new
-  end
-
-  test "make sure modules can overwrite I18n methods" do
-    @I18n.extend OverrideInverse
-    @I18n.backend.store_translations('en', :foo => 'bar')
-
-    assert_equal 'rab', @I18n.translate(:foo, :locale => 'en')
-    assert_equal 'rab', @I18n.t(:foo, :locale => 'en')
-    assert_equal 'rab', @I18n.translate!(:foo, :locale => 'en')
-    assert_equal 'rab', @I18n.t!(:foo, :locale => 'en')
-  end
-
-  test "make sure modules can overwrite I18n signature" do
-    exception = catch(:exception) do
-      @I18n.t('Hello', 'Welcome message on home page', :tokenize => true, :throw => true)
-    end
-    assert exception.message
-    @I18n.extend OverrideSignature
-    assert_equal 'HelloWelcome message on home page', @I18n.translate('Hello', 'Welcome message on home page', :tokenize => true) # tr8n example
-  end
-end