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.

add missing shipment tracking fallback in shipment view (#12858)

Szymon Chorobskicde99f4958aa
diff --git a/admin/app/helpers/spree/admin/shipment_helper.rb b/admin/app/helpers/spree/admin/shipment_helper.rb
index 0e9b3a5597..f02295e582 100644
--- a/admin/app/helpers/spree/admin/shipment_helper.rb
+++ b/admin/app/helpers/spree/admin/shipment_helper.rb
@@ -1,5 +1,7 @@
module Spree::Admin
module ShipmentHelper
+ include Spree::ShipmentHelper
+
def can_ship?(shipment)
can?(:update, shipment) && shipment.shippable?
end
diff --git a/admin/app/views/spree/admin/orders/_shipment.html.erb b/admin/app/views/spree/admin/orders/_shipment.html.erb
index 2149008ae4..f1740d4dce 100644
--- a/admin/app/views/spree/admin/orders/_shipment.html.erb
+++ b/admin/app/views/spree/admin/orders/_shipment.html.erb
@@ -65,7 +65,7 @@
<strong><%= Spree.t(:tracking) %>: </strong>
<% if shipment.tracked? %>
<% if shipment.tracking_url.present? %>
- <span><%= link_to ERB::Util.html_escape(shipment.tracking), ERB::Util.html_escape(shipment.tracking_url), target: '_blank', rel: "noopener noreferrer" %></span>
+ <span><%= shipment_tracking_link_to(shipment: shipment, html_options: { target: '_blank', rel: 'noopener noreferrer' }) %></span>
<% elsif shipment.tracking.present? %>
<span><%= shipment.tracking %></span>
<% end %>
diff --git a/core/app/helpers/spree/shipment_helper.rb b/core/app/helpers/spree/shipment_helper.rb
new file mode 100644
index 0000000000..672e1e7959
--- /dev/null
+++ b/core/app/helpers/spree/shipment_helper.rb
@@ -0,0 +1,12 @@
+module Spree
+ module ShipmentHelper
+ def shipment_tracking_link_to(shipment:, name: nil, html_options: {})
+ tracking_url = shipment.tracking_url.presence
+ return '' unless tracking_url
+
+ display_text = name || shipment.tracking.presence || tracking_url
+
+ link_to display_text, tracking_url, html_options
+ end
+ end
+end
diff --git a/core/spec/helpers/shipment_helper_spec.rb b/core/spec/helpers/shipment_helper_spec.rb
new file mode 100644
index 0000000000..bbc68a152e
--- /dev/null
+++ b/core/spec/helpers/shipment_helper_spec.rb
@@ -0,0 +1,75 @@
+require 'spec_helper'
+
+module Spree
+ describe ShipmentHelper, type: :helper do
+ let(:shipment) { create(:shipment, tracking: tracking) }
+ let(:tracking) { 'tracking' }
+
+ before do
+ allow(shipment).to receive(:tracking_url).and_return(tracking_url)
+ end
+
+ describe '#shipment_tracking_link_to' do
+ subject(:shipment_tracking_link_to) { helper.shipment_tracking_link_to(**params) }
+
+ let(:params) do
+ {
+ shipment: shipment,
+ }
+ end
+
+ let(:tracking_url) { 'https://example.com?tracking=Abc' }
+
+ context 'with tracking and tracking_url' do
+ it 'creates link with tracking as a name' do
+ expect(shipment_tracking_link_to).to eq('<a href="https://example.com?tracking=Abc">tracking</a>')
+ end
+ end
+
+ context 'with name passed in params' do
+ let(:name) { 'overridden name' }
+
+ let(:params) do
+ {
+ shipment: shipment,
+ name: name
+ }
+ end
+
+ it 'creates link with passed value as a name' do
+ expect(shipment_tracking_link_to).to eq('<a href="https://example.com?tracking=Abc">overridden name</a>')
+ end
+ end
+
+ context 'with tracking_url only' do
+ let(:tracking) { nil }
+ let(:tracking_url) { 'https://example.com' }
+
+ it 'creates a link with tracking_url as a name' do
+ expect(shipment_tracking_link_to).to eq('<a href="https://example.com">https://example.com</a>')
+ end
+ end
+
+ context 'with no tracking_url' do
+ let(:tracking_url) { '' }
+
+ it 'returns empty string' do
+ expect(shipment_tracking_link_to).to eq('')
+ end
+ end
+
+ context 'with options' do
+ let(:params) do
+ {
+ shipment: shipment,
+ html_options: { data: { foo: 'bar' } }
+ }
+ end
+
+ it 'sets options for link' do
+ expect(shipment_tracking_link_to).to include(' data-foo="bar"')
+ end
+ end
+ end
+ end
+end
diff --git a/emails/app/mailers/spree/shipment_mailer.rb b/emails/app/mailers/spree/shipment_mailer.rb
index b4dd2bfbfa..0cb29c7801 100644
--- a/emails/app/mailers/spree/shipment_mailer.rb
+++ b/emails/app/mailers/spree/shipment_mailer.rb
@@ -1,5 +1,7 @@
module Spree
class ShipmentMailer < BaseMailer
+ helper Spree::ShipmentHelper
+
def shipped_email(shipment, resend = false)
@shipment = shipment.respond_to?(:id) ? shipment : Spree::Shipment.find(shipment)
@order = @shipment.order
diff --git a/emails/app/views/spree/shipment_mailer/shipped_email.html.erb b/emails/app/views/spree/shipment_mailer/shipped_email.html.erb
index 8ec1c53f58..e8baa46b03 100644
--- a/emails/app/views/spree/shipment_mailer/shipped_email.html.erb
+++ b/emails/app/views/spree/shipment_mailer/shipped_email.html.erb
@@ -26,7 +26,7 @@
<% end %>
<% if @shipment.tracking_url %>
<p>
- <%= Spree.t('shipment_mailer.shipped_email.track_link', url: link_to(@shipment.tracking_url, @shipment.tracking_url)).html_safe %>
+ <%= Spree.t('shipment_mailer.shipped_email.track_link', url: shipment_tracking_link_to(shipment: @shipment)).html_safe %>
</p>
<% end %>
<p>
diff --git a/emails/lib/generators/spree/emails/install/templates/mailers/previews/shipment_preview.rb b/emails/lib/generators/spree/emails/install/templates/mailers/previews/shipment_preview.rb
index ecbdba5d9e..4b07fae75c 100644
--- a/emails/lib/generators/spree/emails/install/templates/mailers/previews/shipment_preview.rb
+++ b/emails/lib/generators/spree/emails/install/templates/mailers/previews/shipment_preview.rb
@@ -1,4 +1,6 @@
class ShipmentPreview < ActionMailer::Preview
+ helper Spree::ShipmentHelper
+
def shipped_email
Spree::ShipmentMailer.shipped_email(Spree::Shipment.shipped.first)
end
diff --git a/storefront/app/helpers/spree/storefront_helper.rb b/storefront/app/helpers/spree/storefront_helper.rb
index 5d91b90ad9..65c555d4e5 100644
--- a/storefront/app/helpers/spree/storefront_helper.rb
+++ b/storefront/app/helpers/spree/storefront_helper.rb
@@ -2,6 +2,7 @@ module Spree
module StorefrontHelper
include BaseHelper
include Spree::ImagesHelper
+ include Spree::ShipmentHelper
include Heroicon::Engine.helpers
# Renders the storefront partials for the given section.
diff --git a/storefront/app/views/themes/default/spree/shared/_order_shipment.html.erb b/storefront/app/views/themes/default/spree/shared/_order_shipment.html.erb
index bb7f0c8d4b..ba24e82e93 100644
--- a/storefront/app/views/themes/default/spree/shared/_order_shipment.html.erb
+++ b/storefront/app/views/themes/default/spree/shared/_order_shipment.html.erb
@@ -33,10 +33,7 @@
<% unless shipment.digital? %>
<div class="mt-4 lg:-mt-2 lg:-mr-2">
<% if shipment.shipped? && shipment.tracked? && shipment.tracking_url.present? %>
- <%= link_to Spree.t(:track_items),
- shipment.tracking_url,
- class: "!px-3 !py-1 block btn-primary !leading-6 text-sm text-center",
- target: :_blank %>
+ <%= shipment_tracking_link_to(shipment: shipment, name: Spree.t(:track_items), html_options: { class: "!px-3 !py-1 block btn-primary !leading-6 text-sm text-center", target: :_blank }) %>
<% else %>
<button
class="