rails-translate-models 0.0.1

data/.document

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

data/Gemfile

@@ -0,0 +1,12 @@
+source "http://rubygems.org"
+
+gem "activerecord", ">= 3.0"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,37 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.1.3)
+      activesupport (= 3.1.3)
+      builder (~> 3.0.0)
+      i18n (~> 0.6)
+    activerecord (3.1.3)
+      activemodel (= 3.1.3)
+      activesupport (= 3.1.3)
+      arel (~> 2.2.1)
+      tzinfo (~> 0.3.29)
+    activesupport (3.1.3)
+      multi_json (~> 1.0)
+    arel (2.2.1)
+    builder (3.0.0)
+    git (1.2.5)
+    i18n (0.6.0)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    multi_json (1.0.4)
+    rake (0.9.2.2)
+    rcov (0.9.11)
+    shoulda (2.11.3)
+    tzinfo (0.3.31)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (>= 3.0)
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.4)
+  rcov
+  shoulda

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Francesc Pla
+
+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,101 @@
+= rails-translate-models
+
+Minimal implementation of model translations for Rails 3.x having a translations table for each model, based on translated_attributes.
+
+== Installation
+
+Add it to your Gemfile:
+
+  gem 'rails-translate-models'
+
+== Setting up
+
+All examples provided will be based on an article model with title and body as translated attributes.
+
+<b>Migration</b>
+
+For each model you have to create a table for the translations, you can do it on model migration, for example:
+
+  class CreateArticles < ActiveRecord::Migration
+    def change
+      create_table :articles do |t|
+        t.timestamps
+      end
+
+      create_table :article_translations do |t|
+        t.integer    :article_id
+        t.string     :language_code
+        t.string     :title
+        t.text       :body
+        t.timestamps
+      end
+
+      add_index :pages_translations, :page_id
+      add_index :pages_translations, [:page_id, :language_code]
+    end
+  end
+
+<b>Specify translated attributes in model</b>
+
+  class Article < ActiveRecord::Base
+    has_translations :title, :body
+  end
+
+== Usage
+
+Self-explained usage given an article with two translations (en / es)
+
+Retrieve data, english as current language:
+
+  a = Article.first
+  a.title
+  => "example title"
+
+Change language and you'll get in spanish
+
+  I18n.locale = :es
+  a.title
+  => "título ejemplo"
+
+Or you can also get any other language using in_language_code for each attribute
+
+  a.title_in_en
+  => "example title"
+
+Note that if the current language doesn't have a translation it always tries to fallback to english then returns nil if it's also not available.
+
+To create a new object.
+
+  a = Article.new
+  a.title = "example title"
+  a.title_in_es = "título ejemplo"
+  a.save
+
+When translation associated record is destroyed all translations are destroyed as well
+
+==
+
+== Scopes
+
+All models with 'has_translations' have 'has_many :model_translations' and 'default_scope :include => :model_translations' so you can take advantage of it and make use of some scopes, for example:
+
+  class Article < ActiveRecord::Base
+    has_translations :title, :body
+
+    scope :ordered_by_title, :order => 'article_translations.title'
+    scope :with_title, lambda { |title| { where("article_translations.title = ?", title) } }
+  end
+
+== TODO
+
+It's an initial implementation for a work in progress project, it's just an initial release but does the basic stuff I need. Help is welcome ;)
+
+ * make tests
+ * translations models generators
+
+
+
+
+
+
+

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 = "rails-translate-models"
+  gem.homepage = "http://github.com/francesc/rails-translate-models"
+  gem.license = "MIT"
+  gem.summary = %Q{Simple gem to translate multi-lingual content in Rails models}
+  gem.description = %Q{Simple gem to translate multi-lingual content in Rails models in separate tables for each model (modelname_translations)}
+  gem.email = "francesc@francesc.net"
+  gem.authors = ["Francesc Pla"]
+  # 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 = "rails-translate-models #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

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

data/lib/rails-translate-models.rb

@@ -0,0 +1,143 @@
+module RailsTranslateModels
+  def has_translations(*args)
+    # store options
+    cattr_accessor :has_translations_options
+    self.has_translations_options = args
+
+    # create translations class
+    type = self.to_s.underscore
+    translations_klass_name = "#{self}_translation".classify
+    translations_table_name = translations_klass_name.pluralize.tableize.to_sym
+
+    translations_klass = Class.new(ActiveRecord::Base) do
+      set_table_name translations_table_name
+      belongs_to type.to_sym
+    end
+
+    Object.const_set(translations_klass_name, translations_klass)
+
+    # set translations association, scoping, and after_save
+    has_many :translations, :class_name => translations_klass_name, :dependent => :destroy
+    default_scope :include => :translations
+
+    after_save :store_translated_attributes
+
+    # include methods
+    include InstanceMethods
+  end
+
+  module InstanceMethods
+    def translatable?
+      true
+    end
+
+    def self.included(base)
+      attributes = base.has_translations_options
+
+      attributes.each do |attribute|
+        base.class_eval <<-GETTER_AND_SETTER
+         def get_#{attribute}(locale=nil)
+           get_translated_attribute(locale, :#{attribute})
+         end
+
+         def set_#{attribute}(value, locale=I18n.locale)
+           set_translated_attribute(locale, :#{attribute}, value)
+         end
+
+         alias #{attribute} get_#{attribute}
+         alias #{attribute}= set_#{attribute}
+       GETTER_AND_SETTER
+      end
+    end
+
+    def get_translated_attribute(locale, attribute)
+      translated_value = if locale
+        translated_attributes_for(locale)[attribute]
+      else
+        # find translated attribute, first try current locale, then english
+        text = translated_attributes_for(I18n.locale)[attribute] || translated_attributes_for("en")[attribute]
+      end
+    end
+
+    def set_translated_attribute(locale, attribute, value)
+      old_value = translated_attributes_for(locale)[attribute]
+      return if old_value.to_s == value.to_s
+      changed_attributes.merge!("#{attribute}_in_#{locale}" => old_value)
+      translated_attributes_for(locale)[attribute] = value
+      @translated_attributes_changed = true
+      # self.translations_attributes.merge!({ :language_code => locale, attribute.to_sym => value })
+      # raise self.translations.inspect
+    end
+
+    def translated_attributes
+      return @translated_attributes if @translated_attributes
+      merge_db_translations_with_instance_variable
+      @translated_attributes ||= {}.with_indifferent_access
+    end
+
+    def translated_attributes= hash
+      @db_translations_merged = true
+      @translated_attributes_changed = true
+      @translated_attributes = hash.with_indifferent_access
+    end
+
+    def respond_to?(name, *args)
+      return true if parse_translated_attribute_method(name)
+      super
+    end
+
+    def method_missing(name, *args)
+      attribute, locale = parse_translated_attribute_method(name)
+      return super unless attribute
+      if name.to_s.include? '='
+        send("set_#{attribute}", args[0], locale)
+      else
+        send("get_#{attribute}", locale)
+      end
+    end
+
+    protected
+
+    def store_translated_attributes
+      return true unless @translated_attributes_changed
+      translations.delete_all
+      @translated_attributes.each do |locale, attributes|
+        translations.create!(attributes.merge(:language_code => locale))
+      end
+      @translated_attributes_changed = false
+      true
+    end
+
+    private
+
+    def merge_db_translations_with_instance_variable
+      return if new_record? or @db_translations_merged
+      @db_translations_merged = true
+
+      translations.each do |t|
+        has_translations_options.each do |attribute|
+          translated_attributes_for(t.language_code)[attribute] = eval("t.#{attribute.to_s}")
+        end
+      end
+    end
+
+    def translated_attributes_for(locale)
+      translated_attributes[locale] ||= {}.with_indifferent_access
+      translated_attributes[locale]
+    end
+
+    def parse_translated_attribute_method(name)
+      return false if name.to_s !~ /^([a-zA-Z_]+)_in_([a-z]{2})[=]?$/
+      attribute = $1; locale = $2
+      return false unless is_translated_attribute?(attribute)
+      return attribute, locale
+    end
+
+    def is_translated_attribute?(method_name)
+      attributes = self.class.has_translations_options
+      attributes.include? method_name.sub('=','').to_sym
+    end
+  end
+end
+
+ActiveRecord::Base.extend RailsTranslateModels

data/rails-translate-models.gemspec

@@ -0,0 +1,62 @@
+# 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 = "rails-translate-models"
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Francesc Pla"]
+  s.date = "2011-12-29"
+  s.description = "Simple gem to translate multi-lingual content in Rails models in separate tables for each model (modelname_translations)"
+  s.email = "francesc@francesc.net"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/rails-translate-models.rb",
+    "rails-translate-models.gemspec",
+    "test/helper.rb",
+    "test/test_rails-translate-models.rb"
+  ]
+  s.homepage = "http://github.com/francesc/rails-translate-models"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.10"
+  s.summary = "Simple gem to translate multi-lingual content in Rails models"
+
+  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<activerecord>, [">= 3.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"])
+    else
+      s.add_dependency(%q<activerecord>, [">= 3.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"])
+    end
+  else
+    s.add_dependency(%q<activerecord>, [">= 3.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"])
+  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 'rails-translate-models'
+
+class Test::Unit::TestCase
+end

data/test/test_rails-translate-models.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestRailsTranslateModels < 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,117 @@
+--- !ruby/object:Gem::Specification
+name: rails-translate-models
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Francesc Pla
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-12-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &70186038307120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70186038307120
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: &70186038309020 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70186038309020
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70186038310860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *70186038310860
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &70186038312320 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+  type: :development
+  prerelease: false
+  version_requirements: *70186038312320
+- !ruby/object:Gem::Dependency
+  name: rcov
+  requirement: &70186038313780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70186038313780
+description: Simple gem to translate multi-lingual content in Rails models in separate
+  tables for each model (modelname_translations)
+email: francesc@francesc.net
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/rails-translate-models.rb
+- rails-translate-models.gemspec
+- test/helper.rb
+- test/test_rails-translate-models.rb
+homepage: http://github.com/francesc/rails-translate-models
+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: -3390267926304446438
+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: Simple gem to translate multi-lingual content in Rails models
+test_files: []