i18n_column 0.0.1

data/.document

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

data/.gitignore

@@ -0,0 +1,22 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+.rvmrc

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Philipp Ullmann
+
+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,60 @@
+= i18n_column
+
+== Introduction
+
+This extension provides the capabilities of storing and retrieving translations from a single database column. The translations are stored as a JSON object i.e. {"en":"Home","de":"Zuhause"}.
+
+The current and default language are stored within the class <tt>I18nColumn::Language</tt>. On each request the current language must be set via <tt>I18nColumn::Language.current_lang = 'en'</tt>. If not set the default language is taken. <tt>I18nColumn::Language.current_lang</tt> is used as the JSON key to store a translation i.e. "en":"Home".
+
+== Installation
+
+* Recently a gem version will be provided on gemcutter.
+* Run <tt>rails generate i18n_column:install</tt>. It will generate a i18n_column initializer file in order to set the default language.
+
+== Example
+
+<b>Migration</b>
+
+ class CreateNodes < ActiveRecord::Migration
+   def self.up
+     create_table(:nodes) do |t|
+       t.text(:name)
+     end
+   end
+
+   def self.down
+     drop_table :nodes
+   end
+ end
+
+<b>Model</b>
+
+ class Node < ActiveRecord::Base
+   i18n_column(:name)
+ end
+
+<b>Controller</b>
+
+ class ApplicationController < ActionController::Base
+   before_filter(:set_i18n_column_lang)
+
+   private
+
+   def set_i18n_column_lang
+     I18nColumn::Language.current_lang = params[:lang]
+   end
+ end
+
+<b>Console</b>
+
+ I18nColumn::Language.current_lang = 'en'
+ node = Node.create!(:name => 'Home') => {"en":"Home"}
+ node.name => 'Home'
+ I18nColumn::Language.current_lang = 'de'
+ node.name = 'Zuhause'
+ node.save! => {"en":"Home","de":"Zuhause"}
+ node.name => 'Zuhause'
+
+== Copyright
+
+Copyright (c) 2010 Philipp Ullmann. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,28 @@
+require('rubygems')
+require('rake')
+require 'rspec/core/rake_task'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "i18n_column"
+    gem.summary = %Q{Storing and retrieving translations from a single database column}
+    gem.description = %Q{This extension provides the capabilities of storing and retrieving translations from a single database column. The translations are serialized using JSON.}
+    gem.email = "philipp.ullmann@create.at"
+    gem.homepage = "http://github.com/create-philipp-ullmann/i18n_column"
+    gem.authors = ["Philipp Ullmann"]
+    gem.add_development_dependency('rspec', '>= 2.0.0')
+    gem.add_development_dependency('sqlite3-ruby', '>= 1.3.1')
+    gem.add_development_dependency('activerecord', '>= 3.0.0')
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts('Jeweler (or a dependency) not available. Install it with: gem install jeweler')
+end
+
+desc('Run RSpec')
+RSpec::Core::RakeTask.new do |t|
+  t.verbose = false
+end
+
+task(:default => :spec)

data/VERSION

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

data/i18n_column.gemspec

@@ -0,0 +1,65 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{i18n_column}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Philipp Ullmann"]
+  s.date = %q{2010-10-13}
+  s.description = %q{This extension provides the capabilities of storing and retrieving translations from a single database column. The translations are serialized using JSON.}
+  s.email = %q{philipp.ullmann@create.at}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "i18n_column.gemspec",
+     "lib/generators/i18n_column/install/install_generator.rb",
+     "lib/generators/i18n_column/install/templates/config/initializers/i18n_column.rb",
+     "lib/i18n_column.rb",
+     "lib/i18n_column/base.rb",
+     "lib/i18n_column/language.rb",
+     "spec/.rspec",
+     "spec/i18n_column_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/create-philipp-ullmann/i18n_column}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Storing and retrieving translations from a single database column}
+  s.test_files = [
+    "spec/i18n_column_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 2.0.0"])
+      s.add_development_dependency(%q<sqlite3-ruby>, [">= 1.3.1"])
+      s.add_development_dependency(%q<activerecord>, [">= 3.0.0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 2.0.0"])
+      s.add_dependency(%q<sqlite3-ruby>, [">= 1.3.1"])
+      s.add_dependency(%q<activerecord>, [">= 3.0.0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 2.0.0"])
+    s.add_dependency(%q<sqlite3-ruby>, [">= 1.3.1"])
+    s.add_dependency(%q<activerecord>, [">= 3.0.0"])
+  end
+end
+

data/lib/generators/i18n_column/install/install_generator.rb

@@ -0,0 +1,19 @@
+module I18nColumn
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+
+      desc <<DESC
+Description:
+    Copy initialize file to your application.
+DESC
+
+      def self.source_root
+        @source_root ||= File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
+      end
+      
+      def copy_initializer_file
+        template('config/initializers/i18n_column.rb')
+      end
+    end
+  end
+end

data/lib/generators/i18n_column/install/templates/config/initializers/i18n_column.rb

@@ -0,0 +1,2 @@
+# On each request the current language must be set via I18nColumn::Language.current_lang = 'de'. If not set the default language ('en') is returned by I18nColumn::Language.current_lang.
+I18nColumn::Language.default_lang = 'en'

data/lib/i18n_column/base.rb

@@ -0,0 +1,44 @@
+# This extension provides the capabilities of storing and retrieving translations from a single database column.
+# The translations are serialized using JSON i.e. {"en":"Spindle axes","de":"Spindelachsen"}.
+# 
+# Example
+# 
+# class Node < ActiveRecord::Base
+#   i18n_column(:name)
+# end
+module I18nColumn
+  module Base
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+  
+    module ClassMethods
+      # Creates i18n getter and setter methods for the given column names.
+      def i18n_column(*col_names)
+        for col_name in col_names
+          class_eval <<-EOV
+            def #{col_name}
+              json = #{col_name}_to_json
+              json.nil? ? nil : json[::I18nColumn::Language.current_lang]
+            end
+          
+            def #{col_name}=(value)
+              json = #{col_name}_to_json || {}
+              json[::I18nColumn::Language.current_lang] = value
+              self[:#{col_name}] = json.to_json
+              value
+            end
+          
+            private
+          
+            def #{col_name}_to_json
+              ::ActiveSupport::JSON::decode(self[:#{col_name}].to_s) || nil
+            end
+          EOV
+        end
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.class_eval { include I18nColumn::Base }

data/lib/i18n_column/language.rb

@@ -0,0 +1,21 @@
+# Saves the current and default language.
+module I18nColumn
+  class Language
+    @@default_lang = 'en'
+    
+    # Sets the default language.
+    def self.default_lang=(lang)
+      @@default_lang = lang
+    end
+    
+    # Returns the current language.
+    def self.current_lang
+      ::Thread.current[:i18n_column_current_lang] || @@default_lang
+    end
+  
+    # Sets the current language. Must be set by each request.
+    def self.current_lang=(lang)
+      ::Thread.current[:i18n_column_current_lang] = lang
+    end
+  end
+end

data/lib/i18n_column.rb

@@ -0,0 +1,3 @@
+require('active_record')
+require('i18n_column/base')
+require('i18n_column/language')

data/spec/.rspec

@@ -0,0 +1 @@
+--color

data/spec/i18n_column_spec.rb

@@ -0,0 +1,96 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe(I18nColumn::Base) do
+  before(:each) do
+    setup_db
+  end
+  
+  after(:each) do
+    teardown_db
+  end
+  
+  context('with no translation') do
+    before(:each) do
+      I18nColumn::Language.current_lang = 'en'
+      @node = Node.new
+    end
+    
+    describe('#name') do
+      it('returns nil') do
+        @node.name.should(be_nil)
+      end
+    end
+    
+    describe('#name=') do
+      it('sets the english name') do
+        @node.name = 'Home'
+        @node.name.should == 'Home'
+      end
+    end
+  end
+  
+  context('with an english name only') do
+    before(:each) do
+      I18nColumn::Language.current_lang = 'en'
+      @node = Node.create!(:name => 'Home')
+    end
+    
+    describe('#name') do
+      it('returns the english name') do
+        @node.name.should == 'Home'
+      end
+    end
+    
+    describe('#name=') do
+      it('overrides the english name') do
+        @node.name = 'Home overridden'
+        @node.name.should == 'Home overridden'
+      end
+      
+      it('translates the name into german') do
+        I18nColumn::Language.current_lang = 'de'
+        @node.name = 'Zuhause'
+        @node.name.should == 'Zuhause'
+      end
+    end
+  end
+  
+  context('with an english and german name') do
+    before(:each) do
+      I18nColumn::Language.current_lang = 'en'
+      @node = Node.create!(:name => 'Home')
+      I18nColumn::Language.current_lang = 'de'
+      @node.update_attribute(:name, 'Zuhause')
+    end
+    
+    describe('#name') do
+      it('returns the english name') do
+        I18nColumn::Language.current_lang = 'en'
+        @node.name.should == 'Home'
+      end
+      
+      it('returns the german name') do
+        I18nColumn::Language.current_lang = 'de'
+        @node.name.should == 'Zuhause'
+      end
+    end
+    
+    describe('#name=') do
+      it('overrides the english name only') do
+        I18nColumn::Language.current_lang = 'en'
+        @node.name = 'Home overridden'
+        @node.name.should == 'Home overridden'
+        I18nColumn::Language.current_lang = 'de'
+        @node.name.should == 'Zuhause'
+      end
+      
+      it('overrides the german name only') do
+        I18nColumn::Language.current_lang = 'de'
+        @node.name = 'Zuhause ueberschrieben'
+        @node.name.should == 'Zuhause ueberschrieben'
+        I18nColumn::Language.current_lang = 'en'
+        @node.name.should == 'Home'
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rubygems'
+require 'active_record'
+require 'i18n_column'
+
+ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :database => ':memory:')
+
+def setup_db
+  ActiveRecord::Schema.define(:version => 1) do
+    create_table(:nodes) do |t|
+      t.text(:name)
+    end
+  end
+end
+
+def teardown_db
+  ActiveRecord::Base.connection.tables.each do |table|
+    ActiveRecord::Base.connection.drop_table(table)
+  end
+end
+
+class Node < ActiveRecord::Base
+  i18n_column(:name)
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification 
+name: i18n_column
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Philipp Ullmann
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-13 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 2
+        - 0
+        - 0
+        version: 2.0.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: sqlite3-ruby
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 1
+        - 3
+        - 1
+        version: 1.3.1
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :development
+  version_requirements: *id003
+description: This extension provides the capabilities of storing and retrieving translations from a single database column. The translations are serialized using JSON.
+email: philipp.ullmann@create.at
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- i18n_column.gemspec
+- lib/generators/i18n_column/install/install_generator.rb
+- lib/generators/i18n_column/install/templates/config/initializers/i18n_column.rb
+- lib/i18n_column.rb
+- lib/i18n_column/base.rb
+- lib/i18n_column/language.rb
+- spec/.rspec
+- spec/i18n_column_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/create-philipp-ullmann/i18n_column
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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.3.7
+signing_key: 
+specification_version: 3
+summary: Storing and retrieving translations from a single database column
+test_files: 
+- spec/i18n_column_spec.rb
+- spec/spec_helper.rb