para-i18n 0.1.0

checksums.yaml

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

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in para-i18n.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 vala
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,82 @@
+# Para::I18n
+
+This gem allows for translating models content within the [Para](https://github.com/para-cms/para)
+admin interface.
+
+It works by adding a translations layer to ActiveRecord models, like Globalize
+does, and with a similar API, but using JSON fields instead of tables.
+
+**Note** : This gem only works with Postgres 9.4+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'para-i18n'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install para-i18n
+
+Add the para-i18n javascript file to your app's admin manifest at `app/assets/javascripts/admin/app.(js|coffee)` :
+
+```javascript
+//= require para/i18n
+```
+
+## Usage
+
+To allow models to be translated, you need to add the `_translations:jsonb`
+column to your model.
+
+You can use the `para:i18n:translate` generator to generate the migration.
+For example, to translate a page model :
+
+```bash
+rails generate para:i18n:translate page -m
+```
+
+Note that the `-m` option automatically migrates after the migration is
+created.
+
+Now that your model has the translations field in the table, juste use the
+`translates` macro in your model to define which fields will be translated :
+
+```ruby
+class Page < ActiveRecord::Base
+  translates :title, :content
+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
+
+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
+properly displayed by the default view.
+
+For example, the `Page` model translation form can be generated the following
+way :
+
+```bash
+rails g para:i18n:form page
+```
+
+This will create a partial at `app/views/admin/pages/_translations_form.html.haml`
+that you can override.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/para-cms/para-i18n.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/app/assets/javascripts/para/admin/translation.coffee

@@ -0,0 +1,3 @@
+$(document).on 'page:change', ->
+  $('body').on 'change', '[data-locale-select]', (e) ->
+    $(e.currentTarget).closest('form').submit()

data/app/assets/javascripts/para/i18n.coffee

@@ -0,0 +1 @@
+#= require ./admin/translation

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

@@ -0,0 +1,44 @@
+module Para
+  module Admin
+    class TranslationsController < ::Para::Admin::CrudResourcesController
+      before_action :load_locales
+
+      def edit
+      end
+
+      def update
+        if ::I18n.with_locale(@target_locale) { resource.update(resource_params) }
+          flash_message(:success, resource)
+          redirect_to after_form_submit_path
+        else
+          flash_message(:error, resource)
+          render 'edit'
+        end
+      end
+
+      private
+
+      def load_and_authorize_crud_resource
+        loader = self.class.cancan_resource_class.new(
+          self, :resource, class: resource_model
+        )
+
+        loader.load_and_authorize_resource
+      end
+
+      def load_locales
+        @locales = ::I18n.available_locales - [::I18n.default_locale]
+        @target_locale = params[:target_locale] || @locales.first
+      end
+
+      def resource_params
+        params.require(:resource).permit!
+      end
+
+      def add_breadcrumbs
+        super
+        add_breadcrumb(t('para.i18n.translation'))
+      end
+    end
+  end
+end

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

@@ -0,0 +1,6 @@
+= para_form_for(resource, url: @component.relation_path(resource, :translation)) do |form|
+  = form.fieldset do
+    - translated_model_fields_for(resource.class).each do |field|
+      = form.input field.field_name, as: :i18n, locale: @target_locale
+
+  = form.actions(except: :submit_and_add_another)

data/app/views/para/admin/translations/edit.html.haml

@@ -0,0 +1,9 @@
+= page_top_bar(title: resource_title_for(resource), type: 'crud/edit')
+
+.page-content-wrap
+  .well
+    = form_tag @component.relation_path(resource, :translation, action: :edit), method: :get do
+      = label :target_locale, t('i18n_admin.translations.choose_locale')
+      = select_tag :target_locale, options_for_select(@locales.map { |locale| [locale, locale] }, @target_locale), data: { :'locale-select' => true }
+
+  = render find_partial_for(resource, :translations_form)

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

@@ -0,0 +1,7 @@
+.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'

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "para/i18n"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

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

@@ -0,0 +1,5 @@
+fr:
+  para:
+    i18n:
+      translate: "Traduire"
+      translation: "Traduction"

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

@@ -0,0 +1,31 @@
+require 'para/i18n/translations_helper'
+
+module Para
+  module I18n
+    class FormGenerator < Para::Generators::NamedBase
+      include Para::Admin::BaseHelper
+      include Para::Generators::FieldHelpers
+      include Para::ModelHelper
+      include Para::I18n::TranslationsHelper
+
+      source_root File.expand_path("../templates", __FILE__)
+
+      def generate_form
+        template(
+          "_translations_form.html.haml",
+          "app/views/admin/#{ plural_namespaced_path }/_translations_form.html.haml"
+        )
+      end
+
+      private
+
+      def translated_attributes
+        translated_model_fields_for(model)
+      end
+
+      def model
+        @model ||= Para.const_get(class_name)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,8 @@
+= para_form_for(resource, url: @component.relation_path(resource, :translation)) do |form|
+  = form.fieldset do
+  <%- translated_attributes.each do |field| -%>
+    = form.input :<%= field.field_name %>, as: :i18n, locale: @target_locale
+  <%- end -%>
+
+  = form.actions(except: :submit_and_add_another)
+

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

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

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

@@ -0,0 +1,40 @@
+require 'rails/generators/active_record/migration'
+
+module Para
+  module I18n
+    class TranslateGenerator < Rails::Generators::NamedBase
+     include Rails::Generators::Migration
+     include ActiveRecord::Generators::Migration
+
+      # Copied files come from templates folder
+      source_root File.expand_path('../templates', __FILE__)
+
+      class_option :migrate, type: :boolean, default: false, :aliases => "-m"
+
+      # Generator desc
+      desc "I18nAdmin translation generator"
+
+      def generate_migration
+        migration_template 'model_migration.rb.erb', "db/migrate/translate_#{ plural_file_name }.rb"
+      end
+
+      def migrate
+        rake 'db:migrate' if options[:migrate]
+      end
+
+      private
+
+      def class_name
+        @class_name ||= super.gsub(/I18nAdmin::/, '')
+      end
+
+      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

@@ -0,0 +1,39 @@
+module Para
+  module I18n
+    class Engine < ::Rails::Engine
+      initializer 'para.i18n.include_model_extension_into_active_record' do
+        ActiveSupport.on_load(:active_record) do
+          include Para::I18n::Model
+        end
+      end
+
+      initializer 'para.i18n.extend_para_routes' do
+        ::Para.config.routes.extend_routes_for(:crud_component) do
+          resource :translation, only: [:edit, :update]
+        end
+      end
+
+      initializer 'para.i18n.include_view_helpers' do
+        ActiveSupport.on_load(:action_view) do
+          include Para::I18n::TranslationsHelper
+        end
+      end
+
+      initializer 'para.i18n.extend_para_resources_table' do
+        ActiveSupport.on_load(:action_view) do
+          ::Para::Markup::ResourcesTable.send(:include, Para::I18n::ResourcesTable)
+        end
+      end
+
+      initializer 'para.i18n.add_translate_actions' do
+        Para.config.add_actions_for('crud/edit') do
+          {
+            icon: 'globe',
+            label: ::I18n.t('para.i18n.translate'),
+            url: @component.relation_path(resource, :translation, action: :edit)
+          }
+        end
+      end
+    end
+  end
+end

data/lib/para/i18n/fallbacks.rb

@@ -0,0 +1,15 @@
+module Para
+  module I18n
+    module Fallbacks
+      def self.i18n_fallback_for(locale)
+        return unless ::I18n.respond_to?(:fallbacks)
+
+        if (fallbacks = ::I18n.fallbacks[locale]) && fallbacks.length > 1
+          fallbacks[1]
+        else
+          ::I18n.default_locale
+        end
+      end
+    end
+  end
+end

data/lib/para/i18n/friendly_id.rb

@@ -0,0 +1,63 @@
+require 'i18n'
+
+module FriendlyId
+  module I18n
+    class << self
+      def setup(model_class)
+        model_class.friendly_id_config.use :slugged
+      end
+
+      def included(model_class)
+        model_class.extend(ClassMethods)
+      end
+    end
+
+    def set_friendly_id(text, locale = nil)
+      ::I18n.with_locale(locale || ::I18n.locale) do
+        set_slug(normalize_friendly_id(text))
+      end
+    end
+
+    def should_generate_new_friendly_id?
+      translation_for(::I18n.locale)[friendly_id_config.slug_column].blank?
+    end
+
+    def set_slug(normalized_slug = nil)
+      return unless should_generate_new_friendly_id?
+
+      candidates = FriendlyId::Candidates.new(self, normalized_slug || send(friendly_id_config.base))
+      slug = slug_generator.generate(candidates) || resolve_friendly_id_conflict(candidates)
+      self.slug = slug
+    end
+
+    module ClassMethods
+      def exists_by_friendly_id?(id)
+        if (exists = by_friendly_id(id).exists?)
+          exists
+        elsif (fallback_locale = Para::I18n::Fallbacks.i18n_fallback_for(::I18n.locale))
+          by_friendly_id(id, fallback_locale).exists?
+        end
+      end
+
+      private
+
+      def first_by_friendly_id(id)
+        if (first = by_friendly_id(id).first)
+          first
+        elsif (fallback_locale = Para::I18n::Fallbacks.i18n_fallback_for(::I18n.locale))
+          by_friendly_id(id, fallback_locale).first
+        end
+      end
+
+      def by_friendly_id(id, locale = ::I18n.locale)
+        if locale == ::I18n.default_locale
+          where(friendly_id_config.query_field => id)
+        else
+          json_path = "{#{ ::I18n.locale },#{ friendly_id_config.query_field }}"
+          where("_translations#>>'#{ json_path }' = ?", id)
+        end
+      end
+    end
+  end
+end
+

data/lib/para/i18n/i18n_input.rb

@@ -0,0 +1,29 @@
+module Para
+  module Inputs
+    class I18nInput < SimpleForm::Inputs::Base
+      def input(wrapper_options = nil)
+        model = object.class
+
+        template.render(
+          partial: 'para/inputs/i18n',
+          locals: {
+            form: @builder,
+            resource: object,
+            attribute_name: attribute_name,
+            locale: locale
+          }
+        )
+      end
+
+      private
+
+      def locale
+        if (locale = options[:locale])
+          locale
+        else
+          raise 'Missing `:locale` option passed to :i18n input.'
+        end
+      end
+    end
+  end
+end

data/lib/para/i18n/model.rb

@@ -0,0 +1,67 @@
+module Para
+  module I18n
+    module Model
+      extend ActiveSupport::Concern
+
+      included do
+        class_attribute :translated_fields
+      end
+
+      def read_translated_attribute(field, locale = ::I18n.locale)
+        return read_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
+      end
+
+      def write_translated_attribute field, value, locale = ::I18n.locale
+        return write_attribute(field, value) if locale == ::I18n.default_locale
+
+        model_translations[locale.to_s] ||= {}
+        model_translations[locale.to_s][field.to_s] = 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 }` " +
+                "generator to create the model's migration."
+        end
+
+        self._translations ||= {}
+      end
+
+      def translation_for(locale)
+        model_translations[locale] || {}
+      end
+
+      module ClassMethods
+        def translates(*fields)
+          self.translated_fields = fields.map(&:to_sym)
+
+          fields.each do |field|
+            define_method field do
+              read_translated_attribute(field)
+            end
+
+            define_method :"#{ field }=" do |value|
+              write_translated_attribute(field, value)
+            end
+          end
+        end
+
+        def translatable?
+          translated_fields.length > 0
+        end
+      end
+    end
+  end
+end

data/lib/para/i18n/resources_table.rb

@@ -0,0 +1,24 @@
+module Para
+  module I18n
+    module ResourcesTable
+      extend ActiveSupport::Concern
+
+      included do
+        last_action = default_actions.pop
+        default_actions << :translate
+        default_actions << last_action
+      end
+
+      def translate_button(resource)
+        return unless resource.class.translatable?
+
+        path = component.relation_path(resource, :translation, action: :edit)
+        options = { class: 'btn btn-info' }
+
+        view.link_to(path, options) do
+          content_tag(:i, '', class: 'fa fa-globe')
+        end
+      end
+    end
+  end
+end

data/lib/para/i18n/translations_helper.rb

@@ -0,0 +1,12 @@
+module Para
+  module I18n
+    module TranslationsHelper
+      # 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)
+        end
+      end
+    end
+  end
+end

data/lib/para/i18n/version.rb

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

data/lib/para/i18n.rb

@@ -0,0 +1,19 @@
+require 'para/i18n/version'
+
+require 'para/i18n/fallbacks'
+
+require 'para/i18n/model'
+require 'para/i18n/resources_table'
+require 'para/i18n/translations_helper'
+
+require 'para/i18n/friendly_id'
+
+require 'para/i18n/i18n_input'
+
+require 'para/i18n/engine'
+
+module Para
+  module I18n
+    # Your code goes here...
+  end
+end

data/para-i18n.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'para/i18n/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "para-i18n"
+  spec.version       = Para::I18n::VERSION
+  spec.authors       = ["Valentin Ballestrino"]
+  spec.email         = ["vala@glyph.fr"]
+
+  spec.summary       = %q{Para CMS I18n admin module for models}
+  spec.description   = %q{Para CMS I18n admin module for models}
+  spec.homepage      = "https://github.com/para-cms/para-i18n"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: para-i18n
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Valentin Ballestrino
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-05-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Para CMS I18n admin module for models
+email:
+- vala@glyph.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/assets/javascripts/para/admin/translation.coffee
+- app/assets/javascripts/para/i18n.coffee
+- 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
+- lib/generators/para/i18n/form/form_generator.rb
+- lib/generators/para/i18n/form/templates/_translations_form.html.haml
+- 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/engine.rb
+- lib/para/i18n/fallbacks.rb
+- lib/para/i18n/friendly_id.rb
+- lib/para/i18n/i18n_input.rb
+- lib/para/i18n/model.rb
+- lib/para/i18n/resources_table.rb
+- lib/para/i18n/translations_helper.rb
+- lib/para/i18n/version.rb
+- para-i18n.gemspec
+homepage: https://github.com/para-cms/para-i18n
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Para CMS I18n admin module for models
+test_files: []