solidus_promotions 4.4.0

data/db/migrate/20230703101637_create_promotions.rb

@@ -0,0 +1,25 @@
+class CreatePromotions < ActiveRecord::Migration[7.0]
+  def change
+    promotion_foreign_key = table_exists?(:spree_promotions) ? { to_table: :spree_promotions } : false
+
+    create_table :solidus_promotions_promotions do |t|
+      t.string :description
+      t.datetime :expires_at, precision: nil
+      t.datetime :starts_at, precision: nil
+      t.string :name
+      t.integer :usage_limit
+      t.boolean :advertise, default: false
+      t.string :path
+      t.integer :per_code_usage_limit
+      t.boolean :apply_automatically, default: false
+      t.integer :lane, null: false, default: 1
+      t.string :customer_label
+      t.datetime :deleted_at
+      t.references :original_promotion, type: :integer, index: { name: :index_original_promotion_id }, foreign_key: promotion_foreign_key
+
+      t.timestamps
+    end
+
+    add_index :solidus_promotions_promotions, :deleted_at
+  end
+end

data/db/migrate/20230703113625_create_promotion_benefits.rb

@@ -0,0 +1,15 @@
+class CreatePromotionBenefits < ActiveRecord::Migration[7.0]
+  def change
+    promotion_action_foreign_key = table_exists?(:spree_promotion_actions) ? { to_table: :spree_promotion_actions } : false
+
+    create_table :solidus_promotions_benefits do |t|
+      t.references :promotion, index: true, null: false, foreign_key: { to_table: :solidus_promotions_promotions }
+      t.string :type
+      t.text :preferences
+      t.references :original_promotion_action, type: :integer, index: { name: :index_original_promotion_action_id }, foreign_key: promotion_action_foreign_key
+      t.index [:id, :type], name: :index_solidus_promotions_benefits_on_id_and_type
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20230703141116_create_promotion_categories.rb

@@ -0,0 +1,14 @@
+class CreatePromotionCategories < ActiveRecord::Migration[7.0]
+  def change
+    create_table :solidus_promotions_promotion_categories do |t|
+      t.string :name
+      t.string :code
+
+      t.timestamps
+    end
+
+    add_reference :solidus_promotions_promotions,
+      :promotion_category,
+      foreign_key: { to_table: :solidus_promotions_promotion_categories }
+  end
+end

data/db/migrate/20230703143943_create_promotion_conditions.rb

@@ -0,0 +1,12 @@
+class CreatePromotionConditions < ActiveRecord::Migration[7.0]
+  def change
+    create_table :solidus_promotions_conditions do |t|
+      t.references :benefit,
+        foreign_key: { to_table: :solidus_promotions_benefits }
+      t.string :type
+      t.text :preferences
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20230704083830_add_condition_join_tables.rb

@@ -0,0 +1,31 @@
+class AddConditionJoinTables < ActiveRecord::Migration[7.0]
+  def change
+    create_table :solidus_promotions_condition_products, force: :cascade do |t|
+      t.references :product, type: :integer, index: true, null: false, foreign_key: { to_table: :spree_products }
+      t.references :condition, index: true, null: false, foreign_key: { to_table: :solidus_promotions_conditions }
+
+      t.timestamps
+    end
+
+    create_table :solidus_promotions_condition_taxons, force: :cascade do |t|
+      t.references :taxon, type: :integer, index: true, null: false, foreign_key: { to_table: :spree_taxons }
+      t.references :condition, index: true, null: false, foreign_key: { to_table: :solidus_promotions_conditions }
+
+      t.timestamps
+    end
+
+    create_table :solidus_promotions_condition_users, force: :cascade do |t|
+      t.references :user, type: :integer, index: true, null: false, foreign_key: { to_table: Spree.user_class.table_name }
+      t.references :condition, index: true, null: false, foreign_key: { to_table: :solidus_promotions_conditions }
+
+      t.timestamps
+    end
+
+    create_table :solidus_promotions_condition_stores do |t|
+      t.references :store, type: :integer, index: true, null: false, foreign_key: { to_table: :spree_stores }
+      t.references :condition, index: true, null: false, foreign_key: { to_table: :solidus_promotions_conditions }
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20230704102444_create_promotion_codes.rb

@@ -0,0 +1,11 @@
+class CreatePromotionCodes < ActiveRecord::Migration[7.0]
+  def change
+    create_table :solidus_promotions_promotion_codes, force: :cascade do |t|
+      t.references :promotion, null: false, index: true, foreign_key: { to_table: :solidus_promotions_promotions }
+      t.string :value, null: false
+      t.timestamps
+
+      t.index ["value"], name: "index_solidus_promotions_promotion_codes_on_value", unique: true
+    end
+  end
+end

data/db/migrate/20230704102656_create_promotion_code_batches.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+class CreatePromotionCodeBatches < ActiveRecord::Migration[7.0]
+  def change
+    create_table :solidus_promotions_promotion_code_batches do |t|
+      t.references :promotion, null: false, index: true, foreign_key: { to_table: :solidus_promotions_promotions }
+      t.string :base_code, null: false
+      t.integer :number_of_codes, null: false
+      t.string :join_characters, null: false, default: "_"
+      t.string :email
+      t.string :error
+      t.string :state, default: "pending"
+      t.timestamps precision: 6
+    end
+
+    add_column(
+      :solidus_promotions_promotion_codes,
+      :promotion_code_batch_id,
+      :bigint
+    )
+
+    add_foreign_key(
+      :solidus_promotions_promotion_codes,
+      :solidus_promotions_promotion_code_batches,
+      column: :promotion_code_batch_id
+    )
+
+    add_index(
+      :solidus_promotions_promotion_codes,
+      :promotion_code_batch_id,
+      name: "index_promotion_codes_on_promotion_code_batch_id"
+    )
+  end
+end

data/db/migrate/20230705171556_create_order_promotions.rb

@@ -0,0 +1,11 @@
+class CreateOrderPromotions < ActiveRecord::Migration[7.0]
+  def change
+    create_table :solidus_promotions_order_promotions do |t|
+      t.references :order, type: :integer, index: true, null: false, foreign_key: { to_table: :spree_orders }
+      t.references :promotion, index: true, null: false, foreign_key: { to_table: :solidus_promotions_promotions }
+      t.references :promotion_code, index: true, null: true, foreign_key: { to_table: :solidus_promotions_promotion_codes }
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20230725074235_create_shipping_rate_discounts.rb

@@ -0,0 +1,12 @@
+class CreateShippingRateDiscounts < ActiveRecord::Migration[7.0]
+  def change
+    create_table :solidus_promotions_shipping_rate_discounts do |t|
+      t.references :benefit, type: :bigint, null: false, foreign_key: { to_table: :solidus_promotions_benefits }, index: { name: "index_shipping_rate_discounts_on_benefit_id" }
+      t.references :shipping_rate, type: :integer, null: false, foreign_key: { to_table: :spree_shipping_rates }, index: { name: "index_shipping_rate_discounts_on_shipping_rate_id" }
+      t.decimal :amount, precision: 10, scale: 2, null: false
+      t.string :label, null: false
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20231011100059_add_db_comments_to_order_promotions.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+class AddDbCommentsToOrderPromotions < ActiveRecord::Migration[6.1]
+  def up
+    if connection.supports_comments?
+      change_table_comment(:solidus_promotions_order_promotions, solidus_promotions_order_promotions_table_comment)
+      change_column_comment(:solidus_promotions_order_promotions, :order_id, order_id_comment)
+      change_column_comment(:solidus_promotions_order_promotions, :promotion_id, promotion_id_comment)
+      change_column_comment(:solidus_promotions_order_promotions, :promotion_code_id, promotion_code_id_comment)
+      change_column_comment(:solidus_promotions_order_promotions, :id, id_comment)
+      change_column_comment(:solidus_promotions_order_promotions, :created_at, created_at_comment)
+      change_column_comment(:solidus_promotions_order_promotions, :updated_at, updated_at_comment)
+    end
+  end
+
+  private
+
+  def solidus_promotions_order_promotions_table_comment
+    <<~COMMENT
+      Join table between spree_orders and solidus_promotions_promotions. One of two places that record whether a promotion is linked to an order.
+      The other place is the spree_adjustments table when the source of an adjustment is a SolidusPromotions::Benefit.
+      An entry here is created every time a promotion is explicitly linked to an order. No entry is created for automatic promotions.
+    COMMENT
+  end
+
+  def order_id_comment
+    <<~COMMENT
+      Foreign key to the spree_orders table.
+    COMMENT
+  end
+
+  def promotion_id_comment
+    <<~COMMENT
+      Foreign key to the solidus_promotions_promotions table.
+    COMMENT
+  end
+
+  def promotion_code_id_comment
+    <<~COMMENT
+      Foreign key to the solidus_promotions_promotion_codes table. If a promotion code was used, records the promotion code.
+    COMMENT
+  end
+
+  def id_comment
+    <<~COMMENT
+      Primary key of this 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/20231011120928_add_db_comments_to_condition_taxons.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+class AddDbCommentsToConditionTaxons < ActiveRecord::Migration[6.1]
+  def up
+    if connection.supports_comments?
+      change_table_comment(:solidus_promotions_condition_taxons, solidus_promotions_condition_taxons_table_comment)
+      change_column_comment(:solidus_promotions_condition_taxons, :id, id_comment)
+      change_column_comment(:solidus_promotions_condition_taxons, :taxon_id, taxon_id_comment)
+      change_column_comment(:solidus_promotions_condition_taxons, :condition_id, condition_id_comment)
+      change_column_comment(:solidus_promotions_condition_taxons, :created_at, created_at_comment)
+      change_column_comment(:solidus_promotions_condition_taxons, :updated_at, updated_at_comment)
+    end
+  end
+
+  private
+
+  def solidus_promotions_condition_taxons_table_comment
+    <<~COMMENT
+      Join table between promotion conditions and taxons. Only used if the promotion rule's type is SolidusPromotions::Conditions::Taxon or
+      SolidusPromotions::Conditions::LineItemTaxon. Represents those taxons that the promotion rule matches on using its any/all/none
+      or include/exclude match policy.
+    COMMENT
+  end
+
+  def id_comment
+    <<~COMMENT
+      Primary key of this table.
+    COMMENT
+  end
+
+  def taxon_id_comment
+    <<~COMMENT
+      Foreign key to the spree_taxons 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/20231011131324_add_db_comments_to_conditions.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+class AddDbCommentsToConditions < ActiveRecord::Migration[6.1]
+  def up
+    if connection.supports_comments?
+      change_table_comment(:solidus_promotions_conditions, solidus_promotions_conditions_table_comment)
+      change_column_comment(:solidus_promotions_conditions, :id, id_comment)
+      change_column_comment(:solidus_promotions_conditions, :benefit_id, benefit_id_comment)
+      change_column_comment(:solidus_promotions_conditions, :type, type_comment)
+      change_column_comment(:solidus_promotions_conditions, :created_at, created_at_comment)
+      change_column_comment(:solidus_promotions_conditions, :updated_at, updated_at_comment)
+      change_column_comment(:solidus_promotions_conditions, :preferences, preferences_comment)
+    end
+  end
+
+  private
+
+  def solidus_promotions_conditions_table_comment
+    <<~COMMENT
+      Represents promotion conditions. A benefit may have many conditions, which determine whether the benefit is eligible.
+      All rules must be eligible for the benefit to be eligible. If there are no rules, the benefit is always eligible.
+    COMMENT
+  end
+
+  def id_comment
+    <<~COMMENT
+      Primary key of this table.
+    COMMENT
+  end
+
+  def benefit_id_comment
+    <<~COMMENT
+      Foreign key to the benefits table.
+    COMMENT
+  end
+
+  def type_comment
+    <<~COMMENT
+      STI column. This represents which Ruby class to load when an entry of this table is loaded in Rails.
+    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
+
+  def preferences_comment
+    <<~COMMENT
+      Preferences for this condition. Serialized YAML column with preferences for this condition.
+    COMMENT
+  end
+end

data/db/migrate/20231011142040_add_db_comments_to_condition_users.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+class AddDbCommentsToConditionUsers < ActiveRecord::Migration[6.1]
+  def up
+    if connection.supports_comments?
+      change_table_comment(:solidus_promotions_condition_users, solidus_promotions_condition_users_table_comment)
+      change_column_comment(:solidus_promotions_condition_users, :user_id, user_id_comment)
+      change_column_comment(:solidus_promotions_condition_users, :condition_id, condition_id_comment)
+      change_column_comment(:solidus_promotions_condition_users, :id, id_comment)
+      change_column_comment(:solidus_promotions_condition_users, :created_at, created_at_comment)
+      change_column_comment(:solidus_promotions_condition_users, :updated_at, updated_at_comment)
+    end
+  end
+
+  private
+
+  def solidus_promotions_condition_users_table_comment
+    <<~COMMENT
+      Join table between conditions and users. Used with conditions of type "SolidusPromotions::Conditions::User".
+      An entry here indicates that a promotion is eligible for the user ID specified here.
+    COMMENT
+  end
+
+  def user_id_comment
+    <<~COMMENT
+      Foreign key to the users table.
+    COMMENT
+  end
+
+  def condition_id_comment
+    <<~COMMENT
+      Foreign key to the conditions table.
+    COMMENT
+  end
+
+  def id_comment
+    <<~COMMENT
+      Primary key of this 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/20231011155822_add_db_comments_to_promotions.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+class AddDbCommentsToPromotions < ActiveRecord::Migration[6.1]
+  def up
+    if connection.supports_comments?
+      change_table_comment(:solidus_promotions_promotions, solidus_promotions_promotions_table_comment)
+      change_column_comment(:solidus_promotions_promotions, :id, id_comment)
+      change_column_comment(:solidus_promotions_promotions, :description, description_comment)
+      change_column_comment(:solidus_promotions_promotions, :expires_at, expires_at_comment)
+      change_column_comment(:solidus_promotions_promotions, :starts_at, starts_at_comment)
+      change_column_comment(:solidus_promotions_promotions, :customer_label, customer_label_comment)
+      change_column_comment(:solidus_promotions_promotions, :usage_limit, usage_limit_comment)
+      change_column_comment(:solidus_promotions_promotions, :advertise, advertise_comment)
+      change_column_comment(:solidus_promotions_promotions, :path, path_comment)
+      change_column_comment(:solidus_promotions_promotions, :lane, lane_comment)
+      change_column_comment(:solidus_promotions_promotions, :name, name_comment)
+      change_column_comment(:solidus_promotions_promotions, :created_at, created_at_comment)
+      change_column_comment(:solidus_promotions_promotions, :updated_at, updated_at_comment)
+      change_column_comment(:solidus_promotions_promotions, :promotion_category_id, promotion_category_id_comment)
+      change_column_comment(:solidus_promotions_promotions, :per_code_usage_limit, per_code_usage_limit_comment)
+      change_column_comment(:solidus_promotions_promotions, :apply_automatically, apply_automatically_comment)
+    end
+  end
+
+  private
+
+  def solidus_promotions_promotions_table_comment
+    <<~COMMENT
+      Promotions are sets of rules and actions to discount (parts of) an order.
+    COMMENT
+  end
+
+  def id_comment
+    <<~COMMENT
+      Primary key of this table.
+    COMMENT
+  end
+
+  def description_comment
+    <<~COMMENT
+      The description of this promotion.
+    COMMENT
+  end
+
+  def expires_at_comment
+    <<~COMMENT
+      Timestamp at which the promotion stops being eligible.
+    COMMENT
+  end
+
+  def starts_at_comment
+    <<~COMMENT
+      Timestamp at which the promotion starts being eligible.
+    COMMENT
+  end
+
+  def customer_label_comment
+    <<~COMMENT
+      The contents of this field will be replicated in the labels of adjustments created with it.
+    COMMENT
+  end
+
+  def name_comment
+    <<~COMMENT
+      Admin name of the promotion.
+    COMMENT
+  end
+
+  def usage_limit_comment
+    <<~COMMENT
+      How many times this promotion can be applied to orders globally.
+    COMMENT
+  end
+
+  def advertise_comment
+    <<~COMMENT
+      Marks a promotion as advertised.
+    COMMENT
+  end
+
+  def path_comment
+    <<~COMMENT
+      This could be used for applying a promotion based on a route the customer visits.
+    COMMENT
+  end
+
+  def lane_comment
+    <<~COMMENT
+      Priority lane of this promotion.
+    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
+
+  def promotion_category_id_comment
+    <<~COMMENT
+      Foreign key to the solidus_promotions_promotion_categories table.
+    COMMENT
+  end
+
+  def per_code_usage_limit_comment
+    <<~COMMENT
+      How many times this promotion can be used per promotion code.
+    COMMENT
+  end
+
+  def apply_automatically_comment
+    <<~COMMENT
+      Whether this promotion applies automatically in the cart, as opposed to the promotion being activated through a promotion code
+      or a path (see above).
+    COMMENT
+  end
+end

data/db/migrate/20231011163030_add_db_comments_to_promotion_codes.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+class AddDbCommentsToPromotionCodes < ActiveRecord::Migration[6.1]
+  def up
+    if connection.supports_comments?
+      change_table_comment(:solidus_promotions_promotion_codes, solidus_promotions_promotion_codes_table_comment)
+      change_column_comment(:solidus_promotions_promotion_codes, :id, id_comment)
+      change_column_comment(:solidus_promotions_promotion_codes, :promotion_id, promotion_id_comment)
+      change_column_comment(:solidus_promotions_promotion_codes, :value, value_comment)
+      change_column_comment(:solidus_promotions_promotion_codes, :created_at, created_at_comment)
+      change_column_comment(:solidus_promotions_promotion_codes, :updated_at, updated_at_comment)
+      change_column_comment(:solidus_promotions_promotion_codes, :promotion_code_batch_id, promotion_code_batch_id_comment)
+    end
+  end
+
+  private
+
+  def solidus_promotions_promotion_codes_table_comment
+    <<~COMMENT
+      Promotions can have many promotion codes. This table is a collection of those codes.
+    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 value_comment
+    <<~COMMENT
+      The actual code, such as "BOATLIFE" for example.
+    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
+
+  def promotion_code_batch_id_comment
+    <<~COMMENT
+      Foreign key to the solidus_promotions_promotion_code_batches table.
+      If this promotion code was created using a promotion code batch, links to the batch.
+    COMMENT
+  end
+end

data/db/migrate/20231011173312_add_db_comments_to_promotion_code_batches.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+class AddDbCommentsToPromotionCodeBatches < ActiveRecord::Migration[6.1]
+  def up
+    if connection.supports_comments?
+      change_table_comment(:solidus_promotions_promotion_code_batches, solidus_promotions_promotion_code_batches_table_comment)
+      change_column_comment(:solidus_promotions_promotion_code_batches, :id, id_comment)
+      change_column_comment(:solidus_promotions_promotion_code_batches, :promotion_id, promotion_id_comment)
+      change_column_comment(:solidus_promotions_promotion_code_batches, :base_code, base_code_comment)
+      change_column_comment(:solidus_promotions_promotion_code_batches, :number_of_codes, number_of_codes_comment)
+      change_column_comment(:solidus_promotions_promotion_code_batches, :email, email_comment)
+      change_column_comment(:solidus_promotions_promotion_code_batches, :error, error_comment)
+      change_column_comment(:solidus_promotions_promotion_code_batches, :state, state_comment)
+      change_column_comment(:solidus_promotions_promotion_code_batches, :created_at, created_at_comment)
+      change_column_comment(:solidus_promotions_promotion_code_batches, :updated_at, updated_at_comment)
+      change_column_comment(:solidus_promotions_promotion_code_batches, :join_characters, join_characters_comment)
+    end
+  end
+
+  private
+
+  def solidus_promotions_promotion_code_batches_table_comment
+    <<~COMMENT
+      We allow creating a large number of promotion codes automatically through a background job. This table collects the input
+      for creating such a batch of promotion codes.
+    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 base_code_comment
+    <<~COMMENT
+      The base code of this promotion code batch, such as "BOATLIFE".
+    COMMENT
+  end
+
+  def number_of_codes_comment
+    <<~COMMENT
+      How many codes should be generated.
+    COMMENT
+  end
+
+  def email_comment
+    <<~COMMENT
+      After the batch has been created, or in the event of an error, notify this email address.
+    COMMENT
+  end
+
+  def error_comment
+    <<~COMMENT
+      Error that has occurred during batch processing, if any.
+    COMMENT
+  end
+
+  def state_comment
+    <<~COMMENT
+      What the state of the promotion code batch is:
+      - pending
+      - processing
+      - completed
+    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
+
+  def join_characters_comment
+    <<~COMMENT
+      What characters to use for joining the base code with the individual extension, such as "_" for creating "BOATLIFE_S3CR3T".
+    COMMENT
+  end
+end