is_translatable 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2011 Alex Dixon
+
+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.markdown

@@ -0,0 +1,41 @@
+# is\_translatable
+
+(development in progress)
+
+This is a simple library geared towards translating dynamic text in your database.
+Unlike most similar libaries, is_translatable uses a single table for all translations, so once it's hooked up you won't
+need to do anything fancy in your DB migrations to add support for translations.
+
+## Usage
+
+Add the 'translatable' declaration to your model and specify the columns you want translated:
+
+    class TranslateMe < ActiveRecord::Base
+      translatable :title, :description
+    end
+
+Now you can get/set translations on those columns (defaulting to the current locale):
+
+    I18n.locale = :es
+    t = TranslateMe.new
+    t.set_translation(:title, 'In Spanish')
+    t.get_translation(:title) # 'In Spanish'
+
+Or if you want to override the locale:
+
+    t.set_translation(:title, 'In French', :fr) # specific override
+    t.get_translation(:title, :fr) # 'In French'
+
+TODO: hookup behavior for default locale and fallbacking.
+
+## Installation
+
+TODO: create a migration generator, and make 'gem install is_translatable' work.
+
+## Credits
+
+Inspired by the is\_taggable gem at https://github.com/jamesgolick/is_taggable
+
+## License
+
+is\_translatable is available under the MIT license

data/Rakefile

@@ -0,0 +1,14 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+task :default => :spec

data/lib/is_translatable/version.rb

@@ -0,0 +1,3 @@
+module IsTranslatable
+  VERSION = "0.1.0"
+end

data/lib/is_translatable.rb

@@ -0,0 +1,67 @@
+require 'active_record'
+require 'translation'
+
+module IsTranslatable
+  module ActiveRecordExtension
+    def translatable(*kinds)
+      class_attribute :translatable_kinds
+      self.translatable_kinds ||= {}
+      self.translatable_kinds = kinds.map(&:to_s)
+
+      include IsTranslatable::Methods
+    end
+  end
+
+  module Methods
+    def self.included(klass)
+      klass.class_eval do
+        include IsTranslatable::Methods::InstanceMethods
+
+        has_many :translations, :as => :translatable, :dependent => :destroy, :autosave => true
+        accepts_nested_attributes_for :translations
+      end
+    end
+
+    module InstanceMethods
+      def set_translation(kind, t, locale=nil)
+        validate_kind(kind)
+        locale ||= I18n.locale
+        t_obj = find_translation(kind, locale)
+        if t_obj.nil?
+          translations.build({:kind => kind.to_s, :translation => t, :locale => locale.to_s})
+        else
+          t_obj.translation = t
+        end
+      end
+  
+      def get_translation(kind, locale=nil)
+        validate_kind(kind)
+        locale ||= I18n.locale
+        t = translations.find_by_kind(kind.to_s, :conditions => {:locale => locale.to_s})
+        t ||= find_translation(kind, locale)
+        t.translation unless t.nil?
+      end
+
+      def remove_translation(kind, locale = nil)
+        validate_kind(kind)
+        locale ||= I18n.locale
+        t = find_translation(kind, locale)
+        t.mark_for_destruction unless t.nil?
+      end
+
+    protected
+      def find_translation(kind, locale)
+        translations.each do |t|
+          return t if t.kind == kind.to_s && t.locale == locale.to_s
+        end
+        nil
+      end
+
+      def validate_kind(kind)
+        raise ArgumentError.new("#{kind} is not a translatable field") unless translatable_kinds.include?(kind.to_s)
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send(:extend, IsTranslatable::ActiveRecordExtension)

data/lib/rails/generators/is_translatable_migration/is_translatable_migration_generator.rb

@@ -0,0 +1,24 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+# This article helps figure out what's going on with Rails 3 generators:
+# http://www.themodestrubyist.com/2010/03/16/rails-3-plugins---part-3---rake-tasks-generators-initializers-oh-my/
+class IsTranslatableMigrationGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+  source_root File.expand_path('../templates', __FILE__)
+
+  # Ugh :(
+  # Implement the required interface for Rails::Generators::Migration.
+  # taken from http://github.com/rails/rails/blob/master/activerecord/lib/generators/active_record.rb
+  def self.next_migration_number(dirname)
+    if ActiveRecord::Base.timestamped_migrations
+      Time.now.utc.strftime("%Y%m%d%H%M%S")
+    else
+      "%.3d" % (current_migration_number(dirname) + 1)
+    end
+  end
+
+  def create_translatable_migration
+    migration_template 'migration.rb', 'db/migrate/is_translatable_migration'
+  end
+end

data/lib/rails/generators/is_translatable_migration/templates/migration.rb

@@ -0,0 +1,17 @@
+class IsTranslatableMigration < ActiveRecord::Migration
+  def self.up
+    create_table :translations do |t|
+      t.string    :translatable_type , :default => ''
+      t.integer   :translatable_id
+      t.string    :kind
+      t.string    :locale, :limit => 5
+      t.text      :translation
+    end
+
+    add_index :translations, [:translatable_id, :translatable_type, :kind, :locale], :name => 'index_translations'
+  end
+
+  def self.down
+    drop_table :translations
+  end
+end

data/lib/tasks/is_translatable_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :is_translatable do
+#   # Task goes here
+# end

data/lib/translation.rb

@@ -0,0 +1,3 @@
+class Translation < ActiveRecord::Base
+  belongs_to :translatable, :polymorphic => true
+end

data/spec/lib/is_translatable_spec.rb

@@ -0,0 +1,180 @@
+require 'spec_helper'
+
+# NOTE: trying to switch closer to this style (mostly for the nicer errors)
+# http://eggsonbread.com/2010/03/28/my-rspec-best-practices-and-tips/
+describe IsTranslatable do
+  before :each do
+    @titles = {
+      :en => 'Translations now easier',
+      :es => 'Traducciones ahora facil',
+      :fr => 'Traductions maintenant plus facile'
+    }
+  end
+
+  it 'should test default locale (just using the actual field)'
+  it 'should be even more awesome'
+
+  context 'article translations' do
+    before {@article = Article.new(:title => 'Translations now easier', :body => 'is_translatable plugin makes translating easier...')}
+    subject {@article}
+
+    specify {subject.save.should be_true}
+    it {should be_valid}
+
+    context 'with spanish locale' do
+      before {I18n.locale = :es}
+
+      context 'with translated title' do
+        before {@article.set_translation(:title, @titles[:es])}
+        it {should be_valid}
+
+        it {subject.get_translation(:title).should == @titles[:es]}
+
+        context 'set twice' do
+          before {@article.set_translation(:title, 'spanish override')}
+
+          it {subject.translations.length.should == 1}
+          it {subject.get_translation(:title).should == 'spanish override'}
+        end
+
+        context 'loaded from db' do
+          before :each do
+            @article.save!
+            @loaded_article = Article.find(@article.id)
+          end
+          subject{@loaded_article}
+
+          it {should be_valid}
+
+          it {subject.get_translation(:title).should == @titles[:es]}
+
+          context 'and removed' do
+            before :each do
+              @loaded_article.remove_translation(:title)
+              @loaded_article.save!
+            end
+
+            it {subject.get_translation(:title).should be_nil}
+          end
+        end
+      end
+
+      it 'should not translate if not translatable' do
+        lambda {@article.set_translation(:non_translatable, 'foo')}.should raise_error(ArgumentError)
+      end
+
+      context 'with translated title and locale override' do
+        before {@article.set_translation(:title, @titles[:fr], :fr)}
+        it {should be_valid}
+
+        it 'should allow specifying fallback behavior?'
+        it {subject.get_translation(:title).should == nil}
+        it {subject.get_translation(:title, :fr).should == @titles[:fr]}
+      end
+
+    end
+  end
+
+  context 'multiple translations' do
+    before :each do
+      # Creating these in a couple of different ways to excersize the code a little better.
+      # Also putting in overlapping ids to make sure we're loading for the right table.
+      @article1 = Article.new(:title => 'Article Title', :body => 'Article Body')
+      @article1.id = 1
+      @article1.set_translation(:title, 'es A1T', :es)
+      @article1.set_translation(:title, 'pt-BR A1T', :'pt-BR')
+      @article1.set_translation(:body, 'pt-BR A1B', :'pt-BR')
+      @article1.save!
+
+      article2 = Article.new(:title => 'Article2 Title', :body => 'Article2 Body')
+      article2.id = 2
+      article2.set_translation(:title, 'es A2T', :es)
+      article2.set_translation(:title, 'pt-BR A2T', :'pt-BR')
+      article2.set_translation(:body, 'pt-BR A2B', :'pt-BR')
+      article2.save!
+      @article2 = Article.find(article2.id)
+
+      @note1 = Note.create!(:body => 'Note Body')
+      @note1.set_translation(:body, 'pt-BR N1B', :'pt-BR')
+      @note1.set_translation(:body, 'es N1B', :'es')
+      @note1.save!
+
+      @note2 = Note.new(:body => 'Note2 Body')
+      @note2.set_translation(:body, 'pt-BR N2B', :'pt-BR')
+      @note2.set_translation(:body, 'es N2B', :'es')
+      @note2.save!
+    end
+
+    context 'article1' do
+      subject {@article1}
+      
+      it {should be_valid}
+      it {subject.get_translation(:title, :es).should == 'es A1T'}
+      it {subject.get_translation(:title, :'pt-BR').should == 'pt-BR A1T'}
+      it {subject.get_translation(:body, :'pt-BR').should == 'pt-BR A1B'}
+      it {subject.get_translation(:body, :es).should be_nil}
+    end
+
+    context 'article2' do
+      subject {@article2}
+      
+      it {should be_valid}
+      it {subject.get_translation(:title, :es).should == 'es A2T'}
+      it {subject.get_translation(:title, :'pt-BR').should == 'pt-BR A2T'}
+      it {subject.get_translation(:body, :'pt-BR').should == 'pt-BR A2B'}
+      it {subject.get_translation(:body, :es).should be_nil}
+    end
+
+    context 'note1' do
+      subject {@note1}
+      
+      it {should be_valid}
+      it {subject.get_translation(:body, :'pt-BR').should == 'pt-BR N1B'}
+      it {subject.get_translation(:body, :es).should == 'es N1B'}
+    end
+
+    context 'note2' do
+      subject {@note2}
+      
+      it {should be_valid}
+      it {subject.get_translation(:body, :'pt-BR').should == 'pt-BR N2B'}
+      it {subject.get_translation(:body, :es).should == 'es N2B'}
+    end
+
+    context 'article1 body translations deleted' do
+      before :each do
+        @article1.remove_translation(:body, :es)
+        @article1.remove_translation(:body, :'pt-BR')
+        @article1.save!
+      end
+
+      context 'article1 reloaded' do
+        before { @article1_loaded = Article.find(@article1.id) }
+        subject { @article1_loaded }
+
+        it {subject.get_translation(:title, :es).should == 'es A1T'}
+        it {subject.get_translation(:title, :'pt-BR').should == 'pt-BR A1T'}
+        it {subject.get_translation(:body, :es).should be_nil}
+        it {subject.get_translation(:body, :'pt-BR').should be_nil}
+      end
+
+      context 'article2' do
+        subject {@article2}
+        it {subject.get_translation(:body, :'pt-BR').should == 'pt-BR A2B'}
+        it {subject.get_translation(:body, :es).should be_nil}
+      end
+
+      context 'note1' do
+        subject {@note1}
+        it {subject.get_translation(:body, :'pt-BR').should == 'pt-BR N1B'}
+        it {subject.get_translation(:body, :es).should == 'es N1B'}
+      end
+
+      context 'note2' do
+        subject {@note2}
+        it {subject.get_translation(:body, :'pt-BR').should == 'pt-BR N2B'}
+        it {subject.get_translation(:body, :es).should == 'es N2B'}
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,49 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'is_translatable'
+require 'sqlite3'
+require 'active_record'
+
+# Create test schema and models
+
+ActiveRecord::Base.configurations = {'sqlite3' => {:adapter => 'sqlite3', :database => ':memory:'}}
+ActiveRecord::Base.establish_connection('sqlite3')
+
+ActiveRecord::Schema.define(:version => 0) do
+  create_table :articles do |t|
+    t.string :title
+    t.string :body
+    t.string :non_translatable
+  end
+
+  create_table :notes do |t|
+    t.string :body # for dupe tests with articles
+  end
+
+  create_table :translations do |t|
+    t.string    :translatable_type , :default => ''
+    t.integer   :translatable_id
+    t.string    :kind
+    t.string    :locale, :limit => 5
+    t.text      :translation
+  end
+
+  class Article < ActiveRecord::Base
+    translatable :title, :body
+  end
+
+  class Note < ActiveRecord::Base
+    translatable :body
+  end
+end
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+  config.before :each do
+    Article.destroy_all
+    Note.destroy_all
+    Translation.destroy_all
+  end
+end
+

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: is_translatable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Alex Dixon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-12-15 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &70343138412680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: *70343138412680
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &70343138409820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70343138409820
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70343138394480 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70343138394480
+description: 
+email:
+- dixo0015+is_translatable@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/is_translatable/version.rb
+- lib/is_translatable.rb
+- lib/rails/generators/is_translatable_migration/is_translatable_migration_generator.rb
+- lib/rails/generators/is_translatable_migration/templates/migration.rb
+- lib/tasks/is_translatable_tasks.rake
+- lib/translation.rb
+- MIT-LICENSE
+- Rakefile
+- README.markdown
+- spec/lib/is_translatable_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/alexdixon/is_translatable
+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.12
+signing_key: 
+specification_version: 3
+summary: Simple translation of dynamic db fields.
+test_files:
+- spec/lib/is_translatable_spec.rb
+- spec/spec_helper.rb