Skip to content

armgit / spree

Public Imported from GitHub
0

Open Source Platform for DTC, B2B Commerce, Marketplaces & Omnichannel. REST APIs, TypeScript SDKs, and production-ready Next.js storefront. Self-host it. Own your data. No vendor lock-in. Zero platform fees.

Added rspec shared examples lifecycle events

Damian Legawiecc30eab737b08
diff --git a/core/app/models/concerns/spree/user_methods.rb b/core/app/models/concerns/spree/user_methods.rb
index bf712b1d0d..a5f3e33f3e 100644
--- a/core/app/models/concerns/spree/user_methods.rb
+++ b/core/app/models/concerns/spree/user_methods.rb
@@ -162,6 +162,14 @@ module Spree
name&.full
end
+ def event_serializer_class
+ Spree::Events::UserSerializer
+ end
+
+ def event_prefix
+ 'user'
+ end
+
private
def check_completed_orders
diff --git a/core/app/serializers/spree/events/legacy_user_serializer.rb b/core/app/serializers/spree/events/legacy_user_serializer.rb
deleted file mode 100644
index 3fb4e4ef99..0000000000
--- a/core/app/serializers/spree/events/legacy_user_serializer.rb
+++ /dev/null
@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-module Spree
- module Events
- # LegacyUser serializer - uses the same attributes as UserSerializer
- class LegacyUserSerializer < UserSerializer
- end
- end
-end
diff --git a/core/lib/spree/testing_support/lifecycle_events.rb b/core/lib/spree/testing_support/lifecycle_events.rb
new file mode 100644
index 0000000000..e3072da761
--- /dev/null
+++ b/core/lib/spree/testing_support/lifecycle_events.rb
@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+shared_examples_for 'lifecycle events' do |factory: nil, event_prefix: nil|
+ let(:lifecycle_factory) { factory || described_class.name.demodulize.underscore.to_sym }
+ let(:lifecycle_event_prefix) { event_prefix || described_class.event_prefix }
+
+ describe 'lifecycle events' do
+ describe "#{described_class.event_prefix}.created" do
+ it 'publishes created event when record is created' do
+ record = build(lifecycle_factory)
+ expect(record).to receive(:publish_event).with("#{lifecycle_event_prefix}.created")
+ allow(record).to receive(:publish_event).with(anything)
+
+ record.save!
+ end
+ end
+
+ describe "#{described_class.event_prefix}.updated" do
+ it 'publishes updated event when record is updated' do
+ record = create(lifecycle_factory)
+ expect(record).to receive(:publish_event).with("#{lifecycle_event_prefix}.updated")
+ allow(record).to receive(:publish_event).with(anything)
+
+ record.touch
+ end
+ end
+
+ describe "#{described_class.event_prefix}.destroyed" do
+ it 'publishes destroyed event when record is destroyed' do
+ record = create(lifecycle_factory)
+ expect(record).to receive(:publish_event).with("#{lifecycle_event_prefix}.destroyed", kind_of(Hash))
+ allow(record).to receive(:publish_event).with(anything)
+
+ record.destroy!
+ end
+ end
+ end
+end
diff --git a/core/spec/models/spree/asset_spec.rb b/core/spec/models/spree/asset_spec.rb
index bed7965f34..2ff717ba77 100644
--- a/core/spec/models/spree/asset_spec.rb
+++ b/core/spec/models/spree/asset_spec.rb
@@ -2,6 +2,7 @@ require 'spec_helper'
describe Spree::Asset, type: :model do
it_behaves_like 'metadata'
+ it_behaves_like 'lifecycle events'
describe 'named variants' do
let(:reflection) { described_class.attachment_reflections['attachment'] }
@@ -16,7 +17,7 @@ describe Spree::Asset, type: :model do
named_variant = reflection.named_variants[name]
expect(named_variant).to be_present
expect(named_variant.transformations[:resize_to_fill]).to eq([width, height])
- expect(named_variant.transformations[:format]).to eq("webp")
+ expect(named_variant.transformations[:format]).to eq('webp')
expect(named_variant.instance_variable_get(:@preprocessed)).to eq(true)
end
end
@@ -78,7 +79,7 @@ describe Spree::Asset, type: :model do
let(:uuid) { SecureRandom.uuid }
it 'returns assets with the given uuid' do
- expect(subject).to contain_exactly(*assets)
+ expect(subject).to match_array(assets)
end
end
diff --git a/core/spec/models/spree/customer_return_spec.rb b/core/spec/models/spree/customer_return_spec.rb
index 95f210e802..f77cf30374 100644
--- a/core/spec/models/spree/customer_return_spec.rb
+++ b/core/spec/models/spree/customer_return_spec.rb
@@ -7,6 +7,41 @@ describe Spree::CustomerReturn, type: :model do
it_behaves_like 'metadata'
+ describe 'lifecycle events' do
+ describe 'customer_return.created' do
+ it 'publishes created event when record is created' do
+ customer_return = build(:customer_return_without_return_items, store: create(:store))
+ shipped_order = create(:shipped_order, line_items_count: 1, store: customer_return.store)
+ customer_return.return_items << build(:return_item, inventory_unit: shipped_order.inventory_units.first)
+
+ expect(customer_return).to receive(:publish_event).with('customer_return.created')
+ allow(customer_return).to receive(:publish_event).with(anything)
+
+ customer_return.save!
+ end
+ end
+
+ describe 'customer_return.updated' do
+ it 'publishes updated event when record is updated' do
+ record = create(:customer_return)
+ expect(record).to receive(:publish_event).with('customer_return.updated')
+ allow(record).to receive(:publish_event).with(anything)
+
+ record.touch
+ end
+ end
+
+ describe 'customer_return.destroyed' do
+ it 'publishes destroyed event when record is destroyed' do
+ record = create(:customer_return)
+ expect(record).to receive(:publish_event).with('customer_return.destroyed', kind_of(Hash))
+ allow(record).to receive(:publish_event).with(anything)
+
+ record.destroy!
+ end
+ end
+ end
+
describe '.validation' do
describe '#must_have_return_authorization' do
subject { customer_return.valid? }
diff --git a/core/spec/models/spree/digital_link_spec.rb b/core/spec/models/spree/digital_link_spec.rb
index ee674b55e6..2c365b31b0 100644
--- a/core/spec/models/spree/digital_link_spec.rb
+++ b/core/spec/models/spree/digital_link_spec.rb
@@ -6,6 +6,8 @@ describe Spree::DigitalLink, type: :model do
let(:variant) { digital.variant }
let(:line_item) { create(:line_item, variant: variant) }
+ it_behaves_like 'lifecycle events'
+
it 'validates presence of digital and line_item' do
expect(described_class.new(digital: digital, line_item: line_item)).to be_valid
end
diff --git a/core/spec/models/spree/digital_spec.rb b/core/spec/models/spree/digital_spec.rb
index fec84852da..0a5c2f31cf 100644
--- a/core/spec/models/spree/digital_spec.rb
+++ b/core/spec/models/spree/digital_spec.rb
@@ -6,6 +6,8 @@ describe Spree::Digital, type: :model do
let(:file_upload) { fixture_file_upload(file_fixture('icon_256x256.png'), 'image/png') }
let(:variant) { create(:variant) }
+ it_behaves_like 'lifecycle events'
+
it 'validates presence of variant' do
expect(described_class.new(attachment: file_upload)).not_to be_valid
end
diff --git a/core/spec/models/spree/export_spec.rb b/core/spec/models/spree/export_spec.rb
index 5bb87bf1fa..d902c5341d 100644
--- a/core/spec/models/spree/export_spec.rb
+++ b/core/spec/models/spree/export_spec.rb
@@ -1,23 +1,14 @@
require 'spec_helper'
RSpec.describe Spree::Export, :job, type: :model do
+ it_behaves_like 'lifecycle events', factory: :product_export
+
let(:store) { create(:store, code: 'my-store') }
let(:user) { create(:admin_user) }
let(:search_params) { nil }
let(:export) { build(:product_export, store: store, user: user, format: 'csv', search_params: search_params) }
- describe 'custom events' do
- describe 'export.created' do
- it 'publishes export.created event when saved' do
- expect(export).to receive(:publish_event).with('export.created')
- allow(export).to receive(:publish_event).with(anything)
-
- export.save!
- end
- end
- end
-
describe '#model_class' do
it 'returns the correct record class' do
expect(export.model_class).to eq(Spree::Product)
diff --git a/core/spec/models/spree/gift_card_batch_spec.rb b/core/spec/models/spree/gift_card_batch_spec.rb
index a0f9d42804..fde043b17b 100644
--- a/core/spec/models/spree/gift_card_batch_spec.rb
+++ b/core/spec/models/spree/gift_card_batch_spec.rb
@@ -1,6 +1,40 @@
require 'spec_helper'
RSpec.describe Spree::GiftCardBatch, type: :model do
+ describe 'lifecycle events' do
+ let(:gift_card_batch_attrs) { { codes_count: 2, prefix: 'batch_', amount: 10 } }
+
+ describe 'gift_card_batch.created' do
+ it 'publishes created event when record is created' do
+ record = build(:gift_card_batch, gift_card_batch_attrs)
+ expect(record).to receive(:publish_event).with('gift_card_batch.created')
+ allow(record).to receive(:publish_event).with(anything)
+
+ record.save!
+ end
+ end
+
+ describe 'gift_card_batch.updated' do
+ it 'publishes updated event when record is updated' do
+ record = create(:gift_card_batch, gift_card_batch_attrs)
+ expect(record).to receive(:publish_event).with('gift_card_batch.updated')
+ allow(record).to receive(:publish_event).with(anything)
+
+ record.touch
+ end
+ end
+
+ describe 'gift_card_batch.destroyed' do
+ it 'publishes destroyed event when record is destroyed' do
+ record = create(:gift_card_batch, gift_card_batch_attrs)
+ expect(record).to receive(:publish_event).with('gift_card_batch.destroyed', kind_of(Hash))
+ allow(record).to receive(:publish_event).with(anything)
+
+ record.destroy!
+ end
+ end
+ end
+
describe '#create_gift_cards' do
subject(:gift_card_batch) { build(:gift_card_batch, codes_count: 2, prefix: 'batch_', amount: 10) }
diff --git a/core/spec/models/spree/gift_card_spec.rb b/core/spec/models/spree/gift_card_spec.rb
index 0ecf1f65bb..8a7a651917 100644
--- a/core/spec/models/spree/gift_card_spec.rb
+++ b/core/spec/models/spree/gift_card_spec.rb
@@ -3,6 +3,8 @@ require 'spec_helper'
RSpec.describe Spree::GiftCard, type: :model do
let(:store) { @default_store }
+ it_behaves_like 'lifecycle events'
+
describe 'Callbacks' do
describe '#ensure_can_be_deleted' do
it "ensures a used gift card can't be destroyed" do
diff --git a/core/spec/models/spree/import_spec.rb b/core/spec/models/spree/import_spec.rb
index 89b75d5c78..934c442a82 100644
--- a/core/spec/models/spree/import_spec.rb
+++ b/core/spec/models/spree/import_spec.rb
@@ -7,6 +7,8 @@ RSpec.describe Spree::Import, :job, type: :model do
let(:csv_content) { File.read(File.join(Spree::Core::Engine.root, 'spec/fixtures/files', 'products_import.csv')) }
let(:import) { build(:product_import, owner: store, user: user) }
+ it_behaves_like 'lifecycle events', factory: :product_import
+
before do
# Stub the file content reading since ActiveStorage doesn't persist files properly in transactional tests
allow(import).to receive(:attachment_file_content).and_return(csv_content)
diff --git a/core/spec/models/spree/line_item_spec.rb b/core/spec/models/spree/line_item_spec.rb
index 149fcfbbaa..73e6ee15a1 100644
--- a/core/spec/models/spree/line_item_spec.rb
+++ b/core/spec/models/spree/line_item_spec.rb
@@ -6,6 +6,7 @@ describe Spree::LineItem, type: :model do
let(:line_item) { order.line_items.first }
it_behaves_like 'metadata'
+ it_behaves_like 'lifecycle events'
describe 'Validations' do
describe 'ensure_proper_currency' do
diff --git a/core/spec/models/spree/newsletter_subscriber_spec.rb b/core/spec/models/spree/newsletter_subscriber_spec.rb
index 5b0e52ce7b..57cbde80a2 100644
--- a/core/spec/models/spree/newsletter_subscriber_spec.rb
+++ b/core/spec/models/spree/newsletter_subscriber_spec.rb
@@ -5,6 +5,8 @@ describe Spree::NewsletterSubscriber, type: :model, newsletter: true do
let(:email) { 'joe#example.com' }
+ it_behaves_like 'lifecycle events'
+
describe 'normalizations' do
it { is_expected.to normalize(:email).from(" [email protected]\n").to('[email protected]') }
it { is_expected.to normalize(:email).from('').to(nil) }
diff --git a/core/spec/models/spree/order_spec.rb b/core/spec/models/spree/order_spec.rb
index 0ff7f44f94..6de1abd1bd 100644
--- a/core/spec/models/spree/order_spec.rb
+++ b/core/spec/models/spree/order_spec.rb
@@ -7,6 +7,8 @@ class FakeCalculator < Spree::Calculator
end
describe Spree::Order, type: :model do
+ it_behaves_like 'lifecycle events'
+
let(:user) { create(:user) }
let!(:store) { @default_store }
let(:order) { create(:order, user: user, store: store) }
diff --git a/core/spec/models/spree/payment_spec.rb b/core/spec/models/spree/payment_spec.rb
index 40739217fb..decdf6d838 100644
--- a/core/spec/models/spree/payment_spec.rb
+++ b/core/spec/models/spree/payment_spec.rb
@@ -1,6 +1,8 @@
require 'spec_helper'
describe Spree::Payment, type: :model do
+ it_behaves_like 'lifecycle events'
+
let(:store) { @default_store }
let(:order) { create(:order, store: store, total: 200) }
let(:refund_reason) { create(:refund_reason) }
diff --git a/core/spec/models/spree/post_category_spec.rb b/core/spec/models/spree/post_category_spec.rb
index 53bdca3c90..e800dcbe4f 100644
--- a/core/spec/models/spree/post_category_spec.rb
+++ b/core/spec/models/spree/post_category_spec.rb
@@ -3,6 +3,8 @@ require 'spec_helper'
RSpec.describe Spree::PostCategory, type: :model do
let(:post_category) { build(:post_category) }
+ it_behaves_like 'lifecycle events'
+
context 'Associations' do
describe 'posts' do
it 'has many posts' do
diff --git a/core/spec/models/spree/post_spec.rb b/core/spec/models/spree/post_spec.rb
index cf5ba0814c..43da1b86b5 100644
--- a/core/spec/models/spree/post_spec.rb
+++ b/core/spec/models/spree/post_spec.rb
@@ -3,6 +3,8 @@ require 'spec_helper'
RSpec.describe Spree::Post, type: :model do
let(:post) { create(:post) }
+ it_behaves_like 'lifecycle events'
+
context 'Validations' do
describe 'image' do
it 'validates content type' do
diff --git a/core/spec/models/spree/price_spec.rb b/core/spec/models/spree/price_spec.rb
index 38ef2a7ec4..60449e37ef 100644
--- a/core/spec/models/spree/price_spec.rb
+++ b/core/spec/models/spree/price_spec.rb
@@ -1,6 +1,8 @@
require 'spec_helper'
describe Spree::Price, type: :model do
+ it_behaves_like 'lifecycle events'
+
describe 'Callbacks' do
context 'when compare_at_amount is equal to amount' do
let(:variant) { create(:variant) }
diff --git a/core/spec/models/spree/product_spec.rb b/core/spec/models/spree/product_spec.rb
index 4389158437..0159fd6a3d 100644
--- a/core/spec/models/spree/product_spec.rb
+++ b/core/spec/models/spree/product_spec.rb
@@ -11,6 +11,7 @@ describe Spree::Product, type: :model do
let!(:store) { Spree::Store.default }
it_behaves_like 'metadata'
+ it_behaves_like 'lifecycle events'
describe 'after_initialize :assign_default_tax_category' do
@@ -1679,37 +1680,4 @@ describe Spree::Product, type: :model do
end
end
- describe 'lifecycle events' do
- describe 'product.created' do
- it 'publishes product.created event when product is created' do
- product = build(:product, stores: [store])
- expect(product).to receive(:publish_event).with('product.created')
- allow(product).to receive(:publish_event).with(anything)
-
- product.save!
- end
- end
-
- describe 'product.updated' do
- let!(:product) { create(:product, name: 'Original Name', stores: [store]) }
-
- it 'publishes product.updated event when product is updated' do
- expect(product).to receive(:publish_event).with('product.updated')
- allow(product).to receive(:publish_event).with(anything)
-
- product.update!(name: 'Updated Name')
- end
- end
-
- describe 'product.destroyed' do
- let!(:product) { create(:product, name: 'To Be Destroyed', stores: [store]) }
-
- it 'publishes product.destroyed event when product is destroyed' do
- expect(product).to receive(:publish_event).with('product.destroyed', kind_of(Hash))
- allow(product).to receive(:publish_event).with(anything)
-
- product.destroy!
- end
- end
- end
end
diff --git a/core/spec/models/spree/promotion_spec.rb b/core/spec/models/spree/promotion_spec.rb
index dce33c3294..3f9a3e47f1 100644
--- a/core/spec/models/spree/promotion_spec.rb
+++ b/core/spec/models/spree/promotion_spec.rb
@@ -2,6 +2,7 @@ require 'spec_helper'
describe Spree::Promotion, type: :model do
it_behaves_like 'metadata'
+ it_behaves_like 'lifecycle events'
let(:store) { @default_store }
let(:promotion) { create(:promotion, kind: :automatic) }
diff --git a/core/spec/models/spree/refund_spec.rb b/core/spec/models/spree/refund_spec.rb
index 5041c528df..e835bb5598 100644
--- a/core/spec/models/spree/refund_spec.rb
+++ b/core/spec/models/spree/refund_spec.rb
@@ -1,12 +1,13 @@
require 'spec_helper'
describe Spree::Refund, type: :model do
- describe 'metadata' do
+ describe 'shared examples' do
before do
allow_any_instance_of(Spree::Refund).to receive(:amount_is_less_than_or_equal_to_allowed_amount)
end
it_behaves_like 'metadata'
+ it_behaves_like 'lifecycle events'
end
describe 'create' do
diff --git a/core/spec/models/spree/report_spec.rb b/core/spec/models/spree/report_spec.rb
index 019a7282bf..a2bc7bfbc9 100644
--- a/core/spec/models/spree/report_spec.rb
+++ b/core/spec/models/spree/report_spec.rb
@@ -1,6 +1,8 @@
require 'spec_helper'
RSpec.describe Spree::Report, type: :model do
+ it_behaves_like 'lifecycle events', factory: :report
+
let(:store) { @default_store }
let(:user) { create(:admin_user) }
let(:report) { build(:report, store: store, user: user) }
@@ -48,17 +50,6 @@ RSpec.describe Spree::Report, type: :model do
end
end
- describe 'custom events' do
- describe 'report.created' do
- it 'publishes report.created event when saved' do
- expect(report).to receive(:publish_event).with('report.created')
- allow(report).to receive(:publish_event).with(anything)
-
- report.save!
- end
- end
- end
-
describe 'callbacks' do
describe 'after_initialize' do
let(:new_report) { Spree::Report.new(store: store) }
diff --git a/core/spec/models/spree/return_authorization_spec.rb b/core/spec/models/spree/return_authorization_spec.rb
index 889e5eb222..51ad7e9006 100644
--- a/core/spec/models/spree/return_authorization_spec.rb
+++ b/core/spec/models/spree/return_authorization_spec.rb
@@ -13,6 +13,39 @@ describe Spree::ReturnAuthorization, type: :model do
return_authorization_reason_id: rma_reason.id)
end
+ describe 'lifecycle events' do
+ describe 'return_authorization.created' do
+ it 'publishes created event when record is created' do
+ shipped_order = create(:shipped_order)
+ record = build(:new_return_authorization, order: shipped_order)
+ expect(record).to receive(:publish_event).with('return_authorization.created')
+ allow(record).to receive(:publish_event).with(anything)
+
+ record.save!
+ end
+ end
+
+ describe 'return_authorization.updated' do
+ it 'publishes updated event when record is updated' do
+ record = create(:return_authorization)
+ expect(record).to receive(:publish_event).with('return_authorization.updated')
+ allow(record).to receive(:publish_event).with(anything)
+
+ record.touch
+ end
+ end
+
+ describe 'return_authorization.destroyed' do
+ it 'publishes destroyed event when record is destroyed' do
+ record = create(:return_authorization)
+ expect(record).to receive(:publish_event).with('return_authorization.destroyed', kind_of(Hash))
+ allow(record).to receive(:publish_event).with(anything)
+
+ record.destroy!
+ end
+ end
+ end
+
context 'save' do
let(:order) { Spree::Order.create }
diff --git a/core/spec/models/spree/shipment_spec.rb b/core/spec/models/spree/shipment_spec.rb
index 776ffc74b5..06dd6d7670 100644
--- a/core/spec/models/spree/shipment_spec.rb
+++ b/core/spec/models/spree/shipment_spec.rb
@@ -1,6 +1,8 @@
require 'spec_helper'
describe Spree::Shipment, type: :model do
+ it_behaves_like 'lifecycle events'
+
let(:inventory_units) { create_list(:inventory_unit, 2) }
let(:variant) { line_item.variant }
let!(:line_item) { create(:line_item) }
diff --git a/core/spec/models/spree/stock_item_spec.rb b/core/spec/models/spree/stock_item_spec.rb
index ac784e8255..acba32ffdf 100644
--- a/core/spec/models/spree/stock_item_spec.rb
+++ b/core/spec/models/spree/stock_item_spec.rb
@@ -6,6 +6,7 @@ describe Spree::StockItem, type: :model do
let(:stock_location) { create(:stock_location_with_items) }
it_behaves_like 'metadata'
+ it_behaves_like 'lifecycle events'
it 'maintains the count on hand for a variant' do
expect(subject.count_on_hand).to eq 10
diff --git a/core/spec/models/spree/stock_movement_spec.rb b/core/spec/models/spree/stock_movement_spec.rb
index e9d5eb1afb..4244d632f9 100644
--- a/core/spec/models/spree/stock_movement_spec.rb
+++ b/core/spec/models/spree/stock_movement_spec.rb
@@ -1,6 +1,19 @@
require 'spec_helper'
describe Spree::StockMovement, type: :model do
+ # Note: StockMovement is marked as readonly after creation, so we only test the created event
+ describe 'lifecycle events' do
+ describe 'stock_movement.created' do
+ it 'publishes created event when record is created' do
+ record = build(:stock_movement)
+ expect(record).to receive(:publish_event).with('stock_movement.created')
+ allow(record).to receive(:publish_event).with(anything)
+
+ record.save!
+ end
+ end
+ end
+
describe 'Constants' do
describe 'QUANTITY_LIMITS[:max]' do
it 'return 2**31 - 1' do
diff --git a/core/spec/models/spree/stock_transfer_spec.rb b/core/spec/models/spree/stock_transfer_spec.rb
index c43fc2ba81..329dbaedc9 100644
--- a/core/spec/models/spree/stock_transfer_spec.rb
+++ b/core/spec/models/spree/stock_transfer_spec.rb
@@ -17,6 +17,7 @@ module Spree
let(:variant) { stock_item.variant }
it_behaves_like 'metadata'
+ it_behaves_like 'lifecycle events'
describe '#reference' do
subject { stock_transfer.reference }
diff --git a/core/spec/models/spree/store_credit_spec.rb b/core/spec/models/spree/store_credit_spec.rb
index 9813cfb397..f6dc50437a 100644
--- a/core/spec/models/spree/store_credit_spec.rb
+++ b/core/spec/models/spree/store_credit_spec.rb
@@ -6,6 +6,7 @@ describe Spree::StoreCredit, type: :model do
let(:store_credit_attrs) { {} }
it_behaves_like 'metadata'
+ it_behaves_like 'lifecycle events'
describe 'callbacks' do
subject { store_credit.save }
diff --git a/core/spec/models/spree/user_spec.rb b/core/spec/models/spree/user_spec.rb
index 1d4d1a509d..fc191f9302 100644
--- a/core/spec/models/spree/user_spec.rb
+++ b/core/spec/models/spree/user_spec.rb
@@ -1,6 +1,14 @@
require 'spec_helper'
describe Spree::LegacyUser, type: :model do # rubocop:disable RSpec/MultipleDescribes
+ it_behaves_like 'lifecycle events', factory: :user, event_prefix: 'user'
+
+ describe '#event_serializer_class' do
+ subject { build(:user).event_serializer_class }
+
+ it { is_expected.to eq(Spree::Events::UserSerializer) }
+ end
+
describe '#can_be_deleted?' do
subject { user.can_be_deleted? }
@@ -19,7 +27,7 @@ describe Spree::LegacyUser, type: :model do # rubocop:disable RSpec/MultipleDesc
describe '#full_name' do
context 'when names are present' do
- let(:user) { create(:user, first_name: 'John', last_name: 'Doe') }
+ let(:user) { build(:user, first_name: 'John', last_name: 'Doe') }
it 'returns the full name of the user' do
expect(user.full_name).to eq('John Doe')
@@ -27,7 +35,7 @@ describe Spree::LegacyUser, type: :model do # rubocop:disable RSpec/MultipleDesc
end
context 'when both first and last names are nil' do
- let(:user) { create(:user, first_name: nil, last_name: nil) }
+ let(:user) { build(:user, first_name: nil, last_name: nil) }
it 'does not raise error and returns nil' do
expect { user.full_name }.not_to raise_error
@@ -37,7 +45,7 @@ describe Spree::LegacyUser, type: :model do # rubocop:disable RSpec/MultipleDesc
end
# Regression test for #2844 + #3346
- context '#last_incomplete_order' do
+ describe '#last_incomplete_order' do
let!(:user) { create(:user) }
let!(:order) { create(:order, store: store, bill_address: create(:address), ship_address: create(:address)) }
let(:store) { @default_store }
@@ -45,6 +53,7 @@ describe Spree::LegacyUser, type: :model do # rubocop:disable RSpec/MultipleDesc
let(:order_1) { create(:order, created_at: 1.day.ago, user: user, created_by: user, store: store) }
let(:order_2) { create(:order, user: user, created_by: user, store: store) }
let(:order_3) { create(:order, user: user, created_by: create(:user), store: store) }
+
it 'returns correct order' do
Timecop.scale(3600) do
order_1
@@ -175,16 +184,16 @@ describe Spree.user_class, type: :model do
context 'lifetime_value' do
it 'returns a list of store lifetime values' do
- expect(subject.report_values_for(:lifetime_value, store)).to eq([Spree::Money.new((order_count * order_value), currency: currency),
- Spree::Money.new((eur_order_count * eur_order_value), currency: eur_currency)])
+ expect(subject.report_values_for(:lifetime_value, store)).to eq([Spree::Money.new(order_count * order_value, currency: currency),
+ Spree::Money.new(eur_order_count * eur_order_value, currency: eur_currency)])
end
end
context 'average_order_value' do
context 'with orders' do
it 'returns a list of average completed order prices for the user' do
- expect(subject.report_values_for(:average_order_value, store)).to eq([Spree::Money.new((order_value), currency: currency),
- Spree::Money.new((eur_order_value), currency: eur_currency)])
+ expect(subject.report_values_for(:average_order_value, store)).to eq([Spree::Money.new(order_value, currency: currency),
+ Spree::Money.new(eur_order_value, currency: eur_currency)])
end
end
end
@@ -295,9 +304,7 @@ describe Spree.user_class, type: :model do
end
it 'returns sum of amounts' do
- expect(subject.available_store_credits(store)).to match_array([Spree::Money.new(usd_amount, currency: 'USD'),
- Spree::Money.new(gbp_amount, currency: 'GBP'),
- Spree::Money.new(eur_amount, currency: 'EUR')])
+ expect(subject.available_store_credits(store)).to contain_exactly(Spree::Money.new(usd_amount, currency: 'USD'), Spree::Money.new(gbp_amount, currency: 'GBP'), Spree::Money.new(eur_amount, currency: 'EUR'))
end
end
end
@@ -348,19 +355,19 @@ describe Spree.user_class, type: :model do
context 'when default bill address does not belong to any user' do
let(:assigned_user) { nil }
- it_should_behave_like 'valid'
+ it_behaves_like 'valid'
end
context 'when default bill address belongs to user' do
let(:assigned_user) { user }
- it_should_behave_like 'valid'
+ it_behaves_like 'valid'
end
context 'when associated bill address belongs to other user' do
let(:assigned_user) { other_user }
- it_should_behave_like 'invalid'
+ it_behaves_like 'invalid'
it 'assigns error to bill address' do
expect(subject.errors.messages.keys).to include(:bill_address_id)
@@ -374,19 +381,19 @@ describe Spree.user_class, type: :model do
context 'when default ship address does not belong to any user' do
let(:assigned_user) { nil }
- it_should_behave_like 'valid'
+ it_behaves_like 'valid'
end
context 'when default ship address belongs to user' do
let(:assigned_user) { user }
- it_should_behave_like 'valid'
+ it_behaves_like 'valid'
end
context 'when associated ship address belongs to other user' do
let(:assigned_user) { other_user }
- it_should_behave_like 'invalid'
+ it_behaves_like 'invalid'
it 'assigns error to ship address' do
expect(subject.errors.messages.keys).to include(:ship_address_id)
@@ -414,13 +421,13 @@ describe Spree.user_class, type: :model do
context 'when default bill address is not associated to completed order' do
let!(:completed_order) { create(:completed_order_with_totals, user: user) }
- it_should_behave_like 'valid'
+ it_behaves_like 'valid'
end
context 'when default bill address is associated to uncompleted order' do
let!(:uncompleted_order) { create(:order, user: user, bill_address: address, ship_address: address) }
- it_should_behave_like 'valid'
+ it_behaves_like 'valid'
end
context 'when default bill address is associated to completed order' do
@@ -429,7 +436,7 @@ describe Spree.user_class, type: :model do
context 'when default bill address is the same as associated to order' do
it { expect(user.addresses).to include(address) }
- it_should_behave_like 'valid'
+ it_behaves_like 'valid'
end
context 'when user changed bill address which was used in completed order so the old one is deprecated' do
@@ -437,7 +444,7 @@ describe Spree.user_class, type: :model do
it { expect(user.addresses).not_to include(address) }
- it_should_behave_like 'invalid'
+ it_behaves_like 'invalid'
it 'assigns error to bill address' do
expect(subject.valid?).to be false
@@ -453,13 +460,13 @@ describe Spree.user_class, type: :model do
context 'when default ship address is not associated to completed order' do
let!(:completed_order) { create(:completed_order_with_totals, user: user) }
- it_should_behave_like 'valid'
+ it_behaves_like 'valid'
end
context 'when default ship address is associated to uncompleted order' do
let!(:uncompleted_order) { create(:order, user: user, ship_address: address) }
- it_should_behave_like 'valid'
+ it_behaves_like 'valid'
end
context 'when default ship address is associated to completed order' do
@@ -468,7 +475,7 @@ describe Spree.user_class, type: :model do
context 'when default ship address is the same as associated to order' do
it { expect(user.addresses).to include(address) }
- it_should_behave_like 'valid'
+ it_behaves_like 'valid'
end
context 'when user changed ship address which was used in completed order so the old one is deprecated' do
@@ -476,7 +483,7 @@ describe Spree.user_class, type: :model do
it { expect(user.addresses).not_to include(address) }
- it_should_behave_like 'invalid'
+ it_behaves_like 'invalid'
it 'assigns error to ship address' do
expect(subject.valid?).to be false
diff --git a/core/spec/models/spree/variant_spec.rb b/core/spec/models/spree/variant_spec.rb
index 1ba901ce02..2ac6171162 100644
--- a/core/spec/models/spree/variant_spec.rb
+++ b/core/spec/models/spree/variant_spec.rb
@@ -7,6 +7,7 @@ describe Spree::Variant, type: :model do
it_behaves_like 'default_price'
it_behaves_like 'metadata'
+ it_behaves_like 'lifecycle events'
context 'sorting' do
it 'responds to set_list_position' do
diff --git a/core/spec/models/spree/wished_item_spec.rb b/core/spec/models/spree/wished_item_spec.rb
index 3173d5e0c5..de624aad83 100644
--- a/core/spec/models/spree/wished_item_spec.rb
+++ b/core/spec/models/spree/wished_item_spec.rb
@@ -1,6 +1,8 @@
require 'spec_helper'
RSpec.describe Spree::WishedItem, type: :model do
+ it_behaves_like 'lifecycle events'
+
describe '.quantity' do
subject { build(:wished_item) }
diff --git a/core/spec/models/spree/wishlist_spec.rb b/core/spec/models/spree/wishlist_spec.rb
index b5d12534e3..bf049f319b 100644
--- a/core/spec/models/spree/wishlist_spec.rb
+++ b/core/spec/models/spree/wishlist_spec.rb
@@ -10,6 +10,37 @@ describe Spree::Wishlist, type: :model do
let!(:wishlist_belonging_to_other_store) { create(:wishlist, user: user, name: 'My Wishlist', store: other_store, is_default: true) }
let!(:wishlist_belonging_to_other_user) { create(:wishlist, user: other_user, name: 'My Wishlist', store: store, is_default: true) }
+ describe 'lifecycle events' do
+ describe 'wishlist.created' do
+ it 'publishes created event when record is created' do
+ record = build(:wishlist, user: user, store: store)
+ expect(record).to receive(:publish_event).with('wishlist.created')
+ allow(record).to receive(:publish_event).with(anything)
+
+ record.save!
+ end
+ end
+
+ describe 'wishlist.updated' do
+ it 'publishes updated event when record is updated' do
+ expect(wishlist).to receive(:publish_event).with('wishlist.updated')
+ allow(wishlist).to receive(:publish_event).with(anything)
+
+ wishlist.touch
+ end
+ end
+
+ describe 'wishlist.destroyed' do
+ it 'publishes destroyed event when record is destroyed' do
+ record = create(:wishlist, user: user, store: store)
+ expect(record).to receive(:publish_event).with('wishlist.destroyed', kind_of(Hash))
+ allow(record).to receive(:publish_event).with(anything)
+
+ record.destroy!
+ end
+ end
+ end
+
it 'has a valid factory' do
expect(wishlist).to be_valid
end
diff --git a/core/spec/serializers/spree/events/legacy_user_serializer_spec.rb b/core/spec/serializers/spree/events/legacy_user_serializer_spec.rb
deleted file mode 100644
index 4fe243583f..0000000000
--- a/core/spec/serializers/spree/events/legacy_user_serializer_spec.rb
+++ /dev/null
@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-RSpec.describe Spree::Events::LegacyUserSerializer do
- let(:user) { create(:user) }
-
- subject { described_class.serialize(user) }
-
- describe '#as_json' do
- it 'inherits from UserSerializer' do
- expect(described_class.superclass).to eq(Spree::Events::UserSerializer)
- end
-
- it 'includes identity attributes' do
- expect(subject[:id]).to eq(user.id)
- expect(subject[:email]).to eq(user.email)
- end
-
- it 'includes timestamps' do
- expect(subject[:created_at]).to be_present
- expect(subject[:updated_at]).to be_present
- end
-
- it 'does not include sensitive data' do
- expect(subject).not_to have_key(:encrypted_password)
- expect(subject).not_to have_key(:password)
- expect(subject).not_to have_key(:spree_api_key)
- end
- end
-end
diff --git a/core/spec/spec_helper.rb b/core/spec/spec_helper.rb
index 4bce192d2d..6b7794c7ae 100644
--- a/core/spec/spec_helper.rb
+++ b/core/spec/spec_helper.rb
@@ -45,6 +45,7 @@ require 'spree/testing_support/factories'
require 'spree/testing_support/jobs'
require 'spree/testing_support/store'
require 'spree/testing_support/metadata'
+require 'spree/testing_support/lifecycle_events'
require 'spree/testing_support/preferences'
require 'spree/testing_support/url_helpers'
require 'spree/testing_support/kernel'