translatable_records 1.0.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 483bcb525853842c890f60d0a302627951f39c30
+  data.tar.gz: 291162c9fc9494e145a5cda54e400fb879258e87
+SHA512:
+  metadata.gz: e600cdf3023c1ab5cebb201f8de927700a9f74f97f6d100f00ffe302c2dfbb8ee6587e9bbc5c912d5a1d2b29d8d47c02a87b98a42bc303a7aaa2f3de8ef416ec
+  data.tar.gz: 9b8758d9bd6d588d69f27c31fb4d7e42ad40f6232a54f25c2170eaf41ff1191834e1801990ffd8384c547ef0b2acac0ec7cf0e6181452f04b467f76581faa42d

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 Mattways
+
+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.rdoc

@@ -0,0 +1,52 @@
+{<img src="https://codeclimate.com/github/mattways/translatable_records.png" />}[https://codeclimate.com/github/mattways/translatable_records] {<img src="https://secure.travis-ci.org/mattways/translatable_records.png?branch=master" alt="Build Status" />}[https://travis-ci.org/mattways/translatable_records] {<img src="https://gemnasium.com/mattways/translatable_records.png" alt="Dependency Status" />}[https://gemnasium.com/mattways/translatable_records]
+
+= Translatable Records
+
+Everything you need to work with translatable records.
+
+= Install
+
+Put this line in your Gemfile:
+  gem 'translatable_records'
+  
+Then bundle:
+  $ bundle
+  
+= Usage
+
+First define the model and set the name of the fields you want to translate with the attr_translatable method:
+  attr_translatable :attr
+
+Generate the translation model and migration for that model:
+  rails g translation Model
+  
+Update the translation migration with the column for that field and remove the column from the original table:
+  t.string :attr
+  
+Update your db:
+  rake db:migrate
+  
+(Now you can use that field of the model as usual and any change would be saved using the current I18n.locale) 
+
+If you want to build a translation for each available locale:
+  model_instance.build_translations
+
+If you want to get another translation:
+  model_instance.translation_by_locale :es
+
+If you want to change the locale to something different than I18n.locale:
+  model_instance.with_locale :es
+  
+If you want to save multiple translations:
+  <%= f.fields_for 'translations_attributes[]', t do |ff| %>
+    <%= field_set_tag t("languages.#{t.locale}") do %>
+      <% unless t.new_record? %>
+        <%= ff.hidden_field :id %>
+      <% end %>
+      <%= ff.hidden_field :locale %>
+      <li>
+        <%= ff.label :attr %>
+        <%= ff.text_field :attr %>
+      </li>
+    <% end %>
+  <% end %>

data/Rakefile

@@ -0,0 +1,32 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'TranslatableRecords'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

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

@@ -0,0 +1,12 @@
+class <%= "Create#{singular_name.camelize}Translations" %> < ActiveRecord::Migration
+  def change
+    create_table <%= ":#{singular_table_name}_translations" %> do |t|
+      t.integer <%= ":#{singular_table_name}_id" %>
+      t.string :locale
+
+      t.timestamps 
+    end
+    add_index <%= ":#{singular_table_name}_translations" %>, <%= ":#{singular_table_name}_id" %>
+    add_index <%= ":#{singular_table_name}_translations" %>, :locale
+  end
+end

data/lib/generators/templates/model.rb.erb

@@ -0,0 +1,13 @@
+class <%= "#{class_name}Translation" %> < ActiveRecord::Base
+  <% if Rails::VERSION::MAJOR < 4 %>  
+
+    attr_accessible :locale, <%= ":#{singular_table_name}_id" %>, <%= @model ? @model.translatable_attrs.map{ |a| ":#{a}" }.join(', ') : '' %>
+
+  <% end %>
+  belongs_to <%= ":#{table_name}" %>
+  
+  validates :locale, presence: true    
+  validates :locale, inclusion: { in: I18n.available_locales.map(&:to_s) }
+  validates <%= ":#{singular_table_name}_id" %>, uniqueness: { scope: :locale }  
+  
+end

data/lib/generators/translation_generator.rb

@@ -0,0 +1,21 @@
+require 'rails/generators'
+
+class TranslationGenerator < Rails::Generators::NamedBase
+  include Rails::Generators::Migration
+
+  source_root File.expand_path('../templates', __FILE__)
+  
+  def create_model
+    @model = Object.const_get(class_name)
+    template 'model.rb.erb', "app/models/#{file_name}_translation.rb"
+  end
+  
+  def create_migration
+    migration_template 'migration.rb.erb', "db/migrate/create_#{singular_table_name}_translations.rb"
+  end
+  
+  def self.next_migration_number(path)
+    Time.now.utc.strftime '%Y%m%d%H%M%S'
+  end  
+  
+end

data/lib/translatable_records/active_record/base.rb

@@ -0,0 +1,59 @@
+module TranslatableRecords
+  module ActiveRecord
+    module Base
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+
+        def translatable?
+          reflections.has_key? :translations
+        end
+     
+        def translatable_attrs
+          @translatable_attrs ||= []
+        end
+
+        def attr_translatable(*args)
+          make_translatable unless translatable?
+          args.each do |name| 
+            define_translatable_attribute_methods(name)
+            translatable_attrs << name
+          end
+        end 
+
+        protected
+
+        def make_translatable
+          send :include, TranslatableRecords::ActiveRecord::Translatable
+          default_scope -> { includes(:translations) }
+          attr_accessible :translations_attributes if Rails::VERSION::MAJOR < 4
+          has_many :translations, class_name: "#{name}Translation", autosave: true, dependent: :destroy    
+          accepts_nested_attributes_for :translations                                        
+        end
+
+        def define_translatable_attribute_methods(attr)
+          ['set', 'get'].each { |method| send "define_translatable_attribute_method_#{method}", attr }
+        end
+
+        def define_translatable_attribute_method_set(attr)
+          method_name = :"#{attr}="
+          define_method method_name do |value|  
+            t = translation_by_locale(current_locale)
+            t ? t.send(method_name, value) : translations.build(locale: current_locale.to_s, attr.to_sym => value)        
+          end        
+        end
+
+        def define_translatable_attribute_method_get(attr)
+          ['', '_was', '_changed?'].each do |suffix|
+            method_name = :"#{attr}#{suffix}"
+            define_method method_name do
+              t = translation_by_locale(current_locale)
+              t ? t.send(method_name) : nil
+            end           
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/translatable_records/active_record/translatable.rb

@@ -0,0 +1,30 @@
+module TranslatableRecords
+  module ActiveRecord
+    module Translatable
+      extend ActiveSupport::Concern
+      
+      def with_locale(locale)
+        @locale = locale
+      end
+      
+      def build_translations
+        I18n.available_locales.each do |locale| 
+          t = translations.find_by_locale(locale)
+          translations.build locale: locale.to_s unless t
+        end
+      end   
+      
+      protected
+      
+      def current_locale
+        defined?(@locale).nil? ? I18n.locale.to_s : @locale
+      end
+      
+      def translation_by_locale(locale)
+        t = translations.find { |t| t.locale == locale.to_s }
+        t ? t : translations.find_by_locale(locale)
+      end
+      
+    end
+  end
+end

data/lib/translatable_records/railtie.rb

@@ -0,0 +1,9 @@
+module TranslatableRecords
+  class Railtie < Rails::Railtie
+
+    initializer 'translatable_records' do
+      ::ActiveRecord::Base.send :include, TranslatableRecords::ActiveRecord::Base
+    end
+
+  end
+end

data/lib/translatable_records/version.rb

@@ -0,0 +1,5 @@
+module TranslatableRecords
+
+  VERSION = '1.0.6'
+
+end

data/lib/translatable_records.rb

@@ -0,0 +1,7 @@
+require 'translatable_records/active_record/base'
+require 'translatable_records/active_record/translatable'
+require 'translatable_records/railtie'
+require 'translatable_records/version'
+
+module TranslatableRecords
+end

data/test/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/test/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__)
+
+Dummy::Application.load_tasks

data/test/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/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,13 @@
+/*
+ * 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 top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/test/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/test/dummy/app/helpers/application_helper.rb

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

data/test/dummy/app/models/model.rb

@@ -0,0 +1,3 @@
+class Model < ActiveRecord::Base
+  attr_translatable :name
+end

data/test/dummy/app/models/model_translation.rb

@@ -0,0 +1,9 @@
+class ModelTranslation < ActiveRecord::Base
+  
+  belongs_to :models
+  
+  validates :locale, presence: true    
+  validates :locale, inclusion: { in: I18n.available_locales.map(&:to_s) }
+  validates :model_id, uniqueness: { scope: :locale }  
+  
+end

data/test/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/test/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/test/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/test/dummy/bin/rake

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

data/test/dummy/config/application.rb

@@ -0,0 +1,23 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require(*Rails.groups)
+require "translatable_records"
+
+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/test/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.exists?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/test/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'
+development:
+  adapter: sqlite3
+  database: db/development.sqlite3
+  pool: 5
+  timeout: 5000
+
+# 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:
+  adapter: sqlite3
+  database: ":memory:"
+  pool: 5
+  timeout: 5000
+
+production:
+  adapter: sqlite3
+  database: db/production.sqlite3
+  pool: 5
+  timeout: 5000

data/test/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require File.expand_path('../application', __FILE__)
+
+# Initialize the Rails application.
+Dummy::Application.initialize!

data/test/dummy/config/environments/development.rb

@@ -0,0 +1,29 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send.
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+  # Raise an error on page load if there are pending migrations
+  config.active_record.migration_error = :page_load
+
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  config.assets.debug = true
+end

data/test/dummy/config/environments/production.rb

@@ -0,0 +1,80 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # Code is not reloaded between requests.
+  config.cache_classes = true
+
+  # Eager load code on boot. This eager loads most of Rails and
+  # your application in memory, allowing both thread web servers
+  # and those relying on copy on write to perform better.
+  # Rake tasks automatically ignore this option for performance.
+  config.eager_load = true
+
+  # Full error reports are disabled and caching is turned on.
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+
+  # Enable Rack::Cache to put a simple HTTP cache in front of your application
+  # Add `rack-cache` to your Gemfile before enabling this.
+  # For large-scale production use, consider using a caching reverse proxy like nginx, varnish or squid.
+  # config.action_dispatch.rack_cache = true
+
+  # Disable Rails's static asset server (Apache or nginx will already do this).
+  config.serve_static_assets = false
+
+  # Compress JavaScripts and CSS.
+  config.assets.js_compressor = :uglifier
+  # config.assets.css_compressor = :sass
+
+  # Do not fallback to assets pipeline if a precompiled asset is missed.
+  config.assets.compile = false
+
+  # Generate digests for assets URLs.
+  config.assets.digest = true
+
+  # Version of your assets, change this if you want to expire all your assets.
+  config.assets.version = '1.0'
+
+  # Specifies the header that your server uses for sending files.
+  # config.action_dispatch.x_sendfile_header = "X-Sendfile" # for apache
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for nginx
+
+  # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
+  # config.force_ssl = true
+
+  # Set to :debug to see everything in the log.
+  config.log_level = :info
+
+  # Prepend all log lines with the following tags.
+  # config.log_tags = [ :subdomain, :uuid ]
+
+  # Use a different logger for distributed setups.
+  # config.logger = ActiveSupport::TaggedLogging.new(SyslogLogger.new)
+
+  # Use a different cache store in production.
+  # config.cache_store = :mem_cache_store
+
+  # Enable serving of images, stylesheets, and JavaScripts from an asset server.
+  # config.action_controller.asset_host = "http://assets.example.com"
+
+  # Precompile additional assets.
+  # application.js, application.css, and all non-JS/CSS in app/assets folder are already added.
+  # config.assets.precompile += %w( search.js )
+
+  # Ignore bad email addresses and do not raise email delivery errors.
+  # Set this to true and configure the email server for immediate delivery to raise delivery errors.
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation can not be found).
+  config.i18n.fallbacks = true
+
+  # Send deprecation notices to registered listeners.
+  config.active_support.deprecation = :notify
+
+  # Disable automatic flushing of the log to improve performance.
+  # config.autoflush_log = false
+
+  # Use default logging formatter so that PID and timestamp are not suppressed.
+  config.log_formatter = ::Logger::Formatter.new
+end

data/test/dummy/config/environments/test.rb

@@ -0,0 +1,36 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # The test environment is used exclusively to run your application's
+  # test suite. You never need to work with it otherwise. Remember that
+  # your test database is "scratch space" for the test suite and is wiped
+  # and recreated between test runs. Don't rely on the data there!
+  config.cache_classes = true
+
+  # Do not eager load code on boot. This avoids loading your whole application
+  # just for the purpose of running a single test. If you are using a tool that
+  # preloads Rails for running tests, you may have to set it to true.
+  config.eager_load = false
+
+  # Configure static asset server for tests with Cache-Control for performance.
+  config.serve_static_assets  = true
+  config.static_cache_control = "public, max-age=3600"
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Raise exceptions instead of rendering exception templates.
+  config.action_dispatch.show_exceptions = false
+
+  # Disable request forgery protection in test environment.
+  config.action_controller.allow_forgery_protection = false
+
+  # Tell Action Mailer not to deliver emails to the real world.
+  # The :test delivery method accumulates sent emails in the
+  # ActionMailer::Base.deliveries array.
+  config.action_mailer.delivery_method = :test
+
+  # Print deprecation notices to the stderr.
+  config.active_support.deprecation = :stderr
+end

data/test/dummy/config/initializers/backtrace_silencers.rb

@@ -0,0 +1,7 @@
+# Be sure to restart your server when you modify this file.
+
+# You can add backtrace silencers for libraries that you're using but don't wish to see in your backtraces.
+# Rails.backtrace_cleaner.add_silencer { |line| line =~ /my_noisy_library/ }
+
+# You can also remove all the silencers if you're trying to debug a problem that might stem from framework code.
+# Rails.backtrace_cleaner.remove_silencers!

data/test/dummy/config/initializers/filter_parameter_logging.rb

@@ -0,0 +1,4 @@
+# Be sure to restart your server when you modify this file.
+
+# Configure sensitive parameters which will be filtered from the log file.
+Rails.application.config.filter_parameters += [:password]

data/test/dummy/config/initializers/inflections.rb

@@ -0,0 +1,16 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new inflection rules using the following format. Inflections
+# are locale specific, and you may define rules for as many different
+# locales as you wish. All of these examples are active by default:
+# ActiveSupport::Inflector.inflections(:en) do |inflect|
+#   inflect.plural /^(ox)$/i, '\1en'
+#   inflect.singular /^(ox)en/i, '\1'
+#   inflect.irregular 'person', 'people'
+#   inflect.uncountable %w( fish sheep )
+# end
+
+# These inflection rules are supported but not enabled by default:
+# ActiveSupport::Inflector.inflections(:en) do |inflect|
+#   inflect.acronym 'RESTful'
+# end

data/test/dummy/config/initializers/mime_types.rb

@@ -0,0 +1,5 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new mime types for use in respond_to blocks:
+# Mime::Type.register "text/richtext", :rtf
+# Mime::Type.register_alias "text/html", :iphone