para-i18n 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 17b8bcf97585a99d6bdebb63fed2edb77b8ee5c8
-  data.tar.gz: 0c273413dfd04f84dea954ebe616e57873771314
+  metadata.gz: 7ca0ae98159f636ad5cf97f4481d066819e4daf2
+  data.tar.gz: e2bd232647bd4edee8c06fc82a931fad40ef7211
 SHA512:
-  metadata.gz: dfa24b1fc36ecb0f04a82c6ae428109ef6a2d0fdb2f0a8347b28704aba7b06577c70d85fcbe5bc49d0fa5a3bc2efe73f426e4e11a1175dcd6a8cad812db039f6
-  data.tar.gz: c7c76befcdb61fec112409df695ddcde5523b3c5fb475bc39fb3220ef535cf516667192d2022663b5b4cc2a6c95201d570113079376b2a9b8cd981b32dd08420
+  metadata.gz: 79e0910d8bf7ec05871b8721f547ee29b4fd4e5192f2aaf1d8ae7bd1f825dd8a79040d144c538e3c2b1677d1cd8f420d2137d6db0d9ba37ffa6e907bdf876330
+  data.tar.gz: b19299a63bb9eff4690854f285eda67dab0c5df3bbd1cbbd703ab5139b71fede3425b49d97abc1bb048390b4b8c6b4372be2cb23cb3937db61de40cab638ad62

data/README.md

@@ -57,7 +57,7 @@ end
 Now, any `crud` component managing the `Page` model will show a button to access
 the translation interface for existing entries.
 
-## Overriding the translations form
+### Overriding the translations form
 
 The translation form can be overriden by generating it with the `para:i18n:form`
 generator. This is useful to delete or add fields to translate that are not
@@ -73,6 +73,82 @@ rails g para:i18n:form page
 This will create a partial at `app/views/admin/pages/_translations_form.html.haml`
 that you can override.
 
+### Translation fields customization
+
+This gem uses a special [Simple Form](https://github.com/plataformatec/simple_form)
+input to manage translations.
+
+Example :
+
+```ruby
+= form.input :title, as: :i18n, locale: @target_locale
+```
+
+When generating the translations form, you can edit those inputs, remove or add
+some inputs.
+
+#### Managing nested resources
+
+You can simply manage nested resources by using the `simple_fields_for` form
+helper :
+
+```ruby
+= form.simple_fields_for :nested_resources do |fields|
+  = fields.input :nested_title, as: :i18n, locale: @target_locale
+```
+
+#### Passing options to the translation field
+
+The I18n field generates a plain HTML section with the original contents of the
+field (in the `I18n.default_locale` locale), and a sub-input, which uses the
+default type that Para infers from the attribute.
+
+You can override the generated field type or pass other options by using the
+`:input_html` option :
+
+```ruby
+= form.input :value, as: :i18n, locale: @target_locale, input_html: { as: :numeric, spinner: false }
+```
+
+Also, if your original content contains useful HTML, you can use the `:html_safe`
+to be applied to the original content by using the `:original_html` option :
+
+```ruby
+= form.input :value, as: :i18n, locale: @target_locale, original_html: { html_safe: true }
+```
+
+### Locales fallbacks support
+
+The gem fully supports Rails' I18n fallbacks and will try to fallback to any
+available translation using the `I18n.fallbacks` hash if you enable them.
+
+If not enabled, any untranslated content will be empty.
+
+### Friendly id support
+
+The gem comes with friendly_id i18n support, with a dedicated `:i18n` module to
+include instead of the `:slugged` module into your models friendly_id options.
+
+For example, for the page :
+
+```ruby
+class Page < ActiveRecord::Base
+  translates :title, :slug
+
+  friendly_id :title, use: [:finders, :i18n]
+end
+```
+
+> **Warning** : You always need to put the `:i18n` fiendly_id module after all
+other modules, so the finder methods included in this module take the current
+locale into account.
+
+This will automatically build localized slugs when updating the `title` in any
+locale, and will allow you to find the resources with the translated slugs.
+
+Note that if I18n fallbacks are enabled, it will try to fall back to the next
+locale if no resource was found for the given slug and locale.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/para-cms/para-i18n.

data/app/controllers/para/admin/translations_controller.rb

@@ -1,7 +1,11 @@
 module Para
   module Admin
-    class TranslationsController < ::Para::Admin::CrudResourcesController
+    class TranslationsController < ::Para::Admin::ResourcesController
+      include Para::Admin::ResourceControllerConcerns
+
+      before_action :load_and_authorize_crud_resource
       before_action :load_locales
+      before_action :add_breadcrumbs
 
       def edit
       end
@@ -19,10 +23,14 @@ module Para
       private
 
       def load_and_authorize_crud_resource
-        loader = self.class.cancan_resource_class.new(
-          self, :resource, class: resource_model
-        )
+        options = { class: resource_model }
+
+        options.merge!(
+          singleton: true,
+          through: :component
+        ) unless params.key?(:resource_id)
 
+        loader = self.class.cancan_resource_class.new(self, :resource, options)
         loader.load_and_authorize_resource
       end
 
@@ -36,7 +44,7 @@ module Para
       end
 
       def add_breadcrumbs
-        super
+        add_breadcrumb(resource_title_for(resource), @component.relation_path(resource, action: :show)) if resource
         add_breadcrumb(t('para.i18n.translation'))
       end
     end

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

@@ -1,4 +1,4 @@
-class Translate<%= plural_class_name %> < ActiveRecord::Migration
+class Translate<%= table_name.camelize %> < ActiveRecord::Migration
   def change
     add_column :<%= table_name %>, :_translations, :jsonb
   end

data/lib/generators/para/i18n/translate/translate_generator.rb

@@ -15,7 +15,7 @@ module Para
       desc "I18nAdmin translation generator"
 
       def generate_migration
-        migration_template 'model_migration.rb.erb', "db/migrate/translate_#{ plural_file_name }.rb"
+        migration_template 'model_migration.rb.erb', "db/migrate/translate_#{ table_name }.rb"
       end
 
       def migrate
@@ -31,10 +31,6 @@ module Para
       def plural_class_name
         @plural_class_name ||= class_name.pluralize
       end
-
-      def table_name
-        @table_name ||= plural_class_name.underscore
-      end
     end
   end
 end

data/lib/para/i18n/engine.rb

@@ -9,7 +9,11 @@ module Para
 
       initializer 'para.i18n.extend_para_routes' do
         ::Para.config.routes.extend_routes_for(:crud_component) do
-          resource :translation, only: [:edit, :update]
+          resource :translation, only: [:edit, :update], controller: '/para/admin/translations'
+        end
+
+        ::Para.config.routes.extend_routes_for(:form_component) do
+          resource :translation, only: [:edit, :update], controller: '/para/admin/translations'
         end
       end
 
@@ -26,12 +30,12 @@ module Para
       end
 
       initializer 'para.i18n.add_translate_actions' do
-        Para.config.add_actions_for('crud/edit') do
+        Para.config.add_actions_for('crud/edit', 'form/show') do
           {
             icon: 'globe',
             label: ::I18n.t('para.i18n.translate'),
             url: @component.relation_path(resource, :translation, action: :edit)
-          }
+          } if resource.class.translates?
         end
       end
     end

data/lib/para/i18n/friendly_id.rb

@@ -9,6 +9,15 @@ module FriendlyId
 
       def included(model_class)
         model_class.extend(ClassMethods)
+
+        # Support for friendly finds on associations for Rails 4.0.1 and above.
+        #
+        # Borrowed from FriendlyId::Finders module
+        #
+        if ::ActiveRecord.const_defined?('AssociationRelation')
+          association_relation_delegate_class = model_class.relation_delegate_class(::ActiveRecord::AssociationRelation)
+          association_relation_delegate_class.send(:include, ClassMethods)
+        end
       end
     end
 
@@ -31,21 +40,25 @@ module FriendlyId
     end
 
     module ClassMethods
-      def exists_by_friendly_id?(id)
-        if (exists = by_friendly_id(id).exists?)
+      def exists_by_friendly_id?(id, locale = ::I18n.locale)
+        if (exists = by_friendly_id(id, locale).exists?)
           exists
-        elsif (fallback_locale = Para::I18n::Fallbacks.i18n_fallback_for(::I18n.locale))
-          by_friendly_id(id, fallback_locale).exists?
+        elsif (fallback_locale = Para::I18n::Fallbacks.i18n_fallback_for(locale)) &&
+          fallback_locale != locale
+        then
+          exists_by_friendly_id?(id, fallback_locale)
         end
       end
 
       private
 
-      def first_by_friendly_id(id)
-        if (first = by_friendly_id(id).first)
+      def first_by_friendly_id(id, locale = ::I18n.locale)
+        if (first = by_friendly_id(id, locale).first)
           first
-        elsif (fallback_locale = Para::I18n::Fallbacks.i18n_fallback_for(::I18n.locale))
-          by_friendly_id(id, fallback_locale).first
+        elsif (fallback_locale = Para::I18n::Fallbacks.i18n_fallback_for(locale)) &&
+          fallback_locale != locale
+        then
+          first_by_friendly_id(id, fallback_locale)
         end
       end
 
@@ -53,7 +66,7 @@ module FriendlyId
         if locale == ::I18n.default_locale
           where(friendly_id_config.query_field => id)
         else
-          json_path = "{#{ ::I18n.locale },#{ friendly_id_config.query_field }}"
+          json_path = "{#{ locale },#{ friendly_id_config.query_field }}"
           where("_translations#>>'#{ json_path }' = ?", id)
         end
       end

data/lib/para/i18n/i18n_input.rb

@@ -1,18 +1,26 @@
 module Para
   module Inputs
     class I18nInput < SimpleForm::Inputs::Base
+      delegate :content_tag, to: :template
+
       def input(wrapper_options = nil)
         model = object.class
+        render
+      end
 
-        template.render(
-          partial: 'para/inputs/i18n',
-          locals: {
-            form: @builder,
-            resource: object,
-            attribute_name: attribute_name,
-            locale: locale
-          }
-        )
+      def render
+        content_tag(:div, class: 'row') do
+          content_tag(:div, class: 'col-md-6') do
+            ::I18n.with_locale(::I18n.default_locale) do
+              original_content
+            end
+          end +
+          content_tag(:div, class: 'col-md-6') do
+            ::I18n.with_locale(locale) do
+              @builder.input_field(attribute_name, input_options)
+            end
+          end
+        end
       end
 
       private
@@ -24,6 +32,23 @@ module Para
           raise 'Missing `:locale` option passed to :i18n input.'
         end
       end
+
+      def original_content
+        value = template.value_for(object, attribute_name)
+        value = value.html_safe if original_options[:html_safe]
+        value
+      end
+
+      def original_options
+        @original_options ||= options[:original_html] || {}
+      end
+
+      def input_options
+        @input_options ||= (options[:input_html] || {}).tap do |hash|
+          hash[:class] ||= ''
+          hash[:class] += ' form-control'
+        end
+      end
     end
   end
 end

data/lib/para/i18n/model.rb

@@ -4,11 +4,11 @@ module Para
       extend ActiveSupport::Concern
 
       included do
-        class_attribute :translated_fields
+        class_attribute :translated_attribute_names
       end
 
       def read_translated_attribute(field, locale = ::I18n.locale)
-        return read_attribute(field) if locale == ::I18n.default_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])
@@ -23,7 +23,7 @@ module Para
       end
 
       def write_translated_attribute field, value, locale = ::I18n.locale
-        return write_attribute(field, value) if locale == ::I18n.default_locale
+        return write_plain_or_store_attribute(field, value) if locale == ::I18n.default_locale
 
         model_translations[locale.to_s] ||= {}
         model_translations[locale.to_s][field.to_s] = value
@@ -40,12 +40,46 @@ module Para
       end
 
       def translation_for(locale)
-        model_translations[locale] || {}
+        model_translations[locale.to_s] || {}
+      end
+
+      private
+
+      def read_plain_or_store_attribute(field)
+        if plain_column?(field)
+          read_attribute(field)
+        elsif (store_name = find_stored_column(field))
+          read_store_attribute(store_name, field)
+        else
+          raise ActiveRecord::UnknownAttributeError.new(self, field)
+        end
+      end
+
+      def write_plain_or_store_attribute(field, value)
+        if plain_column?(field)
+          write_attribute(field, value)
+        elsif (store_name = find_stored_column(field))
+          write_store_attribute(store_name, field, value)
+        else
+          raise ActiveRecord::UnknownAttributeError.new(self, field)
+        end
+      end
+
+      def plain_column?(field)
+        self.class.columns_hash.key?(field.to_s)
+      end
+
+      def find_stored_column(field)
+        store = self.class.stored_attributes.find do |name, attributes|
+          attributes.include?(field.to_sym)
+        end
+
+        store.first if store
       end
 
       module ClassMethods
         def translates(*fields)
-          self.translated_fields = fields.map(&:to_sym)
+          self.translated_attribute_names = fields.map(&:to_sym)
 
           fields.each do |field|
             define_method field do
@@ -58,8 +92,8 @@ module Para
           end
         end
 
-        def translatable?
-          translated_fields.length > 0
+        def translates?
+          translated_attribute_names && translated_attribute_names.length > 0
         end
       end
     end

data/lib/para/i18n/resources_table.rb

@@ -10,7 +10,7 @@ module Para
       end
 
       def translate_button(resource)
-        return unless resource.class.translatable?
+        return unless resource.class.translates?
 
         path = component.relation_path(resource, :translation, action: :edit)
         options = { class: 'btn btn-info' }

data/lib/para/i18n/translations_helper.rb

@@ -4,7 +4,8 @@ module Para
       # TODO : Support images & co
       def translated_model_fields_for(model)
         model_field_mappings(model).fields.select do |field|
-          model.translated_fields.include?(field.name.to_sym)
+          model.translated_attribute_names &&
+            model.translated_attribute_names.include?(field.name.to_sym)
         end
       end
     end

data/lib/para/i18n/version.rb

@@ -1,5 +1,5 @@
 module Para
   module I18n
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end

data/lib/para/i18n.rb

@@ -15,5 +15,8 @@ require 'para/i18n/engine'
 module Para
   module I18n
     # Your code goes here...
+    def self.method_missing(method, *args, &block)
+      ::I18n.send(method, *args, &block)
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: para-i18n
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Valentin Ballestrino
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-05-11 00:00:00.000000000 Z
+date: 2016-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -71,7 +71,6 @@ files:
 - app/controllers/para/admin/translations_controller.rb
 - app/views/para/admin/resources/_translations_form.html.haml
 - app/views/para/admin/translations/edit.html.haml
-- app/views/para/inputs/_i18n.html.haml
 - bin/console
 - bin/setup
 - config/locales/para-i18n.fr.yml

data/app/views/para/inputs/_i18n.html.haml

@@ -1,7 +0,0 @@
-.row
-  .col-md-6
-    - I18n.with_locale(I18n.default_locale) do
-      = field_value_for(resource, attribute_name)
-  .col-md-6
-    - I18n.with_locale(locale) do
-      = form.input_field attribute_name, class: 'form-control'