translatable_records 1.1.7 → 4.0.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b4228adff17f8b8ab53b85eef95a3be51440a541
-  data.tar.gz: c1e619dddbbb566e976e8e48d39273f05678efe6
+  metadata.gz: 0aa7a3637f4a3e85e9a73392989ab14fb3b3256f
+  data.tar.gz: bee2ea776f4f3075ec6b14f65969485d29eeac94
 SHA512:
-  metadata.gz: 9d776770cbb1a7cdf6d407809df5804714f5ee5516e1e587c19ad64b02adfc3c414b3ff8ab175f18780af4351db2d737728dedc81e1a9468e77fa81936021282
-  data.tar.gz: 28c8cc5576f218722edc70e486d658d85a3cbfb26c3fca641bedf7cd98748162d4737568c74ef0750c29da2e5db15ebd602aa297c48a97fc6b563af7b91e67b8
+  metadata.gz: 9dd0bd41b405a1cd70f046903ab7229682c0b31bf5beb30d63f456cbf0fef69405e10b326fef5b897f678ac713d91ef6560b6b6640f2490d1645ff0432f209f2
+  data.tar.gz: 192a617012a83f7fe36357ce3bcf60953d6624255b1b290256ed1b70e49b4810cbad79cca3ad982b9da13fc49495567acbe9ace667caf3eaf79ba4adc573650a

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2015 Mathías Montossi
+Copyright 2016 Mathías Montossi
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -5,7 +5,15 @@
 
 # Translatable Records
 
-Minimalistic toolkit to work with translatable records in rails.
+Fully customizable record translations for rails.
+
+## Why
+
+I did this gem to:
+
+- Have the freedom to customize the translation model.
+- Avoid duplication by delegate translatable attributes directly to translation model.
+- Use translations other than I18n.available_locales.
 
 ## Install
 
@@ -21,49 +29,45 @@ $ bundle
 
 ## Configuration
 
-Define wich attributes will be translatable with the attr_translatable in your models:
+Define wich attributes will be translated in the model:
 ```ruby
-attr_translatable :attr
+class Product < ActiveRecord::Base
+  translate :name
+end
 ```
 
-Generate the translation model and migration for them:
+Generate the translation and migration:
 ```
-rails g translation model
-```
-
-Complete the migrations adding the columns for each field in the translatations tables:
-```ruby
-add_column :model_translations, :attr, :string
-```
-
-Remove the original column from models table:
-```ruby
-remove_column :models, :attr
+$ bundle exec rails g translation product
 ```
 
 Update your db:
 ```
-rake db:migrate
+$ bundle exec rake db:migrate
 ```
 
 ## Usage
 
-If you want to change the locale to something different than I18n.locale:
+### Accessors
+
+By default will use I18n.locale but you can change it:
 ```ruby
-record.with_locale :es
+product.locale = :en
 ```
 
-If you want to build a translation for each available locale:
+Accessor continue working the same:
 ```ruby
-record.build_translations
+product.name = 'Phone'
 ```
 
+### Views
+
 If you want to save multiple translations:
 ```erb
 <%= f.fields_for :translations do |ff| %>
   <%= ff.hidden_field :locale %>
-  <%= ff.label :attr %>
-  <%= ff.text_field :attr %>
+  <%= ff.label :name %>
+  <%= ff.text_field :name %>
 <% end %>
 ```
 

data/Rakefile

@@ -4,19 +4,6 @@ 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'
@@ -26,7 +13,7 @@ Rake::TestTask.new(:test) do |t|
   t.libs << 'test'
   t.pattern = 'test/**/*_test.rb'
   t.verbose = false
+  t.warning = false
 end
 
-
 task default: :test

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

@@ -0,0 +1,14 @@
+class Create<%= class_name %>Translations < ActiveRecord::Migration
+  def change
+    create_table :<%= singular_table_name %>_translations do |t|
+      t.integer :<%= singular_table_name %>_id
+      t.string :locale
+      <%- @attributes.each do |attribute| -%>
+      t.string :<%= attribute %>
+      <%- end -%>
+
+      t.timestamps null: false
+    end
+    add_index :<%= singular_table_name %>_translations, [:<%= singular_table_name %>_id, :locale], unique: true
+  end
+end

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

@@ -0,0 +1,8 @@
+class <%= class_name %>Translation < ActiveRecord::Base
+
+  belongs_to :<%= singular_table_name %>
+
+  validates_presence_of :locale
+  validates_uniqueness_of :<%= singular_table_name %>_id, scope: :locale
+
+end

data/lib/generators/translation/translation_generator.rb

@@ -0,0 +1,25 @@
+require 'rails/generators'
+
+module TranslatableRecords
+  module Generators
+    class TranslationGenerator < ::Rails::Generators::NamedBase
+      include Rails::Generators::Migration
+
+      source_root File.expand_path('../templates', __FILE__)
+
+      def create_model_file
+        template 'model.rb', "app/models/#{singular_table_name}_translation.rb"
+      end
+
+      def create_migration_file
+        @attributes = class_name.constantize.translations
+        migration_template 'migration.rb', "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
+  end
+end

data/lib/translatable_records/builder.rb

@@ -0,0 +1,66 @@
+module TranslatableRecords
+  class Builder
+
+    attr_reader :model, :concern
+
+    def initialize(model)
+      @model = model
+      @concern = Module.new
+    end
+
+    def define(attributes)
+      model.include Concern
+      ensure_association
+      attributes.each do |attribute|
+        define_writer attribute
+        define_readers attribute
+        model.translations << attribute
+      end
+      model.include concern
+    end
+
+    private
+
+    def ensure_association
+      unless model.reflections.has_key?(:translations)
+        model.has_many(
+          :translations,
+          class_name: "#{model.name}Translation",
+          dependent: :destroy
+        )
+        model.accepts_nested_attributes_for :translations
+      end
+    end
+
+    def define_writer(attribute)
+      name = "#{attribute}="
+      concern.class_eval do
+        define_method name do |value|
+          if translation = find_translation(locale)
+            translation.send name, value
+          else
+            translations.build(locale: locale, attribute => value)
+          end
+        end
+      end
+    end
+
+    def define_readers(attribute)
+      names = [
+        attribute,
+        "#{attribute}_was",
+        "#{attribute}_changed?",
+        "#{attribute}_before_type_cast",
+        "#{attribute}_came_from_user?"
+      ]
+      concern.class_eval do
+        names.each do |name|
+          define_method name do
+            find_translation(locale).try name
+          end
+        end
+      end
+    end
+
+  end
+end

data/lib/translatable_records/concern.rb

@@ -0,0 +1,22 @@
+module TranslatableRecords
+  module Concern
+    extend ActiveSupport::Concern
+
+    def locale=(value)
+      if value.present?
+        @locale = value.to_s
+      else
+        @locale = nil
+      end
+    end
+
+    def locale
+      @locale || I18n.locale.to_s
+    end
+
+    def find_translation(locale)
+      translations.to_a.group_by(&:locale)[locale.to_s].try :first
+    end
+
+  end
+end

data/lib/translatable_records/extensions/active_record/base.rb

@@ -0,0 +1,26 @@
+module TranslatableRecords
+  module Extensions
+    module ActiveRecord
+      module Base
+        extend ActiveSupport::Concern
+
+        module ClassMethods
+
+          def translatable?
+            translations.any?
+          end
+
+          def translations
+            @translations ||= []
+          end
+
+          def translate(*attributes)
+            builder = Builder.new(self)
+            builder.define attributes
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/translatable_records/railtie.rb

@@ -1,8 +1,10 @@
 module TranslatableRecords
   class Railtie < Rails::Railtie
 
-    initializer 'translatable_records' do
-      ::ActiveRecord::Base.send :include, TranslatableRecords::ActiveRecord::Base
+    initializer 'translatable_records.extensions' do
+      ::ActiveRecord::Base.include(
+        TranslatableRecords::Extensions::ActiveRecord::Base
+      )
     end
 
   end

data/lib/translatable_records/version.rb

@@ -1,5 +1,5 @@
 module TranslatableRecords
 
-  VERSION = '1.1.7'
+  VERSION = '4.0.0.0'
 
 end

data/lib/translatable_records.rb

@@ -1,6 +1,8 @@
-require 'translatable_records/active_record/base'
-require 'translatable_records/active_record/translatable'
+require 'translatable_records/extensions/active_record/base'
+require 'translatable_records/builder'
+require 'translatable_records/concern'
 require 'translatable_records/railtie'
+require 'translatable_records/version'
 
 module TranslatableRecords
 end

data/test/dummy/Rakefile

@@ -2,5 +2,4 @@
 # 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
+Rails.application.load_tasks

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

@@ -2,12 +2,12 @@
 // 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.
+// or any plugin's vendor/assets/javascripts directory 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
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
 // about supported directives.
 //
 //= require_tree .

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

@@ -3,11 +3,13 @@
  * 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.
+ * or any plugin's vendor/assets/stylesheets directory 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.
+ * 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_self
  *= require_tree .
+ *= require_self
  */

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

@@ -0,0 +1,5 @@
+class Product < ActiveRecord::Base
+
+  translate :name
+
+end

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

@@ -0,0 +1,8 @@
+class ProductTranslation < ActiveRecord::Base
+
+  belongs_to :product
+
+  validates_presence_of :locale
+  validates_uniqueness_of :product_id, scope: :locale
+
+end

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

@@ -1,14 +1,12 @@
 <!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>
+  <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

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

data/test/dummy/bin/rails

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

data/test/dummy/bin/rake

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