Merge pull request #5240 from opf/fix/custom_options_migration_rollback

Fix: custom options migration rollback

db/migrate/20170116105342_add_custom_options.rb

@@ -30,12 +30,17 @@
 ##
 # Adds a table for storing possible values (options) for custom fields.
 # If a custom field has no possible values then arbitrary values
-# are allowed which may be further restriced by other means other
+# are allowed which may be further restriced by other means other than
 # specific values.
 class AddCustomOptions < ActiveRecord::Migration[5.0]
-  class OldTranslationModel < ActiveRecord::Base
-    self.table_name = :custom_field_translations
+  class OldCustomField < ActiveRecord::Base
+    self.table_name = :custom_fields
+    self.inheritance_column = nil
 
+    translates :name, :default_value, :possible_values
+  end
+
+  class OldCustomField::Translation
     serialize :possible_values, Array
   end
 
@@ -60,8 +65,23 @@ class AddCustomOptions < ActiveRecord::Migration[5.0]
     remove_column :custom_field_translations, :possible_values # replaced by custom options
   end
 
+  ##
+  # Dropping the translations for custom field default values and possible values is irreversible.
+  # We can just create one default translation.
   def down
-    drop_table table_name
+    CustomOption.transaction do
+      add_column :custom_field_translations, :default_value, :text
+      add_column :custom_field_translations, :possible_values, :text
+
+      rollback_custom_fields!
+      rollback_values!
+      rollback_journals!
+
+      remove_column :custom_fields, :multi_value
+      remove_column :custom_fields, :default_value
+
+      drop_table table_name
+    end
   end
 
   def migrate_data!
@@ -81,7 +101,7 @@ class AddCustomOptions < ActiveRecord::Migration[5.0]
   end
 
   def get_translations(custom_field)
-    OldTranslationModel
+    OldCustomField::Translation
       .where(custom_field_id: custom_field.id)
       .order(id: :asc)
   end
@@ -89,8 +109,15 @@ class AddCustomOptions < ActiveRecord::Migration[5.0]
   def create_custom_options_for_translations!(translations, custom_field)
     return if translations.empty?
 
-    translations.first.possible_values.each_with_index.map do |value, i|
-      custom_field.custom_options.create! value: value, position: i + 1
+    # we don't support translations anymore, assume first as canonical
+    translation = translations.first
+
+    translation.possible_values.each_with_index.map do |value, i|
+      custom_field.custom_options.create!(
+        value: value,
+        position: i + 1,
+        default_value: (value == translation.default_value)
+      )
     end
   end
 
@@ -118,9 +145,62 @@ class AddCustomOptions < ActiveRecord::Migration[5.0]
     end
   end
 
+  def rollback_custom_fields!
+    Globalize.with_locale(Setting.default_language.to_sym) do
+      rollback_list_custom_fields!
+      rollback_other_custom_fields!
+    end
+  end
+
+  def rollback_list_custom_fields!
+    OldCustomField.where(field_format: "list").each do |old_custom_field|
+      new_custom_field = CustomField.find old_custom_field.id
+
+      old_custom_field.default_value =
+        new_custom_field.custom_options.select(&:default_value?).map(&:value).first
+      old_custom_field.possible_values =
+        new_custom_field.custom_options.map(&:value)
+
+      old_custom_field.save
+    end
+  end
+
+  def rollback_other_custom_fields!
+    OldCustomField.where.not(field_format: "list").each do |old_custom_field|
+      new_custom_field = CustomField.find old_custom_field.id
+
+      old_custom_field.default_value = new_custom_field.default_value
+
+      old_custom_field.save
+    end
+  end
+
+  def rollback_values!
+    list_custom_fields.each do |custom_field|
+      CustomValue.where(custom_field: custom_field).each do |custom_value|
+        option_value = CustomOption.find_by(id: custom_value.value, custom_field_id: custom_field.id).try(:value)
+
+        if option_value
+          custom_value.value = option_value
+          custom_value.save(validate: false) # with the new code the validation will fail as an ID is expected
+        end
+      end
+    end
+  end
+
+  def rollback_journals!
+    list_custom_fields.each do |custom_field|
+      CustomizableJournal.where(custom_field: custom_field).each do |journal|
+        option_value = CustomOption.find_by(id: journal.value, custom_field_id: custom_field.id).try(:value)
+
+        journal.update! value: option_value if option_value
+      end
+    end
+  end
+
   def lookup_custom_option_id(value, custom_field_id)
     CustomOption
-      .where(value: value, id: custom_field_id)
+      .where(value: value, custom_field_id: custom_field_id)
       .order(id: :asc)
       .limit(1)
       .pluck(:id)

db/migrate/20170308120915_migrate_missed_list_custom_values.rb

@@ -0,0 +1,20 @@
+require_relative './20170116105342_add_custom_options'
+
+##
+# A bug in the AddCustomOptions migration was fixed because of which not
+# all list custom field values were migrated correctly.
+# The missed values can be simply migrated by calling the fixed code
+# which is all this migration does.
+class MigrateMissedListCustomValues < ActiveRecord::Migration[5.0]
+  def up
+    migration = AddCustomOptions.new
+
+    migration.migrate_values!
+    migration.migrate_journals!
+  end
+
+  def down
+    # No down migration is necessary as it wil be handled in the original
+    # AddCustomOptions migration.
+  end
+end