i18n_sync 0.1.0 → 0.3.0

data/README.rdoc

@@ -1,21 +1,47 @@
-= i18n_sync
+i18n Sync!
+==========
 
 Syncs all locale yml/rb files based on a "master" one.
 
 
-== Install
+Install
+-------
 
-  gem install i18n_sync
+    gem install i18n_sync
 
 
-= Use
+Use
+---
 
-  i18s path/to/master/file.yml
+
+    i18s path/to/master/file.lang.yml
 
 All other yml should be located on the same folder as the "master".
 
+Example:
+
+
+    i18s config/locales/app.en.yml
+
+This command syncs all config/locale/app.*.yml files
+using en as the master.
+
+
+Other Options
+-------------
+
+    i18s add some.very.nested.key Value path/to/file
+
+Adds the new key on the file and every other translation.
+
+
+    i18s path/to/directory
+
+Syncronizes the entire directory.
+
 
-== Note on Patches/Pull Requests
+Note on Patches/Pull Requests
+-----------------------------
 
 * Fork the project.
 * Make your feature addition or bug fix.
@@ -25,6 +51,7 @@ All other yml should be located on the same folder as the "master".
   (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
 * Send me a pull request. Bonus points for topic branches.
 
-== Copyright
+Copyright
+---------
 
 Copyright (c) 2010 Marcos Piccinini. See LICENSE for details.

data/Rakefile

@@ -1,5 +1,7 @@
 require 'rubygems'
 require 'rake'
+require 'rspec/core/rake_task'
+
 
 begin
   require 'jeweler'
@@ -11,7 +13,7 @@ begin
     gem.homepage = "http://github.com/nofxx/i18n_sync"
     gem.authors = ["Marcos Piccinini"]
     gem.add_dependency "ya2yaml"
-    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_development_dependency "rspec", ">= 2.5.0"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
   Jeweler::GemcutterTasks.new
@@ -19,21 +21,14 @@ rescue LoadError
   puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
 end
 
-# require 'spec/rake/spectask'
-# Spec::Rake::SpecTask.new(:spec) do |spec|
-#   spec.libs << 'lib' << 'spec'
-#   spec.spec_files = FileList['spec/**/*_spec.rb']
-# end
-
-# Spec::Rake::SpecTask.new(:rcov) do |spec|
-#   spec.libs << 'lib' << 'spec'
-#   spec.pattern = 'spec/**/*_spec.rb'
-#   spec.rcov = true
-# end
 
-# task :spec => :check_dependencies
+desc "Runs spec suite"
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = 'spec/*_spec.rb'
+  spec.rspec_opts = ['--backtrace --colour']
+end
 
-# task :default => :spec
+task :default => :spec
 
 require 'rake/rdoctask'
 Rake::RDocTask.new do |rdoc|

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.3.0

data/bin/i18s

@@ -14,7 +14,7 @@ require 'optparse'
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'i18n_sync'
 
-Options = {}
+Options = {:lang => :en}
 
 parser = OptionParser.new do |opts|
   opts.banner = <<BANNER
@@ -24,8 +24,9 @@ Usage: #{File.basename($0)} <path/to/master.yml> [args]
 
 Options are:
 
-     -o --order    -  Order by name
-     -t --trace    -  Be more verbose
+     -l --lang LANG   -  Select a default language
+     -o --order       -  Order by name
+     -t --trace       -  Be more verbose
 
 Common usage:
 
@@ -34,15 +35,22 @@ Common usage:
 
 
 BANNER
+  opts.on("-l LANGUAGE", "--lang", "Default Language" ) { |l| Options[:lang] = l }
   opts.on("-O", "--no-order", "Table order" ) { Options[:order] = false }
-  opts.on("-t", "--trace") { Options[:trace] = true }
+  opts.on("-v", "--verbose") { Options[:debug] = true }
   opts.parse!(ARGV)
 end
 
 if ARGV.empty?
-  puts parser.banner
-  exit
+  # ipaths = %w{ config/locales lib/locales }.select { |ipath| File.exists?(ipath) }
+  # unless ipaths.empty?
+  #   ipaths.each { |i| I18S.work_on(i) }
+  # else
+    puts parser.banner
+    exit
+  # end
+elsif ARGV[0] == "add"
+  I18S.add_key *ARGV[1..-1]
 else
-  syncr = I18S.new ARGV, Options # ARGF
-  syncr.work
+  I18S.work_on ARGV, Options # ARGF
 end

data/i18n_sync.gemspec

@@ -1,63 +1,68 @@
 # Generated by jeweler
 # DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{i18n_sync}
-  s.version = "0.0.5"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Marcos Piccinini"]
-  s.date = %q{2010-07-16}
+  s.date = %q{2011-06-06}
   s.default_executable = %q{i18s}
   s.description = %q{Gem to sync all locale yml/rb files based on a "master" one.}
   s.email = %q{x@nofxx.com}
   s.executables = ["i18s"]
   s.extra_rdoc_files = [
     "LICENSE",
-     "README.rdoc"
+    "README.rdoc"
   ]
   s.files = [
     ".document",
-     ".gitignore",
-     "LICENSE",
-     "README.rdoc",
-     "Rakefile",
-     "VERSION",
-     "bin/i18s",
-     "i18n_sync.gemspec",
-     "lib/i18n_sync.rb",
-     "spec/fixtures/en.yml",
-     "spec/fixtures/named.en.yml",
-     "spec/fixtures/named.pt.yml",
-     "spec/fixtures/order.en.yml",
-     "spec/fixtures/order.pt.yml",
-     "spec/fixtures/pt.yml",
-     "spec/i18n_sync_spec.rb",
-     "spec/spec_helper.rb"
+    "LICENSE",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "bin/i18s",
+    "i18n_sync.gemspec",
+    "lib/i18n_sync.rb",
+    "spec/fixtures/children.en.yml",
+    "spec/fixtures/children.pt.yml",
+    "spec/fixtures/en.yml",
+    "spec/fixtures/extra.en.yml",
+    "spec/fixtures/extra.pt.yml",
+    "spec/fixtures/named.en.yml",
+    "spec/fixtures/named.pt.yml",
+    "spec/fixtures/order.en.yml",
+    "spec/fixtures/order.pt.yml",
+    "spec/fixtures/pt.yml",
+    "spec/i18n_sync_spec.rb",
+    "spec/results/children.pt.yml",
+    "spec/results/extra.pt.yml",
+    "spec/results/named.pt.yml",
+    "spec/results/order.en.yml",
+    "spec/spec_helper.rb"
   ]
   s.homepage = %q{http://github.com/nofxx/i18n_sync}
-  s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.7}
   s.summary = %q{Syncs all locale yml/rb files based on a "master" one.}
-  s.test_files = [
-    "spec/spec_helper.rb",
-     "spec/i18n_sync_spec.rb"
-  ]
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_runtime_dependency(%q<ya2yaml>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 2.5.0"])
     else
-      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_dependency(%q<ya2yaml>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 2.5.0"])
     end
   else
-    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    s.add_dependency(%q<ya2yaml>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 2.5.0"])
   end
 end
 

data/lib/i18n_sync.rb

@@ -1,58 +1,96 @@
 #
-# Based on translation rake task on spree (http://spreecommerce.com/)
+# Inspired by translation rake task on spree (http://spreecommerce.com/)
 #
+# Changed to use YAML instead of text regex, but yaml has issues so we need to:
 require 'ya2yaml'
+# To work with utf8 encoded .yml files.
+
+
+class Hash
+  def deep_merge!(other_hash)
+    other_hash.each do |k,v|
+      next unless tv = self[k]
+      self[k] = tv.is_a?(Hash) && v.is_a?(Hash) ? tv.dup.deep_merge!(v) : v
+    end
+    self
+  end
+end
 
 class I18S
 
-  def initialize(argv, opts = {}, argf=[])
+  # Just here cuz I'm lazy....TBF really ugly !  ! ! !
+  def self.work_on(argv, opts = {}, argf = [])
+    if File.directory? path = argv[0]
+      Dir["#{path}/**"].map do |file|
+        next unless file =~ /(^|\.)#{opts[:lang]}\./
+        new([file], opts, argf)
+      end.reject(&:nil?)
+    else
+      [new(argv, opts, argf)]
+    end
+  end
+
+  def self.recursive_hash
+    Hash.new { |h,k| h[k] = recursive_hash }
+  end
+
+  def self.add_key(key, val, file)
+    hsh = Hash.new { |h, k| h[k] = Hash.new(&h.default_proc) }#recursive_hash
+    keys = key.split(".")
+    keys.reduce(hsh) do |a, k|
+      k == keys[-1] ? a[k] = val : a = a[k]
+    end
+    new(file, {}, hsh)
+  end
+
+  def initialize(argv, opts = {}, keys = {}, argf=[])
     # argf.each { |file| p file }
     @fullpath, *@new_ones = argv
     @file, *path = @fullpath.split("/").reverse # hm.. hack,,, in 1.9
     @path = path.reverse.join("/") || "."       # can splat the first
     _, @lang, @namespace = @file.split(".").reverse
-    @debug = opts[:trace]
+    @debug = opts[:debug]
     @order = opts[:order]
     @comments, @words = read_file(@fullpath, @lang)
+    @words.merge! keys unless keys.empty?
+    work
   end
 
   def work
-    puts "Start work on #{@file} (#{@lang})"
+    out "Start work on #{@file} (#{@lang})"
     @new_ones.empty? ? sync : create_new_files
   end
 
   def create_new_files
-    @new_ones.each do |file|
-      puts "Creating new file #{file}"
-      create(file)
+    @new_ones.each do |name|
+      puts "Creating new file #{name}"
+      create name
     end
   end
 
   def sync
     Dir["#{@path}/*.{yml,rb}"].each do |filename|
-      #next if filename.match('_rails')
-      next if filename =~ /#{@file}/
-      lang, namespace = File.basename(filename, '.yml').split(".").reverse  #filename.split("/").last.split(".").reverse
+      lang, namespace = File.basename(filename, '.yml').split(".").reverse
       if namespace
         next unless @namespace && @namespace == namespace
       else
         next if @namespace
       end
 
-      puts "Writing #{filename}"
-      (_comments, other) = read_file(filename, lang)
+      out "Writing #{filename}"
+      (_comments, old) = read_file(filename, lang)
       # Initializing hash variable as empty if it does not exist
-      @words.each { |k,v| other[k] ||= @words[k] }
-      # Remove if not defined in master
-      other.delete_if { |k,v| !@words[k] }
+      other = @words.dup.deep_merge! old
       write_file(filename, lang, @comments, other)
     end
   end
 
-  def create(file)
-    fullpath = file =~ /\// ? file : "#{@path}/#{file}.yml"
+  def create newlang
+    # New name  "app.en.yml" -> "app.pt.yml", "en.yml" -> "pt.yml"
+    newname =  @file.gsub(/(^|\.)#{@lang}\./, "\\1#{newlang}.")
+    fullpath =  "#{@path}/#{newname}"
     return puts("File exists.") if File.exists?(fullpath)
-    write_file(fullpath, file, @comments, @words)
+    write_file(fullpath, newlang, @comments, @words)
   end
 
   #Retrieve comments, translation data in hash form
@@ -61,40 +99,12 @@ class I18S
     [comments, YAML.load(File.open(filename, "r:utf-8"))[basename]]
   end
 
-  #Creates hash of translation data
-  #def create_hash(data, filename)
-    # return {} unless data
-    # words = Hash.new
-    # return words if !data
-    # parent = Array.new
-    # previous_key = 'base'
-    # data.split("\n").each do |w|
-    #   next if w.strip.empty?
-    #   w.sub!(":", "") if w =~ /^(\s*)\:/
-    #   (key, *value) = w.split(':')
-    #   value = value.join# ||= ''
-    #   shift = (key =~ /\w/)/2 - parent.size                             #Determine level of current key in comparison to parent array
-    #   key = key.sub(/^\s+/,'')
-    #   parent << previous_key if shift > 0                               #If key is child of previous key, add previous key as parent
-    #   (shift*-1).times { parent.pop } if shift < 0                      #If key is not related to previous key, remove parent keys
-    #   previous_key = key                                                #Track key in case next key is child of this key
-    #   words[parent.join(':')+':'+key] = value
-    # end
-    # words
-  #end
-
   #Writes to file from translation data hash structure
   def write_file(filename, basename, comments, data)
     File.delete filename if File.exists? filename
     File.open(filename, "w:utf-8") do |y|
       y.puts(comments) if comments
-      #y.puts(basename + ":\n")
-      y.puts({ basename => data }.ya2yaml )# (:sick_compatible => true))
-      # words.sort.each do |k,v|
-      #   keys = k.split(':')
-      #   (keys.size-1).times { keys[keys.size-1] = '  ' + keys[keys.size-1] }   #Add indentation for children keys
-      #   y.puts(keys[keys.size-1]+':'+v+"\n")
-      # end
+      y.puts({ basename => data }.ya2yaml )
     end
   end
 

data/spec/fixtures/children.en.yml

@@ -0,0 +1,14 @@
+en:
+  another: Another
+  newone: "New One!"
+  test: Test
+  very:
+    nasty:
+      nested:
+        bax: Bax
+        foo: Foo
+        bar: Bar
+  newvery:
+    nasty:
+      nested:
+        hi: Hi

data/spec/fixtures/children.pt.yml

@@ -0,0 +1,8 @@
+pt:
+  test: Teste
+  old: Velho
+  very:
+    nasty:
+      nested:
+        foo: Fu
+        old: Velho

data/spec/i18n_sync_spec.rb

@@ -7,8 +7,16 @@ def run(comm)
   `bin/i18s #{comm}`
 end
 
+def result(name)
+  File.read("spec/results/#{name}.yml")
+end
+
+def files_should_match(name, extra = nil)
+  File.read("spec/work#{extra}/#{name}.yml").should eql(result(name))
+end
+
 describe "I18nSync" do
-  before(:each) do
+  before do
     `rm -rf spec/work`
     `cp -rf spec/fixtures spec/work`
   end
@@ -40,6 +48,7 @@ describe "I18nSync" do
   end
 
   describe "Namespaced" do
+
     let(:i) { I18S.new("spec/work/named.en.yml") }
 
     it "should parse master file" do
@@ -50,20 +59,14 @@ describe "I18nSync" do
     end
 
     it "should read the hash" do
-      i.instance_variable_get("@words").should eql({"something"=>"Something", "another"=>"Another"})
+      i.instance_variable_get("@words").
+        should eql({"something"=>"Something", "another"=>"Another"})
     end
 
   end
 
   describe "Acceptance" do
 
-    it "should create a new one" do
-      newfile = "spec/work/fo.yml"
-      `rm #{newfile}` if File.exists?(newfile)
-      run("#{EN} fo")
-      File.read(newfile).should eql("# Comment cool\n--- \nfo: \n  sync: \"To Sync It!\"\n  test: Test\n")
-    end
-
     it "should sync files nicely" do
       run("spec/work/pt.yml")
       File.read(EN).should eql("\n--- \nen: \n  new: \"Uau, isso é novo\"\n  sync: \"To Sync It!\"\n  test: Test\n")
@@ -76,21 +79,71 @@ describe "I18nSync" do
 
     it "should work with namespaces" do
       run("spec/work/named.en.yml")
-      File.read("spec/work/named.pt.yml").should eql("\n--- \npt: \n  another: Another\n  something: Algo\n")
-      File.read("spec/work/pt.yml").should eql("\npt:\n  sync: To Sync It!\n  test: Teste\n  new: \"Uau, isso é novo\"\n")
+      files_should_match("named.pt")
+      File.read("spec/work/pt.yml").
+        should eql("\npt:\n  sync: To Sync It!\n  test: Teste\n  new: \"Uau, isso é novo\"\n")
     end
 
     it "should order alphabeticaly namespaces" do
       run("spec/work/order.pt.yml")
-      File.read("spec/work/order.en.yml").should eql("\n--- \nen: \n  alpha: Alpha\n  blue: Blue\n  zebra: Zebra\n")
+      files_should_match("order.en")
       File.read("spec/work/named.pt.yml").should eql("\npt:\n  something: Algo\n")
     end
 
     it "should work with extra chars" do
       run("spec/work/extra.en.yml")
-      File.read("spec/work/extra.pt.yml").should eql("\n--- \npt: \n  normal: Normal\n  with_colon: \"Value: Rock\"\n  yup: Sim\n")
+      files_should_match("extra.pt")
+    end
+
+    it "should work with deep nestings" do
+      run("spec/work/children.en.yml")
+      files_should_match("children.pt")
+    end
+
+  end
+
+  describe "Creating files" do
+
+    it "should create a new one" do
+      newfile = "spec/work/fo.yml"; `rm #{newfile}` if File.exists?(newfile)
+      run("#{EN} fo")
+      File.read(newfile).should eql("# Comment cool\n--- \nfo: \n  sync: \"To Sync It!\"\n  test: Test\n")
+    end
+
+    it "should create a new with the right name" do
+      newfile = "spec/work/named.fo.yml"; `rm #{newfile}` if File.exists?(newfile)
+      run("spec/work/named.en.yml fo")
+      File.read(newfile).should eql("\n--- \nfo: \n  another: Another\n  something: Something\n")
+    end
+
+  end
+
+  describe "Multi Files" do
+
+    before do
+      `rm -rf spec/workmulti`
+      `cp -rf spec/fixtures spec/workmulti`
     end
 
+    it "should sync a show directory" do
+      run("spec/workmulti")
+      files_should_match("extra.pt", :multi)
+    end
+
+  end
+
+  describe "Add keys to i18n!" do
+
+    it "should have a nice command to add stuff" do
+      run("add dynamic Dynamic spec/work/en.yml")
+      File.read("spec/work/en.yml").should eql("# Comment cool\n--- \nen: \n  dynamic: Dynamic\n  sync: \"To Sync It!\"\n  test: Test\n")
+    end
+
+    it "should work on a complex scenario" do
+      run("add dynamic.nested.very.nasty Nasty spec/work/extra.en.yml")
+      File.read("spec/work/extra.en.yml").should eql("\n--- \nen: \n  dynamic: \n    nested: \n      very: \n        nasty: Nasty\n  normal: Normal\n  with_colon: \"Value: Rock\"\n  yup: true\n")
+
+    end
   end
 
 end

data/spec/results/children.pt.yml

@@ -0,0 +1,16 @@
+
+--- 
+pt: 
+  another: Another
+  newone: "New One!"
+  newvery: 
+    nasty: 
+      nested: 
+        hi: Hi
+  test: Teste
+  very: 
+    nasty: 
+      nested: 
+        bar: Bar
+        bax: Bax
+        foo: Fu

data/spec/results/extra.pt.yml

@@ -0,0 +1,6 @@
+
+--- 
+pt: 
+  normal: Normal
+  with_colon: "Value: Rock"
+  yup: Sim

data/spec/results/named.pt.yml

@@ -0,0 +1,5 @@
+
+--- 
+pt: 
+  another: Another
+  something: Algo

data/spec/results/order.en.yml

@@ -0,0 +1,6 @@
+
+--- 
+en: 
+  alpha: Alpha
+  blue: Blue
+  zebra: Zebra

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
+  - 3
   - 0
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Marcos Piccinini
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-04 00:00:00 -03:00
+date: 2011-06-06 00:00:00 -03:00
 default_executable: i18s
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -39,10 +39,10 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version 
         segments: 
-        - 1
         - 2
-        - 9
-        version: 1.2.9
+        - 5
+        - 0
+        version: 2.5.0
   type: :development
   version_requirements: *id002
 description: Gem to sync all locale yml/rb files based on a "master" one.
@@ -63,6 +63,8 @@ files:
 - bin/i18s
 - i18n_sync.gemspec
 - lib/i18n_sync.rb
+- spec/fixtures/children.en.yml
+- spec/fixtures/children.pt.yml
 - spec/fixtures/en.yml
 - spec/fixtures/extra.en.yml
 - spec/fixtures/extra.pt.yml
@@ -72,6 +74,10 @@ files:
 - spec/fixtures/order.pt.yml
 - spec/fixtures/pt.yml
 - spec/i18n_sync_spec.rb
+- spec/results/children.pt.yml
+- spec/results/extra.pt.yml
+- spec/results/named.pt.yml
+- spec/results/order.en.yml
 - spec/spec_helper.rb
 has_rdoc: true
 homepage: http://github.com/nofxx/i18n_sync
@@ -105,6 +111,5 @@ rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Syncs all locale yml/rb files based on a "master" one.
-test_files: 
-- spec/i18n_sync_spec.rb
-- spec/spec_helper.rb
+test_files: []
+