localization_generator 1.0.0 → 1.0.1

data/USAGE

@@ -2,8 +2,10 @@ NAME
      localization - rails localization generator
 
 SYNOPSIS
-     ruby script/generate localization
-     
+     ruby script/generate localization class_name
+
+     Good names are Localization, LocalizationSettings.
+
 DESCRIPTION
      This generator installs a module, as originally implemented in RForum,
      for localization of strings.
@@ -21,4 +23,4 @@ EXAMPLE
      via the variable 'default_lang.' The value should be the prefix of the
      .yaml file in the lang directory.
 
-     That's it! Thanks to Andreas Schwarz for the code.
+     That's it! Thanks to Andreas Schwarz for the code.

data/localization_generator.rb

@@ -12,6 +12,13 @@ class LocalizationGenerator < Rails::Generator::NamedBase
 
       # Configuration
       m.template "localization_environment.rb", "config/environments/#{file_name}_environment.rb"
+
+      # Tests
+      m.template "localization_test.rb", "test/unit/#{file_name}_test.rb"
+      m.template "lang.yaml", "lang/#{plural_name}.yaml"
+
+      m.template "README", "README_#{class_name.upcase}"
     end
   end
 end
+

data/templates/README

@@ -0,0 +1,51 @@
+== Installation
+
+After generating the login system, open your application.rb controller.
+The beginning of your ApplicationController should look something like this:
+
+  require '<%= singular_name %>'
+
+  class ApplicationController < ActionController::Base
+    include <%= class_name %>
+
+Additionally, you'll need to includes this module as appropriate to use it
+elsewhere, such as in your views. You also need to add the following at the end
+of your config/environment.rb file:
+
+require 'environments/<%= singular_name %>_environment'
+require '<%= singular_name %>'
+<%= class_name %>::load_localized_strings
+
+Under the 'enviroments' subdirectory, you'll find <%= singular_name %>_environment.rb.
+Edit this file as necessary...
+
+== Requirements
+
+You need to put your translations in the files lang/[language].yaml. Then, the
+:default_language => [language] configuration variable will ensure that the
+appropriate file is loaded.
+
+== How to use it 
+
+When you want a localized string such as "localized_hello", simply create a new
+entry in all supported lannguage YAML files of the form:
+
+In en.yaml:
+
+localized_hello: hello
+
+In sp.yaml:
+
+localized_hello: hola
+
+Then in your code, you assign the string as follows:
+
+str_var = l(:localized_hello)
+
+In the environments/<%= singular_name %>_environment file, set the
+configuration variable :default_language to either 'en' or 'sp.' That's it!
+
+== Changelog
+
+1.0.1 Fixed a few problems, including with test suite
+1.0.0 First gem release

data/templates/lang.yaml

@@ -0,0 +1,2 @@
+available_forums: Available forums
+registration_email_sent: Email was sent to %s

data/templates/localization.rb

@@ -19,10 +19,15 @@ module <%= class_name %>
       arguments = symbol
       symbol = arguments.shift
     end
-  
-    translation = (LOCALIZED_STRINGS[language][symbol] or
-      LOCALIZED_STRINGS['en'][symbol] or
-        symbol.to_s)
+
+    begin
+      translation = (LOCALIZED_STRINGS[language][symbol] or
+                       LOCALIZED_STRINGS['en'][symbol] or
+                       symbol.to_s)
+    rescue
+      translation = symbol.to_s
+    end
+
     begin
       return translation % arguments
     rescue => e

data/templates/localization_test.rb

@@ -0,0 +1,47 @@
+#!/bin/env ruby
+
+require File.dirname(__FILE__) + '/../test_helper'
+
+class <%= class_name %>Test < Test::Unit::TestCase
+  
+  include <%= class_name %>
+  
+  # TODO: shouldn't use production data for tests
+  # require File.dirname(__FILE__) + '/../test_helper'
+  TRANSLATION_TABLE = LOCALIZED_STRINGS['<%= plural_name %>']
+  CONFIG[:default_language] = '<%= plural_name %>'
+
+  def test_normal_translation
+    assert_equal TRANSLATION_TABLE[:available_forums], l(:available_forums)
+  end
+
+  def test_unknown_string
+    assert_equal 'test_symbol_that_has_no_traslation', l(:test_symbol_that_has_no_traslation)
+  end
+  
+  def test_with_arguments
+    assert_match /an argument/, l(:registration_email_sent, 'an argument')
+  end
+
+  def test_missing_an_expected_argument
+    assert_raise (ArgumentError) { l(:registration_email_sent) }
+  end
+
+  def test_arguments_as_array
+    assert_match /an argument/, l([:registration_email_sent, 'an argument'])
+  end
+
+  def test_arguments_empty_array
+    assert_raise(ArgumentError) { l([]) }
+  end
+
+  def test_array_and_arguments
+    assert_raise(ArgumentError) { l([:registration_email_sent, 'an argument'], 'some more arguments') }
+  end
+
+  def test_LString_to_s
+    # was a silly bug
+    assert_nothing_raised { LString.new(:registration_email_sent, 'an argument').to_s }
+  end
+
+end

metadata

@@ -3,7 +3,7 @@ rubygems_version: 0.8.8
 specification_version: 1
 name: localization_generator
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
+  version: 1.0.1
 date: 2005-04-19
 summary: "[Rails] Localization generator."
 require_paths: 
@@ -29,9 +29,12 @@ authors:
   - Joe Hosteny
 files: 
   - USAGE
+  - templates/README
   - localization_generator.rb
   - templates/localization.rb
   - templates/localization_environment.rb
+  - templates/localization_test.rb
+  - templates/lang.yaml
 test_files: []
 rdoc_options: []
 extra_rdoc_files: []