r18n-core 3.1.1 → 5.0.1

data/base/cy.yml

@@ -0,0 +1,34 @@
+ok: 'Iawn'
+save: 'Cadw'
+cancel: 'Canslo'
+'yes': 'Ie'
+'no': 'Na'
+exit: 'Gadael'
+delete: 'Dileu'
+
+human_time:
+  after_days: !!pl
+    1: 'ar ôl %1 diwrnod'
+    2: 'ar ôl %1 ddiwrnod'
+    n: 'ar ôl %1 diwrnod'
+  tomorrow: 'yfory'
+  after_hours: !!pl
+    1: 'ar ôl %1 awr'
+    n: 'ar ôl %1 awr'
+  after_minutes: !!pl
+    1: 'ar ôl %1 munud'
+    n: 'ar ôl %1 munud'
+  now: 'nawr'
+  today: 'heddiw'
+  minutes_ago: !!pl
+    1: '%1 munud yn ôl'
+    2: '%1 funud yn ôl'
+    n: '%1 munud yn ôl'
+  hours_ago: !!pl
+    1: '%1 awr yn ôl'
+    n: '%1 awr yn ôl'
+  yesterday: 'ddoe'
+  days_ago: !!pl
+    1: '%1 diwrnod yn ôl'
+    2: '%1 ddiwrnod yn ôl'
+    n: '%1 diwrnod yn ôl'

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 <tt>R18n.default_places</tt>.
-    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
+    # Set I18n object globally. You can miss translation `places`, it will be
+    # taken from `R18n.default_places`.
+    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.
@@ -90,48 +75,62 @@ module R18n
       Thread.current
     end
 
-    # Translate message. Alias for <tt>R18n.get.t</tt>.
+    # Translate message. Alias for `R18n.get.t`.
     def t(*params)
       get.t(*params)
     end
 
-    # Localize object. Alias for <tt>R18n.get.l</tt>.
+    # Localize object. Alias for `R18n.get.l`.
     def l(*params)
       get.l(*params)
     end
 
-    # Return I18n object for +locale+. Useful to temporary change locale,
+    # Return I18n object for `locale`. Useful to temporary change locale,
     # for example, to show text in locales list:
     #
     #   - R18n.available_locales.each do |locale|
     #     - R18n.change(locale).t.language_title
+    #
+    # It also can be used with block:
+    #
+    #   - R18n.change(locale) { t.language_title }
     def change(locale)
       locale = locale.code if locale.is_a? Locale
       exists = get ? get.locales.map(&:code) : []
       places = get ? get.translation_places : R18n.default_places
-      R18n::I18n.new([locale] + exists, places)
+
+      i18n = R18n::I18n.new([locale] + exists, places)
+
+      if block_given?
+        old_thread_i18n = thread[:r18n_i18n]
+        thread_set i18n
+        yield
+        thread[:r18n_i18n] = old_thread_i18n
+      end
+
+      i18n
     end
 
-    # Return Locale object by locale code. It’s shortcut for
-    # <tt>R18n::Locale.load(code)</tt>.
+    # Return Locale object by locale code. It's shortcut for
+    # `R18n::Locale.load(code)`.
     def locale(code)
       R18n::Locale.load(code)
     end
 
-    # Return Array of locales with available translations. You can miss
-    # translation +places+, it will be taken from <tt>R18n.default_places</tt>.
+    # Return `Array` of locales with available translations. You can miss
+    # translation `places`, it will be taken from `R18n.default_places`.
     def available_locales(places = R18n.default_places)
       R18n::I18n.convert_places(places).map(&:available).flatten.uniq
     end
 
-    # Default places for <tt>R18n.set</tt> and <tt>R18n.available_locales</tt>.
+    # Default places for `R18n.set` and `R18n.available_locales`.
     #
     # You can set block to calculate places dynamically:
     #   R18n.default_places { settings.i18n_places }
     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
@@ -140,15 +139,15 @@ module R18n
       end
     end
 
-    # Default loader class, which will be used if you didn’t send loader to
-    # +I18n.new+ (object with +available+ and +load+ methods).
+    # 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.
+    # `Hash` of hash-like (see Moneta) object to store loaded translations.
     attr_accessor :cache
   end
 

data/lib/r18n-core/filter_list.rb

@@ -18,10 +18,10 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 module R18n
-  # Superclass for +GlobalFilterList+ and +CustomFilterList+ with filters
+  # Superclass for `GlobalFilterList` and `CustomFilterList` with filters
   # processing.
   class FilterList
-    # Process +value+ by filters in +enabled+.
+    # Process `value` by filters in `enabled`.
     def process(filters_type, type, value, locale, path, params)
       config = { locale: locale, path: path }
 
@@ -39,15 +39,17 @@ module R18n
 
     # Shortcut to process `R18n::Typed`.
     def process_typed(filters_type, typed_value, params)
-      process(filters_type,
-              typed_value.type,
-              typed_value.value,
-              typed_value.locale,
-              typed_value.path,
-              params)
+      process(
+        filters_type,
+        typed_value.type,
+        typed_value.value,
+        typed_value.locale,
+        typed_value.path,
+        params
+      )
     end
 
-    # Process +value+ by global filters in +enabled+.
+    # Process `value` by global filters in `enabled`.
     def process_string(filters_type, value, config, params)
       config = { locale: value.locale, path: config } if config.is_a? String
 
@@ -55,18 +57,19 @@ 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
       end
     end
 
-    # Array of enabled filters with +filters_type+ for +type+.
+    # `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)
@@ -109,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
@@ -137,6 +142,7 @@ module R18n
     def passive(type)
       enabled = Filters.passive_enabled[type]
       return enabled unless @changed_passive.include? type
+
       enabled = enabled.reject { |i| @off_by_type[type].include? i }
       enabled + @on_by_type[type].select(&:passive)
     end
@@ -144,6 +150,7 @@ module R18n
     def active(type)
       enabled = Filters.active_enabled[type]
       return enabled unless @changed_active.include? type
+
       enabled = enabled.reject { |i| @off_by_type[type].include? i }
       enabled + @on_by_type[type].reject(&:passive)
     end
@@ -151,6 +158,7 @@ module R18n
     def all(type)
       enabled = Filters.enabled[type]
       return enabled unless @changed_types.include? type
+
       enabled = enabled.reject { |i| @off_by_type[type].include? i }
       enabled + @on_by_type[type]
     end

data/lib/r18n-core/filters.rb

@@ -42,14 +42,14 @@ module R18n
   #
   #   i18n.filtered('_') #=> "This_content_will_be_processed_by_filter!"
   #
-  # Use String class as type to add global filter for all translated strings:
+  # Use `String` class as type to add global filter for all translated strings:
   #
   #   R18n::Filters.add(String, :escape_html) do |content, config, params|
   #     escape_html(content)
   #   end
   #
   # Filter config contain two parameters: translation locale and path. But it is
-  # Hash and you can add you own parameter to cross-filter communications:
+  # `Hash` and you can add you own parameter to cross-filter communications:
   #
   #   R18n::Filters.add(String, :hide_truth) do |content, config|
   #     return content if config[:censorship_check]
@@ -74,28 +74,28 @@ module R18n
   #   i18n.filtered('_') #=> "This_content_will_be_processed_by_filter!"
   #   R18n::Filters.delete(:no_space)
   #
-  # You can enabled/disabled filters only for special I18n object:
+  # You can enabled/disabled filters only for special `I18n` object:
   #
   #   R18n::I18n.new('en', nil, on_filters: [:untranslated_html, :no_space],
   #                             off_filters: :untranslated )
   module Filters
     class << self
-      # Hash of filter names to Filters.
+      # `Hash` of filter names to Filters.
       attr_accessor :defined
 
-      # Hash of types to all Filters.
+      # `Hash` of types to all Filters.
       attr_accessor :by_type
 
-      # Hash of types to enabled active filters.
+      # `Hash` of types to enabled active filters.
       attr_accessor :active_enabled
 
-      # Hash of types to enabled passive filters.
+      # `Hash` of types to enabled passive filters.
       attr_accessor :passive_enabled
 
-      # Hash of types to enabled passive and active filters.
+      # `Hash` of types to enabled passive and active filters.
       attr_accessor :enabled
 
-      # Rebuild +active_enabled+ and +passive_enabled+ for +type+.
+      # Rebuild `active_enabled` and `passive_enabled` for `type`.
       def rebuild_enabled!(type)
         @passive_enabled[type] = []
         @active_enabled[type] = []
@@ -103,6 +103,7 @@ module R18n
 
         @by_type[type].each do |filter|
           next unless filter.enabled?
+
           @enabled[type] << filter
           if filter.passive?
             @passive_enabled[type] << filter
@@ -112,17 +113,17 @@ module R18n
         end
       end
 
-      # Add new filter for +type+ with +name+ and return filter object. You
-      # can use String class as +type+ to add global filter for all translated
+      # Add new filter for `type` with `name` and return filter object. You
+      # can use `String` class as `type` to add global filter for all translated
       # string.
       #
-      # Filter content will be sent to +block+ as first argument, struct with
+      # Filter content will be sent to `block` as first argument, struct with
       # config as second and filters parameters will be in next arguments.
       #
       # Options:
-      # * +position+ – change order on processing several filters for same type.
+      # * `position` – change order on processing several filters for same type.
       #    Note that passive filters will be always run before active.
-      # * +passive+ – if +true+, filter will process only on translation
+      # * `passive` – if `true`, filter will process only on translation
       #   loading. Note that you must add all passive before load translation.
       def add(types, name = nil, options = {}, &block)
         if name.is_a? Hash
@@ -161,7 +162,7 @@ module R18n
         filter
       end
 
-      # Delete +filter+ by name or Filter object.
+      # Delete `filter` by name or Filter object.
       def delete(filter)
         filter = @defined[filter] unless filter.is_a? Filter
         return unless filter
@@ -173,7 +174,7 @@ module R18n
         end
       end
 
-      # Disable +filter+ by name or Filter object.
+      # Disable `filter` by name or Filter object.
       def off(filter)
         filter = @defined[filter] unless filter.is_a? Filter
         return unless filter
@@ -182,7 +183,7 @@ module R18n
         filter.types.each { |type| rebuild_enabled! type }
       end
 
-      # Turn on disabled +filter+ by name or Filter object.
+      # Turn on disabled `filter` by name or Filter object.
       def on(filter)
         filter = @defined[filter] unless filter.is_a? Filter
         return unless filter
@@ -191,7 +192,7 @@ module R18n
         filter.types.each { |type| rebuild_enabled! type }
       end
 
-      # Return filters, which be added inside +block+.
+      # Return filters, which be added inside `block`.
       def listen(&_block)
         filters = []
         @new_filter_listener = proc { |i| filters << i }
@@ -209,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?
@@ -222,14 +223,8 @@ module R18n
     end
   end
 
-  Filters.add('proc', :procedure) do |content, _config, *params|
-    # rubocop:disable Security/Eval
-    eval("proc { #{content} }", nil, __FILE__, __LINE__).call(*params)
-    # rubocop:enable Security/Eval
-  end
-
   # Class to mark unpluralized translation.
-  class UnpluralizetedTranslation < Translation
+  class UnpluralizedTranslation < Translation
   end
 
   Filters.add('pl', :pluralization) do |content, config, param|
@@ -239,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
       )
@@ -248,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
@@ -265,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
@@ -282,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)
@@ -310,8 +304,9 @@ module R18n
     content
   end
 
-  Filters.add([String, 'markdown', 'textile'],
-              :global_escape_html, passive: true) do |html, config|
+  Filters.add(
+    [String, 'markdown', 'textile'], :global_escape_html, passive: true
+  ) do |html, config|
     if config[:dont_escape_html]
       html
     else