solidus_promotions 4.4.0

data/db/migrate/20231011184205_add_db_comments_to_condition_stores.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+class AddDbCommentsToConditionStores < ActiveRecord::Migration[6.1]
+  def up
+    if connection.supports_comments?
+      change_table_comment(:solidus_promotions_condition_stores, solidus_promotions_condition_stores_table_comment)
+      change_column_comment(:solidus_promotions_condition_stores, :id, id_comment)
+      change_column_comment(:solidus_promotions_condition_stores, :store_id, store_id_comment)
+      change_column_comment(:solidus_promotions_condition_stores, :condition_id, condition_id_comment)
+      change_column_comment(:solidus_promotions_condition_stores, :created_at, created_at_comment)
+      change_column_comment(:solidus_promotions_condition_stores, :updated_at, updated_at_comment)
+    end
+  end
+
+  private
+
+  def solidus_promotions_condition_stores_table_comment
+    <<~COMMENT
+      Join table between conditions and stores. Only used with the condition "Store", which checks that an order
+      has been placed in a particular Spree::Store instance.
+    COMMENT
+  end
+
+  def id_comment
+    <<~COMMENT
+      Primary key of this table.
+    COMMENT
+  end
+
+  def store_id_comment
+    <<~COMMENT
+      Foreign key to the spree_stores table.
+    COMMENT
+  end
+
+  def condition_id_comment
+    <<~COMMENT
+      Foreign key to the solidus_promotions_promotion_rules table.
+    COMMENT
+  end
+
+  def created_at_comment
+    <<~COMMENT
+      Timestamp indicating when this record was created.
+    COMMENT
+  end
+
+  def updated_at_comment
+    <<~COMMENT
+      Timestamp indicating when this record was last updated.
+    COMMENT
+  end
+end

data/db/migrate/20231011190222_add_db_comments_to_benefits.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+class AddDbCommentsToBenefits < ActiveRecord::Migration[6.1]
+  def up
+    if connection.supports_comments?
+      change_table_comment(:solidus_promotions_benefits, solidus_promotions_benefits_table_comment)
+      change_column_comment(:solidus_promotions_benefits, :id, id_comment)
+      change_column_comment(:solidus_promotions_benefits, :promotion_id, promotion_id_comment)
+      change_column_comment(:solidus_promotions_benefits, :type, type_comment)
+      change_column_comment(:solidus_promotions_benefits, :preferences, preferences_comment)
+      change_column_comment(:solidus_promotions_benefits, :created_at, created_at_comment)
+      change_column_comment(:solidus_promotions_benefits, :updated_at, updated_at_comment)
+    end
+  end
+
+  private
+
+  def solidus_promotions_benefits_table_comment
+    <<~COMMENT
+      Single Table inheritance table. Represents what to do to an order when the linked promotion is eligible.
+      Promotions can have many benefits.
+    COMMENT
+  end
+
+  def id_comment
+    <<~COMMENT
+      Primary key of this table.
+    COMMENT
+  end
+
+  def promotion_id_comment
+    <<~COMMENT
+      Foreign key to the solidus_promotions_promotions table.
+    COMMENT
+  end
+
+  def type_comment
+    <<~COMMENT
+      A class name representing which benefit this represents.
+      Usually SolidusPromotions::PromotionAction::Adjust{LineItem,Shipment}.
+    COMMENT
+  end
+
+  def preferences_comment
+    <<~COMMENT
+      Preferences for this benefit. Serialized YAML.
+    COMMENT
+  end
+
+  def created_at_comment
+    <<~COMMENT
+      Timestamp indicating when this record was created.
+    COMMENT
+  end
+
+  def updated_at_comment
+    <<~COMMENT
+      Timestamp indicating when this record was last updated.
+    COMMENT
+  end
+end

data/db/migrate/20231012020928_add_db_comments_to_condition_products.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+class AddDbCommentsToConditionProducts < ActiveRecord::Migration[6.1]
+  def up
+    if connection.supports_comments?
+      change_table_comment(:solidus_promotions_condition_products, solidus_promotions_condition_products_table_comment)
+      change_column_comment(:solidus_promotions_condition_products, :id, id_comment)
+      change_column_comment(:solidus_promotions_condition_products, :product_id, product_id_comment)
+      change_column_comment(:solidus_promotions_condition_products, :condition_id, condition_id_comment)
+      change_column_comment(:solidus_promotions_condition_products, :created_at, created_at_comment)
+      change_column_comment(:solidus_promotions_condition_products, :updated_at, updated_at_comment)
+    end
+  end
+
+  private
+
+  def solidus_promotions_condition_products_table_comment
+    <<~COMMENT
+      Join table between conditions and products.
+    COMMENT
+  end
+
+  def id_comment
+    <<~COMMENT
+      Primary key of this table.
+    COMMENT
+  end
+
+  def product_id_comment
+    <<~COMMENT
+      Foreign key to the spree_products table.
+    COMMENT
+  end
+
+  def condition_id_comment
+    <<~COMMENT
+      Foreign key to the solidus_promotions_conditions table.
+    COMMENT
+  end
+
+  def created_at_comment
+    <<~COMMENT
+      Timestamp indicating when this record was created.
+    COMMENT
+  end
+
+  def updated_at_comment
+    <<~COMMENT
+      Timestamp indicating when this record was last updated.
+    COMMENT
+  end
+end

data/db/migrate/20231012120928_add_db_comments_to_promotion_categories.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+class AddDbCommentsToPromotionCategories < ActiveRecord::Migration[6.1]
+  def up
+    if connection.supports_comments?
+      change_table_comment(:solidus_promotions_promotion_categories, solidus_promotions_promotion_categories_table_comment)
+      change_column_comment(:solidus_promotions_promotion_categories, :id, id_comment)
+      change_column_comment(:solidus_promotions_promotion_categories, :name, name_comment)
+      change_column_comment(:solidus_promotions_promotion_categories, :code, code_comment)
+      change_column_comment(:solidus_promotions_promotion_categories, :created_at, created_at_comment)
+      change_column_comment(:solidus_promotions_promotion_categories, :updated_at, updated_at_comment)
+    end
+  end
+
+  private
+
+  def solidus_promotions_promotion_categories_table_comment
+    <<~COMMENT
+      Category that helps admins index promotions.
+    COMMENT
+  end
+
+  def id_comment
+    <<~COMMENT
+      Primary key of this table.
+    COMMENT
+  end
+
+  def name_comment
+    <<~COMMENT
+      Name of this promotion category.
+    COMMENT
+  end
+
+  def code_comment
+    <<~COMMENT
+      Code of this promotion category.
+    COMMENT
+  end
+
+  def created_at_comment
+    <<~COMMENT
+      Timestamp indicating when this record was created.
+    COMMENT
+  end
+
+  def updated_at_comment
+    <<~COMMENT
+      Timestamp indicating when this record was last updated.
+    COMMENT
+  end
+end

data/db/migrate/20231104135812_add_managed_by_order_benefit_to_line_items.rb

@@ -0,0 +1,5 @@
+class AddManagedByOrderBenefitToLineItems < ActiveRecord::Migration[7.0]
+  def change
+    add_reference :spree_line_items, :managed_by_order_benefit, foreign_key: { to_table: :solidus_promotions_benefits, null: true }
+  end
+end

data/lib/components/admin/solidus_admin/orders/show/adjustments/index/source/solidus_promotions_benefit/component.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+class SolidusAdmin::Orders::Show::Adjustments::Index::Source::SolidusPromotionsBenefit::Component < SolidusAdmin::Orders::Show::Adjustments::Index::Source::Component
+  def detail
+    link_to("#{model_name}: #{promotion_name}", solidus_promotions.edit_admin_promotion_path(adjustment.source_id), class: "body-link")
+  end
+
+  private
+
+  def promotion_name
+    source.promotion.name
+  end
+
+  def solidus_promotions
+    @solidus_promotions ||= SolidusPromotions::Engine.routes.url_helpers
+  end
+end

data/lib/components/admin/solidus_promotions/orders/index/component.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+class SolidusPromotions::Orders::Index::Component < SolidusAdmin::Orders::Index::Component
+  def filters
+    super + [
+      {
+        label: t(".filters.promotions"),
+        combinator: "or",
+        attribute: "solidus_promotions_id",
+        predicate: "in",
+        options: SolidusPromotions::Promotion.all.pluck(:name, :id)
+      }
+    ]
+  end
+end

data/lib/components/admin/solidus_promotions/orders/index/component.yml

@@ -0,0 +1,3 @@
+en:
+  filters:
+    promotions: Promotions

data/lib/components/admin/solidus_promotions/promotion_categories/index/component.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+class SolidusPromotions::PromotionCategories::Index::Component < SolidusAdmin::UI::Pages::Index::Component
+  def model_class
+    SolidusPromotions::PromotionCategory
+  end
+
+  def row_url(promotion_category)
+    solidus_promotions.edit_admin_promotion_category_path(promotion_category)
+  end
+
+  def page_actions
+    render component("ui/button").new(
+      tag: :a,
+      text: t(".add"),
+      href: solidus_promotions.new_admin_promotion_category_path,
+      icon: "add-line"
+    )
+  end
+
+  def batch_actions
+    [
+      {
+        label: t(".batch_actions.delete"),
+        action: solidus_promotions.promotion_categories_path,
+        method: :delete,
+        icon: "delete-bin-7-line"
+      }
+    ]
+  end
+
+  def columns
+    [
+      name_column,
+      code_column
+    ]
+  end
+
+  def name_column
+    {
+      header: :name,
+      data: ->(promotion_category) do
+        content_tag :div, promotion_category.name
+      end
+    }
+  end
+
+  def code_column
+    {
+      header: :code,
+      data: ->(promotion_category) do
+        content_tag :div, promotion_category.code
+      end
+    }
+  end
+
+  def solidus_promotions
+    @solidus_promotions ||= SolidusPromotions::Engine.routes.url_helpers
+  end
+end

data/lib/components/admin/solidus_promotions/promotions/index/component.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+class SolidusPromotions::Promotions::Index::Component < SolidusAdmin::UI::Pages::Index::Component
+  def model_class
+    SolidusPromotions::Promotion
+  end
+
+  def search_key
+    :name_or_codes_value_or_path_or_description_cont
+  end
+
+  def search_url
+    solidus_promotions.promotions_path
+  end
+
+  def row_url(promotion)
+    solidus_promotions.admin_promotion_path(promotion)
+  end
+
+  def page_actions
+    render component("ui/button").new(
+      tag: :a,
+      text: t(".add"),
+      href: solidus_promotions.new_admin_promotion_path,
+      icon: "add-line"
+    )
+  end
+
+  def batch_actions
+    [
+      {
+        label: t(".batch_actions.delete"),
+        action: solidus_promotions.promotions_path,
+        method: :delete,
+        icon: "delete-bin-7-line"
+      }
+    ]
+  end
+
+  def scopes
+    [
+      { name: :active, label: t(".scopes.active"), default: true },
+      { name: :draft, label: t(".scopes.draft") },
+      { name: :future, label: t(".scopes.future") },
+      { name: :expired, label: t(".scopes.expired") },
+      { name: :all, label: t(".scopes.all") }
+    ]
+  end
+
+  def filters
+    [
+      {
+        label: SolidusPromotions::PromotionCategory.model_name.human.pluralize,
+        attribute: "promotion_category_id",
+        predicate: "in",
+        options: SolidusPromotions::PromotionCategory.pluck(:name, :id)
+      }
+    ]
+  end
+
+  def columns
+    [
+      {
+        header: :name,
+        data: ->(promotion) do
+          content_tag :div, promotion.name
+        end
+      },
+      {
+        header: :code,
+        data: ->(promotion) do
+          count = promotion.codes.count
+          (count == 1) ? promotion.codes.pick(:value) : t("spree.number_of_codes", count: count)
+        end
+      },
+      {
+        header: :status,
+        data: ->(promotion) do
+          if promotion.active?
+            render component("ui/badge").new(name: t(".status.active"), color: :green)
+          else
+            render component("ui/badge").new(name: t(".status.inactive"), color: :graphite_light)
+          end
+        end
+      },
+      {
+        header: :usage_limit,
+        data: ->(promotion) { promotion.usage_limit || icon_tag("infinity-line") }
+      },
+      {
+        header: :uses,
+        data: ->(promotion) { promotion.usage_count }
+      },
+      {
+        header: :starts_at,
+        data: ->(promotion) { promotion.starts_at ? l(promotion.starts_at, format: :long) : icon_tag("infinity-line") }
+      },
+      {
+        header: :expires_at,
+        data: ->(promotion) { promotion.expires_at ? l(promotion.expires_at, format: :long) : icon_tag("infinity-line") }
+      }
+    ]
+  end
+
+  def solidus_promotions
+    @solidus_promotions ||= SolidusPromotions::Engine.routes.url_helpers
+  end
+end

data/lib/components/admin/solidus_promotions/promotions/index/component.yml

@@ -0,0 +1,10 @@
+en:
+  scopes:
+    active: Active
+    draft: Draft
+    future: Future
+    expired: Expired
+    all: All
+  status:
+    active: Active
+    inactive: Inactive

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module SolidusPromotions
+  class PromotionCategoriesController < SolidusAdmin::BaseController
+    include SolidusAdmin::ControllerHelpers::Search
+
+    def index
+      promotion_categories = apply_search_to(
+        SolidusPromotions::PromotionCategory.all,
+        param: :q
+      )
+
+      set_page_and_extract_portion_from(promotion_categories)
+
+      respond_to do |format|
+        format.html { render component("promotion_categories/index").new(page: @page) }
+      end
+    end
+
+    def destroy
+      @promotion_categories = SolidusPromotions::PromotionCategory.where(id: params[:id])
+
+      SolidusPromotions::PromotionCategory.transaction { @promotion_categories.destroy_all }
+
+      flash[:notice] = t(".success")
+      redirect_back_or_to solidus_promotions.promotion_categories_path, status: :see_other
+    end
+  end
+end

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

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module SolidusPromotions
+  class PromotionsController < SolidusAdmin::BaseController
+    include SolidusAdmin::ControllerHelpers::Search
+
+    search_scope(:active, default: true, &:active)
+    search_scope(:draft) { _1.where.not(id: _1.has_benefits.select(:id)) }
+    search_scope(:future) { _1.has_benefits.where(starts_at: Time.current..) }
+    search_scope(:expired) { _1.has_benefits.where(expires_at: ..Time.current) }
+    search_scope(:all)
+
+    def index
+      promotions = apply_search_to(
+        SolidusPromotions::Promotion.order(id: :desc),
+        param: :q
+      )
+
+      set_page_and_extract_portion_from(promotions)
+
+      respond_to do |format|
+        format.html { render component("promotions/index").new(page: @page) }
+      end
+    end
+
+    def destroy
+      @promotions = SolidusPromotions::Promotion.where(id: params[:id])
+
+      SolidusPromotions::Promotion.transaction { @promotions.destroy_all }
+
+      flash[:notice] = t(".success")
+      redirect_back_or_to promotions_path, status: :see_other
+    end
+
+    private
+
+    def load_promotion
+      @promotion = SolidusPromotions::Promotion.find_by!(number: params[:id])
+      authorize! action_name, @promotion
+    end
+
+    def promotion_params
+      params.require(:promotion).permit(:user_id, permitted_promotion_attributes)
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module SolidusPromotions
+  module Admin
+    class BaseController < Spree::Admin::ResourceController
+      def routes_proxy
+        solidus_promotions
+      end
+
+      def parent_model_name
+        self.class.parent_data[:model_name].gsub("solidus_promotions/", "")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module SolidusPromotions
+  module Admin
+    class BenefitsController < Spree::Admin::BaseController
+      before_action :load_promotion, only: [:create, :destroy, :new, :update, :edit]
+      before_action :validate_benefit_type, only: [:create, :edit]
+
+      def new
+        @benefit = @promotion.benefits.build(benefit_params)
+        render layout: false
+      end
+
+      def create
+        @benefit = @benefit_type.new(benefit_params)
+        @benefit.promotion = @promotion
+        if @benefit.save(validate: false)
+          flash[:success] =
+            t("spree.successfully_created", resource: SolidusPromotions::Benefit.model_name.human)
+          redirect_to location_after_save, format: :html
+        else
+          render :new, layout: false
+        end
+      end
+
+      def edit
+        @benefit = @promotion.benefits.find(params[:id])
+        if params.dig(:benefit, :calculator_type)
+          @benefit.calculator_type = params[:benefit][:calculator_type]
+        end
+        render layout: false
+      end
+
+      def update
+        @benefit = @promotion.benefits.find(params[:id])
+        @benefit.assign_attributes(benefit_params)
+        if @benefit.save
+          flash[:success] =
+            t("spree.successfully_updated", resource: SolidusPromotions::Benefit.model_name.human)
+          redirect_to location_after_save, format: :html
+        else
+          render :edit
+        end
+      end
+
+      def destroy
+        @benefit = @promotion.benefits.find(params[:id])
+        if @benefit.destroy
+          flash[:success] =
+            t("spree.successfully_removed", resource: SolidusPromotions::Benefit.model_name.human)
+        end
+        redirect_to location_after_save, format: :html
+      end
+
+      private
+
+      def location_after_save
+        solidus_promotions.edit_admin_promotion_path(@promotion)
+      end
+
+      def load_promotion
+        @promotion = SolidusPromotions::Promotion.find(params[:promotion_id])
+      end
+
+      def benefit_params
+        params[:benefit].try(:permit!) || {}
+      end
+
+      def validate_benefit_type
+        requested_type = params[:benefit].delete(:type)
+        benefit_types = SolidusPromotions.config.benefits
+        @benefit_type = benefit_types.detect do |klass|
+          klass.name == requested_type
+        end
+        return if @benefit_type
+
+        flash[:error] = t("solidus_promotions.invalid_benefit")
+        respond_to do |format|
+          format.html { redirect_to solidus_promotions.edit_admin_promotion_path(@promotion) }
+          format.js { render layout: false }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module SolidusPromotions
+  module Admin
+    class ConditionsController < Spree::Admin::BaseController
+      helper "solidus_promotions/admin/conditions"
+
+      before_action :load_benefit, only: [:create, :destroy, :update, :new]
+      rescue_from ActiveRecord::SubclassNotFound, with: :invalid_condition_error
+
+      def new
+        @condition = @benefit.conditions.build(condition_params)
+        render layout: false
+      end
+
+      def create
+        @condition = @benefit.conditions.build(condition_params)
+        if @condition.save
+          flash[:success] =
+            t("spree.successfully_created", resource: model_class.model_name.human)
+        end
+        redirect_to location_after_save
+      end
+
+      def update
+        @condition = @benefit.conditions.find(params[:id])
+        @condition.assign_attributes(condition_params)
+        if @condition.save
+          flash[:success] =
+            t("spree.successfully_updated", resource: model_class.model_name.human)
+        end
+        redirect_to location_after_save
+      end
+
+      def destroy
+        @condition = @benefit.conditions.find(params[:id])
+        if @condition.destroy
+          flash[:success] =
+            t("spree.successfully_removed", resource: model_class.model_name.human)
+        end
+        redirect_to location_after_save
+      end
+
+      private
+
+      def invalid_condition_error
+        flash[:error] = t("solidus_promotions.invalid_condition")
+        redirect_to location_after_save
+      end
+
+      def location_after_save
+        solidus_promotions.edit_admin_promotion_path(@promotion)
+      end
+
+      def load_benefit
+        @promotion = SolidusPromotions::Promotion.find(params[:promotion_id])
+        @benefit = @promotion.benefits.find(params[:benefit_id])
+      end
+
+      def model_class
+        SolidusPromotions::Condition
+      end
+
+      def condition_params
+        params[:condition].try(:permit!) || {}
+      end
+    end
+  end
+end