Module: EnumCSV

Defined in:
lib/enum_csv.rb

Overview

EnumCSV exposes a single method, csv, for easily creating CSV output/files from enumerable objects.

Class Method Summary collapse

Class Method Details

.csv(enum, opts = {}) ⇒ Object

Create CSV from the given Enumerable object. If a block is given, each item in the enumerable is yielded to the block, and the block should return an array of of items to use for the CSV line.

Options:

:headers

Should be an array of headers to use as the first line of the CSV output, or a comma-delimited string of headers.

:file

Output to the given file and return nil instead of returning a string with the CSV output.

all other options

Passed to CSV.open or CSV.generate



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
 
# File 'lib/enum_csv.rb', line 19

def csv(enum, opts={})
  headers = opts[:headers]
  headers = headers.split(',') if headers.is_a?(String)
  has_headers = headers.is_a?(Array) && !opts.has_key?(:write_headers)
  has_file = opts[:file]

  if has_headers || has_file
    opts = opts.dup
    file = opts.delete(:file)

    if has_headers
      opts[:write_headers] = true
      opts[:headers] = headers
    end
  end

  csv_proc = proc do |csv|
    enum.each do |line|
      line = yield(line) if block_given?
      csv << line
    end
  end

  if file
    CSV.open(file, 'wb', **opts, &csv_proc)
    nil
  else
    CSV.generate(**opts, &csv_proc)
  end
end