solidus_legacy_promotions 4.4.0

data/lib/controllers/backend/spree/admin/promotion_actions_controller.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+class Spree::Admin::PromotionActionsController < Spree::Admin::BaseController
+  before_action :load_promotion, only: [:create, :destroy]
+  before_action :validate_promotion_action_type, only: :create
+
+  def create
+    @promotion_action = @promotion_action_type.new(params[:promotion_action])
+    @calculators = @promotion_action.available_calculators
+    @promotion_action.promotion = @promotion
+    if @promotion_action.save
+      flash[:success] = t('spree.successfully_created', resource: t('spree.promotion_action'))
+    end
+    respond_to do |format|
+      format.html { redirect_to spree.edit_admin_promotion_path(@promotion) }
+      format.js   { render layout: false }
+    end
+  end
+
+  def destroy
+    @promotion_action = @promotion.promotion_actions.find(params[:id])
+    if @promotion_action.discard
+      flash[:success] = t('spree.successfully_removed', resource: t('spree.promotion_action'))
+    end
+    respond_to do |format|
+      format.html { redirect_to spree.edit_admin_promotion_path(@promotion) }
+      format.js   { render layout: false }
+    end
+  end
+
+  private
+
+  def load_promotion
+    @promotion = Spree::Promotion.find(params[:promotion_id])
+  end
+
+  def validate_promotion_action_type
+    requested_type = params[:action_type]
+    promotion_action_types = Spree::Config.promotions.actions
+    @promotion_action_type = promotion_action_types.detect do |klass|
+      klass.name == requested_type
+    end
+    if !@promotion_action_type
+      flash[:error] = t('spree.invalid_promotion_action')
+      respond_to do |format|
+        format.html { redirect_to spree.edit_admin_promotion_path(@promotion) }
+        format.js   { render layout: false }
+      end
+    end
+  end
+end

data/lib/controllers/backend/spree/admin/promotion_categories_controller.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Spree
+  module Admin
+    class PromotionCategoriesController < ResourceController
+    end
+  end
+end

data/lib/controllers/backend/spree/admin/promotion_code_batches_controller.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Spree
+  module Admin
+    class PromotionCodeBatchesController < ResourceController
+      belongs_to 'spree/promotion'
+
+      create.after :build_promotion_code_batch
+
+      def download
+        require "csv"
+
+        @promotion_code_batch = Spree::PromotionCodeBatch.find(
+          params[:promotion_code_batch_id]
+        )
+
+        send_data(
+          render_to_string,
+          filename: "promotion-code-batch-list-#{@promotion_code_batch.id}.csv"
+        )
+      end
+
+      private
+
+      def build_promotion_code_batch
+        @promotion_code_batch.process
+      end
+    end
+  end
+end

data/lib/controllers/backend/spree/admin/promotion_codes_controller.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'csv'
+
+module Spree
+  module Admin
+    class PromotionCodesController < Spree::Admin::ResourceController
+      def index
+        @promotion = Spree::Promotion.accessible_by(current_ability, :show).find(params[:promotion_id])
+        @promotion_codes = @promotion.promotion_codes.order(:value)
+
+        respond_to do |format|
+          format.html do
+            @promotion_codes = @promotion_codes.page(params[:page]).per(50)
+          end
+          format.csv do
+            filename = "promotion-code-list-#{@promotion.id}.csv"
+            headers["Content-Type"] = "text/csv"
+            headers["Content-disposition"] = "attachment; filename=\"#{filename}\""
+          end
+        end
+      end
+
+      def new
+        @promotion = Spree::Promotion.accessible_by(current_ability, :show).find(params[:promotion_id])
+        if @promotion.apply_automatically
+          flash[:error] = t('activerecord.errors.models.spree/promotion_code.attributes.base.disallowed_with_apply_automatically')
+          redirect_to admin_promotion_promotion_codes_url(@promotion)
+        else
+          @promotion_code = @promotion.promotion_codes.build
+        end
+      end
+
+      def create
+        @promotion = Spree::Promotion.accessible_by(current_ability, :show).find(params[:promotion_id])
+        @promotion_code = @promotion.promotion_codes.build(value: params[:promotion_code][:value])
+
+        if @promotion_code.save
+          flash[:success] = flash_message_for(@promotion_code, :successfully_created)
+          redirect_to admin_promotion_promotion_codes_url(@promotion)
+        else
+          flash.now[:error] = @promotion_code.errors.full_messages.to_sentence
+          render_after_create_error
+        end
+      end
+    end
+  end
+end

data/lib/controllers/backend/spree/admin/promotion_rules_controller.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+class Spree::Admin::PromotionRulesController < Spree::Admin::BaseController
+  helper 'spree/promotion_rules'
+
+  before_action :load_promotion, only: [:create, :destroy]
+  before_action :validate_promotion_rule_type, only: :create
+
+  def create
+    @promotion_rule = @promotion_rule_type.new(promotion_rule_params)
+    @promotion_rule.promotion = @promotion
+    if @promotion_rule.save
+      flash[:success] = t('spree.successfully_created', resource: t('spree.promotion_rule'))
+    end
+    respond_to do |format|
+      format.html { redirect_to spree.edit_admin_promotion_path(@promotion) }
+      format.js   { render layout: false }
+    end
+  end
+
+  def destroy
+    @promotion_rule = @promotion.promotion_rules.find(params[:id])
+    if @promotion_rule.destroy
+      flash[:success] = t('spree.successfully_removed', resource: t('spree.promotion_rule'))
+    end
+    respond_to do |format|
+      format.html { redirect_to spree.edit_admin_promotion_path(@promotion) }
+      format.js   { render layout: false }
+    end
+  end
+
+  private
+
+  def load_promotion
+    @promotion = Spree::Promotion.find(params[:promotion_id])
+  end
+
+  def model_class
+    Spree::PromotionRule
+  end
+
+  def validate_promotion_rule_type
+    requested_type = params[:promotion_rule].delete(:type)
+    promotion_rule_types = Spree::Config.promotions.rules
+    @promotion_rule_type = promotion_rule_types.detect do |klass|
+      klass.name == requested_type
+    end
+    if !@promotion_rule_type
+      flash[:error] = t('spree.invalid_promotion_rule')
+      respond_to do |format|
+        format.html { redirect_to spree.edit_admin_promotion_path(@promotion) }
+        format.js   { render layout: false }
+      end
+    end
+  end
+
+  def promotion_rule_params
+    params[:promotion_rule].permit!
+  end
+end

data/lib/controllers/backend/spree/admin/promotions_controller.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module Spree
+  module Admin
+    class PromotionsController < ResourceController
+      before_action :load_data
+
+      helper 'spree/promotion_rules'
+
+      def show
+        redirect_to action: :edit
+      end
+
+      def create
+        @promotion = Spree::Promotion.new(permitted_resource_params)
+        @promotion.codes.new(value: params[:single_code]) if params[:single_code].present?
+
+        if params[:promotion_code_batch]
+          @promotion_code_batch = @promotion.promotion_code_batches.new(promotion_code_batch_params)
+        end
+
+        if @promotion.save
+          @promotion_code_batch.process if @promotion_code_batch
+          flash[:success] = t('spree.promotion_successfully_created')
+          redirect_to location_after_save
+        else
+          flash[:error] = @promotion.errors.full_messages.to_sentence
+          render action: 'new'
+        end
+      end
+
+      private
+
+      def location_after_save
+        spree.edit_admin_promotion_url(@promotion)
+      end
+
+      def load_data
+        @promotion_categories = Spree::PromotionCategory.order(:name)
+      end
+
+      def collection
+        return @collection if @collection
+        params[:q] ||= HashWithIndifferentAccess.new
+        params[:q][:s] ||= 'id desc'
+
+        @collection = super
+        @search = @collection.ransack(params[:q])
+        @collection = @search.result(distinct: true).
+          includes(promotion_includes).
+          page(params[:page]).
+          per(params[:per_page] || Spree::Config.promotions.promotions_per_page)
+
+        @collection
+      end
+
+      def promotion_code_batch_params
+        params.require(:promotion_code_batch).permit!
+      end
+
+      def promotion_includes
+        [:promotion_actions]
+      end
+    end
+  end
+end

data/lib/solidus_legacy_promotions/configuration.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+module SolidusLegacyPromotions
+  class Configuration < Spree::Preferences::Configuration
+    include Spree::Core::EnvironmentExtension
+
+    # @!attribute [rw] promotions_per_page
+    #   @return [Integer] Promotions to show per-page in the admin (default: +15+)
+    preference :promotions_per_page, :integer, default: 15
+
+    # @!attribute [rw] promotion_attributes
+    #   @return [Array<Symbol>] Attributes to be returned by the API for a promotion
+    preference :promotion_api_attributes, :array, default: [
+      :id,
+      :name,
+      :description,
+      :expires_at,
+      :starts_at,
+      :type,
+      :usage_limit,
+      :advertise,
+      :path
+    ]
+
+    # promotion_chooser_class allows extensions to provide their own PromotionChooser
+    class_name_attribute :promotion_chooser_class, default: 'Spree::PromotionChooser'
+
+    # order_adjuster_class allows extensions to provide their own Order Adjuster
+    class_name_attribute :order_adjuster_class, default: 'Spree::Promotion::OrderAdjustmentsRecalculator'
+
+    # promotion_finder_class allows extensions to provide their own Promotion Finder
+    class_name_attribute :promotion_finder_class, default: 'Spree::PromotionFinder'
+
+    # Allows providing a different shipping promotion handler.
+    # @!attribute [rw] shipping_promotion_handler_class
+    # @see Spree::PromotionHandler::Shipping
+    # @return [Class] an object that conforms to the API of
+    #   the standard shipping promotion handler class
+    #   Spree::PromotionHandler::Coupon.
+    class_name_attribute :shipping_promotion_handler_class, default: 'Spree::PromotionHandler::Shipping'
+
+    # Allows providing your own Mailer for promotion code batch mailer.
+    #
+    # @!attribute [rw] promotion_code_batch_mailer_class
+    # @return [ActionMailer::Base] an object that responds to "promotion_code_batch_finished",
+    #   and "promotion_code_batch_errored"
+    #   (e.g. an ActionMailer with a "promotion_code_batch_finished" method) with the same
+    #   signature as Spree::PromotionCodeBatchMailer.promotion_code_batch_finished.
+    class_name_attribute :promotion_code_batch_mailer_class, default: 'Spree::PromotionCodeBatchMailer'
+
+    # Allows providing a different coupon code handler.
+    # @!attribute [rw] coupon_code_handler_class
+    # @see Spree::PromotionHandler::Coupon
+    # @return [Class] an object that conforms to the API of
+    #   the standard coupon code handler class
+    #   Spree::PromotionHandler::Coupon.
+    class_name_attribute :coupon_code_handler_class, default: 'Spree::PromotionHandler::Coupon'
+
+    # Allows providing a different promotion advertiser.
+    # @!attribute [rw] advertiser_class
+    # @see Spree::PromotionAdvertiser
+    # @return [Class] an object that conforms to the API of
+    #   the standard promotion advertiser class
+    #   Spree::PromotionAdvertiser.
+    class_name_attribute :advertiser_class, default: 'Spree::PromotionAdvertiser'
+
+    add_class_set :rules, default: %w[
+      Spree::Promotion::Rules::ItemTotal
+      Spree::Promotion::Rules::Product
+      Spree::Promotion::Rules::User
+      Spree::Promotion::Rules::FirstOrder
+      Spree::Promotion::Rules::UserLoggedIn
+      Spree::Promotion::Rules::OneUsePerUser
+      Spree::Promotion::Rules::Taxon
+      Spree::Promotion::Rules::MinimumQuantity
+      Spree::Promotion::Rules::NthOrder
+      Spree::Promotion::Rules::OptionValue
+      Spree::Promotion::Rules::FirstRepeatPurchaseSince
+      Spree::Promotion::Rules::UserRole
+      Spree::Promotion::Rules::Store
+    ]
+
+    add_class_set :actions, default: %w[
+      Spree::Promotion::Actions::CreateAdjustment
+      Spree::Promotion::Actions::CreateItemAdjustments
+      Spree::Promotion::Actions::CreateQuantityAdjustments
+      Spree::Promotion::Actions::FreeShipping
+    ]
+
+    add_class_set :shipping_actions, default: %w[
+      Spree::Promotion::Actions::FreeShipping
+    ]
+
+    add_nested_class_set :calculators, default: {
+      "Spree::Promotion::Actions::CreateAdjustment" => %w[
+        Spree::Calculator::FlatPercentItemTotal
+        Spree::Calculator::FlatRate
+        Spree::Calculator::FlexiRate
+        Spree::Calculator::TieredPercent
+        Spree::Calculator::TieredFlatRate
+      ],
+      "Spree::Promotion::Actions::CreateItemAdjustments" => %w[
+        Spree::Calculator::DistributedAmount
+        Spree::Calculator::FlatRate
+        Spree::Calculator::FlexiRate
+        Spree::Calculator::PercentOnLineItem
+        Spree::Calculator::TieredPercent
+      ],
+      "Spree::Promotion::Actions::CreateQuantityAdjustments" => %w[
+        Spree::Calculator::PercentOnLineItem
+        Spree::Calculator::FlatRate
+      ]
+    }
+  end
+end

data/lib/solidus_legacy_promotions/engine.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+require 'solidus_legacy_promotions'
+
+module SolidusLegacyPromotions
+  class Engine < ::Rails::Engine
+    include SolidusSupport::EngineExtensions
+
+    initializer "solidus_legacy_promotions.add_backend_menu_item" do
+      if SolidusSupport.backend_available?
+        promotions_menu_item = Spree::BackendConfiguration::MenuItem.new(
+          label: :promotions,
+          icon: Spree::Backend::Config.admin_updated_navbar ? "ri-megaphone-line" : "bullhorn",
+          partial: "spree/admin/shared/promotion_sub_menu",
+          condition: -> { can?(:admin, Spree::Promotion) },
+          url: :admin_promotions_path,
+          data_hook: :admin_promotion_sub_tabs,
+          children: [
+            Spree::BackendConfiguration::MenuItem.new(
+              label: :promotions,
+              condition: -> { can?(:admin, Spree::Promotion) }
+            ),
+            Spree::BackendConfiguration::MenuItem.new(
+              label: :promotion_categories,
+              condition: -> { can?(:admin, Spree::PromotionCategory) }
+            )
+          ]
+        )
+        product_menu_item_index = Spree::Backend::Config.menu_items.find_index { |item| item.label == :products }
+        Spree::Backend::Config.menu_items.insert(product_menu_item_index + 1, promotions_menu_item)
+      end
+    end
+
+    initializer "solidus_legacy_promotions.add_admin_order_index_component" do
+      if SolidusSupport.admin_available?
+        SolidusAdmin::Config.components["orders/index"] = "SolidusLegacyPromotions::Orders::Index::Component"
+      end
+    end
+
+    initializer "solidus_legacy_promotions.add_solidus_admin_menu_items" do
+      if SolidusSupport.admin_available?
+        SolidusAdmin::Config.configure do |config|
+          config.menu_items << {
+            key: "promotions",
+            route: -> { spree.admin_promotions_path },
+            icon: "megaphone-line",
+            position: 30
+          }
+        end
+      end
+    end
+
+    initializer "solidus_legacy_promotions.add_order_search_field" do
+      if SolidusSupport.backend_available?
+        email_field_index = Spree::Backend::Config.search_fields["spree/admin/orders"].find_index do |field|
+          field.dig(:locals, :ransack) == :email_start
+        end
+        Spree::Backend::Config.search_fields["spree/admin/orders"].insert(email_field_index + 1, {
+          partial: "spree/admin/shared/search_fields/text_field",
+          locals: {
+            ransack: :order_promotions_promotion_code_value_start,
+            label: -> { I18n.t(:promotion, scope: :spree) }
+          }
+        })
+      end
+    end
+
+    initializer 'solidus_legacy_promotions.core.pub_sub', after: 'spree.core.pub_sub' do |app|
+      app.reloader.to_prepare do
+        Spree::OrderPromotionSubscriber.new.subscribe_to(Spree::Bus)
+      end
+    end
+
+    initializer "solidus_legacy_promotions.assets" do |app|
+      app.config.assets.precompile << "solidus_legacy_promotions/manifest.js"
+    end
+
+    initializer "solidus_legacy_promotions.add_factories_to_core" do
+      if Rails.env.test?
+        require "spree/testing_support/factory_bot"
+        require "solidus_legacy_promotions/testing_support/factory_bot"
+        Spree::TestingSupport::FactoryBot.definition_file_paths.concat(SolidusLegacyPromotions::TestingSupport::FactoryBot.definition_file_paths)
+      end
+    rescue LoadError
+      # FactoryBot is not available, we don't need factories
+    end
+
+    initializer "solidus_legacy_promotions", after: "spree.load_config_initializers" do
+      Spree::Config.order_contents_class = "Spree::OrderContents"
+      Spree::Config.promotions = SolidusLegacyPromotions::Configuration.new
+      Spree::Config.adjustment_promotion_source_types << "Spree::PromotionAction"
+
+      Spree::Api::Config.adjustment_attributes << :promotion_code_id
+      Spree::Api::Config.adjustment_attributes << :eligible
+    end
+  end
+end

data/lib/solidus_legacy_promotions/migrations/promotions_with_code_handlers.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require 'spree/core'
+
+module SolidusLegacyPromotions
+  module Migrations
+    module PromotionWithCodeHandlers
+      class PromotionCode < ::Spree::Base
+        self.table_name = "spree_promotion_codes"
+      end
+
+      class Base
+        attr_reader :migration_context, :promotions
+
+        def initialize(migration_context, promotions)
+          @migration_context = migration_context
+          @promotions = promotions
+        end
+      end
+
+      class RaiseException < Base
+        def call
+          # Please note that this will block the current migration and rollback all
+          # the previous ones run with the same "rails db:migrate" command.
+          #
+          raise StandardError, "You are trying to drop 'code' column from "\
+            "spree_promotions table but you have at least one record with that "\
+            "column filled. Please take care of that or you could lose data. See:" \
+            "\n" \
+            "https://github.com/solidusio/solidus/pull/3028"\
+            "\n"
+        end
+      end
+
+      class MoveToSpreePromotionCode < Base
+        def call
+          # This is another possible approach, it will convert Spree::Promotion#code
+          # to a Spree::PromotionCode before removing the `code` field.
+          #
+          # NOTE: promotion codes will be downcased and stripped
+          promotions.find_each do |promotion|
+            normalized_code = promotion.code.downcase.strip
+
+            PromotionCode.find_or_create_by!(
+              value: normalized_code,
+              promotion_id: promotion.id
+            ) do
+              migration_context.say "Creating Spree::PromotionCode with value "\
+               "'#{normalized_code}' for Spree::Promotion with id '#{promotion.id}'"
+            end
+          end
+        end
+      end
+
+      class DoNothing < Base
+        def call
+          # This approach will delete all codes without taking any action. At
+          # least we could print a message to track what we are deleting.
+          #
+          promotions.find_each do |promotion|
+            migration_context.say "Code '#{promotion.code}' is going to be removed "\
+              "from Spree::Promotion with id '#{promotion.id}'"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/solidus_legacy_promotions/testing_support/factories/calculator_factory.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  factory :percent_on_item_calculator, class: 'Spree::Calculator::PercentOnLineItem' do
+    preferred_percent { 10 }
+  end
+end

data/lib/solidus_legacy_promotions/testing_support/factories/order_factory.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  factory :completed_order_with_promotion, parent: :order_with_line_items do
+    transient do
+      completed_at { Time.current }
+      promotion { nil }
+    end
+
+    after(:create) do |order, evaluator|
+      promotion = evaluator.promotion || create(:promotion, code: "test")
+      promotion_code = promotion.codes.first || create(:promotion_code, promotion:)
+
+      promotion.activate(order:, promotion_code:)
+      order.order_promotions.create!(promotion:, promotion_code:)
+
+      # Complete the order after the promotion has been activated
+      order.update_column(:completed_at, evaluator.completed_at)
+      order.update_column(:state, "complete")
+    end
+  end
+end

data/lib/solidus_legacy_promotions/testing_support/factories/order_promotion_factory.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  factory :order_promotion, class: 'Spree::OrderPromotion' do
+    association :order
+    association :promotion
+  end
+end

data/lib/solidus_legacy_promotions/testing_support/factories/promotion_category_factory.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  factory :promotion_category, class: 'Spree::PromotionCategory' do
+    name { 'Promotion Category' }
+  end
+end

data/lib/solidus_legacy_promotions/testing_support/factories/promotion_code_factory.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+FactoryBot.define do
+  factory :promotion_code, class: 'Spree::PromotionCode' do
+    promotion
+    sequence(:value) { |i| "code#{i}" }
+  end
+end