solidus_core 3.0.0 → 4.5.1

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

@@ -1,20 +1,15 @@
 # frozen_string_literal: true
 
-require 'spree/testing_support/factory_bot'
-Spree::TestingSupport::FactoryBot.when_cherry_picked do
-  Spree::TestingSupport::FactoryBot.deprecate_cherry_picking
-
-  require 'spree/testing_support/factories/taxonomy_factory'
-end
-
 FactoryBot.define do
   factory :taxon, class: 'Spree::Taxon' do
     name { 'Ruby on Rails' }
-    taxonomy
-    parent_id { nil }
+    taxonomy_id { (parent&.taxonomy || create(:taxonomy)).id }
+    parent_id { parent&.id || taxonomy.root.id }
 
     trait :with_icon do
-      icon { Spree::Core::Engine.root.join('lib', 'spree', 'testing_support', 'fixtures', 'blank.jpg').open }
+      after(:create) do |taxon|
+        taxon.update(icon: Spree::Core::Engine.root.join('lib', 'spree', 'testing_support', 'fixtures', 'blank.jpg').open)
+      end
     end
   end
 end

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

@@ -1,12 +1,9 @@
 # frozen_string_literal: true
 
-require 'spree/testing_support/factory_bot'
-Spree::TestingSupport::FactoryBot.when_cherry_picked do
-  Spree::TestingSupport::FactoryBot.deprecate_cherry_picking
-end
-
 FactoryBot.define do
   factory :taxonomy, class: 'Spree::Taxonomy' do
-    name { 'Brand' }
+    sequence :name do |seq|
+      "Brand #{seq}"
+    end
   end
 end

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

@@ -1,14 +1,5 @@
 # frozen_string_literal: true
 
-require 'spree/testing_support/factory_bot'
-Spree::TestingSupport::FactoryBot.when_cherry_picked do
-  Spree::TestingSupport::FactoryBot.deprecate_cherry_picking
-
-  require 'spree/testing_support/sequences'
-  require 'spree/testing_support/factories/role_factory'
-  require 'spree/testing_support/factories/address_factory'
-end
-
 FactoryBot.define do
   factory :user, class: Spree::UserClassHandle.new do
     email { generate(:email) }
@@ -21,6 +12,12 @@ FactoryBot.define do
       end
     end
 
+    trait :with_orders do
+      after(:create) do |user, _|
+        create(:order, 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/factories/variant_factory.rb

@@ -1,15 +1,5 @@
 # frozen_string_literal: true
 
-require 'spree/testing_support/factory_bot'
-Spree::TestingSupport::FactoryBot.when_cherry_picked do
-  Spree::TestingSupport::FactoryBot.deprecate_cherry_picking
-
-  require 'spree/testing_support/sequences'
-  require 'spree/testing_support/factories/option_value_factory'
-  require 'spree/testing_support/factories/option_type_factory'
-  require 'spree/testing_support/factories/product_factory'
-end
-
 FactoryBot.define do
   sequence(:random_float) { BigDecimal("#{rand(200)}.#{rand(99)}") }
 

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

@@ -1,13 +1,5 @@
 # frozen_string_literal: true
 
-require 'spree/testing_support/factory_bot'
-Spree::TestingSupport::FactoryBot.when_cherry_picked do
-  Spree::TestingSupport::FactoryBot.deprecate_cherry_picking
-
-  require 'spree/testing_support/factories/option_value_factory'
-  require 'spree/testing_support/factories/variant_property_rule_factory'
-end
-
 FactoryBot.define do
   factory :variant_property_rule_condition, class: 'Spree::VariantPropertyRuleCondition' do
     variant_property_rule

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

@@ -1,14 +1,5 @@
 # frozen_string_literal: true
 
-require 'spree/testing_support/factory_bot'
-Spree::TestingSupport::FactoryBot.when_cherry_picked do
-  Spree::TestingSupport::FactoryBot.deprecate_cherry_picking
-
-  require 'spree/testing_support/factories/product_factory'
-  require 'spree/testing_support/factories/property_factory'
-  require 'spree/testing_support/factories/option_value_factory'
-end
-
 FactoryBot.define do
   factory :variant_property_rule, class: 'Spree::VariantPropertyRule' do
     product

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

@@ -1,13 +1,5 @@
 # frozen_string_literal: true
 
-require 'spree/testing_support/factory_bot'
-Spree::TestingSupport::FactoryBot.when_cherry_picked do
-  Spree::TestingSupport::FactoryBot.deprecate_cherry_picking
-
-  require 'spree/testing_support/factories/variant_property_rule_factory'
-  require 'spree/testing_support/factories/property_factory'
-end
-
 FactoryBot.define do
   factory :variant_property_rule_value, class: 'Spree::VariantPropertyRuleValue' do
     variant_property_rule

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

@@ -1,20 +1,12 @@
 # frozen_string_literal: true
 
-require 'spree/testing_support/factory_bot'
-Spree::TestingSupport::FactoryBot.when_cherry_picked do
-  Spree::TestingSupport::FactoryBot.deprecate_cherry_picking
-
-  require 'spree/testing_support/sequences'
-  require 'spree/testing_support/factories/country_factory'
-end
-
 FactoryBot.define do
   factory :global_zone, class: 'Spree::Zone' do
     initialize_with { Spree::Zone.find_or_initialize_by(name: 'GlobalZone') }
     zone_members do |proxy|
       zone = proxy.instance_eval { @instance }
       Spree::Country.all.map do |c|
-        Spree::ZoneMember.create(zoneable: c, zone: zone)
+        Spree::ZoneMember.create(zoneable: c, zone:)
       end
     end
   end

data/lib/spree/testing_support/factory_bot.rb

@@ -17,43 +17,20 @@ module Spree
         @paths ||= PATHS.map { |path| path.sub(/.rb\z/, '') }
       end
 
-      def self.when_cherry_picked
-        callsites = caller
-
-        # All good if the factory is being loaded by FactoryBot or from `testing_support/factories.rb`.
-        return if callsites.find do |line|
-          line.include?("/factory_bot/find_definitions.rb") ||
-          line.include?("/spree/testing_support/factories.rb")
-        end
-
-        yield
-      end
-
-      def self.deprecate_cherry_picking
-        callsites = caller
-        core_root = Spree::Core::Engine.root.to_s
-        index = callsites.index { |line| !line.start_with? core_root }
-
-        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]
-        )
-      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
-          Spree::Deprecation.warn(
-            "Please be aware that the supported version of FactoryBot is #{requirement}, " \
-            "using version #{version} could lead to factory loading issues.", caller(2)
-          )
+          raise <<~MSG
+            Please be aware that the supported version of FactoryBot is #{requirement},
+            using version #{version} could lead to factory loading issues.
+          MSG
         end
       end
+      deprecate :check_version, deprecator: Spree.deprecator
 
       def self.add_definitions!
         ::FactoryBot.definition_file_paths.unshift(*definition_file_paths).uniq!

data/lib/spree/testing_support/flaky.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+require 'rspec/retry'
+
+# Usage:
+#
+# it 'fails intermittently', :flaky do
+#   ...
+# end
+#
+# Docs: https://github.com/NoRedInk/rspec-retry
+RSpec.configure do |config|
+  config.verbose_retry = true
+  config.display_try_failure_messages = true
+
+  config.around(:each, :flaky) do |example|
+    if ENV['CI']
+      example.run_with_retry retry: 2
+    else
+      example.run
+    end
+  end
+end

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:)
       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:,
           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|
@@ -46,7 +47,7 @@ module Spree
       private
 
       def add_line_item!(order)
-        ::FactoryBot.create(:line_item, order: order)
+        ::FactoryBot.create(:line_item, order:)
         order.reload
       end
 
@@ -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'

data/lib/spree/testing_support/sequences.rb

@@ -1,10 +1,5 @@
 # frozen_string_literal: true
 
-require 'spree/testing_support/factory_bot'
-Spree::TestingSupport::FactoryBot.when_cherry_picked do
-  Spree::TestingSupport::FactoryBot.deprecate_cherry_picking
-end
-
 FactoryBot.define do
   sequence(:sku) { |n| "SKU-#{n}" }
   sequence(:email) { |n| "email#{n}@example.com" }

data/lib/spree/testing_support/shared_examples/calculator.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+RSpec.shared_examples_for 'a calculator with a description' do
+  describe ".description" do
+    subject { described_class.description }
+    it "has a description" do
+      expect(subject.size).to be > 0
+    end
+  end
+end

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

@@ -0,0 +1,141 @@
+# frozen_string_literal: true
+
+RSpec.shared_examples "shipping methods are assigned" do
+  context "given a shipping method" do
+    let(:shipping_method) { create(:shipping_method) }
+
+    it "assigns the shipping method when created" do
+      expect(
+        create(
+          factory,
+          shipping_method:
+        ).shipments.map(&:shipping_method)
+      ).to all(eq(shipping_method))
+    end
+
+    it "assigns the shipping method when built" do
+      expect(
+        build(
+          factory,
+          shipping_method:
+        ).shipments.map(&:shipping_method)
+      ).to all(eq(shipping_method))
+    end
+  end
+end
+
+RSpec.shared_examples "an order with line items factory" do |expected_order_state, expected_inventory_unit_state|
+  # This factory cannot be built correctly because Shipment#set_up_inventory
+  # requires records to be saved.
+  context "when created" do
+    let(:stock_location) { create(:stock_location) }
+    let(:first_variant) { create(:variant) }
+    let(:second_variant) { create(:variant) }
+    let(:shipping_method) { create(:shipping_method) }
+    let(:order) do
+      create(
+        factory,
+        stock_location:,
+        line_items_attributes: [
+          { variant: first_variant, quantity: 1, price: 1 },
+          { variant: second_variant, quantity: 2, price: 2 }
+        ],
+        shipment_cost: 3,
+        shipping_method:
+      )
+    end
+
+    it "has the expected attributes" do
+      aggregate_failures "for line items" do
+        expect(order.line_items.count).to eq 2
+        expect(order.line_items[0]).to have_attributes(
+          quantity: 1,
+          price: 1.0
+        )
+        expect(order.line_items[1]).to have_attributes(
+          price: 2.0,
+          quantity: 2
+        )
+      end
+
+      aggregate_failures "for shipments" do
+        expect(order.shipments.count).to eq 1
+        expect(order.shipments[0]).to have_attributes(
+          amount: 3.0,
+          stock_location:
+        )
+
+        expect(order.shipments[0].shipping_method).to eq(shipping_method)
+
+        # Explicitly order by line item id, because otherwise these can be in
+        # an arbitrary order.
+        inventory_units = order.shipments[0].inventory_units.sort_by(&:line_item_id)
+
+        expect(inventory_units.count).to eq(3)
+        expect(inventory_units[0]).to have_attributes(
+          order:,
+          shipment: order.shipments[0],
+          line_item: order.line_items[0],
+          variant: order.line_items[0].variant,
+          state: expected_inventory_unit_state
+        )
+        expect(inventory_units[1]).to have_attributes(
+          order:,
+          shipment: order.shipments[0],
+          line_item: order.line_items[1],
+          variant: order.line_items[1].variant,
+          state: expected_inventory_unit_state
+        )
+        expect(inventory_units[2]).to have_attributes(
+          order:,
+          shipment: order.shipments[0],
+          line_item: order.line_items[1],
+          variant: order.line_items[1].variant,
+          state: expected_inventory_unit_state
+        )
+      end
+
+      expect(order).to have_attributes(
+        item_total: 5.0,
+        ship_total: 3.0,
+        total: 8.0,
+        state: expected_order_state
+      )
+    end
+  end
+
+  context 'when shipments should be taxed' do
+    let!(:ship_address) { create(:address) }
+    let!(:tax_zone) { create(:global_zone) } # will include the above address
+    let!(:tax_rate) { create(:tax_rate, amount: 0.10, zone: tax_zone, tax_categories: [tax_category]) }
+
+    let(:tax_category) { create(:tax_category) }
+    let(:shipping_method) { create(:shipping_method, tax_category:, zones: [tax_zone]) }
+
+    it 'shipments get a tax adjustment' do
+      order = create(factory, ship_address:, shipping_method:)
+      shipment = order.shipments[0]
+
+      expect(shipment.additional_tax_total).to be > 0
+    end
+  end
+end
+
+RSpec.shared_examples 'supplied completed_at is respected' do
+  context 'when passed a completed_at timestamp' do
+    let(:completed_at) { 2.days.ago }
+    let(:order) { create(factory, completed_at:) }
+
+    it 'respects the timestamp' do
+      expect(order.completed_at).to be_within(5.seconds).of(completed_at)
+    end
+  end
+
+  context 'when no completed_at timestamp is passed' do
+    let(:order) { create(factory) }
+
+    it 'defaults to the current time' do
+      expect(order.completed_at).to be_within(2.seconds).of(Time.current)
+    end
+  end
+end

data/lib/spree/testing_support/shared_examples/working_factory.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+RSpec.shared_examples_for 'a working factory' do
+  it "builds successfully" do
+    expect(build(factory)).to be_a(factory_class)
+  end
+
+  it "creates successfully" do
+    expect(create(factory)).to be_a(factory_class)
+  end
+
+  it "is creates a valid record" do
+    expect(create(factory)).to be_valid
+  end
+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.deprecator.silence do
+      example.run
+    end
+  end
+end

data/lib/spree/user_class_handle.rb

@@ -21,8 +21,8 @@ module Spree
     # @return [String] the name of the user class as a string.
     # @raise [RuntimeError] if Spree.user_class is nil
     def to_s
-      fail "'Spree.user_class' has not been set yet." unless Spree.user_class
-      "::#{Spree.user_class}"
+      fail "'Spree.user_class' has not been set yet." unless Spree.user_class_name
+      "::#{Spree.user_class_name}"
     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:,
+        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/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/solidus_core.gemspec

@@ -14,23 +14,25 @@ Gem::Specification.new do |s|
   s.homepage    = 'http://solidus.io'
   s.license     = 'BSD-3-Clause'
 
+  s.metadata['rubygems_mfa_required'] = 'true'
+
   s.files = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(spec|script)/})
+    f.match(%r{^(spec|bin)/})
   end
 
-  s.required_ruby_version = '>= 2.5.0'
+  s.required_ruby_version = '>= 3.1.0'
   s.required_rubygems_version = '>= 1.8.23'
 
   %w[
     actionmailer actionpack actionview activejob activemodel activerecord
-    activesupport railties
+    activestorage activesupport railties
   ].each do |rails_dep|
-    s.add_dependency rails_dep, ['>= 5.2', '< 6.2.x']
+    s.add_dependency rails_dep, ['>= 7.0', '< 8.1.0.beta1']
   end
 
   s.add_dependency 'activemerchant', '~> 1.66'
   s.add_dependency 'acts_as_list', '< 2.0'
-  s.add_dependency 'awesome_nested_set', '~> 3.3'
+  s.add_dependency 'awesome_nested_set', ['~> 3.3', '>= 3.7.0']
   s.add_dependency 'cancancan', ['>= 2.2', '< 4.0']
   s.add_dependency 'carmen', '~> 1.1.0'
   s.add_dependency 'discard', '~> 1.0'
@@ -39,9 +41,12 @@ Gem::Specification.new do |s|
   s.add_dependency 'kaminari-activerecord', '~> 1.1'
   s.add_dependency 'mini_magick', '~> 4.10'
   s.add_dependency 'monetize', '~> 1.8'
-  s.add_dependency 'kt-paperclip', '~> 6.3'
-  s.add_dependency 'ransack', '~> 2.0'
+  s.add_dependency 'kt-paperclip', ['>= 6.3', '< 8']
+  s.add_dependency 'psych', ['>= 4.0.1', '< 6.0']
+  s.add_dependency 'ransack', ['~> 4.0', '< 5']
+  s.add_dependency 'sprockets-rails', '!= 3.5.0'
   s.add_dependency 'state_machines-activerecord', '~> 0.6'
+  s.add_dependency 'omnes', '~> 0.2.2'
 
   s.post_install_message = <<-MSG
 -------------------------------------------------------------
@@ -55,7 +60,12 @@ $ bin/rails g solidus:install
 If you are updating Solidus from an older version, please run
 the following commands to complete the update:
 
-$ bin/rails solidus:upgrade
+$ bin/rails g solidus:update
+
+Please, don't forget to look at the CHANGELOG to see what has changed and
+whether you need to perform other tasks.
+
+https://github.com/solidusio/solidus/blob/main/CHANGELOG.md
 
 Please report any issues at:
 - https://github.com/solidusio/solidus/issues