localite 0.3 → 0.5.6

data/lib/localite/translate.rb

@@ -1,6 +1,20 @@
 require "set"
 
 module Localite::Translate
+  
+  private
+  
+  def log_translation(str, locale, scope, value)        
+    value = value[0,37] + "…" if value.length > 40
+
+    msg = "Resolved #{current_scope.first(str)}"
+    msg += " (as #{scope.inspect})" if current_scope.first(str) != scope
+    msg += " to #{value.inspect} [#{locale}]"
+    logger.warn msg
+  end
+
+  public
+  
   # 
   # translate a string 
   #
@@ -9,31 +23,42 @@ module Localite::Translate
   # If still no translation is found, return nil
   # 
   def translate(s, raise_mode)
-    r = do_translate(locale, s)
-    return r if r
-
-    r = do_translate(base, s) if base != locale
-    return r if r
+    old_i18n_locale = I18n.locale
     
-    raise Missing, [locale, s] if raise_mode != :no_raise
-  end
+    [ current_locale, base ].uniq.each do |locale|
+      current_scope.each(s) do |scope|
+        next unless value = translate_via_i18n(locale, scope)
 
-  private
+        log_translation s, locale, scope, value
+        
+        #
+        # reformat: if target format is html, convert the value into text.
+        return Localite::Format.send(current_format, value)
+      end
+    end
 
-  def do_translate(locale, s)
-    scopes.each(s) do |scoped_string|
-      tr = translate_via_i18n locale, scoped_string
-      return tr if tr
+    src = caller[1]
+    if src =~ /^([^:]+:[^:]+):/
+      src = $1
     end
+    logger.warn "[#{current_locale}] Could not translate #{current_scope.first(s).inspect}; from #{src}"
 
-    record_missing locale, scopes.first(s)
-    nil
+    record_missing current_locale, current_scope.first(s)
+    return if raise_mode == :no_raise
+    
+    raise Missing, [current_locale, s]
+  ensure
+    I18n.locale = old_i18n_locale
   end
+
+  private
   
-  def translate_via_i18n(locale, s)
-    locale = base unless I18n.backend.available_locales.include?(locale)
+  def translate_via_i18n(locale, str)
     I18n.locale = locale
-    I18n.translate(s, :raise => true)
+    
+    r = I18n.translate(str, :raise => true)
+    return nil if r.is_a?(Hash)
+    r
   rescue I18n::MissingTranslationData
     nil
   end
@@ -51,15 +76,16 @@ module Localite::Translate
   public
   
   class Missing < RuntimeError
-    attr :locale
-    attr :string
+    attr_reader :locale, :string, :scope
 
     def initialize(opts)
       @locale, @string = *opts
+      @scope = Localite.current_scope.to_s
+      # dlog "--> scope", @scope.inspect
     end
 
     def to_s
-      "Missing translation: [#{locale}] #{string.inspect}"
+      "Missing translation: [#{locale}] #{string.inspect} (in scope #{scope.inspect})"
     end
   end
 end

data/localite.gemspec

@@ -2,27 +2,30 @@
 
 Gem::Specification.new do |s|
   s.name = %q{localite}
-  s.version = "0.3"
+  s.version = "0.5.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["pboy"]
-  s.date = %q{2010-05-23}
+  s.date = %q{2010-06-18}
+  s.default_executable = %q{list-tr}
   s.description = %q{An easy to use localization gem.}
   s.email = %q{eno-pboy@open-lab.org}
-  s.extra_rdoc_files = ["lib/localite.rb", "lib/localite/filter.rb", "lib/localite/scope.rb", "lib/localite/settings.rb", "lib/localite/template.rb", "lib/localite/translate.rb", "tasks/echoe.rake"]
-  s.files = ["Manifest", "Rakefile", "VERSION", "config/dependencies.rb", "config/gem.yml", "lib/localite.rb", "lib/localite/filter.rb", "lib/localite/scope.rb", "lib/localite/settings.rb", "lib/localite/template.rb", "lib/localite/translate.rb", "localite.tmproj", "script/console", "script/rebuild", "tasks/echoe.rake", "test/i18n/de.yml", "test/initializers/fake_rails.rb", "test/test.rb", "localite.gemspec"]
+  s.executables = ["list-tr"]
+  s.extra_rdoc_files = ["bin/list-tr", "lib/localite.rb", "lib/localite/filter.rb", "lib/localite/format.rb", "lib/localite/node_filter.rb", "lib/localite/scopes.rb", "lib/localite/settings.rb", "lib/localite/storage.rb", "lib/localite/template.rb", "lib/localite/tr.rb", "lib/localite/translate.rb", "tasks/echoe.rake"]
+  s.files = ["Manifest", "Rakefile", "VERSION", "bin/list-tr", "config/dependencies.rb", "config/gem.yml", "lib/localite.rb", "lib/localite/filter.rb", "lib/localite/format.rb", "lib/localite/node_filter.rb", "lib/localite/scopes.rb", "lib/localite/settings.rb", "lib/localite/storage.rb", "lib/localite/template.rb", "lib/localite/tr.rb", "lib/localite/translate.rb", "localite.tmproj", "script/console", "script/rebuild", "tasks/echoe.rake", "test/i18n/de.tr", "test/i18n/en.tr", "test/initializers/fake_rails.rb", "test/rails/Rakefile", "test/rails/app/controllers/application_controller.rb", "test/rails/app/controllers/localite_controller.rb", "test/rails/app/views/localite/index.html.erb", "test/rails/app/views/localite/template.de.html.erb", "test/rails/app/views/localite/template.en.html.erb", "test/rails/config/boot.rb", "test/rails/config/environment.rb", "test/rails/config/environments/development.rb", "test/rails/config/environments/production.rb", "test/rails/config/environments/test.rb", "test/rails/config/initializers/new_rails_defaults.rb", "test/rails/config/initializers/session_store.rb", "test/rails/config/locales/de.yml", "test/rails/config/locales/en.yml", "test/rails/config/routes.rb", "test/rails/script/console", "test/rails/script/server", "test/rails/test/functional/localite_controller_test.rb", "test/rails/test/test_helper.rb", "test/test.rb", "localite.gemspec"]
   s.homepage = %q{http://github.com/pboy/localite}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Localite"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{localite}
-  s.rubygems_version = %q{1.3.6}
+  s.rubygems_version = %q{1.3.7}
   s.summary = %q{An easy to use localization gem.}
+  s.test_files = ["test/rails/test/functional/localite_controller_test.rb", "test/rails/test/test_helper.rb"]
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<i18n>, [">= 0"])
     else
       s.add_dependency(%q<i18n>, [">= 0"])

data/localite.tmproj

@@ -2,8 +2,6 @@
 <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
 <plist version="1.0">
 <dict>
-	<key>currentDocument</key>
-	<string>lib/localite/filter.rb</string>
 	<key>documents</key>
 	<array>
 		<dict>
@@ -12,7 +10,7 @@
 			<key>name</key>
 			<string>localite</string>
 			<key>regexFolderFilter</key>
-			<string>!.*/(\.[^/]*|CVS|_darcs|_MTN|\{arch\}|blib|.*~\.nib|.*\.(framework|app|pbproj|pbxproj|xcode(proj)?|bundle))$</string>
+			<string>!.*/(\.[^/]*|CVS|_darcs|coverage|_MTN|\{arch\}|blib|.*~\.nib|.*\.(framework|app|pbproj|pbxproj|xcode(proj)?|bundle))$</string>
 			<key>sourceDirectory</key>
 			<string></string>
 		</dict>
@@ -20,104 +18,10 @@
 	<key>fileHierarchyDrawerWidth</key>
 	<integer>339</integer>
 	<key>metaData</key>
-	<dict>
-		<key>config/dependencies.rb</key>
-		<dict>
-			<key>caret</key>
-			<dict>
-				<key>column</key>
-				<integer>0</integer>
-				<key>line</key>
-				<integer>4</integer>
-			</dict>
-			<key>firstVisibleColumn</key>
-			<integer>0</integer>
-			<key>firstVisibleLine</key>
-			<integer>0</integer>
-		</dict>
-		<key>config/gem.yml</key>
-		<dict>
-			<key>caret</key>
-			<dict>
-				<key>column</key>
-				<integer>0</integer>
-				<key>line</key>
-				<integer>7</integer>
-			</dict>
-			<key>firstVisibleColumn</key>
-			<integer>0</integer>
-			<key>firstVisibleLine</key>
-			<integer>0</integer>
-		</dict>
-		<key>lib/localite.rb</key>
-		<dict>
-			<key>caret</key>
-			<dict>
-				<key>column</key>
-				<integer>0</integer>
-				<key>line</key>
-				<integer>208</integer>
-			</dict>
-			<key>firstVisibleColumn</key>
-			<integer>0</integer>
-			<key>firstVisibleLine</key>
-			<integer>172</integer>
-		</dict>
-		<key>lib/localite/filter.rb</key>
-		<dict>
-			<key>caret</key>
-			<dict>
-				<key>column</key>
-				<integer>45</integer>
-				<key>line</key>
-				<integer>65</integer>
-			</dict>
-			<key>firstVisibleColumn</key>
-			<integer>0</integer>
-			<key>firstVisibleLine</key>
-			<integer>56</integer>
-		</dict>
-		<key>lib/localite/template.rb</key>
-		<dict>
-			<key>caret</key>
-			<dict>
-				<key>column</key>
-				<integer>0</integer>
-				<key>line</key>
-				<integer>54</integer>
-			</dict>
-			<key>firstVisibleColumn</key>
-			<integer>0</integer>
-			<key>firstVisibleLine</key>
-			<integer>31</integer>
-		</dict>
-		<key>script/console</key>
-		<dict>
-			<key>caret</key>
-			<dict>
-				<key>column</key>
-				<integer>47</integer>
-				<key>line</key>
-				<integer>16</integer>
-			</dict>
-			<key>firstVisibleColumn</key>
-			<integer>0</integer>
-			<key>firstVisibleLine</key>
-			<integer>0</integer>
-		</dict>
-	</dict>
-	<key>openDocuments</key>
-	<array>
-		<string>lib/localite.rb</string>
-		<string>lib/localite/filter.rb</string>
-		<string>script/console</string>
-		<string>lib/localite/template.rb</string>
-		<string>config/gem.yml</string>
-		<string>config/dependencies.rb</string>
-	</array>
+	<dict/>
 	<key>showFileHierarchyDrawer</key>
 	<true/>
 	<key>windowFrame</key>
-	<string>{{10, 12}, {924, 778}}</string>
+	<string>{{10, 0}, {924, 778}}</string>
 </dict>
 </plist>

data/tasks/echoe.rake

@@ -38,7 +38,7 @@ if gem_config = YAML.load(File.read("#{GEM_ROOT}/config/gem.yml"))
     puts "============================================="
     puts "Installing gem..."
 
-    system "gem install #{gem} > /dev/null 2>&1"
+    system "sudo gem install #{gem} > /dev/null 2>&1"
 
     puts ""
     puts "I built and installed the gem for you. To upload, run "

data/test/i18n/de.tr

@@ -0,0 +1,5 @@
+t: "de.t"
+outer:
+  inner:
+    x1: "de/outer/inner/x1"
+title: "Das ist Hypertext!"

data/test/i18n/en.tr

@@ -0,0 +1,16 @@
+#
+# comment
+param: "{* xxx *}"
+base: "en_only"
+t: "en.t"
+#
+# another comment
+outer:
+  inner:
+    x1: "en/outer/inner/x1"
+title: "This is hypertext"
+title2: "This is <> hypertext"
+
+outer: |
+  A multiline
+  entry

data/test/rails/Rakefile

@@ -0,0 +1,10 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require(File.join(File.dirname(__FILE__), 'config', 'boot'))
+
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+require 'tasks/rails'

data/test/rails/app/controllers/application_controller.rb

@@ -0,0 +1,10 @@
+# Filters added to this controller apply to all controllers in the application.
+# Likewise, all the methods added will be available for all controllers.
+
+class ApplicationController < ActionController::Base
+  helper :all # include all helpers, all the time
+  protect_from_forgery # See ActionController::RequestForgeryProtection for details
+
+  # Scrub sensitive parameters from your log
+  # filter_parameter_logging :password
+end

data/test/rails/app/controllers/localite_controller.rb

@@ -0,0 +1,20 @@
+require "localite/filter"
+
+class LocaliteController < ApplicationController
+  include Localite::Filter
+  
+  def index
+  end
+
+  def current_locale
+    return "de" if action_name == "auto" 
+    super
+  end
+
+  def auto
+    render :action => :index
+  end
+  
+  def template
+  end
+end

data/test/rails/app/views/localite/index.html.erb

@@ -0,0 +1,19 @@
+<h1>Localite test page</h1>
+
+<div class="localite">
+  <div class="title"><%= :title.t %></div>
+  <div class="paragraph"><%= :paragraph.t %></div>
+</div>
+
+<div class="error">
+  <%=
+    err = begin
+      :error.t 
+    rescue Localite::Translate::Missing
+      $!
+    end
+    %w(string locale).map do |key|
+      content_tag :div, key + err.send(key).inspect, :class => key
+    end.join("\n")
+  %>
+</div>

data/test/rails/app/views/localite/template.de.html.erb

@@ -0,0 +1 @@
+das ist deutsch!

data/test/rails/app/views/localite/template.en.html.erb

@@ -0,0 +1 @@
+this is english!

data/test/rails/config/boot.rb

@@ -0,0 +1,110 @@
+# Don't change this file!
+# Configure your app in config/environment.rb and config/environments/*.rb
+
+RAILS_ROOT = "#{File.dirname(__FILE__)}/.." unless defined?(RAILS_ROOT)
+
+module Rails
+  class << self
+    def boot!
+      unless booted?
+        preinitialize
+        pick_boot.run
+      end
+    end
+
+    def booted?
+      defined? Rails::Initializer
+    end
+
+    def pick_boot
+      (vendor_rails? ? VendorBoot : GemBoot).new
+    end
+
+    def vendor_rails?
+      File.exist?("#{RAILS_ROOT}/vendor/rails")
+    end
+
+    def preinitialize
+      load(preinitializer_path) if File.exist?(preinitializer_path)
+    end
+
+    def preinitializer_path
+      "#{RAILS_ROOT}/config/preinitializer.rb"
+    end
+  end
+
+  class Boot
+    def run
+      load_initializer
+      Rails::Initializer.run(:set_load_path)
+    end
+  end
+
+  class VendorBoot < Boot
+    def load_initializer
+      require "#{RAILS_ROOT}/vendor/rails/railties/lib/initializer"
+      Rails::Initializer.run(:install_gem_spec_stubs)
+      Rails::GemDependency.add_frozen_gem_path
+    end
+  end
+
+  class GemBoot < Boot
+    def load_initializer
+      self.class.load_rubygems
+      load_rails_gem
+      require 'initializer'
+    end
+
+    def load_rails_gem
+      if version = self.class.gem_version
+        gem 'rails', version
+      else
+        gem 'rails'
+      end
+    rescue Gem::LoadError => load_error
+      $stderr.puts %(Missing the Rails #{version} gem. Please `gem install -v=#{version} rails`, update your RAILS_GEM_VERSION setting in config/environment.rb for the Rails version you do have installed, or comment out RAILS_GEM_VERSION to use the latest version installed.)
+      exit 1
+    end
+
+    class << self
+      def rubygems_version
+        Gem::RubyGemsVersion rescue nil
+      end
+
+      def gem_version
+        if defined? RAILS_GEM_VERSION
+          RAILS_GEM_VERSION
+        elsif ENV.include?('RAILS_GEM_VERSION')
+          ENV['RAILS_GEM_VERSION']
+        else
+          parse_gem_version(read_environment_rb)
+        end
+      end
+
+      def load_rubygems
+        min_version = '1.3.2'
+        require 'rubygems'
+        unless rubygems_version >= min_version
+          $stderr.puts %Q(Rails requires RubyGems >= #{min_version} (you have #{rubygems_version}). Please `gem update --system` and try again.)
+          exit 1
+        end
+
+      rescue LoadError
+        $stderr.puts %Q(Rails requires RubyGems >= #{min_version}. Please install RubyGems and try again: http://rubygems.rubyforge.org)
+        exit 1
+      end
+
+      def parse_gem_version(text)
+        $1 if text =~ /^[^#]*RAILS_GEM_VERSION\s*=\s*["']([!~<>=]*\s*[\d.]+)["']/
+      end
+
+      private
+        def read_environment_rb
+          File.read("#{RAILS_ROOT}/config/environment.rb")
+        end
+    end
+  end
+end
+
+# All that for this:
+Rails.boot!