ar-translatable 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9e2c3ad150a6762ebe5695a8d5925d5a52703552
+  data.tar.gz: 099a19c95387f430601f3cbe3757876e4456ba9e
+SHA512:
+  metadata.gz: a897633c7fe6d83c3f955ef01f358aa5052f263fb154319db4adbe90ae70dcf375249bf2898d4a91b9e90cc4fd0241543ae1010e3e82fdde6a357c18501b265f
+  data.tar.gz: 70a5e3db396e1c92fa94937b7ae7365ed6cbd3c5b23a4536816538346a0613a1a43d13a8f674050da9d39cf7a3a1159fcec55f60991c71492ad5098601b643a0

data/.gitignore

@@ -0,0 +1,28 @@
+*.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
+log/*.log
+spec/dummy/db/*.sqlite3
+spec/dummy/db/*.sqlite3-journal
+spec/dummy/log/*.log
+spec/dummy/tmp/
+spec/dummy/.sass-cache

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+#--warnings

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.2

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 masarakki
+
+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,82 @@
+# Translatable
+
+ActiveRecord plugin for translate columns
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'translatable'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install translatable
+
+## Usage
+
+### Setup
+
+    rails generate translatable:migration
+    rake db:migrate
+
+### Setting Model
+
+```ruby
+class User < ActiveRecord::Base
+  translatable :first_name
+  translatable :last_name
+end
+```
+
+### Creation
+
+create User with TranslatedWords via nested attributes
+
+```ruby
+user = User.create(first_names_attributes: [{locale: 'en', value: 'John'}, {locale: 'ja', "ジョン"}],
+                   last_names_attributes: [{locale: 'en', value: 'Lennon'}, {locale: 'ja', "レノン"}])
+```
+
+### Access
+
+list of translated words
+
+```ruby
+user.first_names
+#=> [<TranslatedWord locale: "en", value: "John">, <TranslatedWord locale: "ja", value: "ジョン">]
+```
+
+access value with locale name
+
+```ruby
+user.first_name(:en)
+#=> "John"
+user.first_name(:ja)
+#=> "ジョン"
+```
+
+using default locale if locale name not given
+
+```ruby
+I18n.default_locale
+#=> :en
+user.last_name
+#=> "Lennon"
+
+I18n.default_locale = :ja
+#=> :ja
+user.last_name
+#=> "レノン"
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/masarakki/translatable/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+

data/lib/ar-translatable.rb

@@ -0,0 +1 @@
+require 'translatable'

data/lib/generators/translatable/migration_generator.rb

@@ -0,0 +1,17 @@
+require 'rails/generators/active_record'
+
+module Translatable
+  class MigrationGenerator < ::Rails::Generators::Base
+    include Rails::Generators::Migration
+    source_root File.expand_path('../templates', __FILE__)
+
+    desc 'Install migration file'
+    def install
+      migration_template 'migration.rb', 'db/migrate/create_translated_words.rb'
+    end
+
+    def self.next_migration_number(dirname)
+      ActiveRecord::Generators::Base.next_migration_number(dirname)
+    end
+  end
+end

data/lib/generators/translatable/templates/migration.rb

@@ -0,0 +1,13 @@
+class CreateTranslatedWords < ActiveRecord::Migration
+  def change
+    create_table(:translated_words) do |t|
+      t.string  :translatable_type, null: false
+      t.integer :translatable_id, null: false
+      t.string  :key, null: false
+      t.string  :locale, null: false
+      t.string  :value, null: false
+      t.index [:translatable_type, :translatable_id, :key, :locale], name: 'translated_word', unique: true
+      t.timestamps
+    end
+  end
+end

data/lib/translatable.rb

@@ -0,0 +1,7 @@
+require "translatable/version"
+require "translatable/acts_as_translatable"
+require "translatable/railtie" if defined? Rails
+require "translatable/translated_word" if defined? ActiveRecord
+
+module Translatable
+end

data/lib/translatable/acts_as_translatable.rb

@@ -0,0 +1,19 @@
+require 'active_support/concern'
+
+module Translatable
+  module ActsAsTranslatable
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def translatable(column)
+        key_name = column.to_s.pluralize.to_sym
+        has_many key_name, -> { where(key: column.to_s) }, :as => :translatable, class_name: 'Translatable::TranslatedWord',
+        :inverse_of => :translatable, :dependent => :destroy
+        accepts_nested_attributes_for key_name
+        define_method column do |locale = I18n.default_locale|
+          send(key_name).detect{|w| w.locale.to_s == locale.to_s }.try(:value)
+        end
+      end
+    end
+  end
+end

data/lib/translatable/railtie.rb

@@ -0,0 +1,7 @@
+module Translatable
+  class Railtie < ::Rails::Railtie
+    initializer "translatable.initialize" do
+      ActiveRecord::Base.include Translatable::ActsAsTranslatable
+    end
+  end
+end

data/lib/translatable/translated_word.rb

@@ -0,0 +1,12 @@
+module Translatable
+  class TranslatedWord < ActiveRecord::Base
+    self.table_name = :translated_words
+
+    validates :translatable, presence: true
+    validates :key,          presence: true
+    validates :locale,       presence: true, uniqueness: { scope: [:translatable_type, :translatable_id, :key] }
+    validates :value,        presence: true
+
+    belongs_to :translatable, polymorphic: true
+  end
+end

data/lib/translatable/version.rb

@@ -0,0 +1,3 @@
+module Translatable
+  VERSION = "0.0.1"
+end

data/spec/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/models/user.rb

@@ -0,0 +1,4 @@
+class User < ActiveRecord::Base
+  translatable :first_name
+  translatable :last_name
+end

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/spec/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/spec/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/spec/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/spec/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment',  __FILE__)
+run Rails.application

data/spec/dummy/config/application.rb

@@ -0,0 +1,22 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require(*Rails.groups)
+require "translatable"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+  end
+end

data/spec/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/spec/dummy/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+#
+default: &default
+  adapter: sqlite3
+  pool: 5
+  timeout: 5000
+
+development:
+  <<: *default
+  database: db/development.sqlite3
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  <<: *default
+  database: db/test.sqlite3
+
+production:
+  <<: *default
+  database: db/production.sqlite3