langulator 0.0.1 → 0.0.2

data/README.md

@@ -1,6 +1,20 @@
 # Langulator
 
-TODO: Write a gem description
+Manage your i18n.
+
+Or rather: compile it into a single managable file and give it to the translator, so you don't have to deal with it.
+
+## Caveats
+
+If you need something other than US-ASCII, you may want to consider using ruby 1.9.3.
+
+In 1.9.2 (patch 290):
+
+   S\xC3\xB8knadstekst
+
+In 1.9.3:
+
+    Søknadstekst
 
 ## Installation
 
@@ -18,7 +32,63 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Given that you've written the original translations in English and also need French and German versions, and that you have multiple paths that contain i18n yml files named per the convention `<iso-language-code>.yml`, then this will give you a single output file where each key is listed with the translations immediately below it.
+
+If you have partial translations in the target languages, these will be included.
+
+Any extraneous translations (i.e. keys that may have been in use previously but are no longer referenced in the original language) will be discarded.
+
+Any missing translations will be given keys with an empty spot, ready for translation.
+
+It handles arbitrarily deep nestings.
+
+This first version doesn't handle yml files that are namespaced by the language, but I anticipate needing it very soon.
+
+Also, this first version doesn't actually decompile the finished product. Come back tomorrow for that one.
+
+e.g.
+
+Input:
+
+    # en.yml
+    ---
+    food:
+      breakfast: Eggs
+      lunch: Sandwich
+      dinner:
+        main_course: Steak
+        desert: Chocolate pudding
+
+    # fr.yml
+    ---
+    food:
+      breakfast: Des oeufs
+    thank_you: Merci
+
+    # no de.yml file
+
+    Langulator.write(:language => 'en', :alternates => ['fr', 'de'], :base_path => '**/i18n/', :to => '/tmp/translations.yml')
+
+Outputs:
+
+    food:
+      breakfast:
+        en: Eggs
+        fr: Des oeufs
+        de: 
+      lunch:
+        en: Sandwich
+        fr: 
+        de: 
+      dinner:
+        main_course:
+          en: Steak
+          fr: 
+          de: 
+        desert:
+          en: Chocolate pudding
+          fr: 
+          de: 
 
 ## Contributing
 

data/langulator.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.name          = "langulator"
   gem.require_paths = ["lib"]
-  gem.version       = "0.0.1"
+  gem.version       = "0.0.2"
 
   gem.add_development_dependency "rspec"
 end

data/lib/langulator.rb

@@ -1,18 +1,44 @@
+# encoding: utf-8
+require 'yaml'
 require 'langulator/loader'
 require 'langulator/munger'
+require 'langulator/untangler'
 
 module Langulator
-  def self.compile(options = {})
-    loader = Loader.new(options)
-    munger = Munger.new(:language => loader.origin, :translations => loader.source_translations, :alternates => loader.destination_translations)
+  class << self
+    def munge(options = {})
+      loader = Loader.new(options)
+      munger = Munger.new(:language => loader.origin, :translations => loader.source_translations, :alternates => loader.destination_translations)
 
-    munger.munge
-  end
+      munger.munge
+    end
+
+    def compile(options)
+      filename = options[:to]
+      translations = compile(options)
+      write filename, translations
+    end
+
+    def untangle(aggregate, options)
+      Untangler.new(aggregate, options).untangle
+    end
+
+    def decompile(aggregate, options)
+      translations = untangle(aggregate, options)
+
+      translations.each do |language, data|
+        data.each do |path, translation|
+          filename = "#{path}#{language}.yml"
+          write filename, translation
+        end
+      end
+    end
 
-  def self.write(options)
-    translations = compile(options)
-    File.open(options[:to], 'w') do |file|
-      file.write translations.to_yaml
+    private
+    def write(filename, content)
+      File.open(filename, 'w:utf-8') do |file|
+        file.write content.to_yaml
+      end
     end
   end
 end

data/lib/langulator/untangler.rb

@@ -0,0 +1,34 @@
+module Langulator
+  class Untangler
+    attr_reader :aggregate, :languages
+    def initialize(aggregate, options = {})
+      @aggregate = aggregate
+      @languages = options[:languages]
+    end
+
+    def untangle
+      untangled = {}
+      languages.each do |language|
+        untangled[language] = extract(language, aggregate)
+      end
+      untangled
+    end
+
+    def extract(language, tangled)
+      untangled = {}
+      tangled.keys.each do |key|
+        values = tangled[key]
+        if translations?(values)
+          untangled[key] = values[language]
+        else
+          untangled[key] = extract(language, values)
+        end
+      end
+      untangled
+    end
+
+    def translations?(values)
+      !values.keys.select {|key| languages.include?(key) }.empty?
+    end
+  end
+end

data/spec/fixtures/lang/english.yml

@@ -2,4 +2,4 @@
 volume:
   sound: loud
   liquid: sloshing
-  hair: "because I'm worth it"
+  hair: because I'm worth it

data/spec/langulator_spec.rb

@@ -4,7 +4,7 @@ require 'langulator'
 describe Langulator do
   let(:options) { {:base_path => 'spec/fixtures/**/', :origin => 'english', :alternates => ['norsk', 'francais']} }
 
-  let(:combined) do
+  let(:aggregate_incomplete) do
     {
       "spec/fixtures/" => {
         "food" => {
@@ -28,6 +28,60 @@ describe Langulator do
   end
 
   it "loads and munges" do
-    Langulator.compile(options).should eq(combined)
+    Langulator.munge(options).should eq(aggregate_incomplete)
   end
+
+  let(:aggregate_complete) do
+    {
+      "spec/fixtures/" => {
+        "food" => {
+          "breakfast" => {"english" => "yoghurt", "norsk" => "joggurt", "francais" => "yaourt"},
+          "lunch" => {"english" => "sandwich", "norsk" => "smørbrød", "francais" => "sandwich"},
+          "dinner" => {
+            "main_course" => {"english" => "steak", "norsk" => "steak", "francais" => "biffteak"},
+            "side" => {"english" => "baked potato", "norsk" => "bakt potet", "francais" => "pomme de terre au four"},
+            "desert" => {"english" => "chocolate mousse", "norsk" => "sjokolademousse", "francais" => "mousse au chocolat"}
+          }
+        }
+      },
+      "spec/fixtures/lang/" => {
+        "volume" => {
+          "sound" => {"english" => "loud", "norsk" => "høyt", "francais" => "fort"},
+          "liquid" => {"english" => "sloshing", "norsk" => "skvulper", "francais" => "agité"},
+          "hair" => {"english" => "because I'm worth it", "norsk" => "for det er jeg verdt", "francais" => "parce que je le vaux bien"}
+        }
+      }
+    }
+  end
+
+  it "untangles" do
+    expected = {
+      "english" => {
+        "spec/fixtures/" => {
+          "food" => {"breakfast" => "yoghurt", "lunch" => "sandwich", "dinner" => {"main_course" => "steak", "side" => "baked potato", "desert" => "chocolate mousse"}}
+        },
+        "spec/fixtures/lang/" => {
+          "volume" => {"sound" => "loud", "liquid" => "sloshing", "hair" => "because I'm worth it"}
+        }
+      },
+      "norsk" => {
+        "spec/fixtures/" => {
+          "food" => {"breakfast" => "joggurt", "lunch" => "smørbrød", "dinner" => {"main_course" => "steak", "side" => "bakt potet", "desert" => "sjokolademousse"}}
+        },
+        "spec/fixtures/lang/" => {
+          "volume" => {"sound" => "høyt", "liquid" => "skvulper", "hair" => "for det er jeg verdt"}
+        }
+      },
+      "francais" => {
+        "spec/fixtures/" => {
+          "food" => {"breakfast" => "yaourt", "lunch" => "sandwich", "dinner" => {"main_course" => "biffteak", "side" => "pomme de terre au four", "desert" => "mousse au chocolat"}}
+        },
+        "spec/fixtures/lang/" => {
+          "volume" => {"sound" => "fort", "liquid" => "agité", "hair" => "parce que je le vaux bien"}
+        }
+      }
+    }
+    Langulator.untangle(aggregate_complete, :languages => ["english", "norsk", "francais"]).should eq(expected)
+  end
+
 end

data/spec/untangler_spec.rb

@@ -0,0 +1,75 @@
+# encoding: utf-8
+require 'langulator/untangler'
+
+describe Langulator::Untangler do
+  let(:aggregate) do
+    {
+      :game => {
+        :rock => {
+          :english => "rock",
+          :french => "pierre",
+        },
+        :paper => {
+          :english => "paper",
+          :french => "papier"
+        },
+        :scissors => {
+          :english => "scissors",
+          :french => "ciseau"
+        },
+        :other => {
+          :deeply => {
+            :english => "nested",
+            :french => "imbriqué"
+          }
+        }
+      }
+    }
+  end
+
+  let(:english) do
+    {
+      :game => {
+        :rock => "rock",
+        :paper => "paper",
+        :scissors => "scissors",
+        :other => {:deeply => "nested"}
+      }
+    }
+  end
+
+  let(:french) do
+    {
+      :game => {
+        :rock => "pierre",
+        :paper => "papier",
+        :scissors => "ciseau",
+        :other => {:deeply => "imbriqué"}
+      }
+    }
+  end
+
+  context "with tangled data" do
+    subject { Langulator::Untangler.new(aggregate, :languages => [:english, :french]) }
+
+    it 'extracts English' do
+      input = {:rock => {:english => "rock"}, :paper => {:english => "paper"}}
+      expected_output = {:rock => "rock", :paper => "paper"}
+      subject.extract(:english, input).should eq(expected_output)
+    end
+
+    it "extracts complicated English" do
+      input = {:a => {:really => {:deeply => {:nested => {:game => {:rock => {:english => "rock"}, :paper => {:english => "paper"}}}}}}}
+      expected_output = {:a => {:really => {:deeply => {:nested => {:game => {:rock => "rock", :paper => "paper"}}}}}}
+      subject.extract(:english, input).should eq(expected_output)
+    end
+
+    it "filters out the english" do
+      subject.untangle[:english].should eq(english)
+    end
+
+    it "filters out the french" do
+      subject.untangle[:french].should eq(french)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: langulator
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70137034740080 !ruby/object:Gem::Requirement
+  requirement: &70102603779800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70137034740080
+  version_requirements: *70102603779800
 description: Manage, maintain, and munge your i18n files.
 email:
 - katrina.owen@gmail.com
@@ -40,12 +40,14 @@ files:
 - lib/langulator.rb
 - lib/langulator/loader.rb
 - lib/langulator/munger.rb
+- lib/langulator/untangler.rb
 - spec/fixtures/english.yml
 - spec/fixtures/lang/english.yml
 - spec/fixtures/norsk.yml
 - spec/langulator_spec.rb
 - spec/loader_spec.rb
 - spec/munger_spec.rb
+- spec/untangler_spec.rb
 homepage: http://github.com/kytrinyx/langulator
 licenses: []
 post_install_message: 
@@ -77,3 +79,4 @@ test_files:
 - spec/langulator_spec.rb
 - spec/loader_spec.rb
 - spec/munger_spec.rb
+- spec/untangler_spec.rb