spree_mobility 1.0.0

data/spec/models/taxon_spec.rb

@@ -0,0 +1,16 @@
+module Spree
+  RSpec.describe Taxon, type: :model do
+    describe '.ransack' do
+      let!(:taxon) { create(:taxon, name: 'find-me') }
+      let!(:other_taxon) { create(:taxon, name: 'no-thanks') }
+
+      it 'handles translation' do
+        result = described_class.ransack(name_cont: taxon.name[0..2]).result
+        expect(result.to_a).to eq [taxon]
+
+        result = described_class.search(name_cont: taxon.name[0..2]).result
+        expect(result.to_a).to eq [taxon]
+      end
+    end
+  end
+end

data/spec/models/translated_models_spec.rb

@@ -0,0 +1,33 @@
+module Spree
+  RSpec.describe Product, type: :model do
+    include_context "behaves as translatable"
+  end
+
+  RSpec.describe OptionType, type: :model do
+    include_context "behaves as translatable"
+  end
+
+  RSpec.describe Taxon, type: :model do
+    include_context "behaves as translatable"
+  end
+
+  RSpec.describe Taxonomy, type: :model do
+    include_context "behaves as translatable"
+  end
+
+  RSpec.describe Promotion, type: :model do
+    include_context "behaves as translatable"
+  end
+
+  RSpec.describe Property, type: :model do
+    include_context "behaves as translatable"
+  end
+
+  RSpec.describe ProductProperty, type: :model do
+    include_context "behaves as translatable"
+  end
+
+  RSpec.describe Spree::ShippingMethod, type: :model do
+    include_context 'behaves as translatable'
+  end
+end

data/spec/models/variant_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+module Spree
+  RSpec.describe Variant do
+    let(:product) do
+      Product.create!(
+        name: 'mobility',
+        price: 19.99,
+        shipping_category: ShippingCategory.create!(name: 'a')
+      )
+    end
+
+    let!(:variant) do
+      Variant.create!(
+        price: 19.99,
+        product: product
+      )
+    end
+
+    # this test is invalid, should be removed or changed
+    #  see https://github.com/spree-contrib/spree_mobility/commit/87802a97c8ee82f5444243467faf2a8faa8236f6#commitcomment-12963401
+    xit 'fetches variant from product via translation table' do
+      product_relation = Product.where(name: "mobility")
+      variant_relation = described_class.joins(:product).merge(product_relation)
+      described_class.includes(:product).ransack(name_cont: 'mobility').result.to_a
+
+      expect(variant_relation.last).to eq variant
+
+      variants = described_class.includes(:product).ransack(name_cont: 'mobility').result.to_a
+      expect(variants.last).to eq variant
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+# Configure Rails Environment
+ENV['RAILS_ENV'] = 'test'
+
+require File.expand_path('../dummy/config/environment.rb', __FILE__)
+
+require 'spree_dev_tools/rspec/spec_helper'
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir[File.join(File.dirname(__FILE__), 'support/**/*.rb')].sort.each { |f| require f }

data/spec/support/i18n.rb

@@ -0,0 +1,5 @@
+RSpec.configure do |config|
+  config.before do
+    I18n.locale = I18n.default_locale
+  end
+end

data/spec/support/matchers/be_a_thorough_translation_of_matcher.rb

@@ -0,0 +1,21 @@
+RSpec::Matchers.define :be_a_thorough_translation_of do |default_locale_filepath|
+  match do |filepath|
+    locale_file = I18nSpec::LocaleFile.new(filepath)
+    default_locale = I18nSpec::LocaleFile.new(default_locale_filepath)
+
+    @misses = default_locale.flattened_translations.select do |key, value|
+      !@keys.include?(key) &&
+        locale_file.flattened_translations[key] != "" &&
+        locale_file.flattened_translations[key] == value
+    end
+    @misses.empty?
+  end
+
+  chain :except do |keys|
+    @keys = keys
+  end
+
+  failure_message do |filepath|
+    "expected #{filepath} to translate :\n- " << @misses.keys.sort.join("\n- ")
+  end
+end

data/spec/support/matchers/have_text_like.rb

@@ -0,0 +1,3 @@
+def have_text_like(expected)
+  have_text(/#{Regexp.quote(expected)}/iu)
+end

data/spec/support/shared_contexts/translatable_context.rb

@@ -0,0 +1,63 @@
+shared_context "behaves as translatable" do
+  testable_attributes = [:name, :value]
+  attribute = nil
+
+  before do
+    subject.attribute_names.each do |a|
+      if testable_attributes.include? a.to_sym
+        attribute = a.to_sym
+      end
+    end
+  end
+
+  context "when there's a missing translation" do
+    before do
+      subject[attribute] = "English"
+      I18n.locale = :es
+    end
+
+    it "falls back to default locale" do
+      expect(subject[attribute]).to eq "English"
+    end
+  end
+
+  context "missing translation on default locale" do
+    let!(:change_locale) { I18n.locale = :es }
+    let!(:model) { subject.class.new }
+
+    before do
+      [:es, :en, :de].each do |locale|
+        create(:store, default_locale: locale)
+      end
+      SpreeMobility::Fallbacks.config!
+
+      model[attribute] = 'produto'
+    end
+
+    it "falls back to not default translations" do
+      I18n.locale = :en
+      expect(model[attribute]).to eq "produto"
+    end
+  end
+
+  context "missing translation on locale other than default" do
+    let!(:model) { subject.class.new }
+
+    before do
+      [:es, :en, :de].each do |locale|
+        create(:store, default_locale: locale)
+      end
+      SpreeMobility::Fallbacks.config!
+
+      model[attribute] = 'product'
+    end
+
+    it "falls back to default locale first" do
+      I18n.locale = :es
+      model[attribute] = "produto"
+
+      I18n.locale = :de
+      expect(model[attribute]).to eq "product"
+    end
+  end
+end

data/spree_mobility.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib/', __FILE__)
+$LOAD_PATH.unshift lib unless $LOAD_PATH.include?(lib)
+
+require 'spree_mobility/version'
+
+Gem::Specification.new do |s|
+  s.platform    = Gem::Platform::RUBY
+  s.name        = 'spree_mobility'
+  s.version     = SpreeMobility.version
+  s.summary     = 'Better model translation for Spree'
+  s.description = 'Provides model translation, localization, globalization features for Spreecommerce. Based on the Mobility gem, successor of Globalize.'
+
+  s.author      = 'Jan Berdajs'
+  s.email       = 'mrbrdo@mrbrdo.net'
+  s.homepage    = 'https://github.com/mrbrdo'
+  s.license     = 'BSD-3'
+
+  s.files        = `git ls-files`.split("\n")
+  s.test_files   = `git ls-files -- spec/*`.split("\n")
+  s.require_path = 'lib'
+  s.requirements << 'none'
+
+  spree_version =  '>= 4.3.0', '< 5.0'
+  s.add_dependency 'spree_core', spree_version
+  s.add_runtime_dependency 'spree_extension'
+  s.add_runtime_dependency 'friendly_id-mobility'
+  s.add_runtime_dependency 'mobility'
+  s.add_runtime_dependency 'spree_i18n'
+  s.add_runtime_dependency 'i18n_data'
+  s.add_runtime_dependency 'rails-i18n'
+  s.add_runtime_dependency 'kaminari-i18n'
+  s.add_dependency 'deface', '~> 1.0'
+
+  s.add_development_dependency 'acts_as_paranoid'
+  s.add_development_dependency 'spree_dev_tools'
+end

metadata

@@ -0,0 +1,316 @@
+--- !ruby/object:Gem::Specification
+name: spree_mobility
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jan Berdajs
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-04-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: spree_core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.3.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.3.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: spree_extension
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: friendly_id-mobility
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mobility
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: spree_i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: i18n_data
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails-i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: kaminari-i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: deface
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: acts_as_paranoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: spree_dev_tools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Provides model translation, localization, globalization features for
+  Spreecommerce. Based on the Mobility gem, successor of Globalize.
+email: mrbrdo@mrbrdo.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".hound.yml"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Appraisals
+- CONTRIBUTING.md
+- Gemfile
+- Guardfile
+- LICENSE.md
+- README.md
+- Rakefile
+- app/assets/javascripts/spree/backend/spree_mobility.js
+- app/assets/javascripts/spree/backend/taxon_tree_menu.js
+- 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/product_properties_controller_decorator.rb
+- app/controllers/spree/admin/shipping_methods_controller_decorator.rb
+- app/controllers/spree/admin/translations_controller.rb
+- app/controllers/spree/api/base_controller_decorator.rb
+- app/controllers/spree/base_controller_decorator.rb
+- app/helpers/spree_mobility/locale_helper.rb
+- 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/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
+- app/overrides/spree/admin/shared/_translations/translation.rb
+- app/overrides/spree/admin/shared/sub_menu/_configuration/store_translations.rb
+- app/overrides/spree/admin/shipping_methods/index/add_translation.rb
+- app/overrides/spree/admin/taxonomies/_list/add_translations.rb
+- app/views/spree/admin/translations/_fields.html.erb
+- app/views/spree/admin/translations/_form.html.erb
+- app/views/spree/admin/translations/_form_fields.html.erb
+- 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/product.html.erb
+- app/views/spree/admin/translations/product_property.html.erb
+- app/views/spree/admin/translations/promotion.html.erb
+- app/views/spree/admin/translations/property.html.erb
+- app/views/spree/admin/translations/shipping_method.html.erb
+- app/views/spree/admin/translations/store.html.erb
+- app/views/spree/admin/translations/taxon.html.erb
+- app/views/spree/admin/translations/taxonomy.html.erb
+- bin/rails
+- config/initializers/enable_extensions.rb
+- config/initializers/form_builder_mobility_patch.rb
+- config/initializers/mobility.rb
+- config/initializers/spree_ransack.rb
+- config/locales/be.yml
+- config/locales/bg.yml
+- config/locales/en.yml
+- config/locales/it.yml
+- config/locales/ru.yml
+- config/locales/zh-TW.yml
+- config/routes.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
+- gemfiles/spree_4_2.gemfile
+- gemfiles/spree_master.gemfile
+- lib/generators/spree_mobility/install/install_generator.rb
+- lib/spree_mobility.rb
+- lib/spree_mobility/configuration.rb
+- 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/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
+- lib/spree_mobility/core_ext/spree/products/find_with_mobility_decorator.rb
+- lib/spree_mobility/core_ext/spree/promotion_decorator.rb
+- lib/spree_mobility/core_ext/spree/property_decorator.rb
+- lib/spree_mobility/core_ext/spree/shipping_method_decorator.rb
+- lib/spree_mobility/core_ext/spree/store_decorator.rb
+- lib/spree_mobility/core_ext/spree/taxon_decorator.rb
+- lib/spree_mobility/core_ext/spree/taxonomy_decorator.rb
+- lib/spree_mobility/core_ext/spree/variant_decorator.rb
+- lib/spree_mobility/engine.rb
+- lib/spree_mobility/fallbacks.rb
+- lib/spree_mobility/translation_query.rb
+- lib/spree_mobility/version.rb
+- spec/features/admin/products_spec.rb
+- spec/features/admin/translations_spec.rb
+- spec/features/translations_spec.rb
+- spec/models/product_spec.rb
+- spec/models/taxon_spec.rb
+- spec/models/translated_models_spec.rb
+- spec/models/variant_spec.rb
+- spec/spec_helper.rb
+- spec/support/i18n.rb
+- spec/support/matchers/be_a_thorough_translation_of_matcher.rb
+- spec/support/matchers/have_text_like.rb
+- spec/support/shared_contexts/translatable_context.rb
+- spree_mobility.gemspec
+homepage: https://github.com/mrbrdo
+licenses:
+- BSD-3
+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:
+- none
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: Better model translation for Spree
+test_files:
+- spec/features/admin/products_spec.rb
+- spec/features/admin/translations_spec.rb
+- spec/features/translations_spec.rb
+- spec/models/product_spec.rb
+- spec/models/taxon_spec.rb
+- spec/models/translated_models_spec.rb
+- spec/models/variant_spec.rb
+- spec/spec_helper.rb
+- spec/support/i18n.rb
+- spec/support/matchers/be_a_thorough_translation_of_matcher.rb
+- spec/support/matchers/have_text_like.rb
+- spec/support/shared_contexts/translatable_context.rb