spree_core 4.1.1 → 4.5.0

data/lib/spree/testing_support/factories/stock_item_factory.rb

@@ -4,6 +4,13 @@ FactoryBot.define do
     stock_location
     variant
 
+    before(:create) do |stock_item|
+      Spree::StockItem.find_by(
+        variant: stock_item.variant,
+        stock_location: stock_item.stock_location
+      )&.destroy
+    end
+
     after(:create) { |object| object.adjust_count_on_hand(10) }
   end
 end

data/lib/spree/testing_support/factories/stock_location_factory.rb

@@ -7,6 +7,7 @@ FactoryBot.define do
     phone                 { '(202) 456-1111' }
     active                { true }
     backorderable_default { true }
+    propagate_all_variants { false }
 
     country  { |stock_location| Spree::Country.first || stock_location.association(:country) }
     state do |stock_location|
@@ -17,11 +18,12 @@ FactoryBot.define do
       after(:create) do |stock_location, _evaluator|
         # variant will add itself to all stock_locations in an after_create
         # creating a product will automatically create a master variant
-        product_1 = create(:product)
-        product_2 = create(:product)
+        store = Spree::Store.first || create(:store)
+        product_1 = create(:product, stores: [store])
+        product_2 = create(:product, stores: [store])
 
-        stock_location.stock_items.where(variant_id: product_1.master.id).first.adjust_count_on_hand(10)
-        stock_location.stock_items.where(variant_id: product_2.master.id).first.adjust_count_on_hand(20)
+        stock_location.stock_item_or_create(product_1.master).adjust_count_on_hand(10)
+        stock_location.stock_item_or_create(product_2.master).adjust_count_on_hand(20)
       end
     end
   end

data/lib/spree/testing_support/factories/stock_transfer_factory.rb

@@ -0,0 +1,9 @@
+FactoryBot.define do
+  factory :stock_transfer, class: Spree::StockTransfer do
+    destination_location {}
+    number {}
+    reference {}
+    source_location {}
+    type {}
+  end
+end

data/lib/spree/testing_support/factories/store_credit_factory.rb

@@ -8,6 +8,7 @@ FactoryBot.define do
     amount { 150.00 }
     currency { 'USD' }
     credit_type { create(:primary_credit_type) }
+    store { Spree::Store.default || create(:store) }
   end
 
   factory :store_credits_order_without_user, class: Spree::Order do

data/lib/spree/testing_support/factories/store_credit_type_factory.rb

@@ -4,6 +4,11 @@ FactoryBot.define do
     priority  { '1' }
   end
 
+  factory :store_credit_type, class: Spree::StoreCreditType do
+    name      { Spree::StoreCreditType::DEFAULT_TYPE_NAME }
+    priority  { '1' }
+  end
+
   factory :secondary_credit_type, class: Spree::StoreCreditType do
     name      { 'Non-expiring' }
     priority  { '2' }

data/lib/spree/testing_support/factories/store_factory.rb

@@ -1,12 +1,27 @@
 FactoryBot.define do
   factory :store, class: Spree::Store do
-    sequence(:code)   { |i| "spree_#{i}" }
-    name              { 'Spree Test Store' }
-    url               { 'www.example.com' }
-    mail_from_address { 'spree@example.org' }
-    default_currency  { 'USD' }
-    facebook          { 'spreecommerce' }
-    twitter           { 'spreecommerce' }
-    instagram         { 'spreecommerce' }
+    sequence(:code)        { |i| "spree_#{i}" }
+    name                   { 'Spree Test Store' }
+    url                    { 'www.example.com' }
+    mail_from_address      { 'no-reply@example.com' }
+    customer_support_email { 'support@example.com' }
+    new_order_notifications_email { 'store-owner@example.com' }
+    default_currency       { 'USD' }
+    supported_currencies   { 'USD,EUR,GBP' }
+    default_locale         { 'en' }
+    facebook               { 'spreecommerce' }
+    twitter                { 'spreecommerce' }
+    instagram              { 'spreecommerce' }
+
+    trait :with_favicon do
+      transient do
+        filepath { Spree::Core::Engine.root.join('spec', 'fixtures', 'favicon.ico') }
+        image_type { 'image/x-icon' }
+      end
+
+      favicon_image do
+        create(:favicon_image, attachment: Rack::Test::UploadedFile.new(filepath, image_type))
+      end
+    end
   end
 end

data/lib/spree/testing_support/factories/tax_rate_factory.rb

@@ -1,5 +1,6 @@
 FactoryBot.define do
   factory :tax_rate, class: Spree::TaxRate do
+    name { "TaxRate - #{rand(999_999)}" }
     zone
     tax_category
     amount { 0.1 }

data/lib/spree/testing_support/factories/taxon_factory.rb

@@ -1,7 +1,9 @@
 FactoryBot.define do
   factory :taxon, class: Spree::Taxon do
     sequence(:name) { |n| "taxon_#{n}" }
-    association(:taxonomy, strategy: :create)
+
+    association :taxonomy, strategy: :create
+    association :icon, factory: :taxon_image
     parent_id { taxonomy.root.id }
   end
 end

data/lib/spree/testing_support/factories/taxon_image_factory.rb

@@ -0,0 +1,9 @@
+FactoryBot.define do
+  factory :taxon_image, class: Spree::TaxonImage do
+    before(:create) do |taxon_image|
+      if taxon_image.class.method_defined?(:attachment)
+        taxon_image.attachment.attach(io: File.new(Spree::Core::Engine.root + 'spec/fixtures/thinking-cat.jpg'), filename: 'thinking-cat.jpg')
+      end
+    end
+  end
+end

data/lib/spree/testing_support/factories/taxonomy_factory.rb

@@ -1,5 +1,6 @@
 FactoryBot.define do
   factory :taxonomy, class: Spree::Taxonomy do
     sequence(:name) { |n| "taxonomy_#{n}" }
+    store { Spree::Store.default }
   end
 end

data/lib/spree/testing_support/factories/user_factory.rb

@@ -10,13 +10,24 @@ FactoryBot.define do
     password_confirmation { password }
     authentication_token  { generate(:user_authentication_token) } if Spree.user_class.attribute_method? :authentication_token
 
+    first_name { FFaker::Name.first_name }
+    last_name  { FFaker::Name.last_name }
+
+    public_metadata { {} }
+    private_metadata { {} }
+
     factory :admin_user do
       spree_roles { [Spree::Role.find_by(name: 'admin') || create(:role, name: 'admin')] }
     end
 
     factory :user_with_addresses, aliases: [:user_with_addreses] do
-      ship_address
-      bill_address
+      after(:create) do |user|
+        user.ship_address = create(:address, user: user)
+        user.bill_address = create(:address, user: user)
+        user.addresses << user.ship_address
+        user.addresses << user.bill_address
+        user.save
+      end
     end
   end
 end

data/lib/spree/testing_support/factories/variant_factory.rb

@@ -12,15 +12,19 @@ FactoryBot.define do
     is_master       { 0 }
     track_inventory { true }
 
-    product       { |p| p.association(:base_product) }
+    product       { |p| p.association(:base_product, stores: [create(:store)]) }
     option_values { [create(:option_value)] }
 
     # ensure stock item will be created for this variant
     before(:create) { create(:stock_location) unless Spree::StockLocation.any? }
 
+    after(:create) do |variant|
+      Spree::StockLocation.all.each { |stock_location| stock_location.propagate_variant(variant) }
+    end
+
     factory :variant do
       # on_hand 5
-      product { |p| p.association(:product) }
+      product { |p| p.association(:product, stores: [create(:store)]) }
     end
 
     factory :master_variant do

data/lib/spree/testing_support/factories/wished_variant_factory.rb

@@ -0,0 +1,6 @@
+FactoryBot.define do
+  factory :wished_item, class: Spree::WishedItem do
+    variant
+    wishlist
+  end
+end

data/lib/spree/testing_support/factories/wishlist_factory.rb

@@ -0,0 +1,18 @@
+FactoryBot.define do
+  factory :wishlist, class: Spree::Wishlist do
+    user
+
+    sequence(:name) { |n| "Wishlist_#{n}" }
+    is_private { true }
+    is_default { false }
+
+    before(:create) do |wishlist|
+      if wishlist.store.nil?
+        default_store = Spree::Store.default.persisted? ? Spree::Store.default : nil
+        store = default_store || create(:store)
+
+        wishlist.store = store
+      end
+    end
+  end
+end

data/lib/spree/testing_support/factories/zone_factory.rb

@@ -1,24 +1,27 @@
 FactoryBot.define do
-  factory :global_zone, class: Spree::Zone do
-    name        { 'GlobalZone' }
-    description { generate(:random_string) }
-    zone_members do |proxy|
-      zone = proxy.instance_eval { @instance }
-      Spree::Country.all.map do |c|
-        Spree::ZoneMember.create(zoneable: c, zone: zone)
-      end
-    end
-  end
-
   factory :zone, class: Spree::Zone do
     name        { generate(:random_string) }
     description { generate(:random_string) }
 
     factory :zone_with_country do
+      kind { :country }
+
       zone_members do |proxy|
         zone = proxy.instance_eval { @instance }
-        country = create(:country)
-        [Spree::ZoneMember.create(zoneable: country, zone: zone)]
+
+        [Spree::ZoneMember.create(zoneable: create(:country), zone: zone)]
+      end
+
+      factory :global_zone, class: Spree::Zone do
+        sequence(:name) { |n| "GlobalZone_#{n}" }
+
+        zone_members do |proxy|
+          zone = proxy.instance_eval { @instance }
+
+          Spree::Country.all.map do |country|
+            Spree::ZoneMember.where(zoneable: country, zone: zone).first_or_create
+          end
+        end
       end
     end
   end

data/lib/spree/testing_support/flatpickr_capybara.rb

@@ -0,0 +1,124 @@
+module Spree
+  module TestingSupport
+    module FlatpickrCapybara
+      def fill_in_date_manually(label_text, options = {})
+        with_open_flatpickr(label_text) do |field|
+          fill_in field[:id], with: string_date(options)
+        end
+      end
+
+      def fill_in_date_picker(label_text, options = {})
+        if options[:hour].blank? && options[:minute].blank?
+          flatpickr_date_only(label_text, options)
+        else
+          flatpickr_date_time(label_text, options)
+        end
+      end
+
+      def fill_in_date_with_js(label_text, options = {})
+        date_field = find("input[id='#{label_text}']")
+        script = "document.querySelector('#{date_field}').flatpickr().setDate('#{string_date(options)}');"
+
+        page.execute_script(script)
+      end
+
+      private
+
+      def flatpickr_date_only(label_text, options = {})
+        within_open_flatpickr(label_text) do
+          within_flatpickr_months do
+            fill_in_flatpickr_year(options[:year].to_i)
+            sleep(0.25) # Pause to let JavaScript adjust the month selector in the flatpickr cal in relation to any related FROM...TO cal.
+
+            select_flatpickr_month(options[:month].to_i)
+            sleep(0.25) # Pause to let JavaScript adjust the day selection area in the flatpickr cal in relation to any related FROM...TO cal.
+
+            click_on_flatpickr_day(options[:day].to_i)
+          end
+        end
+      end
+
+      def flatpickr_date_time(label_text, options = {})
+        within_open_flatpickr(label_text) do
+          within_flatpickr_months do
+            fill_in_flatpickr_year(options[:year].to_i)
+            sleep(0.25) # Pause to let JavaScript adjust the month selector in the flatpickr cal in relation to any related FROM...TO cal.
+
+            select_flatpickr_month(options[:month].to_i)
+            sleep(0.25) # Pause to let JavaScript adjust the day selection area in the flatpickr cal in relation to any related FROM...TO cal.
+
+            click_on_flatpickr_day(options[:day].to_i)
+          end
+
+          within_flatpickr_time do
+            select_flatpickr_hour(options[:hour].to_i)
+            select_flatpickr_min(options[:minute].to_i)
+          end
+        end
+      end
+
+      def with_open_flatpickr(label_text)
+        field_label = find_field(id: label_text, type: :hidden)
+
+        date_field = field_label.sibling('.flatpickr-alt-input')
+        date_field.click # Open the flatpickr cal.
+        sleep(0.25) # Pause to let JavaScript populate DOM with an open flatpickr cal.
+
+        yield(date_field) # Complete required action within the open flatpickr cal.
+
+        date_field.send_keys :tab # Close the date flatpickr cal.
+        sleep(0.25) # Pause to let JavaScript adjust any DOM values in relation to any related FROM...TO cal.
+      end
+
+      def within_open_flatpickr(label_text, &block)
+        with_open_flatpickr(label_text) do
+          within find('.flatpickr-calendar.open', &block)
+        end
+      end
+
+      def within_flatpickr_months(&block)
+        within find('.flatpickr-months > .flatpickr-month > .flatpickr-current-month', &block)
+      end
+
+      def within_flatpickr_time(&block)
+        within find('.flatpickr-time', &block)
+      end
+
+      def select_flatpickr_month(month)
+        accurate_month = (month.to_i - 1)
+
+        find("select.flatpickr-monthDropdown-months > option[value='#{accurate_month}']").select_option
+      end
+
+      def fill_in_flatpickr_year(year)
+        find('input.cur-year').set(year)
+      end
+
+      def click_on_flatpickr_day(day)
+        within_flatpickr_days do
+          find('.flatpickr-day:not(.prevMonthDay):not(.nextMonthDay)', text: day, exact_text: true).click
+        end
+      end
+
+      def within_flatpickr_days(&block)
+        within find('.flatpickr-innerContainer > .flatpickr-rContainer > .flatpickr-days > .dayContainer', &block)
+      end
+
+      def select_flatpickr_hour(hour)
+        find('input.flatpickr-hour').set(hour)
+      end
+
+      def select_flatpickr_min(min)
+        find('input.flatpickr-minute').set(min)
+      end
+
+      def string_date(options)
+        if options[:hour].present? && options[:minute].present?
+          "#{options[:year]}-#{options[:month]}-#{options[:day]}-#{options[:hour]}-#{options[:minute]}"
+        else
+          "#{options[:year]}-#{options[:month]}-#{options[:day]}"
+        end
+      end
+    end
+  end
+end

data/lib/spree/testing_support/i18n.rb

@@ -84,7 +84,7 @@ RSpec.configure do |config|
       end
 
       Spree.check_unused_translations
-      if false && Spree.unused_translation_messages.any?
+      if Spree.unused_translation_messages.any?
         puts "\nThere are unused translations within Spree:"
         puts Spree.unused_translation_messages.sort
         exit(1)

data/lib/spree/testing_support/jobs.rb

@@ -0,0 +1,9 @@
+RSpec.configure do |config|
+  config.before(:each, :job) do
+    ActiveJob::Base.queue_adapter = :test
+  end
+
+  config.after(:each, :job) do
+    ActiveJob::Base.queue_adapter = :inline
+  end
+end

data/lib/spree/testing_support/locale_helpers.rb

@@ -0,0 +1,78 @@
+module Spree
+  module TestingSupport
+    module LocaleHelpers
+      # rubocop:disable Layout/ArgumentAlignment
+      def add_french_locales
+        I18n.backend.store_translations(:fr,
+          spree: {
+            added_to_cart: 'Ajouté au panier avec succès!',
+            continue_shopping: 'Continuer vos achats',
+            choose_currency: 'Choisir la devise',
+            internationalization: 'Internationalisation',
+            i18n: {
+              language: 'Langue',
+              this_file_language: 'Français (FR)'
+            },
+            cart_page: {
+              header: 'Votre panier',
+              empty_info: 'Votre panier est vide',
+              add_promo_code: 'AJOUTER UN CODE PROMOTIONNEL',
+              checkout: 'Passer la commande',
+              product: 'articles',
+              quantity: 'quantité',
+              title: 'Panier',
+              change_quantity: 'Changer la quantité',
+              remove_from_cart: 'Retirer du panier'
+            },
+            shopping_cart: 'Panier',
+            cart: 'Panier',
+            close: 'Fermer',
+            search: 'Rechercher',
+            home: 'Accueil',
+            nav_bar: {
+              admin_panel: "Panneau d'administration",
+              close_menu: 'Fermer le menu',
+              go_to_previous_menu: 'Vers le menu précédent',
+              show_menu: 'Afficher le menu',
+              show_search: 'Afficher la recherche',
+              show_user_menu: 'Afficher le menu utilisateur',
+              change_country: 'Changer de pays',
+              desktop: 'Navigation sur le bureau',
+              mobile: 'Navigation mobile'
+            },
+            login: 'Connexion',
+            logout: 'Se déconnecter',
+            sign_up: 'Enregistrer',
+            email: 'Courriel',
+            password: 'Mot de passe',
+            remember_me: 'Se souvenir de moi',
+            my_account: 'Mon compte',
+            my_orders: 'Mes commandes',
+            logged_in_successfully: 'Connexion réussie'
+          })
+      end
+      # rubocop:enable Layout/ArgumentAlignment
+
+      def open_i18n_menu
+        find('#header #internationalization-button-desktop').click
+        expect(page).to have_selector('#internationalization-options-desktop')
+      end
+
+      def close_i18n_menu
+        find('#header #internationalization-button-desktop').click
+        expect(page).not_to have_selector('#internationalization-options-desktop')
+      end
+
+      def switch_to_currency(currency)
+        open_i18n_menu
+        select currency, from: 'switch_to_currency'
+        expect(page).to have_no_css '.turbolinks-progress-bar'
+      end
+
+      def switch_to_locale(locale)
+        open_i18n_menu
+        select locale, from: 'Language'
+      end
+    end
+  end
+end

data/lib/spree/testing_support/metadata.rb

@@ -0,0 +1,54 @@
+shared_examples_for 'metadata' do |factory: described_class.name.demodulize.underscore.to_sym|
+  subject { FactoryBot.create(factory) }
+
+  it { expect(subject.has_attribute?(:public_metadata)).to be_truthy }
+  it { expect(subject.has_attribute?(:private_metadata)).to be_truthy }
+
+  it { expect(subject.public_metadata).to eq({}) }
+  it { expect(subject.private_metadata).to eq({}) }
+
+  it { expect(subject.public_metadata.class).to eq(ActiveSupport::HashWithIndifferentAccess) }
+  it { expect(subject.private_metadata.class).to eq(ActiveSupport::HashWithIndifferentAccess) }
+
+  it 'reads data as symbolized keys' do
+    string = subject.public_metadata[:color] = 'red'
+    number = subject.public_metadata[:priority] = 1
+    array = subject.public_metadata[:keywords] = ['k1', 'k2']
+    hash = subject.public_metadata[:additional_data] = { size: 'big', material: 'wool' }
+
+    subject.save!
+
+    expect(subject.public_metadata[:color]).to eq(string)
+    expect(subject.public_metadata[:priority]).to eq(number)
+    expect(subject.public_metadata[:keywords]).to eq(array)
+    expect(subject.public_metadata[:additional_data]).to eq(hash.stringify_keys)
+  end
+
+  it 'reads data as not symbolized keys' do
+    string = subject.public_metadata[:color] = 'red'
+    number = subject.public_metadata[:priority] = 1
+    array = subject.public_metadata[:keywords] = ['k1', 'k2']
+    hash = subject.public_metadata[:additional_data] = { size: 'big', material: 'wool' }
+
+    subject.save!
+
+    expect(subject.public_metadata['color']).to eq(string)
+    expect(subject.public_metadata['priority']).to eq(number)
+    expect(subject.public_metadata['keywords']).to eq(array)
+    expect(subject.public_metadata['additional_data']).to eq(hash.stringify_keys)
+  end
+
+  it 'can query records by metadata properties', skip: ENV['DB'] == 'mysql' do
+    subject.public_metadata[:color] = 'red'
+    subject.public_metadata[:priority] = 1
+    subject.public_metadata[:keywords] = ['k1', 'k2']
+    subject.public_metadata[:additional_data] = { size: 'big', material: 'wool' }
+
+    subject.save!
+
+    expect(described_class.where("public_metadata->>'color' = ?", 'red').count).to eq(1)
+    expect(described_class.where("public_metadata->>'priority' = ?", '1').count).to eq(1)
+    expect(described_class.where("public_metadata -> 'keywords' ? :keyword", keyword: 'k1').count).to eq(1)
+    expect(described_class.where("public_metadata -> 'additional_data' ->> 'size' = :size", size: 'big').count).to eq(1)
+  end
+end

data/lib/spree/testing_support/next_instance_of.rb

@@ -0,0 +1,38 @@
+# Helper services with prepended ServiceModule
+# https://gitlab.com/gitlab-org/gitlab-foss/-/issues/33587
+#
+# ex:
+# expect_next_instance_of(service_class) do |instance|
+#   expect(instance).to receive(:call)
+# end
+
+module NextInstanceOf
+  def expect_next_instance_of(klass, *new_args)
+    stub_new(expect(klass), *new_args) do |expectation|
+      yield(expectation)
+    end
+  end
+
+  def allow_next_instance_of(klass, *new_args)
+    stub_new(allow(klass), *new_args) do |allowance|
+      yield(allowance)
+    end
+  end
+
+  private
+
+  def stub_new(target, *new_args)
+    receive_new = receive(:new)
+    receive_new.with(*new_args) if new_args.any?
+
+    target.to receive_new.and_wrap_original do |method, *original_args|
+      method.call(*original_args).tap do |instance|
+        yield(instance)
+      end
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.include NextInstanceOf
+end

data/lib/spree/testing_support/order_walkthrough.rb

@@ -1,11 +1,16 @@
 class OrderWalkthrough
-  def self.up_to(state)
-    # A default store must exist to provide store settings
-    store = Spree::Store.default || FactoryBot.create(:store, default: true)
+  def self.up_to(state, store = nil)
+    store ||= if Spree::Store.exists?
+                # Ensure the default store is used
+                Spree::Store.default || FactoryBot.create(:store, default: true)
+              else
+                # Create a default store
+                FactoryBot.create(:store, default: true)
+              end
 
     # A payment method must exist for an order to proceed through the Address state
     unless Spree::PaymentMethod.exists?
-      FactoryBot.create(:check_payment_method)
+      FactoryBot.create(:check_payment_method, stores: [store])
     end
 
     # Need to create a valid zone too...
@@ -23,7 +28,7 @@ class OrderWalkthrough
       end
     end
 
-    order = Spree::Order.create!(email: 'spree@example.com')
+    order = store.orders.create!(email: 'spree@example.com')
     add_line_item!(order)
     order.next!
 

data/lib/spree/testing_support/rspec_retry_config.rb

@@ -0,0 +1,15 @@
+require 'rspec/retry'
+
+RSpec.configure do |config|
+  config.verbose_retry = true
+  config.display_try_failure_messages = true
+
+  config.around :each, type: :feature do |ex|
+    ex.run_with_retry retry: ENV.fetch('RSPEC_RETRY_RETRY_COUNT', 3).to_i
+  end
+
+  # callback to be run between retries
+  config.retry_callback = proc do |ex|
+    Rails.cache.clear
+  end
+end

data/lib/spree_core.rb

@@ -1,2 +1,3 @@
-require 'friendly_id/slug_rails5_patch'
+require 'friendly_id/paranoia'
+
 require 'spree/core'