caxlsx_builder 1.0.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 166ae65f2879639670efc80db83d33e769008aff2445b8f17a201ed859e739b0
-  data.tar.gz: 22925363722171bdf7141d22e8f964c2f5a28344dff5b18bec7ea7f69942a026
+  metadata.gz: 99c1449eab24e473b70cfb60c6fb9ffb8750bcfd3331bd4e1bc4d11fa172c5ea
+  data.tar.gz: d5a2146247674eb9bd7abb422a0e5635997759ec205619e1518a6e322af1c535
 SHA512:
-  metadata.gz: 94cf4c88f0c77fabc79e2e2699d7a1d2898abd1008901771fecb1d197e29692c9b473f3adf9775771c54e110d5075b07dbdfcfe8bcbff7ca6d73ec3f57557aa7
-  data.tar.gz: bc70d29e37edc0a7d289e617238ef6785aa94484c969a166426ab47ba7a378f10cb00d0ee17e3534aeb542b7dd7ee8f3cf0d4d69fd5d9d0761289ceda12edcb9
+  metadata.gz: 6018bbabd3db00124d3657aee635c6c082c313d321c38345b6322e9ebad534318b73331f897508b1b2863a9933e50ae3b70d1cc2ef0f83783815411f1502c1c3
+  data.tar.gz: 0fe4e1c53f7d85a28cb00e7804f77310971d8fae32994a84a590de651283d20f45b32601bb11be2ef252c930fe55cbfef5945582ef995f4c5519295cf9e8d48b

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## [1.1.1] - 2022-12-26
+
+- Fix 'rescue_errors' option
+
+## [1.1.0] - 2022-12-26
+
+- Allow to rescue errors when calling procs to generate cell, style, type or footer
+
 ## [1.0.0] - 2022-12-26
 
 - Initial release

data/lib/caxlsx_builder/builder.rb

@@ -7,12 +7,11 @@ module CaxlsxBuilder
     CELL_TYPES = %i[date time float integer richtext string boolean iso_8601 text].freeze
     # rubocop:enable Naming/VariableNumber
 
-    def initialize(sheets, &builder)
+    def initialize(sheets, options: { rescue_errors: false }, &builder)
       @sheets  = sheets
       @builder = builder
+      @options = options || { rescue_errors: false }
       @styles  = {}
-
-      # raise ArgumentError, "`sheets` must be a Hash[String, Array[untyped]]"
     end
 
     # @return [Axlsx::Package]
@@ -104,7 +103,7 @@ module CaxlsxBuilder
     # @param worksheet [Axlsx::Worksheet]
     def add_data_rows(collection, sheet, worksheet)
       collection.each do |item|
-        row = sheet.make_row(item)
+        row = sheet.make_row(item, rescue_errors: @options[:rescue_errors])
 
         # Nil row or empty row means no row
         compacted_row = row&.compact
@@ -113,7 +112,9 @@ module CaxlsxBuilder
         # Cells options returns an array which is logic: one option per sheet cell
         # But `sheet.add_row` does not handle arrays correctly, so I transform it to a valid
         # Hash using `cast_to_hash`.
-        cells   = sheet.cell_styles.map { |cell| cell_options(**cell.as_style(item)) }
+        cells   = sheet.cell_styles.map do |cell|
+          cell_options(**cell.as_style(item, rescue_errors: @options[:rescue_errors]))
+        end
         options = cast_to_hash(cells)
         worksheet.add_row(row, options)
       end
@@ -124,18 +125,24 @@ module CaxlsxBuilder
 
       footer = sheet.footers.map.with_index do |cell, index|
         if cell.respond_to?(:call)
-          cell.call(sheet.cells(index))
+          call_footer_proc(cell, sheet.cells(index))
         else
           cell
         end
-      rescue StandardError
-        nil
       end
 
       # Last row is the footer with the footer style applied
       worksheet.add_row(footer, style: @styles[:footer])
     end
 
+    def call_footer_proc(cell, cells)
+      cell.call(cells)
+    rescue StandardError => e
+      return nil if @options[:rescue_errors]
+
+      raise e
+    end
+
     # @return [Hash] The options to apply to a cell
     def cell_options(style: nil, type: nil)
       style = get_style(style)

data/lib/caxlsx_builder/cell.rb

@@ -7,13 +7,35 @@ module CaxlsxBuilder
       @type  = type
     end
 
-    def as_style(item)
-      style = @style.respond_to?(:call) ? @style.call(item) : @style
-      type  = @type.respond_to?(:call) ? @type.call(item) : @type
+    def as_style(item, rescue_errors: false)
+      style = @style.respond_to?(:call) ? call_style_proc(item, rescue_errors:) : @style
+      type  = @type.respond_to?(:call) ? call_type_proc(item, rescue_errors:) : @type
 
       { style:, type: }
     end
 
+    private
+
+    def call_style_proc(item, rescue_errors: false)
+      @style.call(item)
+    rescue StandardError => e
+      if rescue_errors
+        :default
+      else
+        raise e
+      end
+    end
+
+    def call_type_proc(item, rescue_errors: false)
+      @type.call(item)
+    rescue StandardError => e
+      if rescue_errors
+        :string
+      else
+        raise e
+      end
+    end
+
   end
 
 end

data/lib/caxlsx_builder/sheet.rb

@@ -25,12 +25,16 @@ module CaxlsxBuilder
       @styles[name] = style
     end
 
-    def make_row(item)
+    def make_row(item, rescue_errors: false)
       # Build the new row
       row = @cell_builders.map do |cell|
-        cell.call(item)
-      rescue StandardError
-        nil
+        begin
+          cell.call(item)
+        rescue StandardError => e
+          next nil if rescue_errors
+
+          raise e
+        end
       end
 
       # Add the new row to the cache then return it

data/lib/caxlsx_builder/version.rb

@@ -2,6 +2,6 @@
 
 module CaxlsxBuilder
 
-  VERSION = '1.0.0'
+  VERSION = '1.1.1'
 
 end

data/sig/caxlsx_builder/builder.rbs

@@ -16,7 +16,7 @@ module CaxlsxBuilder
   class Builder
     CELL_TYPES: Array[Cell::type_value]
 
-    def initialize: (Hash[String, Array[untyped]] sheets) { (Sheet) -> void } -> void
+    def initialize: (Hash[String, Array[untyped]] sheets, options: { rescue_errors: bool }) { (Sheet) -> void } -> void
 
     def call: () -> Axlsx::Package
 
@@ -34,6 +34,8 @@ module CaxlsxBuilder
 
     def add_footer_row: (Sheet sheet, Axlsx::Worksheet worksheet) -> void
 
+    def call_footer_proc: (Sheet::footer_proc cell, Array[Sheet::cell_value]? cells) -> Sheet::cell_value?
+
     def cell_options: (style: String? | Symbol?, type: Cell::type_value?) -> { style: Integer, type: Cell::type_value }
 
     def cast_to_hash: (Array[{ style: Integer, type: Cell::type_value }] | { style: Array[Integer], types: Array[Cell::type_value] }) -> { style: Array[Integer], types: Array[Cell::type_value] }

data/sig/caxlsx_builder/cell.rbs

@@ -9,6 +9,11 @@ module CaxlsxBuilder
 
     def initialize: (?style: Symbol | style_proc, ?type: type_value | type_proc) -> void
 
-    def as_style: (untyped item) -> ({ style: Symbol, type: type_value })
+    def as_style: (untyped item, rescue_errors: bool) -> ({ style: Symbol, type: type_value })
+
+    private
+
+    def call_style_proc: (untyped item, rescue_errors: bool) -> Symbol
+    def call_type_proc: (untyped item, rescue_errors: bool) -> type_value
   end
 end

data/sig/caxlsx_builder/sheet.rbs

@@ -16,7 +16,7 @@ module CaxlsxBuilder
 
     def add_style: (String | Symbol name, Hash[Symbol, untyped] style) -> void
 
-    def make_row: (untyped item) -> Array[cell_value]?
+    def make_row: (untyped item, rescue_errors: bool) -> Array[cell_value]?
 
     def cells: (Integer index) -> Array[cell_value]?
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: caxlsx_builder
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Matthieu CIAPPARA