localize 0.1

data/LICENSE

@@ -0,0 +1,10 @@
+Copyright (c) 2010, Andrey Savchenko
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+* Neither the name of the Aejis nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.rdoc

@@ -0,0 +1,127 @@
+= Localize
+Localize is a small library for internationalization.
+Example:
+
+  puts t.hello # => Hola
+  puts t.hello.world # => Hola, mundo
+  puts f 380441234567 # => +380 (44) 123-45-67
+  puts l Time.utc(2000, "jan"), :short # => Sat 01-Jan-00
+  puts l 1200.05 # => 1.200,05
+
+== Install
+
+  gem install localize
+  require 'localize'
+
+== Setup
+
+Set the store, yaml or plain for now, xml and others planned (default yaml):
+
+  Localize.store = :plain
+
+Specify location of the translation files:
+
+  Localize.location = 'lib/translations'
+
+if store set to plain, location must be a ruby hash:
+
+  Localize.location = {'text' => { 'hello' => {'world' => 'mundo' } }
+
+Set locale:
+
+  Localize.locale = :esp
+
+and default locale (optional, en by default):
+
+  Localize.default_locale = :ru
+
+Now, load the translation:
+
+  t = Localize.translate
+  f = Localize.f
+  l = Localize.l
+
+== Sinatra setup
+sinatra.rb contains predefined helpers <tt>t</tt>, <tt>l</tt> and <tt>f</tt> and set locale from <tt>session['locale']</tt>
+
+  require 'localize/sinatra'
+  Localize.default_locale = :ru
+  Localize.location = 'locales' # Change to your path
+
+== Translation files
+Translation file must contain two sections: 'text' and 'formats'.
+
+Text section contains translations and can have an unlimited nesting:
+
+  text:
+    hello: 'hola' # t.hello
+    foo:
+        bar: 'baz' # t.foo.bar
+
+Formats section contains different localization rules and formats:
+
+  formats:
+    phone:
+      :full: '+### (##) ###-##-##'
+      :short: '###-##-##'
+    number:
+      separator: ','
+      dec_point: '.'
+
+Phone subsection must have format named 'full', and may have arbitrary names which can called by second parameter in f method:
+
+  f(78977654) # Full format
+  f(12345678, :short)
+  f(32145687, :other)
+
+Date subsection must contains translations for months and days of the week. Also set formats in strftime format:
+
+  formats:
+    date:
+      format:
+        :full: '%a %b %d %H:%M:%S %Z %Y'
+        :short: '%a %d-%B-%y'
+      day_names:
+        short:
+          - Sun
+          - Mon
+          - Tue
+          - Wed
+          - Thu
+          - Fri
+          - Sat
+        full:
+          - Sunday
+          - Monday
+          - Tuesday
+          - Wednesday
+          - Thursday
+          - Friday
+          - Saturday
+      mon_names:
+        short:
+          - Jan
+          - Feb
+          - Mar
+          - Apr
+          - May
+          - Jun
+          - Jul
+          - Aug
+          - Sep
+          - Oct
+          - Nov
+          - Dec
+        full:
+          - January
+          - February
+          - March
+          - April
+          - May
+          - June
+          - July
+          - August
+          - September
+          - October
+          - November
+          - December

data/lib/localize/adapters/yaml.rb

@@ -0,0 +1,15 @@
+# encoding: utf-8
+module Localize
+  class YAMLadapter
+    require 'yaml'
+
+    def self.get_trans
+      tr = {}
+      Dir.glob(File.join(Localize::location, "#{Localize::locale.to_s}.yml")).each do |file|
+        f = (RUBY_VERSION < '1.9') ? ::File.open(file) : ::File.open(file, 'r:utf-8')
+        tr.merge! ::YAML.load(f)
+      end
+      tr
+    end
+  end
+end

data/lib/localize/formats.rb

@@ -0,0 +1,60 @@
+module Localize
+  class Formats
+    class << self
+
+      # Based on snippet in http://snippets.dzone.com/posts/show/2472
+      def phone(str, format = :full)
+        require 'strscan'
+        pattern = Localize.trans[:formats]['phone'][format]
+        slots = pattern.count('#')
+        source = str.to_s
+
+        if source.length < slots
+          keepCount = source.length
+          leftmost, rightmost = 0, pattern.length - 1
+
+          leftmost = (1...keepCount).inject(pattern.rindex('#')) {
+              |leftmost, n| pattern.rindex('#', leftmost - 1) }
+
+          pattern = pattern[leftmost..rightmost]
+        end
+
+        scanner = ::StringScanner.new(pattern)
+        sourceIndex = 0
+        result = ''
+        fixRegexp = Regexp.new(Regexp.escape('#'))
+        while not scanner.eos?
+          if scanner.scan(fixRegexp) then
+            result += source[sourceIndex].chr
+            sourceIndex += 1
+          else
+            result += scanner.getch
+          end
+        end
+        result
+      end
+
+      def date(source, format = :full)
+        locale = Localize.trans[:formats]['date']
+        format = locale['format'][format]
+
+        format.gsub!(/%a/, locale['day_names']['short'][source.wday])
+        format.gsub!(/%A/, locale['day_names']['full'][source.wday])
+        format.gsub!(/%b/, locale['mon_names']['short'][source.mon-1])
+        format.gsub!(/%B/, locale['mon_names']['full'][source.mon-1])
+
+        source.strftime(format)
+      end
+
+      # Based on snippet on rubygarden
+      def number(num)
+        locale = Localize.trans[:formats]['number']
+        separator = locale['separator'] || ''
+        decimal_point = locale['dec_point'] || '.'
+        num_parts = num.to_s.split('.')
+        x = num_parts[0].reverse.scan(/.{1,3}/).join(separator).reverse
+        x << decimal_point + num_parts[1]
+      end
+    end
+  end
+end

data/lib/localize/sinatra.rb

@@ -0,0 +1,19 @@
+require 'localize'
+
+before do
+  Localize.locale = session['locale'] if session['locale']
+end
+
+helpers do
+  def t
+    Localize.translate
+  end
+
+  def l(source, format = :full)
+    Localize.l(source, format)
+  end
+
+  def f(source, format = :full)
+    Localize.f(source, format)
+  end
+end

data/lib/localize.rb

@@ -0,0 +1,138 @@
+# encoding: utf-8
+$KCODE = 'u' if RUBY_VERSION < '1.9'
+
+module Localize
+
+  autoload :YAMLadapter, File.join(File.dirname(__FILE__), 'localize/adapters/yaml')
+  autoload :Formats, File.join(File.dirname(__FILE__), 'localize/formats')
+
+  @@default_locale = :en
+  @@locale = @@default_locale
+  @@store = :yaml
+  @@location = ''
+
+  class << self
+    def load(locale=nil, location=nil)
+      @@locale = locale if locale
+      @@location = location if location
+
+      ret = case @@store
+        when :yaml
+          YAMLadapter.get_trans
+        when :plain
+          @@location
+        else
+          raise "Adapter not avalaible: #{adapter}"
+      end
+      @@trans = {
+        :text => Translation.new(ret['text']),
+        :formats => ret['formats']
+      }
+    end
+
+    def translate
+      load unless @@trans
+      @@trans[:text]
+    end
+
+    def localize(source, format = :full)
+      load unless @@trans
+
+      if source.is_a?(Integer)
+        Formats.number(source)
+      elsif source.is_a?(Float)
+        Formats.number(source)
+      elsif source.is_a?(Time) or source.is_a?(Date)
+        Formats.date(source, format)
+      else
+        raise "Format not recognize"
+      end
+    end
+
+    alias :l :localize
+
+    def phone(source, format = :full)
+      load unless @@trans
+
+      fone = if source.is_a?(Integer)
+        source
+      elsif source.is_a?(String)
+        source.gsub(/[\+., -]/, '').trim.to_i
+      elsif source.is_a?(Float)
+        source.to_s.gsub('.', '').to_i
+      else
+        raise "Format not recognize"
+      end
+      Formats.phone(fone, format)
+    end
+
+    alias :f :phone
+
+    def reset!
+      @@trans = nil
+    end
+
+    def store=(str)
+      reset!
+      @@store = str.to_sym
+    end
+
+    def store
+      @@store
+    end
+
+    def locale=(loc)
+      reset!
+      @@locale = loc
+    end
+
+    def locale
+      @@locale
+    end
+
+    def default_locale=(loc)
+      reset!
+      @@locale = loc.to_sym
+    end
+
+    def default_locale
+      @@locale
+    end
+
+    def location=(locat)
+      reset!
+      @@location = locat
+    end
+
+    def location
+      @@location
+    end
+
+    def trans
+      @@trans
+    end
+  end
+
+  class Translation
+    def initialize(hash)
+      hash.each_pair do |key, value|
+        value = Translation.new(value) if value.is_a?(Hash)
+        key = key.to_s
+        instance_variable_set("@#{key}", value)
+        self.class.class_eval do
+          define_method("#{key}") { instance_variable_get("@#{key}") }
+        end
+      end
+    end
+
+    def method_missing(name, *params)
+      MissString.new('Translation missing: '+name.to_s)
+    end
+  end
+
+  class MissString < String
+    def method_missing(name, *params)
+      self << '.' + name.to_s
+    end
+  end
+end

data/localize.gemspec

@@ -0,0 +1,33 @@
+Gem::Specification.new do |s|
+  s.name          = "localize"
+  s.version       = "0.1"
+  s.date          = "2010-05-06"
+
+  s.summary       = "Lightweight localization library"
+  s.description   = "Lightweight, ruby-way localization solution"
+
+  s.author        = "Andrey Savchenko"
+  s.email         = "andrey@aejis.eu"
+  s.homepage      = "http://aejis.eu/tools/localize"
+  
+  s.files         = %w[
+    LICENSE
+    README.rdoc
+    lib/localize.rb
+    lib/localize/formats.rb
+    lib/localize/sinatra.rb
+    lib/localize/adapters/yaml.rb
+    localize.gemspec
+    test/formats_test.rb
+    test/translate_test.rb
+    test/stores/en.yml
+  ]
+  s.require_paths = %w[lib]
+
+  s.test_files = s.files.select {|path| path =~ /^test\/.*_test.rb/}
+
+  s.has_rdoc = true
+  s.extra_rdoc_files = %w[README.rdoc LICENSE]
+
+  s.add_development_dependency 'rspec'
+end

data/test/formats_test.rb

@@ -0,0 +1,23 @@
+require File.join(File.dirname(__FILE__), '../lib/localize')
+
+describe Localize do
+  before do
+    Localize.location = 'stores'
+  end
+
+  it "Format phone numbers" do
+    Localize.f(380446666666, :full).should == '+380 (44) 666-66-66'
+  end
+
+  it "Localize dates" do
+    Localize.l(Time.utc(2000, "jan")).should == 'Sat Jan 01 00:00:00 UTC 2000'
+  end
+
+  it "Format dates" do
+    Localize.l(Time.utc(2000, "jan"), :short).should == 'Sat 01-January-00'
+  end
+
+  it "Format numbers" do
+    Localize.l(1000.02).should == '1,000.02'
+  end
+end

data/test/stores/en.yml

@@ -0,0 +1,59 @@
+text:
+    hello: 'world'
+    foo:
+        bar: 'baz'
+formats:
+    phone:
+        :full: '+### (##) ###-##-##'
+        :short: '###-##-##'
+    number:
+        separator: ','
+        dec_point: '.'
+    date:
+        format:
+            :full: '%a %b %d %H:%M:%S %Z %Y'
+            :short: '%a %d-%B-%y'
+        day_names:
+            short:
+                - Sun
+                - Mon
+                - Tue
+                - Wed
+                - Thu
+                - Fri
+                - Sat
+            full:
+                - Sunday
+                - Monday
+                - Tuesday
+                - Wednesday
+                - Thursday
+                - Friday
+                - Saturday
+        mon_names:
+            short:
+                - Jan
+                - Feb
+                - Mar
+                - Apr
+                - May
+                - Jun
+                - Jul
+                - Aug
+                - Sep
+                - Oct
+                - Nov
+                - Dec
+            full:
+                - January
+                - February
+                - March
+                - April
+                - May
+                - June
+                - July
+                - August
+                - September
+                - October
+                - November
+                - December

data/test/translate_test.rb

@@ -0,0 +1,36 @@
+require File.join(File.dirname(__FILE__), '../lib/localize')
+
+describe Localize do
+  it "Get translation from plain" do
+    Localize.store      = :plain
+    Localize.location   = {
+      'text' => {
+        'hello' => 'world'
+      }
+    }
+    t = Localize.translate
+    t.hello.should == 'world'
+  end
+
+  it "Get translation from yaml" do
+    Localize.store = :yaml
+    Localize.load(:en, 'stores')
+    t = Localize.translate
+    t.hello.should == 'world'
+  end
+
+  it "Accept nested translations" do
+    t = Localize.translate
+    t.foo.bar.should == 'baz'
+  end
+
+  it "Return right error" do
+    t = Localize.translate
+    t.fee.should == 'Translation missing: fee'
+  end
+
+  it "Return right error with nested translation" do
+    t = Localize.translate
+    t.fee.baz.should == 'Translation missing: fee.baz'
+  end
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification 
+name: localize
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  version: "0.1"
+platform: ruby
+authors: 
+- Andrey Savchenko
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-06 00:00:00 +03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: Lightweight, ruby-way localization solution
+email: andrey@aejis.eu
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- LICENSE
+files: 
+- LICENSE
+- README.rdoc
+- lib/localize.rb
+- lib/localize/formats.rb
+- lib/localize/sinatra.rb
+- lib/localize/adapters/yaml.rb
+- localize.gemspec
+- test/formats_test.rb
+- test/translate_test.rb
+- test/stores/en.yml
+has_rdoc: true
+homepage: http://aejis.eu/tools/localize
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Lightweight localization library
+test_files: 
+- test/formats_test.rb
+- test/translate_test.rb