spree_frontend 4.3.1 → 4.5.0

data/.rubocop.yml

@@ -0,0 +1,197 @@
+require: rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.5
+  Exclude:
+    - '**/sandbox/**/*'
+    - '**/db/migrate/*'
+    - '**/Gemfile'
+    - '**/Gemfile.lock'
+    - '**/Rakefile'
+    - '**/rails'
+    - '**/*.gemspec'
+    - '**/dummy/**/*'
+    - '**/vendor/**/*'
+    - '**/spec_helper.rb'
+    - '**/templates/**/*'
+
+Layout/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+Layout/ParameterAlignment:
+  Enabled: false
+
+Metrics/ClassLength:
+  CountComments: false
+  Max: 150
+
+Metrics/ModuleLength:
+  CountComments: false
+  Max: 250
+  Exclude:
+    - '**/spec/**/*'
+
+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/.solargraph.yml

@@ -0,0 +1,20 @@
+---
+include:
+- "**/*.rb"
+exclude:
+- "*/spec/**/*"
+- "*test/**/*"
+- "*/vendor/**/*"
+- vendor/**/*
+- ".bundle/**/*"
+- sample/**/*
+- sandbox/**/*
+- pkg/**/*
+- cli/**/*.gemspec
+require: []
+domains: []
+reporters:
+- rubocop
+- require_not_found
+require_paths: []
+max_files: 50_000

data/.stylelintignore

@@ -0,0 +1,4 @@
+**/vendor/**
+**/dummy/**
+**/sandbox/**
+/cli/lib/spree_cli/templates/**

data/.stylelintrc

@@ -0,0 +1,6 @@
+{
+  "extends": "stylelint-config-recommended",
+  "rules": {
+    "at-rule-no-unknown": null
+  }
+}

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,22 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of fostering an open and welcoming community, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic addresses, without explicit permission
+* Other unethical or unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. By adopting this Code of Conduct, project maintainers commit themselves to fairly and consistently applying these principles to every aspect of managing this project. Project maintainers who do not follow or enforce the Code of Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.2.0, available at [http://contributor-covenant.org/version/1/2/0/](http://contributor-covenant.org/version/1/2/0/)

data/Gemfile

@@ -1,6 +1,61 @@
-eval_gemfile('../common_spree_dependencies.rb')
+source 'https://rubygems.org'
 
-gem 'spree_core', path: '../core'
-gem 'spree_api', path: '../api'
+gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw]
+
+%w[
+  actionmailer actionpack actionview activejob activemodel activerecord
+  activestorage activesupport railties
+].each do |rails_gem|
+  gem rails_gem, ENV.fetch('RAILS_VERSION', '~> 7.0.0'), require: false
+end
+
+platforms :jruby do
+  gem 'jruby-openssl'
+end
+
+platforms :ruby do
+  if ENV['DB'] == 'mysql'
+    gem 'mysql2'
+  else
+    gem 'pg', '~> 1.1'
+  end
+end
+
+group :test do
+  gem 'capybara', '~> 3.24'
+  gem 'capybara-screenshot', '~> 1.0'
+  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', '~> 1.0'
+  gem 'rspec-rails', '~> 5.0'
+  gem 'rspec-retry'
+  gem 'rspec_junit_formatter'
+  gem 'rswag-specs'
+  gem 'jsonapi-rspec'
+  gem 'simplecov', '0.17.1'
+  gem 'webmock', '~> 3.7'
+  gem 'timecop'
+  gem 'rails-controller-testing'
+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'
+  gem 'webdrivers', '~> 4.1'
+  # Puma 6.0 causes issues in specs due to conflict with capybara version
+  gem 'puma', '< 6.0'
+  gem 'ffaker'
+end
+
+spree_opts = { github: 'spree/spree', branch: ENV.fetch('SPREE_BRANCH', 'main') }
+gem 'spree_core', spree_opts
+gem 'spree_api', spree_opts
 
 gemspec

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2007-2019, Spree Commerce, Inc., Spark Solutions Sp. z o.o. and other contributors
+Copyright (c) 2007-2021, 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

@@ -0,0 +1,88 @@
+# Spree (Legacy) Frontend
+
+This is the old Spree Storefront extracted from Spree < 4.3 which was upgraded to Turbo/Hotwire.
+
+## Developed by
+
+[![Vendo](https://assets-global.website-files.com/6230c485f2c32ea1b0daa438/623372f40a8c54ca9aea34e8_vendo%202.svg)](https://getvendo.com?utm_source=spree_frontend_github)
+
+> 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)
+
+## Installation
+
+Add
+
+```ruby
+gem '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.
+
+Run:
+
+```bash
+bundle install
+bin/rails javascript:install:esbuild
+bin/rails turbo:install
+bin/rails g spree:frontend:install
+yarn build
+```
+
+### 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
+  bin/rails turbo:install
+  bin/rails g spree:frontend:install
+  yarn build
+  ```
+
+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.
+
+#### Checkout without logging in results in 500 error
+
+When you navigate to checkout without logging in first, you may get a a 500 error notifying you that "yourdomain.com redirected you too many times."
+
+This error results from the routes defined in `spree_frontend` and `spree_auth_devise` not being built in the correct order. Make sure the `spree_frontend` gem is listed before `spree_auth_devise` in your main project's gemfile, then try again.
+
+## 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:
+```          
+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:
+```
+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)

data/SECURITY.md

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

data/app/assets/config/spree_frontend_manifest.js

@@ -2,3 +2,4 @@
 //
 //= link spree/frontend/all.js
 //= link spree/frontend/all.css
+//= link application.js

data/app/assets/javascripts/spree/{api → frontend/api}/main.js

@@ -1,4 +1,4 @@
-//= require spree
+//= require spree/frontend/main
 
 var SpreeAPI = {
   oauthToken: null, // user Bearer token to authorize operations for the given user
@@ -9,9 +9,9 @@ SpreeAPI.Storefront = {}
 SpreeAPI.Platform = {}
 
 // API routes
-Spree.routes.api_v2_storefront_cart_create = Spree.pathFor('api/v2/storefront/cart')
-Spree.routes.api_v2_storefront_cart_add_item = Spree.pathFor('api/v2/storefront/cart/add_item')
-Spree.routes.api_v2_storefront_cart_apply_coupon_code = Spree.pathFor('api/v2/storefront/cart/apply_coupon_code')
+Spree.routes.api_v2_storefront_cart_create = Spree.localizedPathFor('api/v2/storefront/cart')
+Spree.routes.api_v2_storefront_cart_add_item = Spree.localizedPathFor('api/v2/storefront/cart/add_item')
+Spree.routes.api_v2_storefront_cart_apply_coupon_code = Spree.localizedPathFor('api/v2/storefront/cart/apply_coupon_code')
 
 // helpers
 SpreeAPI.handle500error = function () {

data/app/assets/javascripts/spree/{api → frontend/api}/storefront/cart.js

@@ -1,4 +1,4 @@
-//= require spree/api/main
+//= require spree/frontend/api/main
 
 SpreeAPI.Storefront.createCart = function (successCallback, failureCallback) {
   fetch(Spree.routes.api_v2_storefront_cart_create, {

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

@@ -69,11 +69,11 @@ Spree.ready(function($) {
         var stateSpanRequired = statePara.find('abbr')
 
         if (states.length > 0) {
-          selected = parseInt(stateSelect.val())
+          selected = stateSelect.val()
           stateSelect.html('')
           $.each(states, function(idx, state) {
-            var opt = $(document.createElement('option')).attr('value', state.id).html(state.name)
-            if (selected.toString(10) === state.id.toString(10)) {
+            var opt = $(document.createElement('option')).attr('value', state.id.toString()).html(state.name)
+            if (selected && selected.toString() === state.id.toString()) {
               opt.prop('selected', true)
             }
             stateSelect.append(opt)

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

@@ -1,12 +1,11 @@
-document.addEventListener('turbolinks:load', function(event) {
-  // this condition checks if this is the first initial load of turbolinks application
-  if (!event.data.timing.visitStart) {
+document.addEventListener('turbo:load', function(event) {
+  // this condition checks if this is the first initial load of turbo application
+  if (!event.detail.timing.visitStart) {
     var currencySelect = document.querySelectorAll('select[name=switch_to_currency]')
 
     if (currencySelect.length) {
       currencySelect.forEach(function (element) {
         element.addEventListener('change', function () {
-          Spree.showProgressBar()
           var newCurrency = this.value
 
           // we need to make AJAX call here to the backend to set currency in session
@@ -28,16 +27,16 @@ document.addEventListener('turbolinks:load', function(event) {
 
 // fix back button issue with different currency set
 // invalidate page if cached page has different currency then the current one
-document.addEventListener('turbolinks:load', function(event) {
+document.addEventListener('turbo:load', function(event) {
   if (typeof (SPREE_DEFAULT_CURRENCY) !== 'undefined' && typeof (SPREE_CURRENCY) !== 'undefined') {
     if (SPREE_CURRENCY === SPREE_DEFAULT_CURRENCY) {
       var regexAnyCurrency = new RegExp('currency=')
-      if (event.data.url.match(regexAnyCurrency) && !event.data.url.match(SPREE_CURRENCY)) {
+      if (event.detail.url.match(regexAnyCurrency) && !event.detail.url.match(SPREE_CURRENCY)) {
         Spree.setCurrency(SPREE_CURRENCY)
       }
     } else {
       var regex = new RegExp('currency=' + SPREE_CURRENCY)
-      if (!event.data.url.match(regex)) {
+      if (!event.detail.url.match(regex)) {
         Spree.setCurrency(SPREE_CURRENCY)
       }
     }

data/app/assets/javascripts/spree/frontend/locale.es6

@@ -1,11 +1,10 @@
-document.addEventListener('turbolinks:load', () => {
+document.addEventListener('turbo:load', () => {
   const localeSelect = document.querySelectorAll('select[name=switch_to_locale]')
 
   if (localeSelect.length) {
     localeSelect.forEach((element) => {
       element.addEventListener('change', () => {
         Spree.clearCache()
-        Spree.showProgressBar()
         element.form.submit()
       })
     })

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

@@ -2,7 +2,7 @@
 function Spree () {}
 
 Spree.ready = function (callback) {
-  return jQuery(document).on('page:load turbolinks:load', function () {
+  return jQuery(document).on('page:load turbo:load', function () {
     return callback(jQuery)
   })
 }
@@ -32,7 +32,7 @@ Spree.localizedPathFor = function(path) {
     if (pathName.match(/api\/v/)) {
       params.set('locale', SPREE_LOCALE)
     } else {
-      pathName = (this.mountedAt()) + SPREE_LOCALE + '/' + path
+      pathName = (this.mountedAt()) + SPREE_LOCALE + '/' + pathName
     }
     return fullUrl.origin + pathName + '?' + params.toString()
   }
@@ -68,11 +68,11 @@ Spree.ajax = function (urlOrSettings, settings) {
 }
 
 Spree.routes = {
-  states_search: Spree.pathFor('api/v1/states'),
+  states_search: Spree.localizedPathFor('api/v1/states'),
   apply_coupon_code: function (orderId) {
-    return Spree.pathFor('api/v1/orders/' + orderId + '/apply_coupon_code')
+    return Spree.localizedPathFor('api/v1/orders/' + orderId + '/apply_coupon_code')
   },
-  cart: Spree.pathFor('cart')
+  cart: Spree.localizedPathFor('cart')
 }
 
 Spree.url_params = {}

data/app/assets/javascripts/spree/frontend/{turbolinks_scroll_fix.js → turbo_scroll_fix.js}

@@ -15,8 +15,8 @@
 
   // Invalidate the page when the next page is different from the current page
   // Persist scroll information across pages
-  document.addEventListener('turbolinks:before-visit', function (event) {
-    if (event.data.url !== location.href) {
+  document.addEventListener('turbo:before-visit', function (event) {
+    if (event.detail.url !== location.href) {
       sessionStorage.setItem(PAGE_INVALIDATED, 'true')
     }
     sessionStorage.setItem(SCROLL_POSITION, JSON.stringify(scrollData()))
@@ -28,7 +28,7 @@
   // invalidation,
   // 3. scroll to the persisted position if there, or to the top otherwise
   // 4. Remove the persisted information
-  addEventListener('turbolinks:load', function (event) {
+  addEventListener('turbo:load', function (event) {
     var scrollPosition = JSON.parse(sessionStorage.getItem(SCROLL_POSITION))
 
     if (shouldScroll(scrollPosition)) {

data/app/assets/javascripts/spree/frontend/views/spree/home/product_carousels.js

@@ -26,7 +26,7 @@ Spree.loadsCarouselElements = function () {
   $('div[data-product-carousel-taxon-id]').each(function (_index, element) { Spree.loadCarousel(element, this) })
 }
 
-document.addEventListener('turbolinks:load', function () {
+document.addEventListener('turbo:load', function () {
   var carouselPresent = $('div[data-product-carousel-taxon-id]')
 
   if (carouselPresent.length) {

data/app/assets/javascripts/spree/frontend/views/spree/product/related.js

@@ -9,7 +9,7 @@ Spree.fetchRelatedProducts = function (id, htmlContainer) {
   })
 }
 
-document.addEventListener('turbolinks:load', function () {
+document.addEventListener('turbo:load', function () {
   var productDetailsPage = $('body#product-details')
 
   if (productDetailsPage.length) {

data/app/assets/javascripts/spree/frontend/views/spree/products/cart_form.js

@@ -1,4 +1,4 @@
-//= require spree/api/storefront/cart
+//= require spree/frontend/api/storefront/cart
 //= require ../shared/product_added_modal
 //= require ../shared/variant_select
 
@@ -89,7 +89,7 @@ function CartForm($, $cartForm) {
     this.selectedOptionValueIds.splice(
       optionTypeIndex,
       this.selectedOptionValueIds.length,
-      parseInt($optionValue.val())
+      $optionValue.val().toString()
     )
   }
 
@@ -104,7 +104,7 @@ function CartForm($, $cartForm) {
         .find(OPTION_VALUE_SELECTOR)
         .each(function(_index, ov) {
           var $ov = $(ov)
-          var id = parseInt($ov.val())
+          var id = $ov.val().toString()
 
           $ov.prop('checked', false)
           $ov.prop('disabled', !availableOptionValueIds.includes(id))
@@ -121,7 +121,7 @@ function CartForm($, $cartForm) {
 
     return this.variants.reduce(function(acc, variant) {
       var optionValues = variant.option_values.map(function(ov) {
-        return ov.id
+        return ov.id.toString()
       })
 
       var isPossibleVariantFound = selectedOptionValueIds.every(function(ov) {
@@ -180,7 +180,7 @@ function CartForm($, $cartForm) {
 
     if (!this.withOptionValues) {
       return this.variants.find(function(variant) {
-        return variant.id === parseInt(self.$variantIdInput.val())
+        return variant.id && self.$variantIdInput.val() && variant.id.toString() === self.$variantIdInput.val().toString()
       })
     }
 
@@ -190,7 +190,7 @@ function CartForm($, $cartForm) {
 
     return this.variants.find(function(variant) {
       var optionValueIds = variant.option_values.map(function(ov) {
-        return ov.id
+        return ov.id.toString()
       })
 
       return self.areArraysEqual(optionValueIds, self.selectedOptionValueIds)
@@ -298,7 +298,7 @@ Spree.ready(function($) {
         quantity,
         options, // options hash - you can pass additional parameters here, your backend
         // needs to be aware of those, see API docs:
-        // https://github.com/spree/spree/blob/master/api/docs/v2/storefront/index.yaml#L42
+        // https://github.com/spree/spree/blob/d894358e49b8c3a7f6944e838de7cd92510e31d0/api/docs/v2/storefront/index.yaml#L442
         function(response) {
           $addToCart.prop('disabled', false)
           Spree.fetchCart()
@@ -331,7 +331,7 @@ Spree.ready(function($) {
     CartForm($, $cartForm)
   })
 
-  document.addEventListener('turbolinks:request-start', function () {
+  document.addEventListener('turbo:request-start', function () {
     Spree.hideProductAddedModal()
   })
 })

data/app/assets/javascripts/spree/frontend/views/spree/products/description.js

@@ -1,4 +1,4 @@
-document.addEventListener('turbolinks:load', function () {
+document.addEventListener('turbo:load', function () {
   $('#product-description-arrow').click(function () {
     document.getElementById('product-description-long').classList.remove('d-none')
     document.getElementById('product-description-short').classList.add('d-none')

data/app/assets/javascripts/spree/frontend/views/spree/products/index.js

@@ -35,7 +35,7 @@ Spree.ready(function ($) {
         '?' +
         customEncodeURI(decodeURIComponent(searchParams.toString()))
     );
-    Turbolinks.visit(location);
+    Turbo.visit(location);
   }
 
   function updateFilters(event, $this, removeValue) {