Ensure db:seed runs before spree_sample:load

Author: lsizani

core/lib/generators/solidus/install/install_generator.rb

@@ -37,7 +37,7 @@ class InstallGenerator < Rails::Generators::AppBase
 
     class_option :migrate, type: :boolean, default: true, banner: 'Run Solidus migrations'
     class_option :seed, type: :boolean, default: true, banner: 'Load seed data (migrations must be run)'
-    class_option :sample, type: :boolean, default: true, banner: 'Load sample data (migrations and seeds must be run)'
+    class_option :sample, type: :boolean, default: true, banner: 'Load sample data (migrations must be run)'
     class_option :active_storage, type: :boolean, default: (
       Rails.gem_version >= Gem::Version.new("6.1.0")
     ), banner: 'Install ActiveStorage as image attachments handler for products and taxons'
@@ -64,7 +64,7 @@ def self.exit_on_failure?
     def prepare_options
       @run_migrations = options[:migrate]
       @load_seed_data = options[:seed] && @run_migrations
-      @load_sample_data = options[:sample] && @run_migrations && @load_seed_data
+      @load_sample_data = options[:sample] && @run_migrations
       @selected_frontend = detect_frontend_to_install
       @selected_authentication = detect_authentication_to_install
       @selected_payment_method = detect_payment_method_to_install

core/spec/generators/solidus/install/install_generator_spec.rb

@@ -72,15 +72,6 @@
       expect(generator.instance_variable_get(:@load_sample_data)).to eq(false)
     end
 
-    it 'skips sample data if seeds are disabled' do
-      generator = described_class.new([], ['--auto-accept', '--seed=false'])
-      generator.prepare_options
-
-      expect(generator.instance_variable_get(:@run_migrations)).to eq(true)
-      expect(generator.instance_variable_get(:@load_seed_data)).to eq(false)
-      expect(generator.instance_variable_get(:@load_sample_data)).to eq(false)
-    end
-
     context 'supports legacy frontend option names' do
       it 'transform "solidus_frontend" into "classic"' do
         generator = described_class.new([], ['--auto-accept', '--frontend=solidus_frontend'])

sample/db/samples/shipping_methods.rb

@@ -3,8 +3,11 @@
 begin
 north_america = Spree::Zone.find_by!(name: "North America")
 rescue ActiveRecord::RecordNotFound
-  puts "Couldn't find 'North America' zone. Did you run `rake db:seed` first?"
-  puts "That task will set up the countries, states and zones required for Spree."
+  puts <<~TEXT
+    Couldn't find 'North America' zone. Did you run `rake db:seed` first?
+
+    That task will set up the countries, states and zones required for your store.
+  TEXT
   exit
 end
 

sample/db/samples/tax_rates.rb

@@ -1,6 +1,16 @@
 # frozen_string_literal: true
 
-north_america = Spree::Zone.find_by!(name: "North America")
+begin
+  north_america = Spree::Zone.find_by!(name: "North America")
+rescue ActiveRecord::RecordNotFound
+  puts <<~TEXT
+    Couldn't find 'North America' zone. Did you run `rake db:seed` first?
+
+    That task will set up the countries, states and zones required for your store.
+  TEXT
+  exit
+end
+
 clothing = Spree::TaxCategory.find_by!(name: "Default")
 tax_rate = Spree::TaxRate.create(
   name: "North America",

sample/lib/tasks/sample.rake

@@ -5,7 +5,7 @@ require 'spree/sample'
 
 namespace :spree_sample do
   desc 'Loads sample data'
-  task load: :environment do
+  task load: ['db:seed', :environment] do
     if ARGV.include?("db:migrate")
       puts <<~TEXT
         Please run db:migrate separately from spree_sample:load.

sample/spec/lib/load_sample_spec.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
+require "spec_helper"
+require "rake"
 
 describe "Load samples" do
   it "doesn't raise any error" do
@@ -9,4 +10,21 @@
       SpreeSample::Engine.load_samples
     }.to output.to_stdout
   end
+
+  it "has db:seed as a prerequisite" do
+    Rails.application.load_tasks
+
+    task = Rake::Task["spree_sample:load"]
+    seed_task = Rake::Task["db:seed"]
+    expect(task.prerequisite_tasks).to include(seed_task)
+  end
+end
+
+describe "Load seeds multiple times" do
+  it "doesn't duplicate records" do
+    3.times { Spree::Core::Engine.load_seed }
+
+    expect(Spree::Store.count).to eq(1)
+    expect(Spree::Zone.count).to eq(2)
+  end
 end