i18n_screwdriver 0.6.0 → 1.0.0

data/.gitignore

@@ -1,21 +1,4 @@
-## MAC OS
-.DS_Store
-
-## TEXTMATE
-*.tmproj
-tmtags
-
-## EMACS
-*~
-\#*
-.\#*
-
-## VIM
-*.swp
-
-## PROJECT::GENERAL
-coverage
-rdoc
-pkg
-
-## PROJECT::SPECIFIC
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -1,4 +1,4 @@
 source "http://rubygems.org"
 
-# Specify your gem's dependencies in datatrans.gemspec
+# Specify your gem's dependencies in i18n_screwdriver.gemspec
 gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    i18n_screwdriver (0.4.0)
+    i18n_screwdriver (1.0.0)
       rails (>= 3.0.0)
 
 GEM
@@ -41,6 +41,7 @@ GEM
     erubis (2.7.0)
     hike (1.2.1)
     i18n (0.6.0)
+    json (1.6.1)
     mail (2.3.0)
       i18n (>= 0.4.0)
       mime-types (~> 1.16)
@@ -73,7 +74,8 @@ GEM
       rdoc (~> 3.4)
       thor (~> 0.14.6)
     rake (0.9.2)
-    rdoc (3.9.4)
+    rdoc (3.10)
+      json (~> 1.4)
     rspec (2.6.0)
       rspec-core (~> 2.6.0)
       rspec-expectations (~> 2.6.0)

data/README.rdoc

@@ -2,9 +2,8 @@
 
 Translating applications is often a pain in the ass. The problem with rails i18n
 is that you have to use keys for every string to translate.
-
 That is one too many abstraction layers - I love the gettext syntax but I want to
-stick to the rails standard libraries. Therefor I created this small toolbox. 
+stick to the rails standard libraries. Therefor I created this small toolbox.
 
 == Installation
 
@@ -20,35 +19,44 @@ Then run the generator that copies the translation rake task to your application
 
 Set these constants to make i18n screwdriver aware of the languages you are using
 
-  DEFAULT_LANGUAGE = 'de'
-  FOREIGN_LANGUAGES = ['en, 'fr', 'it']
+  I18n.default_locale
+  I18n.available_locales
 
-In your views, helpers and controllers use the convenient underscore helper method for all your translations 
+In your views, helpers and controllers use the convenient underscore helper method for all your translations
 
   _("your translation")
 
 When you are done you have 2 helper rake tasks. The first one scans all your views, controllers and
 helpers for translations. It removes unused translation strings and creates an application.<lang>.yml file
-for each of your APPLICATION_LANGUAGES.
+for each of your I18n.available_locales.
 
   rake i18n:update
 
-The seconds one lets you translate your application.<lang>.yml file line by line. Of course
+The second one lets you translate your application.<lang>.yml file line by line. Of course
 you can edit the application.<lang>.yml file itself - but dont do that for your default language file.
 It gets recreated everytime you run the tasks - edit those translations in your views e.g. itself.
 
   TRANSLATE=en rake i18n:translate
 
+== Test Helpers
+
+In your tests (functionals and integration) you can use the same translation helper
+
+  _("your translation")
+
 == Next steps
 
-* fix drawback that multiple translations on the same line are currently not recognized, happens very well with options for select tags
 * also recognize model validation error messages
-* test more
+* DRY the code
+* test more (= test at all)
 * use ruby_parser instead of regex
-* support interpolation like "my name is #{user.full_name} and I am living in #{user.location}"
+* support interpolation like the following (take care about naming - could be different in other languages)
+
+
+  _("my name is %{name} and I am living in %{location}", :name => @name, :location => @location)
 
 == Contributing to i18n_screwdriver
- 
+
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
 * Fork the project
@@ -59,4 +67,4 @@ It gets recreated everytime you run the tasks - edit those translations in your
 
 == Copyright
 
-Copyright (c) 2010-2011 Tobias Miesel. Released unter the MIT license.
+Copyright (c) 2010 Tobias Miesel & Corin Langosch. Released unter the MIT license.

data/Rakefile

@@ -1 +1 @@
-require 'bundler/gem_tasks'
+require "bundler/gem_tasks"

data/i18n_screwdriver.gemspec

@@ -1,12 +1,13 @@
 # -*- encoding: utf-8 -*-
 $:.push File.expand_path("../lib", __FILE__)
+require "i18n_screwdriver/version"
 
 Gem::Specification.new do |s|
   s.name        = "i18n_screwdriver"
-  s.version     = "0.6.0"
-  s.authors     = ["Tobias Miesel"]
-  s.email       = ["agileapplications@gmail.com"]
-  s.homepage    = "http://github.com/agileapplications/i18n_screwdriver"
+  s.version     = I18nScrewdriver::VERSION
+  s.authors     = ["Tobias Miesel", "Corin Langosch"]
+  s.email       = ["agileapplications@gmail.com", "info@corinlangosch.com"]
+  s.homepage    = "https://github.com/agileapplications/i18n_screwdriver"
   s.summary     = %q{make translating with rails i18n fun again}
   s.description = %q{make translating with rails i18n fun again}
 
@@ -16,7 +17,9 @@ Gem::Specification.new do |s|
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
-  
-  s.add_dependency 'rails', '>= 3.0.0'
-  s.add_development_dependency 'rspec'
+
+  # specify any dependencies here; for example:
+  s.add_development_dependency "rspec"
+  s.add_runtime_dependency "rails", ">=3.0.0"
 end
+

data/lib/i18n_screwdriver/rails/engine.rb

@@ -0,0 +1,7 @@
+module I18nScrewdriver
+  module Rails
+    class Engine < ::Rails::Engine
+    end
+  end
+end
+

data/lib/i18n_screwdriver/rails/helper.rb

@@ -0,0 +1,21 @@
+module I18nScrewdriver
+  module Rails
+    module Helper
+      def self.included(klass)
+        klass.send :include, InstanceMethods
+      end
+
+      module InstanceMethods
+        def _(text, options = {})
+          I18n.translate(I18nScrewdriver.for_key(text), options)
+        end
+      end
+    end
+  end
+end
+
+ActionView::Base.send :include, I18nScrewdriver::Rails::Helper
+ActionController::Base.send :include, I18nScrewdriver::Rails::Helper
+ActionController::IntegrationTest.send :include, I18nScrewdriver::Rails::Helper
+ActionController::TestCase.send :include, I18nScrewdriver::Rails::Helper
+

data/lib/i18n_screwdriver/rails.rb

@@ -0,0 +1,4 @@
+require 'rails'
+require 'i18n_screwdriver/rails/engine'
+require 'i18n_screwdriver/rails/helper'
+

data/lib/i18n_screwdriver/version.rb

@@ -0,0 +1,4 @@
+module I18nScrewdriver
+  VERSION = "1.0.0"
+end
+

data/lib/i18n_screwdriver.rb

@@ -1,33 +1,35 @@
-# encoding: utf-8
+require "i18n_screwdriver/version"
+require "i18n_screwdriver/rails"
 
-require 'action_view'
-require 'action_controller'
-require 'i18n/screwdriver/scanner'
+module I18nScrewdriver
+  def self.filename(locale)
+    "config/locales/application.#{locale}.yml"
+  end
+
+  def self.for_key(string)
+    string.gsub(/\./, "").strip
+  end
 
-module I18n
-  module Screwdriver
-    def self.included(klass)
-      klass.send :include, InstanceMethods
+  def self.load_translations(locale)
+    filename = self.filename(locale)
+    raise "File #{filename} not found!" unless File.exists?(filename)
+    YAML.load_file(filename)[locale]
+  end
+
+  def self.write_translations(locale, translations)
+    File.open(filename(locale), "w") do |file|
+      file.puts "# use rake task i18n:update to generate this file"
+      file.puts
+      file.puts({locale => translations}.to_yaml)
+      file.puts
     end
-    
-    module InstanceMethods
-      def _(translation)
-        # the . is a special character in rails i18n - we have to strip it
-        translation_without_dot = translation.gsub(/\./, '').strip
-        translated = I18n.translate(translation_without_dot)
-        
-        if defined?(Rails) && Rails.env.development? && translated.start_with?('translation missing')
-          # TODO: add translation with key to all translation files
-          #       so that rake task is obsolete - instant feedback!
-        end
-        
-        translated
-      end
+  end
+
+  def self.grab_texts_to_be_translated(string)
+    [].tap do |texts|
+      texts.concat(string.scan(/_\("([^"]+)"\)/).map{ |v| v[0] })
+      texts.concat(string.scan(/_\('([^']+)'\)/).map{ |v| v[0] })
     end
   end
 end
 
-ActionView::Base.send :include, I18n::Screwdriver
-ActionController::Base.send :include, I18n::Screwdriver
-ActionController::IntegrationTest.send :include, I18n::Screwdriver
-ActionController::TestCase.send :include, I18n::Screwdriver

data/lib/tasks/i18n.rake

@@ -1,14 +1,68 @@
 namespace :i18n do
-  desc 'update translation files'
+  desc 'Find all translations in views, helpers and controllers'
   task :update => :environment do
-    I18n::Screwdriver::Scanner.new.run
+    raise "Please set I18.default_locale" unless I18n.default_locale.present?
+    default_locale = I18n.default_locale.to_s
+
+    raise "Please set I18.available_locales" unless I18n.available_locales.count > 0
+    available_locales = I18n.available_locales.map(&:to_s)
+
+    # parse all view files for texts to be translated
+    texts = []
+    Dir.glob("**/*.{haml,erb,slim}").each do |file|
+      texts.concat(I18nScrewdriver.grab_texts_to_be_translated(File.read(file)))
+    end
+
+    # also check helper files and controllers
+    Dir.glob("**/*{_helper,_controller}.rb").each do |file|
+      texts.concat(I18nScrewdriver.grab_texts_to_be_translated(File.read(file)))
+    end
+
+    # remove duplicates
+    texts.uniq!
+
+    # transform translations into a hash, sanitizing the keys
+    translations = {}
+    texts.each{ |text| translations[I18nScrewdriver.for_key(text)] = text }
+
+    # rewrite default language file with updated translations
+    puts "Found #{translations.keys.size} unique translations"
+    I18nScrewdriver.write_translations(default_locale, translations)
+
+    # process each language we'd like to translate
+    (available_locales - [default_locale]).each do |locale|
+      filename = I18nScrewdriver.filename(locale)
+
+      # load existing translations
+      existing_translations = File.exists?(filename) ? I18nScrewdriver.load_translations(locale) : {}
+
+      # delete removed translations from hash
+      existing_translations.reject!{ |k| !translations.has_key?(k) }
+
+      # add new translations
+      translations.each_key{ |k| existing_translations[k] ||= "TRANSLATION_MISSING" }
+
+      # write the file
+      I18nScrewdriver.write_translations(locale, existing_translations)
+    end
   end
-  
-  desc 'translate foreign language file line by line'
+
+  desc 'Translate all not yet translated texts for a given locale'
   task :translate => :environment do
-    language = ENV['TRANSLATE'] || FOREIGN_LANGUAGES.first
-    raise "ERROR: usage: TRANSLATE=de rake i18n:translate" unless language
-    
-    I18n::Screwdriver::Scanner.new.translate(language)
+    raise "ERROR: usage: TRANSLATE=de rake i18n:translate" unless ENV['TRANSLATE']
+    locale = ENV['TRANSLATE']
+
+    translations = I18nScrewdriver.load_translations(locale)
+    puts "Translating #{translations.keys.size} entries to <#{locale}> (enter :q to save and quit):"
+    translations.keys.sort.each do |key|
+      next unless ["TRANSLATION_MISSING", ""].include?(translations[key])
+      puts "> #{key}"
+      input = STDIN.gets.chomp
+      break if input == ":q"
+      translations[key] = input
+    end
+
+    puts "Saving translations..."
+    I18nScrewdriver.write_translations(locale, translations)
   end
-end
+end

metadata

@@ -1,63 +1,60 @@
 --- !ruby/object:Gem::Specification
 name: i18n_screwdriver
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
 - Tobias Miesel
+- Corin Langosch
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-13 00:00:00.000000000 +02:00
-default_executable: 
+date: 2011-10-13 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
-  requirement: &70122007483080 !ruby/object:Gem::Requirement
+  name: rspec
+  requirement: &18220320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 3.0.0
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
-  version_requirements: *70122007483080
+  version_requirements: *18220320
 - !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: &70122007482320 !ruby/object:Gem::Requirement
+  name: rails
+  requirement: &18219700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: 3.0.0
+  type: :runtime
   prerelease: false
-  version_requirements: *70122007482320
+  version_requirements: *18219700
 description: make translating with rails i18n fun again
 email:
 - agileapplications@gmail.com
+- info@corinlangosch.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .bundle/config
 - .gitignore
-- .rvmrc
 - Gemfile
 - Gemfile.lock
 - README.rdoc
 - Rakefile
 - i18n_screwdriver.gemspec
-- lib/generators/screwdriver_generator.rb
-- lib/i18n/screwdriver/scanner.rb
 - lib/i18n_screwdriver.rb
+- lib/i18n_screwdriver/rails.rb
+- lib/i18n_screwdriver/rails/engine.rb
+- lib/i18n_screwdriver/rails/helper.rb
+- lib/i18n_screwdriver/version.rb
 - lib/tasks/i18n.rake
-- spec/libraries/i18n_screwdriver_spec.rb
-- spec/libraries/scanner_spec.rb
-- spec/spec_helper.rb
-has_rdoc: true
-homepage: http://github.com/agileapplications/i18n_screwdriver
+homepage: https://github.com/agileapplications/i18n_screwdriver
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -77,11 +74,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: i18n_screwdriver
-rubygems_version: 1.6.2
+rubygems_version: 1.8.8
 signing_key: 
 specification_version: 3
 summary: make translating with rails i18n fun again
-test_files:
-- spec/libraries/i18n_screwdriver_spec.rb
-- spec/libraries/scanner_spec.rb
-- spec/spec_helper.rb
+test_files: []

data/.bundle/config

@@ -1,2 +0,0 @@
---- {}
-

data/.rvmrc

@@ -1 +0,0 @@
-rvm 1.9.2

data/lib/generators/screwdriver_generator.rb

@@ -1,5 +0,0 @@
-class ScrewdriverGenerator < Rails::Generators::Base
-  def generate_screwdriver
-    copy_file "#{File.expand_path('../../tasks', __FILE__)}/i18n.rake", "lib/tasks/i18n.rake"
-  end
-end

data/lib/i18n/screwdriver/scanner.rb

@@ -1,119 +0,0 @@
-# encoding: utf-8
-
-module I18n
-  module Screwdriver
-    class Scanner
-      
-      PATH_TO_LOCALES = "config/locales/"
-      LOCALE_PREFIX = "application"
-      
-      def initialize
-        raise "ERROR: FOREIGN_LANGUAGES is not defined" unless defined? FOREIGN_LANGUAGES
-        raise "ERROR: DEFAULT_LANGUAGE is not defined" unless defined? DEFAULT_LANGUAGE
-        
-        @translations = {}
-      end
-      
-      def run
-        scan_files
-        write_translation_file(@translations, DEFAULT_LANGUAGE)
-        
-        FOREIGN_LANGUAGES.each do |language|
-          update_translations(language)
-        end
-        
-        puts "#{@translations.keys.length} unique translations found"
-      end
-      
-      def translate(language)
-        file_name = PATH_TO_LOCALES + LOCALE_PREFIX + ".#{language}.yml"
-        raise "File #{file_name} not found!" unless File.exists?(file_name)
-        existing_translations = YAML.load_file(file_name)[language]
-        
-        existing_translations.each do |key, translation|
-          if translation.length == 0
-            puts "> #{key}"
-            input = STDIN.gets.chomp
-            if input == ":q"
-              break
-            else
-              existing_translations[key] = input
-            end
-          end
-        end
-
-        write_translation_file(existing_translations, language)
-      end
-      
-      
-      private
-      
-      def update_translations(language)
-        existing_translations = {}
-        file_name = PATH_TO_LOCALES + LOCALE_PREFIX + ".#{language}.yml"
-        existing_translations = YAML.load_file(file_name)[language] if File.exists?(file_name)
-        
-        syncronize_translations(existing_translations)
-        write_translation_file(existing_translations, language)
-      end
-      
-      def syncronize_translations(existing_translations)
-        @translations.each_key do |key|
-          existing_translations[key] = "" unless existing_translations.has_key?(key)
-        end
-        existing_translations
-      end
-      
-      def scan_files
-        Dir.glob("**/*.{haml,erb,slim,rb}").each do |file_name|
-          scan_file(file_name)
-        end
-      end
-      
-      def scan_file(file_name)
-        File.open(file_name) do |file|
-          file.each do |line| 
-            @translations.merge!(extract_translation(line))
-          end
-        end
-      end
-      
-      def extract_translation(line)
-        {}.tap do |hash|
-          if line =~ /_\("([^"]+)"\)/
-            hash[translation_to_key($1)] = $1
-          elsif line =~ /_\('([^']+)'\)/
-            hash[translation_to_key($1)] = $1
-          end
-        end
-      end
-      
-      def sorted_translations(translations)
-        translations.keys.sort do |a, b|
-          a.downcase <=> b.downcase
-        end.each do |key|
-          yield key, translations[key]
-        end
-      end
-      
-      def translation_to_key(translation)
-        translation.gsub(/\./, '')
-      end
-      
-      def remove_translation(key)
-        @translations.delete(key) #unless translations.has_key?(key)
-      end
-      
-      def write_translation_file(translations, language)
-        File.open("config/locales/application.#{language}.yml", "w") do |file|
-          file.puts "# use rake task i18n:update to update this file"
-          file.puts
-          file.puts "\"#{language}\":"
-          sorted_translations(translations) do |key, translation|
-            file.puts "  \"#{key}\": \"#{translation}\""
-          end
-        end
-      end
-    end
-  end
-end

data/spec/libraries/i18n_screwdriver_spec.rb

@@ -1,11 +0,0 @@
-require 'spec_helper'
-
-describe I18n::Screwdriver do
-
-  describe "translation helper" do
-    it "removes dots from translation string" do
-      _("my.new.translation").should == "translation missing: en.mynewtranslation"
-    end
-  end
-  
-end

data/spec/libraries/scanner_spec.rb

@@ -1,43 +0,0 @@
-require 'spec_helper'
-
-describe I18n::Screwdriver::Scanner do
-  
-  before do
-    @scanner = I18n::Screwdriver::Scanner.new
-  end
-
-  describe "extract_translation" do
-    it "returns an empty hash when no translation was found" do
-      @scanner.send(:extract_translation, 'hello world').should == {}
-    end
-    
-    it "returns a filled hash when translation was found" do
-      @scanner.send(:extract_translation, '_("hello world")').should == {
-        'hello world' => 'hello world'
-      }
-      
-      @scanner.send(:extract_translation, '_("Going out today.")').should == {
-        'Going out today' => 'Going out today.'
-      }
-      
-      @scanner.send(:extract_translation, '_(".a.b.c.d.e")').should == {
-        'abcde' => '.a.b.c.d.e'
-      }
-    end
-  end
-  
-  describe "translation_to_key" do
-    it "removes all dots" do
-      @scanner.send(:translation_to_key, 'Good morning.').should == 'Good morning'
-    end
-  end
-  
-  describe "sorted_translations" do
-    it "returns all translations sorted" do
-      #@scanner.send(:sorted_translations) do |key, translation|
-      #  puts "  \"#{key}\": \"#{translation}\""
-      #end
-    end
-  end
-  
-end

data/spec/spec_helper.rb

@@ -1,13 +0,0 @@
-require 'rubygems'
-require 'bundler/setup'
-
-require 'i18n_screwdriver'
-
-DEFAULT_LANGUAGE = 'de'
-FOREIGN_LANGUAGES = ['en']
-
-RSpec.configure do |config|
-
-  config.include I18n::Screwdriver
-    
-end