ntq_excelsior 1.0.3 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c96b982e0a82d6d397c05c339052dfee85ccb954ece87b3a86e9f2af9cd22574
-  data.tar.gz: 56fa79c641c2e54493d72068ab8bde737d9d60c2bc670c68107f32af2e9ac93b
+  metadata.gz: bf457474e835aa5716abbdf7004f795ca97d1796cf49c9528ca59b3a7b233d10
+  data.tar.gz: 71af4c5b26604522ee93d68013f238095d3f086091ae34c6e97e32749bec42d8
 SHA512:
-  metadata.gz: a7b4c533e1840113c21795842e7c2d0ee2d5fa27226b0e6b78d263412126d2c1df18c1c577ead64ef7e9dc7ee4604aa395d86ff30f58e0f5cdf82d4232d3c5a0
-  data.tar.gz: 58fe7e1282c8ec6ab29be8d39ad3c1119e5adbe269723e21bec5ae0ab6b61be97c3a6b5168a583ea6f5a2decf98d7a269326ae614f11859296eac148d2e31655
+  metadata.gz: e07c0aba24f0369cfdfe20635b78a61f9a2a9eded12bf116e698cda59b69345d1ef5cbf94149f4e1810ab2cbd88174beba3f43f2eff34525d8674c9899eb8239
+  data.tar.gz: f08ef0e18a77235445888759cb0d57c86d8885b215920960b75299978c1be91acf4602135eaa5d11e95a0cee5a72975658be1457a3b6916694154ea8c4412163

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ntq_excelsior (1.0.3)
+    ntq_excelsior (1.2.0)
       caxlsx (< 4)
       roo (< 3)
 

data/README.md

@@ -1,5 +1,7 @@
 # NtqExcelsior
 
+[![Maintainability](https://api.codeclimate.com/v1/badges/8bc43b15a0a8bfc5d660/maintainability)](https://codeclimate.com/github/9troisquarts/ntq-excelsior/maintainability)
+
 Ntq excelsior simplifie l'import et l'export de vos données.
 
 ## Installation
@@ -32,7 +34,8 @@ class UserExporter < NtqExcelsior::Exporter
       [
         {
           title: "Utilisateurs",
-          width: 4,
+          width: -> (context) { context[:current_user].can?(:access_to_email, User) ? 4 : 3 }
+          # width: 4,
           styles: [:bold]
         }
       ],
@@ -46,11 +49,13 @@ class UserExporter < NtqExcelsior::Exporter
       {
         title: 'Email',
         header_styles: [:blue],
-        resolve: 'email'
+        resolve: 'email',
+        visible: -> (record, context) { context[:current_user].can?(:access_to_email, User) }
       },
       {
         title: 'Birthdate',
-        resolve: 'birthdate'
+        resolve: 'birthdate',
+        visible: true # Optional
       }
       {
         title: 'Address (nested)',
@@ -71,18 +76,39 @@ class UserExporter < NtqExcelsior::Exporter
 end
 
 exporter = UserExporter.new(@users)
+# Optional : Context can be passed to exporter
+exporter.context = { current_user: current_user }
 stream = exporter.export.to_stream.read
 
 # In ruby file
-File.open("export.xlsx", "w") do |tpm|
-  tpm.binmode
-  tpm.write(stream)
+File.open("export.xlsx", "w") do |tmp|
+  tmp.binmode
+  tmp.write(stream)
 end
 
 # In Controller action
 send_data stream, type: 'application/xlsx', filename: "filename.xlsx"
 ```
 
+### Multiple workbooks export
+
+```ruby
+  user_exporter = UserExporter.new(@user_data)
+  product_exporter = ProductExporter.new(@product_data)
+
+  exporter = NtqExcelsior::MultiWorkbookExporter.new([user_exporter, product_exporter])
+  stream = exporter.export.to_stream.read
+
+  # In ruby file
+  File.open("export.xlsx", "w") do |tmp|
+    tmp.binmode
+    tmp.write(stream)
+  end
+  
+  # In Controller action
+  send_data stream, type: 'application/xlsx', filename: "filename.xlsx"
+```
+
 ### Import
 
 ```ruby

data/lib/ntq_excelsior/exporter.rb

@@ -3,6 +3,7 @@ require 'caxlsx'
 module NtqExcelsior
   class Exporter
     attr_accessor :data
+    attr_accessor :context
 
     DEFAULT_STYLES = {
       date_format: {
@@ -91,13 +92,28 @@ module NtqExcelsior
       styles_hash
     end
 
+    def column_is_visible?(column, record = nil)
+      return true if !column.key?(:visible)
+      return column[:visible].call(record, context) if column[:visible].is_a?(Proc)
+
+      column[:visible]
+    end
+
+    def column_width(column)
+      return column[:width].call(context) if column[:width] && column[:width].is_a?(Proc)
+
+      column[:width] || 1
+    end
+
     def resolve_header_row(headers, index)
       row = { values: [], styles: [], merge_cells: [], height: nil }
       return row unless headers
-      
+
       col_index = 1
       headers.each do |header|
-        width = header[:width] || 1
+        next unless column_is_visible?(header)
+
+        width = column_width(header)
         row[:values] << header[:title] || ''
         row[:styles] << get_styles(header[:header_styles] || header[:styles])
         if width > 1
@@ -116,6 +132,8 @@ module NtqExcelsior
       v = value
       return  v unless accessors && accessors.length > 0
 
+      return v.dig(*accessors) if v.is_a?(Hash)
+
       v = v.send(accessors[0])
       return v if accessors.length == 1
       return dig_value(v, accessors.slice(1..-1))
@@ -151,7 +169,9 @@ module NtqExcelsior
       row = { values: [], styles: [], merge_cells: [], height: nil, types: [] }
       col_index = 1
       schema.each do |column|
-        width = column[:width] || 1
+        next unless column_is_visible?(column, record)
+
+        width = column_width(column)
         formatted_value = format_value(column[:resolve], record)
         row[:values] << formatted_value[:value]
         row[:types] << (column[:type] || formatted_value[:type])
@@ -211,7 +231,7 @@ module NtqExcelsior
           end
         end
 
-        sheet.column_widths *content[:col_widths] if content[:col_widths].present?
+        sheet.column_widths * content[:col_widths] if content[:col_widths].present?
       end
 
       sheet

data/lib/ntq_excelsior/multi_workbook_exporter.rb

@@ -0,0 +1,28 @@
+require 'caxlsx'
+
+module NtqExcelsior
+  class MultiWorkbookExporter
+
+    attr_accessor :exporters
+  
+    def initialize(exporters = [])
+      @exporters = exporters
+    end
+
+    def export
+      exports = exporters
+      exports = [exporters] if exporters && !exporters.is_a?(Array)
+
+      package = Axlsx::Package.new
+      wb = package.workbook
+      wb_styles = wb.styles
+
+      exports.each do |exporter|
+        exporter.generate_workbook(wb, wb_styles)
+      end
+
+      package
+    end
+
+  end
+end

data/lib/ntq_excelsior/version.rb

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

data/lib/ntq_excelsior.rb

@@ -2,6 +2,7 @@
 
 require_relative "ntq_excelsior/version"
 require 'ntq_excelsior/exporter'
+require 'ntq_excelsior/multi_workbook_exporter'
 require 'ntq_excelsior/importer'
 module NtqExcelsior
   class Error < StandardError; end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ntq_excelsior
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.2.0
 platform: ruby
 authors:
 - Kevin
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-07-05 00:00:00.000000000 Z
+date: 2023-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: caxlsx
@@ -58,6 +58,7 @@ files:
 - lib/ntq_excelsior.rb
 - lib/ntq_excelsior/exporter.rb
 - lib/ntq_excelsior/importer.rb
+- lib/ntq_excelsior/multi_workbook_exporter.rb
 - lib/ntq_excelsior/version.rb
 - sig/ntq_excelsior.rbs
 homepage: https://github.com/9troisquarts/ntq-excelsior
@@ -67,7 +68,7 @@ metadata:
   homepage_uri: https://github.com/9troisquarts/ntq-excelsior
   source_code_uri: https://github.com/9troisquarts/ntq-excelsior
   changelog_uri: https://github.com/9troisquarts/ntq-excelsior/CHANGELOG.md
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -83,7 +84,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.3.7
-signing_key:
+signing_key: 
 specification_version: 4
 summary: Library use by 9tq for import/export
 test_files: []