i18n-csv_translation 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: aa5a41cfc85d0e28282efed2cd3620e18f04e2bb
+  data.tar.gz: 83cf14dcd473a54aeb010eb880ca992e67295eba
+SHA512:
+  metadata.gz: 6fa68089c774d3d0392aa8fa86ac08c74365e398865158b1bce108367d3659d18bb75dab98f7a296fa87edf46028032ba556c80699c78c3b4f4b3349e7f5beeb
+  data.tar.gz: 2e6f6d9011c0a11a3c577603cac50b74e62a9c5a742f35da303e2450d7ef384115de60e4f5a2c31a31002f3355a743c605c40d5f00f0c0d5580e1b3e794f7bad

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.13.1

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in i18n-csv_translation.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Sebastian Welther
+
+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.md

@@ -0,0 +1,114 @@
+# I18n::CsvTranslation
+
+Ever needed to add a new locale to an existing (Rails) project with dozens of .yml files? Too afraid to give all files to the customer or translation service and hope they do not mess up the YAML format?
+
+This gem allows you to export all i18n keys and values to one CSV file. With this the values can be easily translated and later reimported into your project. The new translations are saved in a filename similar to the original one (only the locale is replaced).
+
+## Installation
+
+Add this line to your application's Gemfile in the development group because you will need it only locally:
+
+```ruby
+group :development do
+  gem "i18n_csv", require: false
+end
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install i18n-csv_translation
+
+## Usage
+
+### Export translations into one csv file
+
+Write in a (Rails) console or script:
+
+```ruby
+  require "i18n/csv-translation"
+
+  exporter = I18n::CsvTranslation::Exporter.new
+  exporter.export(path: "path-to-your-locales-directory", output: "my_translations.csv", files: "*.yml")
+```
+
+Note: The gem expects only one locale in each file. If you want to export only English to have it translated you can either
+give a files param like `files: "en.*.yml"` or use a block (see below) to determine if the files content should be processed.
+
+If you wish a different csv column separator give it as option:
+
+```ruby
+  I18n::CsvTranslation::Exporter.new(col_sep: "\t")
+```
+
+With a block you can decide if the translation file should be processed
+
+```ruby
+  exporter.export(path: "path-to-your-locales-directory", output: "my_translations.csv") do |file|
+    !file.include? "admin"
+  end
+```
+
+Ignores all files with "admin" in the name.
+
+### Import translations from csv
+
+Given you got a csv with translated values for a new locale, lets say German.
+
+The import process works only if the first two columns on the csv file haven't been
+touched by the translaters. The first column holds the file name of the original
+translation file, without the locale. The second one is the translation key,
+again without locale.
+
+Creating new translation files can be done like this:
+
+```ruby
+  require "i18n/csv-translation"
+
+  importer = I18n::CsvTranslation::Importer.new
+  importer.import input: "path_to_translated_csv_file", path: "path_for_new_translation_files", new_locale: "de"
+```
+
+Given you had two English translation files:
+
+```
+  config/locales/en.users.yml
+  config/locales/en.addresses.yml
+```
+
+After the import you would have these two new German translation files:
+
+```
+  de.users.yml
+  de.addresses.yml
+```
+
+With all keys and values in their respective files, e.g. "de.users.name" in de.users.yml,
+"de.addresses.street" in de.addresses.yml.
+
+The translated csv file has a custom col sep?
+
+```ruby
+  importer = I18n::CsvTranslation::Importer.new(col_sep: "\t")
+```
+
+## TODO
+
+- Option for the locale to be exported instead of files param. Would load all yml files but process only thos with a distinct locale.
+- Remove YAML header from new translation files (optionally)
+- Option for verbose output (which file processed, which keys, etc...)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/swelther/i18n-csv_translation.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/certs/swelther.pem

@@ -0,0 +1,21 @@
+-----BEGIN CERTIFICATE-----
+MIIDeDCCAmCgAwIBAgIBATANBgkqhkiG9w0BAQUFADBBMRIwEAYDVQQDDAlzZWJh
+c3RpYW4xFzAVBgoJkiaJk/IsZAEZFgd3ZWx0aGVyMRIwEAYKCZImiZPyLGQBGRYC
+ZGUwHhcNMTYwOTI3MDgzMzIyWhcNMTcwOTI3MDgzMzIyWjBBMRIwEAYDVQQDDAlz
+ZWJhc3RpYW4xFzAVBgoJkiaJk/IsZAEZFgd3ZWx0aGVyMRIwEAYKCZImiZPyLGQB
+GRYCZGUwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDNjCSKEQmOCsrJ
+MqFRLEi3OQ7l8qTtf0IeIi/BIdA4Pwb/jgsQzwoY2yW2NwNYKC0AaHZVtAqZ5sCH
+Xj3OVKHVK7beWptHCljs+kDuHM1cGl3h4VXAano+VrXCy0TwaiJ0dzDFfPhkvfPq
+CmzNRDJvb3RRYx5H/v/+0pZZCaZ+5shncaiBS8UmLYD27BdsNE45nHZkiuCe/7Kt
+rGqRpX/+ZgHZlZxSSYuUp1pdGCNUgLe91qjV1SAgeXub4mmR3e1+s/lATClqPspv
+WD3CLnxYdAxLHtfiOhfId4DF5E65rYM5pLg2Zp/QSOHQyxbhfCQ1R1zv1HJULVs6
+V4EJ29FvAgMBAAGjezB5MAkGA1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQW
+BBQhYVZ9gH8Io+1u5dpWwsS5qvlzPjAfBgNVHREEGDAWgRRzZWJhc3RpYW5Ad2Vs
+dGhlci5kZTAfBgNVHRIEGDAWgRRzZWJhc3RpYW5Ad2VsdGhlci5kZTANBgkqhkiG
+9w0BAQUFAAOCAQEAQ4mn273uhDc5ZSZtcPJ6FbxtvHt2G3pzup30fJqrMyOsNi7P
+B1QHLsTlbxvtGGbTARl6gsoADzTIaDY99jbwBK2iHsWxiMcfFw7qintddtwHPEfP
+CyLELS8TGdA0aWXu+jLgk/22Az+irx6qhlZLrwoQgTOqst/2FcvWoeQvSwT3vSxH
+WoA2XFqw2ewJw2SJmpcVwY8wN4AUqn5fieu0lO3fZE8BTcxLK15DljWlFhVg0zrh
+4Q9DVxGADMOl4uvvg4JHeLVYzenzkP3z1vhkCd5ZaOjd4fFSBlXW0Ewl8KMVRNL+
+rQQ/uL3CcurQ/cyMOz/xeLTkXo80XtfgYUDOyw==
+-----END CERTIFICATE-----

data/i18n-csv_translation.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'i18n/csv_translation/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "i18n-csv_translation"
+  spec.version       = I18n::CsvTranslation::VERSION
+  spec.authors       = ["Sebastian Welther"]
+  spec.email         = ["sebastian@welther.de"]
+
+  spec.summary       = %q{Exports all i18n keys and values of one locale into one CSV and imports it back as new locale.}
+  spec.description   = %q{Ever needed to add a new locale to an existing (Rails) project with dozens of .yml files? Too afraid to give all files to the customer or translation service and hope they do not mess up the YAML format? This gem allows you to export all i18n keys and values to one CSV file. With this the values can be easily translated and later reimported into your project. The new translations are saved in a filename similar to the original one (only the locale is replaced).}
+  spec.homepage      = "https://github.com/swelther/i18n-csv_translation"
+  spec.license       = "MIT"
+
+  spec.cert_chain  = ["certs/swelther.pem"]
+  spec.signing_key = File.expand_path("~/.ssh/gem-private_key.pem") if $0 =~ /gem\z/
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.executables   = []
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "deep_merge", "~> 1.1"
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_development_dependency "pry", "~> 0.10"
+end

data/lib/i18n/csv_translation.rb

@@ -0,0 +1,9 @@
+require "i18n/csv_translation/version"
+
+require "i18n/csv_translation/importer"
+require "i18n/csv_translation/exporter"
+
+module I18n
+  module CsvTranslation
+  end
+end

data/lib/i18n/csv_translation/exporter.rb

@@ -0,0 +1,83 @@
+require "yaml"
+require "csv"
+
+module I18n::CsvTranslation
+  class Exporter
+    def initialize col_sep: ";"
+      @col_sep = col_sep
+    end
+
+    def export path:, files: "*.yml", output:, &block
+      @path   = path
+      @files  = files
+      @output = output
+
+      translations = load_translations_into_hash &block
+      save_translations_to_csv translations
+    end
+
+    private
+
+    def load_translations_into_hash
+      translations = {}
+
+      Dir[current_path.join(@path, "**", @files)].sort.each do |file|
+        process_file =  if block_given?
+                          yield(file)
+                        else
+                          true
+                        end
+
+        if process_file
+          ymls = YAML.load_file file
+          translations.merge! output_filename(file, yml_locale(ymls)) => flat_translation_hash(ymls.values.first)
+        end
+      end
+
+      translations
+    end
+
+    def save_translations_to_csv translations
+      CSV.open(@output, "w", col_sep: @col_sep) do |csv|
+        translations.each do |key, value|
+          if value.is_a?(Hash)
+            value.each do |inner_key, inner_value|
+              csv << [key, inner_key, inner_value]
+            end
+          else
+            csv << [key, value]
+          end
+        end
+      end
+    end
+
+    def flat_translation_hash translations, parent=[]
+      result = {}
+
+      translations.each do |key, values|
+        current_key = parent.dup << key
+
+        if values.is_a?(Hash)
+          result.merge! flat_translation_hash(values, current_key)
+        else
+          result[current_key.join(".")] = values
+        end
+      end
+
+      result
+    end
+
+    def current_path
+      Pathname.new(File.dirname(__FILE__))
+    end
+
+    def output_filename file, old_locale
+      File.basename(file).gsub("#{old_locale}.", "")
+    end
+
+    def yml_locale yml
+      yml.keys.first
+    end
+
+  end
+end

data/lib/i18n/csv_translation/importer.rb

@@ -0,0 +1,63 @@
+require "csv"
+require "deep_merge"
+
+module I18n::CsvTranslation
+  class Importer
+    def initialize col_sep: ";"
+      @col_sep = col_sep
+    end
+
+    def import input:, path:, new_locale:
+      @input      = input
+      @path       = path
+      @new_locale = new_locale
+
+      translations = load_translations_from_csv
+      save_translations_as_yaml translations
+    end
+
+    private
+
+    def load_translations_from_csv
+      translations = {}
+
+      CSV.foreach(@input, col_sep: @col_sep) do |csv|
+        unless csv[1].nil? && csv[2].nil?
+          if translations[csv[0]].nil?
+            translations[csv[0]] = { key_with_locale(csv[1]) => csv[2] }
+          else
+            translations[csv[0]].merge!({ key_with_locale(csv[1]) => csv[2] })
+          end
+        end
+      end
+
+      translations
+    end
+
+    def save_translations_as_yaml translations
+      translations.each do |key, value|
+        unless key.nil?
+          filename = Pathname.new(@path).join("#{@new_locale}." + Pathname.new(key).basename.to_s)
+          file = File.open(filename, "w")
+
+          hash = {}
+
+          value.each do |inner_key, inner_value|
+            a = inner_key.split(".").reverse.inject(inner_value) { |a, n| { n => a } }
+            hash.deep_merge! a
+          end
+
+          # TODO Add option to omit "header"
+          file.write(hash.to_yaml)
+
+          file.close
+        end
+      end
+    end
+
+    def key_with_locale key
+      "#{@new_locale}.#{key}"
+    end
+
+  end
+end

data/lib/i18n/csv_translation/version.rb

@@ -0,0 +1,5 @@
+module I18n
+  module CsvTranslation
+    VERSION = "1.0.0"
+  end
+end

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: i18n-csv_translation
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Sebastian Welther
+autorequire: 
+bindir: bin
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDeDCCAmCgAwIBAgIBATANBgkqhkiG9w0BAQUFADBBMRIwEAYDVQQDDAlzZWJh
+  c3RpYW4xFzAVBgoJkiaJk/IsZAEZFgd3ZWx0aGVyMRIwEAYKCZImiZPyLGQBGRYC
+  ZGUwHhcNMTYwOTI3MDgzMzIyWhcNMTcwOTI3MDgzMzIyWjBBMRIwEAYDVQQDDAlz
+  ZWJhc3RpYW4xFzAVBgoJkiaJk/IsZAEZFgd3ZWx0aGVyMRIwEAYKCZImiZPyLGQB
+  GRYCZGUwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDNjCSKEQmOCsrJ
+  MqFRLEi3OQ7l8qTtf0IeIi/BIdA4Pwb/jgsQzwoY2yW2NwNYKC0AaHZVtAqZ5sCH
+  Xj3OVKHVK7beWptHCljs+kDuHM1cGl3h4VXAano+VrXCy0TwaiJ0dzDFfPhkvfPq
+  CmzNRDJvb3RRYx5H/v/+0pZZCaZ+5shncaiBS8UmLYD27BdsNE45nHZkiuCe/7Kt
+  rGqRpX/+ZgHZlZxSSYuUp1pdGCNUgLe91qjV1SAgeXub4mmR3e1+s/lATClqPspv
+  WD3CLnxYdAxLHtfiOhfId4DF5E65rYM5pLg2Zp/QSOHQyxbhfCQ1R1zv1HJULVs6
+  V4EJ29FvAgMBAAGjezB5MAkGA1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQW
+  BBQhYVZ9gH8Io+1u5dpWwsS5qvlzPjAfBgNVHREEGDAWgRRzZWJhc3RpYW5Ad2Vs
+  dGhlci5kZTAfBgNVHRIEGDAWgRRzZWJhc3RpYW5Ad2VsdGhlci5kZTANBgkqhkiG
+  9w0BAQUFAAOCAQEAQ4mn273uhDc5ZSZtcPJ6FbxtvHt2G3pzup30fJqrMyOsNi7P
+  B1QHLsTlbxvtGGbTARl6gsoADzTIaDY99jbwBK2iHsWxiMcfFw7qintddtwHPEfP
+  CyLELS8TGdA0aWXu+jLgk/22Az+irx6qhlZLrwoQgTOqst/2FcvWoeQvSwT3vSxH
+  WoA2XFqw2ewJw2SJmpcVwY8wN4AUqn5fieu0lO3fZE8BTcxLK15DljWlFhVg0zrh
+  4Q9DVxGADMOl4uvvg4JHeLVYzenzkP3z1vhkCd5ZaOjd4fFSBlXW0Ewl8KMVRNL+
+  rQQ/uL3CcurQ/cyMOz/xeLTkXo80XtfgYUDOyw==
+  -----END CERTIFICATE-----
+date: 2016-09-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: deep_merge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+description: Ever needed to add a new locale to an existing (Rails) project with dozens
+  of .yml files? Too afraid to give all files to the customer or translation service
+  and hope they do not mess up the YAML format? This gem allows you to export all
+  i18n keys and values to one CSV file. With this the values can be easily translated
+  and later reimported into your project. The new translations are saved in a filename
+  similar to the original one (only the locale is replaced).
+email:
+- sebastian@welther.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- certs/swelther.pem
+- i18n-csv_translation.gemspec
+- lib/i18n/csv_translation.rb
+- lib/i18n/csv_translation/exporter.rb
+- lib/i18n/csv_translation/importer.rb
+- lib/i18n/csv_translation/version.rb
+homepage: https://github.com/swelther/i18n-csv_translation
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Exports all i18n keys and values of one locale into one CSV and imports it
+  back as new locale.
+test_files: []