i18n_tools 0.0.1

data/lib/i18n_tools/missing_scanner.rb

@@ -0,0 +1,28 @@
+module I18nTools
+  class MissingScanner < Scanner
+    def initialize(locale)
+      @locale = locale
+    end
+    
+    def results
+      missing_ones = []
+
+      scan do |key|
+        missing_ones << key unless I18n.backend.send(:lookup, @locale, key)
+      end
+
+      result = {}
+
+      missing_ones.each do |key|
+        current_hash = result
+        parts = key.split(".")
+        parts[0..-2].each do |part|
+          current_hash[part] ||= {}
+          current_hash = current_hash[part]
+        end
+
+        current_hash[parts.last] = ""
+      end
+    end
+  end
+end

data/lib/i18n_tools/scanner.rb

@@ -0,0 +1,54 @@
+module I18nTools
+  class Scanner
+    VIEW_REGEXPS = [/[^\w]t\(\"(.*?)\".*?\)/, /[^\w]t\(\'(.*?)\'.*?\)/]
+    CODE_REGEXPS = [/I18n\.t\(\"(.*?)\".*?\)/, /I18n\.t\(\'(.*?)\'.*?\)/]
+    
+    cattr_accessor :file_types
+    self.file_types = ['controllers', 'helpers', 'models']
+
+  protected
+    def scan(&block)
+      scan_views(&block)
+      scan_code(&block)
+    end
+    
+  private
+    def scan_views(&block)
+      Dir['app/views/**/*.erb', 'app/views/**/*.rhtml'].each do |filename|
+        next if ignores.any? { |r| filename =~ r }
+
+        content = File.read(filename)
+        VIEW_REGEXPS.each do |view_regexp|
+          content.scan(view_regexp) do |match|
+            key = match.first
+            next if key =~ /\#\{/
+            if key =~ /^\./
+              namespace = filename.gsub('app/views/', '').gsub('.html.erb', '').gsub('/', '.')
+              key = (namespace + key).split('.').collect { |part| part.gsub(/^\_/, '') }.join('.')
+            end
+            yield key
+          end
+        end
+      end
+    end
+    
+    def scan_code(&block)
+      Dir["lib/**/*.rb", *self.class.file_types.collect { |t| "app/#{t}/**/*.rb" }].each do |filename|
+        next if ignores.any? { |r| filename =~ r }
+
+        content = File.read(filename)
+        CODE_REGEXPS.each do |code_regexp|
+          content.scan(code_regexp) do |match|
+            key = match.first
+            next if key =~ /\#\{/
+            yield key
+          end
+        end
+      end
+    end
+    
+    def ignores
+      @ignores ||= File.read(".i18nignore").split("\n").reject { |e| e.strip.blank? || e =~ /^#/ }.collect { |i| Regexp.new(i) } rescue []
+    end
+  end
+end

data/lib/i18n_tools/tasks.rb

@@ -0,0 +1,21 @@
+namespace :translations do
+  task :setup => :environment do
+    require 'i18n_tools'
+    
+    @locale = (ENV['LOCALE'] || 'en').to_sym
+  end
+  
+  desc 'Detect missing translations'
+  task :missing => :setup do
+    require 'ya2yaml'
+    
+    results = I18nTools::MissingScanner.new(@locale).results
+    puts({ @locale.to_s => results }.ya2yaml)
+  end
+  
+  desc 'Detect translations that are not used in code'
+  task :unused => :setup do
+    unused = I18nTools::UnusedScanner.new(@locale).results
+    puts unused
+  end
+end

data/lib/i18n_tools/unused_scanner.rb

@@ -0,0 +1,24 @@
+module I18nTools
+  class UnusedScanner < Scanner
+    def initialize(locale)
+      @locale = locale
+    end
+    
+    def results
+      used_ones = []
+
+      scan do |key|
+        used_ones << [@locale, key].join('.')
+      end
+
+      defined_ones = I18nTools.extract_i18n_keys(@locale.to_s, I18n.backend.send(:lookup, @locale, ''))
+
+      unused = (defined_ones - used_ones).reject { |key| ignore_keys.any? { |rx| rx =~ key } }.sort
+    end
+  
+  protected
+    def ignore_keys
+      @ignore_keys ||= File.read(".i18nignore_unused").split("\n").reject { |e| e.strip.blank? || e =~ /^#/ }.collect { |key| Regexp.new(Regexp.escape("#{@locale}.#{key}")) } rescue []
+    end
+  end
+end

data/lib/i18n_tools.rb

@@ -0,0 +1,19 @@
+# require all necessary files here
+
+module I18nTools
+  def self.extract_i18n_keys(prefix, object)
+    case object
+    when Hash
+      return prefix if object.keys.include?(:one) && object.keys.include?(:other)
+      object.collect do |key, value|
+        extract_i18n_keys([prefix, key].join('.'), value)
+      end.flatten.compact
+    when String
+      prefix
+    end
+  end
+end
+
+require File.dirname(__FILE__) + '/i18n_tools/scanner'
+require File.dirname(__FILE__) + '/i18n_tools/missing_scanner'
+require File.dirname(__FILE__) + '/i18n_tools/unused_scanner'

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+name: i18n_tools
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Thomas Kadauke
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-17 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: 
+email: tkadauke@imedo.de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/i18n_tools/missing_scanner.rb
+- lib/i18n_tools/scanner.rb
+- lib/i18n_tools/tasks.rb
+- lib/i18n_tools/unused_scanner.rb
+- lib/i18n_tools.rb
+has_rdoc: true
+homepage: 
+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.3.7
+signing_key: 
+specification_version: 3
+summary: Tasks for extracting missing and unused translations from Rails projects
+test_files: []
+