i18n 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e56b50c83ab6291a1321b462814b80ad73d74d01cb77c25ab6a1d948c8737afc
-  data.tar.gz: 23d1ac1b19a36a2543e063f612170f45be6d404d2ff258c611c75be159dde98c
+  metadata.gz: 8f090f4664c260c453c6287eda93ccabd1681c8ca2cef077794fcc8ec32dab4f
+  data.tar.gz: 639643c1611bd9800407a84b1fc4c0dcf57e85e9cab85c9a4a82e56418a15a48
 SHA512:
-  metadata.gz: b555490dcb1c101f72f04f6ce9f257070da32021906355f7ccf96ee8ef62d33fda682e75bfb634d91c13afc72fa2d6f74135721a0df40c473edb083cf0a04360
-  data.tar.gz: 810d9280d42cf03d60d4251371bad79f602799b786660413e00b8f4d351a81c70b0ad7f4223ac276d0600721139e367b2b39a656f6d60335993bcc46d30abafb
+  metadata.gz: 8b9747cc4ba7e203400ed38c21a2c6e5c35b45c4283bd56e4cb608b72c3904e6117d80b11a91b97753344ac0185fae0f340e3687b26eb40a95669d0039fad6ee
+  data.tar.gz: 48aa51116fe7450ce06036dbd537e7711d66d755a4001bc148936573c08b74744428cf5877f757fe53fb6326d8b99f891639a31844396d9c24e1ff2477cebd1d

data/README.md

@@ -104,6 +104,10 @@ the API definition test methods in test/api/tests.
 All other test cases (e.g. as defined in test/backend, test/core_ext) etc.
 follow the usual test setup and should be easy to grok.
 
+## More Documentation
+
+Additional documentation can be found here: https://github.com/svenfuchs/i18n/wiki
+
 ## Authors
 
 * [Sven Fuchs](http://www.artweb-design.de)

data/lib/i18n/backend.rb

@@ -5,6 +5,7 @@ module I18n
     autoload :Base,                  'i18n/backend/base'
     autoload :InterpolationCompiler, 'i18n/backend/interpolation_compiler'
     autoload :Cache,                 'i18n/backend/cache'
+    autoload :CacheFile,             'i18n/backend/cache_file'
     autoload :Cascade,               'i18n/backend/cascade'
     autoload :Chain,                 'i18n/backend/chain'
     autoload :Fallbacks,             'i18n/backend/fallbacks'

data/lib/i18n/backend/base.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'yaml'
+require 'json'
 require 'i18n/core_ext/hash'
 
 module I18n
@@ -9,7 +10,7 @@ module I18n
       include I18n::Backend::Transliterator
 
       # Accepts a list of paths to translation files. Loads translations from
-      # plain Ruby (*.rb) or YAML files (*.yml). See #load_rb and #load_yml
+      # plain Ruby (*.rb), YAML files (*.yml), or JSON files (*.json). See #load_rb, #load_yml, and #load_json
       # for details.
       def load_translations(*filenames)
         filenames = I18n.load_path if filenames.empty?
@@ -235,6 +236,16 @@ module I18n
         end
         alias_method :load_yaml, :load_yml
 
+        # Loads a JSON translations file. The data must have locales as
+        # toplevel keys.
+        def load_json(filename)
+          begin
+            ::JSON.parse(File.read(filename))
+          rescue TypeError, StandardError => e
+            raise InvalidLocaleData.new(filename, e.inspect)
+          end
+        end
+
         def translate_localization_format(locale, object, format, options)
           format.to_s.gsub(/%[aAbBpP]/) do |match|
             case match

data/lib/i18n/backend/cache_file.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'digest/sha2'
+
+module I18n
+  module Backend
+    # Overwrites the Base load_file method to cache loaded file contents.
+    module CacheFile
+      # Optionally provide path_roots array to normalize filename paths,
+      # to make the cached i18n data portable across environments.
+      attr_accessor :path_roots
+
+      protected
+
+      # Track loaded translation files in the `i18n.load_file` scope,
+      # and skip loading the file if its contents are still up-to-date.
+      def load_file(filename)
+        initialized = !respond_to?(:initialized?) || initialized?
+        key = I18n::Backend::Flatten.escape_default_separator(normalized_path(filename))
+        old_mtime, old_digest = initialized && lookup(:i18n, key, :load_file)
+        return if (mtime = File.mtime(filename).to_i) == old_mtime ||
+                  (digest = Digest::SHA2.file(filename).hexdigest) == old_digest
+        super
+        store_translations(:i18n, load_file: { key => [mtime, digest] })
+      end
+
+      # Translate absolute filename to relative path for i18n key.
+      def normalized_path(file)
+        return file unless path_roots
+        path = path_roots.find(&file.method(:start_with?)) ||
+               raise(InvalidLocaleData.new(file, 'outside expected path roots'))
+        file.sub(path, path_roots.index(path).to_s)
+      end
+    end
+  end
+end

data/lib/i18n/backend/chain.rb

@@ -26,6 +26,15 @@ module I18n
           self.backends = backends
         end
 
+        def initialized?
+          backends.all? do |backend|
+            backend.instance_eval do
+              return false unless initialized?
+            end
+          end
+          true
+        end
+          
         def reload!
           backends.each { |backend| backend.reload! }
         end
@@ -74,6 +83,19 @@ module I18n
         end
 
         protected
+          def init_translations
+            backends.each do |backend|
+              backend.send(:init_translations)
+            end
+          end
+
+          def translations
+            backends.first.instance_eval do
+              init_translations unless initialized?
+              translations
+            end
+          end  
+
           def namespace_lookup?(result, options)
             result.is_a?(Hash) && !options.has_key?(:count)
           end

data/lib/i18n/backend/key_value.rb

@@ -76,6 +76,10 @@ module I18n
           @store, @subtrees = store, subtrees
         end
 
+        def initialized?
+          !@store.nil?
+        end
+
         def store_translations(locale, data, options = EMPTY_HASH)
           escape = options.fetch(:escape, true)
           flatten_translations(locale, data, escape, @subtrees).each do |key, value|
@@ -105,6 +109,26 @@ module I18n
 
       protected
 
+        # Queries the translations from the key-value store and converts
+        # them into a hash such as the one returned from loading the
+        # haml files
+        def translations
+          @translations = @store.keys.clone.map do |main_key|
+            main_value = JSON.decode(@store[main_key])
+            main_key.to_s.split(".").reverse.inject(main_value) do |value, key|
+              {key.to_sym => value}
+            end
+          end.inject{|hash, elem| hash.deep_merge!(elem)}.deep_symbolize_keys
+        end
+
+        def init_translations
+          # NO OP
+          # This call made also inside Simple Backend and accessed by
+          # other plugins like I18n-js and babilu and
+          # to use it along with the Chain backend we need to
+          # provide a uniform API even for protected methods :S
+        end
+
         def subtrees?
           @subtrees
         end

data/lib/i18n/backend/simple.rb

@@ -39,7 +39,7 @@ module I18n
           end
           locale = locale.to_sym
           translations[locale] ||= {}
-          data = data.deep_symbolize_keys
+          data = data.deep_stringify_keys.deep_symbolize_keys
           translations[locale].deep_merge!(data)
         end
 

data/lib/i18n/config.rb

@@ -145,5 +145,21 @@ module I18n
     def enforce_available_locales=(enforce_available_locales)
       @@enforce_available_locales = enforce_available_locales
     end
+
+    # Returns the current interpolation patterns. Defaults to
+    # I18n::DEFAULT_INTERPOLATION_PATTERNS.
+    def interpolation_patterns
+      @@interpolation_patterns ||= I18n::DEFAULT_INTERPOLATION_PATTERNS.dup
+    end
+
+    # Sets the current interpolation patterns. Used to set a interpolation
+    # patterns.
+    #
+    # E.g. using {{}} as a placeholder like "{{hello}}, world!":
+    #
+    #   I18n.config.interpolation_patterns << /\{\{(\w+)\}\}/
+    def interpolation_patterns=(interpolation_patterns)
+      @@interpolation_patterns = interpolation_patterns
+    end
   end
 end

data/lib/i18n/core_ext/hash.rb

@@ -17,6 +17,14 @@ class Hash
     }
   end unless Hash.method_defined?(:deep_symbolize_keys)
 
+  def deep_stringify_keys
+    inject({}) { |result, (key, value)|
+      value = value.deep_stringify_keys if value.is_a?(Hash)
+      result[key.to_s] = value
+      result
+    }
+  end unless Hash.method_defined?(:deep_stringify_keys)
+
   # deep_merge_hash! by Stefan Rusterholz, see http://www.ruby-forum.com/topic/142809
   MERGER = proc do |key, v1, v2|
     Hash === v1 && Hash === v2 ? v1.merge(v2, &MERGER) : v2

data/lib/i18n/interpolate/ruby.rb

@@ -2,11 +2,13 @@
 # http://github.com/mutoh/gettext/blob/f6566738b981fe0952548c421042ad1e0cdfb31e/lib/gettext/core_ext/string.rb
 
 module I18n
-  INTERPOLATION_PATTERN = Regexp.union(
+  DEFAULT_INTERPOLATION_PATTERNS = [
     /%%/,
     /%\{(\w+)\}/,                               # matches placeholders like "%{foo}"
     /%<(\w+)>(.*?\d*\.?\d*[bBdiouxXeEfgGcps])/  # matches placeholders like "%<foo>.d"
-  )
+  ].freeze
+  INTERPOLATION_PATTERN = Regexp.union(DEFAULT_INTERPOLATION_PATTERNS)
+  deprecate_constant :INTERPOLATION_PATTERN if method_defined? :INTERPOLATION_PATTERN
 
   class << self
     # Return String or raises MissingInterpolationArgument exception.
@@ -18,7 +20,7 @@ module I18n
     end
 
     def interpolate_hash(string, values)
-      string.gsub(INTERPOLATION_PATTERN) do |match|
+      string.gsub(Regexp.union(config.interpolation_patterns)) do |match|
         if match == '%%'
           '%'
         else

data/lib/i18n/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: i18n
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Sven Fuchs
@@ -13,7 +13,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-14 00:00:00.000000000 Z
+date: 2018-12-11 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
@@ -89,48 +83,6 @@ 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.yaml
-- 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
 licenses:
 - MIT
@@ -139,7 +91,19 @@ metadata:
   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: 
+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.x and Rails (< 6.0), 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

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'