solidus_core 3.0.2 → 3.1.0

data/lib/spree/app_configuration.rb

@@ -372,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
@@ -453,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`

data/lib/spree/core/engine.rb

@@ -55,18 +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
+        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/version.rb

@@ -1,12 +1,16 @@
 # frozen_string_literal: true
 
 module Spree
-  VERSION = "3.0.2"
+  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,

data/lib/spree/preferences/configuration.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'spree/core/versioned_value'
 require 'spree/preferences/preferable'
 
 module Spree::Preferences
@@ -29,6 +30,44 @@ module Spree::Preferences
   class Configuration
     include Spree::Preferences::Preferable
 
+    # @!attribute [r] loaded_defaults
+    #   @return [String]
+    #     Some configuration defaults can be added or changed when a new Solidus
+    #     version is released. Setting this to an older Solidus version allows keeping
+    #     backward compatibility until the application code is updated to the new
+    #     defaults. Set via {#load_defaults}
+    attr_reader :loaded_defaults
+
+    attr_reader :load_defaults_called
+
+    def initialize
+      @loaded_defaults = Spree.solidus_version
+      @load_defaults_called = false
+    end
+
+    # @param [String] Solidus version from which take defaults when not
+    # overriden.
+    # @see #load_defaults
+    def load_defaults(version)
+      @loaded_defaults = version
+      @load_defaults_called = true
+      reset
+    end
+
+    def check_load_defaults_called(instance_constant_name = nil)
+      return if load_defaults_called || !Spree::Core.has_install_generator_been_run?
+
+      target_name = instance_constant_name || "#{self.class.name}.new"
+      Spree::Deprecation.warn <<~MSG
+        It's recommended that you explicitly load the default configuration for
+        your current Solidus version. You can do it by adding the following call
+        to your Solidus initializer within the #{target_name} block:
+
+          config.load_defaults('#{Spree.solidus_version}')
+
+      MSG
+    end
+
     # @yield [config] Yields this configuration object to a block
     def configure
       yield(self)
@@ -79,6 +118,23 @@ module Spree::Preferences
       end
     end
 
+    # Generates a different preference default depending on {#version_defaults}
+    #
+    # This method is meant to be used in the `default:` keyword argument for
+    # {.preference}. For instance, in the example, `foo`'s default was `true`
+    # until version 3.0.0.alpha, when it became `false`:
+    #
+    # @example
+    #   preference :foo, :boolean, default: by_version(true, "3.0.0.alpha" => false)
+    #
+    # @see #loaded_defaults
+    # @see Spree::Core::VersionedValue
+    def self.by_version(*args)
+      proc do |loaded_defaults|
+        Spree::Core::VersionedValue.new(*args).call(loaded_defaults)
+      end
+    end
+
     def self.preference(name, type, options = {})
       super
       alias_method name.to_s, "preferred_#{name}"
@@ -103,5 +159,11 @@ module Spree::Preferences
         class_name
       end
     end
+
+    private
+
+    def context_for_default
+      [loaded_defaults]
+    end
   end
 end

data/lib/spree/preferences/preferable.rb

@@ -11,6 +11,10 @@ module Spree
     # A class including Preferable must implement #preferences which should return
     # an object responding to .fetch(key), []=(key, val), and .delete(key).
     #
+    # It may also define a `#context_for_default` method. It should return an
+    # array with the arguments to be provided to a proc used as the `default:`
+    # keyword for a preference.
+    #
     # The generated writer method performs typecasting before assignment into the
     # preferences object.
     #
@@ -176,6 +180,10 @@ module Spree
           value
         end
       end
+
+      def context_for_default
+        [].freeze
+      end
     end
   end
 end

data/lib/spree/preferences/preferable_class_methods.rb

@@ -27,7 +27,7 @@ module Spree::Preferences
       end
 
       default = options[:default]
-      default = ->{ options[:default] } unless default.is_a?(Proc)
+      default = proc { options[:default] } unless default.is_a?(Proc)
 
       # The defined preferences on a class are all those defined directly on
       # that class as well as those defined on ancestors.
@@ -44,7 +44,7 @@ module Spree::Preferences
       # is a pending preference before going to default
       define_method preference_getter_method(name) do
         value = preferences.fetch(name) do
-          default.call
+          default.call(*context_for_default)
         end
         value = preference_encryptor.decrypt(value) if preference_encryptor.present?
         value
@@ -60,7 +60,9 @@ module Spree::Preferences
         preferences_will_change! if respond_to?(:preferences_will_change!)
       end
 
-      define_method preference_default_getter_method(name), &default
+      define_method preference_default_getter_method(name) do
+        default.call(*context_for_default)
+      end
 
       define_method preference_type_getter_method(name) do
         type

data/lib/spree/preferences/preference_differentiator.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Spree
+  module Preferences
+    class PreferenceDifferentiator
+      attr_reader :config_class
+
+      def initialize(config_class)
+        @config_class = config_class
+      end
+
+      def call(from:, to:)
+        preferences_from = config_class.new.load_defaults(from)
+        preferences_to = config_class.new.load_defaults(to)
+        preferences_from.reduce({}) do |changes, (pref_key, value_from)|
+          value_to = preferences_to[pref_key]
+          if value_from == value_to
+            changes
+          else
+            changes.merge(
+              pref_key => { from: value_from, to: value_to }
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/spree/testing_support/dummy_app/database.yml

@@ -1,34 +1,54 @@
-<%
-database_prefix = ENV['LIB_NAME'].presence || "solidus"
-%>
-<% case ENV['DB']
+<% 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_prefix = ENV['LIB_NAME'].presence || "solidus" %>
+<% db_username = ENV['DB_USERNAME'] %>
+<% db_password = ENV['DB_PASSWORD'] %>
+<% case db
 when 'mysql' %>
 test:
   adapter: mysql2
-  <% if ENV['CI'] %>
-  username: root
-  password:
+  database: <%= db_prefix %>_test
+  <% unless db_username.blank? %>
+  username: <%= db_username %>
   <% end %>
-  database: <%= database_prefix %>_test
-  encoding: utf8
-  <% unless ENV['DB_HOST'].blank? %>
-  host: <%= ENV['DB_HOST'] %>
+  <% unless db_password.blank? %>
+  password: <%= db_password %>
+  <% end %>
+  <% unless db_host.blank? %>
+  host: <%= db_host %>
   <% end %>
-<% when 'postgres', 'postgresql' %>
-<% db_host = ENV['DB_HOST'] %>
+  encoding: utf8
+<% when 'postgres' %>
 test:
   adapter: postgresql
-  database: <%= database_prefix %>_test
-  username: postgres
-  min_messages: warning
-<% unless db_host.blank? %>
+  database: <%= db_prefix %>_test
+  username: <%= db_username.presence || "postgres" %>
+  <% unless db_password.blank? %>
+  password: <%= db_password %>
+  <% end %>
+  <% unless db_host.blank? %>
   host: <%= db_host %>
-<% end %>
-<% when 'sqlite', '', nil %>
+  <% end %>
+  min_messages: warning
+<% when 'sqlite' %>
 test:
   adapter: sqlite3
-  database: db/<%= database_prefix %>_test.sqlite3
+  database: db/<%= db_prefix %>_test.sqlite3
   timeout: 10000
-<% else %>
-  <% raise "Invalid DB specified: #{ENV['DB']}" %>
 <% end %>