fast_gettext 1.1.2 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 36f41bf872f76a6c0c9b26ba498a0fecc968c230
-  data.tar.gz: d5e0c0eaad54bb0b3d7853e23873bdaca80f9280
+  metadata.gz: f47483365d8998f016a8c092875a4b92cc281264
+  data.tar.gz: e3cdfa1fd0ca9ffc4b7ba397c10f7de01e6099d4
 SHA512:
-  metadata.gz: 228f8ed4f8ef424374fd922b6788576471ab3912b0535a1614ca560dd38ce240d2dd65138202f68f1f5eec120477967f67d12d63f495cd51622a6ea9a9c8f42c
-  data.tar.gz: dfa66187d06d380817522c75ac0903ef9fb9141773d6414a0748dd4c56e7239759367f0483b344a7ed8c35fb99cf69ea98efe839ed85b5a80c65e84469c276cd
+  metadata.gz: cf39c69120683117225d63aed75e3d4e451d89ef863edebee55055155b16dc5ed37413d183cd98e5edca4c63fe758652664f3afa0574c40a58eb70bc859a5280
+  data.tar.gz: 14ddb2652d36ce7b9f9dc22bdfbcc36341446d5e623b1df41f33087cd75507194b567aabd96cab384573c94344084122297846f7b920b84746b8ac1a25a79b8d

data/CHANGELOG

@@ -1,3 +1,4 @@
+1.1.0 -- translations are no longer eager loaded for improved startup performance, pass `eager_load: true` to preload for example in preforked web server
 1.0.0 -- do not enforce attr_accessible unless ProtectedAttributes are loaded
 0.9.0 -- reworked internals of caching to be plugable
 0.7.0 -- set_locale resets to default locale if none of the available locales was tried to set

data/Readme.md

@@ -50,24 +50,24 @@ Setup
 
 From mo files (traditional/default)
 
-    FastGettext.add_text_domain('my_app',:path => 'locale')
+    FastGettext.add_text_domain('my_app', path: 'locale')
 
 Or po files (less maintenance than mo)
 
-    FastGettext.add_text_domain('my_app',:path => 'locale', :type => :po)
+    FastGettext.add_text_domain('my_app', path: 'locale', type: :po)
     # :ignore_fuzzy => true to not use fuzzy translations
     # :report_warning => false to hide warnings about obsolete/fuzzy translations
 
 Or yaml files (use I18n syntax/indentation)
 
-    FastGettext.add_text_domain('my_app', :path => 'config/locales', :type => :yaml)
+    FastGettext.add_text_domain('my_app', path: 'config/locales', type: :yaml)
 
 Or database (scaleable, good for many locales/translators)
 
     # db access is cached <-> only first lookup hits the db
     require "fast_gettext/translation_repository/db"
     FastGettext::TranslationRepository::Db.require_models #load and include default models
-    FastGettext.add_text_domain('my_app', :type => :db, :model => TranslationKey)
+    FastGettext.add_text_domain('my_app', type: :db, model: TranslationKey)
 
 ### 3. Choose text domain and locale for translation
 Do this once in every Thread. (e.g. Rails -> ApplicationController)
@@ -83,7 +83,7 @@ Do this once in every Thread. (e.g. Rails -> ApplicationController)
     _('not-found') == 'not-found'
     s_('Namespace|not-found') == 'not-found'
     n_('Axis','Axis',3) == 'Achsen' #German plural of Axis
-    _('Hello %{name}!') % {:name => "Pete"} == 'Hello Pete!'
+    _('Hello %{name}!') % {name: "Pete"} == 'Hello Pete!'
 
 
 Managing translations
@@ -93,7 +93,7 @@ Generate .po or .mo files using GetText parser (example tasks at [gettext_i18n_r
 
 Tell Gettext where your .mo or .po files lie, e.g. for locale/de/my_app.po and locale/de/LC_MESSAGES/my_app.mo
 
-    FastGettext.add_text_domain('my_app',:path=>'locale')
+    FastGettext.add_text_domain('my_app', path: 'locale')
 
 Use the [original GetText](http://github.com/mutoh/gettext) to create and manage po/mo-files.
 (Work on a po/mo parser & reader that is easier to use has started, contributions welcome @ [get_pomo](http://github.com/grosser/get_pomo) )
@@ -116,9 +116,9 @@ Setting `available_locales`,`text_domain` or `locale` will not work inside the `
 since it runs in a different thread then e.g. controllers, so set them inside your application_controller.
 
     #environment.rb after initializers
-    Object.send(:include,FastGettext::Translation)
-    FastGettext.add_text_domain('accounting',:path=>'locale')
-    FastGettext.add_text_domain('frontend',:path=>'locale')
+    Object.send(:include, FastGettext::Translation)
+    FastGettext.add_text_domain('accounting', path: 'locale')
+    FastGettext.add_text_domain('frontend', path: 'locale')
     ...
 
     #application_controller.rb
@@ -165,19 +165,35 @@ You can use any number of repositories to find a translation. Simply add them to
 the first cannot translate a given key, the next is asked and so forth.
 
     repos = [
-      FastGettext::TranslationRepository.build('new', :path=>'....'),
-      FastGettext::TranslationRepository.build('old', :path=>'....')
+      FastGettext::TranslationRepository.build('new', path: '....'),
+      FastGettext::TranslationRepository.build('old', path: '....')
     ]
-    FastGettext.add_text_domain 'combined', :type=>:chain, :chain=>repos
+    FastGettext.add_text_domain 'combined', type: :chain, :chain: repos
+
+###Merge
+In some cases you can benefit from using merge repositories as an alternative to chains. They behave nearly the same. The difference is in the internal
+data structure. While chain repos iterate over the whole chain for each translation, merge repositories select and store the first translation at the time
+a subordinate repository is added. This puts the burden on the load phase and speeds up the translations.
+
+    repos = [
+      FastGettext::TranslationRepository.build('new', :path: '....'),
+      FastGettext::TranslationRepository.build('old', :path: '....')
+    ]
+    domain = FastGettext.add_text_domain 'combined', type: :merge, chain: repos
+
+Downside of this approach is that you have to reload the merge repo each time a language is changed.
+
+    FastGettext.locale = 'de'
+    domain.reload
 
 ###Logger
 When you want to know which keys could not be translated or were used, add a Logger to a Chain:
 
     repos = [
-      FastGettext::TranslationRepository.build('app', :path=>'....')
-      FastGettext::TranslationRepository.build('logger', :type=>:logger, :callback=>lambda{|key_or_array_of_ids| ... }),
+      FastGettext::TranslationRepository.build('app', path: '....')
+      FastGettext::TranslationRepository.build('logger', type: :logger, callback: lambda{|key_or_array_of_ids| ... }),
     }
-    FastGettext.add_text_domain 'combined', :type=>:chain, :chain=>repos
+    FastGettext.add_text_domain 'combined', type: :chain, chain: repos
 
 If the Logger is in position #1 it will see all translations, if it is in position #2 it will only see the unfound.
 Unfound may not always mean missing, if you choose not to translate a word because the key is a good translation, it will appear nevertheless.
@@ -223,6 +239,8 @@ order (depends on the Ruby hash implementation):
     D_("string") # finds 'string' in any domain
     # etc.
 
+Alternatively you can use [merge repository](https://github.com/grosser/fast_gettext#merge) to achieve the same behaviour.
+
 FAQ
 ===
  - [Problems with ActiveRecord messages?](http://wiki.github.com/grosser/fast_gettext/activerecord)

data/lib/fast_gettext/mo_file.rb

@@ -30,17 +30,17 @@ module FastGettext
       nil
     end
 
+    def data
+      load_data if @data.nil?
+      @data
+    end
+
     def self.empty
       MoFile.new(File.join(File.dirname(__FILE__),'vendor','empty.mo'))
     end
 
     private
 
-    def data
-      load_data if @data.nil?
-      @data
-    end
-
     def load_data
       @data = if @filename.is_a? FastGettext::GetText::MOFile
         @filename

data/lib/fast_gettext/po_file.rb

@@ -32,7 +32,7 @@ module FastGettext
       parser.report_warning = options.fetch(:report_warning, true)
 
       mo_file = FastGettext::GetText::MOFile.new
-      parser.parse_file(file, mo_file)
+      parser.parse(File.read(file), mo_file)
       mo_file
     end
   end

data/lib/fast_gettext/translation_repository/merge.rb

@@ -0,0 +1,73 @@
+require 'fast_gettext/translation_repository/po'
+
+module FastGettext
+  module TranslationRepository
+    # Responsibility:
+    #  - merge data from multiple repositories into one hash structure
+    #  - can be used instead of searching for translations in multiple domains
+    #  - requires reload when current locale is changed
+    class Merge < Base
+      def initialize(name, options={})
+        clear
+        super(name, options)
+        options.fetch(:chain, []).each do |repo|
+          add_repo(repo)
+        end
+      end
+
+      def available_locales
+        @repositories.flat_map(&:available_locales).uniq
+      end
+
+      def pluralisation_rule
+        @repositories.each do |r|
+          result = r.pluralisation_rule and return result
+        end
+        nil
+      end
+
+      def plural(*keys)
+        @repositories.each do |r|
+          result = r.plural(*keys)
+          return result unless result.compact.empty?
+        end
+        []
+      end
+
+      def reload
+        @data = {}
+        @repositories.each do |r|
+          r.reload
+          load_repo(r)
+        end
+        super
+      end
+
+      def add_repo(repo)
+        raise "Unsupported repository" unless repo_supported?(repo)
+        @repositories << repo
+        load_repo(repo)
+        true
+      end
+
+      def [](key)
+        @data[key]
+      end
+
+      def clear
+        @repositories = []
+        @data = {}
+      end
+
+      protected
+
+      def repo_supported?(repo)
+        repo.respond_to?(:all_translations)
+      end
+
+      def load_repo(r)
+        @data = r.all_translations.merge(@data)
+      end
+    end
+  end
+end

data/lib/fast_gettext/translation_repository/mo.rb

@@ -24,12 +24,16 @@ module FastGettext
         super
       end
 
+      def all_translations
+        current_translations.data
+      end
+
       protected
 
       def find_and_store_files(name,options)
         # parse all .mo files with the right name, that sit in locale/LC_MESSAGES folders
         find_files_in_locale_folders(File.join('LC_MESSAGES',"#{name}.mo"), options[:path]) do |locale,file|
-          MoFile.new(file, :eager_load => @eager_load)
+          MoFile.new(file, eager_load: @eager_load)
         end
       end
 

data/lib/fast_gettext/vendor/poparser.rb

@@ -133,7 +133,7 @@ module GetText
 
   def parse_file(po_file, data)
     args = [ po_file ]
-    # We should not try to detect the string encoding in Ruby 1.8
+    # In Ruby 1.9, we must detect proper encoding of a PO file.
     if String.instance_methods.include?(:encode)
       encoding = detect_file_encoding(po_file)
       args << "r:#{encoding}"
@@ -144,7 +144,7 @@ module GetText
 
   def detect_file_encoding(po_file)
     open(po_file, :encoding => 'ASCII-8BIT') do |input|
-      input.each_line do |line|
+      input.lines.each do |line|
         return Encoding.find($1) if %r["Content-Type:.*\scharset=(.*)\\n"] =~ line
       end
     end

data/lib/fast_gettext/version.rb

@@ -1,3 +1,3 @@
 module FastGettext
-  VERSION = Version = '1.1.2'
+  VERSION = Version = '1.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fast_gettext
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.2.0
 platform: ruby
 authors:
 - Michael Grosser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-18 00:00:00.000000000 Z
+date: 2016-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -129,6 +129,7 @@ files:
 - lib/fast_gettext/translation_repository/db_models/translation_key.rb
 - lib/fast_gettext/translation_repository/db_models/translation_text.rb
 - lib/fast_gettext/translation_repository/logger.rb
+- lib/fast_gettext/translation_repository/merge.rb
 - lib/fast_gettext/translation_repository/mo.rb
 - lib/fast_gettext/translation_repository/po.rb
 - lib/fast_gettext/translation_repository/yaml.rb
@@ -139,7 +140,7 @@ files:
 - lib/fast_gettext/vendor/poparser.rb
 - lib/fast_gettext/vendor/string.rb
 - lib/fast_gettext/version.rb
-homepage: http://github.com/grosser/fast_gettext
+homepage: https://github.com/grosser/fast_gettext
 licenses:
 - MIT
 - Ruby
@@ -152,7 +153,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -160,7 +161,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: A simple, fast, memory-efficient and threadsafe implementation of GetText