grosser-gettext_test_log 0.2.0

data/README.markdown

@@ -0,0 +1,56 @@
+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!
+
+Usage
+=====
+  Create a rake task:
+    #lib/tasks/gettext_test_log.rake
+    desc "write all msgids used into testlog_phrases.rb"
+    task :gettext_test_log => :environment do
+      #place the file should somewhere your updatepo is searching
+      GettextTestLog::write_test_log("locale/testlog_phrases.rb",
+        :exclude_msgids_in_po_files=>[
+          'some_po_file_that_contains_translations_you_do_not_need.po'
+        ]
+      )
+    end
+
+  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
+
+Install
+=======
+ - As Rails plugin: `script/plugin install git://github.com/grosser/gettext_test_log.git `
+ - As gem: `sudo gem install grosser-gettext_test_log -s http://gems.github.com/`
+
+Examples output
+===============
+    #locale/testlog_phrases.rb
+    _("Add to favorites")
+    _("Added a subtitle to %{name}")
+    _("Additional Information")
+    _("Address")
+    ...
+
+Author
+======
+Michael Grosser  
+grosser.michael@gmail.com  
+Hereby placed under public domain, do what you want, just do not hold me accountable...  

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:minor: 2
+:patch: 0
+:major: 0

data/lib/gettext_test_log.rb

@@ -0,0 +1,69 @@
+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.before(: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:models"].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 'gettext'
+    require 'gettext/poparser'
+    require 'gettext/mofile'
+    data = MOFile.new
+    GetText::PoParser.new.parse(File.read(file),data)
+    data
+  end
+
+  def store_messages(messages,file)
+    File.open(file,'w') do |f|
+      f.puts messages.uniq.sort.map{|message| %Q[_("#{message}")].gsub("\n","\\n")} * "\n"
+    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,32 @@
+# ---- requirements
+require 'rubygems'
+require 'spec'
+require 'mocha'
+
+$LOAD_PATH << File.expand_path("../lib", File.dirname(__FILE__))
+require 'gettext_test_log'
+
+# ---- rspec
+Spec::Runner.configure do |config|
+  config.mock_with :mocha
+end
+
+
+# ---- bugfix
+#`exit?': undefined method `run?' for Test::Unit:Module (NoMethodError)
+#can be solved with require test/unit but this will result in extra test-output
+module Test
+  module Unit
+    def self.run?
+      true
+    end
+  end
+end
+
+
+# ---- Helpers
+def pending_it(text,&block)
+  it text do
+    pending(&block)
+  end
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification 
+name: grosser-gettext_test_log
+version: !ruby/object:Gem::Version 
+  version: 0.2.0
+platform: ruby
+authors: 
+- Michael Grosser
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-02-24 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: 
+email: grosser.michael@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.markdown
+- VERSION.yml
+- lib/gettext_test_log
+- lib/gettext_test_log.rb
+- lib/gettext_test_log/fast_gettext_stub.rb
+- spec/gettext_test_log_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/grosser/gettext_test_log
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --charset=UTF-8
+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: Logs all gettext translations during test execution, to a GetText readable format
+test_files: []
+