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.
Ruby b2b-commercee-commerceecommerceecommerce-apiecommerce-frameworkecommerce-platformheadlessheadless-commerceheadless-ecommercemarketplacemulti-tenantmulti-vendormulti-vendor-ecommerceopen-sourcespree-commerce
newsletter subscribers update (#13118)
Szymon Chorobski4bf6d313bfb9
diff --git a/core/app/models/spree/newsletter_subscriber.rb b/core/app/models/spree/newsletter_subscriber.rbindex 1b70fb4ca9..8ddc1f39d2 100644--- a/core/app/models/spree/newsletter_subscriber.rb+++ b/core/app/models/spree/newsletter_subscriber.rb@@ -35,6 +35,12 @@ module Spree#self.whitelisted_ransackable_attributes = %w[email verified_at]self.whitelisted_ransackable_scopes = %w[verified unverified]++ def accepts_email_marketing+ return user.accepts_email_marketing if user.present?++ verified?+ enddef verified?verified_at.present?@@ -45,7 +51,7 @@ module Spreeenddef self.subscribe(email:, user: nil)- Spree::Newsletter::Subscribe.new(email: email, user: user).call+ Spree::Newsletter::Subscribe.new(email: email, current_user: user).callenddef self.verify(token:)diff --git a/core/app/services/spree/newsletter/subscribe.rb b/core/app/services/spree/newsletter/subscribe.rbindex c87825efba..e714a2bddb 100644--- a/core/app/services/spree/newsletter/subscribe.rb+++ b/core/app/services/spree/newsletter/subscribe.rb@@ -1,9 +1,9 @@module Spreemodule Newsletterclass Subscribe- def initialize(email:, user: nil)+ def initialize(email:, current_user: nil)@email = email- @user = user+ @current_user = current_userenddef call@@ -13,7 +13,7 @@ module Spreeupsert_subscriberreturn subscriber if subscriber.errors.any?- if subscriber.email == user&.email+ if subscriber.email == current_user&.email# no need to verified since user email is already verifiedSpree::Newsletter::Verify.new(subscriber: subscriber).callend@@ -26,13 +26,11 @@ module Spreeprivate- attr_reader :email, :user+ attr_reader :email, :current_userdef upsert_subscriber- @upsert_subscriber ||= Spree::NewsletterSubscriber.where(email: email).first_or_create do |new_record|- new_record.user = Spree.user_class.find_by(email: new_record.email)- rescue ActiveRecord::RecordNotFound- retry+ @upsert_subscriber ||= Spree::NewsletterSubscriber.find_or_create_by(email: email) do |new_record|+ new_record.user = Spree.user_class.find_by(email: new_record.email) || current_userendendalias_method :subscriber, :upsert_subscriberdiff --git a/core/app/services/spree/orders/create_user_account.rb b/core/app/services/spree/orders/create_user_account.rbindex 590967fdc1..6a949e1dc3 100644--- a/core/app/services/spree/orders/create_user_account.rb+++ b/core/app/services/spree/orders/create_user_account.rb@@ -6,8 +6,12 @@ module Spreeprepend ::Spree::ServiceModule::Basedef call(order:, accepts_email_marketing: false)- existing_user = Spree.user_class.find_by(email: order.email)- return existing_user if existing_user.present?+ Spree.user_class.find_by(email: order.email).tap do |existing_user|+ next if existing_user.blank?++ create_newsletter_subscriber(existing_user) if accepts_email_marketing+ return existing_user+ enduser = create_new_user(order, accepts_email_marketing)return failure(:user_creation_failed) unless user.persisted?@@ -22,6 +26,7 @@ module Spree# send welcome emailuser.send_welcome_email if user.respond_to?(:send_welcome_email)+ create_newsletter_subscriber(user) if accepts_email_marketingsuccess(user.reload)end@@ -65,6 +70,10 @@ module Spreeuser.update_columns(ship_address_id: order.ship_address_id, updated_at: Time.current) unless user.ship_address_id.present?endend++ def create_newsletter_subscriber(user)+ Spree::NewsletterSubscriber.subscribe(email: user.email, user: user)+ endendendenddiff --git a/core/db/migrate/20250915093930_add_metadata_to_spree_newsletter_subscribers.rb b/core/db/migrate/20250915093930_add_metadata_to_spree_newsletter_subscribers.rbnew file mode 100644index 0000000000..737eb17405--- /dev/null+++ b/core/db/migrate/20250915093930_add_metadata_to_spree_newsletter_subscribers.rb@@ -0,0 +1,20 @@+class AddMetadataToSpreeNewsletterSubscribers < ActiveRecord::Migration[7.2]+ def up+ change_table :spree_newsletter_subscribers do |t|+ if t.respond_to? :jsonb+ t.jsonb :public_metadata+ t.jsonb :private_metadata+ else+ t.json :public_metadata+ t.json :private_metadata+ end+ end+ end++ def down+ change_table :spree_newsletter_subscribers do |t|+ t.remove :public_metadata+ t.remove :private_metadata+ end+ end+enddiff --git a/core/lib/spree/core/version.rb b/core/lib/spree/core/version.rbindex 144d630dfb..58919d093e 100644--- a/core/lib/spree/core/version.rb+++ b/core/lib/spree/core/version.rb@@ -1,5 +1,5 @@module Spree- VERSION = '5.2.0.alpha'.freeze+ VERSION = '5.2.0.alpha2'.freezedef self.versionVERSIONdiff --git a/core/spec/models/spree/newsletter_subscriber_spec.rb b/core/spec/models/spree/newsletter_subscriber_spec.rbindex 6b3f264320..5b0e52ce7b 100644--- a/core/spec/models/spree/newsletter_subscriber_spec.rb+++ b/core/spec/models/spree/newsletter_subscriber_spec.rb@@ -1,6 +1,6 @@require 'spec_helper'-describe Spree::NewsletterSubscriber, type: :model do+describe Spree::NewsletterSubscriber, type: :model, newsletter: true dosubject(:subscriber) { build(:newsletter_subscriber, email: email) }let(:email) { 'joe#example.com' }@@ -44,7 +44,7 @@ describe Spree::NewsletterSubscriber, type: :model dolet(:user) { create(:user) }before do- allow(Spree::Newsletter::Subscribe).to receive(:new).with(email: email, user: user).and_return(subscribe_service)+ allow(Spree::Newsletter::Subscribe).to receive(:new).with(email: email, current_user: user).and_return(subscribe_service)endit 'calls subscribe service' do@@ -58,7 +58,7 @@ describe Spree::NewsletterSubscriber, type: :model dosubject { described_class.subscribe(email: email) }before do- allow(Spree::Newsletter::Subscribe).to receive(:new).with(email: email, user: nil).and_return(subscribe_service)+ allow(Spree::Newsletter::Subscribe).to receive(:new).with(email: email, current_user: nil).and_return(subscribe_service)endit 'calls subscribe service' dodiff --git a/core/spec/services/spree/newsletter/subscribe_spec.rb b/core/spec/services/spree/newsletter/subscribe_spec.rbindex 21e45bb603..358219c2d8 100644--- a/core/spec/services/spree/newsletter/subscribe_spec.rb+++ b/core/spec/services/spree/newsletter/subscribe_spec.rb@@ -7,7 +7,7 @@ module Spreelet(:params) do{email: email,- user: user+ current_user: user}enddiff --git a/core/spec/services/spree/orders/create_user_account_spec.rb b/core/spec/services/spree/orders/create_user_account_spec.rbindex b33444d13f..133deea430 100644--- a/core/spec/services/spree/orders/create_user_account_spec.rb+++ b/core/spec/services/spree/orders/create_user_account_spec.rb@@ -1,13 +1,34 @@require 'spec_helper'describe Spree::Orders::CreateUserAccount do+ subject(:service) { described_class.call(order: order, accepts_email_marketing: accepts_email_marketing) }++ let(:accepts_email_marketing) { false }let(:store) { @default_store }let(:address) { create(:address, country: store.default_country, firstname: 'John', lastname: 'Snow') }let(:order) docreate(:completed_order_with_totals, bill_address: address, ship_address: address, store: store, user: nil, email: '[email protected]')end- subject { described_class.call(order: order) }+ context 'when accepts_email_marketing is true' do+ let(:accepts_email_marketing) { true }++ it 'calls subscribe for newsletter' do+ expect(Spree::NewsletterSubscriber).to receive(:subscribe).with(email: order.email, user: kind_of(Spree.user_class))++ service+ end+ end++ context 'when accepts_email_marketing is false' do+ let(:accepts_email_marketing) { false }++ it 'does not call subscribe for newsletter' do+ expect(Spree::NewsletterSubscriber).to_not receive(:subscribe)++ service+ end+ endcontext 'when order has no user' dolet(:new_user) { Spree.user_class.find_by!(email: order.email) }@@ -43,5 +64,15 @@ describe Spree::Orders::CreateUserAccount doit 'does not create a new user' doexpect { subject }.to change { Spree.user_class.count }.by(0)end++ context 'when accepts_email_marketing is true' do+ let(:accepts_email_marketing) { true }++ it 'calls subscribe for newsletter' do+ expect(Spree::NewsletterSubscriber).to receive(:subscribe).with(email: order.email, user: user)++ service+ end+ endendenddiff --git a/emails/spec/models/spree/newsletter_subscriber_spec.rb b/emails/spec/models/spree/newsletter_subscriber_spec.rbindex e1a8cdae2b..1caba8a92a 100644--- a/emails/spec/models/spree/newsletter_subscriber_spec.rb+++ b/emails/spec/models/spree/newsletter_subscriber_spec.rb@@ -1,5 +1,5 @@require 'spec_helper'-describe Spree::NewsletterSubscriber, type: :model do+describe Spree::NewsletterSubscriber, type: :model, newsletter: true dolet(:store) { Spree::Store.default }let(:subscriber) { create(:newsletter_subscriber) }diff --git a/storefront/spec/controllers/spree/account/newsletter_controller_spec.rb b/storefront/spec/controllers/spree/account/newsletter_controller_spec.rbindex d0b5659530..6cfee62b05 100644--- a/storefront/spec/controllers/spree/account/newsletter_controller_spec.rb+++ b/storefront/spec/controllers/spree/account/newsletter_controller_spec.rb@@ -1,6 +1,6 @@require 'spec_helper'-RSpec.describe Spree::Account::NewsletterController, type: :controller do+RSpec.describe Spree::Account::NewsletterController, type: :controller, newsletter: true dolet(:store) { @default_store }let(:user) { create(:user, email: '[email protected]') }diff --git a/storefront/spec/controllers/spree/newsletter_subscribers_controller_spec.rb b/storefront/spec/controllers/spree/newsletter_subscribers_controller_spec.rbindex 62803d1de3..9956110931 100644--- a/storefront/spec/controllers/spree/newsletter_subscribers_controller_spec.rb+++ b/storefront/spec/controllers/spree/newsletter_subscribers_controller_spec.rb@@ -1,6 +1,6 @@require 'spec_helper'-RSpec.describe Spree::NewsletterSubscribersController, type: :controller do+RSpec.describe Spree::NewsletterSubscribersController, type: :controller, newsletter: true dorender_viewslet(:store) { @default_store }