i18n_screwdriver 0.1.0

data/.bundle/config

@@ -0,0 +1,2 @@
+--- 
+BUNDLE_DISABLE_SHARED_GEMS: "1"

data/Gemfile

@@ -0,0 +1,10 @@
+source "http://rubygems.org"
+
+gem "actionpack", ">= 3.0.0"
+
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.1"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,47 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionpack (3.0.3)
+      activemodel (= 3.0.3)
+      activesupport (= 3.0.3)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.4)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.13)
+      rack-test (~> 0.5.6)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.3)
+      activesupport (= 3.0.3)
+      builder (~> 2.1.2)
+      i18n (~> 0.4)
+    activesupport (3.0.3)
+    builder (2.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    git (1.2.5)
+    i18n (0.4.2)
+    jeweler (1.5.1)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rack (1.2.1)
+    rack-mount (0.6.13)
+      rack (>= 1.0.0)
+    rack-test (0.5.6)
+      rack (>= 1.0)
+    rake (0.8.7)
+    rcov (0.9.9)
+    shoulda (2.11.3)
+    tzinfo (0.3.23)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  actionpack (>= 3.0.0)
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.1)
+  rcov
+  shoulda

data/README.rdoc

@@ -0,0 +1,52 @@
+= i18n_screwdriver
+
+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. 
+
+== Usage
+
+Set these constants to make i18n screwdriver aware of the languages you are using
+
+  APPLICATION_LANGUAGES = ['de', 'en, 'fr', 'it']
+  DEFAULT_LANGUAGE = 'de'
+
+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 translation. It removes unused translation strings and creates an application.<lang>.yml file
+for each of your APPLICATION_LANGUAGES.
+
+  rake i18n:update
+
+The seconds 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
+
+
+== Next steps
+
+* DRY the code
+* test more
+* use ruby_parser instead of regex
+* support interpolation
+
+== 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
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2010 Tobias Miesel. Released unter the MIT license.

data/Rakefile

@@ -0,0 +1,46 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "i18n_screwdriver"
+    gem.homepage = "http://github.com/agileapplications/i18n_screwdriver"
+    gem.license = "MIT"
+    gem.summary = %Q{make translating with rails i18n fun again}
+    gem.email = "agileapplications@gmail.com"
+    gem.authors = ["Tobias Miesel"]
+    gem.add_development_dependency "shoulda", ">= 0"
+    gem.add_dependency "actionpack", ">= 3.0.0"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :test => :check_dependencies
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "i18n_screwdriver #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/i18n_screwdriver.gemspec

@@ -0,0 +1,71 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{i18n_screwdriver}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Tobias Miesel"]
+  s.date = %q{2010-11-19}
+  s.email = %q{agileapplications@gmail.com}
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    ".bundle/config",
+    "Gemfile",
+    "Gemfile.lock",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "i18n_screwdriver.gemspec",
+    "lib/i18n_screwdriver.rb",
+    "tasks/i18n.rake",
+    "test/helper.rb",
+    "test/test_i18n_screwdriver.rb"
+  ]
+  s.homepage = %q{http://github.com/agileapplications/i18n_screwdriver}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{make translating with rails i18n fun again}
+  s.test_files = [
+    "test/helper.rb",
+    "test/test_i18n_screwdriver.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_runtime_dependency(%q<actionpack>, [">= 3.0.0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.1"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_runtime_dependency(%q<actionpack>, [">= 3.0.0"])
+    else
+      s.add_dependency(%q<actionpack>, [">= 3.0.0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<actionpack>, [">= 3.0.0"])
+    end
+  else
+    s.add_dependency(%q<actionpack>, [">= 3.0.0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<actionpack>, [">= 3.0.0"])
+  end
+end
+

data/lib/i18n_screwdriver.rb

@@ -0,0 +1,22 @@
+module I18n
+  module Screwdriver
+    def self.included(klass)
+      klass.send :include, InstanceMethods
+    end
+    
+    module InstanceMethods
+      def _(translation)
+        # the . is a special character in rails i18n - we have to strip it
+        translation_without_dot = translation.gsub(/\./, '').strip
+        t("#{translation_without_dot}")
+      end
+    end
+  end
+end
+
+ActionController::Base.send :include, I18n::Screwdriver
+ActionView::Helpers::TranslationHelper.send :include, I18n::Screwdriver
+# make helper available in tests
+ActionController::TestCase.send :include, I18n::Screwdriver
+ActiveSupport::TestCase.send :include, I18n::Screwdriver
+ActionController::IntegrationTest.send :include, I18n::Screwdriver

data/tasks/i18n.rake

@@ -0,0 +1,99 @@
+namespace :i18n do
+  task :update => :environment do
+    
+    translations = {}
+    raise "ERROR: APPLICATION_LANGUAGES = ['de', 'en', ...] is not defined - define it in your initializers" unless defined? APPLICATION_LANGUAGES
+    raise "ERROR: DEFAULT_LANGUAGE = '??' is not defined - define it in your initializers" unless defined? DEFAULT_LANGUAGE
+    
+    # parse all view files for translations - removed ones get removed from
+    # the i18n translation yml's automatically
+    Dir.glob("**/*.{haml,erb}").each do |file|
+      scan_for_translations(file, translations)
+    end
+    
+    # also check helper files and controllers
+    Dir.glob("**/*{_helper,_controller}.rb").each do |file|
+      scan_for_translations(file, translations)
+    end
+    
+    # rewrite default language file with updated translations
+    puts "found #{translations.keys.size} unique translations"
+    write_translation_file(DEFAULT_LANGUAGE, translations)
+    
+    # write a file for each foreign language
+    (APPLICATION_LANGUAGES - [DEFAULT_LANGUAGE]).each do |language|
+      # load foreign language file in temp hash
+      if File.exists?("config/locales/application.#{language}.yml")
+        existing_translations = YAML.load_file("config/locales/application.#{language}.yml")
+        existing_translations = existing_translations[language]
+      else
+        existing_translations = { language => {} }
+      end
+      
+      # delete removed translations from hash
+      existing_translations.each_key do |key|
+        existing_translations.delete(key) unless translations.has_key?(key)
+      end
+      
+      # add new keys with empty translation to hash
+      translations.each_key do |key|
+        existing_translations[key] = "TRANSLATION_MISSING: #{key}" unless existing_translations.has_key?(key)
+      end
+      write_translation_file(language, existing_translations)
+    end
+  end
+  
+  task :translate => :environment do
+    raise "ERROR: usage: TRANSLATE=de rake i18n:translate" unless ENV['TRANSLATE']
+    language = ENV['TRANSLATE']
+    if File.exists?("config/locales/application.#{language}.yml")
+      existing_translations = YAML.load_file("config/locales/application.#{language}.yml")
+      existing_translations = existing_translations[language]
+      puts "Translating #{existing_translations.keys.size} entries to <#{language}> (enter :q to save and quit):"
+      existing_translations.keys.sort.each do |key|
+        if existing_translations[key] == "TRANSLATION_MISSING"
+          puts "> #{key}"
+          input = STDIN.gets.chomp
+          if input == ":q"
+            break
+          else
+            existing_translations[key] = 
+          end
+        end
+      end
+      
+      puts "Schreiben der Datei config/locales/application.#{language}.yml"
+      write_translation_file(language, existing_translations)
+    else
+      puts "ERROR: No translation file in config/locales/application.#{language}.yml"
+      puts "Choosen language is invalid or you did not run rake i18n:update yet"
+    end
+  end
+  
+  def write_translation_file(language, translations)
+    file = File.open("config/locales/application.#{language}.yml", "w")
+    file.puts "# use rake task i18n:update to generate this file"
+    file.puts
+    file.puts "\"#{language}\":"
+    translations.keys.sort do |a, b|
+      a.downcase <=> b.downcase
+    end.each do |key|
+      file.puts "  \"#{key}\": \"#{translations[key]}\""
+    end
+    file.close
+  end
+  
+  def scan_for_translations(file, translations)
+    File.open(file) do |io|
+      io.each do |line| 
+        if line =~ /_\("([^"]+)"\)/
+          value = $1
+          translations[$1.gsub(/\./, '').strip] = value.strip
+        elsif line =~ /_\('([^']+)'\)/
+          value = $1
+          translations[$1.gsub(/\./, '').strip] = value.strip
+        end
+      end
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,22 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+require 'action_controller'
+require 'action_view'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'i18n_screwdriver'
+
+class Test::Unit::TestCase
+  include I18n::Screwdriver
+  include ActionView::Helpers
+end

data/test/test_i18n_screwdriver.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestI18nScrewdriver < Test::Unit::TestCase  
+  should "remove dots from translation string" do
+    assert_equal "<span class=\"translation_missing\">en, mynewtranslation</span>", _("my.new.translation")
+  end
+end

metadata

@@ -0,0 +1,183 @@
+--- !ruby/object:Gem::Specification 
+name: i18n_screwdriver
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Tobias Miesel
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-19 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  prerelease: false
+  name: actionpack
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: shoulda
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: bundler
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: jeweler
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 1
+        - 5
+        - 1
+        version: 1.5.1
+  requirement: *id004
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: rcov
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id005
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: shoulda
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id006
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  prerelease: false
+  name: actionpack
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  requirement: *id007
+description: 
+email: agileapplications@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- .bundle/config
+- Gemfile
+- Gemfile.lock
+- README.rdoc
+- Rakefile
+- VERSION
+- i18n_screwdriver.gemspec
+- lib/i18n_screwdriver.rb
+- tasks/i18n.rake
+- test/helper.rb
+- test/test_i18n_screwdriver.rb
+has_rdoc: true
+homepage: http://github.com/agileapplications/i18n_screwdriver
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: make translating with rails i18n fun again
+test_files: 
+- test/helper.rb
+- test/test_i18n_screwdriver.rb