solidus_core 2.11.10 → 3.3.1

data/lib/spree/testing_support/dummy_app.rb

@@ -7,6 +7,7 @@ require 'rails'
 require 'active_record/railtie'
 require 'action_controller/railtie'
 require 'action_mailer/railtie'
+require 'active_storage/engine'
 
 Rails.env = 'test'
 
@@ -37,7 +38,7 @@ module DummyApp
     ENV["LIB_NAME"] = lib_name
     DummyApp::Application.config.root = File.join(gem_root, 'spec', 'dummy')
 
-    DummyApp::Application.initialize!
+    DummyApp::Application.initialize! unless DummyApp::Application.initialized?
 
     if auto_migrate
       DummyApp::Migrations.auto_migrate
@@ -45,37 +46,60 @@ module DummyApp
   end
 
   class Application < ::Rails::Application
-    config.eager_load = false
-    config.cache_classes = true
-    config.cache_store = :memory_store
-    config.serve_static_assets = true
-    config.public_file_server.headers = { 'Cache-Control' => 'public, max-age=3600' }
-    config.whiny_nils = true
-    config.consider_all_requests_local = true
+    config.load_defaults("#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}")
+    # Make the test environment more production-like:
     config.action_controller.allow_forgery_protection = false
     config.action_controller.default_protect_from_forgery = false
+    config.action_mailer.perform_caching = false
+    config.i18n.fallbacks = true
+
+    # In the test environment, we use the `caching: true` RSpec metadata to
+    # enable caching on select specs. See
+    # core/lib/spree/testing_support/caching.rb. See also
+    # https://github.com/solidusio/solidus/issues/4110
     config.action_controller.perform_caching = false
+
+    # It needs to be explicitly set from Rails 7
+    # https://guides.rubyonrails.org/upgrading_ruby_on_rails.html#upgrading-from-rails-6-1-to-rails-7-0-spring
+    config.cache_classes = true
+
+    # Make debugging easier:
+    config.consider_all_requests_local = true
     config.action_dispatch.show_exceptions = false
     config.active_support.deprecation = :stderr
+    config.log_level = :debug
+
+    # Improve test suite performance:
+    config.eager_load = false
+    config.public_file_server.headers = { 'Cache-Control' => 'public, max-age=3600' }
+    config.cache_store = :memory_store
+
+    # We don't use a web server, so we let Rails serve assets.
+    config.public_file_server.enabled = true
+
+    # We don't want to send email in the test environment.
     config.action_mailer.delivery_method = :test
-    config.active_support.deprecation = :stderr
+
+    # No need to use credentials file in a test environment.
     config.secret_key_base = 'SECRET_TOKEN'
 
-    config.action_mailer.delivery_job = "ActionMailer::MailDeliveryJob" if RAILS_6_OR_ABOVE
+    # Set the preview path within the dummy app:
     config.action_mailer.preview_path = File.expand_path('dummy_app/mailer_previews', __dir__)
-    config.active_record.sqlite3.represent_boolean_as_integer = true unless RAILS_6_OR_ABOVE
 
-    config.storage_path = Rails.root.join('tmp', 'storage')
+    config.active_record.sqlite3.represent_boolean_as_integer = true unless RAILS_6_OR_ABOVE
+    config.active_record.dump_schema_after_migration = false
 
-    if ENV['ENABLE_ACTIVE_STORAGE']
+    # Configure active storage to use storage within tmp folder
+    unless (ENV['DISABLE_ACTIVE_STORAGE'] == 'true')
       initializer 'solidus.active_storage' do
         config.active_storage.service_configurations = {
           test: {
             service: 'Disk',
-            root: config.storage_path
+            root: Rails.root.join('tmp', 'storage')
           }
         }
         config.active_storage.service = :test
+        config.active_storage.variant_processor = ENV.fetch('ACTIVE_STORAGE_VARIANT_PROCESSOR', Spree::RailsCompatibility.variant_processor).to_sym
       end
     end
 
@@ -92,13 +116,10 @@ module DummyApp
     end
     config.paths['db/migrate'] = migration_dirs
     ActiveRecord::Migrator.migrations_paths = migration_dirs
+    ActiveRecord::Migration.verbose = false
 
-    config.action_controller.include_all_helpers = false
-
-    if config.respond_to?(:assets)
-      config.assets.paths << File.expand_path('dummy_app/assets/javascripts', __dir__)
-      config.assets.paths << File.expand_path('dummy_app/assets/stylesheets', __dir__)
-    end
+    config.assets.paths << File.expand_path('dummy_app/assets/javascripts', __dir__)
+    config.assets.paths << File.expand_path('dummy_app/assets/stylesheets', __dir__)
 
     config.paths["config/database"] = File.expand_path('dummy_app/database.yml', __dir__)
     config.paths['app/views'] = File.expand_path('dummy_app/views', __dir__)
@@ -115,21 +136,13 @@ ActiveSupport.on_load(:action_controller) do
 end
 
 Spree.user_class = 'Spree::LegacyUser'
+Spree.load_defaults(Spree.solidus_version)
 Spree.config do |config|
-  config.use_legacy_address_state_validator = false
-  config.mails_from = "store@example.com"
-  config.raise_with_invalid_currency = false
-  config.redirect_back_on_unauthorized = true
-  config.run_order_validations_on_order_updater = true
-  config.use_combined_first_and_last_name_in_address = true
-  config.use_legacy_order_state_machine = false
-  config.use_custom_cancancan_actions = false
-  config.consider_actionless_promotion_active = false
-  config.use_legacy_store_credit_reimbursement_category_name = false
-
-  if ENV['ENABLE_ACTIVE_STORAGE']
-    config.image_attachment_module = 'Spree::Image::ActiveStorageAttachment'
-    config.taxon_attachment_module = 'Spree::Taxon::ActiveStorageAttachment'
+  config.use_legacy_events = (ENV['USE_LEGACY_EVENTS'] == 'true')
+
+  if (ENV['DISABLE_ACTIVE_STORAGE'] == 'true')
+    config.image_attachment_module = 'Spree::Image::PaperclipAttachment'
+    config.taxon_attachment_module = 'Spree::Taxon::PaperclipAttachment'
   end
 end
 

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

@@ -24,16 +24,19 @@ FactoryBot.define do
     phone { '555-555-0199' }
     alternative_phone { '555-555-0199' }
 
-    state do |address|
-      Spree::State.joins(:country).where('spree_countries.iso = (?)', country_iso_code).find_by(abbr: state_code) ||
-        address.association(:state, country_iso: country_iso_code, state_code: state_code)
-    end
-
     country do |address|
       if address.state
         address.state.country
       else
-        address.association(:country, iso: country_iso_code)
+        Spree::Country.find_by(iso: country_iso_code) ||
+          address.association(:country, strategy: :create, iso: country_iso_code)
+      end
+    end
+
+    after(:build) do |address, evaluator|
+      if address&.country&.states_required? && address.state.nil? && address.state_name.nil?
+        address.state = address.country.states.find_by(abbr: evaluator.state_code) ||
+          create(:state, country_iso: address.country.iso, state_code: evaluator.state_code)
       end
     end
   end

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

@@ -17,6 +17,9 @@ FactoryBot.define do
   factory :default_tax_calculator, class: 'Spree::Calculator::DefaultTax' do
   end
 
+  factory :flat_fee_calculator, class: 'Spree::Calculator::FlatFee' do
+  end
+
   factory :shipping_calculator, class: 'Spree::Calculator::Shipping::FlatRate' do
     preferred_amount { 10.0 }
   end

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

@@ -20,7 +20,6 @@ FactoryBot.define do
     iso3 { carmen_country.alpha_3_code }
     numcode { carmen_country.numeric_code }
 
-    # FIXME: We should set states required, but it causes failing tests
-    # states_required { carmen_country.subregions? }
+    states_required { carmen_country.subregions? }
   end
 end

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

@@ -17,7 +17,7 @@ FactoryBot.define do
       stock_location { nil }
     end
 
-    variant
+    association :variant, strategy: :create
     line_item do
       if order
         build(:line_item, variant: variant, order: order)

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

@@ -19,7 +19,7 @@ FactoryBot.define do
     ship_address
     completed_at { nil }
     email { user.try(:email) }
-    store
+    association :store, strategy: :create
 
     transient do
       line_items_price { BigDecimal(10) }
@@ -30,7 +30,6 @@ FactoryBot.define do
       after(:build) do |order, evaluator|
         order.line_items << build(
           :line_item,
-          order: order,
           price: evaluator.line_items_price
         )
       end
@@ -69,6 +68,7 @@ FactoryBot.define do
 
       factory :completed_order_with_promotion do
         transient do
+          completed_at { Time.current }
           promotion { nil }
         end
 
@@ -80,7 +80,7 @@ FactoryBot.define do
           order.order_promotions.create!(promotion: promotion, promotion_code: promotion_code)
 
           # Complete the order after the promotion has been activated
-          order.update_column(:completed_at, Time.current)
+          order.update_column(:completed_at, evaluator.completed_at)
           order.update_column(:state, "complete")
         end
       end
@@ -105,13 +105,16 @@ FactoryBot.define do
       end
 
       factory :completed_order_with_totals do
+        transient do
+          completed_at { Time.current }
+        end
         state { 'complete' }
 
-        after(:create) do |order|
+        after(:create) do |order, evaluator|
           order.shipments.each do |shipment|
             shipment.inventory_units.update_all state: 'on_hand', pending: false
           end
-          order.update_column(:completed_at, Time.current)
+          order.update_column(:completed_at, evaluator.completed_at)
         end
 
         factory :completed_order_with_pending_payment do

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

@@ -20,7 +20,10 @@ FactoryBot.define do
     sku { generate(:sku) }
     available_on { 1.year.ago }
     deleted_at { nil }
-    shipping_category { |r| Spree::ShippingCategory.first || r.association(:shipping_category) }
+    shipping_category do |r|
+      Spree::ShippingCategory.first ||
+        r.association(:shipping_category, strategy: :create)
+    end
 
     # ensure stock item will be created for this products master
     before(:create) { create(:stock_location) if Spree::StockLocation.count == 0 }

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

@@ -22,23 +22,40 @@ FactoryBot.define do
     end
 
     trait :with_action do
-      after(:create) do |promotion, _evaluator|
-        promotion.actions << Spree::Promotion::Actions::CreateAdjustment.new
+      transient do
+        promotion_action_class { Spree::Promotion::Actions::CreateAdjustment }
+      end
+
+      after(:create) do |promotion, evaluator|
+        promotion.actions << evaluator.promotion_action_class.new
       end
     end
 
-    trait :with_line_item_adjustment do
+    trait :with_adjustable_action do
       transient do
-        adjustment_rate { 10 }
+        preferred_amount { 10 }
+        calculator_class { Spree::Calculator::FlatRate }
+        promotion_action_class { Spree::Promotion::Actions::CreateItemAdjustments }
       end
 
       after(:create) do |promotion, evaluator|
-        calculator = Spree::Calculator::FlatRate.new
-        calculator.preferred_amount = evaluator.adjustment_rate
-        Spree::Promotion::Actions::CreateItemAdjustments.create!(calculator: calculator, promotion: promotion)
+        calculator = evaluator.calculator_class.new
+        calculator.preferred_amount = evaluator.preferred_amount
+        evaluator.promotion_action_class.create!(calculator: calculator, promotion: promotion)
       end
     end
 
+    factory :promotion_with_action_adjustment, traits: [:with_adjustable_action]
+
+    trait :with_line_item_adjustment do
+      transient do
+        adjustment_rate { 10 }
+      end
+
+      with_adjustable_action
+      preferred_amount { adjustment_rate }
+    end
+
     factory :promotion_with_item_adjustment, traits: [:with_line_item_adjustment]
 
     trait :with_free_shipping do
@@ -52,14 +69,11 @@ FactoryBot.define do
         weighted_order_adjustment_amount { 10 }
       end
 
-      after(:create) do |promotion, evaluator|
-        calculator = Spree::Calculator::FlatRate.new
-        calculator.preferred_amount = evaluator.weighted_order_adjustment_amount
-        action = Spree::Promotion::Actions::CreateAdjustment.create!(calculator: calculator)
-        promotion.actions << action
-        promotion.save!
-      end
+      with_adjustable_action
+      preferred_amount { weighted_order_adjustment_amount }
+      promotion_action_class { Spree::Promotion::Actions::CreateAdjustment }
     end
+
     factory :promotion_with_order_adjustment, traits: [:with_order_adjustment]
 
     trait :with_item_total_rule do

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

@@ -18,7 +18,6 @@ FactoryBot.define do
 
     amount { 100.00 }
     transaction_id { generate(:refund_transaction_id) }
-    perform_after_create { false }
     payment do
       association(:payment, state: 'completed', amount: payment_amount)
     end

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

@@ -17,9 +17,15 @@ FactoryBot.define do
       carmen_subregion do
         carmen_country = Carmen::Country.coded(country.iso)
 
-        carmen_country.subregions.coded(state_code) ||
-          carmen_country.subregions.sort_by(&:name).first ||
+        unless carmen_country.subregions?
           fail("Country #{country.iso} has no subregions")
+        end
+
+        carmen_regions = carmen_country.subregions
+        carmen_regions = carmen_regions.flat_map(&:subregions) if carmen_regions.first.subregions?
+        region_collection = Carmen::RegionCollection.new(carmen_regions)
+
+        region_collection.coded(state_code) || region_collection.sort_by(&:name).first
       end
     end
 

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

@@ -11,11 +11,11 @@ end
 
 FactoryBot.define do
   factory :store_credit, class: 'Spree::StoreCredit' do
-    user
-    association :created_by, factory: :user
-    association :category, factory: :store_credit_category
+    association :user, strategy: :create
+    association :created_by, factory: :user, strategy: :create
+    association :category, factory: :store_credit_category, strategy: :create
     amount { 150.00 }
     currency { "USD" }
-    association :credit_type, factory: :primary_credit_type
+    association :credit_type, factory: :primary_credit_type, strategy: :create
   end
 end

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

@@ -21,6 +21,12 @@ FactoryBot.define do
       end
     end
 
+    trait :with_orders do
+      after(:create) do |user, _|
+        create(:order, user: user)
+      end
+    end
+
     factory :admin_user do
       after(:create) do |user, _|
         admin_role = Spree::Role.find_by(name: 'admin') || create(:role, name: 'admin')

data/lib/spree/testing_support/factory_bot.rb

@@ -37,14 +37,14 @@ module Spree
         Spree::Deprecation.warn(
           "Please do not cherry-pick factories, this is not well supported by FactoryBot, " \
           'follow the changelog instructions on how to migrate your current setup.',
-          callsites[index..-1]
+          callsites[index..]
         )
       end
 
       def self.check_version
         require "factory_bot/version"
 
-        requirement = Gem::Requirement.new("~> 4.8")
+        requirement = Gem::Requirement.new(">= 4.8")
         version = Gem::Version.new(::FactoryBot::VERSION)
 
         unless requirement.satisfied_by? version

data/lib/spree/testing_support/order_walkthrough.rb

@@ -3,11 +3,11 @@
 module Spree
   module TestingSupport
     class OrderWalkthrough
-      def self.up_to(state)
-        new.up_to(state)
+      def self.up_to(state, user: nil)
+        new.up_to(state, user: user)
       end
 
-      def up_to(state)
+      def up_to(state, user: nil)
         # Need to create a valid zone too...
         @zone = ::FactoryBot.create(:zone)
         @country = ::FactoryBot.create(:country)
@@ -23,6 +23,7 @@ module Spree
         end
 
         order = Spree::Order.create!(
+          user: user,
           email: "solidus@example.com",
           store: Spree::Store.first || ::FactoryBot.create(:store)
         )
@@ -33,7 +34,7 @@ module Spree
                               states
                             else
                               end_state_position = states.index(state.to_sym)
-                              states[0..end_state_position]
+                              states[..end_state_position]
                             end
 
         states_to_process.each do |state_to_process|
@@ -61,7 +62,7 @@ module Spree
       end
 
       def payment(order)
-        credit_card = ::FactoryBot.create(:credit_card)
+        credit_card = ::FactoryBot.create(:credit_card, user: order.user)
         order.payments.create!(payment_method: credit_card.payment_method, amount: order.total, source: credit_card)
         # TODO: maybe look at some way of making this payment_state change automatic
         order.payment_state = 'paid'
@@ -82,6 +83,3 @@ module Spree
     end
   end
 end
-
-# @private
-OrderWalkthrough = ActiveSupport::Deprecation::DeprecatedConstantProxy.new('OrderWalkthrough', 'Spree::TestingSupport::OrderWalkthrough')

data/lib/spree/testing_support/preferences.rb

@@ -1,33 +1,8 @@
 # frozen_string_literal: true
 
-require 'spree/deprecation'
-
 module Spree
   module TestingSupport
     module Preferences
-      # Resets all preferences to default values, you can
-      # pass a block to override the defaults with a block
-      #
-      # reset_spree_preferences do |config|
-      #   config.track_inventory_levels = false
-      # end
-      #
-      # @deprecated
-      def reset_spree_preferences(&config_block)
-        Spree::Config.instance_variables.
-          reject { |iv| iv == :@events_configuration }.
-          each { |iv| Spree::Config.remove_instance_variable(iv) }
-        Spree::Config.preference_store = Spree::Config.default_preferences
-
-        if defined?(Railties)
-          Rails.application.config.spree = Spree::Config.environment
-        end
-
-        configure_spree_preferences(&config_block) if block_given?
-      end
-
-      deprecate :reset_spree_preferences, deprecator: Spree::Deprecation
-
       def configure_spree_preferences
         yield(Spree::Config) if block_given?
       end

data/lib/spree/testing_support/silence_deprecations.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+RSpec.configure do |config|
+  config.around(:each, silence_deprecations: true) do |example|
+    Spree::Deprecation.silence do
+      example.run
+    end
+  end
+end

data/lib/tasks/colorado_delivery_fee.rake

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+namespace :taxes do
+  desc "Creates all of the records necessary to start collecting the Colorado Delivery Fee"
+  task colorado_delivery_fee: :environment do
+    usa = Spree::Country.find_by!(iso: "US")
+    colorado = usa.states.find_by!(abbr: "CO")
+
+    ActiveRecord::Base.transaction do
+      zone = Spree::Zone.create!(
+        name: "Colorado",
+        description: "State-based zone containing only Colorado.",
+        states: [colorado]
+      )
+
+      calculator = Spree::Calculator::FlatFee.new
+      rate = Spree::TaxRate.create!(
+        name: "Colorado Delivery Fee",
+        calculator: calculator,
+        zone: zone,
+        amount: 0.27,
+        show_rate_in_label: false,
+        level: "order"
+      )
+      rate.tax_categories << Spree::TaxCategory.default if Spree::TaxCategory.default
+    end
+  end
+end

data/lib/tasks/payment_method.rake

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+namespace :payment_method do
+  desc "Deactivates old payment methods and fixes ActiveRecord::SubclassNotFound error, "\
+  "which happens after switching Payment Service Provider."
+  task deactivate_unsupported_payment_methods: :environment do
+    Spree::PaymentMethod.pluck(:id, :type).select do |id, type|
+      type.constantize
+    rescue NameError
+      fix_payment_method_record(id, type)
+    end
+  end
+
+  def fix_payment_method_record(id, previous_type)
+    connection = ActiveRecord::Base.connection
+    false_value = connection.quoted_false
+    connection.exec_update(<<-SQL
+      UPDATE spree_payment_methods
+      SET
+        type='#{Spree::PaymentMethod.name}',
+        type_before_removal='#{previous_type}',
+        active=#{false_value},
+        available_to_users=#{false_value},
+        available_to_admin=#{false_value}
+      WHERE id=#{id};
+    SQL
+    )
+  end
+end

data/lib/tasks/solidus/check_orders_with_invalid_email.rake

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+namespace :solidus do
+  desc 'Prints orders with invalid email (after fix for GHSA-qxmr-qxh6-2cc9)'
+  task check_orders_with_invalid_email: :environment do
+    matches = Spree::Order.find_each.reduce([]) do |matches, order|
+      order.email.nil? || Spree::EmailValidator::EMAIL_REGEXP.match?(order.email) ? matches : matches + [order]
+    end
+    if matches.any?
+      puts 'Email / ID / Number'
+      puts(matches.map do |order|
+        "#{order.email} / #{order.id} / #{order.number}"
+      end.join("\n"))
+    else
+      puts 'NO MATCHES'
+    end
+  end
+end

data/lib/tasks/solidus/delete_prices_with_nil_amount.rake

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+namespace :solidus do
+  desc "Delete Spree::Price records (including discarded) which amount field is NULL"
+  task delete_prices_with_nil_amount: :environment do
+    Spree::Price.with_discarded.where(amount: nil).delete_all
+  end
+end

data/lib/tasks/solidus/split_promotions_with_any_match_policy.rake

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+namespace :solidus do
+  desc "Split Promotions with 'any' match policy"
+  task split_promotions_with_any_match_policy: :environment do
+    Spree::Promotion.where(match_policy: :any).includes(:promotion_rules).all.each do |promotion|
+      if promotion.promotion_rules.length <= 1
+        promotion.update!(match_policy: :all)
+      elsif promotion.active?
+        promotion.rules.map do |rule|
+          new_promotion = promotion.dup
+          new_promotion.promotion_rules = [rule]
+          new_promotion.match_policy = "all"
+          new_promotion.promotion_actions = promotion.actions.map do |action|
+            new_action = action.dup
+            if action.respond_to?(:calculator)
+              new_action.calculator = action.calculator.dup
+            end
+            new_action.promotion = new_promotion
+            new_action.save!
+            new_action
+          end
+          new_promotion.expires_at = promotion.expires_at
+          new_promotion.starts_at = Time.current
+          new_promotion.save!
+        end
+        promotion.update!(expires_at: Time.current)
+      end
+    end
+
+    Spree::Order.where(completed_at: nil).each { |order| Spree::PromotionHandler::Cart.new(order).activate }
+  end
+end