spree_mobility 1.1.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 30f3cdb07e980914cb9e50dc2ac6f2ece8ab75547b12f811e772bfacb06a0942
-  data.tar.gz: 2d4091a9e0399685cdfbab7f3df2c7067f567a32d133eb94f41d473caf9efbf4
+  metadata.gz: 4b978eb059a4af42b54b7972c52ca54a3c05e5bf2e1a1e6c184472da2298c555
+  data.tar.gz: '0748c01ed29ce8e98ae2e68b707d540d4e97066fb744f679f9e86087cfe555e9'
 SHA512:
-  metadata.gz: ddd330d66753f527b3f705a0957389f3f8b2cda6f410acfd3faa9e120a45583c98969f352fee5a4b9e44972c10bf6d42ff31ef03a5b42973330beeb0f3832913
-  data.tar.gz: cabd47580f96da77e9dc017f421a2b56f47f70e8e46f074569b3900afeb961a77118cbaa68d3ab0f11416e3e0ae6c3a96f035fc7e39441053712308bc7f77bc8
+  metadata.gz: 97541ca9b86a4a59632852d1ddd9c98c51dbfa82db2818e534ea4651754f85247efa9aa04df4ace9c5680639c1cef7b466e0d6ad7350fd548251ed1ec4da9232
+  data.tar.gz: 4fdae65ac633438659005a07fb4d9c6f62245c4fe4b566bc2b29f01c427253fc0916a6b54db3bc6c0908218e4df95f9ec35dcd12e622869f7cec0d061ae86960

data/LICENSE.md

@@ -1,4 +1,4 @@
-Copyright (c) 2011-2015 Spree Commerce Inc., and other contributors.
+Copyright (c) 2022 mrbrdo, Spree Commerce Inc., and other contributors.
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification,

data/README.md

@@ -4,7 +4,7 @@ This is a Spree model translation gem based on `spree_globalize` for [Spree Comm
 It uses `mobility` instead of `globalize`, since `globalize` is not actively developed anymore.
 It is a drop-in replacement for `spree_globalize` and will use your existing translations.
 
-Currently, this gem is tested with Spree 4.3.1.
+Currently, this gem is tested with Spree 4.3.1. Since version 1.3, it should also work with Spree 4.4.
 
 ## Installation
 
@@ -34,6 +34,15 @@ Mobility.configure do
 end
 ```
 
+## Spree 4.3.x
+
+It seems there is a bug in spree_backend v4.3.x (before v4.4), which prevents translation links working correctly.
+To fix this, add to the bottom of `vendor/assets/javascripts/spree/backend/all.js`:
+
+```ruby
+$(document).trigger('page:load');
+```
+
 ---
 
 ## Improvements over spree_globalize
@@ -59,7 +68,7 @@ For more localization features, see my `better_spree_localization` gem.
 This feature uses the [Mobility][3] gem to localize model data.
 So far the following models are translatable:
 
-    Product, Promotion, OptionType, Taxonomy, Taxon, Property, Store and ShippingMethod.
+    Product, Promotion, OptionType, Taxonomy, Taxon, Property, Store, ShippingMethod and PaymentMethod.
 
 Start your server and you should see a TRANSLATIONS link or a flag icon on each
 admin section that supports this feature.

data/app/assets/javascripts/spree/backend/taxon_tree_menu.js

@@ -1,4 +1,4 @@
-(function() {
+Spree.ready(function () {
   var root;
 
   root = typeof exports !== "undefined" && exports !== null ? exports : this;
@@ -46,4 +46,4 @@
     };
   };
 
-}).call(this);
+});

data/app/assets/javascripts/spree/backend/translations.js

@@ -1,4 +1,4 @@
-(function() {
+Spree.ready(function() {
   var display_locale_fields;
 
   display_locale_fields = function() {
@@ -47,4 +47,4 @@
     });
   });
 
-}).call(this);
+});

data/app/controllers/spree/admin/payment_method_translations_controller.rb

@@ -0,0 +1,25 @@
+module Spree
+  module Admin
+    class PaymentMethodTranslationsController < Spree::Admin::BaseController
+      def translate
+        # Need to manually update translations, otherwise Rails
+        # accepts_nested_attributes_for in combination with current mobility
+        # implementation has some problems with the subclasses used with
+        # PaymentMethods
+        payment_method = Spree::PaymentMethod.find(params[:id])
+
+        translations_params =
+          params.require(:payment_method).permit(
+            [translations_attributes: [:id, :locale, :name, :description]])
+
+        payment_method.translations.delete_all
+        translations_params[:translations_attributes].each_pair do |k, value|
+          payment_method.translations.create(value)
+        end
+
+        flash[:success] = Spree.t(:successfully_updated, resource: Spree.t(:payment_method))
+        redirect_to spree.edit_admin_payment_method_path(payment_method)
+      end
+    end
+  end
+end

data/app/overrides/spree/admin/option_types/_option_value_fields/add_translation.rb

@@ -1,10 +1,10 @@
 Deface::Override.new(
   virtual_path:  'spree/admin/option_types/_option_value_fields',
   name:          'option_value_translation',
-  insert_bottom: 'td.actions',
+  insert_bottom: 'td.actions > span:first',
   text:           <<-HTML
                     <% if f.object.persisted? %>
-                      <%= link_to_with_icon 'translate', nil, spree.admin_translations_path('option_values', f.object.id), title: Spree.t(:'i18n.translations'), class: 'btn btn-sm btn-primary' %>
+                      <%= link_to_with_icon 'translate', nil, spree.admin_translations_path('option_values', f.object.id), title: Spree.t(:'i18n.translations'), class: 'btn btn-sm btn-primary', no_text: true %>
                     <% end %>
                   HTML
 )

data/app/overrides/spree/admin/option_types/index/add_translation.rb

@@ -1,8 +1,8 @@
 Deface::Override.new(
   virtual_path:  'spree/admin/option_types/index',
   name:          'option_types_index_translation',
-  insert_top:    'td.actions',
+  insert_top:    'td.actions > span:first',
   text:          <<-HTML
-                  <%= link_to_with_icon 'translate', nil, spree.admin_translations_path('option_types', option_type.id), title: Spree.t(:'i18n.translations'), class: 'btn btn-sm btn-primary' %>
+                  <%= link_to_with_icon 'translate', nil, spree.admin_translations_path('option_types', option_type.id), title: Spree.t(:'i18n.translations'), class: 'btn btn-sm btn-primary', no_text: true %>
                 HTML
 )

data/app/overrides/spree/admin/payment_methods/index/add_translation.rb

@@ -0,0 +1,8 @@
+Deface::Override.new(
+  virtual_path:  'spree/admin/payment_methods/index',
+  name:          'payment_methods_translation',
+  insert_bottom: 'td.actions > span:first',
+  text:           <<-HTML
+                    <%= link_to_with_icon 'translate', nil, spree.admin_translations_path('payment_methods', method.id), title: Spree.t(:'i18n.translations'), class: 'btn btn-sm btn-primary', no_text: true %>
+                  HTML
+)

data/app/overrides/spree/admin/product_properties/_product_property_fields/add_translation.rb

@@ -1,10 +1,10 @@
 Deface::Override.new(
   virtual_path:  'spree/admin/product_properties/_product_property_fields',
   name:          'product_property_translation',
-  insert_bottom: 'td.actions',
+  insert_bottom: 'td.actions > span:first',
   text:           <<-HTML
                     <% if f.object.persisted? %>
-                      <%= link_to_with_icon 'translate', nil, spree.admin_translations_path('product_property', f.object.id), title: Spree.t(:'i18n.translations'), class: 'btn btn-sm btn-primary' %>
+                      <%= link_to_with_icon 'translate', nil, spree.admin_translations_path('product_property', f.object.id), title: Spree.t(:'i18n.translations'), class: 'btn btn-sm btn-primary', no_text: true %>
                     <% end %>
                   HTML
 )

data/app/overrides/spree/admin/promotions/index/add_translation_link.rb

@@ -1,8 +1,8 @@
 Deface::Override.new(
   virtual_path:  'spree/admin/promotions/index',
   name:          'promotions_translation',
-  insert_bottom: 'td.actions',
+  insert_bottom: 'td.actions > span:first',
   text:           <<-HTML
-                    <%= link_to_with_icon 'translate', nil, spree.admin_translations_path('promotions', promotion.id), title: Spree.t(:'i18n.translations'), class: 'btn btn-sm btn-primary' %>
+                    <%= link_to_with_icon 'translate', nil, spree.admin_translations_path('promotions', promotion.id), title: Spree.t(:'i18n.translations'), class: 'btn btn-sm btn-primary', no_text: true %>
                   HTML
 )

data/app/overrides/spree/admin/properties/index/add_translation.rb

@@ -1,8 +1,8 @@
 Deface::Override.new(
   virtual_path:  'spree/admin/properties/index',
   name:          'properties_translation',
-  insert_bottom: 'td.actions',
+  insert_bottom: 'td.actions > span:first',
   text:           <<-HTML
-                    <%= link_to_with_icon 'translate', nil, spree.admin_translations_path('properties', property.id), title: Spree.t(:'i18n.translations'), class: 'btn btn-sm btn-primary' %>
+                    <%= link_to_with_icon 'translate', nil, spree.admin_translations_path('properties', property.id), title: Spree.t(:'i18n.translations'), class: 'btn btn-sm btn-primary', no_text: true %>
                   HTML
 )

data/app/overrides/spree/admin/shipping_methods/index/add_translation.rb

@@ -1,8 +1,8 @@
 Deface::Override.new(
   virtual_path:  'spree/admin/shipping_methods/index',
   name:          'shipping_methods_translation',
-  insert_bottom: 'td.actions',
+  insert_bottom: 'td.actions > span:first',
   text:           <<-HTML
-                    <%= link_to_with_icon 'translate', nil, spree.admin_translations_path('shipping_methods', shipping_method.id), title: Spree.t(:'i18n.translations'), class: 'btn btn-sm btn-primary' %>
+                    <%= link_to_with_icon 'translate', nil, spree.admin_translations_path('shipping_methods', shipping_method.id), title: Spree.t(:'i18n.translations'), class: 'btn btn-sm btn-primary', no_text: true %>
                   HTML
 )

data/app/overrides/spree/admin/taxonomies/_list/add_translations.rb

@@ -1,8 +1,8 @@
 Deface::Override.new(
   virtual_path:  'spree/admin/taxonomies/_list',
   name:          'taxonomies_translation',
-  insert_bottom: 'td.actions',
+  insert_bottom: 'td.actions > span:first',
   text:           <<-HTML
-                    <%= link_to_with_icon 'translate', nil, spree.admin_translations_path('taxonomies', taxonomy.id), title: Spree.t(:'i18n.translations'), class: 'btn btn-sm btn-primary' %>
+                    <%= link_to_with_icon 'translate', nil, spree.admin_translations_path('taxonomies', taxonomy.id), title: Spree.t(:'i18n.translations'), class: 'btn btn-sm btn-primary', no_text: true %>
                   HTML
 )

data/app/views/spree/admin/translations/_fields.html.erb

@@ -1,11 +1,12 @@
+<% resource_class ||= @resource.class %>
 <div class="panel panel-default fields">
   <div class="panel-heading">
     <%= Spree.t(:'i18n.fields') %>
   </div>
   <div class="list-group" id="attr_list">
-    <% @resource.class.mobility_attributes.each_with_index do |attr, i| %>
+    <% resource_class.mobility_attributes.each_with_index do |attr, i| %>
       <a class="list-group-item <%= 'active' if i.zero? %>" data-attr="<%= attr %>" href="#">
-        <%= @resource.class.human_attribute_name(attr) %>
+        <%= resource_class.human_attribute_name(attr) %>
       </a>
     <% end %>
   </div>

data/app/views/spree/admin/translations/_form_fields.html.erb

@@ -1,11 +1,12 @@
+<% resource_class ||= @resource.class %>
 <div id="attr_fields">
   <% available_locales.each do |locale| %>
     <%= f.mobility_fields_for locale.to_sym do |g| %>
-      <% @resource.class.mobility_attributes.each_with_index do |attr, i| %>
+      <% resource_class.mobility_attributes.each_with_index do |attr, i| %>
         <div class="panel panel-default <%= attr %> <%= locale %>" style="display:<%= i == 0 ? 'auto' : 'none' %>;">
           <div class="panel-heading">
             <% I18n.with_locale(locale) do %>
-              <%= @resource.class.human_attribute_name(attr) %>
+              <%= resource_class.human_attribute_name(attr) %>
 
               <div class="pull-right text-muted">
                 <small><i><%= Spree.t(:'i18n.this_file_language') %></i></small>
@@ -14,11 +15,11 @@
           </div>
 
           <div class="panel-body">
-            <% field_type = @resource.class.translation_class.columns_hash[attr.to_s].type %>
+            <% field_type = resource_class.translation_class.columns_hash[attr.to_s].type %>
             <% if @resource.kind_of?(Spree::Product) && attr.to_sym == :description %>
-              <%= g.text_area :description, { rows: "30", class: "form-control #{"spree-rte" if Spree::Config[:product_wysiwyg_editor_enabled] }" } %>
+              <%= g.text_area :description, { rows: "30", class: "form-control #{"spree-rte" if SpreeMobility.product_wysiwyg_editor_enabled? }" } %>
             <% elsif @resource.kind_of?(Spree::Taxon) && attr.to_sym == :description %>
-              <%= g.text_area :description, { rows: "30", class: "form-control #{"spree-rte" if Spree::Config[:taxon_wysiwyg_editor_enabled] }" } %>
+              <%= g.text_area :description, { rows: "30", class: "form-control #{"spree-rte" if SpreeMobility.taxon_wysiwyg_editor_enabled? }" } %>
             <% elsif field_type == :text %>
               <%= g.text_area attr, class: 'form-control', rows: 4 %>
             <% else %>

data/app/views/spree/admin/translations/payment_method.html.erb

@@ -0,0 +1,21 @@
+<% content_for :page_title do %>
+  <%= Spree.t(:editing_resource, resource: Spree::PaymentMethod.model_name.human) %>
+<% end %>
+
+<% content_for :page_actions do %>
+  <%= button_link_to Spree.t(:back_to_resource_list, resource: Spree::PaymentMethod.model_name.human), spree.admin_payment_methods_path, class: 'btn-primary', :icon => 'arrow-left' %>
+<% end %>
+
+<%= render 'settings' %>
+
+<div class="row translations">
+  <div class="col-md-4">
+    <%= render 'fields', resource_class: Spree::PaymentMethod %>
+  </div>
+  <div class="col-md-8">
+    <%= form_for [:admin, @resource], url: admin_translate_payment_method_path(@resource), as: :payment_method do |f| %>
+      <%= render 'form_fields', f: f, resource_class: Spree::PaymentMethod %>
+      <%= render 'spree/admin/shared/edit_resource_links' %>
+    <% end %>
+  </div>
+</div>

data/config/initializers/enable_extensions.rb

@@ -16,10 +16,10 @@ Rails.application.config.to_prepare do
   SpreeMobility.prepend_once(::Spree::Promotion, SpreeMobility::CoreExt::Spree::PromotionDecorator)
   SpreeMobility.prepend_once(::Spree::Property, SpreeMobility::CoreExt::Spree::PropertyDecorator)
   SpreeMobility.prepend_once(::Spree::ShippingMethod, SpreeMobility::CoreExt::Spree::ShippingMethodDecorator)
+  SpreeMobility.prepend_once(::Spree::PaymentMethod, SpreeMobility::CoreExt::Spree::PaymentMethodDecorator)
   SpreeMobility.prepend_once(::Spree::Store, SpreeMobility::CoreExt::Spree::StoreDecorator)
   SpreeMobility.prepend_once(::Spree::Taxon, SpreeMobility::CoreExt::Spree::TaxonDecorator)
   SpreeMobility.prepend_once(::Spree::Taxonomy, SpreeMobility::CoreExt::Spree::TaxonomyDecorator)
   SpreeMobility.prepend_once(::Spree::Variant.singleton_class, SpreeMobility::CoreExt::Spree::VariantDecorator::ClassMethods)
   SpreeMobility.prepend_once(::Spree::Products::Find, SpreeMobility::CoreExt::Spree::Products::FindWithMobilityDecorator)
 end
-  

data/config/routes.rb

@@ -3,5 +3,6 @@ Spree::Core::Engine.add_routes do
     get '/:resource/:resource_id/translations' => 'translations#index', as: :translations
     patch '/option_values/:id' => 'option_values#update', as: :option_type_option_value
     patch 'product/:id/product_properties/:id' => "product_properties#translate", as: :translate_product_property
+    patch 'payment_methods/:id/translate' => "payment_method_translations#translate", as: :translate_payment_method
   end
 end

data/db/migrate/20220309003419_add_translations_to_payment_method.rb

@@ -0,0 +1,54 @@
+class AddTranslationsToPaymentMethod < SpreeExtension::Migration[4.2]
+  def up
+    unless table_exists?(:spree_payment_method_translations)
+      params = { name: :string, description: :text }
+      create_translation_table(:spree_payment_method, params)
+      migrate_data(Spree::PaymentMethod, params)
+    end
+  end
+
+  def down
+    drop_table :spree_payment_method_translations
+  end
+
+  protected
+
+  def create_translation_table(table, params)
+    create_table :"#{table}_translations" do |t|
+
+      # Translated attribute(s)
+      params.each_pair do |attr, attr_type|
+        t.send attr_type, attr
+      end
+
+      t.string  :locale, null: false
+      t.references table, null: false, foreign_key: true, index: false
+
+      t.timestamps null: false
+    end
+
+    add_index :"#{table}_translations", :locale, name: :"index_#{table}_translations_on_locale"
+    add_index :"#{table}_translations", [:"#{table}_id", :locale], name: :"index_#{table}_translations_on_id_and_locale", unique: true
+  end
+
+  def migrate_data(model_klass, fields)
+    store = Spree::Store.unscoped.first
+    return unless store
+    default_locale = store.default_locale.to_s
+    field_names = fields.keys + ['created_at', 'updated_at']
+    translation_table = "#{model_klass.table_name.singularize}_translations"
+    foreign_key = "#{model_klass.table_name.singularize}_id"
+
+    # In case we are migrating from Globalize with existing translations, skip this step
+    return if ActiveRecord::Base.connection.execute("SELECT id FROM #{translation_table}").any?
+    ActiveRecord::Base.connection.execute("SELECT id, #{field_names.join(',')} FROM #{model_klass.table_name}").each do |r|
+      field_values =
+        field_names.each_with_object([]) do |field_name, a|
+          a << r[field_name.to_s]
+        end
+
+      ActiveRecord::Base.connection.execute(ActiveRecord::Base.sanitize_sql_array(["INSERT INTO #{translation_table} (locale, #{foreign_key}, #{field_names.join(',')}) VALUES (?,?,#{(['?'] * field_names.size).join(',')})",
+        default_locale.to_s, r['id'], *field_values]))
+    end
+  end
+end

data/lib/spree_mobility/core_ext/spree/payment_method_decorator.rb

@@ -0,0 +1,10 @@
+module SpreeMobility::CoreExt::Spree::PaymentMethodDecorator
+  def self.prepended(base)
+    base.include SpreeMobility::Translatable
+    SpreeMobility.translates_for base, :name, :description
+
+    base.translation_class.class_eval do
+      validates :name, presence: true
+    end
+  end
+end

data/lib/spree_mobility/version.rb

@@ -9,7 +9,7 @@ module SpreeMobility
 
   module VERSION
     MAJOR = 1
-    MINOR = 1
+    MINOR = 4
     TINY  = 0
     PRE   = nil # 'beta'
 

data/lib/spree_mobility.rb

@@ -9,13 +9,13 @@ module SpreeMobility
   def self.prepend_once(to_klass, klass)
     to_klass.prepend(klass) unless to_klass.ancestors.include?(klass)
   end
-  
+
   def self.clear_validations_for(klass, *attrs)
     attrs.each do |attr|
       klass.validators_on(attr).each { |val| val.attributes.delete(attr) }
     end
   end
-  
+
   def self.translates_for(klass, *attrs)
     klass.translates(*attrs)
     klass.accepts_nested_attributes_for :translations
@@ -44,4 +44,20 @@ module SpreeMobility
     end
     result
   end
-end
+
+  def self.product_wysiwyg_editor_enabled?
+    spree_backend_config :product_wysiwyg_editor_enabled
+  end
+
+  def self.taxon_wysiwyg_editor_enabled?
+    spree_backend_config :taxon_wysiwyg_editor_enabled
+  end
+
+  def self.spree_backend_config(key)
+    if defined?(Spree::Backend::Config) && Spree::Backend::Config.has_preference?(key)
+      Spree::Backend::Config[key]
+    else
+      Spree::Config[key]
+    end
+  end
+end

data/spec/models/translated_models_spec.rb

@@ -30,4 +30,8 @@ module Spree
   RSpec.describe Spree::ShippingMethod, type: :model do
     include_context 'behaves as translatable'
   end
+
+  RSpec.describe Spree::PaymentMethod, type: :model do
+    include_context 'behaves as translatable'
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spree_mobility
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Jan Berdajs
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-12 00:00:00.000000000 Z
+date: 2022-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: spree_core
@@ -194,6 +194,7 @@ files:
 - app/assets/javascripts/spree/backend/translations.js
 - app/controllers/concerns/spree_mobility/controller_mobility_helper.rb
 - app/controllers/spree/admin/option_values_controller_decorator.rb
+- app/controllers/spree/admin/payment_method_translations_controller.rb
 - app/controllers/spree/admin/product_properties_controller_decorator.rb
 - app/controllers/spree/admin/shipping_methods_controller_decorator.rb
 - app/controllers/spree/admin/translations_controller.rb
@@ -203,6 +204,7 @@ files:
 - app/models/concerns/spree_mobility/translatable.rb
 - app/overrides/spree/admin/option_types/_option_value_fields/add_translation.rb
 - app/overrides/spree/admin/option_types/index/add_translation.rb
+- app/overrides/spree/admin/payment_methods/index/add_translation.rb
 - app/overrides/spree/admin/product_properties/_product_property_fields/add_translation.rb
 - app/overrides/spree/admin/promotions/index/add_translation_link.rb
 - app/overrides/spree/admin/properties/index/add_translation.rb
@@ -217,6 +219,7 @@ files:
 - app/views/spree/admin/translations/_settings.html.erb
 - app/views/spree/admin/translations/option_type.html.erb
 - app/views/spree/admin/translations/option_value.html.erb
+- app/views/spree/admin/translations/payment_method.html.erb
 - app/views/spree/admin/translations/product.html.erb
 - app/views/spree/admin/translations/product_property.html.erb
 - app/views/spree/admin/translations/promotion.html.erb
@@ -237,6 +240,7 @@ files:
 - config/locales/ru.yml
 - config/locales/zh-TW.yml
 - config/routes.rb
+- db/migrate/20220309003419_add_translations_to_payment_method.rb
 - db/migrate/20220411041407_add_translations_to_main_models.rb
 - db/migrate/20220412095648_remove_null_constraints_from_spree_tables.rb
 - db/migrate/20220413095648_migrate_translation_data.rb
@@ -248,6 +252,7 @@ files:
 - lib/spree_mobility/core_ext/mobility/backends/active_record/table/mobility_acts_as_paranoid_decorator.rb
 - lib/spree_mobility/core_ext/spree/option_type_decorator.rb
 - lib/spree_mobility/core_ext/spree/option_value_decorator.rb
+- lib/spree_mobility/core_ext/spree/payment_method_decorator.rb
 - lib/spree_mobility/core_ext/spree/product_decorator.rb
 - lib/spree_mobility/core_ext/spree/product_property_decorator.rb
 - lib/spree_mobility/core_ext/spree/product_scopes_with_mobility_decorator.rb