chore: Add comment about StaffingLoader also cloning enrollment data when it clones staffing data

app/lib/seeder.rb

@@ -19,17 +19,17 @@ class Seeder
     dese_ids = []
     schools = []
     CSV.parse(File.read(csv_file), headers: true) do |row|
-      district_name = row['District'].strip
+      district_name = row["District"].strip
       next if rules.any? do |rule|
                 rule.new(row:).skip_row?
               end
 
-      district_code = row['District Code'].try(:strip)
+      district_code = row["District Code"].try(:strip)
-      dese_id = row['DESE School ID'].strip
+      dese_id = row["DESE School ID"].strip
       dese_ids << dese_id
-      school_name = row['School Name'].strip
+      school_name = row["School Name"].strip
-      school_code = row['School Code'].try(:strip)
+      school_code = row["School Code"].try(:strip)
-      hs = row['HS?']
+      hs = row["HS?"]
 
       district = District.find_or_create_by! name: district_name
       district.slug = district_name.parameterize
@@ -52,60 +52,60 @@ class Seeder
   def seed_sqm_framework(csv_file)
     admin_data_item_ids = []
     CSV.parse(File.read(csv_file), headers: true) do |row|
-      category_id = row['Category ID'].strip
+      category_id = row["Category ID"].strip
       category = Category.find_or_create_by!(category_id:)
       category_slugs = {
-        '1' => 'teachers-and-leadership',
+        "1" => "teachers-and-leadership",
-        '2' => 'school-culture',
+        "2" => "school-culture",
-        '3' => 'resources',
+        "3" => "resources",
-        '4' => 'academic-learning',
+        "4" => "academic-learning",
-        '5' => 'community-and-wellbeing'
+        "5" => "community-and-wellbeing"
       }
-      category.update! name: row['Category'].strip, description: row['Category Description'].strip,
+      category.update! name: row["Category"].strip, description: row["Category Description"].strip,
-                       short_description: row['Category Short Description'], slug: category_slugs[category_id], sort_index: category_slugs.keys.index(category_id)
+                       short_description: row["Category Short Description"], slug: category_slugs[category_id], sort_index: category_slugs.keys.index(category_id)
 
-      subcategory_id = row['Subcategory ID'].strip
+      subcategory_id = row["Subcategory ID"].strip
       subcategory = Subcategory.find_or_create_by!(subcategory_id:, category:)
-      subcategory.update! name: row['Subcategory'].strip, description: row['Subcategory Description'].strip
+      subcategory.update! name: row["Subcategory"].strip, description: row["Subcategory Description"].strip
 
-      measure_id = row['Measure ID'].strip
+      measure_id = row["Measure ID"].strip
-      measure_name = row['Measures'].try(:strip)
+      measure_name = row["Measures"].try(:strip)
-      watch_low = row['Item Watch Low'].try(:strip)
+      watch_low = row["Item Watch Low"].try(:strip)
-      growth_low = row['Item Growth Low'].try(:strip)
+      growth_low = row["Item Growth Low"].try(:strip)
-      approval_low = row['Item Approval Low'].try(:strip)
+      approval_low = row["Item Approval Low"].try(:strip)
-      ideal_low = row['Item Ideal Low'].try(:strip)
+      ideal_low = row["Item Ideal Low"].try(:strip)
-      on_short_form = row['On Short Form?'].try(:strip)
+      on_short_form = row["On Short Form?"].try(:strip)
-      measure_description = row['Measure Description'].try(:strip)
+      measure_description = row["Measure Description"].try(:strip)
 
-      next if row['Source'] == 'No source'
+      next if row["Source"] == "No source"
 
       measure = Measure.find_or_create_by!(measure_id:, subcategory:)
       measure.name = measure_name
       measure.description = measure_description
       measure.save!
 
-      data_item_id = row['Survey Item ID'].strip
+      data_item_id = row["Survey Item ID"].strip
-      scale_id = data_item_id.split('-')[0..1].join('-')
+      scale_id = data_item_id.split("-")[0..1].join("-")
       scale = Scale.find_or_create_by!(scale_id:, measure:)
 
-      if %w[Teachers Students].include? row['Source']
+      if %w[Teachers Students].include? row["Source"]
         survey_item = SurveyItem.where(survey_item_id: data_item_id, scale:).first_or_create
         survey_item.watch_low_benchmark = watch_low if watch_low
         survey_item.growth_low_benchmark = growth_low if growth_low
         survey_item.approval_low_benchmark = approval_low if approval_low
         survey_item.ideal_low_benchmark = ideal_low if ideal_low
         survey_item.on_short_form = marked? on_short_form
-        survey_item.update! prompt: row['Question/item (22-23)'].strip
+        survey_item.update! prompt: row["Question/item (22-23)"].strip
       end
 
-      if row['Source'] == 'Admin Data' && row['Active admin & survey items'] == 'TRUE'
+      if row["Source"] == "Admin Data" && row["Active admin & survey items"] == "TRUE"
         admin_data_item = AdminDataItem.where(admin_data_item_id: data_item_id, scale:).first_or_create
         admin_data_item.watch_low_benchmark = watch_low if watch_low
         admin_data_item.growth_low_benchmark = growth_low if growth_low
         admin_data_item.approval_low_benchmark = approval_low if approval_low
         admin_data_item.ideal_low_benchmark = ideal_low if ideal_low
-        admin_data_item.description = row['Question/item (22-23)'].strip
+        admin_data_item.description = row["Question/item (22-23)"].strip
-        admin_data_item.hs_only_item = marked? row['HS only admin item?']
+        admin_data_item.hs_only_item = marked? row["HS only admin item?"]
         admin_data_item.save!
         admin_data_item_ids << admin_data_item.id
       end
@@ -128,16 +128,18 @@ class Seeder
     missing_staffing_for_current_year = Respondent.where(academic_year: AcademicYear.order(:range).last).none? do |respondent|
       respondent.total_teachers.present?
     end
+
+    # This will also clone previous year enrollment data
     StaffingLoader.clone_previous_year_data if missing_staffing_for_current_year
   end
 
   private
 
   def marked?(mark)
-    mark.present? ? mark.upcase.strip == 'X' : false
+    mark.present? ? mark.upcase.strip == "X" : false
   end
 
   def remove_commas(target)
-    target.delete(',') if target.present?
+    target.delete(",") if target.present?
   end
 end

app/services/staffing_loader.rb

@@ -15,6 +15,7 @@ class StaffingLoader
     Respondent.import respondents, batch_size: 1000, on_duplicate_key_update: [:total_teachers]
   end
 
+  # Clones staffing and enrollment data from previous year
   def self.clone_previous_year_data
     years = AcademicYear.order(:range).last(2)
     previous_year = years.first
@@ -66,3 +67,4 @@ class StaffingRowValues
     row['FTE Count']
   end
 end
+