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.
Ruby b2b-commercee-commerceecommerceecommerce-apiecommerce-frameworkecommerce-platformheadlessheadless-commerceheadless-ecommercemarketplacemulti-tenantmulti-vendormulti-vendor-ecommerceopen-sourcespree-commerce
Setup Storefront gem skeleton (#12297)
Damian Legawiec50e149a7e8a2
diff --git a/Rakefile b/Rakefileindex 8e4e82f3d8..f0ba487137 100644--- a/Rakefile+++ b/Rakefile@@ -92,7 +92,7 @@ enddesc "Creates a sandbox application for simulating the Spree code in a deployed Rails app"task :sandbox do- Bundler.with_clean_env do+ Bundler.with_unbundled_env doexec("bin/sandbox.sh")endenddiff --git a/bin/build-ci.rb b/bin/build-ci.rbindex 40a4772aa0..e385a018cd 100755--- a/bin/build-ci.rb+++ b/bin/build-ci.rb@@ -21,7 +21,7 @@ class Project@name = nameend- ALL = %w[emails api core sample admin].map(&method(:new)).freeze+ ALL = %w[emails api core sample admin storefront].map(&method(:new)).freezeCORE_GEMS = %w[api core].freeze# Install subprojectdiff --git a/bin/sandbox.sh b/bin/sandbox.shindex 69628d3d81..97310dd405 100755--- a/bin/sandbox.sh+++ b/bin/sandbox.sh@@ -39,8 +39,7 @@ gem 'spree', path: '..'gem 'spree_emails', path: '../emails'gem 'spree_sample', path: '../sample'gem 'spree_admin', path: '../admin'-gem 'spree_auth_devise', github: 'spree/spree_auth_devise', branch: 'main'-gem 'spree_gateway', github: 'spree/spree_gateway', branch: 'main'+gem 'spree_storefront', path: '../storefront'gem 'spree_i18n', github: 'spree-contrib/spree_i18n', branch: 'main'group :test, :development do@@ -72,6 +71,5 @@ bin/rails db:createbin/rails g spree:install --auto-accept --user_class=Spree::User --sample=truebin/rails g spree:emails:installbin/rails g spree:admin:install-bin/rails g spree:auth:install-bin/rails g spree_gateway:install+bin/rails g spree:storefront:installbin/rake acts_as_taggable_on_engine:install:migrationsdiff --git a/core/lib/spree/core/components.rb b/core/lib/spree/core/components.rbindex 0bd46cf5dd..e2997236a1 100644--- a/core/lib/spree/core/components.rb+++ b/core/lib/spree/core/components.rb@@ -16,7 +16,7 @@ module Spreeenddef self.frontend_available?- @@frontend_available ||= ::Rails::Engine.subclasses.map(&:instance).map { |e| e.class.to_s }.include?('Spree::Frontend::Engine')+ @@frontend_available ||= ::Rails::Engine.subclasses.map(&:instance).map { |e| e.class.to_s }.include?('Spree::Storefront::Engine')enddef self.emails_available?diff --git a/storefront/Gemfile b/storefront/Gemfilenew file mode 100644index 0000000000..1dc0e76e77--- /dev/null+++ b/storefront/Gemfile@@ -0,0 +1,11 @@+eval_gemfile('../common_spree_dependencies.rb')++gem 'spree_core', path: '../core'+gem 'spree_api', path: '../api'+gem 'spree_emails', path: '../emails'++group :test, :development do+ gem 'selenium-webdriver'+end++gemspecdiff --git a/storefront/LICENSE.md b/storefront/LICENSE.mdnew file mode 100644index 0000000000..c26a6dc657--- /dev/null+++ b/storefront/LICENSE.md@@ -0,0 +1,13 @@+# License++Copyright © 2024-present, Vendo Connect Inc.++This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.++This program is distributed in the hope that it will be useful,+but WITHOUT ANY WARRANTY; without even the implied warranty of+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the+GNU Affero General Public License for more details.++You should have received a copy of the GNU Affero General Public License+along with this program. If not, see [https://www.gnu.org/licenses/](https://www.gnu.org/licenses/).\ No newline at end of filediff --git a/storefront/Rakefile b/storefront/Rakefilenew file mode 100644index 0000000000..7cc76207b3--- /dev/null+++ b/storefront/Rakefile@@ -0,0 +1,15 @@+require 'rubygems'+require 'rake'+require 'rake/testtask'+require 'rspec/core/rake_task'+require 'spree/testing_support/common_rake'++RSpec::Core::RakeTask.new++task default: :spec++desc "Generates a dummy app for testing"+task :test_app do+ ENV['LIB_NAME'] = 'spree/storefront'+ Rake::Task['common:test_app'].invoke+enddiff --git a/storefront/config/imprtmap.rb b/storefront/config/imprtmap.rbnew file mode 100644index 0000000000..f25a79e2af--- /dev/null+++ b/storefront/config/imprtmap.rb@@ -0,0 +1,8 @@+pin "application-spree-storefront", to: "spree/storefront/application.js", preload: true+pin "@hotwired/turbo-rails", to: "turbo.min.js", preload: true+pin "@hotwired/stimulus", to: "stimulus.min.js", preload: true+pin "@hotwired/stimulus-loading", to: "stimulus-loading.js", preload: true+pin "@rails/request.js", to: "requestjs.js", preload: true++pin_all_from Spree::Storefront::Engine.root.join("app/javascript/spree/storefront/controllers"), under: "controllers", to: "spree/storefront/controllers"+pin_all_from Spree::Storefront::Engine.root.join("app/javascript/spree/storefront/helpers"), under: "helpers", to: "spree/storefront/helpers"diff --git a/storefront/config/initializers/assets.rb b/storefront/config/initializers/assets.rbnew file mode 100644index 0000000000..4eaeb7cb20--- /dev/null+++ b/storefront/config/initializers/assets.rb@@ -0,0 +1 @@+Rails.application.config.assets.precompile << 'spree_storefront_manifest.js'diff --git a/storefront/config/initializers/heroicon.rb b/storefront/config/initializers/heroicon.rbnew file mode 100644index 0000000000..ab8849d673--- /dev/null+++ b/storefront/config/initializers/heroicon.rb@@ -0,0 +1,10 @@+# frozen_string_literal: true++Heroicon.configure do |config|+ config.variant = :solid # Options are :solid, :outline and :mini++ ##+ # You can set a default class, which will get applied to every icon with+ # the given variant. To do so, un-comment the line below.+ config.default_class = {solid: "h-5 w-5 mr-2", outline: "h-6 w-6 mr-2", mini: "h-4 w-4 mr-1"}+enddiff --git a/storefront/config/locales/en.yml b/storefront/config/locales/en.ymlnew file mode 100644index 0000000000..ce4d630f50--- /dev/null+++ b/storefront/config/locales/en.yml@@ -0,0 +1,4 @@+en:+ spree:+ storefront:+\ No newline at end of filediff --git a/storefront/config/routes.rb b/storefront/config/routes.rbnew file mode 100644index 0000000000..c95c5c1ef5--- /dev/null+++ b/storefront/config/routes.rb@@ -0,0 +1,2 @@+Spree::Core::Engine.add_routes do+enddiff --git a/storefront/lib/generators/install/install_generator.rb b/storefront/lib/generators/install/install_generator.rbnew file mode 100644index 0000000000..52a42bb557--- /dev/null+++ b/storefront/lib/generators/install/install_generator.rb@@ -0,0 +1,20 @@+module Spree+ module Storefront+ module Generators+ class InstallGenerator < Rails::Generators::Base+ desc 'Installs Spree Storefront'++ def self.source_paths+ [+ File.expand_path('templates', __dir__),+ File.expand_path('../templates', "../#{__FILE__}"),+ File.expand_path('../templates', "../../#{__FILE__}")+ ]+ end++ def install+ end+ end+ end+ end+enddiff --git a/storefront/lib/spree/storefront.rb b/storefront/lib/spree/storefront.rbnew file mode 100644index 0000000000..963e76f580--- /dev/null+++ b/storefront/lib/spree/storefront.rb@@ -0,0 +1,19 @@+require 'spree_core'+require 'spree_api'++require 'sprockets/railtie'++require 'active_link_to'+require 'canonical-rails'+require 'heroicon'+require 'geared_pagination'+require 'importmap-rails'+require 'inline_svg'+require 'local_time'+require 'mail_form'+require 'payment_icons'+require 'stimulus-rails'+require 'tailwindcss-rails'+require 'turbo-rails'++require 'spree/storefront/engine'diff --git a/storefront/lib/spree/storefront/engine.rb b/storefront/lib/spree/storefront/engine.rbnew file mode 100644index 0000000000..324492c470--- /dev/null+++ b/storefront/lib/spree/storefront/engine.rb@@ -0,0 +1,22 @@+require_relative 'runtime_configuration'++module Spree+ module Storefront+ class Engine < ::Rails::Engine+ initializer 'spree.storefront.configuration', before: :load_config_initializers do |_app|+ Spree::Storefront::RuntimeConfig = Spree::Storefront::RuntimeConfiguration.new+ end++ initializer 'spree.storefront.assets' do |app|+ app.config.assets.paths << root.join('app/javascript')+ app.config.assets.precompile += %w[ spree_storefront_manifest ]+ end++ initializer 'spree.storefront.importmap', before: 'importmap' do |app|+ app.config.importmap.paths << root.join('config/importmap.rb')+ # https://github.com/rails/importmap-rails?tab=readme-ov-file#sweeping-the-cache-in-development-and-test+ app.config.importmap.cache_sweepers << root.join('app/javascript')+ end+ end+ end+enddiff --git a/storefront/lib/spree/storefront/runtime_configuration.rb b/storefront/lib/spree/storefront/runtime_configuration.rbnew file mode 100644index 0000000000..3ab192b0f3--- /dev/null+++ b/storefront/lib/spree/storefront/runtime_configuration.rb@@ -0,0 +1,6 @@+module Spree+ module Storefront+ class RuntimeConfiguration < ::Spree::Preferences::RuntimeConfiguration+ end+ end+enddiff --git a/storefront/lib/spree/storefront/testing_support/capybara_utils.rb b/storefront/lib/spree/storefront/testing_support/capybara_utils.rbnew file mode 100644index 0000000000..dcf6601aad--- /dev/null+++ b/storefront/lib/spree/storefront/testing_support/capybara_utils.rb@@ -0,0 +1,13 @@+module Spree+ module Storefront+ module TestingSupport+ module CapybaraUtils+ def wait_for_turbo(timeout = nil)+ if has_css?('.turbo-progress-bar', visible: true, wait: 1.seconds)+ has_no_css?('.turbo-progress-bar', wait: timeout.presence || 5.seconds)+ end+ end+ end+ end+ end+enddiff --git a/storefront/lib/spree_storefront.rb b/storefront/lib/spree_storefront.rbnew file mode 100644index 0000000000..a1997cffb3--- /dev/null+++ b/storefront/lib/spree_storefront.rb@@ -0,0 +1 @@+require 'spree/storefront'diff --git a/storefront/spec/spec_helper.rb b/storefront/spec/spec_helper.rbnew file mode 100644index 0000000000..7cff22cbde--- /dev/null+++ b/storefront/spec/spec_helper.rb@@ -0,0 +1,111 @@+if ENV['COVERAGE']+ # Run Coverage report+ require 'simplecov'+ SimpleCov.start 'rails' do+ add_group 'Libraries', 'lib/spree'++ add_filter '/bin/'+ add_filter '/db/'+ add_filter '/script/'+ add_filter '/spec/'+ add_filter '/lib/generators/'++ coverage_dir "#{ENV['COVERAGE_DIR']}/storefront" if ENV['COVERAGE_DIR']+ end+end++# This file is copied to ~/spec when you run 'ruby script/generate rspec'+# from the project root directory.+ENV['RAILS_ENV'] ||= 'test'+++begin+ require File.expand_path('../dummy/config/environment', __FILE__)+rescue LoadError+ puts 'Could not load dummy application. Please ensure you have run `bundle exec rake test_app`'+ exit+end++require 'rspec/rails'++# Requires supporting files with custom matchers and macros, etc,+# in ./support/ and its subdirectories.+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }++require 'database_cleaner/active_record'+require 'ffaker'++require 'spree/testing_support/authorization_helpers'+require 'spree/testing_support/factories'+require 'spree/testing_support/preferences'+require 'spree/testing_support/jobs'+require 'spree/testing_support/store'+require 'spree/testing_support/controller_requests'+require 'spree/testing_support/url_helpers'+require 'spree/testing_support/order_walkthrough'+require 'spree/storefront/testing_support/capybara_utils'+require 'spree/testing_support/capybara_config'+require 'spree/testing_support/rspec_retry_config'+require 'spree/testing_support/image_helpers'++require 'spree/core/controller_helpers/strong_parameters'++RSpec.configure do |config|+ config.color = true+ config.default_formatter = 'doc'+ config.fail_fast = ENV['FAIL_FAST'] || false+ config.infer_spec_type_from_file_location!+ config.mock_with :rspec+ config.raise_errors_for_deprecations!++ # If you're not using ActiveRecord, or you'd prefer not to run each of your+ # examples within a transaction, comment the following line or assign false+ # instead of true.+ config.use_transactional_fixtures = false++ config.before(:suite) do+ Capybara.match = :smart+ Capybara.javascript_driver = :selenium_chrome+ Capybara.default_max_wait_time = 10+ Capybara.raise_server_errors = false+ # Clean out the database state before the tests run+ DatabaseCleaner.strategy = :transaction+ DatabaseCleaner.clean_with(:truncation)+ end++ config.around(:each) do |example|+ DatabaseCleaner.cleaning do+ example.run+ end+ end++ config.before(:each) do+ begin+ Rails.cache.clear+ reset_spree_preferences+ rescue Errno::ENOTEMPTY+ end+ end++ config.around(:each) do |example|+ DatabaseCleaner.cleaning do+ example.run+ end+ end++ config.include FactoryBot::Syntax::Methods++ config.include Spree::Storefront::TestingSupport::CapybaraUtils+ config.include Spree::TestingSupport::Preferences+ config.include Spree::TestingSupport::UrlHelpers+ config.include Spree::TestingSupport::ControllerRequests, type: :controller+ config.include Spree::TestingSupport::ImageHelpers++ config.include Spree::Core::ControllerHelpers::StrongParameters, type: :controller++ config.order = :random+ Kernel.srand config.seed++ config.filter_run_including focus: true unless ENV['CI']+ config.run_all_when_everything_filtered = true+enddiff --git a/storefront/spree_storefront.gemspec b/storefront/spree_storefront.gemspecnew file mode 100644index 0000000000..965a761eeb--- /dev/null+++ b/storefront/spree_storefront.gemspec@@ -0,0 +1,45 @@+# encoding: UTF-8++require_relative '../core/lib/spree/core/version.rb'++Gem::Specification.new do |s|+ s.platform = Gem::Platform::RUBY+ s.name = 'spree_storefront'+ s.version = Spree.version+ s.authors = ['Vendo Connect Inc.']+ s.email = '[email protected]'+ s.summary = 'Modern fully featured storefront and checkout for Spree Commerce'+ s.description = 'Modern fully featured storefront and checkout for Spree Commerce'+ s.homepage = 'https://getvendo.com'+ s.license = 'AGPL-3.0-or-later'++ s.metadata = {+ "bug_tracker_uri" => "https://github.com/spree/spree/issues",+ "changelog_uri" => "https://github.com/spree/spree/releases/tag/v#{s.version}",+ "documentation_uri" => "https://docs.spreecommerce.org/",+ "source_code_uri" => "https://github.com/spree/spree/tree/v#{s.version}",+ }++ s.required_ruby_version = '>= 3.0'+ s.required_rubygems_version = '>= 1.8.23'++ s.files = `git ls-files`.split("\n").reject { |f| f.match(/^spec/) && !f.match(/^spec\/fixtures/) }+ s.require_path = 'lib'++ s.add_dependency 'spree_core', ">= #{s.version}"+ s.add_dependency 'spree_api', ">= #{s.version}"++ s.add_dependency 'active_link_to'+ s.add_dependency 'canonical-rails', '~> 0.2.14'+ s.add_dependency 'geared_pagination'+ s.add_dependency 'heroicon'+ s.add_dependency 'importmap-rails'+ s.add_dependency 'inline_svg', '~> 1.5'+ s.add_dependency 'local_time', '~> 3.0'+ s.add_dependency 'mail_form'+ s.add_dependency 'payment_icons'+ s.add_dependency 'sprockets', '>= 4.0'+ s.add_dependency 'stimulus-rails'+ s.add_dependency 'tailwindcss-rails'+ s.add_dependency 'turbo-rails'+end