Class: ActiveImport::ImportExcel

Inherits:
Object
  • Object
show all
Defined in:
lib/active_import/import_excel.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(model_converter, data_file) ⇒ ImportExcel

Returns a new instance of ImportExcel.



8
9
10
11
# File 'lib/active_import/import_excel.rb', line 8

def initialize(model_converter, data_file)
  @converter = model_converter
  @data_file = data_file
end

Instance Attribute Details

#converterObject (readonly)

Returns the value of attribute converter.



6
7
8
# File 'lib/active_import/import_excel.rb', line 6

def converter
  @converter
end

#data_fileObject (readonly)

Returns the value of attribute data_file.



6
7
8
# File 'lib/active_import/import_excel.rb', line 6

def data_file
  @data_file
end

#estimated_rowsObject (readonly)

Returns the value of attribute estimated_rows.



6
7
8
# File 'lib/active_import/import_excel.rb', line 6

def estimated_rows
  @estimated_rows
end

Instance Method Details

#all_headers_found(headers) ⇒ Object



13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
# File 'lib/active_import/import_excel.rb', line 13

def all_headers_found(headers)
  mappings = @converter.columns

  @missing_headers_mandatory = []
  @missing_headers_optional = []
  found_at_least_one = false

  mappings.each_pair do |column_name, mapping|
    if headers[column_name].nil?
      if mapping[:mandatory]
        @missing_headers_mandatory << column_name
      else
        @missing_headers_optional << column_name
      end
    else
      found_at_least_one = true
    end
  end
  if found_at_least_one
    @missing_headers_optional.each { |field| puts "Missing optional column #{field.to_s.yellow}" }
    @missing_headers_mandatory.each { |field| puts "Missing mandatory column #{field.to_s.red}" }
  end
  return false unless @missing_headers_mandatory.empty?
  true
end

#find_excel_header_row(e) ⇒ Object



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
# File 'lib/active_import/import_excel.rb', line 39

def find_excel_header_row(e)
  column_mappings = @converter.columns

  e.sheets.each do |sheet|
    puts "Looking for the header row in sheet #{sheet}".cyan
    e.default_sheet = sheet
    e.first_row.upto(e.last_row) do |row|
      headers = {}
      (e.first_column..e.last_column).each do |column|
        column_mappings.each do |column_name, mapping|
          match = mapping[:match] || mapping[:header]
          if /#{match}/.match(e.cell(row, column).to_s)
            puts "Found header for #{column_name.to_s.green} at column #{column} at row #{row}"
            if (headers[column_name].nil?)
              headers[column_name] = column
            else
              puts "Found duplicate header '#{column_name.to_s.red}' on columns #{column} and #{headers[column_name]}."
            end
          end
        end
      end

      if all_headers_found(headers)
        puts "All headers found on row #{row}".green
        return {:row => row, :sheet => sheet, :headers => headers}
      end
    end
  end
  return nil
end

#parse(&block) ⇒ Object



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
# File 'lib/active_import/import_excel.rb', line 70

def parse(&block)
  column_mappings = @converter.columns

  excelx = false
  case File.extname(data_file).downcase
    when ".xls"
      e = Roo::Excel.new(data_file)
    when ".xlsx"
      excelx = true
      e = Roo::Excelx.new(data_file)
  end

  result = find_excel_header_row(e)

  if result.nil?
    puts "Could not find header row.".red
    return
  end

  e.default_sheet = result[:sheet]
  header_row = result[:row]
  headers = result[:headers]

  # Loop through the data
  puts "Reading data from row #{header_row + 1} to #{e.last_row}"
  @estimated_rows = e.last_row - header_row;
  row_number = 0
  (header_row + 1).upto(e.last_row) do |row|
    row_number += 1
    import_row = {}
    headers.each_pair do |name, column|
      if excelx
        value = e.cell(row, column).to_s
      else
        value = e.cell(row, column).to_s
      end
      import_row[name] = value
    end
    yield import_row, @converter, row_number, @estimated_rows
  end
end