spreadsheet_architect 3.3.0 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 98f8a3ed9a6547577bf17351106ea52fd0d10d8eff5369af35173eaad305a673
-  data.tar.gz: 3800e3f6170b478e2874f687bdc627dca549f95bce8d9ee489359e21cfac14ba
+  metadata.gz: f453f3bd541db38744f93c7803a473dea7f8dee0c9c45ab86523992c78bd6317
+  data.tar.gz: 5c92d3ac4e35db0c17bd4da1e4325d08700decf476546fde20a66aa6057dacdd
 SHA512:
-  metadata.gz: 0a66f1282fdae79e05e3ca5452aa2c1596578fb4052d571eb7eea1619cd854ec8612ee57dbd0155f46b369c1bd90c144a74d08811a505d772dd5723973c85270
-  data.tar.gz: bf4b69cdb84c27875c4dcf8d928370af9ae2ffdedf80e2e7339f97cfaf2720b16c7eef69e891a327e94bde20442d8f878084fffebfe9027b5930fe4deac061b7
+  metadata.gz: e89d0f1f1968275084495fdd420af039b61d7033606be0d9b63428fc3aab944baf82377103057fbf1ec43c91c02a7c48210bd81617ba55893ef998c3848265c0
+  data.tar.gz: ddfdcd2c578a1aa10dd2839368cdf99b897a49abf1a888bae40dbd08ad310f4ee26a5bc93ce9fdd484092b5f32ee4d5195c7cb5bdb466fcdf5dec6250e79603e

data/CHANGELOG.md

@@ -1,29 +1,59 @@
 CHANGELOG
 ---------
 
-- **Unreleased**
-  - Nothing Yet
-- **3.3.0**
+- **Unreleased** - [View Diff](https://github.com/westonganger/spreadsheet_architect/compare/v4.2.0...master)
+  - Nothing yet
+
+- **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** - 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** - 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
+  - Add XLSX option `:freeze` to freeze custom sections of your spreadsheet
+  - 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** - 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** - 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.
@@ -38,12 +68,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
@@ -51,14 +84,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
@@ -66,52 +102,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,16 +1,15 @@
 # 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.org/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.
 
 Key Features:
 
 - Dead simple custom spreadsheets with custom data
-- Data Sources: ActiveRecord relations, array of plain Ruby object instances, or tabular 2D Array Data
+- Data Sources: Tabular Data from an Array, ActiveRecord relations, or array of plain Ruby object instances
 - Easily style and customize spreadsheets
 - Create multi sheet spreadsheets
 - Setting Class/Model or Project specific defaults
@@ -22,10 +21,12 @@ Key Features:
 gem 'spreadsheet_architect'
 ```
 
-# General Usage 
+# General Usage
 
 ### Tabular (Array) Data
 
+The simplest and preffered usage is to simply create the data array yourself.
+
 ```ruby
 headers = ['Col 1','Col 2','Col 3']
 data = [[1,2,3], [4,5,6], [7,8,9]]
@@ -34,50 +35,25 @@ SpreadsheetArchitect.to_ods(headers: headers, data: data)
 SpreadsheetArchitect.to_csv(headers: headers, data: data)
 ```
 
-### Rails relation or an array of plain Ruby object instances
-
-```ruby
-posts = Post.order(name: :asc).where(published: true)
-# OR
-posts = 10.times.map{|i| Post.new(number: i)}
+Using this style will allow you to utilize any custom performance optimizations during your data generation process. This will come in handy when the spreadsheets get large and things start to get slow. One of my favourites for Rails is [light_record](https://github.com/Paxa/light_record)
 
-SpreadsheetArchitect.to_xlsx(instances: posts)
-SpreadsheetArchitect.to_ods(instances: posts)
-SpreadsheetArchitect.to_csv(instances: posts)
-```
+### Rails Relations or an Array of plain Ruby object instances
 
-**(Optional)** If you would like to add the methods `to_xlsx`, `to_ods`, `to_csv`, `to_axlsx_package`, `to_rodf_spreadsheet` to some class, you can simply include the SpreadsheetArchitect module to whichever classes you choose. A good default strategy is to simply add it to the ApplicationRecord or another parent class to have it available on all appropriate classes. For example:
+If you would like to add the methods `to_xlsx`, `to_ods`, `to_csv`, `to_axlsx_package`, `to_rodf_spreadsheet` to some class, you can simply include the SpreadsheetArchitect module to whichever classes you choose. For example:
 
 ```ruby
-class ApplicationRecord < ActiveRecord::Base
+class Post < ApplicationRecord
   include SpreadsheetArchitect
 end
 ```
 
-Then use it on the class or ActiveRecord relations of the class
-
-```ruby
-posts = Post.order(name: :asc).where(published: true)
-posts.to_xlsx
-posts.to_ods
-posts.to_csv
-
-# Plain Ruby Objects
-posts_array = 10.times.map{|i| Post.new(number: i)}
-Post.to_xlsx(instances: posts_array)
-Post.to_ods(instances: posts_array)
-Post.to_csv(instances: posts_array)
-```
-
-# Usage with Instances / ActiveRecord Relations
-
-When NOT using the `:data` option, ie. on an AR Relation or using the `:instances` option, Spreadsheet Architect requires an instance method defined on the class to generate the data. It looks for the `spreadsheet_columns` method on the class. If you are using on an ActiveRecord model and that method is not defined, it would fallback to the models `column_names` method (not recommended). If using the `:data` option this is ignored.
+When using on an AR Relation or using the `:instances` option, SpreadsheetArchitect requires an instance method to be defined on the class to generate the data. By default it looks for the `spreadsheet_columns` method on the class. If you are using on an ActiveRecord model and that method is not defined, it would fallback to the models `column_names` method. If using the `:data` option this is completely ignored.
 
 ```ruby
 class Post
+  include SpreadsheetArchitect
 
   def spreadsheet_columns
-
     ### Column format is: [Header, Cell Data / Method (if symbol) to Call on each Instance, (optional) Cell Type]
     [
       ['Title', :title],
@@ -89,15 +65,30 @@ class Post
       ['Rating', :rating],
       ['Category/Tags', "#{category.name} - #{tags.collect(&:name).join(', ')}"]
     ]
+  end
+
 end
+```
+
+Then use it on the class or ActiveRecord relations of the class
 
-Post.to_xlsx(instances: posts)
+```ruby
+posts = Post.order(name: :asc).where(published: true)
+posts.to_xlsx
+posts.to_ods
+posts.to_csv
+
+# Plain Ruby Objects
+posts_array = 10.times.map{|i| Post.new(number: i)}
+Post.to_xlsx(instances: posts_array)
+Post.to_ods(instances: posts_array)
+Post.to_csv(instances: posts_array)
 ```
 
-If you want to use a different method name then `spreadsheet_columns` you can pass a method name as a Symbol or String to the `spreadsheet_columns` option. Feel free to utilize the model-wide/project-wide defaults features if desired necessary.
+If you want to use a different method name then `spreadsheet_columns` you can pass a method name to the `:spreadsheet_columns` option.
 
 ```ruby
-Post.to_xlsx(instances: posts, spreadsheet_columns: :my_special_columns)
+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.
@@ -119,10 +110,19 @@ Post.to_xlsx(instances: posts, spreadsheet_columns: Proc.new{|instance|
 
 # Sending & Saving Spreadsheets
 
-### Method 1: Send Data via Rails Controller
+### Method 1: Save to a file manually
 
 ```ruby
+file_data = SpreadsheetArchitect.to_xlsx(headers: headers, data: data)
 
+File.open('path/to/file.xlsx', 'w+b') do |f|
+  f.write file_data
+end
+```
+
+### Method 2: Send Data via Rails Controller
+
+```ruby
 class PostsController < ActionController::Base
   respond_to :html, :xlsx, :ods, :csv
 
@@ -176,49 +176,32 @@ class PostsController < ActionController::Base
 end
 ```
 
-### Method 2: Save to a file manually
+# Multi Sheet Spreadsheets
 
-```ruby
-### Ex. with ActiveRecord relation
-file_data = Post.order(published_at: :asc).to_xlsx
-File.open('path/to/file.xlsx', 'w+b') do |f|
-  f.write file_data
-end
+### XLSX
 
-file_data = Post.order(published_at: :asc).to_ods
-File.open('path/to/file.ods', 'w+b') do |f|
-  f.write file_data
-end
-
-file_data = Post.order(published_at: :asc).to_csv
-File.open('path/to/file.csv', 'w+b') do |f|
-  f.write file_data
-end
-```
-
-# Multi Sheet XLSX Spreadsheets
 ```ruby
 axlsx_package = SpreadsheetArchitect.to_axlsx_package({headers: headers, data: data})
-axlsx_package = SpreadsheetArchitect.to_axlsx_package({headers: headers, data: data}, package)
+axlsx_package = SpreadsheetArchitect.to_axlsx_package({headers: headers, data: data}, axlsx_package)
 
-File.open('path/to/file.xlsx', 'w+b') do |f|
+File.open('path/to/multi_sheet_file.xlsx', 'w+b') do |f|
   f.write axlsx_package.to_stream.read
 end
 ```
 
-See this file for more details: https://github.com/westonganger/spreadsheet_architect/blob/master/test/spreadsheet_architect/multi_sheet_test.rb
+See this file for more details: [test/unit/multi_sheet_test.rb](./test/unit/multi_sheet_test.rb)
 
-### Multi Sheet ODS Spreadsheets
+### ODS
 ```ruby
 ods_spreadsheet = SpreadsheetArchitect.to_rodf_spreadsheet({headers: headers, data: data})
-ods_spreadsheet = SpreadsheetArchitect.to_rodf_spreadsheet({headers: headers, data: data}, spreadsheet)
+ods_spreadsheet = SpreadsheetArchitect.to_rodf_spreadsheet({headers: headers, data: data}, ods_spreadsheet)
 
-File.open('path/to/file.ods', 'w+b') do |f|
+File.open('path/to/multi_sheet_file.ods', 'w+b') do |f|
   f.write ods_spreadsheet
 end
 ```
 
-See this file for more details: https://github.com/westonganger/spreadsheet_architect/blob/master/test/spreadsheet_architect/multi_sheet_test.rb
+See this file for more details: [test/unit/multi_sheet_test.rb](./test/unit/multi_sheet_test.rb)
 
 # Methods
 
@@ -231,15 +214,18 @@ 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_styles_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_styles_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)|
+|**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, nil = auto determine.|
 |**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.|
+|**skip_defaults**<br>*Boolean*|`false`|Removes defaults and default styles. Particularily useful for heavily customized spreadsheets where the default styles get in the way.|
 
 ## `to_axlsx_spreadsheet(options={}, axlsx_package_to_join=nil)`
 Same options as `to_xlsx`
@@ -256,6 +242,7 @@ Same options as `to_xlsx`
 |**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 |
+|**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`
@@ -273,7 +260,9 @@ Same options as `to_ods`
 # Change class-wide default method options
 
 ```ruby
-class Post
+class Post < ApplicationRecord
+  include SpreadsheetArchitect
+
   def spreadsheet_columns
     [:name, :content]
   end
@@ -318,11 +307,11 @@ SpreadsheetArchitect.default_options = {
 ```
 
 # 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