-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathcsv_input.rb
188 lines (158 loc) · 6.21 KB
/
csv_input.rb
1
2
3
4
5
6
7
8
9
10
11
12
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
38
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
69
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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
require 'csv'
module WorkerTools
module CsvInput
# If an array is provided, the names will be used as the row keys, the row
# values will be assign according to the columns order.
#
# Ex: %w(tenant segment area)
# row => {
# tenant: _value_at_first_column_,
# segment: _value_at_second_column_,
# area: _value_at_third_column_
# }
#
# If a hash if provided, the keys will turn into the row keys, the values
# will be used to find the corresponding columns (the order in the csv won't
# affect the import)
#
# Ex: { tenant: 'Mandant', segment: 'Segment', area: 'Bereich')
# row => {
# tenant: _value_at_column_Mandant,
# segment: _value_at_column_Segment,
# area: _value_at_column_Bereich
# }
#
# The name of the column is filtered using the csv_input_header_normalized
# method, which takes care of extra spaces and looks for a case insentive
# match (so 'Bereich' matches ' Bereich', 'bereich', etc.). You can override
# that method as well.
#
# Besides matching the columns using strings, it is possible to use a regular
# expression or a proc:
# {
# tenant: 'Mandant',
# segment: /Segment/i,
# area: ->(name) { name.downcase == 'area' }
# }
def csv_input_columns
raise "csv_input_columns has to be defined in #{self}"
end
def csv_input_header_normalized(name)
name = name.to_s.strip
name = name.downcase if csv_input_header_normalize?
name
end
# Allows for some basic cleanup of the values, such as applying strip to
# the strings.
def cvs_input_value_cleanup(value)
value.is_a?(String) ? value.strip : value
end
def csv_input_columns_check(csv_rows_enum)
# override and return true if you do not want this check to be performed
return csv_input_columns_array_check(csv_rows_enum) if csv_input_columns.is_a?(Array)
csv_input_columns_hash_check(csv_rows_enum)
end
def csv_input_columns_array_check(csv_rows_enum)
expected_columns_length = csv_input_columns.length
actual_columns_length = csv_rows_enum.first.length
return if expected_columns_length == actual_columns_length
msg = "The number of columns (#{actual_columns_length}) is not the expected (#{expected_columns_length})"
raise Errors::WrongNumberOfColumns, msg
end
def csv_input_columns_hash_check(csv_rows_enum)
expected_names = csv_input_columns.values
filtered_actual_names = csv_rows_enum.first.map { |n| csv_input_header_normalized(n) }
csv_input_columns_hash_check_duplicates(filtered_actual_names)
csv_input_columns_hash_check_missing(filtered_actual_names, expected_names)
end
def csv_input_columns_hash_check_duplicates(names)
dups = names.group_by(&:itself).select { |_, v| v.count > 1 }.keys
return unless dups.present?
raise Errors::DuplicatedColumns, "The file contains duplicated columns: #{dups}"
end
def csv_input_columns_hash_check_missing(actual_names, expected_names)
missing = expected_names.reject do |name|
matchable = name.is_a?(String) ? csv_input_header_normalized(name) : name
actual_names.any? { |n| case n when matchable then true end } # rubocop does not like ===
end
raise Errors::MissingColumns, "Some columns are missing: #{missing}" unless missing.empty?
end
def csv_input_csv_options
# Ex: { col_sep: ';', encoding: Encoding::ISO_8859_1 }
{ col_sep: ';' }
end
def csv_input_include_other_columns
false
end
def csv_input_header_normalize?
true
end
# Compares the first row (header names) with the csv_input_columns hash to find
# the corresponding positions.
#
# Ex: csv_input_columns: {tenant: 'Mandant', area: 'Bereich'}
# headers: ['Bereich', 'Mandant']
# => { tenant: 1, area: 0}
def csv_input_mapping_order(header_names)
return csv_input_columns.map.with_index { |n, i| [n, i] }.to_h if csv_input_columns.is_a?(Array)
csv_input_mapping_order_for_hash(header_names)
end
def csv_input_mapping_order_for_hash(header_names)
filtered_column_names = header_names.map { |n| csv_input_header_normalized(n) }
mapping = csv_input_columns.each_with_object({}) do |(k, v), h|
matchable = v.is_a?(String) ? csv_input_header_normalized(v) : v
h[k] = filtered_column_names.index { |n| case n when matchable then true end }
end
return mapping unless csv_input_include_other_columns
csv_input_mapping_order_with_other_columns(mapping, filtered_column_names)
end
def csv_input_mapping_order_with_other_columns(mapping, filtered_column_names)
positions_taken = mapping.values
filtered_column_names.each_with_index do |header, index|
mapping[header.to_sym] = index unless positions_taken.include?(index)
end
mapping
end
def csv_input_file_path
model.attachment.path.to_s
end
def csv_rows_enum
@csv_rows_enum ||= CSV.foreach(csv_input_file_path, **csv_input_csv_options)
end
def csv_input_headers_present
true
end
def csv_input_foreach
@csv_input_foreach ||= begin
csv_input_columns_check(csv_rows_enum)
CsvInputForeach.new(
rows_enum: csv_rows_enum,
mapping_order: csv_input_mapping_order(csv_rows_enum.first),
cleanup_method: method(:cvs_input_value_cleanup),
headers_present: csv_input_headers_present
)
end
end
class CsvInputForeach
include Enumerable
def initialize(rows_enum:, mapping_order:, cleanup_method:, headers_present:)
@rows_enum = rows_enum
@mapping_order = mapping_order
@cleanup_method = cleanup_method
@headers_present = headers_present
end
def each
return enum_for(:each) unless block_given?
@rows_enum.with_index.each do |values, index|
next if index.zero? && @headers_present
yield values_to_row(values)
end
end
def values_to_row(values)
@mapping_order.each_with_object(HashWithIndifferentAccess.new) do |(k, v), h|
h[k] = @cleanup_method.call(values[v])
end
end
end
end
end