Merge pull request #2944 from DMPRoadmap/bug_template_customization

bug fix: customization upgrade #2898

Author: raycarrick-ed

app/services/template/upgrade_customization_service.rb

@@ -3,23 +3,23 @@
 class Template
 
   # Service object to upgrade a customization Template with new changes from the original
-  # funder Template. Remember: {target_template} is a customization of funder Template.
+  # funder Template. Remember: {updated_template} is a customization of funder Template.
   #
-  # - Duplicate the init template (Duplication called {#customized_template})
+  # - Duplicate the init template (Duplication called {#@copy_of_original_customizations})
   #
   # - Create a new customisation of funder template (Customization called
-  #   {#target_template})
+  #   {#updated_template})
   #
-  # - Take each phase on the {#target_template} and iterate to find if there's a
-  #   corresponding one in {#customized_template}
+  # - Take each phase on the {#updated_template} and iterate to find if there's a
+  #   corresponding one in {#@copy_of_original_customizations}
   #   - Test for each of  corresponding phase in source
   #   - Copy over each of the modifiable sections from source to the target
   #     - Re-number the sections if necessary to keep the display order (number) the same
   #     - Copy each of the questions and annotations exactly
   #   - For each unmodifiable section, copy over any modifiable questions from target
   #
-  # - Copy each of the modifiable sections from the {#customized_template} to the
-  #   {#target_template}
+  # - Copy each of the modifiable sections from the {#@copy_of_original_customizations} to the
+  #   {#updated_template}
   #
   class UpgradeCustomizationService
 
@@ -31,12 +31,6 @@ class NotACustomizationError < StandardError
     class NoFunderTemplateError < StandardError
     end
 
-    ##
-    # The Template we're upgrading
-    #
-    # Returns {Template}
-    attr_reader :init_template
-
     # Initialize a new instance and run the script
     #
     # template - The Template we're upgrading
@@ -50,83 +44,72 @@ def self.call(template)
 
     # Initialize a new record
     #
-    # template - The Template we're upgrading. Sets the value for {#init_template}
+    # template - The Template we're upgrading.
     #
     def initialize(template)
-      @init_template = template
+      @source_template = template
+
+      @original_funder_template = Template.published(@source_template.customization_of).first
+
+      @copy_of_original_customizations = @source_template.deep_copy(
+        attributes: { version: @source_template.version + 1, published: false }
+      )
+
+      @updated_template = init_updated_template
     end
 
     # Run the script
     #
     # Returns {Template}
     def call
       Template.transaction do
-        if init_template.customization_of.blank?
+        if @source_template.customization_of.blank?
           raise NotACustomizationError,
                 _("upgrade_customization! requires a customised template")
         end
-        if funder_template.nil?
+        if @original_funder_template.nil?
           # rubocop:disable Layout/LineLength
           raise NoFunderTemplateError,
                 _("upgrade cannot be carried out since there is no published template of its current funder")
           # rubocop:enable Layout/LineLength
         end
 
-        # Merges modifiable sections or questions from source into target_template object
-        target_template.phases.map do |funder_phase|
+        # Merges modifiable sections or questions from source into updated_template object
+        @updated_template.phases.map do |funder_phase|
           # Search for the phase in the source template whose versionable_id matches the
           # customization_phase
           customized_phase = find_matching_record_in_collection(
             record: funder_phase,
-            collection: customized_template.phases
+            collection: @copy_of_original_customizations.phases
           )
-          # a) If the Org's template ({#customized_template}) has the Phase...
+          # a) If the Org's template ({@copy_of_original_customizations}) has the Phase...
           next unless customized_phase.present?
 
-          # b) If the Org's template ({#customized_template}) doesn't have this Phase.
-          #    This is not a problem, since {#customization_template} should have this
+          # b) If the Org's template ({@copy_of_original_customizations}) doesn't have this Phase.
+          #    This is not a problem, since {@copy_of_original_customizations} should have this
           #    Phase copied over from {#template_phase}.
           copy_modifiable_sections_for_phase(customized_phase, funder_phase)
           sort_sections_within_phase(funder_phase)
         end
         copy_custom_annotations_for_questions
       end
-      target_template
+      @updated_template
     end
 
     private
 
-    # The funder Template for this {#template}
-    #
-    # Returns Template
-    def funder_template
-      @funder_template ||= Template.published(init_template.customization_of).first
-    end
-
-    # A copy of the Template we're currently upgrading. Preserves modifiable flags from
-    # the self template copied
-    #
-    #
-    # Returns {Template}
-    def customized_template
-      @customized_template ||= init_template.deep_copy(attributes: {
-                                                         version: init_template.version + 1,
-                                                         published: false
-                                                       })
-    end
-
     # Creates a new customisation for the published template whose family_id {#template}
     # is a customization of
     #
     # Returns {Template}
-    def target_template
-      @target_template ||= funder_template.deep_copy(
+    def init_updated_template
+      @updated_template = @original_funder_template&.deep_copy(
         attributes: {
-          version: customized_template.version,
-          published: customized_template.published,
-          family_id: customized_template.family_id,
-          customization_of: customized_template.customization_of,
-          org: customized_template.org,
+          version: @copy_of_original_customizations.version,
+          published: @copy_of_original_customizations.published,
+          family_id: @copy_of_original_customizations.family_id,
+          customization_of: @copy_of_original_customizations.customization_of,
+          org: @copy_of_original_customizations.org,
           visibility: Template.visibilities[:organisationally_visible],
           is_default: false
         }, modifiable: false, save: true
@@ -162,8 +145,8 @@ def copy_modifiable_sections_for_phase(source_phase, target_phase)
     end
 
     def copy_custom_annotations_for_questions
-      init_template.annotations.where(org: template_org).each do |custom_annotation|
-        target_question = target_template.questions.find_by(
+      @source_template.annotations.where(org: template_org).each do |custom_annotation|
+        target_question = @updated_template.questions.find_by(
           versionable_id: custom_annotation.question.versionable_id
         )
         target_question.annotations << custom_annotation if target_question.present?
@@ -175,7 +158,7 @@ def sort_sections_within_phase(phase)
     end
 
     def template_org
-      init_template.org
+      @source_template.org
     end
 
   end