armot 0.1.0

data/.gitignore

@@ -0,0 +1,11 @@
+pkg/*
+*.gem
+.bundle
+
+Gemfile.lock
+.DS_Store
+test_app/.bundle
+test_app/db/*.sqlite3
+test_app/log/*.log
+test_app/tmp/**/*
+

data/Gemfile

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

data/README.md

@@ -0,0 +1,87 @@
+Armot
+=====
+
+Armot is a minimal rails 3 library for handle your model translations. It's
+heavily based on [puret](https://github.com/jo/puret), by Johannes Jörg
+Schmidt, since it does basically the same but relying on i18n ActiveRecord
+backend to store and fetch translations instead of custom tables.
+
+Choosing between puret or armot is as always a decision based on your custom
+requirements:
+
+1. If your application is multilingual, and it's translated with default yaml
+   files with i18n Simple backend, you should definitely go with Puret. In this
+   scenario your application contents are multilingual but doesn't dynamically
+   change, they're always the same.
+
+2. If your application is multilingual, and also you want to give access to
+   change it's contents, you might have chose to use another i18n backend like
+   activerecord to be able to edit the translations in live. If this is your
+   scenario, armot may give you a few advantages:
+
+   - Your translations are centralized. If you're giving your users (maybe the
+     admins of the site) the ability to change it's multilingual contents, it
+     means that you already have an interface to edit I18n translations. Use it
+     to edit your model translations too.
+   - Use of all i18n benefits for free, like fallbacks or speed up model
+     translations with Flatten and Memoize.
+   - No worry for eager loading translations every time you load translated
+     models.
+   - Easy setup, no external tables.
+
+
+Installing armot
+----------------
+
+First add the following line to your Gemfile:
+
+    gem 'armot'
+
+Using armot is pretty straightforward. Just add the following line to any
+model with attributes you want to translate:
+
+    class Product < ActiveRecord::Base
+      armotize :name, :description
+    end
+
+This will make attributes 'name' and 'description' multilingual for the
+product model.
+
+If your application is already in production and with real contents, making an
+attribute armotized won't do any difference. You can expect your models to
+return their old values until you make some translations.
+
+
+Usage
+-----
+
+Your translated model will have different contents for each locale transparently.
+
+    I18n.locale = :en
+
+    car = Product.create :name => "A car"
+    car.name #=> A car
+
+    I18n.locale = :es
+    car.name = "Un coche"
+    car.name #=> Un coche
+
+    I18n.locale = :en
+    car.name #=> A car
+
+
+Be aware that armot doesn't take care of any cache expiration. If you're using
+Memoize with I18n ActiveRecord backend you must take care yourself to reload
+the backend with an observer, for example.
+
+
+
+Migrating from puret
+--------------------
+
+If you want to migrate your current model translations from puret to armot,
+simply run this rake task:
+
+    rake armot:migrate_puret
+
+

data/Rakefile

@@ -0,0 +1,17 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake'
+require 'rake/testtask'
+
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the puret plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end

data/armot.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "armot/version"
+
+Gem::Specification.new do |s|
+  s.name        = "armot"
+  s.version     = Armot::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Roger Campos"]
+  s.email       = ["roger@itnig.net"]
+  s.homepage    = "https://github.com/rogercampos/armot"
+  s.summary     = %q{translation support for your models with an I18n active-record backend}
+  s.description = %q{translation support for your models with an I18n active-record backend}
+
+  s.rubyforge_project = "armot"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency "i18n-active_record", ">= 0.0.2"
+  s.add_development_dependency "activerecord", ">= 3.0.0"
+  s.add_development_dependency "activesupport", ">= 3.0.0"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "sqlite3"
+
+end

data/lib/armot.rb

@@ -0,0 +1,9 @@
+if defined?(I18n::Backend::ActiveRecord)
+  require 'armot/active_record_extensions'
+end
+
+require 'armot/railtie' if defined?(Rails)
+
+module Armot
+end
+

data/lib/armot/active_record_extensions.rb

@@ -0,0 +1,64 @@
+module Armot
+  module ActiveRecordExtensions
+    module ClassMethods
+      def armotize(*attributes)
+        make_it_armot! unless included_modules.include?(InstanceMethods)
+
+        attributes.each do |attribute|
+          # attribute setter
+          define_method "#{attribute}=" do |value|
+            armot_attributes[I18n.locale][attribute] = value
+          end
+
+          # attribute getter
+          define_method attribute do
+            return armot_attributes[I18n.locale][attribute] if armot_attributes[I18n.locale][attribute]
+            return if new_record?
+
+            begin
+              I18n.t "#{attribute}_#{id}", :scope => "armot.#{self.class.to_s.underscore.pluralize}.#{attribute}", :raise => true
+            rescue I18n::MissingTranslationData
+              self[attribute] || "translation missing: #{I18n.locale}.armot.#{self.class.to_s.underscore.pluralize}.#{attribute}.#{attribute}_#{id}"
+            end
+          end
+        end
+      end
+
+    private
+
+      # configure model
+      def make_it_armot!
+        include InstanceMethods
+
+        after_save :update_translations!
+        after_destroy :remove_i18n_entries
+      end
+    end
+
+    module InstanceMethods
+
+    private
+      def armot_attributes
+        @armot_attributes ||= Hash.new { |hash, key| hash[key] = {} }
+      end
+
+      # called after save
+      def update_translations!
+        return if armot_attributes.blank?
+        armot_attributes.each do |locale, attributes|
+          attributes.each do |k, v|
+            translation = I18n::Backend::ActiveRecord::Translation.find_or_initialize_by_locale_and_key(locale.to_s, "armot.#{self.class.to_s.underscore.pluralize}.#{k}.#{k}_#{id}")
+            translation.update_attribute(:value, v)
+          end
+        end
+      end
+
+      def remove_i18n_entries
+        t = I18n::Backend::ActiveRecord::Translation.arel_table
+        I18n::Backend::ActiveRecord::Translation.delete_all(t[:key].matches("armot.#{self.class.to_s.underscore.pluralize}%_#{id}"))
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.extend Armot::ActiveRecordExtensions::ClassMethods

data/lib/armot/puret_integration.rb

@@ -0,0 +1,35 @@
+module Armot
+  module PuretIntegration
+
+    # It assumes all of your tables ending with _translations are puret
+    # translation tables.
+    def self.migrate
+
+      black_list = ["created_at", "updated_at", "locale", "id"]
+
+      new_i18n_translations = []
+      ActiveRecord::Base.connection.tables.each do |t|
+        if t =~ /(\w+)_translations$/
+          model = $1
+          attributes = ActiveRecord::Base.connection.columns(t).select{|x| !(black_list + ["#{model}_id"]).include?(x.name)}.map{|x| x.name}
+
+          t.classify.constantize.all.each do |instance|
+
+            attributes.each do |attr|
+              if value = instance.send(attr)
+                new_i18n_translations << I18n::Backend::ActiveRecord::Translation.new(
+                          :locale => instance.locale,
+                          :value => value,
+                          :key => "armot.#{model.pluralize}.#{attr}.#{attr}_#{  instance.send("#{model}_id")  }")
+              end
+            end
+          end
+        end
+      end
+
+      I18n::Backend::ActiveRecord::Translation.transaction do
+        new_i18n_translations.each {|x| x.save}
+      end
+    end
+  end
+end

data/lib/armot/railtie.rb

@@ -0,0 +1,7 @@
+module Armot
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load "tasks/puret_migration.rake"
+    end
+  end
+end

data/lib/armot/version.rb

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

data/lib/tasks/puret_migration.rake

@@ -0,0 +1,8 @@
+require 'armot/puret_integration'
+
+namespace :armot do
+  desc 'dump all the existing translations in puret to i18n'
+  task :migrate_puret => :environment do
+    Armot::PuretIntegration.migrate
+  end
+end

data/test/armot_test.rb

@@ -0,0 +1,102 @@
+require 'test_helper'
+
+class ArmotTest < ActiveSupport::TestCase
+  def setup
+    setup_db
+    I18n.locale = I18n.default_locale = :en
+    Post.create(:title => 'English title')
+  end
+
+  def teardown
+    teardown_db
+  end
+
+  test "database setup" do
+    assert_equal 1, Post.count
+  end
+
+  test "allow translation" do
+    I18n.locale = :de
+    Post.first.update_attribute :title, 'Deutscher Titel'
+    assert_equal 'Deutscher Titel', Post.first.title
+    I18n.locale = :en
+    assert_equal 'English title', Post.first.title
+  end
+
+  test "assert fallback to default locale" do
+    post = Post.first
+    I18n.locale = :sv
+    post.title = 'Svensk titel'
+    I18n.locale = :en
+    assert_equal 'English title', post.title
+    I18n.locale = :de
+    assert_equal 'English title', post.title
+  end
+
+  test 'validates_presence_of should work' do
+    post = Post.new
+    assert_equal false, post.valid?
+
+    post.title = 'English title'
+    assert_equal true, post.valid?
+  end
+
+  test 'temporary locale switch should not clear changes' do
+    I18n.locale = :de
+    post = Post.first
+    post.text = 'Deutscher Text'
+    assert !post.title.blank?
+    assert_equal 'Deutscher Text', post.text
+  end
+
+  test 'temporary locale switch should work like expected' do
+    post = Post.new
+    post.title = 'English title'
+    I18n.locale = :de
+    post.title = 'Deutscher Titel'
+    post.save
+    assert_equal 'Deutscher Titel', post.title
+    I18n.locale = :en
+    assert_equal 'English title', post.title
+  end
+
+  test 'should remove unused I18n translation entries when instance is removed' do
+    post = Post.first
+    post.title = "English title"
+    post.text = "Some text"
+    post.save!
+    assert_equal 2, I18n::Backend::ActiveRecord::Translation.count
+    post.destroy
+    assert_equal 0, I18n::Backend::ActiveRecord::Translation.count
+  end
+
+  test "should remove entries for all languages" do
+    post = Post.first
+    post.title = "English title"
+    I18n.locale = :ca
+    post.title = "Catalan title"
+    post.save!
+    assert_equal 2, I18n::Backend::ActiveRecord::Translation.count
+    post.destroy
+    assert_equal 0, I18n::Backend::ActiveRecord::Translation.count
+  end
+
+  test "should not remove other instance translations" do
+    post = Post.first
+    post.title = "English title"
+    post.save!
+    post2 = Post.create! :title => "Other english title"
+    assert_equal 2, I18n::Backend::ActiveRecord::Translation.count
+    post.destroy
+    assert_equal 1, I18n::Backend::ActiveRecord::Translation.count
+  end
+
+  test "should return original attribute when there are no translations" do
+    post = Post.first
+    post[:title] = "original title"
+    post.save!
+    I18n::Backend::ActiveRecord::Translation.delete_all
+
+    assert_equal "original title", Post.first.title
+  end
+end

data/test/puret_migration_test.rb

@@ -0,0 +1,49 @@
+require 'test_helper'
+require 'armot/puret_integration'
+
+class PuretMigrationTest < ActiveSupport::TestCase
+  def setup
+    setup_db
+    I18n.locale = I18n.default_locale = :en
+    Post.create :title => "English title"
+    Post.create :title => "Second english title"
+    I18n::Backend::ActiveRecord::Translation.delete_all
+
+    PostTranslation.create(:post_id => Post.first.id, :locale => "en", :title => 'English title', :text => "Some text")
+    PostTranslation.create(:post_id => Post.last.id, :locale => "en", :title => 'Second english title')
+  end
+
+  def teardown
+    teardown_db
+  end
+
+  test "db setup" do
+    assert_equal 0, I18n::Backend::ActiveRecord::Translation.count
+    assert_equal 2, Post.count
+    assert_equal 2, PostTranslation.count
+  end
+
+  test "armot should not work" do
+    assert_equal "translation missing: en.armot.posts.title.title_1", Post.first.title
+  end
+
+  test "should create i18n records for exiting puret translations" do
+    Armot::PuretIntegration.migrate
+
+    assert_equal 3, I18n::Backend::ActiveRecord::Translation.count
+  end
+
+  test "translations with armot should work after migrate" do
+    Armot::PuretIntegration.migrate
+
+    assert_equal "English title", Post.first.title
+    assert_equal "Second english title", Post.last.title
+  end
+
+  test "non existing translations reamain the same" do
+    Armot::PuretIntegration.migrate
+
+    assert_equal "translation missing: en.armot.posts.text.text_2", Post.last.text
+  end
+
+end

data/test/schema.rb

@@ -0,0 +1,27 @@
+ActiveRecord::Schema.define(:version => 1) do
+  create_table :posts do |t|
+    t.string :title
+    t.text   :text
+
+    t.timestamps
+  end
+
+  # I18n ar translations table
+  create_table :translations do |t|
+    t.string :locale
+    t.string :key
+    t.text   :value
+    t.text   :interpolations
+    t.boolean :is_proc, :default => false
+  end
+
+  # Puret post translations to test the migration process
+  create_table :post_translations do |t|
+    t.references :post
+    t.string :locale
+    t.string :title
+    t.text :text
+    t.timestamps
+  end
+end
+

data/test/test_helper.rb

@@ -0,0 +1,33 @@
+require 'test/unit'
+require 'i18n'
+require 'i18n/backend/active_record'
+
+require 'armot'
+require 'logger'
+
+ActiveRecord::Base.logger = Logger.new(nil)
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+
+# Allow fallbacks to test production-like behaviour
+I18n::Backend::ActiveRecord.send(:include, I18n::Backend::Fallbacks)
+I18n.backend = I18n::Backend::ActiveRecord.new
+
+def setup_db
+  ActiveRecord::Migration.verbose = false
+  load "schema.rb"
+end
+
+def teardown_db
+  ActiveRecord::Base.connection.tables.each do |table|
+    ActiveRecord::Base.connection.drop_table(table)
+  end
+end
+
+class Post < ActiveRecord::Base
+  armotize :title, :text
+  validates_presence_of :title
+end
+
+# Puret translation model to test migration process
+class PostTranslation < ActiveRecord::Base
+end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification 
+name: armot
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Roger Campos
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-07 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: i18n-active_record
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 0
+        - 0
+        - 2
+        version: 0.0.2
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id002 !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: *id002
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  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
+- !ruby/object:Gem::Dependency 
+  name: rake
+  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: sqlite3
+  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: translation support for your models with an I18n active-record backend
+email: 
+- roger@itnig.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- armot.gemspec
+- lib/armot.rb
+- lib/armot/active_record_extensions.rb
+- lib/armot/puret_integration.rb
+- lib/armot/railtie.rb
+- lib/armot/version.rb
+- lib/tasks/puret_migration.rake
+- test/armot_test.rb
+- test/puret_migration_test.rb
+- test/schema.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: https://github.com/rogercampos/armot
+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: armot
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: translation support for your models with an I18n active-record backend
+test_files: []
+