translations_sync 0.2.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 [name of plugin creator]
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -0,0 +1,66 @@
+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.
+
+
+Requirements
+============
+
+gem 'ya2yaml'
+
+
+Installation
+============
+
+1. As plugin
+  rails plugin install http://github.com/dima4p/translations_sync/
+
+2. As gem
+  sudo gem install translations_sync
+  translations_sync
+
+
+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.
+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 task generates a single file config/locales/singles.yml that contains the
+translations occuring only in one locale.
+
+3. rake translations:move KEY=key.to.move TO=where.to.move
+
+This task moves the given KEY under the TO. Please note, that the TO
+must not have the last part of the KEY at the end.
+You can use all the parameters available for the translations:sync task with the default
+value for the NAME equal to 'moved'.
+In order to overwrite the existing file both NAME and SOURCE should be given
+with the same value. For that there is the parameter IN that sets both values.
+
+
+So far it works only for rails applications. Suggestions for others are welcome.
+
+
+Copyright (c) 2010-2011 Dmitri Koulikoff, released under the MIT license

data/Rakefile

@@ -0,0 +1,67 @@
+require 'rake/rdoctask'
+require 'rubygems'
+require 'rake/gempackagetask'
+# require 'spec/rake/spectask'
+require 'rubygems/specification'
+require 'date'
+
+GEM = "translations_sync"
+GEM_VERSION = "0.2.0"
+AUTHOR = "Dmitri Koulikoff"
+EMAIL = "koulikoff@gmail.com"
+HOMEPAGE = "http://github.com/dima4p/translations_sync/"
+SUMMARY = "Synchronizes the different locales represeinted in yaml, in particular, for I18n"
+
+spec = Gem::Specification.new do |s|
+  s.name = GEM
+  s.version = GEM_VERSION
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = true
+  s.extra_rdoc_files = ["README", "MIT-LICENSE"]
+  s.summary = SUMMARY
+  s.description = s.summary
+  s.author = AUTHOR
+  s.email = EMAIL
+  s.homepage = HOMEPAGE
+
+   s.add_dependency "ya2yaml"
+
+  s.executables = 'translations_sync'
+  s.default_executable = 'translations_sync'
+  s.require_path = 'lib'
+  s.files = %w(MIT-LICENSE README Rakefile init.rb) +
+    Dir.glob("{bin,lib,spec}/**/*") -
+    Dir.glob("{bin,lib,spec}/**/*~")
+end
+
+desc 'Generate documentation for the translations_sync plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'TranslationsSync'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+# task :default => :spec
+# desc "Default: Run specs"
+# Spec::Rake::SpecTask.new do |t|
+#   t.spec_files = FileList['spec/**/*_spec.rb']
+#   t.spec_opts = %w(-fs --color)
+# end
+
+desc "install the gem locally"
+task :install => [:package] do
+  sh %{sudo gem install pkg/#{GEM}-#{GEM_VERSION}}
+end
+
+desc "create a gemspec file"
+task :make_spec do
+  File.open("#{GEM}.gemspec", "w") do |file|
+    file.puts spec.to_ruby
+  end
+end

data/bin/translations_sync

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+require 'fileutils'
+
+from = File.join(File.split(Gem.bin_path('translations_sync')).first,
+                 '..', 'lib', 'tasks', '*.rake')
+to = File.expand_path('.', File.join('lib', 'tasks'))
+environment = File.expand_path('.', File.join('config', 'environment.rb'))
+
+if File.directory? to and File.exists? environment
+  FileUtils.cp Dir.glob(from), to
+  puts "Rake file are copied to #{to}"
+else
+  puts 'You must run it from within the rails directory'
+end

data/init.rb

@@ -0,0 +1,2 @@
+# Include hook code here
+require 'translations_sync'

data/lib/tasks/translations_sync.rake

@@ -0,0 +1,69 @@
+# encoding: utf-8
+namespace :translations do
+
+  PARAMS = '. LIST=locales,to,use EXCLUDE=locales,to,ignore'
+
+  desc "Synchronizes the existing translations" + PARAMS +  ' NAME=file_name_prefix'
+  task :sync => :environment do
+    source = ENV['SOURCE'] || ENV['IN']
+    ts = TranslationsSync.new ENV['LIST'], ENV['EXCLUDE'], source
+    name = ENV['NAME'] || ENV['IN'] || 'missing'
+    ts.missing.keys.sort.each do |lang|
+      filename = File.join Rails.root, 'config', 'locales', "#{name}_#{lang}.yml"
+      print filename + ' ...  '
+      if File.exist? filename
+        hash = YAML::load(File.open(filename))
+        File.open(filename, "w") do |file|
+          file.write(TranslationsSync.to_yaml(hash.deep_merge!(ts.missing.slice(lang))))
+        end
+        puts 'updated'
+      else
+        File.open(filename, "w") do |file|
+          file.write(TranslationsSync.to_yaml(ts.missing.slice lang))
+        end
+        puts 'created'
+      end
+    end
+    puts "All is synchronized" if ts.missing.size == 0
+  end
+
+  desc "Detects the translations existing only in one locale" + PARAMS
+  task :singles => :environment do
+    ts = TranslationsSync.new ENV['LIST'], ENV['EXCLUDE']
+    filename = File.join Rails.root, 'config', 'locales', "singles.yml"
+    if ts.singles.size > 0
+      File.open(filename, "w") do |file|
+        file.write(TranslationsSync.to_yaml ts.singles)
+      end
+      puts filename + ' <= ' + ts.singles.keys.join(', ')
+    else
+      puts 'No singles were found'
+    end
+  end
+
+  desc "Moves the key in the translations" + PARAMS + " KEY=key.to.move TO=where.to.move IN=filespec"
+  task :move => :environment do
+    source = ENV['SOURCE'] || ENV['IN']
+    name = ENV['NAME'] || ENV['IN'] || 'moved'
+    key = ENV['KEY'] or raise "Parameter KEY must be given"
+    ts = TranslationsSync.new ENV['LIST'], ENV['EXCLUDE'], source
+    if ts.move key, ENV['TO']
+      ts.moved.keys.sort.each do |lang|
+        filename = File.join Rails.root, 'config', 'locales', "#{name}_#{lang}.yml"
+        print filename + ' ...  '
+        if File.exist? filename
+          status = 'updated'
+        else
+          status = 'created'
+        end
+        File.open(filename, "w") do |file|
+          file.write(TranslationsSync.to_yaml(ts.moved.slice lang))
+        end
+        puts status
+      end
+    else
+      puts "The key \"#{key}\" was not found"
+    end
+  end
+
+end

data/lib/translations_sync.rb

@@ -0,0 +1,245 @@
+# encoding: utf-8
+require 'ya2yaml'
+require 'i18n'
+
+class Hash
+  def stringify_keys!
+    keys.each do |key|
+      self[key.to_s] = delete(key)
+    end
+    self
+  end
+end
+
+class TranslationsSync
+
+  attr_accessor :translations, :list
+  DEFAULT_LIST = 'ru,en'
+  EXCLUDE_LIST = ''
+  TAIL = '=TODO'
+  PKORDER = {'zero' => 0, 'one' => 1, 'two' => 2, 'few' => 3, 'many' => 5, 'other' => 9}
+  PKLIST = PKORDER.keys
+  RE = Regexp.new ' \d(' + PKORDER.keys.join('|') + '):'
+
+  class << self
+    def to_yaml(hash)
+      translate_keys(hash).ya2yaml.gsub(RE, ' \1:')
+    end
+
+    private
+
+    def translate_keys(hash)
+      hash.each_pair do |key, v|
+        if v.is_a? Hash
+          if v.keys.sort == (v.keys & PKLIST).sort
+            new = {}
+            v.keys.each do |k|
+              new["#{PKORDER[k]}#{k.to_s}"] = v[k]
+            end
+            hash[key] = new
+          else
+            translate_keys v
+          end
+        end
+      end
+      hash
+    end
+  end
+
+  def initialize(list = nil, exclude = nil, source = nil)
+    I18n.backend.send(:init_translations) unless I18n.backend.initialized?
+    @translations = I18n.backend.send :translations
+    if source
+      re = Regexp.new "#{Regexp.escape source}_[^.]+\\.(yml|rb)\\Z"
+      I18n.load_path.reject! do |path|
+        path !~ re
+      end
+      @translations.each do |key, hash|
+        hash.keys.each do |k|
+          hash.delete(k) unless k == :pluralize
+        end
+      end
+      I18n.backend.send(:init_translations)
+    end
+    @full_list = ((list || DEFAULT_LIST).split(',').map(&:to_sym) + translations.keys).uniq
+    exclude = (exclude || EXCLUDE_LIST).split(',').map(&:to_sym)
+    @list = @full_list - exclude
+    @flat = {}
+    @list.each do |lang|
+      flatten_keys(lang, translations[lang] || {}, @flat)
+    end
+    @flat.delete([:pluralize]) # we do not need this proc if it exists
+    @pluralize_keys = @list.inject({}) do |acc, lang|
+      acc[lang] = if locale_pluralize = I18n.backend.send(:lookup, lang, :pluralize) and
+          locale_pluralize.respond_to?(:call)
+        ((0..100).map do |n|
+          locale_pluralize.call n
+        end << :other).uniq
+      else
+        [:one, :other]
+      end
+      acc
+    end
+  end
+
+  def locales_with_missing
+    unless @locales_with_missing
+      size = list.size
+      @locales_with_missing = []
+      @flat.each_pair do |key, val|
+        if val.size < size
+          (@locales_with_missing += list - val.keys).uniq!
+          break if @locales_with_missing.size == size
+        end
+      end
+    end
+    @locales_with_missing
+  end
+
+  def missing
+    unless @missing
+      @missing = {}
+      locales_with_missing.each do |lang|
+        @missing[lang] = {}
+      end
+      @flat.each_pair do |key, val|
+        (locales_with_missing - val.keys).each do |lang|
+          push_to_hash @missing[lang], lang, key, val, :missing
+        end
+      end
+      @missing.stringify_keys!
+    end
+    @missing
+  end
+
+  def locales_with_singles
+    unless @locales_with_singles
+      size = list.size
+      @locales_with_singles = []
+      @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
+        end
+      end
+    end
+    @locales_with_singles
+  end
+
+  def singles
+    unless @singles
+      @singles = {}
+      locales_with_singles.each do |lang|
+        @singles[lang] = {}
+      end
+      @flat.each_pair do |key, val|
+        lang = val.keys.first
+        push_to_hash @singles[lang], lang, key, val, :singles if val.size == 1
+      end
+      @singles.stringify_keys!
+    end
+    @singles
+  end
+
+  def move(key, destination)
+    key = key.split('.').map(&:to_sym)
+    key_length = key.length - 1
+    return false if key_length < 0
+    destination ||= ''
+    destination = destination.split('.').map(&:to_sym)
+    result = false
+    @flat.each_pair do |array, val|
+      if array[0, key_length + 1] == key
+        array[0, key_length] = destination
+        result = true
+      end
+    end
+    @moved = nil
+    result
+  end
+
+  def moved
+    unless @moved
+      @moved = {}
+      @list.each do |lang|
+        @moved[lang] = {}
+      end
+      @flat.each_pair do |key, val|
+        val.keys.each do |lang|
+          push_to_hash @moved[lang], lang, key, val, :moved
+        end
+      end
+      @moved.keys.each do |key|
+        @moved.delete(key) if @moved[key].size == 0
+      end
+      @moved.stringify_keys!
+    end
+    @moved
+  end
+
+  private
+
+  def flatten_keys(lang, src, dest = {}, prefix = [])
+    src.each_pair do |key, value|
+      new = prefix.dup << key
+      if value.is_a? Hash
+        if value.keys.include? :other
+          insert_translation(dest, new, lang, value)
+        else
+          flatten_keys lang, value, dest, new
+        end
+      else
+        insert_translation(dest, new, lang, value)
+      end
+    end
+    dest
+  end
+
+  def insert_translation(dest, key, lang, value)
+    dest[key] ||= {}
+    dest[key][lang] = value
+  end
+
+  def push_to_hash(hash, target, keys, val, mode)
+    key = keys.pop
+    h = hash
+    keys.each do |k|
+      h[k.to_s] = {} unless h[k.to_s]
+      h = h[k.to_s]
+    end
+    case mode
+    when :missing
+      lang = @full_list.detect do |lang|
+        not val[lang].nil?
+      end
+      if val[lang].is_a? Hash
+        h[key.to_s] = {}
+        @pluralize_keys[target].each do |pkey|
+          h[key.to_s][pkey.to_s] =
+            (val[lang][pkey] || val[lang][:many] || val[lang][:other]) + TAIL
+        end
+      elsif val[lang].is_a? Array
+        h[key.to_s] = val[lang].map do |text|
+          text.is_a?(String) ? (text + TAIL) : text
+        end
+      else
+        begin
+          h[key.to_s] = val[lang].to_s + TAIL
+        rescue
+          puts %Q(Can not assign to the key "#{key}")
+          raise
+        end
+      end
+    when :singles
+      value = val.values.first
+      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.stringify_keys! if value.is_a? Hash
+      h[key.to_s] = value
+    end
+    keys.push key
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+# -*- encoding: utf-8 -*-
+
+$TESTING=true
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+
+require 'translation_sync'

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification 
+name: translations_sync
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
+platform: ruby
+authors: 
+- Dmitri Koulikoff
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-16 00:00:00 +03:00
+default_executable: translations_sync
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: ya2yaml
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: Synchronizes the different locales represeinted in yaml, in particular, for I18n
+email: koulikoff@gmail.com
+executables: 
+- translations_sync
+extensions: []
+
+extra_rdoc_files: 
+- README
+- MIT-LICENSE
+files: 
+- MIT-LICENSE
+- README
+- Rakefile
+- init.rb
+- bin/translations_sync
+- lib/tasks/translations_sync.rake
+- lib/translations_sync.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/dima4p/translations_sync/
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Synchronizes the different locales represeinted in yaml, in particular, for I18n
+test_files: []
+