solidus_legacy_promotions 4.4.0

data/app/models/spree/promotion_handler/coupon.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+module Spree
+  module PromotionHandler
+    class Coupon
+      attr_reader :order, :coupon_code
+      attr_accessor :error, :success, :status_code
+
+      def initialize(order)
+        @order = order
+        @coupon_code = order.coupon_code && order.coupon_code.downcase
+      end
+
+      def can_apply?
+        Spree::Promotion.order_activatable?(order)
+      end
+
+      def apply
+        if coupon_code.present?
+          if promotion.present? && promotion.active? && promotion.actions.exists?
+            handle_present_promotion(promotion)
+          elsif promotion_code&.promotion&.expired?
+            set_error_code :coupon_code_expired
+          else
+            set_error_code :coupon_code_not_found
+          end
+        end
+
+        self
+      end
+
+      def remove
+        if promotion.blank?
+          set_error_code :coupon_code_not_found
+        elsif !promotion_exists_on_order?(order, promotion)
+          set_error_code :coupon_code_not_present
+        else
+          promotion.remove_from(order)
+          order.recalculate
+          set_success_code :coupon_code_removed
+        end
+
+        self
+      end
+
+      def set_success_code(status_code)
+        @status_code = status_code
+        @success = I18n.t(status_code, scope: 'spree')
+      end
+
+      def set_error_code(status_code, options = {})
+        @status_code = status_code
+        @error = options[:error] || I18n.t(status_code, scope: 'spree')
+      end
+
+      def promotion
+        @promotion ||= if promotion_code && promotion_code.promotion.active?
+          promotion_code.promotion
+        end
+      end
+
+      def successful?
+        success.present? && error.blank?
+      end
+
+      private
+
+      def promotion_code
+        @promotion_code ||= Spree::PromotionCode.where(value: coupon_code).first
+      end
+
+      def handle_present_promotion(promotion)
+        return promotion_usage_limit_exceeded if promotion.usage_limit_exceeded? || promotion_code.usage_limit_exceeded?
+        return promotion_applied if promotion_exists_on_order?(order, promotion)
+
+        unless promotion.eligible?(order, promotion_code:)
+          set_promotion_eligibility_error_code(promotion)
+          return error || ineligible_for_this_order
+        end
+
+        # If any of the actions for the promotion return `true`,
+        # then result here will also be `true`.
+        result = promotion.activate(order:, promotion_code:)
+        if result
+          order.recalculate
+          set_success_code :coupon_code_applied
+        else
+          set_error_code :coupon_code_unknown_error
+        end
+      end
+
+      def set_promotion_eligibility_error_code(promotion)
+        return unless eligibility_error_code_present?(promotion)
+
+        eligibility_error = promotion.eligibility_errors.details[:base].first
+
+        @status_code = eligibility_error[:error_code]
+        @error = eligibility_error[:error]
+      end
+
+      def promotion_usage_limit_exceeded
+        set_error_code :coupon_code_max_usage
+      end
+
+      def ineligible_for_this_order
+        set_error_code :coupon_code_not_eligible
+      end
+
+      def promotion_applied
+        set_error_code :coupon_code_already_applied
+      end
+
+      def promotion_exists_on_order?(order, promotion)
+        order.promotions.include? promotion
+      end
+
+      def eligibility_error_code_present?(promotion)
+        promotion.eligibility_errors.present? &&
+          promotion.eligibility_errors.details.present? &&
+          promotion.eligibility_errors.details.key?(:base) &&
+          promotion.eligibility_errors.details[:base].first[:error_code].present?
+      end
+    end
+  end
+end

data/app/models/spree/promotion_handler/page.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Spree
+  module PromotionHandler
+    class Page
+      attr_reader :order, :path
+
+      def initialize(order, path)
+        @order = order
+        @path = path.delete_prefix('/')
+      end
+
+      def activate
+        if promotion && promotion.eligible?(order)
+          promotion.activate(order:)
+        end
+      end
+
+      private
+
+      def promotion
+        @promotion ||= Spree::Promotion.active.find_by(path:)
+      end
+    end
+  end
+end

data/app/models/spree/promotion_handler/shipping.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Spree
+  module PromotionHandler
+    # Used for activating promotions with shipping rules
+    class Shipping
+      attr_reader :order
+      attr_accessor :error, :success
+
+      def initialize(order)
+        @order = order
+      end
+
+      def activate
+        connected_promotions.each do |order_promotion|
+          if order_promotion.promotion.eligible?(order)
+            order_promotion.promotion.activate(
+              order:,
+              promotion_code: order_promotion.promotion_code,
+            )
+          end
+        end
+
+        not_connected_automatic_promotions.each do |promotion|
+          if promotion.eligible?(order)
+            promotion.activate(order:)
+          end
+        end
+      end
+
+      private
+
+      def not_connected_automatic_promotions
+        automatic_promotions - connected_promotions.map(&:promotion)
+      end
+
+      def automatic_promotions
+        @automatic_promotions ||= active_shipping_promotions.
+          where(apply_automatically: true).
+          to_a.
+          uniq
+      end
+
+      def connected_promotions
+        @connected_promotions ||= order.order_promotions.
+          joins(:promotion).
+          includes(:promotion).
+          merge(active_shipping_promotions).
+          to_a.
+          uniq
+      end
+
+      def active_shipping_promotions
+        Spree::Promotion.all.
+          active.
+          joins(:promotion_actions).
+          merge(Spree::PromotionAction.shipping)
+      end
+    end
+  end
+end

data/app/models/spree/promotion_rule.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require 'spree/preferences/persistable'
+
+module Spree
+  # Base class for all promotion rules
+  class PromotionRule < Spree::Base
+    include Spree::Preferences::Persistable
+
+    belongs_to :promotion, class_name: 'Spree::Promotion', inverse_of: :promotion_rules, optional: true
+
+    scope :of_type, ->(type) { where(type:) }
+
+    validates :promotion, presence: true
+    validate :unique_per_promotion, on: :create
+
+    def preload_relations
+      []
+    end
+
+    def applicable?(_promotable)
+      raise NotImplementedError, "applicable? should be implemented in a sub-class of Spree::PromotionRule"
+    end
+
+    def eligible?(_promotable, _options = {})
+      raise NotImplementedError, "eligible? should be implemented in a sub-class of Spree::PromotionRule"
+    end
+
+    # This states if a promotion can be applied to the specified line item
+    # It is true by default, but can be overridden by promotion rules to provide conditions
+    def actionable?(_line_item)
+      true
+    end
+
+    def eligibility_errors
+      @eligibility_errors ||= ActiveModel::Errors.new(self)
+    end
+
+    def to_partial_path
+      "spree/admin/promotions/rules/#{model_name.element}"
+    end
+
+    private
+
+    def unique_per_promotion
+      if Spree::PromotionRule.exists?(promotion_id:, type: self.class.name)
+        errors[:base] << "Promotion already contains this rule type"
+      end
+    end
+
+    def eligibility_error_message(key, options = {})
+      I18n.t(key, **{ scope: [:spree, :eligibility_errors, :messages] }.merge(options))
+    end
+  end
+end

data/app/models/spree/promotion_rule_store.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Spree
+  class PromotionRuleStore < Spree::Base
+    self.table_name = "spree_promotion_rules_stores"
+
+    belongs_to :promotion_rule, class_name: "Spree::PromotionRule", optional: true
+    belongs_to :store, class_name: "Spree::Store", optional: true
+  end
+end

data/app/models/spree/promotion_rule_taxon.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Spree
+  class PromotionRuleTaxon < Spree::Base
+    belongs_to :promotion_rule, optional: true
+    belongs_to :taxon, optional: true
+  end
+end

data/app/models/spree/promotion_rule_user.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Spree
+  class PromotionRuleUser < Spree::Base
+    self.table_name = 'spree_promotion_rules_users'
+
+    belongs_to :promotion_rule, class_name: 'Spree::PromotionRule', optional: true
+    belongs_to :user, class_name: Spree::UserClassHandle.new, optional: true
+  end
+end

data/app/subscribers/spree/order_promotion_subscriber.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Spree
+  # Clears promotions from an emptied order
+  class OrderPromotionSubscriber
+    include Omnes::Subscriber
+
+    handle :order_emptied,
+           with: :clear_order_promotions,
+           id: :spree_order_promotion_clear_order_promotions
+
+    # Clears all promotions from the order
+    #
+    # @param event [Omnes::UnstructuredEvent]
+    def clear_order_promotions(event)
+      order = event[:order]
+      order.order_promotions.destroy_all
+    end
+  end
+end

data/app/views/spree/order_mailer/cancel_email.html.erb

@@ -0,0 +1,45 @@
+<table>
+  <tr>
+    <td>
+      <p class="lede">
+        <%= t('.dear_customer') %>
+      </p>
+      <p>
+        <%= t('.instructions') %>
+      </p>
+      <p>
+        <%= t('.order_summary_canceled') %>
+      </p>
+      <table>
+        <% @order.line_items.each do |item| %>
+          <tr>
+            <td><%= item.variant.sku %></td>
+            <td>
+              <%= item.variant.product.name %>
+              <%= item.variant.options_text -%>
+            </td>
+            <td>(<%=item.quantity%>) @ <%= item.single_money %> = <%= item.display_amount %></td>
+          </tr>
+        <% end %>
+        <tr>
+          <td></td>
+          <td><%= t('.subtotal') %></td>
+          <td><%= @order.display_item_total %></td>
+        </tr>
+        <% @order.adjustments.eligible.each do |adjustment| %>
+          <tr>
+            <td></td>
+            <td><%= sanitize(adjustment.label) %></td>
+            <td><%= adjustment.display_amount %></td>
+          </tr>
+        <% end %>
+        <tr>
+          <td></td>
+          <td><%= t('.total') %></td>
+          <td><%= @order.display_total %></td>
+        </tr>
+      </table>
+    </td>
+    <td class="expander"></td>
+  </tr>
+</table>

data/app/views/spree/order_mailer/cancel_email.text.erb

@@ -0,0 +1,16 @@
+<%= t('.dear_customer') %>
+
+<%= t('.instructions') %>
+
+============================================================
+<%= t('.order_summary_canceled') %>
+============================================================
+<% @order.line_items.each do |item| %>
+  <%= item.variant.sku %> <%= raw(item.variant.product.name) %> <%= raw(item.variant.options_text) -%> (<%=item.quantity%>) @ <%= item.single_money %> = <%= item.display_amount %>
+<% end %>
+============================================================
+<%= t('.subtotal') %> <%= @order.display_item_total %>
+<% @order.adjustments.eligible.each do |adjustment| %>
+  <%= raw(adjustment.label) %> <%= adjustment.display_amount %>
+<% end %>
+<%= t('.total') %> <%= @order.display_total %>

data/app/views/spree/order_mailer/confirm_email.html.erb

@@ -0,0 +1,84 @@
+<table>
+  <tr>
+    <td>
+      <p class="lede">
+        <%= t('.dear_customer') %>
+      </p>
+      <p>
+        <%= t('.instructions') %>
+      </p>
+      <p>
+        <%= t('.order_summary') %>
+      </p>
+      <table>
+        <% @order.line_items.each do |item| %>
+          <tr>
+            <td><%= item.variant.sku %></td>
+            <td>
+              <%= item.variant.product.name %>
+              <%= item.variant.options_text -%>
+            </td>
+            <td>(<%=item.quantity%>) @ <%= item.single_money %> = <%= item.display_amount %></td>
+          </tr>
+        <% end %>
+        <tr>
+          <td></td>
+          <td>
+            <%= t('.subtotal') %>
+          </td>
+          <td>
+            <%= @order.display_item_total %>
+          </td>
+        </tr>
+        <% if @order.line_item_adjustments.exists? %>
+          <% if @order.all_adjustments.promotion.eligible.exists? %>
+            <% @order.all_adjustments.promotion.eligible.group_by(&:label).each do |label, adjustments| %>
+              <tr>
+                <td></td>
+                <td><%= t('spree.promotion') %> <%= label %>:</td>
+                <td><%= Spree::Money.new(adjustments.sum(&:amount), currency: @order.currency) %></td>
+              </tr>
+            <% end %>
+          <% end %>
+        <% end %>
+        <% @order.shipments.group_by { |s| s.selected_shipping_rate.try(:name) }.each do |name, shipments| %>
+          <tr>
+            <td></td>
+            <td><%= t('spree.shipping') %> <%= name %>:</td>
+            <td><%= Spree::Money.new(shipments.sum(&:total_before_tax), currency: @order.currency) %></td>
+          </tr>
+        <% end %>
+        <% if @order.all_adjustments.eligible.tax.exists? %>
+          <% @order.all_adjustments.eligible.tax.group_by(&:label).each do |label, adjustments| %>
+            <tr>
+              <td></td>
+              <td><%= t('spree.tax') %> <%= label %>:</td>
+              <td><%= Spree::Money.new(adjustments.sum(&:amount), currency: @order.currency) %></td>
+            </tr>
+          <% end %>
+        <% end %>
+        <% @order.adjustments.eligible.each do |adjustment| %>
+          <% next if (adjustment.source_type == 'Spree::TaxRate') and (adjustment.amount == 0) %>
+          <tr>
+            <td></td>
+            <td><%= adjustment.label %>:</td>
+            <td><%= adjustment.display_amount %></td>
+          </tr>
+        <% end %>
+        <tr>
+          <td></td>
+          <td>
+            <%= t('.total') %>
+          </td>
+          <td>
+            <%= @order.display_total %>
+          </td>
+        </tr>
+      </table>
+      <p>
+        <%= t('.thanks') %>
+      </p>
+    </td>
+    <td class="expander"></td>
+  </tr>
+</table>

data/app/views/spree/order_mailer/confirm_email.text.erb

@@ -0,0 +1,38 @@
+<%= t('.dear_customer') %>
+
+<%= t('.instructions') %>
+
+============================================================
+<%= t('.order_summary') %>
+============================================================
+<% @order.line_items.each do |item| %>
+  <%= item.variant.sku %> <%= raw(item.variant.product.name) %> <%= raw(item.variant.options_text) -%> (<%=item.quantity%>) @ <%= item.single_money %> = <%= item.display_amount %>
+<% end %>
+============================================================
+<%= t('.subtotal') %> <%= @order.display_item_total %>
+<% if @order.line_item_adjustments.exists? %>
+  <% if @order.all_adjustments.promotion.eligible.exists? %>
+    <% @order.all_adjustments.promotion.eligible.group_by(&:label).each do |label, adjustments| %>
+<%= t('spree.promotion') %>: <%= label %> <%= Spree::Money.new(adjustments.sum(&:amount), currency: @order.currency) %>
+    <% end %>
+  <% end %>
+<% end %>
+
+<% @order.shipments.group_by { |s| s.selected_shipping_rate.try(:name) }.each do |name, shipments| %>
+<%= t('spree.shipping') %>: <%= name %> <%= Spree::Money.new(shipments.sum(&:total_before_tax), currency: @order.currency) %>
+<% end %>
+
+<% if @order.all_adjustments.eligible.tax.exists? %>
+  <% @order.all_adjustments.eligible.tax.group_by(&:label).each do |label, adjustments| %>
+<%= t('spree.tax') %>: <%= label %> <%= Spree::Money.new(adjustments.sum(&:amount), currency: @order.currency) %>
+  <% end %>
+<% end %>
+
+<% @order.adjustments.eligible.each do |adjustment| %>
+  <% next if (adjustment.source_type == 'Spree::TaxRate') and (adjustment.amount == 0) %>
+<%= adjustment.label %> <%= adjustment.display_amount %>
+<% end %>
+============================================================
+<%= t('.total') %> <%= @order.display_total %>
+
+<%= t('.thanks') %>

data/app/views/spree/promotion_code_batch_mailer/promotion_code_batch_errored.text.erb

@@ -0,0 +1,2 @@
+<%= t(".message", error: @promotion_code_batch.error) %>
+<%= @promotion_code_batch.promotion.name %>

data/app/views/spree/promotion_code_batch_mailer/promotion_code_batch_finished.text.erb

@@ -0,0 +1,2 @@
+<%= t(".message", number_of_codes: 10) %>
+<%= @promotion_code_batch.promotion.name %>

data/bin/rails

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails gems
+# installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('..', __dir__)
+ENGINE_PATH = File.expand_path('../lib/solidus_legacy_promotions/engine', __dir__)
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __dir__)
+require "bundler/setup" if File.exist?(ENV["BUNDLE_GEMFILE"])
+
+require "rails/all"
+require "rails/engine/commands"

data/config/locales/en.yml

@@ -0,0 +1,101 @@
+en:
+  spree:
+    admin:
+      promotion_status:
+        active: Active
+        expired: Expired
+        inactive: Inactive
+        not_started: Not started
+      promotions:
+        actions:
+          calculator_label: Calculated by
+        activations_edit:
+          auto: All orders will attempt to use this promotion
+          multiple_codes_html: This promotion uses %{count} promotion codes
+          single_code_html: 'This promotion uses the promotion code: <code>%{code}</code>'
+        activations_new:
+          auto: Apply to all orders
+          multiple_codes: Multiple promotion codes
+          single_code: Single promotion code
+        form:
+          activation: Activation
+          expires_at_placeholder: Never
+          general: General
+          starts_at_placeholder: Immediately
+      tab:
+        promotion_categories: Promotion Categories
+        promotions: Promotions
+    back_to_promotion_categories_list: Back To Promotions Categories List
+    back_to_promotions_list: Back To Promotions List
+    base_amount: Base Amount
+    choose_promotion_action: Choose Action
+    choose_promotion_rule: Choose Rule
+    create_promotion_code: Create promotion code
+    current_promotion_usage: 'Current Usage: %{count}'
+    discount_rules: Discount Rules
+    download_promotion_codes_list: Download codes list
+    editing_promotion: Editing Promotion
+    editing_promotion_category: Editing Promotion Category
+    group_size: Group size
+    hints:
+      spree/calculator:
+        promotions: This is used to determine the promotional discount to be applied to an order, an item, or shipping charges.
+      spree/promotion:
+        expires_at: This determines when the promotion expires. <br> If no value is specified, the promotion will never expire.
+        promo_code_will_be_disabled: Selecting this option, promo codes will be disabled for this promotion because all its rules / actions will be applied automatically to all orders.
+        starts_at: This determines when the promotion can be applied to orders. <br> If no value is specified, the promotion will be immediately available.
+    invalid_promotion_action: Invalid promotion action.
+    invalid_promotion_rule: Invalid promotion rule.
+    manage_promotion_categories: Manage Promotion Categories
+    match_choices:
+      all: All
+      none: None
+    new_promotion: New Promotion
+    new_promotion_category: New Promotion Category
+    new_promotion_code_batch: New Promotion Code Batch
+    no_actions_added: No actions added
+    no_rules_added: No rules added
+    no_promotions_found: No promotions found
+    product_rule:
+      choose_products: Choose products
+      label: Order must contain %{select} of these products
+      match_all: all
+      match_any: at least one
+      match_none: none
+      product_source:
+        group: From product group
+        manual: Manually choose
+    promotion: Promotion
+    promotion_action: Promotion Action
+    promotion_actions: Actions
+    promotion_form:
+      match_policies:
+        all: Match all of these rules
+        any: Match any of these rules
+    promotion_rule: Promotion Rule
+    promotion_successfully_created: Promotion has been successfully created!
+    promotion_uses: Promotion uses
+    promotionable: Promotable
+    promotions: Promotions
+    rules: Rules
+    store_rule:
+      choose_stores: Choose Stores
+    taxon_rule:
+      choose_taxons: Choose taxons
+      label: Order must contain %{select} of these taxons
+      match_all: all
+      match_any: at least one
+      match_none: none
+    tiers: Tiers
+    promotion_code_batches:
+      errored: 'Errored: %{error}'
+      finished: All %{number_of_codes} codes have been created.
+      processing: 'Processing: %{number_of_codes_processed} / %{number_of_codes}'
+    user_role_rule:
+      choose_roles: Choose Roles
+      label: User must contain %{select} of these roles
+      match_all: all
+      match_any: at least one
+    user_rule:
+      choose_users: Choose Users
+    view_promotion_codes_list: View codes list

data/config/locales/promotion_categories.en.yml

@@ -0,0 +1,6 @@
+en:
+  solidus_admin:
+    promotion_categories:
+      title: "Promotion Categories"
+      destroy:
+        success: "Promotion Categories were successfully removed."

data/config/locales/promotions.en.yml

@@ -0,0 +1,6 @@
+en:
+  solidus_admin:
+    promotions:
+      title: "Promotions"
+      destroy:
+        success: "Promotions were successfully removed."

data/config/routes.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+if SolidusSupport.backend_available?
+  Spree::Core::Engine.routes.draw do
+    namespace :admin do
+      resources :promotions do
+        resources :promotion_rules
+        resources :promotion_actions
+        resources :promotion_codes, only: [:index, :new, :create]
+        resources :promotion_code_batches, only: [:index, :new, :create] do
+          get '/download', to: "promotion_code_batches#download", defaults: { format: "csv" }
+        end
+      end
+
+      resources :promotion_categories, except: [:show]
+    end
+  end
+end
+
+if SolidusSupport.admin_available?
+  SolidusAdmin::Engine.routes.draw do
+    require "solidus_admin/admin_resources"
+    extend SolidusAdmin::AdminResources
+
+    admin_resources :promotions, only: [:index, :destroy]
+    admin_resources :promotion_categories, only: [:index, :destroy]
+  end
+end