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.

Digital assets management (#12507)

Damian Kaczmarczyk138a1ad5bc79
diff --git a/admin/app/controllers/spree/admin/digital_assets_controller.rb b/admin/app/controllers/spree/admin/digital_assets_controller.rb
new file mode 100644
index 0000000000..74ce414756
--- /dev/null
+++ b/admin/app/controllers/spree/admin/digital_assets_controller.rb
@@ -0,0 +1,45 @@
+module Spree
+ module Admin
+ class DigitalAssetsController < ResourceController
+ belongs_to 'spree/product', find_by: :slug
+
+ private
+
+ def model_class
+ Spree::Digital
+ end
+
+ def collection
+ parent.digitals
+ end
+
+ def collection_url
+ spree.admin_product_digital_assets_path(parent)
+ end
+
+ def build_resource
+ parent.digitals.build
+ end
+
+ def find_resource
+ parent.digitals.find(params[:id])
+ end
+
+ def create_turbo_stream_enabled?
+ @object.errors.any?
+ end
+
+ def update_turbo_stream_enabled?
+ @object.errors.any?
+ end
+
+ def location_after_save
+ spree.admin_product_digital_assets_path(parent)
+ end
+
+ def permitted_resource_params
+ params.require(:digital_asset).permit(permitted_digital_attributes)
+ end
+ end
+ end
+end
diff --git a/admin/app/views/spree/admin/digital_assets/_digital_asset.html.erb b/admin/app/views/spree/admin/digital_assets/_digital_asset.html.erb
new file mode 100644
index 0000000000..d1ca530dc6
--- /dev/null
+++ b/admin/app/views/spree/admin/digital_assets/_digital_asset.html.erb
@@ -0,0 +1,30 @@
+<tr id="<%= dom_id(digital_asset) %>">
+ <% unless digital_asset.variant.is_master? %>
+ <td><%= digital_asset.variant.options_text %></td>
+ <% end %>
+ <td><%= digital_asset.attachment.filename %></td>
+ <td><%= number_to_human_size(digital_asset.attachment.byte_size) %></td>
+ <td class="actions">
+ <% if can? :edit, digital_asset %>
+ <span data-toggle="modal" data-target="#modal">
+ <%= link_to_edit(
+ digital_asset,
+ no_text: true,
+ url: spree.edit_admin_product_digital_asset_path(digital_asset.product, digital_asset),
+ data: {
+ turbo_frame: "dialog_modal",
+ },
+ ) %>
+ </span>
+ <% end %>
+ <% if can? :destroy, digital_asset %>
+ <%= link_to_delete(
+ digital_asset,
+ {
+ url: spree.admin_product_digital_asset_path(digital_asset.product, digital_asset),
+ no_text: true,
+ },
+ ) %>
+ <% end %>
+ </td>
+</tr>
diff --git a/admin/app/views/spree/admin/digital_assets/_form.html.erb b/admin/app/views/spree/admin/digital_assets/_form.html.erb
new file mode 100644
index 0000000000..aad1059552
--- /dev/null
+++ b/admin/app/views/spree/admin/digital_assets/_form.html.erb
@@ -0,0 +1,18 @@
+<div class="form-group mb-3">
+ <%= f.label :attachment, Spree.t(:filename) %>
+ <%= f.file_field :attachment, required: true, class: "form-control w-100" %>
+</div>
+<%= f.error_message_on :attachment %>
+
+<% if @product.has_variants? %>
+ <div class="form-group">
+ <%= f.label :variant_id, Spree.t(:variant) %>
+ <%= f.select :variant_id,
+ @product.variants.map { |variant| [variant.options_text, variant.id] },
+ {},
+ required: true,
+ class: "custom-select" %>
+ </div>
+<% else %>
+ <%= hidden_field_tag "digital_asset[variant_id]", @product.master.id %>
+<% end %>
diff --git a/admin/app/views/spree/admin/digital_assets/_table.html.erb b/admin/app/views/spree/admin/digital_assets/_table.html.erb
new file mode 100644
index 0000000000..d383bb9e8e
--- /dev/null
+++ b/admin/app/views/spree/admin/digital_assets/_table.html.erb
@@ -0,0 +1,40 @@
+<table class="table">
+ <thead class="text-muted">
+ <tr>
+ <% if @product.has_variants? %>
+ <th><%= Spree.t(:variant) %></th>
+ <% end %>
+ <th><%= Spree.t(:name) %></th>
+ <th><%= Spree.t(:size) %></th>
+ <th class="actions"></th>
+ </tr>
+ </thead>
+ <tbody>
+ <%= render partial: "spree/admin/digital_assets/digital_asset",
+ collection: @product.digitals.includes(:variant, attachment_attachment: [:blob]), cached: spree_base_cache_scope %>
+ <% if @product.digitals.empty? %>
+ <tr>
+ <td colspan="4">
+ <div
+ class="
+ text-muted p-5 d-flex align-items-center w-100 justify-content-center
+ "
+ >
+ <%= Spree.t(:no_resource_found, resource: Spree.t(:digital_assets)) %>
+ <% if can?(:create, Spree::Digital.new(variant: @product.default_variant)) %>
+ <span data-toggle="modal" data-target="#modal">
+ <%= link_to_with_icon "plus",
+ Spree.t(:add_one),
+ spree.new_admin_product_digital_asset_path(@product),
+ class: "btn btn-light ml-3",
+ data: {
+ turbo_frame: "dialog_modal",
+ } %>
+ </span>
+ <% end %>
+ </div>
+ </td>
+ </tr>
+ <% end %>
+ </tbody>
+</table>
diff --git a/admin/app/views/spree/admin/digital_assets/create.turbo_stream.erb b/admin/app/views/spree/admin/digital_assets/create.turbo_stream.erb
new file mode 100644
index 0000000000..90c38d2259
--- /dev/null
+++ b/admin/app/views/spree/admin/digital_assets/create.turbo_stream.erb
@@ -0,0 +1,2 @@
+<%= turbo_render_alerts %>
+<%= turbo_close_modal %>
diff --git a/admin/app/views/spree/admin/digital_assets/edit.html.erb b/admin/app/views/spree/admin/digital_assets/edit.html.erb
new file mode 100644
index 0000000000..2476917b0d
--- /dev/null
+++ b/admin/app/views/spree/admin/digital_assets/edit.html.erb
@@ -0,0 +1,22 @@
+<%= turbo_frame_tag :dialog_modal do %>
+ <%= form_for :digital_asset, url: spree.admin_product_digital_asset_path(@product, @digital_asset), method: :put do |f| %>
+ <div class="modal-content">
+ <div class="modal-header">
+ <h5 class="modal-title" id="exampleModalLabel"><%= @digital_asset.attachment.filename %></h5>
+ <button
+ type="button"
+ class="btn-close"
+ data-dismiss="modal"
+ aria-label="<%= Spree.t(:close) %>"
+ />
+ </div>
+ <div class="modal-body">
+ <%= render "spree/admin/digital_assets/form", f: f %>
+ </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 Spree.t("actions.save"), data: { turbo_frame: :_top } %>
+ </div>
+ </div>
+ <% end %>
+<% end %>
diff --git a/admin/app/views/spree/admin/digital_assets/index.html.erb b/admin/app/views/spree/admin/digital_assets/index.html.erb
new file mode 100644
index 0000000000..965fd3328a
--- /dev/null
+++ b/admin/app/views/spree/admin/digital_assets/index.html.erb
@@ -0,0 +1,27 @@
+<% content_for :page_title do %>
+ <%= page_header_back_button spree.admin_product_path(@product) %>
+ <span class="mr-3"><%= @product.name %></span>
+ <span><%= Spree.t("digital_assets") %></span>
+<% end %>
+
+<% content_for :page_actions do %>
+ <% if can?(:create, Spree::Digital.new(variant: @product.default_variant)) %>
+ <span data-toggle="modal" data-target="#modal">
+ <%= link_to_with_icon "plus",
+ Spree.t(:new_digital_asset),
+ spree.new_admin_product_digital_asset_path(@product),
+ class: "btn btn-primary",
+ data: {
+ turbo_frame: "dialog_modal",
+ } %>
+ </span>
+ <% end %>
+<% end %>
+
+<div class="card p-0">
+ <div class="card-body p-0">
+ <div class="table-responsive" id="<%= dom_id(@product, :digital_assets) %>">
+ <%= render "spree/admin/digital_assets/table" %>
+ </div>
+ </div>
+</div>
diff --git a/admin/app/views/spree/admin/digital_assets/new.html.erb b/admin/app/views/spree/admin/digital_assets/new.html.erb
new file mode 100644
index 0000000000..39bc126923
--- /dev/null
+++ b/admin/app/views/spree/admin/digital_assets/new.html.erb
@@ -0,0 +1,22 @@
+<%= turbo_frame_tag :dialog_modal do %>
+ <%= form_for :digital_asset, url: spree.admin_product_digital_assets_path(@product) do |f| %>
+ <div class="modal-content">
+ <div class="modal-header">
+ <h5 class="modal-title" id="exampleModalLabel"><%= Spree.t(:new_digital_asset) %></h5>
+ <button
+ type="button"
+ class="btn-close"
+ data-dismiss="modal"
+ aria-label="<%= Spree.t(:close) %>"
+ />
+ </div>
+ <div class="modal-body">
+ <%= render "spree/admin/digital_assets/form", f: f %>
+ </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 Spree.t("actions.save"), data: { turbo_frame: :_top } %>
+ </div>
+ </div>
+ <% end %>
+<% end %>
diff --git a/admin/app/views/spree/admin/digital_assets/update.turbo_stream.erb b/admin/app/views/spree/admin/digital_assets/update.turbo_stream.erb
new file mode 100644
index 0000000000..90c38d2259
--- /dev/null
+++ b/admin/app/views/spree/admin/digital_assets/update.turbo_stream.erb
@@ -0,0 +1,2 @@
+<%= turbo_render_alerts %>
+<%= turbo_close_modal %>
diff --git a/admin/app/views/spree/admin/products/edit.html.erb b/admin/app/views/spree/admin/products/edit.html.erb
index c3717793f6..5c51abb680 100644
--- a/admin/app/views/spree/admin/products/edit.html.erb
+++ b/admin/app/views/spree/admin/products/edit.html.erb
@@ -1,20 +1,36 @@
<% content_for :page_actions_dropdown do %>
<%= link_to_edit_translations(@product) %>
+ <%= link_to_with_icon(
+ "file",
+ Spree.t(:digital_assets),
+ spree.admin_product_digital_assets_path(@product),
+ class: "dropdown-item",
+ ) %>
<%= external_page_preview_link(@product) %>
<% if can?(:clone, @product) %>
- <%= link_to_with_icon('copy', Spree.t(:clone), spree.clone_admin_product_path(@product), class: 'dropdown-item', data: { turbo_method: :post }) %>
+ <%= link_to_with_icon(
+ "copy",
+ Spree.t(:clone),
+ spree.clone_admin_product_path(@product),
+ class: "dropdown-item",
+ data: {
+ turbo_method: :post,
+ },
+ ) %>
<% end %>
<% end %>
-<%= render partial: 'spree/admin/shared/error_messages', locals: { target: @product } %>
+<%= render partial: "spree/admin/shared/error_messages",
+locals: {
+ target: @product,
+} %>
<% content_for :page_title do %>
- <%= render 'spree/admin/products/edit_page_title' %>
+ <%= render "spree/admin/products/edit_page_title" %>
<% end %>
<%= form_for [:admin, @product] do |f| %>
- <%= render 'form', f: f %>
- <%= render 'spree/admin/shared/edit_resource_links', f: f %>
+ <%= render "form", f: f %>
+ <%= render "spree/admin/shared/edit_resource_links", f: f %>
<% end %>
-
diff --git a/admin/config/routes.rb b/admin/config/routes.rb
index 3e49095909..c58b4cb9d3 100644
--- a/admin/config/routes.rb
+++ b/admin/config/routes.rb
@@ -20,7 +20,7 @@ Spree::Core::Engine.add_routes do
post :clone
end
resources :variants, only: [:edit, :update, :destroy]
- resources :digitals, only: [:index, :create, :destroy]
+ resources :digital_assets, except: [:show]
end
# variant search
post 'variants/search'
diff --git a/admin/spec/controllers/spree/admin/digital_assets_controller_spec.rb b/admin/spec/controllers/spree/admin/digital_assets_controller_spec.rb
new file mode 100644
index 0000000000..358324da2a
--- /dev/null
+++ b/admin/spec/controllers/spree/admin/digital_assets_controller_spec.rb
@@ -0,0 +1,91 @@
+require 'spec_helper'
+
+describe Spree::Admin::DigitalAssetsController, type: :controller do
+ stub_authorization!
+ render_views
+
+ let(:store) { Spree::Store.default }
+ let(:product) { create(:product, stores: [store]) }
+ let(:variant) { product.master }
+ let(:attachment) { Rack::Test::UploadedFile.new(File.join(Spree::Core::Engine.root, 'spec/fixtures', 'thinking-cat.jpg'), 'image/jpeg') }
+
+ describe '#create' do
+ subject { post :create, params: params }
+
+ let(:params) do
+ {
+ product_id: product.slug,
+ digital_asset: {
+ variant_id: variant.id,
+ attachment: attachment
+ }
+ }
+ end
+
+ it 'creates a new digital with attachment' do
+ expect { subject }.to change(Spree::Digital, :count).by(1)
+
+ digital = Spree::Digital.last
+ expect(digital.variant).to eq(variant)
+ expect(digital.attachment).to be_attached
+ expect(digital.attachment.filename.to_s).to eq('thinking-cat.jpg')
+ end
+
+ context 'with invalid params' do
+ let(:params) do
+ {
+ product_id: product.slug,
+ digital_asset: {
+ variant_id: variant.id
+ }
+ }
+ end
+
+ it 'does not create a digital' do
+ expect { subject }.not_to change(Spree::Digital, :count)
+ end
+ end
+ end
+
+ describe '#update' do
+ subject { put :update, params: params }
+
+ let!(:digital) { create(:digital, variant: variant) }
+ let(:new_attachment) { Rack::Test::UploadedFile.new(File.join(Spree::Core::Engine.root, 'spec/fixtures', 'thinking-cat.jpg'), 'image/jpeg') }
+
+ let(:params) do
+ {
+ product_id: product.slug,
+ id: digital.id,
+ digital_asset: {
+ attachment: new_attachment
+ }
+ }
+ end
+
+ it 'updates the digital with new attachment' do
+ subject
+
+ digital.reload
+ expect(digital.attachment).to be_attached
+ expect(digital.attachment.filename.to_s).to eq('thinking-cat.jpg')
+ end
+ end
+
+ describe '#destroy' do
+ subject { delete :destroy, params: params }
+
+ let!(:digital) { create(:digital, variant: variant) }
+
+ let(:params) do
+ {
+ product_id: product.slug,
+ id: digital.id
+ }
+ end
+
+ it 'deletes the digital' do
+ expect { subject }.to change(Spree::Digital, :count).by(-1)
+ end
+ end
+end
diff --git a/core/app/models/spree/digital.rb b/core/app/models/spree/digital.rb
index 19ff25dc5f..d4543699f5 100644
--- a/core/app/models/spree/digital.rb
+++ b/core/app/models/spree/digital.rb
@@ -11,5 +11,7 @@ module Spree
validates :attachment, attached: true
validates :variant, presence: true
+
+ delegate :product, to: :variant
end
end
diff --git a/core/config/locales/en.yml b/core/config/locales/en.yml
index f9e07a17d2..2f17f5af65 100644
--- a/core/config/locales/en.yml
+++ b/core/config/locales/en.yml
@@ -321,6 +321,9 @@ en:
spree/customer_return:
one: Customer Return
other: Customer Returns
+ spree/digital:
+ one: Digital asset
+ other: Digital assets
spree/inventory_unit:
one: Inventory Unit
other: Inventory Units
@@ -869,6 +872,7 @@ en:
developers: Developers
digital:
digital_delivery: Digital Delivery
+ digital_assets: Digital assets
dimension_units:
centimeter: Centimeter (cm)
foot: Foot (ft)
@@ -1208,6 +1212,7 @@ en:
new_country: New Country
new_customer: Create new account
new_customer_return: New Customer Return
+ new_digital_asset: New digital asset
new_domain: New domain
new_image: New Image
new_line_item: Add line item