spree_mobility 1.0.0

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

@@ -0,0 +1,12 @@
+module SpreeMobility::CoreExt::Spree::StoreDecorator
+  def self.prepended(base)
+    base.include SpreeMobility::Translatable
+    if ::ApplicationRecord.connected? && ::ApplicationRecord.connection.table_exists?(:spree_store_translations)
+      SpreeMobility.translates_for base, :name, :meta_description, :meta_keywords, :seo_title
+      
+      base.translation_class.class_eval do
+        validates :name, presence: true
+      end
+    end
+  end
+end

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

@@ -0,0 +1,54 @@
+module SpreeMobility::CoreExt::Spree::TaxonDecorator
+  module TranslationMethods
+    def permalink_uniqueness_validation
+      return unless permalink.present?
+      return unless translated_model
+      check_scope =
+        ::Spree::Taxon.
+        where.not(id: translated_model.id).
+        where(parent_id: translated_model.parent_id,
+          taxonomy_id: translated_model.taxonomy_id).
+        joins(:translations).
+        where(spree_taxon_translations: { locale: locale }).
+        where('LOWER(spree_taxon_translations.permalink) = LOWER(?)', permalink)
+      if check_scope.exists?
+        errors.add(:permalink, :taken, value: permalink)
+      end
+    end
+    
+    def name_uniqueness_validation
+      return unless name.present?
+      return unless translated_model
+      check_scope =
+        ::Spree::Taxon.
+        where.not(id: translated_model.id).
+        where(parent_id: translated_model.parent_id,
+          taxonomy_id: translated_model.taxonomy_id).
+        joins(:translations).
+        where(spree_taxon_translations: { locale: locale }).
+        where('LOWER(spree_taxon_translations.name) = LOWER(?)', name)
+      if check_scope.exists?
+        errors.add(:name, :taken, value: name)
+      end
+    end
+  end
+
+  def self.prepended(base)
+    base.include SpreeMobility::Translatable
+    SpreeMobility.translates_for base, :name, :description, :meta_title,
+      :meta_description, :meta_keywords, :permalink
+    base.friendly_id :permalink, slug_column: :permalink, use: [:history, :mobility]
+    
+    base.translation_class.class_eval do
+      include TranslationMethods
+      validates :name, presence: true
+      validate :name_uniqueness_validation
+      with_options length: { maximum: 255 }, allow_blank: true do
+        validates :meta_keywords
+        validates :meta_description
+        validates :meta_title
+      end
+      validate :permalink_uniqueness_validation
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+module SpreeMobility::CoreExt::Spree::TaxonomyDecorator
+  module TranslationMethods
+    def name_uniqueness_validation
+      return unless name.present?
+      return unless translated_model
+      check_scope =
+        ::Spree::Taxonomy.
+        where.not(id: translated_model.id).
+        where(store_id: translated_model.store_id).
+        joins(:translations).
+        where(spree_taxonomy_translations: { locale: locale }).
+        where('LOWER(spree_taxonomy_translations.name) = LOWER(?)', name)
+      if check_scope.exists?
+        errors.add(:name, :taken, value: name)
+      end
+    end
+  end
+  
+  def self.prepended(base)
+    base.include SpreeMobility::Translatable
+    SpreeMobility.translates_for base, :name
+    
+    base.translation_class.class_eval do
+      include TranslationMethods
+      validates :name, presence: true
+      validate :name_uniqueness_validation
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+module SpreeMobility::CoreExt::Spree
+  module VariantDecorator
+    module ClassMethods
+      def product_name_or_sku_cont(query)
+        helper =
+          SpreeMobility::TranslationQuery.new(
+            ::Spree::Product.mobility_backend_class(:name))
+
+        helper.add_joins(self.joins(:product)).
+        where(
+          "(LOWER(#{helper.col_name(:name)}) LIKE LOWER(:query)) OR (LOWER(#{::Spree::Variant.table_name}.sku) LIKE LOWER(:query))", query: "%#{query}%").distinct
+      end
+      
+      def search_by_product_name_or_sku(query)
+        product_name_or_sku_cont(query)
+      end
+    end
+  end
+end

data/lib/spree_mobility/engine.rb

@@ -0,0 +1,33 @@
+require 'mobility'
+require 'friendly_id/mobility'
+
+module SpreeMobility
+  class Engine < Rails::Engine
+    engine_name 'spree_mobility'
+
+    config.autoload_paths += %W(#{config.root}/lib)
+
+    initializer "spree_mobility.environment", before: :load_config_initializers do |app|
+      SpreeMobility::Config = SpreeMobility::Configuration.new
+    end
+
+    initializer "spree_mobility.permitted_attributes", before: :load_config_initializers do |app|
+      taxon_attributes = { translations_attributes: [:id, :locale, :name, :description, :permalink, :meta_description, :meta_keywords, :meta_title] }
+      Spree::PermittedAttributes.taxon_attributes << taxon_attributes
+
+      option_value_attributes = { translations_attributes: [:id, :locale, :name, :presentation] }
+      Spree::PermittedAttributes.option_value_attributes << option_value_attributes
+
+      store_attributes = { translations_attributes: [:id, :locale, :name, :meta_description, :meta_keywords, :seo_title] }
+      Spree::PermittedAttributes.store_attributes << store_attributes
+    end
+
+    def self.activate
+      Dir.glob(File.join(root, "app/**/*_decorator*.rb")) do |c|
+        Rails.configuration.cache_classes ? require(c) : load(c)
+      end
+    end
+
+    config.to_prepare &method(:activate).to_proc
+  end
+end

data/lib/spree_mobility/fallbacks.rb

@@ -0,0 +1,45 @@
+module SpreeMobility
+  module Fallbacks
+    # Prevents the app from breaking when a translation is not present on the
+    # default locale. It should search for translations in all supported
+    # locales
+    #
+    # It needs to build a proper key value hash for every locale. So that a locale
+    # always fallbacks to itself first before looking at the default and then
+    # to any other. e.g
+    #
+    #   supported_locales = [:es, :de, :en]
+    #
+    #   # right
+    #   { en: [:en, :de, :es], es: [:es, :en, :de] .. }
+    #
+    #   # wrong, spanish locale would fallback to english first
+    #   { en: [:en, :es], es: [:en, :es] }
+    #
+    #   # wrong, spanish locale would fallback to german first instead of :en (default)
+    #   { en: [:en, :de, :es], es: [:es, :de, :en] .. }
+    #
+    def self.config!
+      supported = if Spree::Store.respond_to?(:available_locales) && Spree::Store.available_locales.any?
+                    Spree::Store.available_locales
+                  else
+                    Config.supported_locales
+                  end
+      default = I18n.default_locale.to_s
+
+      fallbacks_map = supported.inject({}) do |fallbacks, locale|
+        if locale == default
+          fallbacks.merge(locale => (supported-[locale]).flatten)
+        else
+          fallbacks.merge(locale => [default].push(supported-[locale, default]).flatten)
+        end
+      end
+      
+      Mobility.configure do
+        plugins do
+          fallbacks fallbacks_map
+        end
+      end
+    end
+  end
+end

data/lib/spree_mobility/translation_query.rb

@@ -0,0 +1,36 @@
+module SpreeMobility
+  class TranslationQuery
+    def initialize(mobility_backend_class)
+      @mobility_backend_class = mobility_backend_class
+    end
+
+    def add_joins(search_scope)
+      fallback_locales.each do |locale|
+        search_scope =
+          @mobility_backend_class.
+          send(:join_translations, search_scope, locale, ::Arel::Nodes::OuterJoin)
+      end
+      search_scope
+    end
+
+    def col_name(attr)
+      select_columns = []
+      fallback_locales.each do |locale|
+        select_columns << "#{table_alias(locale)}.#{attr}"
+      end
+      "COALESCE(#{select_columns.join(',')})"
+    end
+
+    private
+
+    def fallback_locales
+      # Cache this result, since Mobility.locale will not change
+      # during this class's lifetime
+      @fallback_locales ||= SpreeMobility.locale_with_fallbacks
+    end
+
+    def table_alias(locale)
+      @mobility_backend_class.table_alias(locale)
+    end
+  end
+end

data/lib/spree_mobility/version.rb

@@ -0,0 +1,18 @@
+module SpreeMobility
+  module_function
+
+  # Returns the version of the currently loaded SpreeMobility as a
+  # <tt>Gem::Version</tt>.
+  def version
+    Gem::Version.new VERSION::STRING
+  end
+
+  module VERSION
+    MAJOR = 1
+    MINOR = 0
+    TINY  = 0
+    PRE   = nil # 'beta'
+
+    STRING = [MAJOR, MINOR, TINY, PRE].compact.join('.')
+  end
+end

data/lib/spree_mobility.rb

@@ -0,0 +1,47 @@
+require 'spree_i18n'
+require 'spree_mobility/engine'
+require 'spree_mobility/version'
+require 'spree_mobility/fallbacks'
+require 'spree_mobility/translation_query'
+require 'deface'
+
+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
+    klass.whitelisted_ransackable_associations ||= []
+    klass.whitelisted_ransackable_associations << 'translations'
+    clear_validations_for(klass, *attrs)
+
+    # used for preloading only current locale and its fallbacks
+    translations_assoc = klass.reflect_on_association(:translations)
+    klass.has_many :active_translations,
+      -> { where(locale: SpreeMobility.locale_with_fallbacks) },
+      class_name:  translations_assoc.class_name,
+      inverse_of:  translations_assoc.inverse_of.name,
+      foreign_key: translations_assoc.foreign_key
+  end
+
+  def self.locale_with_fallbacks
+    result = [::Mobility.locale]
+    begin
+      # At the moment the easiest way to access Mobility fallbacks properly
+      # is through a translated model's attribute
+      backend = ::Spree::Product.mobility_backend_class(:name)
+      result.concat(backend.fallbacks[::Mobility.locale])
+      result.uniq!
+    rescue KeyError # backend not found
+    end
+    result
+  end
+end

data/spec/features/admin/products_spec.rb

@@ -0,0 +1,15 @@
+RSpec.feature "Products", :js do
+  stub_authorization!
+  given!(:product) { create(:product) }
+  given!(:store) { create(:store) }
+
+  # Regression Spec: https://github.com/spree/spree_i18n/issues/386
+  context "cloning" do
+    xscenario "doesnt blow up" do
+      visit spree.admin_products_path
+      click_icon :clone
+
+      expect(page).to have_text_like 'has been cloned'
+    end
+  end
+end

data/spec/features/admin/translations_spec.rb

@@ -0,0 +1,259 @@
+RSpec.feature "Translations", :js do
+  stub_authorization!
+
+  given(:language) { Spree.t(:this_file_language, scope: 'i18n', locale: 'pt-BR') }
+  given!(:store) { create(:store) }
+
+  background do
+    [:en, :'pt-BR'].each do |locale|
+      create(:store, default_locale: locale)
+    end
+  end
+
+  context "products" do
+    given(:product) { create(:product) }
+
+    context "fills in translations fields" do
+      scenario "saves translated attributes properly" do
+        visit spree.admin_product_path(product)
+        click_on "Translations"
+
+        within("#attr_fields .name.en") { fill_in_name "Pearl Jam" }
+        within("#attr_fields .name.pt-BR") { fill_in_name "Geleia de perola" }
+        click_on "Update"
+
+        visit spree.admin_translations_path('products', product.id)
+        select2 'Português (pt-BR)', from: 'Select locale'
+
+        expect(page).to have_selector("input[value='Geleia de perola']")
+      end
+    end
+
+    context "product properties" do
+      given!(:product_property) { create(:product_property, value: "red") }
+
+      xscenario "saves translated attributes properly" do
+        visit spree.admin_product_product_properties_path(product_property.product)
+        within_row(1) { click_icon :translate }
+
+        within("#attr_fields .value.pt-BR") { fill_in_name "vermelho" }
+        click_on "Update"
+        visit spree.admin_product_product_properties_path(product_property.product)
+
+        expect(page).to have_selector("input[value=vermelho]")
+      end
+    end
+
+    context "option types" do
+      given!(:option_type) { create(:option_value).option_type }
+
+      scenario "saves translated attributes properly" do
+        visit spree.admin_option_types_path
+        within_row(1) { click_icon :translate }
+
+        within("#attr_fields .name.en") { fill_in_name "shirt sizes" }
+        within("#attr_list") { click_on "Presentation" }
+        within("#attr_fields .presentation.en") { fill_in_name "size" }
+        within("#attr_fields .presentation.pt-BR") { fill_in_name "tamanho" }
+        click_on "Update"
+        visit spree.admin_translations_path('option_types', option_type.id)
+        select2 'Português (pt-BR)', from: 'Select locale'
+        click_on 'Presentation'
+
+        expect(page).to have_selector("input[value=tamanho]")
+      end
+
+      # Regression test for issue #354
+      scenario "successfully creates an option type and go to its edit page" do
+        visit spree.admin_option_types_path
+        click_link "New Option Type"
+        fill_in "Name", with: "Shirt Size"
+        fill_in "Presentation", with: "Sizes"
+        click_button "Create"
+
+        expect(page).to have_text_like 'has been successfully created'
+        expect(page).to have_text_like 'Option Values'
+      end
+    end
+
+    context "option values" do
+      given!(:option_type) { create(:option_value).option_type }
+
+      scenario "saves translated attributes properly" do
+        visit spree.admin_option_types_path
+        within_row(1) { click_icon :translate }
+
+        within("#attr_fields .name.en") { fill_in_name "big" }
+        within("#attr_list") { click_on "Presentation" }
+        within("#attr_fields .presentation.en") { fill_in_name "big" }
+        within("#attr_fields .presentation.pt-BR") { fill_in_name "grande" }
+        click_on "Update"
+
+        visit spree.admin_translations_path('option_types', option_type.id)
+        select2 'Português (pt-BR)', from: 'Select locale'
+        click_on 'Presentation'
+
+        expect(page).to have_selector("input[value=grande]")
+      end
+    end
+
+    context "properties" do
+      given!(:property) { create(:property) }
+
+      scenario "saves translated attributes properly" do
+        visit spree.admin_properties_path
+        within_row(1) { click_icon :translate }
+
+        within("#attr_fields .name.pt-BR") { fill_in_name "Modelo" }
+        within("#attr_list") { click_on "Presentation" }
+        within("#attr_fields .presentation.en") { fill_in_name "Model" }
+        within("#attr_fields .presentation.pt-BR") { fill_in_name "Modelo" }
+        click_on "Update"
+        visit spree.admin_translations_path('properties', property.id)
+        select2 'Português (pt-BR)', from: 'Select locale'
+
+        expect(page).to have_selector("input[value=Modelo]")
+      end
+    end
+  end
+
+  context "promotions" do
+    given!(:promotion) { create(:promotion) }
+
+    scenario "saves translated attributes properly" do
+      visit spree.admin_promotions_path
+      within_row(1) { click_icon :translate }
+
+      within("#attr_fields .name.en") { fill_in_name "All free" }
+      within("#attr_fields .name.pt-BR") { fill_in_name "Salve salve" }
+      click_on "Update"
+      visit spree.admin_translations_path('promotions', promotion.id)
+      select2 'Português (pt-BR)', from: 'Select locale'
+      expect(page).to have_selector("input[value='Salve salve']")
+    end
+
+    it "render edit route properly" do
+      visit spree.admin_promotions_path
+      within_row(1) { click_icon :translate }
+      click_on 'Cancel'
+
+      expect(page).to have_css('.content-header')
+    end
+  end
+
+  context "taxonomies" do
+    given!(:taxonomy) { create(:taxonomy) }
+
+    scenario "saves translated attributes properly" do
+      visit spree.admin_taxonomies_path
+      within_row(1) { click_icon :translate }
+
+      within("#attr_fields .name.en") { fill_in_name "Guitars" }
+      within("#attr_fields .name.pt-BR") { fill_in_name "Guitarras" }
+      click_on "Update"
+
+      visit spree.admin_translations_path('taxonomies', taxonomy.id)
+      select2 'Português (pt-BR)', from: 'Select locale'
+
+      expect(page).to have_selector("input[value=Guitarras]")
+    end
+  end
+
+  context 'taxons' do
+    given!(:taxonomy) { create(:taxonomy) }
+    given!(:taxon) { create(:taxon, taxonomy: taxonomy, parent_id: taxonomy.root.id) }
+
+    scenario "saves translated attributes properly" do
+      visit spree.admin_translations_path('taxons', taxon.id)
+
+      within("#attr_fields .name.en") { fill_in_name "Acoustic" }
+      within("#attr_fields .name.pt-BR") { fill_in_name "Acusticas" }
+      click_on "Update"
+
+      visit spree.admin_translations_path('taxons', taxon.id)
+
+      # ensure we're not duplicating translated records on database
+      expect {
+        click_on "Update"
+      }.not_to change { taxon.translations.count }
+
+      # ensure taxon is in root or it will not be visible
+      expect(taxonomy.root.children.count).to be(1)
+
+      visit spree.admin_translations_path('taxons', taxon.id)
+      select2 'Português (pt-BR)', from: 'Select locale'
+
+      expect(page).to have_selector("input[value=Acusticas]")
+    end
+  end
+
+  context "store" do
+    scenario 'saves translated attributes properly' do
+      visit spree.admin_translations_path('stores', store.id)
+
+      within("#attr_fields .name.pt-BR") { fill_in_name "nome store" }
+
+      click_on "Update"
+
+      visit spree.admin_translations_path('stores', store.id)
+      select2 'Português (pt-BR)', from: 'Select locale'
+
+      expect(page).to have_selector("input[value='nome store']")
+    end
+  end
+
+  context "shipping methods" do
+    given(:shipping_category) { create(:shipping_category) }
+    given!(:shipping_method) { create(:shipping_method, shipping_categories:[shipping_category]) }
+
+    scenario 'saves translated attributes properly' do
+      visit spree.admin_translations_path('shipping_methods', shipping_method.id)
+
+      within("#attr_fields .name.en") { fill_in_name "Urgent elivery" }
+      within("#attr_fields .name.pt-BR") { fill_in_name "Entrega urgente" }
+      click_on "Update"
+
+      visit spree.admin_translations_path('shipping_methods', shipping_method.id)
+      select2 'Português (pt-BR)', from: 'Select locale'
+      expect(page).to have_selector("input[value='Entrega urgente']")
+    end
+
+    it "render edit route properly" do
+      visit spree.admin_shipping_methods_path
+      within_row(1) { click_icon :translate }
+      click_on 'Cancel'
+
+      expect(page).to have_css('.content-header')
+    end
+  end
+
+  context "permalink routing" do
+    given(:language) { Spree.t(:this_file_language, scope: 'i18n', locale: 'de') }
+    given(:product) { create(:product) }
+
+    scenario "finds the right product with permalink in a not active language" do
+      [:en, :de].each do |locale|
+        create(:store, default_locale: locale)
+      end
+
+      visit spree.admin_product_path(product)
+      click_on "Translations"
+      click_on "Slug"
+      within("#attr_fields .slug.en") { fill_in_name "en_link" }
+      within("#attr_fields .slug.de") { fill_in_name "de_link" }
+      click_on "Update"
+
+      visit spree.product_path 'en_link'
+      expect(page).to have_text_like 'Product'
+
+      visit spree.product_path 'de_link'
+      expect(page).to have_text_like 'Product'
+    end
+  end
+
+  private
+
+  def fill_in_name(value)
+    fill_in first("input[type='text']")["name"], with: value
+  end
+end

data/spec/features/translations_spec.rb

@@ -0,0 +1,35 @@
+# encoding: utf-8
+RSpec.feature "Translations" do
+  before do
+    Spree::Store.update_all(default_locale: 'pt-BR')
+  end
+
+  context 'product' do
+    let!(:store) { create(:store, default: true, default_locale: 'pt-BR', supported_locales: 'pt-BR', url:'http://www.example.com') }
+    let!(:product) do
+      create(:product,
+        name: 'Antimatter',
+        meta_title: 'Antimatter meta_title',
+        meta_description: 'Antimatter meta_description',
+        translations: [
+          Spree::Product::Translation.new(
+            locale: 'pt-BR',
+            name: 'Antimatéria',
+            meta_title: 'Antimatéria meta_title',
+            meta_description: 'Antimatéria meta_description'
+          )
+        ]
+      )
+    end
+
+    scenario 'displays translated product page', js: true do
+      visit '/products/antimatter'
+      expect(page.title).to have_content('Antimatéria')
+    end
+
+    scenario 'displays translated products list', js: true do
+      visit '/products'
+      expect(page).to have_content('Antimatéria')
+    end
+  end
+end

data/spec/models/product_spec.rb

@@ -0,0 +1,77 @@
+# encoding: utf-8
+
+module Spree
+  RSpec.describe Product, type: :model do
+    let(:product) { create(:product) }
+    let(:taxon) { create(:taxon) }
+
+    # Regression test for #309
+    xit "duplicates translations" do
+      original_count = product.translations.count
+      new_product = product.duplicate
+      expect(new_product.translations).not_to be_blank
+      expect(product.translations.count).to eq original_count
+    end
+
+    # Regression test for #433
+    it "allow saving a product with taxons" do
+      product.taxons << taxon
+      expect(product.taxons).to include(taxon)
+    end
+
+    it "handle translation in ransack" do
+      result = described_class.ransack(name_cont: product.name[0..2]).result
+      expect(result.first).to eq product
+
+      result = described_class.search(name_cont: product.name[0..2]).result
+      expect(result.first).to eq product
+    end
+
+    # Regression tests for #466
+    describe ".like_any" do
+      context "allow searching products through their translations" do
+        before do
+          I18n.locale = :"zh-CN"
+        end
+
+        it "with name" do
+          product.translations.create locale: "zh-CN",
+                                      name: "创意马克杯",
+                                      description: "<p>一流工程师设计制造手工艺品</p>",
+                                      meta_description: '顶尖工艺设计',
+                                      meta_keywords: '工艺品'
+
+          expect(Product.like_any([:name], ['创意'])).to include(product)
+        end
+
+        it "with name or description" do
+          product.translations.create locale: "zh-CN",
+                                      name: "创意马克杯",
+                                      description: "<p>一流工程师设计制造手工艺品</p>",
+                                      meta_description: '顶尖工艺设计',
+                                      meta_keywords: '工艺品'
+
+          expect(Product.like_any([:name, :description], ['手工艺品'])).to include(product)
+        end
+      end
+    end
+
+    context "soft-deletion" do
+      subject do
+        product.destroy
+        product.reload
+      end
+
+      it "keeps the translation on deletion" do
+        subject
+        expect(product.translations).not_to be_empty
+      end
+
+      it "changes the slug on the translation to allow reuse of original slug" do
+        expect do
+          subject
+        end.to change { product.slug }
+      end
+    end
+  end
+end