summaryrefslogtreecommitdiff
path: root/doc/csv/options/generating/write_converters.rdoc
blob: 6e5fae5fda6e8791c99bd7efefbef4b0daee43ae (plain)
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
====== Option +write_converters+

Specifies converters to be used in generating fields.
See {Write Converters}[#class-CSV-label-Write+Converters]

Default value:
  CSV::DEFAULT_OPTIONS.fetch(:write_converters) # => nil

With no write converter:
  str = CSV.generate_line(["\na\n", "\tb\t", " c "])
  str # => "\"\na\n\",\tb\t, c \n"

With a write converter:
  strip_converter = proc {|field| field.strip }
  str = CSV.generate_line(["\na\n", "\tb\t", " c "], write_converters: strip_converter)
  str # => "a,b,c\n"

With two write converters (called in order):
  upcase_converter = proc {|field| field.upcase }
  downcase_converter = proc {|field| field.downcase }
  write_converters = [upcase_converter, downcase_converter]
  str = CSV.generate_line(['a', 'b', 'c'], write_converters: write_converters)
  str # => "a,b,c\n"

See also {Write Converters}[#class-CSV-label-Write+Converters]

---

Raises an exception if the converter returns a value that is neither +nil+
nor \String-convertible:
  bad_converter = proc {|field| BasicObject.new }
  # Raises NoMethodError (undefined method `is_a?' for #<BasicObject:>)
  CSV.generate_line(['a', 'b', 'c'], write_converters: bad_converter)