gettext_test_log 0.2.1

data/Gemfile

@@ -0,0 +1,7 @@
+source :rubygems
+
+group :dev do
+  gem 'rake'
+  gem 'rspec', '~>2'
+  gem 'jeweler'
+end

data/Gemfile.lock

@@ -0,0 +1,26 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    git (1.2.5)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.9.2)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jeweler
+  rake
+  rspec (~> 2)

data/Rakefile

@@ -0,0 +1,20 @@
+require 'rubygems'
+
+task :default do
+  sh "bundle exec rspec spec"
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "gettext_test_log"
+    gem.summary = "Logs all gettext translations during test execution, to a GetText readable format"
+    gem.email = "grosser.michael@gmail.com"
+    gem.homepage = "http://github.com/grosser/#{gem.name}"
+    gem.authors = ["Michael Grosser"]
+  end
+
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler, or one of its dependencies, is not available. Install it with: gem install jeweler"
+end

data/Readme.md

@@ -0,0 +1,69 @@
+Problem
+=======
+ - Finding all translations by parsing is impossible for dynamic calls
+ - often even static calls are not found
+ - some file formats do not have a gettext parser
+
+Solution
+========
+ - log all translations during test execution
+ - write them to an parseable temp file
+ - use gettext:find / gettext:pack as usual
+ - missing translation = missing test, write tests!
+
+This will only work with [FastGettext](http://github.com/grosser/fast_gettext) and RSpec for now!
+
+Install
+=======
+ - `rails plugin install git://github.com/grosser/gettext_test_log.git `
+ - Gem: `gem install gettext_test_log`
+
+Usage
+=====
+    rake gettext:test_log
+
+Optionally copy+modify task with options:
+    :exclude_msgids_in_po_files=>[
+      'some_po_file_that_contains_translations_you_do_not_need.po'
+    ]
+
+  Add to your spec_helper:
+    #spec/spec_helper.rb
+    GettextTestLog::activate_test_logging
+
+  Run:
+    rake gettext:test_log
+    rake gettext:find  #find new translations
+    #fill newly found translations
+    rake gettext:pack #write translations
+
+Examples output
+===============
+    #locale/testlog_phrases.rb
+    _("Add to favorites")
+    _("Added a subtitle to %{name}")
+    _("Additional Information")
+    _("Address")
+    ...
+
+Unwanted translations
+=====================
+When using gettext_i18n_rails, most of the columns of a model will be translated during model tests
+this can be annoying since normally no user will see them.
+To disable this, add to `spec/spec_helper.rb` :
+    class ActiveRecord::Base
+      def self.human_attribute_name(attr)
+        attr.to_s
+      end
+    end
+
+TODO
+====
+ - needs tests... :(
+ - make compatible with GetText and FastGettext at the same time ?
+
+Author
+======
+[Michael Grosser](http://grosser.it)<br/>
+michael@grosser.it<br/>
+Hereby placed under public domain, do what you want, just do not hold me accountable...

data/VERSION

@@ -0,0 +1 @@
+0.2.1

data/gettext_test_log.gemspec

@@ -0,0 +1,42 @@
+# 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{gettext_test_log}
+  s.version = "0.2.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Michael Grosser"]
+  s.date = %q{2011-09-23}
+  s.email = %q{grosser.michael@gmail.com}
+  s.files = [
+    "Gemfile",
+    "Gemfile.lock",
+    "Rakefile",
+    "Readme.md",
+    "VERSION",
+    "gettext_test_log.gemspec",
+    "init.rb",
+    "lib/gettext_test_log.rb",
+    "lib/gettext_test_log/fast_gettext_stub.rb",
+    "spec/gettext_test_log_spec.rb",
+    "spec/spec_helper.rb",
+    "tasks/gettext_test_log.rake"
+  ]
+  s.homepage = %q{http://github.com/grosser/gettext_test_log}
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.6.2}
+  s.summary = %q{Logs all gettext translations during test execution, to a GetText readable format}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/init.rb

@@ -0,0 +1 @@
+require 'gettext_test_log' if Rails.env.test?

data/lib/gettext_test_log.rb

@@ -0,0 +1,67 @@
+module GettextTestLog
+  extend self
+  SEPERATOR = "\nNEXT-WORD\n"
+
+  # write to a given file, which msgids where found
+  # in the `rake updatepo` recogniseable format _("msgid")
+  def write_test_log(storage_file,options={})
+    messages = messages_from_test_run
+    if excluded = options[:exclude_msgids_in_po_files]
+      messages -= msgids_in_po_files(excluded)
+    end
+    store_messages(messages,storage_file)
+  end
+
+  # call this inside your spec_helper.rb
+  # to activate test message storage
+  def activate_test_logging
+    if ENV['LOG_GETTEXT']
+      require 'gettext_test_log/fast_gettext_stub'
+      Spec::Runner.configure do |config|
+        #TODO only call after the 'last' test was executed
+        config.after(:all) do
+          File.open(ENV['LOG_GETTEXT'],'w') do |f|
+            f.puts FastGettext::Translation::TRANSLATIONS_USED * SEPERATOR
+          end
+        end
+      end
+    end
+  end
+
+private
+
+  def messages_from_test_run
+    logfile = 'tmp_gettext_test_log.txt'
+    run_tests(logfile)
+    ids = used_msgids(logfile)
+    `rm #{logfile}`
+    ids
+  end
+
+  def used_msgids(logfile)
+    File.read(logfile).split(/#{SEPERATOR}/m).map(&:strip).reject(&:blank?).uniq
+  end
+
+  def run_tests(logfile)
+    ENV['LOG_GETTEXT']=logfile
+    Rake::Task["spec"].invoke rescue nil
+  end
+
+  def msgids_in_po_files(files)
+    [*files].map{|file| messages_from_po_file(file).keys}.flatten
+  end
+
+  #returns a hash of all msgid => msgstr
+  def messages_from_po_file(file)
+    require 'fast_gettext/po_file'
+    FastGettext::PoFile.conver_to_mo(file).instance_variable_get('@data')
+  end
+
+  def store_messages(messages,file)
+    File.open(file,'w') do |f|
+      f.puts "#GENERATED FILE DO NOT MODIFY"
+      f.puts messages.uniq.sort.map{|message| %Q[_("#{message}")].gsub("\n","\\n")} * "\n"
+      f.puts "#GENERATED FILE DO NOT MODIFY"
+    end
+  end
+end

data/lib/gettext_test_log/fast_gettext_stub.rb

@@ -0,0 +1,15 @@
+module FastGettext::Translation
+  TRANSLATIONS_USED = []
+
+  def __with_log(x)
+    TRANSLATIONS_USED << x
+    __without_log(x)
+  end
+  alias_method_chain :_, :log
+
+  def s__with_log(x)
+    TRANSLATIONS_USED << x
+    s__without_log(x)
+  end
+  alias_method_chain :s_, :log
+end

data/spec/gettext_test_log_spec.rb

@@ -0,0 +1,4 @@
+require File.expand_path("spec_helper", File.dirname(__FILE__))
+
+describe GettextTestLog do
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'rspec'
+
+$LOAD_PATH << File.expand_path("../lib", File.dirname(__FILE__))
+require 'gettext_test_log'

data/tasks/gettext_test_log.rake

@@ -0,0 +1,6 @@
+namespace :gettext do
+  desc "write all msgids used into testlog_phrases.rb"
+  task :test_log => :environment do
+    GettextTestLog::write_test_log("locale/testlog_phrases.rb")
+  end
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+name: gettext_test_log
+version: !ruby/object:Gem::Version 
+  hash: 21
+  prerelease: 
+  segments: 
+  - 0
+  - 2
+  - 1
+  version: 0.2.1
+platform: ruby
+authors: 
+- Michael Grosser
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-09-23 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: 
+email: grosser.michael@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Gemfile
+- Gemfile.lock
+- Rakefile
+- Readme.md
+- VERSION
+- gettext_test_log.gemspec
+- init.rb
+- lib/gettext_test_log.rb
+- lib/gettext_test_log/fast_gettext_stub.rb
+- spec/gettext_test_log_spec.rb
+- spec/spec_helper.rb
+- tasks/gettext_test_log.rake
+has_rdoc: true
+homepage: http://github.com/grosser/gettext_test_log
+licenses: []
+
+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.6.2
+signing_key: 
+specification_version: 3
+summary: Logs all gettext translations during test execution, to a GetText readable format
+test_files: []
+