r18n-core 4.0.0 → 5.0.1

data/lib/r18n-core.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Main file to load all neccessary classes for i18n support.
+# Main file to load all necessary classes for i18n support.
 #
 # Copyright (C) 2008 Andrey “A.I.” Sitnik <andrey@sitnik.ru>
 #
@@ -35,40 +35,25 @@
   require_relative File.join('r18n-core', file)
 end
 
+# Root module with singleton methods
 module R18n
   autoload :Translated, 'r18n-core/translated'
 
   class << self
     # Set I18n object globally. You can miss translation `places`, it will be
     # taken from `R18n.default_places`.
-    def set(i18n = nil, places = R18n.default_places, &block)
-      @i18n =
-        if block_given?
-          @setter = block
-          nil
-        elsif i18n.is_a? I18n
-          i18n
-        else
-          I18n.new(i18n, places)
-        end
+    def set(i18n, places = R18n.default_places)
+      @i18n = i18n.is_a?(I18n) ? i18n : I18n.new(i18n, places)
     end
 
     # Set I18n object to current thread.
-    def thread_set(i18n = nil, &block)
-      if block_given?
-        thread[:r18n_setter] = block
-        thread[:r18n_i18n]   = nil
-      else
-        thread[:r18n_i18n] = i18n
-      end
+    def thread_set(i18n)
+      thread[:r18n_i18n] = i18n
     end
 
     # Get I18n object for current thread.
     def get
-      thread[:r18n_i18n] ||
-        (thread[:r18n_setter] && thread_set(thread[:r18n_setter].call)) ||
-        @i18n ||
-        (@setter && set(@setter.call))
+      thread[:r18n_i18n] || @i18n
     end
 
     # Clean translations cache.
@@ -145,7 +130,7 @@ module R18n
     attr_writer :default_places
 
     def default_places(&block)
-      if block_given?
+      if block
         @default_places = block
       elsif @default_places.is_a? Proc
         @default_places.call
@@ -154,12 +139,12 @@ module R18n
       end
     end
 
-    # Default loader class, which will be used if you didn't send loader to
+    # Default loader class, which will be used if you did not send loader to
     # `I18n.new` (object with `available` and `load` methods).
     attr_accessor :default_loader
 
     # Loaders with extension translations. If application translations with
-    # same locale isn't exists, extension file willn't be used.
+    # same locale isn't exists, extension file will not be used.
     attr_accessor :extension_places
 
     # `Hash` of hash-like (see Moneta) object to store loaded translations.

data/lib/r18n-core/filter_list.rb

@@ -57,7 +57,7 @@ module R18n
         value = f.call(value, config, *params)
       end
 
-      if value.class == String
+      if value.instance_of? String
         TranslatedString.new(value, config[:locale], config[:path], self)
       else
         value
@@ -66,9 +66,10 @@ module R18n
 
     # `Array` of enabled filters with `filters_type` for `type`.
     def enabled(filters_type, type)
-      if filters_type == :passive
+      case filters_type
+      when :passive
         passive(type)
-      elsif filters_type == :active
+      when :active
         active(type)
       else
         all(type)
@@ -111,6 +112,8 @@ module R18n
   # Filter list for I18n object with custom disabled/enabled filters.
   class CustomFilterList < FilterList
     def initialize(on, off)
+      super()
+
       @on  = Array(on).map  { |i| Filters.defined[i] }
       @off = Array(off).map { |i| Filters.defined[i] }
       @changed_types = (@on + @off).map(&:types).flatten.uniq

data/lib/r18n-core/filters.rb

@@ -210,7 +210,7 @@ module R18n
 
     Filter = Struct.new(:name, :types, :block, :enabled, :passive) do
       def call(*params)
-        block.call(*params)
+        instance_exec(*params, &block)
       end
 
       def enabled?
@@ -224,7 +224,7 @@ module R18n
   end
 
   # Class to mark unpluralized translation.
-  class UnpluralizetedTranslation < Translation
+  class UnpluralizedTranslation < Translation
   end
 
   Filters.add('pl', :pluralization) do |content, config, param|
@@ -234,7 +234,7 @@ module R18n
       type = 'n' unless content.key? type
       content[type]
     else
-      UnpluralizetedTranslation.new(
+      UnpluralizedTranslation.new(
         config[:locale], config[:path],
         locale: config[:locale], translations: content
       )
@@ -243,13 +243,11 @@ module R18n
 
   Filters.add(String, :variables) do |content, config, *params|
     cached_params = []
-    content.to_s.gsub(/\%\d/) do |key|
+    content.to_s.gsub(/%\d/) do |key|
       i = key[1..-1].to_i
       unless cached_params.include? i - 1
         param = config[:locale].localize(params[i - 1])
-        if defined? ActiveSupport::SafeBuffer
-          param = ActiveSupport::SafeBuffer.new + param
-        end
+        param = ActiveSupport::SafeBuffer.new + param if defined? ActiveSupport::SafeBuffer
 
         cached_params[i - 1] = param
       end
@@ -260,13 +258,11 @@ module R18n
   Filters.add(String, :named_variables) do |content, config, params|
     if params.is_a? Hash
       content = content.clone
-      params.each_pair do |name, value|
-        value = config[:locale].localize(value)
-        if defined? ActiveSupport::SafeBuffer
-          value = ActiveSupport::SafeBuffer.new + value
-        end
-        content.gsub! "%{#{name}}",  value
-        content.gsub! "{{#{name}}}", value
+      content.gsub!(/(?:%{(\w+)}|{{(\w+)}})/) do |name|
+        key = name.delete('%{}').to_sym
+        value = config[:locale].localize(params[key])
+        value = ActiveSupport::SafeBuffer.new + value if defined? ActiveSupport::SafeBuffer
+        value
       end
     end
     content
@@ -277,20 +273,23 @@ module R18n
     "#{translated}[#{untranslated}]"
   end
 
-  Filters.add(Untranslated, :untranslated_bash) do |_v, _c, transl, untransl|
-    "#{transl}\e[0;31m[#{untransl}]\e[0m"
+  Filters.add(Untranslated, :untranslated_bash) do |_v, _c, translated, untranslated|
+    "#{translated}\e[0;31m[#{untranslated}]\e[0m"
   end
   Filters.off(:untranslated_bash)
 
-  Filters.add(Untranslated, :untranslated_html) do |_v, _c, transl, untransl|
+  Filters.add(Untranslated, :untranslated_html) do |_v, _c, translated, untranslated|
     prefix  = '<span style="color: red">['
     postfix = ']</span>'
-    if prefix.respond_to? :html_safe
-      prefix  = prefix.html_safe
-      postfix = postfix.html_safe
-      transl + prefix + untransl + postfix
+    if defined? ActiveSupport::SafeBuffer
+      ## Not every project with `ActiveSupport` has `ActionView`
+      ## https://github.com/r18n/r18n/issues/251
+      ## I guess, we can trust to developers here
+      translated = ActiveSupport::SafeBuffer.new + translated
+      untranslated = ActiveSupport::SafeBuffer.new + untranslated
+      translated + prefix.html_safe + untranslated + postfix.html_safe
     else
-      Utils.escape_html(transl) + prefix + Utils.escape_html(untransl) + postfix
+      Utils.escape_html(translated) + prefix + Utils.escape_html(untranslated) + postfix
     end
   end
   Filters.off(:untranslated_html)

data/lib/r18n-core/i18n.rb

@@ -137,15 +137,11 @@ module R18n
     def initialize(locales, translation_places = nil, opts = {})
       locales = Array(locales)
 
-      if !locales.empty? && Locale.exists?(locales.first)
-        locales += Locale.load(locales.first).sublocales
-      end
-      locales << self.class.default
       locales.each_with_index do |locale, i|
-        if locale =~ /[^_-]+[_-]/
-          locales.insert(i + 1, locale.match(/([^_-]+)[_-]/)[1])
-        end
+        locales.insert(i + 1, locale.match(/([^_-]+)[_-]/)[1]) if locale.match?(/[^_-]+[_-]/)
+        locales.insert(i + 1, *(Locale.load(locale).sublocales - locales)) if Locale.exists?(locale)
       end
+      locales << self.class.default
       locales.map! { |i| i.to_s.downcase }.uniq!
       @locales_codes = locales
       @locales = locales.each_with_object([]) do |locale, result|
@@ -189,10 +185,8 @@ module R18n
       @available_codes ||= @translation_places
         .inject([]) { |all, i| all + i.available }
         .uniq.map { |i| i.code.downcase }
-      (@locales_codes & @available_codes).join(',') + '@' +
-        @filters.hash.to_s + '_' +
-        R18n.default_loader.hash.to_s + '_' +
-        @translation_places.hash.to_s + '_' +
+      "#{(@locales_codes & @available_codes).join(',')}@" \
+        "#{@filters.hash}_#{R18n.default_loader.hash}_#{@translation_places.hash}_" +
         R18n.extension_places.hash.to_s
     end
 
@@ -240,9 +234,8 @@ module R18n
         next unless loaded
 
         available_in_extensions.each do |extension, available|
-          if available.include? locale
-            @translation.merge! extension.load(locale), locale
-          end
+          @translation.merge! extension.load(locale), locale if available.include? locale
+
           if available.include? locale.parent
             @translation.merge! extension.load(locale.parent), locale.parent
           end
@@ -270,8 +263,8 @@ module R18n
     #   i18n.l Time.now.to_date #=> "07/01/09"
     #   i18n.l Time.now, :human #=> "now"
     #   i18n.l Time.now, :full  #=> "Jule 1st, 2009 12:59"
-    def localize(object, format = nil, *params)
-      locale.localize(object, format, self, *params)
+    def localize(object, format = nil, **kwargs)
+      locale.localize(object, format, i18n: self, **kwargs)
     end
     alias l localize
 

data/lib/r18n-core/locale.rb

@@ -109,6 +109,7 @@ module R18n
       #   locale.code  #=> "en"
       def set(properties)
         properties.each_pair do |key, value|
+          undef_method key if method_defined? key
           define_method(key) { value }
         end
       end
@@ -127,7 +128,7 @@ module R18n
       @parent = self.class.superclass.new
     end
 
-    set sublocales: %w[en],
+    set sublocales: [],
         week_start: :monday,
         time_am: 'AM',
         time_pm: 'PM',
@@ -175,7 +176,7 @@ module R18n
     # `:full` ("01 Jule, 2009"), `:human` ("yesterday"),
     # `:standard` ("07/01/09") or `:month` for standalone month
     # name. Default format is `:standard`.
-    def localize(obj, format = nil, *params)
+    def localize(obj, format = nil, *args, **kwargs)
       case obj
       when Integer
         format_integer(obj)
@@ -184,7 +185,7 @@ module R18n
       when Time, DateTime, Date
         return strftime(obj, format) if format.is_a? String
         return month_standalone[obj.month - 1] if format == :month
-        return obj.to_s if format == :human && !params.first.is_a?(I18n)
+        return obj.to_s if format == :human && !kwargs.key?(:i18n)
 
         type = obj.is_a?(Date) && !obj.is_a?(DateTime) ? 'date' : 'time'
         format ||= :standard
@@ -194,14 +195,14 @@ module R18n
           raise ArgumentError, "Unknown time formatter #{format}"
         end
 
-        send format_method_name, obj, *params
+        send format_method_name, obj, *args, **kwargs
       else
         format_method_name =
-          "format_#{Utils.underscore(obj.class.name)}_#{format}"
+          "format_#{Utils.underscore(obj.class.name).tr('/', '_')}_#{format}"
 
         return obj.to_s unless respond_to? format_method_name
 
-        send format_method_name, obj, *params
+        send format_method_name, obj, *args, **kwargs
       end
     end
 
@@ -250,7 +251,7 @@ module R18n
     end
 
     # Format `time` and set `date`
-    def format_time(date, time, with_seconds: false)
+    def format_time(date, time, with_seconds: false, **_kwargs)
       strftime(
         time, with_seconds ? time_with_seconds_format : time_format
       ).sub('_', date.to_s)
@@ -259,12 +260,12 @@ module R18n
     # Format `time` in human usable form. For example "5 minutes ago" or
     # "yesterday". In `now` you can set base time, which be used to get relative
     # time. For special cases you can replace it in locale's class.
-    def format_time_human(time, i18n, now = time.class.now, *_params)
+    def format_time_human(time, i18n:, now: time.class.now, **_kwargs)
       diff = time - now
       minutes = time.is_a?(DateTime) ? diff * 24 * 60.0 : diff / 60.0
       diff = minutes.abs
       if (diff > 24 * 60) || (time.mday != now.mday && diff > 12 * 24)
-        format_time(format_date_human(time.to_date, i18n, now.to_date), time)
+        format_time(format_date_human(time.to_date, now: now.to_date, i18n: i18n), time)
       elsif minutes > -1 && minutes < 1
         i18n.human_time.now
       elsif minutes >= 60
@@ -279,22 +280,20 @@ module R18n
     end
 
     # Format `time` in compact form. For example, "12/31/09 12:59".
-    def format_time_standard(time, *params)
-      options = params.last.is_a?(Hash) ? params.last : {}
-      format_time(format_date_standard(time), time, **options)
+    def format_time_standard(time, *args, **kwargs)
+      format_time(format_date_standard(time), time, *args, **kwargs)
     end
 
     # Format `time` in most official form. For example, "December 31st, 2009
     # 12:59". For special cases you can replace it in locale's class.
-    def format_time_full(time, *params)
-      options = params.last.is_a?(Hash) ? params.last : {}
-      format_time(format_date_full(time), time, **options)
+    def format_time_full(time, **kwargs)
+      format_time(format_date_full(time, **kwargs), time, **kwargs)
     end
 
-    # Format `date` in human usable form. For example "5 days ago" or
-    # "yesterday". In `now` you can set base time, which be used to get relative
-    # time. For special cases you can replace it in locale's class.
-    def format_date_human(date, i18n, now = Date.today, *_params)
+    # Format `date` in human usable form. For example "5 days ago" or "yesterday".
+    # In `:now` you can set base time, which be used to get relative time.
+    # For special cases you can replace it in locale's class.
+    def format_date_human(date, *_args, i18n:, now: Date.today, **_kwargs)
       days = (date - now).to_i
       case days
       when -6..-2
@@ -308,7 +307,7 @@ module R18n
       when 2..6
         i18n.human_time.after_days(days)
       else
-        format_date_full(date, date.year != now.year)
+        format_date_full(date, year: date.year != now.year)
       end
     end
 
@@ -320,7 +319,7 @@ module R18n
     # Format `date` in most official form. For example, "December 31st, 2009".
     # For special cases you can replace it in locale's class. If `year` is false
     # date will be without year.
-    def format_date_full(date, year = true, *_params)
+    def format_date_full(date, year: true, **_kwargs)
       format = full_format
       format = year_format.sub('_', format) if year
       strftime(date, format)

data/lib/r18n-core/locales/cy.rb

@@ -40,7 +40,7 @@ module R18n
         end
       end
 
-      def format_date_full(date, year = true, *_params)
+      def format_date_full(date, year: true, **_kwargs)
         format = full_format
         format = year_format.sub('_', format) if year
         strftime(date, format.sub('%e', ordinalize(date.mday)))

data/lib/r18n-core/locales/en-au.rb

@@ -7,7 +7,7 @@ module R18n
     # Australian English locale
     class EnAU < En
       set title: 'Australian English',
-          sublocales: %w[en]
+          sublocales: %w[en en-US en-GB]
     end
   end
 end

data/lib/r18n-core/locales/en-gb.rb

@@ -8,7 +8,7 @@ module R18n
     class EnGB < En
       set(
         title: 'British English',
-        sublocales: %w[en],
+        sublocales: %w[en en-US en-AU],
 
         date_format: '%d/%m/%Y'
       )

data/lib/r18n-core/locales/en-us.rb

@@ -8,7 +8,7 @@ module R18n
     class EnUS < En
       set(
         title: 'American English',
-        sublocales: %w[en],
+        sublocales: %w[en en-GB en-AU],
 
         time_format: '_ %I:%M %p',
         time_with_seconds_format: '_ %r',

data/lib/r18n-core/locales/en.rb

@@ -6,7 +6,7 @@ module R18n
     class En < Locale
       set(
         title: 'English',
-        sublocales: [],
+        sublocales: %w[en-US en-GB en-AU],
 
         week_start: :sunday,
         wday_names: %w[
@@ -41,7 +41,7 @@ module R18n
         end
       end
 
-      def format_date_full(date, year = true, *_params)
+      def format_date_full(date, year: true, **_kwargs)
         format = full_format
         format = year_format.sub('_', format) if year
         strftime(date, format.sub('%-d', ordinalize(date.mday)))

data/lib/r18n-core/locales/es-cl.rb

@@ -8,7 +8,7 @@ module R18n
     class EsCL < Es
       set(
         title: 'Español Chile',
-        sublocales: %w[es],
+        sublocales: %w[es es-US],
         date_format: '%d-%m-%Y'
       )
     end

data/lib/r18n-core/locales/es-us.rb

@@ -8,7 +8,7 @@ module R18n
     class EsUS < Es
       set(
         title: 'Español Estadounidense',
-        sublocales: %w[es en],
+        sublocales: %w[es es-CL en],
 
         time_format: '_ %I:%M %p',
         time_with_seconds_format: '_ %r',