Class: Csvlint::Validator

Inherits:
Object
  • Object
show all
Includes:
ErrorCollector
Defined in:
lib/csvlint/validate.rb

Constant Summary collapse

ERROR_MATCHERS = 
{
  "Missing or stray quote" => :stray_quote,
  "Illegal quoting" => :whitespace,
  "Unclosed quoted field" => :unclosed_quote,
  "Unquoted fields do not allow \\r or \\n" => :line_breaks,
}

Instance Attribute Summary collapse

Attributes included from ErrorCollector

#errors, #info_messages, #warnings

Instance Method Summary collapse

Methods included from ErrorCollector

#build_errors, #build_info_messages, #build_warnings, #reset, #valid?

Constructor Details

#initialize(source, dialect = nil, schema = nil, options = {}) ⇒ Validator

Returns a new instance of Validator.



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

def initialize(source, dialect = nil, schema = nil, options = {})      
  @source = source
  @formats = []
  @schema = schema
  
  @supplied_dialect = dialect != nil
        
  @dialect = {
    "header" => true,
    "delimiter" => ",",
    "skipInitialSpace" => true,
    "lineTerminator" => :auto,
    "quoteChar" => '"'
  }.merge(dialect || {})
        
  @csv_header = @dialect["header"]
  @limit_lines = options[:limit_lines]
  @csv_options = dialect_to_csv_options(@dialect)
  @extension = parse_extension(source)
  reset
  validate
end

Instance Attribute Details

#content_type ⇒ Object (readonly)

Returns the value of attribute content_type.



7
8
9
 
# File 'lib/csvlint/validate.rb', line 7

def content_type
  @content_type
end

#csv_header ⇒ Object (readonly)

Returns the value of attribute csv_header.



7
8
9
 
# File 'lib/csvlint/validate.rb', line 7

def csv_header
  @csv_header
end

#data ⇒ Object (readonly)

Returns the value of attribute data.



7
8
9
 
# File 'lib/csvlint/validate.rb', line 7

def data
  @data
end

#dialect ⇒ Object (readonly)

Returns the value of attribute dialect.



7
8
9
 
# File 'lib/csvlint/validate.rb', line 7

def dialect
  @dialect
end

#encoding ⇒ Object (readonly)

Returns the value of attribute encoding.



7
8
9
 
# File 'lib/csvlint/validate.rb', line 7

def encoding
  @encoding
end

#extension ⇒ Object (readonly)

Returns the value of attribute extension.



7
8
9
 
# File 'lib/csvlint/validate.rb', line 7

def extension
  @extension
end

#headers ⇒ Object (readonly)

Returns the value of attribute headers.



7
8
9
 
# File 'lib/csvlint/validate.rb', line 7

def headers
  @headers
end

#line_breaks ⇒ Object (readonly)

Returns the value of attribute line_breaks.



7
8
9
 
# File 'lib/csvlint/validate.rb', line 7

def line_breaks
  @line_breaks
end

#schema ⇒ Object (readonly)

Returns the value of attribute schema.



7
8
9
 
# File 'lib/csvlint/validate.rb', line 7

def schema
  @schema
end

Instance Method Details

#build_formats(row) ⇒ Object 



199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/csvlint/validate.rb', line 199

def build_formats(row) 
  row.each_with_index do |col, i|
    next if col.nil? || col.empty?
    @formats[i] ||= Hash.new(0)

    format = if col.strip[FORMATS[:numeric]]
      :numeric
    elsif uri?(col)
      :uri
    elsif col[FORMATS[:date_db]] && date_format?(Date, col, '%Y-%m-%d')
      :date_db
    elsif col[FORMATS[:date_short]] && date_format?(Date, col, '%e %b')
      :date_short
    elsif col[FORMATS[:date_rfc822]] && date_format?(Date, col, '%e %b %Y')
      :date_rfc822
    elsif col[FORMATS[:date_long]] && date_format?(Date, col, '%B %e, %Y')
      :date_long
    elsif col[FORMATS[:dateTime_time]] && date_format?(Time, col, '%H:%M')
      :dateTime_time
    elsif col[FORMATS[:dateTime_hms]] && date_format?(Time, col, '%H:%M:%S')
      :dateTime_hms
    elsif col[FORMATS[:dateTime_db]] && date_format?(Time, col, '%Y-%m-%d %H:%M:%S')
      :dateTime_db
    elsif col[FORMATS[:dateTime_iso8601]] && date_format?(Time, col, '%Y-%m-%dT%H:%M:%SZ')
      :dateTime_iso8601
    elsif col[FORMATS[:dateTime_short]] && date_format?(Time, col, '%d %b %H:%M')
      :dateTime_short
    elsif col[FORMATS[:dateTime_long]] && date_format?(Time, col, '%B %d, %Y %H:%M')
      :dateTime_long
    else
      :string
    end
    
    @formats[i][format] += 1
  end
end

#check_consistency ⇒ Object 



236
237
238
239
240
241
242
243
244
245
 
# File 'lib/csvlint/validate.rb', line 236

def check_consistency
  @formats.each_with_index do |format,i|
    if format
      total = format.values.reduce(:+).to_f
      if format.none?{|_,count| count / total >= 0.9}
        build_warnings(:inconsistent_values, :schema, nil, i + 1)
      end
    end
  end
end

#dialect_to_csv_options(dialect) ⇒ Object 



187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/csvlint/validate.rb', line 187

def dialect_to_csv_options(dialect) 
    skipinitialspace = dialect["skipInitialSpace"] || true
    delimiter = dialect["delimiter"]
    delimiter = delimiter + " " if !skipinitialspace
    return {
        :col_sep => delimiter,
        :row_sep => dialect["lineTerminator"],
        :quote_char => dialect["quoteChar"],
        :skip_blanks => false
    }
end

#fetch_error(error) ⇒ Object 



181
182
183
184
185
 
# File 'lib/csvlint/validate.rb', line 181

def fetch_error(error)
  e = error.message.match(/^(.+?)(?: [io]n)? \(?line \d+\)?\.?$/i)
  message = e[1] rescue nil
  ERROR_MATCHERS.fetch(message, :unknown_error)
end

#header? ⇒ Boolean

Returns:

  • (Boolean) 


177
178
179
 
# File 'lib/csvlint/validate.rb', line 177

def header?
  @csv_header
end

#parse_csv(io) ⇒ Object 



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
 
# File 'lib/csvlint/validate.rb', line 94

def parse_csv(io)
  @expected_columns = 0
  current_line = 0
  reported_invalid_encoding = false
  @col_counts = []
  
  @csv_options[:encoding] = @encoding  
  
  begin
    wrapper = WrappedIO.new( io )
    csv = CSV.new( wrapper, @csv_options )
    @data = []
    @line_breaks = csv.row_sep
    if @line_breaks != "\r\n"
      build_info_messages(:nonrfc_line_breaks, :structure)
    end
    row = nil
    loop do
     current_line += 1
     if @limit_lines && current_line > @limit_lines 
       break
     end
     begin
       wrapper.reset_line
       row = csv.shift
       @data << row
       if row             
         if current_line == 1 && header?
           row = row.reject{|col| col.nil? || col.empty?}
           validate_header(row)
           @col_counts << row.size
         else               
           build_formats(row)
           @col_counts << row.reject{|col| col.nil? || col.empty?}.size
           @expected_columns = row.size unless @expected_columns != 0
           
           build_errors(:blank_rows, :structure, current_line, nil, wrapper.line) if row.reject{ |c| c.nil? || c.empty? }.size == 0
           
           if @schema
             @schema.validate_row(row, current_line)
             @errors += @schema.errors
             @warnings += @schema.warnings
           else
             build_errors(:ragged_rows, :structure, current_line, nil, wrapper.line) if !row.empty? && row.size != @expected_columns
           end
           
         end
       else             
         break
       end         
     rescue CSV::MalformedCSVError => e
       type = fetch_error(e)
       if type == :stray_quote && !wrapper.line.match(csv.row_sep)
         build_errors(:line_breaks, :structure)
       else
         build_errors(type, :structure, current_line, nil, wrapper.line)
       end
     end
  end
  rescue ArgumentError => ae
    build_errors(:invalid_encoding, :structure, current_line, nil, wrapper.line) unless reported_invalid_encoding
    reported_invalid_encoding = true
  end
end

#validate ⇒ Object 



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/csvlint/validate.rb', line 39

def validate
  single_col = false   
  io = nil   
  begin
    io = @source.respond_to?(:gets) ? @source : open(@source, :allow_redirections=>:all)
    validate_metadata(io)
    parse_csv(io)
    sum = @col_counts.inject(:+)
    unless sum.nil?
      build_warnings(:title_row, :structure) if @col_counts.first < (sum / @col_counts.size.to_f)
    end
    build_warnings(:check_options, :structure) if @expected_columns == 1        
    check_consistency      
  rescue OpenURI::HTTPError, Errno::ENOENT
    build_errors(:not_found)
  ensure
    io.close if io && io.respond_to?(:close)
  end
end

#validate_header(header) ⇒ Object 



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/csvlint/validate.rb', line 159

def validate_header(header)
  names = Set.new
  header.each_with_index do |name,i|
    build_warnings(:empty_column_name, :schema, nil, i+1) if name == ""
    if names.include?(name)
      build_warnings(:duplicate_column_name, :schema, nil, i+1)
    else
      names << name
    end
  end
  if @schema
    @schema.validate_header(header)
    @errors += @schema.errors
    @warnings += @schema.warnings
  end
  return valid?
end

#validate_metadata(io) ⇒ Object 



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
 
# File 'lib/csvlint/validate.rb', line 59

def validate_metadata(io)
  @encoding = io.charset rescue nil
  @content_type = io.content_type rescue nil
  @headers = io.meta rescue nil    
  assumed_header = undeclared_header = !@supplied_dialect
  if @headers
    if @headers["content-type"] =~ /text\/csv/
      @csv_header = true
      undeclared_header = false
      assumed_header = true
    end
    if @headers["content-type"] =~ /header=(present|absent)/
      @csv_header = true if $1 == "present"
      @csv_header = false if $1 == "absent"
      undeclared_header = false
      assumed_header = false
    end
    if @headers["content-type"] !~ /charset=/
      build_warnings(:no_encoding, :context) 
    else
      build_warnings(:encoding, :context) if @encoding != "utf-8"
    end
    build_warnings(:no_content_type, :context) if @content_type == nil
    build_warnings(:excel, :context) if @content_type == nil && @extension =~ /.xls(x)?/
    build_errors(:wrong_content_type, :context) unless (@content_type && @content_type =~ /text\/csv/)
    
    if undeclared_header
      build_errors(:undeclared_header, :structure)
      assumed_header = false
    end
    
  end
  build_info_messages(:assumed_header, :structure) if assumed_header
end