spree_core 4.2.5 → 4.3.0

data/app/models/spree/credit_card.rb

@@ -2,14 +2,7 @@ module Spree
   class CreditCard < Spree::Base
     include ActiveMerchant::Billing::CreditCardMethods
 
-    # to migrate safely from older Spree versions that din't provide safe deletion for CCs
-    # we need to ensure that we have a connection to the DB and that the `deleted_at` column exists
-    if !ENV['SPREE_DISABLE_DB_CONNECTION'] &&
-        connected? &&
-        table_exists? &&
-        connection.column_exists?(:spree_credit_cards, :deleted_at)
-      acts_as_paranoid
-    end
+    acts_as_paranoid
 
     belongs_to :payment_method
     belongs_to :user, class_name: Spree.user_class.to_s, foreign_key: 'user_id',
@@ -42,6 +35,7 @@ module Spree
         or(where('CAST(spree_credit_cards.year AS DECIMAL) = ?', Time.current.year).
            where('CAST(spree_credit_cards.month AS DECIMAL) >= ?', Time.current.month))
     }
+    scope :not_removed, -> { where(deleted_at: nil) }
 
     # needed for some of the ActiveMerchant gateways (eg. SagePay)
     alias_attribute :brand, :cc_type

data/app/models/spree/customer_return.rb

@@ -2,6 +2,7 @@ module Spree
   class CustomerReturn < Spree::Base
     include Spree::Core::NumberGenerator.new(prefix: 'CR', length: 9)
     belongs_to :stock_location
+    belongs_to :store, class_name: 'Spree::Store', inverse_of: :customer_returns
 
     has_many :reimbursements, inverse_of: :customer_return
     has_many :return_items, inverse_of: :customer_return
@@ -9,6 +10,7 @@ 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
@@ -17,7 +19,7 @@ module Spree
     accepts_nested_attributes_for :return_items
 
     extend DisplayMoney
-    money_methods pre_tax_total: { currency: Spree::Config[:currency] }
+    money_methods :pre_tax_total
 
     self.whitelisted_ransackable_attributes = ['number']
 
@@ -31,6 +33,10 @@ module Spree
       completely_decided? && return_items.accepted.includes(:reimbursement).all? { |return_item| return_item.reimbursement.try(:reimbursed?) }
     end
 
+    def currency
+      order&.currency
+    end
+
     # Temporarily tie a customer_return to one order
     def order
       return nil if return_items.blank?
@@ -49,7 +55,7 @@ module Spree
     end
 
     def must_have_return_authorization
-      if item = return_items.find { |ri| ri.return_authorization.blank? }
+      if (item = return_items.find { |ri| ri.return_authorization.blank? })
         errors.add(:base, Spree.t(:missing_return_authorization, item_name: item.inventory_unit.variant.name))
       end
     end

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

@@ -9,14 +9,12 @@ module Spree
 
     attr_accessor :test
 
+    preference :dummy_key, :string, default: 'PUBLICKEY123'
+
     def provider_class
       self.class
     end
 
-    def preferences
-      {}
-    end
-
     def create_profile(payment)
       return if payment.source.has_payment_profile?
 
@@ -88,5 +86,9 @@ module Spree
       end
       random
     end
+
+    def public_preference_keys
+      [:dummy_key]
+    end
   end
 end

data/app/models/spree/icon.rb

@@ -0,0 +1,9 @@
+module Spree
+  class Icon < Spree::Asset
+    has_one_attached :attachment
+
+    ICON_TYPES = %i[png jpg jpeg gif svg]
+
+    validates :attachment, attached: true, content_type: ICON_TYPES
+  end
+end

data/app/models/spree/image/configuration/active_storage.rb

@@ -10,6 +10,8 @@ module Spree
 
           has_one_attached :attachment
 
+          default_scope { includes(attachment_attachment: :blob) }
+
           def self.styles
             @styles ||= {
               mini: '48x48>',

data/app/models/spree/image.rb

@@ -2,6 +2,7 @@ module Spree
   class Image < Asset
     include Configuration::ActiveStorage
     include Rails.application.routes.url_helpers
+    include ::Spree::ImageMethods
 
     # In Rails 5.x class constants are being undefined/redefined during the code reloading process
     # in a rails development environment, after which the actual ruby objects stored in those class constants
@@ -15,13 +16,8 @@ module Spree
         width, height = size.chop.split('x')
 
         {
-          url: polymorphic_path(attachment.variant(
-                                  gravity: 'center',
-                                  resize: size,
-                                  extent: size,
-                                  background: 'snow2',
-                                  quality: 80
-                                ), only_path: true),
+          url: generate_url(size: size),
+          size: size,
           width: width,
           height: height
         }
@@ -35,13 +31,7 @@ module Spree
       width, height = size.chop.split('x')
 
       {
-        url: polymorphic_path(attachment.variant(
-                                gravity: 'center',
-                                resize: size,
-                                extent: size,
-                                background: 'snow2',
-                                quality: 80
-                              ), only_path: true),
+        url: generate_url(size: size),
         size: size,
         width: width,
         height: height
@@ -59,16 +49,7 @@ module Spree
     end
 
     def plp_url
-      size = self.class.styles[:plp_and_carousel]
-      variant = attachment.variant(
-        gravity: 'center',
-        resize: size,
-        extent: size,
-        background: 'snow2',
-        quality: 80
-      )
-
-      polymorphic_path(variant, only_path: true)
+      generate_url(size: self.class.styles[:plp_and_carousel])
     end
   end
 end

data/app/models/spree/inventory_unit.rb

@@ -4,7 +4,7 @@ module Spree
       belongs_to :variant, -> { with_deleted }, class_name: 'Spree::Variant'
       belongs_to :order, class_name: 'Spree::Order'
       belongs_to :shipment, class_name: 'Spree::Shipment', touch: true, optional: true
-      has_many :return_items, inverse_of: :inventory_unit
+      has_many :return_items, class_name: 'Spree::ReturnItem', inverse_of: :inventory_unit
       has_many :return_authorizations, class_name: 'Spree::ReturnAuthorization', through: :return_items
       belongs_to :line_item, class_name: 'Spree::LineItem'
     end

data/app/models/spree/line_item.rb

@@ -39,7 +39,7 @@ module Spree
 
     after_create :update_tax_charge
 
-    delegate :name, :description, :sku, :should_track_inventory?, :product, :options_text, :slug, to: :variant
+    delegate :name, :description, :sku, :should_track_inventory?, :product, :options_text, :slug, :product_id, to: :variant
     delegate :brand, :category, to: :product
     delegate :tax_zone, to: :order
 

data/app/models/spree/menu.rb

@@ -0,0 +1,63 @@
+module Spree
+  class Menu < Spree::Base
+    include SingleStoreResource
+
+    MENU_LOCATIONS = ['Header', 'Footer']
+    MENU_LOCATIONS_PARAMETERIZED = []
+
+    MENU_LOCATIONS.each do |location|
+      parameterize_location = location.parameterize(separator: '_')
+      MENU_LOCATIONS_PARAMETERIZED << parameterize_location
+    end
+
+    has_many :menu_items, dependent: :destroy, class_name: 'Spree::MenuItem'
+    belongs_to :store, touch: true, class_name: 'Spree::Store'
+
+    before_validation :parameterize_location
+    after_create :set_root
+    after_save :update_root_name
+    after_touch :touch_store
+
+    validates :name, :store, :locale, presence: true
+    validates :location, uniqueness: { scope: [:store, :locale] }
+    validates :location, inclusion: { in: MENU_LOCATIONS_PARAMETERIZED }
+
+    has_one :root, -> { where(parent_id: nil) }, class_name: 'Spree::MenuItem', dependent: :destroy
+
+    default_scope { order(created_at: :asc) }
+
+    scope :by_locale, ->(locale) { where(locale: locale) }
+
+    self.whitelisted_ransackable_attributes = %w[name location locale store_id]
+
+    MENU_LOCATIONS_PARAMETERIZED.each do |location_name|
+      define_singleton_method("for_#{location_name}") do |locale|
+        menu = find_by(location: location_name, locale: locale.to_s)
+
+        menu.root if menu.present?
+      end
+    end
+
+    private
+
+    def parameterize_location
+      return unless location.present?
+
+      self.location = location.parameterize(separator: '_')
+    end
+
+    def set_root
+      self.root ||= menu_items.create!(name: name, item_type: 'Container')
+    end
+
+    def update_root_name
+      return unless saved_change_to_name?
+
+      root.update(name: name)
+    end
+
+    def touch_store
+      store.touch
+    end
+  end
+end

data/app/models/spree/menu_item.rb

@@ -0,0 +1,76 @@
+module Spree
+  class MenuItem < Spree::Base
+    include Spree::DisplayLink
+
+    acts_as_nested_set dependent: :destroy
+
+    belongs_to :menu, touch: true
+    belongs_to :linked_resource, polymorphic: true
+
+    before_create :ensure_item_belongs_to_root
+    before_update :reset_link_attributes
+    before_save :paremeterize_code
+
+    after_save :touch_ancestors_and_menu
+    after_touch :touch_ancestors_and_menu
+
+    ITEM_TYPE = %w[Link Container]
+
+    LINKED_RESOURCE_TYPE = ['URL']
+    STATIC_RESOURCE_TYPE = ['Home Page']
+    DYNAMIC_RESOURCE_TYPE = ['Spree::Product', 'Spree::Taxon', 'Spree::CmsPage']
+
+    LINKED_RESOURCE_TYPE.unshift(*STATIC_RESOURCE_TYPE)
+    LINKED_RESOURCE_TYPE.push(*DYNAMIC_RESOURCE_TYPE)
+
+    validates :name, :menu, presence: true
+    validates :item_type, inclusion: { in: ITEM_TYPE }
+    validates :linked_resource_type, inclusion: { in: LINKED_RESOURCE_TYPE }
+
+    has_one :icon, as: :viewable, dependent: :destroy, class_name: 'Spree::Icon'
+    accepts_nested_attributes_for :icon, reject_if: :all_blank
+
+    def container?
+      item_type == 'Container'
+    end
+
+    def code?(item_code = nil)
+      if item_code
+        code == item_code
+      else
+        code.present?
+      end
+    end
+
+    private
+
+    def reset_link_attributes
+      if linked_resource_type_changed? || item_type == 'Container'
+        self.linked_resource_id = nil
+        self.destination = nil
+        self.new_window = false
+
+        self.linked_resource_type = 'URL' if item_type == 'Container'
+      end
+    end
+
+    def ensure_item_belongs_to_root
+      if menu.try(:root).present? && parent_id.nil?
+        self.parent = menu.root
+
+        store_new_parent
+      end
+    end
+
+    def touch_ancestors_and_menu
+      ancestors.update_all(updated_at: Time.current)
+      menu.try!(:touch)
+    end
+
+    def paremeterize_code
+      return if code.blank?
+
+      self.code = code.parameterize
+    end
+  end
+end

data/app/models/spree/option_type.rb

@@ -26,7 +26,7 @@ module Spree
     after_touch :touch_all_products
 
     def filter_param
-      name.titleize.delete(' ').downcase
+      name.parameterize
     end
 
     def self.color

data/app/models/spree/option_value.rb

@@ -11,6 +11,17 @@ module Spree
       validates :presentation
     end
 
+    scope :filterable, lambda {
+      joins(:option_type).
+        where(OptionType.table_name => { filterable: true }).
+        distinct
+    }
+
+    scope :for_products, lambda { |products|
+      joins(:variants).
+        where(Variant.table_name => { product_id: products.map(&:id) })
+    }
+
     after_touch :touch_all_variants
 
     delegate :name, :presentation, to: :option_type, prefix: true, allow_nil: true

data/app/models/spree/option_value_variant.rb

@@ -1,7 +1,7 @@
 module Spree
   class OptionValueVariant < Spree::Base
     belongs_to :option_value, class_name: 'Spree::OptionValue'
-    belongs_to :variant, class_name: 'Spree::Variant'
+    belongs_to :variant, touch: true, class_name: 'Spree::Variant'
 
     validates :option_value, :variant, presence: true
     validates :option_value_id, uniqueness: { scope: :variant_id }

data/app/models/spree/order/address_book.rb

@@ -2,7 +2,7 @@
 module Spree
   class Order < Spree::Base
     module AddressBook
-      extend ActiveSupport::Concern
+      extend ActiveSupport::Concern # FIXME: this module is not required to be a concern
 
       def clone_shipping_address
         if ship_address
@@ -22,7 +22,6 @@ module Spree
         address = Spree::Address.find_by(id: id)
         if address && address.user_id == user_id
           self['bill_address_id'] = address.id
-          user.update_attribute(:bill_address_id, address.id)
           bill_address.reload
         else
           self['bill_address_id'] = nil
@@ -31,14 +30,13 @@ module Spree
 
       def bill_address_attributes=(attributes)
         self.bill_address = update_or_create_address(attributes)
-        user.bill_address = bill_address if user
+        user.bill_address = bill_address if user && user.bill_address.nil?
       end
 
       def ship_address_id=(id)
         address = Spree::Address.find_by(id: id)
         if address && address.user_id == user_id
           self['ship_address_id'] = address.id
-          user.update_attribute(:ship_address_id, address.id)
           ship_address.reload
         else
           self['ship_address_id'] = nil
@@ -47,7 +45,7 @@ module Spree
 
       def ship_address_attributes=(attributes)
         self.ship_address = update_or_create_address(attributes)
-        user.ship_address = ship_address if user
+        user.ship_address = ship_address if user && user.ship_address.nil?
       end
 
       private

data/app/models/spree/order/currency_updater.rb

@@ -1,7 +1,7 @@
 module Spree
   class Order < Spree::Base
     module CurrencyUpdater
-      extend ActiveSupport::Concern
+      extend ActiveSupport::Concern # FIXME: this module is not required to be a concern
 
       included do
         def homogenize_line_item_currencies

data/app/models/spree/order/emails.rb

@@ -0,0 +1,32 @@
+module Spree
+  class Order < Spree::Base
+    module Emails
+      extend ActiveSupport::Concern
+
+      def deliver_order_confirmation_email
+        # you can overwrite this method in your application / extension to send out the confirmation email
+        # or use `spree_emails` gem
+        # YourEmailVendor.deliver_order_confirmation_email(id) # `id` = ID of the Order being sent, you can also pass the entire Order object using `self`
+        # update_column(:confirmation_delivered, true) # if you would like to mark that the email was sent
+      end
+
+      # If you would like to also send confirmation email to store owner(s)
+      def deliver_store_owner_order_notification_email?
+        false
+      end
+
+      def deliver_store_owner_order_notification_email
+        # you can overwrite this method in your application / extension to send out the confirmation email
+        # or use `spree_emails` gem
+        # YourEmailVendor.deliver_store_owner_notification_email(id) # `id` = ID of the Order being sent, you can also pass the entire Order object using `self`
+        # update_column(:store_owner_notification_delivered, true) # if you would like to mark that the email was sent
+      end
+
+      def send_cancel_email
+        # you can overwrite this method in your application / extension to send out the confirmation email
+        # or use `spree_emails` gem
+        # YourEmailVendor.deliver_cancel_email(id) # `id` = ID of the Order being sent, you can also pass the entire Order object using `self`
+      end
+    end
+  end
+end