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.

[VEN-105] Product states - pre-Orders support - drop available_on logic (#11600)

Konrad Gorazd5515a2458d5b
diff --git a/api/spec/requests/spree/api/v2/platform/products_spec.rb b/api/spec/requests/spree/api/v2/platform/products_spec.rb
index a4a860e287..36503b869d 100644
--- a/api/spec/requests/spree/api/v2/platform/products_spec.rb
+++ b/api/spec/requests/spree/api/v2/platform/products_spec.rb
@@ -18,7 +18,7 @@ describe 'API V2 Platform Products Spec' do
let(:product) { create(:product, stores: [store]) }
let!(:deleted_product) { create(:product, deleted_at: Time.current - 1.day, stores: [store]) }
let!(:discontinued_product) { create(:product, discontinue_on: Time.current - 1.day, stores: [store]) }
- let!(:not_available_product) { create(:product, available_on: nil, stores: [store]) }
+ let!(:not_available_product) { create(:product, status: 'draft', stores: [store]) }
let!(:in_stock_product) { create(:product_in_stock, stores: [store]) }
let!(:not_backorderable_product) { create(:product_in_stock, :without_backorder, stores: [store]) }
let!(:property) { create(:property) }
diff --git a/api/spec/requests/spree/api/v2/storefront/products_spec.rb b/api/spec/requests/spree/api/v2/storefront/products_spec.rb
index b4b9421d38..c8383a6931 100644
--- a/api/spec/requests/spree/api/v2/storefront/products_spec.rb
+++ b/api/spec/requests/spree/api/v2/storefront/products_spec.rb
@@ -14,8 +14,8 @@ describe 'API V2 Storefront Products Spec', type: :request do
let!(:variant) { create(:variant, product: product_with_option, option_values: [option_value]) }
let(:product) { create(:product, stores: [store]) }
let!(:deleted_product) { create(:product, deleted_at: Time.current - 1.day, stores: [store]) }
- let!(:discontinued_product) { create(:product, discontinue_on: Time.current - 1.day, stores: [store]) }
- let!(:not_available_product) { create(:product, available_on: nil, stores: [store]) }
+ let!(:discontinued_product) { create(:product, status: 'archived', discontinue_on: Time.current - 1.day, stores: [store]) }
+ let!(:not_available_product) { create(:product, status: 'draft', stores: [store]) }
let!(:in_stock_product) { create(:product_in_stock, stores: [store]) }
let!(:not_backorderable_product) { create(:product_in_stock, :without_backorder, stores: [store]) }
let!(:property) { create(:property) }
@@ -428,7 +428,7 @@ describe 'API V2 Storefront Products Spec', type: :request do
end
context 'sorting by available_on' do
- before { store.products.each_with_index { |p, i| p.update(available_on: Time.current - i.days) } }
+ before { store.products.each_with_index { |p, i| p.update(status: 'active', available_on: Time.current - i.days) } }
context 'ascending order' do
before { get '/api/v2/storefront/products?sort=available_on' }
diff --git a/api/spec/serializers/spree/api/v2/platform/product_serializer_spec.rb b/api/spec/serializers/spree/api/v2/platform/product_serializer_spec.rb
index 7d8d8a51d3..4f4dc9913e 100644
--- a/api/spec/serializers/spree/api/v2/platform/product_serializer_spec.rb
+++ b/api/spec/serializers/spree/api/v2/platform/product_serializer_spec.rb
@@ -26,6 +26,7 @@ describe Spree::Api::V2::Platform::ProductSerializer do
name: product.name,
description: product.description,
available_on: product.available_on,
+ status: product.status,
deleted_at: product.deleted_at,
slug: product.slug,
meta_description: product.meta_description,
diff --git a/core/app/models/concerns/spree/product_scopes.rb b/core/app/models/concerns/spree/product_scopes.rb
index c46b3879a4..014f7d63a7 100644
--- a/core/app/models/concerns/spree/product_scopes.rb
+++ b/core/app/models/concerns/spree/product_scopes.rb
@@ -236,7 +236,7 @@ module Spree
def self.not_discontinued(only_not_discontinued = true)
if only_not_discontinued != '0' && only_not_discontinued
- where("#{Product.quoted_table_name}.discontinue_on IS NULL or #{Product.quoted_table_name}.discontinue_on >= ?", Time.zone.now)
+ where.not(status: 'archived')
else
all
end
@@ -253,9 +253,11 @@ module Spree
# Can't use add_search_scope for this as it needs a default argument
def self.available(available_on = nil, currency = nil)
- available_on ||= Time.current
-
- scope = not_discontinued.where("#{Product.quoted_table_name}.available_on <= ?", available_on)
+ if available_on
+ scope = not_discontinued.where("#{Product.quoted_table_name}.available_on <= ?", available_on)
+ else
+ scope = where(status: 'active')
+ end
unless Spree::Config.show_products_without_price
currency ||= Spree::Store.default.default_currency
diff --git a/core/app/models/spree/product.rb b/core/app/models/spree/product.rb
index 7e4dd4e232..66aa7f7fee 100644
--- a/core/app/models/spree/product.rb
+++ b/core/app/models/spree/product.rb
@@ -231,14 +231,16 @@ module Spree
end
# determine if product is available.
- # deleted products and products with nil or future available_on date
+ # deleted products and products with status different than active
# are not available
def available?
- !(available_on.nil? || available_on.future?) && !deleted? && !discontinued?
+ status == 'active' && !deleted?
end
def discontinue!
- update_attribute(:discontinue_on, Time.current)
+ self.discontinue_on = Time.current
+ self.status = 'archived'
+ save(validate: false)
end
def discontinued?
diff --git a/core/db/migrate/20220103082046_add_status_and_make_active_at_to_spree_products.rb b/core/db/migrate/20220103082046_add_status_and_make_active_at_to_spree_products.rb
new file mode 100644
index 0000000000..eabcd41c6f
--- /dev/null
+++ b/core/db/migrate/20220103082046_add_status_and_make_active_at_to_spree_products.rb
@@ -0,0 +1,7 @@
+class AddStatusAndMakeActiveAtToSpreeProducts < ActiveRecord::Migration[5.2]
+ def change
+ add_column :spree_products, :status, :string, null: false, default: 'draft'
+ add_index :spree_products, :status
+ add_index :spree_products, %i[status deleted_at]
+ end
+end
diff --git a/core/lib/spree/testing_support/factories/product_factory.rb b/core/lib/spree/testing_support/factories/product_factory.rb
index 2eea8ad1a2..5fad238945 100644
--- a/core/lib/spree/testing_support/factories/product_factory.rb
+++ b/core/lib/spree/testing_support/factories/product_factory.rb
@@ -8,6 +8,7 @@ FactoryBot.define do
available_on { 1.year.ago }
deleted_at { nil }
shipping_category { |r| Spree::ShippingCategory.first || r.association(:shipping_category) }
+ status { 'active' }
# ensure stock item will be created for this products master
# also attach this product to the default store if no stores are passed in
diff --git a/core/lib/tasks/core.rake b/core/lib/tasks/core.rake
index 50ba5a9962..9e221d98ee 100644
--- a/core/lib/tasks/core.rake
+++ b/core/lib/tasks/core.rake
@@ -185,3 +185,15 @@ use rake db:load_file[/absolute/path/to/sample/filename.rb]}
end
end
end
+
+namespace :core do
+ desc 'Set "active" status on draft products where available_on is in the past'
+ task activate_products: :environment do |_t, _args|
+ Spree::Product.where('available_on <= ?', Time.current).where(status: 'draft').update_all(status: 'active', updated_at: Time.current)
+ end
+
+ desc 'Set "archived" status on active products where discontinue_on is in the past'
+ task archive_products: :environment do |_t, _args|
+ Spree::Product.where('discontinue_on <= ?', Time.current).where.not(status: 'archived').update_all(status: 'archived', updated_at: Time.current)
+ end
+end
diff --git a/core/spec/finders/spree/products/find_spec.rb b/core/spec/finders/spree/products/find_spec.rb
index 5c3f9c7097..a8902b8cd2 100644
--- a/core/spec/finders/spree/products/find_spec.rb
+++ b/core/spec/finders/spree/products/find_spec.rb
@@ -7,7 +7,7 @@ module Spree
let!(:product_3) { create(:variant, price: 19.99).product }
let!(:option_value) { create(:option_value) }
let!(:deleted_product) { create(:product, deleted_at: Time.current - 1.day) }
- let!(:discontinued_product) { create(:product, discontinue_on: Time.current - 1.day) }
+ let!(:discontinued_product) { create(:product, status: 'archived') }
let!(:in_stock_product) { create(:product_in_stock) }
let!(:not_backorderable_product) { create(:product_in_stock, :without_backorder) }
let(:store) { product.stores.first }
diff --git a/core/spec/helpers/products_helper_spec.rb b/core/spec/helpers/products_helper_spec.rb
index 854ee76cbf..4dcefbb802 100644
--- a/core/spec/helpers/products_helper_spec.rb
+++ b/core/spec/helpers/products_helper_spec.rb
@@ -320,6 +320,7 @@ module Spree
context 'product will be available soon' do
before do
+ product.status = 'draft'
product.available_on = 1.month.from_now
end
diff --git a/core/spec/lib/tasks/core_spec.rb b/core/spec/lib/tasks/core_spec.rb
new file mode 100644
index 0000000000..d6f972f91d
--- /dev/null
+++ b/core/spec/lib/tasks/core_spec.rb
@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+describe 'core:activate_products' do
+ include_context 'rake'
+
+ let(:product) { create(:product) }
+
+ describe '#prerequisites' do
+ it { expect(subject.prerequisites).to include('environment') }
+ end
+
+ it 'draft, available_on in the past -> active' do
+ product.update(status: 'draft', available_on: 1.day.ago)
+ subject.invoke
+ expect(product.reload.status).to eq('active')
+ end
+
+ it 'draft, available_on in the future -> draft' do
+ product.update(status: 'draft', available_on: 1.day.from_now)
+ subject.invoke
+ expect(product.reload.status).to eq('draft')
+ end
+
+ it 'archived, available_on in the past -> archived' do
+ product.update(status: 'archived', available_on: 1.day.ago)
+ subject.invoke
+ expect(product.reload.status).to eq('archived')
+ end
+
+ it 'archived, available_on in the future -> archived' do
+ product.update(status: 'archived', available_on: 1.day.from_now)
+ subject.invoke
+ expect(product.reload.status).to eq('archived')
+ end
+end
+
+describe 'core:archive_products' do
+ include_context 'rake'
+
+ let(:product) { create(:product) }
+
+ describe '#prerequisites' do
+ it { expect(subject.prerequisites).to include('environment') }
+ end
+
+ it 'draft, discontinue_on in the past -> archived' do
+ product.update(status: 'draft', discontinue_on: 1.day.ago)
+ subject.invoke
+ expect(product.reload.status).to eq('archived')
+ end
+
+ it 'draft, discontinue_on in the future -> draft' do
+ product.update(status: 'draft', discontinue_on: 1.day.from_now)
+ subject.invoke
+ expect(product.reload.status).to eq('draft')
+ end
+
+ it 'active, discontinue_on in the past -> archived' do
+ product.update(status: 'active', discontinue_on: 1.day.ago)
+ subject.invoke
+ expect(product.reload.status).to eq('archived')
+ end
+
+ it 'active, discontinue_on in the future -> active' do
+ product.update(status: 'active', discontinue_on: 1.day.from_now)
+ subject.invoke
+ expect(product.reload.status).to eq('active')
+ end
+end
diff --git a/core/spec/models/spree/product/scopes_spec.rb b/core/spec/models/spree/product/scopes_spec.rb
index 713229508b..80e1ebb909 100644
--- a/core/spec/models/spree/product/scopes_spec.rb
+++ b/core/spec/models/spree/product/scopes_spec.rb
@@ -6,7 +6,7 @@ describe 'Product scopes', type: :model do
describe '#available' do
context 'when discontinued' do
- let!(:discontinued_product) { create(:product, discontinue_on: Time.current - 1.day, stores:[store]) }
+ let!(:discontinued_product) { create(:product, status: 'archived', stores:[store]) }
it { expect(Spree::Product.available).not_to include(discontinued_product) }
end
@@ -24,7 +24,7 @@ describe 'Product scopes', type: :model do
end
context 'when not available' do
- let!(:unavailable_product) { create(:product, available_on: Time.current + 1.day,stores: [store]) }
+ let!(:unavailable_product) { create(:product, status: 'draft', stores: [store]) }
it { expect(Spree::Product.available).not_to include(unavailable_product) }
end
diff --git a/core/spec/models/spree/product_spec.rb b/core/spec/models/spree/product_spec.rb
index 50150e1f42..0f0f2eddde 100644
--- a/core/spec/models/spree/product_spec.rb
+++ b/core/spec/models/spree/product_spec.rb
@@ -169,19 +169,11 @@ describe Spree::Product, type: :model do
end
context '#available?' do
- it 'is available if date is in the past' do
- product.available_on = 1.day.ago
+ it 'is available if status is set to active' do
+ product.status = 'active'
expect(product).to be_available
end
- it 'is not available if date is nil or in the future' do
- product.available_on = nil
- expect(product).not_to be_available
-
- product.available_on = 1.day.from_now
- expect(product).not_to be_available
- end
-
it 'is not available if destroyed' do
product.destroy
expect(product).not_to be_available
@@ -605,6 +597,12 @@ describe Spree::Product, type: :model do
expect(product.discontinued?).to be(true)
end
+ it 'sets the status to archived' do
+ product.discontinue!
+ product.reload
+ expect(product.status).to eq('archived')
+ end
+
it 'changes updated_at' do
Timecop.scale(1000) do
expect { product.discontinue! }.to change(product, :updated_at)
diff --git a/sample/db/samples/products.rb b/sample/db/samples/products.rb
index 60b4076450..bd852698ea 100644
--- a/sample/db/samples/products.rb
+++ b/sample/db/samples/products.rb
@@ -23,6 +23,7 @@ PRODUCTS.each do |(parent_name, taxon_name, product_name)|
product.price = rand(10...100) + 0.99
product.description = FFaker::Lorem.paragraph
product.available_on = Time.zone.now
+ product.status = 'active'
if parent_name == 'Women' and %w[Dresses Skirts].include?(taxon_name)
product.option_types = [color, length, size]
else