para-i18n 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: bffd454f68783dc4413fab9cff53b3c899b0f908
-  data.tar.gz: 783928239cee302a6e963057cc8f68becd744c8c
+SHA256:
+  metadata.gz: 90d12992580fc4a99c6c61436e3fda627f33c8064316d72d9dac154234bf7e58
+  data.tar.gz: 4592e7c3895bc9200f212879171f5b039d75884bd0dfa73f576a8624346fbd5d
 SHA512:
-  metadata.gz: aa848897075a6d40a94d92451e3b660e1c18aade214e90ca0a394d066b58dd03f3d143f6457f29e469b805215f37e451f21a093443f67cc7298b2bd8a7a047de
-  data.tar.gz: 3ce0e4a22d344090a9d98ba86fb505b778549e2a230d8e981b9288af8b0d16da180e8993d1b828c7d795d867092d01575c3a040e43e74f6f2c3c05ade9eaa975
+  metadata.gz: 2cf9a1a632377a4d9d4f0780401028e4fd44b6991427a96af28e9ea21414d804a3ad97d0ca552b051fe43848a0c98f5df703a999e104bd0a8eae9309a3b7d69c
+  data.tar.gz: f676eac78ac6492fc3a283a162a0e06874d55873ead0e5a0c429ed93cc2445e6dfa2f0491e51e08626eca37dbcc59c08eaba07a083248c843d9d84c67a9bd8af

data/app/helpers/para/i18n/form_helper.rb

@@ -0,0 +1,13 @@
+module Para
+  module I18n
+    module FormHelper
+      def para_translations_form_for(resource, options = {}, &block)
+        extended_options = options.reverse_merge(
+          Para::I18n::FormBuilder::TranslationsForm::TRANSLATIONS_FORM_PARAM_KEY => true
+        )
+
+        para_form_for(resource, extended_options, &block)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+= form.fieldset do
+  - I18n.with_locale(@target_locale) do
+    = form.input :_disabled_for_locale, as: :boolean, label: t("para.i18n.disabled_for_locale")
+
+  - translated_model_fields_for(form.object.class).each do |field|
+    = form.input field.field_name, as: :i18n
+
+  - nested_relations_attributes_for(form.object.class).each do |field|
+    = form.input field.field_name, as: field.field_type

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

@@ -1,10 +1,14 @@
-= para_form_for(resource, url: @component.relation_path(resource, :translation)) do |form|
+= para_translations_form_for(resource, url: @component.relation_path(resource, :translation), locale: @target_locale) do |form|
   = 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") }
+    - I18n.with_locale(@target_locale) do
+      = 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
+      = form.input field.field_name, as: :i18n
+
+    - nested_relations_attributes_for(resource.class).each do |field|
+      = form.input field.field_name, as: field.field_type
 
   = form.actions(except: :submit_and_add_another)

data/lib/generators/para/i18n/base_form_generator.rb

@@ -0,0 +1,28 @@
+module Para
+  module I18n
+    module FormGeneratorConcern
+      extend ActiveSupport::Concern
+
+      included do
+        include Para::Admin::BaseHelper
+        include Para::Generators::FieldHelpers
+        include Para::ModelHelper
+        include Para::I18n::Helpers::TranslationsHelper
+      end
+
+      private
+
+      def translated_attributes
+        translated_model_fields_for(model)
+      end
+
+      def nested_relations_attributes
+        nested_relations_attributes_for(model)
+      end
+
+      def model
+        @model ||= class_name.constantize
+      end
+    end
+  end
+end

data/lib/generators/para/i18n/form/form_generator.rb

@@ -1,10 +1,9 @@
+require "generators/para/i18n/base_form_generator"
+
 module Para
   module I18n
     class FormGenerator < Para::Generators::NamedBase
-      include Para::Admin::BaseHelper
-      include Para::Generators::FieldHelpers
-      include Para::ModelHelper
-      include Para::I18n::Helpers::TranslationsHelper
+      include Para::I18n::FormGeneratorConcern
 
       source_root File.expand_path("../templates", __FILE__)
 
@@ -14,16 +13,6 @@ module Para
           "app/views/admin/#{ plural_namespaced_path }/_translations_form.html.haml"
         )
       end
-
-      private
-
-      def translated_attributes
-        translated_model_fields_for(model)
-      end
-
-      def model
-        @model ||= class_name.constantize
-      end
     end
   end
 end

data/lib/generators/para/i18n/form/templates/_translations_form.html.haml

@@ -1,9 +1,15 @@
-= para_form_for(resource, url: @component.relation_path(resource, :translation)) do |form|
+= para_translations_form_for(resource, url: @component.relation_path(resource, :translation), locale: @target_locale) do |form|
   = target_locale_select
 
   = form.fieldset do
+    - I18n.with_locale(@target_locale) do
+      = form.input :_disabled_for_locale, as: :boolean, label: t("para.i18n.disabled_for_locale")
+
   <%- translated_attributes.each do |field| -%>
-    = form.input :<%= field.field_name %>, as: :i18n, locale: @target_locale
+    = form.input :<%= field.field_name %>, as: :i18n
+  <%- end -%>
+  <%- nested_relations_attributes.each do |field| -%>
+    = form.input :<%= field.field_name %>, as: :<%= field.field_type %>
   <%- end -%>
 
   = form.actions(except: :submit_and_add_another)

data/lib/generators/para/i18n/nested_fields/nested_fields_generator.rb

@@ -0,0 +1,18 @@
+require "generators/para/i18n/base_form_generator"
+
+module Para
+  module I18n
+    class NestedFieldsGenerator < Para::Generators::NamedBase
+      include Para::I18n::FormGeneratorConcern
+
+      source_root File.expand_path("../templates", __FILE__)
+
+      def generate_nested_fields
+        template(
+          "_translations_fields.html.haml",
+          "app/views/admin/#{ plural_namespaced_path }/_translations_fields.html.haml"
+        )
+      end
+    end
+  end
+end

data/lib/generators/para/i18n/nested_fields/templates/_translations_fields.html.haml

@@ -0,0 +1,11 @@
+= form.fieldset do
+  - I18n.with_locale(@target_locale) do
+    = form.input :_disabled_for_locale, as: :boolean, label: t("para.i18n.disabled_for_locale")
+
+<%- translated_attributes.each do |field| -%>
+  = form.input :<%= field.field_name %>, as: :i18n
+<%- end -%>
+<%- nested_relations_attributes.each do |field| -%>
+  = form.input :<%= field.field_name %>, as: :<%= field.field_type %>
+<%- end -%>
+

data/lib/generators/para/i18n/translate/templates/model_migration.rb.erb

@@ -1,4 +1,4 @@
-class Translate<%= table_name.camelize %> < ActiveRecord::Migration
+class Translate<%= table_name.camelize %> < ActiveRecord::Migration<%= "[#{Rails.version.to_f}]" if Rails.version.to_i >= 5 %>
   def change
     add_column :<%= table_name %>, :_translations, :jsonb
   end

data/lib/para/i18n.rb

@@ -13,6 +13,9 @@ require 'para/i18n/attribute_translation/base'
 require 'para/i18n/attribute_translation/simple_attribute'
 require 'para/i18n/attribute_translation/attachment'
 
+require 'para/i18n/form_builder'
+require 'para/i18n/inputs'
+
 require 'para/i18n/friendly_id'
 
 require 'para/i18n/i18n_input'

data/lib/para/i18n/form_builder.rb

@@ -0,0 +1,10 @@
+require 'para/form_builder'
+
+require 'para/i18n/form_builder/nested_form'
+require 'para/i18n/form_builder/translations_form'
+
+# Extend the para extended simple_form form builder to included translations related
+# methods.
+#
+SimpleForm::FormBuilder.prepend(Para::I18n::FormBuilder::NestedForm)
+SimpleForm::FormBuilder.prepend(Para::I18n::FormBuilder::TranslationsForm)

data/lib/para/i18n/form_builder/nested_form.rb

@@ -0,0 +1,46 @@
+# frozen_string_literals: true
+
+module Para
+  module I18n
+    module FormBuilder
+      # Thid module provides methods to extend the para's nested form functionality by
+      # extending the SimpleForm::FormBuilder.
+      #
+      module NestedForm
+        # Traverses the parent_builder chain until the top of the builder chain returning
+        # the top-most form builder which represents the one created through the
+        # `form_for` like helper.
+        #
+        # Note that this could go into the Para::FormBuilder::NestedForm module, but it's
+        # not used inside Para, so we keep it here for now.
+        #
+        def top_level_form_builder
+          parent_builder = options[:parent_builder]
+
+          while parent_builder && parent_builder.options[:parent_builder]
+            parent_builder = parent_builder.options[:parent_builder]
+          end
+
+          parent_builder || self
+        end
+
+        # Don't allow nested fields destruction if we're in a translations form as this is
+        # the method used by the FormBuilder#remove_association_button method to check
+        # whether it's allowed to render the remove button or not.
+        #
+        def allow_destroy?
+          return false if translations_form?
+
+          super
+        end
+
+        # Overrides the Para::FormBuilder::NestedForm#fields_partial_name method to render
+        # a different nested fields partial when the builder is a translations form
+        #
+        def nested_fields_partial_name
+          translations_form? ? :translations_fields : :fields
+        end
+      end
+    end
+  end
+end

data/lib/para/i18n/form_builder/translations_form.rb

@@ -0,0 +1,42 @@
+# frozen_string_literals: true
+
+module Para
+  module I18n
+    module FormBuilder
+      # Thid module extends the Para overriden SimpleForm::FormBuilder to include some
+      # trnaslations form related methods and overrides, allowing a simple use of
+      # translations forms with the para-i18n gem.
+      #
+      module TranslationsForm
+        TRANSLATIONS_FORM_PARAM_KEY = :_translations_form
+
+        # Allows storing a gobal reference to the target locale of the translations form,
+        # which allows input objects to fetch it directly, without having to provide
+        # manually the :locale parameter for each input
+        #
+        # Example :
+        #
+        #   = para_translations_form_for(resource, locale: @target_Locale) do |form|
+        #     =  form.input :title, as: :i18n # No need to pass `:locale` option here.
+        #
+        def target_locale
+          top_level_form_builder.options.with_indifferent_access[:locale]
+        end
+
+        # Allows checking if the current form builder is a translations form, depending
+        # on the passed TRANSLATIONS_FORM_PARAM_KEY option. This is automatically passed
+        # to the form builder when using the `para_translations_form_for` helper.
+        #
+        # Example :
+        #
+        #   para_translations_form_for(resource)
+        #   # OR
+        #   para_form_for(resource, _translations_form: true)
+        #
+        def translations_form?
+          !!top_level_form_builder.options.with_indifferent_access[TRANSLATIONS_FORM_PARAM_KEY]
+        end
+      end
+    end
+  end
+end

data/lib/para/i18n/friendly_id.rb

@@ -14,7 +14,7 @@ module FriendlyId
         # 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
+          if (ActiveRecord::VERSION::MAJOR == 4 && ActiveRecord::VERSION::MINOR == 2) || ActiveRecord::VERSION::MAJOR >= 5
             model_class.send(:extend, ClassMethods)
           end
         end

data/lib/para/i18n/helpers/translations_helper.rb

@@ -9,6 +9,15 @@ module Para
               model.translated_attribute_names.include?(field.name.to_sym)
           end
         end
+
+        def nested_relations_attributes_for(model)
+          model_field_mappings(model).fields.select do |field|
+            next unless field.field_type.in?(["nested_one", "nested_many"])
+
+            # This returns nil if the target model is not translated
+            model.reflect_on_association(field.name).klass.translatable?
+          end
+        end
       end
     end
   end

data/lib/para/i18n/i18n_input.rb

@@ -26,11 +26,11 @@ module Para
       private
 
       def locale
-        if (locale = options[:locale])
-          locale
-        else
-          raise 'Missing `:locale` option passed to :i18n input.'
-        end
+        locale = options.fetch(:locale, @builder.target_locale)
+        return locale if locale.present?
+
+        raise 'No target locale for the current i18n input. Please provide a `:locale`' \
+              'option to the :i18n input or the `para_translations_form_for` method'
       end
 
       def original_content

data/lib/para/i18n/inputs.rb

@@ -0,0 +1,4 @@
+require "para/inputs/nested_many_input"
+require 'para/i18n/inputs/nested_many_input'
+
+Para::Inputs::NestedManyInput.prepend(Para::I18n::Inputs::NestedManyInput)

data/lib/para/i18n/inputs/nested_many_input.rb

@@ -0,0 +1,41 @@
+module Para
+  module I18n
+    module Inputs
+      module NestedManyInput
+        def input(_wrapper_options = nil)
+          # Disable the add button and orderable features of the input.
+          # Note : The remove button disabling is done by the
+          # Para::I18n::FormBuilder::TranslationsForm extension
+          if within_translations_form?
+            options[:add_button] = false
+            options[:orderable] = false
+          end
+
+          super
+        end
+        private
+
+        def within_translations_form?
+          @builder.translations_form?
+        end
+
+        # Extend remote partial params with the :_translations_form key if we're in the
+        # context of a translations form builder.
+        #
+        def remote_partial_params
+          super.tap do |remote_partial_params|
+            if within_translations_form?
+              remote_partial_params.deep_merge!(
+                builder_options: {
+                  Para::I18n::FormBuilder::TranslationsForm::TRANSLATIONS_FORM_PARAM_KEY => true,
+                  locale: @builder.target_locale
+                }
+              )
+            end
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/para/i18n/version.rb

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

data/para-i18n.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "para", "~> 0.8"
+  spec.add_dependency "para", ">= 0.9.2", "<= 1.0"
 
   spec.add_development_dependency "bundler", "~> 1.11"
   spec.add_development_dependency "rake", "~> 10.0"

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: para-i18n
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Valentin Ballestrino
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-09-22 00:00:00.000000000 Z
+date: 2021-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: para
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+    - - "<="
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+    - - "<="
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -83,14 +89,19 @@ files:
 - app/assets/javascripts/para/admin/translation.coffee
 - app/assets/javascripts/para/i18n.coffee
 - app/controllers/para/admin/translations_controller.rb
+- app/helpers/para/i18n/form_helper.rb
+- app/views/para/admin/resources/_translations_fields.html.haml
 - app/views/para/admin/resources/_translations_form.html.haml
 - app/views/para/admin/translations/_target_locale_select.html.haml
 - app/views/para/admin/translations/edit.html.haml
 - bin/console
 - bin/setup
 - config/locales/para-i18n.fr.yml
+- lib/generators/para/i18n/base_form_generator.rb
 - lib/generators/para/i18n/form/form_generator.rb
 - lib/generators/para/i18n/form/templates/_translations_form.html.haml
+- lib/generators/para/i18n/nested_fields/nested_fields_generator.rb
+- lib/generators/para/i18n/nested_fields/templates/_translations_fields.html.haml
 - lib/generators/para/i18n/translate/templates/model_migration.rb.erb
 - lib/generators/para/i18n/translate/translate_generator.rb
 - lib/para/i18n.rb
@@ -100,11 +111,16 @@ files:
 - lib/para/i18n/attribute_translation/simple_attribute.rb
 - lib/para/i18n/engine.rb
 - lib/para/i18n/fallbacks.rb
+- lib/para/i18n/form_builder.rb
+- lib/para/i18n/form_builder/nested_form.rb
+- lib/para/i18n/form_builder/translations_form.rb
 - lib/para/i18n/friendly_id.rb
 - lib/para/i18n/helpers.rb
 - lib/para/i18n/helpers/translations_form_helper.rb
 - lib/para/i18n/helpers/translations_helper.rb
 - lib/para/i18n/i18n_input.rb
+- lib/para/i18n/inputs.rb
+- lib/para/i18n/inputs/nested_many_input.rb
 - lib/para/i18n/model.rb
 - lib/para/i18n/resources_buttons.rb
 - lib/para/i18n/resources_table.rb
@@ -129,8 +145,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Para CMS I18n admin module for models