spree_core 4.3.0 → 4.5.1

data/app/models/concerns/spree/user_methods.rb

@@ -25,6 +25,8 @@ module Spree
       belongs_to :ship_address, class_name: 'Spree::Address', optional: true
       belongs_to :bill_address, class_name: 'Spree::Address', optional: true
 
+      has_many :wishlists, class_name: 'Spree::Wishlist', foreign_key: :user_id
+
       self.whitelisted_ransackable_associations = %w[bill_address ship_address addresses]
       self.whitelisted_ransackable_attributes = %w[id email]
 
@@ -66,6 +68,13 @@ module Spree
       end
     end
 
+    def default_wishlist_for_store(current_store)
+      wishlists.find_or_create_by(is_default: true, store_id: current_store.id) do |wishlist|
+        wishlist.name = Spree.t(:default_wishlist_name)
+        wishlist.save
+      end
+    end
+
     private
 
     def check_completed_orders

data/app/models/concerns/spree/user_reporting.rb

@@ -41,7 +41,7 @@ module Spree
     end
 
     def completed_orders(store)
-      orders.for_store(store).complete
+      orders.for_store(store).complete.order(currency: :desc)
     end
   end
 end

data/app/models/concerns/spree/user_roles.rb

@@ -6,18 +6,36 @@ module Spree
       has_many :role_users, class_name: 'Spree::RoleUser', foreign_key: :user_id, dependent: :destroy
       has_many :spree_roles, through: :role_users, class_name: 'Spree::Role', source: :role
 
-      scope :admin, -> { joins(:spree_roles).where(Spree::Role.table_name => { name: 'admin' }) }
+      scope :spree_admin, -> { joins(:spree_roles).where(Spree::Role.table_name => { name: 'admin' }) }
 
       # has_spree_role? simply needs to return true or false whether a user has a role or not.
       def has_spree_role?(role_name)
         spree_roles.exists?(name: role_name)
       end
 
+      def self.admin
+        ActiveSupport::Deprecation.warn('`User#admin` is deprecated and will be removed in Spree 5. Please use `User#spree_admin`')
+
+        spree_admin
+      end
+
       def self.admin_created?
-        admin.exists?
+        ActiveSupport::Deprecation.warn('`User#admin_created?` is deprecated and will be removed in Spree 5. Please use `User#spree_admin_created?`')
+
+        spree_admin_created?
       end
 
       def admin?
+        ActiveSupport::Deprecation.warn('`User#admin?` is deprecated and will be removed in Spree 5. Please use `User#spree_admin?`')
+
+        spree_admin?
+      end
+
+      def self.spree_admin_created?
+        spree_admin.exists?
+      end
+
+      def spree_admin?
         has_spree_role?('admin')
       end
     end

data/app/models/spree/ability.rb

@@ -1,8 +1,9 @@
-# Implementation class for Cancan gem.  Instead of overriding this class, consider adding new permissions
+# Implementation class for Cancan gem. Instead of overriding this class, consider adding new permissions
 # using the special +register_ability+ method which allows extensions to add their own abilities.
 #
-# See http://github.com/ryanb/cancan for more details on cancan.
+# See https://github.com/CanCanCommunity/cancancan for more details.
 require 'cancan'
+
 module Spree
   class Ability
     include CanCan::Ability
@@ -27,7 +28,7 @@ module Spree
 
       user ||= Spree.user_class.new
 
-      if user.respond_to?(:has_spree_role?) && user.has_spree_role?('admin')
+      if user.persisted? && user.try(:spree_admin?)
         apply_admin_permissions(user)
       else
         apply_user_permissions(user)
@@ -85,6 +86,13 @@ module Spree
       can :read, ::Spree::Taxonomy
       can :read, ::Spree::Variant
       can :read, ::Spree::Zone
+      can :manage, ::Spree::Wishlist, user_id: user.id
+      can :show, ::Spree::Wishlist do |wishlist|
+        wishlist.user == user || wishlist.is_private == false
+      end
+      can [:create, :update, :destroy], ::Spree::WishedItem do |wished_item|
+        wished_item.wishlist.user == user
+      end
     end
 
     def protect_admin_role

data/app/models/spree/address.rb

@@ -2,6 +2,14 @@ module Spree
   class Address < Spree::Base
     require 'validates_zipcode'
 
+    include Metadata
+    if defined?(Spree::Webhooks)
+      include Spree::Webhooks::HasWebhooks
+    end
+    if defined?(Spree::Security::Addresses)
+      include Spree::Security::Addresses
+    end
+
     if Rails::VERSION::STRING >= '6.1'
       serialize :preferences, Hash, default: {}
     end
@@ -23,13 +31,13 @@ module Spree
     # we're not freezing this on purpose so developers can extend and manage
     # those attributes depending of the logic of their applications
     ADDRESS_FIELDS = %w(firstname lastname company address1 address2 city state zipcode country phone)
-    EXCLUDED_KEYS_FOR_COMPARISION = %w(id updated_at created_at deleted_at label user_id)
+    EXCLUDED_KEYS_FOR_COMPARISON = %w(id updated_at created_at deleted_at label user_id)
 
     scope :not_deleted, -> { where(deleted_at: nil) }
 
     belongs_to :country, class_name: 'Spree::Country'
     belongs_to :state, class_name: 'Spree::State', optional: true
-    belongs_to :user, class_name: Spree.user_class.name, optional: true
+    belongs_to :user, class_name: "::#{Spree.user_class}", optional: true
 
     has_many :shipments, inverse_of: :address
 
@@ -117,7 +125,7 @@ module Spree
     end
 
     def value_attributes
-      attributes.except(*EXCLUDED_KEYS_FOR_COMPARISION)
+      attributes.except(*EXCLUDED_KEYS_FOR_COMPARISON)
     end
 
     def empty?

data/app/models/spree/adjustment.rb

@@ -42,6 +42,7 @@ module Spree
       end
     end
 
+    # FIXME: we should check if we also need to fire this action after update
     after_create :update_adjustable_adjustment_total
     after_destroy :update_adjustable_adjustment_total
 

data/app/models/spree/asset/support/active_storage.rb

@@ -8,7 +8,7 @@ module Spree
           def url(style)
             return placeholder(style) unless attachment.attached?
 
-            attachment.variant(resize: dimensions_for_style(style))
+            attachment.variant(resize_to_limit: dimensions_for_style(style))
           end
 
           def placeholder(style)
@@ -16,7 +16,8 @@ module Spree
           end
 
           def dimensions_for_style(style)
-            self.class.styles.with_indifferent_access[style] || self.class.styles.with_indifferent_access[default_style]
+            dimensions = self.class.styles.with_indifferent_access[style] || self.class.styles.with_indifferent_access[default_style]
+            dimensions.split('x').map(&:to_i)
           end
         end
       end

data/app/models/spree/asset.rb

@@ -1,6 +1,10 @@
 module Spree
   class Asset < Spree::Base
     include Support::ActiveStorage
+    include Metadata
+    if defined?(Spree::Webhooks)
+      include Spree::Webhooks::HasWebhooks
+    end
 
     belongs_to :viewable, polymorphic: true, touch: true
     acts_as_list scope: [:viewable_id, :viewable_type]

data/app/models/spree/base.rb

@@ -36,6 +36,10 @@ class Spree::Base < ApplicationRecord
     where(nil)
   end
 
+  def self.spree_base_uniqueness_scope
+    ApplicationRecord.try(:spree_base_uniqueness_scope) || []
+  end
+
   # FIXME: https://github.com/rails/rails/issues/40943
   def self.has_many_inversing
     false
@@ -45,6 +49,16 @@ class Spree::Base < ApplicationRecord
     column_names.reject { |c| c.match(/_id$|id|preferences|(.*)password|(.*)token|(.*)api_key/) }
   end
 
+  def self.json_api_permitted_attributes
+    skipped_attributes = %w[id]
+
+    if included_modules.include?(CollectiveIdea::Acts::NestedSet::Model)
+      skipped_attributes.push('lft', 'rgt', 'depth')
+    end
+
+    column_names.reject { |c| skipped_attributes.include?(c.to_s) }
+  end
+
   def self.json_api_type
     to_s.demodulize.underscore
   end

data/app/models/spree/calculator/flat_rate.rb

@@ -3,7 +3,7 @@ require_dependency 'spree/calculator'
 module Spree
   class Calculator::FlatRate < Calculator
     preference :amount, :decimal, default: 0
-    preference :currency, :string, default: -> { Spree::Config[:currency] }
+    preference :currency, :string, default: -> { Spree::Store.default.default_currency }
 
     def self.description
       Spree.t(:flat_rate_per_order)

data/app/models/spree/calculator/flexi_rate.rb

@@ -5,7 +5,7 @@ module Spree
     preference :first_item,      :decimal, default: 0.0
     preference :additional_item, :decimal, default: 0.0
     preference :max_items,       :integer, default: 0
-    preference :currency,        :string,  default: -> { Spree::Config[:currency] }
+    preference :currency,        :string,  default: -> { Spree::Store.default.default_currency }
 
     def self.description
       Spree.t(:flexible_rate)

data/app/models/spree/calculator/price_sack.rb

@@ -5,7 +5,7 @@ module Spree
     preference :minimal_amount, :decimal, default: 0
     preference :normal_amount, :decimal, default: 0
     preference :discount_amount, :decimal, default: 0
-    preference :currency, :string, default: -> { Spree::Config[:currency] }
+    preference :currency, :string, default: -> { Spree::Store.default.default_currency }
 
     def self.description
       Spree.t(:price_sack)

data/app/models/spree/calculator/shipping/digital_delivery.rb

@@ -0,0 +1,22 @@
+require_dependency 'spree/shipping_calculator'
+
+module Spree
+  module Calculator::Shipping
+    class DigitalDelivery < ShippingCalculator
+      preference :amount, :decimal, default: 0
+      preference :currency, :string, default: -> { Spree::Store.default.default_currency }
+
+      def self.description
+        Spree.t('digital.digital_delivery')
+      end
+
+      def compute_package(_package = nil)
+        preferred_amount
+      end
+
+      def available?(package)
+        package.contents.all? { |content| content.variant.digital? }
+      end
+    end
+  end
+end

data/app/models/spree/calculator/shipping/flat_rate.rb

@@ -4,7 +4,7 @@ module Spree
   module Calculator::Shipping
     class FlatRate < ShippingCalculator
       preference :amount, :decimal, default: 0
-      preference :currency, :string, default: -> { Spree::Config[:currency] }
+      preference :currency, :string, default: -> { Spree::Store.default.default_currency }
 
       def self.description
         Spree.t(:shipping_flat_rate_per_order)

data/app/models/spree/calculator/shipping/flexi_rate.rb

@@ -6,7 +6,7 @@ module Spree
       preference :first_item,      :decimal, default: 0.0
       preference :additional_item, :decimal, default: 0.0
       preference :max_items,       :integer, default: 0
-      preference :currency,        :string,  default: -> { Spree::Config[:currency] }
+      preference :currency,        :string,  default: -> { Spree::Store.default.default_currency }
 
       def self.description
         Spree.t(:shipping_flexible_rate)

data/app/models/spree/calculator/shipping/per_item.rb

@@ -4,7 +4,7 @@ module Spree
   module Calculator::Shipping
     class PerItem < ShippingCalculator
       preference :amount, :decimal, default: 0
-      preference :currency, :string, default: -> { Spree::Config[:currency] }
+      preference :currency, :string, default: -> { Spree::Store.default.default_currency }
 
       def self.description
         Spree.t(:shipping_flat_rate_per_item)

data/app/models/spree/calculator/shipping/price_sack.rb

@@ -6,7 +6,7 @@ module Spree
       preference :minimal_amount, :decimal, default: 0
       preference :normal_amount, :decimal, default: 0
       preference :discount_amount, :decimal, default: 0
-      preference :currency, :string, default: -> { Spree::Config[:currency] }
+      preference :currency, :string, default: -> { Spree::Store.default.default_currency }
 
       def self.description
         Spree.t(:shipping_price_sack)

data/app/models/spree/calculator.rb

@@ -2,9 +2,9 @@ module Spree
   class Calculator < Spree::Base
     acts_as_paranoid
 
-    belongs_to :calculable, polymorphic: true, optional: true
+    belongs_to :calculable, polymorphic: true, optional: true, inverse_of: :calculator
 
-    # This method calls a compute_<computable> method. must be overriden in concrete calculator.
+    # This method calls a compute_<computable> method. must be overridden in concrete calculator.
     #
     # It should return amount computed based on #calculable and the computable parameter
     def compute(computable)

data/app/models/spree/cms_page.rb

@@ -3,6 +3,10 @@ module Spree
     include SingleStoreResource
     include DisplayLink
 
+    if defined?(Spree::Webhooks)
+      include Spree::Webhooks::HasWebhooks
+    end
+
     acts_as_paranoid
 
     TYPES = ['Spree::Cms::Pages::StandardPage',
@@ -16,7 +20,7 @@ module Spree
 
     before_validation :handle_slug
 
-    validates :title, :store, :locale, presence: true
+    validates :title, :store, :locale, :type, presence: true
     validates :slug, uniqueness: { scope: :store_id, allow_nil: true, case_sensitive: true }
     validates :locale, uniqueness: { scope: [:store, :type] }, if: :homepage?
 
@@ -28,7 +32,7 @@ module Spree
     scope :standard, -> { where(type: 'Spree::Cms::Pages::StandardPage') }
     scope :feature, -> { where(type: 'Spree::Cms::Pages::FeaturePage') }
 
-    self.whitelisted_ransackable_attributes = %w[title type locale store_id]
+    self.whitelisted_ransackable_attributes = %w[title type locale]
 
     def seo_title
       if meta_title.present?
@@ -38,7 +42,7 @@ module Spree
       end
     end
 
-    # Overide this if your page type uses cms_sections
+    # Override this if your page type uses cms_sections
     def sections?
       false
     end

data/app/models/spree/cms_section.rb

@@ -7,29 +7,29 @@ module Spree
 
     validate :reset_link_attributes
 
-    IMAGE_COUNT = ['one', 'two', 'three']
-    IMAGE_TYPES = ['image/png', 'image/jpg', 'image/jpeg', 'image/gif'].freeze
-    IMAGE_SIZE = ['sm', 'md', 'lg', 'xl']
+    has_one :image_one, class_name: 'Spree::CmsSectionImageOne', dependent: :destroy, as: :viewable
+    accepts_nested_attributes_for :image_one, reject_if: :all_blank
 
-    IMAGE_COUNT.each do |count|
-      send(:has_one_attached, "image_#{count}".to_sym)
+    has_one :image_two, class_name: 'Spree::CmsSectionImageTwo', dependent: :destroy, as: :viewable
+    accepts_nested_attributes_for :image_two, reject_if: :all_blank
 
-      IMAGE_SIZE.each do |size|
+    has_one :image_three, class_name: 'Spree::CmsSectionImageThree', dependent: :destroy, as: :viewable
+    accepts_nested_attributes_for :image_three, reject_if: :all_blank
+
+    Spree::CmsSectionImage::IMAGE_COUNT.each do |count|
+      Spree::CmsSectionImage::IMAGE_SIZE.each do |size|
         define_method("img_#{count}_#{size}") do |dimensions = nil|
-          return if !send("image_#{count}").attached? || dimensions.nil?
+          image = send("image_#{count}")&.attachment
+          return if !image&.attached? || dimensions.nil?
 
-          send("image_#{count}").variant(resize: dimensions)
+          image.variant(resize_to_limit: dimensions.split('x').map(&:to_i))
         end
       end
     end
 
-    belongs_to :linked_resource, polymorphic: true
-
     default_scope { order(position: :asc) }
 
-    validates :name, :cms_page, presence: true
-
-    validates :image_one, :image_two, :image_three, content_type: IMAGE_TYPES
+    validates :name, :cms_page, :type, presence: true
 
     LINKED_RESOURCE_TYPE = []
 

data/app/models/spree/cms_section_image.rb

@@ -0,0 +1,15 @@
+module Spree
+  class CmsSectionImage < Asset
+    if Spree.public_storage_service_name
+      has_one_attached :attachment, service: Spree.public_storage_service_name
+    else
+      has_one_attached :attachment
+    end
+
+    IMAGE_COUNT = ['one', 'two', 'three']
+    IMAGE_TYPES = ['image/png', 'image/jpg', 'image/jpeg', 'image/gif'].freeze
+    IMAGE_SIZE = ['sm', 'md', 'lg', 'xl']
+
+    validates :attachment, attached: true, content_type: IMAGE_TYPES
+  end
+end

data/app/models/spree/cms_section_image_one.rb

@@ -0,0 +1,4 @@
+module Spree
+  class CmsSectionImageOne < CmsSectionImage
+  end
+end

data/app/models/spree/cms_section_image_three.rb

@@ -0,0 +1,4 @@
+module Spree
+  class CmsSectionImageThree < CmsSectionImage
+  end
+end

data/app/models/spree/cms_section_image_two.rb

@@ -0,0 +1,4 @@
+module Spree
+  class CmsSectionImageTwo < CmsSectionImage
+  end
+end

data/app/models/spree/country.rb

@@ -2,7 +2,7 @@ module Spree
   class Country < Spree::Base
     # we need to have this callback before any dependent: :destroy associations
     # https://github.com/rails/rails/issues/3458
-    before_destroy :ensure_not_default
+    # before_destroy :ensure_not_default
 
     has_many :addresses, dependent: :restrict_with_error
     has_many :states,
@@ -16,7 +16,7 @@ module Spree
              foreign_key: :zoneable_id
     has_many :zones, through: :zone_members, class_name: 'Spree::Zone'
 
-    validates :name, :iso_name, :iso, :iso3, presence: true, uniqueness: { case_sensitive: false }
+    validates :name, :iso_name, :iso, :iso3, presence: true, uniqueness: { case_sensitive: false, scope: spree_base_uniqueness_scope }
 
     def self.default(store = nil)
       ActiveSupport::Deprecation.warn(<<-DEPRECATION, caller)
@@ -49,6 +49,8 @@ module Spree
     private
 
     def ensure_not_default
+      ActiveSupport::Deprecation.warn('Country#ensure_not_default is deprecated and will be removed in Spree v5')
+
       if id.eql?(Spree::Config[:default_country_id])
         errors.add(:base, Spree.t(:default_country_cannot_be_deleted))
         throw(:abort)

data/app/models/spree/credit_card.rb

@@ -1,11 +1,18 @@
 module Spree
   class CreditCard < Spree::Base
     include ActiveMerchant::Billing::CreditCardMethods
+    include Metadata
+    if defined?(Spree::Webhooks)
+      include Spree::Webhooks::HasWebhooks
+    end
+    if defined?(Spree::Security::CreditCards)
+      include Spree::Security::CreditCards
+    end
 
     acts_as_paranoid
 
     belongs_to :payment_method
-    belongs_to :user, class_name: Spree.user_class.to_s, foreign_key: 'user_id',
+    belongs_to :user, class_name: "::#{Spree.user_class}", foreign_key: 'user_id',
                       optional: true
     has_many :payments, as: :source
 
@@ -171,6 +178,15 @@ module Spree
       )
     end
 
+    def self.json_api_permitted_attributes
+      [
+        'number', 'month', 'year', 'expiry', 'verification_value', 'first_name', 'last_name',
+        'cc_type', 'gateway_customer_profile_id', 'gateway_payment_profile_id', 'last_digits',
+        'name', 'encrypted_data', 'address_id', 'created_at', 'updated_at', 'user_id',
+        'payment_method_id', 'default', 'deleted_at'
+      ]
+    end
+
     private
 
     def require_card_numbers?

data/app/models/spree/customer_return.rb

@@ -1,6 +1,12 @@
 module Spree
   class CustomerReturn < Spree::Base
     include Spree::Core::NumberGenerator.new(prefix: 'CR', length: 9)
+    include NumberIdentifier
+    include Metadata
+    if defined?(Spree::Webhooks)
+      include Spree::Webhooks::HasWebhooks
+    end
+
     belongs_to :stock_location
     belongs_to :store, class_name: 'Spree::Store', inverse_of: :customer_returns
 
@@ -11,7 +17,6 @@ module Spree
     after_create :process_return!
 
     validates :store, presence: true
-    validates :number, uniqueness: { case_sensitive: true }
     validates :return_items, :stock_location, presence: true
     validate :must_have_return_authorization, on: :create
     validate :return_items_belong_to_same_order

data/app/models/spree/digital.rb

@@ -0,0 +1,19 @@
+module Spree
+  class Digital < Spree::Base
+    belongs_to :variant
+    has_many :digital_links, dependent: :destroy
+
+    if defined?(Spree::Webhooks)
+      include Spree::Webhooks::HasWebhooks
+    end
+
+    if Spree.private_storage_service_name
+      has_one_attached :attachment, service: Spree.private_storage_service_name
+    else
+      has_one_attached :attachment
+    end
+
+    validates :attachment, attached: true
+    validates :variant, presence: true
+  end
+end

data/app/models/spree/digital_link.rb

@@ -0,0 +1,57 @@
+module Spree
+  class DigitalLink < Spree::Base
+    has_secure_token
+
+    if defined?(Spree::Webhooks)
+      include Spree::Webhooks::HasWebhooks
+    end
+    if defined?(Spree::Security::DigitalLinks)
+      include Spree::Security::DigitalLinks
+    end
+
+    belongs_to :digital
+    belongs_to :line_item
+
+    before_validation :set_defaults, on: :create
+    validates :digital, :line_item, presence: true
+    validates :access_counter, numericality: { greater_than_or_equal_to: 0 }
+
+    def authorizable?
+      !(expired? || access_limit_exceeded?)
+    end
+
+    def expired?
+      if line_item.order.store.limit_digital_download_days
+        created_at <= line_item.order.store.digital_asset_authorized_days.day.ago
+      else
+        false
+      end
+    end
+
+    def access_limit_exceeded?
+      if line_item.order.store.limit_digital_download_count
+        access_counter >= line_item.order.store.digital_asset_authorized_clicks
+      else
+        false
+      end
+    end
+
+    # This method should be called when a download is initiated.
+    # It returns +true+ or +false+ depending on whether the authorization is granted.
+    def authorize!
+      authorizable? && increment!(:access_counter, touch: true) ? true : false
+    end
+
+    def reset!
+      self.access_counter = 0
+      self.created_at = Time.current
+      save!
+    end
+
+    private
+
+    def set_defaults
+      self.access_counter ||= 0
+    end
+  end
+end

data/app/models/spree/fulfilment_changer.rb

@@ -92,7 +92,7 @@ module Spree
     end
 
     def get_desired_shipment_inventory_unit(state)
-      desired_shipment.inventory_units.find_or_create_by(state: state) do |unit|
+      desired_shipment.inventory_units.find_or_create_by(state: state, variant: variant) do |unit|
         current_shipment_unit = current_shipment_units.first
         unit.variant_id = current_shipment_unit.variant_id
         unit.order_id = current_shipment_unit.order_id

data/app/models/spree/gateway/bogus.rb

@@ -58,7 +58,7 @@ module Spree
       ActiveMerchant::Billing::Response.new(true, 'Bogus Gateway: Forced success', {}, test: true, authorization: '12345')
     end
 
-    def cancel(_response_code)
+    def cancel(_response_code, _payment = nil)
       ActiveMerchant::Billing::Response.new(true, 'Bogus Gateway: Forced success', {}, test: true, authorization: '12345')
     end
 
@@ -71,6 +71,10 @@ module Spree
       true
     end
 
+    def payment_source_class
+      CreditCard
+    end
+
     def actions
       %w(capture void credit)
     end

data/app/models/spree/icon.rb

@@ -1,6 +1,10 @@
 module Spree
   class Icon < Spree::Asset
-    has_one_attached :attachment
+    if Spree.public_storage_service_name
+      has_one_attached :attachment, service: Spree.public_storage_service_name
+    else
+      has_one_attached :attachment
+    end
 
     ICON_TYPES = %i[png jpg jpeg gif svg]