spree_core 4.3.0 → 4.6.1

data/app/models/spree/state.rb

@@ -14,7 +14,7 @@ module Spree
     validates :country, :name, presence: true
     validates :name, :abbr, uniqueness: { case_sensitive: false, scope: :country_id }, allow_blank: true
 
-    self.whitelisted_ransackable_attributes = %w(abbr)
+    self.whitelisted_ransackable_attributes = %w(abbr country_id name)
 
     def self.find_all_by_name_or_abbr(name_or_abbr)
       where('name = ? OR abbr = ?', name_or_abbr, name_or_abbr)

data/app/models/spree/state_change.rb

@@ -1,6 +1,6 @@
 module Spree
   class StateChange < Spree::Base
-    belongs_to :user, class_name: Spree.user_class.to_s, optional: true
+    belongs_to :user, class_name: "::#{Spree.user_class}", optional: true
     belongs_to :stateful, polymorphic: true
 
     def <=>(other)

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

@@ -14,9 +14,15 @@ module Spree
         display_name = variant.name.to_s
         display_name += " (#{variant.options_text})" unless variant.options_text.blank?
 
-        line_item.errors.add(:quantity,
-                             :selected_quantity_not_available,
-                             message: 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

@@ -12,7 +12,7 @@ module Spree
         @total_on_hand ||= if variant.should_track_inventory?
                              stock_items.sum(:count_on_hand)
                            else
-                             Float::INFINITY
+                             BigDecimal::INFINITY
                            end
       end
 
@@ -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,6 +2,11 @@ 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, -> { with_deleted }, class_name: 'Spree::Variant'
@@ -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) }
 
@@ -79,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,5 +1,16 @@
 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
@@ -8,8 +19,6 @@ module Spree
     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) }
 
@@ -47,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)
@@ -88,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
@@ -108,27 +120,7 @@ module Spree
     private
 
     def create_stock_items
-      variants_scope = Spree::Variant
-
-      if self.class.method_defined?(:insert_all) && self.class.method_defined?(:touch_all)
-        prepared_stock_items = variants_scope.ids.map do |variant_id|
-          Hash[
-            'stock_location_id', id,
-            'variant_id', variant_id,
-            'backorderable', backorderable_default,
-            'created_at', Time.current,
-            'updated_at', Time.current
-          ]
-        end
-        if prepared_stock_items.any?
-          stock_items.insert_all(prepared_stock_items)
-          variants_scope.touch_all
-        end
-      else
-        variants_scope.find_each do |variant|
-          propagate_variant(variant)
-        end
-      end
+      Spree::StockLocations::StockItems::CreateJob.perform_later(self)
     end
 
     def ensure_one_default

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,7 +1,36 @@
 module Spree
   class Store < Spree::Base
-    MAILER_LOGO_CONTENT_TYPES = ['image/png', 'image/jpg', 'image/jpeg'].freeze
-    FAVICON_CONTENT_TYPES = ['image/png', 'image/x-icon', 'image/vnd.microsoft.icon'].freeze
+    include TranslatableResource
+    if defined?(Spree::Webhooks)
+      include Spree::Webhooks::HasWebhooks
+    end
+    if defined?(Spree::Security::Stores)
+      include Spree::Security::Stores
+    end
+
+    TRANSLATABLE_FIELDS = %i[name meta_description meta_keywords seo_title facebook
+                             twitter instagram customer_support_email description
+                             address contact_phone new_order_notifications_email].freeze
+    translates(*TRANSLATABLE_FIELDS)
+
+    self::Translation.class_eval do
+      acts_as_paranoid
+      # deleted translation values still need to be accessible - remove deleted_at scope
+      default_scope { unscope(where: :deleted_at) }
+    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'
@@ -19,7 +48,7 @@ module Spree
     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', dependent: :destroy
+    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
@@ -36,6 +65,10 @@ module Spree
     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'
+
+    has_many :data_feeds, class_name: 'Spree::DataFeed'
+
     belongs_to :default_country, class_name: 'Spree::Country'
     belongs_to :checkout_zone, class_name: 'Spree::Zone'
 
@@ -43,8 +76,12 @@ module Spree
       validates :name, :url, :mail_from_address, :default_currency, :code
     end
 
-    validates :code, uniqueness: true
+    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? &&
@@ -54,19 +91,19 @@ module Spree
 
     default_scope { order(created_at: :asc) }
 
-    has_one_attached :logo
-    has_one_attached :mailer_logo
-    has_one_attached :favicon_image
+    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
 
-    validates :mailer_logo, content_type: MAILER_LOGO_CONTENT_TYPES
-    validates :favicon_image, content_type: FAVICON_CONTENT_TYPES,
-                              dimension: { max: 256..256 },
-                              aspect_ratio: :square,
-                              size: { less_than_or_equal_to: 1.megabyte }
+    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_save :ensure_supported_currencies, :ensure_supported_locales, :ensure_default_country
-    before_destroy :validate_not_default
+    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}%") }
 
@@ -82,9 +119,16 @@ module Spree
       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
+        # workaround for Mobility bug with first_or_initialize
+        if where(default: true).any?
+          where(default: true).first
+        else
+          new(default: true)
+        end
       end
     end
 
@@ -142,21 +186,27 @@ module Spree
     end
 
     def countries_available_for_checkout
-      @countries_available_for_checkout ||= checkout_zone_or_default.try(:country_list) || Spree::Country.all
+      @countries_available_for_checkout ||= checkout_zone.try(:country_list) || Spree::Country.all
     end
 
     def states_available_for_checkout(country)
-      checkout_zone_or_default.try(:state_list_for, country) || country.states
+      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.attached?
+      return unless favicon_image&.attachment&.attached?
+
+      favicon_image.attachment.variant(resize_to_limit: [32, 32])
+    end
 
-      favicon_image.variant(resize: '32x32')
+    def can_be_deleted?
+      self.class.where.not(id: id).any?
     end
 
     private
@@ -185,13 +235,20 @@ module Spree
       self.supported_currencies = default_currency
     end
 
-    def validate_not_default
-      if default
-        errors.add(:base, :cannot_destroy_default_store)
+    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')

data/app/models/spree/store_credit.rb

@@ -1,6 +1,10 @@
 module Spree
   class StoreCredit < Spree::Base
     include SingleStoreResource
+    include Metadata
+    if defined?(Spree::Webhooks)
+      include Spree::Webhooks::HasWebhooks
+    end
 
     acts_as_paranoid
 
@@ -14,9 +18,9 @@ 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'
     belongs_to :store, class_name: 'Spree::Store'
     has_many :store_credit_events, class_name: 'Spree::StoreCreditEvent'
@@ -41,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
@@ -246,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

@@ -10,13 +10,8 @@ module Spree
 
     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

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

data/app/models/spree/store_mailer_logo.rb

@@ -0,0 +1,13 @@
+module Spree
+  class StoreMailerLogo < 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/jpg', 'image/jpeg'].freeze
+
+    validates :attachment, content_type: VALID_CONTENT_TYPES
+  end
+end

data/app/models/spree/tax_category.rb

@@ -1,12 +1,20 @@
 module Spree
   class TaxCategory < Spree::Base
+    if defined?(Spree::Webhooks)
+      include Spree::Webhooks::HasWebhooks
+    end
+
     acts_as_paranoid
-    validates :name, presence: true, uniqueness: { case_sensitive: false, scope: :deleted_at }
+    validates :name, presence: true, uniqueness: { case_sensitive: false, scope: spree_base_uniqueness_scope.push(:deleted_at) }
 
     has_many :tax_rates, dependent: :destroy, inverse_of: :tax_category
+    has_many :products, dependent: :nullify
+    has_many :variants, dependent: :nullify
 
     before_save :set_default_category
 
+    self.whitelisted_ransackable_attributes = %w[name is_default tax_code]
+
     def set_default_category
       # set existing default tax category to false if this one has been marked as default
 

data/app/models/spree/tax_rate.rb

@@ -4,6 +4,10 @@ module Spree
 
     include Spree::CalculatedAdjustments
     include Spree::AdjustmentSource
+    include Spree::Metadata
+    if defined?(Spree::Webhooks)
+      include Spree::Webhooks::HasWebhooks
+    end
 
     with_options inverse_of: :tax_rates do
       belongs_to :zone, class_name: 'Spree::Zone', optional: true
@@ -13,7 +17,7 @@ module Spree
 
     with_options presence: true do
       validates :amount, numericality: { allow_nil: true }
-      validates :tax_category
+      validates :tax_category, :name
     end
 
     scope :by_zone, ->(zone) { where(zone_id: zone.id) }
@@ -27,6 +31,8 @@ module Spree
           ->(category) { where(tax_category_id: category.try(:id)) }
     scope :included_in_price, -> { where(included_in_price: true) }
 
+    self.whitelisted_ransackable_attributes = %w[amount zone_id tax_category_id included_in_price name]
+
     # Gets the array of TaxRates appropriate for the specified tax zone
     def self.match(order_tax_zone)
       return [] unless order_tax_zone
@@ -112,7 +118,8 @@ module Spree
 
       ' ' + ActiveSupport::NumberHelper::NumberToPercentageConverter.convert(
         amount * 100,
-        locale: I18n.locale
+        locale: I18n.locale,
+        strip_insignificant_zeros: true
       )
     end
   end