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
Re-do export modal plus added support for exporting Customers via export system
Damian Legawiecb73d296a534f
diff --git a/admin/app/controllers/spree/admin/exports_controller.rb b/admin/app/controllers/spree/admin/exports_controller.rbindex 4302194aa3..02977bf717 100644--- a/admin/app/controllers/spree/admin/exports_controller.rb+++ b/admin/app/controllers/spree/admin/exports_controller.rb@@ -40,13 +40,17 @@ module Spreeenddef assign_params- @object.type = permitted_resource_params[:type] if Spree::Export.available_types.map(&:to_s).include?(permitted_resource_params[:type])+ @object.type = permitted_resource_params[:type] if available_types.map(&:to_s).include?(permitted_resource_params[:type])@object.search_params = permitted_resource_params[:search_params]enddef permitted_resource_paramsparams.require(:export).permit(permitted_export_attributes)end++ def available_types+ Spree::Export.available_types + ['Spree::Exports::Customers']+ endendendenddiff --git a/admin/app/helpers/spree/admin/navigation_helper.rb b/admin/app/helpers/spree/admin/navigation_helper.rbindex f711917ae0..4e92b64d31 100644--- a/admin/app/helpers/spree/admin/navigation_helper.rb+++ b/admin/app/helpers/spree/admin/navigation_helper.rb@@ -114,6 +114,13 @@ module Spreelink_to(text.html_safe, url, options)end+ def link_to_export_modal+ link_to '#', data: { toggle: 'modal', target: '#export-modal' }, class: 'btn btn-light' do+ icon('table-export', class: 'mr-0 mr-lg-2') ++ content_tag(:span, Spree.t(:export), class: 'd-none d-lg-inline')+ end if can?(:create, Spree::Export)+ end+# renders an active link with an icon, using the active_link_to method from https://github.com/comfy/active_link_to gem# @param icon_name [String] the name of the icon, eg: 'pencil', see: https://tabler.io/icons# @param text [String] the text of the linkdiff --git a/admin/app/views/spree/admin/exports/create.turbo_stream.erb b/admin/app/views/spree/admin/exports/create.turbo_stream.erbindex 90c38d2259..4329caa589 100644--- a/admin/app/views/spree/admin/exports/create.turbo_stream.erb+++ b/admin/app/views/spree/admin/exports/create.turbo_stream.erb@@ -1,2 +1,2 @@<%= turbo_render_alerts %>-<%= turbo_close_modal %>+<%= turbo_close_modal('export-modal') %>diff --git a/admin/app/views/spree/admin/exports/new.html.erb b/admin/app/views/spree/admin/exports/new.html.erbindex f536c91b53..3e71136630 100644--- a/admin/app/views/spree/admin/exports/new.html.erb+++ b/admin/app/views/spree/admin/exports/new.html.erb@@ -1,4 +1,4 @@-<%= turbo_frame_tag :dialog_modal do %>+<%= turbo_frame_tag :export_modal do %><%= form_for @export, url: spree.admin_exports_path do |f| %><%= f.hidden_field :type %><%= f.hidden_field :search_params %>diff --git a/admin/app/views/spree/admin/orders/index.html.erb b/admin/app/views/spree/admin/orders/index.html.erbindex c0b1d4eec3..863864108e 100644--- a/admin/app/views/spree/admin/orders/index.html.erb+++ b/admin/app/views/spree/admin/orders/index.html.erb@@ -7,6 +7,7 @@<% end %><% content_for :page_actions do %>+ <%= link_to_export_modal %><%= link_to_with_icon 'plus', Spree.t(:new_order), spree.admin_orders_path, class: "btn btn-primary", data: { turbo_method: :post } if can?(:create, Spree::Order) %><% end %>@@ -19,5 +20,6 @@<% else %><%= render 'spree/admin/orders/filters' %><%= render 'spree/admin/orders/list' %>+ <%= render 'spree/admin/shared/export_modal', export_type: Spree::Exports::Orders %><% end %></div>diff --git a/admin/app/views/spree/admin/products/index.html.erb b/admin/app/views/spree/admin/products/index.html.erbindex ba8d2eac4b..263dcec46d 100644--- a/admin/app/views/spree/admin/products/index.html.erb+++ b/admin/app/views/spree/admin/products/index.html.erb@@ -9,6 +9,7 @@<% else %><%= render 'filters' %><%= render 'list' %>+ <%= render 'spree/admin/shared/export_modal', export_type: Spree::Exports::Products %><% end %></div>diff --git a/admin/app/views/spree/admin/shared/_content_header.html.erb b/admin/app/views/spree/admin/shared/_content_header.html.erbindex 9ed9f36ea7..4133d4a1a8 100644--- a/admin/app/views/spree/admin/shared/_content_header.html.erb+++ b/admin/app/views/spree/admin/shared/_content_header.html.erb@@ -12,15 +12,6 @@<%= yield :page_title %></h3><div id="page_actions" class="ml-auto page-actions d-flex align-items-center gap-2">- <% if action_name == 'index' && defined?(model_class) && model_class && Spree::Export.available_models.include?(model_class) && can?(:create, Spree::Export) %>- <span data-toggle="modal" data-target="#modal">- <%= link_to spree.new_admin_export_path(export: { search_params: params[:q]&.to_json, type: Spree::Export.type_for_model(model_class) }), class: 'btn btn-light bg-transparent with-tip', title: 'Download records as CSV file', data: { turbo_frame: :dialog_modal } do %>- <%= icon 'table-export', class: 'mr-0 mr-lg-2' %>- <span class="d-none d-lg-inline"><%= Spree.t(:export) %></span>- <% end %>- </span>- <% end %>-<%= yield :page_actions if content_for?(:page_actions) %><% if action_name == 'edit' && @object %>diff --git a/admin/app/views/spree/admin/shared/_export_modal.html.erb b/admin/app/views/spree/admin/shared/_export_modal.html.erbnew file mode 100644index 0000000000..d8fa3bc036--- /dev/null+++ b/admin/app/views/spree/admin/shared/_export_modal.html.erb@@ -0,0 +1,5 @@+<div class="modal fade" id="export-modal" tabindex="-1" aria-labelledby="exampleModalLabel" aria-hidden="true">+ <div class="modal-dialog modal-dialog-centered">+ <%= turbo_frame_tag :export_modal, src: spree.new_admin_export_path(export: { search_params: params[:q]&.to_json, type: export_type }) %>+ </div>+</div>\ No newline at end of filediff --git a/admin/app/views/spree/admin/users/index.csv.erb b/admin/app/views/spree/admin/users/index.csv.erbdeleted file mode 100644index 334aabf5e8..0000000000--- a/admin/app/views/spree/admin/users/index.csv.erb+++ /dev/null@@ -1,43 +0,0 @@-<%- headers = [- 'First Name',- 'Last Name',- 'Email',- 'Accepts Email Marketing',- 'Company',- 'Address 1',- 'Address 2',- 'City',- 'Province',- 'Province Code',- 'Country',- 'Country Code',- 'Zip',- 'Phone',- 'Total Spent',- 'Total Orders',- 'Tags'- ]--%>-<%= CSV.generate_line(headers).strip %>-<%- @users.includes( bill_address: [:country], ship_address: [:country], addresses: [:country]).each do |user| -%>-<%= CSV.generate_line([- user.first_name,- user.last_name,- user.email,- user.accepts_email_marketing ? 'Yes' : 'No',- user.address&.company,- user.address&.address1,- user.address&.address2,- user.address&.city,- user.address&.state_text,- user.address&.state_abbr,- user.address&.country&.name,- user.address&.country&.iso,- user.address&.zipcode,- user.phone,- user.amount_spent_in(current_currency),- user.completed_orders.count,- user.tag_list- ]).strip.html_safe %>-<%- end -%>-diff --git a/admin/app/views/spree/admin/users/index.html.erb b/admin/app/views/spree/admin/users/index.html.erbindex 932fe2bc1f..6c6f661be8 100644--- a/admin/app/views/spree/admin/users/index.html.erb+++ b/admin/app/views/spree/admin/users/index.html.erb@@ -3,10 +3,7 @@<% end %><% content_for :page_actions do %>- <%= link_to spree.admin_users_path(q: params[:q].to_unsafe_hash, page: params[:page], per_page: params[:per_page], format: :csv), class: 'btn btn-light bg-transparent with-tip d-none d-lg-inline-flex', title: 'Export Customers to a CSV file. To filter specific Customers use "Filters" or Customers/Subscribers tabs before clicking this button' do %>- <%= icon 'table-export' %>- <%= Spree.t(:export) %>- <% end if can?(:create, Spree::Export) %>+ <%= link_to_export_modal %><%= render 'extra_actions' %>@@ -14,58 +11,61 @@<% end %><div class="card-lg">- <%= render "spree/admin/users/filters" %>+ <%= turbo_frame_tag "customers", autoscroll: true, data: { autoscroll_behavior: :smooth, turbo_action: 'advance' } do %>+ <%= render 'spree/admin/shared/export_modal', export_type: Spree::Exports::Customers %>+ <%= render "spree/admin/users/filters" %>- <% if @collection.any? %>- <div data-controller="bulk-operation" data-action="keydown.esc->bulk-operation#cancel" tabindex="0">- <%= form_tag spree.admin_users_path, data: { 'bulk-operation-target': 'form' } do %>- <%= render 'spree/admin/shared/bulk_modal' %>- <div id="bulk-panel" class="d-none" data-bulk-operation-target="panel">- <div class="bulk-panel-container">- <%= bulk_operations_counter %>+ <% if @collection.any? %>+ <div data-controller="bulk-operation" data-action="keydown.esc->bulk-operation#cancel" tabindex="0">+ <%= form_tag spree.admin_users_path, data: { 'bulk-operation-target': 'form' } do %>+ <%= render 'spree/admin/shared/bulk_modal' %>+ <div id="bulk-panel" class="d-none" data-bulk-operation-target="panel">+ <div class="bulk-panel-container">+ <%= bulk_operations_counter %>- <% if can?(:manage_tags, Spree.user_class) %>- <%= bulk_action_link(- Spree.t("admin.bulk_ops.users.title.add_tags"),- spree.bulk_modal_admin_users_path(kind: :add_tags),- icon: "tag-plus",- url: spree.bulk_add_tags_admin_users_path- ) %>- <%= bulk_action_link(- Spree.t("admin.bulk_ops.users.title.remove_tags"),- spree.bulk_modal_admin_users_path(kind: :remove_tags),- icon: "tag-minus",- url: spree.bulk_remove_tags_admin_users_path- ) %>- <% end %>- <%= bulk_operations_close_button %>+ <% if can?(:manage_tags, Spree.user_class) %>+ <%= bulk_action_link(+ Spree.t("admin.bulk_ops.users.title.add_tags"),+ spree.bulk_modal_admin_users_path(kind: :add_tags),+ icon: "tag-plus",+ url: spree.bulk_add_tags_admin_users_path+ ) %>+ <%= bulk_action_link(+ Spree.t("admin.bulk_ops.users.title.remove_tags"),+ spree.bulk_modal_admin_users_path(kind: :remove_tags),+ icon: "tag-minus",+ url: spree.bulk_remove_tags_admin_users_path+ ) %>+ <% end %>+ <%= bulk_operations_close_button %>+ </div></div>- </div>- <div class="table-responsive">- <table class="table" id="listing_users">- <thead>- <tr data-hook="admin_users_index_headers">- <th scope="col" class="pr-0 w-5">- <%= bulk_operations_select_all_checkbox %>- </th>- <th><%= Spree.t(:name) %></th>- <th><%= Spree.t(:email_marketing) %></th>- <th><%= Spree.t(:location) %></th>- <th><%= Spree.t('admin.num_orders') %></th>- <th><%= Spree.t('admin.amount_spent') %></th>- <th><%= sort_link @search, :created_at, Spree.t(:created_at) %></th>- </tr>- </thead>- <tbody>- <%= render collection: @collection, partial: "spree/admin/users/user", cached: spree_base_cache_scope %>- </tbody>- </table>- </div>- <% end %>- </div>- <%= render "spree/admin/shared/index_table_options", collection: @collection if @collection.any? %>- <% else %>- <%= render "spree/admin/shared/no_resource_found" %>+ <div class="table-responsive">+ <table class="table" id="listing_users">+ <thead>+ <tr data-hook="admin_users_index_headers">+ <th scope="col" class="pr-0 w-5">+ <%= bulk_operations_select_all_checkbox %>+ </th>+ <th><%= Spree.t(:name) %></th>+ <th><%= Spree.t(:email_marketing) %></th>+ <th><%= Spree.t(:location) %></th>+ <th><%= Spree.t('admin.num_orders') %></th>+ <th><%= Spree.t('admin.amount_spent') %></th>+ <th><%= sort_link @search, :created_at, Spree.t(:created_at) %></th>+ </tr>+ </thead>+ <tbody>+ <%= render collection: @collection, partial: "spree/admin/users/user", cached: spree_base_cache_scope %>+ </tbody>+ </table>+ </div>+ <% end %>+ </div>+ <%= render "spree/admin/shared/index_table_options", collection: @collection if @collection.any? %>+ <% else %>+ <%= render "spree/admin/shared/no_resource_found" %>+ <% end %><% end %></div>diff --git a/admin/spec/controllers/spree/admin/users_controller_spec.rb b/admin/spec/controllers/spree/admin/users_controller_spec.rbindex 74e39c9a0a..bd7cae7aa3 100644--- a/admin/spec/controllers/spree/admin/users_controller_spec.rb+++ b/admin/spec/controllers/spree/admin/users_controller_spec.rb@@ -89,48 +89,6 @@ RSpec.describe Spree::Admin::UsersController, type: :controller doendend- context 'csv' do- let!(:country) { create(:country) }- let!(:state) { create(:state, country: country) }- let!(:address) { create(:address, user: user_1) }-- before do- user_1.tag_list = ['Tag 1', 'Tag 2']- user_1.save!- end-- it 'returns a csv file' do- get :index, params: { format: 'csv', q: { first_name_eq: user_1.first_name } }-- expect(response.headers['Content-Type']).to eq 'text/csv; charset=utf-8'- expect(response.body.split("\n").count).to eq(2)-- user_csv_line = response.body.split("\n").last-- expect(user_csv_line).to eq(- [- user_1.first_name,- user_1.last_name,- user_1.email,- user_1.accepts_email_marketing ? 'Yes' : 'No',- user_1.address&.company,- user_1.address&.address1,- user_1.address&.address2,- user_1.address&.city,- user_1.address&.state_text,- user_1.address&.state_abbr,- user_1.address&.country&.name,- user_1.address&.country&.iso,- user_1.address&.zipcode,- user_1.phone,- user_1.amount_spent_in('USD').to_s,- user_1.completed_orders.count.to_s,- "\"#{user_1.tag_list.join(', ')}\"",- ].join(',')- )- end- end-context 'search by country name' dolet!(:address) { create(:address, user: user_1) }let!(:other_address) { create(:address, user: user_1) }diff --git a/core/app/models/concerns/spree/user_methods.rb b/core/app/models/concerns/spree/user_methods.rbindex 390043662e..3263cc5797 100644--- a/core/app/models/concerns/spree/user_methods.rb+++ b/core/app/models/concerns/spree/user_methods.rb@@ -134,6 +134,10 @@ module Spreeorders.complete.none?end+ def to_csv(_store = nil)+ Spree::CSV::CustomerPresenter.new(self).call+ end+privatedef check_completed_ordersdiff --git a/core/app/models/spree/export.rb b/core/app/models/spree/export.rbindex 541d127db1..13632d08a1 100644--- a/core/app/models/spree/export.rb+++ b/core/app/models/spree/export.rb@@ -120,7 +120,11 @@ module Spree# eg. Spree::Exports::Products => Spree::Productdef model_class- "Spree::#{type.demodulize.singularize}".constantize+ if type == 'Spree::Exports::Customers'+ Spree.user_class+ else+ "Spree::#{type.demodulize.singularize}".constantize+ endenddef current_abilitydiff --git a/core/app/models/spree/exports/customers.rb b/core/app/models/spree/exports/customers.rbnew file mode 100644index 0000000000..85b378fe0d--- /dev/null+++ b/core/app/models/spree/exports/customers.rb@@ -0,0 +1,16 @@+module Spree+ module Exports+ class Customers < Spree::Export+ def scope_includes+ [+ { bill_address: :state },+ { ship_address: :state },+ ]+ end++ def csv_headers+ Spree::CSV::CustomerPresenter::HEADERS+ end+ end+ end+enddiff --git a/core/app/presenters/spree/csv/customer_presenter.rb b/core/app/presenters/spree/csv/customer_presenter.rbnew file mode 100644index 0000000000..d029564033--- /dev/null+++ b/core/app/presenters/spree/csv/customer_presenter.rb@@ -0,0 +1,53 @@+module Spree+ module CSV+ class CustomerPresenter+ HEADERS = [+ 'First Name',+ 'Last Name',+ 'Email',+ 'Accepts Email Marketing',+ 'Company',+ 'Address 1',+ 'Address 2',+ 'City',+ 'Province',+ 'Province Code',+ 'Country',+ 'Country Code',+ 'Zip',+ 'Phone',+ 'Total Spent',+ 'Total Orders',+ 'Tags'+ ].freeze++ def initialize(customer)+ @customer = customer+ end++ attr_accessor :customer++ def call+ [+ customer.first_name,+ customer.last_name,+ customer.email,+ customer.accepts_email_marketing ? Spree.t(:say_yes) : Spree.t(:say_no),+ customer.address&.company,+ customer.address&.address1,+ customer.address&.address2,+ customer.address&.city,+ customer.address&.state_text,+ customer.address&.state_abbr,+ customer.address&.country&.name,+ customer.address&.country&.iso,+ customer.address&.zipcode,+ customer.phone,+ customer.amount_spent_in(Spree::Store.current.default_currency),+ customer.completed_orders.count,+ customer.tag_list+ ]+ end+ end+ end+enddiff --git a/core/lib/spree/core/engine.rb b/core/lib/spree/core/engine.rbindex bf71f915a5..398a7b596f 100644--- a/core/lib/spree/core/engine.rb+++ b/core/lib/spree/core/engine.rb@@ -150,7 +150,8 @@ module SpreeRails.application.config.spree.export_types = [Spree::Exports::Products,- Spree::Exports::Orders+ Spree::Exports::Orders,+ Spree::Exports::Customers]Rails.application.config.spree.taxon_rules = [diff --git a/core/spec/presenters/spree/csv/customer_presenter_spec.rb b/core/spec/presenters/spree/csv/customer_presenter_spec.rbnew file mode 100644index 0000000000..6b4d2cff85--- /dev/null+++ b/core/spec/presenters/spree/csv/customer_presenter_spec.rb@@ -0,0 +1,131 @@+require 'spec_helper'++RSpec.describe Spree::CSV::CustomerPresenter do+ let(:store) { @default_store }+ let(:country) { store.default_country || create(:country, name: 'United States', iso: 'US') }+ let(:state) { country.states.find_by(name: 'California') || create(:state, name: 'California', abbr: 'CA', country: country) }+ let(:address) do+ create(:address,+ company: 'Test Company',+ address1: '123 Main St',+ address2: 'Apt 4B',+ city: 'Los Angeles',+ state: state,+ country: country,+ zipcode: '90210',+ phone: '555-1234')+ end+ let(:customer) do+ create(:user,+ first_name: 'John',+ last_name: 'Doe',+ email: '[email protected]',+ accepts_email_marketing: true,+ bill_address: address,+ ship_address: address,+ tag_list: ['premium', 'vip'])+ end+ let!(:orders) { create_list(:completed_order_with_totals, 3, user: customer, store: store) }+ let(:presenter) { described_class.new(customer) }++ before do+ orders[0].update_column(:total, 100)+ orders[1].update_column(:total, 200)+ orders[2].update_column(:total, 150)+ end++ describe '#call' do+ subject { presenter.call }++ it 'returns array with correct values' do+ expect(subject[0]).to eq customer.first_name+ expect(subject[1]).to eq customer.last_name+ expect(subject[2]).to eq customer.email+ expect(subject[3]).to eq Spree.t(:say_yes)+ expect(subject[4]).to eq customer.address.company+ expect(subject[5]).to eq customer.address.address1+ expect(subject[6]).to eq customer.address.address2+ expect(subject[7]).to eq customer.address.city+ expect(subject[8]).to eq customer.address.state_text+ expect(subject[9]).to eq customer.address.state_abbr+ expect(subject[10]).to eq customer.address.country.name+ expect(subject[11]).to eq customer.address.country.iso+ expect(subject[12]).to eq customer.address.zipcode+ expect(subject[13]).to eq customer.phone+ expect(subject[14]).to eq customer.amount_spent_in(store.default_currency)+ expect(subject[15]).to eq customer.completed_orders.count+ expect(subject[16]).to eq customer.tag_list+ end++ context 'when customer does not accept email marketing' do+ before { customer.update!(accepts_email_marketing: false) }++ it 'returns say_no for email marketing' do+ expect(subject[3]).to eq Spree.t(:say_no)+ end+ end++ context 'when customer has no address' do+ let(:customer_without_address) do+ create(:user,+ first_name: 'Jane',+ last_name: 'Smith',+ email: '[email protected]',+ accepts_email_marketing: false)+ end+ let(:presenter) { described_class.new(customer_without_address) }++ it 'returns nil for address fields' do+ expect(subject[4]).to be_nil # company+ expect(subject[5]).to be_nil # address1+ expect(subject[6]).to be_nil # address2+ expect(subject[7]).to be_nil # city+ expect(subject[8]).to be_nil # state_text+ expect(subject[9]).to be_nil # state_abbr+ expect(subject[10]).to be_nil # country name+ expect(subject[11]).to be_nil # country iso+ expect(subject[12]).to be_nil # zipcode+ end+ end++ context 'when customer has no orders' do+ let(:customer_without_orders) do+ create(:user,+ first_name: 'Bob',+ last_name: 'Johnson',+ email: '[email protected]')+ end+ let(:presenter) { described_class.new(customer_without_orders) }++ it 'returns zero for total orders and amount spent' do+ expect(subject[14]).to eq 0 # amount spent+ expect(subject[15]).to eq 0 # total orders+ end+ end+ end++ describe 'HEADERS constant' do+ it 'contains all expected headers' do+ expected_headers = [+ 'First Name',+ 'Last Name',+ 'Email',+ 'Accepts Email Marketing',+ 'Company',+ 'Address 1',+ 'Address 2',+ 'City',+ 'Province',+ 'Province Code',+ 'Country',+ 'Country Code',+ 'Zip',+ 'Phone',+ 'Total Spent',+ 'Total Orders',+ 'Tags'+ ]+ expect(described_class::HEADERS).to eq(expected_headers)+ end+ end+end