g11n 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in g11n.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Fernando Via
+
+MIT License
+
+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.

data/README.md

@@ -0,0 +1,85 @@
+# G11n is Globalization
+
+Globalization (g11n) is a Ruby Gem for easy language file handling aimed at internationalized projects.
+
+The developers of g11n are well aware of the existence of both i18n and r18n Ruby Gems, but wanted a new approach (specially in terms of simplicity) and this is the answer.
+
+## Usage
+
+G11n assumes you will have a series of language files written in YAML in an accessible folder to your project, named after each language's locale and followed by the YAML extension. Both `.yaml` and `.yml` extensions are recognized.
+
+The default path for that folder is `translations/`. So, for example, if you have a file named `translations/it.yaml` that reads as...
+
+    # ./translations/it.yaml
+    home:
+      title: La pasta di la nonna
+      menu:
+        preparation: Comme farla
+        eating: Comme si mangia
+        wine: Con che si accompagna
+
+... you can, in your project, insert the following code and get the internationalized strings:
+
+    # .script.rb
+    require "g11n"
+    
+    G11n.locale :it                             # Configures G11n to use italian. Default is "en"
+    
+    G11n.t.home.title                           # => "La pasta di la nonna"
+    G11n.t.home.menu.wine                       # => "Con che si accompagna"
+    
+## Installation
+
+    $ gem install g11n
+
+### Or when using Bundler
+
+Add this line to your application's Gemfile:
+
+    gem 'g11n'
+
+And then execute:
+
+    $ bundle
+
+## Configuring
+
+Configuration is straight forward. You are using another directory for your language files? Just `G11n.path "your/path"`. You want to change the locale? `G11n.locale :yours`.
+
+    # ./translations/ru.yml
+    home:
+      land: Российская Федерация
+    
+    require "g11n"
+    
+    G11n.path "i18ns"
+    G11n.locale :ru
+    
+    G11n.t.home.land                           # => "Российская Федерация"
+
+Also, the `G11n::DSL` module can be included in any object of class you want to use the `#t` method more confortably.
+
+> **Note**: g11n is planned to soon be made a Sinatra extension
+
+## Testing
+
+Cucumber features and RSpec specs are provided to check functionality.
+
+An exception is the G11n::Dictionary class, which is just a subclass of SymbolTable that recursively converts all hashes passed as argument to the initializer into Dictionaries. This is really handy.
+
+## License
+
+Copyright (C) 2012 Fetcher
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <http://www.gnu.org/licenses/>.

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/features/domain_specific_language.feature

@@ -0,0 +1,16 @@
+Feature: Domain Specific Language
+  In order to use the g11n engine easily
+  As a developer
+  I want to have a DSL in a Façade object
+  
+@rollback
+Scenario: Setup the translations path, the locale and get a translation
+  Given a source file "i18n/uy.yaml" with:
+    """
+    bebida:
+      nacional: Mate
+    """
+  When I send :path "i18n" to the configuration DSL
+  And I send :locale :uy to the configuration DSL
+  And I run "bebida.nacional" on the :t method
+  Then I should see "Mate"

data/features/get_a_translation.feature

@@ -0,0 +1,56 @@
+Feature: Get a translation
+  In order to get a translation of an identifier
+  As a developer of an internationalized app
+  I want to have a simple syntax
+
+@rollback
+Scenario: Simple example and simple translation
+  Given a source file "translations/en.yaml" with:
+    """
+    hello: Hello World!
+    """
+  When I have the locale setted as "en"
+  And I write "hello" in the translation engine
+  Then I should see "Hello World!"
+  
+@rollback
+Scenario: Not so simple, more interesting case
+  Given a source file "translations/ru.yml" with:
+    """
+    home:
+      country: Российская Федерация
+    """
+  When I have the locale setted as "ru"
+  And I write "home.country" in the translation engine
+  Then I should see "Российская Федерация"
+
+@rollback
+Scenario: With several languages and changing language on the fly
+  Given a source file "translations/es-ar.yaml" with:
+    """
+    home:
+      country:
+        legal_name: República Argentina
+    """
+  And a source file "translations/ja.yml" with:
+    """
+    home:
+      country:
+        legal_name: 日本国
+    """
+  When I have the locale setted as "es-ar"
+  And I write "home.country.legal_name" in the translation engine
+  Then I should see "República Argentina"
+  When I have the locale setted as "ja"
+  And I write "home.country.legal_name" in the translation engine
+  Then I should see "日本国"
+
+@rollback
+Scenario: Locale left default
+  Given a source file "translations/en.yaml" with:
+    """
+    comes:
+      from: USA
+    """
+  When I write "comes.from" in the translation engine
+  Then I should see "USA"

data/features/stepdefs/domain_specific_language/setup_the_translations_path_the_locale_and_get_a_translation.rb

@@ -0,0 +1,28 @@
+#Scenario: Setup the translations path, the locale and get a translation
+#  Given a source file "i18n/uy.yaml" with:
+#    """
+#    bebida:
+#      nacional: Mate
+#    """
+#  When I send :path "i18n" to the DSL
+#  And I send :locale :uy to the DSL
+#  And I run "bebida.nacional" on the :t method
+#  Then I should see "Mate"
+
+When /^I send :(\w+) "(.+?)" to the configuration DSL$/ do |message, argument|
+  o = Object.new
+  o.extend G11n::Configuration
+  o.send message.to_sym, argument
+end 
+
+And /^I send :(\w+) :(\w+) to the configuration DSL$/ do |message, argument|
+  o = Object.new
+  o.extend G11n::Configuration
+  o.send message.to_sym, argument
+end
+
+And /^I run "(.*?)" on the :(\w+) method$/ do |argument, message|
+  o = Object.new
+  o.extend G11n::DSL
+  @the_translation = eval "o.#{message}.#{argument}"  
+end

data/features/stepdefs/get_a_translation/simple_example_and_simple_translation.rb

@@ -0,0 +1,24 @@
+#Scenario: Simple example and simple translation
+#  Given a source file "translations/en.yaml" with:
+#    """
+#    hello: Hello World!
+#    """
+#  When I have the locale setted as "en"
+#  And I write "hello" in the translation engine
+#  Then I should see "Hello World!"
+
+Given /^a source file "(.*?)" with:$/ do |file, content|
+  Fast.file.write file, content
+end
+
+When /^I have the locale setted as "(.*?)"$/ do |locale|
+  G11n::Translator.instance.locale = locale.to_sym
+end
+
+And /^I write "(.*?)" in the translation engine$/ do |identifier|
+  @the_translation = eval "G11n::Translator.instance.translate.#{identifier}"
+end
+
+Then /^I should see "(.*?)"$/ do |text|
+  @the_translation.should == text
+end

data/features/support/env.rb

@@ -0,0 +1,7 @@
+require "fast/fast"
+require "pry"
+
+$LOAD_PATH << File.expand_path("../../../../lib", __FILE__)
+require "g11n"
+
+World Fast

data/features/support/hooks.rb

@@ -0,0 +1,12 @@
+# The translations/ folder should be removed after use
+After "@rollback" do
+  Fast.dir.delete! :translations, :i18n
+
+  class << G11n::Translator.instance
+    def cleanup
+      reset
+    end
+  end
+  
+  G11n::Translator.instance.cleanup
+end

data/g11n.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/g11n/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Xavier Via"]
+  gem.email         = ["xavier.via.canel@gmail.com"]
+  gem.description   = %q{Internationalization library focused in simplicity of implementation}
+  gem.summary       = %q{Internationalization library focused in simplicity of implementation}
+  gem.homepage      = "http://github.com/Fetcher/g11n"
+
+  gem.add_dependency "symboltable"
+
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "cucumber"
+  gem.add_development_dependency "fast"
+  gem.add_development_dependency "pry"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "g11n"
+  gem.require_paths = ["lib"]
+  gem.version       = G11n::VERSION
+end

data/lib/g11n.rb

@@ -0,0 +1,20 @@
+# Core
+require "singleton"
+
+# Third-party
+require "symboltable"
+
+# Local
+require "g11n/version"
+require "g11n/translator"
+require "g11n/dictionary"
+require "g11n/exceptions"
+require "g11n/dsl"
+require "g11n/configuration"
+
+module G11n
+  class << self
+    include DSL
+    include Configuration
+  end
+end

data/lib/g11n/configuration.rb

@@ -0,0 +1,14 @@
+module G11n
+  # DSL for the configuration of G11n
+  module Configuration    
+    # Sets the translations path
+    def path the_path
+      Translator.instance.translations_path = the_path + "/"
+    end
+    
+    # Sets the locale
+    def locale the_locale
+      Translator.instance.locale = the_locale
+    end
+  end
+end

data/lib/g11n/dictionary.rb

@@ -0,0 +1,21 @@
+# Stupid but really useful class:
+# Inherits from SymbolTable (https://github.com/mjijackson/symboltable), but when it is initialized
+# it simply... well, recursively converts all Hashes into dictionaries
+module G11n
+  class Dictionary < SymbolTable
+    
+    def initialize *args
+      super *args
+      _symbolize!
+    end
+    
+    private
+      def _symbolize!
+        each_key do |key|
+          if self[key].instance_of? Hash
+            self[key] = Dictionary.new self[key]
+          end
+        end
+      end
+  end
+end

data/lib/g11n/dsl.rb

@@ -0,0 +1,13 @@
+module G11n
+
+  # The Facade so the g11n library gets used by humans!
+  module DSL
+  
+    # Makes the translations. Nice, isn't it? Also, a bonus :translate alias
+    def t
+      Translator.instance.translate
+    end
+    
+    alias :translate :t
+  end
+end

data/lib/g11n/exceptions.rb

@@ -0,0 +1,3 @@
+module G11n
+  class NoTranslationAvailable < StandardError; end
+end

data/lib/g11n/translator.rb

@@ -0,0 +1,54 @@
+module G11n
+  # Manages the configuration of the G11n library
+  class Translator
+    include Singleton
+    
+    def initialize
+      reset
+    end
+    
+    # Sets the locale. Fails if the locale matches no available file
+    def locale= the_locale
+      unless locale_file_exists_for? the_locale
+        raise NoTranslationAvailable, "There is no translation file available for the '#{the_locale}' locale, check the tranlations source directory configuration"
+      end      
+      @locale = the_locale
+    end
+    
+    # Sets the path where translations will be looked for
+    def translations_path= the_path
+      @translations_path = the_path
+    end
+   
+    # Forwards the method call to the right "dictionary" (a SymbolTable object)
+    # http://mjijackson.com/2010/04/config-revisited
+    # What it truely does the #translate method is to retrieve the right SymbolTable object from the 
+    # dictionary
+    def translate
+      dictionary_for @locale
+    end
+    
+    # Looks and returns the right dictionary for the given locale
+    def dictionary_for the_locale
+      return @dictionaries[the_locale] if @dictionaries.has_key? the_locale # In case is already loaded
+      if File.exists? "#{@translations_path}#{the_locale}.yaml" 
+        @dictionaries[the_locale] = Dictionary.new YAML.load_file "#{@translations_path}#{the_locale}.yaml"
+      elsif File.exists? "#{@translations_path}#{the_locale}.yml"
+        @dictionaries[the_locale] = Dictionary.new YAML.load_file "#{@translations_path}#{the_locale}.yml"
+      else
+        raise NoTranslationAvailable, "There is no translation file available for the '#{the_locale}' locale, check the tranlations source directory configuration"
+      end
+    end
+    
+    private
+      def locale_file_exists_for? the_locale
+        File.exists?("#{@translations_path}#{the_locale}.yaml") || File.exists?("#{@translations_path}#{the_locale}.yml")
+      end
+      
+      def reset
+        @translations_path = "translations/"
+        @dictionaries = {}
+        @locale = :en
+      end
+  end
+end

data/lib/g11n/version.rb

@@ -0,0 +1,3 @@
+module G11n
+  VERSION = "0.0.1"
+end

data/spec/g11n/translator_spec.rb

@@ -0,0 +1,109 @@
+require "g11n"
+require "fast/fast"
+require "pry"
+
+def low_level_deconfigurate!
+  Fast.dir.delete! :translations
+
+  class << G11n::Translator.instance
+    def cleanup
+      reset
+    end
+  end
+  
+  G11n::Translator.instance.cleanup
+end
+
+describe G11n::Translator do
+  after :each do  
+    low_level_deconfigurate!
+  end
+  
+  describe "#locale=" do
+    context "there is no available file for that locale" do
+      it "should raise a relevant error" do
+        expect { G11n::Translator.instance.locale = :ru
+        }.to raise_error G11n::NoTranslationAvailable, 
+          "There is no translation file available for the 'ru' locale, check the tranlations source directory configuration"
+      end
+    end
+    
+    context "there is a file available for that locale" do
+      before { Fast.file.write "translations/en.yaml", "text: Hello" }
+      
+      it "should set the locale as the given argument" do
+        G11n::Translator.instance.locale = :en
+        class << G11n::Translator.instance
+          def test_me
+            @locale.should == :en
+          end
+        end
+        G11n::Translator.instance.test_me
+      end
+    end
+  end
+  
+  describe "#translations_path=" do
+    it "sets the translations path" do
+      G11n::Translator.instance.translations_path = "other_path"
+      class << G11n::Translator.instance
+        def test_me
+          @translations_path.should == "other_path"
+        end
+      end
+      G11n::Translator.instance.test_me
+    end
+  end 
+  
+  describe "#dictionary_for" do
+    context "there is in fact a dictionary for the locale" do
+      before do 
+        Fast.file.write "translations/en.yaml", { :hello => "Text", :nested => { :is => "good" } }.to_yaml
+      end
+      
+      it "should return the G11n::Dictionary object with the information from the YAML file" do
+        dictionary = G11n::Translator.instance.dictionary_for :en
+        dictionary.should be_a G11n::Dictionary
+        dictionary.should have_key :hello
+      end
+    end
+  end
+
+  describe "#translate" do
+    context "there is a file usable for translation" do
+      before do 
+        Fast.file.write "translations/en.yaml", { :text => "Hello" }.to_yaml
+      end
+      
+      it "should return the translated string" do
+        G11n::Translator.instance.translate.text.should == "Hello"
+      end
+    end
+  end
+  
+  # PRIVATE methods
+  describe "#locale_file_exists_for?" do
+    context "the file in deed exists" do
+      before { Fast.file.touch "translations/en.yaml" }
+      it "should return true" do
+        class << G11n::Translator.instance
+          def test_me
+            locale_file_exists_for?(:en).should == true
+          end
+        end
+        G11n::Translator.instance.test_me
+      end
+    end
+    
+    context "there's no such file" do
+      it "should return false" do
+        class << G11n::Translator.instance
+          def test_me
+            locale_file_exists_for?(:en).should == false
+          end
+        end
+        G11n::Translator.instance.test_me
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification 
+name: g11n
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Xavier Via
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-07-24 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: symboltable
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: cucumber
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: fast
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: pry
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+description: Internationalization library focused in simplicity of implementation
+email: 
+- xavier.via.canel@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- features/domain_specific_language.feature
+- features/get_a_translation.feature
+- features/stepdefs/domain_specific_language/setup_the_translations_path_the_locale_and_get_a_translation.rb
+- features/stepdefs/get_a_translation/simple_example_and_simple_translation.rb
+- features/support/env.rb
+- features/support/hooks.rb
+- g11n.gemspec
+- lib/g11n.rb
+- lib/g11n/configuration.rb
+- lib/g11n/dictionary.rb
+- lib/g11n/dsl.rb
+- lib/g11n/exceptions.rb
+- lib/g11n/translator.rb
+- lib/g11n/version.rb
+- spec/g11n/translator_spec.rb
+homepage: http://github.com/Fetcher/g11n
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Internationalization library focused in simplicity of implementation
+test_files: 
+- features/domain_specific_language.feature
+- features/get_a_translation.feature
+- features/stepdefs/domain_specific_language/setup_the_translations_path_the_locale_and_get_a_translation.rb
+- features/stepdefs/get_a_translation/simple_example_and_simple_translation.rb
+- features/support/env.rb
+- features/support/hooks.rb
+- spec/g11n/translator_spec.rb
+has_rdoc: