harpiya_core 4.3.0.alpha

data/app/models/harpiya/adjustable/adjuster/base.rb

@@ -0,0 +1,25 @@
+module Harpiya
+  module Adjustable
+    module Adjuster
+      class Base
+        def self.adjust(adjustable, totals)
+          new(adjustable, totals).update
+        end
+
+        def initialize(adjustable, totals)
+          @adjustable = adjustable
+          @totals = totals
+        end
+
+        def update
+          raise NotImplementedError, "Please implement 'update' in your adjuster: #{self.class.name}"
+        end
+
+        private
+
+        attr_reader :adjustable
+        delegate :adjustments, to: :adjustable
+      end
+    end
+  end
+end

data/app/models/harpiya/adjustable/adjuster/promotion.rb

@@ -0,0 +1,41 @@
+module Harpiya
+  module Adjustable
+    module Adjuster
+      class Promotion < Harpiya::Adjustable::Adjuster::Base
+        def update
+          promo_adjustments = adjustments.competing_promos.reload.map { |a| a.update!(adjustable) }
+          promos_total = promo_adjustments.compact.sum
+          choose_best_promo_adjustment unless promos_total == 0
+          promo_total = best_promo_adjustment.try(:amount).to_f if best_promo_adjustment.try(:promotion?)
+
+          update_totals(promo_total)
+        end
+
+        private
+
+        # Picks one (and only one) competing discount to be eligible for
+        # this order. This adjustment provides the most discount, and if
+        # two adjustments have the same amount, then it will pick the
+        # latest one.
+        def choose_best_promo_adjustment
+          if best_promo_adjustment
+            other_promotions = adjustments.competing_promos.where.not(id: best_promo_adjustment.id)
+            other_promotions.update_all(eligible: false)
+          end
+        end
+
+        def best_promo_adjustment
+          @best_promo_adjustment ||= begin
+            adjustments.competing_promos.eligible.reorder('amount ASC, created_at DESC, id DESC').first
+          end
+        end
+
+        def update_totals(promo_total)
+          promo_total ||= 0.0
+          @totals[:promo_total] = promo_total
+          @totals[:taxable_adjustment_total] += promo_total
+        end
+      end
+    end
+  end
+end

data/app/models/harpiya/adjustable/adjuster/tax.rb

@@ -0,0 +1,26 @@
+module Harpiya
+  module Adjustable
+    module Adjuster
+      class Tax < Harpiya::Adjustable::Adjuster::Base
+        def update
+          tax = adjustments.tax
+          included_tax_total = tax.is_included.reload.map(&:update!).compact.sum
+          additional_tax_total = tax.additional.reload.map(&:update!).compact.sum
+
+          update_totals(included_tax_total, additional_tax_total)
+        end
+
+        private
+
+        def adjustments
+          adjustable.try(:all_adjustments) || adjustable.adjustments
+        end
+
+        def update_totals(included_tax_total, additional_tax_total)
+          @totals[:included_tax_total] = included_tax_total
+          @totals[:additional_tax_total] = additional_tax_total
+        end
+      end
+    end
+  end
+end

data/app/models/harpiya/adjustable/adjustments_updater.rb

@@ -0,0 +1,51 @@
+module Harpiya
+  module Adjustable
+    class AdjustmentsUpdater
+      def self.update(adjustable)
+        new(adjustable).update
+      end
+
+      def initialize(adjustable)
+        @adjustable = adjustable
+        adjustable.reload if shipment? && adjustable && adjustable.persisted?
+      end
+
+      def update
+        return unless adjustable_still_exists?
+
+        totals = {
+          non_taxable_adjustment_total: 0,
+          taxable_adjustment_total: 0
+        }
+        adjusters.each do |klass|
+          klass.adjust(@adjustable, totals)
+        end
+
+        persist_totals totals
+      end
+
+      private
+
+      def persist_totals(totals)
+        attributes = totals
+        attributes[:adjustment_total] = totals[:non_taxable_adjustment_total] +
+          totals[:taxable_adjustment_total] +
+          totals[:additional_tax_total]
+        attributes[:updated_at] = Time.current
+        @adjustable.update_columns(totals)
+      end
+
+      def shipment?
+        @adjustable.is_a?(Shipment)
+      end
+
+      def adjusters
+        Rails.application.config.harpiya.adjusters
+      end
+
+      def adjustable_still_exists?
+        @adjustable&.class&.exists?(@adjustable.id)
+      end
+    end
+  end
+end

data/app/models/harpiya/adjustable/promotion_accumulator.rb

@@ -0,0 +1,78 @@
+module Harpiya
+  module Adjustable
+    class PromotionAccumulator
+      attr_reader :adjustments, :sources, :promotions
+
+      # Adds accumulator as an attribute of adjustable to
+      # avoid changing number of passed arguments to
+      # adjustment#update! and concequential methods
+      def self.add_to(adjustable)
+        class << adjustable
+          attr_accessor :promotion_accumulator
+        end
+
+        adjustable.promotion_accumulator = new(adjustable)
+      end
+
+      def initialize(adjustable)
+        @adjustable = adjustable
+        @adjustments = []
+        @sources = []
+        @promotions = []
+        all_adjustments.each { |a| add_adjustment(a) }
+      end
+
+      def add_adjustment(adjustment, opts = {})
+        return unless adjustment.promotion?
+
+        source = opts[:source] || adjustment.source
+        promotion = opts[:promotion] || source.promotion
+
+        add(adjustments, adjustment, adjustment.id)
+        add(sources, source, adjustment.source_id)
+        add(promotions, promotion, source.promotion_id)
+      end
+
+      def promotions_adjustments(promotion_id, adjustments = self.adjustments)
+        where(sources, promotion_id: promotion_id).map do |source|
+          where(adjustments, source_id: source.id)
+        end.flatten
+      end
+
+      def promo_total(*args)
+        promotions_adjustments(*args).map(&:amount).reduce(0, &:+)
+      end
+
+      def total_with_promotion(promotion_id)
+        amount + ship_total + promo_total(promotion_id)
+      end
+
+      def item_total_with_promotion(promotion_id)
+        amount + promo_total(promotion_id, item_adjustments)
+      end
+
+      private
+
+      attr_reader :adjustable
+      delegate :order, to: :adjustable
+      delegate :amount, :ship_total, to: :order
+
+      def all_adjustments
+        order.all_adjustments.promotion.includes(source: [:promotion]).where.
+          not('adjustable_id = ? AND adjustable_type = ?', adjustable.id, adjustable.class.to_s)
+      end
+
+      def add(array, object, id)
+        array << object if array.none? { |a| a.id == id }
+      end
+
+      def item_adjustments
+        adjustments.reject { |a| a.adjustable_type == 'Harpiya::Shipment' }
+      end
+
+      def where(array, opts = {})
+        array.select { |a| opts.all? { |k, v| a.respond_to?(k) && a.send(k) == v } }
+      end
+    end
+  end
+end

data/app/models/harpiya/adjustment.rb

@@ -0,0 +1,109 @@
+# Adjustments represent a change to the +item_total+ of an Order. Each adjustment
+# has an +amount+ that can be either positive or negative.
+#
+# Adjustments can be "opened" or "closed".
+# Once an adjustment is closed, it will not be automatically updated.
+#
+# Boolean attributes:
+#
+# +mandatory+
+#
+# If this flag is set to true then it means the the charge is required and will not
+# be removed from the order, even if the amount is zero. In other words a record
+# will be created even if the amount is zero. This is useful for representing things
+# such as shipping and tax charges where you may want to make it explicitly clear
+# that no charge was made for such things.
+#
+# +eligible?+
+#
+# This boolean attributes stores whether this adjustment is currently eligible
+# for its order. Only eligible adjustments count towards the order's adjustment
+# total. This allows an adjustment to be preserved if it becomes ineligible so
+# it might be reinstated.
+module Harpiya
+  class Adjustment < Harpiya::Base
+    with_options polymorphic: true do
+      belongs_to :adjustable, touch: true
+      belongs_to :source
+    end
+    belongs_to :order, class_name: 'Harpiya::Order', inverse_of: :all_adjustments
+    belongs_to :promotion_action, class_name: 'Harpiya::PromotionAction', foreign_key: :source_id, optional: true # created only for has_free_shipping?
+
+    validates :adjustable, :order, :label, presence: true
+    validates :amount, numericality: true
+
+    state_machine :state, initial: :open do
+      event :close do
+        transition from: :open, to: :closed
+      end
+
+      event :open do
+        transition from: :closed, to: :open
+      end
+    end
+
+    after_create :update_adjustable_adjustment_total
+    after_destroy :update_adjustable_adjustment_total
+
+    class_attribute :competing_promos_source_types
+
+    self.competing_promos_source_types = ['Harpiya::PromotionAction']
+
+    scope :not_finalized, -> { where(state: 'open') }
+    scope :finalized, -> { where(state: 'closed') }
+    scope :tax, -> { where(source_type: 'Harpiya::TaxRate') }
+    scope :non_tax, -> do
+      source_type = arel_table[:source_type]
+      where(source_type.not_eq('Harpiya::TaxRate').or(source_type.eq(nil)))
+    end
+    scope :price, -> { where(adjustable_type: 'Harpiya::LineItem') }
+    scope :shipping, -> { where(adjustable_type: 'Harpiya::Shipment') }
+    scope :optional, -> { where(mandatory: false) }
+    scope :eligible, -> { where(eligible: true) }
+    scope :charge, -> { where("#{quoted_table_name}.amount >= 0") }
+    scope :credit, -> { where("#{quoted_table_name}.amount < 0") }
+    scope :nonzero, -> { where("#{quoted_table_name}.amount != 0") }
+    scope :promotion, -> { where(source_type: 'Harpiya::PromotionAction') }
+    scope :return_authorization, -> { where(source_type: 'Harpiya::ReturnAuthorization') }
+    scope :is_included, -> { where(included: true) }
+    scope :additional, -> { where(included: false) }
+    scope :competing_promos, -> { where(source_type: competing_promos_source_types) }
+    scope :for_complete_order, -> { joins(:order).merge(Harpiya::Order.complete) }
+    scope :for_incomplete_order, -> { joins(:order).merge(Harpiya::Order.incomplete) }
+
+    extend DisplayMoney
+    money_methods :amount
+
+    def amount=(amount)
+      self[:amount] = Harpiya::LocalizedNumber.parse(amount)
+    end
+
+    def currency
+      adjustable ? adjustable.currency : order.currency
+    end
+
+    def promotion?
+      source_type == 'Harpiya::PromotionAction'
+    end
+
+    # Passing a target here would always be recommended as it would avoid
+    # hitting the database again and would ensure you're compute values over
+    # the specific object amount passed here.
+    def update!(target = adjustable)
+      return amount if closed? || source.blank?
+
+      amount = source.compute_amount(target)
+      attributes = { amount: amount, updated_at: Time.current }
+      attributes[:eligible] = source.promotion.eligible?(target) if promotion?
+      update_columns(attributes)
+      amount
+    end
+
+    private
+
+    def update_adjustable_adjustment_total
+      # Cause adjustable's total to be recalculated
+      Adjustable::AdjustmentsUpdater.update(adjustable)
+    end
+  end
+end

data/app/models/harpiya/app_configuration.rb

@@ -0,0 +1,85 @@
+# This is the primary location for defining harpiya preferences
+#
+# The expectation is that this is created once and stored in
+# the harpiya environment
+#
+# setters:
+# a.color = :blue
+# a[:color] = :blue
+# a.set :color = :blue
+# a.preferred_color = :blue
+#
+# getters:
+# a.color
+# a[:color]
+# a.get :color
+# a.preferred_color
+#
+require 'harpiya/core/search/base'
+
+module Harpiya
+  class AppConfiguration < Preferences::Configuration
+    # Alphabetized to more easily lookup particular preferences
+    preference :address_requires_state, :boolean, default: true # should state/state_name be required
+    preference :address_requires_phone, :boolean, default: true # Determines whether we require phone in address
+    preference :admin_interface_logo, :string, default: 'admin/logo.png'
+    preference :admin_path, :string, default: '/admin'
+    preference :admin_products_per_page, :integer, default: Kaminari.config.default_per_page
+    preference :admin_orders_per_page, :integer, default: Kaminari.config.default_per_page
+    preference :admin_properties_per_page, :integer, default: Kaminari.config.default_per_page
+    preference :admin_promotions_per_page, :integer, default: Kaminari.config.default_per_page
+    preference :admin_customer_returns_per_page, :integer, default: Kaminari.config.default_per_page
+    preference :admin_users_per_page, :integer, default: Kaminari.config.default_per_page
+    preference :admin_show_version, :boolean, default: true
+    preference :allow_checkout_on_gateway_error, :boolean, default: false
+    preference :allow_guest_checkout, :boolean, default: true
+    preference :alternative_shipping_phone, :boolean, default: false # Request extra phone for ship addr
+    preference :always_include_confirm_step, :boolean, default: false # Ensures confirmation step is always in checkout_progress bar, but does not force a confirm step if your payment methods do not support it.
+    preference :always_put_site_name_in_title, :boolean, default: true
+    preference :title_site_name_separator, :string, default: '-' # When always_put_site_name_in_title is true, insert a separator character before the site name in the title
+    preference :auto_capture, :boolean, default: false # automatically capture the credit card (as opposed to just authorize and capture later)
+    preference :auto_capture_on_dispatch, :boolean, default: false # Captures payment for each shipment in Shipment#after_ship callback, and makes Shipment.ready when payment authorized.
+    preference :binary_inventory_cache, :boolean, default: false # only invalidate product cache when a stock item changes whether it is in_stock
+    preference :checkout_zone, :string, default: nil # replace with the name of a zone if you would like to limit the countries
+    preference :company, :boolean, default: false # Request company field for billing and shipping addr
+    preference :currency, :string, default: 'USD'
+    preference :default_country_id, :integer
+    preference :disable_sku_validation, :boolean, default: false # when turned off disables the built-in SKU uniqueness validation
+    preference :expedited_exchanges, :boolean, default: false # NOTE this requires payment profiles to be supported on your gateway of choice as well as a delayed job handler to be configured with activejob. kicks off an exchange shipment upon return authorization save. charge customer if they do not return items within timely manner.
+    preference :expedited_exchanges_days_window, :integer, default: 14 # the amount of days the customer has to return their item after the expedited exchange is shipped in order to avoid being charged
+    preference :layout, :string, default: 'harpiya/layouts/harpiya_application'
+    preference :logo, :string, default: 'logo/harpiya_50.png'
+    preference :mailer_logo, :string, default: 'logo/harpiya_50.png'
+    preference :max_level_in_taxons_menu, :integer, default: 1 # maximum nesting level in taxons menu
+    preference :products_per_page, :integer, default: 12
+    preference :require_master_price, :boolean, default: true
+    preference :restock_inventory, :boolean, default: true # Determines if a return item is restocked automatically once it has been received
+    preference :return_eligibility_number_of_days, :integer, default: 365
+    preference :send_core_emails, :boolean, default: true # Default mail headers settings
+    preference :shipping_instructions, :boolean, default: false # Request instructions/info for shipping
+    preference :show_only_complete_orders_by_default, :boolean, default: true
+    preference :show_variant_full_price, :boolean, default: false # Displays variant full price or difference with product price. Default false to be compatible with older behavior
+    preference :show_products_without_price, :boolean, default: false
+    preference :show_raw_product_description, :boolean, default: false
+    preference :tax_using_ship_address, :boolean, default: true
+    preference :track_inventory_levels, :boolean, default: true # Determines whether to track on_hand values for variants / products.
+
+    # Store credits configurations
+    preference :non_expiring_credit_types, :array, default: []
+    preference :credit_to_new_allocation, :boolean, default: false
+
+    # Multi store configurations
+    preference :show_store_selector, :boolean, default: false
+
+    # searcher_class allows harpiya extension writers to provide their own Search class
+    def searcher_class
+      @searcher_class ||= Harpiya::Core::Search::Base
+    end
+
+    # Sets the path used for products and taxons.
+    preference :storefront_products_path, :string, default: 'products'
+    preference :storefront_taxons_path, :string, default: 't'
+
+    attr_writer :searcher_class
+  end
+end

data/app/models/harpiya/app_dependencies.rb

@@ -0,0 +1,87 @@
+module Harpiya
+  class AppDependencies
+    include Harpiya::DependenciesHelper
+
+    INJECTION_POINTS = [
+      :ability_class,
+      :cart_create_service, :cart_add_item_service, :cart_remove_item_service,
+      :cart_remove_line_item_service, :cart_set_item_quantity_service, :cart_recalculate_service,
+      :cart_update_service, :checkout_next_service, :checkout_advance_service, :checkout_update_service,
+      :checkout_complete_service, :checkout_add_store_credit_service,
+      :checkout_remove_store_credit_service, :checkout_get_shipping_rates_service,
+      :coupon_handler, :menu_finder, :country_finder, :current_order_finder, :credit_card_finder,
+      :completed_order_finder, :order_sorter, :cart_compare_line_items_service, :collection_paginator, :products_sorter,
+      :products_finder, :taxon_finder, :line_item_by_variant_finder, :cart_estimate_shipping_rates_service,
+      :account_create_address_service, :account_update_address_service, :account_create_service, :account_update_service,
+      :address_finder, :collection_sorter, :error_handler
+    ].freeze
+
+    attr_accessor *INJECTION_POINTS
+
+    def initialize
+      set_default_ability
+      set_default_services
+      set_default_finders
+    end
+
+    private
+
+    def set_default_ability
+      @ability_class = 'Harpiya::Ability'
+    end
+
+    def set_default_services
+      # cart
+      @cart_compare_line_items_service = 'Harpiya::CompareLineItems'
+      @cart_create_service = 'Harpiya::Cart::Create'
+      @cart_add_item_service = 'Harpiya::Cart::AddItem'
+      @cart_update_service = 'Harpiya::Cart::Update'
+      @cart_recalculate_service = 'Harpiya::Cart::Recalculate'
+      @cart_remove_item_service = 'Harpiya::Cart::RemoveItem'
+      @cart_remove_line_item_service = 'Harpiya::Cart::RemoveLineItem'
+      @cart_set_item_quantity_service = 'Harpiya::Cart::SetQuantity'
+      @cart_estimate_shipping_rates_service = 'Harpiya::Cart::EstimateShippingRates'
+
+      # checkout
+      @checkout_next_service = 'Harpiya::Checkout::Next'
+      @checkout_advance_service = 'Harpiya::Checkout::Advance'
+      @checkout_update_service = 'Harpiya::Checkout::Update'
+      @checkout_complete_service = 'Harpiya::Checkout::Complete'
+      @checkout_add_store_credit_service = 'Harpiya::Checkout::AddStoreCredit'
+      @checkout_remove_store_credit_service = 'Harpiya::Checkout::RemoveStoreCredit'
+      @checkout_get_shipping_rates_service = 'Harpiya::Checkout::GetShippingRates'
+
+      # sorter
+      @collection_sorter = 'Harpiya::BaseSorter'
+      @order_sorter = 'Harpiya::BaseSorter'
+      @products_sorter = 'Harpiya::Products::Sort'
+
+      # paginator
+      @collection_paginator = 'Harpiya::Shared::Paginate'
+
+      # coupons
+      # TODO: we should split this service into 2 seperate - Add and Remove
+      @coupon_handler = 'Harpiya::PromotionHandler::Coupon'
+
+      # account
+      @account_create_service = 'Harpiya::Account::Create'
+      @account_update_service = 'Harpiya::Account::Update'
+      @account_create_address_service = 'Harpiya::Account::Addresses::Create'
+      @account_update_address_service = 'Harpiya::Account::Addresses::Update'
+
+      @error_handler = 'Harpiya::ErrorReporter'
+    end
+
+    def set_default_finders
+      @address_finder = 'Harpiya::Addresses::Find'
+      @country_finder = 'Harpiya::Countries::Find'
+      @menu_finder = 'Harpiya::Menus::Find'
+      @current_order_finder = 'Harpiya::Orders::FindCurrent'
+      @completed_order_finder = 'Harpiya::Orders::FindComplete'
+      @credit_card_finder = 'Harpiya::CreditCards::Find'
+      @products_finder = 'Harpiya::Products::Find'
+      @taxon_finder = 'Harpiya::Taxons::Find'
+      @line_item_by_variant_finder = 'Harpiya::LineItems::FindByVariant'
+    end
+  end
+end