solidus_promotions 4.4.0

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module SolidusPromotions
+  module Admin
+    class PromotionCategoriesController < BaseController
+      private
+
+      def model_class
+        SolidusPromotions::PromotionCategory
+      end
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module SolidusPromotions
+  module Admin
+    class PromotionCodeBatchesController < BaseController
+      belongs_to "solidus_promotions/promotion"
+
+      create.after :build_promotion_code_batch
+
+      def download
+        require "csv"
+
+        @promotion_code_batch = SolidusPromotions::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
+
+      def model_class
+        SolidusPromotions::PromotionCodeBatch
+      end
+
+      def collection
+        parent.code_batches
+      end
+
+      def build_resource
+        parent.code_batches.build
+      end
+    end
+  end
+end

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

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require "csv"
+
+module SolidusPromotions
+  module Admin
+    class PromotionCodesController < BaseController
+      before_action :load_promotion
+
+      def index
+        @promotion_codes = @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
+        if @promotion.apply_automatically
+          flash[:error] = t(
+            :disallowed_with_apply_automatically,
+            scope: "activerecord.errors.models.solidus_promotions/promotion_code.attributes.base"
+          )
+          redirect_to solidus_promotions.admin_promotion_promotion_codes_url(@promotion)
+        else
+          @promotion_code = @promotion.codes.build
+        end
+      end
+
+      def create
+        @promotion_code = @promotion.codes.build(value: params[:promotion_code][:value])
+
+        if @promotion_code.save
+          flash[:success] = flash_message_for(@promotion_code, :successfully_created)
+          redirect_to solidus_promotions.admin_promotion_promotion_codes_url(@promotion)
+        else
+          flash.now[:error] = @promotion_code.errors.full_messages.to_sentence
+          render_after_create_error
+        end
+      end
+
+      private
+
+      def load_promotion
+        @promotion = SolidusPromotions::Promotion
+          .accessible_by(current_ability, :show)
+          .find(params[:promotion_id])
+      end
+    end
+  end
+end

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

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module SolidusPromotions
+  module Admin
+    class PromotionsController < BaseController
+      before_action :load_data
+
+      helper "solidus_promotions/admin/conditions"
+      helper "solidus_promotions/admin/benefits"
+      helper "solidus_promotions/admin/promotions"
+
+      def create
+        @promotion = model_class.new(permitted_resource_params)
+        @promotion.codes.new(value: params[:single_code]) if params[:single_code].present?
+
+        if params[:code_batch]
+          @code_batch = @promotion.code_batches.new(code_batch_params)
+        end
+
+        if @promotion.save
+          @code_batch&.process
+          flash[:success] = t("solidus_promotions.promotion_successfully_created")
+          redirect_to location_after_save
+        else
+          flash[:error] = @promotion.errors.full_messages.to_sentence
+          render action: "new"
+        end
+      end
+
+      private
+
+      def collection
+        return @collection if @collection
+
+        params[:q] ||= HashWithIndifferentAccess.new
+        params[:q][:s] ||= "updated_at desc"
+
+        @collection = super
+        @search = @collection.ransack(params[:q])
+        @collection = @search.result(distinct: true)
+          .includes(promotion_includes)
+          .page(params[:page])
+          .per(params[:per_page] || SolidusPromotions.config.promotions_per_page)
+
+        @collection
+      end
+
+      def promotion_includes
+        [:benefits]
+      end
+
+      def model_class
+        SolidusPromotions::Promotion
+      end
+
+      def load_data
+        @promotion_categories = PromotionCategory.order(:name)
+      end
+
+      def location_after_save
+        solidus_promotions.edit_admin_promotion_url(@promotion)
+      end
+    end
+  end
+end

data/lib/generators/solidus_promotions/install/install_generator.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module SolidusPromotions
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      class_option :auto_run_migrations, type: :boolean, default: false
+      source_root File.expand_path("templates", __dir__)
+
+      def self.exit_on_failure?
+        true
+      end
+
+      def copy_initializer
+        template "initializer.rb", "config/initializers/solidus_promotions.rb"
+      end
+
+      def add_migrations
+        run "bin/rails railties:install:migrations FROM=solidus_promotions"
+      end
+
+      def modify_spree_initializer
+        spree_rb_path = "config/initializers/spree.rb"
+        new_content = <<-RUBY.gsub(/^ {8}/, "")
+          # Make sure we use Spree::SimpleOrderContents
+          # Spree::Config.order_contents_class = "Spree::SimpleOrderContents"
+          # Set the promotion configuration to ours
+          # Spree::Config.promotions = SolidusPromotions.configuration
+        RUBY
+        insert_into_file spree_rb_path, new_content, after: "Spree.config do |config|\n"
+      end
+
+      def mount_engine
+        inject_into_file "config/routes.rb",
+          "  mount SolidusPromotions::Engine => '/'\n",
+          before: /  mount Spree::Core::Engine.*/,
+          verbose: true
+      end
+
+      def run_migrations
+        run_migrations = options[:auto_run_migrations] || ["", "y", "Y"].include?(ask("Would you like to run the migrations now? [Y/n]"))
+        if run_migrations
+          run "bin/rails db:migrate"
+        else
+          puts "Skipping bin/rails db:migrate, don't forget to run it!"
+        end
+      end
+
+      def explain_promotion_config
+        say "SolidusPromotions is now installed. You can configure it by editing the initializer at `config/initializers/solidus_promotions.rb`."
+        say "By default, it is not activated. In order to activate it, you need to set `Spree::Config.promotions` to `SolidusPromotions.configuration`" \
+          "in your `config/initializers/spree.rb` file."
+        say "If you have been running the legacy promotion system, we recommend converting your existing promotions using the `solidus_promotions:migrate_existing_promotions` rake task."
+      end
+    end
+  end
+end

data/lib/generators/solidus_promotions/install/templates/initializer.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+# SolidusPromotions.configure do |config|
+#   # Add your own configuration here. See https://github.com/solidusio/solidus/blob/main/promotions/lib/solidus_promotions/configuration.rb
+#   # to learn more about the available options.
+# end

data/lib/solidus_promotions/configuration.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+require "spree/core/environment_extension"
+
+module SolidusPromotions
+  class Configuration < Spree::Preferences::Configuration
+    include Spree::Core::EnvironmentExtension
+
+    class_name_attribute :order_adjuster_class, default: "SolidusPromotions::OrderAdjuster"
+
+    class_name_attribute :coupon_code_handler_class, default: "SolidusPromotions::PromotionHandler::Coupon"
+
+    class_name_attribute :promotion_finder_class, default: "SolidusPromotions::PromotionFinder"
+
+    # Allows providing a different promotion advertiser.
+    # @!attribute [rw] advertiser_class
+    # @see Spree::NullPromotionAdvertiser
+    # @return [Class] an object that conforms to the API of
+    #   the standard promotion advertiser class
+    #   Spree::NullPromotionAdvertiser.
+    class_name_attribute :advertiser_class, default: "SolidusPromotions::PromotionAdvertiser"
+
+    # In case solidus_legacy_promotions is loaded, we need to define this.
+    class_name_attribute :shipping_promotion_handler_class, default: "Spree::NullPromotionHandler"
+
+    add_class_set :order_conditions, default: [
+      "SolidusPromotions::Conditions::FirstOrder",
+      "SolidusPromotions::Conditions::FirstRepeatPurchaseSince",
+      "SolidusPromotions::Conditions::ItemTotal",
+      "SolidusPromotions::Conditions::DiscountedItemTotal",
+      "SolidusPromotions::Conditions::MinimumQuantity",
+      "SolidusPromotions::Conditions::NthOrder",
+      "SolidusPromotions::Conditions::OneUsePerUser",
+      "SolidusPromotions::Conditions::OptionValue",
+      "SolidusPromotions::Conditions::Product",
+      "SolidusPromotions::Conditions::Store",
+      "SolidusPromotions::Conditions::Taxon",
+      "SolidusPromotions::Conditions::UserLoggedIn",
+      "SolidusPromotions::Conditions::UserRole",
+      "SolidusPromotions::Conditions::User"
+    ]
+
+    add_class_set :line_item_conditions, default: [
+      "SolidusPromotions::Conditions::LineItemOptionValue",
+      "SolidusPromotions::Conditions::LineItemProduct",
+      "SolidusPromotions::Conditions::LineItemTaxon"
+    ]
+    add_class_set :shipment_conditions, default: [
+      "SolidusPromotions::Conditions::ShippingMethod"
+    ]
+
+    add_class_set :benefits, default: [
+      "SolidusPromotions::Benefits::AdjustLineItem",
+      "SolidusPromotions::Benefits::AdjustLineItemQuantityGroups",
+      "SolidusPromotions::Benefits::AdjustShipment",
+      "SolidusPromotions::Benefits::CreateDiscountedItem"
+    ]
+
+    add_nested_class_set :promotion_calculators, default: {
+      "SolidusPromotions::Benefits::AdjustShipment" => [
+        "SolidusPromotions::Calculators::FlatRate",
+        "SolidusPromotions::Calculators::FlexiRate",
+        "SolidusPromotions::Calculators::Percent",
+        "SolidusPromotions::Calculators::TieredFlatRate",
+        "SolidusPromotions::Calculators::TieredPercent",
+        "SolidusPromotions::Calculators::TieredPercentOnEligibleItemQuantity"
+      ],
+      "SolidusPromotions::Benefits::AdjustLineItem" => [
+        "SolidusPromotions::Calculators::DistributedAmount",
+        "SolidusPromotions::Calculators::FlatRate",
+        "SolidusPromotions::Calculators::FlexiRate",
+        "SolidusPromotions::Calculators::Percent",
+        "SolidusPromotions::Calculators::TieredFlatRate",
+        "SolidusPromotions::Calculators::TieredPercent",
+        "SolidusPromotions::Calculators::TieredPercentOnEligibleItemQuantity"
+      ],
+      "SolidusPromotions::Benefits::AdjustLineItemQuantityGroups" => [
+        "SolidusPromotions::Calculators::FlatRate",
+        "SolidusPromotions::Calculators::Percent",
+        "SolidusPromotions::Calculators::TieredPercentOnEligibleItemQuantity"
+      ],
+      "SolidusPromotions::Benefits::CreateDiscountedItem" => [
+        "SolidusPromotions::Calculators::FlatRate",
+        "SolidusPromotions::Calculators::Percent",
+        "SolidusPromotions::Calculators::TieredPercentOnEligibleItemQuantity"
+      ]
+    }
+
+    class_name_attribute :discount_chooser_class, default: "SolidusPromotions::OrderAdjuster::ChooseDiscounts"
+    class_name_attribute :promotion_code_batch_mailer_class,
+      default: "SolidusPromotions::PromotionCodeBatchMailer"
+
+    # @!attribute [rw] promotions_per_page
+    #   @return [Integer] Promotions to show per-page in the admin (default: +25+)
+    preference :promotions_per_page, :integer, default: 25
+
+    preference :lanes, :hash, default: {
+      pre: 0,
+      default: 1,
+      post: 2
+    }
+
+    preference :recalculate_complete_orders, :boolean, default: true
+
+    preference :sync_order_promotions, :boolean, default: false
+
+    preference :use_new_admin, :boolean, default: false
+
+    def use_new_admin?
+      SolidusSupport.admin_available? && preferred_use_new_admin
+    end
+  end
+
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    alias_method :config, :configuration
+
+    def configure
+      yield configuration
+    end
+  end
+end

data/lib/solidus_promotions/engine.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+require "solidus_core"
+require "solidus_support"
+
+module SolidusPromotions
+  class Engine < Rails::Engine
+    include SolidusSupport::EngineExtensions
+
+    isolate_namespace ::SolidusPromotions
+
+    engine_name "solidus_promotions"
+
+    # use rspec for tests
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+
+    initializer "solidus_promotions.assets" do |app|
+      if SolidusSupport.backend_available?
+        app.config.assets.precompile << "solidus_promotions/manifest.js"
+      end
+    end
+
+    initializer "solidus_promotions.importmap" do |app|
+      if SolidusSupport.backend_available?
+        SolidusPromotions.importmap.draw(Engine.root.join("config", "importmap.rb"))
+
+        package_path = Engine.root.join("app/javascript")
+        app.config.assets.paths << package_path
+
+        if app.config.importmap.sweep_cache
+          SolidusPromotions.importmap.cache_sweeper(watches: package_path)
+          ActiveSupport.on_load(:action_controller_base) do
+            before_action { SolidusPromotions.importmap.cache_sweeper.execute_if_updated }
+          end
+        end
+      end
+    end
+
+    initializer "solidus_promotions.spree_config", after: "spree.load_config_initializers" do
+      Spree::Config.adjustment_promotion_source_types << "SolidusPromotions::Benefit"
+
+      Rails.application.config.to_prepare do
+        Spree::Order.line_item_comparison_hooks << :free_from_order_benefit?
+      end
+    end
+
+    initializer "solidus_promotions.core.pub_sub", after: "spree.core.pub_sub" do |app|
+      app.reloader.to_prepare do
+        SolidusPromotions::OrderPromotionSubscriber.new.subscribe_to(Spree::Bus)
+      end
+    end
+
+    initializer "solidus_promotions.add_admin_order_index_component", after: "solidus_legacy_promotions.add_admin_order_index_component" do
+      if SolidusSupport.admin_available?
+        SolidusAdmin::Config.components["orders/index"] = "SolidusPromotions::Orders::Index::Component"
+        SolidusAdmin::Config.components["promotions/index"] = "SolidusPromotions::Promotions::Index::Component"
+        SolidusAdmin::Config.components["promotion_categories/index"] = "SolidusPromotions::PromotionCategories::Index::Component"
+      end
+    end
+
+    initializer "solidus_promotions.add_backend_menus", after: "spree.backend.environment" do
+      if SolidusSupport.backend_available?
+        # Replace the promotions menu from core with ours
+        Spree::Backend::Config.configure do |config|
+          config.menu_items = config.menu_items.flat_map do |item|
+            next item unless item.label.to_sym == :promotions
+
+            [
+              Spree::BackendConfiguration::MenuItem.new(
+                label: :promotions,
+                icon: config.admin_updated_navbar ? "ri-megaphone-line" : "bullhorn",
+                condition: -> { can?(:admin, SolidusPromotions::Promotion) },
+                url: -> { SolidusPromotions::Engine.routes.url_helpers.admin_promotions_path },
+                data_hook: :admin_solidus_promotion_sub_tabs,
+                children: [
+                  Spree::BackendConfiguration::MenuItem.new(
+                    label: :promotions,
+                    url: -> { SolidusPromotions::Engine.routes.url_helpers.admin_promotions_path },
+                    condition: -> { can?(:admin, SolidusPromotions::Promotion) }
+                  ),
+                  Spree::BackendConfiguration::MenuItem.new(
+                    label: :promotion_categories,
+                    url: -> { SolidusPromotions::Engine.routes.url_helpers.admin_promotion_categories_path },
+                    condition: -> { can?(:admin, SolidusPromotions::PromotionCategory) }
+                  )
+                ]
+              ),
+              Spree::BackendConfiguration::MenuItem.new(
+                label: :legacy_promotions,
+                icon: config.admin_updated_navbar ? "ri-megaphone-line" : "bullhorn",
+                condition: -> { can?(:admin, SolidusPromotions::Promotion) },
+                url: -> { Spree::Core::Engine.routes.url_helpers.admin_promotions_path },
+                data_hook: :admin_promotion_sub_tabs,
+                children: [
+                  Spree::BackendConfiguration::MenuItem.new(
+                    label: :legacy_promotions,
+                    condition: -> { can?(:admin, Spree::Promotion && Spree::Promotion.any?) },
+                    url: -> { Spree::Core::Engine.routes.url_helpers.admin_promotions_path },
+                  ),
+                  Spree::BackendConfiguration::MenuItem.new(
+                    label: :legacy_promotion_categories,
+                    condition: -> { can?(:admin, Spree::PromotionCategory && Spree::Promotion.any?) },
+                    url: -> { Spree::Core::Engine.routes.url_helpers.admin_promotion_categories_path },
+                  )
+                ]
+              )
+            ]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/solidus_promotions/migrate_adjustments.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module SolidusPromotions
+  class MigrateAdjustments
+    class << self
+      def up
+        sql = if ActiveRecord::Base.connection_db_config.adapter == "mysql2"
+          <<~SQL
+            UPDATE spree_adjustments
+              INNER JOIN spree_promotion_actions ON spree_adjustments.source_id = spree_promotion_actions.id and spree_adjustments.source_type = 'Spree::PromotionAction'
+              INNER JOIN solidus_promotions_benefits ON solidus_promotions_benefits.original_promotion_action_id = spree_promotion_actions.id
+            SET source_id = solidus_promotions_benefits.id,
+              source_type = 'SolidusPromotions::Benefit'
+          SQL
+        else
+          <<~SQL
+            UPDATE spree_adjustments
+            SET source_id = solidus_promotions_benefits.id,
+              source_type = 'SolidusPromotions::Benefit'
+            FROM spree_promotion_actions
+              INNER JOIN solidus_promotions_benefits ON solidus_promotions_benefits.original_promotion_action_id = spree_promotion_actions.id
+            WHERE spree_adjustments.source_id = spree_promotion_actions.id and spree_adjustments.source_type = 'Spree::PromotionAction'
+          SQL
+        end
+
+        execute(sql)
+      end
+
+      def down
+        sql = if ActiveRecord::Base.connection_db_config.adapter == "mysql2"
+          <<~SQL
+            UPDATE spree_adjustments
+              INNER JOIN solidus_promotions_benefits
+              INNER JOIN spree_promotion_actions ON spree_adjustments.source_id = solidus_promotions_benefits.id and spree_adjustments.source_type = 'SolidusPromotions::Benefit'
+            SET source_id = spree_promotion_actions.id,
+              source_type = 'Spree::PromotionAction'
+            WHERE solidus_promotions_benefits.original_promotion_action_id = spree_promotion_actions.id
+          SQL
+        else
+          <<~SQL
+            UPDATE spree_adjustments
+            SET source_id = spree_promotion_actions.id,
+                source_type = 'Spree::PromotionAction'
+            FROM spree_promotion_actions
+              INNER JOIN solidus_promotions_benefits ON solidus_promotions_benefits.original_promotion_action_id = spree_promotion_actions.id
+            WHERE spree_adjustments.source_id = solidus_promotions_benefits.id and spree_adjustments.source_type = 'SolidusPromotions::Benefit'
+          SQL
+        end
+
+        execute(sql)
+      end
+
+      private
+
+      def execute(sql)
+        Spree::Adjustment.transaction do
+          ActiveRecord::Base.connection.execute(sql)
+        end
+      end
+    end
+  end
+end

data/lib/solidus_promotions/migrate_order_promotions.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module SolidusPromotions
+  class MigrateOrderPromotions
+    class << self
+      def up
+        sql = <<~SQL
+          INSERT INTO solidus_promotions_order_promotions (
+            order_id,
+            promotion_id,
+            promotion_code_id,
+            created_at,
+            updated_at
+          )
+          SELECT
+            spree_orders_promotions.order_id AS order_id,
+            solidus_promotions_promotions.id AS promotion_id,
+            solidus_promotions_promotion_codes.id AS promotion_code_id,
+            spree_orders_promotions.created_at,
+            spree_orders_promotions.updated_at
+          FROM spree_orders_promotions
+            INNER JOIN spree_promotions ON spree_orders_promotions.promotion_id = spree_promotions.id
+            INNER JOIN solidus_promotions_promotions ON spree_promotions.id = solidus_promotions_promotions.original_promotion_id
+            LEFT OUTER JOIN spree_promotion_codes ON spree_orders_promotions.promotion_code_id = spree_promotion_codes.id
+            LEFT OUTER JOIN solidus_promotions_promotion_codes ON spree_promotion_codes.value = solidus_promotions_promotion_codes.value
+          WHERE NOT EXISTS (
+            SELECT NULL
+            FROM solidus_promotions_order_promotions
+            WHERE solidus_promotions_order_promotions.order_id = order_id
+              AND (solidus_promotions_order_promotions.promotion_code_id = promotion_code_id OR promotion_code_id IS NULL)
+              AND solidus_promotions_order_promotions.promotion_id = promotion_id
+          );
+        SQL
+        ActiveRecord::Base.connection.execute(sql)
+
+        Spree::OrderPromotion.delete_all
+      end
+
+      def down
+        sql = <<~SQL
+          INSERT INTO spree_orders_promotions (
+            order_id,
+            promotion_id,
+            promotion_code_id,
+            created_at,
+            updated_at
+          )
+          SELECT
+            solidus_promotions_order_promotions.order_id AS order_id,
+            spree_promotions.id AS promotion_id,
+            spree_promotion_codes.id AS promotion_code_id,
+            solidus_promotions_order_promotions.created_at,
+            solidus_promotions_order_promotions.updated_at
+          FROM solidus_promotions_order_promotions
+            INNER JOIN solidus_promotions_promotions ON solidus_promotions_order_promotions.promotion_id = solidus_promotions_promotions.id
+            INNER JOIN spree_promotions ON spree_promotions.id = solidus_promotions_promotions.original_promotion_id
+            LEFT OUTER JOIN solidus_promotions_promotion_codes ON solidus_promotions_order_promotions.promotion_code_id = solidus_promotions_promotion_codes.id
+            LEFT OUTER JOIN spree_promotion_codes ON spree_promotion_codes.value = solidus_promotions_promotion_codes.value
+          WHERE NOT EXISTS (
+            SELECT NULL
+            FROM spree_orders_promotions
+            WHERE spree_orders_promotions.order_id = order_id
+              AND (spree_orders_promotions.promotion_code_id = promotion_code_id OR promotion_code_id IS NULL)
+              AND spree_orders_promotions.promotion_id = promotion_id
+          );
+        SQL
+        ActiveRecord::Base.connection.execute(sql)
+
+        SolidusPromotions::OrderPromotion.delete_all
+      end
+    end
+  end
+end