acts_as_translated 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e4d64595d0a9517ba19cc3a8265e5a9e2fe24b43
+  data.tar.gz: 3fb8bafa1b863462ac85296e23a4cae29d330794
+SHA512:
+  metadata.gz: 73632959c1a3838f70486ef1b177f85393405554344a22570659d5b8ce3447e45f8d18213961f87fcc4c8786ea214f3b035b16f0a4e0c159c4c06ce2ef864894
+  data.tar.gz: ca3a0156fab58f916eeb33626cd892a089257b36613864ee0c544f2b8a983d8013da77c971984629722cd72ab963606113ef091087a5a6ad0bab040dc29e5cb5

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in acts_as_translated.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Stijn Mathysen
+
+MIT License
+
+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.md

@@ -0,0 +1,48 @@
+# ActsAsTranslated
+
+This acts_as extension allows easy attribute translation.
+
+## Examples
+
+Your migration file should look like this;
+
+create_table :countries do |t|
+  t.string :name_nl
+  t.string :name_fr
+  t.string :name_en
+
+  t.timestamps
+end
+
+Create a class;
+
+class Country < ActiveRecord::Base
+  acts_as_translated :name #, :default => :nl
+end
+
+Use it in your views, controllers, ...
+
+<% Country.all.each do |country| %>
+  <%= country.name %>
+<% end %>
+
+
+# Form Example
+
+Build a dynamic form that extends, based on the number of languages available;
+
+<% form_for @country do %>
+  ...
+  <% @country.translated_fields_to_attributes.each do |attribute| %>
+    <p><%= f.label attribute %><br/>
+        <%= f.text_field attribute %></p>
+    <% end %>
+  ...
+<% end %>
+
+
+# Install
+
+In your bundler Gemfile
+
+gem 'acts_as_translated'

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/acts_as_translated.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+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      = ""
+  spec.license       = "MIT"
+
+  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.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

data/lib/acts_as_translated.rb

@@ -0,0 +1,57 @@
+require "acts_as_translated/version"
+
+module ActsAsTranslated
+  def self.included(base)
+    class << base
+      attr_accessor :language
+      attr_accessor :translated_fields
+    end
+    
+    base.extend(ClassMethods)
+  end
+
+  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
+      end
+    end
+  end
+  
+  module InstanceMethods
+    def translated_field_exists(field)
+      self.class.translated_fields.member?(field.to_sym) && attributes.member?("#{field}_#{self.class.language}")
+    end
+    
+    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
+          end
+        end
+      end
+      
+      result.sort
+    end
+    
+    def respond_to?(field, include_priv = false)
+      return true if translated_field_exists(field)
+      super
+    end
+    
+    def method_missing(field, *args)
+      return self["#{field}_#{self.class.language}".to_sym] if translated_field_exists(field)
+      super
+    end
+  end
+end
+
+class ActiveRecord::Base
+  include ActsAsTranslated
+end

data/lib/acts_as_translated/version.rb

@@ -0,0 +1,3 @@
+module ActsAsTranslated
+  VERSION = '0.0.2'
+end

data/tests/countries.yml

@@ -0,0 +1,17 @@
+belgium:
+  name_nl: België
+  name_fr: Belgique
+  name_en: Belgium
+  description_nl: Koninkrijk België
+  description_fr: Royaume de Belgique
+  description_en: Kingdom of Belgium
+  position: 1
+  
+holland:
+  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

data/tests/translated_test.rb

@@ -0,0 +1,94 @@
+require 'test/unit'
+
+require 'rubygems'
+gem 'activerecord', '>= 1.15.4.7794'
+require 'active_record'
+
+require "#{File.dirname(__FILE__)}/../init"
+
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+
+def setup_db
+  ActiveRecord::Schema.define(:version => 1) do
+    create_table :countries do |t|
+      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 :created_at, :datetime      
+      t.column :updated_at, :datetime
+      t.column :position, :integer
+    end
+  end
+end
+
+def fixtures(filename)
+  records = YAML.load_file("#{filename}.yml")
+  records.each do |key, record|
+    Country.create!(record)
+  end
+end
+
+def teardown_db
+  ActiveRecord::Base.connection.tables.each do |table|
+    ActiveRecord::Base.connection.drop_table(table)
+  end
+end
+
+class Country < ActiveRecord::Base
+  acts_as_translated :name
+  acts_as_translated :description
+  
+  default_scope :order => 'position'
+end
+
+class TranslatedTest < Test::Unit::TestCase
+  def setup
+    setup_db
+    fixtures :countries
+  end
+
+  def teardown
+    teardown_db
+  end
+
+  def test_fixtures
+    assert_equal 2, Country.count
+    assert_equal 'Belgium', Country.first.name_en
+    assert_equal 'Netherlands', Country.last.name_en
+  end
+
+  def test_translated_name
+    @belgium = Country.first
+    @netherlands = Country.last
+    
+    # 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
+    
+    # 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 'Koninkrijk der Nederlanden', @netherlands.description
+    
+    # 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 'Royaume des Pays-Bas', @netherlands.description
+
+    # 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 'Kingdom of the Netherlands', @netherlands.description
+  end
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: acts_as_translated
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Stijn Mathysen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- stijn@skylight.be
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- acts_as_translated.gemspec
+- lib/acts_as_translated.rb
+- lib/acts_as_translated/version.rb
+- tests/countries.yml
+- tests/translated_test.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.3
+signing_key: 
+specification_version: 4
+summary: This acts_as extension allows easy attribute translation.
+test_files: []