visionmedia-translatable 0.0.1

data/History.rdoc

@@ -0,0 +1,4 @@
+
+=== 0.0.1 / YYYY-MM-DD
+
+* Initial release

data/Manifest

@@ -0,0 +1,11 @@
+benchmarks/translations.rb
+History.rdoc
+lib/translatable/string.rb
+lib/translatable/translatable.rb
+lib/translatable/version.rb
+lib/translatable.rb
+Manifest
+Rakefile
+README.rdoc
+spec/translatable_spec.rb
+Todo.rdoc

data/README.rdoc

@@ -0,0 +1,29 @@
+
+= Translatable
+
+High performance, minimalistic translation library
+
+== License:
+
+(The MIT License)
+
+Copyright (c) 2008 TJ Holowaychuk
+
+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, an d/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.

data/Rakefile

@@ -0,0 +1,27 @@
+
+require 'rubygems'
+require 'rake'
+require 'echoe'
+require 'spec/rake/spectask'
+require './lib/translatable.rb'
+
+Echoe.new("translatable", Translatable::VERSION::STRING) do |p|
+  p.author = "TJ Holowaychuk"
+  p.email = "tj@vision-media.ca"
+  p.summary = "High performance, minimalistic translation library"
+  p.url = "http://github.com/visionmedia/translateable"
+  p.runtime_dependencies = []
+end
+
+desc 'Run specifications verbosely'
+Spec::Rake::SpecTask.new(:spec) do |t|
+  sh 'clear'
+  t.libs << "lib"
+  t.spec_opts = ["--color", "--format", "specdoc", "--require", "translatable"]
+end
+
+desc 'Run benchmark suite (specify TIMES)'
+task :benchmark do
+  sh 'clear'
+  sh 'ruby benchmarks/translations.rb'
+end

data/Todo.rdoc

@@ -0,0 +1,6 @@
+
+== Major:
+
+* Faster !!!
+* Docs
+* HTML entity escaping (optional but default)

data/benchmarks/translations.rb

@@ -0,0 +1,37 @@
+#!/usr/bin/env ruby
+
+require 'benchmark'
+require File.dirname(__FILE__) + '/../lib/translatable'
+require File.dirname(__FILE__) + '/faux_translations'
+
+n = ENV['TIMES'].to_i || 1000
+puts "\nEach report ran %d times with %d faux translations\n\n" % [n, translations[:en].length]
+Benchmark.bm(25) do |x|
+  x.report("String") {
+    n.times do |i|
+      'String'
+    end
+  }
+  x.report("String Sub #\{\}") {
+    n.times do |i|
+      "String #{i}"
+    end
+  }
+  x.report("String Sub %") {
+    n.times do |i|
+      'String %d' % i
+    end
+  }
+  x.report("Translation Bypassed") {
+    n.times do |i|
+      'String %d'.t i 
+    end
+  }
+  x.report("Translation Performed") {
+    allow_english_translations
+    translate :en, 'String %d' => 'Index is %d'
+    n.times do |i|
+      'String %d'.t i 
+    end
+  }
+end

data/lib/translatable/string.rb

@@ -0,0 +1,39 @@
+
+class String
+  
+  ##
+  # Translate a string. 
+  #
+  # Pass _args_ which in turn are passed to String's % method, used 
+  # for placeholders which should not be translated such as peoples names,
+  # emails, etc.
+  #
+  # When the language is english (default), this process
+  # is simply bypassed, returning the original string. Otherwise
+  # a lookup on the translations hash is performed, searching for a match,
+  # otherwise again the original string is returned.
+  #
+  # There are times when you may want to override strings even within the 
+  # english language simply for flexibility, to do this set 
+  # Translateable::BypassEnglishTranslations to false.
+  #
+  #
+  # === Examples:
+  #
+  #   'Hello'.t                                      # => Hello
+  #   'Hello %s'.t 'TJ'                              # => Hello TJ
+  #   'Hello %s, welcome to %s'.t 'TJ', 'Magic Land' # => Hello TJ, welcome to Magic Land
+  #   'Welcome to %2$s %1$s'.t 'TJ', 'Magic Land'    # => Welcome to Magic Land TJ
+  #
+  
+  def translate *args
+    t = Translatable
+    if t.language == :en and not t.english_translations_allowed?
+      self % args
+    else
+      s = t.translations[t.language][self] rescue self
+      s % args
+    end
+  end
+  alias_method :t, :translate
+end

data/lib/translatable/translatable.rb

@@ -0,0 +1,82 @@
+
+module Translatable
+  
+  ##
+  # Active language symbol.
+  
+  @@language = :en
+  
+  ##
+  # Hash of translations loaded.
+  
+  @@translations = {}
+  
+  ##
+  # Wither or not english string translation lookup should be bypassed 
+  # for performance enhancements.
+  
+  @@bypass_english_translations = true
+    
+  module_function
+  
+  def english_translations_allowed?
+    !@@bypass_english_translations
+  end
+  
+  ##
+  # Allow overriding of english strings, this can be used
+  # to make alterations in situations such as a CMS where you
+  # may not want to alter core. However since most instances
+  # will be using english we typically bypass the translation
+  # process when #language is set to :en
+  
+  def allow_english_translations
+    @@bypass_english_translations = false
+  end
+  
+  ##
+  # Contrast of #allow_english_translations.
+  
+  def disallow_english_translations
+    @@bypass_english_translations = true
+  end
+  
+  ##
+  # Set or return _lanf_ code symbol. Default is :en
+  
+  def language lang = nil
+    @@language = lang.to_sym unless lang.nil?
+    @@language
+  end
+  
+  ##
+  # Translate one or more strings for _lang_.
+  #
+  # Where _lang_ is a symbol representation of the language
+  # such as :en, :fr, and _translations_ is a hash of one or more
+  # key / value pairs containing the original / translated string.
+  #
+  # === Examples:
+  #
+  #   translate :fr, 'I like cookies' => 'J'aime des biscuits'
+  #
+  #   OR 
+  #
+  #   translate :fr, 
+  #     'I like cookies' => 'J'aime des biscuits'
+  #     'I like ruby' => '...'
+  #     'I like ferrets' => '...'
+  #
+  
+  def translate lang, translations
+    @@translations[lang] = (@@translations[lang] || {}).merge translations
+  end
+  
+  ##
+  # Return translation hash.
+  
+  def translations
+    @@translations
+  end
+
+end

data/lib/translatable/version.rb

@@ -0,0 +1,7 @@
+
+module Translatable
+  module VERSION #:nodoc:
+    MAJOR, MINOR, TINY = [0, 0, 1]
+    STRING = [MAJOR, MINOR, TINY].join '.'
+  end
+end

data/lib/translatable.rb

@@ -0,0 +1,30 @@
+#--
+# Copyright (c) 2008 TJ Holowaychuk
+#
+# 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.
+#++
+
+$:.unshift File.dirname(__FILE__)
+
+require 'translatable/version'
+require 'translatable/translatable'
+require 'translatable/string'
+
+Object.send :include, Translatable

data/spec/translatable_spec.rb

@@ -0,0 +1,34 @@
+
+describe "Translateable" do
+  
+  before :each do
+    disallow_english_translations
+  end
+  
+  it "should not allow overriding of english strings" do
+    translate :en, 'foo' => 'bar'
+    'foo'.t.should eql('foo')
+    'foo'.t.should_not eql('bar')
+  end
+  
+  it "should allow overriding of english strings" do
+    allow_english_translations
+    translate :en, 'foo' => 'bar'
+    'foo'.t.should eql('bar')
+  end
+  
+  it "should allow overriding of strings in english with placeholders" do
+    allow_english_translations
+    translate :en, 'Your username is %s, you may also login using %s.' => 'Try your email %2$s, or maybe the username %1$s.'
+    string = 'Your username is %s, you may also login using %s.'.t 'tjholowaychuk', 'tj@vision-media.ca'
+    string.should eql('Try your email tj@vision-media.ca, or maybe the username tjholowaychuk.')
+  end
+  
+  it "should allow translations of strings using other languages" do
+    translate :fr, 'I like %s' => "J'aime %s"
+    language :fr
+    string = 'I like %s'.t 'cookies'
+    string.should eql("J'aime cookies")
+  end
+  
+end

data/translatable.gemspec

@@ -0,0 +1,34 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{translatable}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["TJ Holowaychuk"]
+  s.date = %q{2008-12-11}
+  s.description = %q{High performance, minimalistic translation library}
+  s.email = %q{tj@vision-media.ca}
+  s.extra_rdoc_files = ["lib/translatable/string.rb", "lib/translatable/translatable.rb", "lib/translatable/version.rb", "lib/translatable.rb", "README.rdoc"]
+  s.files = ["benchmarks/translations.rb", "History.rdoc", "lib/translatable/string.rb", "lib/translatable/translatable.rb", "lib/translatable/version.rb", "lib/translatable.rb", "Manifest", "Rakefile", "README.rdoc", "spec/translatable_spec.rb", "Todo.rdoc", "translatable.gemspec"]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/visionmedia/translateable}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Translatable", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{translatable}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{High performance, minimalistic translation library}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<echoe>, [">= 0"])
+    else
+      s.add_dependency(%q<echoe>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<echoe>, [">= 0"])
+  end
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification 
+name: visionmedia-translatable
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- TJ Holowaychuk
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-12-11 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: echoe
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: High performance, minimalistic translation library
+email: tj@vision-media.ca
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- lib/translatable/string.rb
+- lib/translatable/translatable.rb
+- lib/translatable/version.rb
+- lib/translatable.rb
+- README.rdoc
+files: 
+- benchmarks/translations.rb
+- History.rdoc
+- lib/translatable/string.rb
+- lib/translatable/translatable.rb
+- lib/translatable/version.rb
+- lib/translatable.rb
+- Manifest
+- Rakefile
+- README.rdoc
+- spec/translatable_spec.rb
+- Todo.rdoc
+- translatable.gemspec
+has_rdoc: true
+homepage: http://github.com/visionmedia/translateable
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Translatable
+- --main
+- README.rdoc
+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: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: translatable
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: High performance, minimalistic translation library
+test_files: []
+