translations 0.1.0

data/.gitignore

@@ -0,0 +1,6 @@
+# Ignore project files
+.idea
+*.iml
+
+# Ignore build artifacts
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+ruby-1.9.3-p385@translations

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,40 @@
+PATH
+  remote: .
+  specs:
+    translations (0.0.1)
+      thor (~> 0.17.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    predicated (0.2.6)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.2)
+    rspec-expectations (2.12.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.12.2)
+    ruby2ruby (2.0.3)
+      ruby_parser (~> 3.1)
+      sexp_processor (~> 4.0)
+    ruby_parser (3.1.1)
+      sexp_processor (~> 4.1)
+    sexp_processor (4.1.4)
+    thor (0.17.0)
+    wrong (0.7.0)
+      diff-lcs (~> 1.1.2)
+      predicated (~> 0.2.6)
+      ruby2ruby (>= 2.0.1)
+      ruby_parser (>= 3.0.1)
+      sexp_processor (>= 4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rspec (~> 2.12.0)
+  translations!
+  wrong (~> 0.7.0)

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Marten Lienen
+
+MIT License
+
+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,72 @@
+Translations
+============
+
+Edit your translation files in a synchronized way.
+
+
+Naming
+------
+
+1. One translation is your `master`. This file is always complete and serves as a reference for the `slaves`.
+2. All translations that are not `master` are `slave`s. This means that they may not be up-to-date and can be synchronized
+   with the master using `translate`.
+
+The default master is `en`, but you may alter it using the `-m <locale>` switch.
+
+
+Usage
+-----
+
+Currently there are 6 commands to alter your translation files:
+
+- `add`: Add a new key to all your files
+- `update`: Update a key in a single file
+- `change`: Change the meaning of a key in a way that requires a re-translation for all locales
+- `move`: Move a key around
+- `remove`: Remove a key from all files
+- `translate`: Translate all keys that are missing from a given file
+
+For more info just run `translations help <command>`.
+
+
+Requirements
+------------
+
+- All your translations are stored in YAML format and one file per locale called `<locale>.yml`
+- Optimally you work in a rails project, e.g. your translations are stored in `config/locales`, but you may alter this location with `-d <directory>`
+- Optimally you have a master
+
+
+Missing/Coming Features
+----------------
+
+The following features (or whatever comes to your mind) will probably be implemented in the next time:
+
+- Support for Pluralizations
+- Support for [Cascading](http://svenfuchs.com/2011/2/11/organizing-translations-with-i18n-cascade-and-i18n-missingtranslations)
+
+
+Installation
+------------
+
+Add this line to your application's Gemfile:
+
+    gem 'translations'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install translations
+
+
+Contributing
+------------
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/translations

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+require "rubygems"
+require "bundler/setup"
+require "translations/cli"
+
+Translations::CLI.start

data/lib/translations.rb

@@ -0,0 +1,5 @@
+require "translations/version"
+
+module Translations
+
+end

data/lib/translations/cli.rb

@@ -0,0 +1,147 @@
+require "thor"
+
+require "translations/serializer"
+
+module Translations
+  class CLI < Thor
+    class_option :directory, aliases: ["-d"], default: "config/locales", type: :string, desc: "Directory containing the translations"
+    class_option :master, aliases: ["-m"], default: "en", type: :string, desc: "The master locale"
+
+    desc "translate LOCALE [KEYS]", "Translate the KEYS into the given LOCALE"
+    long_desc <<-DESC
+      Translate KEYS from the master to LOCALE. If you omit KEYS it will instead ask you to translate all keys that exist
+      in master but not in LOCALE.
+    DESC
+    def translate locale, *keys
+      translations = serializer.translations
+
+      translation = translations.for_locale(locale)
+
+      if keys.length == 0
+        keys = translation.missing_keys_from_translation(translations.master)
+      end
+
+      master = translations.master
+
+      keys.each do |key|
+        say key
+        say "#{master.locale}: #{master[key]}"
+
+        translations.slaves.each do |translation|
+          answer = ask "#{translation.locale}?"
+
+          if answer.length > 0
+            translation[key] = answer
+          end
+
+          puts
+
+          serializer.save translations
+        end
+      end
+    end
+
+    desc "remove KEYS", "Remove KEYS from all locales"
+    def remove *keys
+      translations = serializer.translations
+
+      keys.each do |key|
+        translations.remove key
+      end
+
+      serializer.save translations
+    end
+
+    desc "move FROM TO", "Move a translation from FROM to TO"
+    def move from, to
+      translations = serializer.translations
+
+      translations.move from, to
+
+      serializer.save translations
+    end
+
+    desc "add KEY", "Add a new KEY to all translations"
+    long_desc <<-DESC
+      Add a key and provide translations for as many locales as you can.
+    DESC
+    def add key
+      translations = serializer.translations
+
+      answer = ask "#{translations.master.locale}?"
+
+      if answer.length > 0
+        translations.master[key] = answer
+      else
+        say "You have to provide a translation for master"
+
+        return
+      end
+
+      translations.slaves.each do |translation|
+        answer = ask "#{translation.locale}?"
+
+        if answer.length > 0
+          translation[key] = answer
+        end
+      end
+
+      serializer.save translations
+    end
+
+    desc "change KEY", "Change the meaning of KEY"
+    long_desc <<-DESC
+      Changes the meaning of KEY in a way that requires re-translation to all locales. Therefore the key will be removed
+      from all locales for which you cannot provide a translation, so that it can be fixed using the translate command.
+    DESC
+    def change key
+      translations = serializer.translations
+
+      say "#{translations.master.locale}: #{translations.master[key]}"
+      answer = ask "#{translations.master.locale}?"
+
+      if answer.length > 0
+        translations.master[key] = answer
+      else
+        say "You have to provide a translation for master"
+
+        return
+      end
+
+      translations.slaves.each do |translation|
+        say "#{translation.locale}: #{translation[key]}"
+        answer = ask "#{translation.locale}?"
+
+        if answer.length > 0
+          translation[key] = answer
+        else
+          translation.remove key
+        end
+      end
+
+      serializer.save translations
+    end
+
+    desc "update LOCALE KEY", "Update KEY in a specific LOCALE without changing it's meaning"
+    long_desc <<-DESC
+      Just update KEY in LOCALE without altering any other locales.
+    DESC
+    def update locale, key
+      translations = serializer.translations
+      translation = translations.for_locale(locale)
+
+      say "#{locale}: #{translation[key]}"
+      answer = ask "#{locale}?"
+
+      translation[key] = answer
+
+      serializer.save translations
+    end
+
+    no_tasks do
+      def serializer
+        @serializer ||= Serializer.new options.directory, options.master
+      end
+    end
+  end
+end

data/lib/translations/serializer.rb

@@ -0,0 +1,22 @@
+require "translations/translation_collection"
+
+module Translations
+  class Serializer
+    def initialize directory, master
+      @directory = directory
+      @master = master
+    end
+
+    def translations
+      TranslationCollection.new Dir["#{@directory}/*"].map { |file| Translation.new YAML.load_file(file) }, @master
+    end
+
+    def save translations
+      translations.each do |translation|
+        File.open File.join(@directory, "#{translation.locale}.yml"), "w" do |file|
+          file.write translation.to_hash.to_yaml
+        end
+      end
+    end
+  end
+end

data/lib/translations/translation.rb

@@ -0,0 +1,94 @@
+module Translations
+  class Translation
+    class InvalidKeyException < ArgumentError
+
+    end
+
+    attr_reader :locale
+
+    def initialize translations
+      @locale = translations.keys.first
+      @translations = translations[@locale]
+    end
+
+    def keys
+      keys_of_nested_hash @translations
+    end
+
+    def missing_keys_from_translation translation
+      translation.keys - keys
+    end
+
+    def has_key? key
+      translation = key.split(".").inject(@translations) do |translation, key|
+        if translation.nil?
+          nil
+        else
+          translation[key]
+        end
+      end
+
+      translation != nil
+    end
+
+    def [] key
+      key.split(".").inject(@translations) do |translation, key|
+        if translation.nil?
+          raise InvalidKeyException
+        else
+          translation[key]
+        end
+      end
+    end
+
+    def []= key, value
+      parts = key.split(".")
+
+      hash = parts.slice(0, parts.length - 1).inject(@translations) do |translation, key|
+        if !translation.has_key? key
+          translation[key] = { }
+        end
+
+        if !translation[key].is_a? Hash
+          translation[key] = { }
+        end
+
+        translation[key]
+      end
+
+      hash[parts.last] = value
+    end
+
+    def remove key
+      parts = key.split(".")
+      last_part = parts.pop
+
+      parent = parts.inject(@translations) do |translation, key|
+        translation[key]
+      end
+
+      parent.delete last_part
+    end
+
+    def move from, to
+      self[to] = self[from]
+
+      remove from
+    end
+
+    def to_hash
+      { @locale => @translations }
+    end
+
+    private
+    def keys_of_nested_hash hash
+      hash.map do |key, value|
+        if value.is_a? Hash
+          keys_of_nested_hash(value).map { |nested_key| "#{key}.#{nested_key}" }
+        else
+          key
+        end
+      end.flatten 1
+    end
+  end
+end

data/lib/translations/translation_collection.rb

@@ -0,0 +1,34 @@
+require "translations/translation"
+
+module Translations
+  class TranslationCollection
+    include Enumerable
+
+    attr_reader :master
+
+    def initialize translations, master
+      @translations = translations
+      @master = @translations.select { |translation| translation.locale == master }.first
+    end
+
+    def each
+      @translations.each { |translation| yield translation }
+    end
+
+    def for_locale locale
+      @translations.select { |translation| translation.locale == locale }.first
+    end
+
+    def slaves
+      @translations.reject { |translation| translation == master }
+    end
+
+    def remove key
+      @translations.each { |translation| translation.remove key }
+    end
+
+    def move from, to
+      @translations.each { |translation| translation.move from, to }
+    end
+  end
+end

data/lib/translations/version.rb

@@ -0,0 +1,3 @@
+module Translations
+  VERSION = "0.1.0"
+end

data/spec/fixtures/missing_keys/de.yml

@@ -0,0 +1,2 @@
+de:
+  save: 'Speichern'

data/spec/fixtures/missing_keys/en.yml

@@ -0,0 +1,6 @@
+en:
+  save: 'Save'
+  buttons:
+    add: 'Add'
+    save: 'Save'
+    delete: 'Delete'

data/spec/fixtures/working/de.yml

@@ -0,0 +1,2 @@
+de:
+  save: 'Speichern'

data/spec/fixtures/working/en.yml

@@ -0,0 +1,2 @@
+en:
+  save: 'Save'

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require "wrong/adapters/rspec"

data/spec/translations/serializer_spec.rb

@@ -0,0 +1,76 @@
+require "translations/serializer"
+
+describe Translations::Serializer do
+  describe "#translations" do
+    let(:serializer) { Translations::Serializer.new("spec/fixtures/working", "en") }
+
+    it "should parse YAML files into a TranslationCollection" do
+      assert { serializer.translations.is_a? Translations::TranslationCollection }
+    end
+
+    it "should create a translation for every found locale" do
+      locales = serializer.translations.map(&:locale)
+
+      assert { locales.== ["en", "de"] }
+    end
+
+    it "should set the master correctly" do
+      assert { serializer.translations.master.locale == "en" }
+    end
+  end
+
+  describe "#save" do
+    before :each do
+      if File.exists? "/tmp/de.yml"
+        File.delete "/tmp/de.yml"
+      end
+    end
+
+    it "should write the YAML serialization of the translations into the files" do
+      translation = Translations::Translation.new({
+        "de" => {
+          "save" => "Speichern"
+        }
+      })
+
+      translations = Translations::TranslationCollection.new [translation], "de"
+
+      serializer = Translations::Serializer.new "/tmp/", "de"
+
+      serializer.save translations
+
+      assert { File.exists?("/tmp/de.yml") }
+    end
+
+    it "should output the keys in alphabetical order" do
+      translations_hash = {
+        "en" => {
+          "animals" => {
+            "mammals" => {
+              "elephant" => "Elephant",
+              "human" => "Human"
+            },
+            "fish" => {
+              "trout" => "Trout",
+              "bass" => "Bass",
+              "mackerel" => "Mackerel"
+            }
+          },
+          "actions" => {
+            "save" => "Save",
+            "add" => "Add",
+            "delete" => "Delete"
+          }
+        }
+      }
+
+      translation = Translations::Translation.new(translations_hash)
+      translations = Translations::TranslationCollection.new [translation], "en"
+      serializer = Translations::Serializer.new "/tmp/", "en"
+
+      serializer.save translations
+
+      assert { YAML.load_file("/tmp/en.yml") == translations_hash }
+    end
+  end
+end

data/spec/translations/translation_collection_spec.rb

@@ -0,0 +1,47 @@
+require "translations/translation_collection"
+
+describe Translations::TranslationCollection do
+  let(:translation_de) { Translations::Translation.new({ "de" => { "save" => "Speichern" } }) }
+  let(:translation_en) { Translations::Translation.new({ "en" => { "save" => "Save" } }) }
+  let(:translations) { Translations::TranslationCollection.new [translation_de, translation_en], "en" }
+
+  it "should be Enumerable" do
+    enumerated_translations = []
+
+    translations.each { |translation| enumerated_translations << translation }
+
+    assert { enumerated_translations == [translation_de, translation_en] }
+  end
+
+  it "should have a master locale" do
+    assert { translations.master == translation_en }
+  end
+
+  it "should expose all translations that are not master as slaves" do
+    assert { translations.slaves == [translation_de] }
+  end
+
+  describe "#for_locale" do
+    it "should return the Translation for a locale" do
+      assert { translations.for_locale("de") == translation_de }
+    end
+  end
+
+  describe "#remove" do
+    it "should remove the given key from all translations" do
+      translations.remove "save"
+
+      assert { translation_de.has_key?("save") == false }
+      assert { translation_en.has_key?("save") == false }
+    end
+  end
+
+  describe "#move" do
+    it "should move the key in all translations" do
+      translations.move "save", "x_save"
+
+      assert { translation_de["x_save"] == "Speichern" }
+      assert { translation_en["x_save"] == "Save" }
+    end
+  end
+end

data/spec/translations/translation_spec.rb

@@ -0,0 +1,119 @@
+require "translations/translation"
+
+describe Translations::Translation do
+  let(:translation) {
+    Translations::Translation.new({
+      "en" => {
+        "save" => "Save",
+        "buttons" => {
+          "delete" => "Delete",
+          "save" => "Save"
+        }
+      }
+    })
+  }
+
+  it "should have a locale" do
+    assert { translation.locale == "en" }
+  end
+
+  it "should be able to enumerate it's keys" do
+    assert { translation.keys == ["save", "buttons.delete", "buttons.save"] }
+  end
+
+  it "should be able to compute the missing keys when compared to another translation" do
+    translation_de = Translations::Translation.new({
+      "de" => {
+        "buttons" => {
+          "save" => "Speichern"
+        }
+      }
+    })
+
+    translation_de.missing_keys_from_translation(translation).should == ["save", "buttons.delete"]
+  end
+
+  describe "#has_key?" do
+    it "should return true if the key exists" do
+      assert { translation.has_key?("buttons.delete") == true }
+    end
+
+    it "should return false if the key does not exist" do
+      assert { translation.has_key?("key.does.not.exist") == false }
+    end
+
+    it "should return false if the key does not exist" do
+      assert { translation.has_key?("buttons.xxx") == false }
+    end
+  end
+
+  describe "#[]" do
+    it "should expose translations through their keys" do
+      assert { translation["buttons.delete"] == "Delete" }
+    end
+
+    it "should raise an exception if the key is not found" do
+      assert { rescuing { translation["key.does.not.exist"] }.is_a? Translations::Translation::InvalidKeyException }
+    end
+  end
+
+  describe "#[]=" do
+    it "should let you mutate translations through their keys" do
+      translation["buttons.delete"] = "Remove"
+
+      assert { translation["buttons.delete"] == "Remove" }
+    end
+
+    it "should let you create new translations using keys" do
+      translation = Translations::Translation.new({
+                                                    "en" => { }
+                                                  })
+
+      translation["buttons.delete"] = "Delete"
+
+      assert { translation["buttons.delete"] == "Delete" }
+    end
+
+    it "should expand a node when you set a key that goes 'through' another translation" do
+      translation["save.success"] = "Success"
+
+      assert { translation["save.success"] == "Success" }
+    end
+  end
+
+  describe "#remove" do
+    it "should remove the key" do
+      translation.remove "buttons.delete"
+
+      assert { translation.has_key?("buttons.delete") == false }
+    end
+  end
+
+  describe "#move" do
+    it "should move the key" do
+      translation.move "buttons.delete", "actions.crud.delete"
+
+      assert { translation["actions.crud.delete"] == "Delete" }
+    end
+
+    it "should remove the old key" do
+      translation.move "buttons.delete", "actions.crud.delete"
+
+      assert { translation.has_key?("buttons.delete") == false }
+    end
+  end
+
+  it "should have a Hash representation" do
+    expected = {
+      "en" => {
+        "save" => "Save",
+        "buttons" => {
+          "delete" => "Delete",
+          "save" => "Save"
+        }
+      }
+    }
+
+    assert { translation.to_hash == expected }
+  end
+end

data/translations.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'translations/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "translations"
+  gem.version       = Translations::VERSION
+  gem.authors       = ["Marten Lienen"]
+  gem.email         = ["marten.lienen@gmail.com"]
+  gem.description   = %q{Manage YAML translations}
+  gem.summary       = %q{}
+  gem.homepage      = "https://github.com/CQQL/translations"
+
+  gem.add_dependency "thor", "~> 0.17.0"
+
+  gem.add_development_dependency "rspec", "~> 2.12.0"
+  gem.add_development_dependency "wrong", "~> 0.7.0"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: translations
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Marten Lienen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+- !ruby/object:Gem::Dependency
+  name: wrong
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+description: Manage YAML translations
+email:
+- marten.lienen@gmail.com
+executables:
+- translations
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .ruby-version
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/translations
+- lib/translations.rb
+- lib/translations/cli.rb
+- lib/translations/serializer.rb
+- lib/translations/translation.rb
+- lib/translations/translation_collection.rb
+- lib/translations/version.rb
+- spec/fixtures/missing_keys/de.yml
+- spec/fixtures/missing_keys/en.yml
+- spec/fixtures/working/de.yml
+- spec/fixtures/working/en.yml
+- spec/spec_helper.rb
+- spec/translations/serializer_spec.rb
+- spec/translations/translation_collection_spec.rb
+- spec/translations/translation_spec.rb
+- translations.gemspec
+homepage: https://github.com/CQQL/translations
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: ''
+test_files:
+- spec/fixtures/missing_keys/de.yml
+- spec/fixtures/missing_keys/en.yml
+- spec/fixtures/working/de.yml
+- spec/fixtures/working/en.yml
+- spec/spec_helper.rb
+- spec/translations/serializer_spec.rb
+- spec/translations/translation_collection_spec.rb
+- spec/translations/translation_spec.rb