rails_db_localize 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b871138a311b81b19fe496d8ee8e5a24728d0d2d
+  data.tar.gz: 9fef4a09569e4063bb8aa9cc102a948306f5eb01
+SHA512:
+  metadata.gz: 25dff5f05e0d1c9d5d4a594c6317f60a869e25273a05cf42c272c6676f80d013a5304b303e0af626d38a161eb3de3821a618a0d6c466ecaed6997a338c00144a
+  data.tar.gz: 46dd58fb5744d3d084ac2c403a61a626456d00917e1ad552574dcf894b7f05fb1c59ca480325876b8f7e752db1f1b486199e397facd47c30d055cd9ea3f6a880

data/LICENSE

@@ -0,0 +1,202 @@
+                                 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
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

data/README.md

@@ -0,0 +1,100 @@
+# rails_db_localize
+
+Gem for managing translations of database objects without any pain
+
+# Why I've made this gem?
+
+In some translations project we used the globalize3 gem, but I wasn't really happy with it.
+The most annoying part is globalize3 create a table for each object you want to translate.
+
+I've made this gem with theses rules in head:
+
+## 1/ Translation just in time.
+
+You don't need to think about translation in your project until you begin the translation process.
+`rails_db_localize` doesn't modify your database schematic but instead just add a layer on it.
+
+## 2/ One table to bring them all.
+
+`rails_db_localize` add only one table to your project. All your translations are stored inside this table.
+This allow you to make without any pain a tool to manage a team of traductors for example. 
+
+Since everything is in the same table, one controller is enough to manage the translation process!
+About performance, `rails_db_localize` use some optimisations for fetching the rows (caching and hashing system).
+
+
+## 3/ Only one query for all your translations
+
+Thanks to the caching system, `rails_db_localize` need only one query to retrieve all the translations of your current view (see below)
+
+# Installation
+
+```Gemfile
+gem 'rails_db_localize'
+```
+
+You need to create a migration also, and put this inside:
+
+```ruby
+  def change
+    create_rails_db_localize_translations
+  end
+```
+
+Note: the migration process is reversible
+
+# Use of the gem
+
+Then just declare the stuff you want to translate:
+
+```ruby
+  #in your model.rb
+  has_translations :name, :comment #and everything you want...
+```
+
+Your code is still working the same way, but your model have now theses methods:
+
+```ruby
+  model.name_translated
+  model.comment_translated
+```
+
+By default, `rails_db_localize` will use the I18n.locale to find the current locale. You can force to show a special locale:
+
+```ruby
+  model.name_translated(:fr)
+```
+
+To create a new translation, you can use the setter with it:
+
+```ruby
+  model.name_translated = "Name in current 'I18n.locale'"
+```
+
+or:
+
+```ruby
+  model.name_translated = "Name in french", :fr
+```
+
+# SQL Optimisation
+
+To avoid N+1 requests, please use the preloader on every array of models you want to use:
+
+```ruby
+    @translatables = Translatable.all
+    @categories = Category.all
+    #Only one request per preload_translations_for call
+    preload_translations_for(@translatables, @categories)
+```
+
+# Changelog
+
+0.1 - First commit
+
+# Licensing
+
+Apache 2. Use it, fork it, have fun!
+
+Happy coding!
+

data/Rakefile

@@ -0,0 +1,30 @@
+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    = 'RailsDbLocalize'
+  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/app/models/rails_db_localize/translation.rb

@@ -0,0 +1,33 @@
+class RailsDbLocalize::Translation < ActiveRecord::Base
+  self.table_name = "rails_db_localize_translations"
+
+  belongs_to :resource, polymorphic: true
+
+  validates :resource_id, presence: true
+  validates :resource_type, presence: true
+  validates :field, presence: true
+  validates :lang, presence: true
+  validates :compound_key, presence: true
+
+  validates :content, uniqueness: { scope: [:lang, :field, :resource_type, :resource_id] }
+
+  scope :with_language, lambda { |x| where("lang LIKE ?", "#{x}%") }
+
+  before_validation :set_compound_key
+
+  def self.generate_ck resource_type, resource_id
+    #Keep it 32bits.
+    [resource_type.to_s.underscore, resource_id].join("|").hash & 0x7fffffff
+  end
+
+   def self.get_untranslated model, field, lang
+    model.where("id NOT IN (?)",
+      [-1, *RailsDbLocalize::Translation.where(resource_type: k.to_s, lang: lang, field: field).pluck(:resource_id).uniq]
+    )
+  end
+
+private
+  def set_compound_key
+    self.compound_key = RailsDbLocalize::Translation.generate_ck(resource_type, resource_id)
+  end
+end

data/lib/ext/active_record_ext.rb

@@ -0,0 +1,52 @@
+class ActiveRecord::Base
+  class << self
+
+    def has_translations *fields
+
+      unless @__rdbl_translations
+        @__rdbl_translations = true
+        # Register it mostly to remove the translations once you delete an object
+        self.has_many :translations, as: :resource, dependent: :destroy
+      end
+
+      fields.each do |field|
+        # Add a marker to the schema of the application translations.
+        RailsDbLocalize::add_to_schema(self, field)
+
+        # Not sure if I would have to put dependent: :destroy here.
+        self.has_many :"#{field}_translations", -> { where(field: field)  }, as: :resource
+
+        # Making the magic happends.
+        # I should really learn how to use the Reflection helpers in ActiveRecord, because
+        # ruby eval is not the most readable stuff... :o)
+        self.class_eval <<-CODE, __FILE__, __LINE__ + 1
+          def #{field}_translated (lang=nil)
+            lang ||= I18n.locale
+            RailsDbLocalize::TranslationCache.instance.get_translation_for(self.class, self.id, "#{field}", lang, self.#{field} )
+          end
+
+          def #{field}_translated= args
+            if args.is_a?(Array)
+              value, lang = args
+            else
+              value = args
+              lang = I18n.locale
+            end
+
+            if self.id
+              translated = RailsDbLocalize::Translation.where(
+                resource_type: self.class.to_s, resource_id: self.id,  field: "#{field}", lang: lang
+              ).first_or_create
+
+              translated.content = value
+
+              translated.save!
+            else
+              translations.build field: "#{field}", lang: lang, content: value
+            end
+          end
+        CODE
+      end
+    end
+  end
+end

data/lib/ext/controller_ext.rb

@@ -0,0 +1,19 @@
+require 'action_controller/base'
+
+class ActionController::Base
+
+  before_action :prepare_translation_cache
+
+  # Preload the translations string for all the collections.
+  # This allow to load all translation resources in only one SQL query.
+  # Take in consideration this will execute the request for
+  def preload_translations_for *collections
+    RailsDbLocalize::TranslationCache.instance.prefetch_collections(*collections)
+  end
+
+private
+  def prepare_translation_cache
+    RailsDbLocalize::TranslationCache.reinit
+    yield if block_given?
+  end
+end