spree_core 4.0.0 → 4.5.1

data/app/models/spree/stock/availability_validator.rb

@@ -14,10 +14,15 @@ module Spree
         display_name = variant.name.to_s
         display_name += " (#{variant.options_text})" unless variant.options_text.blank?
 
-        line_item.errors[:quantity] << Spree.t(
-          :selected_quantity_not_available,
-          item: display_name.inspect
-        )
+        if variant.available?
+          line_item.errors.add(:quantity,
+                               :selected_quantity_not_available,
+                               message: Spree.t(:selected_quantity_not_available, item: display_name.inspect))
+        else
+          line_item.errors.add(:base,
+                               :only_active_products_can_be_added_to_cart,
+                               message: Spree.t(:only_active_products_can_be_added_to_cart))
+        end
       end
 
       private

data/app/models/spree/stock/content_item.rb

@@ -12,7 +12,7 @@ module Spree
         delegate :line_item,
                  :quantity,
                  :variant, to: :inventory_unit
-        delegate :price, to: :variant
+        delegate :price, to: :line_item
         delegate :dimension,
                  :volume,
                  :weight, to: :variant, prefix: true

data/app/models/spree/stock/quantifier.rb

@@ -9,15 +9,15 @@ module Spree
       end
 
       def total_on_hand
-        if variant.should_track_inventory?
-          stock_items.sum(:count_on_hand)
-        else
-          Float::INFINITY
-        end
+        @total_on_hand ||= if variant.should_track_inventory?
+                             stock_items.sum(:count_on_hand)
+                           else
+                             BigDecimal::INFINITY
+                           end
       end
 
       def backorderable?
-        stock_items.any?(&:backorderable)
+        @backorderable ||= stock_items.any?(&:backorderable)
       end
 
       def can_supply?(required = 1)
@@ -31,7 +31,7 @@ module Spree
       private
 
       def scope_to_location(collection)
-        return collection.with_active_stock_location unless stock_location.present?
+        return collection.with_active_stock_location if stock_location.blank?
 
         collection.where(stock_location: stock_location)
       end

data/app/models/spree/stock/splitter/digital.rb

@@ -0,0 +1,35 @@
+module Spree
+  module Stock
+    module Splitter
+      class Digital < Spree::Stock::Splitter::Base
+        def split(packages)
+          split_packages = []
+          packages.each do |package|
+            split_packages += split_by_digital(package)
+          end
+
+          return_next(split_packages)
+        end
+
+        private
+
+        def split_by_digital(package)
+          digitals = Hash.new { |hash, key| hash[key] = [] }
+          package.contents.each do |item|
+            digitals[item.variant.digital?] << item
+          end
+
+          hash_to_packages(digitals)
+        end
+
+        def hash_to_packages(digitals)
+          packages = []
+          digitals.each do |_id, contents|
+            packages << build_package(contents)
+          end
+          packages
+        end
+      end
+    end
+  end
+end

data/app/models/spree/stock_item.rb

@@ -2,9 +2,14 @@ module Spree
   class StockItem < Spree::Base
     acts_as_paranoid
 
+    include Metadata
+    if defined?(Spree::Webhooks)
+      include Spree::Webhooks::HasWebhooks
+    end
+
     with_options inverse_of: :stock_items do
       belongs_to :stock_location, class_name: 'Spree::StockLocation'
-      belongs_to :variant, class_name: 'Spree::Variant'
+      belongs_to :variant, -> { with_deleted }, class_name: 'Spree::Variant'
     end
     has_many :stock_movements, inverse_of: :stock_item
 
@@ -26,7 +31,7 @@ module Spree
     after_destroy { variant.touch }
 
     self.whitelisted_ransackable_attributes = %w[count_on_hand stock_location_id variant_id]
-    self.whitelisted_ransackable_associations = ['variant']
+    self.whitelisted_ransackable_associations = %w[variant stock_location]
 
     scope :with_active_stock_location, -> { joins(:stock_location).merge(Spree::StockLocation.active) }
 
@@ -56,10 +61,6 @@ module Spree
       in_stock? || backorderable?
     end
 
-    def variant
-      Spree::Variant.unscoped { super }
-    end
-
     def reduce_count_on_hand_to_zero
       set_count_on_hand(0) if count_on_hand > 0
     end
@@ -83,7 +84,7 @@ module Spree
 
         if unit.quantity > number
           # if required quantity is greater than available
-          # split off and fullfill that
+          # split off and fulfill that
           split = unit.split_inventory!(number)
           split.fill_backorder
         else

data/app/models/spree/stock_location.rb

@@ -1,19 +1,30 @@
 module Spree
   class StockLocation < Spree::Base
+    include UniqueName
+    if defined?(Spree::Webhooks)
+      include Spree::Webhooks::HasWebhooks
+    end
+    if defined?(Spree::Security::StockLocations)
+      include Spree::Security::StockLocations
+    end
+    if defined?(Spree::VendorConcern)
+      include Spree::VendorConcern
+    end
+
     has_many :shipments
     has_many :stock_items, dependent: :delete_all, inverse_of: :stock_location
+    has_many :variants, through: :stock_items
     has_many :stock_movements, through: :stock_items
 
     belongs_to :state, class_name: 'Spree::State', optional: true
     belongs_to :country, class_name: 'Spree::Country'
 
-    validates :name, presence: true, uniqueness: { allow_blank: true, case_sensitive: false }
-
     scope :active, -> { where(active: true) }
     scope :order_default, -> { order(default: :desc, name: :asc) }
 
     after_create :create_stock_items, if: :propagate_all_variants?
     after_save :ensure_one_default
+    after_update :conditional_touch_records
 
     def state_text
       state.try(:abbr) || state.try(:name) || state_name
@@ -45,15 +56,19 @@ module Spree
     end
 
     # Attempts to look up StockItem for the variant, and creates one if not found.
-    # This method accepts an instance of the variant.
-    # Other methods in this model attempt to pass a variant,
-    # but controller actions can pass just the variant id as a parameter.
     #
-    # @param variant [Variant] Variant instance.
+    # @param variant Variant instance or Variant ID
     #
     # @return [StockItem] Corresponding StockItem for the StockLocation's variant.
-    def stock_item_or_create(variant)
-      stock_item(variant) || stock_items.create(variant_id: variant.id)
+    def stock_item_or_create(variant_or_variant_id)
+      if variant_or_variant_id.is_a?(Spree::Variant)
+        variant_id = variant_or_variant_id.id
+        variant = variant_or_variant_id
+      else
+        variant_id = variant_or_variant_id
+        variant = Spree::Variant.find(variant_or_variant_id)
+      end
+      stock_item(variant_id) || propagate_variant(variant)
     end
 
     def count_on_hand(variant)
@@ -86,8 +101,7 @@ module Spree
     end
 
     def fill_status(variant, quantity)
-      if item = stock_item(variant)
-
+      if item = stock_item_or_create(variant)
         if item.count_on_hand >= quantity
           on_hand = quantity
           backordered = 0
@@ -106,9 +120,7 @@ module Spree
     private
 
     def create_stock_items
-      Variant.includes(:product).find_each do |variant|
-        propagate_variant(variant)
-      end
+      Spree::StockLocations::StockItems::CreateJob.perform_later(self)
     end
 
     def ensure_one_default
@@ -116,5 +128,12 @@ module Spree
         StockLocation.where(default: true).where.not(id: id).update_all(default: false)
       end
     end
+
+    def conditional_touch_records
+      return unless active_changed?
+
+      stock_items.update_all(updated_at: Time.current)
+      variants.update_all(updated_at: Time.current)
+    end
   end
 end

data/app/models/spree/stock_movement.rb

@@ -5,6 +5,10 @@ module Spree
       min: -2**31
     }.freeze
 
+    if defined?(Spree::Webhooks)
+      include Spree::Webhooks::HasWebhooks
+    end
+
     belongs_to :stock_item, class_name: 'Spree::StockItem', inverse_of: :stock_movements
     belongs_to :originator, polymorphic: true
 
@@ -21,6 +25,9 @@ module Spree
 
     scope :recent, -> { order(created_at: :desc) }
 
+    delegate :variant, to: :stock_item
+    delegate :product, to: :variant
+
     self.whitelisted_ransackable_attributes = ['quantity']
 
     def readonly?

data/app/models/spree/stock_transfer.rb

@@ -1,20 +1,20 @@
 module Spree
   class StockTransfer < Spree::Base
     include Spree::Core::NumberGenerator.new(prefix: 'T')
+    include NumberIdentifier
+    include NumberAsParam
+    include Metadata
+    if defined?(Spree::Webhooks)
+      include Spree::Webhooks::HasWebhooks
+    end
 
     has_many :stock_movements, as: :originator
 
     belongs_to :source_location, class_name: 'StockLocation', optional: true
     belongs_to :destination_location, class_name: 'StockLocation'
 
-    validates :number, uniqueness: true
-
     self.whitelisted_ransackable_attributes = %w[reference source_location_id destination_location_id number]
 
-    def to_param
-      number
-    end
-
     def source_movements
       find_stock_location_with_location_id(source_location_id)
     end

data/app/models/spree/store.rb

@@ -1,30 +1,195 @@
 module Spree
   class Store < Spree::Base
+    if defined?(Spree::Webhooks)
+      include Spree::Webhooks::HasWebhooks
+    end
+    if defined?(Spree::Security::Stores)
+      include Spree::Security::Stores
+    end
+
+    typed_store :settings, coder: ActiveRecord::TypedStore::IdentityCoder do |s|
+      # Spree Digital Asset Configurations
+      s.boolean :limit_digital_download_count, default: true, null: false
+      s.boolean :limit_digital_download_days, default: true, null: false
+      s.integer :digital_asset_authorized_clicks, default: 5, null: false # number of times a customer can download a digital file.
+      s.integer :digital_asset_authorized_days, default: 7, null: false # number of days after initial purchase the customer can download a file.
+      s.integer :digital_asset_link_expire_time, default: 300, null: false # 5 minutes in seconds
+    end
+
+    attr_accessor :skip_validate_not_last
+
+    acts_as_paranoid
+
     has_many :orders, class_name: 'Spree::Order'
+    has_many :line_items, through: :orders, class_name: 'Spree::LineItem'
+    has_many :shipments, through: :orders, class_name: 'Spree::Shipment'
+    has_many :payments, through: :orders, class_name: 'Spree::Payment'
+    has_many :return_authorizations, through: :orders, class_name: 'Spree::ReturnAuthorization'
+    # has_many :reimbursements, through: :orders, class_name: 'Spree::Reimbursement' FIXME: we should fetch this via Customer Return
+
+    has_many :store_payment_methods, class_name: 'Spree::StorePaymentMethod'
+    has_many :payment_methods, through: :store_payment_methods, class_name: 'Spree::PaymentMethod'
+
+    has_many :cms_pages, class_name: 'Spree::CmsPage'
+    has_many :cms_sections, through: :cms_pages, class_name: 'Spree::CmsSection'
+
+    has_many :menus, class_name: 'Spree::Menu'
+    has_many :menu_items, through: :menus, class_name: 'Spree::MenuItem'
+
+    has_many :store_products, class_name: 'Spree::StoreProduct'
+    has_many :products, through: :store_products, class_name: 'Spree::Product'
+    has_many :product_properties, through: :products, class_name: 'Spree::ProductProperty'
+    has_many :variants, through: :products, class_name: 'Spree::Variant', source: :variants_including_master
+    has_many :stock_items, through: :variants, class_name: 'Spree::StockItem'
+    has_many :inventory_units, through: :variants, class_name: 'Spree::InventoryUnit'
+    has_many :customer_returns, class_name: 'Spree::CustomerReturn', inverse_of: :store
+
+    has_many :store_credits, class_name: 'Spree::StoreCredit'
+    has_many :store_credit_events, through: :store_credits, class_name: 'Spree::StoreCreditEvent'
+
+    has_many :taxonomies, class_name: 'Spree::Taxonomy'
+    has_many :taxons, through: :taxonomies, class_name: 'Spree::Taxon'
+
+    has_many :store_promotions, class_name: 'Spree::StorePromotion'
+    has_many :promotions, through: :store_promotions, class_name: 'Spree::Promotion'
+
+    has_many :wishlists, class_name: 'Spree::Wishlist'
+
+    belongs_to :default_country, class_name: 'Spree::Country'
+    belongs_to :checkout_zone, class_name: 'Spree::Zone'
 
     with_options presence: true do
-      validates :code, uniqueness: { case_sensitive: false, allow_blank: true }
-      validates :name, :url, :mail_from_address
+      validates :name, :url, :mail_from_address, :default_currency, :code
     end
 
+    validates :digital_asset_authorized_clicks, numericality: { only_integer: true, greater_than: 0 }
+    validates :digital_asset_authorized_days, numericality: { only_integer: true, greater_than: 0 }
+    validates :code, uniqueness: { case_sensitive: false, conditions: -> { with_deleted } }
+    validates :mail_from_address, email: { allow_blank: false }
+
+    # FIXME: we should remove this condition in v5
+    if !ENV['SPREE_DISABLE_DB_CONNECTION'] &&
+        connected? &&
+        table_exists? &&
+        connection.column_exists?(:spree_stores, :new_order_notifications_email)
+      validates :new_order_notifications_email, email: { allow_blank: true }
+    end
+
+    default_scope { order(created_at: :asc) }
+
+    has_one :logo, class_name: 'Spree::StoreLogo', dependent: :destroy, as: :viewable
+    accepts_nested_attributes_for :logo, reject_if: :all_blank
+
+    has_one :mailer_logo, class_name: 'Spree::StoreMailerLogo', dependent: :destroy, as: :viewable
+    accepts_nested_attributes_for :mailer_logo, reject_if: :all_blank
+
+    has_one :favicon_image, class_name: 'Spree::StoreFaviconImage', dependent: :destroy, as: :viewable
+    accepts_nested_attributes_for :favicon_image, reject_if: :all_blank
+
     before_save :ensure_default_exists_and_is_unique
-    before_destroy :validate_not_default
+    before_save :ensure_supported_currencies, :ensure_supported_locales, :ensure_default_country
+    before_destroy :validate_not_last, unless: :skip_validate_not_last
+    before_destroy :pass_default_flag_to_other_store
 
     scope :by_url, ->(url) { where('url like ?', "%#{url}%") }
 
     after_commit :clear_cache
 
-    def self.current(domain = nil)
-      current_store = domain ? Store.by_url(domain).first : nil
-      current_store || Store.default
+    alias_attribute :contact_email, :customer_support_email
+
+    def self.current(url = nil)
+      ActiveSupport::Deprecation.warn(<<-DEPRECATION, caller)
+        `Spree::Store.current` is deprecated and will be removed in Spree 5.0
+        Please use `Spree::Stores::FindCurrent.new(url: "https://example.com").execute` instead
+      DEPRECATION
+      Stores::FindCurrent.new(url: url).execute
     end
 
+    # FIXME: we need to drop `or_initialize` in v5
+    # this behaviour is very buggy and unpredictable
     def self.default
       Rails.cache.fetch('default_store') do
         where(default: true).first_or_initialize
       end
     end
 
+    def self.available_locales
+      Rails.cache.fetch('stores_available_locales') do
+        Spree::Store.all.map(&:supported_locales_list).flatten.uniq
+      end
+    end
+
+    def default_menu(location)
+      menu = menus.find_by(location: location, locale: default_locale) || menus.find_by(location: location)
+
+      menu.root if menu.present?
+    end
+
+    def supported_currencies_list
+      @supported_currencies_list ||= (read_attribute(:supported_currencies).to_s.split(',') << default_currency).sort.map(&:to_s).map do |code|
+        ::Money::Currency.find(code.strip)
+      end.uniq.compact
+    end
+
+    def homepage(requested_locale)
+      cms_pages.by_locale(requested_locale).find_by(type: 'Spree::Cms::Pages::Homepage') ||
+        cms_pages.by_locale(default_locale).find_by(type: 'Spree::Cms::Pages::Homepage') ||
+        cms_pages.find_by(type: 'Spree::Cms::Pages::Homepage')
+    end
+
+    def seo_meta_description
+      if meta_description.present?
+        meta_description
+      elsif seo_title.present?
+        seo_title
+      else
+        name
+      end
+    end
+
+    def supported_locales_list
+      # TODO: add support of multiple supported languages to a single Store
+      @supported_locales_list ||= (read_attribute(:supported_locales).to_s.split(',') << default_locale).compact.uniq.sort
+    end
+
+    def unique_name
+      @unique_name ||= "#{name} (#{code})"
+    end
+
+    def formatted_url
+      return if url.blank?
+
+      @formatted_url ||= if url.match(/http:\/\/|https:\/\//)
+                           url
+                         else
+                           Rails.env.development? || Rails.env.test? ? "http://#{url}" : "https://#{url}"
+                         end
+    end
+
+    def countries_available_for_checkout
+      @countries_available_for_checkout ||= checkout_zone.try(:country_list) || Spree::Country.all
+    end
+
+    def states_available_for_checkout(country)
+      checkout_zone.try(:state_list_for, country) || country.states
+    end
+
+    def checkout_zone_or_default
+      ActiveSupport::Deprecation.warn('Store#checkout_zone_or_default is deprecated and will be removed in Spree 5')
+
+      @checkout_zone_or_default ||= checkout_zone || Spree::Zone.default_checkout_zone
+    end
+
+    def favicon
+      return unless favicon_image&.attachment&.attached?
+
+      favicon_image.attachment.variant(resize_to_limit: [32, 32])
+    end
+
+    def can_be_deleted?
+      self.class.where.not(id: id).any?
+    end
+
     private
 
     def ensure_default_exists_and_is_unique
@@ -35,15 +200,50 @@ module Spree
       end
     end
 
-    def validate_not_default
-      if default
-        errors.add(:base, :cannot_destroy_default_store)
+    def ensure_supported_locales
+      return unless attributes.keys.include?('supported_locales')
+      return if supported_locales.present?
+      return if default_locale.blank?
+
+      self.supported_locales = default_locale
+    end
+
+    def ensure_supported_currencies
+      return unless attributes.keys.include?('supported_currencies')
+      return if supported_currencies.present?
+      return if default_currency.blank?
+
+      self.supported_currencies = default_currency
+    end
+
+    def validate_not_last
+      unless can_be_deleted?
+        errors.add(:base, :cannot_destroy_only_store)
         throw(:abort)
       end
     end
 
+    def pass_default_flag_to_other_store
+      if default? && can_be_deleted?
+        self.class.where.not(id: id).first.update!(default: true)
+        self.default = false
+      end
+    end
+
     def clear_cache
       Rails.cache.delete('default_store')
+      Rails.cache.delete('stores_available_locales')
+    end
+
+    def ensure_default_country
+      return unless has_attribute?(:default_country_id)
+      return if default_country.present? && (checkout_zone.blank? || checkout_zone.country_list.blank? || checkout_zone.country_list.include?(default_country))
+
+      self.default_country = if checkout_zone.present? && checkout_zone.country_list.any?
+                               checkout_zone.country_list.first
+                             else
+                               Country.find_by(iso: 'US') || Country.first
+                             end
     end
   end
 end

data/app/models/spree/store_credit.rb

@@ -1,5 +1,11 @@
 module Spree
   class StoreCredit < Spree::Base
+    include SingleStoreResource
+    include Metadata
+    if defined?(Spree::Webhooks)
+      include Spree::Webhooks::HasWebhooks
+    end
+
     acts_as_paranoid
 
     VOID_ACTION       = 'void'.freeze
@@ -12,13 +18,14 @@ module Spree
 
     DEFAULT_CREATED_BY_EMAIL = 'spree@example.com'.freeze
 
-    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'
     belongs_to :category, class_name: 'Spree::StoreCreditCategory'
-    belongs_to :created_by, class_name: Spree.user_class.to_s, foreign_key: 'created_by_id'
+    belongs_to :created_by, class_name: Spree.admin_user_class.to_s, foreign_key: 'created_by_id'
     belongs_to :credit_type, class_name: 'Spree::StoreCreditType', foreign_key: 'type_id'
-    has_many :store_credit_events
+    belongs_to :store, class_name: 'Spree::Store'
+    has_many :store_credit_events, class_name: 'Spree::StoreCreditEvent'
 
-    validates :user, :category, :credit_type, :created_by, :currency, presence: true
+    validates :user, :category, :credit_type, :created_by, :currency, :store, presence: true
     validates :amount, numericality: { greater_than: 0 }
     validates :amount_used, numericality: { greater_than_or_equal_to: 0 }
     validate :amount_used_less_than_or_equal_to_amount
@@ -38,6 +45,9 @@ module Spree
     extend Spree::DisplayMoney
     money_methods :amount, :amount_used
 
+    self.whitelisted_ransackable_attributes = %w[user_id created_by_id amount currency type_id]
+    self.whitelisted_ransackable_associations = %w[type user created_by]
+
     def amount_remaining
       amount - amount_used - amount_authorized
     end
@@ -68,7 +78,7 @@ module Spree
     end
 
     def validate_authorization(amount, order_currency)
-      if amount_remaining.to_d < amount.to_d
+      if BigDecimal(amount_remaining, 3) < BigDecimal(amount, 3)
         errors.add(:base, Spree.t('store_credit_payment_method.insufficient_funds'))
       elsif currency != order_currency
         errors.add(:base, Spree.t('store_credit_payment_method.currency_mismatch'))
@@ -188,7 +198,8 @@ module Spree
         created_by_id: created_by_id,
         currency: currency,
         type_id: type_id,
-        memo: credit_allocation_memo
+        memo: credit_allocation_memo,
+        store: store
       }
     end
 
@@ -242,7 +253,7 @@ module Spree
     def associate_credit_type
       unless type_id
         credit_type_name = category.try(:non_expiring?) ? 'Non-expiring' : 'Expiring'
-        self.credit_type = Spree::StoreCreditType.find_by(name: credit_type_name)
+        self.credit_type = Spree::StoreCreditType.find_or_create_by(name: credit_type_name)
       end
     end
   end

data/app/models/spree/store_credit_category.rb

@@ -7,6 +7,8 @@ module Spree
     GIFT_CARD_CATEGORY_NAME = 'Gift Card'.freeze
     DEFAULT_NON_EXPIRING_TYPES = [GIFT_CARD_CATEGORY_NAME]
 
+    self.whitelisted_ransackable_attributes = %w[name]
+
     def non_expiring?
       non_expiring_category_types.include? name
     end

data/app/models/spree/store_credit_event.rb

@@ -8,15 +8,10 @@ module Spree
     scope :exposed_events, -> { where.not(action: [Spree::StoreCredit::ELIGIBLE_ACTION, Spree::StoreCredit::AUTHORIZE_ACTION]) }
     scope :reverse_chronological, -> { order(created_at: :desc) }
 
-    delegate :currency, to: :store_credit
+    delegate :currency, :store, to: :store_credit
 
-    def display_amount
-      Spree::Money.new(amount, currency: currency)
-    end
-
-    def display_user_total_amount
-      Spree::Money.new(user_total_amount, currency: currency)
-    end
+    extend DisplayMoney
+    money_methods :amount, :user_total_amount
 
     def display_action
       case action
@@ -32,7 +27,7 @@ module Spree
     end
 
     def order
-      Spree::Payment.find_by(response_code: authorization_code).try(:order)
+      store.payments.find_by(response_code: authorization_code).try(:order)
     end
   end
 end

data/app/models/spree/store_credit_type.rb

@@ -2,5 +2,7 @@ module Spree
   class StoreCreditType < Spree::Base
     DEFAULT_TYPE_NAME = 'Expiring'.freeze
     has_many :store_credits, class_name: 'Spree::StoreCredit', foreign_key: 'type_id'
+
+    validates :name, presence: true
   end
 end

data/app/models/spree/store_favicon_image.rb

@@ -0,0 +1,17 @@
+module Spree
+  class StoreFaviconImage < Asset
+    if Spree.public_storage_service_name
+      has_one_attached :attachment, service: Spree.public_storage_service_name
+    else
+      has_one_attached :attachment
+    end
+
+    VALID_CONTENT_TYPES = ['image/png', 'image/x-icon', 'image/vnd.microsoft.icon'].freeze
+
+    validates :attachment,
+              content_type: VALID_CONTENT_TYPES,
+              dimension: { max: 256..256 },
+              aspect_ratio: :square,
+              size: { less_than_or_equal_to: 1.megabyte }
+  end
+end

data/app/models/spree/store_logo.rb

@@ -0,0 +1,9 @@
+module Spree
+  class StoreLogo < Asset
+    if Spree.public_storage_service_name
+      has_one_attached :attachment, service: Spree.public_storage_service_name
+    else
+      has_one_attached :attachment
+    end
+  end
+end