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 Admin UI + ability to export subscribers in a CSV (#13131)
Damian Legawiec8941320e6f41
diff --git a/admin/app/controllers/spree/admin/newsletter_subscribers_controller.rb b/admin/app/controllers/spree/admin/newsletter_subscribers_controller.rbnew file mode 100644index 0000000000..741407ec90--- /dev/null+++ b/admin/app/controllers/spree/admin/newsletter_subscribers_controller.rb@@ -0,0 +1,8 @@+module Spree+ module Admin+ class NewsletterSubscribersController < ResourceController+ add_breadcrumb_icon 'users'+ add_breadcrumb Spree.t(:customers), :admin_users_path+ end+ end+enddiff --git a/admin/app/views/spree/admin/newsletter_subscribers/_filters.html.erb b/admin/app/views/spree/admin/newsletter_subscribers/_filters.html.erbnew file mode 100644index 0000000000..e5ecce0159--- /dev/null+++ b/admin/app/views/spree/admin/newsletter_subscribers/_filters.html.erb@@ -0,0 +1,41 @@+<%= search_form_for [:admin, search_collection], class: "filter-wrap", data: { controller: "filters" } do |f| %>+ <div class="d-flex flex-column flex-lg-row gap-2">+ <%= render 'spree/admin/shared/filters_search_bar', param: :email_cont, label: Spree.t(:email) %>++ <div class="dropdown">+ <button class="btn btn-light dropdown-toggle" type="button" data-toggle="dropdown" aria-expanded="false">+ <span class="text-muted font-weight-normal mr-1">+ <%= Spree.t(:show) %>+ </span>+ <%# Show current filter value %>+ <% current_value =+ if params.dig(:q, :verified).to_s == 'true'+ Spree.t('admin.newsletter_subscribers.verified')+ elsif params.dig(:q, :unverified).to_s == 'true'+ Spree.t('admin.newsletter_subscribers.unverified')+ else+ Spree.t('admin.newsletter_subscribers.all')+ end+ %>+ <%= current_value %>+ </button>+ <div class="dropdown-menu dropdown-menu-right w-100" style="min-width: 200px">+ <%= active_link_to Spree.t('admin.newsletter_subscribers.all'),+ params.to_unsafe_h.deep_merge(q: { verified: nil, unverified: nil }),+ class: 'dropdown-item',+ active: params.dig(:q, :verified).blank? && params.dig(:q, :unverified).blank? %>+ <%= active_link_to Spree.t('admin.newsletter_subscribers.verified'),+ params.to_unsafe_h.deep_merge(q: { verified: true, unverified: nil }),+ class: 'dropdown-item',+ active: params.dig(:q, :verified).to_s == 'true' %>+ <%= active_link_to Spree.t('admin.newsletter_subscribers.unverified'),+ params.to_unsafe_h.deep_merge(q: { verified: nil, unverified: true }),+ class: 'dropdown-item',+ active: params.dig(:q, :unverified).to_s == 'true' %>+ </div>+ </div>+ </div>++ <%= render "spree/admin/shared/filter_badge_template" %>+ <div data-filters-target="badgesContainer" class="filter-badges-container"></div>+<% end %>diff --git a/admin/app/views/spree/admin/newsletter_subscribers/_table_header.html.erb b/admin/app/views/spree/admin/newsletter_subscribers/_table_header.html.erbnew file mode 100644index 0000000000..14902dc223--- /dev/null+++ b/admin/app/views/spree/admin/newsletter_subscribers/_table_header.html.erb@@ -0,0 +1,8 @@+<tr>+ <th scope="col"><%= sort_link search_collection, :email, Spree.t(:email) %></th>+ <th scope="col"><%= Spree.t(:customer) %></th>+ <th scope="col"><%= Spree.t(:verified) %>?</th>+ <th scope="col"><%= Spree.t(:verified_at) %></th>+ <th scope="col"><%= sort_link search_collection, :created_at, Spree.t(:created_at) %></th>+ <th scope="col"></th>+</tr>\ No newline at end of filediff --git a/admin/app/views/spree/admin/newsletter_subscribers/_table_row.html.erb b/admin/app/views/spree/admin/newsletter_subscribers/_table_row.html.erbnew file mode 100644index 0000000000..1ee96b4ce8--- /dev/null+++ b/admin/app/views/spree/admin/newsletter_subscribers/_table_row.html.erb@@ -0,0 +1,36 @@+<tr id="<%= spree_dom_id newsletter_subscriber %>">+ <td class="w-30">+ <%= newsletter_subscriber.email %>+ <%= clipboard_component(newsletter_subscriber.email) %>+ </td>+ <td class="w-25">+ <% if newsletter_subscriber.user.present? %>+ <%= link_to newsletter_subscriber.user.full_name, spree.admin_user_path(newsletter_subscriber.user) %>+ <% else %>+ <span class="text-muted"><%= Spree.t(:not_available) %></span>+ <% end %>+ </td>+ <td class="w-10">+ <%= active_badge(newsletter_subscriber.verified?) %>+ </td>+ <td class="w-15">+ <% if newsletter_subscriber.verified_at.present? %>+ <%= spree_date(newsletter_subscriber.verified_at) %>+ <% else %>+ <span class="text-muted"><%= Spree.t(:not_available) %></span>+ <% end %>+ </td>+ <td class="w-15">+ <%= spree_date(newsletter_subscriber.created_at) %>+ </td>+ <td class="w-5">+ <div class="dropdown" data-toggle="dropdown">+ <button class="btn btn-sm btn-light" type="button" id="newsletter-subscriber-actions-<%= newsletter_subscriber.id %>" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">+ <%= icon('dots-vertical', class: 'mr-0') %>+ </button>+ <div class="dropdown-menu dropdown-menu-right" aria-labelledby="newsletter-subscriber-actions-<%= newsletter_subscriber.id %>">+ <%= link_to_delete(newsletter_subscriber, icon: 'trash', class: 'dropdown-item text-danger') %>+ </div>+ </div>+ </td>+</tr>\ No newline at end of filediff --git a/admin/app/views/spree/admin/newsletter_subscribers/index.html.erb b/admin/app/views/spree/admin/newsletter_subscribers/index.html.erbnew file mode 100644index 0000000000..c170aefcad--- /dev/null+++ b/admin/app/views/spree/admin/newsletter_subscribers/index.html.erb@@ -0,0 +1,9 @@+<% content_for :page_title do %>+ <%= Spree.t(:newsletter_subscribers) %>+<% end %>++<% content_for :page_actions do %>+ <%= link_to_export_modal %>+<% end %>++<%= render 'spree/admin/shared/index_table', new_object_url: nil, export_type: Spree::Exports::NewsletterSubscribers %>\ No newline at end of filediff --git a/admin/app/views/spree/admin/shared/_index_table.html.erb b/admin/app/views/spree/admin/shared/_index_table.html.erbindex db02154f34..aeee3dbab5 100644--- a/admin/app/views/spree/admin/shared/_index_table.html.erb+++ b/admin/app/views/spree/admin/shared/_index_table.html.erb@@ -1,6 +1,7 @@<% sortable = local_assigns[:sortable] %><%= turbo_frame_tag controller_name, autoscroll: true, data: { autoscroll_block: :start, autoscroll_behavior: :smooth, turbo_action: 'advance' } do %>+ <%= render 'spree/admin/shared/export_modal', export_type: export_type if local_assigns[:export_type] %><div class="card-lg"><% if lookup_context.template_exists?('filters', lookup_context.prefixes, true) %><%= render 'filters' %>diff --git a/admin/app/views/spree/admin/shared/sidebar/_customers_nav.html.erb b/admin/app/views/spree/admin/shared/sidebar/_customers_nav.html.erbnew file mode 100644index 0000000000..40edfab591--- /dev/null+++ b/admin/app/views/spree/admin/shared/sidebar/_customers_nav.html.erb@@ -0,0 +1,8 @@+<% if can?(:manage, Spree.user_class) %>+ <% customers_active = %w[users newsletter_subscribers].include?(controller_name) %>+ <%= nav_item(Spree.t(:customers), spree.admin_users_path, icon: 'users', active: customers_active) %>++ <ul class="nav-submenu <% unless customers_active %>d-none<% end %>">+ <%= nav_item(Spree.t(:newsletter_subscribers), spree.admin_newsletter_subscribers_path) %>+ </ul>+<% end %>\ No newline at end of filediff --git a/admin/app/views/spree/admin/shared/sidebar/_store_nav.html.erb b/admin/app/views/spree/admin/shared/sidebar/_store_nav.html.erbindex 647a30ef49..cb16c5a6fa 100644--- a/admin/app/views/spree/admin/shared/sidebar/_store_nav.html.erb+++ b/admin/app/views/spree/admin/shared/sidebar/_store_nav.html.erb@@ -82,11 +82,7 @@<%= render 'spree/admin/shared/sidebar/returns_nav' %><%= render 'spree/admin/shared/sidebar/products_nav' %><%= render 'spree/admin/shared/sidebar/vendors_nav' %>-- <% if can?(:manage, Spree.user_class) %>- <%= nav_item(Spree.t(:customers), spree.admin_users_path, icon: 'users') %>- <% end %>-+ <%= render 'spree/admin/shared/sidebar/customers_nav' %><%= render 'spree/admin/shared/sidebar/promotions_nav' %><% if can?(:manage, Spree::Report) %>diff --git a/admin/config/locales/en.yml b/admin/config/locales/en.ymlindex 9591371b7a..facca60d33 100644--- a/admin/config/locales/en.yml+++ b/admin/config/locales/en.yml@@ -100,6 +100,10 @@ en:name: Namenavigation:nested_under: Nested under+ newsletter_subscribers:+ all: All+ unverified: Unverified+ verified: Verifiednot_tracking_inventory: Not tracking inventorynotifications: Notificationsnum_orders: No. of Ordersdiff --git a/admin/config/routes.rb b/admin/config/routes.rbindex dd22a4a40c..fd0896f778 100644--- a/admin/config/routes.rb+++ b/admin/config/routes.rb@@ -105,7 +105,7 @@ Spree::Core::Engine.add_routes dopost :bulk_remove_tagsendend-+ resources :newsletter_subscribers, only: [:index, :destroy]resources :addresses, except: [:index, :show]# promotionsdiff --git a/admin/spec/controllers/spree/admin/newsletter_subscribers_controller_spec.rb b/admin/spec/controllers/spree/admin/newsletter_subscribers_controller_spec.rbnew file mode 100644index 0000000000..9fc46131b7--- /dev/null+++ b/admin/spec/controllers/spree/admin/newsletter_subscribers_controller_spec.rb@@ -0,0 +1,28 @@+require 'spec_helper'++RSpec.describe Spree::Admin::NewsletterSubscribersController, type: :controller do+ stub_authorization!+ render_views++ describe '#index' do+ let!(:newsletter_subscribers) { create_list(:newsletter_subscriber, 3) }++ it 'renders the index template' do+ get :index+ expect(response).to render_template(:index)+ expect(response.status).to eq(200)+ expect(assigns(:collection).to_a).to eq(newsletter_subscribers)+ end+ end++ describe '#destroy' do+ let!(:newsletter_subscriber) { Spree::NewsletterSubscriber.create!(email: '[email protected]') }++ it 'destroys the newsletter subscriber and redirects' do+ expect {+ delete :destroy, params: { id: newsletter_subscriber.id }+ }.to change(Spree::NewsletterSubscriber, :count).by(-1)+ expect(response).to redirect_to(admin_newsletter_subscribers_path)+ end+ end+enddiff --git a/core/app/models/concerns/spree/user_methods.rb b/core/app/models/concerns/spree/user_methods.rbindex db0b95149d..d5cd74fdec 100644--- a/core/app/models/concerns/spree/user_methods.rb+++ b/core/app/models/concerns/spree/user_methods.rb@@ -134,10 +134,19 @@ module Spreeorders.complete.none?end+ # Returns the CSV row representation of the user+ # @param [Spree::Store] store+ # @return [Array<String>]def to_csv(_store = nil)Spree::CSV::CustomerPresenter.new(self).callend+ # Returns the full name of the user+ # @return [String]+ def full_name+ name.full+ end+privatedef check_completed_ordersdiff --git a/core/app/models/spree/exports/newsletter_subscribers.rb b/core/app/models/spree/exports/newsletter_subscribers.rbnew file mode 100644index 0000000000..0d792fd97e--- /dev/null+++ b/core/app/models/spree/exports/newsletter_subscribers.rb@@ -0,0 +1,13 @@+module Spree+ module Exports+ class NewsletterSubscribers < Spree::Export+ def scope_includes+ [:user]+ end++ def csv_headers+ Spree::CSV::NewsletterSubscriberPresenter::HEADERS+ end+ end+ end+enddiff --git a/core/app/models/spree/newsletter_subscriber.rb b/core/app/models/spree/newsletter_subscriber.rbindex c0925d06ac..1b70fb4ca9 100644--- a/core/app/models/spree/newsletter_subscriber.rb+++ b/core/app/models/spree/newsletter_subscriber.rb@@ -6,22 +6,44 @@ module Spreehas_secure_token :verification_token+ #+ # Associations+ #belongs_to :user, optional: true, class_name: Spree.user_class.name+ #+ # Validations+ #validates :email,presence: true,format: { with: URI::MailTo::EMAIL_REGEXP },uniqueness: { case_sensitive: false, scope: spree_base_uniqueness_scope }+ #+ # Scopes+ #scope :verified, -> { where.not(verified_at: nil) }scope :unverified, -> { where(verified_at: nil) }+ #+ # Callbacks+ #normalizes :email, with: ->(email) { email.to_s.strip.downcase.presence }+ #+ # Ransack filtering+ #+ self.whitelisted_ransackable_attributes = %w[email verified_at]+ self.whitelisted_ransackable_scopes = %w[verified unverified]+def verified?verified_at.present?end+ def to_csv(_store = nil)+ Spree::CSV::NewsletterSubscriberPresenter.new(self).call+ end+def self.subscribe(email:, user: nil)Spree::Newsletter::Subscribe.new(email: email, user: user).callenddiff --git a/core/app/models/spree/order.rb b/core/app/models/spree/order.rbindex 1b558eaedb..c9aa27f093 100644--- a/core/app/models/spree/order.rb+++ b/core/app/models/spree/order.rb@@ -454,7 +454,7 @@ module Spreedef full_name@full_name ||= if user.present? && user.name.present?- user.name.full+ user.full_nameelsebilling_address&.full_name || emailenddiff --git a/core/app/presenters/spree/csv/newsletter_subscriber_presenter.rb b/core/app/presenters/spree/csv/newsletter_subscriber_presenter.rbnew file mode 100644index 0000000000..6d0dbaebc4--- /dev/null+++ b/core/app/presenters/spree/csv/newsletter_subscriber_presenter.rb@@ -0,0 +1,33 @@+module Spree+ module CSV+ class NewsletterSubscriberPresenter+ HEADERS = [+ 'Email',+ 'Customer Name',+ 'Customer ID',+ 'Verified',+ 'Verified At',+ 'Created At',+ 'Updated At'+ ].freeze++ def initialize(newsletter_subscriber)+ @newsletter_subscriber = newsletter_subscriber+ end++ attr_accessor :newsletter_subscriber++ def call+ [+ newsletter_subscriber.email,+ newsletter_subscriber.user&.full_name,+ newsletter_subscriber.user_id,+ newsletter_subscriber.verified? ? Spree.t(:say_yes) : Spree.t(:say_no),+ newsletter_subscriber.verified_at,+ newsletter_subscriber.created_at,+ newsletter_subscriber.updated_at+ ]+ end+ end+ end+enddiff --git a/core/config/locales/en.yml b/core/config/locales/en.ymlindex 968200130c..f533e77327 100644--- a/core/config/locales/en.yml+++ b/core/config/locales/en.yml@@ -1365,6 +1365,7 @@ en:subject: Verify your email addressthanks: Thank youverify_email_address_link: Verify email address+ newsletter_subscribers: Newsletter Subscribersnewsletters: Newslettersnext: Nextno_actions_added: No actions added@@ -2268,6 +2269,8 @@ en:variants_count: Variants countvendor: Vendorvendors: Vendors+ verified: Verified+ verified_at: Verified atversion: Versionview: Viewview_all: View alldiff --git a/core/lib/spree/core/engine.rb b/core/lib/spree/core/engine.rbindex 94fce23f73..22c4ead763 100644--- a/core/lib/spree/core/engine.rb+++ b/core/lib/spree/core/engine.rb@@ -152,7 +152,8 @@ module SpreeSpree::Exports::Products,Spree::Exports::Orders,Spree::Exports::Customers,- Spree::Exports::GiftCards+ Spree::Exports::GiftCards,+ Spree::Exports::NewsletterSubscribers]Rails.application.config.spree.taxon_rules = [diff --git a/core/spec/models/spree/user_spec.rb b/core/spec/models/spree/user_spec.rbindex 05cafef660..2dc8f0011b 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+ describe '#full_name' do+ let(:user) { create(:user, first_name: 'John', last_name: 'Doe') }++ it 'returns the full name of the user' do+ expect(user.full_name).to eq('John Doe')+ end+ end+# Regression test for #2844 + #3346context '#last_incomplete_order' dolet!(:user) { create(:user) }diff --git a/core/spec/presenters/spree/csv/newsletter_subscriber_presenter_spec.rb b/core/spec/presenters/spree/csv/newsletter_subscriber_presenter_spec.rbnew file mode 100644index 0000000000..a68df17812--- /dev/null+++ b/core/spec/presenters/spree/csv/newsletter_subscriber_presenter_spec.rb@@ -0,0 +1,83 @@+require 'spec_helper'++RSpec.describe Spree::CSV::NewsletterSubscriberPresenter do+ let(:user) do+ create(+ :user,+ first_name: 'Alice',+ last_name: 'Wonderland',+ email: '[email protected]'+ )+ end++ let(:newsletter_subscriber) do+ create(+ :newsletter_subscriber,+ email: '[email protected]',+ user: user,+ user_id: user.id,+ verified_at: Time.current.change(usec: 0),+ created_at: 2.days.ago.change(usec: 0),+ updated_at: 1.day.ago.change(usec: 0)+ )+ end++ let(:presenter) { described_class.new(newsletter_subscriber) }++ describe '#call' do+ subject(:row) { presenter.call }++ it 'returns array with correct values' do+ expect(row[0]).to eq newsletter_subscriber.email+ expect(row[1]).to eq user.full_name+ expect(row[2]).to eq user.id+ expect(row[3]).to eq Spree.t(:say_yes)+ expect(row[4]).to eq newsletter_subscriber.verified_at+ expect(row[5]).to eq newsletter_subscriber.created_at+ expect(row[6]).to eq newsletter_subscriber.updated_at+ end++ context 'when subscriber is not verified' do+ before { newsletter_subscriber.update!(verified_at: nil) }++ it 'returns say_no for verified and nil for verified_at' do+ expect(row[3]).to eq Spree.t(:say_no)+ expect(row[4]).to be_nil+ end+ end++ context 'when subscriber has no user' do+ let(:newsletter_subscriber) do+ create(+ :newsletter_subscriber,+ email: '[email protected]',+ user: nil,+ user_id: nil,+ verified_at: nil,+ created_at: 3.days.ago.change(usec: 0),+ updated_at: 2.days.ago.change(usec: 0)+ )+ end++ it 'returns nil for customer name and id' do+ expect(row[1]).to be_nil+ expect(row[2]).to be_nil+ end+ end+ end++ describe 'HEADERS constant' do+ it 'contains all expected headers' do+ expected_headers = [+ 'Email',+ 'Customer Name',+ 'Customer ID',+ 'Verified',+ 'Verified At',+ 'Created At',+ 'Updated At'+ ]+ expect(described_class::HEADERS).to eq(expected_headers)+ end+ end+end