ntq_excelsior 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8bf1d29e56d85c440a139e5f9e51aab9acd22b68e2da799352435298382e9c11
-  data.tar.gz: 4de9735295bee676cb0fa6fe738cf18253348021b00060b1dacee3ae6d9d2197
+  metadata.gz: d1f1c651087df6ca7f9dea48884d8976b210294cb95a2577a3048f57ac8488ee
+  data.tar.gz: ce39afeae3e37049578a191dea797ce8c7cb06be31c3e60fb726cb823a93140f
 SHA512:
-  metadata.gz: 179249f8e55907b347cc715c96c8b0b4ece8c0fa98526a2233fe5587333cf05a89d303b32e15c7ec921c0ccc55e620e330d762d279e99b68d6fa7d9bad8eee73
-  data.tar.gz: 54fe084c4e0cc8525703547a7075ed64791300cbbeb32664fdf75fba463a2a0e124c6e5c7b9e302c8e0ff8d3c08c660433f189cc2a01c9230a73b6ad2342ce62
+  metadata.gz: 62c3a791e7fce170b95c2fcd07fa4c9410b57c7aa10570925169cdfa2f38ee603c102a59fafeb49db077ddba9b9644bd6380662105936f12f033c04794d55f33
+  data.tar.gz: c22d31f130c0d0c3ae5f9a52f346255cb0926ad5c56f93880ba12dc8e622260c12a8e35de0eca1bb2d4a58c50bb4fd3d1d2037c53d377fbf3e618b6ed804db24

data/CHANGELOG.md

@@ -1,5 +1,3 @@
-## [Unreleased]
-
 ## [0.1.0] - 2023-02-02
 
 - Initial release

data/README.md

@@ -17,15 +17,23 @@ If bundler is not being used to manage dependencies, install the gem by executin
 ### Export
 
 ```ruby
+# Exporter class
 class UserExporter < NtqExcelsior::Exporter
 
+  styles ({
+    blue: {
+      fg_color: "2F5496",
+    }
+  })
+
   schema ({
-    name: 'Mobilités',
+    name: 'Utilisateurs',
     extra_headers: [
       [
         {
           title: "Utilisateurs",
-          width: 4
+          width: 4,
+          styles: [:bold]
         }
       ],
     ],
@@ -33,11 +41,16 @@ class UserExporter < NtqExcelsior::Exporter
       {
         title: 'Name',
         resolve: -> (record) { [record.first_name, record.last_name].join(' ') },
+        styles: [:bold, :blue]
       },
       {
         title: 'Email',
         resolve: 'email'
       },
+      {
+        title: 'Birthdate',
+        resolve: 'birthdate'
+      }
       {
         title: 'Address (nested)',
         resolve: ['address', 'address_one']
@@ -45,12 +58,23 @@ class UserExporter < NtqExcelsior::Exporter
       {
         title: 'City (nested)',
         resolve: ['address', 'city']
+      },
+      {
+        title: 'Age',
+        resolve: 'age',
+        type: :number
       }
     ]
   })
 
 end
 
+exporter = UserExporter.new(@users)
+exporter.export
+File.open("export.xlsx", "w") do |tpm|
+  tpm.binmode
+  tpm.write(file.to_stream.read)
+end
 ```
 
 ## Development

data/lib/ntq_excelsior/exporter.rb

@@ -5,6 +5,12 @@ module NtqExcelsior
     attr_accessor :data
 
     DEFAULT_STYLES = {
+      date_format: {
+        format_code: 'dd-mm-yyyy'
+      },
+      time_format: {
+        format_code: 'dd-mm-yyyy hh:mm:ss'
+      },
       bold: {
         b: true
       },
@@ -23,7 +29,7 @@ module NtqExcelsior
         @schema ||= value
       end
       def styles(value = nil)
-        @schema ||= value
+        @styles ||= value
       end
     end
 
@@ -73,16 +79,27 @@ module NtqExcelsior
       count
     end
 
-    def get_styles(styles)
+    def get_styles(row_styles, cell_styles = [])
+      row_styles ||= []
+      return {} if row_styles.length == 0 && cell_styles.length == 0
+
+      styles_hash = {}
+      stylesheet = styles || {}
+      (row_styles + cell_styles).each do |style_key|
+        styles_hash = styles_hash.merge(stylesheet[style_key] || DEFAULT_STYLES[style_key] || {})
+      end
+      styles_hash
     end
 
     def resolve_header_row(headers, index)
-      row = { values: [], styles: nil, merge_cells: [], height: nil }
-
+      row = { values: [], styles: [], merge_cells: [], height: nil }
+      return row unless headers
+      
       col_index = 1
       headers.each do |header|
         width = header[:width] || 1
         row[:values] << header[:title] || ''
+        row[:styles] << get_styles(header[:styles])
         if width > 1
           colspan = width - 1
           row[:values].push(*Array.new(colspan, nil))
@@ -105,20 +122,37 @@ module NtqExcelsior
     end
 
     def format_value(resolver, record)
-      return resolver.call(record) if resolver.is_a?(Proc)
-      
-      accessors = resolver
-      accessors = accessors.split(".") if accessors.is_a?(String)
-      dig_value(record, accessors)
+      styles = []
+      type = nil
+      if resolver.is_a?(Proc)
+        value = resolver.call(record) 
+      else
+        accessors = resolver
+        accessors = accessors.split(".") if accessors.is_a?(String)
+        value = dig_value(record, accessors)
+      end
+      if value.is_a?(Date)
+        value = value.strftime("%Y-%m-%d")
+        styles << :date_format
+        type = :date
+      end
+      if value.is_a?(Time) | value.is_a?(DateTime)
+        value = value.strftime("%Y-%m-%d %H:%M:%S")
+        styles << :time_format
+        type = :time
+      end
+      { value: value, styles: styles, type: type }
     end
 
     def resolve_record_row(schema, record, index)
-      row = { values: [], styles: nil, merge_cells: [], height: nil }
+      row = { values: [], styles: [], merge_cells: [], height: nil, types: [] }
       col_index = 1
       schema.each do |column|
         width = column[:width] || 1
-        row[:values] << format_value(column[:resolve], record)
-        
+        formatted_value = format_value(column[:resolve], record)
+        row[:values] << formatted_value[:value]
+        row[:types] << (column[:type] || formatted_value[:type])
+        row[:styles] << get_styles(column[:styles], formatted_value[:styles])
         if width > 1
           colspan = width - 1
           row[:values].push(*Array.new(colspan, nil))
@@ -128,7 +162,6 @@ module NtqExcelsior
 
         col_index += 1
       end
-
       row
     end
 
@@ -150,22 +183,26 @@ module NtqExcelsior
 
     def add_sheet_content(content, wb_styles, sheet)
       content[:rows].each do |row|
-        row_style = wb_styles.add_style(row[:styles]) if row[:styles].is_a? Hash
-        row_style = row[:styles]&.map { |style| wb_styles.add_style(style) if style } if row[:styles].is_a? Array
-        sheet.add_row row[:values], style: row_style, height: row[:height]
-        next unless row[:merge_cells]
-
-        row[:merge_cells]&.each do |range|
-          sheet.merge_cells range
+        row_style = []
+        if row[:styles].is_a?(Array) && row[:styles].any?
+          row[:styles].each do |style|
+            row_style << wb_styles.add_style(style || {})
+          end
+        end
+        sheet.add_row row[:values], style: row_style, height: row[:height], types: row[:types]
+        if row[:merge_cells]
+          row[:merge_cells]&.each do |range|
+            sheet.merge_cells range
+          end
         end
       end
 
-      # do not apply styles if there are now rows
+      # do not apply styles if there are no rows
       if content[:rows].present?
-        content[:styles]&.each_with_index do |(range, styles), index|
+        content[:styles]&.each_with_index do |(range, sty), index|
           begin
-            sheet.add_style range, styles.except(:border) if range && styles
-            sheet.add_border range, styles[:border] if range && styles && styles[:border]
+            sheet.add_style range, sty.except(:border) if range && sty
+            sheet.add_border range, sty[:border] if range && sty && sty[:border]
           rescue NoMethodError
             # do not apply styles if error
           end
@@ -185,13 +222,13 @@ module NtqExcelsior
     end
 
 		def export
-      p = Axlsx::Package.new
-      wb = p.workbook
+      package = Axlsx::Package.new
+      wb = package.workbook
       wb_styles = wb.styles
 
       generate_workbook(wb, wb_styles)
 
-      p
+      package
     end
 
 	end

data/lib/ntq_excelsior/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module NtqExcelsior
-  VERSION = "0.1.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ntq_excelsior
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Kevin
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-02-02 00:00:00.000000000 Z
+date: 2023-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: caxlsx