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.

Fix some issues with duplicating products, move the Product Duplicator to spree services (#12202)

Łukasz Adamczyk926ed4e3b631
diff --git a/core/app/models/spree/product.rb b/core/app/models/spree/product.rb
index 3061ee68cf..6f938141de 100644
--- a/core/app/models/spree/product.rb
+++ b/core/app/models/spree/product.rb
@@ -297,8 +297,7 @@ module Spree
# for adding products which are closely related to existing ones
# define "duplicate_extra" for site-specific actions, eg for additional fields
def duplicate
- duplicator = ProductDuplicator.new(self)
- duplicator.duplicate
+ Products::Duplicator.call(product: self)
end
# use deleted? rather than checking the attribute directly. this
diff --git a/core/app/services/spree/products/duplicator.rb b/core/app/services/spree/products/duplicator.rb
new file mode 100644
index 0000000000..b00d47f9c6
--- /dev/null
+++ b/core/app/services/spree/products/duplicator.rb
@@ -0,0 +1,97 @@
+module Spree
+ module Products
+ class Duplicator
+ prepend ::Spree::ServiceModule::Base
+
+ def call(product:, include_images: true)
+ new_product = duplicate_product(product, include_images)
+
+ # don't dup the actual variants, just the characterising types
+ new_product.option_types = product.option_types if product.has_variants?
+
+ # allow site to do some customization
+ new_product.send(:duplicate_extra, product) if new_product.respond_to?(:duplicate_extra)
+ new_product.save
+
+ new_product.persisted? ? success(new_product) : failure(new_product, duplicate_error_message(new_product))
+ end
+
+ protected
+
+ def duplicate_product(product, include_images)
+ product.dup.tap do |new_product|
+ new_product.translations.each do |t|
+ t.name = "COPY OF #{t.name}"
+ t.slug = nil
+ end
+
+ new_product.name = "COPY OF #{product.name}"
+ new_product.taxons = product.taxons
+ new_product.stores = product.stores
+ new_product.created_at = nil
+ new_product.deleted_at = nil
+ new_product.updated_at = nil
+ new_product.master = duplicate_master(product.master, include_images)
+ new_product.variants = product.variants.map { |variant| duplicate_variant(variant) }
+
+ duplicate_properties(product.product_properties, new_product)
+ end
+ end
+
+ def duplicate_master(master, include_images)
+ master.dup.tap do |new_master|
+ new_master.sku = sku_generator(master.sku)
+ new_master.deleted_at = nil
+ new_master.price = master.price
+ new_master.currency = master.currency
+
+ master.images.each { |image| duplicate_image(image, new_master) } if include_images
+ end
+ end
+
+ def duplicate_variant(variant)
+ new_variant = variant.dup
+ new_variant.sku = sku_generator(new_variant.sku)
+ new_variant.deleted_at = nil
+ new_variant.option_values = variant.option_values.map { |option_value| option_value }
+ new_variant
+ end
+
+ def duplicate_image(image, viewable)
+ new_image = image.dup
+ new_image.viewable = viewable
+ new_image.attachment.attach(image.attachment.blob)
+ new_image.save
+ new_image
+ end
+
+ def duplicate_properties(product_properties, new_product)
+ product_properties.each do |prop|
+ new_prop = prop.dup
+ new_prop.created_at = nil
+ new_prop.updated_at = nil
+ new_prop.product = new_product
+ new_prop.save
+ end
+ end
+
+ def sku_generator(sku)
+ return '' if sku.blank?
+
+ "COPY OF #{Variant.unscoped.where('sku like ?', "%#{sku}").order(:created_at).last.sku}"
+ end
+
+ def duplicate_error_message(new_product)
+ errors = []
+ errors << new_product.errors.full_messages
+ errors << new_product.master.errors.full_messages
+
+ new_product.variants.each do |variant|
+ errors << variant.errors.full_messages
+ end
+
+ errors.flatten.to_sentence
+ end
+ end
+ end
+end
diff --git a/core/lib/spree/core.rb b/core/lib/spree/core.rb
index f0807cd046..59ef33a828 100644
--- a/core/lib/spree/core.rb
+++ b/core/lib/spree/core.rb
@@ -152,7 +152,6 @@ require 'spree/database_type_utilities'
require 'spree/core/importer'
require 'spree/core/query_filters'
-require 'spree/core/product_duplicator'
require 'spree/core/controller_helpers/auth'
require 'spree/core/controller_helpers/common'
require 'spree/core/controller_helpers/order'
diff --git a/core/lib/spree/core/product_duplicator.rb b/core/lib/spree/core/product_duplicator.rb
deleted file mode 100644
index 59e078e1b3..0000000000
--- a/core/lib/spree/core/product_duplicator.rb
+++ /dev/null
@@ -1,85 +0,0 @@
-module Spree
- class ProductDuplicator
- attr_accessor :product
-
- @@clone_images_default = true
- mattr_accessor :clone_images_default
-
- def initialize(product, include_images = @@clone_images_default)
- @product = product
- @include_images = include_images
- end
-
- def duplicate
- new_product = duplicate_product
-
- # don't dup the actual variants, just the characterising types
- new_product.option_types = product.option_types if product.has_variants?
-
- # allow site to do some customization
- new_product.send(:duplicate_extra, product) if new_product.respond_to?(:duplicate_extra)
- new_product.save!
- new_product
- end
-
- protected
-
- def duplicate_product
- product.dup.tap do |new_product|
- new_product.translations.each do |t|
- t.name = "COPY OF #{t.name}"
- t.slug = nil
- end
-
- new_product.name = "COPY OF #{product.name}"
- new_product.taxons = product.taxons
- new_product.stores = product.stores
- new_product.created_at = nil
- new_product.deleted_at = nil
- new_product.updated_at = nil
- new_product.product_properties = reset_properties
- new_product.master = duplicate_master
- new_product.variants = product.variants.map { |variant| duplicate_variant variant }
- end
- end
-
- def duplicate_master
- master = product.master
- master.dup.tap do |new_master|
- new_master.sku = sku_generator(master.sku)
- new_master.deleted_at = nil
- new_master.images = master.images.map { |image| duplicate_image image } if @include_images
- new_master.price = master.price
- new_master.currency = master.currency
- end
- end
-
- def duplicate_variant(variant)
- new_variant = variant.dup
- new_variant.sku = sku_generator(new_variant.sku)
- new_variant.deleted_at = nil
- new_variant.option_values = variant.option_values.map { |option_value| option_value }
- new_variant
- end
-
- def duplicate_image(image)
- new_image = image.dup
- new_image.attachment.attach(image.attachment.blob)
- new_image.save!
- new_image
- end
-
- def reset_properties
- product.product_properties.map do |prop|
- prop.dup.tap do |new_prop|
- new_prop.created_at = nil
- new_prop.updated_at = nil
- end
- end
- end
-
- def sku_generator(sku)
- "COPY OF #{Variant.unscoped.where('sku like ?', "%#{sku}").order(:created_at).last.sku}"
- end
- end
-end
diff --git a/core/spec/models/spree/product_duplicator_spec.rb b/core/spec/models/spree/product_duplicator_spec.rb
deleted file mode 100644
index 78a79e0ded..0000000000
--- a/core/spec/models/spree/product_duplicator_spec.rb
+++ /dev/null
@@ -1,113 +0,0 @@
-require 'spec_helper'
-
-module Spree
- describe Spree::ProductDuplicator, type: :model do
- let(:store) { create(:store) }
- let!(:product_property) { create(:product_property, product: product) }
- let!(:product) { create(:product, stores: [store]) }
- let!(:duplicator) { Spree::ProductDuplicator.new(product) }
-
- let(:file) { File.open(File.expand_path('../../fixtures/thinking-cat.jpg', __dir__)) }
- let(:params) do
- {
- viewable_id: product.master.id,
- viewable_type: 'Spree::Variant',
- alt: 'position 1',
- position: 1
- }
- end
-
- before do
- new_image = Spree::Image.new(params)
- new_image.attachment.attach(io: file, filename: File.basename(file))
- new_image.save!
- end
-
- it 'will duplicate the product' do
- expect { duplicator.duplicate }.to change { Spree::Product.count }.by(1)
- end
-
- it 'will duplicate already duplicated product' do
- Timecop.scale(3600)
- expect { 3.times { duplicator.duplicate } }.to change { Spree::Product.count }.by(3)
- Timecop.return
- end
-
- context 'when image duplication enabled' do
- it 'will duplicate the product images' do
- expect { duplicator.duplicate }.to change { Spree::Image.count }.by(1)
- end
- end
-
- context 'when image duplication disabled' do
- let!(:duplicator) { Spree::ProductDuplicator.new(product, false) }
-
- it 'will not duplicate the product images' do
- expect { duplicator.duplicate }.to change { Spree::Image.count }.by(0)
- end
- end
-
- context 'image duplication default' do
- context 'when default is set to true' do
- it 'clones images if no flag passed to initializer' do
- expect { duplicator.duplicate }.to change { Spree::Image.count }.by(1)
- end
- end
-
- context 'when default is set to false' do
- before do
- ProductDuplicator.clone_images_default = false
- end
-
- after do
- ProductDuplicator.clone_images_default = true
- end
-
- it 'does not clone images if no flag passed to initializer' do
- expect { ProductDuplicator.new(product).duplicate }.to change { Spree::Image.count }.by(0)
- end
- end
- end
-
- context 'product attributes' do
- let!(:new_product) { duplicator.duplicate }
-
- it 'will set an unique name' do
- expect(new_product.name).to eql "COPY OF #{product.name}"
- end
-
- it 'will set an unique sku' do
- expect(new_product.sku).to include 'COPY OF SKU'
- end
-
- it 'copied the properties' do
- expect(new_product.product_properties.count).to eq 1
- expect(new_product.product_properties.first.property.name).to eql product_property.property.name
- end
- end
-
- context 'stores' do
- let!(:new_product) { duplicator.duplicate }
-
- it { expect(new_product.stores).to eq [store] }
- end
-
- context 'with variants' do
- let(:option_type) { create(:option_type, name: 'MyOptionType') }
- let(:option_value1) { create(:option_value, name: 'OptionValue1', option_type: option_type) }
- let(:option_value2) { create(:option_value, name: 'OptionValue2', option_type: option_type) }
-
- let!(:variant1) { create(:variant, product: product, option_values: [option_value1]) }
- let!(:variant2) { create(:variant, product: product, option_values: [option_value2]) }
-
- it 'will duplicate the variants' do
- # will change the count by 3, since there will be a master variant as well
- expect { duplicator.duplicate }.to change { Spree::Variant.count }.by(3)
- end
-
- it 'will not duplicate the option values' do
- expect { duplicator.duplicate }.to change { Spree::OptionValue.count }.by(0)
- end
- end
- end
-end
diff --git a/core/spec/models/spree/product_spec.rb b/core/spec/models/spree/product_spec.rb
index 6808c13cef..183e830ab6 100644
--- a/core/spec/models/spree/product_spec.rb
+++ b/core/spec/models/spree/product_spec.rb
@@ -61,7 +61,10 @@ describe Spree::Product, type: :model do
end
it 'duplicates product' do
- clone = product.duplicate
+ duplicate_result = product.duplicate
+ expect(duplicate_result).to be_success
+
+ clone = duplicate_result.value
expect(clone.name).to eq("COPY OF #{product.name}")
expect(clone.slug).to eq("copy-of-#{product.slug}")
expect(clone.master.sku).to eq("COPY OF #{product.master.sku}")
@@ -77,8 +80,11 @@ describe Spree::Product, type: :model do
end
it 'duplicates translations for all locales' do
- clone = product.duplicate
- expect(clone.name(locale: :fr)).to eq ('COPY OF ' + product.name(locale: :fr))
+ duplicate_result = product.duplicate
+ expect(duplicate_result).to be_success
+
+ clone = duplicate_result.value
+ expect(clone.name(locale: :fr)).to eq("COPY OF #{product.name(locale: :fr)}")
end
end
diff --git a/core/spec/services/spree/products/duplicator_spec.rb b/core/spec/services/spree/products/duplicator_spec.rb
new file mode 100644
index 0000000000..a5823d6a46
--- /dev/null
+++ b/core/spec/services/spree/products/duplicator_spec.rb
@@ -0,0 +1,93 @@
+require 'spec_helper'
+
+RSpec.describe Spree::Products::Duplicator do
+ subject(:duplicate) { described_class.call(product: product) }
+
+ let(:store) { create(:store) }
+
+ let!(:product_property) { create(:product_property, product: product) }
+ let!(:product) { create(:product, stores: [store]) }
+
+ let(:file) { File.open(File.expand_path('../../../fixtures/thinking-cat.jpg', __dir__)) }
+ let(:params) do
+ {
+ viewable_id: product.master.id,
+ viewable_type: 'Spree::Variant',
+ alt: 'position 1',
+ position: 1
+ }
+ end
+
+ before do
+ new_image = Spree::Image.new(params)
+ new_image.attachment.attach(io: file, filename: File.basename(file))
+ new_image.save!
+ end
+
+ it { is_expected.to be_success }
+
+ it 'duplicates the product' do
+ expect { duplicate }.to change { Spree::Product.count }.by(1)
+ end
+
+ it 'duplicates already duplicated product' do
+ Timecop.scale(3600)
+ expect { 3.times { described_class.call(product: product) } }.to change { Spree::Product.count }.by(3)
+ Timecop.return
+ end
+
+ describe 'image duplication' do
+ it 'clones images by default' do
+ expect { duplicate }.to change { Spree::Image.count }.by(1)
+ end
+
+ context 'when excluding images from cloning' do
+ subject(:duplicate) { described_class.call(product: product, include_images: false) }
+
+ it 'doesn\'t clone images' do
+ expect { duplicate }.not_to change(Spree::Image, :count)
+ end
+ end
+ end
+
+ describe 'product attributes' do
+ let!(:new_product) { duplicate.value }
+
+ it 'sets an unique name' do
+ expect(new_product.name).to eql "COPY OF #{product.name}"
+ end
+
+ it 'sets an unique sku' do
+ expect(new_product.sku).to include 'COPY OF SKU'
+ end
+
+ it 'copies the properties' do
+ expect(new_product.product_properties.count).to eq 1
+ expect(new_product.product_properties.first.property.name).to eql product_property.property.name
+ end
+ end
+
+ describe 'stores' do
+ let!(:new_product) { duplicate.value }
+
+ it { expect(new_product.stores).to eq [store] }
+ end
+
+ context 'with variants' do
+ let(:option_type) { create(:option_type, name: 'MyOptionType') }
+ let(:option_value1) { create(:option_value, name: 'OptionValue1', option_type: option_type) }
+ let(:option_value2) { create(:option_value, name: 'OptionValue2', option_type: option_type) }
+
+ let!(:variant1) { create(:variant, product: product, option_values: [option_value1]) }
+ let!(:variant2) { create(:variant, product: product, option_values: [option_value2]) }
+
+ it 'duplicates the variants' do
+ # will change the count by 3, since there will be a master variant as well
+ expect { duplicate }.to change { Spree::Variant.count }.by(3)
+ end
+
+ it 'doesn\'t duplicate the option values' do
+ expect { duplicate }.to change { Spree::OptionValue.count }.by(0)
+ end
+ end
+end