spree_storefront 5.0.0.rc1

data/lib/generators/spree/storefront/install/templates/dev

@@ -0,0 +1,16 @@
+#!/usr/bin/env sh
+
+if ! gem list foreman -i --silent; then
+  echo "Installing foreman..."
+  gem install foreman
+fi
+
+# Default to port 3000 if not specified
+export PORT="${PORT:-3000}"
+
+# Let the debug gem allow remote connections,
+# but avoid loading until `debugger` is called
+export RUBY_DEBUG_OPEN="true"
+export RUBY_DEBUG_LAZY="true"
+
+exec foreman start -f Procfile.dev "$@"

data/lib/generators/spree/storefront/install/templates/tailwind.config.js

@@ -0,0 +1,128 @@
+const defaultTheme = require('tailwindcss/defaultTheme')
+
+module.exports = {
+  content: [
+    'public/*.html',
+    'app/helpers/**/*.rb',
+    'app/javascript/**/*.js',
+    'app/views/spree/**/*.erb',
+    'app/views/devise/**/*.erb',
+    'app/views/themes/**/*.erb',
+    process.env.SPREE_STOREFRONT_PATH + '/app/helpers/**/*.rb',
+    process.env.SPREE_STOREFRONT_PATH + '/app/javascript/**/*.js',
+    process.env.SPREE_STOREFRONT_PATH + '/app/views/themes/**/*.erb',
+    process.env.SPREE_STOREFRONT_PATH + '/app/views/spree/**/*.erb',
+    process.env.SPREE_STOREFRONT_PATH + '/app/views/devise/**/*.erb'
+  ],
+  plugins: [
+    require('@tailwindcss/typography'),
+    require('@tailwindcss/forms'),
+    require('@tailwindcss/aspect-ratio')
+  ],
+  variants: {
+    scrollbar: ['rounded']
+  },
+  safelist: [
+    'hidden',
+    'lg:grid',
+    'grid',
+    'text-xs',
+    'text-sm',
+    'text-base',
+    'text-lg',
+    'text-xl',
+    'text-2xl',
+    'text-3xl',
+    'text-4xl',
+    'text-left',
+    'text-right',
+    'text-center',
+    'cursor-wait',
+    'lg:sr-only'
+  ],
+  theme: {
+    extend: {
+      fontFamily: {
+        body: ['var(--font-body)', ...defaultTheme.fontFamily.sans]
+      },
+      screens: {
+        lg: { raw: '(min-width: 1024px) { &:not(.force-mobile-view *) }' }
+      },
+      animation: {
+        fadeIn: 'fadeIn 0.5s ease-in-out'
+      },
+      keyframes: {
+        fadeIn: {
+          '0%': { opacity: 0 },
+          '100%': { opacity: 1 }
+        }
+      },
+      colors: {
+        primary: 'var(--primary)',
+        accent: 'var(--accent)',
+        neutral: 'var(--neutral)',
+        danger: 'var(--danger)',
+        success: 'var(--success)',
+
+        'accent-100': 'var(--accent-100)',
+        'neutral-50': 'var(--neutral-50)',
+        'neutral-100': 'var(--neutral-100)',
+        'neutral-200': 'var(--neutral-200)',
+        'neutral-300': 'var(--neutral-300)',
+        'neutral-400': 'var(--neutral-400)',
+        'neutral-500': 'var(--neutral-500)',
+        'neutral-600': 'var(--neutral-600)',
+        'neutral-700': 'var(--neutral-700)',
+        'neutral-800': 'var(--neutral-800)',
+        'neutral-900': 'var(--neutral-900)',
+
+        background: 'var(--background)',
+        'section-background': 'var(--section-background, var(--background))',
+        text: 'var(--text)',
+
+        button: 'rgba(var(--button-rgb), <alpha-value>)',
+        'button-text': 'var(--button-text)',
+        'button-hover': 'var(--button-hover)',
+        'button-hover-text': 'var(--button-hover-text)',
+
+        'secondary-button': 'var(--secondary-button)',
+        'secondary-button-text': 'var(--secondary-button-text)',
+        'secondary-button-hover': 'var(--secondary-button-hover)',
+        'secondary-button-hover-text': 'var(--secondary-button-hover-text)',
+
+        'button-light': 'var(--button-light)',
+        'button-light-text': 'var(--button-light-text)',
+        'button-light-hover': 'var(--button-light-hover)',
+        'button-light-hover-text': 'var(--button-light-hover-text)',
+
+        input: 'var(--input)',
+        'input-bg': 'var(--input-bg)',
+        'input-text': 'var(--input-text)',
+        'input-focus': 'var(--input-focus)',
+        'input-focus-bg': 'var(--input-focus-bg)',
+        'input-focus-text': 'var(--input-focus-text)'
+      },
+      letterSpacing: {
+        widest: '0.07rem'
+      },
+      typography: {
+        DEFAULT: {
+          css: {
+            '--tw-prose-body': 'var(--text)',
+            '--tw-prose-headings': 'var(--text)',
+            '--tw-prose-bold': 'var(--text)',
+            '--tw-prose-links': 'var(--text)',
+            '--tw-prose-counters': 'var(--text)',
+            '--tw-prose-bullets': 'var(--text)',
+            '--tw-prose-lead': 'var(--text)',
+            '--tw-prose-hr': 'var(--border-default-color)',
+            '--tw-prose-th-borders': 'var(--border-default-color)',
+            '--tw-prose-td-borders': 'var(--border-default-color)',
+            '--tw-prose-quote-borders': 'var(--border-default-color)',
+            '--tw-prose-quotes': 'var(--text)'
+          }
+        }
+      }
+    }
+  }
+}

data/lib/generators/spree/storefront/theme/templates/model.rb.tt

@@ -0,0 +1,12 @@
+module Spree
+  module Themes
+    class <%= class_name %> < Default
+      def self.metadata
+        {
+          authors: ['Your Name'],
+          license: 'MIT',
+        }
+      end
+    end
+  end
+end

data/lib/generators/spree/storefront/theme/theme_generator.rb

@@ -0,0 +1,41 @@
+require 'rails/generators'
+
+module Spree
+  module Storefront
+    module Generators
+      class ThemeGenerator < Rails::Generators::Base
+        argument :name, type: :string, default: 'my_theme'
+
+        def self.source_paths
+          [
+            File.expand_path('templates', __dir__),
+            File.expand_path('../../../../../app/views', __dir__)
+          ]
+        end
+
+        def copy_theme
+          empty_directory "app/models/spree/themes"
+          template "model.rb.tt", "app/models/spree/themes/#{file_name}.rb"
+
+          empty_directory "app/views/themes"
+
+          directory "themes/default", "app/views/themes/#{file_name}"
+
+          append_to_file "config/initializers/spree.rb", after: "Rails.application.config.after_initialize do\n" do
+            "  Rails.application.config.spree.themes << Spree::Themes::#{class_name}\n"
+          end
+        end
+
+        no_tasks do
+          def class_name
+            name.camelize
+          end
+
+          def file_name
+            name.underscore
+          end
+        end
+      end
+    end
+  end
+end

data/lib/spree/storefront/configuration.rb

@@ -0,0 +1,11 @@
+require 'spree/core/preferences/runtime_configuration'
+
+module Spree
+  module Storefront
+    class Configuration < ::Spree::Preferences::RuntimeConfiguration
+      preference :products_per_page, :integer, default: 20
+
+      preference :search_min_query_length, :integer, default: 2
+    end
+  end
+end

data/lib/spree/storefront/engine.rb

@@ -0,0 +1,51 @@
+require_relative 'configuration'
+
+module Spree
+  module Storefront
+    class Engine < ::Rails::Engine
+      Environment = Struct.new(
+        :head_partials,
+        :body_start_partials,
+        :body_end_partials,
+        :add_to_cart_partials,
+        :remove_from_cart_partials,
+        :checkout_partials,
+        :checkout_complete_partials,
+        :quick_checkout_partials
+      )
+
+      initializer 'spree.storefront.configuration', before: :load_config_initializers do |_app|
+        Spree::Storefront::Config = Spree::Storefront::Configuration.new
+      end
+
+      initializer 'spree.storefront.assets' do |app|
+        app.config.spree_storefront = Environment.new
+        app.config.assets.paths << root.join('app/javascript')
+        app.config.assets.paths << root.join('vendor/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
+
+      # we need to set the path to the storefront so that tailwind can find the views
+      initializer 'spree.storefront.tailwind_views_path' do
+        ENV['SPREE_STOREFRONT_PATH'] = root.to_s
+      end
+
+      config.after_initialize do
+        Rails.application.config.spree_storefront.head_partials = []
+        Rails.application.config.spree_storefront.body_start_partials = []
+        Rails.application.config.spree_storefront.body_end_partials = []
+        Rails.application.config.spree_storefront.add_to_cart_partials = []
+        Rails.application.config.spree_storefront.remove_from_cart_partials = []
+        Rails.application.config.spree_storefront.checkout_partials = []
+        Rails.application.config.spree_storefront.checkout_complete_partials = []
+        Rails.application.config.spree_storefront.quick_checkout_partials = []
+      end
+    end
+  end
+end

data/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
+end

data/lib/spree/storefront.rb

@@ -0,0 +1,16 @@
+require 'spree_core'
+
+require 'sprockets/railtie'
+
+require 'active_link_to'
+require 'canonical-rails'
+require 'heroicon'
+require 'importmap-rails'
+require 'local_time'
+require 'mail_form'
+require 'payment_icons'
+require 'stimulus-rails'
+require 'tailwindcss-rails'
+require 'turbo-rails'
+
+require 'spree/storefront/engine'

data/lib/spree_storefront.rb

@@ -0,0 +1 @@
+require 'spree/storefront'