traco 0.3.1 → 0.4.2

data/README.markdown

@@ -2,7 +2,7 @@
 
 [![Build Status](https://secure.travis-ci.org/barsoom/traco.png)](http://travis-ci.org/barsoom/traco)
 
-Translatable columns for Rails 3, stored in the model table itself.
+Translatable attributes for Rails 3, stored in the model table itself.
 
 Inspired by Iain Hecker's [translatable_columns](https://github.com/iain/translatable_columns/).
 
@@ -26,9 +26,9 @@ Write a migration to get database columns with locale suffixes, e.g. `title_sv`
       end
     end
 
-Don't create a column named `title` without a suffix, since Traco will define a method with that name.
+Don't create a database column named `title` without a suffix, since Traco will define a method with that name.
 
-Declare these columns in the model:
+Declare the attributes in the model:
 
     class Post < ActiveRecord::Base
       translates :title, :body
@@ -42,17 +42,26 @@ You can still use your accessors like `title_sv` and `title_sv=` in forms, valid
 
 `.human_attribute_name(:title_sv)`: Extends this standard method to return "Title (Swedish)" if you have a translation key `i18n.languages.sv = "Swedish"` and "Title (SV)" otherwise. Rails uses this method to build validation error messages and form labels.
 
-`.translatable_columns`: Returns an array like `[:title, :body]`.
+`.translatable_attributes`: Returns an array like `[:title, :body]`.
 
-`.locales_for_column(:title)`: Returns an array like `[:sv, :en]` sorted with default locale first and then alphabetically. Suitable for looping in forms:
+`.locale_columns(:title)`: Returns an array like `[:title_sv, :title_en]` sorted with default locale first and then alphabetically. Suitable for looping in forms:
 
-    <% Post.locales_for_column(:title).each do |locale| %>
+    <% Post.locale_columns(:title).each do |column| %>
       <p>
-        <%= form.label "title_#{locale}" %>
-        <%= form.text_field "title_#{locale}" %>
+        <%= form.label column %>
+        <%= form.text_field column %>
       </p>
     <% end %>
 
+Or perhaps for things like:
+
+    attr_accessible *locale_columns(:name)
+
+    validates *locale_columns(:name),
+      :uniqueness => true
+
+`.locales_for_attribute(:title)`: Returns an array like `[:sv, :en]` sorted with default locale first and then alphabetically.
+
 And the equivalent methods for `body`, of course.
 
 
@@ -68,15 +77,24 @@ if you specify
 then `#title` will return `nil` if there is no translation in the current locale, instead of falling back to the default locale.
 
 
-## Installation
+### Overriding methods
 
-Add this to your `Gemfile` if you use Bundler 1.1+:
+Methods are defined in an included module, so you can just override them and call Traco's implementation with `super`:
+
+    class Post < ActiveRecord::Base
+      translates :title
+
+      def title
+        super.reverse
+      end
+    end
 
-    gem 'traco', github: 'barsoom/traco'
 
-Or with an earlier version of Bundler:
+## Installation
+
+Add this to your `Gemfile` if you use Bundler 1.1+:
 
-    gem 'traco', git: 'git://github.com/barsoom/traco.git'
+    gem 'traco'
 
 Then run
 

data/lib/traco/class_methods.rb

@@ -1,9 +1,17 @@
 module Traco
   module ClassMethods
-    def locales_for_column(column)
-      column_names.grep(/\A#{column}_([a-z]{2})\z/) {
-        $1.to_sym
-      }.sort_by { |locale| locale_sort_value(locale) }
+    def locales_for_attribute(attribute)
+      re = /\A#{attribute}_([a-z]{2})\z/
+
+      column_names.
+        grep(re) { $1.to_sym }.
+        sort_by(&locale_sort_value)
+    end
+
+    def locale_columns(attribute)
+      locales_for_attribute(attribute).map { |locale|
+        :"#{attribute}_#{locale}"
+      }
     end
 
     def human_attribute_name(attribute, options = {})
@@ -19,18 +27,20 @@ module Traco
 
     private
 
-    def locale_sort_value(locale)
-      if locale == I18n.default_locale
-        # Sort the default locale first.
-        "0"
-      else
-        # Sort the rest alphabetically.
-        locale.to_s
-      end
+    def locale_sort_value
+      lambda { |locale|
+        if locale == I18n.default_locale
+          # Sort the default locale first.
+          "0"
+        else
+          # Sort the rest alphabetically.
+          locale.to_s
+        end
+      }
     end
 
-    def translates?(column)
-      translatable_columns.include?(column.to_sym)
+    def translates?(attribute)
+      translatable_attributes.include?(attribute.to_sym)
     end
 
     def locale_name(locale)

data/lib/traco/localized_reader.rb

@@ -1,14 +1,14 @@
 module Traco
   class LocalizedReader
-    def initialize(record, column, options)
+    def initialize(record, attribute, options)
       @record = record
-      @column = column
+      @attribute = attribute
       @fallback = options[:fallback]
     end
 
     def value
       locales_to_try.each do |locale|
-        value = @record.send("#{@column}_#{locale}")
+        value = @record.send("#{@attribute}_#{locale}")
         return value if value.present?
       end
 
@@ -18,7 +18,7 @@ module Traco
     private
 
     def locales_to_try
-      @locales_to_try ||= locale_chain & locales_for_column
+      @locales_to_try ||= locale_chain & locales_for_attribute
     end
 
     def locale_chain
@@ -28,8 +28,8 @@ module Traco
       chain
     end
 
-    def locales_for_column
-      @record.class.locales_for_column(@column)
+    def locales_for_attribute
+      @record.class.locales_for_attribute(@attribute)
     end
   end
 end

data/lib/traco/translates.rb

@@ -1,52 +1,61 @@
 module Traco
   module Translates
-    def translates(*columns)
-      options = columns.extract_options!
+    def translates(*attributes)
+      options = attributes.extract_options!
       set_up_once
-      store_as_translatable_columns columns.map(&:to_sym), options
+      store_as_translatable_attributes attributes.map(&:to_sym), options
     end
 
     private
 
-    # Don't overwrite values if running multiple times in the same
-    # class or in different classes of an inheritance chain.
+    # Only called once per class or inheritance chain (e.g. once
+    # for the superclass, not at all for subclasses). The separation
+    # is important if we don't want to overwrite values if running
+    # multiple times in the same class or in different classes of
+    # an inheritance chain.
     def set_up_once
-      return if respond_to?(:translatable_columns)
+      return if respond_to?(:translatable_attributes)
 
-      extend Traco::ClassMethods
+      class_attribute :traco_instance_methods
+      class_attribute :translatable_attributes
 
-      class_attribute :translatable_columns
-      self.translatable_columns = []
+      self.translatable_attributes = []
+      extend Traco::ClassMethods
     end
 
-    def store_as_translatable_columns(columns, options)
+    def store_as_translatable_attributes(attributes, options)
       fallback = options.fetch(:fallback, true)
 
-      self.translatable_columns |= columns
+      self.translatable_attributes |= attributes
+
+      # Instance methods are defined on an included module, so your class
+      # can just redefine them and call `super`, if you need to.
+      self.traco_instance_methods = Module.new
+      include traco_instance_methods
 
-      columns.each do |column|
-        define_localized_reader column, :fallback => fallback
-        define_localized_writer column
+      attributes.each do |attribute|
+        define_localized_reader attribute, :fallback => fallback
+        define_localized_writer attribute
       end
     end
 
-    def define_localized_reader(column, options)
+    def define_localized_reader(attribute, options)
       fallback = options[:fallback]
 
-      define_method(column) do
-        @localized_readers ||= {}
-        @localized_readers[column] ||= Traco::LocalizedReader.new(
-          self,
-          column,
-          :fallback => fallback
-        )
-        @localized_readers[column].value
+      traco_instance_methods.module_eval do
+        define_method(attribute) do
+          @localized_readers ||= {}
+          @localized_readers[attribute] ||= Traco::LocalizedReader.new(self, attribute, :fallback => fallback)
+          @localized_readers[attribute].value
+        end
       end
     end
 
-    def define_localized_writer(column)
-      define_method("#{column}=") do |value|
-        send("#{column}_#{I18n.locale}=", value)
+    def define_localized_writer(attribute)
+      traco_instance_methods.module_eval do
+        define_method("#{attribute}=") do |value|
+          send("#{attribute}_#{I18n.locale}=", value)
+        end
       end
     end
   end

data/lib/traco/version.rb

@@ -1,3 +1,3 @@
 module Traco
-  VERSION = "0.3.1"
+  VERSION = "0.4.2"
 end

data/spec/traco_spec.rb

@@ -28,29 +28,42 @@ describe ActiveRecord::Base, ".translates" do
   end
 end
 
-describe Post, ".translatable_columns" do
+describe Post, ".translatable_attributes" do
   before do
     Post.translates :title
   end
 
-  it "should list the translatable columns" do
-    Post.translatable_columns.should == [ :title ]
+  it "should list the translatable attributes" do
+    Post.translatable_attributes.should == [ :title ]
   end
 end
 
-describe Post, ".locales_for_column" do
+describe Post, ".locales_for_attribute" do
   before do
     Post.translates :title
   end
 
   it "should list the locales, default first and then alphabetically" do
     I18n.default_locale = :fi
-    Post.locales_for_column(:title).should == [
+    Post.locales_for_attribute(:title).should == [
       :fi, :en, :sv
     ]
   end
 end
 
+describe Post, ".locale_columns" do
+  before do
+    Post.translates :title
+  end
+
+  it "should list the columns-with-locale for that attribute, default locale first and then alphabetically" do
+    I18n.default_locale = :fi
+    Post.locale_columns(:title).should == [
+      :title_fi, :title_en, :title_sv
+    ]
+  end
+end
+
 describe Post, "#title" do
   let(:post) {
     Post.new(:title_sv => "Hej", :title_en => "Halloa", :title_fi => "Moi moi")
@@ -89,6 +102,16 @@ describe Post, "#title" do
     post.title.should be_nil
   end
 
+  it "should be overridable" do
+    class Post
+      def title
+        super.reverse
+      end
+    end
+
+    post.title.should == "jeH"
+  end
+
   # Had a regression.
   it "handles multiple columns" do
     Post.translates :title, :body
@@ -104,7 +127,7 @@ describe Post, "#title" do
     }
 
     before do
-      Post.translates :title, fallback: false
+      Post.translates :title, :fallback => false
       I18n.default_locale = :en
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: traco
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-29 00:00:00.000000000 Z
+date: 2012-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &70244124230460 !ruby/object:Gem::Requirement
+  requirement: &70327471440700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70244124230460
+  version_requirements: *70327471440700
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &70244124230040 !ruby/object:Gem::Requirement
+  requirement: &70327471440280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70244124230040
+  version_requirements: *70327471440280
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70244124213140 !ruby/object:Gem::Requirement
+  requirement: &70327471423380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70244124213140
+  version_requirements: *70327471423380
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70244124212720 !ruby/object:Gem::Requirement
+  requirement: &70327471422960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70244124212720
+  version_requirements: *70327471422960
 - !ruby/object:Gem::Dependency
   name: guard
-  requirement: &70244124212300 !ruby/object:Gem::Requirement
+  requirement: &70327471422540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70244124212300
+  version_requirements: *70327471422540
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &70244124211880 !ruby/object:Gem::Requirement
+  requirement: &70327471422120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,7 +76,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70244124211880
+  version_requirements: *70327471422120
 description: 
 email:
 - henrik@barsoom.se
@@ -115,7 +115,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2678658822643103053
+      hash: -237714647746195328
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -124,7 +124,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2678658822643103053
+      hash: -237714647746195328
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.5