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.

Move Spree Seeds into their own services to allow easier customization (#11344)

Damian Legawiecffc2f3e8ee78
diff --git a/core/app/services/spree/seeds/all.rb b/core/app/services/spree/seeds/all.rb
new file mode 100644
index 0000000000..f25b75dc33
--- /dev/null
+++ b/core/app/services/spree/seeds/all.rb
@@ -0,0 +1,17 @@
+module Spree
+ module Seeds
+ class All
+ prepend Spree::ServiceModule::Base
+
+ def call
+ Countries.call
+ DefaultReimbursementType.call
+ Roles.call
+ States.call
+ StoreCreditCategories.call
+ Stores.call
+ Zones.call
+ end
+ end
+ end
+end
diff --git a/core/app/services/spree/seeds/countries.rb b/core/app/services/spree/seeds/countries.rb
new file mode 100644
index 0000000000..14a12c96a9
--- /dev/null
+++ b/core/app/services/spree/seeds/countries.rb
@@ -0,0 +1,34 @@
+require 'carmen'
+
+module Spree
+ module Seeds
+ class Countries
+ prepend Spree::ServiceModule::Base
+
+ EXCLUDED_COUNTRIES = ['AQ', 'AX', 'GS', 'UM', 'HM', 'IO', 'EH', 'BV', 'TF'].freeze
+
+ def call
+ ApplicationRecord.transaction do
+ Carmen::Country.all.each do |country|
+ # Skip the creation of some territories, uninhabited islands and the Antarctic.
+ next if EXCLUDED_COUNTRIES.include?(country.alpha_2_code)
+
+ Spree::Country.where(
+ name: country.name,
+ iso3: country.alpha_3_code,
+ iso: country.alpha_2_code,
+ iso_name: country.name.upcase,
+ numcode: country.numeric_code
+ ).first_or_create
+ end
+
+ # Find countries that do not use postal codes (by iso) and set 'zipcode_required' to false for them.
+ Spree::Country.where(iso: Spree::Address::NO_ZIPCODE_ISO_CODES).update_all(zipcode_required: false)
+
+ # Find all countries that require a state (province) at checkout and set 'states_required' to true.
+ Spree::Country.where(iso: Spree::Address::STATES_REQUIRED).update_all(states_required: true)
+ end
+ end
+ end
+ end
+end
diff --git a/core/app/services/spree/seeds/default_reimbursement_type.rb b/core/app/services/spree/seeds/default_reimbursement_type.rb
new file mode 100644
index 0000000000..43c5697f61
--- /dev/null
+++ b/core/app/services/spree/seeds/default_reimbursement_type.rb
@@ -0,0 +1,12 @@
+module Spree
+ module Seeds
+ class DefaultReimbursementType
+ prepend Spree::ServiceModule::Base
+
+ def call
+ # FIXME: we should use translations here
+ Spree::RefundReason.find_or_create_by!(name: 'Return processing', mutable: false)
+ end
+ end
+ end
+end
diff --git a/core/app/services/spree/seeds/roles.rb b/core/app/services/spree/seeds/roles.rb
new file mode 100644
index 0000000000..cff1c50d93
--- /dev/null
+++ b/core/app/services/spree/seeds/roles.rb
@@ -0,0 +1,14 @@
+module Spree
+ module Seeds
+ class Roles
+ prepend Spree::ServiceModule::Base
+
+ EXCLUDED_COUNTRIES = ['AQ', 'AX', 'GS', 'UM', 'HM', 'IO', 'EH', 'BV', 'TF'].freeze
+
+ def call
+ Spree::Role.where(name: 'admin').first_or_create
+ Spree::Role.where(name: 'user').first_or_create
+ end
+ end
+ end
+end
diff --git a/core/app/services/spree/seeds/states.rb b/core/app/services/spree/seeds/states.rb
new file mode 100644
index 0000000000..9a77542408
--- /dev/null
+++ b/core/app/services/spree/seeds/states.rb
@@ -0,0 +1,61 @@
+require 'carmen'
+
+module Spree
+ module Seeds
+ class States
+ prepend Spree::ServiceModule::Base
+
+ EXCLUDED_US_STATES = ['UM', 'AS', 'MP', 'VI', 'PR', 'GU'].freeze
+ EXCLUDED_CN_STATES = ['HK', 'MO', 'TW'].freeze
+
+ def call
+ Spree::Country.where(states_required: true).each do |country|
+ carmen_country = Carmen::Country.named(country.name)
+ next unless carmen_country
+
+ carmen_country.subregions.each do |subregion|
+ if carmen_country.alpha_2_code == 'US'
+ # Produces 50 states, one postal district (Washington DC)
+ # and 3 APO's as you would expect to see on any good U.S. states list.
+ next if EXCLUDED_US_STATES.include?(subregion.code)
+
+ state_level(country, subregion)
+ elsif carmen_country.alpha_2_code == 'CA' || carmen_country.alpha_2_code == 'MX'
+ # Force Canada and Mexico to use state-level data import from Carmen Gem
+ # else we pull in a subset of provinces that are not common at checkout.
+ state_level(country, subregion)
+ elsif carmen_country.alpha_2_code == 'CN'
+ # Removes 3 "States" from that list that are also listed as Countries,
+ # Hong Kong, Taiwan and Macao
+ next if EXCLUDED_CN_STATES.include?(subregion.code)
+
+ state_level(country, subregion)
+ elsif subregion.subregions?
+ province_level(country, subregion)
+ else
+ state_level(country, subregion)
+ end
+ end
+ end
+ end
+
+ protected
+
+ def state_level(country, subregion)
+ country.states.where(
+ name: subregion.name,
+ abbr: subregion.code
+ ).first_or_create
+ end
+
+ def province_level(country, subregion)
+ subregion.subregions.each do |province|
+ country.states.where(
+ name: province.name,
+ abbr: province.code
+ ).first_or_create
+ end
+ end
+ end
+ end
+end
diff --git a/core/app/services/spree/seeds/store_credit_categories.rb b/core/app/services/spree/seeds/store_credit_categories.rb
new file mode 100644
index 0000000000..5c5a2ab49b
--- /dev/null
+++ b/core/app/services/spree/seeds/store_credit_categories.rb
@@ -0,0 +1,12 @@
+module Spree
+ module Seeds
+ class StoreCreditCategories
+ prepend Spree::ServiceModule::Base
+
+ def call
+ # FIXME: we should use translations here
+ Spree::StoreCreditCategory.find_or_create_by!(name: 'Default')
+ end
+ end
+ end
+end
diff --git a/core/app/services/spree/seeds/stores.rb b/core/app/services/spree/seeds/stores.rb
new file mode 100644
index 0000000000..ca932fa793
--- /dev/null
+++ b/core/app/services/spree/seeds/stores.rb
@@ -0,0 +1,31 @@
+module Spree
+ module Seeds
+ class Stores
+ prepend Spree::ServiceModule::Base
+
+ def call
+ default_store = Spree::Store.default
+
+ if default_store.persisted?
+ default_store.update!(default_country_id: Spree::Config[:default_country_id])
+ else
+ Spree::Store.new do |s|
+ s.name = 'Spree Demo Site'
+ s.code = 'spree'
+ s.url = Rails.application.routes.default_url_options[:host] || 'demo.spreecommerce.org'
+ s.mail_from_address = '[email protected]'
+ s.customer_support_email = '[email protected]'
+ s.default_currency = 'USD'
+ s.default_country_id = Spree::Config[:default_country_id]
+ s.default_locale = I18n.locale
+ s.seo_title = 'Spree Commerce Demo Shop'
+ s.meta_description = 'This is the new Spree UX DEMO | OVERVIEW: http://bit.ly/new-spree-ux | DOCS: http://bit.ly/spree-ux-customization-docs | CONTACT: https://spreecommerce.org/contact/'
+ s.facebook = 'spreecommerce'
+ s.twitter = 'spreecommerce'
+ s.instagram = 'spreecommerce'
+ end.save!
+ end
+ end
+ end
+ end
+end
diff --git a/core/app/services/spree/seeds/zones.rb b/core/app/services/spree/seeds/zones.rb
new file mode 100644
index 0000000000..2539173b0e
--- /dev/null
+++ b/core/app/services/spree/seeds/zones.rb
@@ -0,0 +1,39 @@
+module Spree
+ module Seeds
+ class Zones
+ prepend Spree::ServiceModule::Base
+
+ def call
+ eu_vat = Spree::Zone.where(name: 'EU_VAT', description: 'Countries that make up the EU VAT zone.', kind: 'country').first_or_create!
+ uk_vat = Spree::Zone.where(name: 'UK_VAT', kind: 'country').first_or_create!
+ north_america = Spree::Zone.where(name: 'North America', description: 'USA + Canada', kind: 'country').first_or_create!
+ south_america = Spree::Zone.where(name: 'South America', description: 'South America', kind: 'country').first_or_create!
+ middle_east = Spree::Zone.where(name: 'Middle East', description: 'Middle East', kind: 'country').first_or_create!
+ asia = Spree::Zone.where(name: 'Asia', description: 'Asia', kind: 'country').first_or_create!
+
+ %w(PL FI PT RO DE FR SK HU SI IE AT ES IT BE SE LV BG LT CY LU MT DK NL EE HR CZ GR).each do |name|
+ eu_vat.zone_members.where(zoneable: Spree::Country.find_by!(iso: name)).first_or_create!
+ end
+
+ uk_vat.zone_members.where(zoneable: Spree::Country.find_by(iso: 'GB')).first_or_create!
+
+ %w(US CA).each do |name|
+ north_america.zone_members.where(zoneable: Spree::Country.find_by!(iso: name)).first_or_create!
+ end
+
+ %w(BH CY EG IR IQ IL JO KW LB OM QA SA SY TR AE YE).each do |name|
+ middle_east.zone_members.where(zoneable: Spree::Country.find_by!(iso: name)).first_or_create!
+ end
+
+ %w(AF AM AZ BH BD BT BN KH CN CX CC GE HK IN ID IR IQ IL JP JO KZ KW KG LA LB MO MY MV MN MM NP
+ KP OM PK PS PH QA SA SG KR LK SY TW TJ TH TR TM AE UZ VN YE).each do |name|
+ asia.zone_members.where(zoneable: Spree::Country.find_by!(iso: name)).first_or_create!
+ end
+
+ %w(AR BO BR CL CO EC FK GF GY PY PE SR UY VE).each do |name|
+ south_america.zone_members.where(zoneable: Spree::Country.find_by!(iso: name)).first_or_create!
+ end
+ end
+ end
+ end
+end
diff --git a/core/db/default/spree/countries.rb b/core/db/default/spree/countries.rb
deleted file mode 100644
index bf6a76c901..0000000000
--- a/core/db/default/spree/countries.rb
+++ /dev/null
@@ -1,24 +0,0 @@
-require 'carmen'
-
-EXCLUDED_COUNTRIES = ['AQ', 'AX', 'GS', 'UM', 'HM', 'IO', 'EH', 'BV', 'TF'].freeze
-
-Carmen::Country.all.each do |country|
- # Skip the creation of some territories, uninhabited islands and the Antarctic.
- next if EXCLUDED_COUNTRIES.include?(country.alpha_2_code)
-
- Spree::Country.where(
- name: country.name,
- iso3: country.alpha_3_code,
- iso: country.alpha_2_code,
- iso_name: country.name.upcase,
- numcode: country.numeric_code
- ).first_or_create
-end
-
-Spree::Config[:default_country_id] = Spree::Country.find_by(iso: 'US').id
-
-# Find countries that do not use postal codes (by iso) and set 'zipcode_required' to false for them.
-Spree::Country.where(iso: Spree::Address::NO_ZIPCODE_ISO_CODES).update_all(zipcode_required: false)
-
-# Find all countries that require a state (province) at checkout and set 'states_required' to true.
-Spree::Country.where(iso: Spree::Address::STATES_REQUIRED).update_all(states_required: true)
diff --git a/core/db/default/spree/default_reimbursement_type.rb b/core/db/default/spree/default_reimbursement_type.rb
deleted file mode 100644
index 62c1e99212..0000000000
--- a/core/db/default/spree/default_reimbursement_type.rb
+++ /dev/null
@@ -1 +0,0 @@
-Spree::RefundReason.find_or_create_by!(name: 'Return processing', mutable: false)
diff --git a/core/db/default/spree/roles.rb b/core/db/default/spree/roles.rb
deleted file mode 100644
index afdffc4255..0000000000
--- a/core/db/default/spree/roles.rb
+++ /dev/null
@@ -1,2 +0,0 @@
-Spree::Role.where(name: 'admin').first_or_create
-Spree::Role.where(name: 'user').first_or_create
diff --git a/core/db/default/spree/states.rb b/core/db/default/spree/states.rb
deleted file mode 100644
index 3b2d9fc4cd..0000000000
--- a/core/db/default/spree/states.rb
+++ /dev/null
@@ -1,49 +0,0 @@
-# frozen_string_literal: true
-
-EXCLUDED_US_STATES = ['UM', 'AS', 'MP', 'VI', 'PR', 'GU'].freeze
-EXCLUDED_CN_STATES = ['HK', 'MO', 'TW'].freeze
-
-def state_level(country, subregion)
- country.states.where(
- name: subregion.name,
- abbr: subregion.code
- ).first_or_create
-end
-
-def province_level(country, subregion)
- subregion.subregions.each do |province|
- country.states.where(
- name: province.name,
- abbr: province.code
- ).first_or_create
- end
-end
-
-Spree::Country.where(states_required: true).each do |country|
- carmen_country = Carmen::Country.named(country.name)
- next unless carmen_country
-
- carmen_country.subregions.each do |subregion|
- if carmen_country.alpha_2_code == 'US'
- # Produces 50 states, one postal district (Washington DC)
- # and 3 APO's as you would expect to see on any good U.S. states list.
- next if EXCLUDED_US_STATES.include?(subregion.code)
-
- state_level(country, subregion)
- elsif carmen_country.alpha_2_code == 'CA' || carmen_country.alpha_2_code == 'MX'
- # Force Canada and Mexico to use state-level data import from Carmen Gem
- # else we pull in a subset of provinces that are not common at checkout.
- state_level(country, subregion)
- elsif carmen_country.alpha_2_code == 'CN'
- # Removes 3 "States" from that list that are also listed as Countries,
- # Hong Kong, Taiwan and Macao
- next if EXCLUDED_CN_STATES.include?(subregion.code)
-
- state_level(country, subregion)
- elsif subregion.subregions?
- province_level(country, subregion)
- else
- state_level(country, subregion)
- end
- end
-end
diff --git a/core/db/default/spree/store_credit_categories.rb b/core/db/default/spree/store_credit_categories.rb
deleted file mode 100644
index 874bb84d87..0000000000
--- a/core/db/default/spree/store_credit_categories.rb
+++ /dev/null
@@ -1 +0,0 @@
-Spree::StoreCreditCategory.find_or_create_by!(name: 'Default')
diff --git a/core/db/default/spree/stores.rb b/core/db/default/spree/stores.rb
deleted file mode 100644
index 5b8417e406..0000000000
--- a/core/db/default/spree/stores.rb
+++ /dev/null
@@ -1,21 +0,0 @@
-default_store = Spree::Store.default
-
-if default_store.persisted?
- default_store.update!(default_country_id: Spree::Config[:default_country_id])
-else
- Spree::Store.new do |s|
- s.name = 'Spree Demo Site'
- s.code = 'spree'
- s.url = Rails.application.routes.default_url_options[:host] || 'demo.spreecommerce.org'
- s.mail_from_address = '[email protected]'
- s.customer_support_email = '[email protected]'
- s.default_currency = 'USD'
- s.default_country_id = Spree::Config[:default_country_id]
- s.default_locale = I18n.locale
- s.seo_title = 'Spree Commerce Demo Shop'
- s.meta_description = 'This is the new Spree UX DEMO | OVERVIEW: http://bit.ly/new-spree-ux | DOCS: http://bit.ly/spree-ux-customization-docs | CONTACT: https://spreecommerce.org/contact/'
- s.facebook = 'spreecommerce'
- s.twitter = 'spreecommerce'
- s.instagram = 'spreecommerce'
- end.save!
-end
diff --git a/core/db/default/spree/zones.rb b/core/db/default/spree/zones.rb
deleted file mode 100644
index b5faaac010..0000000000
--- a/core/db/default/spree/zones.rb
+++ /dev/null
@@ -1,29 +0,0 @@
-eu_vat = Spree::Zone.where(name: 'EU_VAT', description: 'Countries that make up the EU VAT zone.', kind: 'country').first_or_create!
-uk_vat = Spree::Zone.where(name: 'UK_VAT', kind: 'country').first_or_create!
-north_america = Spree::Zone.where(name: 'North America', description: 'USA + Canada', kind: 'country').first_or_create!
-south_america = Spree::Zone.where(name: 'South America', description: 'South America', kind: 'country').first_or_create!
-middle_east = Spree::Zone.where(name: 'Middle East', description: 'Middle East', kind: 'country').first_or_create!
-asia = Spree::Zone.where(name: 'Asia', description: 'Asia', kind: 'country').first_or_create!
-
-%w(PL FI PT RO DE FR SK HU SI IE AT ES IT BE SE LV BG LT CY LU MT DK NL EE HR CZ GR).each do |name|
- eu_vat.zone_members.where(zoneable: Spree::Country.find_by!(iso: name)).first_or_create!
-end
-
-uk_vat.zone_members.where(zoneable: Spree::Country.find_by(iso: 'GB')).first_or_create!
-
-%w(US CA).each do |name|
- north_america.zone_members.where(zoneable: Spree::Country.find_by!(iso: name)).first_or_create!
-end
-
-%w(BH CY EG IR IQ IL JO KW LB OM QA SA SY TR AE YE).each do |name|
- middle_east.zone_members.where(zoneable: Spree::Country.find_by!(iso: name)).first_or_create!
-end
-
-%w(AF AM AZ BH BD BT BN KH CN CX CC GE HK IN ID IR IQ IL JP JO KZ KW KG LA LB MO MY MV MN MM NP
- KP OM PK PS PH QA SA SG KR LK SY TW TJ TH TR TM AE UZ VN YE).each do |name|
- asia.zone_members.where(zoneable: Spree::Country.find_by!(iso: name)).first_or_create!
-end
-
-%w(AR BO BR CL CO EC FK GF GY PY PE SR UY VE).each do |name|
- south_america.zone_members.where(zoneable: Spree::Country.find_by!(iso: name)).first_or_create!
-end
diff --git a/core/db/seeds.rb b/core/db/seeds.rb
index 456e8cadcc..1b741e2f14 100644
--- a/core/db/seeds.rb
+++ b/core/db/seeds.rb
@@ -1,5 +1 @@
-# Loads seed data out of default dir
-default_path = File.join(File.dirname(__FILE__), 'default')
-
-Rake::Task['db:load_dir'].reenable
-Rake::Task['db:load_dir'].invoke(default_path)
+Spree::Seeds::All.call