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.

Make the asset uploader generic instead of specific to products only, allow some configurations for admin template views (#13039)

Łukasz Adamczyk91352dc2e45b
diff --git a/admin/app/controllers/spree/admin/assets_controller.rb b/admin/app/controllers/spree/admin/assets_controller.rb
index d92fc825ca..c1173ea84e 100644
--- a/admin/app/controllers/spree/admin/assets_controller.rb
+++ b/admin/app/controllers/spree/admin/assets_controller.rb
@@ -1,7 +1,7 @@
module Spree
module Admin
class AssetsController < ResourceController
- include Spree::Admin::SessionAssetsHelper
+ include Spree::Admin::AssetsHelper
def create
@asset = asset_type.new(permitted_resource_params)
@@ -10,10 +10,8 @@ module Spree
authorize! :update, @asset.viewable if @asset.viewable.present? && current_vendor
if @asset.save
- @product = @asset.product || current_store.products.new
-
- # we need to store the asset ids in the session to be able to display them in the product page
- store_uploaded_asset_in_session(@asset) if @product.new_record?
+ # we need to store the asset ids in the session for new assets to be able to display them
+ store_uploaded_asset_in_session(@asset, @asset.viewable_type) if @asset.viewable.nil? || @asset.viewable.new_record?
else
flash.now[:error] = @asset.errors.full_messages.to_sentence
render :create, status: :unprocessable_entity
diff --git a/admin/app/controllers/spree/admin/products_controller.rb b/admin/app/controllers/spree/admin/products_controller.rb
index 8fa5186b34..45ce2c5982 100644
--- a/admin/app/controllers/spree/admin/products_controller.rb
+++ b/admin/app/controllers/spree/admin/products_controller.rb
@@ -3,7 +3,7 @@ module Spree
class ProductsController < ResourceController
include Spree::Admin::StockLocationsHelper
include Spree::Admin::BulkOperationsConcern
- include Spree::Admin::SessionAssetsHelper
+ include Spree::Admin::AssetsHelper
include Spree::Admin::ProductsBreadcrumbConcern
helper 'spree/admin/products'
@@ -15,7 +15,6 @@ module Spree
before_action :prepare_product_params, only: [:create, :update]
before_action :strip_stock_items_param, only: [:create, :update]
- before_action :ensure_session_uploaded_assets_uuid, only: :new
before_action :check_slug_availability, only: [:create, :update]
new_action.before :build_master_prices
@@ -331,10 +330,12 @@ module Spree
def assign_master_images
return unless @product.master.persisted?
- return if session_uploaded_assets.empty?
+ uploaded_assets = session_uploaded_assets('Spree::Variant')
- session_uploaded_assets.update_all(viewable_id: @product.master.id, viewable_type: 'Spree::Variant', updated_at: Time.current)
- clear_session_for_uploaded_assets
+ return if uploaded_assets.empty?
+
+ uploaded_assets.update_all(viewable_id: @product.master.id, viewable_type: 'Spree::Variant', updated_at: Time.current)
+ clear_session_for_uploaded_assets('Spree::Variant')
end
def product_includes
diff --git a/admin/app/helpers/spree/admin/assets_helper.rb b/admin/app/helpers/spree/admin/assets_helper.rb
new file mode 100644
index 0000000000..e1559127be
--- /dev/null
+++ b/admin/app/helpers/spree/admin/assets_helper.rb
@@ -0,0 +1,42 @@
+module Spree
+ module Admin
+ module AssetsHelper
+ def media_form_assets(viewable, viewable_type)
+ if viewable&.persisted?
+ viewable.images
+ elsif session_uploaded_assets(viewable_type).any?
+ Spree::Asset.accessible_by(current_ability, :manage).where(id: session_uploaded_assets(viewable_type))
+ else
+ []
+ end
+ end
+
+ def ensure_session_uploaded_assets_uuid(viewable_type)
+ session[session_uploaded_assets_uuid_key(viewable_type)] ||= SecureRandom.uuid
+ end
+
+ def store_uploaded_asset_in_session(asset, viewable_type)
+ ensure_session_uploaded_assets_uuid(viewable_type)
+ asset.update(session_id: session[session_uploaded_assets_uuid_key(viewable_type)])
+ end
+
+ def session_uploaded_assets(viewable_type)
+ return Spree::Asset.none if session[session_uploaded_assets_uuid_key(viewable_type)].blank?
+
+ Spree::Asset.with_session_uploaded_assets_uuid(session[session_uploaded_assets_uuid_key(viewable_type)]).where(viewable_id: nil)
+ end
+
+ def clear_session_for_uploaded_assets(viewable_type)
+ session.delete(session_uploaded_assets_uuid_key(viewable_type))
+ end
+
+ def session_uploaded_assets_uuid_key(viewable_type)
+ [
+ 'spree.admin.uploaded_assets',
+ viewable_type&.underscore,
+ 'uuid'
+ ].compact_blank.join('.')
+ end
+ end
+ end
+end
diff --git a/admin/app/helpers/spree/admin/products_helper.rb b/admin/app/helpers/spree/admin/products_helper.rb
index ebdc351d30..3e5536b6d2 100644
--- a/admin/app/helpers/spree/admin/products_helper.rb
+++ b/admin/app/helpers/spree/admin/products_helper.rb
@@ -27,18 +27,6 @@ module Spree
end
end
- # we use this method to fetch images for media gallery on product form
- # for new products we use session to store temporary assets not tied to any variant/product (yet)
- def media_form_assets(variant)
- if variant&.persisted?
- variant.images
- elsif session_uploaded_assets.any?
- Spree::Image.accessible_by(current_ability, :manage).where(id: session_uploaded_assets)
- else
- []
- end
- end
-
def product_status(product)
if product.deleted?
content_tag(:span, 'Deleted', class: 'badge badge-danger')
diff --git a/admin/app/helpers/spree/admin/session_assets_helper.rb b/admin/app/helpers/spree/admin/session_assets_helper.rb
deleted file mode 100644
index e4c011d6ec..0000000000
--- a/admin/app/helpers/spree/admin/session_assets_helper.rb
+++ /dev/null
@@ -1,24 +0,0 @@
-module Spree
- module Admin
- module SessionAssetsHelper
- def ensure_session_uploaded_assets_uuid
- session['spree.admin.uploaded_assets.uuid'] ||= SecureRandom.uuid
- end
-
- def store_uploaded_asset_in_session(asset)
- ensure_session_uploaded_assets_uuid
- asset.update(session_id: session['spree.admin.uploaded_assets.uuid'])
- end
-
- def session_uploaded_assets
- return Spree::Asset.none if session['spree.admin.uploaded_assets.uuid'].blank?
-
- Spree::Asset.with_session_uploaded_assets_uuid(session['spree.admin.uploaded_assets.uuid']).where(viewable_id: nil)
- end
-
- def clear_session_for_uploaded_assets
- session.delete('spree.admin.uploaded_assets.uuid')
- end
- end
- end
-end
diff --git a/admin/app/views/spree/admin/assets/create.turbo_stream.erb b/admin/app/views/spree/admin/assets/create.turbo_stream.erb
index b3e256135c..8ac8327dc0 100644
--- a/admin/app/views/spree/admin/assets/create.turbo_stream.erb
+++ b/admin/app/views/spree/admin/assets/create.turbo_stream.erb
@@ -1,5 +1,5 @@
<%= turbo_render_alerts %>
<%= turbo_stream.replace 'media-form' do %>
- <%= render 'spree/admin/variants/form/media', viewable: @asset.viewable %>
+ <%= render 'spree/admin/shared/media_form', viewable: @asset.viewable, viewable_type: @asset.viewable_type %>
<% end %>
diff --git a/admin/app/views/spree/admin/assets/edit.html.erb b/admin/app/views/spree/admin/assets/edit.html.erb
index baaa3742e8..3ae25f8d95 100644
--- a/admin/app/views/spree/admin/assets/edit.html.erb
+++ b/admin/app/views/spree/admin/assets/edit.html.erb
@@ -6,7 +6,7 @@
<%= render 'active_storage/upload_form', form: f, field_name: :attachment, width: 200, height: 200, can_delete: false %>
</div>
<div class="modal-body" style="min-height: 200px">
- <%= f.spree_text_area :alt, rows: 4 %>
+ <%= f.spree_text_area :alt, label: Spree.t(:alt_text), rows: 4 %>
</div>
<div class="modal-footer">
<%= turbo_save_button_tag %>
diff --git a/admin/app/views/spree/admin/assets/update.turbo_stream.erb b/admin/app/views/spree/admin/assets/update.turbo_stream.erb
index 4525b2f6e3..abb9525d55 100644
--- a/admin/app/views/spree/admin/assets/update.turbo_stream.erb
+++ b/admin/app/views/spree/admin/assets/update.turbo_stream.erb
@@ -3,5 +3,5 @@
<!-- Uploader operates on Spree::Asset, but the edit page uses Spree::Image for the dom_id -->
<%= turbo_stream.replace spree_dom_id(Spree::Image.new(id: @asset.id)) do %>
- <%= render 'spree/admin/variants/form/media_asset', asset: @asset %>
+ <%= render 'spree/admin/shared/media_asset', asset: @asset %>
<% end %>
diff --git a/admin/app/views/spree/admin/products/_form.html.erb b/admin/app/views/spree/admin/products/_form.html.erb
index dd5cae9f1f..adea4e42c5 100644
--- a/admin/app/views/spree/admin/products/_form.html.erb
+++ b/admin/app/views/spree/admin/products/_form.html.erb
@@ -1,7 +1,7 @@
<div class="row" data-controller="product-form slug-form seo-form" data-seo-form-editor-value="tinymce">
<div class="col-md-8">
<%= render 'spree/admin/products/form/base', f: f %>
- <%= render 'spree/admin/variants/form/media', viewable: @product.master %>
+ <%= render 'spree/admin/shared/media_form', viewable: @product.master, viewable_type: 'Spree::Variant' %>
<%= f.fields_for :master, @product.master do |vf| %>
<%= render 'spree/admin/variants/form/pricing', f: vf %>
<% end unless @product.has_variants? %>
diff --git a/admin/app/views/spree/admin/shared/_edit_resource.html.erb b/admin/app/views/spree/admin/shared/_edit_resource.html.erb
index ce9cb7e815..94e9f90cd8 100644
--- a/admin/app/views/spree/admin/shared/_edit_resource.html.erb
+++ b/admin/app/views/spree/admin/shared/_edit_resource.html.erb
@@ -1,11 +1,14 @@
+<% col_class ||= 'col-lg-6 offset-lg-3' %>
+<% page_header_back_button_url ||= collection_url %>
+
<%= content_for :page_title do %>
- <%= page_header_back_button(collection_url) %>
+ <%= page_header_back_button(page_header_back_button_url) %>
<%= @object.try(:name) || @object.try(:title) || @object.try(:number) %>
<% end %>
<%= form_with model: [:admin, @object], url: object_url, scope: @resource.object_name, id: "edit_#{controller_name.singularize}_#{@object.id}", data: local_assigns[:data] || {} do |f| %>
<div class="row">
- <div class="col-lg-6 offset-lg-3">
+ <div class="<%= col_class %>">
<%= render 'spree/admin/shared/error_messages', target: @object %>
<%= render 'form', f: f %>
<%= render 'spree/admin/shared/edit_resource_links', f: f %>
diff --git a/admin/app/views/spree/admin/shared/_index_table.html.erb b/admin/app/views/spree/admin/shared/_index_table.html.erb
index 47e8b65a91..db02154f34 100644
--- a/admin/app/views/spree/admin/shared/_index_table.html.erb
+++ b/admin/app/views/spree/admin/shared/_index_table.html.erb
@@ -27,7 +27,7 @@
<%= render 'spree/admin/shared/index_table_options', collection: paginated_collection %>
<% else %>
- <%= render 'spree/admin/shared/no_resource_found', new_object_url: new_object_url %>
+ <%= render 'spree/admin/shared/no_resource_found', new_object_url: (new_object_url if can?(:create, model_class)) %>
<% end %>
</div>
<% end %>
\ No newline at end of file
diff --git a/admin/app/views/spree/admin/variants/form/_media_asset.html.erb b/admin/app/views/spree/admin/shared/_media_asset.html.erb
similarity index 100%
rename from admin/app/views/spree/admin/variants/form/_media_asset.html.erb
rename to admin/app/views/spree/admin/shared/_media_asset.html.erb
diff --git a/admin/app/views/spree/admin/variants/form/_media.html.erb b/admin/app/views/spree/admin/shared/_media_form.html.erb
similarity index 87%
rename from admin/app/views/spree/admin/variants/form/_media.html.erb
rename to admin/app/views/spree/admin/shared/_media_form.html.erb
index 5429009a53..a894bb45a2 100644
--- a/admin/app/views/spree/admin/variants/form/_media.html.erb
+++ b/admin/app/views/spree/admin/shared/_media_form.html.erb
@@ -12,12 +12,12 @@
data-sortable-handle-value=".move-handle"
data-sortable-resource-name-value="asset"
data-sortable-response-kind-value="json">
- <%= render partial: 'spree/admin/variants/form/media_asset', collection: media_form_assets(viewable), as: :asset, cached: spree_base_cache_scope %>
+ <%= render partial: 'spree/admin/shared/media_asset', collection: media_form_assets(viewable, viewable_type), as: :asset, cached: spree_base_cache_scope %>
<%= button_tag class: 'upload-area media-form__add-button', data: {
controller: 'asset-uploader',
asset_uploader_multiple_value: true,
asset_uploader_viewable_id_value: viewable&.id,
- asset_uploader_viewable_type_value: 'Spree::Variant',
+ asset_uploader_viewable_type_value: viewable_type,
asset_uploader_allowed_file_types_value: allowed_file_types_for_upload,
asset_uploader_admin_assets_path_value: spree.admin_assets_path,
action: 'asset-uploader#open',
diff --git a/admin/app/views/spree/admin/shared/_new_resource.html.erb b/admin/app/views/spree/admin/shared/_new_resource.html.erb
index beb6828577..788593ac70 100644
--- a/admin/app/views/spree/admin/shared/_new_resource.html.erb
+++ b/admin/app/views/spree/admin/shared/_new_resource.html.erb
@@ -1,11 +1,14 @@
+<% col_class ||= 'col-lg-6 offset-lg-3' %>
+<% page_header_back_button_url ||= collection_url %>
+
<%= content_for :page_title do %>
- <%= page_header_back_button(collection_url) %>
+ <%= page_header_back_button(page_header_back_button_url) %>
<%= Spree.t("new_#{controller_name.singularize}") %>
<% end %>
<%= form_with model: [:admin, @object], url: collection_url, id: "new_#{controller_name.singularize}", data: local_assigns[:data] || {} do |f| %>
<div class="row">
- <div class="col-lg-6 offset-lg-3">
+ <div class="<%= col_class %>">
<%= render 'spree/admin/shared/error_messages', target: @object %>
<%= render 'form', f: f %>
<%= render 'spree/admin/shared/new_resource_links', f: f %>
diff --git a/admin/app/views/spree/admin/variants/edit.html.erb b/admin/app/views/spree/admin/variants/edit.html.erb
index af1bc365c6..285996c7e7 100644
--- a/admin/app/views/spree/admin/variants/edit.html.erb
+++ b/admin/app/views/spree/admin/variants/edit.html.erb
@@ -10,7 +10,7 @@
<%= render 'spree/admin/variants/form/basic', f: f %>
<%= render 'spree/admin/variants/form/pricing', f: f %>
<%= render 'spree/admin/variants/form/inventory', f: f %>
- <%= render 'spree/admin/variants/form/media', viewable: @variant %>
+ <%= render 'spree/admin/shared/media_form', viewable: @variant, viewable_type: 'Spree::Variant' %>
<%= render 'spree/admin/shared/edit_resource_links', f: f %>
</div>
</div>
diff --git a/admin/spec/helpers/spree/admin/assets_helper_spec.rb b/admin/spec/helpers/spree/admin/assets_helper_spec.rb
new file mode 100644
index 0000000000..7de9c7b9e6
--- /dev/null
+++ b/admin/spec/helpers/spree/admin/assets_helper_spec.rb
@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe Spree::Admin::AssetsHelper do
+ let(:user) { create(:admin_user) }
+
+ before do
+ allow(helper).to receive(:current_ability).and_return(Spree::Ability.new(user))
+ end
+
+ describe '#media_form_assets' do
+ context 'when variant is persisted' do
+ let(:variant) { create(:variant, images: [image]) }
+ let(:image) { create(:image) }
+
+ it 'returns the correct assets' do
+ expect(helper.media_form_assets(variant, 'Spree::Variant')).to eq([image])
+ end
+ end
+
+ context 'when variant is not persisted' do
+ let(:variant) { build(:variant, id: nil) }
+
+ it 'returns an empty array' do
+ expect(helper.media_form_assets(variant, 'Spree::Variant')).to eq([])
+ end
+ end
+
+ context 'when there are session uploaded assets' do
+ let(:variant) { build(:variant, id: nil) }
+ let(:session_uploaded_assets) { [create(:asset)] }
+
+ before do
+ allow(helper).to receive(:session_uploaded_assets).and_return(session_uploaded_assets)
+ end
+
+ it 'returns the correct assets' do
+ expect(helper.media_form_assets(variant, 'Spree::Variant')).to eq(session_uploaded_assets)
+ end
+ end
+ end
+end
diff --git a/admin/spec/helpers/spree/admin/products_helper_spec.rb b/admin/spec/helpers/spree/admin/products_helper_spec.rb
index 473f30f8c7..6bbb4ba15b 100644
--- a/admin/spec/helpers/spree/admin/products_helper_spec.rb
+++ b/admin/spec/helpers/spree/admin/products_helper_spec.rb
@@ -49,44 +49,13 @@ describe Spree::Admin::ProductsHelper do
end
end
- describe '#media_form_assets' do
- context 'when variant is persisted' do
- let(:variant) { build(:variant) }
-
- it 'returns the correct assets' do
- expect(helper.media_form_assets(variant)).to eq(variant.images)
- end
- end
-
- context 'when variant is not persisted' do
- let(:variant) { build(:variant, id: nil) }
-
- it 'returns an empty array' do
- expect(helper.media_form_assets(variant)).to eq([])
- end
- end
-
- context 'when there are session uploaded assets' do
- let(:variant) { build(:variant, id: nil) }
- let(:session_uploaded_assets) { [create(:image)] }
-
- before do
- allow(helper).to receive(:session_uploaded_assets).and_return(session_uploaded_assets)
- end
-
- it 'returns the correct assets' do
- expect(helper.media_form_assets(variant)).to eq(session_uploaded_assets)
- end
- end
- end
-
describe '#sorted_product_properties' do
let(:product) { create(:product) }
context 'when the product has product properties' do
let!(:product_property1) { create(:product_property, product: product, property: create(:property, position: 2)) }
let!(:product_property2) { create(:product_property, product: product, property: create(:property, position: 1)) }
-
+
it 'returns the product properties sorted by position' do
expect(sorted_product_properties(product)).to eq([product_property2, product_property1])
end