spreadsheet_architect 4.1.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b0e103cc275bf05dabe10a86cb7f74dcc4a412daa2328e607ca70d7af22ea40b
-  data.tar.gz: 5799934cf9f9e177ca49ed33d749d01e535143cc18bf6990082b834fe6d9a6d5
+  metadata.gz: c88ecaffa3abed6ef127dc13d42c612ebf224c6d8552590d68ae544af2713f93
+  data.tar.gz: d0e864c2f50e99040f932da595b7270dd0e9c0161fc1189e6d99cb43126f6b5a
 SHA512:
-  metadata.gz: cee7b3f8dfc727d63c1f84f06f94c1bf3eaf46283b15b698724a5d0f57d3ef39728838b5295376df6e112bbb3141579c6ebc4189e8af85bd82558abe0cbd2546
-  data.tar.gz: 13c7e7db2193bb37be8911592e5eab725700e047dc8437c455adcad0ae8574f3187ac2d40412b82e706e90a286ec38b15be248c013b0fc5ed9db1d0c0b943e98
+  metadata.gz: dfc0caea596d57bd5aa88cd3b5ff3cebfca8b1299d1660e9995ca93837746d21420a90e0f427df9b3f8e73c13914a24b137572c005ee16fafdeeb6ddaf18b95d
+  data.tar.gz: c31f408e271453d46454e4f85ad2437a2539e39973186a8889c917a338f9e5f57f9ef3f3f28797955d61f8daa6a7100ffb46624ab3974c4bfd9273cc5cacba29

data/CHANGELOG.md

@@ -1,14 +1,34 @@
 CHANGELOG
 ---------
 
-- **Unreleased**
+- **Unreleased** - [View Diff](https://github.com/westonganger/spreadsheet_architect/compare/v5.0.0...master)
   - Nothing yet
-- **4.1.0**
+
+- **5.0.0** - [View Diff](https://github.com/westonganger/spreadsheet_architect/compare/v4.2.0...v5.0.0)
+  - [#52](https://github.com/westonganger/spreadsheet_architect/pull/52) - Update to caxlsx v3.3.0+ which now contains the axlsx_styler code, so we drop the dependency on axlsx_styler
+  - [#38](https://github.com/westonganger/spreadsheet_architect/pull/38) - **Breaking Change**  - Add `escape_formulas` option for xlsx spreadsheets. This is a breaking change because we default to `escape_formulas: true` whereas before there was no formula escaping at all. The reasoning for this breaking change is that creating spreadsheets where many of the fields contain direct user input are a large majority compared to use cases that involve formulas.
+  - [#39](https://github.com/westonganger/spreadsheet_architect/pull/39) - Add option `use_zero_based_row_index: true` (Default `false`) which allows you to use zero-based row indexes instead of the default 1-based row indexes. Recomended to set this option for the whole project. The original reason it was designed to be 1-based is because spreadsheet row numbers literally start with 1. However this tends to be unituitive for the developer because columns use zero based indexes because they use letter-based notation instead.
+  - [#40](https://github.com/westonganger/spreadsheet_architect/pull/40) - Improve argument handling for freeze option and add support for all Axlsx supported options for panes using the `:freeze` hash. See test case for example (./test/unit/xlsx_freeze_test.rb)
+  - [#42](https://github.com/westonganger/spreadsheet_architect/pull/42) - Improve exceptions and messages regarding invalid ranges
+  - [#45](https://github.com/westonganger/spreadsheet_architect/pull/45) - For `to_xlsx`, dont add empty header row when `header: true`
+  - [#44](https://github.com/westonganger/spreadsheet_architect/pull/44) - Add support for hyperlinks in XLSX and ODS
+  - [#49](https://github.com/westonganger/spreadsheet_architect/pulls/49) - Extracted some ODS methods from `SpreadsheetArchitect::Utils` to `SpreadsheetArchitect::Utils::ODS`
+  - [#51](https://github.com/westonganger/spreadsheet_architect/pulls/51) - Add Proc support to `:column_types`
+
+- **4.2.0** - May 27, 2021 - [View Diff](https://github.com/westonganger/spreadsheet_architect/compare/v4.1.0...v4.2.0)
+  - Add option `:skip_defaults` which removes the defaults and default styles. Particularily useful for heavily customized spreadsheets where the default styles get in the way.
+  - Fix bug where styles werent being un-applied when using the `false` value.
+  - Add style aliases for `:valign` and `:wrap_text`
+  - Fix error with `headers: false`, previously had to use `headers: []`
+
+- **4.1.0** - Nov 20, 2020 - [View Diff](https://github.com/westonganger/spreadsheet_architect/compare/v4.0.1...v4.1.0)
   - Raise ArgumentError when invalid option names are given
-- **4.0.1**
+
+- **4.0.1** - Nov 20, 2020 - [View Diff](https://github.com/westonganger/spreadsheet_architect/compare/v4.0.0...v4.0.1)
   - Fix bug with `headers: false` where a blank header row is still added 
   - Fix Bug for older version of `caxlsx` v2.0.2
-- **4.0.0**
+
+- **4.0.0** - Mar 3, 2020 - [View Diff](https://github.com/westonganger/spreadsheet_architect/compare/v3.3.1...v4.0.0)
   - Switch to the `caxlsx` gem (Community Axlsx) from the legacy unmaintained `axlsx` gem. Axlsx has had a long history of being poorly maintained so this community gem improves the situation.
   - Require Ruby 2.3+
   - Ensure all options using Hash are automatically converted to symbol only hashes
@@ -16,29 +36,35 @@ CHANGELOG
   - Add XLSX option `:freeze_headers` to freeze the headers of your spreadsheet
   - Remove old Axlsx patch for column width
   - Backport new code for `string_width` calculations to Axlsx 3.0.1 and below.
-- **3.3.1**
+
+- **3.3.1** - Dec 2, 2019 - [View Diff](https://github.com/westonganger/spreadsheet_architect/compare/v3.3.0...v3.3.1)
   - [Issue #30](https://github.com/westonganger/spreadsheet_architect/issues/30) - Fix duplicate constant warning for XLSX_COLUMN_TYPES
-- **3.3.0**
+
+- **3.3.0** - Nov 28, 2019 - [View Diff](https://github.com/westonganger/spreadsheet_architect/compare/v3.2.1...v3.3.0)
   - Fix `:borders` option, was broken in v3.2.1
   - Fix bug when passing `false` to `:headers` option
   - Raise error when unsupported column type is passed
   - Remove claimed support for `:currency` and `:percent` for ODS spreadsheets as they were not working. PR Wanted.
-- **3.2.1** - April 10, 2019
+
+- **3.2.1** - April 10, 2019 - [View Diff](https://github.com/westonganger/spreadsheet_architect/compare/v3.2.0...v3.2.1)
   - Fix bug when using `column_style` option with `include_header: true` & letter based column numbering
-- **3.2.0** - September 14, 2018
+
+- **3.2.0** - September 14, 2018 - [View Diff](https://github.com/westonganger/spreadsheet_architect/compare/v3.1.0...v3.2.0)
   - Change implementation of `:column_styles` option to utilize `axlsx_styler` instead of the built-in axlsx `col_style` method. The reason for the switch is that `col_style` would overwrite all previously set styles. `axlsx_styler` already has the ability to add onto existing styles and is what is currently utilized by `range_styles`.
   - Date / Time formatting is now set per cell instead of on the entire column.
   - Default Date formatting for `xlsx` changed from `m/d/yyyy` to `yyyy-mm-dd`
   - Default Time/DateTime formatting for `xlsx` changed from `yyyy/m/d h:mm AM/PM` to `yyyy-mm-dd h:mm AM/PM`
   - Fix bug where the ActionController::Renderer `:filename` option was ignored when an AR::Relation passed directly to the renderer without first calling `to_#{format}`
-- **3.1.0** - August 19, 2018
+
+- **3.1.0** - August 19, 2018 - [View Diff](https://github.com/westonganger/spreadsheet_architect/compare/v3.0.0...v3.1.0)
   - Add new option `:conditional_row_styles` to `to_xlsx`.
   - Add ability to pass an alternative method name as a Symbol/String to the `:spreadsheet_columns` option.
   - Replace all usage of the legacy method `instance_eval` with the proper method `send`.
   - [#23](https://github.com/westonganger/spreadsheet_architect/issues/23#issuecomment-412803761) - Fix bug where custom `columns_widths` in xlsx spreadsheets might not get set correctly.
   - All exceptions now inherit from the appropriate ruby core exception classes
   - `SpreadsheetArchitect::Exceptions::InvalidOptionError` renamed to `SpreadsheetArchitect::Exceptions::OptionTypeError`
-- **3.0.0** - July 6, 2018
+
+- **3.0.0** - July 6, 2018 - [View Diff](https://github.com/westonganger/spreadsheet_architect/compare/v2.1.2...v3.0.0)
   - [#16](https://github.com/westonganger/spreadsheet_architect/issues/16) - Add ability to pass :instances option to SpreadsheetArchitect class methods
   - [#16](https://github.com/westonganger/spreadsheet_architect/issues/16) - Remove Plain Ruby syntax `Post.to_xlsx(instances: posts_array)` in favor of `SpreadsheetArchitect.to_xlsx(instance: posts_array)`. However, it may still work at this time if configured correctly.
   - Fix project-wide and model-level defaults before only `header_style`, `row_style`, & `sheet_name` were being utilized.
@@ -53,12 +79,15 @@ CHANGELOG
   - Remove all Rails generators `spreadsheet_architect:add_default_options`. No need since its just as easy to copy from the README
   - Major overhaul of test suite, add a ton more tests, for DRYness use resursion for tests when appropriate
   - Use appraisal to test various `axlsx` versions
-- **2.1.2** - July 6, 2018
+
+- **2.1.2** - July 6, 2018 - [View Diff](https://github.com/westonganger/spreadsheet_architect/compare/v2.1.1...v2.1.2)
   - Fix bug where everything was underlined by default in Excel (LibreOffice was working correctly). For some reason, `false` in `:u` or `:underline` was incorrectly being treated as `true` but only within Excel. Now anytime `false` is encountered for either `:u` or `:underline` it is now converted to `nil`
   - Fix bug where empty xlsx spreadsheets were corrupt when trying to open with Excel (LibreOffice was working correctly). This only occured when containing no headers and empty `:data` option which resulted in a package with no sheets.
-- **2.1.1** - July 4, 2018
+
+- **2.1.1** - July 4, 2018 - [View Diff](https://github.com/westonganger/spreadsheet_architect/compare/v2.1.0...v2.1.1)
   - [#18](https://github.com/westonganger/spreadsheet_architect/pull/18) - Fix controller bug when using an non-ActiveRecord ORM only within Rails
-- **2.1.0** - June 20, 2018
+
+- **2.1.0** - June 20, 2018 - [View Diff](https://github.com/westonganger/spreadsheet_architect/compare/v2.0.2...v2.1.0)
   - [#15](https://github.com/westonganger/spreadsheet_architect/pull/15) - Improved the method symbolize_keys. This method did not work properly for nested objects.
   - [PR #15](https://github.com/westonganger/spreadsheet_architect/pull/15) - Added the ability to pass `:text_wrap` option within the `:alignment` style
   - Make axlsx styles higher precendence over Spreadsheet Architect style aliases
@@ -66,14 +95,17 @@ CHANGELOG
   - Due to [RODF bug](https://github.com/thiagoarrais/rodf/issues/19) convert all Date and Time cells to String in ODS spreadsheets
   - Improve test suite
   - Dont test against Ruby versions that Rails no longer supports. Gem code should remain compatible with Ruby 1.9.3.
-- **2.0.2** - July 14 2017
+
+- **2.0.2** - July 14 2017 - [View Diff](https://github.com/westonganger/spreadsheet_architect/compare/v2.0.1...v2.0.2)
   - Fix bug with range styles rows option not counting headers
   - Fix bug with range styles rows :all option
-- **2.0.1** - February 16 2017
+
+- **2.0.1** - February 16 2017 - [View Diff](https://github.com/westonganger/spreadsheet_architect/compare/v2.0.0...v2.0.1)
   - Fix bug where `SpreadsheetArchitect.default_options` and `SPREADSHEET_OPTIONS` were being overwritten
   - Fix bug where col_styles ignored previous styles on header when using `include_header` option
   - Errors now try to provide which value is the cause
-- **2.0.0** - January 28 2017
+
+- **2.0.0** - January 28 2017 - [View Diff](https://github.com/westonganger/spreadsheet_architect/compare/v1.4.8...v2.0.0)
   - Add to xlsx: `merges`, `column_styles`, `range_styles`, `borders`, `column_widths` multi-row headers, date/time default format_code
   - Add `column_types` option for xlsx and ods
   - Add ability to make multi-sheet spreadsheets in XLSX & ODS
@@ -81,52 +113,74 @@ CHANGELOG
   - Add Examples
   - Add Axlsx Style Reference
   - Refractor into smaller files
+
 - **1.4.8** - December 6 2016
   - Lock `rodf` gem to v0.3.7 for last v1 version of this gem
+
 - **1.4.7** - November 7 2016
   - Fix method arguments for `to_rodf_spreadsheet` method
+
 - **1.4.6** - May 16 2016
   - Fix hash syntax for support of ruby v2.1 and below
+
 - **1.4.5** - May 4 2016
   - Bug fixes
+
 - **1.4.4** - May 3 2016
   - Add Ability to add format_code to all numbers body rows
+
 - **1.4.3** - May 3 2016
   - Bug fixes
+
 - **1.4.2** - May 3 2016
   - Add to_axlsx_package, to_rodf_spreadsheet methods for the item to be further manipulated. Ex. axlsx_styler
+
 - **1.4.1** - May 2 2016
   - Add rails generator for project defaults initializer
+
 - **1.4.0** - April 29 2016
   - Add to_xlsx, to_ods, & to_csv to SpreadsheetArchitect model for direct calling by passing in cell data
+
 - **1.3.0** - April 21 2016
   - Add ability to create class/model and project option defaults
+
 - **1.2.5** - March 25 2016
   - Fix each_with_index bug
+
 - **1.2.4** - March 24 2016
   - Fix cell type logic for symbol methods
+
 - **1.2.3** - March 20 2016
   - Fix cell type logic
+
 - **1.2.2** - March 19 2016
   - Make cell type numeric if value is numeric
+
 - **1.2.1** - March 13 2016
   - Better error reporting
   - Fix for Plain ruby models
+
 - **1.2.0** - March 10 2016
   - Fix Bug: first row data repeated for all records on custom values
+
 - **1.1.0** - March 3 2016
   - Breaking Change - Move spreadsheet_columns method from the class to the instance
   - Fix Bug: remove default underline on cells
+
 - **1.0.4** - March 1 2016
   - Extract helper methods to seperate module
   - Improve readme
+
 - **1.0.3** - March 1 2016
   - Fix/Improve renderers
   - Fix header default background color
   - Fix default columns
+
 - **1.0.2** - February 26 2016
   - Enhance Style options
+
 - **1.0.1** - February 26 2016
   - Fix bug in renderers
+
 - **1.0.0** - February 26 2016
   - Gem Initial Release

data/README.md

@@ -1,9 +1,8 @@
 # Spreadsheet Architect
 
 <a href="https://badge.fury.io/rb/spreadsheet_architect" target="_blank"><img height="21" style='border:0px;height:21px;' border='0' src="https://badge.fury.io/rb/spreadsheet_architect.svg" alt="Gem Version"></a>
-<a href='https://travis-ci.com/westonganger/spreadsheet_architect' target='_blank'><img height='21' style='border:0px;height:21px;' src='https://api.travis-ci.org/westonganger/spreadsheet_architect.svg?branch=master' border='0' alt='Build Status' /></a>
+<a href='https://github.com/westonganger/spreadsheet_architect/actions' target='_blank'><img src="https://github.com/westonganger/spreadsheet_architect/workflows/Tests/badge.svg" style="max-width:100%;" height='21' style='border:0px;height:21px;' border='0' alt="CI Status"></a>
 <a href='https://rubygems.org/gems/spreadsheet_architect' target='_blank'><img height='21' style='border:0px;height:21px;' src='https://ruby-gem-downloads-badge.herokuapp.com/spreadsheet_architect?label=rubygems&type=total&total_label=downloads&color=brightgreen' border='0' alt='RubyGems Downloads' /></a>
-<a href='https://ko-fi.com/A5071NK' target='_blank'><img height='22' style='border:0px;height:22px;' src='https://az743702.vo.msecnd.net/cdn/kofi1.png?v=a' border='0' alt='Buy Me a Coffee' /></a>
 
 Spreadsheet Architect is a library that allows you to create XLSX, ODS, or CSV spreadsheets super easily from ActiveRecord relations, plain Ruby objects, or tabular data.
 
@@ -92,7 +91,7 @@ If you want to use a different method name then `spreadsheet_columns` you can pa
 Post.to_xlsx(instances: posts, spreadsheet_columns: :my_special_method)
 ```
 
-Alternatively, you can pass a Proc/lambda to the `spreadsheet_columns` option. For those purists that really dont want to define any extra `spreadsheet_columns` instance method on your model, this option can help you work with that methodology.
+Alternatively, you can pass a Proc to the `spreadsheet_columns` option. For those purists that really dont want to define any extra `spreadsheet_columns` instance method on your model, this option can help you work with that methodology.
 
 ```ruby
 Post.to_xlsx(instances: posts, spreadsheet_columns: Proc.new{|instance|
@@ -104,7 +103,8 @@ Post.to_xlsx(instances: posts, spreadsheet_columns: Proc.new{|instance|
     :published_at, # uses the method name as header title Einstance. 'Published At'
     ['# of Views', :number_of_views, :float],
     ['Rating', :rating],
-    ['Category/Tags', "#{instance.category.name} - #{instance.tags.collect(&:name).join(', ')}"]
+    ['Category/Tags', "#{instance.category.name} - #{instance.tags.collect(&:name).join(', ')}"],
+    ['URL', :url, (val.start_with?("http") ? :hyperlink : :string)],
   ]
 })
 ```
@@ -190,20 +190,16 @@ File.open('path/to/multi_sheet_file.xlsx', 'w+b') do |f|
 end
 ```
 
-See this file for more details: https://github.com/westonganger/spreadsheet_architect/blob/master/test/spreadsheet_architect/multi_sheet_test.rb
-
 ### ODS
 ```ruby
 ods_spreadsheet = SpreadsheetArchitect.to_rodf_spreadsheet({headers: headers, data: data})
 ods_spreadsheet = SpreadsheetArchitect.to_rodf_spreadsheet({headers: headers, data: data}, ods_spreadsheet)
 
 File.open('path/to/multi_sheet_file.ods', 'w+b') do |f|
-  f.write ods_spreadsheet
+  f.write ods_spreadsheet.bytes
 end
 ```
 
-See this file for more details: https://github.com/westonganger/spreadsheet_architect/blob/master/test/spreadsheet_architect/multi_sheet_test.rb
-
 # Methods
 
 ## `to_xlsx(options={})`
@@ -215,17 +211,20 @@ See this file for more details: https://github.com/westonganger/spreadsheet_arch
 |**spreadsheet_columns**<br>*Proc/Symbol/String*| Use this option to override or define the spreadsheet columns. Normally, if this option is not specified and are using the instances option/ActiveRecord relation, it uses the classes custom `spreadsheet_columns` method or any custom defaults defined.<br>If neither of those and is an ActiveRecord model, then it will falls back to the models `self.column_names` | Cannot be used with the `:data` option.<br><br>If a Proc value is passed it will be evaluated on the instance object.<br><br>If a Symbol or String value is passed then it will search the instance for a method name that matches and call it. |
 |**headers**<br>*Array / 2D Array*| |Data for the header row cells. If using on a class/relation, this defaults to the ones provided via `spreadsheet_columns`. Pass `false` to skip the header row. |
 |**sheet_name**<br>*String*|`Sheet1`||
-|**header_style**<br>*Hash*|`{background_color: "AAAAAA", color: "FFFFFF", align: :center, font_name: 'Arial', font_size: 10, bold: false, italic: false, underline: false}`|See all available style options [here](https://github.com/westonganger/spreadsheet_architect/blob/master/docs/axlsx_style_reference.md)|
-|**row_style**<br>*Hash*|`{background_color: nil, color: "000000", align: :left, font_name: 'Arial', font_size: 10, bold: false, italic: false, underline: false, format_code: nil}`|Styles for non-header rows. See all available style options [here](https://github.com/westonganger/spreadsheet_architect/blob/master/docs/axlsx_style_reference.md)|
-|**column_styles**<br>*Array*||[See this example for usage](https://github.com/westonganger/spreadsheet_architect/blob/master/test/unit/kitchen_sink_test.rb)|
-|**range_styles**<br>*Array*||[See this example for usage](https://github.com/westonganger/spreadsheet_architect/blob/master/test/unit/kitchen_sink_test.rb)|
-|**conditional_row_styles**<br>*Array*||[See this example for usage](https://github.com/westonganger/spreadsheet_architect/blob/master/test/unit/kitchen_sink_test.rb). The if/unless proc will called with the following args: `row_index`, `row_data`|
-|**merges**<br>*Array*||Merge cells. [See this example for usage](https://github.com/westonganger/spreadsheet_architect/blob/master/test/unit/kitchen_sink_test.rb). Warning merges cannot overlap eachother, if you attempt to do so Excel will claim your spreadsheet is corrupt and refuse to open your spreadsheet.|
-|**borders**<br>*Array*||[See this example for usage](https://github.com/westonganger/spreadsheet_architect/blob/master/test/unit/kitchen_sink_test.rb)|
-|**column_types**<br>*Array*||Valid types for XLSX are :string, :integer, :float, :date, :time, :boolean, nil = auto determine.|
+|**header_style**<br>*Hash*|`{background_color: "AAAAAA", color: "FFFFFF", align: :center, font_name: 'Arial', font_size: 10, bold: false, italic: false, underline: false}`|See all available style options [here](./docs/axlsx_style_reference.md)|
+|**row_style**<br>*Hash*|`{background_color: nil, color: "000000", align: :left, font_name: 'Arial', font_size: 10, bold: false, italic: false, underline: false, format_code: nil}`|Styles for non-header rows. See all available style options [here](./docs/axlsx_style_reference.md)|
+|**column_styles**<br>*Array*||[See this example for usage](./test/unit/kitchen_sink_test.rb)|
+|**range_styles**<br>*Array*||[See this example for usage](./test/unit/kitchen_sink_test.rb)|
+|**conditional_row_styles**<br>*Array*||[See this example for usage](./test/unit/kitchen_sink_test.rb). The if/unless proc will called with the following args: `row_index`, `row_data`|
+|**merges**<br>*Array*||Merge cells. [See this example for usage](./test/unit/kitchen_sink_test.rb). Warning merges cannot overlap eachother, if you attempt to do so Excel will claim your spreadsheet is corrupt and refuse to open your spreadsheet.|
+|**borders**<br>*Array*||[See this example for usage](./test/unit/kitchen_sink_test.rb)|
+|**column_types**<br>*Array*||Valid types for XLSX are :string, :integer, :float, :date, :time, :boolean, :hyperlink, nil = auto determine. You may also pass a Proc which evaluates to any of the valid types, for example `->(cell_val){ cell_val.start_with?('http') ? :hyperlink : :string }`|
 |**column_widths**<br>*Array*||Sometimes you may want explicit column widths. Use nil if you want a column to autofit again.|
 |**freeze_headers**<br>*Boolean*||Make all header rows frozen/fixed so they do not scroll.|
-|**freeze**<br>* Hash*|`{rows: (1..4), columns: :all}`|Make all specified rows and columns frozen/fixed so they do not scroll.|
+|**freeze**<br>*Hash*||Make all specified row and/or column frozen/fixed so they do not scroll. See [example usage](./test/unit/xlsx_freeze_test.rb)|
+|**skip_defaults**<br>*Boolean*|`false`|Removes defaults and default styles. Particularily useful for heavily customized spreadsheets where the default styles get in the way.|
+|**escape_formulas**<br>*Boolean* or *Array*|`true`|Pass a single boolean to apply to all cells, or an array of booleans to control column-by-column. Advisable to be set true when involved with untrusted user input. See [an example of the underlying functionality](https://github.com/caxlsx/caxlsx/blob/master/examples/escape_formula_example.md). NOTE: Header row cells are not escaped. |
+|**use_zero_based_row_index**<br>*Boolean*|`false`|Allows you to use zero-based row indexes when defining `range_styles`, `merges`, etc. Recomended to set this option for the whole project rather than per call. The original reason it was designed to be 1-based is because spreadsheet row numbers actually start with 1.|
 
 ## `to_axlsx_spreadsheet(options={}, axlsx_package_to_join=nil)`
 Same options as `to_xlsx`
@@ -241,7 +240,8 @@ Same options as `to_xlsx`
 |**sheet_name**<br>*String*|`Sheet1`||
 |**header_style**<br>*Hash*|`{background_color: "AAAAAA", color: "FFFFFF", align: :center, font_size: 10, bold: true}`|Note: Currently ODS only supports these options|
 |**row_style**<br>*Hash*|`{background_color: nil, color: "000000", align: :left, font_size: 10, bold: false}`|Styles for non-header rows. Currently ODS only supports these options|
-|**column_types**<br>*Array*||Valid types for ODS are :string, :float, :date, :time, :boolean, nil = auto determine. Due to [RODF Issue #19](https://github.com/thiagoarrais/rodf/issues/19), :date/:time will be converted to :string |
+|**column_types**<br>*Array*||Valid types for ODS are :string, :float, :date, :time, :boolean, :hyperlink, nil = auto determine. Due to [RODF Issue #19](https://github.com/thiagoarrais/rodf/issues/19), :date/:time will be converted to :string. You may also pass a Proc which evaluates to any of the valid types, for example `->(cell_val){ cell_val.start_with?('http') ? :hyperlink : :string }` |
+|**skip_defaults**<br>*Boolean*|`false`|Skip defaults and default styles. Particularily useful for heavily customized spreadsheets where the default styles get in the way.|
 
 ## `to_rodf_spreadsheet(options={}, spreadsheet_to_join=nil)`
 Same options as `to_ods`
@@ -302,15 +302,16 @@ SpreadsheetArchitect.default_options = {
   merges: [],
   borders: [],
   column_types: [],
+  use_zero_based_row_index: false,
 }
 ```
 
 # Kitchen Sink Examples with Styling for XLSX and ODS
-See this example: https://github.com/westonganger/spreadsheet_architect/blob/master/test/unit/kitchen_sink_test.rb
+See this example: [test/unit/kitchen_sink_test.rb](./test/unit/kitchen_sink_test.rb)
 
 # Axlsx Style Reference
 
-I have compiled a list of all available style options for axlsx here: https://github.com/westonganger/spreadsheet_architect/blob/master/docs/axlsx_style_reference.md
+I have compiled a list of all available style options for axlsx here: [docs/axlsx_style_reference.md](./docs/axlsx_style_reference.md)
 
 # Testing / Validating your Spreadsheets
 
@@ -328,7 +329,3 @@ At this time the spreadsheets generated by the test suite are manually inspected
 # Credits
 
 Created & Maintained by [Weston Ganger](https://westonganger.com) - [@westonganger](https://github.com/westonganger)
-
-For any consulting or contract work please contact me via my company website: [Solid Foundation Web Development](https://solidfoundationwebdev.com)
-
-[![Solid Foundation Web Development Logo](https://solidfoundationwebdev.com/logo-sm.png)](https://solidfoundationwebdev.com)

data/lib/spreadsheet_architect/class_methods/ods.rb

@@ -11,7 +11,7 @@ module SpreadsheetArchitect
       opts = SpreadsheetArchitect::Utils.get_options(opts, self)
       options = SpreadsheetArchitect::Utils.get_cell_data(opts, self)
 
-      if options[:column_types] && !(options[:column_types].compact.collect(&:to_sym) - SpreadsheetArchitect::ODS_COLUMN_TYPES).empty?
+      if options[:column_types] && !(options[:column_types].compact.reject{|x| x.is_a?(Proc) }.collect(&:to_sym) - SpreadsheetArchitect::ODS_COLUMN_TYPES).empty?
         raise SpreadsheetArchitect::Exceptions::ArgumentError.new("Invalid column type. Valid ODS values are #{SpreadsheetArchitect::ODS_COLUMN_TYPES}")
       end
 
@@ -21,7 +21,7 @@ module SpreadsheetArchitect
 
       spreadsheet.office_style :header_style, family: :cell do
         if options[:header_style]
-          SpreadsheetArchitect::Utils.convert_styles_to_ods(options[:header_style]).each do |prop, styles|
+          SpreadsheetArchitect::Utils::ODS.convert_styles(options[:header_style]).each do |prop, styles|
             styles.each do |k,v|
               property prop.to_sym, k => v
             end
@@ -31,7 +31,7 @@ module SpreadsheetArchitect
 
       spreadsheet.office_style :row_style, family: :cell do
         if options[:row_style]
-          SpreadsheetArchitect::Utils.convert_styles_to_ods(options[:row_style]).each do |prop, styles|
+          SpreadsheetArchitect::Utils::ODS.convert_styles(options[:row_style]).each do |prop, styles|
             styles.each do |k,v|
               property prop.to_sym, k => v
             end
@@ -54,15 +54,25 @@ module SpreadsheetArchitect
           row do 
             row_data.each_with_index do |val, i|
               if options[:column_types]
-                type = options[:column_types][i]
+                provided_column_type = options[:column_types][i]
+
+                if provided_column_type.is_a?(Proc)
+                  provided_column_type = provided_column_type.call(val)
+                end
               end
 
-              if (type && [:date, :time].include?(type)) || val.respond_to?(:strftime)
-                type = :string
-                val = val.to_s 
+              type = SpreadsheetArchitect::Utils::ODS.get_cell_type(val, provided_column_type) 
+
+              cell_opts = {
+                style: :row_style, 
+                type: type,
+              }
+
+              if provided_column_type == :hyperlink
+                cell_opts[:url] = val
               end
 
-              cell val, style: :row_style, type: type
+              cell(val, **cell_opts)
             end
           end
         end

data/lib/spreadsheet_architect/class_methods/xlsx.rb

@@ -1,5 +1,4 @@
 require 'axlsx'
-require 'axlsx_styler'
 
 require 'spreadsheet_architect/axlsx_string_width_patch'
 
@@ -14,7 +13,7 @@ module SpreadsheetArchitect
       opts = SpreadsheetArchitect::Utils.get_options(opts, self)
       options = SpreadsheetArchitect::Utils.get_cell_data(opts, self)
 
-      if options[:column_types] && !(options[:column_types].compact.collect(&:to_sym) - SpreadsheetArchitect::XLSX_COLUMN_TYPES).empty?
+      if options[:column_types] && !(options[:column_types].compact.reject{|x| x.is_a?(Proc) }.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
 
@@ -79,16 +78,27 @@ module SpreadsheetArchitect
 
           types = []
           styles = []
-          row_data.each_with_index do |x,i|
-            if (x.respond_to?(:empty) ? x.empty? : x.nil?)
+          hyperlink_cell_indexes = []
+
+          row_data.each_with_index do |val,i|
+            if (val.respond_to?(:empty) ? val.empty? : val.nil?)
               types[i] = nil
               styles[i] = row_style_index
             else
               if options[:column_types]
-                types[i] = options[:column_types][i]
+                provided_column_type = options[:column_types][i]
+
+                if provided_column_type.is_a?(Proc)
+                  provided_column_type = provided_column_type.call(val)
+                end
               end
 
-              types[i] ||= SpreadsheetArchitect::Utils::XLSX.get_type(x)
+              if provided_column_type == :hyperlink
+                hyperlink_cell_indexes << i
+                row_data[i] = val.to_s
+              end
+
+              types[i] = SpreadsheetArchitect::Utils::XLSX.get_type(val, provided_column_type)
 
               if [:date, :time].include?(types[i])
                 if types[i] == :date
@@ -104,7 +114,12 @@ module SpreadsheetArchitect
             end
           end
 
-          sheet.add_row row_data, style: styles, types: types
+          sheet.add_row row_data, style: styles, types: types, escape_formulas: options[:escape_formulas]
+
+          hyperlink_cell_indexes.each do |cell_index|
+            cell_ref = "#{SpreadsheetArchitect::Utils::XLSX::COL_NAMES[cell_index]}#{row_index+1}"
+            sheet.add_hyperlink location: row_data[cell_index], ref: cell_ref
+          end
 
           if options[:conditional_row_styles]
             options[:conditional_row_styles] = SpreadsheetArchitect::Utils.hash_array_symbolize_keys(options[:conditional_row_styles])
@@ -133,12 +148,12 @@ module SpreadsheetArchitect
 
           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)
+              x[:range] = SpreadsheetArchitect::Utils::XLSX.range_hash_to_str(x[:range], max_row_length, num_rows, use_zero_based_row_index: options[:use_zero_based_row_index])
             else
               SpreadsheetArchitect::Utils::XLSX.verify_range(x[:range], num_rows)
             end
 
-            sheet.add_border x[:range], (x[:border_styles] || x[:styles])
+            sheet.add_border x[:range], (x[:border_styles] || x[:styles] || Axlsx::Border::EDGES)
           end
         end
 
@@ -182,7 +197,7 @@ module SpreadsheetArchitect
             styles = SpreadsheetArchitect::Utils::XLSX.convert_styles_to_axlsx(x[:styles])
 
             if x[:range].is_a?(Hash)
-              x[:range] = SpreadsheetArchitect::Utils::XLSX.range_hash_to_str(x[:range], max_row_length, num_rows)
+              x[:range] = SpreadsheetArchitect::Utils::XLSX.range_hash_to_str(x[:range], max_row_length, num_rows, use_zero_based_row_index: options[:use_zero_based_row_index])
             else
               SpreadsheetArchitect::Utils::XLSX.verify_range(x[:range], num_rows)
             end
@@ -196,7 +211,7 @@ module SpreadsheetArchitect
 
           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)
+              x[:range] = SpreadsheetArchitect::Utils::XLSX.range_hash_to_str(x[:range], max_row_length, num_rows, use_zero_based_row_index: options[:use_zero_based_row_index])
             else
               SpreadsheetArchitect::Utils::XLSX.verify_range(x[:range], num_rows)
             end
@@ -212,33 +227,62 @@ module SpreadsheetArchitect
           end
 
         elsif options[:freeze]
-          options[:freeze] = SpreadsheetArchitect::Utils.symbolize_keys(options[:freeze])
+          case options[:freeze][:type].to_s
+          when "split_panes"
+            options[:freeze][:state] == "split"
+          when "frozen", "freeze"
+            options[:freeze][:state] == "frozen"
+          end
+
+          if options[:freeze][:rows]
+            options[:freeze][:row] ||= options[:freeze][:rows]
+          end
+
+          if options[:freeze][:columns]
+            options[:freeze][:column] ||= options[:freeze][:columns]
+          end
+
+          if options[:freeze][:row] == :all
+            options[:freeze][:row] = nil
+          elsif options[:freeze][:row].is_a?(Range)
+            options[:freeze][:row] = options[:freeze][:row].last
+          end
+
+          if options[:freeze][:column] == :all
+            options[:freeze][:column] = nil
+          elsif options[:freeze][:column].is_a?(Range)
+            options[:freeze][:column] = options[:freeze][:column].last
+          end
+
+          if !options[:freeze][:row] && !options[:freeze][:column]
+            raise SpreadsheetArchitect::Exceptions::ArgumentError.new("Missing required :row or :column value in the :freeze option hash")
+          elsif options[:freeze][:row] && !options[:freeze][:row].is_a?(Integer)
+            raise SpreadsheetArchitect::Exceptions::ArgumentError.new("Invalid :row value provided for in :freeze option hash, must be an Integer")
+          elsif options[:freeze][:column] && !options[:freeze][:column].is_a?(Integer)
+            raise SpreadsheetArchitect::Exceptions::ArgumentError.new("Invalid :column value provided for in :freeze option hash, must be an Integer")
+          end
 
           sheet.sheet_view.pane do |pane|
-            pane.state = :frozen
+            pane.state = (options[:freeze][:state] || :frozen).to_sym ### Other options are :split and :frozen_split
 
-            ### 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
+            if options[:freeze][:active_pane]
+              pane.active_pane = options[:freeze][:active_pane].to_sym
             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
+            if options[:freeze][:top_left_cell]
+              pane.top_left_cell = options[:freeze][:top_left_cell]
+            end
+
+            if options[:freeze][:row]
+              if options[:use_zero_based_row_index]
+                options[:freeze][:row] += 1
               end
+
+              pane.y_split = options[:freeze][:row]
+            end
+
+            if options[:freeze][:column]
+              pane.x_split = options[:freeze][:column]
             end
           end
         end

data/lib/spreadsheet_architect/exceptions.rb

@@ -14,17 +14,27 @@ module SpreadsheetArchitect
     end
 
     class InvalidRangeError < ArgumentError
-      def initialize(type, range)
-        case type
-        when :columns, :rows
-          super("Invalid range `#{range}` passed. Some of the #{type} specified were greater than the total number of #{type}")
-        when :format
-          super("Invalid range `#{range}` passed. Format must be as follows: A1:D4")
-        when :type
-          super("Invalid range type `#{range}`. Valid types are String and Hash")
-        else
-          super("Invalid range `#{range}` passed.")
+      def initialize(type, range, message: nil)
+        default_msg = "Invalid range `#{range}` passed"
+
+        if message.nil?
+          case type
+          when :missing_range_keys
+            message = "Missing :rows or :columns key"
+          when :format
+            message = "Format must be as follows: A1:D4"
+          when :type
+            message = "Valid types are Hash and String"
+          end
         end
+
+        super([default_msg, message].compact.join(". "))
+      end
+    end
+
+    class InvalidRangeValue < ArgumentError
+      def initialize(type, range)
+        super("Invalid range `#{range}` passed. Some of the :#{type} specified are either an invalid value or are greater than the total number of #{type}")
       end
     end
 
@@ -34,9 +44,16 @@ module SpreadsheetArchitect
       end
     end
 
-    class InvalidRangeStylesOptionError < ArgumentError
-      def initialize(type, opt)
-        super("Invalid or missing :#{type} option for `#{opt}`. :#{type} can be an integer, range, or :all")
+    class InvalidRangeOptionError < ArgumentError
+      def initialize(key, opt)
+        default_msg = "Invalid :#{key} option for `#{opt}`"
+
+        case key
+        when :columns, :rows
+          message = ":#{key} can be an integer, range, or :all"
+        end
+
+        super([default_msg, message].compact.join(". "))
       end
     end