Add logic for dependent pick lists

Author: alexdunae

README.md

@@ -37,14 +37,13 @@ options = {
   # multiple rows
   "data_sources" => {
     "food_types" => %w[Polenta Paella Papaya],
+    "countries" => {"Canada"=>["Sxwōxwiyám", "Toronto"], "Türkiye"=>["Eskişehir", "İzmir", "İstanbul"]}
   },
   "validations" => {
     "favourite_food" => SpreadsheetExporter::ColumnValidation.new(
-      attribute_name: "favourite_food",
       data_source: "food_types"
     ),
     "yuckiest_food" => SpreadsheetExporter::ColumnValidation.new(
-      attribute_name: "yuckiest_food",
       data_source: "food_types"
     )
   }

lib/spreadsheet_exporter/column_validation.rb

@@ -1,5 +1,5 @@
 module SpreadsheetExporter
-  ColumnValidation = Struct.new(:attribute_name, :ignore_blank, :data_source, :indirect_built_from, :error_type, keyword_init: true) do
+  ColumnValidation = Struct.new(:ignore_blank, :data_source, :indirect_built_from, :error_type, keyword_init: true) do
     def initialize(*)
       super
       self.ignore_blank = true if ignore_blank.nil?

lib/spreadsheet_exporter/spreadsheet.rb

@@ -7,8 +7,15 @@ def self.from_objects(objects, options = {})
 
       # Get all the data and accumulate headers from each row (since rows may not have all the same attributes)
       Array(objects).each do |object|
-        data = object.respond_to?(:as_csv) ? get_values(object.as_csv(options)) : get_values(object.as_json(options))
-        headers = headers | data.keys
+        data = if object.respond_to?(:as_spreadsheet)
+          get_values(object.as_spreadsheet(options))
+        elsif object.respond_to?(:as_csv)
+          get_values(object.as_csv(options))
+        else
+          get_values(object.as_json(options))
+        end
+
+        headers |= data.keys
         rows << data
       end
 

lib/spreadsheet_exporter/xlsx.rb

@@ -37,6 +37,7 @@ def self.from_spreadsheet(spreadsheet, options = {})
       end
 
       data_sources = add_data_sources(workbook, header_format, options)
+      pp data_sources
       add_worksheet_validation(workbook, worksheet, column_indexes, data_sources, header_format, options)
 
       workbook.worksheets.each do |ws|
@@ -47,6 +48,10 @@ def self.from_spreadsheet(spreadsheet, options = {})
       io.string
     end
 
+    def self.sanitize_defined_name(raw)
+      raw.gsub(/^[A-Za-z_]/, "_")
+    end
+
     def self.add_data_sources(workbook, header_format, options = {})
       data_sources = options.fetch("data_sources", {}) || {}
       return {} if data_sources.empty?
@@ -57,8 +62,19 @@ def self.add_data_sources(workbook, header_format, options = {})
 
       data_source_refs = {}
 
-      data_sources.each_with_index do |(data_key, data_values), column_index|
-        data_source_refs[data_key] = add_data_source(workbook, data_sheet, data_key, data_values, column_index, header_format)
+      column_index = 0
+      data_sources.each do |data_key, data_values|
+        if data_values.is_a?(Hash)
+          # nested, conditional data structure
+          data_values.each do |data_value, sub_values|
+            sub_key = sanitize_defined_name("#{data_key}_#{data_value}")
+            data_source_refs[sub_key] = add_data_source(workbook, data_sheet, sub_key, sub_values, column_index, header_format)
+            column_index += 1
+          end
+        else
+          data_source_refs[data_key] = add_data_source(workbook, data_sheet, data_key, data_values, column_index, header_format)
+          column_index += 1
+        end
       end
 
       data_source_refs
@@ -68,15 +84,18 @@ def self.add_data_sources(workbook, header_format, options = {})
     #
     # Returnd the named range's name
     def self.add_data_source(workbook, data_sheet, data_key, data_values, column_index, header_format)
-      raise ArgumentError unless data_values.is_a?(Array)
+      unless data_values.is_a?(Array)
+        debugger
+        raise ArgumentError, "data_values should be an array (got #{data_values.inspect}"
+      end
 
       data_start = xl_rowcol_to_cell(1, column_index, true, true)
       data_end = xl_rowcol_to_cell(data_values.length, column_index, true, true)
 
       defined_name_source = "=#{DATA_WORKSHEET_NAME}!#{data_start}:#{data_end}"
 
       data_sheet.write(0, column_index, data_key, header_format)
-      data_sheet.write_col(1, column_index, data_values)
+      data_sheet.write_col(1, column_index, data_values.map(&:strip))
       defined_name = data_key
       workbook.define_name(defined_name, defined_name_source)
       defined_name
@@ -85,6 +104,7 @@ def self.add_data_source(workbook, data_sheet, data_key, data_values, column_ind
     # TODO: we should DRY this up with the Spreadsheet.from_objects logic
     def self.rewrite_validation_column_names(column_validations, options)
       return column_validations unless options["humanize_headers_class"]
+
       klass = options["humanize_headers_class"]
 
       column_validations.each_with_object({}) do |(attribute, v), obj|
@@ -109,18 +129,34 @@ def self.add_worksheet_validation(workbook, worksheet, column_indexes, data_sour
           next
         end
 
-        defined_name = data_sources[column_validation.data_source]
-        raise ArgumentError, "missing data for data_source=#{column_validation.data_source}" unless defined_name
-
-        validation_options = add_column_validation(column_validation, defined_name)
-
-        pp validation_options
-
-        worksheet.data_validation(1, column_index, ROW_MAX, column_index, validation_options)
+        # Excel's `INDIRECT` function lets us build up the name of a defined range dynamically
+        if column_validation.indirect_built_from
+          parent_column_index = column_indexes[column_validation.indirect_built_from]
+
+          (1..100).each do |row_index|
+            indirect_cell = xl_rowcol_to_cell(row_index, parent_column_index, false, false)
+            defined_name = "INDIRECT(\"#{column_validation.data_source}\" & \"_\" & SUBSTITUTE(#{indirect_cell}, \" \", \"\"))"
+
+            validation_options = generate_validation(column_validation, defined_name)
+            pp validation_options
+            worksheet.data_validation(row_index, column_index, validation_options)
+          end
+        else
+          defined_name = data_sources[column_validation.data_source]
+          unless defined_name
+            raise ArgumentError, "missing data for data_source=#{column_validation.data_source}"
+          end
+
+          validation_options = generate_validation(column_validation, defined_name)
+          pp validation_options
+          worksheet.data_validation(1, column_index, ROW_MAX, column_index, validation_options)
+        end
+      rescue StandardError => e
+        debugger
       end
     end
 
-    def self.add_column_validation(column_validation, defined_name)
+    def self.generate_validation(column_validation, defined_name)
       {
         "validate" => "list",
         "input_title" => "Select a value",

test.rb

@@ -20,37 +20,33 @@
   "data_sources" => {
     "all_meals" => MEALS,
     "roles" => %w[admin user spammer boss],
-    "countries" => CONDITIONAL_CITIES.keys
+    "countries" => COUNTRIES,
+    "cities" => CONDITIONAL_CITIES
   },
 
   "validations" => {
     "role" => SpreadsheetExporter::ColumnValidation.new(
-      attribute_name: "role",
       ignore_blank: false,
       data_source: "roles"
     ),
 
     "country" => SpreadsheetExporter::ColumnValidation.new(
-      attribute_name: "country",
       ignore_blank: true,
       error_type: "information",
       data_source: "countries"
     ),
-    # "city" => SpreadsheetExporter::ColumnValidation.new(
-    #   :attribute_name => "city",
-    #   :ignore_blank => true,
-    #   :error_type => "information",
-    #   :indirect_built_from => "country",
-    #   :data_source => CONDITIONAL_CITIES
-    # ),
+    "city" => SpreadsheetExporter::ColumnValidation.new(
+      ignore_blank: true,
+      error_type: "information",
+      indirect_built_from: "country",
+      data_source: "cities"
+    ),
     "favourite_meal" => SpreadsheetExporter::ColumnValidation.new(
-      attribute_name: "favourite_meal",
       ignore_blank: true,
       error_type: "warning",
       data_source: "all_meals"
     ),
     "most_recent_meal" => SpreadsheetExporter::ColumnValidation.new(
-      attribute_name: "most_recent_meal",
       ignore_blank: true,
       error_type: "warning",
       data_source: "all_meals"

test_data.rb

@@ -1,27 +1,26 @@
-CITIES = [
-  "Sxwōxwiyám: Sqáyéx/Xwyélés",
-  "Ceuta",
-  "Juanhaven",
-  "佳市",
-  "East Sarah",
-  "山武郡横芝光町",
-  "川崎市宮前区",
-  "Blondel-sur-Pottier",
-  "West Christine",
-  "Lake Amandahaven",
-  "Weekshaven",
-  "Breuerscheid",
-  "Matisscheid",
-  "Groß Naemidorf",
-  "Groß Maxim",
-  "Scharfgrün",
-  "Neu Liahhagen",
-  "Eliasstadt",
-  "Mögenburgscheid",
-  "Edirne",
-  "Eskişehir",
-  "İzmir",
-  "İstanbul",
-  "Van",
-  "Şırnak"
-].map { |s| s.encode("UTF-8") }
+def country_and_city
+  country = sample_country
+  city = CONDITIONAL_CITIES[country].sample
+  {country: country, city: city}
+end
+
+def sample_country
+  CONDITIONAL_CITIES.keys.sample
+end
+
+MEALS = %w[Omnivore Veg Vegan]
+
+# COUNTRIES = %w[Canada Türkiye]
+COUNTRIES = %w[Canada Turkey]
+
+CONDITIONAL_CITIES = {
+  COUNTRIES[0] => [
+    "Sxwōxwiyám",
+    "Toronto"
+  ].map { |s| s.encode("UTF-8") },
+  COUNTRIES[1] => [
+    "Eskişehir",
+    "İzmir",
+    "İstanbul"
+  ].map { |s| s.encode("UTF-8") }
+}