attr-translatable 0.1.0

data/LICENSE

@@ -0,0 +1,177 @@
+
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS

data/README.md

@@ -0,0 +1,39 @@
+## attr-translatable
+
+attr-translatable gem allows you to translate string attributes of your ActiveRecord.
+
+## Installation
+
+Add to Gemfile
+
+```ruby
+gem 'attr-translatable', :require => 'attr_translatable'
+```
+
+Run:
+```ruby
+bundle install
+rails g attr_translatable
+rake db:migrate
+```
+
+## Usage Example
+
+```ruby
+class Post < ActiveRecord
+  attr_accessible :title, :content, :author
+  attr_translatable :title, :content
+end
+
+@post = Post.create(
+  title: "New Blog Post",
+  content: "attr-translatable is awesome!",
+  author: "Katsuya Noguchi"
+)
+@post.update_translation(:title, :ja, "新しいブログポスト")
+@post.translate(:title, :ja)
+#=> "新しいブログポスト"
+```
+## Authors
+
+* Katsuya Noguchi: http://github.com/katsuyan

data/Rakefile

@@ -0,0 +1,20 @@
+require 'rdoc/task'
+require 'rubygems'
+require 'rubygems/package_task'
+require 'rspec/core/rake_task'
+
+desc 'Default: run specs.'
+task :default => :rspec
+
+desc 'Run the specs'
+RSpec::Core::RakeTask.new(:rspec) do |t|
+  t.rspec_opts = ['--color']
+  t.pattern = './spec/**/*_spec.rb'
+end
+
+spec = Gem::Specification.load("#{File.dirname(__FILE__)}/attr-translatable.gemspec")
+
+desc "Package gem."
+Gem::PackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end

data/lib/attr_translatable.rb

@@ -0,0 +1,7 @@
+# encoding: UTF-8
+
+require 'attr_translatable/base'
+require 'attr_translatable/translation'
+require 'models/attr_translation'
+
+ActiveRecord::Base.send(:include, AttrTranslatable::Base)

data/lib/attr_translatable/base.rb

@@ -0,0 +1,38 @@
+# encoding: UTF-8
+
+module AttrTranslatable
+  module Base
+    def self.included(klass)
+      klass.extend ClassMethods
+    end
+
+    module ClassMethods
+      def attr_translatable(*args)
+        attrs = validate_attrs(args)
+        unless ancestors.include?(AttrTranslatable::Translation)
+          @valid_translatable_attrs = attrs
+          has_many :attr_translatables, as: :model, dependent: :destroy
+          include AttrTranslatable::Translation
+        end
+      end
+
+      def valid_translatable_attrs
+        @valid_translatable_attrs || []
+      end
+
+      private
+        
+        def validate_attrs(attrs)
+          valid_attrs = self.new.attributes.keys
+          attrs.map do |a|
+            a = a.to_s
+            raise ArgumentError, "#{a} is not an attribute of #{self.name}." unless valid_attrs.include?(a)
+            type = columns.find { |c| c.name == a }.type
+            raise ArgumentError, "Only a string type can be translatable." unless type == :string
+            a
+          end
+        end
+
+    end
+  end
+end

data/lib/attr_translatable/translation.rb

@@ -0,0 +1,39 @@
+# encoding: UTF-8
+
+module AttrTranslatable
+  module Translation
+
+    def update_translation(attr, lang, translation)
+      new_translation(attr, lang, translation).save
+    end
+
+    def translate(attr, lang)
+      internal_translate(attr, lang)
+    end
+    
+    def t(attr, lang)
+      internal_translate(attr, lang)
+    end
+
+    private
+      
+      def new_translation(attr, lang, translation)
+        attr, lang = [attr.to_s, lang.to_s]
+        validate_attr(attr)
+        at = AttrTranslation.find_or_initialize_by_attr_and_lang_and_model_id_and_model_type(attr, lang, self.id, self.class.name)
+        at.translation = translation
+        at
+      end
+      
+      def internal_translate(attr, lang)
+        attr, lang = [attr.to_s, lang.to_s]
+        validate_attr(attr)
+        at = AttrTranslation.select(:translation).where(attr: attr, lang: lang, model_id: self.id, model_type: self.class.name).first
+        at ? at.translation : self.send(attr)
+      end
+
+      def validate_attr(attr)
+        raise ArgumentError, "#{attr} is not translatable attribute." unless self.class.valid_translatable_attrs.include?(attr)
+      end
+  end
+end

data/lib/attr_translatable/version.rb

@@ -0,0 +1,3 @@
+module AttrTranslatable
+  VERSION = "0.1.0"
+end

data/lib/generators/attr_translatable/attr_translatable_generator.rb

@@ -0,0 +1,29 @@
+# encoding: UTF-8
+
+require 'rails/generators'
+require 'rails/generators/migration'
+require 'rails/generators/active_record'
+
+class AttrTranslatableGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+
+  desc "Creates migration files required by attr-translatable gem."
+
+  self.source_paths << File.join(File.dirname(__FILE__), 'templates')
+
+  def self.next_migration_number(path)
+    ActiveRecord::Generators::Base.next_migration_number(path)
+  end
+
+  def create_migration_files
+    create_migration_file_if_not_exist 'create_attr_translations'
+  end
+
+  private
+    
+    def create_migration_file_if_not_exist(file_name)
+      unless self.class.migration_exists?(File.dirname(File.expand_path("db/migrate/#{file_name}")), file_name)
+        migration_template "#{file_name}.rb", "db/migrate/#{file_name}.rb"
+      end
+    end
+end

data/lib/generators/attr_translatable/templates/create_attr_translations.rb

@@ -0,0 +1,15 @@
+# encoding: UTF-8
+
+class CreateAttrTranslations < ActiveRecord::Migration
+  def self.change
+    create_table :attr_translations do |t|
+      t.string      :translation
+      t.string      :lang
+      t.string      :attr
+      t.references  :model, polymorphic: true
+      t.timestamps
+    end
+
+    add_index :attr_translations, [:lang, :attr, :model_id, :model_type], unique: true, name: "index_attr_translations_on_attr_and_lang_and_model"
+  end
+end

data/lib/models/attr_translation.rb

@@ -0,0 +1,9 @@
+# encoding: UTF-8
+
+class AttrTranslation < ActiveRecord::Base
+  belongs_to :model, :polymorphic => true
+
+  attr_accessible :translation, :lang, :attr, :model_id, :model_type
+
+  validates :attr, uniqueness: { :scope => [:lang, :model_id, :model_type] }
+end

data/spec/attr_translatable_spec.rb

@@ -0,0 +1,63 @@
+# encoding: UTF-8
+
+require 'spec_helper'
+
+describe ActiveRecord::Base do
+
+  before :each do
+    @post = Post.create :title => "Blog Title", :content => "Blog Content", :url => "www.katsuyan.me/post/1"
+  end
+
+  context "when attr_translatable is called with invalid args" do
+    describe "#attr_translatable" do
+      it "raises an error if a given attr is not defined" do
+        lambda { Post.attr_translatable :attr_undefined }.should raise_error ArgumentError
+      end
+      it "raises an error if a given attr is not a string" do
+        lambda { Post.attr_translatable :votes }.should raise_error ArgumentError
+      end
+    end
+  end
+
+  context "when attr_translatable is called with valid args" do
+    before :each do
+      Post.attr_translatable :title, :content
+    end
+
+    describe "#update_translation" do
+      context "when non translatable attribute is given" do
+        it "raises an error" do
+          lambda { @post.update_translation(:url, :ja, "アドレス") }.should raise_error ArgumentError
+        end
+      end
+    end
+
+    describe "#translate" do
+      context "when translatable attribute is given" do
+        context "translation exists" do
+          before :each do
+            @ja_translation = "ブログのタイトル"
+            @post.update_translation(:title, :ja, @ja_translation)
+          end
+          it "returns a translation" do
+            @post.translate(:title, :ja).should == @ja_translation
+            @post.t(:title, :ja).should == @ja_translation
+          end
+        end
+
+        context "translation does not exist" do
+          it "returns a default string" do
+            @post.translate(:title, :fr).should == "Blog Title"
+            @post.t(:title, :fr).should == "Blog Title"
+          end
+        end
+      end
+      context "when non translatable attribute is given" do
+        it "should raise an error" do
+          lambda { @post.translate(:url, :ja) }.should raise_error ArgumentError
+          lambda { @post.t(:url, :ja) }.should raise_error ArgumentError
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,45 @@
+# encoding: UTF-8
+
+require 'active_record'
+require 'database_cleaner'
+require 'sqlite3'
+require 'attr_translatable'
+
+ActiveRecord::Base.establish_connection(
+  adapter: "sqlite3",
+  database: ":memory:"
+)
+
+RSpec.configure do |config|
+  config.before :each do
+    DatabaseCleaner.start
+  end
+  config.after :each do
+    DatabaseCleaner.clean
+  end
+end
+
+ActiveRecord::Migration.verbose = false
+
+ActiveRecord::Schema.define do
+  create_table :attr_translations do |t|
+    t.string      :translation
+    t.string      :lang
+    t.string      :attr
+    t.references  :model, polymorphic: true
+    t.timestamps
+  end
+
+  add_index :attr_translations, [:lang, :attr, :model_id, :model_type], unique: true, name: "index_attr_translations_on_attr_and_lang_and_model"
+
+  create_table :posts do |t|
+    t.string  :title
+    t.string  :content
+    t.integer  :votes
+    t.string  :url
+    t.timestamps
+  end
+end
+
+class Post < ActiveRecord::Base
+end

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: attr-translatable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Katsuya Noguchi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.8'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  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: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.5
+description: attr-translatable gem allows attributes of ActiveRecord to be translated.
+email:
+- katsuya7s@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- lib/attr_translatable/base.rb
+- lib/attr_translatable/translation.rb
+- lib/attr_translatable/version.rb
+- lib/attr_translatable.rb
+- lib/generators/attr_translatable/attr_translatable_generator.rb
+- lib/generators/attr_translatable/templates/create_attr_translations.rb
+- lib/models/attr_translation.rb
+- spec/attr_translatable_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/katsuyan/attr-translatable
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1703276739540596886
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1703276739540596886
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: attr-translatable gem allows attributes of ActiveRecord to be translated.
+test_files: []