docs

Author: tilo

docs/value_converters.md

@@ -21,10 +21,10 @@ If you use `key_mappings` and `value_converters`, make sure that the value conve
 
 ```ruby
     $ cat spec/fixtures/with_dates.csv
-    first,last,date,price
-    Ben,Miller,10/30/1998,$44.50
-    Tom,Turner,2/1/2011,$15.99
-    Ken,Smith,01/09/2013,$199.99
+    first,last,date,price,member
+    Ben,Miller,10/30/1998,$44.50,TRUE
+    Tom,Turner,2/1/2011,$15.99,False
+    Ken,Smith,01/09/2013,$199.99,true
 
     $ irb
     > require 'smarter_csv'
@@ -51,7 +51,20 @@ If you use `key_mappings` and `value_converters`, make sure that the value conve
       end
     end
 
-    options = {:value_converters => {:date => DateConverter, :price => DollarConverter}}
+    class BooleanConverter
+      def self.convert(value)
+        case value
+        when /true/i
+          true
+        when /false/i
+          false
+        else
+          nil
+        end
+      end
+    end
+
+    options = {value_converters: {date: DateConverter, price: DollarConverter, member: BooleanConverter}}
     data = SmarterCSV.process("spec/fixtures/with_dates.csv", options)
     first_record = data.first
     first_record[:date]
@@ -62,6 +75,8 @@ If you use `key_mappings` and `value_converters`, make sure that the value conve
       => 44.50
     first_record[:price].class
       => Float
+    first_record[:member]
+      => true
 ```
 
 --------------------

spec/features/converters/value_converters_spec.rb

@@ -15,6 +15,19 @@ def self.convert(value)
   end
 end
 
+class BooleanConverter
+  def self.convert(value)
+    case value
+    when /true/i
+      true
+    when /false/i
+      false
+    else
+      nil
+    end
+  end
+end
+
 describe ':value_converters option' do
   it 'convert date values into Date instances' do
     options = {value_converters: {date: DateConverter}}
@@ -49,4 +62,12 @@ def self.convert(value)
     expect(data[1][:price]).to eq 15.0
     expect(data[2][:price]).to eq 0.11
   end
+
+  it 'converts boolean values into true/false' do
+    options = {value_converters: {member: BooleanConverter}}
+    data = SmarterCSV.process("#{fixture_path}/with_dates.csv", options)
+    expect(data.flatten.size).to eq 3
+    expect(data[0][:member]).to eq true
+    expect(data[1][:member]).to eq false
+  end
 end

spec/fixtures/with_dates.csv

@@ -1,4 +1,4 @@
-first,last,date,price
-Ben,Miller,10/30/1998,$44.50
-Tom,Turner,2/1/2011,$15
-Ken,Smith,01/09/2013,$0.11
+first,last,date,price,member
+Ben,Miller,10/30/1998,$44.50,TRUE
+Tom,Turner,2/1/2011,$15,False
+Ken,Smith,01/09/2013,$0.11,true