spreadsheet_architect 5.0.0 → 5.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c88ecaffa3abed6ef127dc13d42c612ebf224c6d8552590d68ae544af2713f93
-  data.tar.gz: d0e864c2f50e99040f932da595b7270dd0e9c0161fc1189e6d99cb43126f6b5a
+  metadata.gz: ee7b9dd8d17310dd0bd673b0cab5dd6d098ec264273a4f149ce4ec9d7d94e5a9
+  data.tar.gz: '078a43ed925d5dbdfba5ae954235a2f408d1415499633316ae0e02ac81e9709f'
 SHA512:
-  metadata.gz: dfc0caea596d57bd5aa88cd3b5ff3cebfca8b1299d1660e9995ca93837746d21420a90e0f427df9b3f8e73c13914a24b137572c005ee16fafdeeb6ddaf18b95d
-  data.tar.gz: c31f408e271453d46454e4f85ad2437a2539e39973186a8889c917a338f9e5f57f9ef3f3f28797955d61f8daa6a7100ffb46624ab3974c4bfd9273cc5cacba29
+  metadata.gz: 26f7ed771240d97d512bc03ee39ffdf089d55ba0cf911a9dde5962be284aab7feb1183008bf82b97fc5ddb4c09137a4b9448dfda9f8dc035399c778123745ccd
+  data.tar.gz: 4dc96c75de5dfa63b3a9919a9e7d37dcadf2463ac941f1cbf6cfbdb385191fe254c40de52c79d33225576108a07c6873ebef6be6a721212a379a37814d04c77e

data/CHANGELOG.md

@@ -1,10 +1,14 @@
 CHANGELOG
 ---------
 
-- **Unreleased** - [View Diff](https://github.com/westonganger/spreadsheet_architect/compare/v5.0.0...master)
+- **Unreleased** - [View Diff](https://github.com/westonganger/spreadsheet_architect/compare/v5.0.1...master)
   - Nothing yet
 
-- **5.0.0** - [View Diff](https://github.com/westonganger/spreadsheet_architect/compare/v4.2.0...v5.0.0)
+- **v5.0.1** - [View Diff](https://github.com/westonganger/spreadsheet_architect/compare/v5.0.0...v5.0.1)
+  - [#53](https://github.com/westonganger/spreadsheet_architect/pull/53) - Remove legacy string_width patch for axlsx 3.1 and below
+  - [#57](https://github.com/westonganger/spreadsheet_architect/pull/57) - Fix typo in error message for `:conditional_row_styles`
+
+- **5.0.0** - Oct 30, 2022 - [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.
@@ -25,7 +29,7 @@ CHANGELOG
   - 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 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)

data/README.md

@@ -1,8 +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://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://github.com/westonganger/spreadsheet_architect/actions' target='_blank'><img src="https://github.com/westonganger/spreadsheet_architect/actions/workflows/test.yml/badge.svg?branch=master" 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://img.shields.io/gem/dt/spreadsheet_architect?color=brightgreen&label=Rubygems%20Downloads' border='0' alt='RubyGems Downloads' /></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.
 
@@ -25,7 +25,7 @@ gem 'spreadsheet_architect'
 
 ### Tabular (Array) Data
 
-The simplest and preffered usage is to simply create the data array yourself.
+The simplest and preferred usage is to simply create the data array yourself.
 
 ```ruby
 headers = ['Col 1','Col 2','Col 3']
@@ -35,7 +35,7 @@ SpreadsheetArchitect.to_ods(headers: headers, data: data)
 SpreadsheetArchitect.to_csv(headers: headers, data: data)
 ```
 
-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)
+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 any loss in performance starts to matter.
 
 ### Rails Relations or an Array of plain Ruby object instances
 
@@ -91,16 +91,16 @@ 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 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|
+Post.to_xlsx(instances: posts, spreadsheet_columns: ->(instance){
   [
     ['Title', :title],
     ['Content', instance.content.strip],
     ['Author', (instance.author.name if instance.author)],
     ['Published?', (instance.published ? 'Yes' : 'No')],
-    :published_at, # uses the method name as header title Einstance. 'Published At'
+    :published_at, # uses the method name as header title Ex. 'Published At'
     ['# of Views', :number_of_views, :float],
     ['Rating', :rating],
     ['Category/Tags', "#{instance.category.name} - #{instance.tags.collect(&:name).join(', ')}"],
@@ -171,7 +171,7 @@ class PostsController < ActionController::Base
       format.html
       format.xlsx { render xlsx: @posts.to_xlsx(headers: false) }
       format.ods { render ods: Post.to_ods(instances: @posts) }
-      format.csv{ render csv: @posts.to_csv(headers: false), file_name: 'articles' }
+      format.csv{ render csv: @posts.to_csv(headers: false), filename: 'articles' }
     end
   end
 end
@@ -213,18 +213,18 @@ end
 |**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](./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_styles**<br>*Array*||[See the kitchen sink example for usage](./test/unit/xlsx/general_test.rb)|
+|**range_styles**<br>*Array*||[See the kitchen sink example for usage](./test/unit/xlsx/general_test.rb)|
+|**conditional_row_styles**<br>*Array*||[See the kitchen sink example for usage](./test/unit/xlsx/general_test.rb). The if/unless proc will called with the following args: `row_index`, `row_data`|
+|**merges**<br>*Array*||Merge cells. [See the kitchen sink example for usage](./test/unit/xlsx/general_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 the kitchen sink example for usage](./test/unit/xlsx/general_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*||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.|
+|**use_zero_based_row_index**<br>*Boolean*|`false`|Allows you to use zero-based row indexes when defining `range_styles`, `merges`, etc. Recommended 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 +241,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, :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.|
+|**skip_defaults**<br>*Boolean*|`false`|Skip defaults and default styles. Particularly 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`
@@ -307,12 +307,17 @@ SpreadsheetArchitect.default_options = {
 ```
 
 # Kitchen Sink Examples with Styling for XLSX and ODS
-See this example: [test/unit/kitchen_sink_test.rb](./test/unit/kitchen_sink_test.rb)
+
+See `test "kitchen sink"` for [XLSX](./test/unit/xlsx/general_test.rb) and [ODS](./test/unit/ods/general_test.rb)
 
 # Axlsx Style Reference
 
 I have compiled a list of all available style options for axlsx here: [docs/axlsx_style_reference.md](./docs/axlsx_style_reference.md)
 
+# Tips for Reducing Memory Usage
+- Use the `:data` option instead of active record relations
+- Utilize the [`light_record`](https://github.com/Paxa/light_record) gem
+
 # Testing / Validating your Spreadsheets
 
 A wise word of advice, when testing your spreadsheets I recommend to use Excel instead of LibreOffice. This is because I have seen through testing, that where LibreOffice seems to just let most incorrect things just slide on through, Excel will not even open the spreadsheet as apparently it is much more strict about the spreadsheet validations. This will help you better identify any incorrect styling or customization issues.
@@ -324,7 +329,7 @@ We use the `appraisal` gem for testing multiple versions of `axlsx`. Please use
 1. `bundle exec appraisal install`
 2. `bundle exec appraisal rake test`
 
-At this time the spreadsheets generated by the test suite are manually inspected. After running the tests, the test output can be viewed at `tmp/#{alxsx_version}/*`
+At this time the spreadsheets generated by the test suite are manually inspected. After running the tests, the test output can be viewed in `tmp/`
 
 # Credits
 

data/lib/spreadsheet_architect/class_methods/xlsx.rb

@@ -1,7 +1,5 @@
 require 'axlsx'
 
-require 'spreadsheet_architect/axlsx_string_width_patch'
-
 module SpreadsheetArchitect
   module ClassMethods
 

data/lib/spreadsheet_architect/utils/xlsx.rb

@@ -183,11 +183,11 @@ module SpreadsheetArchitect
 
         conditional_row_styles.each do |x|
           if x[:if] && x[:unless]
-            raise SpreadsheetArchitect::Exceptions::ArgumentError.new('Cannot pass both :if and :unless within the same :conditonal_row_styles entry')
+            raise SpreadsheetArchitect::Exceptions::ArgumentError.new('Cannot pass both :if and :unless within the same :conditional_row_styles entry')
           elsif !x[:if] && !x[:unless]
-            raise SpreadsheetArchitect::Exceptions::ArgumentError.new('Must pass either :if or :unless within the each :conditonal_row_styles entry')
+            raise SpreadsheetArchitect::Exceptions::ArgumentError.new('Must pass either :if or :unless within the each :conditional_row_styles entry')
           elsif !x[:styles]
-            raise SpreadsheetArchitect::Exceptions::ArgumentError.new('Must pass the :styles option within a :conditonal_row_styles entry')
+            raise SpreadsheetArchitect::Exceptions::ArgumentError.new('Must pass the :styles option within a :conditional_row_styles entry')
           end
 
           conditions_met = (x[:if] || x[:unless]).call(row_data, row_index)

data/lib/spreadsheet_architect/version.rb

@@ -1,3 +1,3 @@
 module SpreadsheetArchitect
-  VERSION = "5.0.0"
+  VERSION = "5.0.1".freeze
 end