ntq_excelsior 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d1f1c651087df6ca7f9dea48884d8976b210294cb95a2577a3048f57ac8488ee
-  data.tar.gz: ce39afeae3e37049578a191dea797ce8c7cb06be31c3e60fb726cb823a93140f
+  metadata.gz: 4443b707f72d72748af1e8d5c728aef25ea2f7175704f653bebf2b1897ea1784
+  data.tar.gz: 7fdc4700b25c1d5773638186fb5e22f2afd9fa956cf755a5f4c6eccf4fb4f5d3
 SHA512:
-  metadata.gz: 62c3a791e7fce170b95c2fcd07fa4c9410b57c7aa10570925169cdfa2f38ee603c102a59fafeb49db077ddba9b9644bd6380662105936f12f033c04794d55f33
-  data.tar.gz: c22d31f130c0d0c3ae5f9a52f346255cb0926ad5c56f93880ba12dc8e622260c12a8e35de0eca1bb2d4a58c50bb4fd3d1d2037c53d377fbf3e618b6ed804db24
+  metadata.gz: eb6b8a3fbe5ccf2ef25eb5ae3156e40c33fe8d3d67dda073b44a986fe0d4003e6a13ccd871868f2823259e06bd3b89a8c05fac433410927bdcd4337110aacdda
+  data.tar.gz: d0e1c3218ca3f1d85d627a35e594772df18cbe87ba7d6af5e37ad4932c4bb2acfa5823896e6e62457286b9125aefa57435bcdb0f2d450e7ca7a494f68df74b48

data/README.md

@@ -70,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/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.3.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.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Kevin
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-02-14 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