goca-spree-core 3.1.14.rails.5.0

data/app/models/spree/return_item/eligibility_validator/no_reimbursements.rb

@@ -0,0 +1,16 @@
+module Spree
+  class ReturnItem::EligibilityValidator::NoReimbursements < Spree::ReturnItem::EligibilityValidator::BaseValidator
+    def eligible_for_return?
+      if Spree::ReturnItem.where(inventory_unit: @return_item.inventory_unit).where.not(reimbursement_id: nil).any?
+        add_error(:inventory_unit_reimbursed, Spree.t('return_item_inventory_unit_reimbursed'))
+        return false
+      else
+        return true
+      end
+    end
+
+    def requires_manual_intervention?
+      @errors.present?
+    end
+  end
+end

data/app/models/spree/return_item/eligibility_validator/order_completed.rb

@@ -0,0 +1,16 @@
+module Spree
+  class ReturnItem::EligibilityValidator::OrderCompleted < Spree::ReturnItem::EligibilityValidator::BaseValidator
+    def eligible_for_return?
+      if @return_item.inventory_unit.order.completed?
+        return true
+      else
+        add_error(:order_not_completed, Spree.t('return_item_order_not_completed'))
+        return false
+      end
+    end
+
+    def requires_manual_intervention?
+      false
+    end
+  end
+end

data/app/models/spree/return_item/eligibility_validator/rma_required.rb

@@ -0,0 +1,17 @@
+module Spree
+  class ReturnItem::EligibilityValidator::RMARequired < Spree::ReturnItem::EligibilityValidator::BaseValidator
+    def eligible_for_return?
+      if @return_item.return_authorization.present?
+        return true
+      else
+        add_error(:rma_required, Spree.t('return_item_rma_ineligible'))
+        return false
+      end
+    end
+
+    def requires_manual_intervention?
+      false
+    end
+  end
+end
+

data/app/models/spree/return_item/eligibility_validator/time_since_purchase.rb

@@ -0,0 +1,16 @@
+module Spree
+  class ReturnItem::EligibilityValidator::TimeSincePurchase < Spree::ReturnItem::EligibilityValidator::BaseValidator
+    def eligible_for_return?
+      if (@return_item.inventory_unit.order.completed_at + Spree::Config[:return_eligibility_number_of_days].days) > Time.current
+        return true
+      else
+        add_error(:number_of_days, Spree.t('return_item_time_period_ineligible'))
+        return false
+      end
+    end
+
+    def requires_manual_intervention?
+      false
+    end
+  end
+end

data/app/models/spree/return_item/exchange_variant_eligibility/same_option_value.rb

@@ -0,0 +1,34 @@
+module Spree
+  module ReturnItem::ExchangeVariantEligibility
+    class SameOptionValue
+      class_attribute :option_type_restrictions
+      self.option_type_restrictions = []
+      # This can be configured in an initializer, e.g.:
+      # Spree::ReturnItem::ExchangeVariantEligibility::SameOptionValue.option_type_restrictions = ["size", "color"]
+      #
+      # This restriction causes only variants that share the same option value for the
+      # specified option types to be returned. e.g.:
+      #
+      # option_type_restrictions = ["color", "waist"]
+      # Variant: blue pants with 32 waist and 30 inseam
+      #
+      # can be exchanged for:
+      # blue pants with 32 waist and 31 inseam
+      #
+      # cannot be exchanged for:
+      # green pants with 32 waist and 30 inseam
+      # blue pants with 34 waist and 32 inseam
+
+      def self.eligible_variants(variant)
+        product_variants = SameProduct.eligible_variants(variant).includes(option_values: :option_type)
+
+        relevant_option_values = variant.option_values.select { |ov| option_type_restrictions.include? ov.option_type.name }
+        if relevant_option_values.present?
+          product_variants.select { |v| (relevant_option_values & v.option_values) == relevant_option_values }
+        else
+          product_variants
+        end
+      end
+    end
+  end
+end

data/app/models/spree/return_item/exchange_variant_eligibility/same_product.rb

@@ -0,0 +1,9 @@
+module Spree
+  module ReturnItem::ExchangeVariantEligibility
+    class SameProduct
+      def self.eligible_variants(variant)
+        Spree::Variant.where(product_id: variant.product_id, is_master: variant.is_master?).in_stock
+      end
+    end
+  end
+end

data/app/models/spree/return_item.rb

@@ -0,0 +1,236 @@
+module Spree
+  class ReturnItem < Spree::Base
+    COMPLETED_RECEPTION_STATUSES = %w(received given_to_customer)
+
+    class_attribute :return_eligibility_validator
+    self.return_eligibility_validator = ReturnItem::EligibilityValidator::Default
+
+    class_attribute :exchange_variant_engine
+    self.exchange_variant_engine = ReturnItem::ExchangeVariantEligibility::SameProduct
+
+    class_attribute :refund_amount_calculator
+    self.refund_amount_calculator = Calculator::Returns::DefaultRefundAmount
+
+    with_options inverse_of: :return_items do
+      belongs_to :return_authorization
+      belongs_to :inventory_unit
+      belongs_to :customer_return
+      belongs_to :reimbursement
+    end
+    belongs_to :exchange_variant, class_name: 'Spree::Variant'
+    belongs_to :exchange_inventory_unit, class_name: 'Spree::InventoryUnit', inverse_of: :original_return_item
+    belongs_to :preferred_reimbursement_type, class_name: 'Spree::ReimbursementType'
+    belongs_to :override_reimbursement_type, class_name: 'Spree::ReimbursementType'
+
+    validate :eligible_exchange_variant
+    validate :belongs_to_same_customer_order
+    validate :validate_acceptance_status_for_reimbursement
+    validates :inventory_unit, presence: true
+    validate :validate_no_other_completed_return_items, on: :create
+
+    after_create :cancel_others, unless: :cancelled?
+
+    scope :awaiting_return, -> { where(reception_status: 'awaiting') }
+    scope :received, -> { where(reception_status: 'received') }
+    scope :not_cancelled, -> { where.not(reception_status: 'cancelled') }
+    scope :pending, -> { where(acceptance_status: 'pending') }
+    scope :accepted, -> { where(acceptance_status: 'accepted') }
+    scope :rejected, -> { where(acceptance_status: 'rejected') }
+    scope :manual_intervention_required, -> { where(acceptance_status: 'manual_intervention_required') }
+    scope :undecided, -> { where(acceptance_status: %w(pending manual_intervention_required)) }
+    scope :decided, -> { where.not(acceptance_status: %w(pending manual_intervention_required)) }
+    scope :reimbursed, -> { where.not(reimbursement_id: nil) }
+    scope :not_reimbursed, -> { where(reimbursement_id: nil) }
+    scope :exchange_requested, -> { where.not(exchange_variant: nil) }
+    scope :exchange_processed, -> { where.not(exchange_inventory_unit: nil) }
+    scope :exchange_required, -> { exchange_requested.where(exchange_inventory_unit: nil) }
+    scope :resellable, -> { where resellable: true }
+
+    serialize :acceptance_status_errors
+
+    delegate :eligible_for_return?, :requires_manual_intervention?, to: :validator
+    delegate :variant, to: :inventory_unit
+    delegate :shipment, to: :inventory_unit
+
+    before_create :set_default_pre_tax_amount, unless: :pre_tax_amount_changed?
+    before_save :set_exchange_pre_tax_amount
+
+    state_machine :reception_status, initial: :awaiting do
+      after_transition to: :received, do: :attempt_accept
+      after_transition to: :received, do: :process_inventory_unit!
+
+      event :receive do
+        transition to: :received, from: :awaiting
+      end
+
+      event :cancel do
+        transition to: :cancelled, from: :awaiting
+      end
+
+      event :give do
+        transition to: :given_to_customer, from: :awaiting
+      end
+    end
+
+    extend DisplayMoney
+    money_methods :pre_tax_amount, :total
+
+    def reception_completed?
+      COMPLETED_RECEPTION_STATUSES.include?(reception_status)
+    end
+
+    state_machine :acceptance_status, initial: :pending do
+      event :attempt_accept do
+        transition to: :accepted, from: :accepted
+        transition to: :accepted, from: :pending, if: ->(return_item) { return_item.eligible_for_return? }
+        transition to: :manual_intervention_required, from: :pending, if: ->(return_item) { return_item.requires_manual_intervention? }
+        transition to: :rejected, from: :pending
+      end
+
+      # bypasses eligibility checks
+      event :accept do
+        transition to: :accepted, from: [:accepted, :pending, :manual_intervention_required]
+      end
+
+      # bypasses eligibility checks
+      event :reject do
+        transition to: :rejected, from: [:accepted, :pending, :manual_intervention_required]
+      end
+
+      # bypasses eligibility checks
+      event :require_manual_intervention do
+        transition to: :manual_intervention_required, from: [:accepted, :pending, :manual_intervention_required]
+      end
+
+      after_transition any => any, :do => :persist_acceptance_status_errors
+    end
+
+    def self.from_inventory_unit(inventory_unit)
+      not_cancelled.find_by(inventory_unit: inventory_unit) ||
+        new(inventory_unit: inventory_unit).tap(&:set_default_pre_tax_amount)
+    end
+
+    def exchange_requested?
+      exchange_variant.present?
+    end
+
+    def exchange_processed?
+      exchange_inventory_unit.present?
+    end
+
+    def exchange_required?
+      exchange_requested? && !exchange_processed?
+    end
+
+    def total
+      pre_tax_amount + included_tax_total + additional_tax_total
+    end
+
+    def eligible_exchange_variants
+      exchange_variant_engine.eligible_variants(variant)
+    end
+
+    def build_exchange_inventory_unit
+      # The inventory unit needs to have the new variant
+      # but it also needs to know the original line item
+      # for pricing information for if the inventory unit is
+      # ever returned. This means that the inventory unit's line_item
+      # will have a different variant than the inventory unit itself
+      super(variant: exchange_variant, line_item: inventory_unit.line_item, order: inventory_unit.order) if exchange_required?
+    end
+
+    def exchange_shipment
+      exchange_inventory_unit.try(:shipment)
+    end
+
+    def set_default_pre_tax_amount
+      self.pre_tax_amount = refund_amount_calculator.new.compute(self)
+    end
+
+    private
+
+    def persist_acceptance_status_errors
+      self.update_attributes(acceptance_status_errors: validator.errors)
+    end
+
+    def stock_item
+      return unless customer_return
+
+      Spree::StockItem.find_by({
+        variant_id: inventory_unit.variant_id,
+        stock_location_id: customer_return.stock_location_id,
+      })
+    end
+
+    def currency
+      return_authorization.try(:currency) || Spree::Config[:currency]
+    end
+
+    def process_inventory_unit!
+      inventory_unit.return!
+      Spree::StockMovement.create!(
+        stock_item_id: stock_item.id,
+        quantity: 1,
+        originator: return_authorization
+      ) if should_restock?
+    end
+
+    # This logic is also present in the customer return. The reason for the
+    # duplication and not having a validates_associated on the customer_return
+    # is that it would lead to duplicate error messages for the customer return.
+    # Not specifying a stock location for example would add an error message about
+    # the mandatory field when validating the customer return and again when saving
+    # the associated return items.
+    def belongs_to_same_customer_order
+      return unless customer_return && inventory_unit
+
+      if customer_return.order_id != inventory_unit.order_id
+        errors.add(:base, Spree.t(:return_items_cannot_be_associated_with_multiple_orders))
+      end
+    end
+
+    def eligible_exchange_variant
+      return unless exchange_variant && exchange_variant_id_changed?
+      unless eligible_exchange_variants.include?(exchange_variant)
+        errors.add(:base, Spree.t(:invalid_exchange_variant))
+      end
+    end
+
+    def validator
+      @validator ||= return_eligibility_validator.new(self)
+    end
+
+    def validate_acceptance_status_for_reimbursement
+      if reimbursement && !accepted?
+        errors.add(:reimbursement, :cannot_be_associated_unless_accepted)
+      end
+    end
+
+    def set_exchange_pre_tax_amount
+      self.pre_tax_amount = 0.0.to_d if exchange_requested?
+    end
+
+    def validate_no_other_completed_return_items
+      other_return_item = Spree::ReturnItem.where({
+        inventory_unit_id: inventory_unit_id,
+        reception_status: COMPLETED_RECEPTION_STATUSES,
+      }).first
+
+      if other_return_item
+        errors.add(:inventory_unit, :other_completed_return_item_exists, {
+          inventory_unit_id: inventory_unit_id,
+          return_item_id: other_return_item.id,
+        })
+      end
+    end
+
+    def cancel_others
+      Spree::ReturnItem.where(inventory_unit_id: inventory_unit_id).where.not(id: id).
+        not_cancelled.each(&:cancel!)
+    end
+
+    def should_restock?
+      resellable? && variant.should_track_inventory? && stock_item && Spree::Config[:restock_inventory]
+    end
+  end
+end

data/app/models/spree/returns_calculator.rb

@@ -0,0 +1,8 @@
+module Spree
+  class ReturnsCalculator < Calculator
+
+    def compute(return_item)
+      raise NotImplementedError, "Please implement 'compute(return_item)' in your calculator: #{self.class.name}"
+    end
+  end
+end

data/app/models/spree/role.rb

@@ -0,0 +1,8 @@
+module Spree
+  class Role < Spree::Base
+    has_many :role_users, class_name: 'Spree::RoleUser', dependent: :destroy
+    has_many :users, through: :role_users, class_name: Spree.user_class.to_s
+
+    validates :name, presence: true, uniqueness: { allow_blank: true }
+  end
+end

data/app/models/spree/role_user.rb

@@ -0,0 +1,6 @@
+module Spree
+  class RoleUser < Spree::Base
+    belongs_to :role, class_name: 'Spree::Role'
+    belongs_to :user, class_name: Spree.user_class
+  end
+end