para-i18n 0.3.1 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d5c764053878b2cba8adb8ed576917295f425e49
-  data.tar.gz: 872b3159ccda1fbc26dee0522318de70ea361bbe
+  metadata.gz: bffd454f68783dc4413fab9cff53b3c899b0f908
+  data.tar.gz: 783928239cee302a6e963057cc8f68becd744c8c
 SHA512:
-  metadata.gz: bec576e0856d55fef7fc941406886ed633cb9687c529e1958134bb39672b902c2ce9301ec47e5198a595e9ab8180c4291ef44a525d30bd135480c08067eac215
-  data.tar.gz: ef5efc77c67ec25580522c9a1abc4cc881012ac58a8b09c4c9e04be2856e996c82044e85f81e004f1224da6eefbdd81fd73fae63558fa61232278b17c88a8f2f
+  metadata.gz: aa848897075a6d40a94d92451e3b660e1c18aade214e90ca0a394d066b58dd03f3d143f6457f29e469b805215f37e451f21a093443f67cc7298b2bd8a7a047de
+  data.tar.gz: 3ce0e4a22d344090a9d98ba86fb505b778549e2a230d8e981b9288af8b0d16da180e8993d1b828c7d795d867092d01575c3a040e43e74f6f2c3c05ade9eaa975

data/app/views/para/admin/resources/_translations_form.html.haml

@@ -2,6 +2,8 @@
   = target_locale_select
 
   = form.fieldset do
+    = I18n.with_locale(@target_locale) { form.input :_disabled_for_locale, as: :boolean, label: t("para.i18n.disabled_for_locale") }
+
     - translated_model_fields_for(resource.class).each do |field|
       = form.input field.field_name, as: :i18n, locale: @target_locale
 

data/config/locales/para-i18n.fr.yml

@@ -4,3 +4,4 @@ fr:
       translate: "Traduire"
       translation: "Traduction"
       choose_locale: "Traduire en :"
+      disabled_for_locale: "Masquer pour la langue en cours"

data/lib/para/i18n.rb

@@ -8,6 +8,11 @@ require 'para/i18n/model'
 require 'para/i18n/resources_table'
 require 'para/i18n/resources_buttons'
 
+require 'para/i18n/attribute_translation'
+require 'para/i18n/attribute_translation/base'
+require 'para/i18n/attribute_translation/simple_attribute'
+require 'para/i18n/attribute_translation/attachment'
+
 require 'para/i18n/friendly_id'
 
 require 'para/i18n/i18n_input'

data/lib/para/i18n/attribute_translation.rb

@@ -0,0 +1,26 @@
+module Para
+  module I18n
+    # This module redirects the reading and writing of the translated attributes to the
+    # right attribute translation class
+    #
+    module AttributeTranslation
+      def self.read(locale, resource, attribute)
+        attribute_translation_class(locale, resource.class, attribute).read(resource)
+      end
+
+      def self.write(locale, resource, attribute, value)
+        attribute_translation_class(locale, resource.class, attribute).write(resource, value)
+      end
+
+      def self.attribute_translation_class(locale, model, attribute)
+        attribute_translation_class = if AttributeTranslation::Attachment.matches?(model, attribute)
+          AttributeTranslation::Attachment.new(locale, model, attribute)
+        else
+          AttributeTranslation::SimpleAttribute.new(locale, model, attribute)
+        end
+      end
+    end
+  end
+end
+
+

data/lib/para/i18n/attribute_translation/attachment.rb

@@ -0,0 +1,58 @@
+module Para
+  module I18n
+    module AttributeTranslation
+      class Attachment < Para::I18n::AttributeTranslation::Base
+        def read(resource)
+          attachment = resource.public_send(reflection_name)
+
+          if default_locale? || attachment.attached? || !fallback_locale
+            attachment
+          elsif fallback_locale
+            self.class.new(fallback_locale, model, attribute).read(resource)
+          end
+        end
+
+        def write(resource, value)
+          resource.public_send(:"#{reflection_name}=", value)
+        end
+
+        def self.matches?(model, attribute)
+          model.reflections.key?("#{attribute}_attachment") &&
+            model.reflections.key?("#{attribute}_blob")
+        end
+
+        def self.prepare(model, attribute)
+          return unless matches?(model, attribute)
+
+          (I18n.available_locales - [I18n.default_locale]).each do |locale|
+            new(locale, model, attribute).prepare_translated_attachment
+          end
+        end
+
+        def prepare_translated_attachment
+          model.alias_method(untranslated_getter_name, attribute)
+          model.alias_method(untranslated_setter_name, :"#{attribute}=")
+          model.has_one_attached(reflection_name)
+        end
+
+        private
+
+        def reflection_name
+          @reflection_name ||= if default_locale?
+            untranslated_getter_name
+          else
+            [attribute, locale, "translation"].join("_")
+          end
+        end
+
+        def untranslated_getter_name
+          @untranslated_getter_name ||= :"untranslated_#{attribute}"
+        end
+
+        def untranslated_setter_name
+          @untranslated_setter_name ||= :"untranslated_#{attribute}="
+        end
+      end
+    end
+  end
+end

data/lib/para/i18n/attribute_translation/base.rb

@@ -0,0 +1,23 @@
+module Para
+  module I18n
+    module AttributeTranslation
+      class Base
+        attr_reader :locale, :model, :attribute
+
+        def initialize(locale, model, attribute)
+          @locale = locale.to_s
+          @model = model
+          @attribute = attribute.to_s
+        end
+
+        def default_locale?
+          @default_locale ||= locale == I18n.default_locale.to_s
+        end
+
+        def fallback_locale
+          @fallback_locale ||= Para::I18n::Fallbacks.i18n_fallback_for(locale.to_sym)
+        end
+      end
+    end
+  end
+end

data/lib/para/i18n/attribute_translation/simple_attribute.rb

@@ -0,0 +1,37 @@
+module Para
+  module I18n
+    module AttributeTranslation
+      class SimpleAttribute < Para::I18n::AttributeTranslation::Base
+        def read(resource)
+          # Directly read the plain column / store accessor if the current locale is the
+          # default one..
+          if default_locale? && attribute != "_disabled_for_locale"
+            return resource.read_plain_or_store_attribute(attribute)
+          end
+
+          translations = resource.model_translations[locale]
+
+          if translations && (translation = translations[attribute])
+            translation
+          elsif fallback_locale
+            # If no translation was returned, try to fallback to the next locale
+            self.class.new(fallback_locale, model, attribute).read(resource)
+          end
+        end
+
+        def write(resource, value)
+          if default_locale? && attribute != "_disabled_for_locale"
+            return resource.write_plain_or_store_attribute(attribute, value)
+          end
+
+          # did not us ||= here to fix first assignation.
+          # Did not investigate on why ||= does not work
+          resource.model_translations[locale] = {} unless resource.model_translations[locale]
+          resource.model_translations[locale][attribute] = value
+          resource._translations_will_change!
+          value
+        end
+      end
+    end
+  end
+end

data/lib/para/i18n/engine.rb

@@ -8,6 +8,10 @@ module Para
       end
 
       initializer 'para.i18n.extend_para_routes' do
+        ::Para.config.routes.extend_routes_for(:component) do
+          resource :translation, only: [:edit, :update], controller: '/para/admin/translations'
+        end
+
         ::Para.config.routes.extend_routes_for(:crud_component) do
           resource :translation, only: [:edit, :update], controller: '/para/admin/translations'
         end
@@ -37,7 +41,7 @@ module Para
             icon: 'globe',
             label: ::I18n.t('para.i18n.translate'),
             url: @component.relation_path(resource, :translation, action: :edit)
-          } if resource.class.translates?
+          } if resource.class.translates? && can?(:translate, resource)
         end
       end
     end

data/lib/para/i18n/fallbacks.rb

@@ -1,12 +1,21 @@
 module Para
   module I18n
     module Fallbacks
+      mattr_accessor :_disable_fallbacks
+
+      def self.without_i18n_fallbacks(&block)
+        self._disable_fallbacks = true
+        block.call
+      ensure
+        self._disable_fallbacks = false
+      end
+
       def self.i18n_fallback_for(locale)
-        return unless ::I18n.respond_to?(:fallbacks)
+        return if _disable_fallbacks || !::I18n.respond_to?(:fallbacks)
 
         if (fallbacks = ::I18n.fallbacks[locale]) && fallbacks.length > 1
           fallbacks[1]
-        else
+        elsif locale != ::I18n.default_locale
           ::I18n.default_locale
         end
       end

data/lib/para/i18n/friendly_id.rb

@@ -10,6 +10,15 @@ module FriendlyId
       def included(model_class)
         model_class.extend(ClassMethods)
 
+        # Support for I18n finder methods on ActiveRecord::Relation of the including
+        # model. Example :
+        model_class.instance_eval do
+          relation.class.send(:include, ClassMethods)
+          if (ActiveRecord::VERSION::MAJOR == 4 && ActiveRecord::VERSION::MINOR == 2) || ActiveRecord::VERSION::MAJOR == 5
+            model_class.send(:extend, ClassMethods)
+          end
+        end
+
         # Support for friendly finds on associations for Rails 4.0.1 and above.
         #
         # Borrowed from FriendlyId::Finders module

data/lib/para/i18n/model.rb

@@ -9,33 +9,17 @@ module Para
       end
 
       def read_translated_attribute(field, locale = ::I18n.locale)
-        return read_plain_or_store_attribute(field) if locale == ::I18n.default_locale
-
-        if model_translations[locale.to_s]
-          if (translation = model_translations[locale.to_s][field.to_s])
-            return translation
-          end
-        end
-
-        # If no translation was returned, try to fallback to the next locale
-        if (fallback_locale = Fallbacks.i18n_fallback_for(locale))
-          read_translated_attribute(field, fallback_locale)
-        end
+        Para::I18n::AttributeTranslation.read(locale, self, field)
       end
 
-      def write_translated_attribute field, value, locale = ::I18n.locale
-        return write_plain_or_store_attribute(field, value) if locale == ::I18n.default_locale
-
-        # did not us ||= here to fix first assignation.
-        # Did not investigate on why ||= does not work
-        model_translations[locale.to_s] = {} unless model_translations[locale.to_s]
-        model_translations[locale.to_s][field.to_s] = value
+      def write_translated_attribute(field, value, locale = ::I18n.locale)
+        Para::I18n::AttributeTranslation.write(locale, self, field, value)
       end
 
       def model_translations
         unless respond_to?(:_translations)
           raise "The model #{ self.class.name } is not translatable. " +
-                "Please run `rails g i18n_admin:translate #{ self.model_name.element }` " +
+                "Please run `rails g para:i18n:translate #{ self.model_name.element }` " +
                 "generator to create the model's migration."
         end
 
@@ -43,11 +27,20 @@ module Para
       end
 
       def translation_for(locale)
-        model_translations[locale.to_s] || {}
+        case locale.to_sym
+        when I18n.default_locale then default_locale_translations
+        else model_translations[locale.to_s] || {}
+        end.with_indifferent_access
       end
 
-      private
+      def disabled_for_locale?
+        self.class.translates? && _disabled_for_locale
+      end
 
+      # This method allows reading an attribute from the ActiveRecord table, whether it's
+      # a plain column of the table, or a field of a store (hash, json etc.) of the table,
+      # accessed through the ActiveRecord.store_accessor interface.
+      #
       def read_plain_or_store_attribute(field)
         if plain_column?(field)
           read_attribute(field)
@@ -68,6 +61,8 @@ module Para
         end
       end
 
+      private
+
       def plain_column?(field)
         self.class.columns_hash.key?(field.to_s)
       end
@@ -80,25 +75,49 @@ module Para
         store.first if store
       end
 
+      def default_locale_translations
+        translated_attribute_names.each_with_object({}) do |attribute_name, hash|
+          hash[attribute_name] = read_plain_or_store_attribute(attribute_name)
+        end
+      end
+
       module ClassMethods
         def translates(*fields)
           self.translated_attribute_names = fields.map(&:to_sym)
           self.translatable = true
 
           fields.each do |field|
-            define_method field do
-              read_translated_attribute(field)
-            end
+            prepare_attribute_translation(field)
+          end
+
+          define_method(:_disabled_for_locale) do
+            read_translated_attribute(:_disabled_for_locale) == "1"
+          end
 
-            define_method :"#{ field }=" do |value|
-              write_translated_attribute(field, value)
-            end
+          define_method(:_disabled_for_locale=) do |value|
+            write_translated_attribute(:_disabled_for_locale, value)
           end
         end
 
         def translates?
           translatable
         end
+
+        private
+
+        def prepare_attribute_translation(attribute)
+          # Let the Para::I18n::AttributeTranslation::Attachment module handle
+          # ActiveStorage attachment fields translation preparation.
+          Para::I18n::AttributeTranslation::Attachment.prepare(self, attribute)
+
+          define_method(attribute) do
+            read_translated_attribute(attribute)
+          end
+
+          define_method(:"#{attribute}=") do |value|
+            write_translated_attribute(attribute, value)
+          end
+        end
       end
     end
   end

data/lib/para/i18n/resources_buttons.rb

@@ -2,10 +2,10 @@ module Para
   module I18n
     module ResourcesButtons
       def translate_button(resource)
-        return unless resource.class.translates?
+        return unless resource.class.translates? && view.can?(:translate, resource)
 
         path = component.relation_path(resource, :translation, action: :edit)
-        options = { class: 'btn btn-info' }
+        options = { class: 'btn btn-default' }
 
         view.link_to(path, options) do
           content_tag(:i, '', class: 'fa fa-globe')

data/lib/para/i18n/version.rb

@@ -1,5 +1,5 @@
 module Para
   module I18n
-    VERSION = "0.3.1"
+    VERSION = "0.4.1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: para-i18n
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.1
 platform: ruby
 authors:
 - Valentin Ballestrino
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-04-15 00:00:00.000000000 Z
+date: 2020-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: para
@@ -94,6 +94,10 @@ files:
 - lib/generators/para/i18n/translate/templates/model_migration.rb.erb
 - lib/generators/para/i18n/translate/translate_generator.rb
 - lib/para/i18n.rb
+- lib/para/i18n/attribute_translation.rb
+- lib/para/i18n/attribute_translation/attachment.rb
+- lib/para/i18n/attribute_translation/base.rb
+- lib/para/i18n/attribute_translation/simple_attribute.rb
 - lib/para/i18n/engine.rb
 - lib/para/i18n/fallbacks.rb
 - lib/para/i18n/friendly_id.rb