spree_core 4.1.1 → 4.5.0

data/app/models/spree/ability.rb

@@ -1,8 +1,9 @@
-# Implementation class for Cancan gem.  Instead of overriding this class, consider adding new permissions
+# Implementation class for Cancan gem. Instead of overriding this class, consider adding new permissions
 # using the special +register_ability+ method which allows extensions to add their own abilities.
 #
-# See http://github.com/ryanb/cancan for more details on cancan.
+# See https://github.com/CanCanCommunity/cancancan for more details.
 require 'cancan'
+
 module Spree
   class Ability
     include CanCan::Ability
@@ -23,59 +24,79 @@ module Spree
     end
 
     def initialize(user)
-      # add cancancan aliasing
-      alias_action :delete, to: :destroy
-      alias_action :create, :update, :destroy, to: :modify
+      alias_cancan_delete_action
 
       user ||= Spree.user_class.new
 
-      if user.respond_to?(:has_spree_role?) && user.has_spree_role?('admin')
-        can :manage, :all
+      if user.persisted? && user.try(:spree_admin?)
+        apply_admin_permissions(user)
       else
-        can :read, Country
-        can :read, OptionType
-        can :read, OptionValue
-        can :create, Order
-        can :show, Order do |order, token|
-          order.user == user || order.token && token == order.token
-        end
-        can :update, Order do |order, token|
-          !order.completed? && (order.user == user || order.token && token == order.token)
-        end
-        can :manage, Spree::Address do |address|
-          address.user == user
-        end
-        can :create, Spree::Address do |_address|
-          user.id.present?
-        end
-        can :read, CreditCard, user_id: user.id
-        can :read, Product
-        can :read, ProductProperty
-        can :read, Property
-        can :create, Spree.user_class
-        can [:show, :update, :destroy], Spree.user_class, id: user.id
-        can :read, State
-        can :read, Taxon
-        can :read, Taxonomy
-        can :read, Variant
-        can :read, Zone
+        apply_user_permissions(user)
       end
 
       # Include any abilities registered by extensions, etc.
+      # this is legacy behaviour and should be removed in Spree 5.0
       Ability.abilities.merge(abilities_to_register).each do |clazz|
         merge clazz.new(user)
       end
 
-      # Protect admin role
-      cannot [:update, :destroy], Role, name: ['admin']
+      protect_admin_role
     end
 
-    private
+    protected
 
     # you can override this method to register your abilities
     # this method has to return array of classes
     def abilities_to_register
       []
     end
+
+    def alias_cancan_delete_action
+      alias_action :delete, to: :destroy
+      alias_action :create, :update, :destroy, to: :modify
+    end
+
+    def apply_admin_permissions(user)
+      can :manage, :all
+    end
+
+    def apply_user_permissions(user)
+      can :read, ::Spree::Country
+      can :read, ::Spree::Menu
+      can :read, ::Spree::CmsPage
+      can :read, ::Spree::OptionType
+      can :read, ::Spree::OptionValue
+      can :create, ::Spree::Order
+      can :show, ::Spree::Order do |order, token|
+        order.user == user || order.token && token == order.token
+      end
+      can :update, ::Spree::Order do |order, token|
+        !order.completed? && (order.user == user || order.token && token == order.token)
+      end
+      can :manage, ::Spree::Address, user_id: user.id
+      can [:read, :destroy], ::Spree::CreditCard, user_id: user.id
+      can :read, ::Spree::Product
+      can :read, ::Spree::ProductProperty
+      can :read, ::Spree::Property
+      can :create, ::Spree.user_class
+      can [:show, :update, :destroy], ::Spree.user_class, id: user.id
+      can :read, ::Spree::State
+      can :read, ::Spree::Store
+      can :read, ::Spree::Taxon
+      can :read, ::Spree::Taxonomy
+      can :read, ::Spree::Variant
+      can :read, ::Spree::Zone
+      can :manage, ::Spree::Wishlist, user_id: user.id
+      can :show, ::Spree::Wishlist do |wishlist|
+        wishlist.user == user || wishlist.is_private == false
+      end
+      can [:create, :update, :destroy], ::Spree::WishedItem do |wished_item|
+        wished_item.wishlist.user == user
+      end
+    end
+
+    def protect_admin_role
+      cannot [:update, :destroy], ::Spree::Role, name: ['admin']
+    end
   end
 end

data/app/models/spree/address.rb

@@ -1,6 +1,18 @@
 module Spree
   class Address < Spree::Base
-    require 'twitter_cldr'
+    require 'validates_zipcode'
+
+    include Metadata
+    if defined?(Spree::Webhooks)
+      include Spree::Webhooks::HasWebhooks
+    end
+    if defined?(Spree::Security::Addresses)
+      include Spree::Security::Addresses
+    end
+
+    if Rails::VERSION::STRING >= '6.1'
+      serialize :preferences, Hash, default: {}
+    end
 
     NO_ZIPCODE_ISO_CODES ||= [
       'AO', 'AG', 'AW', 'BS', 'BZ', 'BJ', 'BM', 'BO', 'BW', 'BF', 'BI', 'CM', 'CF', 'KM', 'CG',
@@ -10,14 +22,22 @@ module Spree
       'TO', 'TV', 'UG', 'AE', 'VU', 'YE', 'ZW'
     ].freeze
 
+    # The required states listed below match those used by PayPal and Shopify.
+    STATES_REQUIRED = [
+      'AU', 'AE', 'BR', 'CA', 'CN', 'ES', 'HK', 'IE', 'IN',
+      'IT', 'MY', 'MX', 'NZ', 'PT', 'RO', 'TH', 'US', 'ZA'
+    ].freeze
+
     # we're not freezing this on purpose so developers can extend and manage
     # those attributes depending of the logic of their applications
     ADDRESS_FIELDS = %w(firstname lastname company address1 address2 city state zipcode country phone)
-    EXCLUDED_KEYS_FOR_COMPARISION = %w(id updated_at created_at deleted_at user_id)
+    EXCLUDED_KEYS_FOR_COMPARISON = %w(id updated_at created_at deleted_at label user_id)
+
+    scope :not_deleted, -> { where(deleted_at: nil) }
 
     belongs_to :country, class_name: 'Spree::Country'
     belongs_to :state, class_name: 'Spree::State', optional: true
-    belongs_to :user, class_name: Spree.user_class.name, optional: true
+    belongs_to :user, class_name: "::#{Spree.user_class}", optional: true
 
     has_many :shipments, inverse_of: :address
 
@@ -31,19 +51,33 @@ module Spree
 
     validate :state_validate, :postal_code_validate
 
+    validates :label, uniqueness: { conditions: -> { where(deleted_at: nil) },
+                                    scope: :user_id,
+                                    case_sensitive: false,
+                                    allow_blank: true,
+                                    allow_nil: true }
+
     delegate :name, :iso3, :iso, :iso_name, to: :country, prefix: true
     delegate :abbr, to: :state, prefix: true, allow_nil: true
 
     alias_attribute :first_name, :firstname
     alias_attribute :last_name, :lastname
 
-    self.whitelisted_ransackable_attributes = %w[firstname lastname company]
+    self.whitelisted_ransackable_attributes = ADDRESS_FIELDS
+    self.whitelisted_ransackable_associations = %w[country state user]
 
     def self.build_default
+      ActiveSupport::Deprecation.warn(<<-DEPRECATION, caller)
+        `Address#build_default` is deprecated and will be removed in Spree 5.0.
+        Please use standard rails `Address.new(country: current_store.default_country)`
+      DEPRECATION
       new(country: Spree::Country.default)
     end
 
     def self.default(user = nil, kind = 'bill')
+      ActiveSupport::Deprecation.warn(<<-DEPRECATION, caller)
+        `Address#default` is deprecated and will be removed in Spree 5.0.
+      DEPRECATION
       if user && user_address = user.public_send(:"#{kind}_address")
         user_address.clone
       else
@@ -91,7 +125,7 @@ module Spree
     end
 
     def value_attributes
-      attributes.except(*EXCLUDED_KEYS_FOR_COMPARISION)
+      attributes.except(*EXCLUDED_KEYS_FOR_COMPARISON)
     end
 
     def empty?
@@ -139,6 +173,7 @@ module Spree
         super
       else
         update_column :deleted_at, Time.current
+        assign_new_default_address_to_user
       end
     end
 
@@ -196,11 +231,23 @@ module Spree
     end
 
     def postal_code_validate
-      return if country.blank? || country.iso.blank? || !require_zipcode?
-      return unless TwitterCldr::Shared::PostalCodes.territories.include?(country.iso.downcase.to_sym)
+      return if country.blank? || country_iso.blank? || !require_zipcode? || zipcode.blank?
+      return unless ::ValidatesZipcode::CldrRegexpCollection::ZIPCODES_REGEX.keys.include?(country_iso.upcase.to_sym)
+
+      formatted_zip = ::ValidatesZipcode::Formatter.new(
+        zipcode: zipcode.to_s.strip,
+        country_alpha2: country_iso.upcase
+      ).format
+
+      errors.add(:zipcode, :invalid) unless ::ValidatesZipcode.valid?(formatted_zip, country_iso.upcase)
+    end
+
+    def assign_new_default_address_to_user
+      return unless user
 
-      postal_code = TwitterCldr::Shared::PostalCodes.for_territory(country.iso)
-      errors.add(:zipcode, :invalid) unless postal_code.valid?(zipcode.to_s.strip)
+      user.bill_address = user.addresses.last if user.bill_address == self
+      user.ship_address = user.addresses.last if user.ship_address == self
+      user.save!
     end
   end
 end

data/app/models/spree/adjustment.rb

@@ -27,6 +27,7 @@ module Spree
       belongs_to :source
     end
     belongs_to :order, class_name: 'Spree::Order', inverse_of: :all_adjustments
+    belongs_to :promotion_action, class_name: 'Spree::PromotionAction', foreign_key: :source_id, optional: true # created only for has_free_shipping?
 
     validates :adjustable, :order, :label, presence: true
     validates :amount, numericality: true
@@ -41,6 +42,7 @@ module Spree
       end
     end
 
+    # FIXME: we should check if we also need to fire this action after update
     after_create :update_adjustable_adjustment_total
     after_destroy :update_adjustable_adjustment_total
 

data/app/models/spree/asset/support/active_storage.rb

@@ -8,7 +8,7 @@ module Spree
           def url(style)
             return placeholder(style) unless attachment.attached?
 
-            attachment.variant(resize: dimensions_for_style(style))
+            attachment.variant(resize_to_limit: dimensions_for_style(style))
           end
 
           def placeholder(style)
@@ -16,7 +16,8 @@ module Spree
           end
 
           def dimensions_for_style(style)
-            self.class.styles.with_indifferent_access[style] || self.class.styles.with_indifferent_access[default_style]
+            dimensions = self.class.styles.with_indifferent_access[style] || self.class.styles.with_indifferent_access[default_style]
+            dimensions.split('x').map(&:to_i)
           end
         end
       end

data/app/models/spree/asset.rb

@@ -1,6 +1,10 @@
 module Spree
   class Asset < Spree::Base
     include Support::ActiveStorage
+    include Metadata
+    if defined?(Spree::Webhooks)
+      include Spree::Webhooks::HasWebhooks
+    end
 
     belongs_to :viewable, polymorphic: true, touch: true
     acts_as_list scope: [:viewable_id, :viewable_type]

data/app/models/spree/base.rb

@@ -22,7 +22,44 @@ class Spree::Base < ApplicationRecord
     false
   end
 
+  def self.for_store(store)
+    plural_model_name = model_name.plural.gsub(/spree_/, '').to_sym
+
+    if store.respond_to?(plural_model_name)
+      store.send(plural_model_name)
+    else
+      self
+    end
+  end
+
   def self.spree_base_scopes
     where(nil)
   end
+
+  def self.spree_base_uniqueness_scope
+    ApplicationRecord.try(:spree_base_uniqueness_scope) || []
+  end
+
+  # FIXME: https://github.com/rails/rails/issues/40943
+  def self.has_many_inversing
+    false
+  end
+
+  def self.json_api_columns
+    column_names.reject { |c| c.match(/_id$|id|preferences|(.*)password|(.*)token|(.*)api_key/) }
+  end
+
+  def self.json_api_permitted_attributes
+    skipped_attributes = %w[id]
+
+    if included_modules.include?(CollectiveIdea::Acts::NestedSet::Model)
+      skipped_attributes.push('lft', 'rgt', 'depth')
+    end
+
+    column_names.reject { |c| skipped_attributes.include?(c.to_s) }
+  end
+
+  def self.json_api_type
+    to_s.demodulize.underscore
+  end
 end

data/app/models/spree/calculator/flat_rate.rb

@@ -3,7 +3,7 @@ require_dependency 'spree/calculator'
 module Spree
   class Calculator::FlatRate < Calculator
     preference :amount, :decimal, default: 0
-    preference :currency, :string, default: -> { Spree::Config[:currency] }
+    preference :currency, :string, default: -> { Spree::Store.default.default_currency }
 
     def self.description
       Spree.t(:flat_rate_per_order)

data/app/models/spree/calculator/flexi_rate.rb

@@ -5,7 +5,7 @@ module Spree
     preference :first_item,      :decimal, default: 0.0
     preference :additional_item, :decimal, default: 0.0
     preference :max_items,       :integer, default: 0
-    preference :currency,        :string,  default: -> { Spree::Config[:currency] }
+    preference :currency,        :string,  default: -> { Spree::Store.default.default_currency }
 
     def self.description
       Spree.t(:flexible_rate)

data/app/models/spree/calculator/price_sack.rb

@@ -5,7 +5,7 @@ module Spree
     preference :minimal_amount, :decimal, default: 0
     preference :normal_amount, :decimal, default: 0
     preference :discount_amount, :decimal, default: 0
-    preference :currency, :string, default: -> { Spree::Config[:currency] }
+    preference :currency, :string, default: -> { Spree::Store.default.default_currency }
 
     def self.description
       Spree.t(:price_sack)

data/app/models/spree/calculator/shipping/digital_delivery.rb

@@ -0,0 +1,22 @@
+require_dependency 'spree/shipping_calculator'
+
+module Spree
+  module Calculator::Shipping
+    class DigitalDelivery < ShippingCalculator
+      preference :amount, :decimal, default: 0
+      preference :currency, :string, default: -> { Spree::Store.default.default_currency }
+
+      def self.description
+        Spree.t('digital.digital_delivery')
+      end
+
+      def compute_package(_package = nil)
+        preferred_amount
+      end
+
+      def available?(package)
+        package.contents.all? { |content| content.variant.digital? }
+      end
+    end
+  end
+end

data/app/models/spree/calculator/shipping/flat_rate.rb

@@ -4,7 +4,7 @@ module Spree
   module Calculator::Shipping
     class FlatRate < ShippingCalculator
       preference :amount, :decimal, default: 0
-      preference :currency, :string, default: -> { Spree::Config[:currency] }
+      preference :currency, :string, default: -> { Spree::Store.default.default_currency }
 
       def self.description
         Spree.t(:shipping_flat_rate_per_order)

data/app/models/spree/calculator/shipping/flexi_rate.rb

@@ -6,7 +6,7 @@ module Spree
       preference :first_item,      :decimal, default: 0.0
       preference :additional_item, :decimal, default: 0.0
       preference :max_items,       :integer, default: 0
-      preference :currency,        :string,  default: -> { Spree::Config[:currency] }
+      preference :currency,        :string,  default: -> { Spree::Store.default.default_currency }
 
       def self.description
         Spree.t(:shipping_flexible_rate)

data/app/models/spree/calculator/shipping/per_item.rb

@@ -4,7 +4,7 @@ module Spree
   module Calculator::Shipping
     class PerItem < ShippingCalculator
       preference :amount, :decimal, default: 0
-      preference :currency, :string, default: -> { Spree::Config[:currency] }
+      preference :currency, :string, default: -> { Spree::Store.default.default_currency }
 
       def self.description
         Spree.t(:shipping_flat_rate_per_item)

data/app/models/spree/calculator/shipping/price_sack.rb

@@ -6,7 +6,7 @@ module Spree
       preference :minimal_amount, :decimal, default: 0
       preference :normal_amount, :decimal, default: 0
       preference :discount_amount, :decimal, default: 0
-      preference :currency, :string, default: -> { Spree::Config[:currency] }
+      preference :currency, :string, default: -> { Spree::Store.default.default_currency }
 
       def self.description
         Spree.t(:shipping_price_sack)

data/app/models/spree/calculator.rb

@@ -2,9 +2,9 @@ module Spree
   class Calculator < Spree::Base
     acts_as_paranoid
 
-    belongs_to :calculable, polymorphic: true, optional: true
+    belongs_to :calculable, polymorphic: true, optional: true, inverse_of: :calculator
 
-    # This method calls a compute_<computable> method. must be overriden in concrete calculator.
+    # This method calls a compute_<computable> method. must be overridden in concrete calculator.
     #
     # It should return amount computed based on #calculable and the computable parameter
     def compute(computable)

data/app/models/spree/classification.rb

@@ -9,7 +9,10 @@ module Spree
     end
 
     validates :taxon, :product, presence: true
+    validates :position, numericality: { only_integer: true, allow_blank: true, allow_nil: true }
     # For #3494
     validates :taxon_id, uniqueness: { scope: :product_id, message: :already_linked, allow_blank: true }
+
+    self.whitelisted_ransackable_attributes = ['taxon_id', 'product_id']
   end
 end

data/app/models/spree/cms/pages/feature_page.rb

@@ -0,0 +1,7 @@
+module Spree::Cms::Pages
+  class FeaturePage < Spree::CmsPage
+    def sections?
+      true
+    end
+  end
+end

data/app/models/spree/cms/pages/homepage.rb

@@ -0,0 +1,20 @@
+module Spree::Cms::Pages
+  class Homepage < Spree::CmsPage
+    before_create :empty_slug
+    after_save :empty_slug
+
+    def sections?
+      true
+    end
+
+    def seo_meta_description
+      meta_description if meta_description.present?
+    end
+
+    private
+
+    def empty_slug
+      self.slug = nil
+    end
+  end
+end

data/app/models/spree/cms/pages/standard_page.rb

@@ -0,0 +1,4 @@
+module Spree::Cms::Pages
+  class StandardPage < Spree::CmsPage
+  end
+end

data/app/models/spree/cms/sections/featured_article.rb

@@ -0,0 +1,22 @@
+module Spree::Cms::Sections
+  class FeaturedArticle < Spree::CmsSection
+    after_initialize :default_values
+
+    store :content, accessors: [:title, :subtitle, :button_text, :rte_content], coder: JSON
+    store :settings, accessors: [:gutters], coder: JSON
+
+    LINKED_RESOURCE_TYPE = ['Spree::Taxon', 'Spree::Product', 'Spree::CmsPage']
+
+    def gutters?
+      gutters == 'Gutters'
+    end
+
+    private
+
+    def default_values
+      self.gutters ||= 'No Gutters'
+      self.fit ||= 'Screen'
+      self.linked_resource_type ||= 'Spree::Taxon'
+    end
+  end
+end

data/app/models/spree/cms/sections/hero_image.rb

@@ -0,0 +1,38 @@
+module Spree::Cms::Sections
+  class HeroImage < Spree::CmsSection
+    after_initialize :default_values
+
+    store :content, accessors: [:title, :button_text], coder: JSON
+    store :settings, accessors: [:gutters], coder: JSON
+
+    LINKED_RESOURCE_TYPE = ['Spree::Taxon', 'Spree::Product', 'Spree::CmsPage']
+
+    def gutters?
+      gutters == 'Gutters'
+    end
+
+    def img_one_sm(dimensions = '600x250>')
+      super
+    end
+
+    def img_one_md(dimensions = '1200x500>')
+      super
+    end
+
+    def img_one_lg(dimensions = '2400x1000>')
+      super
+    end
+
+    def img_one_xl(dimensions = '4800x2000>')
+      super
+    end
+
+    private
+
+    def default_values
+      self.gutters ||= 'No Gutters'
+      self.fit ||= 'Screen'
+      self.linked_resource_type ||= 'Spree::Taxon'
+    end
+  end
+end

data/app/models/spree/cms/sections/image_gallery.rb

@@ -0,0 +1,103 @@
+module Spree::Cms::Sections
+  class ImageGallery < Spree::CmsSection
+    after_initialize :default_values
+    validate :reset_multiple_link_attributes
+
+    LINKED_RESOURCE_TYPE = if Rails::VERSION::STRING < '6.0'
+                             ['Spree::Taxon'].freeze
+                           else
+                             ['Spree::Taxon', 'Spree::Product'].freeze
+                           end
+
+    LAYOUT_OPTIONS = ['Default', 'Reversed'].freeze
+    LABEL_OPTIONS = ['Show', 'Hide'].freeze
+
+    store :content, accessors: [:link_type_one, :link_one, :title_one,
+                                :link_type_two, :link_two, :title_two,
+                                :link_type_three, :link_three, :title_three], coder: JSON
+
+    store :settings, accessors: [:layout_style, :display_labels], coder: JSON
+
+    #
+    # img_one sizing
+    def img_one_md(dimensions = '270x195>')
+      super
+    end
+
+    def img_one_lg(dimensions = '540x390>')
+      super
+    end
+
+    def img_one_xl(dimensions = '1080x780>')
+      super
+    end
+
+    #
+    # img_two sizing
+    def img_two_md(dimensions = '270x400>')
+      super
+    end
+
+    def img_two_lg(dimensions = '540x800>')
+      super
+    end
+
+    def img_two_xl(dimensions = '1080x1600>')
+      super
+    end
+
+    #
+    # img_three sizing
+    def img_three_md(dimensions = '270x195>')
+      super
+    end
+
+    def img_three_lg(dimensions = '540x390>')
+      super
+    end
+
+    def img_three_xl(dimensions = '1080x780>')
+      super
+    end
+
+    def default_layout?
+      layout_style == 'Default'
+    end
+
+    def show_labels?
+      display_labels == 'Show'
+    end
+
+    private
+
+    def reset_multiple_link_attributes
+      return if Rails::VERSION::STRING < '6.0'
+
+      if link_type_one_changed?
+        return if link_type_one_was.nil?
+
+        self.link_one = nil
+      end
+
+      if link_type_two_changed?
+        return if link_type_two_was.nil?
+
+        self.link_two = nil
+      end
+
+      if link_type_three_changed?
+        return if link_type_three_was.nil?
+
+        self.link_three = nil
+      end
+    end
+
+    def default_values
+      self.layout_style ||= 'Default'
+      self.fit ||= 'Container'
+      self.link_type_one ||= 'Spree::Taxon'
+      self.link_type_two ||= 'Spree::Taxon'
+      self.link_type_three ||= 'Spree::Taxon'
+    end
+  end
+end

data/app/models/spree/cms/sections/product_carousel.rb

@@ -0,0 +1,14 @@
+module Spree::Cms::Sections
+  class ProductCarousel < Spree::CmsSection
+    after_initialize :default_values
+
+    LINKED_RESOURCE_TYPE = ['Spree::Taxon']
+
+    private
+
+    def default_values
+      self.fit ||= 'Screen'
+      self.linked_resource_type ||= 'Spree::Taxon'
+    end
+  end
+end