spree_mobility 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 022505f406f3f9336ed07f01f2e991a46d04d21fb8c6a8320dc4b3c79093b227
-  data.tar.gz: 4bd438df89aad4b7be914cf0e8e40b128b67ac70409d99bc5a775d0841d95a0a
+  metadata.gz: 30f3cdb07e980914cb9e50dc2ac6f2ece8ab75547b12f811e772bfacb06a0942
+  data.tar.gz: 2d4091a9e0399685cdfbab7f3df2c7067f567a32d133eb94f41d473caf9efbf4
 SHA512:
-  metadata.gz: db5144c00d20a57c15a5ce19de8b507d8cf56195ca5c1de4dcb554fb21f4127713fefbb4ed3e2817aa3be5b2335916c7b544e7d363929d5042e9c37622bf2313
-  data.tar.gz: 0cd224a84e281656efd79977715d2c688fa068ff846cea76b84f9a9506e77fb6adc1b09bc6ecf86d6e0ca51e92bbb5ce466a4c0e162745de2816e355b67dc9b2
+  metadata.gz: ddd330d66753f527b3f705a0957389f3f8b2cda6f410acfd3faa9e120a45583c98969f352fee5a4b9e44972c10bf6d42ff31ef03a5b42973330beeb0f3832913
+  data.tar.gz: cabd47580f96da77e9dc017f421a2b56f47f70e8e46f074569b3900afeb961a77118cbaa68d3ab0f11416e3e0ae6c3a96f035fc7e39441053712308bc7f77bc8

data/.gitignore

@@ -20,3 +20,4 @@ public/spree
 .ruby-gemset
 .bundle
 gemfiles/*.gemfile.lock
+/*.gem

data/README.md

@@ -4,22 +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.
 
-## Improvements
-
-This gem offers several improvements over `spree_globalize`:
-
-* Proper translation fallbacks support (if a translation for the current locale is missing, it will fallback to other locales, strictly based on configured fallbacks):
-  * for finders (slug/permalink)
-  * when searching by product name (frontend & admin search)
-* Proper validations on translation models (e.g. slug presence validation), also meaning uniqueness validations will now work correctly per-locale
-* Better support for future versions of Rails as `mobility` is more actively maintained
-
-Admin:
-
-* Rich-text editor for product description translations in admin (if enabled)
-* Searching by product SKU in admin
-* Admin product search will no longer return duplicate results
-* Works correctly if using custom Spree.admin_path config
+Currently, this gem is tested with Spree 4.3.1.
 
 ## Installation
 
@@ -38,16 +23,9 @@ your app spree manifest file.
 
     rails g spree_mobility:install
 
-This will insert these lines into your spree manifest files:
-
-```
-vendor/assets/javascripts/spree/backend/all.js
-//= require spree/backend/spree_mobility
-```
-
 It is also recommended to configure Mobility fallback locales, especially if your admin locale is not the same as your Store's default_locale. For example if you have en and de locale:
 
-```
+```ruby
 # config/initializers/mobility.rb
 Mobility.configure do
   plugins do
@@ -58,6 +36,24 @@ end
 
 ---
 
+## Improvements over spree_globalize
+
+This gem offers several improvements over `spree_globalize`:
+
+* Proper translation fallbacks support (if a translation for the current locale is missing, it will fallback to other locales, strictly based on configured fallbacks):
+  * for finders (slug/permalink)
+  * when searching by product name (frontend & admin search)
+* Proper validations on translation models (e.g. slug presence validation), also meaning uniqueness validations will now work correctly per-locale
+* Better support for future versions of Rails as `mobility` is more actively maintained
+
+Admin:
+
+* Rich-text editor for product description translations in admin (if enabled)
+* Admin product search will no longer return duplicate results
+* Works correctly if using custom Spree.admin_path config
+
+For more localization features, see my `better_spree_localization` gem.
+
 ## Model Translations
 
 This feature uses the [Mobility][3] gem to localize model data.

data/config/initializers/enable_extensions.rb

@@ -1,8 +1,6 @@
 require 'mobility'
 require 'mobility/backends/active_record/table'
 
-Dir[Rails.root.join('lib', 'spree_mobility', 'core_ext', '**', '*.rb')].each { |f| require f }
-
 # Extend library classes
 SpreeMobility.prepend_once(::Mobility::Backends::ActiveRecord::Table.singleton_class,
   SpreeMobility::CoreExt::Mobility::Backends::ActiveRecord::Table::MobilityActsAsParanoidDecorator)

data/config/initializers/spree_ransack.rb

@@ -10,9 +10,9 @@ Rails.application.config.to_prepare do
 
   module SpreeMobilityAdminStoreSearch
     def load_stores_by_query
-      @stores = 
-        stores_scope.joins(:translations).where("LOWER(#{Spree::Store::Translation.table_name}.name) LIKE LOWER(:query)",
-                                                query: "%#{params[:q]}%")
+      @stores =
+        stores_scope.joins(:translations).where("LOWER(#{Spree::Store::Translation.table_name}.name) LIKE ?",
+                                                "%#{params[:q]&.downcase}%")
     end
   end
   Spree::Admin::StoresController.prepend SpreeMobilityAdminStoreSearch
@@ -28,4 +28,4 @@ Rails.application.config.to_prepare do
     end
   end
   Spree::Api::V1::TaxonsController.prepend SpreeMobilityApiV1TaxonSearch
-end
+end

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

@@ -2,10 +2,15 @@ module SpreeMobility::CoreExt::Spree::OptionTypeDecorator
   def self.prepended(base)
     base.include SpreeMobility::Translatable
     SpreeMobility.translates_for base, :name, :presentation
-    
+
     base.translation_class.class_eval do
       validates :name, presence: true, uniqueness: { scope: :locale, case_sensitive: false, allow_blank: true }
       validates :presentation, presence: true
     end
   end
+
+  # Needed for admin
+  def json_api_columns
+    super + ['name', 'presentation']
+  end
 end

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

@@ -9,17 +9,17 @@ module SpreeMobility::CoreExt::Spree::OptionValueDecorator
         where(option_type_id: translated_model.option_type_id).
         joins(:translations).
         where(spree_option_value_translations: { locale: locale }).
-        where('LOWER(spree_option_value_translations.name) = LOWER(?)', name)
+        where('LOWER(spree_option_value_translations.name) = ?', name.downcase)
       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, :presentation
-    
+
     base.translation_class.class_eval do
       include TranslationMethods
       validate :name_uniqueness_validation

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

@@ -4,18 +4,7 @@ module SpreeMobility::CoreExt::Spree
 
     module ClassMethods
       def search_by_name(query)
-        helper = SpreeMobility::TranslationQuery.new(all.model.mobility_backend_class(:name))
-
-        helper.add_joins(self.all).
-        where("LOWER(#{helper.col_name(:name)}) LIKE LOWER(:query)", query: "%#{query}%").distinct
-      end
-    
-      def search_by_name_or_sku(query)
-        helper = SpreeMobility::TranslationQuery.new(all.model.mobility_backend_class(:name))
-
-        helper.add_joins(self.all).
-        joins(:variants_including_master).
-        where("(LOWER(#{helper.col_name(:name)}) LIKE LOWER(:query)) OR (LOWER(#{::Spree::Variant.table_name}.sku) LIKE LOWER(:query))", query: "%#{query}%").distinct
+        like_any([:name], [query]).distinct
       end
 
       def like_any(fields, values)
@@ -24,12 +13,18 @@ module SpreeMobility::CoreExt::Spree
 
         helper = SpreeMobility::TranslationQuery.new(all.model.mobility_backend_class(:name))
         conditions = mobility_fields.product(values).map do |(field, value)|
-          sanitize_sql_array(["LOWER(#{helper.col_name(field)}) LIKE LOWER(?)", "%#{value}%"])
+          sanitize_sql_array(["LOWER(#{helper.col_name(field)}) LIKE ?", "%#{value&.downcase}%"])
+        end
+
+        # From original like_any method
+        conditions += other_fields.product(values).map do |(field, value)|
+          arel_table[field].matches("%#{value}%").to_sql
         end
 
-        scope = other_fields.empty? ? self.all : super(other_fields, values)
+        # Allow further adding/modification of conditions
+        conditions = yield(conditions) if block_given?
 
-        helper.add_joins(scope).where(conditions.join(' OR '))
+        helper.add_joins(self.all).where(conditions.join(' OR '))
       end
     end
 
@@ -37,8 +32,7 @@ module SpreeMobility::CoreExt::Spree
       base.include SpreeMobility::Translatable
       SpreeMobility.translates_for base, :name, :description, :meta_title, :meta_description, :meta_keywords, :slug
       base.friendly_id :slug_candidates, use: [:history, :mobility]
-      base.whitelisted_ransackable_scopes << 'search_by_name_or_sku'
-  
+
       base.translation_class.class_eval do
         acts_as_paranoid
         after_destroy :punch_slug

data/lib/spree_mobility/core_ext/spree/products/find_with_mobility_decorator.rb

@@ -1,12 +1,24 @@
 module SpreeMobility::CoreExt::Spree::Products::FindWithMobilityDecorator
+  private
   # The issue here is that ordering by translated attr (e.g. name) will add
   # an ORDER BY translations_table.name, but the query has a SELECT DISTINCT,
   # which would require the translations_table.name to be added to the SELECT
-  # Instead of using DISTINCT, we select the ID only and use that as a subquery
-  # in a simple SELECT ... FROM products WHERE products.id IN (SUBQUERY).
-  # Performance-wise should be almost the same, or the same.
-  def execute
-    ::Spree::Product.where(id: super.except(:select).select(:id).distinct(false))
+  # So when the order is added, the appropriate SELECT should be added as well.
+  def ordered(products)
+    case sort_by
+    when 'name-a-z'
+      ordered_name(products, :asc)
+    when 'name-z-a'
+      ordered_name(products, :desc)
+    else
+      super
+    end
   end
-end
 
+  def ordered_name(products, direction)
+    helper = SpreeMobility::TranslationQuery.new(::Spree::Product.mobility_backend_class(:name))
+    helper.add_joins(products).
+    select(products.arel.projections, "#{helper.col_name(:name)} AS _name").
+    order(Arel.sql(helper.col_name(:name) + ((direction == :desc) ? ' DESC' : '')))
+  end
+end

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

@@ -10,12 +10,12 @@ module SpreeMobility::CoreExt::Spree::TaxonDecorator
           taxonomy_id: translated_model.taxonomy_id).
         joins(:translations).
         where(spree_taxon_translations: { locale: locale }).
-        where('LOWER(spree_taxon_translations.permalink) = LOWER(?)', permalink)
+        where('LOWER(spree_taxon_translations.permalink) = ?', permalink.downcase)
       if check_scope.exists?
         errors.add(:permalink, :taken, value: permalink)
       end
     end
-    
+
     def name_uniqueness_validation
       return unless name.present?
       return unless translated_model
@@ -26,7 +26,7 @@ module SpreeMobility::CoreExt::Spree::TaxonDecorator
           taxonomy_id: translated_model.taxonomy_id).
         joins(:translations).
         where(spree_taxon_translations: { locale: locale }).
-        where('LOWER(spree_taxon_translations.name) = LOWER(?)', name)
+        where('LOWER(spree_taxon_translations.name) = ?', name.downcase)
       if check_scope.exists?
         errors.add(:name, :taken, value: name)
       end
@@ -38,7 +38,7 @@ module SpreeMobility::CoreExt::Spree::TaxonDecorator
     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

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

@@ -9,17 +9,17 @@ module SpreeMobility::CoreExt::Spree::TaxonomyDecorator
         where(store_id: translated_model.store_id).
         joins(:translations).
         where(spree_taxonomy_translations: { locale: locale }).
-        where('LOWER(spree_taxonomy_translations.name) = LOWER(?)', name)
+        where('LOWER(spree_taxonomy_translations.name) = ?', name.downcase)
       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

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

@@ -8,9 +8,9 @@ module SpreeMobility::CoreExt::Spree
 
         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
+          "(LOWER(#{helper.col_name(:name)}) LIKE :query) OR (LOWER(#{::Spree::Variant.table_name}.sku) LIKE :query)", query: "%#{query&.downcase}%").distinct
       end
-      
+
       def search_by_product_name_or_sku(query)
         product_name_or_sku_cont(query)
       end

data/lib/spree_mobility/version.rb

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

data/spree_mobility.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |s|
   s.author      = 'Jan Berdajs'
   s.email       = 'mrbrdo@mrbrdo.net'
   s.homepage    = 'https://github.com/mrbrdo'
-  s.license     = 'BSD-3'
+  s.license     = 'BSD-3-Clause'
 
   s.files        = `git ls-files`.split("\n")
   s.test_files   = `git ls-files -- spec/*`.split("\n")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spree_mobility
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Jan Berdajs
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-04-22 00:00:00.000000000 Z
+date: 2022-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: spree_core
@@ -204,7 +204,6 @@ files:
 - 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/product_properties/_product_property_fields/add_translation.rb
-- app/overrides/spree/admin/products/index/search_by_name_or_sku.rb
 - app/overrides/spree/admin/promotions/index/add_translation_link.rb
 - app/overrides/spree/admin/properties/index/add_translation.rb
 - app/overrides/spree/admin/shared/_product_tabs/add_translations.rb
@@ -279,7 +278,7 @@ files:
 - spree_mobility.gemspec
 homepage: https://github.com/mrbrdo
 licenses:
-- BSD-3
+- BSD-3-Clause
 metadata: {}
 post_install_message:
 rdoc_options: []

data/app/overrides/spree/admin/products/index/search_by_name_or_sku.rb

@@ -1,21 +0,0 @@
-Deface::Override.new(
-  virtual_path:  'spree/admin/products/index',
-  name:          'search_by_name_or_sku',
-  replace: 'div[data-hook=admin_products_index_search] > div:first-child',
-  text: <<-HTML
-
-        <div class="col-12 col-lg-6">
-          <div class="form-group">
-            <%= f.label :search_by_name_or_sku, Spree.t(:name_or_sku) %>
-            <%= f.text_field :search_by_name_or_sku, size: 15, class: "form-control js-quick-search-target js-filterable" %>
-          </div>
-        </div>
-
-        <div class="col-12 col-lg-6">
-          <div class="form-group">
-            <%= f.label :search_by_name, Spree.t(:product_name) %>
-            <%= f.text_field :search_by_name, size: 15, class: "form-control js-filterable" %>
-          </div>
-        </div>
-        HTML
-)