solidus_core 3.0.8 → 3.1.0

data/lib/generators/solidus/update/update_generator.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+require 'spree/preferences/preference_differentiator'
+require 'rails/generators'
+
+module Solidus
+  # @private
+  class UpdateGenerator < ::Rails::Generators::Base
+    FROM = Spree.previous_solidus_minor_version
+
+    desc 'Generates a new initializer to preview the new defaults for current Solidus version'
+
+    source_root File.expand_path('templates', __dir__)
+
+    class_option :initializer_basename,
+                 type: :string,
+                 default: 'new_solidus_defaults',
+                 banner: 'The name for the new initializer'
+
+    class_option :previous_version_prompt,
+                 type: :boolean,
+                 default: true,
+                 banner: 'Prompt to warn about only previous version support'
+
+    class_option :from,
+                 type: :string,
+                 default: FROM,
+                 banner: 'Solidus version from which you are upgrading'
+
+    class_option :to,
+                 type: :string,
+                 default: Spree.solidus_version,
+                 hide: true
+
+    class_option :initializer_directory,
+                 type: :string,
+                 default: 'config/initializers/',
+                 hide: true
+
+    def create_new_defaults_initializer
+      previous_version_prompt = options[:previous_version_prompt]
+      return if previous_version_prompt && !yes?(<<~MSG, :red)
+        The update process is only supported if you are coming from version #{FROM}. If this is not the case, please, skip it and update your application to use Solidus #{FROM} before retrying.
+        If you are confident you want to upgrade from a previous version, you must rerun the generator with the "--from={OLD_VERSION}" argument.
+        Are you sure you want to continue? (y/N)
+      MSG
+
+      from = options[:from]
+      to = options[:to]
+      @from = from
+      @core_changes = core_changes_template(from, to)
+      @frontend_changes = frontend_changes_template(from, to)
+      @backend_changes = backend_changes_template(from, to)
+      @api_changes = api_changes_template(from, to)
+
+      template 'config/initializers/new_solidus_defaults.rb.tt',
+               File.join(options[:initializer_directory], "#{options[:initializer_basename]}.rb")
+    end
+
+    def print_message
+      say <<~MSG
+
+        ***********************************************************************
+
+        Other tasks may be needed to update to the new Solidus version. Please,
+        check https://github.com/solidusio/solidus/blob/v#{options[:to]}/CHANGELOG.md
+        for details.
+
+        Thanks for using Solidus!
+
+        ***********************************************************************
+
+      MSG
+    end
+
+    private
+
+    def core_changes_template(from, to)
+      changes_template_for(Spree::AppConfiguration, from, to)
+    end
+
+    def frontend_changes_template(from, to)
+      return '' unless defined?(Spree::Frontend::Engine)
+
+      changes_template_for(Spree::FrontendConfiguration, from, to)
+    end
+
+    def backend_changes_template(from, to)
+      return '' unless defined?(Spree::Backend::Engine)
+
+      changes_template_for(Spree::BackendConfiguration, from, to)
+    end
+
+    def api_changes_template(from, to)
+      return '' unless defined?(Spree::Api::Engine)
+
+      changes_template_for(Spree::ApiConfiguration, from, to)
+    end
+
+    def changes_template_for(klass, from, to)
+      changes = Spree::Preferences::PreferenceDifferentiator.new(klass).call(from: from, to: to)
+      return '# No changes' if changes.empty?
+
+      [
+        ["config.load_defaults('#{from}')"] +
+          changes.map do |pref_key, change|
+            "  # config.#{pref_key} = #{change[:to]}"
+          end.flatten
+      ].join("\n")
+    end
+  end
+end

data/lib/generators/spree/dummy/templates/rails/application.rb.tt

@@ -7,4 +7,3 @@ Bundler.require(*Rails.groups(assets: %w(development test)))
 require '<%= lib_name %>'
 
 <%= application_definition %>
-

data/lib/generators/spree/dummy/templates/rails/database.yml

@@ -1,66 +1,111 @@
 <% if agent_number = ENV['TC_AGENT_NUMBER']
 database_prefix = agent_number + '_'
 end %>
+<% db = case ENV['DB']
+        when 'mysql'
+          'mysql'
+        when 'postgres', 'postgresql'
+          'postgres'
+        when 'sqlite', '', nil
+          'sqlite'
+        else
+          raise "Invalid DB specified: #{ENV['DB']}"
+        end %>
+<% db_host = case db
+             when 'mysql'
+               ENV['DB_MYSQL_HOST'] || ENV['DB_HOST']
+             when 'postgres'
+               ENV['DB_POSTGRES_HOST'] || ENV['DB_HOST']
+             else
+               ENV['DB_HOST']
+             end %>
+<% db_username = ENV['DB_USERNAME'] %>
+<% db_password = ENV['DB_PASSWORD'] %>
+
+
+
+
 <% case ENV['DB']
-  when 'sqlite' %>
-development:
-  adapter: sqlite3
-  database: db/solidus_development.sqlite3
-test:
-  adapter: sqlite3
-  database: db/solidus_test.sqlite3
-  timeout: 10000
-production:
-  adapter: sqlite3
-  database: db/solidus_production.sqlite3
-<% when 'mysql' %>
+  when 'mysql' %>
 development:
   adapter: mysql2
   database: <%= database_prefix %><%= options[:lib_name] %>_solidus_development
+  <% unless db_username.blank? %>
+  username: <%= db_username %>
+  <% end %>
+  <% unless db_password.blank? %>
+  password: <%= db_password %>
+  <% end %>
+  <% unless db_host.blank? %>
+  host: <%= db_host %>
+  <% end %>
   encoding: utf8
 test:
   adapter: mysql2
-  <% if ENV['TRAVIS'] %>
-  username: root
-  password:
-  <% end %>
   database: <%= database_prefix %><%= options[:lib_name] %>_solidus_test
+  <% unless db_username.blank? %>
+  username: <%= db_username %>
+  <% end %>
+  <% unless db_password.blank? %>
+  password: <%= db_password %>
+  <% end %>
+  <% unless db_host.blank? %>
+  host: <%= db_host %>
+  <% end %>
   encoding: utf8
 production:
   adapter: mysql2
   database: <%= database_prefix %><%= options[:lib_name] %>_solidus_production
+  <% unless db_username.blank? %>
+  username: <%= db_username %>
+  <% end %>
+  <% unless db_password.blank? %>
+  password: <%= db_password %>
+  <% end %>
+  <% unless db_host.blank? %>
+  host: <%= db_host %>
+  <% end %>
   encoding: utf8
 <% when 'postgres', 'postgresql' %>
-<% db_host = ENV['DB_HOST'] -%>
-<% db_username = ENV['DB_USERNAME'] -%>
-<% db_password = ENV['DB_PASSWORD'] -%>
 development:
   adapter: postgresql
   database: <%= database_prefix %><%= options[:lib_name] %>_solidus_development
-  username: postgres
-  min_messages: warning
-<% unless db_host.blank? %>
+  <% unless db_username.blank? %>
+  username: <%= db_username %>
+  <% end %>
+  <% unless db_password.blank? %>
+  password: <%= db_password %>
+  <% end %>
+  <% unless db_host.blank? %>
   host: <%= db_host %>
-<% end %>
+  <% end %>
+  min_messages: warning
 test:
   adapter: postgresql
   database: <%= database_prefix %><%= options[:lib_name] %>_solidus_test
-  username: <%= db_username || 'postgres' %>
-<% unless db_password.blank? %>
+  <% unless db_username.blank? %>
+  username: <%= db_username %>
+  <% end %>
+  <% unless db_password.blank? %>
   password: <%= db_password %>
-<% end %>
-  min_messages: warning
-<% unless db_host.blank? %>
+  <% end %>
+  <% unless db_host.blank? %>
   host: <%= db_host %>
-<% end %>
+  <% end %>
+  min_messages: warning
 production:
   adapter: postgresql
   database: <%= database_prefix %><%= options[:lib_name] %>_solidus_production
-  username: postgres
-  min_messages: warning
-<% unless db_host.blank? %>
+  <% unless db_username.blank? %>
+  username: <%= db_username %>
+  <% end %>
+  <% unless db_password.blank? %>
+  password: <%= db_password %>
+  <% end %>
+  <% unless db_host.blank? %>
   host: <%= db_host %>
-<% end %>
+  <% end %>
+  min_messages: warning
 <% when 'sqlite', '', nil %>
 development:
   adapter: sqlite3
@@ -71,6 +116,4 @@ test:
 production:
   adapter: sqlite3
   database: db/solidus_production.sqlite3
-<% else %>
-  <% raise "Invalid DB specified: #{ENV['DB']}" %>
 <% end %>

data/lib/spree/app_configuration.rb

@@ -21,7 +21,6 @@ require "spree/core/search/base"
 require "spree/core/search/variant"
 require 'spree/preferences/configuration'
 require 'spree/core/environment'
-require 'rails/gem_version'
 
 module Spree
   class AppConfiguration < Preferences::Configuration
@@ -166,22 +165,6 @@ module Spree
     #   @return [String] URL of logo used on frontend (default: +'logo/solidus.svg'+)
     preference :logo, :string, default: 'logo/solidus.svg'
 
-    # @!attribute [rw] log_entry_permitted_classes
-    #   @return [Array<String>] An array of extra classes that are allowed to be
-    #     loaded from a serialized YAML as details in {Spree::LogEntry}
-    #     (defaults to a non-frozen empty array, so that extensions can add
-    #     their own classes).
-    #   @example
-    #     config.log_entry_permitted_classes = ['Date']
-    preference :log_entry_permitted_classes, :array, default: []
-
-    # @!attribute [rw] log_entry_allow_aliases
-    #   @return [Boolean] Whether YAML aliases are allowed when loading
-    #     serialized data in {Spree::LogEntry}. It defaults to true. Depending
-    #     on the source of your data, you may consider disabling it to prevent
-    #     entity expansion attacks.
-    preference :log_entry_allow_aliases, :boolean, default: true
-
     # @!attribute [rw] mails_from
     #   @return [String] Email address used as +From:+ field in transactional emails.
     preference :mails_from, :string, default: 'solidus@example.com'
@@ -389,6 +372,28 @@ module Spree
     #   Spree::Wallet::DefaultPaymentBuilder.
     class_name_attribute :default_payment_builder_class, default: 'Spree::Wallet::DefaultPaymentBuilder'
 
+    # Allows providing your own class for managing the contents of an order.
+    #
+    # @!attribute [rw] order_contents_class
+    # @return [Class] a class with the same public interfaces as
+    #   Spree::OrderContents.
+    class_name_attribute :order_contents_class, default: 'Spree::OrderContents'
+
+    # Allows providing your own class for shipping an order.
+    #
+    # @!attribute [rw] order_shipping_class
+    # @return [Class] a class with the same public interfaces as
+    #   Spree::OrderShipping.
+    class_name_attribute :order_shipping_class, default: 'Spree::OrderShipping'
+
+    # Allows providing your own class for managing the inventory units of a
+    # completed order.
+    #
+    # @!attribute [rw] order_cancellations_class
+    # @return [Class] a class with the same public interfaces as
+    #   Spree::OrderCancellations.
+    class_name_attribute :order_cancellations_class, default: 'Spree::OrderCancellations'
+
     # Allows providing your own class for canceling payments.
     #
     # @!attribute [rw] payment_canceller
@@ -460,7 +465,7 @@ module Spree
     # @!attribute [rw] image_attachment_module
     # @return [Module] a module that can be included into Spree::Image to allow attachments
     # Enumerable of images adhering to the present_image_class interface
-    class_name_attribute :image_attachment_module, default: Rails.gem_version >= Gem::Version.new("6.1.0") ? "Spree::Image::ActiveStorageAttachment" : "Spree::Image::PaperclipAttachment"
+    class_name_attribute :image_attachment_module, default: 'Spree::Image::ActiveStorageAttachment'
 
     # @!attribute [rw] allowed_image_mime_types
     #
@@ -470,6 +475,46 @@ module Spree
     # @return [Array]
     class_name_attribute :allowed_image_mime_types, default: %w(image/jpeg image/jpg image/png image/gif).freeze
 
+    # @!attribute [rw] product_image_style_default
+    #
+    # Defines which style to default to when style is not provided
+    # :product is the default.
+    #
+    # @return [Symbol]
+    class_name_attribute :product_image_style_default, default: :product
+
+    # @!attribute [rw] product_image_styles
+    #
+    # Defines image styles/sizes hash for styles
+    # `{ mini: '48x48>',
+    #    small: '400x400>',
+    #    product: '680x680>',
+    #    large: '1200x1200>' } is the default.
+    #
+    # @return [Hash]
+    class_name_attribute :product_image_styles, default: { mini: '48x48>',
+                                                          small: '400x400>',
+                                                          product: '680x680>',
+                                                          large: '1200x1200>' }
+    # @!attribute [rw] taxon_image_style_default
+    #
+    # Defines which style to default to when style is not provided
+    # :mini is the default.
+    #
+    # @return [Symbol]
+    class_name_attribute :taxon_image_style_default, default: :mini
+
+    # @!attribute [rw] taxon_styles
+    #
+    # Defines taxon styles/sizes hash for styles
+    # `{ mini: '48x48>',
+    #    small: '400x400>',
+    #    product: '680x680>',
+    #    large: '1200x1200>' } is the default.
+    #
+    # @return [Hash]
+    class_name_attribute :taxon_image_styles, default: { mini: '32x32>', normal: '128x128>' }
+
     # Allows switching attachment library for Taxon
     #
     # `Spree::Taxon::ActiveStorageAttachment`
@@ -478,7 +523,7 @@ module Spree
     # @!attribute [rw] taxon_attachment_module
     # @return [Module] a module that can be included into Spree::Taxon to allow attachments
     # Enumerable of taxons adhering to the present_taxon_class interface
-    class_name_attribute :taxon_attachment_module, default: Rails.gem_version >= Gem::Version.new("6.1.0") ? "Spree::Taxon::ActiveStorageAttachment" : "Spree::Taxon::PaperclipAttachment"
+    class_name_attribute :taxon_attachment_module, default: 'Spree::Taxon::ActiveStorageAttachment'
 
     # Allows providing your own class instance for generating order numbers.
     #

data/lib/spree/core/engine.rb

@@ -15,12 +15,6 @@ module Spree
         generator.test_framework :rspec
       end
 
-      if ActiveRecord.respond_to?(:yaml_column_permitted_classes) || ActiveRecord::Base.respond_to?(:yaml_column_permitted_classes)
-        config.active_record.yaml_column_permitted_classes ||= []
-        config.active_record.yaml_column_permitted_classes |=
-          [Symbol, BigDecimal, ActiveSupport::HashWithIndifferentAccess]
-      end
-
       initializer "spree.environment", before: :load_config_initializers do |app|
         app.config.spree = Spree::Config.environment
       end
@@ -61,26 +55,17 @@ module Spree
         end
       end
 
-      config.after_initialize do
-        # Load in mailer previews for apps to use in development.
-        # We need to make sure we call `Preview.all` before requiring our
-        # previews, otherwise any previews the app attempts to add need to be
-        # manually required.
-        if Rails.env.development? || Rails.env.test?
-          ActionMailer::Preview.all
+      # Load in mailer previews for apps to use in development.
+      initializer "spree.core.action_mailer.set_preview_path", after: "action_mailer.set_configs" do |app|
+        original_preview_path = app.config.action_mailer.preview_path
+        solidus_preview_path = Spree::Core::Engine.root.join 'lib/spree/mailer_previews'
 
-          Dir[root.join("lib/spree/mailer_previews/**/*_preview.rb")].each do |file|
-            require_dependency file
-          end
-        end
+        app.config.action_mailer.preview_path = "{#{original_preview_path},#{solidus_preview_path}}"
+        ActionMailer::Base.preview_path = app.config.action_mailer.preview_path
       end
 
       config.after_initialize do
-        if defined?(Spree::Auth::Engine) &&
-            Gem::Version.new(Spree::Auth::VERSION) < Gem::Version.new('2.5.4') &&
-            defined?(Spree::UsersController)
-          Spree::UsersController.protect_from_forgery with: :exception
-        end
+        Spree::Config.check_load_defaults_called('Spree::Config')
       end
     end
   end

data/lib/spree/core/product_filters.rb

@@ -61,7 +61,7 @@ module Spree
           scope = scope.or(new_scope)
         end
 
-        Spree::Product.joins(master: :default_price).where(scope)
+        Spree::Product.joins(master: :prices).where(scope)
       end
 
       def self.format_price(amount)

data/lib/spree/core/search/base.rb

@@ -51,7 +51,7 @@ module Spree
           # separate queries most of the time but opt for a join as soon as any
           # `where` constraints affecting joined tables are added to the search;
           # which is the case as soon as a taxon is added to the base scope.
-          scope = scope.preload(master: :currently_valid_prices)
+          scope = scope.preload(master: :prices)
           scope = scope.preload(master: :images) if @properties[:include_images]
           scope
         end

data/lib/spree/core/state_machines/order.rb

@@ -73,7 +73,7 @@ module Spree
               end
 
               event :complete do
-                transition to: :complete, from: :confirm
+                transition to: :complete, from: klass.checkout_steps.keys.last
               end
 
               if states[:payment]

data/lib/spree/core/validators/email.rb

@@ -12,7 +12,7 @@ module Spree
   #     end
   #
   class EmailValidator < ActiveModel::EachValidator
-    EMAIL_REGEXP = URI::MailTo::EMAIL_REGEXP
+    EMAIL_REGEXP = /\A([^@\.]|[^@\.]([^@\s]*)[^@\.])@([^@\s]+\.)+[^@\s]+\z/
 
     def validate_each(record, attribute, value)
       unless EMAIL_REGEXP.match? value

data/lib/spree/core/version.rb

@@ -1,12 +1,16 @@
 # frozen_string_literal: true
 
 module Spree
-  VERSION = "3.0.8"
+  VERSION = "3.1.0"
 
   def self.solidus_version
     VERSION
   end
 
+  def self.previous_solidus_minor_version
+    '3.0'
+  end
+
   def self.solidus_gem_version
     Gem::Version.new(solidus_version)
   end

data/lib/spree/core/versioned_value.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module Spree
+  module Core
+    # Wrapper for a value that can be different depending on the Solidus version
+    #
+    # Some configuration defaults can be added or changed when a new Solidus
+    # version is released. This class encapsulates getting the correct value for a
+    # given Solidus version.
+    #
+    # The way it works is you provide an initial value in time, plus the version
+    # boundary where it got changed. Then you can fetch the value providing the
+    # desired Solidus version:
+    #
+    # @example
+    #   value = VersionedValue.new(true, "3.0.0" => false)
+    #   value.call("2.7.0") # => true
+    #   value.call("3.0.0") # => false
+    #   value.call("3.1.0") # => false
+    #
+    # Remember that you must provide the exact boundary when a value got changed,
+    # which could easily be during a pre-release:
+    #
+    # @example
+    #   value = VersionedValue.new(true, "3.0.0" => false)
+    #   value.call("3.0.0.alpha") # => true
+    #
+    #   value = VersionedValue.new(true, "3.0.0.alpha" => false)
+    #   value.call("3.0.0.alpha") # => false
+    #
+    # Multiple boundaries can also be provided:
+    #
+    # @example
+    #   value = VersionedValue.new(0, "2.0.0" => 1, "3.0.0" => 2)
+    #   value.call("1.0.0") # => 0
+    #   value.call("2.1.0") # => 1
+    #   value.call("3.0.0") # => 2
+    class VersionedValue
+      attr_reader :boundaries
+
+      # @param initial_value [Any]
+      # @param boundary [Hash<String, Any>] Map from version number to new value
+      def initialize(initial_value, boundaries = {})
+        @boundaries = Hash[
+                        { '0' => initial_value }
+                        .merge(boundaries)
+                        .transform_keys { |version| to_gem_version(version) }
+                        .sort
+                      ]
+      end
+
+      # @param solidus_version [String]
+      def call(solidus_version = Spree.solidus_version)
+        solidus_version = to_gem_version(solidus_version)
+        boundaries.fetch(
+          boundaries
+            .keys
+            .reduce do |target, following|
+              if target <= solidus_version && solidus_version < following
+                target
+              else
+                following
+              end
+            end
+        )
+      end
+
+      private
+
+      def to_gem_version(string)
+        Gem::Version.new(string)
+      end
+    end
+  end
+end

data/lib/spree/core.rb

@@ -37,6 +37,16 @@ module Spree
     end
   end
 
+  # Load the same version defaults for all available Solidus components
+  #
+  # @see Spree::Preferences::Configuration#load_defaults
+  def self.load_defaults(version)
+    Spree::Config.load_defaults(version)
+    Spree::Frontend::Config.load_defaults(version) if defined?(Spree::Frontend::Config)
+    Spree::Backend::Config.load_defaults(version) if defined?(Spree::Backend::Config)
+    Spree::Api::Config.load_defaults(version) if defined?(Spree::Api::Config)
+  end
+
   # Used to configure Spree.
   #
   # Example:
@@ -52,6 +62,13 @@ module Spree
   end
 
   module Core
+    def self.has_install_generator_been_run?
+      (Rails.env.test? && Rails.application.class.name == 'DummyApp::Application') ||
+        Rails.application.paths['config/initializers'].paths.any? do |path|
+          File.exist?(path.join('spree.rb'))
+        end
+    end
+
     class GatewayError < RuntimeError; end
   end
 end

data/lib/spree/permitted_attributes.rb

@@ -74,7 +74,7 @@ module Spree
     @@product_properties_attributes = [:property_name, :value, :position]
 
     @@product_attributes = [
-      :name, :description, :available_on, :discontinue_on, :permalink, :meta_description,
+      :name, :description, :available_on, :discontinue_on, :meta_description,
       :meta_keywords, :price, :sku, :deleted_at,
       :option_values_hash, :weight, :height, :width, :depth,
       :shipping_category_id, :tax_category_id,