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.

Open source new admin assets management (#12197)

Damian Legawiece0689d7cd445
diff --git a/admin/app/controllers/spree/admin/assets_controller.rb b/admin/app/controllers/spree/admin/assets_controller.rb
new file mode 100644
index 0000000000..70a4c2e26a
--- /dev/null
+++ b/admin/app/controllers/spree/admin/assets_controller.rb
@@ -0,0 +1,69 @@
+module Spree
+ module Admin
+ class AssetsController < ResourceController
+ ALLOWED_ASSET_TYPES = ['Spree::Asset', 'Spree::Image'].freeze
+
+ def create
+ if ALLOWED_ASSET_TYPES.include?(asset_type)
+ @asset = asset_type.constantize.new(permitted_resource_params)
+ else
+ raise "Invalid asset type"
+ end
+
+ # we only should check this for vendor users
+ 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
+ if @product.new_record?
+ uploaded_asssets_id = session[:uploaded_asset_ids]&.split(',') || []
+ uploaded_asssets_id << @asset.id
+
+ session[:uploaded_asset_ids] = uploaded_asssets_id.join(',')
+ end
+ else
+ flash.now[:error] = @asset.errors.full_messages.to_sentence
+ render :create, status: :unprocessable_entity
+ end
+ end
+
+ def update
+ authorize! :update, @asset.viewable if @asset.viewable.present? && current_vendor
+
+ if @asset.update(permitted_resource_params)
+ respond_to do |format|
+ format.turbo_stream
+ format.json { render json: @asset }
+ end
+ else
+ head :unprocessable_entity
+ end
+ end
+
+ def bulk_destroy
+ @assets = model_class.accessible_by(current_ability).where(id: params[:ids])
+ @assets.destroy_all
+ end
+
+ private
+
+ def permitted_resource_params
+ params.require(:asset).permit(:type, :viewable_id, :viewable_type, :attachment, :alt, :position)
+ end
+
+ def create_turbo_stream_enabled?
+ true
+ end
+
+ def update_turbo_stream_enabled?
+ true
+ end
+
+ def asset_type
+ permitted_resource_params[:type] || model_class.to_s
+ end
+ end
+ end
+end
diff --git a/admin/app/controllers/spree/admin/base_controller.rb b/admin/app/controllers/spree/admin/base_controller.rb
index e152a49b70..50e2e7a76b 100644
--- a/admin/app/controllers/spree/admin/base_controller.rb
+++ b/admin/app/controllers/spree/admin/base_controller.rb
@@ -72,6 +72,10 @@ module Spree
def current_timezone
@current_timezone ||= current_store.timezone
end
+
+ def current_vendor
+ nil
+ end
end
end
end
diff --git a/admin/app/views/layouts/spree/admin.html.erb b/admin/app/views/layouts/spree/admin.html.erb
new file mode 100644
index 0000000000..7a31fc3aec
--- /dev/null
+++ b/admin/app/views/layouts/spree/admin.html.erb
@@ -0,0 +1,25 @@
+<!DOCTYPE html>
+<html lang="<%= I18n.locale %>">
+ <head>
+ </head>
+ <body class="admin min-vh-100 <%= controller_name %> <%= action_name %>" data-controller="spree">
+ <div class="container-fluid">
+ <div class="row justify-content-center">
+ <div class="col-lg-3 col-xl-2 d-none d-lg-block position-relative px-2">
+ <%= render 'spree/admin/shared/sidebar' %>
+ </div>
+ <div class="col-lg-9 col-xl-10 px-0 pb-5 mb-3 pt-lg-2">
+ <main id="content" class="container">
+ <% if content_for?(:table_filter) || content_for?(:table_filter_dropdown) %>
+ <div class="card-lg p-0 mb-lg-3">
+ <%= yield %>
+ </div>
+ <% else %>
+ <%= yield %>
+ <% end %>
+ </main>
+ </div>
+ </div>
+ </div>
+ </body>
+</html>
diff --git a/admin/app/views/spree/admin/assets/bulk_destroy.turbo_stream.erb b/admin/app/views/spree/admin/assets/bulk_destroy.turbo_stream.erb
new file mode 100644
index 0000000000..2908421d07
--- /dev/null
+++ b/admin/app/views/spree/admin/assets/bulk_destroy.turbo_stream.erb
@@ -0,0 +1,3 @@
+<% params[:ids].each do |id| %>
+ <%= turbo_stream.remove("spree_image_#{id}") %>
+<% end %>
\ No newline at end of file
diff --git a/admin/app/views/spree/admin/assets/create.turbo_stream.erb b/admin/app/views/spree/admin/assets/create.turbo_stream.erb
new file mode 100644
index 0000000000..b3e256135c
--- /dev/null
+++ b/admin/app/views/spree/admin/assets/create.turbo_stream.erb
@@ -0,0 +1,5 @@
+<%= turbo_render_alerts %>
+
+<%= turbo_stream.replace 'media-form' do %>
+ <%= render 'spree/admin/variants/form/media', viewable: @asset.viewable %>
+<% end %>
diff --git a/admin/app/views/spree/admin/assets/edit.html.erb b/admin/app/views/spree/admin/assets/edit.html.erb
new file mode 100644
index 0000000000..33d9147fbb
--- /dev/null
+++ b/admin/app/views/spree/admin/assets/edit.html.erb
@@ -0,0 +1,25 @@
+<%= turbo_frame_tag :dialog_modal_lg do %>
+ <div class="modal-content" >
+ <div class="modal-header">
+ <h5 class="modal-title" id="exampleModalLabel">
+ <%= Spree.t(:edit) %> <%= Spree.t(:image) %>
+ </h5>
+ <button type="button" class="btn-close" data-dismiss="modal" aria-label="<%= Spree.t(:close) %>" />
+ </div>
+ <%= form_with model: @asset, url: spree.admin_asset_path(@asset), method: :put, scope: :asset do |f| %>
+ <div class="modal-body pb-0" data-turbo-permanent id="asset-<%= @asset.key.parameterize %>">
+ <%= render 'active_storage/upload_form', form: f, field_name: :attachment, width: 200, height: 200, can_delete: false %>
+ </div>
+ <div class="modal-body border-bottom pb-3" style="min-height: 200px">
+ <div class="form-group">
+ <%= f.label :alt, Spree.t(:alt_text) %>
+ <%= f.text_area :alt, rows: 4, class: 'form-control' %>
+ </div>
+ </div>
+ <div class="modal-footer d-flex justify-content-between">
+ <button type="button" class="btn btn-light" data-dismiss="modal"><%= Spree.t('actions.discard') %></button>
+ <%= turbo_save_button_tag %>
+ </div>
+ <% end %>
+ </div>
+<% end %>
\ No newline at end of file
diff --git a/admin/app/views/spree/admin/assets/update.turbo_stream.erb b/admin/app/views/spree/admin/assets/update.turbo_stream.erb
new file mode 100644
index 0000000000..4525b2f6e3
--- /dev/null
+++ b/admin/app/views/spree/admin/assets/update.turbo_stream.erb
@@ -0,0 +1,7 @@
+<%= turbo_render_alerts %>
+<%= turbo_close_modal('modal-lg') %>
+
+<!-- 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 %>
+<% end %>
diff --git a/admin/config/initializers/dartsass.rb b/admin/config/initializers/dartsass.rb
index 5082fd865d..909c7d0b8a 100644
--- a/admin/config/initializers/dartsass.rb
+++ b/admin/config/initializers/dartsass.rb
@@ -1,3 +1,3 @@
Rails.application.config.dartsass.builds = {
- Spree::Admin::Engine.root.join('app/assets/stylesheets/spree/admin/application.scss') => 'spree/admin/applications.css'
+ Spree::Admin::Engine.root.join('app/assets/stylesheets/spree/admin/application.scss') => 'spree/admin/application.css'
}
diff --git a/admin/config/routes.rb b/admin/config/routes.rb
new file mode 100644
index 0000000000..6c03937dc3
--- /dev/null
+++ b/admin/config/routes.rb
@@ -0,0 +1,10 @@
+Spree::Core::Engine.add_routes do
+ namespace :admin, path: Spree.admin_path do
+ # media library
+ resources :assets, only: [:create, :edit, :update, :destroy] do
+ collection do
+ delete :bulk_destroy
+ end
+ end
+ end
+end
diff --git a/admin/lib/spree/admin.rb b/admin/lib/spree/admin.rb
index d727a026ca..e84dcddaef 100644
--- a/admin/lib/spree/admin.rb
+++ b/admin/lib/spree/admin.rb
@@ -6,13 +6,13 @@ require 'active_link_to'
require 'countries/global'
require 'country_select'
require 'currency_select'
-require 'dartsass-rails'
require 'importmap-rails'
require 'bootstrap'
require 'turbo-rails'
require 'stimulus-rails'
require 'inline_svg'
-require 'payment_icons'
+# require 'payment_icons'
+require 'dartsass-rails'
require 'responders'
require 'tinymce-rails'
diff --git a/admin/spec/controllers/spree/admin/assets_controller_spec.rb b/admin/spec/controllers/spree/admin/assets_controller_spec.rb
new file mode 100644
index 0000000000..06be979112
--- /dev/null
+++ b/admin/spec/controllers/spree/admin/assets_controller_spec.rb
@@ -0,0 +1,77 @@
+require 'spec_helper'
+
+describe Spree::Admin::AssetsController, type: :controller do
+ stub_authorization!
+
+ let(:store) { Spree::Store.default }
+ let(:product) { create(:product, stores: [store]) }
+
+ describe '#create' do
+ subject { post :create, params: params, format: :turbo_stream }
+
+ let(:attachment) { Rack::Test::UploadedFile.new(File.join(Spree::Core::Engine.root + 'spec/fixtures' + 'thinking-cat.jpg'), 'image/jpeg') }
+ let(:asset) { Spree::Asset.last }
+
+ context 'without viewable' do
+ let(:params) { { asset: { alt: "some text", attachment: attachment } } }
+
+ it 'creates a new image' do
+ expect { subject }.to change(Spree::Asset, :count).by(1)
+
+ expect(asset.alt).to eq("some text")
+ expect(asset.attached?).to be true
+ expect(asset.viewable).to be_nil
+ end
+ end
+
+ context 'with viewable' do
+ subject { post :create, params: params, format: :turbo_stream }
+
+ let(:params) do
+ { asset: { alt: "some text", attachment: attachment, viewable_id: product.master.id, viewable_type: "Spree::Variant" } }
+ end
+
+ it 'creates a new image' do
+ expect { subject }.to change(Spree::Asset, :count).by(1)
+
+ expect(asset.viewable).to eq(product.master)
+ end
+ end
+ end
+
+ describe '#update' do
+ subject { put :update, params: { id: image.id, asset: { alt: 'Alt text' } }, as: :turbo_stream }
+
+ let!(:image) { create(:image, viewable: product.master) }
+
+ it 'updates the image' do
+ subject
+ expect(image.reload.alt).to eq('Alt text')
+ end
+ end
+
+ describe '#destroy' do
+ subject { delete :destroy, params: { id: image.id } }
+
+ let!(:image) { create(:image, viewable: product.master) }
+
+ it 'deletes the image' do
+ expect { subject }.to change(Spree::Asset, :count).by(-1)
+ end
+ end
+
+ describe '#bulk_destroy' do
+ subject { delete :bulk_destroy, params: params, as: :turbo_stream }
+
+ let!(:images) { create_list(:image, 2, viewable: product.master) }
+ let(:params) do
+ {
+ ids: images.map(&:id)
+ }
+ end
+
+ it 'deletes images' do
+ expect { subject }.to change(Spree::Asset, :count).by(-2)
+ end
+ end
+end
diff --git a/admin/spree_admin.gemspec b/admin/spree_admin.gemspec
index dc1fba606a..a771bba92e 100644
--- a/admin/spree_admin.gemspec
+++ b/admin/spree_admin.gemspec
@@ -36,7 +36,7 @@ Gem::Specification.new do |s|
s.add_dependency 'dartsass-rails', '~> 0.5'
s.add_dependency 'importmap-rails'
s.add_dependency 'inline_svg', '~> 1.5'
- s.add_dependency 'payment_icons'
+ # s.add_dependency 'payment_icons'
s.add_dependency 'turbo-rails'
s.add_dependency 'stimulus-rails'
s.add_dependency 'responders'