multilang 0.0.1

data/lib/multilang/slot.rb

@@ -0,0 +1,71 @@
+require 'multilang/language_names'
+
+module Multilang
+  class Slot
+    def initialize
+      @items = {}
+    end
+
+    # Register the object to the slot.
+    #
+    # @param [String, Symbol] language_spec the language specifier
+    # @param [Object] object object to register
+    # @yield called once at getting the object first
+    #
+    # @see Multilang::Slot#[]
+    def register(language_spec, object, &first)
+      item = {:object => object}
+      item[:first] = first if first
+      @items[LanguageNames[language_spec]] = item
+    end
+
+    # Determine if registered with the language specifier in the slot.
+    #
+    # @param [String, Symbol] language_spec the language specifier
+    # @return whether registered with the language specifier in the slot
+    def exists?(language_spec)
+      !!@items[LanguageNames[language_spec]]
+    end
+
+    # Get the object by the language specifier. And call once the block that was
+    # given at registration the object.
+    #
+    # @param [String, Symbol] language_spec the language specifier
+    # @return [Object] registered object in the slot
+    #
+    # @see Multilang::Slot#register
+    def [](language_spec)
+      language_name = LanguageNames[language_spec]
+      raise ArgumentError, "#{language_spec.inspect} does not register" unless @items.key?(language_name)
+      item = @items[language_name]
+
+      if item[:first]
+        item[:first].call
+        item.delete(:first)
+      end
+
+      item[:object]
+    end
+
+    module Access
+
+      # @attribute [r] slot
+      # @return [Multilang::Slot] slot that is bound to class or module
+      def slot
+        instance_variable_get(Multilang::SLOT_KEY)
+      end
+
+      # Get registered object in the slot.
+      #
+      # @param [String, Symbol] language_spec
+      # @return [Object] registered object to the slot
+      #
+      # @see Multilang::Slot::Access#slot
+      # @see Multilang::Slot#[]
+      def [](language_spec)
+        slot[language_spec]
+      end
+
+    end
+  end
+end

data/lib/multilang/version.rb

@@ -0,0 +1,3 @@
+module Multilang
+  VERSION = '0.0.1'
+end

data/multilang.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'multilang/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'multilang'
+  gem.version       = Multilang::VERSION
+  gem.authors       = ['Takahiro Kondo']
+  gem.email         = ['heartery@gmail.com']
+  gem.description   = %q{Support multilingualization}
+  gem.summary       = %q{Foundation for multilingualization}
+  gem.homepage      = ''
+
+  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.require_paths = ['lib']
+
+  gem.add_development_dependency('rspec')
+  gem.add_development_dependency('nokogiri')
+end

data/spec/for_test.rb

@@ -0,0 +1 @@
+module ForTest end

data/spec/for_test2.rb

@@ -0,0 +1 @@
+module ForTest2 end

data/spec/multilang/language_names_spec.rb

@@ -0,0 +1,20 @@
+require 'multilang/language_names'
+
+describe Multilang::LanguageNames, '.#[]' do
+  it 'returns normalized language name if the language specifier is string' do
+    described_class['english'].should == 'English'
+  end
+
+  it 'returns language name if the language specifier is symbol' do
+    described_class[:en ].should == 'English'
+    described_class[:eng].should == 'English'
+  end
+
+  it 'raises TypeError if the language specifier is not string and symbol' do
+    lambda { described_class[1] }.should raise_error(TypeError, "can't convert Fixnum into String or Symbol")
+  end
+
+  it 'raises ArgumentError if the language specifier does not exist' do
+    lambda { described_class['unknown'] }.should raise_error(ArgumentError, '"unknown" language specifier does not defined')
+  end
+end

data/spec/multilang/slot_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+require 'multilang/slot'
+
+describe Multilang::Slot, '#register' do
+  before do
+    @slot = described_class.new
+  end
+
+  it 'registers the object to the slot' do
+    object = Object.new
+    @slot.register(:en, object)
+    @slot.should be_exists('English')
+    @slot['English'].should == object
+  end
+end
+
+describe Multilang::Slot, '#[]' do
+  before do
+    @slot = described_class.new
+  end
+
+  it 'returns registered object' do
+    object = Object.new
+    @slot.register(:en, object)
+    @slot['English'].should == object
+  end
+
+  it 'calls the block once if gives a block at construction' do
+    count = 0
+    @slot.register(:en, Object.new) { count += 1 }
+    @slot['English']
+    count.should == 1
+    @slot['English']
+    count.should == 1
+  end
+
+  it 'raises ArgumentError if the language specifier does not register to the slot' do
+    lambda { @slot[:en] }.should raise_error(ArgumentError, ':en does not register')
+  end
+end
+
+describe Multilang::Slot::Access, '#slot' do
+  before do
+    @slot = slot_stub
+    @class = Class.new
+    @class.extend(described_class)
+    @class.instance_variable_set(Multilang::SLOT_KEY, @slot)
+  end
+
+  it 'returns the value of instance variable named with Multilang::SLOT_KEY' do
+    @class.slot.should == @slot
+  end
+end
+
+describe Multilang::Slot::Access, '#[]' do
+  before do
+    @slot = slot_stub
+    @class = Class.new
+    @class.extend(described_class)
+    @class.instance_variable_set(Multilang::SLOT_KEY, @slot)
+  end
+
+  it 'calls #[] of the slot with the language specifier' do
+    @class.slot.should_receive(:[]).with('English')
+    @class['English']
+  end
+
+  it 'returns the return value from #[] of the slot' do
+    @class['English'].should == 'item for English'
+  end
+end

data/spec/multilang_spec.rb

@@ -0,0 +1,106 @@
+require 'spec_helper'
+require 'multilang'
+
+describe Multilang, '.#register' do
+  before do
+    define_const Class,  'SampleClass::English'
+    define_const Module, 'SampleModule::English'
+  end
+
+  after do
+    remove_const 'SampleClass::English'
+    remove_const 'SampleModule::English'
+  end
+
+  it 'extends parent class (parent class of Foo::Bar::Baz is Foo::Bar)' do
+    described_class.register SampleClass::English
+    SampleClass.should be_respond_to(:slot)
+    SampleClass.should be_respond_to(:[])
+  end
+
+  it 'extends parent module' do
+    described_class.register SampleModule::English
+    SampleModule.should be_respond_to(:slot)
+    SampleModule.should be_respond_to(:[])
+  end
+
+  it 'registers to the slot' do
+    described_class.register SampleClass::English
+    SampleClass.slot.should be_exists('English')
+  end
+
+  it 'raises TypeError if gives non-module' do
+    lambda { described_class.register 1 }.should raise_error(TypeError, "can't convert Fixnum into Module")
+    lambda { described_class.register 'English' }.should raise_error(TypeError, "can't convert String into Module")
+    lambda { described_class.register SampleClass::English }.should_not raise_error(TypeError)
+    lambda { described_class.register SampleModule::English }.should_not raise_error(TypeError)
+  end
+
+  it 'raises ArgumentError if gives anonymous class' do
+    lambda { described_class.register Class.new }.should raise_error(ArgumentError, "anonymous class can't register")
+    lambda { described_class.register SampleClass::English }.should_not raise_error(ArgumentError)
+  end
+
+  it 'raises ArgumentError if gives anonymous module' do
+    lambda { described_class.register Module.new }.should raise_error(ArgumentError, "anonymous module can't register")
+    lambda { described_class.register SampleModule::English }.should_not raise_error(ArgumentError)
+  end
+
+  it 'raises ArgumentError if gives top-level class' do
+    lambda { described_class.register SampleClass }.should raise_error(ArgumentError, "can't permit top-level class")
+  end
+
+  it 'raises ArgumentError if gives top-level module' do
+    lambda { described_class.register SampleModule }.should raise_error(ArgumentError, "can't permit top-level module")
+  end
+
+  context 'with :as option' do
+    before { define_const Class, 'SampleClass::E' }
+    after  { remove_const        'SampleClass::E' }
+
+    it 'registers to the slot with the value of :as option' do
+      described_class.register SampleClass::E, :as => 'English'
+      SampleClass.slot.should be_exists('English')
+    end
+  end
+
+  context 'with :with option' do
+    it 'calls Kernel#.require with the value of :with option at initialization' do
+      Object.should_not be_const_defined(:ForTest)
+      described_class.register SampleClass::English, :with => 'for_test'
+      SampleClass['English']
+      Object.should be_const_defined(:ForTest)
+    end
+
+    context 'with a block' do
+      it 'considers both the value of :with option and the block' do
+        Object.should_not be_const_defined(:ForTest2)
+        passed = false
+
+        described_class.register SampleClass::English, :with => 'for_test2' do
+          passed = true
+        end
+
+        SampleClass['English']
+        Object.should be_const_defined(:ForTest2)
+        passed.should be_true
+      end
+    end
+  end
+end
+
+describe Multilang, ' including' do
+  before do
+    define_const Class, 'SampleClass::English'
+  end
+
+  after do
+    remove_const 'SampleClass::English'
+  end
+
+  it "calls #{described_class}.#register" do
+    described_class.should_receive(:register).with(SampleClass::English)
+    mod = described_class
+    SampleClass::English.class_eval { include mod }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,29 @@
+def define_const(type, name)
+  klass = name.split('::').inject(Object) do |parent, name|
+    if parent.const_defined?(name)
+      parent.const_get(name)
+    else
+      parent.const_set(name, type.new)
+    end
+  end
+end
+
+def remove_const(name)
+  names = name.split('::')
+
+  parents = names[0..-2].inject([Object]) do |parents, name|
+    parents << parents.last.const_get(name)
+  end
+
+  names.reverse.each do |name|
+    parent = parents.pop
+    parent.class_eval { remove_const name }
+    break unless parent.constants.empty?
+  end
+end
+
+def slot_stub
+  stub.tap do |s|
+    s.stub!(:[]).and_return { |language_spec| "item for #{language_spec}" }
+  end
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: multilang
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Takahiro Kondo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Support multilingualization
+email:
+- heartery@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/multilang.rb
+- lib/multilang/language_names.rb
+- lib/multilang/language_names.yaml
+- lib/multilang/slot.rb
+- lib/multilang/version.rb
+- multilang.gemspec
+- spec/for_test.rb
+- spec/for_test2.rb
+- spec/multilang/language_names_spec.rb
+- spec/multilang/slot_spec.rb
+- spec/multilang_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Foundation for multilingualization
+test_files:
+- spec/for_test.rb
+- spec/for_test2.rb
+- spec/multilang/language_names_spec.rb
+- spec/multilang/slot_spec.rb
+- spec/multilang_spec.rb
+- spec/spec_helper.rb
+has_rdoc: