spree_core 4.10.1 → 5.0.0.rc1

data/app/models/spree/report_line_items/sales_total.rb

@@ -0,0 +1,49 @@
+module Spree
+  module ReportLineItems
+    class SalesTotal < Spree::ReportLineItem
+      attribute :date, :string
+      attribute :order, :string
+      attribute :product, :string
+      attribute :quantity, :integer
+      attribute :pre_tax_amount, :decimal
+      attribute :promo_total, :decimal
+      attribute :shipment_total, :decimal
+      attribute :tax_total, :decimal
+      attribute :total, :decimal
+
+      delegate :quantity, to: :record
+
+      def date
+        record.order.completed_at.strftime('%Y-%m-%d')
+      end
+
+      def order
+        record.order.number
+      end
+
+      def product
+        record.variant.descriptive_name
+      end
+
+      def total
+        Spree::Money.new(record.final_amount + record.shipping_cost, currency: record.currency)
+      end
+
+      def promo_total
+        record.display_promo_total
+      end
+
+      def pre_tax_amount
+        record.display_pre_tax_amount
+      end
+
+      def shipment_total
+        record.display_shipping_cost
+      end
+
+      def tax_total
+        record.display_tax_total
+      end
+    end
+  end
+end

data/app/models/spree/reports/products_performance.rb

@@ -0,0 +1,44 @@
+module Spree
+  module Reports
+    class ProductsPerformance < Spree::Report
+      def line_items_scope
+        line_items_scope = Spree::LineItem.
+                           select("
+                             #{Spree::LineItem.table_name}.quantity as quantity,
+                             #{Spree::LineItem.table_name}.pre_tax_amount as pre_tax_amount,
+                             #{Spree::LineItem.table_name}.promo_total as promo_total,
+                             #{Spree::LineItem.table_name}.included_tax_total + #{Spree::LineItem.table_name}.additional_tax_total AS tax_total,
+                             #{Spree::LineItem.table_name}.pre_tax_amount + #{Spree::LineItem.table_name}.adjustment_total AS total,
+                             #{Spree::Variant.table_name}.product_id AS product_id
+                           ").
+                           joins(:variant, :order).
+                           where(
+                             spree_line_items: {
+                               currency: currency
+                             },
+                             spree_orders: {
+                               completed_at: (date_from.to_time.beginning_of_day)..(date_to.to_time.end_of_day)
+                             }
+                           )
+
+        return Spree::Product.none if line_items_scope.empty?
+
+        line_items_sql = line_items_scope.to_sql
+
+        product_scope = store.products
+        product_scope = product_scope.where(vendor_id: vendor.id) if defined?(vendor) && vendor.present?
+
+        product_scope.includes(:taxons, :tax_category, variants: :prices, master: :prices).
+                              joins("LEFT JOIN (#{line_items_sql}) AS line_items ON #{Spree::Product.table_name}.id = line_items.product_id").
+                              select("
+                                spree_products.*,
+                                COALESCE(SUM(line_items.pre_tax_amount), 0.0) AS pre_tax_amount,
+                                COALESCE(SUM(line_items.quantity), 0) AS quantity,
+                                COALESCE(SUM(line_items.promo_total), 0.0) AS promo_total,
+                                COALESCE(SUM(line_items.tax_total), 0.0) AS tax_total,
+                                COALESCE(SUM(line_items.total), 0.0) AS total
+                              ").group('spree_products.id')
+      end
+    end
+  end
+end

data/app/models/spree/reports/sales_total.rb

@@ -0,0 +1,14 @@
+module Spree
+  module Reports
+    class SalesTotal < Spree::Report
+      def line_items_scope
+        store.line_items.where(
+          order: Spree::Order.complete.where(
+            currency: currency,
+            completed_at: (date_from.to_time.beginning_of_day)..(date_to.to_time.end_of_day)
+          )
+        ).includes(:order, variant: :product)
+      end
+    end
+  end
+end

data/app/models/spree/return_authorization.rb

@@ -1,5 +1,5 @@
 module Spree
-  class ReturnAuthorization < Spree::Base
+  class ReturnAuthorization < Spree.base_class
     include Spree::Core::NumberGenerator.new(prefix: 'RA', length: 9)
     include Spree::NumberIdentifier
     if defined?(Spree::Webhooks::HasWebhooks)
@@ -14,6 +14,9 @@ module Spree
       has_many :customer_returns
     end
 
+    has_many :reimbursements, through: :customer_returns
+    has_many :refunds, through: :reimbursements
+
     belongs_to :stock_location
     belongs_to :reason, class_name: 'Spree::ReturnAuthorizationReason', foreign_key: :return_authorization_reason_id
 

data/app/models/spree/return_authorization_reason.rb

@@ -1,5 +1,5 @@
 module Spree
-  class ReturnAuthorizationReason < Spree::Base
+  class ReturnAuthorizationReason < Spree.base_class
     include Spree::NamedType
 
     has_many :return_authorizations, dependent: :restrict_with_error

data/app/models/spree/return_item.rb

@@ -1,5 +1,5 @@
 module Spree
-  class ReturnItem < Spree::Base
+  class ReturnItem < Spree.base_class
     COMPLETED_RECEPTION_STATUSES = %w(received given_to_customer)
 
     if defined?(Spree::Webhooks::HasWebhooks)
@@ -35,6 +35,7 @@ module Spree
     belongs_to :exchange_variant, class_name: 'Spree::Variant'
     belongs_to :preferred_reimbursement_type, class_name: 'Spree::ReimbursementType'
     belongs_to :override_reimbursement_type, class_name: 'Spree::ReimbursementType'
+    has_one :line_item, through: :inventory_unit
 
     validate :eligible_exchange_variant
     validate :belongs_to_same_customer_order

data/app/models/spree/role.rb

@@ -1,8 +1,11 @@
 module Spree
-  class Role < Spree::Base
+  class Role < Spree.base_class
     include Spree::UniqueName
 
+    ADMIN_ROLE = 'admin'
+
     has_many :role_users, class_name: 'Spree::RoleUser', dependent: :destroy
-    has_many :users, through: :role_users, class_name: "::#{Spree.user_class}"
+    has_many :users, through: :role_users, source: :user, source_type: Spree.user_class.to_s
+    has_many :admin_users, through: :role_users, source: :user, source_type: Spree.admin_user_class.to_s
   end
 end

data/app/models/spree/role_user.rb

@@ -1,6 +1,6 @@
 module Spree
-  class RoleUser < Spree::Base
+  class RoleUser < Spree.base_class
     belongs_to :role, class_name: 'Spree::Role'
-    belongs_to :user, class_name: Spree.admin_user_class.to_s
+    belongs_to :user, polymorphic: true
   end
 end

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

@@ -1,5 +1,5 @@
 module Spree
-  class Shipment < Spree::Base
+  class Shipment < Spree.base_class
     module Emails
       def send_shipped_email
         # you can overwrite this method in your application / extension to send out the confirmation email

data/app/models/spree/shipment/webhooks.rb

@@ -1,5 +1,5 @@
 module Spree
-  class Shipment < Spree::Base
+  class Shipment < Spree.base_class
     module Webhooks
       extend ActiveSupport::Concern
 

data/app/models/spree/shipment.rb

@@ -1,7 +1,7 @@
 require 'ostruct'
 
 module Spree
-  class Shipment < Spree::Base
+  class Shipment < Spree.base_class
     include Spree::Core::NumberGenerator.new(prefix: 'H', length: 11)
     include Spree::NumberIdentifier
     include Spree::NumberAsParam
@@ -45,6 +45,7 @@ module Spree
     scope :pending, -> { with_state('pending') }
     scope :ready,   -> { with_state('ready') }
     scope :shipped, -> { with_state('shipped') }
+    scope :ready_or_pending, -> { where(state: %w(ready pending)) }
     scope :trackable, -> { where("tracking IS NOT NULL AND tracking != ''") }
     scope :with_state, ->(*s) { where(state: s) }
     # sort by most recent shipped_at, falling back to created_at. add "id desc" to make specs that involve this scope more deterministic.
@@ -58,7 +59,8 @@ module Spree
                                                  joins(:selected_shipping_rate).
                                                    where(Spree::ShippingRate.arel_table[:shipping_method_id].not_eq(nil)).
                                                    select(Spree::ShippingRate.arel_table[:shipping_method_id])
-                                               }
+                                          }
+    scope :digital_delivery, -> { joins(:shipping_methods).merge(Spree::ShippingMethod.digital) }
 
     delegate :store, :currency, to: :order
     delegate :amount_in_cents, to: :display_cost
@@ -152,7 +154,7 @@ module Spree
     #
     # @return [Boolean]
     def shippable?
-      can_ship? && tracked?
+      can_ship? && (tracked? || digital?)
     end
 
     # Returns true if not all of the shipment's line items are fully shipped
@@ -173,7 +175,7 @@ module Spree
     def determine_state(order)
       return 'canceled' if canceled? || order.canceled?
       return 'pending' unless order.can_ship?
-      return 'pending' if inventory_units.any? &:backordered?
+      return 'pending' if inventory_units.any?(&:backordered?)
       return 'shipped' if shipped?
 
       order.paid? || Spree::Config[:auto_capture_on_dispatch] ? 'ready' : 'pending'
@@ -195,6 +197,10 @@ module Spree
     def free?
       return true if final_price == BigDecimal(0)
 
+      with_free_shipping_promotion?
+    end
+
+    def with_free_shipping_promotion?
       adjustments.promotion.any? { |p| p.source.type == 'Spree::Promotion::Actions::FreeShipping' }
     end
 
@@ -223,6 +229,10 @@ module Spree
       inventory_units.includes(:line_item).map(&:line_item).uniq
     end
 
+    def digital?
+      shipping_method&.calculator&.is_a?(Spree::Calculator::Shipping::DigitalDelivery)
+    end
+
     ManifestItem = Struct.new(:line_item, :variant, :quantity, :states)
 
     def manifest

data/app/models/spree/shipping_category.rb

@@ -1,5 +1,5 @@
 module Spree
-  class ShippingCategory < Spree::Base
+  class ShippingCategory < Spree.base_class
     include Spree::UniqueName
     if defined?(Spree::Webhooks::HasWebhooks)
       include Spree::Webhooks::HasWebhooks

data/app/models/spree/shipping_method.rb

@@ -1,8 +1,9 @@
 module Spree
-  class ShippingMethod < Spree::Base
+  class ShippingMethod < Spree.base_class
     acts_as_paranoid
     include Spree::CalculatedAdjustments
     include Spree::Metadata
+    include Spree::DisplayOn
     if defined?(Spree::Webhooks::HasWebhooks)
       include Spree::Webhooks::HasWebhooks
     end
@@ -10,7 +11,7 @@ module Spree
       include Spree::VendorConcern
     end
 
-    DISPLAY = [:both, :front_end, :back_end]
+    extend Spree::DisplayMoney
 
     # Used for #refresh_rates
     DISPLAY_ON_FRONT_END = 1
@@ -18,8 +19,6 @@ module Spree
 
     default_scope { where(deleted_at: nil) }
 
-    scope :with_calculator, ->(calculator) { joins(:calculator).where(calculator: { type: calculator.to_s }) }
-
     has_many :shipping_method_categories, dependent: :destroy
     has_many :shipping_categories, through: :shipping_method_categories
     has_many :shipping_rates, inverse_of: :shipping_method
@@ -32,12 +31,21 @@ module Spree
     belongs_to :tax_category, -> { with_deleted }, class_name: 'Spree::TaxCategory', optional: true
 
     validates :name, :display_on, presence: true
-
+    validates :estimated_transit_business_days_min, numericality: { greater_than_or_equal_to: 1 }, allow_nil: true
+    validates :estimated_transit_business_days_max, numericality: { greater_than_or_equal_to: 1 }, allow_nil: true
     validate :at_least_one_shipping_category
 
-    scope :available,              -> { where(display_on: [:both]) }
-    scope :available_on_front_end, -> { where(display_on: [:front_end, :both]) }
-    scope :available_on_back_end,  -> { where(display_on: [:back_end, :both]) }
+    scope :digital, lambda {
+                      joins(:calculator).where(spree_calculators: { type: Spree::Calculator::Shipping::DigitalDelivery.to_s })
+                    }
+
+    if defined?(PgSearch)
+      # full text search
+      include PgSearch::Model
+      pg_search_scope :search_by_name, against: %i[name]
+    else
+      scope :search_by_name, ->(query) { where('name LIKE ?', "%#{query}%") }
+    end
 
     def include?(address)
       return false unless address
@@ -79,6 +87,38 @@ module Spree
         (backend? && display_filter == DISPLAY_ON_BACK_END)
     end
 
+    def delivery_range
+      return unless estimated_transit_business_days_min || estimated_transit_business_days_max
+
+      if estimated_transit_business_days_min == estimated_transit_business_days_max
+        estimated_transit_business_days_min.to_s
+      else
+        "#{estimated_transit_business_days_min}-#{estimated_transit_business_days_max}"
+      end
+    end
+
+    def display_estimated_price
+      return unless calculator
+
+      @display_estimated_price ||= begin
+        calculator.description + ': ' +
+
+        if calculator.is_a?(Spree::Calculator::Shipping::FlatRate)
+          if calculator.preferred_amount == 0
+            Spree.t(:free)
+          else
+            Spree::Money.new(calculator.preferred_amount, { currency: calculator.preferred_currency }).to_s
+          end
+        elsif calculator.is_a?(Spree::Calculator::Shipping::FlexiRate)
+          Spree::Money.new(calculator.preferred_first_item, { currency: calculator.preferred_currency }).to_s
+        elsif calculator.is_a?(Spree::Calculator::Shipping::FlatPercentItemTotal)
+          ActionController::Base.helpers.number_to_percentage(calculator.preferred_flat_percent, precision: 2)
+        else
+          ''
+        end
+      end
+    end
+
     private
 
     # Some shipping methods are only meant to be set via backend

data/app/models/spree/shipping_method_category.rb

@@ -1,5 +1,5 @@
 module Spree
-  class ShippingMethodCategory < Spree::Base
+  class ShippingMethodCategory < Spree.base_class
     belongs_to :shipping_method, class_name: 'Spree::ShippingMethod'
     belongs_to :shipping_category, class_name: 'Spree::ShippingCategory', inverse_of: :shipping_method_categories
   end

data/app/models/spree/shipping_method_zone.rb

@@ -1,5 +1,5 @@
 module Spree
-  class ShippingMethodZone < Spree::Base
+  class ShippingMethodZone < Spree.base_class
     belongs_to :shipping_method, -> { with_deleted }, inverse_of: :shipping_method_zones, class_name: 'Spree::ShippingMethod'
     belongs_to :zone, inverse_of: :shipping_method_zones, class_name: 'Spree::Zone'
 

data/app/models/spree/shipping_rate.rb

@@ -1,5 +1,5 @@
 module Spree
-  class ShippingRate < Spree::Base
+  class ShippingRate < Spree.base_class
     belongs_to :shipment, class_name: 'Spree::Shipment'
     belongs_to :tax_rate, -> { with_deleted }, class_name: 'Spree::TaxRate'
     belongs_to :shipping_method, -> { with_deleted }, class_name: 'Spree::ShippingMethod', inverse_of: :shipping_rates
@@ -7,7 +7,7 @@ module Spree
 
     money_methods :base_price, :final_price, :tax_amount
 
-    delegate :order, :currency, :free?, to: :shipment
+    delegate :order, :currency, :free?, :with_free_shipping_promotion?, to: :shipment
     delegate :name,             to: :shipping_method
     delegate :code,             to: :shipping_method, prefix: true
 
@@ -34,13 +34,31 @@ module Spree
     # returns base price - any available discounts for this Shipment
     # useful when you want to present a list of available shipping rates
     def final_price
-      if free? || cost < -discount_amount
+      if with_free_shipping_promotion? || cost < -discount_amount
         BigDecimal(0)
       else
         cost + discount_amount
       end
     end
 
+    # Returns the delivery range for the shipping method
+    #
+    # @return [String]
+    def delivery_range
+      return unless shipping_method.delivery_range
+
+      shipping_method.delivery_range
+    end
+
+    # Returns the display delivery range for the shipping method
+    #
+    # @return [String]
+    def display_delivery_range
+      return unless delivery_range
+
+      Spree.t(:display_delivery_range, delivery_range: delivery_range)
+    end
+
     private
 
     def discount_amount

data/app/models/spree/state.rb

@@ -1,5 +1,5 @@
 module Spree
-  class State < Spree::Base
+  class State < Spree.base_class
     belongs_to :country, class_name: 'Spree::Country'
     has_many :addresses, dependent: :restrict_with_error
 

data/app/models/spree/state_change.rb

@@ -1,5 +1,5 @@
 module Spree
-  class StateChange < Spree::Base
+  class StateChange < Spree.base_class
     belongs_to :user, class_name: "::#{Spree.user_class}", optional: true
     belongs_to :stateful, polymorphic: true
 

data/app/models/spree/stock_item/webhooks.rb

@@ -1,5 +1,5 @@
 module Spree
-  class StockItem < Spree::Base
+  class StockItem < Spree.base_class
     module Webhooks
     end
   end

data/app/models/spree/stock_item.rb

@@ -1,5 +1,5 @@
 module Spree
-  class StockItem < Spree::Base
+  class StockItem < Spree.base_class
     acts_as_paranoid
 
     include Spree::Metadata
@@ -93,12 +93,15 @@ module Spree
     end
 
     def conditional_variant_touch
-      # the variant_id changes from nil when a new stock location is added
-      stock_changed = (saved_change_to_count_on_hand? &&
-                        saved_change_to_count_on_hand.any?(&:zero?)) ||
-        saved_change_to_variant_id?
+      variant.touch if !Spree::Config.binary_inventory_cache || stock_changed?
+    end
 
-      variant.touch if !Spree::Config.binary_inventory_cache || stock_changed
+    def stock_changed?
+      # the variant_id changes from nil when a new stock location is added
+      (
+        saved_change_to_count_on_hand? &&
+        saved_change_to_count_on_hand.any?(&:zero?)
+      ) || saved_change_to_variant_id?
     end
   end
 end

data/app/models/spree/stock_location.rb

@@ -1,5 +1,5 @@
 module Spree
-  class StockLocation < Spree::Base
+  class StockLocation < Spree.base_class
     include Spree::UniqueName
     if defined?(Spree::Webhooks::HasWebhooks)
       include Spree::Webhooks::HasWebhooks
@@ -28,6 +28,9 @@ module Spree
     after_save :ensure_one_default
     after_update :conditional_touch_records
 
+    delegate :name, :iso3, :iso, :iso_name, to: :country, prefix: true
+    delegate :show_company_address_field?, to: :address
+
     def state_text
       state.try(:abbr) || state.try(:name) || state_name
     end
@@ -86,8 +89,8 @@ module Spree
       stock_item(variant).try(:backorderable?)
     end
 
-    def restock(variant, quantity, originator = nil)
-      move(variant, quantity, originator)
+    def restock(variant, quantity, originator = nil, persist: true)
+      move(variant, quantity, originator, persist: persist)
     end
 
     def restock_backordered(variant, quantity, _originator = nil)
@@ -98,13 +101,18 @@ module Spree
       )
     end
 
-    def unstock(variant, quantity, originator = nil)
-      move(variant, -quantity, originator)
+    def unstock(variant, quantity, originator = nil, persist: true)
+      move(variant, -quantity, originator, persist: persist)
     end
 
-    def move(variant, quantity, originator = nil)
-      stock_item_or_create(variant).stock_movements.create!(quantity: quantity,
-                                                            originator: originator)
+    def move(variant, quantity, originator = nil, persist: true)
+      stock_item = stock_item_or_create(variant)
+
+      if persist
+        stock_item.stock_movements.create!(quantity: quantity, originator: originator)
+      else
+        originator.stock_movements << stock_item.stock_movements.build(quantity: quantity)
+      end
     end
 
     def fill_status(variant, quantity)
@@ -137,6 +145,24 @@ module Spree
       )
     end
 
+    # needed for address form
+    def require_name?
+      false
+    end
+
+    # needed for address form
+    def require_company?
+      false
+    end
+
+    def require_phone?
+      false
+    end
+
+    def display_name
+      @display_name ||= [admin_name, name].delete_if(&:blank?).join(' / ')
+    end
+
     private
 
     def create_stock_items
@@ -146,6 +172,7 @@ module Spree
     def ensure_one_default
       if default
         StockLocation.where(default: true).where.not(id: id).update_all(default: false)
+        StockLocation.where.not(id: id).update_all(updated_at: Time.current)
       end
     end
 

data/app/models/spree/stock_movement/webhooks.rb

@@ -1,5 +1,5 @@
 module Spree
-  class StockMovement < Spree::Base
+  class StockMovement < Spree.base_class
     module Webhooks
     end
   end

data/app/models/spree/stock_movement.rb

@@ -1,5 +1,5 @@
 module Spree
-  class StockMovement < Spree::Base
+  class StockMovement < Spree.base_class
     QUANTITY_LIMITS = {
       max: 2**31 - 1,
       min: -2**31
@@ -15,7 +15,7 @@ module Spree
     with_options presence: true do
       validates :stock_item
       validates :quantity, numericality: {
-        greater_than_or_equal_to: QUANTITY_LIMITS[:min],
+        greater_than_or_equal_to: :min_quantity,
         less_than_or_equal_to: QUANTITY_LIMITS[:max],
         only_integer: true
       }
@@ -23,7 +23,7 @@ module Spree
 
     scope :recent, -> { order(created_at: :desc) }
 
-    delegate :variant, to: :stock_item
+    delegate :variant, :variant_id, to: :stock_item, allow_nil: true
     delegate :product, to: :variant
 
     self.whitelisted_ransackable_attributes = ['quantity']
@@ -39,5 +39,11 @@ module Spree
 
       stock_item.adjust_count_on_hand quantity
     end
+
+    def min_quantity
+      return QUANTITY_LIMITS[:min] if stock_item.nil? || stock_item.backorderable?
+
+      -stock_item.count_on_hand
+    end
   end
 end