i18n 1.14.1 → 1.14.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 692bec57675f1d97cdd0dff4a7b444e1777ba2f360dc3cf7162d5a98e45ab0a5
-  data.tar.gz: 954df8c7788ce253f730e4bf6911373198b26c24c2274113b2e12b6d6527b486
+  metadata.gz: abb47988c5f7107e7752235391d3841b093b22129643b5800fe208fd885c238a
+  data.tar.gz: 95343bb49011a881932676ca8e561a28e0779b1972893d9ece8c012886ac862c
 SHA512:
-  metadata.gz: 26ebf6f4edea8d2a6cf511496bcad2c0e50323c44263c4d27e44f12860f9e4e35e093514bb1fb3cd9925591b5e3db62917af79ee2710b4cc759735dd1ff4d538
-  data.tar.gz: 1764731c2157cddb200a8dec9286248f7fac4e8a23548305aa09e70b5591d924748179c9534bb46cd6d7d892987963566d95e20854d5928b51a0fbad76dded3b
+  metadata.gz: bdeb6008dae46d97da006f84446c0be3a81ffe8fe275ea4a6866673e663b13664fc225c3dcc7314c0db4aa4ef269a8fbcb6b58b5a359452de90625e1a826ff6d
+  data.tar.gz: ca01e033ca49fb385a3e05b3ff72bbfd5a5f256e22379f564367e72eabe125beb0c418654fb423523077a0a9aece57ad9e94d72ee646e5a6483e3e7e14525cc3

data/README.md

@@ -13,10 +13,14 @@ Currently maintained by @radar.
 
 You will most commonly use this library within a Rails app.
 
+We support Rails versions from 6.0 and up.
+
 [See the Rails Guide](https://guides.rubyonrails.org/i18n.html) for an example of its usage.
 
 ### Ruby (without Rails)
 
+We support Ruby versions from 3.0 and up.
+
 If you want to use this library without Rails, you can simply add `i18n` to your `Gemfile`:
 
 ```ruby

data/lib/i18n/backend/base.rb

@@ -54,13 +54,16 @@ module I18n
         end
 
         deep_interpolation = options[:deep_interpolation]
+        skip_interpolation = options[:skip_interpolation]
         values = Utils.except(options, *RESERVED_KEYS) unless options.empty?
-        if values
+        if !skip_interpolation && values && !values.empty?
           entry = if deep_interpolation
             deep_interpolate(locale, entry, values)
           else
             interpolate(locale, entry, values)
           end
+        elsif entry.is_a?(String) && entry =~ I18n.reserved_keys_pattern
+          raise ReservedInterpolationKey.new($1.to_sym, entry)
         end
         entry
       end
@@ -149,7 +152,14 @@ module I18n
           result = catch(:exception) do
             case subject
             when Symbol
-              I18n.translate(subject, **options.merge(:locale => locale, :throw => true))
+              I18n.translate(
+                subject,
+                **options.merge(
+                  :locale => locale,
+                  :throw => true,
+                  :skip_interpolation => true
+                )
+              )
             when Proc
               date_or_time = options.delete(:object) || object
               resolve(locale, object, subject.call(date_or_time, **options))
@@ -186,8 +196,8 @@ module I18n
         #
         #   if the given subject is an array then:
         #   each element of the array is recursively interpolated (until it finds a string)
-        #   method interpolates ["yes, %{user}", ["maybe no, %{user}, "no, %{user}"]], :user => "bartuz"
-        #   # => "["yes, bartuz",["maybe no, bartuz", "no, bartuz"]]"
+        #   method interpolates ["yes, %{user}", ["maybe no, %{user}", "no, %{user}"]], :user => "bartuz"
+        #   # => ["yes, bartuz", ["maybe no, bartuz", "no, bartuz"]]
         def interpolate(locale, subject, values = EMPTY_HASH)
           return subject if values.empty?
 
@@ -242,7 +252,7 @@ module I18n
         # Loads a plain Ruby translations file. eval'ing the file must yield
         # a Hash containing translation data with locales as toplevel keys.
         def load_rb(filename)
-          translations = eval(IO.read(filename), binding, filename)
+          translations = eval(IO.read(filename), binding, filename.to_s)
           [translations, false]
         end
 

data/lib/i18n/backend/fallbacks.rb

@@ -71,7 +71,11 @@ module I18n
 
           case subject
           when Symbol
-            I18n.translate(subject, **options.merge(:locale => options[:fallback_original_locale], :throw => true))
+            I18n.translate(subject, **options.merge(
+              :locale => options[:fallback_original_locale],
+              :throw => true,
+              :skip_interpolation => true
+            ))
           when Proc
             date_or_time = options.delete(:object) || object
             resolve_entry(options[:fallback_original_locale], object, subject.call(date_or_time, **options))
@@ -95,7 +99,7 @@ module I18n
         return super unless options.fetch(:fallback, true)
         I18n.fallbacks[locale].each do |fallback|
           begin
-            return true if super(fallback, key)
+            return true if super(fallback, key, options)
           rescue I18n::InvalidLocale
             # we do nothing when the locale is invalid, as this is a fallback anyways.
           end

data/lib/i18n/backend/interpolation_compiler.rb

@@ -21,8 +21,7 @@ module I18n
       module Compiler
         extend self
 
-        TOKENIZER                    = /(%%\{[^\}]+\}|%\{[^\}]+\})/
-        INTERPOLATION_SYNTAX_PATTERN = /(%)?(%\{([^\}]+)\})/
+        TOKENIZER = /(%%?\{[^}]+\})/
 
         def compile_if_an_interpolation(string)
           if interpolated_str?(string)
@@ -37,7 +36,7 @@ module I18n
         end
 
         def interpolated_str?(str)
-          str.kind_of?(::String) && str =~ INTERPOLATION_SYNTAX_PATTERN
+          str.kind_of?(::String) && str =~ TOKENIZER
         end
 
         protected
@@ -48,13 +47,12 @@ module I18n
 
         def compiled_interpolation_body(str)
           tokenize(str).map do |token|
-            (matchdata = token.match(INTERPOLATION_SYNTAX_PATTERN)) ? handle_interpolation_token(token, matchdata) : escape_plain_str(token)
+            token.match(TOKENIZER) ? handle_interpolation_token(token) : escape_plain_str(token)
           end.join
         end
 
-        def handle_interpolation_token(interpolation, matchdata)
-          escaped, pattern, key = matchdata.values_at(1, 2, 3)
-          escaped ? pattern : compile_interpolation_token(key.to_sym)
+        def handle_interpolation_token(token)
+          token.start_with?('%%') ? token[1..] : compile_interpolation_token(token[2..-2])
         end
 
         def compile_interpolation_token(key)

data/lib/i18n/backend/simple.rb

@@ -10,14 +10,14 @@ module I18n
     # The implementation is provided by a Implementation module allowing to easily
     # extend Simple backend's behavior by including modules. E.g.:
     #
-    # module I18n::Backend::Pluralization
-    #   def pluralize(*args)
-    #     # extended pluralization logic
-    #     super
-    #   end
-    # end
-    #
-    # I18n::Backend::Simple.include(I18n::Backend::Pluralization)
+    #     module I18n::Backend::Pluralization
+    #       def pluralize(*args)
+    #         # extended pluralization logic
+    #         super
+    #       end
+    #     end
+    #     
+    #     I18n::Backend::Simple.include(I18n::Backend::Pluralization)
     class Simple
       module Implementation
         include Base

data/lib/i18n/locale/fallbacks.rb

@@ -79,14 +79,24 @@ module I18n
         end
       end
 
+      def empty?
+        @map.empty? && @defaults.empty?
+      end
+
+      def inspect
+       "#<#{self.class.name} @map=#{@map.inspect} @defaults=#{@defaults.inspect}>"
+      end
+
       protected
 
       def compute(tags, include_defaults = true, exclude = [])
-        result = Array(tags).flat_map do |tag|
+        result = []
+        Array(tags).each do |tag|
           tags = I18n::Locale::Tag.tag(tag).self_and_parents.map! { |t| t.to_sym } - exclude
-          tags.each { |_tag| tags += compute(@map[_tag], false, exclude + tags) if @map[_tag] }
-          tags
+          result += tags
+          tags.each { |_tag| result += compute(@map[_tag], false, exclude + result) if @map[_tag] }
         end
+
         result.push(*defaults) if include_defaults
         result.uniq!
         result.compact!

data/lib/i18n/tests/defaults.rb

@@ -47,6 +47,13 @@ module I18n
         I18n.backend.store_translations(:en, { :foo => { :bar => 'bar' } }, { :separator => '|' })
         assert_equal 'bar', I18n.t(nil, :default => :'foo|bar', :separator => '|')
       end
+
+      # Addresses issue: #599
+      test "defaults: only interpolates once when resolving defaults" do
+        I18n.backend.store_translations(:en, :greeting => 'hey %{name}')
+        assert_equal 'hey %{dont_interpolate_me}',
+          I18n.t(:does_not_exist, :name => '%{dont_interpolate_me}', default: [:greeting])
+      end
     end
   end
 end

data/lib/i18n/tests/interpolation.rb

@@ -112,6 +112,28 @@ module I18n
         assert_raises(I18n::ReservedInterpolationKey) { interpolate(:foo => :bar, :default => '%{default}') }
         assert_raises(I18n::ReservedInterpolationKey) { interpolate(:foo => :bar, :default => '%{separator}') }
         assert_raises(I18n::ReservedInterpolationKey) { interpolate(:foo => :bar, :default => '%{scope}') }
+        assert_raises(I18n::ReservedInterpolationKey) { interpolate(:default => '%{scope}') }
+
+        I18n.backend.store_translations(:en, :interpolate => 'Hi %{scope}!')
+        assert_raises(I18n::ReservedInterpolationKey) { interpolate(:interpolate) }
+      end
+
+      test "interpolation: it does not raise I18n::ReservedInterpolationKey for escaped variables" do
+        assert_nothing_raised do
+          assert_equal '%{separator}', interpolate(:foo => :bar, :default => '%%{separator}')
+        end
+
+        # Note: The two interpolations below do not remove the escape character (%) because
+        #   I18n should not alter the strings when no interpolation parameters are given,
+        #   see the comment at the top of this file.
+        assert_nothing_raised do
+          assert_equal '%%{scope}', interpolate(:default => '%%{scope}')
+        end
+
+        I18n.backend.store_translations(:en, :interpolate => 'Hi %%{scope}!')
+        assert_nothing_raised do
+          assert_equal 'Hi %%{scope}!', interpolate(:interpolate)
+        end
       end
 
       test "interpolation: deep interpolation for default string" do

data/lib/i18n/tests/lookup.rb

@@ -76,6 +76,12 @@ module I18n
       test "lookup: a resulting Hash is not frozen" do
         assert !I18n.t(:hash).frozen?
       end
+
+      # Addresses issue: #599
+      test "lookup: only interpolates once when resolving symbols" do
+        I18n.backend.store_translations(:en, foo: :bar, bar: '%{value}')
+        assert_equal '%{dont_interpolate_me}', I18n.t(:foo, value: '%{dont_interpolate_me}')
+      end
     end
   end
 end

data/lib/i18n/tests/procs.rb

@@ -57,6 +57,7 @@ module I18n
           if arg.is_a?(Hash)
             arg.delete(:fallback_in_progress)
             arg.delete(:fallback_original_locale)
+            arg.delete(:skip_interpolation)
           end
           arg
         end.inspect

data/lib/i18n/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module I18n
-  VERSION = "1.14.1"
+  VERSION = "1.14.6"
 end

data/lib/i18n.rb

@@ -19,6 +19,7 @@ module I18n
   RESERVED_KEYS = %i[
     cascade
     deep_interpolation
+    skip_interpolation
     default
     exception_handler
     fallback
@@ -48,7 +49,7 @@ module I18n
   end
 
   def self.reserved_keys_pattern # :nodoc:
-    @reserved_keys_pattern ||= /%\{(#{RESERVED_KEYS.join("|")})\}/
+    @reserved_keys_pattern ||= /(?<!%)%\{(#{RESERVED_KEYS.join("|")})\}/
   end
 
   module Base
@@ -161,7 +162,7 @@ module I18n
     # or <tt>default</tt> if no translations for <tt>:foo</tt> and <tt>:bar</tt> were found.
     #   I18n.t :foo, :default => [:bar, 'default']
     #
-    # *BULK LOOKUP*
+    # <b>BULK LOOKUP</b>
     #
     # This returns an array with the translations for <tt>:foo</tt> and <tt>:bar</tt>.
     #   I18n.t [:foo, :bar]
@@ -180,7 +181,7 @@ module I18n
     # E.g. assuming the key <tt>:salutation</tt> resolves to:
     #   lambda { |key, options| options[:gender] == 'm' ? "Mr. #{options[:name]}" : "Mrs. #{options[:name]}" }
     #
-    # Then <tt>I18n.t(:salutation, :gender => 'w', :name => 'Smith') will result in "Mrs. Smith".
+    # Then <tt>I18n.t(:salutation, :gender => 'w', :name => 'Smith')</tt> will result in "Mrs. Smith".
     #
     # Note that the string returned by lambda will go through string interpolation too,
     # so the following lambda would give the same result:
@@ -192,7 +193,7 @@ module I18n
     # always return the same translations/values per unique combination of argument
     # values.
     #
-    # *Ruby 2.7+ keyword arguments warning*
+    # <b>Ruby 2.7+ keyword arguments warning</b>
     #
     # 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
@@ -231,11 +232,41 @@ module I18n
     end
     alias :t! :translate!
 
+    # Returns an array of interpolation keys for the given translation key
+    #
+    # *Examples*
+    #
+    # Suppose we have the following:
+    #   I18n.t 'example.zero' == 'Zero interpolations'
+    #   I18n.t 'example.one' == 'One interpolation %{foo}'
+    #   I18n.t 'example.two' == 'Two interpolations %{foo} %{bar}'
+    #   I18n.t 'example.three' == ['One %{foo}', 'Two %{bar}', 'Three %{baz}']
+    #   I18n.t 'example.one', locale: :other == 'One interpolation %{baz}'
+    #
+    # Then we can expect the following results:
+    #   I18n.interpolation_keys('example.zero') #=> []
+    #   I18n.interpolation_keys('example.one') #=> ['foo']
+    #   I18n.interpolation_keys('example.two') #=> ['foo', 'bar']
+    #   I18n.interpolation_keys('example.three') #=> ['foo', 'bar', 'baz']
+    #   I18n.interpolation_keys('one', scope: 'example', locale: :other) #=> ['baz']
+    #   I18n.interpolation_keys('does-not-exist') #=> []
+    #   I18n.interpolation_keys('example') #=> []
+    def interpolation_keys(key, **options)
+      raise I18n::ArgumentError if !key.is_a?(String) || key.empty?
+
+      return [] unless exists?(key, **options.slice(:locale, :scope))
+
+      translation = translate(key, **options.slice(:locale, :scope))
+      interpolation_keys_from_translation(translation)
+        .flatten.compact
+    end
+
     # Returns true if a translation exists for a given key, otherwise returns false.
     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?
+      raise I18n::ArgumentError if (key.is_a?(String) && key.empty?) || key.nil?
+
       config.backend.exists?(locale, key, options)
     end
 
@@ -429,6 +460,17 @@ module I18n
           keys
         end
     end
+
+    def interpolation_keys_from_translation(translation)
+      case translation
+      when ::String
+        translation.scan(Regexp.union(I18n.config.interpolation_patterns))
+      when ::Array
+        translation.map { |element| interpolation_keys_from_translation(element) }
+      else
+        []
+      end
+    end
   end
 
   extend Base

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: i18n
 version: !ruby/object:Gem::Version
-  version: 1.14.1
+  version: 1.14.6
 platform: ruby
 authors:
 - Sven Fuchs
@@ -13,7 +13,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-04 00:00:00.000000000 Z
+date: 2024-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -91,7 +91,10 @@ metadata:
   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:
+post_install_message: 'PSA: I18n will be dropping support for Ruby < 3.2 in the next
+  major release (April 2025), due to Ruby''s end of life for 3.1 and below (https://endoflife.date/ruby).
+  Please upgrade to Ruby 3.2 or newer by April 2025 to continue using future versions
+  of this gem.'
 rdoc_options: []
 require_paths:
 - lib
@@ -106,7 +109,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.5
 requirements: []
-rubygems_version: 3.3.16
+rubygems_version: 3.3.27
 signing_key:
 specification_version: 4
 summary: New wave Internationalization support for Ruby