fast_gettext 1.8.0 → 2.3.0

data/lib/fast_gettext/storage.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'fast_gettext/cache'
 
 module FastGettext
@@ -12,11 +14,15 @@ module FastGettext
       end
     end
 
+    DEFAULT_PLURALIZATION_RULE = ->(i) { i != 1 }
+
     [:available_locales, :_locale, :text_domain, :pluralisation_rule].each do |method_name|
-      key = "fast_gettext_#{method_name}".to_sym
-      define_method "#{method_name}=" do |value|
-        switch_cache if Thread.current[key] != Thread.current[key]=value
-      end
+      key = "fast_gettext_#{method_name}"
+      eval <<-RUBY, nil, __FILE__, __LINE__ + 1 # rubocop:disable Security/Eval
+        def #{method_name}=(value)
+          switch_cache if Thread.current[:#{key}] != Thread.current[:#{key}] = value
+        end
+      RUBY
     end
 
     def _locale
@@ -24,11 +30,11 @@ module FastGettext
     end
     private :_locale, :_locale=
 
-
     def available_locales
       locales = Thread.current[:fast_gettext_available_locales] || default_available_locales
       return unless locales
-      locales.map{|s|s.to_s}
+
+      locales.map(&:to_s)
     end
 
     # cattr_accessor with defaults
@@ -37,7 +43,7 @@ module FastGettext
       [:default_text_domain, "nil"],
       [:cache_class, "FastGettext::Cache"]
     ].each do |name, default|
-      eval <<-Ruby
+      eval <<-RUBY, nil, __FILE__, __LINE__ + 1 # rubocop:disable Security/Eval
         @@#{name} = #{default}
         def #{name}=(value)
           @@#{name} = value
@@ -47,7 +53,7 @@ module FastGettext
         def #{name}
           @@#{name}
         end
-      Ruby
+      RUBY
     end
 
     def text_domain
@@ -57,7 +63,7 @@ module FastGettext
     # if overwritten by user( FastGettext.pluralisation_rule = xxx) use it,
     # otherwise fall back to repo or to default lambda
     def pluralisation_rule
-      Thread.current[:fast_gettext_pluralisation_rule] ||  current_repository.pluralisation_rule || lambda{|i| i!=1}
+      Thread.current[:fast_gettext_pluralisation_rule] || current_repository.pluralisation_rule || DEFAULT_PLURALIZATION_RULE
     end
 
     def cache
@@ -69,8 +75,8 @@ module FastGettext
       translation_repositories.values.each(&:reload)
     end
 
-    #global, since re-parsing whole folders takes too much time...
-    @@translation_repositories={}
+    # global, since re-parsing whole folders takes too much time...
+    @@translation_repositories = {} # rubocop:disable Style/ClassVars
     def translation_repositories
       @@translation_repositories
     end
@@ -97,7 +103,7 @@ module FastGettext
     end
 
     def locale
-      _locale || ( default_locale || (available_locales||[]).first || 'en' )
+      _locale || (default_locale || (available_locales || []).first || 'en')
     end
 
     def locale=(new_locale)
@@ -107,15 +113,15 @@ module FastGettext
     # for chaining: puts set_locale('xx') == 'xx' ? 'applied' : 'rejected'
     # returns the current locale, not the one that was supplied
     # like locale=(), whoes behavior cannot be changed
-    def set_locale(new_locale)
+    def set_locale(new_locale) # rubocop:disable Naming/AccessorMethodName
       new_locale = best_locale_in(new_locale)
       self._locale = new_locale
       locale
     end
 
-    @@default_locale = nil
+    @@default_locale = nil # rubocop:disable Style/ClassVars
     def default_locale=(new_locale)
-      @@default_locale = best_locale_in(new_locale)
+      @@default_locale = best_locale_in(new_locale) # rubocop:disable Style/ClassVars
       switch_cache
     end
 
@@ -123,17 +129,17 @@ module FastGettext
       @@default_locale
     end
 
-    #Opera: de-DE,de;q=0.9,en;q=0.8
-    #Firefox de-de,de;q=0.8,en-us;q=0.5,en;q=0.3
-    #IE6/7 de
-    #nil if nothing matches
+    # Opera: de-DE,de;q=0.9,en;q=0.8
+    # Firefox de-de,de;q=0.8,en-us;q=0.5,en;q=0.3
+    # IE6/7 de
+    # nil if nothing matches
     def best_locale_in(locales)
       formatted_sorted_locales(locales).each do |candidate|
-        return candidate if not available_locales
+        return candidate unless available_locales
         return candidate if available_locales.include?(candidate)
-        return candidate[0..1] if available_locales.include?(candidate[0..1])#available locales include a langauge
+        return candidate[0..1] if available_locales.include?(candidate[0..1]) # available locales include a langauge
       end
-      return nil#nothing found im sorry :P
+      nil # nothing found im sorry :P
     end
 
     # temporarily switch locale for a block
@@ -146,27 +152,27 @@ module FastGettext
       set_locale current_locale
     end
 
-    #turn off translation if none was defined to disable all resulting errors
+    # turn off translation if none was defined to disable all resulting errors
     def silence_errors
       require 'fast_gettext/translation_repository/base'
-      translation_repositories[text_domain] ||= TranslationRepository::Base.new('x', :path => 'locale')
+      translation_repositories[text_domain] ||= TranslationRepository::Base.new('x', path: 'locale')
     end
 
     private
 
     # de-de,DE-CH;q=0.9 -> ['de_DE','de_CH']
     def formatted_sorted_locales(locales)
-      found = weighted_locales(locales).reject{|x|x.empty?}.sort_by{|l|l.last}.reverse #sort them by weight which is the last entry
-      found.flatten.map{|l| format_locale(l)}
+      found = weighted_locales(locales).reject(&:empty?).sort_by(&:last).reverse # sort them by weight which is the last entry
+      found.flatten.map { |l| format_locale(l) }
     end
 
-    #split the locale and seperate it into different languages
-    #de-de,de;q=0.9,en;q=0.8 => [['de-de','de','0.5'], ['en','0.8']]
+    # split the locale and seperate it into different languages
+    # de-de,de;q=0.9,en;q=0.8 => [['de-de','de','0.5'], ['en','0.8']]
     def weighted_locales(locales)
-      locales = locales.to_s.gsub(/\s/,'')
+      locales = locales.to_s.gsub(/\s/, '')
       found = [[]]
       locales.split(',').each do |part|
-        if part =~ /;q=/ #contains language and weight ?
+        if part.include? ';q=' # contains language and weight ?
           found.last << part.split(/;q=/)
           found.last.flatten!
           found << []
@@ -177,9 +183,9 @@ module FastGettext
       found
     end
 
-    #de-de -> de_DE
+    # de-de -> de_DE
     def format_locale(locale)
-      locale.sub(/^([a-zA-Z]{2,3})[-_]([a-zA-Z]{2,3})$/){$1.downcase+'_'+$2.upcase}
+      locale.sub(/^([a-zA-Z]{2,3})[-_]([a-zA-Z]{2,3})$/) { $1.downcase + '_' + $2.upcase }
     end
 
     def switch_cache

data/lib/fast_gettext/translation.rb

@@ -1,4 +1,9 @@
+# frozen_string_literal: true
+
 module FastGettext
+  TRANSLATION_METHODS = [:_, :n_, :s_, :p_, :ns_, :np_].freeze
+  NIL_BLOCK = -> { nil }
+
   # this module should be included
   # Responsibility:
   #  - direct translation queries to the current repository
@@ -6,153 +11,114 @@ module FastGettext
   #  - understand / enforce namespaces
   #  - decide which plural form is used
   module Translation
-    extend self
-
-    #make it usable in class definition, e.g.
-    # class Y
-    #   include FastGettext::Translation
-    #   @@x = _('y')
-    # end
-    def self.included(klas)  #:nodoc:
-      klas.extend self
-    end
-
-    def _(key, &block)
-      FastGettext.cached_find(key) or (block ? block.call : key)
+    def _(key)
+      FastGettext.cached_find(key) || (block_given? ? yield : key)
     end
 
-    #translate pluralized
+    # translate pluralized
     # some languages have up to 4 plural forms...
     # n_(singular, plural, plural form 2, ..., count)
     # n_('apple','apples',3)
-    def n_(*keys, &block)
-      count = keys.pop
+    def n_(*keys, count)
       translations = FastGettext.cached_plural_find(*keys)
-
       selected = FastGettext.pluralisation_rule.call(count)
-      selected = (selected ? 1 : 0) unless selected.is_a? Numeric #convert booleans to numbers
+      selected = (selected ? 1 : 0) unless selected.is_a? Numeric # convert booleans to numbers
 
+      # If we have a translation return it
       result = translations[selected]
-      if result
-        result
-      elsif keys[selected]
-        _(keys[selected])
-      else
-        block ? block.call : keys.last
-      end
+      return result if result
+
+      # If we have a block always use it in place of a translation
+      return yield if block_given?
+
+      # Fall back to the best fit translated key if it's there
+      _(keys[selected] || keys.last)
     end
 
-    #translate with namespace, use namespect to find key
-    # 'Car','Tire' -> Tire if no translation could be found
-    # p_('Car','Tire') <=> s_('Car|Tire')
-    def p_(namespace, key, separator=nil, &block)
-      msgid = "#{namespace}#{separator||NAMESPACE_SEPARATOR}#{key}"
-      FastGettext.cached_find(msgid) or (block ? block.call : key)
+    # translate with namespace
+    # 'Car', 'Tire' -> Tire if no translation could be found
+    # p_('Car', 'Tire') == s_('Car|Tire')
+    def p_(namespace, key, separator = nil)
+      msgid = "#{namespace}#{separator || CONTEXT_SEPARATOR}#{key}"
+
+      translation = FastGettext.cached_find(msgid)
+      return translation if translation
+
+      block_given? ? yield : key
     end
 
-    #translate, but discard namespace if nothing was found
+    # translate, but discard namespace if nothing was found
     # Car|Tire -> Tire if no translation could be found
-    def s_(key, separator=nil, &block)
-      translation = FastGettext.cached_find(key) and return translation
-      block ? block.call : key.split(separator||NAMESPACE_SEPARATOR).last
+    def s_(key, separator = nil)
+      translation = FastGettext.cached_find(key)
+      return translation if translation
+
+      block_given? ? yield : key.split(separator || NAMESPACE_SEPARATOR).last
     end
 
-    #tell gettext: this string need translation (will be found during parsing)
+    # tell gettext: this string need translation (will be found during parsing)
     def N_(translate)
       translate
     end
 
-    #tell gettext: this string need translation (will be found during parsing)
+    # tell gettext: this string need translation (will be found during parsing)
     def Nn_(*keys)
       keys
     end
 
-    def ns_(*args, &block)
-      translation = n_(*args, &block)
-      # block is called once again to compare result
-      block && translation == block.call ? translation : translation.split(NAMESPACE_SEPARATOR).last
-    end
-  end
+    # translate pluralized with separator
+    def ns_(*args)
+      translation = n_(*args, &NIL_BLOCK)
+      return translation if translation
 
-  # this module should be included for multi-domain support
-  module TranslationMultidomain
-    extend self
-
-    #make it usable in class definition, e.g.
-    # class Y
-    #   include FastGettext::TranslationMultidomain
-    #   @@x = d_('domain', 'y')
-    # end
-    def self.included(klas)  #:nodoc:
-      klas.extend self
-    end
+      return yield if block_given?
 
-    # helper block for changing domains
-    def _in_domain domain
-      old_domain = FastGettext.text_domain
-      FastGettext.text_domain = domain
-      yield if block_given?
-    ensure
-      FastGettext.text_domain = old_domain
+      n_(*args).split(NAMESPACE_SEPARATOR).last
     end
 
-    # gettext functions to translate in the context of given domain
-    def d_(domain, key, &block)
-      _in_domain domain do
-        FastGettext::Translation._(key, &block)
-      end
-    end
-
-    def dn_(domain, *keys, &block)
-      _in_domain domain do
-        FastGettext::Translation.n_(*keys, &block)
-      end
-    end
+    # translate pluralized with context
+    def np_(context, plural_one, *args, separator: nil)
+      nargs = ["#{context}#{separator || CONTEXT_SEPARATOR}#{plural_one}"] + args
+      translation = n_(*nargs, &NIL_BLOCK)
+      return translation if translation
 
-    def ds_(domain, key, separator=nil, &block)
-      _in_domain domain do
-        FastGettext::Translation.s_(key, separator, &block)
-      end
-    end
-
-    def dns_(domain, *keys, &block)
-      _in_domain domain do
-        FastGettext::Translation.ns_(*keys, &block)
-      end
-    end
+      return yield if block_given?
 
-    # gettext functions to translate in the context of any domain
-    # (note: if mutiple domains contains key, random translation is returned)
-    def D_(key)
-      FastGettext.translation_repositories.each_key do |domain|
-        result = FastGettext::TranslationMultidomain.d_(domain, key) {nil}
-        return result unless result.nil?
-      end
-      key
+      n_(plural_one, *args)
     end
+  end
 
-    def Dn_(*keys)
-      FastGettext.translation_repositories.each_key do |domain|
-        result = FastGettext::TranslationMultidomain.dn_(domain, *keys) {nil}
-        return result unless result.nil?
-      end
-      keys[-3].split(keys[-2]||NAMESPACE_SEPARATOR).last
-    end
+  module TranslationAliased
+    include Translation
+    TRANSLATION_METHODS.each { |m| alias_method "#{m.to_s.delete('_')}gettext", m }
+  end
 
-    def Ds_(key, separator=nil)
-      FastGettext.translation_repositories.each_key do |domain|
-        result = FastGettext::TranslationMultidomain.ds_(domain, key, separator) {nil}
-        return result unless result.nil?
-      end
-      key.split(separator||NAMESPACE_SEPARATOR).last
-    end
+  # this module should be included for multi-domain support
+  module TranslationMultidomain
+    include Translation
 
-    def Dns_(*keys)
-      FastGettext.translation_repositories.each_key do |domain|
-        result = FastGettext::TranslationMultidomain.dns_(domain, *keys) {nil}
-        return result unless result.nil?
-      end
-      keys[-2].split(NAMESPACE_SEPARATOR).last
+    # gettext functions to translate in the context of given domain
+    TRANSLATION_METHODS.each do |method|
+      eval <<-RUBY, nil, __FILE__, __LINE__ + 1 # rubocop:disable Security/Eval
+        # translate in given domain
+        def d#{method}(domain, *args, &block)
+          FastGettext.with_domain(domain) { #{method}(*args, &block) }
+        end
+
+        # translate with whatever domain finds a translation
+        def D#{method}(*args, &block)
+          repos = FastGettext.translation_repositories
+          last = repos.size - 1
+          repos.each_key.each_with_index do |domain, i|
+            if i == last
+              return d#{method}(domain, *args, &block)
+            else
+              result = d#{method}(domain, *args, &NIL_BLOCK)
+              return result if result
+            end
+          end
+        end
+      RUBY
     end
   end
 end

data/lib/fast_gettext/translation_repository/base.rb

@@ -1,13 +1,14 @@
+# frozen_string_literal: true
+
 module FastGettext
   module TranslationRepository
     # Responsibility:
     #  - base for all repositories
     #  - fallback as empty repository, that cannot translate anything but does not crash
     class Base
-
       attr_reader :name, :options
 
-      def initialize(name,options={})
+      def initialize(name, options = {})
         @name = name
         @options = options
       end
@@ -38,17 +39,19 @@ module FastGettext
         MoFile.empty
       end
 
-      def find_files_in_locale_folders(relative_file_path,path)
+      def find_files_in_locale_folders(relative_file_path, path)
         path ||= "locale"
         raise "path #{path} could not be found!" unless File.exist?(path)
 
         @files = {}
-        Dir[File.join(path,'*')].each do |locale_folder|
+        Dir[File.join(path, '*')].each do |locale_folder|
           next unless File.basename(locale_folder) =~ LOCALE_REX
-          file = File.join(locale_folder,relative_file_path).untaint
+
+          file = File.join(locale_folder, relative_file_path)
           next unless File.exist? file
+
           locale = File.basename(locale_folder)
-          @files[locale] = yield(locale,file)
+          @files[locale] = yield(locale, file)
         end
       end
     end

data/lib/fast_gettext/translation_repository/chain.rb

@@ -1,32 +1,38 @@
+# frozen_string_literal: true
+
 require 'fast_gettext/translation_repository/base'
 
 module FastGettext
   module TranslationRepository
     # Responsibility:
     #  - delegate calls to members of the chain in turn
-    #TODO cache should be expired after a repo was added
+    # TODO cache should be expired after a repo was added
     class Chain < Base
       attr_accessor :chain
 
-      def initialize(name,options={})
+      def initialize(name, options = {})
         super
         self.chain = options[:chain]
       end
 
       def available_locales
-        chain.map{|c|c.available_locales}.flatten.uniq
+        chain.map(&:available_locales).flatten.uniq
       end
 
       def pluralisation_rule
         chain.each do |c|
-          result = c.pluralisation_rule and return result
+          if result = c.pluralisation_rule
+            return result
+          end
         end
         nil
       end
 
       def [](key)
         chain.each do |c|
-          result = c[key] and return result
+          if result = c[key]
+            return result
+          end
         end
         nil
       end

data/lib/fast_gettext/translation_repository/db.rb

@@ -1,4 +1,5 @@
-require 'active_record'
+# frozen_string_literal: true
+
 module FastGettext
   module TranslationRepository
     # Responsibility:
@@ -11,13 +12,14 @@ module FastGettext
     #     key: find_by_key, translations
     #     translation: text, locale
     class Db
-      def initialize(name,options={})
+      def initialize(_name, options = {})
         @model = options[:model]
       end
 
-      @@seperator = '||||' # string that seperates multiple plurals
-      def self.seperator=(sep);@@seperator = sep;end
-      def self.seperator;@@seperator;end
+      @separator = '||||' # string that separates multiple plurals
+      class << self
+        attr_accessor :separator
+      end
 
       def available_locales
         if @model.respond_to? :available_locales
@@ -28,11 +30,7 @@ module FastGettext
       end
 
       def pluralisation_rule
-        if @model.respond_to? :pluralsation_rule
-          @model.pluralsation_rule
-        else
-          nil
-        end
+        @model.pluralisation_rule if @model.respond_to? :pluralisation_rule
       end
 
       def [](key)
@@ -40,8 +38,8 @@ module FastGettext
       end
 
       def plural(*args)
-        if translation = @model.translation(args*self.class.seperator, FastGettext.locale)
-          translation.to_s.split(self.class.seperator)
+        if translation = @model.translation(args * self.class.separator, FastGettext.locale)
+          translation.to_s.split(self.class.separator)
         else
           []
         end
@@ -52,11 +50,12 @@ module FastGettext
       end
 
       def self.require_models
+        require 'active_record'
         folder = "fast_gettext/translation_repository/db_models"
         require "#{folder}/translation_key"
         require "#{folder}/translation_text"
         Module.new do
-          def self.included(base)
+          def self.included(_base)
             puts "you no longer need to include the result of require_models"
           end
         end

data/lib/fast_gettext/translation_repository/db_models/translation_key.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 class TranslationKey < ActiveRecord::Base
-  has_many :translations, :class_name => 'TranslationText', :dependent => :destroy
+  has_many :translations, class_name: 'TranslationText', dependent: :destroy
 
-  accepts_nested_attributes_for :translations, :allow_destroy => true
+  accepts_nested_attributes_for :translations, allow_destroy: true
 
   validates_uniqueness_of :key
   validates_presence_of :key
@@ -13,25 +15,26 @@ class TranslationKey < ActiveRecord::Base
   def self.translation(key, locale)
     return unless translation_key = find_by_key(newline_normalize(key))
     return unless translation_text = translation_key.translations.find_by_locale(locale)
+
     translation_text.text
   end
 
   def self.available_locales
-    @@available_locales ||= begin
+    @available_locales ||= begin
       if ActiveRecord::VERSION::MAJOR >= 3
         TranslationText.group(:locale).count
       else
-        TranslationText.count(:group=>:locale)
+        TranslationText.count(group: :locale)
       end.keys.sort
     end
   end
 
-  protected
-
-  def self.newline_normalize(s)
-    s.to_s.gsub("\r\n", "\n")
+  def self.newline_normalize(string)
+    string.to_s.gsub("\r\n", "\n")
   end
 
+  protected
+
   def normalize_newlines
     self.key = self.class.newline_normalize(key)
   end

data/lib/fast_gettext/translation_repository/db_models/translation_text.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 class TranslationText < ActiveRecord::Base
-  belongs_to :translation_key, :class_name => 'TranslationKey'
+  belongs_to :translation_key, class_name: 'TranslationKey'
   validates_presence_of :locale
-  validates_uniqueness_of :locale, :scope=>:translation_key_id
+  validates_uniqueness_of :locale, scope: :translation_key_id
   attr_accessible :text, :locale, :translation_key, :translation_key_id if ActiveRecord::VERSION::MAJOR == 3 || defined?(ProtectedAttributes)
   after_update :expire_cache
 

data/lib/fast_gettext/translation_repository/logger.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'fast_gettext/translation_repository/base'
 
 module FastGettext
@@ -8,7 +10,7 @@ module FastGettext
     class Logger < Base
       attr_accessor :callback
 
-      def initialize(name,options={})
+      def initialize(name, options = {})
         super
         self.callback = options[:callback]
       end
@@ -24,4 +26,4 @@ module FastGettext
       end
     end
   end
-end
+end