spree_core 5.1.0.beta3 → 5.1.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7dbf1c3a02958e3dcb370c47d5cd4e9c209924301fcf451e91cdce682e60ea74
-  data.tar.gz: 83d62b4be4aeeb60fda78de84dfe73bd5ebf9603b32b5b938274be67a54c25a0
+  metadata.gz: a357b0d9005bb8d7ed5b4b56ebe020d34435ac15a402db9d650880ae01c38127
+  data.tar.gz: 729183094fa42d6d5b00632e5b9d44b61958643aef7b42d1b7931dd98c87b0f6
 SHA512:
-  metadata.gz: fdfef29cde021604e1309c49fd2218ced2bbf37c66b4642a88979955e57d6744a1f6630b1e8937aa4633d626f8c509bf8a7c3fc1c5bf76f0c5ba3f8472bd7fe1
-  data.tar.gz: a2d843bd61853ce37850019f7d378a83cd7fe88b523f1be07354271350498e851625caa9a49f969cbf338a00c12bb289d55a449f8a212d1a8290bab75d720971
+  metadata.gz: 49525a096671b7fce9970204619b1d05d7a421b3d6966b2ca139e492dda1ee2cd3a7339b3ee37ebbb4a31e2e93cdcfc49f8dffd6371ca91f813d9782259bf91f
+  data.tar.gz: faff9b9dd0388d354efcef394b6051951426824ee4d9e05ad5e6c3f952cf3eeba46ba40e631ee306f861529f840efb01e5b138075c188300bded5a88aec65d49

data/app/helpers/spree/base_helper.rb

@@ -230,7 +230,7 @@ module Spree
     end
 
     def spree_base_cache_key
-      [
+      @spree_base_cache_key ||= [
         I18n.locale,
         (current_currency if defined?(current_currency)),
         defined?(try_spree_current_user) && try_spree_current_user.present?,
@@ -246,6 +246,11 @@ module Spree
       Spree::DatabaseTypeUtilities.maximum_value_for(:integer)
     end
 
+    def payment_method_icon_tag(payment_method, opts = {})
+      image_tag "payment_icons/#{payment_method}.svg", opts
+    rescue Sprockets::Rails::Helper::AssetNotFound
+    end
+
     private
 
     def create_product_image_tag(image, product, options, style)

data/app/helpers/spree/images_helper.rb

@@ -15,21 +15,23 @@ module Spree
     end
 
     def spree_image_url(image, options = {})
+      return unless image
+      return unless image.variable?
+      return if image.respond_to?(:attached?) && !image.attached?
+      
+      url_helpers = respond_to?(:main_app) ? main_app : Rails.application.routes.url_helpers
       width = options[:width]
       height = options[:height]
 
-      width = width * 2 if width.present?
-      height = height * 2 if height.present?
-
-      return unless image.attached?
-      return unless image.variable?
+      width *= 2 if width.present?
+      height *= 2 if height.present?
 
       if width.present? && height.present?
-        main_app.cdn_image_url(
+        url_helpers.cdn_image_url(
           image.variant(spree_image_variant_options(resize_to_fill: [width, height]))
         )
       else
-        main_app.cdn_image_url(
+        url_helpers.cdn_image_url(
           image.variant(spree_image_variant_options(resize_to_limit: [width, height]))
         )
       end
@@ -51,17 +53,18 @@ module Spree
       return unless height
       return if height.zero?
 
-      w, h = width.to_f, height.to_f
+      w = width.to_f
+      h = height.to_f
 
       # Always return width / height, flipping if needed
-      if h > w
-        ratio = h / w
-      elsif h < w
-        ratio = w / h
-      else
-        # h == w, square image
-        ratio = 1.0
-      end
+      ratio = if h > w
+                h / w
+              elsif h < w
+                w / h
+              else
+                # h == w, square image
+                1.0
+              end
 
       ratio.round(3)
     end

data/app/helpers/spree/shipment_helper.rb

@@ -0,0 +1,12 @@
+module Spree
+  module ShipmentHelper
+    def shipment_tracking_link_to(shipment:, name: nil, html_options: {})
+      tracking_url = shipment.tracking_url.presence
+      return '' unless tracking_url
+
+      display_text = name || shipment.tracking.presence || tracking_url
+
+      link_to display_text, tracking_url, html_options
+    end
+  end
+end

data/app/jobs/spree/gift_cards/bulk_generate_job.rb

@@ -0,0 +1,13 @@
+module Spree
+  module GiftCards
+    class BulkGenerateJob < ::Spree::BaseJob
+      queue_as Spree.queues.gift_cards
+
+      def perform(id)
+        gift_cards_batch = Spree::GiftCardBatch.find(id)
+
+        gift_cards_batch.create_gift_cards
+      end
+    end
+  end
+end

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

@@ -3,12 +3,23 @@ module Spree
     extend ActiveSupport::Concern
 
     included do
+      auto_strip_attributes :name, :presentation
+
       #
       # Callbacks
       #
       before_validation :set_name_from_presentation, if: -> { name.blank? }
       before_validation :normalize_name
 
+      #
+      # Scopes
+      #
+      scope :search_by_name, ->(query) do
+        i18n do
+          name.matches("%#{query.downcase}%").or(presentation.matches("%#{query.downcase}%"))
+        end
+      end
+
       def set_name_from_presentation
         self.name = presentation
       end

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

@@ -0,0 +1,39 @@
+module Spree
+  module PaymentSourceConcern
+    extend ActiveSupport::Concern
+
+    # Available actions for the payment source.
+    # @return [Array<String>]
+    def actions
+      %w{capture void credit}
+    end
+
+    # Indicates whether its possible to capture the payment
+    # @param payment [Spree::Payment]
+    # @return [Boolean]
+    def can_capture?(payment)
+      payment.pending? || payment.checkout?
+    end
+
+    # Indicates whether its possible to void the payment.
+    # @param payment [Spree::Payment]
+    # @return [Boolean]
+    def can_void?(payment)
+      !payment.failed? && !payment.void?
+    end
+
+    # Indicates whether its possible to credit the payment.  Note that most gateways require that the
+    # payment be settled first which generally happens within 12-24 hours of the transaction.
+    # @param payment [Spree::Payment]
+    # @return [Boolean]
+    def can_credit?(payment)
+      payment.completed? && payment.credit_allowed > 0
+    end
+
+    # Returns true if the payment source has a payment profile.
+    # @return [Boolean]
+    def has_payment_profile?
+      gateway_customer_profile_id.present? || gateway_payment_profile_id.present?
+    end
+  end
+end

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

@@ -306,11 +306,7 @@ module Spree
       if defined?(PgSearch)
         include PgSearch::Model
 
-        if connected? && connection.extension_enabled?('pg_trgm')
-          pg_search_scope :search_by_name, against: { name: 'A', meta_title: 'B' }, using: { trigram: { threshold: 0.3, word_similarity: true } }
-        else
-          pg_search_scope :search_by_name, against: { name: 'A', meta_title: 'B' }, using: { tsearch: { any_word: true, prefix: true } }
-        end
+        pg_search_scope :search_by_name, against: { name: 'A', meta_title: 'B' }, using: { trigram: { threshold: 0.3, word_similarity: true } }
       else
         def self.search_by_name(query)
           i18n { name.lower.matches("%#{query.downcase}%") }

data/app/models/concerns/spree/stores/socials.rb

@@ -3,7 +3,7 @@ module Spree
     module Socials
       extend ActiveSupport::Concern
 
-      SUPPORTED_SOCIAL_NETWORKS = %w[instagram facebook twitter pinterest tiktok youtube spotify].freeze
+      SUPPORTED_SOCIAL_NETWORKS = %w[instagram facebook twitter pinterest tiktok youtube spotify discord].freeze
 
       SOCIAL_NETWORKS_CONFIG = {
         twitter: {
@@ -33,6 +33,10 @@ module Spree
         spotify: {
           input_placeholder: 'https://open.spotify.com/user/your_handle',
           profile_link: 'https://open.spotify.com/user/your_handle'
+        },
+        discord: {
+          input_placeholder: 'https://discord.com/invite/your_handle',
+          profile_link: 'https://discord.com/invite/your_handle'
         }
       }.freeze
 
@@ -61,7 +65,7 @@ module Spree
       end
 
       def social_links
-        @social_links ||= [instagram_link, facebook_link, twitter_link, pinterest_link, youtube_link, tiktok_link, spotify_link].compact_blank
+        @social_links ||= [instagram_link, facebook_link, twitter_link, pinterest_link, youtube_link, tiktok_link, spotify_link, discord_link].compact_blank
       end
     end
   end

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

@@ -31,6 +31,7 @@ module Spree
       has_many :wishlists, class_name: 'Spree::Wishlist', foreign_key: :user_id, dependent: :destroy
       has_many :wished_items, through: :wishlists, source: :wished_items
       has_many :gateway_customers, class_name: 'Spree::GatewayCustomer', foreign_key: :user_id
+      has_many :gift_cards, class_name: 'Spree::GiftCard', foreign_key: :user_id, dependent: :destroy
       belongs_to :ship_address, class_name: 'Spree::Address', optional: true
       belongs_to :bill_address, class_name: 'Spree::Address', optional: true
 
@@ -103,7 +104,7 @@ module Spree
     def total_available_store_credit(currency = nil, store = nil)
       store ||= Store.default
       currency ||= store.default_currency
-      store_credits.for_store(store).where(currency: currency).reload.to_a.sum(&:amount_remaining)
+      store_credits.without_gift_card.for_store(store).where(currency: currency).reload.to_a.sum(&:amount_remaining)
     end
 
     # Returns the available store credits for the current store per currency

data/app/models/spree/ability.rb

@@ -61,6 +61,8 @@ module Spree
       can :manage, :all
       cannot :cancel, Spree::Order
       can :cancel, Spree::Order, &:allow_cancel?
+      cannot :destroy, Spree::Order
+      can :destroy, Spree::Order, &:can_be_deleted?
       cannot [:edit, :update], Spree::RefundReason, mutable: false
       cannot [:edit, :update], Spree::ReimbursementType, mutable: false
     end

data/app/models/spree/address.rb

@@ -6,9 +6,6 @@ module Spree
     if defined?(Spree::Webhooks::HasWebhooks)
       include Spree::Webhooks::HasWebhooks
     end
-    if defined?(Spree::Security::Addresses)
-      include Spree::Security::Addresses
-    end
 
     serialize :preferences, type: Hash, coder: YAML, default: {}
 
@@ -32,6 +29,10 @@ module Spree
     EXCLUDED_KEYS_FOR_COMPARISON = %w(id updated_at created_at deleted_at label user_id public_metadata private_metadata)
     FIELDS_TO_NORMALIZE = %w(firstname lastname phone alternative_phone company address1 address2 city zipcode)
 
+    if defined?(Spree::Security::Addresses)
+      include Spree::Security::Addresses
+    end
+
     scope :not_deleted, -> { where(deleted_at: nil) }
 
     scope :by_state_name_or_abbr, lambda { |state_name|
@@ -64,6 +65,7 @@ module Spree
     end
 
     validate :state_validate, :postal_code_validate
+    validate :address_validators, on: [:create, :update]
 
     validates :label, uniqueness: { conditions: -> { where(deleted_at: nil) },
                                     scope: :user_id,
@@ -71,6 +73,12 @@ module Spree
                                     allow_blank: true,
                                     allow_nil: true }
 
+    def address_validators
+      Rails.application.config.spree.validators.addresses.each do |validator|
+        validates_with validator
+      end
+    end
+
     delegate :name, :iso3, :iso, :iso_name, to: :country, prefix: true
     delegate :abbr, to: :state, prefix: true, allow_nil: true
 

data/app/models/spree/credit_card.rb

@@ -2,6 +2,8 @@ module Spree
   class CreditCard < Spree.base_class
     include ActiveMerchant::Billing::CreditCardMethods
     include Spree::Metadata
+    include Spree::PaymentSourceConcern
+
     if defined?(Spree::Webhooks::HasWebhooks)
       include Spree::Webhooks::HasWebhooks
     end
@@ -135,30 +137,6 @@ module Spree
       brand.present? ? brand.upcase : Spree.t(:no_cc_type)
     end
 
-    def actions
-      %w{capture void credit}
-    end
-
-    # Indicates whether its possible to capture the payment
-    def can_capture?(payment)
-      payment.pending? || payment.checkout?
-    end
-
-    # Indicates whether its possible to void the payment.
-    def can_void?(payment)
-      !payment.failed? && !payment.void?
-    end
-
-    # Indicates whether its possible to credit the payment.  Note that most gateways require that the
-    # payment be settled first which generally happens within 12-24 hours of the transaction.
-    def can_credit?(payment)
-      payment.completed? && payment.credit_allowed > 0
-    end
-
-    def has_payment_profile?
-      gateway_customer_profile_id.present? || gateway_payment_profile_id.present?
-    end
-
     # ActiveMerchant needs first_name/last_name because we pass it a Spree::CreditCard and it calls those methods on it.
     # Looking at the ActiveMerchant source code we should probably be calling #to_active_merchant before passing
     # the object to ActiveMerchant but this should do for now.

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

@@ -0,0 +1,33 @@
+module Spree
+  class Gateway::CustomPaymentSourceMethod < Gateway
+    def provider_class
+      self.class
+    end
+
+    def payment_source_class
+      Spree::PaymentSource
+    end
+
+    def payment_profiles_supported?
+      true
+    end
+
+    def show_in_admin?
+      false
+    end
+
+    def create_profile(payment)
+      return if payment.source.gateway_customer.present?
+
+      user = payment.source.user || payment.order.user
+      return if user.blank?
+
+      find_or_create_customer(user)
+    end
+
+    # simulate a 3rd party payment gateway api to fetch/or create a customer
+    def find_or_create_customer(user)
+      gateway_customers.find_or_create_by!(user: user, profile_id: "CUSTOMER-#{user.id}")
+    end
+  end
+end

data/app/models/spree/gift_card.rb

@@ -0,0 +1,162 @@
+module Spree
+  class GiftCard < Spree.base_class
+    extend DisplayMoney
+    include Spree::SingleStoreResource
+    include Spree::Security::GiftCards if defined?(Spree::Security::GiftCards)
+
+    #
+    # State machine
+    #
+    state_machine :state, initial: :active do
+      event :cancel do
+        transition active: :canceled
+      end
+
+      event :redeem do
+        transition active: :redeemed
+      end
+      after_transition to: :redeemed, do: :after_redeem
+
+      event :partial_redeem do
+        transition active: :partially_redeemed
+      end
+    end
+
+    #
+    # Validations
+    #
+    validates :code, presence: true, uniqueness: { scope: :store_id }
+    validates :store, :currency, presence: true
+    validates :amount, presence: true, numericality: { greater_than: 0 }
+    validates :amount_used, :amount_authorized, presence: true, numericality: { greater_than_or_equal_to: 0 }
+
+    #
+    # Associations
+    #
+    belongs_to :store, class_name: 'Spree::Store'
+    belongs_to :user, class_name: Spree.user_class.to_s, optional: true
+    belongs_to :created_by, class_name: Spree.admin_user_class.to_s, optional: true
+    belongs_to :batch, class_name: 'Spree::GiftCardBatch', optional: true, foreign_key: :gift_card_batch_id
+
+    has_many :store_credits, class_name: 'Spree::StoreCredit', as: :originator
+    has_many :orders, inverse_of: :gift_card, class_name: 'Spree::Order'
+    has_many :users, through: :orders, class_name: Spree.user_class.to_s
+
+    #
+    # Scopes
+    #
+    scope :active, -> { where(state: [:active, :partially_redeemed]).where(expires_at: [nil,  Date.tomorrow..]) }
+    scope :expired, -> { where(state: :active).where(expires_at: ..Date.current) }
+    scope :redeemed, -> { where(state: [:redeemed]) }
+    scope :partially_redeemed, -> { where(state: [:partially_redeemed]) }
+
+    #
+    # Ransack
+    #
+    self.whitelisted_ransackable_attributes = %w[code user_id]
+    self.whitelisted_ransackable_associations = %w[users orders batch]
+
+    auto_strip_attributes :code
+
+    #
+    # Callbacks
+    #
+    before_validation :generate_code
+    before_validation :normalize_code
+    before_validation :set_currency
+    before_destroy :ensure_can_be_deleted
+
+    #
+    # Money
+    #
+    money_methods :amount, :amount_used, :amount_authorized, :amount_remaining
+
+    # Sets the amount
+    # @param amount [String]
+    def amount=(amount)
+      self[:amount] = Spree::LocalizedNumber.parse(amount)
+    end
+
+    # Calculates the remaining amount
+    # @return [Decimal]
+    def amount_remaining
+      amount - amount_used - amount_authorized
+    end
+
+    delegate :email, to: :user, prefix: true, allow_nil: true
+
+    def self.json_api_columns
+      %w[code amount expires_at]
+    end
+
+    # Checks if the gift card is editable
+    # @return [Boolean]
+    def editable?
+      active?
+    end
+
+    # Checks if the gift card can be deleted
+    # @return [Boolean]
+    def can_be_deleted?
+      !redeemed? && !partially_redeemed?
+    end
+
+    # Displays the code in uppercase, eg. ABC1234
+    # @return [String]
+    def display_code
+      code.upcase
+    end
+
+    # Checks if the gift card is expired
+    # @return [Boolean]
+    def expired?
+      !redeemed? && expires_at.present? && expires_at <= Date.current
+    end
+
+    # Checks if the gift card is active, i.e. not expired and not redeemed
+    # @return [Boolean]
+    def active?
+      super && !expired?
+    end
+
+    # Displays state as expired if the gift card is expired, otherwise displays the state
+    # @return [String]
+    def display_state
+      if expired?
+        :expired
+      else
+        state
+      end.to_s
+    end
+
+    private
+
+    def generate_code
+      return if code.present?
+
+      self.code = loop do
+        random_token = SecureRandom.hex(8).downcase
+        break random_token unless self.class.exists?(code: random_token, store_id: store_id)
+      end
+    end
+
+    def normalize_code
+      self.code = code.downcase if code.present?
+    end
+
+    def after_redeem
+      update!(redeemed_at: Time.current)
+    end
+
+    def ensure_can_be_deleted
+      return if can_be_deleted?
+
+      errors.add(:base, :cannot_destroy_used_gift_card)
+      throw(:abort)
+    end
+
+    def set_currency
+      self.currency ||= store&.default_currency
+    end
+  end
+end

data/app/models/spree/gift_card_batch.rb

@@ -0,0 +1,79 @@
+module Spree
+  class GiftCardBatch < Spree.base_class
+    extend DisplayMoney
+    include Spree::SingleStoreResource
+
+    #
+    # Associations
+    #
+    belongs_to :store, class_name: 'Spree::Store'
+    belongs_to :created_by, class_name: Spree.admin_user_class.to_s, optional: true
+    has_many :gift_cards, class_name: 'Spree::GiftCard', inverse_of: :batch, dependent: :destroy
+
+
+    #
+    # Validations
+    #
+    validates :codes_count, :amount, :prefix, presence: true
+    validates :codes_count, numericality: { greater_than: 0, less_than_or_equal_to: Spree::Config[:gift_card_batch_limit].to_i }
+    validates :store, :currency, presence: true
+    validates :amount, numericality: { greater_than: 0 }
+
+    #
+    # Callbacks
+    #
+    before_validation :set_currency
+    after_create :generate_gift_cards
+
+    auto_strip_attributes :prefix
+
+    money_methods :amount
+
+    self.whitelisted_ransackable_attributes = %w[prefix]
+
+    def generate_gift_cards
+      if codes_count < Spree::Config[:gift_card_batch_web_limit].to_i
+        create_gift_cards
+      else
+        Spree::GiftCards::BulkGenerateJob.perform_later(id)
+      end
+    end
+
+    def create_gift_cards
+      @gift_cards_to_insert = []
+
+      Spree::GiftCard.transaction do
+        (codes_count - gift_cards.count).times do
+          @gift_cards_to_insert << gift_card_hash
+        end
+        Spree::GiftCard.insert_all @gift_cards_to_insert if @gift_cards_to_insert.any?
+      end
+    end
+
+    def generate_code
+      loop do
+        code = "#{prefix.downcase}#{SecureRandom.hex(3).downcase}"
+        break code unless Spree::GiftCard.exists?(code: code) || @gift_cards_to_insert.detect { |gc| gc[:code] == code }
+      end
+    end
+
+    private
+
+    def gift_card_hash
+      {
+        state: :active,
+        gift_card_batch_id: id,
+        amount: amount,
+        currency: currency,
+        code: generate_code,
+        store_id: store_id,
+        created_by_id: created_by_id,
+        expires_at: expires_at
+      }
+    end
+
+    def set_currency
+      self.currency ||= store&.default_currency
+    end
+  end
+end

data/app/models/spree/inventory_unit.rb

@@ -1,5 +1,6 @@
 module Spree
   class InventoryUnit < Spree.base_class
+    extend Spree::DisplayMoney
     if defined?(Spree::Webhooks::HasWebhooks)
       include Spree::Webhooks::HasWebhooks
     end
@@ -30,6 +31,8 @@ module Spree
 
     validates :quantity, numericality: { greater_than: 0 }
 
+    money_methods :charged_amount
+
     # state machine (see http://github.com/pluginaweek/state_machine/tree/master for details)
     state_machine initial: :on_hand do
       event :fill_backorder do
@@ -113,6 +116,14 @@ module Spree
       original_return_item_id?
     end
 
+    def charged_amount
+      percentage_of_line_item * line_item.pre_tax_amount
+    end
+
+    def percentage_of_line_item
+      quantity / BigDecimal(line_item.quantity)
+    end
+
     private
 
     def allow_ship?
@@ -124,10 +135,6 @@ module Spree
       order.fulfill!
     end
 
-    def percentage_of_line_item
-      quantity / BigDecimal(line_item.quantity)
-    end
-
     def current_return_item
       return_items.not_cancelled.first
     end