r18n-core 3.2.0 → 4.0.0

data/lib/r18n-core/translated_string.rb

@@ -28,8 +28,8 @@ module R18n
     # Path for this translation.
     attr_reader :path
 
-    # Returns a new string object containing a copy of +str+, which translated
-    # for +path+ to +locale+
+    # Returns a new string object containing a copy of `str`, which translated
+    # for `path` to `locale`
     def initialize(value, locale, path, filters = nil)
       super(value.to_s)
       @filters = filters
@@ -93,11 +93,13 @@ module R18n
     # Return untranslated, when user try to go deeper in translation.
     def method_missing(name, *_params)
       return super if NON_KEYS_METHODS.include?(name)
+
       get_untranslated(name.to_s)
     end
 
     def respond_to_missing?(name, *args)
       return super if NON_KEYS_METHODS.include?(name)
+
       true
     end
   end

data/lib/r18n-core/translation.rb

@@ -23,16 +23,16 @@ module R18n
 
   # Translation is container of translated messages.
   #
-  # You can load several locales and if translation willn’t be found in first,
+  # You can load several locales and if translation willn't be found in first,
   # r18n will be search it in next. Use R18n::I18n.new to load translations.
   #
   # To get translation value use method with same name. If translation name
-  # is equal with Object methods (+new+, +to_s+, +methods+) use
-  # <tt>[name, params…]</tt>. If you want to get pluralizable value, just set
+  # is equal with Object methods (`new`, `to_s`, `methods`) use
+  # `[name, params…]`. If you want to get pluralizable value, just set
   # value for pluralization in first argument of method. See samples below.
   #
-  # Translated strings will have +locale+ methods, which return Locale or
-  # UnsupportedLocale, if locale file isn’t exists.
+  # Translated strings will have `locale` methods, which return Locale or
+  # UnsupportedLocale, if locale file isn't exists.
   #
   # == Examples
   # translations/ru.yml
@@ -68,7 +68,7 @@ module R18n
   #   i18n.comments(10)           #=> "10 comments"
   class Translation
     # This is internal a constructor. To load translation use
-    # <tt>R18n::I18n.new(locales, translations_dir)</tt>.
+    # `R18n::I18n.new(locales, translations_dir)`.
     def initialize(locale, path = '', options = {})
       @data    = {}
       @locale  = locale
@@ -78,8 +78,8 @@ module R18n
       merge! options[:translations], options[:locale] if options[:translations]
     end
 
-    # Add another hash with +translations+ for some +locale+. Current data is
-    # more priority, that new one in +translations+.
+    # Add another hash with `translations` for some `locale`. Current data is
+    # more priority, that new one in `translations`.
     def merge!(translations, locale)
       (translations || {}).each_pair do |name, value|
         if !@data.key?(name)
@@ -123,28 +123,27 @@ module R18n
 
     # Return current translation keys.
     #
-    # Deprecated. Use <tt>to_hash.keys</tt>.
+    # Deprecated. Use `to_hash.keys`.
     def translation_keys
       to_hash.keys
     end
 
     # Return hash of current translation node.
     def to_hash
-      Utils.hash_map(@data) do |key, value|
-        value = value.to_hash if value.is_a? Translation
-        [key, value]
+      @data.transform_values do |value|
+        value.is_a?(Translation) ? value.to_hash : value
       end
     end
 
-    # Return +default+.
+    # Return `default`.
     def |(other)
       other
     end
 
-    # Return translation with special +name+.
+    # Return translation with special `name`.
     #
-    # Translation can contain variable part. Just set is as <tt>%1</tt>,
-    # <tt>%2</tt>, etc in translations file and set values in next +params+.
+    # Translation can contain variable part. Just set is as `%1`,
+    # `%2`, etc in translations file and set values in next `params`.
     def [](name, *params)
       unless [String, Integer, TrueClass, FalseClass]
           .any? { |klass| name.is_a?(klass) }
@@ -166,7 +165,7 @@ module R18n
     end
     alias method_missing []
 
-    # Return translation located at +names+.
+    # Return translation located at `keys`.
     # @see Hash#dig
     def dig(*keys)
       keys.reduce(self) { |result, key| result[key] }

data/lib/r18n-core/unsupported_locale.rb

@@ -24,10 +24,13 @@ module R18n
     # Locale, to get data and pluralization for unsupported locale.
     attr_accessor :base
 
-    # Create object for unsupported locale with +code+ and load other locale
-    # data from +base+ locale.
+    attr_reader :code, :downcased_code
+
+    # Create object for unsupported locale with `code` and load other locale
+    # data from `base` locale.
     def initialize(code, _base = nil)
       @code = code
+      @downcased_code = @code.downcase.tr('-', '_').freeze
       @base = Locale.load(I18n.default) if @code != I18n.default
     end
 
@@ -41,9 +44,6 @@ module R18n
       "Unsupported locale #{@code}"
     end
 
-    # Locale RFC 3066 code.
-    attr_reader :code
-
     # Locale code as title.
     def title
       @code
@@ -57,6 +57,7 @@ module R18n
     #  Proxy to default locale object.
     def method_missing(name, *params)
       return super unless @base.respond_to? name
+
       @base.public_send(name, *params)
     end
 

data/lib/r18n-core/untranslated.rb

@@ -18,7 +18,7 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 module R18n
-  # Return if translation isn’t exists. Unlike nil, it didn’t raise error when
+  # Return if translation isn't exists. Unlike nil, it didn't raise error when
   # you try to access for subtranslations.
   #
   # You can set format to print untranslated string by filters. For example:
@@ -37,7 +37,7 @@ module R18n
   #
   #   R18n::Filters.add(R18n::Untranslated, :hide_untranslated) { '' }
   class Untranslated
-    # Path, that isn’t in translation.
+    # Path, that isn't in translation.
     attr_reader :untranslated_path
 
     # Path, that exists in translation.
@@ -89,12 +89,17 @@ module R18n
 
     def respond_to_missing?(name, *args)
       return super if NON_KEYS_METHODS.include?(name)
+
       true
     end
 
     def [](*params)
-      Untranslated.new(translated_path, "#{@untranslated_path}.#{params.first}",
-                       @locale, @filters)
+      Untranslated.new(
+        translated_path,
+        "#{@untranslated_path}.#{params.first}",
+        @locale,
+        @filters
+      )
     end
 
     def |(other)
@@ -116,6 +121,7 @@ module R18n
       return false unless locale            == other.locale
       return false unless translated_path   == other.translated_path
       return false unless untranslated_path == other.untranslated_path
+
       true
     end
   end

data/lib/r18n-core/utils.rb

@@ -20,26 +20,13 @@
 # Common methods for another R18n code.
 module R18n
   module Utils
-    HTML_ENTRIES = { '&' => '&amp;', '<' => '&lt;', '>' => '&gt;' }.freeze
-
     # Escape HTML entries (<, >, &). Copy from HAML helper.
     def self.escape_html(content)
       if defined? ActiveSupport::SafeBuffer
         ActiveSupport::SafeBuffer.new + content
       else
-        content.to_s.gsub(/[><&]/) { |s| HTML_ENTRIES[s] }
-      end
-    end
-
-    # Invokes +block+ once for each key and value of +hash+. Creates a new hash
-    # with the keys and values returned by the +block+.
-    def self.hash_map(hash, &block)
-      result = {}
-      hash.each_pair do |key, val|
-        new_key, new_value = block.call(key, val)
-        result[new_key] = new_value
+        CGI.escapeHTML content
       end
-      result
     end
 
     # Recursively hash merge.

data/lib/r18n-core/version.rb

@@ -2,5 +2,5 @@
 
 # Version of R18n Core
 module R18n
-  VERSION = '3.2.0'.freeze unless defined? R18n::VERSION
+  VERSION = '4.0.0' unless defined? R18n::VERSION
 end

data/lib/r18n-core/yaml_loader.rb

@@ -20,73 +20,73 @@
 module R18n
   module Loader
     # Loader for translations in YAML format. Them should have name like
-    # +en.yml+ (English) or en-US.yml (USA English dialect) with
+    # `en.yml` (English) or en-US.yml (USA English dialect) with
     # language/country code (RFC 3066).
     #
     #   R18n::I18n.new('en', R18n::Loader::YAML.new('dir/with/translations'))
     #
     # YAML loader is default loader, so you can just set constructor parameter
-    # to <tt>R18n::I18n.new</tt>:
+    # to `R18n::I18n.new`:
     #
     #   R18n::I18n.new('en', 'dir/with/translations')
     class YAML
       include ::R18n::YamlMethods
 
-      FILE_EXT = 'y{,a}ml'.freeze
+      FILE_EXT = 'y{,a}ml'
 
       # Dir with translations.
       attr_reader :dir
 
-      # Create new loader for +dir+ with YAML translations.
+      # Create new loader for `dir` with YAML translations.
       def initialize(dir)
         @dir = File.expand_path(dir)
         detect_yaml_private_type
       end
 
-      # Array of locales, which has translations in +dir+.
+      # `Array` of locales, which has translations in `dir`.
       def available
         Dir.glob(File.join(@dir, "**/*.#{FILE_EXT}"))
-          .map { |i| File.basename(i, '.*') }.uniq
+          .map { |i| File.basename(i, '.*').downcase }.uniq
           .map { |i| R18n.locale(i) }
       end
 
-      # Return Hash with translations for +locale+.
+      # Return `Hash` with translations for `locale`.
       def load(locale)
         initialize_types
 
         translations = {}
         Dir.glob(
-          File.join(@dir, "**/#{locale.code.downcase}.#{FILE_EXT}")
+          File.join(@dir, "**/#{locale.code}.#{FILE_EXT}"), File::FNM_CASEFOLD
         ).each do |i|
           Utils.deep_merge!(translations, ::YAML.load_file(i) || {})
         end
         transform(translations)
       end
 
-      # YAML loader with same +dir+ will be have same +hash+.
+      # YAML loader with same `dir` will be have same `hash`.
       def hash
         self.class.hash + @dir.hash
       end
 
-      # Is another +loader+ load YAML translations from same +dir+.
+      # Is another `loader` load YAML translations from same `dir`.
       def ==(other)
         self.class == other.class && dir == other.dir
       end
 
       # Wrap YAML private types to Typed.
       def transform(a_hash)
-        R18n::Utils.hash_map(a_hash) do |key, value|
+        a_hash.transform_values do |value|
           if value.is_a? Hash
             value = transform(value)
           elsif defined?(@private_type_class) &&
-                value.is_a?(@private_type_class)
+              value.is_a?(@private_type_class)
             v = value.value
             if v.respond_to?(:force_encoding) && v.encoding != __ENCODING__
               v = v.force_encoding(__ENCODING__)
             end
             value = Typed.new(value.type_id, v)
           end
-          [key, value]
+          value
         end
       end
     end

data/lib/r18n-core/yaml_methods.rb

@@ -31,9 +31,11 @@ module R18n
     # Register global types in Psych
     def initialize_types
       return unless defined?(Psych)
+
       Filters.by_type.each_key do |type|
         next unless type.is_a? String
-        # Yeah, I add R18n’s types to global, send me patch if you really
+
+        # Yeah, I add R18n's types to global, send me patch if you really
         # use YAML types too ;).
         Psych.add_domain_type('yaml.org,2002', type) do |_full_type, value|
           Typed.new(type, value)

data/r18n-core.gemspec

@@ -24,6 +24,6 @@ Gem::Specification.new do |s|
 
   s.author   = 'Andrey Sitnik'
   s.email    = 'andrey@sitnik.ru'
-  s.homepage = 'https://github.com/ai/r18n'
+  s.homepage = 'https://github.com/r18n/r18n'
   s.license  = 'LGPL-3.0'
 end

data/spec/filters_spec.rb

@@ -11,6 +11,7 @@ describe R18n::Filters do
   after do
     R18n::Filters.defined.each_value do |filter|
       next if @system.include? filter
+
       R18n::Filters.delete(filter)
     end
 
@@ -190,6 +191,7 @@ describe R18n::Filters do
     )
   end
 
+  # rubocop:disable Style/FormatStringToken
   it 'interpolates named variables' do
     R18n::Filters.off(:named_variables)
     expect(@i18n.echo(value: 'R18n')).to eq 'Value is %{value}'
@@ -204,6 +206,7 @@ describe R18n::Filters do
     expect(@i18n.echo2(value: 'R18n')).to eq 'Value2 is R18n'
     expect(@i18n.echo2).to eq 'Value2 is {{value}}'
   end
+  # rubocop:enable Style/FormatStringToken
 
   it 'formats untranslated' do
     expect(@i18n.in.not.to_s).to   eq('in.[not]')

data/spec/i18n_spec.rb

@@ -27,7 +27,7 @@ describe R18n::I18n do
     i18n = R18n::I18n.new('en', DIR)
     expect(i18n.locales).to eq([R18n.locale('en')])
 
-    i18n = R18n::I18n.new(['ru', 'nolocale-DL'], DIR)
+    i18n = R18n::I18n.new(%w[ru nolocale-DL], DIR)
     expect(i18n.locales).to eq([
       R18n.locale('ru'),
       R18n::UnsupportedLocale.new('nolocale-DL'),
@@ -123,6 +123,11 @@ describe R18n::I18n do
     expect(i18n.two).to eq('Two')
   end
 
+  it 'loads base translations from parent locale' do
+    i18n = R18n::I18n.new('en-US', File.join(TRANSLATIONS, 'with_regions'))
+    expect(i18n.save).to eq('Save')
+  end
+
   it 'returns available translations' do
     i18n = R18n::I18n.new('en', DIR)
     expect(i18n.available_locales).to match_array([
@@ -236,18 +241,27 @@ describe R18n::I18n do
     expect(i18n.l(-123_456_789)).to eq('−123 456 789')
     expect(i18n.l(-12_345.67)).to   eq('−12 345,67')
 
-    time = Time.at(0).utc
-    expect(i18n.l(time, '%A')).to      eq('Четверг')
-    expect(i18n.l(time, :month)).to    eq('Январь')
-    expect(i18n.l(time, :standard)).to eq('01.01.1970 00:00')
-    expect(i18n.l(time, :full)).to     eq('1 января 1970 00:00')
+    time = Time.utc(2014, 5, 6, 7, 8, 9)
+    expect(i18n.l(time, '%A'))
+      .to eq('Вторник')
+    expect(i18n.l(time, :month))
+      .to eq('Май')
+    expect(i18n.l(time, :standard))
+      .to eq('06.05.2014 07:08')
+    expect(i18n.l(time, :standard, with_seconds: true))
+      .to eq('06.05.2014 07:08:09')
+    expect(i18n.l(time, :full))
+      .to eq('6 мая 2014 07:08')
+    expect(i18n.l(time, :full, with_seconds: true))
+      .to eq('6 мая 2014 07:08:09')
 
     expect(i18n.l(Date.new(0))).to eq('01.01.0000')
   end
 
   it 'returns marshalizable values' do
-    i18n    = R18n::I18n.new('en', DIR, off_filters: :untranslated,
-                                        on_filters:  :untranslated_html)
+    i18n = R18n::I18n.new(
+      'en', DIR, off_filters: :untranslated, on_filters: :untranslated_html
+    )
     demarsh = Marshal.load(Marshal.dump(i18n.t.one))
 
     expect(i18n.t.one).to        eq(demarsh)

data/spec/locale_spec.rb

@@ -8,11 +8,6 @@ describe R18n::Locale do
     @en = R18n.locale('en')
   end
 
-  it 'returns all available locales' do
-    expect(R18n::Locale.available.class).to eq(Array)
-    expect(R18n::Locale.available).not_to be_empty
-  end
-
   it 'checks is locale exists' do
     expect(R18n::Locale.exists?('ru')).to be true
     expect(R18n::Locale.exists?('nolocale')).to be false
@@ -20,6 +15,10 @@ describe R18n::Locale do
 
   it 'sets locale properties' do
     locale_class = Class.new(R18n::Locale) do
+      def self.name
+        'Foo'
+      end
+
       set one: 1
       set two: 2
     end

data/spec/locales/af_spec.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+describe R18n::Locales::Af do
+  it 'formats Afrikaans time' do
+    af = R18n::I18n.new('af')
+    expect(af.l(Time.utc(2009, 5, 1, 6, 7, 8), :standard, with_seconds: true))
+      .to eq('01/05/2009, 06:07:08')
+  end
+end