Add support for XLSX with data entry enhancements

.gitignore

@@ -7,3 +7,4 @@ test/dummy/log/*.log
 test/dummy/tmp/
 test/dummy/.sass-cache
 *.gem
+*.xlsx

Gemfile.lock

@@ -1,14 +1,26 @@
 PATH
   remote: .
   specs:
-    spreadsheet_exporter (0.1.1)
+    spreadsheet_exporter (0.1.2)
+      activesupport (>= 6)
       write_xlsx
 
 GEM
   remote: https://rubygems.org/
   specs:
-    rubyzip (2.3.0)
-    write_xlsx (0.83.0)
+    activesupport (7.0.3.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    concurrent-ruby (1.1.10)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    minitest (5.16.2)
+    rubyzip (2.3.2)
+    tzinfo (2.0.5)
+      concurrent-ruby (~> 1.0)
+    write_xlsx (1.09.3)
       rubyzip (>= 1.0.0)
       zip-zip
     zip-zip (0.3)
@@ -21,4 +33,4 @@ DEPENDENCIES
   spreadsheet_exporter!
 
 BUNDLED WITH
-   1.10.4
+   2.3.19

README.md

@@ -7,8 +7,9 @@ gem 'spreadsheet_exporter'
 
 ## Usage
 
-Objects that are exported must respond to ```as_csv``` or ```as_json``` and return a hash
-representing column names and values.
+Objects that are exported must respond to `as_spreadsheet`, `as_csv` or `as_json` and return a hash
+representing column names and values.  In Rails you can `include SpreadsheetExporter::GeneratesSpreadsheet` into your model.
+
 
 ### CSV or XLSX
 Output can be .csv or .xlsx. Choose by using SpreadsheetExporter::CSV or SpreadsheetExporter::XLSX modules.
@@ -28,3 +29,41 @@ that is actually comma-delimited, pass ```:col_sep => ','``` as an option when e
 ```ruby
   SpreadsheetExporter::CSV.from_spreadsheet([["First Name", "Last Name"], ["Bob", "Hoskins"], ["Roger", "Rabbit"]])
 ```
+
+### XLSX with Pick Lists
+
+```ruby
+# data sources are written to a `data` worksheet and may be referenced by
+# multiple rows
+data_sources = {
+  "food_types" => %w[Polenta Paella Papaya],
+  "countries" => %w[Canada Türkiye],
+  "cities" => {"Canada"=>["Sxwōxwiyám", "Toronto"], "Türkiye"=>["Eskişehir", "İzmir", "İstanbul"]}
+}
+
+validations = {
+  "favourite_food" => SpreadsheetExporter::ColumnValidation.new(
+    data_source: "food_types"
+  ),
+  "yuckiest_food" => SpreadsheetExporter::ColumnValidation.new(
+    data_source: "food_types"
+  ),
+  "country" => SpreadsheetExporter::ColumnValidation.new(
+    data_source: "countries"
+  ),
+  "city" => SpreadsheetExporter::ColumnValidation.new(
+    dependent_on: "country",
+    data_source: "cities"
+  ),
+}
+
+SpreadsheetExporter::XLSX.from_objects(array_of_objects,
+  data_sources: data_sources,
+  validations: validations,
+  freeze_panes: [1, 0] # number of rows and columns to freeze (only applies to XLSX)
+)
+```
+
+### Testing
+
+There isn't currently a test suite.  You can generate a sample test XLSX file by running `test/test.rb`.

lib/spreadsheet_exporter.rb

@@ -1,6 +1,14 @@
-require 'spreadsheet_exporter/csv'
-require 'spreadsheet_exporter/xlsx'
+require_relative './spreadsheet_exporter/generates_spreadsheet'
+require_relative './spreadsheet_exporter/column_validation'
+require_relative './spreadsheet_exporter/csv'
+require_relative './spreadsheet_exporter/xlsx'
+require 'active_support'
+require 'active_support/core_ext/object/json'
+require 'active_support/core_ext/hash/reverse_merge'
+
 module SpreadsheetExporter
+  VALIDATION_ERROR_TYPES = %w[stop warning information].freeze
+
   begin
     Mime::Type.register "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet", :xlsx
   rescue NameError

lib/spreadsheet_exporter/column_validation.rb

@@ -0,0 +1,9 @@
+module SpreadsheetExporter
+  ColumnValidation = Struct.new(:ignore_blank, :data_source, :dependent_on, :error_type, keyword_init: true) do
+    def initialize(*)
+      super
+      self.ignore_blank = true if ignore_blank.nil?
+      self.error_type ||= VALIDATION_ERROR_TYPES[0]
+    end
+  end
+end

lib/spreadsheet_exporter/csv.rb

@@ -5,19 +5,19 @@ module SpreadsheetExporter
   module CSV
     BOM = "\377\376".force_encoding("utf-16le") # Byte Order Mark so Excel displays characters correctly
 
-    def self.from_objects(objects, options = {})
-      spreadsheet = Spreadsheet.from_objects(objects, options).compact
+    def self.from_objects(objects, humanize_headers_class: nil, **options)
+      spreadsheet = Spreadsheet.from_objects(objects, humanize_headers_class: humanize_headers_class, **options).compact
       from_spreadsheet(spreadsheet)
     end
 
-    def self.from_spreadsheet(spreadsheet, options = {})
-      output = ::CSV.generate(**options.reverse_merge(:encoding => 'UTF-8', :col_sep => "\t")) do |csv|
+    def self.from_spreadsheet(spreadsheet, encoding: 'UTF-8', col_sep: "\t", **options)
+      output = ::CSV.generate(encoding: encoding, col_sep: col_sep, **options) do |csv|
         spreadsheet.each do |row|
           csv << row
         end
       end
 
-      return BOM + output.encode!('utf-16le')
+      BOM + output.encode!('utf-16le')
     end
   end
 end

lib/spreadsheet_exporter/generates_spreadsheet.rb

@@ -0,0 +1,11 @@
+require "active_support/concern"
+
+module SpreadsheetExporter
+  module GeneratesSpreadsheet
+    extend ActiveSupport::Concern
+
+    def as_spreadsheet(options = {})
+      serializable_hash(options)
+    end
+  end
+end

lib/spreadsheet_exporter/spreadsheet.rb

@@ -1,24 +1,43 @@
 # TODO: Find out why we can't detect arrays properly and must resort to crappy class.name comparison
 module SpreadsheetExporter
+  HeaderCell = Struct.new(:attribute_name, :human_attribute_name) do
+    def to_s
+      human_attribute_name.presence || attribute_name
+    end
+  end
+
   module Spreadsheet
-    def self.from_objects(objects, options = {})
+    def self.from_objects(objects, humanize_headers_class: nil, **options)
       headers = []
       rows = []
 
       # 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.map { |v| HeaderCell.new(v) }
         rows << data
       end
 
       # Create the csv, ensuring to place each row's attributes under the appropriate header (since rows may not have all the same attributes)
       [].tap do |spreadsheet|
-        spreadsheet << (options[:humanize_headers_class] ? han(options[:humanize_headers_class], headers) : headers)
+        if humanize_headers_class
+          headers = han(headers, humanize_headers_class: humanize_headers_class, **options)
+        end
+
+        spreadsheet << headers
+
         rows.each do |row|
           sorted_row = []
           row.each do |header, value|
-            sorted_row[headers.index(header)] = value
+            col_index = headers.find_index { |h| h.attribute_name == header }
+            sorted_row[col_index] = value
           end
 
           spreadsheet << sorted_row
@@ -28,14 +47,14 @@ def self.from_objects(objects, options = {})
 
     # Return an array of human_attribute_name's
     # Used by the CSV Import/Export process to match CSV headers to model attribute names
-    def self.han(klass, *attributes)
-      options = attributes.extract_options!
+    def self.han(headers, humanize_headers_class:, downcase: false, **)
+      headers.flatten!
 
-      attributes.flatten!
-      attributes.collect! {|attribute| klass.human_attribute_name(attribute) }
-      attributes.collect!(&:downcase) if options[:downcase]
-
-      return attributes.many? ? attributes : attributes.first
+      headers.collect! do |header|
+        header.human_attribute_name = humanize_headers_class.human_attribute_name(header.attribute_name)
+        header.human_attribute_name.downcase! if downcase
+        header
+      end
     end
 
     def self.get_values(node, current_header = nil)