acts_as_translated 0.0.5 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e7bcf85b91c371dc0de79182b7cc0ae764db8be7
-  data.tar.gz: d4bd339971fef7736eded1b1fbaae2261e2fdd6e
+  metadata.gz: 992b087e031776713de360952b84f7cdda2c4457
+  data.tar.gz: 46a5d433edd5429b190d34efafc25ae045bcbea7
 SHA512:
-  metadata.gz: 7daf028af2e8b1d3244fd3a6613865a0dfe70e9a92c97397cfc3ef6504f8155147ec51d6cd6ed1436ff2a606f2b89472b91819feff7e4b2be399e5689252bc15
-  data.tar.gz: 4f6468e62efe8b5cd2e43d6eaafaec10dbcab1db039a1fa1be8fd069654a01cc4d790230e2f443ba37f5bc6f39ab566e032b949033b638f921b208961b45e70b
+  metadata.gz: 67a506bca487c1b6967a9a769b84edaf6bd83a3975a06becdff13a632fef94ae8569a2ebbebf05b2ccedb0c7c8db83db2032d6eb556a98135e06922e7833bc05
+  data.tar.gz: 58b936dc865c9d7eacd80fa85aed97e64b1b9ab7e7e6b396fd2fcd9ce7a3c7cfd24e04eee6f4c26e2b4c2dd525857c1976d3162f90d81f02be25030e2db3a7d9

data/README.md

@@ -1,6 +1,6 @@
 # ActsAsTranslated
 
-This acts_as extension allows easy attribute translation.
+This acts_as extension allows easy attribute translation. The gem uses the current I18n.locale to return the translated attribute.
 
 ## Examples
 
@@ -20,7 +20,9 @@ Create a class;
 
 ```
 class Country < ActiveRecord::Base
-  acts_as_translated :name #, :default => :nl
+
+  acts_as_translated :name # optional, pass in default fallback locale; default: :nl
+
 end
 ```
 
@@ -32,25 +34,36 @@ Use it in your views, controllers, ...
 <% end %>
 ```
 
-# Form Example
+In your bundler Gemfile
+
+```
+gem 'acts_as_translated', '~> 1.0'
+```
+
+## Deprication warnings
 
-Build a dynamic form that extends, based on the number of languages available;
+To transition smoothly from the previous versions of acts_as_translated, the gem will currently support array styled definitions, as such;
 
 ```
-<%= form_for @country do %>
-  ...
-  <% @country.translated_fields_to_attributes.each do |attribute| %>
-    <p><%= f.label attribute %><br/>
-      <%= f.text_field attribute %></p>
-    <% end %>
-  ...
-<% end %>
+class Country < ActiveRecord::Base
+
+  acts_as_translated [:name, :description]
+
+end
 ```
 
-# Install
+But this will be removed in future versions as the preferred way is to write;
 
-In your bundler Gemfile
+```
+class Country < ActiveRecord::Base
 
+  acts_as_translated :name, :description
+
+end
 ```
-gem 'acts_as_translated'
-```
+
+## History
+
+I've started development on this gem in 2008, way before I18n was considered the de-facto standard gem for internationalising a Ruby or Ruby-on-Rails app.
+
+The gem has been available for a few years now and serves in various production code.

data/acts_as_translated.gemspec

@@ -1,25 +1,27 @@
 # coding: utf-8
-$:.push File.expand_path("../lib", __FILE__)
+$:.push File.expand_path('../lib', __FILE__)
 require 'acts_as_translated/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "acts_as_translated"
-  spec.version       = ActsAsTranslated::VERSION
-  spec.authors       = ["Stijn Mathysen"]
-  spec.email         = ["stijn@skylight.be"]
-  spec.summary       = %q{This acts_as extension allows easy attribute translation.}
-  spec.homepage      = "https://github.com/stijnster/acts_as_translated"
-  spec.license       = "MIT"
-  spec.description   = %q{ActsAsTranslated is an acts_as for ActiveRecord that allows easy attribute translation.}
+  spec.name           = 'acts_as_translated'
+  spec.version        = ActsAsTranslated::VERSION
+  spec.authors        = [ 'Stijn Mathysen' ]
+  spec.email          = [ 'stijn@skylight.be' ]
+  spec.summary        = 'This acts_as extension allows easy attribute translation.'
+  spec.homepage       = 'https://github.com/stijnster/acts_as_translated'
+  spec.license        = 'MIT'
+  spec.description    = 'ActsAsTranslated is an acts_as for ActiveRecord that allows easy attribute translation.'
 
-  spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.files          = `git ls-files -z`.split("\x0")
+  spec.executables    = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files     = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths  = [ 'lib' ]
+
+  spec.platform       = Gem::Platform::RUBY
 
   spec.add_dependency 'activerecord', '>= 3.0.0'
 
   spec.add_development_dependency 'sqlite3', '~> 0'
   spec.add_development_dependency 'rake', '~> 0'
   spec.add_development_dependency 'minitest', '~> 5.8'
-end
+end

data/lib/acts_as_translated.rb

@@ -6,10 +6,8 @@ module ActsAsTranslated
   require 'acts_as_translated/railtie' if defined? Rails::Railtie
 
   def self.included(base)
-
     class << base
-      attr_accessor :language
-      attr_accessor :translated_fields
+      attr_reader :cached_translated_attributes
     end
 
     base.extend(ClassMethods)
@@ -17,45 +15,43 @@ module ActsAsTranslated
 
   module ClassMethods
 
-    def acts_as_translated(fields, options = {})
-      self.language = options[:default] || 'en'
-      self.translated_fields = Array.new if self.translated_fields.blank?
-      self.translated_fields << fields
-      self.translated_fields.flatten!
-      class_eval do
-        include InstanceMethods
+    def acts_as_translated(*args, default: :en)
+
+      # Support old style coded array attributes, for now
+      if args.first.instance_of? Array
+        args = args.first
+        Kernel.warn "[DEPRECATION] ActsAsTranslated will no longer support array-styles options in the future. Please check the documentation."
       end
-    end
 
-  end
+      @cached_translated_attributes ||= []
 
-  module InstanceMethods
+      class_eval do
+        args.each do |attribute|
 
-    def translated_field_exists(field)
-      self.class.translated_fields.member?(field.to_sym) && attributes.member?("#{field}_#{self.class.language}")
-    end
+          raise "The method #{attribute} already exists for #{self}" if self.instance_methods(true).include?(attribute)
 
-    def translated_fields_to_attributes
-      result = Array.new
-      self.class.translated_fields.each do |field|
-        attributes.each do |attribute, value|
-          if attribute =~ /\A#{field}_\w{2}\Z/
-            result << attribute
+          define_method attribute do
+            self.class.acts_as_translated_attribute(self, attribute, I18n.locale, default: default)
           end
         end
       end
-
-      result.sort
     end
 
-    def respond_to?(field, include_priv = false)
-      return true if translated_field_exists(field)
-      super
-    end
+    def acts_as_translated_attribute(object, name, locale, default: :en)
+      attribute = "#{name}_#{locale}".to_sym
+
+      if @cached_translated_attributes.include?(attribute)
+        return object.send attribute
+      end
 
-    def method_missing(field, *args)
-      return self["#{field}_#{self.class.language}".to_sym] if translated_field_exists(field)
-      super
+      if object.respond_to? attribute
+        @cached_translated_attributes << attribute
+        return object.send attribute
+      else
+        return object.send "#{name}_#{default}".to_sym
+      end
     end
+
   end
+
 end

data/lib/acts_as_translated/version.rb

@@ -1,5 +1,5 @@
 module ActsAsTranslated
 
-  VERSION = '0.0.5'
+  VERSION = '1.0.2'
 
 end

data/test/acts_as_translated_test.rb

@@ -20,12 +20,16 @@ def setup_db
     ActiveRecord::Base.logger
     ActiveRecord::Schema.define(:version => 1) do
       create_table :countries do |t|
+        t.column :iso, :string, index: true, unique: true, null: false
         t.column :name_nl, :string
         t.column :name_fr, :string
         t.column :name_en, :string
         t.column :description_nl, :text
         t.column :description_fr, :text
         t.column :description_en, :text
+        t.column :slug_nl, :string
+        t.column :slug_fr, :string
+        t.column :slug_en, :string
         t.column :created_at, :datetime
         t.column :updated_at, :datetime
         t.column :position, :integer
@@ -50,8 +54,17 @@ end
 class Country < ActiveRecord::Base
 	include ActsAsTranslated
 
-  acts_as_translated :name
-  acts_as_translated :description
+  acts_as_translated :name, :description, default: :nl
+  acts_as_translated :slug
+  acts_as_translated :custom, default: :fr
+
+  def custom_fr
+    "Custom FR method"
+  end
+
+  def custom_es
+    "Custom ES method"
+  end
 end
 
 
@@ -72,50 +85,150 @@ class ActsAsTranslatedTest < Minitest::Test
 	end
 
   def test_fixtures
-    assert_equal 2, Country.count
-    assert_equal 'Belgium', Country.first.name_en
-    assert_equal 'Netherlands', Country.last.name_en
+    assert_equal 3, Country.count
+    assert_equal 'Belgium', Country.find_by_iso(:be).name_en
+    assert_equal 'Netherlands', Country.find_by_iso(:nl).name_en
+    assert_equal 'France', Country.find_by_iso(:fr).name_fr
   end
 
-  def test_translated_attributes
-    @belgium = Country.first
-    @netherlands = Country.last
+  def test_acts_as_translated_attribute_presence
+    refute_respond_to Country.new, :acts_as_translated_attribute
+    assert_respond_to Country, :acts_as_translated_attribute
 
-    # test default language
-    assert_equal 'Belgium', @belgium.name
-    assert_equal 'Netherlands', @netherlands.name
-    assert_equal 'Kingdom of Belgium', @belgium.description
-    assert_equal 'Kingdom of the Netherlands', @netherlands.description
+  end
+
+  def test_acts_as_translated_attribute_matches
+    @country = Country.find_by_iso(:be)
+
+    assert_equal 'België', Country.acts_as_translated_attribute(@country, 'name', 'nl')
+    assert_equal 'Belgique', Country.acts_as_translated_attribute(@country, 'name', 'fr')
+    assert_equal 'Royaume de Belgique', Country.acts_as_translated_attribute(@country, 'description', 'fr')
+
+    @country = Country.find_by_iso(:nl)
+
+    assert_equal 'Nederland', Country.acts_as_translated_attribute(@country, :name, :nl)
+    assert_equal 'Pays-Bas', Country.acts_as_translated_attribute(@country, :name, :fr)
+    assert_equal 'Kingdom of the Netherlands', Country.acts_as_translated_attribute(@country, 'description', :en)
+  end
+
+  def test_acts_as_translated_attribute_defaults
+    @country = Country.find_by_iso(:be)
+
+    assert_equal 'België', Country.acts_as_translated_attribute(@country, 'name', 'es', default: 'nl')
+    assert_equal 'Belgium', Country.acts_as_translated_attribute(@country, 'name', 'de')
+    assert_equal 'Royaume de Belgique', Country.acts_as_translated_attribute(@country, 'description', 'ch', default: 'fr')
+
+    @country = Country.find_by_iso(:nl)
+
+    assert_equal 'Nederland', Country.acts_as_translated_attribute(@country, :name, :es, default: :nl)
+    assert_equal 'Netherlands', Country.acts_as_translated_attribute(@country, :name, :de)
+    assert_equal 'Koninkrijk der Nederlanden', Country.acts_as_translated_attribute(@country, :description, :ch, default: :nl)
+  end
+
+  def test_acts_as_translated_attribute_no_default
+    @country = Country.find_by_iso(:be)
+
+    assert_raises NoMethodError do
+      Country.acts_as_translated_attribute(@country, 'name', 'es', default: 'es')
+    end
+
+    assert_raises NoMethodError do
+      Country.acts_as_translated_attribute(@country, :name, :es, default: :es)
+    end
+
+    assert_raises NoMethodError do
+      Country.acts_as_translated_attribute(@country, 'position', 'es')
+    end
+
+    assert_raises NoMethodError do
+      Country.acts_as_translated_attribute(@country, :position, :es)
+    end
+  end
+
+  def test_method_generation
+    @country = Country.find_by_iso(:be)
+
+    refute_respond_to Country, :description
+    assert_respond_to @country, :description
+    assert_respond_to @country, :name
+    assert_respond_to @country, :slug
+  end
+
+  def test_acts_as_translated_attributes
+    @belgium = Country.find_by_iso(:be)
+    @netherlands = Country.find_by_iso(:nl)
+
+    I18n.enforce_available_locales = false
+
+    I18n.locale = :nl
 
-    # change language to dutch
-    Country.language = 'nl'
     assert_equal 'België', @belgium.name
-    assert_equal 'Nederland', @netherlands.name
     assert_equal 'Koninkrijk België', @belgium.description
+    assert_equal 'belgie', @belgium.slug
+
+    assert_equal 'Nederland', @netherlands.name
     assert_equal 'Koninkrijk der Nederlanden', @netherlands.description
+    assert_equal 'nederland', @netherlands.slug
+
+
+    I18n.locale = :fr
 
-    # change language to french
-    Country.language = 'fr'
     assert_equal 'Belgique', @belgium.name
-    assert_equal 'Pays-Bas', @netherlands.name
     assert_equal 'Royaume de Belgique', @belgium.description
+    assert_equal 'belgique', @belgium.slug
+
+    assert_equal 'Pays-Bas', @netherlands.name
     assert_equal 'Royaume des Pays-Bas', @netherlands.description
+    assert_equal 'pays-bas', @netherlands.slug
+
+    I18n.locale = :en
 
-    # change language to english
-    Country.language = 'en'
     assert_equal 'Belgium', @belgium.name
-    assert_equal 'Netherlands', @netherlands.name
     assert_equal 'Kingdom of Belgium', @belgium.description
+    assert_equal 'belgium', @belgium.slug
+
+    assert_equal 'Netherlands', @netherlands.name
     assert_equal 'Kingdom of the Netherlands', @netherlands.description
+    assert_equal 'netherlands', @netherlands.slug
   end
 
-  def test_class_helpers
-    @country = Country.first
+  def test_acts_as_translated_attribute_defaults
+    @belgium = Country.find_by_iso(:be)
+    @netherlands = Country.find_by_iso(:nl)
 
-    assert @country.translated_field_exists('name')
-    refute @country.translated_field_exists('position')
+    I18n.enforce_available_locales = false
 
-    assert_equal %w(description_en description_fr description_nl name_en name_fr name_nl), @country.translated_fields_to_attributes
+    I18n.locale = :es
+
+    assert_equal 'België', @belgium.name
+    assert_equal 'Koninkrijk België', @belgium.description
+    assert_equal 'belgium', @belgium.slug
+
+    assert_equal 'Nederland', @netherlands.name
+    assert_equal 'Koninkrijk der Nederlanden', @netherlands.description
+    assert_equal 'netherlands', @netherlands.slug
+  end
+
+  def test_acts_as_translated_methods_with_defaults
+    @belgium = Country.find_by_iso(:be)
+
+    I18n.enforce_available_locales = false
+
+    I18n.locale = :nl
+    assert_equal 'Custom FR method', @belgium.custom
+
+    I18n.locale = :es
+    assert_equal 'Custom ES method', @belgium.custom
+  end
+
+  def test_existing_method_names_should_fail
+    Country.acts_as_translated(:some_method_name_that_doesnt_exist)
+    assert_raises RuntimeError do
+      Country.acts_as_translated(:id)
+    end
+    assert_raises RuntimeError do
+      Country.acts_as_translated(:send)
+    end
   end
 
 end

data/test/countries.yml

@@ -1,16 +1,36 @@
 belgium:
+  iso: be
   name_nl: België
   name_fr: Belgique
   name_en: Belgium
   description_nl: Koninkrijk België
   description_fr: Royaume de Belgique
   description_en: Kingdom of Belgium
+  slug_nl: belgie
+  slug_fr: belgique
+  slug_en: belgium
   position: 1
 holland:
+  iso: nl
   name_nl: Nederland
   name_fr: Pays-Bas
   name_en: Netherlands
   description_nl: Koninkrijk der Nederlanden
   description_fr: Royaume des Pays-Bas
   description_en: Kingdom of the Netherlands
-  position: 2
+  slug_nl: nederland
+  slug_fr: pays-bas
+  slug_en: netherlands
+  position: 2
+france:
+  iso: fr
+  name_nl: Frankrijk
+  name_fr: France
+  name_en:
+  description_nl:
+  description_fr:
+  description_en:
+  slug_nl: frankrijk
+  slug_fr: france
+  slug_en:
+  position: 3

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_translated
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 1.0.2
 platform: ruby
 authors:
 - Stijn Mathysen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-16 00:00:00.000000000 Z
+date: 2015-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord