translations_sync 0.4.5 → 0.4.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 568de929f677b238fe1cbe0064c74295bfcf55bf
-  data.tar.gz: 905cdc5a32efc20b15af73b58e292e2c9eecfb6b
+  metadata.gz: 42096ed5df2d1d00a7071691ae3f9b61348b565b
+  data.tar.gz: b84217b76307b0ce2102ac99a906739f96d51e5b
 SHA512:
-  metadata.gz: 26efd03cae3981f5a104140e3b05d77295f4cdd6dbb77a2f8d37ae5170f19a889181b9503c55477e404e87c9f59af89f348126badd09b8c1def44db5d4ecd279
-  data.tar.gz: ecc6465b8d06fec02f5d45f8e5bb5aaeadc3539b0c500699e1f2daf9c7a9ed5de24cb9993b409975450e864991bcca65a20d77cee21d7cdfa26c2d215015bcfd
+  metadata.gz: 12153a22337d9e26444b2721904993537ce3451bc52f83b72effd6626a561f5804d1c198d85899a2b39f15568038dc22fcb06582633d6f5207c33ae294137fdd
+  data.tar.gz: 66f9a4a78afaf838b40498665ef4057483fade91cc2a07d020d5f056faa3fe090f83567280075993fe37529eaca0b5a7c0f2b91fa614dfef04476c468f5e7848

data/Changelog

@@ -1,3 +1,16 @@
+2016-06-17 v.0.4.7
+* Parameter IGNORE is added
+* Documentation is refised
+
+2016-06-17 v.0.4.6
+* The locale may be not only suffix, but also directory
+
+2014-12-19 v.0.4.5
+* Ignore gem faker and use I18n.available_locales as default list of locales
+
+2014-12-19 v.0.4.4
+* skipped
+
 2014-05-20 v.0.4.3
 * Dot can be used as separator between name and locale instead of underscore
 

data/README

@@ -1,74 +1,99 @@
 TranslationsSync
 ================
 
-This plugin is intended to help the developer to synchronize the different locales for
-the project that uses yaml based locales, in particular, I18n.
+This gem is intended to help the developer to synchronize the different
+locales for the project that uses yaml based locales, in particular, I18n.
 
 
 Requirements
-============
-
-gem 'ya2yaml'
+------------
 
+    gem 'ya2yaml'
+    gem 'active_support'
 
 Installation
-============
+------------
+
+1. Add to your Gemfile
 
-1. As plugin
-  rails plugin install http://github.com/dima4p/translations_sync/
+    gem 'translations_sync'
 
-2. As gem: add to your Gemfile
-  gem 'translations_sync'
+2. If you are using the gem without bundle just install it
 
-3. If you are using the gem outside rails, execute the following command to copy
-the rake file into your project's directory lib/tasks.
+    gem install translations_sync
 
-  bundle exec translations_sync
+Then execute the following command to copy the rake file into your
+project's directory lib/tasks.
 
-Or, if you keep your rake tesks in other place, you can give the argument with the proper path
+    translations_sync
 
-  bundle exec translations_sync path/to/directory
+Or, if you keep your rake tasks in other place, you can give the argument
+with the proper path
+
+    translations_sync path/to/directory
 
 
 Description
-===========
-
-There are two rake tasks implemented in the plugin.
-
-1. rake translations:sync
-
-This task generates the files with missing translations in the directory
-config/locales. One file per a locale is created with the name missing_#{locale}.yml
-Each file contains the text of one of the existing locales, namely the first one
-existing. The order to check is defined by the LIST parameter.
-This parameter can also be used to add a new locale. If it is not given I18n.available_locales will be used.
-The parameter EXCLUDE may be used to extract one or more locales from the participation
-in the process. If any locale is mentioned in both lists, it will not participate in the
-calculation of the missing translations but it's value may be used in the sample
-translation.
-The parameter NAME allows you to write the missing translations to the specified
-files instead of default 'missing'.
-The parameter SOURCE allows you to restrict the synchronization to be done within
-only one file name. Only the files for all the locales that meet the given name
-will be loaded for the synchronization.
-The parameter IN sets both NAME and SOURCE to its value.
-
-2. rake translations:singles
+-----------
+
+This gem allows different organizations of translation files. They can be
+grouped in the directories that correspond to locales, or the locale
+may be defined in the suffix of a file name separated by a dot or underscore.
+Let us call the file name without locale suffix and extension as
+**base name**
+
+When a file name is to be given as parameter in the description below
+it should not include nor locale prefix, nor locale suffix and extension
+whichever organization is used.
+
+The main goal of the gem to assist in managing the translations for the
+project. This can be done by using the `rake` tasks described below.
+
+The following parameters can be given:
+
+* `LIST=comma,separated,list` specifies the locales that should
+participate in synchronization.
+For example, `LIST=en,de,fr,zh-CN`
+If omitted, I18n.available_locales will be used.
+The order of the locales is important as the existing for the first
+locale in the list will be provided for a missing translation(s).
+The locale in LIST must not be present in I18n.available_locales.
+This allows easily to add new locales to the project.
+* `EXCLUDE=comma,separated,list` specifies the locales that should NOT participate.
+* `NAME=name`. By default missing translations are written to the
+**base name** "missing".
+This parameter tells to use the given name as **base name**.
+If any of the corresponding files exist, the missing translations will
+be added to them.
+* `SOURCE=name`. Only files with the given **base name** will be considered.
+* `IN=name`. It is equivalent to `NAME=name SOURCE=name`
+* `KEY=path.to.key`. Points to the key to be moved or removed.
+Obviously, it should not include locale.
+* `TO=path.to.key`.
+
+Rake tasks
+----------
+
+### rake translations:sync
+
+This task verifies that all the translation keys are present in all
+files specifed by the given parameters and if any is missing creates/updates
+corresponding file(s).
+
+### rake translations:singles
 
 This task generates a single file config/locales/singles.yml that contains the
-translations occuring only in one locale.
+translations occurring only in one locale.
 
-3. rake translations:move KEY=key.to.move TO=where.to.move
+### rake translations:move KEY=key.to.move TO=where.to.move
 
 This task moves the content of given KEY under the TO.
-You can use all the parameters available for the translations:sync task with the default
-value for the NAME equal to 'moved'.
-
-4. rake translations:remove KEY=key.to.remove
+You can use all the parameters available for the translations:sync task
+with the default value for the NAME equal to 'moved'.
 
-This task removes the key from the translations. NAME defalts to 'removed' here.
+### rake translations:remove KEY=key.to.remove
 
-So far it works only for rails applications. Suggestions for others are welcome.
+This task removes the key from the translations. NAME defaults to 'removed' here.
 
 
-Copyright (c) 2010-2011 Dmitri Koulikoff, released under the MIT license
+Copyright (c) 2010-2016 Dmitri Koulikoff, released under the MIT license

data/Rakefile

@@ -6,7 +6,7 @@ require 'rubygems/specification'
 require 'date'
 
 GEM = "translations_sync"
-GEM_VERSION = "0.4.5"
+GEM_VERSION = "0.4.7"
 AUTHOR = "Dmitri Koulikoff"
 EMAIL = "koulikoff@gmail.com"
 HOMEPAGE = "http://github.com/dima4p/translations_sync/"

data/lib/tasks/translations_sync.rake

@@ -5,13 +5,19 @@ namespace :translations do
 
   def get_ts(skip_source = false)
     source = skip_source ? nil : ENV['SOURCE'] || ENV['IN']
-    TranslationsSync.new ENV['LIST'], ENV['EXCLUDE'], source
+    params = {}
+    params[:list] = ENV['LIST']
+    params[:exclude] = ENV['EXCLUDE']
+    params[:source] = ENV['SOURCE'] || ENV['IN'] unless skip_source
+    params[:ignore] = ENV['IGNORE']
+    TranslationsSync.new params
   end
 
-  def save_files(translations, default_name, separator = '_')
+  def save_moved_files(ts, default_name)
+    translations = ts.moved
     name = ENV['NAME'] || ENV['IN'] || default_name
     translations.keys.sort.each do |lang|
-      filename = File.join Rails.root, 'config', 'locales', "#{name}#{separator}#{lang}.yml"
+      filename = ts.filename_for name, lang
       print filename + ' ...  '
       if File.exist? filename
         status = 'updated'
@@ -30,8 +36,7 @@ namespace :translations do
     ts = get_ts
     name = ENV['NAME'] || ENV['IN'] || 'missing'
     ts.missing.keys.sort.each do |lang|
-      filename = File.join Rails.root, 'config', 'locales',
-                           "#{name}#{ts.separator}#{lang}.yml"
+      filename = ts.filename_for name, lang
       print filename + ' ...  '
       if File.exist? filename
         hash = YAML::load(File.open(filename))
@@ -52,7 +57,7 @@ namespace :translations do
   desc "Detects the translations existing only in one locale" + PARAMS
   task :singles => :environment do
     ts = get_ts false
-    filename = File.join Rails.root, 'config', 'locales', "singles.yml"
+    filename = ts.filename_for 'singles', nil
     if ts.singles.size > 0
       File.open(filename, "w") do |file|
         file.write(TranslationsSync.to_yaml ts.singles)
@@ -66,9 +71,10 @@ namespace :translations do
   desc "Moves the key in the translations" + PARAMS + " KEY=key.to.move TO=where.to.move IN=filespec"
   task :move => :environment do
     key = ENV['KEY'] or raise "Parameter KEY must be given"
+    to  = ENV['TO']  or raise "Parameter TO must be given"
     ts = get_ts
-    if ts.move key, ENV['TO']
-      save_files ts.moved, 'moved', ts.separator
+    if ts.move key, to
+      save_moved_files ts, 'moved'
     else
       puts "The key \"#{key}\" was not found"
     end
@@ -79,7 +85,7 @@ namespace :translations do
     key = ENV['KEY'] or raise "Parameter KEY must be given"
     ts = get_ts
     if ts.remove key
-      save_files ts.moved, 'removed', ts.separator
+      save_moved_files ts, 'removed'
     else
       puts "The key \"#{key}\" was not found"
     end

data/lib/translations_sync.rb

@@ -1,6 +1,7 @@
 # encoding: utf-8
 require 'ya2yaml'
 require 'i18n'
+require 'active_support/hash_with_indifferent_access'
 
 class Hash
   def stringify_keys!
@@ -22,6 +23,7 @@ end
 class TranslationsSync
 
   attr_accessor :translations, :list
+  attr_reader :flat
   EXCLUDE_LIST = ''
   TAIL = '=TODO'
   PKORDER = {'zero' => 0, 'one' => 1, 'two' => 2, 'few' => 3, 'many' => 5, 'other' => 9}
@@ -53,9 +55,17 @@ class TranslationsSync
     end
   end   # class << self
 
-  def initialize(list = nil, exclude = nil, source = nil)
-    I18n.backend.send(:init_translations) unless I18n.backend.initialized?
-    translations = I18n.backend.send :translations
+  def initialize(*args)
+    params = args.pop if args.last.is_a? Hash
+    params = (params || {}).with_indifferent_access
+    unless args.size == 0
+      list, exclude, source = agrs
+      puts 'Deprecation warning: a Hash should be used to pass paramteters'
+    end
+    list ||= params[:list]
+    exclude ||= params[:exclude]
+    source ||= params[:source]
+    ignore = params[:ignore]
     @full_list = list ? list.split(',').map(&:to_sym) : I18n.available_locales
     @full_list = @full_list.uniq
     exclude = (exclude || EXCLUDE_LIST).split(',').map(&:to_sym)
@@ -79,20 +89,29 @@ class TranslationsSync
       acc
     end
 
+    translations_path_re = Regexp.new "#{translations_dir}(\\/[a-z]{2}(?:-[A-Z]{2})?)?\\/[-_/0-9a-zA-Z]+(?:(_|.)[a-z]{2}(?:-[A-Z]{2})?)?\\.(?:yml|rb)\\Z"
+    I18n.load_path.find do  |path|
+      path.match translations_path_re
+    end
+    @prefix = $1 or @separator = $2
+
     if source
-      re = Regexp.new "\\/#{Regexp.escape source}(_|.)[a-z]{2}(-[A-Z]{2})?\\.(yml|rb)\\Z"
+      translations_path_re = Regexp.new "#{translations_dir}(\\/[a-z]{2}(?:-[A-Z]{2})?)?\\/#{Regexp.escape source}(?:(_|.)[a-z]{2}(?:-[A-Z]{2})?)?\\.(?:yml|rb)\\Z"
       I18n.load_path.reject! do |path|
-        path !~ re
+        path !~ translations_path_re
       end
-      @separator = $1 == '.' ? '.' : '_'
-      translations.each do |key, hash|
-        hash.keys.each do |k|
-          hash.delete(k) unless k == :pluralize
-        end
+    end
+
+    if ignore
+      translations_path_re = Regexp.new "#{translations_dir}#{'\\/[^/]+' if @prefix}\\/#{Regexp.escape ignore}"
+      I18n.load_path.reject! do |path|
+        path =~ translations_path_re
       end
-      I18n.backend.send(:init_translations)
     end
 
+    I18n.reload!
+    I18n.backend.send(:init_translations)
+    translations = I18n.backend.send :translations
     @flat = {}
     @list.each do |lang|
       flatten_keys(lang, translations[lang] || {}, @flat)
@@ -108,7 +127,7 @@ class TranslationsSync
     unless @locales_with_missing
       size = list.size
       @locales_with_missing = []
-      @flat.each_pair do |key, val|
+      flat.each_pair do |key, val|
         if val.size < size
           (@locales_with_missing += list - val.keys).uniq!
           break if @locales_with_missing.size == size
@@ -124,7 +143,7 @@ class TranslationsSync
       locales_with_missing.each do |lang|
         @missing[lang] = {}
       end
-      @flat.each_pair do |key, val|
+      flat.each_pair do |key, val|
         (locales_with_missing - val.keys).each do |lang|
           push_to_hash @missing[lang], lang, key, val, :missing
         end
@@ -138,7 +157,7 @@ class TranslationsSync
     unless @locales_with_singles
       size = list.size
       @locales_with_singles = []
-      @flat.each_pair do |key, val|
+      flat.each_pair do |key, val|
         if val.size < size
           (@locales_with_singles += val.keys).uniq! if val.size == 1
           break if @locales_with_singles.size == size
@@ -154,7 +173,7 @@ class TranslationsSync
       locales_with_singles.each do |lang|
         @singles[lang] = {}
       end
-      @flat.each_pair do |key, val|
+      flat.each_pair do |key, val|
         lang = val.keys.first
         push_to_hash @singles[lang], lang, key, val, :singles if val.size == 1
       end
@@ -170,14 +189,17 @@ class TranslationsSync
     destination ||= ''
     destination = destination.split('.').map(&:to_sym)
     destination << key.last if destination.size == 0
+    puts "key=#{key.inspect} destination=#{destination.inspect}"
     result = false
-    @flat.each_pair do |array, val|
+    flat.each_pair do |array, val|
       if array[0, key_length] == key
         array[0, key_length] = destination
+        puts array.inspect
         result = true
       end
     end
     @moved = nil
+    puts result
     result
   end
 
@@ -187,7 +209,8 @@ class TranslationsSync
       @list.each do |lang|
         @moved[lang] = {}
       end
-      @flat.each_pair do |key, val|
+      flat.each_pair do |key, val|
+        puts key.inspect
         val.keys.each do |lang|
           push_to_hash @moved[lang], lang, key, val, :moved
         end
@@ -204,7 +227,7 @@ class TranslationsSync
     key = key.split('.').map(&:to_sym)
     key_length = key.length
     result = false
-    @flat.reject! do |array, val|
+    flat.reject! do |array, val|
       r = array[0, key_length] == key
       result ||= r
       r
@@ -213,8 +236,16 @@ class TranslationsSync
     result
   end
 
-  def separator
-    @separator || '_'
+  def filename_for(name, lang = nil)
+    if lang
+      if @prefix
+        "#{translations_dir}/#{lang}/#{name}.yml"
+      else
+        "#{translations_dir}/#{name}#{@separator}#{lang}.yml"
+      end
+    else
+      "#{translations_dir}/#{name}.yml"
+    end
   end
 
   private
@@ -277,11 +308,28 @@ class TranslationsSync
       value.stringify_keys! if value.is_a? Hash
       h[key.to_s] = value
     when :moved
-      value = val[target] or raise 'The translations are not synchronized'
+      value = val[target]
+      raise "The translations are not synchronized for #{keys.inspect}" if value.nil?
       value.stringify_keys! if value.is_a? Hash
       h[key.to_s] = value
     end
     keys.push key
   end
 
+  def translations_dir
+    @translations_dir ||=
+        common_prefix(I18n.config.load_path.grep Regexp.new FileUtils.pwd)
+  end
+
+  def common_prefix(paths)
+    return '' if paths.empty?
+    return paths.first.split('/').slice(0...-1).join('/') if paths.length <= 1
+    arr = paths.sort
+    first = arr.first.split('/')
+    last = arr.last.split('/')
+    i = 0
+    i += 1 while first[i] == last[i] && i <= first.length
+    first.slice(0, i).join('/')
+  end
+
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: translations_sync
 version: !ruby/object:Gem::Version
-  version: 0.4.5
+  version: 0.4.7
 platform: ruby
 authors:
 - Dmitri Koulikoff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-19 00:00:00.000000000 Z
+date: 2016-06-17 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: ya2yaml
   requirement: !ruby/object:Gem::Requirement
@@ -61,8 +75,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: Synchronizes the different locales represeinted in yaml for I18n
+summary: Synchronizes the different locales translations represeinted in yaml for
+  I18n
 test_files: []