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.

Extract Storefront installer into a seperate Generator

Damian Legawiec54afe56cddb2
diff --git a/core/lib/generators/spree/install/install_generator.rb b/core/lib/generators/spree/install/install_generator.rb
index 1d6daab52d..e2ed33e407 100644
--- a/core/lib/generators/spree/install/install_generator.rb
+++ b/core/lib/generators/spree/install/install_generator.rb
@@ -10,7 +10,8 @@ module Spree
class_option :migrate, type: :boolean, default: true, banner: 'Run Spree 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 must be run)'
- class_option :copy_storefront, type: :boolean, default: true, banner: 'copy storefront from spree frontend to your application for easy customization'
+ class_option :install_storefront, type: :boolean, default: true, banner: 'installs storefront configuration files'
+ class_option :copy_storefront, type: :boolean, default: false, banner: 'copy all storefront views and stylesheets'
class_option :auto_accept, type: :boolean
class_option :user_class, type: :string
class_option :admin_email, type: :string
@@ -23,11 +24,6 @@ module Spree
paths << File.expand_path('../templates', "../../#{__FILE__}")
paths << File.expand_path('../templates', "../#{__FILE__}")
paths << File.expand_path('templates', __dir__)
- if Spree::Core::Engine.frontend_available? || Rails.env.test?
- paths << File.expand_path('../../../../../frontend/app/views/spree', __dir__)
- paths << File.expand_path('../../../../../frontend/app/assets/images', __dir__)
- paths << File.expand_path('../../../../../frontend/app/assets/stylesheets/spree/frontend/variables', __dir__)
- end
paths.flatten
end
@@ -35,6 +31,7 @@ module Spree
@run_migrations = options[:migrate]
@load_seed_data = options[:seed]
@load_sample_data = options[:sample]
+ @install_storefront = options[:install_storefront]
@copy_storefront = options[:copy_storefront]
unless @run_migrations
@@ -45,21 +42,6 @@ module Spree
def add_files
template 'config/initializers/spree.rb', 'config/initializers/spree.rb'
-
- # copy essential storefront files for easy customization / theming
- if Spree::Core::Engine.frontend_available? || Rails.env.test?
- # main navigation configuration
- template 'config/initializers/spree_storefront.rb', 'config/initializers/spree_storefront.rb'
- template 'config/spree_storefront.yml', 'config/spree_storefront.yml'
- # static images
- directory 'noimage', './app/assets/images/noimage'
- directory 'homepage', './app/assets/images/homepage'
- directory 'meganav', './app/assets/images/meganav'
- # SCSS theming
- template 'variables.scss', './app/assets/stylesheets/spree/frontend/variables/variables.scss'
- # home page template
- directory 'home', './app/views/spree/home'
- end
end
def additional_tweaks
@@ -106,6 +88,12 @@ module Spree
empty_directory 'app/overrides'
end
+ def install_storefront
+ if @install_storefront && Spree::Core::Engine.frontend_available?
+ generate 'spree:frontend:install'
+ end
+ end
+
def copy_storefront
if @copy_storefront && Spree::Core::Engine.frontend_available?
generate 'spree:frontend:copy_storefront'
diff --git a/core/lib/spree/testing_support/common_rake.rb b/core/lib/spree/testing_support/common_rake.rb
index eb26630428..f9eb2e6227 100644
--- a/core/lib/spree/testing_support/common_rake.rb
+++ b/core/lib/spree/testing_support/common_rake.rb
@@ -15,7 +15,7 @@ namespace :common do
Rails.env = 'test'
Spree::DummyGenerator.start ["--lib_name=#{ENV['LIB_NAME']}", '--quiet']
- Spree::InstallGenerator.start ["--lib_name=#{ENV['LIB_NAME']}", '--auto-accept', '--migrate=false', '--seed=false', '--sample=false', '--quiet', '--copy_storefront=false', "--user_class=#{args[:user_class]}"]
+ Spree::InstallGenerator.start ["--lib_name=#{ENV['LIB_NAME']}", '--auto-accept', '--migrate=false', '--seed=false', '--sample=false', '--quiet', '--copy_storefront=false', '--install_storefront=false', "--user_class=#{args[:user_class]}"]
puts 'Setting up dummy database...'
system("bundle exec rake db:drop db:create > #{File::NULL}")
diff --git a/frontend/lib/generators/spree/frontend/copy_storefront/copy_storefront_generator.rb b/frontend/lib/generators/spree/frontend/copy_storefront/copy_storefront_generator.rb
index a159b5ec6d..afa40bfc49 100644
--- a/frontend/lib/generators/spree/frontend/copy_storefront/copy_storefront_generator.rb
+++ b/frontend/lib/generators/spree/frontend/copy_storefront/copy_storefront_generator.rb
@@ -1,7 +1,7 @@
module Spree
module Frontend
class CopyStorefrontGenerator < Rails::Generators::Base
- desc 'Copies storefront views and stylesheets from spree frontend to your application'
+ desc 'Copies all storefront views and stylesheets from spree frontend to your application'
def self.source_paths
[
diff --git a/frontend/lib/generators/spree/frontend/install/install_generator.rb b/frontend/lib/generators/spree/frontend/install/install_generator.rb
new file mode 100644
index 0000000000..862fa32b41
--- /dev/null
+++ b/frontend/lib/generators/spree/frontend/install/install_generator.rb
@@ -0,0 +1,34 @@
+module Spree
+ module Frontend
+ module Generators
+ class InstallGenerator < Rails::Generators::Base
+ desc 'Copies storefront configuration files for easy customization'
+
+ def self.source_paths
+ [
+ File.expand_path('templates', __dir__),
+ File.expand_path('../templates', "../#{__FILE__}"),
+ File.expand_path('../templates', "../../#{__FILE__}"),
+ File.expand_path('../../../../../app/views/spree', __dir__),
+ File.expand_path('../../../../../app/assets/images', __dir__),
+ File.expand_path('../../../../../app/assets/stylesheets/spree/frontend/variables', __dir__)
+ ]
+ end
+
+ def install
+ # main navigation configuration
+ template 'config/initializers/spree_storefront.rb', 'config/initializers/spree_storefront.rb'
+ template 'config/spree_storefront.yml', 'config/spree_storefront.yml'
+ # static images
+ directory 'noimage', './app/assets/images/noimage'
+ directory 'homepage', './app/assets/images/homepage'
+ directory 'meganav', './app/assets/images/meganav'
+ # SCSS theming
+ template 'variables.scss', './app/assets/stylesheets/spree/frontend/variables/variables.scss'
+ # home page template
+ directory 'home', './app/views/spree/home'
+ end
+ end
+ end
+ end
+end
diff --git a/core/lib/generators/spree/install/templates/config/initializers/spree_storefront.rb b/frontend/lib/generators/spree/frontend/install/templates/config/initializers/spree_storefront.rb
similarity index 100%
rename from core/lib/generators/spree/install/templates/config/initializers/spree_storefront.rb
rename to frontend/lib/generators/spree/frontend/install/templates/config/initializers/spree_storefront.rb
diff --git a/core/lib/generators/spree/install/templates/config/spree_storefront.yml b/frontend/lib/generators/spree/frontend/install/templates/config/spree_storefront.yml
similarity index 100%
rename from core/lib/generators/spree/install/templates/config/spree_storefront.yml
rename to frontend/lib/generators/spree/frontend/install/templates/config/spree_storefront.yml