ntq_excelsior 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 84b27eb6270d0a9527ca77e3c3b9d93328ef2151b14703c796bc07565a16767a
-  data.tar.gz: ef00357a9c9a2e1c1bc54d6b3ecbe2cc935ce8ba93452acba4d6ecd6a9ed1d94
+  metadata.gz: 4443b707f72d72748af1e8d5c728aef25ea2f7175704f653bebf2b1897ea1784
+  data.tar.gz: 7fdc4700b25c1d5773638186fb5e22f2afd9fa956cf755a5f4c6eccf4fb4f5d3
 SHA512:
-  metadata.gz: 830dd162264d62ac828b52d6dd428f251936b2659fb92e5b34ed3e6809bc84e5b2165c804b637685c1e2a82afcbda86685c9afc663149ce000c103ad0954157f
-  data.tar.gz: 0baa0a8bc9807bc405d55598d498d731239a1a39823c044784a9ea7c352258ce3b9216d3ded2a329c521a908b0a1ac9f0c7d72bbaa56c09f1ae788e00aca75f5
+  metadata.gz: eb6b8a3fbe5ccf2ef25eb5ae3156e40c33fe8d3d67dda073b44a986fe0d4003e6a13ccd871868f2823259e06bd3b89a8c05fac433410927bdcd4337110aacdda
+  data.tar.gz: d0e1c3218ca3f1d85d627a35e594772df18cbe87ba7d6af5e37ad4932c4bb2acfa5823896e6e62457286b9125aefa57435bcdb0f2d450e7ca7a494f68df74b48

data/README.md

@@ -49,8 +49,7 @@ class UserExporter < NtqExcelsior::Exporter
       },
       {
         title: 'Birthdate',
-        resolve: 'birthdate',
-        type: :date
+        resolve: 'birthdate'
       }
       {
         title: 'Address (nested)',
@@ -59,6 +58,11 @@ class UserExporter < NtqExcelsior::Exporter
       {
         title: 'City (nested)',
         resolve: ['address', 'city']
+      },
+      {
+        title: 'Age',
+        resolve: 'age',
+        type: :number
       }
     ]
   })
@@ -66,10 +70,47 @@ class UserExporter < NtqExcelsior::Exporter
 end
 
 exporter = UserExporter.new(@users)
-exporter.export
+stream = exporter.export.to_stream.read
+
+# In ruby file
 File.open("export.xlsx", "w") do |tpm|
   tpm.binmode
-  tpm.write(file.to_stream.read)
+  tpm.write(stream)
+end
+
+# In Controller action
+send_data stream, type: 'application/xlsx', filename: "filename.xlsx"
+```
+
+### Import
+
+```ruby
+class UserImporter < NtqExcelsior::Importer
+
+  model_klass User
+
+  primary_key :id
+
+  schema({
+    email: 'Email',
+    first_name: /Prénom/i,
+    last_name: {
+      header: /Nom/i,
+      required: true
+    },
+    active: {
+      header: /Actif/i,
+      required: false
+    }
+  })
+
+  def import_line(line, save: true)
+    super do |record, line|
+      record.email = line[:email]
+      record.first_name = line[:first_name]
+      record.last_name = line[:last_name]
+    end
+  end
 end
 ```
 

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
       },
@@ -73,12 +79,13 @@ module NtqExcelsior
       count
     end
 
-    def get_styles(row_styles)
-      return {} unless row_styles && row_styles.length > 0
+    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.each do |style_key|
+      (row_styles + cell_styles).each do |style_key|
         styles_hash = styles_hash.merge(stylesheet[style_key] || DEFAULT_STYLES[style_key] || {})
       end
       styles_hash
@@ -115,14 +122,26 @@ 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)
-      value = dig_value(record, accessors)
-      value = value.strftime("%Y-%m-%d") if value.is_a?(Date)
-      value = value.strftime("%Y-%m-%d %H:%M:%S") if value.is_a?(Time) | value.is_a?(DateTime)
-      value
+      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)
@@ -130,10 +149,10 @@ module NtqExcelsior
       col_index = 1
       schema.each do |column|
         width = column[:width] || 1
-        row[:values] << format_value(column[:resolve], record)
-        row[:types] << column[:type] || :string
-        row[:styles] << get_styles(column[:styles])
-        
+        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))
@@ -143,7 +162,6 @@ module NtqExcelsior
 
         col_index += 1
       end
-
       row
     end
 

data/lib/ntq_excelsior/importer.rb

@@ -0,0 +1,155 @@
+require 'roo'
+
+module NtqExcelsior
+  class Importer
+
+    attr_accessor :file, :check, :lines, :options, :status_tracker
+
+    class << self
+
+      def spreadsheet_options(value = nil)
+        @spreadsheet_options ||= value
+      end
+
+      def primary_key(value = nil)
+        @primary_key ||= value
+      end
+
+      def model_klass(value = nil)
+        @model_klass ||= value
+      end
+
+      def schema(value = nil)
+        @schema ||= value
+      end
+
+      def max_error_count(value = nil)
+        @max_error_count ||= value
+      end
+
+      def structure(value = nil)
+        @structure ||= value
+      end
+
+      def sample_file(value = nil)
+        @sample_file ||= value
+      end
+    end
+
+    def spreadsheet
+      return @spreadsheet unless @spreadsheet.nil?
+
+      raise 'File is missing' unless file.present?
+  
+      @spreadsheet = Roo::Spreadsheet.open(file, self.class.spreadsheet_options || {})
+    end
+
+    def required_headers
+      return @required_headers if @required_headers
+
+      @required_columns = self.class.schema.select { |field, column_config| !column_config.is_a?(Hash) || !column_config.has_key?(:required) || column_config[:required] }
+      @required_line_keys = @required_columns.map{ |k, v| k }
+      @required_headers = @required_columns.map{ |k, column_config| column_config.is_a?(Hash) ? column_config[:header] : column_config }.map{|header| header.is_a?(String) ? Regexp.new(header, "i") : header}
+      if self.class.primary_key && !@required_line_keys.include?(self.class.primary_key)
+        @required_line_keys = @required_line_keys.unshift(self.class.primary_key)
+        @required_headers = @required_headers.unshift(Regexp.new(self.class.primary_key.to_s, "i")) 
+      end
+      @required_headers
+    end
+
+    def spreadsheet_data
+      spreadsheet.sheet(spreadsheet.sheets[0]).parse(header_search: required_headers)
+    end
+
+    def detect_header_scheme(line)
+      return @header_scheme if @header_scheme
+      @header_scheme = {}
+      l = line.dup
+
+      self.class.schema.each do |field, column_config|
+        header = column_config.is_a?(Hash) ? column_config[:header] : column_config
+
+        l.each do |parsed_header, _value|
+          next unless header.is_a?(Regexp) && parsed_header.match?(header) || header.is_a?(String) && parsed_header == header
+          
+          l.delete(parsed_header)
+          @header_scheme[parsed_header] = field
+        end
+      end
+      @header_scheme[self.class.primary_key.to_s] = self.class.primary_key.to_s if self.class.primary_key && !self.class.schema[self.class.primary_key.to_sym]
+
+      @header_scheme
+    end
+
+    def parse_line(line)
+      parsed_line = {}
+      line.each do |header, value|
+        header_scheme = detect_header_scheme(line)
+        if header.to_s == self.class.primary_key.to_s
+          parsed_line[self.class.primary_key] = value
+          next
+        end
+
+        header_scheme.each do |header, field|
+          parsed_line[field.to_sym] = line[header]
+        end
+      end
+
+      raise Roo::HeaderRowNotFoundError unless (@required_line_keys - parsed_line.keys).size == 0
+
+      parsed_line
+    end
+
+    def lines
+      return @lines if @lines
+
+      @lines = spreadsheet_data.map {|line| parse_line(line) }
+    end
+
+    # id for default query in model
+    # line in case an override is needed to find correct record
+    def find_or_initialize_record(line)
+      raise "Primary key must be set for using the default find_or_initialize" unless self.class.primary_key
+
+      self.class.model_klass.find_or_initialize_by("#{self.class.primary_key}": line[self.class.primary_key.to_sym])
+    end
+
+    def import_line(line, save: true)
+      record = find_or_initialize_record(line)
+
+      yield(record, line) if block_given?
+
+      status = {}
+      return { status: :success } if record.save
+
+      return { status: :error, errors: record.errors.full_messages.join(", ")  }
+    end
+
+    def import(save: true, status_tracker: nil)
+      at = 0
+      errors_lines = []
+      success_count = 0
+      lines.each_with_index do |line, index|
+        break if errors_lines.size == self.class.max_error_count 
+
+        result = import_line(line.with_indifferent_access, save: true)
+        case result[:status]
+        when :success
+          success_count += 1
+        when :error
+          error_line = line.map { |k, v| v }
+          error_line << result[:errors]
+          errors_lines.push(error_line) 
+        end
+
+        if @status_tracker&.is_a?(Proc)
+          at = (((index + 1).to_d / lines.size) * 100.to_d) 
+          @status_tracker.call(at) 
+        end
+      end
+
+      { success_count: success_count, errors: errors_lines }
+    end
+
+  end
+end 

data/lib/ntq_excelsior/version.rb

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

data/lib/ntq_excelsior.rb

@@ -2,6 +2,7 @@
 
 require_relative "ntq_excelsior/version"
 require 'ntq_excelsior/exporter'
+require 'ntq_excelsior/importer'
 module NtqExcelsior
   class Error < StandardError; end
   # Your code goes here...

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ntq_excelsior
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Kevin
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-02-03 00:00:00.000000000 Z
+date: 2023-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: caxlsx
@@ -24,6 +24,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '4'
+- !ruby/object:Gem::Dependency
+  name: roo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
 description: Library use by 9tq for import/export
 email:
 - kevin@9troisquarts.com
@@ -41,6 +55,7 @@ files:
 - Rakefile
 - lib/ntq_excelsior.rb
 - lib/ntq_excelsior/exporter.rb
+- lib/ntq_excelsior/importer.rb
 - lib/ntq_excelsior/version.rb
 - sig/ntq_excelsior.rbs
 homepage: https://github.com/9troisquarts/ntq-excelsior