gibberish

Author: defunkt

LICENSE

@@ -0,0 +1,18 @@
+Copyright (c) 2007 Chris Wanstrath
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of 
+this software and associated documentation files (the "Software"), to deal in 
+the Software without restriction, including without limitation the rights to 
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of 
+the Software, and to permit persons to whom the Software is furnished to do so, 
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all 
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS 
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR 
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER 
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN 
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README

@@ -0,0 +1,6 @@
+= Gibberish
+
+Yet another localization library.  Maybe with the most agreeable API.
+
+>> Chris Wanstrath
+=> chris[at]ozmm[dot]org

init.rb

@@ -0,0 +1 @@
+require 'gibberish'

lang/es.yml

@@ -0,0 +1,3 @@
+welcome_friend: ¡Recepción, amigo!
+welcome_user: ¡Recepción, {user}!
+love_rails: Amo los carriles.

lang/fr.yml

@@ -0,0 +1,3 @@
+welcome_friend: Bienvenue, ami!
+welcome_user: Bienvenue, {user}!
+love_rails: J'aime des rails.

lib/gibberish.rb

@@ -0,0 +1,8 @@
+require 'gibberish/localize'
+require 'gibberish/string_ext'
+
+String.send :include, Gibberish::StringExt
+
+module Gibberish
+  extend Localize
+end

lib/gibberish/localize.rb

@@ -0,0 +1,53 @@
+module Gibberish
+  module Localize
+    @@config = {}
+    mattr_accessor :config
+
+    @@languages = {}
+    mattr_accessor :languages
+
+    @@default_language = :en
+    mattr_reader :default_language
+
+    @@current_language = nil
+    def current_language
+      @@current_language || default_language
+    end
+
+    def current_language=(language)
+      @@current_language = languages[language] ? language : nil
+    end
+
+    def default_language?
+      current_language == default_language
+    end
+
+    def use_default_language
+    end
+
+    def translations
+      @@languages[current_language] || {}
+    end
+
+    def translate(string, key, *args)
+      target = translations[key] || string
+      interpolate_string(target.dup, *args.dup)
+    end
+
+    def load_languages!
+      language_files.each do |file| 
+        key = File.basename(file, '.*').to_sym
+        @@languages[key] = YAML.load_file(file).symbolize_keys
+      end
+    end
+
+  private
+    def interpolate_string(string, *args)
+      string.gsub(/\{\w+\}/) { args.shift }
+    end
+
+    def language_files
+      Dir[File.join(RAILS_ROOT, 'lang', '*.{yml,yaml}')]
+    end
+  end
+end

lib/gibberish/string_ext.rb

@@ -0,0 +1,16 @@
+module Gibberish
+  module StringExt
+    def brackets_with_translation(*args)
+      return brackets_without_translation(*args) unless args.first.is_a? Symbol
+      Gibberish.translate(self, args.shift, *args)
+    end
+
+    def self.included(base)
+      base.class_eval do
+        alias :brackets :[]
+        alias_method_chain :brackets, :translation
+        alias :[] :brackets
+      end
+    end
+  end
+end

test/gibberish_test.rb

@@ -0,0 +1,125 @@
+begin
+  require 'test/spec'
+rescue LoadError
+  puts "==> The test/spec library (gem) is required to run the Gibberish tests."
+  exit
+end
+
+$:.unshift File.dirname(__FILE__) + '/../lib'
+require 'active_support'
+require 'gibberish'
+
+RAILS_ROOT = '.'
+Gibberish.load_languages!
+
+context "After loading languages, Gibberish" do
+  teardown do
+    Gibberish.current_language = nil
+  end
+
+  specify "should know what languages it has translations for" do
+    Gibberish.languages.keys.should.include :es
+  end
+
+  specify "should know if it is using the default language" do
+    Gibberish.should.be.default_language
+  end
+
+  specify "should be able to switch between existing languages" do
+    Gibberish.current_language = :es
+    string = "Welcome, friend!"
+    string[:welcome_friend].should.not.equal string
+
+    Gibberish.current_language = :fr
+    string[:welcome_friend].should.not.equal string
+  end
+
+  specify "should be able to switch to the default language at any time" do
+    Gibberish.current_language = :fr
+    Gibberish.should.not.be.default_language
+
+    Gibberish.current_language = nil
+    Gibberish.should.be.default_language
+  end
+end
+
+context "When no language is set" do
+  setup do
+    Gibberish.current_language = nil
+  end
+
+  specify "the default language should be used" do
+    Gibberish.current_language.should.equal Gibberish.default_language
+  end
+
+  specify "a gibberish string should return itself" do
+    string = "Welcome, friend!"
+    Gibberish.translate(string, :welcome_friend).should.equal string
+
+    string[:welcome_friend].should.equal string
+  end
+end
+
+context "When a non-existent language is set" do
+  setup do
+    Gibberish.current_language = :klingon
+  end
+
+  specify "the default language should be used" do
+    Gibberish.current_language.should.equal Gibberish.default_language
+  end
+
+  specify "gibberish strings should return themselves" do
+    string = "something gibberishy"
+    string[:welcome_friend].should.equal string
+  end
+end
+
+context "A gibberish string (in general)" do
+  specify "should be a string" do
+    "gibberish"[:just_a_string].should.be.an.instance_of String
+    "non-gibberish".should.be.an.instance_of String
+  end
+
+  specify "should interpolate if passed arguments and replaces are present" do
+    'Hi, {user} of {place}'[:hi_there, 'chris', 'france'].should.equal "Hi, chris of france"
+    '{computer} omg?'[:puter, 'mac'].should.equal "mac omg?"
+  end
+
+  specify "should not affect existing string methods" do
+    string = "chris"
+    answer = 'ch'
+    string[0..1].should.equal answer
+    string[0, 2].should.equal answer
+    string[0].should.equal 99
+    string[/ch/].should.equal answer
+    string['ch'].should.equal answer
+    string['bc'].should.be.nil
+    string[/dog/].should.be.nil
+  end
+end
+
+context "When a non-default language is set" do
+  setup do
+    Gibberish.current_language = :es
+  end
+
+  specify "that language should be used" do
+    Gibberish.current_language.should.equal :es
+  end
+
+  specify "the default language should not be used" do
+    Gibberish.should.not.be.default_language
+  end
+
+  specify "a gibberish string should return itself if a corresponding key is not found" do
+    string = "The internet!"
+    string[:the_internet].should.equal string
+  end
+
+  specify "a gibberish string should return a translated version of itself if a corresponding key is found" do
+    "Welcome, friend!"[:welcome_friend].should.equal "¡Recepción, amigo!"
+    "I love Rails."[:love_rails].should.equal "Amo los carriles."
+    'Welcome, {user}!'[:welcome_user, 'Marvin'].should.equal "¡Recepción, Marvin!"
+  end
+end