solidus_core 3.4.2 → 4.1.0

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 'spree/rails_compatibility'
 
 module Spree
   class AppConfiguration < Preferences::Configuration
@@ -61,27 +60,6 @@ module Spree
     #   @return [Boolean] When false, customers must create an account to complete an order (default: +true+)
     preference :allow_guest_checkout, :boolean, default: true
 
-    # @!attribute [rw] allow_promotions_any_match_policy
-    #   @return [Boolean] When false, admins cannot create promotions with an "any" match policy (default: +false+)
-    #                     Create individual, separate promotions for each of your rules instead.
-    preference :allow_promotions_any_match_policy, :boolean, default: false
-    def allow_promotions_any_match_policy=(value)
-      if value == true
-        Spree::Deprecation.warn <<~MSG
-          Solidus 4.0 will remove support for combining promotion rules with the "any" match policy.
-
-          Instead, it's suggested to create individual, separate promotions for each of your current
-          rules combined with the "any" policy. To automate this task, you can use the provided
-          task:
-
-                  bin/rake solidus:split_promotions_with_any_match_policy
-        MSG
-      end
-
-      preferences[:allow_promotions_any_match_policy] = value
-    end
-
-
     # @!attribute [rw] guest_token_cookie_options
     #   @return [Hash] Add additional guest_token cookie options here (ie. domain or path)
     preference :guest_token_cookie_options, :hash, default: {}
@@ -171,38 +149,6 @@ module Spree
     #   @return [Regexp] Regex to be used in email validations, for example in Spree::EmailValidator
     preference :default_email_regexp, :regexp, default: URI::MailTo::EMAIL_REGEXP
 
-    # @!attribute [rw] extra_taxon_validations
-    #   Use extra validations on Taxons in 3.4.0, but default to false so stores can
-    #   upgrade and then fix any now invalid Taxons before enabling.
-    #   @return [Boolean]
-    versioned_preference :extra_taxon_validations, :boolean, initial_value: false, boundaries: { "3.4.0.dev" => true }
-    def extra_taxon_validations=(value)
-      Spree::Deprecation.warn <<~MSG
-        Solidus will remove `Spree::Config.extra_taxon_validations` preference
-        in the next major release and will always use the extra Taxon validations.
-        Before upgrading to the next major, please fix any now invalid Taxons
-        and then remove the preference definition in `config/initializers/spree.rb`.
-      MSG
-
-      preferences[:extra_taxon_validations] = value
-    end
-
-    # @!attribute [rw] extra_taxonomy_validations
-    #   Use extra validations on Taxonomies in 3.4.0, but default to false so stores can
-    #   upgrade and then fix any now invalid Taxonomies before enabling.
-    #   @return [Boolean]
-    versioned_preference :extra_taxonomy_validations, :boolean, initial_value: false, boundaries: { "3.4.0.dev" => true }
-    def extra_taxonomy_validations=(value)
-      Spree::Deprecation.warn <<~MSG
-        Solidus will remove `Spree::Config.extra_taxonomy_validations` preference
-        in the next major release and will always use the extra Taxonomy validations.
-        Before upgrading to the next major, please fix any now invalid Taxons
-        and then remove the preference definition in `config/initializers/spree.rb`.
-      MSG
-
-      preferences[:extra_taxonomy_validations] = value
-    end
-
     # @!attribute [rw] generate_api_key_for_all_roles
     #   @return [Boolean] Allow generating api key automatically for user
     #   at role_user creation for all roles. (default: +false+)
@@ -239,20 +185,6 @@ module Spree
     #     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.
-    #   @deprecated Spree::Store#mail_from_address is used instead
-    preference :mails_from, :string, default: 'solidus@example.com'
-    def mails_from=(value)
-      Spree::Deprecation.warn(<<~MSG) && preferences[:mail_from] = value
-        Solidus doesn't use `Spree::Config.mails_from` preference and it'll
-        removed on the next major release. Please, remove its definition in
-        `config/initializers/spree.rb`. Use the `Spree::Store#mail_from_address`
-        attribute for the default email address used as the 'From:' field in
-        transactional emails.
-      MSG
-    end
-
     # @!attribute [rw] max_level_in_taxons_menu
     #   @return [Integer] maximum nesting level in taxons menu (default: +1+)
     preference :max_level_in_taxons_menu, :integer, default: 1
@@ -347,14 +279,6 @@ module Spree
     #   @return [] Track on_hand values for variants / products. (default: true)
     preference :track_inventory_levels, :boolean, default: true
 
-    # @!attribute [rw] use_legacy_events
-    #   Before v3.2, Solidus used a custom pub/sub implementation based on
-    #   ActiveSupport::Notifications. Now, we internally use and recommend
-    #   [Omnes](https://github.com/nebulab/omnes). This preference allows falling
-    #   back to the old system.
-    #   @return [Boolean]
-    versioned_preference :use_legacy_events, :boolean, initial_value: true, boundaries: { "3.2.0.alpha" => false }
-
     # Other configurations
 
     # Allows restricting what currencies will be available.
@@ -433,6 +357,14 @@ module Spree
     #   with the same signature as Spree::OrderUpdateAttributes.
     class_name_attribute :order_update_attributes_class, default: 'Spree::OrderUpdateAttributes'
 
+    # Allows providing a different order recalculator.
+    # @!attribute [rw] order_recalculator_class
+    # @see Spree::OrderUpdater
+    # @return [Class] an object that conforms to the API of
+    #   the standard order recalculator class
+    #   Spree::OrderUpdater.
+    class_name_attribute :order_recalculator_class, default: 'Spree::OrderUpdater'
+
     # Allows providing your own Mailer for promotion code batch mailer.
     #
     # @!attribute [rw] promotion_code_batch_mailer_class
@@ -566,7 +498,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: Spree::RailsCompatibility.default_image_attachment_module
+    class_name_attribute :image_attachment_module, default: "Spree::Image::ActiveStorageAttachment"
 
     # @!attribute [rw] allowed_image_mime_types
     #
@@ -633,7 +565,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: Spree::RailsCompatibility.default_taxon_attachment_module
+    class_name_attribute :taxon_attachment_module, default: "Spree::Taxon::ActiveStorageAttachment"
 
     # Configures the absolute path that contains the Solidus engine
     # migrations. This will be checked at app boot to confirm that all Solidus
@@ -676,10 +608,6 @@ module Spree
       end
     end
 
-    def events
-      @events_configuration ||= Spree::Event::Configuration.new
-    end
-
     def user_last_url_storer_rules
       @user_last_url_storer_rules ||= ::Spree::Core::ClassConstantizer::Set.new.tap do |set|
         set << 'Spree::UserLastUrlStorer::Rules::AuthenticationRule'

data/lib/spree/bus.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'omnes'
 
 module Spree
@@ -5,16 +7,5 @@ module Spree
   #
   # This is used for internal events, while host applications are also able to
   # use it.
-  #
-  # It has some modifications to support internal usage of the legacy event
-  # system {see Spree::AppConfiguration#use_legacy_events}.
   Bus = Omnes::Bus.new
-  def Bus.publish(event, **kwargs)
-    if Spree::Config.use_legacy_events
-      Spree::Event.fire(event, **kwargs)
-    else
-      # Override caller_location to point to the actual event publisher
-      super(event, **kwargs, caller_location: caller_locations(1)[0])
-    end
-  end
 end

data/lib/spree/core/controller_helpers/auth.rb

@@ -17,7 +17,6 @@ module Spree
 
         included do
           before_action :set_guest_token
-          helper_method :try_spree_current_user
           helper_method :spree_current_user
 
           class_attribute :unauthorized_redirect
@@ -58,21 +57,6 @@ module Spree
         def spree_current_user
           defined?(super) ? super : nil
         end
-
-        # proxy method to *possible* spree_current_user method
-        # Authentication extensions (such as spree_auth_devise) are meant to provide spree_current_user
-        def try_spree_current_user
-          # This one will be defined by apps looking to hook into Spree
-          # As per authentication_helpers.rb
-          if respond_to?(:spree_current_user, true)
-            spree_current_user
-          # This one will be defined by Devise
-          elsif respond_to?(:current_spree_user, true)
-            current_spree_user
-          end
-        end
-
-        deprecate try_spree_current_user: :spree_current_user, deprecator: Spree::Deprecation
       end
     end
   end

data/lib/spree/core/engine.rb

@@ -52,27 +52,17 @@ module Spree
 
       # Setup pub/sub
       initializer 'spree.core.pub_sub' do |app|
-        if Spree::Config.use_legacy_events
-          app.reloader.to_prepare do
-            Spree::Event.activate_autoloadable_subscribers
-          end
-
-          app.reloader.before_class_unload do
-            Spree::Event.deactivate_all_subscribers
-          end
-        else
-          app.reloader.to_prepare do
-            Spree::Bus.clear
-
-            %i[
-              order_finalized
-              order_recalculated
-              reimbursement_reimbursed
-              reimbursement_errored
-            ].each { |event_name| Spree::Bus.register(event_name) }
-
-            Spree::OrderMailerSubscriber.new.subscribe_to(Spree::Bus)
-          end
+        app.reloader.to_prepare do
+          Spree::Bus.clear
+
+          %i[
+            order_finalized
+            order_recalculated
+            reimbursement_reimbursed
+            reimbursement_errored
+          ].each { |event_name| Spree::Bus.register(event_name) }
+
+          Spree::OrderMailerSubscriber.new.subscribe_to(Spree::Bus)
         end
       end
 
@@ -97,16 +87,6 @@ module Spree
           Spree::UsersController.protect_from_forgery with: :exception
         end
       end
-
-      config.after_initialize do
-        if Spree::Config.use_legacy_events && !ENV['CI']
-          Spree::Deprecation.warn <<~MSG
-            Your Solidus store is using the legacy event system. You're
-            encouraged to switch to the new event bus. After you're done, you
-            can remove the `use_legacy_events` setting from `spree.rb`.
-          MSG
-        end
-      end
     end
   end
 end

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

@@ -40,7 +40,7 @@ module Spree
             end
 
             # Really ensure that the order totals & states are correct
-            order.updater.update
+            order.recalculate
             if shipments_attrs.present?
               order.shipments.each_with_index do |shipment, index|
                 shipment.update_columns(cost: shipments_attrs[index][:cost].to_f) if shipments_attrs[index][:cost].present?

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

@@ -12,10 +12,6 @@ module Spree
   #     end
   #
   class EmailValidator < ActiveModel::EachValidator
-    EMAIL_REGEXP = URI::MailTo::EMAIL_REGEXP
-    # Use Spree::Config.default_email_regexp instead
-    deprecate_constant :EMAIL_REGEXP
-
     def validate_each(record, attribute, value)
       unless Spree::Config.default_email_regexp.match? value
         record.errors.add(attribute, :invalid, **{ value: value }.merge!(options))

data/lib/spree/core/version.rb

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
 module Spree
-  VERSION = "3.4.2"
+  VERSION = "4.1.0"
 
   def self.solidus_version
     VERSION
   end
 
   def self.previous_solidus_minor_version
-    '3.3'
+    '4.0'
   end
 
   def self.solidus_gem_version

data/lib/spree/core.rb

@@ -20,7 +20,6 @@ require 'ransack'
 require 'state_machines-activerecord'
 
 require 'spree/deprecation'
-require 'spree/rails_compatibility'
 
 # This is required because ActiveModel::Validations#invalid? conflicts with the
 # invalid state of a Payment. In the future this should be removed.
@@ -94,7 +93,6 @@ require 'spree/core/environment/promotions'
 require 'spree/core/environment'
 require 'spree/migrations'
 require 'spree/migration_helpers'
-require 'spree/event'
 require 'spree/bus'
 require 'spree/core/engine'
 

data/lib/spree/migration_helpers.rb

@@ -6,9 +6,9 @@ module Spree
       remove_index(table, column) if index_exists?(table, column)
     end
 
-    def safe_add_index(table, column, options = {})
-      if columns_exist?(table, column) && !index_exists?(table, column, options)
-        add_index(table, column, options)
+    def safe_add_index(table, column, **options)
+      if columns_exist?(table, column) && !index_exists?(table, column, **options)
+        add_index(table, column, **options)
       end
     end
 

data/lib/spree/permission_sets/configuration_display.rb

@@ -2,9 +2,27 @@
 
 module Spree
   module PermissionSets
+    # Read-only permissions for e-commerce settings.
+    #
+    # Roles with this permission will be able to view information, also from the admin
+    # panel, about:
+    #
+    # - Tax categories
+    # - Tax rates
+    # - Zones
+    # - Countries
+    # - States
+    # - Payment methods
+    # - Taxonomies
+    # - Shipping methods
+    # - Shipping categories
+    # - Stock locations
+    # - Stock movements
+    # - Refund reasons
+    # - Reimbursement types
+    # - Return reasons
     class ConfigurationDisplay < PermissionSets::Base
       def activate!
-          can [:edit, :admin], :general_settings
           can [:read, :admin], Spree::TaxCategory
           can [:read, :admin], Spree::TaxRate
           can [:read, :admin], Spree::Zone

data/lib/spree/permission_sets/configuration_management.rb

@@ -2,9 +2,26 @@
 
 module Spree
   module PermissionSets
+    # Read and write permissions for e-commerce settings.
+    #
+    # Roles with this permission set will have full control over:
+    #
+    # - Tax categories
+    # - Tax rates
+    # - Zones
+    # - Countries
+    # - States
+    # - Payment methods
+    # - Taxonomies
+    # - Shipping methods
+    # - Shipping categories
+    # - Stock locations
+    # - Stock movements
+    # - Refund reasons
+    # - Reimbursement types
+    # - Return reasons
     class ConfigurationManagement < PermissionSets::Base
       def activate!
-        can :manage, :general_settings
         can :manage, Spree::TaxCategory
         can :manage, Spree::TaxRate
         can :manage, Spree::Zone

data/lib/spree/permission_sets/dashboard_display.rb

@@ -2,6 +2,11 @@
 
 module Spree
   module PermissionSets
+    # Permissions for viewing the admin dashboard.
+    #
+    # Roles with this permission set will be able to view the admin dashboard,
+    # which may or not contain sensitive information depending on
+    # customizations.
     class DashboardDisplay < PermissionSets::Base
       def activate!
           can [:admin, :home], :dashboards

data/lib/spree/permission_sets/default_customer.rb

@@ -2,6 +2,35 @@
 
 module Spree
   module PermissionSets
+    # Permissions for e-commerce customers.
+    #
+    # This permission set is always added to the `:default` role, which in turn
+    # is the default role for all users without any explicit roles.
+    #
+    # Permissions include reading and updating orders when the ability's user
+    # has been assigned as the order's user, unless the order is already
+    # completed. Same is true for guest checkout orders.
+    #
+    # It grants read-only permissions for the following resources typically used
+    # during a checkout process:
+    #
+    # - Zones
+    # - Countries
+    # - States
+    # - Taxons
+    # - Taxonomies
+    # - Products
+    # - Properties
+    # - Product properties
+    # - Variants
+    # - Option types
+    # - Option values
+    # - Stock items
+    # - Stock locations
+    #
+    # Abilities with this role can also create refund authorizations for orders
+    # with the same user, as well as reading and updating the user record and
+    # their associated cards.
     class DefaultCustomer < PermissionSets::Base
       def activate!
         can :read, Country

data/lib/spree/permission_sets/order_display.rb

@@ -2,6 +2,25 @@
 
 module Spree
   module PermissionSets
+    # Read permissions for orders.
+    #
+    # This permission set allows users to view all related information about
+    # orders, also from the admin panel, including:
+    #
+    # - Orders
+    # - Payments
+    # - Shipments
+    # - Adjustments
+    # - Line items
+    # - Return authorizations
+    # - Customer returns
+    # - Order cancellations
+    # - Reimbursements
+    # - Return items
+    # - Refunds
+    #
+    # However, it does not allow any modifications to be made to any of these
+    # resources.
     class OrderDisplay < PermissionSets::Base
       def activate!
         can [:read, :admin, :edit, :cart], Spree::Order

data/lib/spree/permission_sets/order_management.rb

@@ -2,6 +2,24 @@
 
 module Spree
   module PermissionSets
+    # Full permissions for order management.
+    #
+    # This permission set grants full control over all order and related resources,
+    # including:
+    #
+    # - Orders
+    # - Payments
+    # - Shipments
+    # - Adjustments
+    # - Line items
+    # - Return authorizations
+    # - Customer returns
+    # - Order cancellations
+    # - Reimbursements
+    # - Return items
+    # - Refunds
+    #
+    # It also allows reading reimbursement types, but not modifying them.
     class OrderManagement < PermissionSets::Base
       def activate!
         can :read, Spree::ReimbursementType

data/lib/spree/permission_sets/product_display.rb

@@ -2,6 +2,20 @@
 
 module Spree
   module PermissionSets
+    # Read-only permissions for products.
+    #
+    # This permission set allows users to view all related information about
+    # products, also from the admin panel, including:
+    #
+    # - Products
+    # - Images
+    # - Variants
+    # - Option values
+    # - Product properties
+    # - Option types
+    # - Properties
+    # - Taxonomies
+    # - Taxons
     class ProductDisplay < PermissionSets::Base
       def activate!
         can [:read, :admin, :edit], Spree::Product

data/lib/spree/permission_sets/product_management.rb

@@ -2,6 +2,22 @@
 
 module Spree
   module PermissionSets
+    # Full permissions for product management.
+    #
+    # This permission set grants full control over all product and related resources,
+    # including:
+    #
+    # - Products
+    # - Images
+    # - Variants
+    # - Option values
+    # - Product properties
+    # - Option types
+    # - Properties
+    # - Taxonomies
+    # - Taxons
+    # - Classifications
+    # - Prices
     class ProductManagement < PermissionSets::Base
       def activate!
         can :manage, Spree::Classification

data/lib/spree/permission_sets/promotion_display.rb

@@ -2,6 +2,16 @@
 
 module Spree
   module PermissionSets
+    # Read-only permissions for promotions.
+    #
+    # This permission set allows users to view all related information about
+    # promotions, also from the admin panel, including:
+    #
+    # - Promotions
+    # - Promotion rules
+    # - Promotion actions
+    # - Promotion categories
+    # - Promotion codes
     class PromotionDisplay < PermissionSets::Base
       def activate!
         can [:read, :admin, :edit], Spree::Promotion

data/lib/spree/permission_sets/promotion_management.rb

@@ -2,6 +2,16 @@
 
 module Spree
   module PermissionSets
+    # Full permissions for promotion management.
+    #
+    # This permission set grants full control over all promotion and related resources,
+    # including:
+    #
+    # - Promotions
+    # - Promotion rules
+    # - Promotion actions
+    # - Promotion categories
+    # - Promotion codes
     class PromotionManagement < PermissionSets::Base
       def activate!
         can :manage, Spree::Promotion

data/lib/spree/permission_sets/restricted_stock_display.rb

@@ -2,6 +2,11 @@
 
 module Spree
   module PermissionSets
+    # Read permissions for stock limited to allowed locations.
+    #
+    # This permission set allows users to view information about stock items and
+    # locations, both of them limited to locations they have access to.
+    # Permissions are also granted for the admin panel for items.
     class RestrictedStockDisplay < PermissionSets::Base
       def activate!
         can [:read, :admin], Spree::StockItem, stock_location_id: location_ids

data/lib/spree/permission_sets/restricted_stock_management.rb

@@ -2,6 +2,11 @@
 
 module Spree
   module PermissionSets
+    # Full permissions for stock management limited to allowed locations.
+    #
+    # This permission set grants full control over all stock items a user has
+    # access to their locations. Those locations are also readable by the
+    # corresponding ability.
     class RestrictedStockManagement < PermissionSets::Base
       def activate!
         can :manage, Spree::StockItem, stock_location_id: location_ids

data/lib/spree/permission_sets/stock_display.rb

@@ -2,6 +2,10 @@
 
 module Spree
   module PermissionSets
+    # Read-only permissions for stock.
+    #
+    # This permission set allows users to view information about stock items
+    # (also from the admin panel) and stock locations.
     class StockDisplay < PermissionSets::Base
       def activate!
         can [:read, :admin], Spree::StockItem

data/lib/spree/permission_sets/stock_management.rb

@@ -2,6 +2,10 @@
 
 module Spree
   module PermissionSets
+    # Full permissions for stock management.
+    #
+    # This permission set grants full control over all stock items and read
+    # access to locations.
     class StockManagement < PermissionSets::Base
       def activate!
         can :manage, Spree::StockItem

data/lib/spree/permission_sets/super_user.rb

@@ -2,6 +2,11 @@
 
 module Spree
   module PermissionSets
+    # Full permissions for store administration.
+    #
+    # This permission set is always added to users with the `:admin` role.
+    #
+    # It grants permission to perform any read or write action on any resource.
     class SuperUser < PermissionSets::Base
       def activate!
         can :manage, :all

data/lib/spree/permission_sets/user_display.rb

@@ -2,6 +2,10 @@
 
 module Spree
   module PermissionSets
+    # Read-only permissions for users, roles and store credits.
+    #
+    # This permission set allows users to view all related information about
+    # users, roles and store credits, also from the admin panel.
     class UserDisplay < PermissionSets::Base
       def activate!
         can [:read, :admin, :edit, :addresses, :orders, :items], Spree.user_class

data/lib/spree/permission_sets/user_management.rb

@@ -2,6 +2,15 @@
 
 module Spree
   module PermissionSets
+    # Full permissions for user management.
+    #
+    # This permission set grants full control over all user and
+    # related resources, including:
+    #
+    # - Users
+    # - Store credits
+    # - Roles
+    # - API keys
     class UserManagement < PermissionSets::Base
       def activate!
         can [:admin, :read, :create, :update, :save_in_address_book, :remove_from_address_book, :addresses, :orders, :items], Spree.user_class