locales_export_import 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: df3dca3ca00924093e0588723666f34cb5c79556
-  data.tar.gz: 8e33aa195182a43849003b726e6a77b34c0aa59c
+  metadata.gz: dc17ccfb4731014d4540fcf55ebc2b80e546e5de
+  data.tar.gz: bfec6dc2a76f2d6f57d066b94a8c53ba7dae4103
 SHA512:
-  metadata.gz: 4b8bd6defc356162b60bbdbece7008208347548378842a53457ce76f6d8304646d085c8917238d8b057c77558ce296dd402bba7ada45b5843437ad6158c36895
-  data.tar.gz: 775b17d57ac4d128ea3b5c2e2b626e7e0dfc0f6457485402d2627a79973280456d0a2499f24aaff043a797aadbea67b298293c5dd17bdf1e8b2230accf75b3d6
+  metadata.gz: 7cf28a1cecdd3b12b48927104eaec1ad5a5de244074103e7173b1d0b1b6edd9d68ca4d9bac566891a5a3a7b211650b6f3ac91517974c13ec32700b0c7635fc8a
+  data.tar.gz: b409b2ce3c923df0ecf5b1154e1204c91fc8c479ff934a777464fbec293431766fc0ec30b5ca118a9fb2cba300914b0d459c0476329d4d9a3d1f2dace31d029b

data/README.md

@@ -1,6 +1,12 @@
-# LocalesExportImport
+# Locales Export & Import
 
-TODO: Write a gem description
+This gem is designed to work with Rails I18n locale files, but it's not dependent on Rails, so can be also used elsewhere. Translation agencies prefer working with the tools they know, typically Excel, while ruby developers usually store localized strings in yaml files. locale_export_import helps with easy conversion between the two formats to make developer-translator interaction less painful.
+  
+The typical workflow of adding new locale(s) with this gem is as follows:
+
+1. Developer exports his base locale file to CSV (currently only CSV is supported, XLSX support is planned).
+2. Translator opens the file in Excel, adds one or several columns with translated texts (one column per locale).
+3. Developer converts the resulting file to YAML file(s) and commits the changes.
 
 ## Installation
 
@@ -18,7 +24,52 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+#### Converting locale YAML file to CSV:
+```
+LocalesExportImport::Yaml2Csv.convert(locale_file_names_array, output_file_name, pattern = nil)
+```
+
+For example:
+```
+LocalesExportImport::Yaml2Csv.convert(['config/locales/en.yml'], 'en_keys.csv')
+```
+Resulting CSV is in the following format:
+```
+key,en_value
+en.views.login.remember_me,Remember me
+...
+```
+
+For multiple locales at once:
+```
+LocalesExportImport::Yaml2Csv.convert(
+                                %w[config/locales/en-UK.yml config/locales/de-DE.yml],
+                                'en_de_keys.csv'
+)
+```
+And the result will be something like this:
+```
+key,en-UK_value,de-DE_value
+en.views.login.remember_me,Remember me,Mich eingeloggt lassen
+en.views.login.log_in,Log in,Einloggen
+...
+```
+Not that each column header for translation texts should be in the format #{locale}_value
+
+Exporting only the texts that match a certain pattern:
+```
+LocalesExportImport::Yaml2Csv.convert(['config/locales/en.yml'], 'en_login_keys.csv', /login/i)
+```
+
+#### Converting CSV back to YAML:
+```
+LocalesExportImport::Csv2Yaml.convert(csv_file_name)
+````
+
+The result will be the locale file(s) in the current working directory, one file for each locale column found in the headers. E.g. if CSV file header row was "key,en-UK,de-DE,fi-FI", then the resulting files will be en-UK.yml, de-DE.yml, and fi-FI.yml populated with corresponding translated strings.
+
+Note that if you already have one or several locale files in the same folder (e.g. en-UK.yml and de-DE.yml), these files will be loaded and updated with new values. That way you can import new portion of translations to already exsisting locale file, adding only the new ones while keeping the old keys/values inatact.
+
 
 ## Contributing
 

data/lib/locales_export_import/version.rb

@@ -1,3 +1,3 @@
 module LocalesExportImport
-  VERSION = "0.4.1"
+  VERSION = "0.4.2"
 end

data/locales_export_import.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["pavlozahozhenko@gmail.com"]
   spec.description   = %q{Used for exporting locale yaml files to CSV format. CSV files are then being imported into Excel, edited by translators, then imported back to yaml.}
   spec.summary       = "Used for exporting and importing locale yaml files to CSV"
-  spec.homepage      = ""
+  spec.homepage      = "https://github.com/buru/locales_export_import"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: locales_export_import
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - buru
@@ -72,7 +72,7 @@ files:
 - locales_export_import.gemspec
 - spec/locales_export_import/yaml2csv_spec.rb
 - spec/support/files/sample_locale.yml
-homepage: ''
+homepage: https://github.com/buru/locales_export_import
 licenses:
 - MIT
 metadata: {}