rails_db_localize 0.0.1

data/lib/ext/migration_ext.rb

@@ -0,0 +1,21 @@
+class ActiveRecord::Migration
+  def create_rails_db_localize_translations
+    self.create_table :rails_db_localize_translations do |t|
+        t.string :resource_type, index: true
+        t.integer :resource_id, index: true
+
+        t.string :field, index: true
+        t.string :lang, index: true
+        t.integer :compound_key, index: true
+
+        t.text :content
+        t.timestamp
+    end
+
+    add_index :rails_db_localize_translations, [:resource_id, :resource_type], name: "index_rdblt_it"
+    add_index :rails_db_localize_translations, [:resource_id, :resource_type, :field], name: "index_rdblt_itf"
+    add_index :rails_db_localize_translations, [:resource_id, :resource_type, :field, :lang], name: "index_rdblt_itfl"
+    add_index :rails_db_localize_translations, [:compound_key, :field], name: "index_rdblt_cf"
+    add_index :rails_db_localize_translations, [:compound_key, :field, :lang], name: "index_rdblt_cfl"
+  end
+end

data/lib/rails_db_localize.rb

@@ -0,0 +1,37 @@
+module RailsDbLocalize
+  class << self
+    @schema = {}
+
+    # This is the schematics of fields
+    # Useful for rake tasks after, to know:
+    #   - Which rows are not used anymore (because the field name has changed for example)
+    #   - Which models are not yet translated
+    attr_reader :schema
+
+    def add_to_schema model, field
+      @schema ||= {}
+      @schema[model.to_s] ||= []
+      @schema[model.to_s] << field
+    end
+
+    def load!
+      %w(app/models).each do |dir|
+        path = File.join(File.expand_path('../..', __FILE__), dir )
+        $LOAD_PATH << path
+        ActiveSupport::Dependencies.autoload_paths << path
+        ActiveSupport::Dependencies.autoload_once_paths.delete(path)
+      end
+    end
+  end
+end
+
+def __rdbl_require(*args)
+  args.each do |path|
+    require File.join(File.expand_path("..", __FILE__), path)
+  end
+end
+
+__rdbl_require 'rails_db_localize/translation_cache'
+__rdbl_require 'ext/active_record_ext', 'ext/controller_ext', 'ext/migration_ext'
+
+RailsDbLocalize::load!

data/lib/rails_db_localize/translation_cache.rb

@@ -0,0 +1,79 @@
+class RailsDbLocalize::TranslationCache
+  class << self
+    def reinit
+      @instance = nil
+    end
+
+    def instance
+      @instance ||= self.new
+    end
+  end
+
+protected
+  def initialize
+    @cache = { :data => {}, :cks => {} }
+  end
+
+  def encache plucked
+    plucked.each do |rt_ri_f_l_c|
+      rt,ri,f, l,c = rt_ri_f_l_c #ressource_type, ressource_id, field, lang and content
+      @cache[:data][rt]          ||= {}
+      @cache[:data][rt][ri]      ||= {}
+      @cache[:data][rt][ri][l]   ||= {}
+      @cache[:data][rt][ri][l][f] = c
+    end
+  end
+
+  def is_cached *cks
+    cks.each{ |ck| @cache[:cks][ck] ||= true }
+  end
+
+public
+  # For debug purpose only
+  attr_reader :cache
+
+  def prefetch_collections *collections
+    # empty string is used here to be sure there's at least one element
+    # for IN clause in SQL (otherwise it will fail miserabily)
+    in_clause = collections.inject([""]) do |arr, collection|
+      klass = if collection.respond_to?(:klass)
+        collection.klass #is a ActiveRecord::Relation
+      else
+        # Tricky part. sometimes using "all" the collection is already
+        # fetched. And there's not really anything to do to get the scope again. except mapping of the primary
+        # key but seems tricky, so I prefer raise an error.
+        if collection.is_a?(Array)
+          raise
+            "You're trying to get translations from a collection which is already fetched (SQL request already sent). " +
+            "This is happening when you are using map/each/all on the request. Please use the translation cache fetching before the request is sent."
+        else
+          collection # This is the model
+        end
+      end
+
+      arr + collection.pluck(klass.primary_key).map do |x|
+        RailsDbLocalize::Translation.generate_ck(klass, x)
+      end
+    end
+
+    is_cached(*in_clause)
+    encache RailsDbLocalize::Translation.where("compound_key IN (?)", in_clause).pluck(:resource_type, :resource_id, :field, :lang, :content)
+  end
+
+  def get_translation_for model_class, model_id, field, lang, default
+    ck = RailsDbLocalize::Translation.generate_ck(model_class, model_id)
+
+    if @cache[:cks][ck]
+      #Prefetch was done. Check if there's a value
+      @cache[:data][model_class.to_s].try(:[], model_id).try(:[], lang.to_s).try(:[], field.to_s) || default
+    else
+      #Do the query if no prefetch was done
+      RailsDbLocalize::Translation.where(
+        resource_type: model_class.to_s, resource_id: model_id, field: field, lang: lang
+        ).select(:content).first.try(:content) || default
+      # BTW We don't cache it now since a cache is done into ActiveRecord core...
+    end
+
+  end
+
+end

data/lib/rails_db_localize/version.rb

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

data/lib/tasks/rails_db_localize_tasks.rake

@@ -0,0 +1,11 @@
+# desc "Explaining what the task does"
+# task :rails_db_localize do
+#   # Task goes here
+# end
+
+#namespace :rails_db_localize do
+#  desc "Remove the orphans in the translations"
+#  task :delete_orphans => :environment do
+#    raise "TODO"
+#  end
+#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__)
+
+Rails.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 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/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

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

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

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

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

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/controllers/translatables_controller.rb

@@ -0,0 +1,16 @@
+class TranslatablesController < ApplicationController
+  def index
+    @translatables = Translatable.all
+    preload_translations_for(@translatables)
+  end
+
+  def set_tr
+    require 'faker'
+
+    @translatable = Translatable.find(params[:id])
+    @translatable.name_translated = Faker::Lorem.paragraph, params[:lang]
+    @translatable.save!
+
+    redirect_to "/"
+  end
+end

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

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

data/test/dummy/app/helpers/translatables_helper.rb

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

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

@@ -0,0 +1,3 @@
+class Translatable < ActiveRecord::Base
+  has_translations :name
+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/app/views/translatables/index.html.erb

@@ -0,0 +1,36 @@
+<div>
+  <h1>Test Translatable</h1>
+  <h2>Schema:</h2>
+  <pre>
+  <%= RailsDbLocalize::schema.inspect %>
+  </pre>
+  <h2>TR Table:</h2>
+  <pre><%= RailsDbLocalize::Translation.all.pluck(:id, :compound_key, :field, :lang, :content).map{|x| x.inspect}.join("\n") %></pre>
+  <h2>Cache info:</h2>
+  <pre><%= RailsDbLocalize::TranslationCache.instance.cache %></pre>
+  <h2>Table info:</h2>
+  <table>
+    <thead>
+      <th>ID</th>
+      <th>Name</th>
+      <th>TR EN</th>
+      <th>TR ES</th>
+      <th>TR FR</th>
+      <th>Actions</th>
+    </thead>
+    <% @translatables.each do |t| %>
+    <tr>
+      <td><%= t.id %></td>
+      <td><%= t.name %></td>
+      <td><%= t.name_translated %></td>
+      <td><%= t.name_translated(:es) %></td>
+      <td><%= t.name_translated(:fr) %></td>
+      <td>
+        <a href="/set_tr/<%=t.id%>/en">GEN EN</a>
+        <a href="/set_tr/<%=t.id%>/es">GEN ES</a>
+        <a href="/set_tr/<%=t.id%>/fr">GEN FR</a>
+      </td>
+    </tr>
+    <% end %>
+  </table>
+</div>

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/bin/setup

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+require 'pathname'
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../',  __FILE__)
+
+Dir.chdir APP_ROOT do
+  # This script is a starting point to setup your application.
+  # Add necessary setup steps to this file:
+
+  puts "== Installing dependencies =="
+  system "gem install bundler --conservative"
+  system "bundle check || bundle install"
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?("config/database.yml")
+  #   system "cp config/database.yml.sample config/database.yml"
+  # end
+
+  puts "\n== Preparing database =="
+  system "bin/rake db:setup"
+
+  puts "\n== Removing old logs and tempfiles =="
+  system "rm -f log/*"
+  system "rm -rf tmp/cache"
+
+  puts "\n== Restarting application server =="
+  system "touch tmp/restart.txt"
+end

data/test/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/test/dummy/config/application.rb

@@ -0,0 +1,26 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require(*Rails.groups)
+require "rails_db_localize"
+
+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
+
+    # Do not swallow errors in after_commit/after_rollback callbacks.
+    config.active_record.raise_in_transactional_callbacks = true
+  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.exist?(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'
+#
+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