solidus_core 3.0.1 → 3.1.2

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,24 @@ module Spree
   end
 
   module Core
+    # @api private
+    def self.has_install_generator_been_run?(rails_paths: Rails.application.paths, initializer_name: 'spree.rb', dummy_app_name: 'DummyApp::Application')
+      does_spree_initializer_exist?(rails_paths, initializer_name) ||
+        running_solidus_test_suite_with_dummy_app?(dummy_app_name)
+    end
+
+    def self.running_solidus_test_suite_with_dummy_app?(dummy_app_name)
+      Rails.env.test? && Rails.application.class.name == dummy_app_name
+    end
+    private_class_method :running_solidus_test_suite_with_dummy_app?
+
+    def self.does_spree_initializer_exist?(rails_paths, initializer_name)
+      rails_paths['config/initializers'].any? do |path|
+        File.exist?(Pathname.new(path).join(initializer_name))
+      end
+    end
+    private_class_method :does_spree_initializer_exist?
+
     class GatewayError < RuntimeError; end
   end
 end

data/lib/spree/permitted_attributes.rb

@@ -51,7 +51,13 @@ module Spree
       :month, :year, :expiry, :first_name, :last_name, :name
     ]
 
-    @@customer_return_attributes = [:stock_location_id, return_items_attributes: [:id, :inventory_unit_id, :return_authorization_id, :returned, :amount, :reception_status_event, :acceptance_status, :exchange_variant_id, :resellable]]
+    @@customer_return_attributes = [
+      :stock_location_id, return_items_attributes: [
+        :id, :inventory_unit_id, :return_authorization_id, :returned, :amount,
+        :reception_status_event, :acceptance_status, :exchange_variant_id,
+        :resellable, :return_reason_id
+      ]
+    ]
 
     @@image_attributes = [:alt, :attachment, :position, :viewable_type, :viewable_id]
 
@@ -68,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

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'spree/deprecation'
 require 'spree/encryptor'
 
 module Spree::Preferences
@@ -26,8 +27,38 @@ module Spree::Preferences
         options[:default] = preference_encryptor.encrypt(options[:default])
       end
 
-      default = options[:default]
-      default = ->{ options[:default] } unless default.is_a?(Proc)
+      default = begin
+                  given = options[:default]
+                  if ancestors.include?(Spree::Preferences::Configuration) &&
+                     given.is_a?(Proc) &&
+                     given.lambda? &&
+                     given.arity.zero?
+                    Spree::Deprecation.warn <<~MSG
+                      The arity of a proc given as the default for a preference
+                      has changed from 0 to 1 on Solidus 3.1. The Solidus
+                      version for the loaded preference defaults is given as the
+                      proc's argument from this point on.
+
+                      If you don't need to return a different default value
+                      depending on the loaded Solidus version, you can change
+                      the proc so that it doesn't have lambda semantics (lambdas
+                      raise when extra arguments are supplied, while raw procs
+                      don't). E.g.:
+
+                      preference :foo, :string, default: proc { true }
+
+                      If you want to branch on the provided Solidus version, you can do like the following:
+
+                      preference :foo, :string, default: by_version(true, "3.2.0" => false)
+
+                    MSG
+                    ->(_default_context) { given.call }
+                  elsif given.is_a?(Proc)
+                    given
+                  else
+                    proc { given }
+                  end
+                end
 
       # The defined preferences on a class are all those defined directly on
       # that class as well as those defined on ancestors.
@@ -44,7 +75,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 +91,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 %>

data/lib/spree/testing_support/dummy_app.rb

@@ -46,34 +46,53 @@ module DummyApp
   end
 
   class Application < ::Rails::Application
-    config.eager_load = false
+    config.load_defaults("#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}")
+    # Make the test environment more production-like:
     config.cache_classes = true
-    config.cache_store = :memory_store
-    config.serve_static_assets = true
-    config.public_file_server.headers = { 'Cache-Control' => 'public, max-age=3600' }
-    config.whiny_nils = true
-    config.consider_all_requests_local = true
     config.action_controller.allow_forgery_protection = false
     config.action_controller.default_protect_from_forgery = false
+    config.action_mailer.perform_caching = false
+    config.i18n.fallbacks = true
+
+    # In the test environment, we use the `caching: true` RSpec metadata to
+    # enable caching on select specs. See
+    # core/lib/spree/testing_support/caching.rb. See also
+    # https://github.com/solidusio/solidus/issues/4110
     config.action_controller.perform_caching = false
+
+    # Make debugging easier:
+    config.consider_all_requests_local = true
     config.action_dispatch.show_exceptions = false
     config.active_support.deprecation = :stderr
+    config.log_level = :debug
+
+    # Improve test suite performance:
+    config.eager_load = false
+    config.public_file_server.headers = { 'Cache-Control' => 'public, max-age=3600' }
+    config.cache_store = :memory_store
+
+    # We don't use a web server, so we let Rails serve assets.
+    config.public_file_server.enabled = true
+
+    # We don't want to send email in the test environment.
     config.action_mailer.delivery_method = :test
-    config.active_support.deprecation = :stderr
+
+    # No need to use credentials file in a test environment.
     config.secret_key_base = 'SECRET_TOKEN'
 
-    config.action_mailer.delivery_job = "ActionMailer::MailDeliveryJob" if RAILS_6_OR_ABOVE
+    # Set the preview path within the dummy app:
     config.action_mailer.preview_path = File.expand_path('dummy_app/mailer_previews', __dir__)
-    config.active_record.sqlite3.represent_boolean_as_integer = true unless RAILS_6_OR_ABOVE
 
-    config.storage_path = Rails.root.join('tmp', 'storage')
+    config.active_record.sqlite3.represent_boolean_as_integer = true unless RAILS_6_OR_ABOVE
+    config.active_record.dump_schema_after_migration = false
 
+    # Configure active storage to use storage within tmp folder
     unless ENV['DISABLE_ACTIVE_STORAGE']
       initializer 'solidus.active_storage' do
         config.active_storage.service_configurations = {
           test: {
             service: 'Disk',
-            root: config.storage_path
+            root: Rails.root.join('tmp', 'storage')
           }
         }
         config.active_storage.service = :test
@@ -94,12 +113,8 @@ module DummyApp
     config.paths['db/migrate'] = migration_dirs
     ActiveRecord::Migrator.migrations_paths = migration_dirs
 
-    config.action_controller.include_all_helpers = false
-
-    if config.respond_to?(:assets)
-      config.assets.paths << File.expand_path('dummy_app/assets/javascripts', __dir__)
-      config.assets.paths << File.expand_path('dummy_app/assets/stylesheets', __dir__)
-    end
+    config.assets.paths << File.expand_path('dummy_app/assets/javascripts', __dir__)
+    config.assets.paths << File.expand_path('dummy_app/assets/stylesheets', __dir__)
 
     config.paths["config/database"] = File.expand_path('dummy_app/database.yml', __dir__)
     config.paths['app/views'] = File.expand_path('dummy_app/views', __dir__)
@@ -116,6 +131,7 @@ ActiveSupport.on_load(:action_controller) do
 end
 
 Spree.user_class = 'Spree::LegacyUser'
+Spree.load_defaults(Spree.solidus_version)
 Spree.config do |config|
   config.mails_from = "store@example.com"
 

data/lib/tasks/solidus/delete_prices_with_nil_amount.rake

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+namespace :solidus do
+  desc "Delete Spree::Price records which amount field is NULL"
+  task delete_prices_with_nil_amount: :environment do
+    Spree::Price.where(amount: nil).delete_all
+  end
+end

data/solidus_core.gemspec

@@ -55,7 +55,12 @@ $ bin/rails g solidus:install
 If you are updating Solidus from an older version, please run
 the following commands to complete the update:
 
-$ bin/rails solidus:upgrade
+$ bin/rails g solidus:update
+
+Please, don't forget to look at the CHANGELOG to see what has changed and
+whether you need to perform other tasks.
+
+https://github.com/solidusio/solidus/blob/master/CHANGELOG.md
 
 Please report any issues at:
 - https://github.com/solidusio/solidus/issues

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solidus_core
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.1.2
 platform: ruby
 authors:
 - Solidus Team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-10 00:00:00.000000000 Z
+date: 2021-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionmailer
@@ -609,7 +609,6 @@ files:
 - app/models/spree/tax/item_tax.rb
 - app/models/spree/tax/order_adjuster.rb
 - app/models/spree/tax/order_tax.rb
-- app/models/spree/tax/shipping_rate_taxer.rb
 - app/models/spree/tax/tax_helpers.rb
 - app/models/spree/tax/tax_location.rb
 - app/models/spree/tax_calculator/default.rb
@@ -705,6 +704,7 @@ files:
 - db/migrate/20200530111458_add_bcc_email_to_spree_stores.rb
 - db/migrate/20201008213609_add_discontinue_on_to_spree_products.rb
 - db/migrate/20210122110141_add_name_to_spree_addresses.rb
+- db/migrate/20210312061050_change_column_null_on_prices.rb
 - db/seeds.rb
 - lib/generators/solidus/install/install_generator.rb
 - lib/generators/solidus/install/templates/config/initializers/spree.rb.tt
@@ -712,6 +712,8 @@ files:
 - lib/generators/solidus/install/templates/vendor/assets/javascripts/spree/frontend/all.js
 - lib/generators/solidus/install/templates/vendor/assets/stylesheets/spree/backend/all.css
 - lib/generators/solidus/install/templates/vendor/assets/stylesheets/spree/frontend/all.css
+- lib/generators/solidus/update/templates/config/initializers/new_solidus_defaults.rb.tt
+- lib/generators/solidus/update/update_generator.rb
 - lib/generators/spree/custom_user/custom_user_generator.rb
 - lib/generators/spree/custom_user/templates/authentication_helpers.rb.tt
 - lib/generators/spree/custom_user/templates/migration.rb.tt
@@ -765,6 +767,7 @@ files:
 - lib/spree/core/stock_configuration.rb
 - lib/spree/core/validators/email.rb
 - lib/spree/core/version.rb
+- lib/spree/core/versioned_value.rb
 - lib/spree/deprecation.rb
 - lib/spree/encryptor.rb
 - lib/spree/event.rb
@@ -804,6 +807,7 @@ files:
 - lib/spree/preferences/persistable.rb
 - lib/spree/preferences/preferable.rb
 - lib/spree/preferences/preferable_class_methods.rb
+- lib/spree/preferences/preference_differentiator.rb
 - lib/spree/preferences/scoped_store.rb
 - lib/spree/preferences/static_model_preferences.rb
 - lib/spree/preferences/statically_configurable.rb
@@ -903,7 +907,7 @@ files:
 - lib/spree/testing_support/url_helpers.rb
 - lib/spree/user_class_handle.rb
 - lib/spree_core.rb
-- lib/tasks/upgrade.rake
+- lib/tasks/solidus/delete_prices_with_nil_amount.rake
 - solidus_core.gemspec
 - vendor/assets/javascripts/jquery.payment.js
 - vendor/assets/javascripts/jsuri.js
@@ -924,7 +928,12 @@ post_install_message: |
   If you are updating Solidus from an older version, please run
   the following commands to complete the update:
 
-  $ bin/rails solidus:upgrade
+  $ bin/rails g solidus:update
+
+  Please, don't forget to look at the CHANGELOG to see what has changed and
+  whether you need to perform other tasks.
+
+  https://github.com/solidusio/solidus/blob/master/CHANGELOG.md
 
   Please report any issues at:
   - https://github.com/solidusio/solidus/issues
@@ -944,7 +953,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.8.23
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Essential models, mailers, and classes for the Solidus e-commerce project.

data/app/models/spree/tax/shipping_rate_taxer.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-module Spree
-  module Tax
-    # Used to build shipping rate taxes
-    class ShippingRateTaxer
-      # Build shipping rate taxes for a shipping rate
-      # Modifies the passed-in shipping rate with associated shipping rate taxes.
-      # @param [Spree::ShippingRate] shipping_rate The shipping rate to add taxes to.
-      #   This parameter will be modified.
-      # @return [Spree::ShippingRate] The shipping rate with associated tax objects
-      def tax(shipping_rate)
-        taxes = Spree::Config.shipping_rate_tax_calculator_class.new(shipping_rate.order).calculate(shipping_rate)
-        taxes.each do |tax|
-          shipping_rate.taxes.build(
-            amount: tax.amount,
-            tax_rate: tax.tax_rate
-          )
-        end
-        shipping_rate
-      end
-    end
-  end
-end

data/lib/tasks/upgrade.rake

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-namespace :solidus do
-  namespace :upgrade do
-    task three_point_zero: [
-        'railties:install:migrations',
-        'db:migrate'
-      ] do
-      puts "Your Solidus install is ready for Solidus 3.0"
-    end
-  end
-
-  desc "Upgrade to the current Solidus version"
-  task upgrade: 'upgrade:three_point_zero'
-end