i18n_namespace 0.0.1

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+
+gem 'i18n'
+gem 'yajl-ruby'
+gem 'active_support', :require => false
+
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "rcov", ">= 0"
+  gem 'rspec'
+end

data/Gemfile.lock

@@ -0,0 +1,38 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    active_support (3.0.0)
+      activesupport (= 3.0.0)
+    activesupport (3.0.0)
+    diff-lcs (1.1.3)
+    git (1.2.5)
+    i18n (0.6.0)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.9.2.2)
+    rcov (0.9.11)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+    shoulda (2.11.3)
+    yajl-ruby (1.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  active_support
+  bundler (~> 1.0.0)
+  i18n
+  jeweler (~> 1.6.4)
+  rcov
+  rspec
+  shoulda
+  yajl-ruby

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Matthias Zirnstein
+
+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.rdoc

@@ -0,0 +1,15 @@
+= i18n_namespace
+
+    I18n.namespace = :administrator
+
+    # with a namespace set, these are the lookup keys
+    # administrator.home.index.content
+    # home.index.content
+    t('home.index.content')
+
+    # your namespace can an array too
+    I18n.namespace = [:administrator, :special_club]
+
+    # administrator.special_club.home.index.content
+    # administrator.home.index.content
+    # home.index.content

data/Rakefile

@@ -0,0 +1,53 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "i18n_namespace"
+  gem.homepage = "http://github.com/avarteqgmbh/i18n_namespace"
+  gem.license = "MIT"
+  gem.summary = %Q{I18n key injection}
+  gem.description = %Q{I18n key injection with fallback functionality}
+  gem.email = "matthias.zirnstein@googlemail.com"
+  gem.authors = ["Matthias Zirnstein"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "i18n_namespace #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/i18n_namespace.gemspec

@@ -0,0 +1,77 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "i18n_namespace"
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Matthias Zirnstein"]
+  s.date = "2012-01-11"
+  s.description = "I18n key injection with fallback functionality"
+  s.email = "matthias.zirnstein@googlemail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "i18n_namespace.gemspec",
+    "lib/i18n_namespace.rb",
+    "lib/i18n_namespace/config.rb",
+    "lib/i18n_namespace/fallbacks.rb",
+    "lib/i18n_namespace/helper.rb",
+    "lib/i18n_namespace/key_value.rb",
+    "lib/i18n_namespace/storing.rb",
+    "spec/lib/i18n_namespace_spec.rb",
+    "test/helper.rb",
+    "test/test_i18n_namespace.rb"
+  ]
+  s.homepage = "http://github.com/avarteqgmbh/i18n_namespace"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.10"
+  s.summary = "I18n key injection"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<i18n>, [">= 0"])
+      s.add_runtime_dependency(%q<yajl-ruby>, [">= 0"])
+      s.add_runtime_dependency(%q<active_support>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+    else
+      s.add_dependency(%q<i18n>, [">= 0"])
+      s.add_dependency(%q<yajl-ruby>, [">= 0"])
+      s.add_dependency(%q<active_support>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<i18n>, [">= 0"])
+    s.add_dependency(%q<yajl-ruby>, [">= 0"])
+    s.add_dependency(%q<active_support>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+  end
+end
+

data/lib/i18n_namespace/config.rb

@@ -0,0 +1,48 @@
+module I18nNamespace
+  module I18n
+    
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods 
+      # TODO: fix this, its absolute
+      ::I18n::RESERVED_KEYS << :namespaced
+      
+      def namespace
+        config.namespace
+      end
+
+      def namespace=(ns)
+        raise "Namespace contains unsupported objects. Allowed are: String, Symbol, Array[Symbol, String] or NilClass. Inspection: #{ns.inspect}" unless valid_namespace?(ns)
+        config.namespace = ns
+      end
+
+      def store_resolved_translation(locale, key, value, options = {})
+        raise "Key has to be a String" unless key.is_a? String
+        raise "Value has to be a String or NilClass" if !value.is_a?(String) && !value.is_a?(NilClass)
+        
+        resolved = key.split('.').reverse.inject(value) {|a, n| {n => a}}
+
+        backend.store_translations locale, resolved, options 
+      end
+
+      private
+        # TODO: fix this complicated logic :)
+        def valid_namespace?(ns)
+          return true if [String, Symbol, NilClass].include?(ns.class)
+          return false unless ns.is_a?(Array)
+
+          # check array for invalid objects
+          return false if ns.select(&:blank?).present?
+          return false if ns.select{|o| ![String, Symbol].include?(o.class)}.present?
+
+          return true
+        end
+    end
+  end
+
+  module Config
+    attr_accessor :namespace
+  end
+end

data/lib/i18n_namespace/fallbacks.rb

@@ -0,0 +1,31 @@
+module I18nNamespace
+
+  module Fallbacks
+    include I18nNamespace::Helper
+
+    def translate(locale, key, options = {})
+      namespaced = options.fetch(:namespaced, false)
+
+      return super if !namespaced || ::I18n.namespace.blank?
+      # TODO: accept default, look for i18n/backend/fallback for a solution
+      # default = extract_string_or_lambda_default!(options) if options[:default]
+      
+      scope     = to_a(options.delete(:scope))
+      namespace = to_a(::I18n.namespace)
+       
+      (namespace.size + 1).times do |part|
+        catch(:exception) do
+          options[:scope] = (namespace | scope).reject(&:nil?)
+
+          result = super(locale, key, options)
+          return result unless result.nil?
+        end
+        namespace.pop
+      end
+
+      # return super(locale, nil, options.merge(:default => default)) if default
+      throw(:exception, ::I18n::MissingTranslation.new(locale, key, options))
+    end
+    
+  end
+end

data/lib/i18n_namespace/helper.rb

@@ -0,0 +1,11 @@
+module I18nNamespace
+  module Helper
+    private
+
+    # save converting to array, :symbol doesn't response to method to_a
+    def to_a(o)
+      return o.dup if o.is_a? Array
+      [o]
+    end
+  end
+end

data/lib/i18n_namespace/key_value.rb

@@ -0,0 +1,18 @@
+module I18nNamespace
+  class KeyValue
+    def self.include(base)
+      raise "You can't include I18n::Backends::Fallbacks in this class." if base == ::I18n::Backend::Fallbacks
+      super
+    end
+
+    def self.extend(base)
+      raise "You can't extend this class with I18n::Backends::Fallbacks." if base == ::I18n::Backend::Fallbacks
+      super
+    end
+
+    include ::I18n::Backend::KeyValue::Implementation
+    include Fallbacks
+    include Storing
+
+  end
+end

data/lib/i18n_namespace/storing.rb

@@ -0,0 +1,16 @@
+module I18nNamespace
+  module Storing
+    include I18nNamespace::Helper
+
+    def store_translations(locale, data, options = {})
+      # TODO: use delete instead of fetch
+      namespaced = options.fetch(:namespaced, false)
+    
+      if namespaced && ::I18n.namespace.present?
+        data = to_a(::I18n.namespace).reverse.inject(data) {|a, n| {n => a}}
+      end
+
+      super locale, data, options
+    end
+  end
+end

data/lib/i18n_namespace.rb

@@ -0,0 +1,11 @@
+require 'i18n'
+require 'i18n_namespace/config'
+require 'i18n_namespace/helper'
+require 'i18n_namespace/storing'
+require 'i18n_namespace/fallbacks'
+require 'i18n_namespace/key_value'
+
+I18n.send         :include, I18nNamespace::I18n
+I18n::Config.send :include, I18nNamespace::Config
+
+raise "Please require 'yajl/json_gem' for proper use. Without causing Json decoding errors when accessing the backend." unless defined?(Yajl) && defined?(JSON)

data/spec/lib/i18n_namespace_spec.rb

@@ -0,0 +1,188 @@
+require 'yajl/json_gem'
+require 'rspec'
+require 'i18n'
+require 'i18n_namespace'
+require 'active_support/core_ext/hash'
+
+describe 'I18n' do
+  before(:all) do
+    @i18n_backend_saved = I18n.backend
+  end
+
+  after(:all) do
+    I18n.backend = @i18n_backend_saved
+  end
+
+  def set_new_backend
+    I18n.backend = I18nNamespace::KeyValue.new({})
+  end
+
+  describe 'with backend chain' do
+    before(:each) do
+      I18n.backend = I18n::Backend::Simple.new
+      I18n.backend.store_translations I18n.locale, {:foo => {:bar => {:title => 'foo bar'}}}, :escape => false
+
+      I18n.backend = I18n::Backend::Chain.new(I18nNamespace::KeyValue.new({}), I18n.backend)
+      I18n.backend.store_translations I18n.locale, {:title => 'Willkommen'}, :escape => false
+    end
+
+    it 'should fallback with the backend chain' do
+      I18n.t('foo.bar.title').should == 'foo bar'
+    end
+  end
+
+  describe 'storing' do
+    before(:each) do
+      set_new_backend
+    end
+
+    def t(key, options = {})
+      options.reverse_merge!(:namespaced => false)
+      I18n.t key, options
+    end
+
+    def s(data, options = {})
+      options.reverse_merge!(:namespaced => true, :escape => false)
+
+      I18n.backend.store_translations I18n.locale, data, options
+    end
+
+    def sr(key, value)
+      I18n.store_resolved_translation I18n.locale, key, value, :escape => false, :namespaced => true
+    end
+
+
+    it 'should resolve dot separated key to hash' do
+      sr('foo.bar.title', 'FooBar')
+      t('foo.bar.title').should == 'FooBar'
+    end
+
+    it 'should save with namespace' do
+      I18n.namespace = :salesman
+
+      s('title' => 'Willkommen')
+      t('salesman.title').should == 'Willkommen'
+
+      I18n.namespace = [ :salesman, :club ]
+
+      s('title' => 'Willkommen')
+      t('salesman.club.title').should == 'Willkommen'
+    end
+
+    it 'should not save with namespace' do
+      options = { :namespaced => false }
+
+      I18n.namespace = :salesman
+
+      s({'title' => 'Willkommen'}, options)
+      t('salesman.title').should include('translation missing')
+
+      I18n.namespace = [:salesman, :club]
+
+      s({'title' => 'Willkommen'}, options)
+      t('salesman.club.title').should include('translation missing')
+    end
+  end
+
+  describe 'validation' do
+    it 'should raise if namespace array includes none supported objects' do
+      lambda { I18n.namespace = [ :salesman, nil ]        }.should raise_error
+      lambda { I18n.namespace = [ :salesman, "" ]         }.should raise_error
+
+      lambda { I18n.namespace = [ :salesman, Proc.new{} ] }.should raise_error
+      lambda { I18n.namespace = [ :salesman, Array.new ]  }.should raise_error
+      lambda { I18n.namespace = [ :salesman, Hash.new ]   }.should raise_error
+    end
+
+    it 'should only accept String, Symbol, Array or NilClass' do
+      I18n.namespace = :symbol
+      I18n.namespace.should == :symbol
+
+      I18n.namespace = "string"
+      I18n.namespace.should == "string"
+
+      I18n.namespace = nil
+      I18n.namespace.should == nil
+
+      I18n.namespace = []
+      I18n.namespace.should == []
+    end
+  end
+
+  describe 'namespace fallbacks' do
+    before(:each) do
+      set_new_backend
+
+      @salesman_title = 'Willkommen Salesman'
+      @club_title     = 'Willkommen im Club'
+      @title          = 'Willkommen'
+
+      store_translations(
+        { :title    => @title,
+          :salesman => { :title => @salesman_title,
+            :club => { :title => @club_title }
+      }
+      })
+    end
+
+    def store_translations(*args)
+      case args.count
+      when 1
+        raise "Your argument isn't a Hash" unless args.first.is_a? Hash
+        data = args.shift
+      when 2
+        data = { args.shift => args.shift }
+      end
+
+      I18n.backend.store_translations I18n.locale, data
+    end
+
+    def t(key, options = {})
+      options.reverse_merge!(:namespaced => true)
+
+      I18n.t key, options
+    end
+
+    describe 'with no namespace' do
+      before(:each) do
+        I18n.namespace = nil
+      end
+
+      it 'should return title' do
+        t('title').should == @title
+      end
+
+      it 'should show translation missing' do
+        t('foobar').should include('translation missing:')
+      end
+    end
+
+    describe 'with namespace' do
+      before(:each) do
+        I18n.namespace = :salesman
+      end
+
+      it 'should not fallback' do
+        I18n.namespace = :salesman
+        t('title').should == @salesman_title
+
+        I18n.namespace = [:salesman, :club]
+        t('title').should == @club_title
+      end
+
+      it 'should fallback' do
+        I18n.namespace = [:salesman, :user]
+        t('title').should == @salesman_title
+
+        I18n.namespace = [:community, :user, '23051949']
+        t('title').should == @title
+      end
+
+      it 'should show translation missing' do
+        t('foobar').should include('translation missing')
+      end
+    end
+
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'i18n_namespace'
+
+class Test::Unit::TestCase
+end

data/test/test_i18n_namespace.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestI18nNamespace < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: i18n_namespace
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Matthias Zirnstein
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-11 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: &70287162048300 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70287162048300
+- !ruby/object:Gem::Dependency
+  name: yajl-ruby
+  requirement: &70287162046920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70287162046920
+- !ruby/object:Gem::Dependency
+  name: active_support
+  requirement: &70287162046200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70287162046200
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: &70287162039100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70287162039100
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70287162036740 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *70287162036740
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &70287162033180 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+  type: :development
+  prerelease: false
+  version_requirements: *70287162033180
+- !ruby/object:Gem::Dependency
+  name: rcov
+  requirement: &70287162024740 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70287162024740
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70287162023100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70287162023100
+description: I18n key injection with fallback functionality
+email: matthias.zirnstein@googlemail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- i18n_namespace.gemspec
+- lib/i18n_namespace.rb
+- lib/i18n_namespace/config.rb
+- lib/i18n_namespace/fallbacks.rb
+- lib/i18n_namespace/helper.rb
+- lib/i18n_namespace/key_value.rb
+- lib/i18n_namespace/storing.rb
+- spec/lib/i18n_namespace_spec.rb
+- test/helper.rb
+- test/test_i18n_namespace.rb
+homepage: http://github.com/avarteqgmbh/i18n_namespace
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2288591149329551058
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: I18n key injection
+test_files: []