caxlsx_builder 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 166ae65f2879639670efc80db83d33e769008aff2445b8f17a201ed859e739b0
+  data.tar.gz: 22925363722171bdf7141d22e8f964c2f5a28344dff5b18bec7ea7f69942a026
+SHA512:
+  metadata.gz: 94cf4c88f0c77fabc79e2e2699d7a1d2898abd1008901771fecb1d197e29692c9b473f3adf9775771c54e110d5075b07dbdfcfe8bcbff7ca6d73ec3f57557aa7
+  data.tar.gz: bc70d29e37edc0a7d289e617238ef6785aa94484c969a166426ab47ba7a378f10cb00d0ee17e3534aeb542b7dd7ee8f3cf0d4d69fd5d9d0761289ceda12edcb9

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,226 @@
+AllCops:
+  TargetRubyVersion: 3.1
+  SuggestExtensions: false
+  NewCops: enable
+  Exclude:
+    - 'bin'
+    - '**/Gemfile'
+    - '**/Rakefile'
+    - 'spec/**/*'
+
+# Checks if String literals are using single quotes when no interpolation is required
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: single_quotes
+  ConsistentQuotesInMultiline: false
+
+# Checks if the quotes used for quoted symbols are single quotes when no interpolation is required
+Style/QuotedSymbols:
+  Enabled: true
+  EnforcedStyle: same_as_string_literals
+
+# This cop checks for uses of literal strings converted to a symbol where a literal symbol could be used instead.
+Lint/SymbolConversion:
+  Enabled: true
+  EnforcedStyle: strict
+
+# Useless cop. It checks for unnecessary safe navigations.
+# Example:
+# obj&.a && obj.b
+# Triggers rubocop error: it requires to add safe navigation for "obj.b" call => "obj&.b".
+# but it is not necessary. obj&.a will return nil if obj is nil, and it will stop
+# execution of the operation because `&&` right part executes only when left part is truthy.
+Lint/SafeNavigationConsistency:
+  Enabled: false
+
+# Checks for places where keyword arguments can be used instead of boolean arguments when defining methods.
+# Disabled because moving from default arguments to keywords is not that easy.
+Style/OptionalBooleanParameter:
+  Enabled: false
+
+# Checks for use of the lambda.(args) syntax.
+# Disabled while the Ruby team has not voted on this.
+Style/LambdaCall:
+  Enabled: false
+  EnforcedStyle: braces
+
+# Checks for presence or absence of braces around hash literal as a last array item depending on configuration.
+# Disabled because it would break a lot of permitted_params definitions
+Style/HashAsLastArrayItem:
+  Enabled: false
+
+# Checks for grouping of accessors in class and module bodies.
+# Useless.
+Style/AccessorGrouping:
+  Enabled: false
+
+# Makes our lives happier: we don't need to disable it in each case/when method
+# with more than 5 "when"s.
+Metrics/CyclomaticComplexity:
+  Max: 10
+
+# Commonly used screens these days easily fit more than 80 characters.
+Layout/LineLength:
+  Max: 120
+
+# Too short methods lead to extraction of single-use methods, which can make
+# the code easier to read (by naming things), but can also clutter the class
+Metrics/MethodLength:
+  Max: 20
+
+# The guiding principle of classes is SRP, SRP can't be accurately measured by LoC
+Metrics/ClassLength:
+  Max: 1500
+
+# No space makes the method definition shorter and differentiates
+# from a regular assignment.
+Layout/SpaceAroundEqualsInParameterDefault:
+  EnforcedStyle: no_space
+
+# We do not need to support Ruby 1.9, so this is good to use.
+Style/SymbolArray:
+  Enabled: true
+
+# Most readable form.
+Layout/HashAlignment:
+  EnforcedHashRocketStyle: table
+  EnforcedColonStyle: table
+
+# Mixing the styles looks just silly.
+Style/HashSyntax:
+  EnforcedStyle: ruby19_no_mixed_keys
+
+# has_key? and has_value? are far more readable than key? and value?
+Style/PreferredHashMethods:
+  Enabled: false
+
+# String#% is by far the least verbose and only object oriented variant.
+Style/FormatString:
+  EnforcedStyle: percent
+
+# Annotated or template are too verbose and rarely needed.
+Style/FormatStringToken:
+  EnforcedStyle: unannotated
+
+Style/CollectionMethods:
+  Enabled: true
+  PreferredMethods:
+    # inject seems more common in the community.
+    reduce: "inject"
+
+# Either allow this style or don't. Marking it as safe with parenthesis
+# is silly. Let's try to live without them for now.
+Style/ParenthesesAroundCondition:
+  AllowSafeAssignment: false
+Lint/AssignmentInCondition:
+  AllowSafeAssignment: false
+
+# A specialized exception class will take one or more arguments and construct the message from it.
+# So both variants make sense.
+Style/RaiseArgs:
+  Enabled: false
+
+# Indenting the chained dots beneath each other is not supported by this cop,
+# see https://github.com/bbatsov/rubocop/issues/1633
+Layout/MultilineOperationIndentation:
+  Enabled: false
+
+# Fail is an alias of raise. Avoid aliases, it's more cognitive load for no gain.
+# The argument that fail should be used to abort the program is wrong too,
+# there's Kernel#abort for that.
+Style/SignalException:
+  EnforcedStyle: only_raise
+
+# Suppressing exceptions can be perfectly fine, and be it to avoid to
+# explicitly type nil into the rescue since that's what you want to return,
+# or suppressing LoadError for optional dependencies
+Lint/SuppressedException:
+  Enabled: false
+
+# { ... } for multi-line blocks is okay, follow Weirichs rule instead:
+# https://web.archive.org/web/20140221124509/http://onestepback.org/index.cgi/Tech/Ruby/BraceVsDoEnd.rdoc
+Style/BlockDelimiters:
+  Enabled: false
+
+# do / end blocks should be used for side effects,
+# methods that run a block for side effects and have
+# a useful return value are rare, assign the return
+# value to a local variable for those cases.
+Style/MethodCalledOnDoEndBlock:
+  Enabled: true
+
+# Enforcing the names of variables? To single letter ones? Just no.
+Style/SingleLineBlockParams:
+  Enabled: false
+
+# Shadowing outer local variables with block parameters is often useful
+# to not reinvent a new name for the same thing, it highlights the relation
+# between the outer variable and the parameter. The cases where it's actually
+# confusing are rare, and usually bad for other reasons already, for example
+# because the method is too long.
+Lint/ShadowingOuterLocalVariable:
+  Enabled: false
+
+# Check with yard instead.
+Style/Documentation:
+  Enabled: false
+
+# This is just silly. Calling the argument `other` in all cases makes no sense.
+Naming/BinaryOperatorParameterName:
+  Enabled: false
+
+# Disable frozen string
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+# Disable No ASCII char in comments
+Style/AsciiComments:
+  Enabled: false
+
+# Disable ordered Gems By ascii
+Bundler/OrderedGems:
+  Enabled: false
+
+# Change ABC max value
+Metrics/AbcSize:
+  Max: 35
+
+# Disable empty method in one line
+Style/EmptyMethod:
+  EnforcedStyle: expanded
+
+# Disable max height block
+Metrics/BlockLength:
+  Enabled: true
+  Exclude:
+    - 'app/admin/**/*'
+
+# Checks if empty lines around the bodies of classes match the configuration.
+Layout/EmptyLinesAroundClassBody:
+  EnforcedStyle: empty_lines
+# Checks if empty lines around the bodies of modules match the configuration.
+Layout/EmptyLinesAroundModuleBody:
+  EnforcedStyle: empty_lines
+
+# Enforces the consistent usage of %-literal delimiters.
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    default: '()'
+    '%i': '[]'
+    '%I': '[]'
+    '%r': '{}'
+    '%w': '[]'
+    '%W': '[]'
+
+# Unnecessary cop. In what universe "A || B && C" or "A && B || C && D" is ambiguous? looks
+# like a cop for those who can't in boolean.
+Lint/AmbiguousOperatorPrecedence:
+  Enabled: false
+
+# Checks for simple usages of parallel assignment.
+Style/ParallelAssignment:
+  Enabled: false
+
+# Checks the style of children definitions at classes and modules.
+Style/ClassAndModuleChildren:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+## [1.0.0] - 2022-12-26
+
+- Initial release
+- Builder with custom styles, dynamic cell styles and types, dynamic footers

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at TODO: Write your email address. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in caxlsx_builder.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.12"
+
+gem "rubocop", "~> 1.41"
+
+gem 'rubyXL', '~> 3.4', '>= 3.4.25'

data/Gemfile.lock

@@ -0,0 +1,73 @@
+PATH
+  remote: .
+  specs:
+    caxlsx_builder (0.1.0)
+      caxlsx (~> 3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    caxlsx (3.3.0)
+      htmlentities (~> 4.3, >= 4.3.4)
+      marcel (~> 1.0)
+      nokogiri (~> 1.10, >= 1.10.4)
+      rubyzip (>= 1.3.0, < 3)
+    diff-lcs (1.5.0)
+    htmlentities (4.3.4)
+    json (2.6.3)
+    marcel (1.0.2)
+    nokogiri (1.13.10-aarch64-linux)
+      racc (~> 1.4)
+    parallel (1.22.1)
+    parser (3.1.3.0)
+      ast (~> 2.4.1)
+    racc (1.6.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.6.1)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.41.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.23.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.24.0)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    rubyXL (3.4.25)
+      nokogiri (>= 1.10.8)
+      rubyzip (>= 1.3.0)
+    rubyzip (2.3.2)
+    unicode-display_width (2.3.0)
+
+PLATFORMS
+  aarch64-linux
+
+DEPENDENCIES
+  caxlsx_builder!
+  rake (~> 13.0)
+  rspec (~> 3.12)
+  rubocop (~> 1.41)
+  rubyXL (~> 3.4, >= 3.4.25)
+
+BUNDLED WITH
+   2.3.26

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Matthieu CIAPPARA
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,76 @@
+# CaxlsxBuilder
+
+Write Excel files with ease using a DSL!
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add caxlsx_builder
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install caxlsx_builder
+
+## Usage
+
+```ruby
+# Initialize the builder
+builder = CaxlsxBuilder::Builder.new({ 'Test' => [['a', 1.99, 'Yay!'], ['b', 2.015, 'Oh?']] }) do |sheet|
+  # Add a custom style
+  sheet.add_style(:white_on_brown, { bg_color: '936E00', fg_color: 'FFFFFF' })
+
+  # Add a first column with a simple footer
+  sheet.column('Letters', footer: 'Some letters') { |item| item.first }
+
+  # Add a second column with some dynamic style, a float type and a dynamic footer
+  sheet.column('Numbers',
+               style:  ->(item) { item[1] > 2 ? :white_on_brown : :default },
+               footer: ->(cells) { cells.sum }, type: :float) { |item| item[1] }
+  
+  # Add a last column with default style and no footer
+  sheet.column('Interjections') { |item| item.last }
+end
+
+# Generate the AXLSX package
+package_axlsx = builder.call
+
+# Use Axlsx package's methods to store/write the file
+
+# Write on disk
+package_axlsx.serialize('test.xlsx')
+
+# Store with ActiveStorage (not a dependency of this gem): https://guides.rubyonrails.org/active_storage_overview.html
+class Export < ApplicationRecord
+  has_one_attached :file
+end
+
+file   = package_axlsx.to_stream.string
+export = Export.new
+export.file.attach(io:           StringIO.new(file), filename: 'test.xlsx',
+                   content_type: 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet')
+```
+
+Result:
+
+![Excel export with 3 columns a header two rows and a footer](/test.xlsx.png)
+
+CaxlsxBuilder use the [Caxlsx](https://github.com/caxlsx/caxlsx) gem. The builder directly returns the Caxlsx package to let you do what you want with it.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Ezveus/caxlsx_builder. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/Ezveus/caxlsx_builder/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the CaxlsxBuilder project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/Ezveus/caxlsx_builder/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/caxlsx_builder/builder.rb

@@ -0,0 +1,172 @@
+module CaxlsxBuilder
+
+  class Builder
+
+    # rubocop:disable Naming/VariableNumber
+    # I can not change iso_8601 to iso8601 since it is the type expected by Caxlsx.
+    CELL_TYPES = %i[date time float integer richtext string boolean iso_8601 text].freeze
+    # rubocop:enable Naming/VariableNumber
+
+    def initialize(sheets, &builder)
+      @sheets  = sheets
+      @builder = builder
+      @styles  = {}
+
+      # raise ArgumentError, "`sheets` must be a Hash[String, Array[untyped]]"
+    end
+
+    # @return [Axlsx::Package]
+    def call
+      # Creating, initializing and returning the +Axlsx+ package
+      Axlsx::Package.new do |package|
+        package.use_shared_strings = true
+
+        workbook = package.workbook
+
+        workbook.styles do |styles|
+          define_default_styles(styles)
+
+          build_sheets(workbook, styles)
+        end
+      end
+    end
+
+    private
+
+    # Define some default styles/formats for the spreadsheet:
+    #   default, header, currency and date
+    # @param styles [Axlsx::Styles]
+    def define_default_styles(styles)
+      # Defines the styles of the spreadsheet
+      #   default style
+      define_style(:default, styles.add_style(sz: 12))
+      #   for the cells of the header
+      define_style(:header, styles.add_style(b: true, sz: 16))
+      #   for the amounts
+      define_style(:currency, styles.add_style(format_code: '#.00 "€"'))
+      #   for the dates
+      define_style(:date, styles.add_style(format_code: 'dd/mm/yyyy'))
+      #   for the cells of the footer
+      define_style(:footer, styles.add_style(sz: 16))
+      #   for wrapped cells
+      define_style(:wrapped, styles.add_style(alignment: { wrap_text: true }))
+    end
+
+    # Register a custom style under the given name
+    # @param name [String,Symbol] A name for the style
+    # @param style [Integer] An Excel style identifier
+    #   e.g. the result of `workbook.styles { |styles| styles.add_style() }`
+    # @return [String, Symbol] The given name as a Symbol
+    def define_style(name, style)
+      name          = name.to_sym
+      @styles[name] = style
+
+      name
+    end
+
+    # @param workbook [Axlsx::Workbook]
+    # @param styles [Axlsx::Styles]
+    def build_sheets(workbook, styles)
+      @sheets.each do |name, collection|
+        sheet = Sheet.new(name)
+        @builder.call(sheet)
+
+        add_custom_styles(sheet, styles)
+
+        # Add a worksheet
+        workbook.add_worksheet(name:) do |worksheet|
+          add_header_row(sheet, worksheet)
+
+          add_data_rows(collection, sheet, worksheet)
+
+          add_footer_row(sheet, worksheet)
+        end
+      end
+    end
+
+    # @param sheet [CaxlsxBuilder::Sheet]
+    # @param styles [Axlsx::Styles]
+    def add_custom_styles(sheet, styles)
+      sheet.styles.each do |style_name, style|
+        define_style(style_name, styles.add_style(style))
+      end
+    end
+
+    # @param sheet [CaxlsxBuilder::Sheet]
+    # @param worksheet [Axlsx::Worksheet]
+    def add_header_row(sheet, worksheet)
+      # First row is the head with the header style applied
+      worksheet.add_row(sheet.headers, style: @styles[:header])
+    end
+
+    # @param collection [#each]
+    # @param sheet [CaxlsxBuilder::Sheet]
+    # @param worksheet [Axlsx::Worksheet]
+    def add_data_rows(collection, sheet, worksheet)
+      collection.each do |item|
+        row = sheet.make_row(item)
+
+        # Nil row or empty row means no row
+        compacted_row = row&.compact
+        next if compacted_row.nil? || compacted_row.empty?
+
+        # 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)) }
+        options = cast_to_hash(cells)
+        worksheet.add_row(row, options)
+      end
+    end
+
+    def add_footer_row(sheet, worksheet)
+      return if sheet.footers.empty?
+
+      footer = sheet.footers.map.with_index do |cell, index|
+        if cell.respond_to?(:call)
+          cell.call(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
+
+    # @return [Hash] The options to apply to a cell
+    def cell_options(style: nil, type: nil)
+      style = get_style(style)
+      type  = get_type(type)
+
+      { style:, type: }
+    end
+
+    # Take an array of cell options and map it to a row option
+    def cast_to_hash(array)
+      return array if array.is_a?(Hash)
+
+      { style: array.map { |i| i[:style] }, types: array.map { |i| i[:type] } }
+    end
+
+    # @param style [String,Symbol,nil] The name of the style
+    # @return [Integer] The Excel style for the given name or the default cell style
+    def get_style(style)
+      return @styles[:default] if style.nil? || style == ''
+
+      @styles[style.to_sym] || @styles[:default]
+    end
+
+    # @param type [Symbol,nil]
+    # @return [Symbol]
+    def get_type(type)
+      return :string unless CELL_TYPES.include?(type)
+
+      type
+    end
+
+  end
+
+end

data/lib/caxlsx_builder/cell.rb

@@ -0,0 +1,19 @@
+module CaxlsxBuilder
+
+  class Cell
+
+    def initialize(style: :default, type: :string)
+      @style = style
+      @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
+
+      { style:, type: }
+    end
+
+  end
+
+end

data/lib/caxlsx_builder/sheet.rb

@@ -0,0 +1,46 @@
+module CaxlsxBuilder
+
+  class Sheet
+
+    attr_reader :name, :headers, :cell_styles, :footers, :styles
+
+    def initialize(name)
+      @name          = name
+      @headers       = []
+      @cell_styles   = []
+      @footers       = []
+      @cell_builders = []
+      @row_cells     = []
+      @styles        = {}
+    end
+
+    def column(header, style: :default, type: :string, footer: nil, &cell_builder)
+      @headers << header
+      @cell_styles << Cell.new(style:, type:)
+      @footers << footer
+      @cell_builders << cell_builder
+    end
+
+    def add_style(name, style)
+      @styles[name] = style
+    end
+
+    def make_row(item)
+      # Build the new row
+      row = @cell_builders.map do |cell|
+        cell.call(item)
+      rescue StandardError
+        nil
+      end
+
+      # Add the new row to the cache then return it
+      (@row_cells << row).last
+    end
+
+    def cells(index)
+      @row_cells.flat_map { |row| row[index] }
+    end
+
+  end
+
+end

data/lib/caxlsx_builder/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module CaxlsxBuilder
+
+  VERSION = '1.0.0'
+
+end

data/lib/caxlsx_builder.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'caxlsx'
+
+require_relative 'caxlsx_builder/version'
+require_relative 'caxlsx_builder/cell'
+require_relative 'caxlsx_builder/sheet'
+require_relative 'caxlsx_builder/builder'
+
+module CaxlsxBuilder
+end

data/sig/caxlsx_builder/builder.rbs

@@ -0,0 +1,45 @@
+module Axlsx
+  class Package
+  end
+
+  class Styles
+  end
+
+  class Workbook
+  end
+
+  class Worksheet
+  end
+end
+
+module CaxlsxBuilder
+  class Builder
+    CELL_TYPES: Array[Cell::type_value]
+
+    def initialize: (Hash[String, Array[untyped]] sheets) { (Sheet) -> void } -> void
+
+    def call: () -> Axlsx::Package
+
+    def define_default_styles: (Axlsx::Styles styles) -> void
+
+    def define_style: (String | Symbol name, Integer style) -> (String | Symbol)
+
+    def build_sheets: (Axlsx::Workbook workbook, Axlsx::Styles styles) -> void
+
+    def add_custom_styles: (Sheet sheet, Axlsx::Styles styles) -> void
+
+    def add_header_row: (Sheet sheet, Axlsx::Worksheet worksheet) -> void
+
+    def add_data_rows: (Array[untyped] collection, Sheet sheet, Axlsx::Worksheet worksheet) -> void
+
+    def add_footer_row: (Sheet sheet, Axlsx::Worksheet worksheet) -> void
+
+    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] }
+
+    def get_style: (String? | Symbol? style) -> Integer
+
+    def get_type: (Cell::type_value?) -> Cell::type_value
+  end
+end

data/sig/caxlsx_builder/cell.rbs

@@ -0,0 +1,14 @@
+module CaxlsxBuilder
+  class Cell
+    type style_proc = ^(untyped) -> Symbol
+    type type_value = :date | :time | :float | :integer | :richtext | :string | :boolean | :iso_8601 | :text
+    type type_proc = ^(untyped) -> type_value
+
+    @style: Symbol | style_proc
+    @type: type_value | type_proc
+
+    def initialize: (?style: Symbol | style_proc, ?type: type_value | type_proc) -> void
+
+    def as_style: (untyped item) -> ({ style: Symbol, type: type_value })
+  end
+end

data/sig/caxlsx_builder/sheet.rbs

@@ -0,0 +1,23 @@
+module CaxlsxBuilder
+  class Sheet
+    type cell_value = String? | Numeric?
+    type footer_proc = ^(Array[cell_value]) -> cell_value
+
+    attr_reader name: String
+    attr_reader headers: Array[String]
+    attr_reader cell_styles: Array[Cell]
+    attr_reader footers: Array[cell_value | footer_proc]
+    attr_reader styles: Hash[String | Symbol, Hash[Symbol, untyped]]
+
+    def initialize: (String name) -> void
+
+    def column: (String header, style: Symbol | Cell::style_proc, type: Cell::type_value | Cell::type_proc,
+        footer: cell_value | footer_proc) { (untyped) -> cell_value } -> void
+
+    def add_style: (String | Symbol name, Hash[Symbol, untyped] style) -> void
+
+    def make_row: (untyped item) -> Array[cell_value]?
+
+    def cells: (Integer index) -> Array[cell_value]?
+  end
+end

data/sig/caxlsx_builder/version.rbs

@@ -0,0 +1,3 @@
+module CaxlsxBuilder
+  VERSION: String
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: caxlsx_builder
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Matthieu CIAPPARA
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-12-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: caxlsx
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Write Excel files with ease using a DSL
+email:
+- matthieu.ciappara@outlook.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/caxlsx_builder.rb
+- lib/caxlsx_builder/builder.rb
+- lib/caxlsx_builder/cell.rb
+- lib/caxlsx_builder/sheet.rb
+- lib/caxlsx_builder/version.rb
+- sig/caxlsx_builder/builder.rbs
+- sig/caxlsx_builder/cell.rbs
+- sig/caxlsx_builder/sheet.rbs
+- sig/caxlsx_builder/version.rbs
+- test.xlsx.png
+homepage: https://github.com/Ezveus/caxlsx_builder
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Ezveus/caxlsx_builder
+  source_code_uri: https://github.com/Ezveus/caxlsx_builder
+  changelog_uri: https://github.com/Ezveus/caxlsx_builder/blob/master/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key: 
+specification_version: 4
+summary: Write Excel files with ease!
+test_files: []