spreadsheet_architect 4.1.0 → 5.0.0

data/lib/spreadsheet_architect/utils/ods.rb

@@ -0,0 +1,66 @@
+module SpreadsheetArchitect
+  module Utils
+    module ODS
+
+      def self.get_cell_type(value, type=nil)
+        if type && !type.empty?
+          case type
+          when :hyperlink
+            return :string
+          when :date, :time
+            return :string
+          end
+
+          return type unless (type.respond_to?(:empty?) ? type.empty? : type.nil?)
+        end
+        
+        if value.is_a?(Numeric)
+          type = :float
+        elsif value.respond_to?(:strftime)
+          type = :string
+        else
+          type = :string
+        end
+
+        return type
+      end
+
+      def self.convert_styles(styles={})
+        styles = {} unless styles.is_a?(Hash)
+        styles = SpreadsheetArchitect::Utils.stringify_keys(styles)
+
+        property_styles = {}
+
+        text_styles = {}
+        text_styles['font-weight'] = styles.delete('bold') ? 'bold' : styles.delete('font-weight')
+        text_styles['font-size'] = styles.delete('font_size') || styles.delete('font-size')
+        text_styles['font-style'] = styles.delete('italic') ? 'italic' : styles.delete('font-style')
+        if styles['underline']
+          styles.delete('underline')
+          text_styles['text-underline-style'] = 'solid'
+          text_styles['text-underline-type'] = 'single'
+        end
+        if styles['align']
+          text_styles['align'] = true
+        end 
+        if styles['color'].respond_to?(:sub) && !styles['color'].empty?
+          text_styles['color'] = "##{styles.delete('color').sub('#','')}"
+        end
+        text_styles.delete_if{|_,v| v.nil?}
+        property_styles['text'] = text_styles
+        
+        cell_styles = {}
+        styles['background_color'] ||= styles.delete('background-color')
+        if styles['background_color'].respond_to?(:sub) && !styles['background_color'].empty?
+          cell_styles['background-color'] = "##{styles.delete('background_color').sub('#','')}"
+        end
+
+        cell_styles.delete_if{|_,v| v.nil?}
+        property_styles['cell'] = cell_styles
+
+        return property_styles
+      end
+
+    end
+  end
+end

data/lib/spreadsheet_architect/utils/xlsx.rb

@@ -3,7 +3,14 @@ module SpreadsheetArchitect
     module XLSX
 
       def self.get_type(value, type=nil)
-        return type unless (type.respond_to?(:empty?) ? type.empty? : type.nil?)
+        if type && !type.empty?
+          case type
+          when :hyperlink
+            return :string
+          end
+
+          return type unless (type.respond_to?(:empty?) ? type.empty? : type.nil?)
+        end
         
         if value.is_a?(Numeric)
           if value.is_a?(Float) || value.is_a?(BigDecimal)
@@ -25,10 +32,30 @@ module SpreadsheetArchitect
       end
 
       def self.convert_styles_to_axlsx(styles={})
-        styles = {} unless styles.is_a?(Hash)
+        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('#','')
         end
@@ -37,7 +64,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], 
@@ -45,37 +72,29 @@ 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)
+      def self.range_hash_to_str(hash, num_columns, num_rows, use_zero_based_row_index: false)
+        if !hash.has_key?(:rows) && !hash.has_key?(:columns)
+          raise SpreadsheetArchitect::Exceptions::InvalidRangeError.new(:missing_range_keys, hash)
+        end
+
         case hash[:columns]
         when Integer
           start_col = end_col = COL_NAMES[hash[:columns]]
@@ -92,24 +111,34 @@ module SpreadsheetArchitect
           unless end_col.is_a?(String)
             end_col = COL_NAMES[end_col]
           end
-        when :all
+        when :all, nil
           start_col = 'A'
           end_col = COL_NAMES[num_columns-1]
         else
-          raise SpreadsheetArchitect::Exceptions::InvalidRangeStylesOptionError.new(:columns, hash)
+          raise SpreadsheetArchitect::Exceptions::InvalidRangeOptionError.new(:columns, hash)
         end
 
         case hash[:rows]
         when Integer
           start_row = end_row = hash[:rows]
+
+          if use_zero_based_row_index
+            start_row += 1
+            end_row += 1
+          end
         when Range
           start_row = hash[:rows].first
           end_row = hash[:rows].last
-        when :all
+
+          if use_zero_based_row_index
+            start_row += 1
+            end_row += 1
+          end
+        when :all, nil
           start_row = 1
           end_row = num_rows
         else
-          raise SpreadsheetArchitect::Exceptions::InvalidRangeStylesOptionError.new(:rows, hash)
+          raise SpreadsheetArchitect::Exceptions::InvalidRangeOptionError.new(:rows, hash)
         end
 
         range_str = "#{start_col}#{start_row}:#{end_col}#{end_row}"
@@ -129,11 +158,11 @@ module SpreadsheetArchitect
             end_col, end_row = back.scan(/\d+|\D+/)
 
             unless COL_NAMES.include?(start_col) && COL_NAMES.include?(end_col)
-              raise SpreadsheetArchitect::Exceptions::InvalidRangeError.new(:columns, range)
+              raise SpreadsheetArchitect::Exceptions::InvalidRangeValue.new(:columns, range)
             end
             
             unless start_row.to_i <= num_rows && end_row.to_i <= num_rows
-              raise SpreadsheetArchitect::Exceptions::InvalidRangeError.new(:rows, range)
+              raise SpreadsheetArchitect::Exceptions::InvalidRangeValue.new(:rows, range)
             end
           else
             raise SpreadsheetArchitect::Exceptions::InvalidRangeError.new(:format, range)

data/lib/spreadsheet_architect/utils.rb

@@ -10,7 +10,9 @@ module SpreadsheetArchitect
       if options[:headers] == true
         headers = []
 
-        if !options[:data]
+        if options[:data]
+          headers = false
+        else
           needs_headers = true
         end
       elsif options[:headers].is_a?(Array)
@@ -112,24 +114,22 @@ module SpreadsheetArchitect
     def self.get_options(options, klass)
       verify_option_types(options)
 
-      if options[:freeze] && options[:freeze_headers]
-        raise SpreadsheetArchitect::Exceptions::ArgumentError.new('Cannot use both :freeze and :freeze_headers options at the same time')
-      end
-
-      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]
@@ -144,47 +144,23 @@ module SpreadsheetArchitect
         end
       end
 
-      if options[:freeze] && 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
+      if options[:freeze]
+        options[:freeze] = SpreadsheetArchitect::Utils.symbolize_keys(options[:freeze])
 
-      return options
-    end
-
-    def self.convert_styles_to_ods(styles={})
-      styles = {} unless styles.is_a?(Hash)
-      styles = stringify_keys(styles)
-
-      property_styles = {}
-
-      text_styles = {}
-      text_styles['font-weight'] = styles.delete('bold') ? 'bold' : styles.delete('font-weight')
-      text_styles['font-size'] = styles.delete('font_size') || styles.delete('font-size')
-      text_styles['font-style'] = styles.delete('italic') ? 'italic' : styles.delete('font-style')
-      if styles['underline']
-        styles.delete('underline')
-        text_styles['text-underline-style'] = 'solid'
-        text_styles['text-underline-type'] = 'single'
-      end
-      if styles['align']
-        text_styles['align'] = true
-      end 
-      if styles['color'].respond_to?(:sub) && !styles['color'].empty?
-        text_styles['color'] = "##{styles.delete('color').sub('#','')}"
+        if options[:freeze_headers]
+          raise SpreadsheetArchitect::Exceptions::ArgumentError.new('Cannot use both :freeze and :freeze_headers options at the same time')
+        end
       end
-      text_styles.delete_if{|_,v| v.nil?}
-      property_styles['text'] = text_styles
-      
-      cell_styles = {}
-      styles['background_color'] ||= styles.delete('background-color')
-      if styles['background_color'].respond_to?(:sub) && !styles['background_color'].empty?
-        cell_styles['background-color'] = "##{styles.delete('background_color').sub('#','')}"
+
+      if options[:escape_formulas].nil?
+        options[:escape_formulas] = true
       end
 
-      cell_styles.delete_if{|_,v| v.nil?}
-      property_styles['cell'] = cell_styles
+      if options[:use_zero_based_row_index].nil?
+        options[:use_zero_based_row_index] = false
+      end
 
-      return property_styles
+      return options
     end
 
     private
@@ -284,11 +260,13 @@ module SpreadsheetArchitect
       instances: Array,
       merges: Array,
       range_styles: Array,
+      skip_defaults: [TrueClass, FalseClass],
       row_style: Hash,
       sheet_name: String,
       spreadsheet_columns: [Proc, Symbol, String],
+      escape_formulas: [TrueClass, FalseClass, Array],
+      use_zero_based_row_index: [TrueClass, FalseClass],
     }.freeze
 
-
   end
 end

data/lib/spreadsheet_architect/version.rb

@@ -1,3 +1,3 @@
 module SpreadsheetArchitect
-  VERSION = "4.1.0"
+  VERSION = "5.0.0"
 end

data/lib/spreadsheet_architect.rb

@@ -4,6 +4,7 @@ require 'spreadsheet_architect/action_controller_renderers'
 require 'spreadsheet_architect/exceptions'
 require 'spreadsheet_architect/utils'
 require 'spreadsheet_architect/utils/xlsx'
+require 'spreadsheet_architect/utils/ods'
 
 require 'spreadsheet_architect/class_methods/csv'
 require 'spreadsheet_architect/class_methods/ods'
@@ -35,7 +36,7 @@ module SpreadsheetArchitect
     @default_options
   end
 
-  XLSX_COLUMN_TYPES = [:string, :integer, :float, :date, :time, :boolean].freeze
-  ODS_COLUMN_TYPES = [:string, :float, :date, :time, :boolean].freeze
+  XLSX_COLUMN_TYPES = [:string, :integer, :float, :date, :time, :boolean, :hyperlink].freeze
+  ODS_COLUMN_TYPES = [:string, :float, :date, :time, :boolean, :hyperlink].freeze
 
 end

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

@@ -14,9 +14,12 @@ class SpreadsheetsController < ApplicationController
     render xlsx: Post.to_xlsx, filename: 'Posts'
   end
 
-  def alt_xlsx
-    @posts = Post.all
-    respond_with @posts
+  def test_respond_with
+    if Rails::VERSION::MAJOR >= 5
+      @posts = Post.all
+
+      respond_with @posts
+    end
   end
   
   def test_xlsx

data/test/dummy_app/config/application.rb

@@ -2,9 +2,6 @@ require File.expand_path('../boot', __FILE__)
 
 require 'rails/all'
 
-require 'axlsx'
-require 'axlsx_styler'
-
 Bundler.require
 
 require "spreadsheet_architect"
@@ -39,14 +36,6 @@ module Dummy
     # Configure sensitive parameters which will be filtered from the log file.
     config.filter_parameters += [:password]
 
-    # Enable the asset pipeline
-    config.assets.enabled = true
-
-    config.assets.quiet = true
-
-    # Version of your assets, change this if you want to expire all your assets
-    config.assets.version = '1.0'
-
     config.generators.test_framework = false
     config.generators.helper = false
     config.generators.stylesheets = false
@@ -58,7 +47,10 @@ module Dummy
 
     if ActiveRecord.respond_to?(:gem_version)
       gem_version = ActiveRecord.gem_version
-      if gem_version.to_s.starts_with?("5.2.")
+
+      if gem_version >= Gem::Version.new("7.0.0")
+        config.active_record.legacy_connection_handling = false
+      elsif gem_version.to_s.start_with?("5.2.")
         config.active_record.sqlite3.represent_boolean_as_integer = true
       end
     end

data/test/dummy_app/config/environments/test.rb

@@ -9,7 +9,7 @@ Dummy::Application.configure do
 
   # Configure static asset server for tests with Cache-Control for performance
   config.serve_static_files = true
-  config.public_file_server.headers = { 'Cache-Control' => 'public, max-age=3600' }
+  config.public_file_server.enabled = true
 
   # Log error messages when you accidentally call methods on nil
   config.whiny_nils = true

data/test/dummy_app/config/routes.rb

@@ -2,5 +2,5 @@ Dummy::Application.routes.draw do
   get 'spreadsheets/csv', to: 'spreadsheets#csv'
   get 'spreadsheets/ods', to: 'spreadsheets#ods'
   get 'spreadsheets/xlsx', to: 'spreadsheets#xlsx'
-  get 'spreadsheets/alt_xlsx', to: 'spreadsheets#alt_xlsx'
+  get 'spreadsheets/test_respond_with', to: 'spreadsheets#test_respond_with'
 end

data/test/dummy_app/db/migrate/20170103234524_add_posts.rb

@@ -1,4 +1,4 @@
-class AddPosts < ActiveRecord::Migration[5.0]
+class AddPosts < ActiveRecord::Migration::Current
   def change
     create_table :posts do |t|
       t.string :name