solidus_core 4.4.2 → 4.5.0

data/lib/spree/core/state_machines.rb

@@ -2,87 +2,54 @@
 
 module Spree
   module Core
-    class StateMachines
-      attr_writer :reimbursement,
-                  :return_authorization,
-                  :return_item_acceptance,
-                  :return_item_reception,
-                  :payment,
-                  :inventory_unit,
-                  :shipment,
-                  :order
-
-      def return_authorization
-        @return_authorization ||= begin
-          require 'spree/core/state_machines/return_authorization'
-          'Spree::Core::StateMachines::ReturnAuthorization'
-        end
-
-        @return_authorization.constantize
-      end
-
-      def return_item_reception
-        @return_item_reception_status ||= begin
-          require 'spree/core/state_machines/return_item/reception_status'
-          'Spree::Core::StateMachines::ReturnItem::ReceptionStatus'
-        end
-
-        @return_item_reception_status.constantize
-      end
-
-      def return_item_acceptance
-        @return_item_acceptance_status ||= begin
-          require 'spree/core/state_machines/return_item/acceptance_status'
-          'Spree::Core::StateMachines::ReturnItem::AcceptanceStatus'
-        end
-
-        @return_item_acceptance_status.constantize
-      end
-
-      def payment
-        @payment ||= begin
-          require 'spree/core/state_machines/payment'
-          'Spree::Core::StateMachines::Payment'
-        end
-
-        @payment.constantize
-      end
-
-      def inventory_unit
-        @inventory_unit ||= begin
-          require 'spree/core/state_machines/inventory_unit'
-          'Spree::Core::StateMachines::InventoryUnit'
-        end
-
-        @inventory_unit.constantize
-      end
-
-      def shipment
-        @shipment ||= begin
-          require 'spree/core/state_machines/shipment'
-          'Spree::Core::StateMachines::Shipment'
-        end
-
-        @shipment.constantize
-      end
-
-      def order
-        @order ||= begin
-          require 'spree/core/state_machines/order'
-          'Spree::Core::StateMachines::Order'
-        end
-
-        @order.constantize
-      end
-
-      def reimbursement
-        @reimbursement ||= begin
-          require 'spree/core/state_machines/reimbursement'
-          'Spree::Core::StateMachines::Reimbursement'
-        end
-
-        @reimbursement.constantize
-      end
+    class StateMachines < Spree::Preferences::Configuration
+      # State Machine module for Reimbursements
+      #
+      # @!attribute [rw] reimbursement
+      # @return [Module] a module that implements the state machine for the `Spree::Reimbursement` model.
+      class_name_attribute :reimbursement, default: "Spree::Core::StateMachines::Reimbursement"
+
+      # State Machine module for Return Authorizations
+      #
+      # @!attribute [rw] return_authorization
+      # @return [Module] a module that implements the state machine for the `Spree::ReturnAuthorization` model.
+      class_name_attribute :return_authorization, default: "Spree::Core::StateMachines::ReturnAuthorization"
+
+      # State Machine module for Return Item Acceptances
+      #
+      # @!attribute [rw] return_item_acceptance
+      # @return [Module] a module that implements the acceptance part of the state machine for the `Spree::ReturnItem` model.
+      class_name_attribute :return_item_acceptance, default: "Spree::Core::StateMachines::ReturnItem::AcceptanceStatus"
+
+      # State Machine module for Return Item Receptions
+      #
+      # @!attribute [rw] return_item_reception
+      # @return [Module] a module that implements the reception part of the state machine for the `Spree::ReturnItem` model.
+      class_name_attribute :return_item_reception, default: "Spree::Core::StateMachines::ReturnItem::ReceptionStatus"
+
+      # State Machine module for Payments
+      #
+      # @!attribute [rw] payment
+      # @return [Module] a module that implements the state machine for the `Spree::Payment` model.
+      class_name_attribute :payment, default: "Spree::Core::StateMachines::Payment"
+
+      # State Machine module for Inventory Units
+      #
+      # @!attribute [rw] inventory_unit
+      # @return [Module] a module that implements the state machine for the `Spree::InventoryUnit` model.
+      class_name_attribute :inventory_unit, default: "Spree::Core::StateMachines::InventoryUnit"
+
+      # State Machine module for Shipments
+      #
+      # @!attribute [rw] shipment
+      # @return [Module] a module that implements the state machine for the `Spree::Shipment` model.
+      class_name_attribute :shipment, default: "Spree::Core::StateMachines::Shipment"
+
+      # State Machine module for Orders
+      #
+      # @!attribute [rw] order
+      # @return [Module] a module that implements the state machine for the `Spree::Order` model.
+      class_name_attribute :order, default: "Spree::Core::StateMachines::Order"
     end
   end
 end

data/lib/spree/core/version.rb

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
 module Spree
-  VERSION = "4.4.2"
+  VERSION = "4.5.0"
 
   def self.solidus_version
     VERSION
   end
 
   def self.previous_solidus_minor_version
-    '4.3'
+    '4.4'
   end
 
   def self.solidus_gem_version

data/lib/spree/core.rb

@@ -105,26 +105,16 @@ require 'spree/core/engine'
 
 require 'spree/i18n'
 require 'spree/localized_number'
-require 'spree/money'
 require 'spree/permitted_attributes'
 
 require 'spree/core/importer'
 require 'spree/core/permalinks'
 require 'spree/core/product_duplicator'
-require 'spree/core/controller_helpers/auth'
-require 'spree/core/controller_helpers/common'
-require 'spree/core/controller_helpers/order'
-require 'spree/core/controller_helpers/payment_parameters'
-require 'spree/core/controller_helpers/pricing'
-require 'spree/core/controller_helpers/search'
-require 'spree/core/controller_helpers/store'
-require 'spree/core/controller_helpers/strong_parameters'
 require 'spree/core/role_configuration'
 require 'spree/core/state_machines'
 require 'spree/core/stock_configuration'
 require 'spree/core/null_promotion_configuration'
 require 'spree/core/validators/email'
-require 'spree/permission_sets'
 require 'spree/user_class_handle'
 
 require 'spree/preferences/store'

data/lib/spree/money.rb

@@ -1,120 +1,7 @@
 # frozen_string_literal: true
 
-module Spree
-  # Spree::Money is a relatively thin wrapper around Monetize which handles
-  # formatting via Spree::Config.
-  class Money
-    include Comparable
-    DifferentCurrencyError = Class.new(StandardError)
-
-    class <<self
-      attr_accessor :default_formatting_rules
-
-      def parse(amount, currency = Spree::Config[:currency])
-        new(parse_to_money(amount, currency))
-      end
-
-      # @api private
-      def parse_to_money(amount, currency)
-        ::Monetize.parse(amount, currency)
-      end
-    end
-    self.default_formatting_rules = {
-      # Ruby money currently has this as false, which is wrong for the vast
-      # majority of locales.
-      sign_before_symbol: true
-    }
-
-    attr_reader :money
-
-    delegate :cents, :currency, :to_d, :zero?, to: :money
-
-    # @param amount [Money, #to_s] the value of the money object
-    # @param options [Hash] the default options for formatting the money object See #format
-    def initialize(amount, options = {})
-      if amount.is_a?(::Money)
-        @money = amount
-      else
-        currency = options[:currency] || Spree::Config[:currency]
-
-        @money = Monetize.from_string(amount, currency)
-      end
-      @options = Spree::Money.default_formatting_rules.merge(options)
-    end
-
-    # @return [String] the value of this money object formatted according to
-    #   its options
-    def to_s
-      format
-    end
-
-    # @param options [Hash, String] the options for formatting the money object
-    # @option options [Boolean] with_currency when true, show the currency
-    # @option options [Boolean] no_cents when true, round to the closest dollar
-    # @option options [String] decimal_mark the mark for delimiting the
-    #   decimals
-    # @option options [String, false, nil] thousands_separator the character to
-    #   delimit powers of 1000, if one is desired, otherwise false or nil
-    # @option options [Boolean] sign_before_symbol when true the sign of the
-    #   value comes before the currency symbol
-    # @option options [:before, :after] symbol_position the position of the
-    #   currency symbol
-    # @return [String] the value of this money object formatted according to
-    #   its options
-    def format(options = {})
-      @money.format(@options.merge(options))
-    end
-
-    # @note If you pass in options, ensure you pass in the { html_wrap: true } as well.
-    # @param options [Hash] additional formatting options
-    # @return [String] the value of this money object formatted according to
-    #   its options and any additional options, by default with html_wrap.
-    def to_html(options = { html_wrap: true })
-      output = format(options)
-      # Maintain compatibility by checking html option renamed to html_wrap.
-      if options[:html_wrap]
-        output = output.html_safe
-      end
-      output
-    end
-
-    # (see #to_s)
-    def as_json(*)
-      to_s
-    end
-
-    def <=>(other)
-      if !other.respond_to?(:money)
-        raise TypeError, "Can't compare #{other.class} to Spree::Money"
-      end
-      if currency != other.currency
-        # By default, ::Money will try to run a conversion on `other.money` and
-        # try a comparison on that. We do not want any currency conversion to
-        # take place so we'll catch this here and raise an error.
-        raise(
-          DifferentCurrencyError,
-          "Can't compare #{currency} with #{other.currency}"
-        )
-      end
-      @money <=> other.money
-    end
-
-    # Delegates comparison to the internal ruby money instance.
-    #
-    # @see http://www.rubydoc.info/gems/money/Money/Arithmetic#%3D%3D-instance_method
-    def ==(other)
-      raise TypeError, "Can't compare #{other.class} to Spree::Money" if !other.respond_to?(:money)
-      @money == other.money
-    end
-
-    def -(other)
-      raise TypeError, "Can't subtract #{other.class} to Spree::Money" if !other.respond_to?(:money)
-      self.class.new(@money - other.money)
-    end
-
-    def +(other)
-      raise TypeError, "Can't add #{other.class} to Spree::Money" if !other.respond_to?(:money)
-      self.class.new(@money + other.money)
-    end
-  end
-end
+Spree.deprecator.warn(
+  <<~MSG
+    The file "#{__FILE__}" does not need to be `require`d any longer, it is now autoloaded.
+  MSG
+)

data/lib/spree/permission_sets/base.rb

@@ -1,44 +1,7 @@
 # frozen_string_literal: true
 
-module Spree
-  module PermissionSets
-    # This is the base class used for crafting permission sets.
-    #
-    # This is used by {Spree::RoleConfiguration} when adding custom behavior to {Spree::Ability}.
-    # See one of the subclasses for example structure such as {Spree::PermissionSets::UserDisplay}
-    #
-    # @see Spree::RoleConfiguration
-    # @see Spree::PermissionSets
-    class Base
-      # @param ability [CanCan::Ability]
-      #   The ability that will be extended with the current permission set.
-      #   The ability passed in must respond to #user
-      def initialize(ability)
-        @ability = ability
-      end
-
-      # Activate permissions on the ability. Put your can and cannot statements here.
-      # Must be overridden by subclasses
-      def activate!
-        raise NotImplementedError.new
-      end
-
-      # Provide the permission set privilege in the form of a :symbol.
-      # Must be overridden by subclasses.
-      def self.privilege
-        raise NotImplementedError, "Subclass #{name} must define a privilege using `self.privilege :symbol`"
-      end
-
-      # Provide the permission set category in the form of a :symbol.
-      # Must be overridden by subclasses.
-      def self.category
-        raise NotImplementedError, "Subclass #{name} must define a category using `self.category :symbol`"
-      end
-
-      private
-
-      attr_reader :ability
-      delegate :can, :cannot, :user, to: :ability
-    end
-  end
-end
+Spree.deprecator.warn(
+  <<~MSG
+    The file "#{__FILE__}" does not need to be `require`d any longer, it is now autoloaded.
+  MSG
+)

data/lib/spree/permission_sets/configuration_display.rb

@@ -1,53 +1,7 @@
 # frozen_string_literal: true
 
-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
-      class << self
-        def privilege
-          :display
-        end
-
-        def category
-          :configuration
-        end
-      end
-
-      def activate!
-          can [:read, :admin], Spree::TaxCategory
-          can [:read, :admin], Spree::TaxRate
-          can [:read, :admin], Spree::Zone
-          can [:read, :admin], Spree::Country
-          can [:read, :admin], Spree::State
-          can [:read, :admin], Spree::PaymentMethod
-          can [:read, :admin], Spree::Taxonomy
-          can [:read, :admin], Spree::ShippingMethod
-          can [:read, :admin], Spree::ShippingCategory
-          can [:read, :admin], Spree::StockLocation
-          can [:read, :admin], Spree::StockMovement
-          can [:read, :admin], Spree::RefundReason
-          can [:read, :admin], Spree::ReimbursementType
-          can [:read, :admin], Spree::ReturnReason
-      end
-    end
-  end
-end
+Spree.deprecator.warn(
+  <<~MSG
+    The file "#{__FILE__}" does not need to be `require`d any longer, it is now autoloaded.
+  MSG
+)

data/lib/spree/permission_sets/configuration_management.rb

@@ -1,52 +1,7 @@
 # frozen_string_literal: true
 
-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
-      class << self
-        def privilege
-          :management
-        end
-
-        def category
-          :configuration
-        end
-      end
-
-      def activate!
-        can :manage, Spree::TaxCategory
-        can :manage, Spree::TaxRate
-        can :manage, Spree::Zone
-        can :manage, Spree::Country
-        can :manage, Spree::State
-        can :manage, Spree::PaymentMethod
-        can :manage, Spree::Taxonomy
-        can :manage, Spree::ShippingMethod
-        can :manage, Spree::ShippingCategory
-        can :manage, Spree::StockLocation
-        can :manage, Spree::StockMovement
-        can :manage, Spree::RefundReason
-        can :manage, Spree::ReimbursementType
-        can :manage, Spree::ReturnReason
-      end
-    end
-  end
-end
+Spree.deprecator.warn(
+  <<~MSG
+    The file "#{__FILE__}" does not need to be `require`d any longer, it is now autoloaded.
+  MSG
+)

data/lib/spree/permission_sets/dashboard_display.rb

@@ -1,28 +1,7 @@
 # frozen_string_literal: true
 
-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
-      class << self
-        def privilege
-          :other
-        end
-
-        def category
-          :dashboard_display
-        end
-      end
-
-      def activate!
-          Spree.deprecator.warn "The #{self.class.name} module is deprecated. " \
-            "If you still use dashboards, please copy all controllers and views from #{self.class.name} to your application."
-          can [:admin, :home], :dashboards
-      end
-    end
-  end
-end
+Spree.deprecator.warn(
+  <<~MSG
+    The file "#{__FILE__}" does not need to be `require`d any longer, it is now autoloaded.
+  MSG
+)

data/lib/spree/permission_sets/default_customer.rb

@@ -1,83 +1,7 @@
 # frozen_string_literal: true
 
-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
-      class << self
-        def privilege
-          :other
-        end
-
-        def category
-          :default_customer
-        end
-      end
-
-      def activate!
-        can :read, Country
-        can :read, OptionType
-        can :read, OptionValue
-        can :create, Order do |order, token|
-          # same user, or both nil
-          order.user == user ||
-          # guest checkout order
-          order.email.present? ||
-          # via API, just like with show and update
-          (order.guest_token.present? && token == order.guest_token)
-        end
-        can [:show, :update], Order, Order.where(user:) do |order, token|
-          order.user == user || (order.guest_token.present? && token == order.guest_token)
-        end
-        cannot :update, Order do |order|
-          order.completed?
-        end
-        can :create, ReturnAuthorization do |return_authorization|
-          return_authorization.order.user == user
-        end
-        can [:read, :update], CreditCard, user_id: user.id
-        can :read, Product
-        can :read, ProductProperty
-        can :read, Property
-        can :create, Spree.user_class
-        can [:show, :update, :update_email], Spree.user_class, id: user.id
-        can :read, State
-        can :read, StockItem, stock_location: { active: true }
-        can :read, StockLocation, active: true
-        can :read, Taxon
-        can :read, Taxonomy
-        can [:save_in_address_book, :remove_from_address_book], Spree.user_class, id: user.id
-        can [:read, :view_out_of_stock], Variant
-        can :read, Zone
-      end
-    end
-  end
-end
+Spree.deprecator.warn(
+  <<~MSG
+    The file "#{__FILE__}" does not need to be `require`d any longer, it is now autoloaded.
+  MSG
+)

data/lib/spree/permission_sets/order_display.rb

@@ -1,50 +1,7 @@
 # frozen_string_literal: true
 
-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
-      class << self
-        def privilege
-          :display
-        end
-
-        def category
-          :order
-        end
-      end
-
-      def activate!
-        can [:read, :admin, :edit, :cart], Spree::Order
-        can [:read, :admin], Spree::Payment
-        can [:read, :admin], Spree::Shipment
-        can [:read, :admin], Spree::Adjustment
-        can [:read, :admin], Spree::LineItem
-        can [:read, :admin], Spree::ReturnAuthorization
-        can [:read, :admin], Spree::CustomerReturn
-        can [:read, :admin], Spree::OrderCancellations
-        can [:read, :admin], Spree::Reimbursement
-        can [:read, :admin], Spree::ReturnItem
-        can [:read, :admin], Spree::Refund
-      end
-    end
-  end
-end
+Spree.deprecator.warn(
+  <<~MSG
+    The file "#{__FILE__}" does not need to be `require`d any longer, it is now autoloaded.
+  MSG
+)