ceritium-lost-in-translation 0.1.0

data/README.rdoc

@@ -0,0 +1,82 @@
+= LostInTranslation
+
+== Description
+
+LostInTranslation es una pequeña gema que nos puede ayudar a mantener al día las traducciones en nuestras aplicaciones que tiren la API I18n de RAILS y que tengan como backend los ficheros yaml.
+
+
+== Installation
+
+    sudo gem install lost-in-translation
+
+== Uso
+
+    
+Su uso es muy sencillo, con solo dos comandos lineas ya puedes recorrer todo el directorio _app_ de tu aplicación y añadir los traducción que anden sueltas al fichero _en.yaml_.
+
+    require 'lost_in_translation'
+    
+
+    i18n = LostInTranslation.new
+    i18n.save_translations
+
+También tienes otros métodos disponibles para configurar el idioma o el archivo de destino.
+
+    i18n = LostInTranslation.new
+
+    # Pone el español como el idioma de destino
+    i18n.locale = 'es'
+
+    # Si por ejemplo queremos almacenar las traducciónes en otro archivo, en este case será prueba_es.yaml
+    i18n.file = 'prueba_es'
+
+    i18n.save
+    
+
+== TODO
+
+- Tests
+- Añadir a varios idiomas a la vez
+- Traducir
+
+== Fedback
+
+Se agradece todo el feedback posible, desde errores, casos de uso o posibles mejoras.
+
+Blog: 
+http://ceritium.net/476/programacion/rails/lost-in-translation
+
+Correo: ceritium@gmail.com
+
+<b>Fork Me!</b>
+
+== Agradecimientos
+
+Al plugin Translate del que pillo algunos métodos.
+http://github.com/newsdesk/translate/tree/master
+
+
+== License
+
+Copyright (c) <year> <copyright holders>
+
+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/Rakefile

@@ -0,0 +1,40 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'rake/testtask'
+
+require 'lib/lost_in_translation/version'
+
+task :default => :test
+
+spec = Gem::Specification.new do |s|
+  s.name             = 'lost-in-translation'
+  s.version          = LostInTranslation::Version.to_s
+  s.has_rdoc         = true
+  s.extra_rdoc_files = %w(README.rdoc)
+  s.rdoc_options     = %w(--main README.rdoc)
+  s.summary          = "This gem does ... "
+  s.author           = 'First Last'
+  s.email            = 'user@example.com'
+  s.homepage         = 'http://my-site.net'
+  s.files            = %w(README.rdoc Rakefile) + Dir.glob("{lib,test}/**/*")
+  # s.executables    = ['lost-in-translation']
+  
+  # s.add_dependency('gem_name', '~> 0.0.1')
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.verbose = true
+end
+
+desc 'Generate the gemspec to serve this Gem from Github'
+task :github do
+  file = File.dirname(__FILE__) + "/#{spec.name}.gemspec"
+  File.open(file, 'w') {|f| f << spec.to_ruby }
+  puts "Created gemspec: #{file}"
+end

data/lib/lost_in_translation.rb

@@ -0,0 +1,5 @@
+#$:.unshift File.dirname(__FILE__)
+
+require 'pathname'
+require 'lost_in_translation/lost_in_translation'
+

data/lib/lost_in_translation/lost_in_translation.rb

@@ -0,0 +1,117 @@
+class LostInTranslation
+  # Expresión regular para recoger todas las cadenas de traducción de la aplicación
+  MATCH = /\b(?:I18n\.t|I18n\.translate|t)(?:\s|\():?'([a-z0-9_]+.[a-z0-9_.]+)'\)?/
+
+  attr_accessor :file, :locale, :path
+  
+  def initialize
+    @locale = 'en'
+    @file = "config/locales/#{@locale}.yml"
+    @translations = []
+    @hash = {}
+    @path = 'app/'
+  end
+
+  # Escaneamos la carpeta en busca de todas las cadenas coincidentes con la expresión regular
+  def scan
+    @translations = []
+    Pathname.new(@path).find do |path|
+      if can_open?(path)
+        read_file(path)
+      end
+    end
+    @translations.flatten!
+  end
+  
+  def store
+    scan if @translations.empty?
+    @translations.each do |translation|
+      key_value = to_deep_hash({translation => nil})
+      translation = deep_symbolize_keys(key_value)
+      merger = proc { |key, v1, v2| Hash === v1 && Hash === v2 ? v1.merge(v2, &merger) : v2 }
+      @hash.merge!(translation, &merger)
+    end
+    @hash = deep_stringify_keys({@locale  => @hash})
+  end
+  
+  # Guarda en el .yml las nuevas traducciones encontradas
+  def save
+    store if @hash.empty?
+    File.open(@file, "w") do |file|
+      file.puts @hash.to_yaml
+    end
+  end
+
+  
+  private
+  
+  def deep_symbolize_keys(hash)
+    hash.inject({}) { |result, (key, value)|
+      value = deep_symbolize_keys(value) if value.is_a? Hash
+      result[(key.to_sym rescue key) || key] = value
+      result
+    }
+  end
+  
+  def to_deep_hash(hash)    
+    hash.inject({}) do |deep_hash, (key, value)|
+      keys = key.split('.').reverse
+      leaf_key = keys.shift
+      key_hash = keys.inject({leaf_key.to_sym => value}) { |hash, key| {key.to_sym => hash} }
+      deep_merge!(deep_hash, key_hash)
+      deep_hash
+    end
+  end
+  
+  def deep_merge!(hash1, hash2)
+    merger = proc { |key, v1, v2| Hash === v1 && Hash === v2 ? v1.merge(v2, &merger) : v2 }
+    hash1.merge!(hash2, &merger)
+  end
+  
+  def deep_stringify_keys(hash)
+    hash.inject({}) { |result, (key, value)|
+      value = deep_stringify_keys(value) if value.is_a? Hash
+      result[(key.to_s rescue key) || key] = value
+      result
+    }
+  end
+  
+  # Convertimos el hash que le pasemos a un array
+  # NOTA: Este método está sacado del plugin translate
+  # http://github.com/newsdesk/translate
+  def extract_i18n_keys(hash, parent_keys = [])
+    hash.inject([]) do |keys, (key, value)|
+      full_key = parent_keys + [key]
+      if value.is_a?(Hash)
+        # Nested hash
+        keys += extract_i18n_keys(value, full_key)
+      elsif value.present?
+        # String leaf node
+        keys << full_key.join(".")
+      end
+      keys
+    end
+  end
+  
+  # Comprueba si es un fichero y si puedo leerlo
+  def can_open?(path)
+    !path.directory? && !path.zero? && path.readable?
+  end
+  
+  # Leemos el fichero de donde sacaremos las traducciones del tipo t()
+  def read_file(file)
+    file.readlines.each do |line|
+      scan_line(line)
+    end
+  end
+  
+  # Escaneamos la linea busqueda de cadenas del tipo t()
+  # y añadimos las coincidencias a @translations
+  def scan_line(line)
+    line.scan(MATCH) do |match|
+      @translations << match
+    end
+  end
+  
+end
+

data/lib/lost_in_translation/version.rb

@@ -0,0 +1,13 @@
+module LostInTranslation
+  module Version
+    
+    MAJOR = 0
+    MINOR = 1
+    TINY  = 0
+    
+    def self.to_s # :nodoc:
+      [MAJOR, MINOR, TINY].join('.')
+    end
+    
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+# http://sneaq.net/textmate-wtf
+$:.reject! { |e| e.include? 'TextMate' }
+
+require 'rubygems'
+require 'test/unit'
+require 'matchy'
+require 'context'
+require 'mocha'
+
+require File.dirname(__FILE__) + '/../lib/lost_in_translation'

data/test/unit/lost_in_translation_test.rb

@@ -0,0 +1,13 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class LostInTranslationTest < Test::Unit::TestCase
+
+  describe "An instance of the LostInTranslation class" do
+
+    it "should flunk" do
+      flunk "Please provide some tests"
+    end
+    
+  end
+
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification 
+name: ceritium-lost-in-translation
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- First Last
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-28 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: user@example.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- README.rdoc
+- Rakefile
+- lib/lost_in_translation
+- lib/lost_in_translation/lost_in_translation.rb
+- lib/lost_in_translation/version.rb
+- lib/lost_in_translation.rb
+- test/test_helper.rb
+- test/unit
+- test/unit/lost_in_translation_test.rb
+has_rdoc: true
+homepage: http://my-site.net
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: This gem does ...
+test_files: []
+