puret 1.0

data/README.rdoc

@@ -0,0 +1,93 @@
+== Puret
+
+Puret is a minimal pure translation library for translating database values for Rails 3.
+
+Puret is quiet like model_translations http://github.com/janne/model_translations (and borrowed much of its code), but comes with generators to help you get started and does not create the translation model dynamically but create it with generator.
+
+
+== Installation
+
+You need configure the puret gem inside your gemfile:
+
+  gem 'puret'
+
+You can also use the latest edge version by specifying the git repository:
+
+  gem 'puret', :git => 'git://github.com/jo/puret.git'
+
+Do not forget to run
+
+  bundle install
+
+
+== Basic Usage
+
+This is a walkthrough with all steps you need to setup puret translated attributes, including model and migration. You MUST also check out the *Generators* section below to help you start.
+
+We're assuming here you want a Post model with some puret attributes, as outlined below:
+
+  class Post < ActiveRecord::Base
+    puret :title, :description
+  end
+
+
+The pure translations are stored in a different translation model for every model you need translations for:
+
+  class PostTranslation < ActiveRecord::Base
+    puret_for :post
+  end
+
+
+You now need to create a migration for the translations table:
+
+  create_table(:post_translations) do |t|
+    t.references :post
+    t.string :locale, :limit => 2
+
+    t.string :title
+    t.text :description
+
+    t.timestamps
+  end
+  add_index :post_translations, [:post_id, :locale], :unique => true
+
+Thats it!
+
+Now you are able to translate values for the attributes :title and :description per locale:
+
+  I18n.locale = :en
+  post.title = 'Puret really rocks!'
+  post.title #=> Puret really rocks!
+  I18n.locale = :de
+  post.title = 'Puret rockt wirklich!'
+  post.title #=> Puret rockt wirklich!
+  I18n.locale = :en
+  post.title #=> Puret really rocks!
+
+
+== Generators
+
+Puret comes with some generators to help you with your daily job:
+
+  rails generate puret:model Post title:string description:text
+
+will setup all the code above and more, either you already have a Post model or not. In the latter case the Post model will be created for you.
+
+In case you already have a translated model and want to add some more puret attributes, just run the puret:attribute generator:
+
+  rails generate puret:attribute Post body:text
+
+This will create the appropriate migration and configure your Post model to translate the new attribute body.
+
+Keep it simple! Relax.
+
+
+== Bugs and Feedback
+
+If you discover any bugs or want to drop a line, feel free to create an issue on
+GitHub:
+
+http://github.com/jo/puret/issues
+
+
+Copyright (c) 2010 Johannes Jörg Schmidt, TF, released under the MIT license

data/init.rb

@@ -0,0 +1 @@
+require 'puret'

data/lib/generators/puret.rb

@@ -0,0 +1,63 @@
+require 'rails/generators/named_base'
+require 'rails/generators/active_model'
+require 'rails/generators/migration'
+
+module Puret
+  module Generators
+    class Base < Rails::Generators::NamedBase #:nodoc:
+      include Rails::Generators::Migration
+
+      def self.source_root
+        @_puret_source_root ||= begin
+          if base_name && generator_name
+            File.expand_path(File.join(base_name, generator_name, 'templates'), File.dirname(__FILE__))
+          end
+        end
+      end
+
+      def self.next_migration_number(path)
+        Time.now.utc.strftime("%Y%m%d%H%M%S")
+      end
+
+      # create model unless exists
+      def invoke_model
+        invoke "model", [name] unless File.exists?(File.join(destination_root, model_path))
+      end
+
+      protected
+  
+      # eg app/models/post.rb
+      def model_path
+        @model_path ||= File.join("app", "models", "#{file_path}.rb")
+      end
+
+      # eg PostTranslation
+      def translation_model_class_name
+        @translation_model_class_name ||= "#{class_name}Translation"
+      end
+
+      # eg app/models/post_translations.rb
+      def translation_model_path
+        @translation_model_path ||= File.join("app", "models", "#{file_path}_translation.rb")
+      end
+
+      def translation_model_exists?
+        File.exists?(File.join(destination_root, translation_model_path))
+      end
+
+      # eg post_translations
+      def translations_table_name
+        translation_model_class_name.tableize
+      end
+
+      def reference_name
+        name.underscore
+      end
+
+      def reference_id
+        "#{reference_name}_id"
+      end
+    end
+  end
+end
+

data/lib/generators/puret/attribute/attribute_generator.rb

@@ -0,0 +1,24 @@
+require 'generators/puret'
+
+module Puret
+  module Generators
+    class AttributeGenerator < Base
+      desc "Generates a translation attribute for the given model NAME (or create it if one does not exist) with Puret configuration plus a migration file."
+
+      argument :attributes, :type => :array, :banner => "field:type field:type"
+
+      # configure puret attributes in model
+      def inject_puret_config_into_model
+        inject_into_class model_path, class_name, <<-CONTENT
+  puret #{attributes.map { |a| ":%s" % a.name }.join(", ")}
+    CONTENT
+      end
+
+      # create migration
+      def copy_attribute_migration_template
+        migration_template "migration.rb", "db/migrate/add_#{translations_table_name}"
+      end
+    end
+  end
+end
+

data/lib/generators/puret/attribute/templates/migration.rb

@@ -0,0 +1,18 @@
+class Add<%= translations_table_name.camelize %> < ActiveRecord::Migration
+  def self.up 
+    change_table(:<%= translations_table_name %>) do |t|
+<% attributes.each do |attribute| -%>
+      t.<%= attribute.type %> :<%= attribute.name %>
+<% end -%>
+    end
+  end
+
+  def self.down
+    change_table(:<%= translations_table_name %>) do |t|
+<% attributes.each do |attribute| -%>
+      t.remove :<%= attribute.name %>
+<% end -%>
+    end
+  end
+end
+

data/lib/generators/puret/model/model_generator.rb

@@ -0,0 +1,29 @@
+require 'generators/puret'
+
+module Puret
+  module Generators
+    class ModelGenerator < Base
+      desc "Generates a translation model for the given model NAME (or create it if one does not exist) with Puret configuration plus a migration file."
+
+      argument :attributes, :type => :array, :default => [], :banner => "field:type field:type"
+
+      # create model
+      def copy_model_template
+        template "model.rb", translation_model_path
+      end
+
+      # configure puret attributes in model
+      def inject_puret_config_into_model
+        inject_into_class model_path, class_name, <<-CONTENT
+  puret #{attributes.map { |a| ":%s" % a.name }.join(", ")}
+    CONTENT
+      end
+
+      # create migration
+      def copy_migration_template
+        migration_template "migration.rb", "db/migrate/create_#{translations_table_name}"
+      end
+    end
+  end
+end
+

data/lib/generators/puret/model/templates/migration.rb

@@ -0,0 +1,20 @@
+class Create<%= translations_table_name.camelize %> < ActiveRecord::Migration
+  def self.up 
+    create_table(:<%= translations_table_name %>) do |t|
+      t.references :<%= reference_name %>
+      t.string :locale, :limit => 2
+
+<% attributes.each do |attribute| -%>
+      t.<%= attribute.type %> :<%= attribute.name %>
+<% end -%>
+
+      t.timestamps
+    end
+    add_index :<%= translations_table_name %>, [:<%= reference_id %>, :locale], :unique => true
+  end
+
+  def self.down
+    drop_table :<%= translations_table_name %>
+  end
+end
+

data/lib/generators/puret/model/templates/model.rb

@@ -0,0 +1,3 @@
+class <%= translation_model_class_name %> < ActiveRecord::Base
+  puret_for :<%= reference_name %>
+end

data/lib/puret.rb

@@ -0,0 +1,4 @@
+require 'puret/active_record_extensions'
+
+module Puret
+end

data/lib/puret/active_record_extensions.rb

@@ -0,0 +1,54 @@
+module Puret
+  module ActiveRecordExtensions
+    module ClassMethods
+      def puret_for(model)
+        belongs_to model
+      end
+
+      def puret(*attributes)
+        make_it_puret! unless included_modules.include?(InstanceMethods)
+
+        attributes.each do |attribute|
+          define_method "#{attribute}=" do |value|
+            puret_attributes[attribute] = value
+          end
+
+          define_method attribute do
+            return puret_attributes[attribute] if puret_attributes[attribute]
+            return if new_record?
+
+            translation = translations.detect { |t| t.locale.to_sym == I18n.locale } ||
+              translations.detect { |t| t.locale.to_sym == I18n.default_locale } ||
+              translations.first
+
+            translation ? translation[attribute] : nil
+          end
+        end
+      end
+
+      private
+
+      def make_it_puret!
+        include InstanceMethods
+
+        has_many :translations, :class_name => "#{self.to_s}Translation", :dependent => :destroy
+        after_save :update_translations!
+      end
+    end
+
+    module InstanceMethods
+      def puret_attributes
+        @puret_attributes ||= {}
+      end
+
+      def update_translations!
+        return if puret_attributes.blank?
+        translation = translations.find_or_initialize_by_locale(I18n.locale.to_s)
+        translation.attributes = translation.attributes.merge(puret_attributes)
+        translation.save!
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.extend Puret::ActiveRecordExtensions::ClassMethods

data/lib/puret/version.rb

@@ -0,0 +1,3 @@
+module Puret
+  VERSION = "1.0".freeze
+end

data/test/puret_test.rb

@@ -0,0 +1,60 @@
+require 'test_helper'
+
+class PuretTest < 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 Post.count == 1
+  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" do
+    assert Post.first.title == 'English title'
+    I18n.locale = :de
+    assert Post.first.title == 'English title'
+  end
+ 
+  test "post has_many translations" do
+    assert_equal PostTranslation, Post.first.translations.first.class
+  end
+ 
+  test "translations are deleted when parent is destroyed" do
+    I18n.locale = :de
+    Post.first.update_attribute :title, 'Deutscher Titel'
+    assert_equal 2, PostTranslation.count
+    
+    Post.destroy_all
+    assert_equal 0, PostTranslation.count
+  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'
+    post.title.blank?
+    assert_equal 'Deutscher Text', post.text
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,37 @@
+require 'rubygems'
+require 'test/unit'
+require 'active_support'
+require "active_record"
+require 'puret'
+
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+
+def setup_db
+  ActiveRecord::Schema.define(:version => 1) do
+    create_table :posts do |t|
+      t.timestamps
+    end
+
+    create_table :post_translations do |t|
+      t.references :post
+      t.string :locale
+      t.string :title
+      t.timestamps
+    end
+  end
+end
+ 
+def teardown_db
+  ActiveRecord::Base.connection.tables.each do |table|
+    ActiveRecord::Base.connection.drop_table(table)
+  end
+end
+
+class Post < ActiveRecord::Base
+  puret :title, :text
+  validates_presence_of :title
+end
+
+class PostTranslation < ActiveRecord::Base
+  puret_for :post
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification 
+name: puret
+version: !ruby/object:Gem::Version 
+  version: "1.0"
+platform: ruby
+authors: 
+- "Johannes J\xC3\xB6rg Schmidt"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-22 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: Pure model translations
+email: schmidt@netzmerk.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- init.rb
+- lib/generators/puret.rb
+- lib/generators/puret/attribute/attribute_generator.rb
+- lib/generators/puret/attribute/templates/migration.rb
+- lib/generators/puret/model/model_generator.rb
+- lib/generators/puret/model/templates/migration.rb
+- lib/generators/puret/model/templates/model.rb
+- lib/puret.rb
+- lib/puret/active_record_extensions.rb
+- lib/puret/version.rb
+- README.rdoc
+has_rdoc: true
+homepage: http://github.com/jo/puret
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Pure model translations
+test_files: 
+- test/puret_test.rb
+- test/test_helper.rb