spreadsheet_architect 3.3.0 → 4.2.0

data/lib/spreadsheet_architect/axlsx_string_width_patch.rb

@@ -0,0 +1,23 @@
+if Axlsx::VERSION.to_f < 3.1
+
+  Axlsx::Cell.class_eval do
+    private
+
+    def string_width(string, font_size)
+      font_scale = font_size / 10.0
+      (string.to_s.size + 3) * font_scale
+    end
+  end
+
+  if defined?(Axlsx::RichTextRun)
+    Axlsx::RichTextRun.class_eval do
+      private
+
+      def string_width(string, font_size)
+        font_scale = font_size / 10.0
+        string.to_s.size * font_scale
+      end
+    end
+  end
+
+end

data/lib/spreadsheet_architect/class_methods/csv.rb

@@ -2,6 +2,7 @@ require 'csv'
 
 module SpreadsheetArchitect
   module ClassMethods
+
     def to_csv(opts={})
       opts = SpreadsheetArchitect::Utils.get_options(opts, self)
       options = SpreadsheetArchitect::Utils.get_cell_data(opts, self)
@@ -18,5 +19,6 @@ module SpreadsheetArchitect
         end
       end
     end
+
   end
 end

data/lib/spreadsheet_architect/class_methods/ods.rb

@@ -2,6 +2,7 @@ require 'rodf'
 
 module SpreadsheetArchitect
   module ClassMethods
+
     def to_ods(opts={})
       return to_rodf_spreadsheet(opts).bytes
     end

data/lib/spreadsheet_architect/class_methods/xlsx.rb

@@ -1,12 +1,11 @@
 require 'axlsx'
 require 'axlsx_styler'
 
-require 'spreadsheet_architect/monkey_patches/axlsx_column_width'
+require 'spreadsheet_architect/axlsx_string_width_patch'
 
 module SpreadsheetArchitect
-  XLSX_COLUMN_TYPES = [:string, :integer, :float, :boolean].freeze
-
   module ClassMethods
+
     def to_xlsx(opts={})
       return to_axlsx_package(opts).to_stream.read
     end
@@ -18,7 +17,7 @@ module SpreadsheetArchitect
       if options[:column_types] && !(options[:column_types].compact.collect(&:to_sym) - SpreadsheetArchitect::XLSX_COLUMN_TYPES).empty?
         raise SpreadsheetArchitect::Exceptions::ArgumentError.new("Invalid column type. Valid XLSX values are #{SpreadsheetArchitect::XLSX_COLUMN_TYPES}")
       end
-    
+
       header_style = SpreadsheetArchitect::Utils::XLSX.convert_styles_to_axlsx(options[:header_style])
       row_style = SpreadsheetArchitect::Utils::XLSX.convert_styles_to_axlsx(options[:row_style])
 
@@ -48,10 +47,10 @@ module SpreadsheetArchitect
 
             if options[:conditional_row_styles]
               conditional_styles_for_row = SpreadsheetArchitect::Utils::XLSX.conditional_styles_for_row(options[:conditional_row_styles], row_index, header_row)
-              
+
               unless conditional_styles_for_row.empty?
                 sheet.add_style(
-                  "#{SpreadsheetArchitect::Utils::XLSX::COL_NAMES.first}#{row_index+1}:#{SpreadsheetArchitect::Utils::XLSX::COL_NAMES[max_row_length-1]}#{row_index+1}", 
+                  "#{SpreadsheetArchitect::Utils::XLSX::COL_NAMES.first}#{row_index+1}:#{SpreadsheetArchitect::Utils::XLSX::COL_NAMES[max_row_length-1]}#{row_index+1}",
                   SpreadsheetArchitect::Utils::XLSX.convert_styles_to_axlsx(conditional_styles_for_row)
                 )
               end
@@ -108,11 +107,13 @@ module SpreadsheetArchitect
           sheet.add_row row_data, style: styles, types: types
 
           if options[:conditional_row_styles]
+            options[:conditional_row_styles] = SpreadsheetArchitect::Utils.hash_array_symbolize_keys(options[:conditional_row_styles])
+
             conditional_styles_for_row = SpreadsheetArchitect::Utils::XLSX.conditional_styles_for_row(options[:conditional_row_styles], row_index, row_data)
-            
+
             unless conditional_styles_for_row.empty?
               sheet.add_style(
-                "#{SpreadsheetArchitect::Utils::XLSX::COL_NAMES.first}#{row_index+1}:#{SpreadsheetArchitect::Utils::XLSX::COL_NAMES[max_row_length-1]}#{row_index+1}", 
+                "#{SpreadsheetArchitect::Utils::XLSX::COL_NAMES.first}#{row_index+1}:#{SpreadsheetArchitect::Utils::XLSX::COL_NAMES[max_row_length-1]}#{row_index+1}",
                 SpreadsheetArchitect::Utils::XLSX.convert_styles_to_axlsx(conditional_styles_for_row)
               )
             end
@@ -128,6 +129,8 @@ module SpreadsheetArchitect
         end
 
         if options[:borders]
+          options[:borders] = SpreadsheetArchitect::Utils.hash_array_symbolize_keys(options[:borders])
+
           options[:borders].each do |x|
             if x[:range].is_a?(Hash)
               x[:range] = SpreadsheetArchitect::Utils::XLSX.range_hash_to_str(x[:range], max_row_length, num_rows)
@@ -140,6 +143,8 @@ module SpreadsheetArchitect
         end
 
         if options[:column_styles]
+          options[:column_styles] = SpreadsheetArchitect::Utils.hash_array_symbolize_keys(options[:column_styles])
+
           options[:column_styles].each do |x|
             start_row = (options[:headers] ? options[:headers].count : 0) + 1
 
@@ -171,6 +176,8 @@ module SpreadsheetArchitect
         end
 
         if options[:range_styles]
+          options[:range_styles] = SpreadsheetArchitect::Utils.hash_array_symbolize_keys(options[:range_styles])
+
           options[:range_styles].each do |x|
             styles = SpreadsheetArchitect::Utils::XLSX.convert_styles_to_axlsx(x[:styles])
 
@@ -185,6 +192,8 @@ module SpreadsheetArchitect
         end
 
         if options[:merges]
+          options[:merges] = SpreadsheetArchitect::Utils.hash_array_symbolize_keys(options[:merges])
+
           options[:merges].each do |x|
             if x[:range].is_a?(Hash)
               x[:range] = SpreadsheetArchitect::Utils::XLSX.range_hash_to_str(x[:range], max_row_length, num_rows)
@@ -195,9 +204,48 @@ module SpreadsheetArchitect
             sheet.merge_cells x[:range]
           end
         end
+
+        if options[:freeze_headers]
+          sheet.sheet_view.pane do |pane|
+            pane.state = :frozen
+            pane.y_split = options[:headers].count
+          end
+
+        elsif options[:freeze]
+          options[:freeze] = SpreadsheetArchitect::Utils.symbolize_keys(options[:freeze])
+
+          sheet.sheet_view.pane do |pane|
+            pane.state = :frozen
+
+            ### Currently not working
+            #if options[:freeze][:active_pane]
+            #  Axlsx.validate_pane_type(options[:freeze][:active_pane])
+            #  pane.active_pane = options[:freeze][:active_pane]
+            #else
+            #  pane.active_pane = :bottom_right
+            #end
+
+            if !options[:freeze][:rows]
+              raise SpreadsheetArchitect::Exceptions::ArgumentError.new("The :rows key must be specified in the :freeze option hash")
+            elsif options[:freeze][:rows].is_a?(Range)
+              pane.y_split = options[:freeze][:rows].count
+            else
+              pane.y_split = 1
+            end
+
+            if options[:freeze][:columns] && options[:freeze][:columns] != :all
+              if options[:freeze][:columns].is_a?(Range)
+                pane.x_split = options[:freeze][:columns].count
+              else
+                pane.x_split = 1
+              end
+            end
+          end
+        end
       end
 
       return package
     end
+
   end
 end

data/lib/spreadsheet_architect/utils.rb

@@ -7,9 +7,12 @@ module SpreadsheetArchitect
         data = options[:data]
       end
 
-      if !options[:data] && options[:headers] == true
+      if options[:headers] == true
         headers = []
-        needs_headers = true
+
+        if !options[:data]
+          needs_headers = true
+        end
       elsif options[:headers].is_a?(Array)
         headers = options[:headers]
       else
@@ -109,20 +112,22 @@ module SpreadsheetArchitect
     def self.get_options(options, klass)
       verify_option_types(options)
 
-      if defined?(klass::SPREADSHEET_OPTIONS)
-        if klass::SPREADSHEET_OPTIONS.is_a?(Hash)
-          options = SpreadsheetArchitect.default_options.merge(
-            klass::SPREADSHEET_OPTIONS.merge(options)
-          )
+      if !options[:skip_defaults]
+        if defined?(klass::SPREADSHEET_OPTIONS)
+          if klass::SPREADSHEET_OPTIONS.is_a?(Hash)
+            defaults = SpreadsheetArchitect.default_options.merge(klass::SPREADSHEET_OPTIONS)
+          else
+            raise SpreadsheetArchitect::Exceptions::OptionTypeError.new("#{klass}::SPREADSHEET_OPTIONS constant")
+          end
         else
-          raise SpreadsheetArchitect::Exceptions::OptionTypeError.new("#{klass}::SPREADSHEET_OPTIONS constant")
+          defaults = SpreadsheetArchitect.default_options
         end
-      else
-        options = SpreadsheetArchitect.default_options.merge(options)
+
+        options = defaults.merge(options)
       end
 
       if !options[:headers]
-        options[:header_style] = false
+        options.delete(:header_style)
       end
 
       if !options[:sheet_name]
@@ -137,6 +142,14 @@ module SpreadsheetArchitect
         end
       end
 
+      if options[:freeze]
+        if options[:freeze_headers]
+          raise SpreadsheetArchitect::Exceptions::ArgumentError.new('Cannot use both :freeze and :freeze_headers options at the same time')
+        elsif options[:freeze].is_a?(Hash) && !options[:freeze][:rows]
+          raise SpreadsheetArchitect::Exceptions::ArgumentError.new('Must provide a :rows key when passing a hash to the :freeze option')
+        end
+      end
+
       return options
     end
 
@@ -208,23 +221,22 @@ module SpreadsheetArchitect
     end
 
     def self.verify_option_types(options)
-      check_option_type(options, :spreadsheet_columns, [Proc, Symbol, String])
-      check_option_type(options, :data, Array)
-      check_option_type(options, :instances, Array)
-      check_option_type(options, :headers, [TrueClass, FalseClass, Array])
-      check_option_type(options, :header_style, Hash)
-      check_option_type(options, :row_style, Hash)
-      check_option_type(options, :column_styles, Array)
-      check_option_type(options, :range_styles, Array)
-      check_option_type(options, :conditional_row_styles, Array)
-      check_option_type(options, :merges, Array)
-      check_option_type(options, :borders, Array)
-      check_option_type(options, :column_widths, Array)
-      check_option_type(options, :column_types, Array)
+      options = self.symbolize_keys(options, shallow: true)
+
+      bad_keys = options.keys - ALLOWED_OPTIONS.keys
+
+      if bad_keys.any?
+        raise SpreadsheetArchitect::Exceptions::ArgumentError.new("Invalid options provided: #{bad_keys}")
+      end
+
+      ALLOWED_OPTIONS.each do |key, allowed_types|
+        check_option_type(options, key, allowed_types)
+      end
     end
 
-    def self.stringify_keys(hash={})
+    def self.stringify_keys(hash)
       new_hash = {}
+
       hash.each do |k,v|
         if v.is_a?(Hash)
           new_hash[k.to_s] = self.stringify_keys(v)
@@ -232,7 +244,54 @@ module SpreadsheetArchitect
           new_hash[k.to_s] = v
         end
       end
+
       return new_hash
     end
+
+    def self.symbolize_keys(hash, shallow: false)
+      new_hash = {}
+
+      hash.each do |k,v|
+        if v.is_a?(Hash)
+          new_hash[k.to_sym] = shallow ? v : self.symbolize_keys(v)
+        else
+          new_hash[k.to_sym] = v
+        end
+      end
+
+      return new_hash
+    end
+
+    def self.hash_array_symbolize_keys(array)
+      new_array = []
+
+      array.each_with_index do |x,i|
+        new_array[i] = x.is_a?(Hash) ? self.symbolize_keys(x) : x
+      end
+
+      return new_array
+    end
+
+    ALLOWED_OPTIONS = {
+      borders: Array,
+      column_styles: Array,
+      conditional_row_styles: Array,
+      column_widths: Array,
+      column_types: Array,
+      data: Array,
+      freeze_headers: [TrueClass, FalseClass],
+      freeze: Hash,
+      headers: [TrueClass, FalseClass, Array],
+      header_style: Hash,
+      instances: Array,
+      merges: Array,
+      range_styles: Array,
+      skip_defaults: [TrueClass, FalseClass],
+      row_style: Hash,
+      sheet_name: String,
+      spreadsheet_columns: [Proc, Symbol, String],
+    }.freeze
+
+
   end
 end

data/lib/spreadsheet_architect/utils/xlsx.rb

@@ -25,8 +25,29 @@ module SpreadsheetArchitect
       end
 
       def self.convert_styles_to_axlsx(styles={})
-        styles = {} unless styles.is_a?(Hash)
-        styles = self.symbolize_keys(styles)
+        if [nil, false, true].include?(styles)
+          return {}
+        end
+
+        styles = SpreadsheetArchitect::Utils.symbolize_keys(styles)
+
+        ### BOOLEAN VALUES
+        if styles[:b].nil? && styles.has_key?(:bold)
+          styles[:b] = !!styles.delete(:bold)
+        end
+
+        if styles[:i].nil? && styles.has_key?(:italic)
+          styles[:i] = !!styles.delete(:italic)
+        end
+
+        if styles[:u].nil? && styles.has_key?(:underline)
+          styles[:u] = !!styles.delete(:underline)
+        end
+
+        ### OTHER VALUES
+        if styles[:sz].nil? && !styles[:font_size].nil?
+          styles[:sz] = styles.delete(:font_size)
+        end
 
         if styles[:fg_color].nil? && styles[:color] && styles[:color].respond_to?(:sub) && !styles[:color].empty?
           styles[:fg_color] = styles.delete(:color).sub('#','')
@@ -36,7 +57,7 @@ module SpreadsheetArchitect
           styles[:bg_color] = styles.delete(:background_color).sub('#','')
         end
         
-        if styles[:alignment].nil? && styles[:align]
+        if styles[:alignment].nil? && [:align, :valign, :wrap_text].any?{|k| styles.has_key?(k) }
           if styles[:align].is_a?(Hash)
             styles[:alignment] = {
               horizontal: styles[:align][:horizontal], 
@@ -44,34 +65,22 @@ module SpreadsheetArchitect
               wrap_text: styles[:align][:wrap_text]
             }
           else
-            styles[:alignment] = {horizontal: (styles.delete(:align) || nil) }
+            styles[:alignment] = {horizontal: styles.delete(:align), vertical: styles.delete(:valign), wrap_text: styles.delete(:wrap_text) }.compact
           end
-
-          styles.delete(:align)
-        end
-
-        if styles[:b].nil?
-          styles[:b] = styles.delete(:bold) || nil
-        end
-
-        if styles[:sz].nil?
-          styles[:sz] = styles.delete(:font_size) || nil
-        end
-
-        if styles[:i].nil?
-          styles[:i] = styles.delete(:italic) || nil
-        end
-
-        if styles[:u].nil?
-          styles[:u] = styles.delete(:underline) || nil
         end
 
+        ### COMMENT SEEMS WRONG, TO BE RECONFIRMED
         ### If `:u` is false instead of nil, it may be incorrectly rendered as true in Excel
-        if styles[:u] == false
-          styles[:u] = nil
+        #if styles[:u] == false
+        #  styles[:u] = nil
+        #end
+        
+        ### ENSURE CLEANUP OF ALL ALIAS KEYS
+        [:bold, :font_size, :italic, :underline, :align, :valign, :wrap_text, :color, :background_color].each do |k|
+          styles.delete(k)
         end
         
-        styles.delete_if{|k,v| v.nil?}
+        return styles
       end
 
       def self.range_hash_to_str(hash, num_columns, num_rows)
@@ -176,18 +185,6 @@ module SpreadsheetArchitect
 
       private
 
-      def self.symbolize_keys(hash={})
-        new_hash = {}
-        hash.each do |k, v|
-          if v.is_a?(Hash)
-            new_hash[k.to_sym] = self.symbolize_keys(v)
-          else
-            new_hash[k.to_sym] = v
-          end
-        end
-        new_hash
-      end
-
       ### Limit of 16384 columns as per Excel limitations
       COL_NAMES = Array('A'..'XFD').freeze
 

data/lib/spreadsheet_architect/version.rb

@@ -1,3 +1,3 @@
 module SpreadsheetArchitect
-  VERSION = "3.3.0"
+  VERSION = "4.2.0"
 end

data/test/dummy_app/app/controllers/spreadsheets_controller.rb

@@ -15,8 +15,11 @@ class SpreadsheetsController < ApplicationController
   end
 
   def alt_xlsx
-    @posts = Post.all
-    respond_with @posts
+    if Rails::VERSION::MAJOR >= 5
+      @posts = Post.all
+
+      respond_with @posts
+    end
   end
   
   def test_xlsx