spree_frontend 4.3.1 → 4.4.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,65 @@
-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', '~> 6.1.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'
+  gem 'puma'
+  gem 'ffaker'
+end
+
+group :development do
+  gem 'github_fast_changelog'
+  gem 'solargraph'
+end
+
+spree_opts = { github: 'spree/spree', branch: ENV.fetch('SPREE_BRANCH', '4-4-stable') }
+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,35 @@
+# Spree (Legacy) Frontend
+
+This is the old Spree Storefront extracted from Spree < 4.3.
+
+## Installation
+
+Add
+
+```ruby
+gem 'spree_frontend'
+```
+
+to your `Gemfile`.
+
+Run:
+
+```bash
+bundle install
+bin/rails g spree:frontend:install
+```
+
+## 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/controllers/spree/addresses_controller.rb

@@ -45,11 +45,11 @@ module Spree
     end
 
     def create_service
-      Spree::Dependencies.account_create_address_service.constantize
+      Spree::Dependencies.address_create_service.constantize
     end
 
     def update_service
-      Spree::Dependencies.account_update_address_service.constantize
+      Spree::Dependencies.address_update_service.constantize
     end
   end
 end

data/app/controllers/spree/locale_controller.rb

@@ -1,6 +1,6 @@
 module Spree
   class LocaleController < Spree::StoreController
-    REDIRECT_TO_ROOT = /\/(#{Spree::Config[:storefront_pages_path]})\//.freeze
+    REDIRECT_TO_ROOT = /\/(pages)\//.freeze
 
     def index
       render :index, layout: false

data/app/controllers/spree/store_controller.rb

@@ -1,7 +1,6 @@
 module Spree
   class StoreController < ApplicationController
     include Spree::Core::ControllerHelpers::Auth
-    include Spree::Core::ControllerHelpers::Common
     include Spree::Core::ControllerHelpers::Search
     include Spree::Core::ControllerHelpers::Store
     include Spree::Core::ControllerHelpers::StrongParameters
@@ -12,10 +11,16 @@ module Spree
 
     respond_to :html
 
+    layout :get_layout
+
     helper 'spree/base'
     helper 'spree/locale'
     helper 'spree/currency'
 
+    helper_method :title
+    helper_method :title=
+    helper_method :accurate_title
+
     skip_before_action :verify_authenticity_token, only: :ensure_cart, raise: false
 
     before_action :redirect_to_default_locale
@@ -43,10 +48,46 @@ module Spree
 
     protected
 
+    # can be used in views as well as controllers.
+    # e.g. <% self.title = 'This is a custom title for this view' %>
+    attr_writer :title
+
+    def title
+      title_string = @title.present? ? @title : accurate_title
+      if title_string.present?
+        if Spree::Frontend::Config[:always_put_site_name_in_title] && !title_string.include?(default_title)
+          [title_string, default_title].join(" #{Spree::Frontend::Config[:title_site_name_separator]} ")
+        else
+          title_string
+        end
+      else
+        default_title
+      end
+    end
+
+    def default_title
+      current_store.name
+    end
+
+    # this is a hook for subclasses to provide title
+    def accurate_title
+      current_store.seo_title
+    end
+
     def config_locale
       Spree::Frontend::Config[:locale]
     end
 
+    # Returns which layout to render.
+    #
+    # You can set the layout you want to render inside your Spree configuration with the +:layout+ option.
+    #
+    # Default layout is: +app/views/spree/layouts/spree_application+
+    #
+    def get_layout
+      layout ||= Spree::Frontend::Config[:layout]
+    end
+
     def store_etag
       [
         current_store,

data/app/helpers/spree/frontend_helper.rb

@@ -14,7 +14,7 @@ module Spree
                      elsif current_store.logo.attached? && current_store.logo.image?
                        main_app.url_for(current_store.logo)
                      else
-                       Spree::Config[:logo]
+                      'logo/spree_50.png'
                      end
 
       path = spree.respond_to?(:root_path) ? spree.root_path : main_app.root_path
@@ -373,6 +373,24 @@ module Spree
       content_tag :span, nil, class: "flag-icon flag-icon-#{country_iso_code.downcase}"
     end
 
+    def product_wysiwyg_editor_enabled?
+      defined?(Spree::Backend) && Spree::Backend::Config[:product_wysiwyg_editor_enabled]
+    end
+
+    def taxon_wysiwyg_editor_enabled?
+      defined?(Spree::Backend) && Spree::Backend::Config[:taxon_wysiwyg_editor_enabled]
+    end
+
+    # converts line breaks in product description into <p> tags (for html display purposes)
+    def product_description(product)
+      description = if Spree::Frontend::Config[:show_raw_product_description] || product_wysiwyg_editor_enabled?
+                      product.description
+                    else
+                      product.description.to_s.gsub(/(.*?)\r?\n\r?\n/m, '<p>\1</p>')
+                    end
+      description.blank? ? Spree.t(:product_has_no_description) : description
+    end
+
     private
 
     def formatted_price(value)

data/app/helpers/spree/navigation_helper.rb

@@ -26,7 +26,7 @@ module Spree
       DEPRECATION
 
       @spree_nav_cache_key = begin
-        keys = base_cache_key + [current_store, spree_navigation_data_cache_key, Spree::Config[:logo], stores&.cache_key_with_version, section]
+        keys = base_cache_key + [current_store, spree_navigation_data_cache_key, stores&.cache_key_with_version, section]
         Digest::MD5.hexdigest(keys.join('-'))
       end
     end

data/app/helpers/spree/store_helper.rb

@@ -28,7 +28,7 @@ module Spree
     end
 
     def should_render_store_chooser?
-      Spree::Config.show_store_selector && stores.size > 1
+      Spree::Frontend::Config[:show_store_selector] && stores.size > 1
     end
 
     def store_link(store = nil, html_opts = {})

data/app/models/spree/frontend_configuration.rb

@@ -1,10 +1,16 @@
 module Spree
   class FrontendConfiguration < Preferences::Configuration
+    preference :additional_filters_partials, :array, default: %w()
+    preference :always_put_site_name_in_title, :boolean, default: true
     preference :coupon_codes_enabled, :boolean, default: true # Determines if we show coupon code form at cart and checkout
     preference :http_cache_enabled, :boolean, default: true
+    preference :layout, :string, default: 'spree/layouts/spree_application'
     preference :locale, :string, default: nil
     preference :products_filters, :array, default: %w(keywords price sort_by)
-    preference :additional_filters_partials, :array, default: %w()
     preference :remember_me_enabled, :boolean, default: true
+    preference :shipping_instructions, :boolean, default: false # Request instructions/info for shipping
+    preference :show_raw_product_description, :boolean, default: false
+    preference :show_store_selector, :boolean, default: false
+    preference :title_site_name_separator, :string, default: '-' # When always_put_site_name_in_title is true, insert a separator character before the site name in the title
   end
 end

data/app/services/spree/build_localized_redirect_url.rb

@@ -0,0 +1,101 @@
+require 'uri'
+
+module Spree
+  class BuildLocalizedRedirectUrl
+    prepend Spree::ServiceModule::Base
+
+    LOCALE_REGEX = /^\/[A-Za-z]{2}\/|^\/[A-Za-z]{2}-[A-Za-z]{2}\/|^\/[A-Za-z]{2}$|^\/[A-Za-z]{2}-[A-Za-z]{2}$/.freeze
+
+    SUPPORTED_PATHS_REGEX = /\/(products|t\/|cart|checkout|addresses|content|pages)/.freeze
+
+    # rubocop:disable Lint/UnusedMethodArgument
+    def call(url:, locale:, default_locale: nil)
+      run :initialize_url_object
+      run :generate_new_path
+      run :append_locale_param
+      run :build_url
+    end
+    # rubocop:enable Lint/UnusedMethodArgument
+
+    protected
+
+    def initialize_url_object(url:, locale:, default_locale:)
+      success(
+        url: URI(url),
+        locale: locale,
+        default_locale_supplied: default_locale_supplied?(locale, default_locale)
+      )
+    end
+
+    def generate_new_path(url:, locale:, default_locale_supplied:)
+      unless supported_path?(url.path)
+        return success(
+          url: url,
+          locale: locale,
+          path: cleanup_path(url.path),
+          default_locale_supplied: default_locale_supplied,
+          locale_added_to_path: false
+        )
+      end
+
+      new_path = if default_locale_supplied
+                   maches_locale_regex?(url.path) ? url.path.gsub(LOCALE_REGEX, '/') : url.path
+                 else
+                   maches_locale_regex?(url.path) ? url.path.gsub(LOCALE_REGEX, "/#{locale}/") : "/#{locale}#{url.path}"
+                 end
+
+      success(
+        url: url,
+        locale: locale,
+        path: cleanup_path(new_path),
+        default_locale_supplied: default_locale_supplied,
+        locale_added_to_path: true
+      )
+    end
+
+    def append_locale_param(url:, locale:, path:, default_locale_supplied:, locale_added_to_path:)
+      return success(url: url, path: path, query: url.query) if locale_added_to_path
+
+      query_params = Rack::Utils.parse_nested_query(url.query)
+
+      if default_locale_supplied
+        query_params.delete('locale')
+      else
+        query_params.merge!('locale' => locale)
+      end
+
+      query_string = query_params.any? ? query_params.to_query : nil
+
+      success(url: url, path: path, query: query_string)
+    end
+
+    def build_url(url:, path:, query:)
+      localized_url = builder_class(url).build(host: url.host, port: url.port, path: path, query: query).to_s
+      success(localized_url)
+    end
+
+    private
+
+    def supported_path?(path)
+      return true if path.blank? || path == '/' || maches_locale_regex?(path)
+
+      path.match(SUPPORTED_PATHS_REGEX)
+    end
+
+    def maches_locale_regex?(path)
+      path.match(LOCALE_REGEX)[0].gsub('/', '') if path.match(LOCALE_REGEX)
+    end
+
+    def default_locale_supplied?(locale, default_locale)
+      default_locale.present? && default_locale.to_s == locale.to_s
+    end
+
+    def cleanup_path(path)
+      path.chomp('/').gsub('//', '/')
+    end
+
+    def builder_class(url)
+      url.scheme == 'http' ? URI::HTTP : URI::HTTPS
+    end
+  end
+end

data/app/views/spree/checkout/_delivery.html.erb

@@ -35,7 +35,7 @@
       <% end %>
     </div>
 
-    <% if Spree::Config[:shipping_instructions] %>
+    <% if Spree::Frontend::Config[:shipping_instructions] %>
       <div id="minstrs" data-hook>
         <h4 class="h5">
           <%= Spree.t(:shipping_instructions) %>

data/app/views/spree/products/_description.html.erb

@@ -1,6 +1,6 @@
 <h3 class="pt-4 font-weight-bold text-uppercase product-details-subtitle"><%= Spree.t(:description) %></h3>
 
-<% if Spree::Config[:show_raw_product_description] || product_wysiwyg_editor_enabled? %>
+<% if Spree::Frontend::Config[:show_raw_product_description] || product_wysiwyg_editor_enabled? %>
   <div id="product-description-long" class="m-0 text-break product-description" data-hook="description">
     <%= raw product_description(@product) %>
   </div>

data/app/views/spree/shared/_link_to_account.html.erb

@@ -1,6 +1,8 @@
 <% if try_spree_current_user %>
   <%= link_to Spree.t(:my_account).upcase, spree.account_path, class: 'dropdown-item' if spree.respond_to?(:account_path) %>
-  <%= link_to Spree.t('nav_bar.admin_panel'), spree.admin_orders_path(locale: nil), class: 'dropdown-item text-uppercase' if try_spree_current_user.has_spree_role?(:admin) %>
+  <% if spree.respond_to(:admin_orders_path) %>
+    <%= link_to Spree.t('nav_bar.admin_panel'), spree.admin_orders_path(locale: nil), class: 'dropdown-item text-uppercase' if try_spree_current_user.has_spree_role?(:admin) %>
+  <% end %>
   <%= link_to Spree.t(:logout).upcase, spree_logout_path, class: 'dropdown-item', method: :get if defined?(spree_logout_path) %>
 <% else %>
   <%= link_to Spree.t(:login).upcase, spree_login_path, class: 'dropdown-item' if defined?(spree_login_path) %>

data/app/views/spree/shared/_paths.html.erb

@@ -2,7 +2,7 @@
   SpreePaths = <%==
   {
     mounted_at: Rails.application.routes.url_helpers.spree_path(trailing_slash: true),
-    admin: Spree.admin_path.gsub(/\A(\/)?(.*[^\/])(\/)?\z/, '\\2/')
+    admin: Spree.respond_to?(:admin_path) ? Spree.admin_path.gsub(/\A(\/)?(.*[^\/])(\/)?\z/, '\\2/') : '/admin'
   }.to_json
   %>
 </script>