traco 1.3.0 → 2.0.0

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+
+## 2.0.0
+
+* Backwards incompatible: for dashed locales like `:"pt-BR"`, the column names are now expected to end in e.g. `_pt_br`, not `_pt-BR`.
+
+## 1.3.0
+
+Whatever we had before introducing this changelog.

data/{README.markdown → README.md}

@@ -2,7 +2,7 @@
 
 [![Build Status](https://secure.travis-ci.org/barsoom/traco.png)](http://travis-ci.org/barsoom/traco)
 
-Translatable attributes for Rails 3, stored in the model table itself.
+Translatable attributes for Rails 3 and 4 (Ruby 1.9+), stored in the model table itself.
 
 Inspired by Iain Hecker's [translatable_columns](https://github.com/iain/translatable_columns/).
 
@@ -15,26 +15,30 @@ Say you want `Post#title` and `Post#body` to support both English and Swedish va
 
 Write a migration to get database columns with locale suffixes, e.g. `title_sv` and `title_en`, like:
 
-    class CreatePosts < ActiveRecord::Migration
-      def change
-        create_table :posts do |t|
-          t.string :title_sv, :title_en
-          t.text :body_sv, :body_en
+```ruby
+class CreatePosts < ActiveRecord::Migration
+  def change
+    create_table :posts do |t|
+      t.string :title_sv, :title_en
+      t.text :body_sv, :body_en
 
-          t.timestamps
-        end
-      end
+      t.timestamps
     end
+  end
+end
+```
 
 Don't create a database column named `title` without a suffix, since Traco will define a method with that name.
 
-E.g. `title_pt-BR` is also fine, if you need to use that locale format.
+If you use a locale format like `pt-BR`, the column name would be `title_pt_br`.
 
 Declare the attributes in the model:
 
-    class Post < ActiveRecord::Base
-      translates :title, :body
-    end
+```ruby
+class Post < ActiveRecord::Base
+  translates :title, :body
+end
+```
 
 You can still use your accessors like `title_sv` and `title_sv=` in forms, validations and other code, but you also get:
 
@@ -48,23 +52,28 @@ You can still use your accessors like `title_sv` and `title_sv=` in forms, valid
 
 `.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.locale_columns(:title).each do |column| %>
-      <p>
-        <%= form.label column %>
-        <%= form.text_field column %>
-      </p>
-    <% end %>
+```erb
+<% Post.locale_columns(:title).each do |column| %>
+  <p>
+    <%= form.label column %>
+    <%= form.text_field column %>
+  </p>
+<% end %>
+```
 
 Or perhaps for things like:
 
-    attr_accessible *locale_columns(:title)
+```ruby
+attr_accessible *locale_columns(:title)
 
-    validates *locale_columns(:title),
-      :uniqueness => true
+validates *locale_columns(:title), :uniqueness => true
+```
 
 You can also pass multiple attributes if you like:
 
-    attr_accessible *locale_columns(:title, :body)
+```ruby
+attr_accessible *locale_columns(:title, :body)
+```
 
 The return value will be sorted like `[:title_sv, :title_en, :body_sv, :body_en]`.
 
@@ -79,10 +88,12 @@ Please note that your `translates :title, :body` declaration must be called befo
 
 if you specify
 
-    class Post < ActiveRecord::Base
-      translates :title, :body,
-        fallback: false
-    end
+```ruby
+class Post < ActiveRecord::Base
+  translates :title, :body,
+    fallback: false
+end
+```
 
 then `#title` will return `nil` if there is no translation in the current locale, instead of falling back to the default locale.
 
@@ -91,20 +102,23 @@ then `#title` will return `nil` if there is no translation in the current locale
 
 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
+```ruby
+class Post < ActiveRecord::Base
+  translates :title
 
+  def title
+    super.reverse
+  end
+end
+```
 
 ## Installation
 
-Add this to your `Gemfile` if you use Bundler 1.1+:
+Add this to your `Gemfile`:
 
-    gem 'traco'
+```ruby
+gem 'traco'
+```
 
 Then run
 
@@ -116,7 +130,7 @@ to install it.
 ## Running the tests
 
     bundle
-    rake # or guard
+    rake
 
 
 <!-- Keeping this a hidden brain dump for now.

data/lib/traco.rb

@@ -2,3 +2,10 @@ require "traco/version"
 require "traco/translates"
 require "traco/class_methods"
 require "traco/localized_reader"
+
+module Traco
+  # E.g. :sv -> :sv, :"pt-BR" -> :pt_br
+  def self.locale_suffix(locale)
+    locale.to_s.downcase.sub("-", "_").to_sym
+  end
+end

data/lib/traco/attribute_setup.rb

@@ -0,0 +1,78 @@
+module Traco
+  class AttributeSetup
+    INSTANCE_METHODS_MODULE_NAME = "TracoInstanceMethods"
+
+    def initialize(klass)
+      @klass = klass
+    end
+
+    def set_up(attributes, options)
+      ensure_class_methods
+      ensure_attribute_list
+      ensure_instance_methods_module
+      add_attributes attributes, options
+    end
+
+    private
+
+    def ensure_class_methods
+      klass.extend Traco::ClassMethods
+    end
+
+    # 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 ensure_attribute_list
+      return if klass.respond_to?(:translatable_attributes)
+      klass.class_attribute :translatable_attributes
+      klass.translatable_attributes = []
+    end
+
+    def ensure_instance_methods_module
+      # Instance methods are defined on an included module, so your class
+      # can just redefine them and call `super`, if you need to.
+      # http://thepugautomatic.com/2013/07/dsom/
+      unless klass.const_defined?(INSTANCE_METHODS_MODULE_NAME, _search_ancestors = false)
+        klass.send :include, klass.const_set(INSTANCE_METHODS_MODULE_NAME, Module.new)
+      end
+    end
+
+    def add_attributes(attributes, options)
+      klass.translatable_attributes |= attributes
+
+      attributes.each do |attribute|
+        define_localized_reader attribute, options
+        define_localized_writer attribute, options
+      end
+    end
+
+    def define_localized_reader(attribute, options)
+      fallback = options.fetch(:fallback, true)
+
+      custom_define_method(attribute) do
+        @localized_readers ||= {}
+        @localized_readers[attribute] ||= Traco::LocalizedReader.new(self, attribute, fallback: fallback)
+        @localized_readers[attribute].value
+      end
+    end
+
+    def define_localized_writer(attribute, options)
+      custom_define_method("#{attribute}=") do |value|
+        suffix = Traco.locale_suffix(I18n.locale)
+        send("#{attribute}_#{suffix}=", value)
+      end
+    end
+
+    def custom_define_method(name, &block)
+      klass.const_get(INSTANCE_METHODS_MODULE_NAME).module_eval do
+        define_method(name, &block)
+      end
+    end
+
+    def klass
+      @klass
+    end
+  end
+end

data/lib/traco/class_methods.rb

@@ -1,6 +1,6 @@
 module Traco
   module ClassMethods
-    LOCALE_RE = /[a-zA-Z]{2}(?:-[a-zA-Z]{2})?/
+    LOCALE_RE = /[a-zA-Z]{2}(?:_[a-zA-Z]{2})?/
 
     def locales_for_attribute(attribute)
       re = /\A#{attribute}_(#{LOCALE_RE})\z/
@@ -19,13 +19,15 @@ module Traco
     end
 
     def human_attribute_name(attribute, options = {})
-      default = super(attribute, options.merge(:default => ""))
-      if default.blank? && attribute.to_s.match(/\A(\w+)_(#{LOCALE_RE})\z/)
+      default = super(attribute, options.merge(default: ""))
+
+      if default.blank? && attribute.to_s.match(/\A(\w+?)_(#{LOCALE_RE})\z/)
         column, locale = $1, $2.to_sym
         if translates?(column)
           return "#{super(column, options)} (#{locale_name(locale)})"
         end
       end
+
       super
     end
 
@@ -33,7 +35,7 @@ module Traco
 
     def locale_sort_value
       lambda { |locale|
-        if locale == I18n.default_locale
+        if locale == Traco.locale_suffix(I18n.default_locale)
           # Sort the default locale first.
           "0"
         else
@@ -48,7 +50,8 @@ module Traco
     end
 
     def locale_name(locale)
-      I18n.t(locale, :scope => :"i18n.languages", :default => locale.to_s.upcase)
+      default = locale.to_s.upcase.sub("_", "-")
+      I18n.t(locale, scope: :"i18n.languages", default: default)
     end
   end
 end

data/lib/traco/localized_reader.rb

@@ -8,7 +8,7 @@ module Traco
 
     def value
       locales_to_try.each do |locale|
-        value = @record.send("#{@attribute}_#{locale}")
+        value = @record.send("#{@attribute}_#{Traco.locale_suffix(locale)}")
         return value if value.present?
       end
 
@@ -18,14 +18,14 @@ module Traco
     private
 
     def locales_to_try
-      @locales_to_try ||= locale_chain & locales_for_attribute
+      locale_chain & locales_for_attribute
     end
 
     def locale_chain
       chain = []
       chain << I18n.locale
       chain << I18n.default_locale if @fallback
-      chain
+      chain.map { |locale| Traco.locale_suffix(locale) }
     end
 
     def locales_for_attribute

data/lib/traco/translates.rb

@@ -1,3 +1,5 @@
+require "traco/attribute_setup"
+
 module Traco
   module Translates
     def translates(*attributes)
@@ -9,84 +11,3 @@ module Traco
 end
 
 ActiveRecord::Base.send :extend, Traco::Translates
-
-
-module Traco
-  class AttributeSetup
-    INSTANCE_METHODS_MODULE_NAME = "TracoInstanceMethods"
-
-    def initialize(klass)
-      @klass = klass
-    end
-
-    def set_up(attributes, options)
-      ensure_class_methods
-      ensure_attribute_list
-      ensure_instance_methods_module
-      add_attributes attributes, options
-    end
-
-    private
-
-    def ensure_class_methods
-      klass.extend Traco::ClassMethods
-    end
-
-    # 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 ensure_attribute_list
-      return if klass.respond_to?(:translatable_attributes)
-      klass.class_attribute :translatable_attributes
-      klass.translatable_attributes = []
-    end
-
-    def ensure_instance_methods_module
-      # Instance methods are defined on an included module, so your class
-      # can just redefine them and call `super`, if you need to.
-      # http://thepugautomatic.com/2013/07/dsom/
-      unless klass.const_defined?(INSTANCE_METHODS_MODULE_NAME, _search_ancestors = false)
-        klass.send :include, klass.const_set(INSTANCE_METHODS_MODULE_NAME, Module.new)
-      end
-    end
-
-    def add_attributes(attributes, options)
-      fallback = options.fetch(:fallback, true)
-
-      klass.translatable_attributes |= attributes
-
-      attributes.each do |attribute|
-        define_localized_reader attribute, :fallback => fallback
-        define_localized_writer attribute
-      end
-    end
-
-    def define_localized_reader(attribute, options)
-      fallback = options[:fallback]
-
-      custom_define_method(attribute) do
-        @localized_readers ||= {}
-        @localized_readers[attribute] ||= Traco::LocalizedReader.new(self, attribute, :fallback => fallback)
-        @localized_readers[attribute].value
-      end
-    end
-
-    def define_localized_writer(attribute)
-      custom_define_method("#{attribute}=") do |value|
-        send("#{attribute}_#{I18n.locale}=", value)
-      end
-    end
-
-    def custom_define_method(name, &block)
-      klass.const_get(INSTANCE_METHODS_MODULE_NAME).module_eval do
-        define_method(name, &block)
-      end
-    end
-
-    def klass
-      @klass
-    end
-  end
-end

data/lib/traco/version.rb

@@ -1,3 +1,3 @@
 module Traco
-  VERSION = "1.3.0"
+  VERSION = "2.0.0"
 end

data/spec/spec_helper.rb

@@ -1,6 +1,6 @@
 RSpec.configure do |config|
   config.treat_symbols_as_metadata_keys_with_true_values = true
-  config.filter_run :focus => true
+  config.filter_run focus: true
   config.run_all_when_everything_filtered = true
 
   # Clear class state before each spec.
@@ -18,13 +18,13 @@ end
 require "active_record"
 require "app/post.rb"
 
-ActiveRecord::Base.establish_connection :adapter => "sqlite3", :database => ":memory:"
+ActiveRecord::Base.establish_connection adapter: "sqlite3", database: ":memory:"
 
 silence_stream(STDOUT) do
-  ActiveRecord::Schema.define(:version => 0) do
-    create_table :posts, :force => true do |t|
-      t.string :title_sv, :title_en, :title_fi, 'title_pt-BR'
-      t.string :body_sv, :body_en, :body_fi, 'body_pt-BR'
+  ActiveRecord::Schema.define(version: 0) do
+    create_table :posts, force: true do |t|
+      t.string :title_sv, :title_en, :title_pt_br
+      t.string :body_sv, :body_en, :body_pt_br
     end
   end
 end

data/spec/traco_spec.rb

@@ -1,3 +1,5 @@
+# encoding: utf-8
+
 require "spec_helper"
 require "traco"
 
@@ -44,9 +46,9 @@ describe Post, ".locales_for_attribute" do
   end
 
   it "lists the locales, default first and then alphabetically" do
-    I18n.default_locale = :fi
+    I18n.default_locale = :"pt-BR"
     Post.locales_for_attribute(:title).should == [
-      :fi, :en, :"pt-BR", :sv, 
+      :pt_br, :en, :sv
     ]
   end
 end
@@ -54,27 +56,27 @@ end
 describe Post, ".locale_columns" do
   before do
     Post.translates :title
-    I18n.default_locale = :fi
+    I18n.default_locale = :"pt-BR"
   end
 
   it "lists the columns-with-locale for that attribute, default locale first and then alphabetically" do
     Post.locale_columns(:title).should == [
-      :title_fi, :title_en, :"title_pt-BR", :title_sv
+      :title_pt_br, :title_en, :title_sv
     ]
   end
 
   it "supports multiple attributes" do
     Post.translates :body
     Post.locale_columns(:body, :title).should == [
-      :body_fi, :body_en, :"body_pt-BR", :body_sv,
-      :title_fi, :title_en, :"title_pt-BR", :title_sv
+      :body_pt_br, :body_en, :body_sv,
+      :title_pt_br, :title_en, :title_sv
     ]
   end
 end
 
 describe Post, "#title" do
   let(:post) {
-    Post.new(:title_sv => "Hej", :title_en => "Halloa", :title_fi => "Moi moi")
+    Post.new(title_sv: "Hej", title_en: "Halloa", title_pt_br: "Olá")
   }
 
   before do
@@ -87,6 +89,12 @@ describe Post, "#title" do
     post.title.should == "Hej"
   end
 
+  it "handles dashed locales" do
+    I18n.locale = :"pt-BR"
+    post.title_pt_br.should == "Olá"
+    post.title.should == "Olá"
+  end
+
   it "falls back to the default locale if locale has no column" do
     I18n.locale = :ru
     post.title.should == "Halloa"
@@ -106,7 +114,7 @@ describe Post, "#title" do
   it "returns nil if all are blank" do
     post.title_sv = " "
     post.title_en = ""
-    post.title_fi = nil
+    post.title_pt_br = nil
     post.title.should be_nil
   end
 
@@ -128,14 +136,22 @@ describe Post, "#title" do
     post.title.should == "title"
     post.body.should == "body"
   end
+  
+  it "reflects locale change" do
+    post.title.should == "Hej"
+    I18n.locale = :en
+    post.title.should == "Halloa"
+    I18n.locale = :sv
+    post.title.should == "Hej"
+  end
 
-  context "with :fallback => false" do
+  context "with fallback: false" do
     let(:post) {
-      Post.new(:title_sv => "Hej", :title_en => "Halloa")
+      Post.new(title_sv: "Hej", title_en: "Halloa")
     }
 
     before do
-      Post.translates :title, :fallback => false
+      Post.translates :title, fallback: false
       I18n.default_locale = :en
     end
 
@@ -155,17 +171,22 @@ end
 describe Post, "#title=" do
   before do
     Post.translates :title
-    I18n.locale = :sv
   end
 
   let(:post) { Post.new }
 
   it "assigns in the current locale" do
+    I18n.locale = :sv
     post.title = "Hej"
-    post.title.should == "Hej"
     post.title_sv.should == "Hej"
   end
 
+  it "handles dashed locales" do
+    I18n.locale = :"pt-BR"
+    post.title = "Olá"
+    post.title_pt_br.should == "Olá"
+  end
+
   it "raises if locale has no column" do
     I18n.locale = :ru
     lambda {
@@ -180,33 +201,33 @@ describe Post, ".human_attribute_name" do
     I18n.locale = :sv
   end
 
-  it "appends a known language name" do
-    Post.human_attribute_name(:title_en).should == "Titel (engelska)"
+  it "uses explicit translations if present" do
+    Post.human_attribute_name(:title_sv).should == "Svensk titel"
   end
 
-  it "uses abbreviation when language name is not known" do
-    Post.human_attribute_name(:title_fi).should == "Titel (FI)"
+  it "appends translated language name if present" do
+    Post.human_attribute_name(:title_en).should == "Titel (engelska)"
   end
 
-  it "yields to defined translations" do
-    Post.human_attribute_name(:title_sv).should == "Svensk titel"
+  it "appends an abbreviation when language name is not translated" do
+    Post.human_attribute_name(:title_pt_br).should == "Titel (PT-BR)"
   end
 
-  it "passes through the default behavior" do
+  it "passes through the default behavior for untranslated attributes" do
     Post.human_attribute_name(:title).should == "Titel"
   end
 
-  it "passes through untranslated columns" do
+  it "passes through untranslated attributes even if the name suggests it's translated" do
     Post.human_attribute_name(:body_sv).should == "Body sv"
   end
 
   # ActiveModel::Errors#full_messages passes in an ugly default.
 
-  it "does not yield to passed-in defaults" do
-    Post.human_attribute_name(:title_en, :default => "Title en").should == "Titel (engelska)"
+  it "does not honor passed-in defaults for locale columns" do
+    Post.human_attribute_name(:title_en, default: "Title en").should == "Titel (engelska)"
   end
 
   it "passes through defaults" do
-    Post.human_attribute_name(:body_sv, :default => "Boday").should == "Boday"
+    Post.human_attribute_name(:body_sv, default: "Boday").should == "Boday"
   end
 end

data/traco.gemspec

@@ -21,6 +21,4 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency "rake"
   s.add_development_dependency "rspec"
-  s.add_development_dependency "guard"
-  s.add_development_dependency "guard-rspec"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: traco
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 2.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-07 00:00:00.000000000 Z
+date: 2013-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -75,38 +75,6 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: guard
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: guard-rspec
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
 description: 
 email:
 - henrik@barsoom.se
@@ -117,11 +85,12 @@ files:
 - .gitignore
 - .rvmrc
 - .travis.yml
+- CHANGELOG.md
 - Gemfile
-- Guardfile
-- README.markdown
+- README.md
 - Rakefile
 - lib/traco.rb
+- lib/traco/attribute_setup.rb
 - lib/traco/class_methods.rb
 - lib/traco/localized_reader.rb
 - lib/traco/translates.rb
@@ -145,7 +114,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2274355270320966914
+      hash: -4140218999015648570
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -154,7 +123,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2274355270320966914
+      hash: -4140218999015648570
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24

data/Guardfile

@@ -1,6 +0,0 @@
-guard "rspec", :version => 2, :cli => "--color" do
-  watch(%r{^spec/.+_spec\.rb$})
-  watch(%r{^lib/traco/(.+)\.rb$}) { |m| "spec/#{m[1]}_spec.rb" }
-  watch(%r{^lib/(.+)\.rb$})       { |m| "spec" }
-  watch('spec/spec_helper.rb')    { |m| "spec" }
-end