interpret 0.1.2 → 0.1.3

data/app/models/interpret/translation.rb

@@ -23,7 +23,7 @@ module Interpret
         tree = LazyHash.build_hash
         all_trans = all_trans.map{|x| x.key.split(".")[0..-2].join(".")}.uniq
         all_trans.each do |x|
-          LazyHash.lazy_add(tree, x, {})
+          LazyHash.add(tree, x, {})
         end
 
         # Generate a new clean hash without the proc's from LazyHash.
@@ -38,7 +38,7 @@ module Interpret
         res = LazyHash.build_hash
 
         translations.each do |e|
-          LazyHash.lazy_add(res, "#{e.locale}.#{e.key}", e.value)
+          LazyHash.add(res, "#{e.locale}.#{e.key}", e.value)
         end
         if res.keys.size != 1
           raise IndexError, "Generated hash must have only one root key. Your translation data in datrabase may be corrupted."
@@ -61,26 +61,20 @@ module Interpret
         raise ArgumentError, "the YAML file must contain an unique first key representing the locale" unless hash.keys.count == 1
 
         lang = hash.keys.first
-        to_remove = locale(lang).all
-        to_remove.each do |x|
-          x.destroy
-        end
+        delete_all(:locale => lang)
+
         records = parse_hash(hash.first[1], lang)
         # TODO: Replace with activerecord-import bulk inserts
         transaction do
-          records.each {|x| x.save!}
+          records.each do |x|
+            x.save!
+          end
         end
       end
 
       # Dump all contents from *.yml locale files into the database.
       # CAUTION: All existing data will be erased!
       #
-      # It will create a "#{locale}.yml.backup" file into config/locales
-      # for each language present in the database, in case you want to
-      # recover some of your just-erased translations.
-      # If you don't want backups, set:
-      #
-      # Interpret.options[:dump_without_backup] = true
       def dump
         files = Dir[Rails.root.join("config", "locales", "*.yml").to_s]
         delete_all
@@ -139,18 +133,23 @@ module Interpret
       #
       # - First of all, get the locale keys for the main language from yml files.
       # - For all of these locale keys, do:
-      #   - If a key is present in the db, but not in the new ones, remove
-      #   it. You have removed it from the new content layout, so it's no longer
-      #   needed.
       #   - If the key is not present in the db, it's new. So, create a new
-      #   entry for that key in each language. Look if a translation for that
-      #   key exists in yml files for each language, if it exists, use it. If
-      #   not, left it empty.
+      #   entry for that key in the main language. If the key also exists in
+      #   some other languages in yml files, also create the entry for that
+      #   languages. But, do not create entries for the languages that does
+      #   not have this key. Later you will be notified about that missing
+      #   translations.
       #   - If the key already exists in the db, do nothing. Maybe somone has
       #   changed that content in production, and you don't want to lose
       #   that. Or maybe you do want to change that content, because you
       #   just added the correct sentence in the yml files. It's up to you to
       #   do the right thing.
+      #   Also, if the key is missing in other languages in database but
+      #   present in yml files, create the new entry for that language.
+      #   - If a key is present in the db, but not in the new ones, remove
+      #   it. You have removed it from the new content layout, so it's no longer
+      #   needed.
+      #
       def update
         files = Dir[Rails.root.join("config", "locales", "*.yml").to_s]
 
@@ -165,8 +164,7 @@ module Interpret
           end
         end
 
-        @main = @languages[I18n.default_locale.to_s].clone
-        sync(@main)
+        sync(@languages[I18n.default_locale.to_s])
       end
 
     private
@@ -178,16 +176,15 @@ module Interpret
         end
 
         hash.keys.each do |x|
-          existing.delete(x)
-
           if hash[x].kind_of?(Hash)
             sync(hash[x], "#{prefix}#{x}.", existing[x])
           else
+            existing.delete(x)
             old = locale(I18n.default_locale).find_by_key("#{prefix}#{x}")
 
             unless old
               # Creates the new entry
-              create_new_translation("#{prefix}#{x}")
+              create_new_translation("#{prefix}#{x}", hash[x])
             else
               # Check if the entry exists in the other languages
               check_in_other_langs("#{prefix}#{x}")
@@ -200,37 +197,33 @@ module Interpret
         end
       end
 
-      # Check if the the given key exists in all languages except @main. If
-      # not, create an entry.
+      # Check if the given key exists in @languages for locales other than
+      # I18n.default_locale. Create the existing ones.
       def check_in_other_langs(key)
         (@languages.keys - [I18n.default_locale]).each do |lang|
           trans = locale(lang).find_by_key(key)
           if trans.nil?
-            create! :locale => lang,
-                    :key => key,
-                    :value => "untranslated"
-            Interpret.logger.info "Created inexistent key [#{key}] for lang [#{lang}]"
+            if value = get_value_from_hash(@languages[lang], key)
+              create! :locale => lang, :key => key, :value => value
+              Interpret.logger.info "New key created [#{key}] for language [#{lang}]"
+            end
           end
         end
       end
 
-      def create_new_translation(missing_key)
-        @languages.keys.each do |lang|
-          origin_hash = @languages[lang].clone
-          value = nil
-          missing_key.split(".")[0..-2].each do |key|
-            if origin_hash[key].nil?
-              value = "untranslated"
-              break
-            end
-            origin_hash = origin_hash[key]
-          end
-          value ||= origin_hash[missing_key.split(".").last]
-          create! :locale => lang,
-                  :key => missing_key,
-                  :value => value
+      def get_value_from_hash(hash, key)
+        key.split(".")[0..-2].each do |k|
+          break if hash.nil?
+          hash = hash[k]
         end
-        Interpret.logger.info "New key created [#{missing_key}] for languages #{@languages.keys.inspect}"
+        hash.nil? ? nil : hash[key.split(".").last]
+      end
+
+      def create_new_translation(missing_key, main_value)
+        create! :locale => I18n.default_locale, :key => missing_key, :value => main_value
+        Interpret.logger.info "New key created [#{missing_key}] for language [#{I18n.default_locale}]"
+
+        check_in_other_langs(missing_key)
       end
 
       def remove_unused_keys(hash, prefix = "")

data/interpret.gemspec

@@ -25,6 +25,7 @@ Gem::Specification.new do |s|
   s.add_dependency "ya2yaml", ">= 0.30.0"
   s.add_dependency "will_paginate", ">= 3.0.pre2"
   s.add_dependency "best_in_place", ">= 0.1.7"
+  s.add_dependency "lazyhash", ">= 0.1.1"
 
   s.add_development_dependency "rspec-rails", "~> 2.5"
 end

data/lib/interpret.rb

@@ -1,6 +1,6 @@
 require 'best_in_place'
 require 'will_paginate'
-require 'interpret/lazy_hash'
+require 'lazyhash'
 
 module Interpret
   mattr_accessor :backend

data/lib/interpret/version.rb

@@ -1,3 +1,3 @@
 module Interpret
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

data/spec/models/translation_spec.rb

@@ -1,3 +1,4 @@
+# encoding: utf-8
 require 'spec_helper'
 
 describe Interpret::Translation do
@@ -7,6 +8,7 @@ en:
   p1: Hello world!
   folder1:
     pr1: Hi
+    content: Some large text content
   folder2:
     pr1: Some other text here
   folder3:
@@ -20,19 +22,93 @@ en:
     """
   }
 
+  let(:es_yml) {"""
+es:
+  folder2:
+    pr1: Algun otro texto aqui
+    content: Un largo parrafo con contenido
+  folder3:
+    pr1: Mas frases aleatorias
+    sub:
+      name: Esta es una subcarpeta de segundo nivel
+      subsub:
+        name: Con otra carpeta anidada en su interior
+    other:
+      name: carpeta
+    """
+  }
+
+  let(:new_en_yml) {"""
+en:
+  p1: Hello modified world! This new translation should not be copied into database
+  new_key: This new key should be created with this english text
+  new_key_in_en: This new key that only exists in english should be created only in english
+
+  folder1:
+    pr1: Hi
+  folder2:
+    pr1: Some other text here
+  folder3:
+    pr1: More phrases
+    sub:
+      name: This is a 2 level subfolder
+      subsub:
+        name: With another nested folder inside
+    other:
+      name: folder
+  """
+  }
+
+  let(:new_es_yml) {"""
+es:
+  p1: Hola mon! Esta nueva traduccion al español deberia copiarse en base de datos porque no existe previamente en :es, aunque si en :en
+  new_key: Esta nueva clave debe crearse con este texto en español
+
+  folder1:
+    pr1: Nueva traduccion que tambien debe copiarse
+  folder2:
+    pr1: Algun otro texto aqui
+    content: Un largo parrafo con contenido
+  folder3:
+    pr1: Mas frases aleatorias
+    sub:
+      name: Esta es una subcarpeta de segundo nivel
+      subsub:
+        name: Con otra carpeta anidada en su interior
+    other:
+      name: carpeta
+  """
+  }
+
+  # Convert a locale file into database translations
   def file2db(string_file)
-    hash = YAML.load string_file
+    def parse_hash(dict, locale, prefix = "")
+      res = []
+      dict.keys.each do |x|
+        if dict[x].kind_of?(Hash)
+          res += parse_hash(dict[x], locale, "#{prefix}#{x}.")
+        else
+          res << Interpret::Translation.new(:locale => locale, :key => "#{prefix}#{x}", :value => dict[x])
+        end
+      end
+      res
+    end
 
+    hash = YAML.load string_file
     lang = hash.keys.first
-    records = Interpret::Translation.send(:parse_hash, hash.first[1], lang)
     Interpret::Translation.transaction do
-      records.each {|x| x.save!}
+      parse_hash(hash.first[1], lang).map{|x| x.save!}
     end
   end
 
+  before do
+    I18n.stub!(:default_locale).and_return('en')
+  end
+
   describe ".get_tree" do
     it "should return a hash representing a tree folder structure of the i18n keys" do
       file2db(en_yml)
+
       Interpret::Translation.get_tree('en').should == {'index' => {
         'folder1' => {},
         'folder2' => {},
@@ -49,20 +125,114 @@ en:
   describe ".export" do
     it "should return a hash representing the yml locale file for the given translations" do
       file2db(en_yml)
+
       translations = Interpret::Translation.all
       Interpret::Translation.export(translations).should == YAML.load(en_yml)
     end
   end
 
-  describe ".import" do
-    pending
+  describe ".update" do
+    before(:all) do
+      # Supose the database has the default contents, look at the top of this
+      # file for en_yml simulated locale file
+      file2db(en_yml)
+      file2db(es_yml)
+    end
+
+    before do
+      Dir.stub!(:"[]").and_return(['/path/to/en.yml', '/path/to/es.yml'])
+      YAML.should_receive(:load_file).twice.and_return(YAML.load(new_en_yml), YAML.load(new_es_yml))
+    end
+
+    context "when a key exists in database but not in yml files [for I18n.default_locale]" do
+      it "should remove that key from database for I18n.default_locale" do
+        Interpret::Translation.update
+        Interpret::Translation.locale('en').find_by_key("folder1.content").should be_nil
+      end
+
+      it "should remove that key if it exists for any other language in database" do
+        Interpret::Translation.update
+        Interpret::Translation.locale('es').find_by_key("folder1.content").should be_nil
+      end
+    end
+
+    context "when a key exists in yml files but not in database [for I18.default_locale]" do
+      it "should create the key for I18n.default_locale with the value from yml files" do
+        Interpret::Translation.update
+        translation = Interpret::Translation.locale('en').find_by_key("new_key")
+        translation.value.should == "This new key should be created with this english text"
+      end
+
+      it "should not create an entry for a key in a language that do not have it" do
+        Interpret::Translation.update
+        Interpret::Translation.locale('es').find_by_key("new_key_in_en").should be_nil
+      end
+
+      it "should look for that key in other languages from yml files and create the existing ones." do
+        Interpret::Translation.update
+        translation = Interpret::Translation.locale('es').find_by_key("new_key")
+        translation.value.should == "Esta nueva clave debe crearse con este texto en español"
+      end
+    end
+
+    context "when a key exists in both yml files and database [for I18n.default_locale]" do
+      it "should not override the contents of the existing database translations" do
+        Interpret::Translation.update
+        translation = Interpret::Translation.locale('en').find_by_key("p1")
+        translation.value.should == "Hello world!"
+      end
+
+      it "should check if there is a language (other than I18n.default_locale) for which that key is new, and create the entry." do
+        Interpret::Translation.update
+        translation = Interpret::Translation.locale('es').find_by_key("p1").should_not be_nil
+      end
+    end
   end
 
   describe ".dump" do
-    pending
+    it "should dump all contents from yml files into database" do
+      # Initial database state
+      file2db(en_yml)
+      file2db(es_yml)
+
+      Dir.stub!(:"[]").and_return(['/path/to/en.yml', '/path/to/es.yml'])
+      YAML.should_receive(:load_file).twice.and_return(YAML.load(new_en_yml), YAML.load(new_es_yml))
+      Interpret::Translation.dump
+
+      # We use export to check for the existing database contents, which is
+      # also tested in this spec file
+      en_trans = Interpret::Translation.locale('en').all
+      Interpret::Translation.export(en_trans).should == YAML.load(new_en_yml)
+
+      es_trans = Interpret::Translation.locale('es').all
+      Interpret::Translation.export(es_trans).should == YAML.load(new_es_yml)
+    end
   end
 
-  describe ".update" do
-    pending
+  describe ".import" do
+    before do
+      @file = new_en_yml
+    end
+
+    it "should dump the contents for the given file into database" do
+      file2db(en_yml)
+      @file.stub!(:content_type).and_return("text/plain")
+      Interpret::Translation.import(@file)
+
+      en_trans = Interpret::Translation.locale('en').all
+      Interpret::Translation.export(en_trans).should == YAML.load(new_en_yml)
+    end
+
+    it "should not modify the database contents for other languages" do
+      Interpret::Translation.delete_all
+      file2db(en_yml)
+      file2db(es_yml)
+
+      @file.stub!(:content_type).and_return("text/plain")
+      Interpret::Translation.import(@file)
+
+      es_trans = Interpret::Translation.locale('es').all
+      Interpret::Translation.export(es_trans).should == YAML.load(es_yml)
+    end
   end
 end

metadata

@@ -1,12 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: interpret
 version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 1
-  - 2
-  version: 0.1.2
+  prerelease: 
+  version: 0.1.3
 platform: ruby
 authors: 
 - Roger Campos
@@ -14,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-15 00:00:00 +01:00
+date: 2011-02-18 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -25,10 +21,6 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        segments: 
-        - 3
-        - 0
-        - 3
         version: 3.0.3
   type: :runtime
   version_requirements: *id001
@@ -40,10 +32,6 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 5
-        - 0
         version: 0.5.0
   type: :runtime
   version_requirements: *id002
@@ -55,8 +43,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
         version: "0"
   type: :runtime
   version_requirements: *id003
@@ -68,10 +54,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 30
-        - 0
         version: 0.30.0
   type: :runtime
   version_requirements: *id004
@@ -83,10 +65,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 3
-        - 0
-        - pre2
         version: 3.0.pre2
   type: :runtime
   version_requirements: *id005
@@ -98,27 +76,31 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 1
-        - 7
         version: 0.1.7
   type: :runtime
   version_requirements: *id006
 - !ruby/object:Gem::Dependency 
-  name: rspec-rails
+  name: lazyhash
   prerelease: false
   requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.1.1
+  type: :runtime
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: rspec-rails
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        segments: 
-        - 2
-        - 5
         version: "2.5"
   type: :development
-  version_requirements: *id007
+  version_requirements: *id008
 description: Manage your app translations with an i18n active_record backend
 email: 
 - roger@itnig.net
@@ -157,7 +139,6 @@ files:
 - lib/interpret/capistrano.rb
 - lib/interpret/engine.rb
 - lib/interpret/helpers.rb
-- lib/interpret/lazy_hash.rb
 - lib/interpret/logger.rb
 - lib/interpret/version.rb
 - lib/tasks/interpret.rake
@@ -235,21 +216,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: interpret
-rubygems_version: 1.3.7
+rubygems_version: 1.5.2
 signing_key: 
 specification_version: 3
 summary: Manage your app translations with an i18n active_record backend

data/lib/interpret/lazy_hash.rb

@@ -1,21 +0,0 @@
-# Gist from: https://gist.github.com/745617
-module LazyHash
-  class << self
-    def lazy_add(hash, key, value, pre = nil)
-      skeys = key.split(".")
-      f = skeys.shift
-      if skeys.empty?
-        pre.nil? ? hash.send("[]=", f, value) : pre.send("[]=", f, value)
-      else
-        pre = pre.nil? ? hash.send("[]", f) : pre.send("[]", f)
-        lazy_add(hash, skeys.join("."), value, pre)
-      end
-    end
-
-    def build_hash
-      lazy = lambda { |h,k| h[k] = Hash.new(&lazy) }
-      Hash.new(&lazy)
-    end
-  end
-end
-