fast_gettext 1.6.0 → 2.1.0

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

data/lib/fast_gettext/translation_repository/merge.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'fast_gettext/translation_repository/po'
 
 module FastGettext
@@ -7,7 +9,7 @@ module FastGettext
     #  - 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={})
+      def initialize(name, options = {})
         clear
         super(name, options)
         options.fetch(:chain, []).each do |repo|
@@ -21,7 +23,9 @@ module FastGettext
 
       def pluralisation_rule
         @repositories.each do |r|
-          result = r.pluralisation_rule and return result
+          if result = r.pluralisation_rule
+            return result
+          end
         end
         nil
       end
@@ -45,6 +49,7 @@ module FastGettext
 
       def add_repo(repo)
         raise "Unsupported repository" unless repo_supported?(repo)
+
         @repositories << repo
         load_repo(repo)
         true
@@ -65,8 +70,8 @@ module FastGettext
         repo.respond_to?(:all_translations)
       end
 
-      def load_repo(r)
-        @data = r.all_translations.merge(@data)
+      def load_repo(repo)
+        @data = repo.all_translations.merge(@data)
       end
     end
   end

data/lib/fast_gettext/translation_repository/mo.rb

@@ -1,11 +1,15 @@
+# frozen_string_literal: true
+
 require 'fast_gettext/translation_repository/base'
 module FastGettext
   module TranslationRepository
-     # Responsibility:
+    # Responsibility:
     #  - find and store mo files
     #  - provide access to translations in mo files
     class Mo < Base
-      def initialize(name,options={})
+      CONTEXT_SEPARATOR = "\u0004"
+
+      def initialize(name, options = {})
         super
         @eager_load = options.fetch(:eager_load, false)
         reload
@@ -30,9 +34,9 @@ module FastGettext
 
       protected
 
-      def find_and_store_files(name,options)
+      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|
+        find_files_in_locale_folders(File.join('LC_MESSAGES', "#{name}.mo"), options[:path]) do |_locale, file|
           MoFile.new(file, eager_load: @eager_load)
         end
       end

data/lib/fast_gettext/translation_repository/po.rb

@@ -1,15 +1,18 @@
+# frozen_string_literal: true
+
 require 'fast_gettext/translation_repository/base'
 require 'fast_gettext/translation_repository/mo'
 module FastGettext
   module TranslationRepository
-     # Responsibility:
+    # Responsibility:
     #  - find and store po files
     #  - provide access to translations in po files
     class Po < Mo
       protected
+
       def find_and_store_files(name, options)
         require 'fast_gettext/po_file'
-        find_files_in_locale_folders("#{name}.po", options[:path]) do |locale,file|
+        find_files_in_locale_folders("#{name}.po", options[:path]) do |_locale, file|
           PoFile.new(file, options)
         end
       end

data/lib/fast_gettext/translation_repository/yaml.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'fast_gettext/translation_repository/base'
 require 'yaml'
 
@@ -7,7 +9,7 @@ module FastGettext
     #  - find and store yaml files
     #  - provide access to translations in yaml files
     class Yaml < Base
-      def initialize(name,options={})
+      def initialize(name, options = {})
         super
         reload
       end
@@ -23,7 +25,11 @@ module FastGettext
       end
 
       def pluralisation_rule
-        self['pluralisation_rule'] ? lambda{|n| eval(self['pluralisation_rule']) } : nil
+        return unless rule = self['pluralisation_rule']
+
+        ->(n) do # rubocop:disable Lint/UnusedBlockArgument n can be used from pluralisation_rule code
+          eval(rule) # rubocop:disable Security/Eval TODO remove eval
+        end
       end
 
       def reload
@@ -39,8 +45,12 @@ module FastGettext
         @files = {}
         path = options[:path] || 'config/locales'
         Dir["#{path}/*.yml"].each do |yaml_file|
-          locale = File.basename(yaml_file, '.yml')
-          @files[locale] = load_yaml(yaml_file, locale)
+          # Only take into account the last dot separeted part of the file name,
+          # excluding the extension file name
+          # that is, we suppose it to be named `qq.yml` or `foo.qq.yml` where
+          # `qq` stands for a locale name
+          locale = File.basename(yaml_file, '.yml').split('.').last
+          (@files[locale] ||= {}).merge! load_yaml(yaml_file, locale)
         end
       end
 
@@ -60,7 +70,7 @@ module FastGettext
 
       def add_yaml_key(result, prefix, hash)
         hash.each_pair do |key, value|
-          if value.kind_of?(Hash)
+          if value.is_a?(Hash)
             add_yaml_key(result, yaml_dot_notation(prefix, key), value)
           else
             result[yaml_dot_notation(prefix, key)] = value
@@ -69,7 +79,7 @@ module FastGettext
         result
       end
 
-      def yaml_dot_notation(a,b)
+      def yaml_dot_notation(a, b) # rubocop:disable Naming/UncommunicativeMethodParamName
         a ? "#{a}.#{b}" : b
       end
     end

data/lib/fast_gettext/translation_repository.rb

@@ -1,16 +1,16 @@
+# frozen_string_literal: true
+
 module FastGettext
   # Responsibility:
   #  - decide which repository to choose from given input
   module TranslationRepository
-    extend self
-
-    def build(name, options)
+    def self.build(name, options)
       type = options[:type] || :mo
       class_name = type.to_s.split('_').map(&:capitalize).join
-      unless FastGettext::TranslationRepository.constants.map{|c|c.to_s}.include?(class_name)
+      unless FastGettext::TranslationRepository.constants.map(&:to_s).include?(class_name)
         require "fast_gettext/translation_repository/#{type}"
       end
-      eval(class_name).new(name,options)
+      const_get(class_name).new(name, options)
     end
   end
 end

data/lib/fast_gettext/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module FastGettext
-  VERSION = Version = '1.6.0'
+  VERSION = Version = '2.1.0' # rubocop:disable Naming/ConstantName
 end

data/lib/fast_gettext.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'fast_gettext/mo_file'
 require 'fast_gettext/storage'
 require 'fast_gettext/translation'
@@ -6,30 +8,28 @@ require 'fast_gettext/vendor/string'
 require 'fast_gettext/version'
 
 module FastGettext
-  include FastGettext::Storage
-  extend self
+  extend FastGettext::Storage
+  extend FastGettext::Translation
 
-  LOCALE_REX =  /^[a-z]{2,3}$|^[a-z]{2,3}_[A-Z]{2,3}$/
+  LOCALE_REX = /^[a-z]{2,3}$|^[a-z]{2,3}_[A-Z]{2,3}$/.freeze
   NAMESPACE_SEPARATOR = '|'
+  CONTEXT_SEPARATOR = "\004"
 
-  # users should not include FastGettext, since this would contaminate their namespace
-  # rather use
-  # FastGettext.locale = ..
-  # FastGettext.text_domain = ..
-  # and
-  # include FastGettext::Translation
-  FastGettext::Translation.public_instance_methods.each do |method|
-    define_method method do |*args|
-      Translation.send(method,*args)
-    end
+  # helper block for changing domains
+  def self.with_domain(domain)
+    old_domain = FastGettext.text_domain
+    FastGettext.text_domain = domain
+    yield
+  ensure
+    FastGettext.text_domain = old_domain
   end
 
-  def add_text_domain(name,options)
-    translation_repositories[name] = TranslationRepository.build(name,options)
+  def self.add_text_domain(name, options)
+    translation_repositories[name] = TranslationRepository.build(name, options)
   end
 
   # some repositories know where to store their locales
-  def locale_path
+  def self.locale_path
     translation_repositories[text_domain].instance_variable_get(:@options)[:path]
   end
 end