spree_frontend 4.7.0 → 4.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 66ee07c39f3973037fba8e3d5c16f5de80d7cf7152051058b7138ea98b1e0160
-  data.tar.gz: 8413f7984b0dca8fbc785c36d958bf409d7d635dadf997861ed3db8c2f9949c2
+  metadata.gz: caad5de0edbc610a11d2fcf5a66ccd2f7b72df02586c6ecbbcd44361c723a8d0
+  data.tar.gz: 0a827e9e0b7c0b105d5f607053ddca0b32b121407307071f68339b3a96815601
 SHA512:
-  metadata.gz: 4276034e9e0892d040c79e0ddbb31753c926d0e1d2d7a7f43a378d23224e2418ec41480b95be79ac84bce9da899b2f6951a7dabbdfdf367b430464084230363c
-  data.tar.gz: 67a583cbbf0c984f0b297b4a258a3391bcef391a54683fa5b7c4bbaaeab5897b37a837e655cba233cfa4835315b908402e5e18fcb6b3371e19bdcd39204f20a3
+  metadata.gz: 107a0e3580ffc8e63d16158fba7d886cedf4fd765cac03497281ab09ee141355cf75905f75b1824a8e1496f1ae8e657f9ea12c90973a31aa586d0fe3aa243b6f
+  data.tar.gz: 4fa6f2841ebe6b61515542b98386f66d62f56bd8a124db6d5771143d7d33f9f554359276f6a9a3adf63f4eb6b89f2325850593607e87e3b9a08db53dcfc6e4e7

data/.circleci/config.yml

@@ -1,4 +1,4 @@
-version: 2.1 # use CircleCI 2.0
+version: 2.1
 
 defaults: &defaults
   environment: &environment
@@ -7,21 +7,19 @@ defaults: &defaults
     BUNDLE_JOBS: 4
     BUNDLE_RETRY: 3
     BUNDLE_PATH: ~/spree/vendor/bundle
-    RAILS_VERSION: '~> 7.1.0'
   working_directory: ~/spree
   docker:
-    - image: &ruby_3_2_image circleci/ruby:3.0-node-browsers
-    - image: &redis_image circleci/redis:6.2-alpine
+    - image: &ruby_image cimg/ruby:3.3.0-browsers
 
-run_tests_3_2: &run_tests_3_2
+run_tests: &run_tests
   <<: *defaults
   parallelism: 8
   steps:
     - checkout
     - restore_cache:
         keys:
-          - spree-storefront-old-bundle-v10-ruby-3-2-{{ .Branch }}
-          - spree-storefront-old-bundle-v10-ruby-3-2
+          - spree-storefront-bundle-{{ checksum ".ruby-version" }}-{{ .Branch }}
+          - spree-storefront-bundle-{{ checksum ".ruby-version" }}
     - run:
         name: Add keyserver
         command: sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 4EB27DB2A3B88B8B
@@ -29,12 +27,12 @@ run_tests_3_2: &run_tests_3_2
         name: Install libvips
         command: sudo apt-get update && sudo apt-get install libvips
     - run:
-          name: Set bundle path
-          command: bundle config --local path vendor/bundle
+        name: Set bundle path
+        command: bundle config --local path vendor/bundle
     - run:
-          name: Ensure bundle Install
-          command: |
-            bundle check || bundle install
+        name: Ensure Bundle Install
+        command: |
+          bundle check || bundle install
     - run:
         name: Create test app
         command: |
@@ -53,14 +51,14 @@ run_tests_3_2: &run_tests_3_2
           path: tmp/capybara
 
 jobs:
-  bundle_ruby_3_2:
+  bundle:
     <<: *defaults
     steps:
       - checkout
       - restore_cache:
           keys:
-            - spree-storefront-old-bundle-v10-ruby-3-2-{{ .Branch }}
-            - spree-storefront-old-bundle-v10-ruby-3-2
+            - spree-storefront-bundle-{{ checksum ".ruby-version" }}-{{ .Branch }}
+            - spree-storefront-bundle-{{ checksum ".ruby-version" }}
       - run:
           name: Add keyserver
           command: sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 4EB27DB2A3B88B8B
@@ -77,25 +75,11 @@ jobs:
       - save_cache:
           paths:
             - vendor/bundle
-          key: spree-storefront-old-bundle-v10-ruby-3-2-{{ checksum "Gemfile.lock" }}
+          key: spree-storefront-bundle-{{ checksum ".ruby-version" }}-{{ .Branch }}
 
-  tests_ruby_3_2_rails_7_1_postgres:
-    <<: *run_tests_3_2
-    environment: &postgres_environment
-      <<: *environment
-      DB: postgres
-      DB_HOST: localhost
-      DB_USERNAME: postgres
-    docker:
-      - image: *ruby_3_2_image
-      - image: &postgres_image circleci/postgres:12-alpine
-        environment:
-          POSTGRES_USER: postgres
-      - image: *redis_image
-
-  tests_ruby_3_2_rails_7_1_mysql:
-    <<: *run_tests_3_2
-    environment: &mysql_environment
+  tests_mysql:
+    <<: *run_tests
+    environment:
       <<: *environment
       DB: mysql
       DB_HOST: 127.0.0.1
@@ -103,18 +87,29 @@ jobs:
       COVERAGE: true
       COVERAGE_DIR: /tmp/workspace/simplecov
     docker:
-      - image: *ruby_3_2_image
-      - image: *redis_image
-      - image: &mysql_image circleci/mysql:8-ram
+      - image: *ruby_image
+      - image: cimg/mysql:8.0
+
+  tests_postgres:
+    <<: *run_tests
+    environment:
+      <<: *environment
+      DB: postgres
+      DB_HOST: localhost
+      DB_USERNAME: postgres
+    docker:
+      - image: *ruby_image
+      - image: cimg/postgres:16.2
+        environment:
+          POSTGRES_USER: postgres
 
 workflows:
-  version: 2
   main:
     jobs:
-      - bundle_ruby_3_2
-      - tests_ruby_3_2_rails_7_1_postgres:
+      - bundle
+      - tests_postgres:
           requires:
-            - bundle_ruby_3_2
-      - tests_ruby_3_2_rails_7_1_mysql:
+            - bundle
+      - tests_mysql:
           requires:
-            - bundle_ruby_3_2
+            - bundle

data/.gem_release.yml

@@ -1,7 +1,7 @@
 
 bump:
   recurse: false
-  file: 'frontend/lib/spree/frontend/version.rb'
+  file: 'lib/spree/frontend/version.rb'
 
 release:
   recurse: true

data/.github/CONTRIBUTING.md

@@ -1 +1 @@
-Please visit [Contributing section](https://dev-docs.spreecommerce.org/contributing/index) of Spree Guides. Thank you!
+Please visit [Contributing section](https://docs.spreecommerce.org/developer/contributing/quickstart) of Spree Guides. Thank you!

data/.github/dependabot.yml

@@ -1,32 +1,11 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
+
 version: 2
 updates:
-- package-ecosystem: bundler
-  directory: "/backend"
-  schedule:
-    interval: daily
-  open-pull-requests-limit: 10
-- package-ecosystem: bundler
-  directory: "/frontend"
-  schedule:
-    interval: daily
-  open-pull-requests-limit: 10
-- package-ecosystem: bundler
-  directory: "/core"
-  schedule:
-    interval: daily
-  open-pull-requests-limit: 10
-- package-ecosystem: bundler
-  directory: "/cli"
-  schedule:
-    interval: daily
-  open-pull-requests-limit: 10
-- package-ecosystem: bundler
-  directory: "/api"
-  schedule:
-    interval: daily
-  open-pull-requests-limit: 10
-- package-ecosystem: bundler
-  directory: "/sample"
-  schedule:
-    interval: daily
-  open-pull-requests-limit: 10
+  - package-ecosystem: "bundler" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "weekly"

data/.rubocop.yml

@@ -1,197 +1,24 @@
-require: rubocop-rspec
-
 AllCops:
+  DisplayCopNames: true
   TargetRubyVersion: 3.0
-  Exclude:
-    - '**/sandbox/**/*'
-    - '**/db/migrate/*'
+  Include:
     - '**/Gemfile'
-    - '**/Gemfile.lock'
     - '**/Rakefile'
-    - '**/rails'
-    - '**/*.gemspec'
-    - '**/dummy/**/*'
-    - '**/vendor/**/*'
-    - '**/spec_helper.rb'
-    - '**/templates/**/*'
-
-Layout/MultilineOperationIndentation:
-  EnforcedStyle: indented
+    - '**/Appraisals'
+  Exclude:
+    - 'spec/dummy/**/*'
+    - 'lib/generators/**/*'
 
-Layout/ParameterAlignment:
-  Enabled: false
+Rails:
+  Enabled: true
 
-Metrics/ClassLength:
-  CountComments: false
+Metrics/LineLength:
   Max: 150
 
-Metrics/ModuleLength:
-  CountComments: false
-  Max: 250
-  Exclude:
-    - '**/spec/**/*'
+# DISABLED
 
 Style/Documentation:
   Enabled: false
 
-Layout/LineLength:
-  Max: 150
-  Exclude:
-    - '**/spec/**/*'
-
-Metrics/MethodLength:
-  CountComments: false
-  Max: 50
-
-Metrics/BlockLength:
-  CountComments: false
-  Max: 50
-  Exclude:
-    - '**/spec/**/*'
-    - '**/*.rake'
-    - '**/factories/**/*'
-    - '**/config/routes.rb'
-
-Metrics/AbcSize:
- Max: 45
-
-Style/StringLiterals:
-  EnforcedStyle: single_quotes
-
-Layout/DotPosition:
-  EnforcedStyle: trailing
-  Enabled: true
-
-Layout/SpaceInsideArrayLiteralBrackets:
-  Exclude:
-    - 'api/spec/integration/**/*.rb'
-    - 'api/lib/spree/api/testing_support/v2/platform_contexts.rb'
-
 Style/FrozenStringLiteralComment:
   Enabled: false
-
-Style/RegexpLiteral:
-  Enabled: false
-
-Style/WordArray:
-  Enabled: false
-
-Style/SymbolArray:
-  Enabled: false
-
-Style/SymbolProc:
-  Exclude:
-    - '**/app/serializers/**/*'
-
-Style/GuardClause:
-  Enabled: false
-
-Style/TrailingCommaInArrayLiteral:
-  Enabled: false
-
-Style/TrailingCommaInHashLiteral:
-  Enabled: false
-
-Style/BarePercentLiterals:
-  Enabled: false
-
-Style/MutableConstant:
-  Enabled: false
-
-Style/PercentLiteralDelimiters:
-  Enabled: false
-
-Style/IfUnlessModifier:
-  Enabled: false
-
-Naming/VariableNumber:
-  Enabled: false
-
-Style/RedundantPercentQ:
-  Enabled: false
-
-Lint/ParenthesesAsGroupedExpression:
-  Enabled: false
-
-Style/NumericPredicate:
-  Enabled: false
-
-Metrics/PerceivedComplexity:
-  Max: 10
-
-Metrics/CyclomaticComplexity:
-  Max: 10
-
-Style/ClassAndModuleChildren:
-  Enabled: false
-
-Style/AndOr:
-  Exclude:
-    - '**/*controller.rb'
-
-Style/HashEachMethods:
-  Enabled: false
-
-Style/HashTransformKeys:
-  Enabled: false
-
-Style/HashTransformValues:
-  Enabled: false
-
-RSpec/NestedGroups:
-  Max: 7
-
-Lint/AmbiguousBlockAssociation:
-  Exclude:
-    - '**/spec/**/*'
-
-Style/NumericLiterals:
-  Enabled: false
-
-RSpec/DescribeClass:
-  Enabled: false
-
-RSpec/VerifiedDoubles:
-  Enabled: false
-
-RSpec/MessageChain:
-  Enabled: false
-
-RSpec/AnyInstance:
-  Enabled: false
-
-RSpec/InstanceVariable:
-  Enabled: false
-
-RSpec/ContextWording:
-  Enabled: false
-
-RSpec/ExpectInHook:
-  Enabled: false
-
-RSpec/ExampleLength:
-  Enabled: false
-
-RSpec/MessageSpies:
-  Enabled: false
-
-RSpec/NamedSubject:
-  Enabled: false
-
-RSpec/MultipleExpectations:
-  Enabled: false
-
-RSpec/FilePath:
-  Enabled: false
-
-RSpec/LetSetup:
-  Enabled: false
-
-RSpec/SubjectStub:
-  Enabled: false
-
-RSpec/VoidExpect:
-  Enabled: false
-
-RSpec/BeforeAfterAll:
-  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+3.3.0

data/Gemfile

@@ -16,8 +16,10 @@ end
 platforms :ruby do
   if ENV['DB'] == 'mysql'
     gem 'mysql2'
+  elsif ENV['DB'] == 'postgres'
+    gem 'pg'
   else
-    gem 'pg', '~> 1.1'
+    gem 'sqlite3', '~> 1.4'
   end
 end
 
@@ -26,7 +28,6 @@ group :test do
   gem 'capybara-screenshot'
   gem 'capybara-select-2'
   gem 'database_cleaner', '~> 2.0'
-  gem 'email_spec'
   gem 'factory_bot_rails', '~> 6.0'
   gem 'multi_json'
   gem 'rspec-activemodel-mocks'
@@ -35,7 +36,7 @@ group :test do
   gem 'rspec_junit_formatter'
   gem 'rswag-specs'
   gem 'jsonapi-rspec'
-  gem 'simplecov', '0.17.1'
+  gem 'simplecov'
   gem 'webmock'
   gem 'timecop'
   gem 'rails-controller-testing'
@@ -44,7 +45,6 @@ end
 group :test, :development do
   gem 'awesome_print'
   gem 'gem-release'
-  gem 'redis'
   gem 'rubocop', '~> 1.22.3', require: false # bumped
   gem 'rubocop-rspec', require: false
   gem 'pry-byebug'

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2007-2021, Spree Commerce, Inc., Spark Solutions Sp. z o.o. and other contributors
+Copyright (c) 2007-2024, Spree Commerce, Inc., Spark Solutions Sp. z o.o. and other contributors
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification,

data/README.md

@@ -1,48 +1,53 @@
-# Spree (Legacy) Frontend
+# Spree Rails Frontend
 
-This is the old Spree Storefront extracted from Spree < 4.3 which was upgraded to Turbo/Hotwire.
+This is the Spree Storefront extracted from Spree < 4.3 which was upgraded to Turbo and Hotwire.
+It is based on Bootstrap 4. It is battle tested and is used in production by many stores.
+
+This storefront includes also Checkout and Cart functionality providing a complete shopping experience.
 
 ## Developed by
 
-[![Vendo](https://assets-global.website-files.com/6230c485f2c32ea1b0daa438/623372f40a8c54ca9aea34e8_vendo%202.svg)](https://getvendo.com?utm_source=spree_frontend_github)
+<a href="https://getvendo.com?utm_source=spree_auth_github"><img src="https://cdn.getvendo.com/assets/vendo-logo-4bda02af8c99bc2ecc5a400120f0ebe4eafcd385e02e25f198a8c355ab75d1ff.png" height=50 alt="Vendo - Start your own multi-brand marketplace" /></a>
 
-> All-in-one platform for all your Marketplace and B2B eCommerce needs. [Start your 30-day free trial](https://e98esoirr8c.typeform.com/contactvendo?typeform-source=spree_sdk_github)
+<a href="http://sparksolutions.co?utm_source=github"><img src="https://sparksolutions.co/wp-content/themes/sparksolutions/images/logo.svg" height=50 alt="Spark Solutions - Ruby on Rails and Spree Commerce developers"></a>
 
 ## Installation
 
-Add
+Run
 
-```ruby
-gem 'spree_frontend'
+```bash
+bundle add 'spree_frontend'
 ```
 
-to your `Gemfile`, making sure that the `spree_frontend` gem is before `spree_auth_devise`.
-
-Make sure both `gem 'jsbundling-rails'` and `gem 'turbo-rails'` are added as well.
+Make sure that the `spree_frontend` gem is before `spree_auth_devise`.
 
 Run:
 
 ```bash
 bundle install
-bin/rails javascript:install:esbuild
-bin/rails turbo:install
 bin/rails g spree:frontend:install
-yarn build
 ```
 
+### Development
+
+You can easily import all storefront templates to your application by running:
+
+```bash
+bin/rails g spree:frontend:copy_storefront
+```
+
+This will allow you to easily customize the look and feel of your storefront.
+
 ### Troubleshooting
 
 #### Disabled 'Add to Cart' Button Issue
 
 If you notice that the 'Add to Cart' button is disabled on product pages, try the following:
-* run `yarn build` again in your main repo
-* if that doesn't fix the issue, try running the following setup commands again:
-  ```
-  bin/rails javascript:install:esbuild
+  
+  ```bash
   bin/rails turbo:install
   bin/rails g spree:frontend:install
-  yarn build
-  rake assets:clean assets:precompile
+  bundle exec rake assets:clean assets:precompile
   ```
 
 This issue may come up if you switch the source of your `spree_frontend` in your Gemfile, e.g. from github to a local path, etc.
@@ -55,35 +60,23 @@ This error results from the routes defined in `spree_frontend` and `spree_auth_d
 
 ## Running Tests
 
-In order to generate the dummy app required for running tests, you’ll need to have the following installed on your machine:
-* node v16.13.1 (npm v8.1.2)
-* yarn ≥ v1.22.15
-* ruby v3.0.3
-
 To run tests locally, first run `bundle exec rake test_app`, then `bundle exec rspec`.
 
 ### Troubleshooting
+
 If you are running on a Mac with an M1 processor, you may run into the following error when running tests:
-```          
+
+```bash
 Webdrivers::NetworkError:
 Net::HTTPServerException: 404 "Not Found"
 ```
+
 If so, update your gemfile locally to get version 5.0 or higher for the web drivers gem:
-```
+
+```bash
 gem 'webdrivers', '~> 5.0'
 ```
 
-## Maintanence policy
-
-This gem is in maintainence mode.
-
-We only accept bug fixes, Spree/Rails compatibility improvements & security patches.
-
-For new project we recommend using [Storefront API](https://api.spreecommerce.org/) to create your own unique storefront or use one of the pre-built starters: 
-
-* [Next.js](https://dev-docs.spreecommerce.org/storefronts/next.js-commerce)
-* [Vue Storefront](https://dev-docs.spreecommerce.org/storefronts/vue-storefront)
-
 ## Customization
 
-[Developer documentation](https://dev-docs.spreecommerce.org/customization/storefront)
+[Developer documentation](https://docs.spreecommerce.org/customization/storefront)

data/SECURITY.md

@@ -1 +1 @@
-Please see [Spree Guides Security section](https://dev-docs.spreecommerce.org/security/index).
+Please see [Spree Guides Security section](https://docs.spreecommerce.org/developer/security/quickstart).

data/app/assets/config/spree_frontend_manifest.js

@@ -1,5 +1,6 @@
+//= link_directory ../../javascript/spree/frontend .js
+
 //= link_tree ../images
 //
 //= link spree/frontend/all.js
 //= link spree/frontend/all.css
-//= link application.js

data/app/assets/javascripts/spree/frontend/{account.js → account.es6}

@@ -1,12 +1,9 @@
-Spree.fetchAccount = function () {
+const fetchAccount = () => {
   return $.ajax({
     url: Spree.localizedPathFor('account_link')
   }).done(function (data) {
-    Spree.accountFetched = true
     return $('#link-to-account').html(data)
   })
 }
 
-Spree.ready(function () {
-  if (!Spree.accountFetched) Spree.fetchAccount()
-})
+document.addEventListener("turbo:load", fetchAccount)

data/app/assets/javascripts/spree/frontend/{api_tokens.js → api_tokens.es6}

@@ -1,4 +1,4 @@
-Spree.fetchApiTokens = function () {
+const fetchApiTokens = () => {
   fetch(Spree.routes.api_tokens, {
     method: 'GET',
     credentials: 'same-origin'
@@ -8,13 +8,10 @@ Spree.fetchApiTokens = function () {
         response.json().then(function (json) {
           SpreeAPI.orderToken = json.order_token
           SpreeAPI.oauthToken = json.oauth_token
-          Spree.apiTokensFetched = true
         })
         break
     }
   })
 }
 
-Spree.ready(function () {
-  if (!Spree.apiTokensFetched) Spree.fetchApiTokens()
-})
+document.addEventListener("turbo:load", fetchApiTokens)

data/app/assets/javascripts/spree/frontend/cart.js

@@ -1,6 +1,6 @@
 //= require spree/frontend/coupon_manager
 
-Spree.ready(function ($) {
+document.addEventListener("turbo:load", function() {
   var formUpdateCart = $('form#update-cart')
 
   function buildEventTriggerObject(dataset, quantity) {

data/app/assets/javascripts/spree/frontend/checkout/address.js

@@ -1,4 +1,4 @@
-Spree.ready(function($) {
+document.addEventListener("turbo:load", function() {
   Spree.onAddress = function() {
     if ($('#checkout_form_address').length) {
       Spree.updateState = function(region) {

data/app/assets/javascripts/spree/frontend/checkout/address_book.js

@@ -1,4 +1,4 @@
-Spree.ready(function ($) {
+document.addEventListener("turbo:load", function() {
   if ($('.select_address').length > 0) {
     $('input#order_use_billing').unbind('change');
 

data/app/assets/javascripts/spree/frontend/checkout/payment.js

@@ -4,7 +4,7 @@ var CARD_EXPIRATION_SELECTOR = '.cardExpiry'
 var CARD_CODE_SELECTOR = '.cardCode'
 
 //= require spree/frontend/coupon_manager
-Spree.ready(function ($) {
+document.addEventListener("turbo:load", function() {
   Spree.onPayment = function () {
     if ($('#checkout_form_payment').length) {
       if ($('#existing_cards').length) {