solidus_friendly_promotions 1.0.0.pre

data/db/migrate/20231011100059_add_db_comments_to_friendly_order_promotions.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+class AddDbCommentsToFriendlyOrderPromotions < ActiveRecord::Migration[6.1]
+  def up
+    if connection.supports_comments?
+      change_table_comment(:friendly_order_promotions, friendly_order_promotions_table_comment)
+      change_column_comment(:friendly_order_promotions, :order_id, order_id_comment)
+      change_column_comment(:friendly_order_promotions, :promotion_id, promotion_id_comment)
+      change_column_comment(:friendly_order_promotions, :promotion_code_id, promotion_code_id_comment)
+      change_column_comment(:friendly_order_promotions, :id, id_comment)
+      change_column_comment(:friendly_order_promotions, :created_at, created_at_comment)
+      change_column_comment(:friendly_order_promotions, :updated_at, updated_at_comment)
+    end
+  end
+
+  private
+
+  def friendly_order_promotions_table_comment
+    <<~COMMENT
+      Join table between spree_orders and friendly_promotions. One of two places that record whether a promotion is linked to an order.
+      The other place is the spree_adjustments table which records promotion code IDs and could be both eligible and ineligible.
+      An entry here is created every time a promotion is linked to an order.
+    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 friendly_promotions table.
+    COMMENT
+  end
+
+  def promotion_code_id_comment
+    <<~COMMENT
+      Foreign key to the friendly_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_friendly_promotion_rules_taxons.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+class AddDbCommentsToFriendlyPromotionRulesTaxons < ActiveRecord::Migration[6.1]
+  def up
+    if connection.supports_comments?
+      change_table_comment(:friendly_promotion_rules_taxons, friendly_promotion_rules_taxons_table_comment)
+      change_column_comment(:friendly_promotion_rules_taxons, :id, id_comment)
+      change_column_comment(:friendly_promotion_rules_taxons, :taxon_id, taxon_id_comment)
+      change_column_comment(:friendly_promotion_rules_taxons, :promotion_rule_id, promotion_rule_id_comment)
+      change_column_comment(:friendly_promotion_rules_taxons, :created_at, created_at_comment)
+      change_column_comment(:friendly_promotion_rules_taxons, :updated_at, updated_at_comment)
+    end
+  end
+
+  private
+
+  def friendly_promotion_rules_taxons_table_comment
+    <<~COMMENT
+      Join table between promotion rules and taxons. Only used if the promotion rule's type is SolidusFriendlyPromotion::Rules::Taxon or
+      SolidusFriendlyPromotion::Rules::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 taxons table.
+    COMMENT
+  end
+
+  def promotion_rule_id_comment
+    <<~COMMENT
+      Foreign key to the friendly_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/20231011131324_add_db_comments_to_friendly_promotion_rules.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+class AddDbCommentsToFriendlyPromotionRules < ActiveRecord::Migration[6.1]
+  def up
+    if connection.supports_comments?
+      change_table_comment(:friendly_promotion_rules, friendly_promotion_rules_table_comment)
+      change_column_comment(:friendly_promotion_rules, :id, id_comment)
+      change_column_comment(:friendly_promotion_rules, :promotion_id, promotion_id_comment)
+      change_column_comment(:friendly_promotion_rules, :type, type_comment)
+      change_column_comment(:friendly_promotion_rules, :created_at, created_at_comment)
+      change_column_comment(:friendly_promotion_rules, :updated_at, updated_at_comment)
+      change_column_comment(:friendly_promotion_rules, :preferences, preferences_comment)
+    end
+  end
+
+  private
+
+  def friendly_promotion_rules_table_comment
+    <<~COMMENT
+      Represents promotion rules. A promotion may have many rules, which determine whether the promotion is eligible.
+      All rules must be eligible for the promotion to be eligible. If there are no rules, the promotion is always eligible.
+    COMMENT
+  end
+
+  def id_comment
+    <<~COMMENT
+      Primary key of this table.
+    COMMENT
+  end
+
+  def promotion_id_comment
+    <<~COMMENT
+      Foreign key to the promotions 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 promotion rule. Serialized YAML column with preferences for this promotion rule.
+    COMMENT
+  end
+end

data/db/migrate/20231011142040_add_db_comments_to_friendly_promotion_rules_users.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+class AddDbCommentsToFriendlyPromotionRulesUsers < ActiveRecord::Migration[6.1]
+  def up
+    if connection.supports_comments?
+      change_table_comment(:friendly_promotion_rules_users, friendly_promotion_rules_users_table_comment)
+      change_column_comment(:friendly_promotion_rules_users, :user_id, user_id_comment)
+      change_column_comment(:friendly_promotion_rules_users, :promotion_rule_id, promotion_rule_id_comment)
+      change_column_comment(:friendly_promotion_rules_users, :id, id_comment)
+      change_column_comment(:friendly_promotion_rules_users, :created_at, created_at_comment)
+      change_column_comment(:friendly_promotion_rules_users, :updated_at, updated_at_comment)
+    end
+  end
+
+  private
+
+  def friendly_promotion_rules_users_table_comment
+    <<~COMMENT
+      Join table between promotion rules and users. Used with promotion rules of type "SolidusFriendlyPromotions::Rules::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 promotion_rule_id_comment
+    <<~COMMENT
+      Foreign key to the promotion_rules 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/20231011154553_allow_null_promotion_ids.rb

@@ -0,0 +1,9 @@
+class AllowNullPromotionIds < ActiveRecord::Migration[7.0]
+  def up
+    change_column_null :friendly_promotion_actions, :promotion_id, true
+  end
+
+  def down
+    change_column_null :friendly_promotion_actions, :promotion_id, false
+  end
+end

data/db/migrate/20231011155822_add_db_comments_to_friendly_promotions.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+class AddDbCommentsToFriendlyPromotions < ActiveRecord::Migration[6.1]
+  def up
+    if connection.supports_comments?
+      change_table_comment(:friendly_promotions, friendly_promotions_table_comment)
+      change_column_comment(:friendly_promotions, :id, id_comment)
+      change_column_comment(:friendly_promotions, :description, description_comment)
+      change_column_comment(:friendly_promotions, :expires_at, expires_at_comment)
+      change_column_comment(:friendly_promotions, :starts_at, starts_at_comment)
+      change_column_comment(:friendly_promotions, :customer_label, customer_label_comment)
+      change_column_comment(:friendly_promotions, :usage_limit, usage_limit_comment)
+      change_column_comment(:friendly_promotions, :advertise, advertise_comment)
+      change_column_comment(:friendly_promotions, :path, path_comment)
+      change_column_comment(:friendly_promotions, :lane, lane_comment)
+      change_column_comment(:friendly_promotions, :name, name_comment)
+      change_column_comment(:friendly_promotions, :created_at, created_at_comment)
+      change_column_comment(:friendly_promotions, :updated_at, updated_at_comment)
+      change_column_comment(:friendly_promotions, :promotion_category_id, promotion_category_id_comment)
+      change_column_comment(:friendly_promotions, :per_code_usage_limit, per_code_usage_limit_comment)
+      change_column_comment(:friendly_promotions, :apply_automatically, apply_automatically_comment)
+    end
+  end
+
+  private
+
+  def friendly_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 friendly_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_friendly_promotion_codes.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+class AddDbCommentsToFriendlyPromotionCodes < ActiveRecord::Migration[6.1]
+  def up
+    if connection.supports_comments?
+      change_table_comment(:friendly_promotion_codes, friendly_promotion_codes_table_comment)
+      change_column_comment(:friendly_promotion_codes, :id, id_comment)
+      change_column_comment(:friendly_promotion_codes, :promotion_id, promotion_id_comment)
+      change_column_comment(:friendly_promotion_codes, :value, value_comment)
+      change_column_comment(:friendly_promotion_codes, :created_at, created_at_comment)
+      change_column_comment(:friendly_promotion_codes, :updated_at, updated_at_comment)
+      change_column_comment(:friendly_promotion_codes, :promotion_code_batch_id, promotion_code_batch_id_comment)
+    end
+  end
+
+  private
+
+  def friendly_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 friendly_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 friendly_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_friendly_promotion_code_batches.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+class AddDbCommentsToFriendlyPromotionCodeBatches < ActiveRecord::Migration[6.1]
+  def up
+    if connection.supports_comments?
+      change_table_comment(:friendly_promotion_code_batches, friendly_promotion_code_batches_table_comment)
+      change_column_comment(:friendly_promotion_code_batches, :id, id_comment)
+      change_column_comment(:friendly_promotion_code_batches, :promotion_id, promotion_id_comment)
+      change_column_comment(:friendly_promotion_code_batches, :base_code, base_code_comment)
+      change_column_comment(:friendly_promotion_code_batches, :number_of_codes, number_of_codes_comment)
+      change_column_comment(:friendly_promotion_code_batches, :email, email_comment)
+      change_column_comment(:friendly_promotion_code_batches, :error, error_comment)
+      change_column_comment(:friendly_promotion_code_batches, :state, state_comment)
+      change_column_comment(:friendly_promotion_code_batches, :created_at, created_at_comment)
+      change_column_comment(:friendly_promotion_code_batches, :updated_at, updated_at_comment)
+      change_column_comment(:friendly_promotion_code_batches, :join_characters, join_characters_comment)
+    end
+  end
+
+  private
+
+  def friendly_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 friendly_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

data/db/migrate/20231011184205_add_db_comments_to_friendly_promotion_rules_stores.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+class AddDbCommentsToFriendlyPromotionRulesStores < ActiveRecord::Migration[6.1]
+  def up
+    if connection.supports_comments?
+      change_table_comment(:friendly_promotion_rules_stores, friendly_promotion_rules_stores_table_comment)
+      change_column_comment(:friendly_promotion_rules_stores, :id, id_comment)
+      change_column_comment(:friendly_promotion_rules_stores, :store_id, store_id_comment)
+      change_column_comment(:friendly_promotion_rules_stores, :promotion_rule_id, promotion_rule_id_comment)
+      change_column_comment(:friendly_promotion_rules_stores, :created_at, created_at_comment)
+      change_column_comment(:friendly_promotion_rules_stores, :updated_at, updated_at_comment)
+    end
+  end
+
+  private
+
+  def friendly_promotion_rules_stores_table_comment
+    <<~COMMENT
+      Join table between promotion rules and stores. Only used with the promotion rule "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 promotion_rule_id_comment
+    <<~COMMENT
+      Foreign key to the friendly_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_friendly_promotion_actions.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+class AddDbCommentsToFriendlyPromotionActions < ActiveRecord::Migration[6.1]
+  def up
+    if connection.supports_comments?
+      change_table_comment(:friendly_promotion_actions, friendly_promotion_actions_table_comment)
+      change_column_comment(:friendly_promotion_actions, :id, id_comment)
+      change_column_comment(:friendly_promotion_actions, :promotion_id, promotion_id_comment)
+      change_column_comment(:friendly_promotion_actions, :type, type_comment)
+      change_column_comment(:friendly_promotion_actions, :deleted_at, deleted_at_comment)
+      change_column_comment(:friendly_promotion_actions, :preferences, preferences_comment)
+      change_column_comment(:friendly_promotion_actions, :created_at, created_at_comment)
+      change_column_comment(:friendly_promotion_actions, :updated_at, updated_at_comment)
+    end
+  end
+
+  private
+
+  def friendly_promotion_actions_table_comment
+    <<~COMMENT
+      Single Table inheritance table. Represents what to do to an order when the linked promotion is eligible.
+      Promotions can have many promotion actions.
+    COMMENT
+  end
+
+  def id_comment
+    <<~COMMENT
+      Primary key of this table.
+    COMMENT
+  end
+
+  def promotion_id_comment
+    <<~COMMENT
+      Foreign key to the friendly_promotions table.
+    COMMENT
+  end
+
+  def type_comment
+    <<~COMMENT
+      A class name representing which promotion action this represents.
+      Usually SolidusFriendlyPromotions::Actions::Adjust{LineItem,Shipment}.
+    COMMENT
+  end
+
+  def deleted_at_comment
+    <<~COMMENT
+      Timestamp indicating if and when this record was soft-deleted.
+    COMMENT
+  end
+
+  def preferences_comment
+    <<~COMMENT
+      Preferences for this promotion action. 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_friendly_products_promotion_rules.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+class AddDbCommentsToFriendlyProductsPromotionRules < ActiveRecord::Migration[6.1]
+  def up
+    if connection.supports_comments?
+      change_table_comment(:friendly_products_promotion_rules, friendly_products_promotion_rules_table_comment)
+      change_column_comment(:friendly_products_promotion_rules, :id, id_comment)
+      change_column_comment(:friendly_products_promotion_rules, :product_id, product_id_comment)
+      change_column_comment(:friendly_products_promotion_rules, :promotion_rule_id, promotion_rule_id_comment)
+      change_column_comment(:friendly_products_promotion_rules, :created_at, created_at_comment)
+      change_column_comment(:friendly_products_promotion_rules, :updated_at, updated_at_comment)
+    end
+  end
+
+  private
+
+  def friendly_products_promotion_rules_table_comment
+    <<~COMMENT
+      Join table between promotion rules 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 promotion_rule_id_comment
+    <<~COMMENT
+      Foreign key to the friendly_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