Class: HoneyFormat::CSV

Inherits:
Matrix
  • Object
show all
Defined in:
lib/honey_format/csv.rb

Overview

Represents CSV.

Instance Method Summary collapse

Methods inherited from Matrix

#columns, #each_row, #header, #rows, #to_csv, #type_map

Constructor Details

#initialize(csv, delimiter: HoneyFormat.config.delimiter, row_delimiter: HoneyFormat.config.row_delimiter, quote_character: HoneyFormat.config.quote_character, header: nil, header_converter: HoneyFormat.header_converter, header_deduplicator: HoneyFormat.config.header_deduplicator, row_builder: nil, encoding: nil, type_map: {}, skip_lines: HoneyFormat.config.skip_lines) ⇒ CSV

Instantiate CSV.

Examples:

csv = HoneyFormat::CSV.new(csv_string)

With custom delimiter

csv = HoneyFormat::CSV.new(csv_string, delimiter: ';')

With custom header converter

converter = proc { |v| v == 'name' ? 'first_name' : v }
csv = HoneyFormat::CSV.new("name,id", header_converter: converter)
csv.columns # => [:first_name, :id]

Handle errors

begin
  csv = HoneyFormat::CSV.new(csv_string)
rescue HoneyFormat::HeaderError => e
  puts "header error: #{e.class}, #{e.message}"
rescue HoneyFormat::RowError => e
  puts "row error: #{e.class}, #{e.message}"
end

Skip lines all lines starting with ‘#’

csv = HoneyFormat::CSV.new("name,id\n# some comment\njacob,1", skip_lines: '#')
csv.rows.length # => 1

CSV encoding

csv = HoneyFormat::CSV.new(csv_string, encoding: "BOM|UTF-16LE:UTF-8")

Parameters:

  • csv (String) —

    the CSV string

  • delimiter (String) (defaults to: HoneyFormat.config.delimiter) —

    the CSV column delimiter

  • row_delimiter (String, Symbol) (defaults to: HoneyFormat.config.row_delimiter) —

    the CSV row delimiter (default: :auto)

  • quote_character (String) (defaults to: HoneyFormat.config.quote_character) —

    the CSV quote character (default: “)

  • header (Array<String>) (defaults to: nil) —

    header optional argument that represents CSV header, required if the CSV file lacks a header row.

  • header_converter (#call) (defaults to: HoneyFormat.header_converter) —

    converts header columns.

  • header_deduplicator (#call) (defaults to: HoneyFormat.config.header_deduplicator) —

    deduplicates header columns.

  • row_builder (#call) (defaults to: nil) —

    will be called for each parsed row.

  • type_map (Hash) (defaults to: {}) —

    map of column_name => type conversion to perform.

  • encoding (String) (defaults to: nil) —

    CSV encoding (for example “BOM|UTF-16LE:UTF-8”).

  • skip_lines (Regexp, String) (defaults to: HoneyFormat.config.skip_lines) —

    Regexp for determining wheter a line is a comment. See CSV skip_lines option.

Raises:

See Also:

  • Matrix#new


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
 
# File 'lib/honey_format/csv.rb', line 53

def initialize(
  csv,
  delimiter: HoneyFormat.config.delimiter,
  row_delimiter: HoneyFormat.config.row_delimiter,
  quote_character: HoneyFormat.config.quote_character,
  header: nil,
  header_converter: HoneyFormat.header_converter,
  header_deduplicator: HoneyFormat.config.header_deduplicator,
  row_builder: nil,
  encoding: nil,
  type_map: {},
  skip_lines: HoneyFormat.config.skip_lines
)
  csv = ::CSV.parse(
    csv,
    col_sep: delimiter,
    row_sep: row_delimiter,
    quote_char: quote_character,
    skip_blanks: true,
    skip_lines: skip_lines,
    encoding: encoding
  )
  super(
    csv,
    header: header,
    header_converter: header_converter,
    header_deduplicator: header_deduplicator,
    row_builder: row_builder,
    type_map: type_map
  )
end