spree_core 5.1.8 → 5.2.0.rc1

data/app/models/spree/metafield_definition.rb

@@ -0,0 +1,91 @@
+module Spree
+  class MetafieldDefinition < Spree.base_class
+    include Spree::DisplayOn
+
+    DISPLAY = [:both, :back_end]
+
+    #
+    # Associations
+    #
+    has_many :metafields, class_name: 'Spree::Metafield', dependent: :destroy
+
+    #
+    # Validations
+    #
+    validates :namespace, :key, :name, :resource_type, presence: true
+    validates :metafield_type, presence: true, inclusion: { in: :valid_available_types }
+    validates :resource_type, presence: true, inclusion: { in: :valid_available_resources }
+    validates :key, uniqueness: { scope: spree_base_uniqueness_scope + [:resource_type, :namespace] }
+
+    #
+    # Scopes
+    #
+    scope :for_resource_type, ->(resource_type) { where(resource_type: resource_type) }
+    scope :multi_search, ->(search) do
+      return all if search.blank?
+
+      search_term = "%#{search.downcase}%"
+      namespace_condition = arel_table[:namespace].lower.matches(search_term)
+      key_condition = arel_table[:key].lower.matches(search_term)
+      name_condition = arel_table[:name].lower.matches(search_term)
+
+      where(namespace_condition.or(key_condition).or(name_condition))
+    end
+
+    #
+    # Callbacks
+    #
+    normalizes :key, with: ->(value) { value.to_s.parameterize.underscore.strip }
+    normalizes :namespace, with: ->(value) { value.to_s.parameterize.underscore.strip }
+    before_validation :set_default_type, if: -> { metafield_type.blank? }, on: :create
+    before_validation :set_name_from_key, if: -> { name.blank? }, on: :create
+
+    #
+    # Ransack
+    #
+    self.whitelisted_ransackable_attributes = %w[key namespace name resource_type display_on]
+    self.whitelisted_ransackable_scopes = %w[multi_search]
+
+    # Returns the full key with namespace
+    # @return [String] eg. custom.id
+    def full_key
+      "#{namespace}.#{key}"
+    end
+
+    # Returns the CSV header name for this metafield
+    # @return [String] eg. metafield.custom.id
+    def csv_header_name
+      "metafield.#{full_key}"
+    end
+
+    # Returns the available types
+    # @return [Array<Class>]
+    def self.available_types
+      Rails.application.config.spree.metafield_types
+    end
+
+    # Returns the available resources
+    # @return [Array<Class>]
+    def self.available_resources
+      Rails.application.config.spree.metafield_enabled_resources
+    end
+
+    private
+
+    def valid_available_types
+      self.class.available_types.map(&:to_s)
+    end
+
+    def valid_available_resources
+      self.class.available_resources.map(&:to_s)
+    end
+
+    def set_default_type
+      self.metafield_type ||= Rails.application.config.spree.metafield_types.first.to_s
+    end
+
+    def set_name_from_key
+      self.name ||= key.titleize
+    end
+  end
+end

data/app/models/spree/metafields/boolean.rb

@@ -0,0 +1,15 @@
+module Spree
+  module Metafields
+    class Boolean < Spree::Metafield
+      normalizes :value, with: ->(value) { value.to_b.to_s }
+
+      def csv_value
+        value.to_b ? Spree.t(:say_yes) : Spree.t(:say_no)
+      end
+
+      def serialize_value
+        value.to_b
+      end
+    end
+  end
+end

data/app/models/spree/metafields/json.rb

@@ -0,0 +1,27 @@
+module Spree
+  module Metafields
+    class Json < Spree::Metafield
+      validate :value_must_be_valid_json
+
+      def serialize_value
+        JSON.parse(value)
+      rescue JSON::ParserError
+        value
+      end
+
+      def csv_value
+        value.to_s
+      end
+
+      private
+
+      def value_must_be_valid_json
+        return if value.blank?
+
+        JSON.parse(value)
+      rescue JSON::ParserError => e
+        errors.add(:value, "must be valid JSON: #{e.message}")
+      end
+    end
+  end
+end

data/app/models/spree/metafields/long_text.rb

@@ -0,0 +1,7 @@
+module Spree
+  module Metafields
+    class LongText < Spree::Metafield
+      normalizes :value, with: ->(value) { value.to_s.strip }
+    end
+  end
+end

data/app/models/spree/metafields/number.rb

@@ -0,0 +1,15 @@
+module Spree
+  module Metafields
+    class Number < Spree::Metafield
+      validates :value, numericality: true
+
+      def serialize_value
+        value.to_d
+      end
+
+      def csv_value
+        value.to_d.to_s
+      end
+    end
+  end
+end

data/app/models/spree/metafields/rich_text.rb

@@ -0,0 +1,18 @@
+module Spree
+  module Metafields
+    class RichText < Spree::Metafield
+      # Avoid collision with the `value` column used by other metafield types
+      self.ignored_columns = %w[value]
+
+      has_rich_text :value
+
+      def serialize_value
+        value&.body&.to_s
+      end
+
+      def csv_value
+        value&.body&.to_plain_text || ''
+      end
+    end
+  end
+end

data/app/models/spree/metafields/short_text.rb

@@ -0,0 +1,7 @@
+module Spree
+  module Metafields
+    class ShortText < Spree::Metafield
+      normalizes :value, with: ->(value) { value.to_s.strip }
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+module Spree
+  class NewsletterSubscriber < Spree.base_class
+    module Emails
+      extend ActiveSupport::Concern
+
+      def deliver_newsletter_email_verification
+        # you can overwrite this method in your application / extension to send out the confirmation email
+        # or use `spree_emails` gem
+      end
+    end
+  end
+end

data/app/models/spree/newsletter_subscriber.rb

@@ -0,0 +1,64 @@
+require_dependency 'spree/newsletter_subscriber/emails'
+
+module Spree
+  class NewsletterSubscriber < Spree.base_class
+    include Spree::NewsletterSubscriber::Emails
+    include Spree::Metafields
+
+    has_secure_token :verification_token
+
+    #
+    # Associations
+    #
+    belongs_to :user, optional: true, class_name: Spree.user_class&.name
+
+    #
+    # Validations
+    #
+    validates :email,
+              presence: true,
+              format: { with: URI::MailTo::EMAIL_REGEXP },
+              uniqueness: { case_sensitive: false, scope: spree_base_uniqueness_scope }
+
+    #
+    # Scopes
+    #
+    scope :verified, -> { where.not(verified_at: nil) }
+    scope :unverified, -> { where(verified_at: nil) }
+
+    #
+    # Callbacks
+    #
+    normalizes :email, with: ->(email) { email.to_s.strip.downcase.presence }
+
+    #
+    # Ransack filtering
+    #
+    self.whitelisted_ransackable_attributes = %w[email verified_at]
+    self.whitelisted_ransackable_scopes = %w[verified unverified]
+    
+    def accepts_email_marketing
+      return user.accepts_email_marketing if user.present?
+
+      verified?
+    end
+
+    def verified?
+      verified_at.present?
+    end
+
+    def to_csv(_store = nil)
+      Spree::CSV::NewsletterSubscriberPresenter.new(self).call
+    end
+
+    def self.subscribe(email:, user: nil)
+      Spree::Newsletter::Subscribe.new(email: email, current_user: user).call
+    end
+
+    def self.verify(token:)
+      subscriber = unverified.find_by!(verification_token: token)
+
+      Spree::Newsletter::Verify.new(subscriber: subscriber).call
+    end
+  end
+end

data/app/models/spree/option_type.rb

@@ -4,6 +4,7 @@ module Spree
 
     include Spree::ParameterizableName
     include Spree::UniqueName
+    include Spree::Metafields
     include Spree::Metadata
     include Spree::TranslatableResource
     if defined?(Spree::Webhooks::HasWebhooks)
@@ -61,6 +62,7 @@ module Spree
 
     # legacy, name itself is now parameterized before saving
     def filter_param
+      Spree::Deprecation.warn('Spree::OptionType#filter_param is deprecated and will be removed in Spree 6. Please use Spree::OptionType#name instead.')
       name.parameterize
     end
 

data/app/models/spree/option_value.rb

@@ -1,6 +1,7 @@
 module Spree
   class OptionValue < Spree.base_class
     include Spree::ParameterizableName
+    include Spree::Metafields
     include Spree::Metadata
     include Spree::TranslatableResource
     if defined?(Spree::Webhooks::HasWebhooks)

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

@@ -122,6 +122,7 @@ module Spree
               after_transition to: :complete, do: :redeem_gift_card
               after_transition to: :resumed, do: :after_resume
               after_transition to: :canceled, do: :after_cancel
+              after_transition to: :complete, do: :subscribe_to_newsletter
 
               after_transition from: any - :cart, to: any - [:confirm, :complete] do |order|
                 order.update_totals
@@ -132,6 +133,12 @@ module Spree
             alias_method :save_state, :save
           end
 
+          def subscribe_to_newsletter
+            return unless accept_marketing?
+
+            Spree::NewsletterSubscriber.subscribe(email: email, user: user)
+          end
+
           def self.go_to_state(name, options = {})
             self.checkout_steps[name] = options
             self.previous_states.each { |state| add_transition({ from: state, to: name }.merge(options)) }

data/app/models/spree/order.rb

@@ -29,6 +29,7 @@ module Spree
     include Spree::NumberAsParam
     include Spree::SingleStoreResource
     include Spree::MemoizedData
+    include Spree::Metafields
     include Spree::Metadata
     include Spree::MultiSearchable
     if defined?(Spree::Security::Orders)
@@ -348,7 +349,7 @@ module Spree
     end
 
     def updater
-      @updater ||= OrderUpdater.new(self)
+      @updater ||= Spree::Dependencies.order_updater.constantize.new(self)
     end
 
     def update_with_updater!
@@ -452,7 +453,7 @@ module Spree
 
     def full_name
       @full_name ||= if user.present? && user.name.present?
-                       user.name.full
+                       user.full_name
                      else
                        billing_address&.full_name || email
                      end
@@ -847,9 +848,13 @@ module Spree
     end
 
     def to_csv(_store = nil)
+      metafields_for_csv ||= Spree::MetafieldDefinition.for_resource_type('Spree::Order').order(:namespace, :key).map do |mf_def|
+        metafields.find { |mf| mf.metafield_definition_id == mf_def.id }&.csv_value
+      end
+
       csv_lines = []
       all_line_items.each_with_index do |line_item, index|
-        csv_lines << Spree::CSV::OrderLineItemPresenter.new(self, line_item, index).call
+        csv_lines << Spree::CSV::OrderLineItemPresenter.new(self, line_item, index, metafields_for_csv).call
       end
       csv_lines
     end

data/app/models/spree/order_merger.rb

@@ -57,7 +57,7 @@ module Spree
         current_line_item.quantity += other_order_line_item.quantity
         handle_error(current_line_item) unless current_line_item.save
       else
-        other_order_line_item.order_id = order.id
+        order.line_items << other_order_line_item
         other_order_line_item.adjustments.update_all(order_id: order.id)
         handle_error(other_order_line_item) unless other_order_line_item.save
       end
@@ -69,9 +69,7 @@ module Spree
     end
 
     def persist_merge
-      updater.update_item_count
-      updater.update_item_total
-      updater.persist_totals
+      updater.update
     end
 
     def handle_gift_card(other_order)

data/app/models/spree/order_promotion.rb

@@ -6,6 +6,9 @@ module Spree
     delegate :name, :description, :code, :public_metadata, to: :promotion
     delegate :currency, to: :order
 
+    validates :order, :promotion, presence: true
+    validates :order, uniqueness: { scope: :promotion }
+
     extend Spree::DisplayMoney
     money_methods :amount
 

data/app/models/spree/order_updater.rb

@@ -69,7 +69,7 @@ module Spree
     end
 
     def update_shipment_total
-      order.shipment_total = shipments.sum(:cost)
+      order.shipment_total = shipments.to_a.sum(&:cost)
       update_order_total
     end
 
@@ -97,7 +97,7 @@ module Spree
     end
 
     def update_item_total
-      order.item_total = line_items.sum('price * quantity')
+      order.item_total = line_items.to_a.sum(&:amount)
       update_order_total
     end
 

data/app/models/spree/page.rb

@@ -1,6 +1,7 @@
 module Spree
   class Page < Spree.base_class
     include Spree::Previewable
+    include Spree::Linkable
 
     #
     # Magic methods
@@ -14,7 +15,6 @@ module Spree
     #
     belongs_to :pageable, polymorphic: true # this can be either Store or Theme
     has_many :sections, -> { order(position: :asc) }, class_name: 'Spree::PageSection', dependent: :destroy_async, as: :pageable
-    has_many :page_links, as: :linkable, class_name: 'Spree::PageLink', dependent: :destroy
     alias page_sections sections
 
     #
@@ -103,6 +103,10 @@ module Spree
       false
     end
 
+    def linkable?
+      false
+    end
+
     def layout_sections?
       true
     end

data/app/models/spree/page_block.rb

@@ -56,6 +56,10 @@ module Spree
       name
     end
 
+    def form_partial_name
+      type.demodulize.underscore
+    end
+
     def icon_name
       'fullscreen'
     end

data/app/models/spree/page_blocks/image.rb

@@ -1,6 +1,8 @@
 module Spree
   module PageBlocks
     class Image < Spree::PageBlock
+      include Spree::HasImageAltText
+      
       alias image asset
 
       TOP_PADDING_DEFAULT = 20
@@ -8,6 +10,7 @@ module Spree
 
       preference :height, :integer, default: 64
       preference :mobile_height, :integer, default: 32
+      preference :image_alt, :string
 
       def icon_name
         'photo'

data/app/models/spree/page_blocks/metafields.rb

@@ -0,0 +1,18 @@
+module Spree
+  module PageBlocks
+    class Metafields < Spree::PageBlock
+      RESOURCE_TYPE_DEFAULT = 'Spree::Product'
+
+      preference :resource_type, :string, default: -> { self.class::RESOURCE_TYPE_DEFAULT if defined?(self.class::RESOURCE_TYPE_DEFAULT) }
+      preference :metafield_definition_ids, :array, default: -> { available_metafield_definitions.pluck(:id) }
+
+      def icon_name
+        'list'
+      end
+
+      def available_metafield_definitions
+        @available_metafield_definitions ||= Spree::MetafieldDefinition.where(resource_type: preferred_resource_type).available_on_front_end
+      end
+    end
+  end
+end

data/app/models/spree/page_blocks/products/brand.rb

@@ -0,0 +1,15 @@
+module Spree
+  module PageBlocks
+    module Products
+      class Brand < Spree::PageBlocks::Heading
+        preference :text_color, :string
+
+        SIZE_DEFAULT = 'medium'
+
+        def display_name
+          Spree.t(:brand)
+        end
+      end
+    end
+  end
+end

data/app/models/spree/page_blocks/products/buy_buttons.rb

@@ -2,7 +2,7 @@ module Spree
   module PageBlocks
     module Products
       class BuyButtons < Spree::PageBlock
-        TOP_PADDING_DEFAULT = 20
+        TOP_PADDING_DEFAULT = 0
         BOTTOM_PADDING_DEFAULT = 20
 
         preference :text_color, :string
@@ -14,6 +14,10 @@ module Spree
         def display_name
           Spree.t('page_blocks.products.buy_buttons.display_name')
         end
+
+        def form_partial_name
+          'products/buy_buttons'
+        end
       end
     end
   end

data/app/models/spree/page_blocks/products/description.rb

@@ -0,0 +1,18 @@
+module Spree
+  module PageBlocks
+    module Products
+      class Description < Spree::PageBlocks::Text
+        TOP_PADDING_DEFAULT = 0
+        BOTTOM_PADDING_DEFAULT = 20
+
+        def form_partial_name
+          'products/description'
+        end
+
+        def display_name
+          I18n.t('activerecord.attributes.spree/product.description')
+        end
+      end
+    end
+  end
+end

data/app/models/spree/page_blocks/products/price.rb

@@ -10,7 +10,7 @@ module Spree
         end
 
         def display_name
-          'Price'
+          Spree.t(:price)
         end
       end
     end

data/app/models/spree/page_blocks/products/quantity_selector.rb

@@ -2,13 +2,17 @@ module Spree
   module PageBlocks
     module Products
       class QuantitySelector < Spree::PageBlock
-        TOP_PADDING_DEFAULT = 20
+        TOP_PADDING_DEFAULT = 0
         BOTTOM_PADDING_DEFAULT = 20
 
         preference :text_color, :string
 
         def icon_name
-          'selector'
+          'plus-minus'
+        end
+
+        def form_partial_name
+          'products/quantity_selector'
         end
       end
     end

data/app/models/spree/page_blocks/products/title.rb

@@ -7,7 +7,11 @@ module Spree
         preference :text_color, :string
 
         def display_name
-          section.product_name.presence || 'Title'
+          I18n.t('activerecord.attributes.spree/product.name')
+        end
+
+        def icon_name
+          'h-1'
         end
       end
     end

data/app/models/spree/page_blocks/products/variant_picker.rb

@@ -5,7 +5,7 @@ module Spree
         preference :text_color, :string
 
         def icon_name
-          'select'
+          'list-details'
         end
       end
     end

data/app/models/spree/page_section.rb

@@ -5,7 +5,7 @@ module Spree
     # Magic methods
     #
     acts_as_paranoid
-    acts_as_list scope: [:pageable_id, { deleted_at: nil }]
+    acts_as_list scope: [:pageable_type, :pageable_id, { deleted_at: nil }]
 
     #
     # Associations
@@ -123,7 +123,7 @@ module Spree
     end
 
     def can_be_sorted?
-      role == 'content'
+      true
     end
 
     def lazy?

data/app/models/spree/page_sections/breadcrumbs.rb

@@ -0,0 +1,12 @@
+module Spree
+  module PageSections
+    class Breadcrumbs < Spree::PageSection
+      TOP_PADDING_DEFAULT = 20
+      BOTTOM_PADDING_DEFAULT = 20
+
+      def icon_name
+        'chevron-right'
+      end
+    end
+  end
+end

data/app/models/spree/page_sections/footer.rb

@@ -48,16 +48,32 @@ module Spree
           shop_default_links << Spree::PageLink.new(linkable: new_arrivals_collection) if new_arrivals_collection.present?
         end
 
+        default_info_links = []
+
+        if store.policies.find_by(name: Spree.t('terms_of_service')).present?
+          default_info_links << Spree::PageLink.new(
+            label: Spree.t('terms_of_service'),
+            linkable: store.policies.find_by(name: Spree.t('terms_of_service'))
+          )
+        end
+
+        if store.policies.find_by(name: Spree.t('privacy_policy')).present?
+          default_info_links << Spree::PageLink.new(
+            label: Spree.t('privacy_policy'),
+            linkable: store.policies.find_by(name: Spree.t('privacy_policy'))
+          )
+        end
+
         [
           Spree::PageBlocks::Nav.new(
             preferred_label: 'Shop',
             default_links: shop_default_links
           ),
           Spree::PageBlocks::Nav.new(
-            preferred_label: 'Account',
+            preferred_label: Spree.t('account'),
             default_links: [
               Spree::PageLink.new(
-                label: 'My Account',
+                label: Spree.t('my_account'),
                 linkable: pages.find_by(type: 'Spree::Pages::Account')
               ),
               Spree::PageLink.new(
@@ -72,17 +88,8 @@ module Spree
           ),
           Spree::PageBlocks::Nav.new(
             preferred_label: 'Info',
-            default_links: [
-              Spree::PageLink.new(
-                label: 'Privacy Policy',
-                linkable: store.customer_privacy_policy
-              ),
-              Spree::PageLink.new(
-                label: 'Terms of Service',
-                linkable: store.customer_terms_of_service
-              ),
-            ]
-          ),
+            default_links: default_info_links
+          )
         ]
       end