-
Version 1.10.0 has BREAKING CHANGES:
Changed behavior:
-
when
user_provided_headersare provided:- if they are not unique, an exception will now be raised
- they are taken "as is", no header transformations can be applied
- when they are given as strings or as symbols, it is assumed that this is the desired format
- the value of the
strings_as_keysoptions will be ignored
-
option
duplicate_header_suffixnow defaults to''instead ofnil.- this allows automatic disambiguation when processing of CSV files with duplicate headers, by appending a number
- explicitly set this option to
nilto get the behavior from previous versions.
-
-
default branch is
mainfor 1.x development -
2.x development is MOVED TO THIS PR
- 2.x behavior is still EXPERIMENTAL - DO NOT USE in production
smarter_csv is a Ruby Gem for smarter importing of CSV Files as Array(s) of Hashes, suitable for direct processing with ActiveRecord, parallel processing, kicking-off batch jobs with Sidekiq, or oploading data to S3.
The goals for SmarterCSV are:
- ease of use for handling most common CSV files without having to tweak options
- improve robustness of your code when you have no control over the quality of the CSV files which are processed
- formatting each row of data as a hash, in order to allow easy processing with ActiveRecord, parallel processing, kicking-off batch jobs with Sidekiq, or oploading data to S3.
While SmarterCSV uses sensible defaults to process the most common CSV files, it will raise exceptions if it can not auto-detect col_sep, row_sep, or if it encounters other problems. Therefore, when calling SmarterCSV.process, please rescue from SmarterCSVException, and handle outliers according to your requirements.
If you encounter unusual CSV files, please follow the tips in the Troubleshooting section below. You can use the options below to accomodate for unusual formats.
One smarter_csv user wrote:
Best gem for CSV for us yet. [...] taking an import process from 7+ hours to about 3 minutes. [...] Smarter CSV was a big part and helped clean up our code ALOT
smarter_csv has lots of features:
- able to process large CSV-files
- able to chunk the input from the CSV file to avoid loading the whole CSV file into memory
- return a Hash for each line of the CSV file, so we can quickly use the results for either creating MongoDB or ActiveRecord entries, or further processing with Resque
- able to pass a block to the
processmethod, so data from the CSV file can be directly processed (e.g. Resque.enqueue ) - allows to have a bit more flexible input format, where comments are possible, and col_sep,row_sep can be set to any character sequence, including control characters.
- able to re-map CSV "column names" to Hash-keys of your choice (normalization)
- able to ignore "columns" in the input (delete columns)
- able to eliminate nil or empty fields from the result hashes (default)
- It is assumed that the escape character is
\, as on UNIX and Windows systems. - It is assumed that quote charcters around fields are balanced, e.g. valid:
"field", invalid:"field\"e.g. an escapedquote_chardoes not denote the end of a field. - This Gem is only for importing CSV files - writing of CSV files is not supported at this time.
Ruby's CSV library's API is pretty old, and it's processing of CSV-files returning Arrays of Arrays feels 'very close to the metal'. The output is not easy to use - especially not if you want to create database records or Sidekiq jobs with it. Another shortcoming is that Ruby's CSV library does not have good support for huge CSV-files, e.g. there is no support for 'chunking' and/or parallel processing of the CSV-content (e.g. with Sidekiq).
As the existing CSV libraries didn't fit my needs, I was writing my own CSV processing - specifically for use in connection with Rails ORMs like Mongoid, MongoMapper and ActiveRecord. In those ORMs you can easily pass a hash with attribute/value pairs to the create() method. The lower-level Mongo driver and Moped also accept larger arrays of such hashes to create a larger amount of records quickly with just one call. The same patterns are used when you pass data to Sidekiq jobs.
For processing large CSV files it is essential to process them in chunks, so the memory impact is minimized.
The two main choices you have in terms of how to call SmarterCSV.process are:
- calling
processwith or without a block - passing a
:chunk_sizeto theprocessmethod, and processing the CSV-file in chunks, rather than in one piece.
By default (since version 1.8.0), detection of the column and row separators is set to automatic row_sep: :auto, col_sep: :auto. This should make it easier to process any CSV files without having to examine the line endings or column separators.
You can change the setting :auto_row_sep_chars to only analyze the first N characters of the file (default is 500 characters); nil or 0 will check the whole file).
You can also set the :row_sep manually! Checkout Example 4 for unusual :row_sep and :col_sep.
In case your CSV file is not being parsed correctly, try to examine it in a text editor. For closer inspection a tool like hexdump can help find otherwise hidden control character or byte sequences like BOMs.
$ hexdump -C spec/fixtures/bom_test_feff.csv
00000000 fe ff 73 6f 6d 65 5f 69 64 2c 74 79 70 65 2c 66 |..some_id,type,f|
00000010 75 7a 7a 62 6f 78 65 73 0d 0a 34 32 37 36 36 38 |uzzboxes..427668|
00000020 30 35 2c 7a 69 7a 7a 6c 65 73 2c 31 32 33 34 0d |05,zizzles,1234.|
00000030 0a 33 38 37 35 39 31 35 30 2c 71 75 69 7a 7a 65 |.38759150,quizze|
00000040 73 2c 35 36 37 38 0d 0a |s,5678..|
Here are some examples to demonstrate the versatility of SmarterCSV.
It is generally recommended to rescue SmarterCSVException or it's sub-classes.
By default SmarterCSV determines the row_sep and col_sep values automatically. In cases where the automatic detection fails, an exception will be raised, e.g. NoColSepDetected. Rescuing from these exceptions will make sure that you don't miss processing CSV files, in case users upload CSV files with unexpected formats.
In rare cases you may have to manually set these values, after going through the troubleshooting procedure described above.
Please note how each hash contains only the keys for columns with non-null values.
$ cat pets.csv
first name,last name,dogs,cats,birds,fish
Dan,McAllister,2,,,
Lucy,Laweless,,5,,
Miles,O'Brian,,,,21
Nancy,Homes,2,,1,
$ irb
> require 'smarter_csv'
=> true
> pets_by_owner = SmarterCSV.process('/tmp/pets.csv')
=> [ {:first_name=>"Dan", :last_name=>"McAllister", :dogs=>"2"},
{:first_name=>"Lucy", :last_name=>"Laweless", :cats=>"5"},
{:first_name=>"Miles", :last_name=>"O'Brian", :fish=>"21"},
{:first_name=>"Nancy", :last_name=>"Homes", :dogs=>"2", :birds=>"1"}
]Please note how the returned array contains two sub-arrays containing the chunks which were read, each chunk containing 2 hashes.
In case the number of rows is not cleanly divisible by :chunk_size, the last chunk contains fewer hashes.
> pets_by_owner = SmarterCSV.process('/tmp/pets.csv', {:chunk_size => 2, :key_mapping => {:first_name => :first, :last_name => :last}})
=> [ [ {:first=>"Dan", :last=>"McAllister", :dogs=>"2"}, {:first=>"Lucy", :last=>"Laweless", :cats=>"5"} ],
[ {:first=>"Miles", :last=>"O'Brian", :fish=>"21"}, {:first=>"Nancy", :last=>"Homes", :dogs=>"2", :birds=>"1"} ]
]Example 1c: How SmarterCSV processes CSV-files as chunks, and passes arrays of hashes to a given block:
Please note how the given block is passed the data for each chunk as the parameter (array of hashes),
and how the process method returns the number of chunks when called with a block
> total_chunks = SmarterCSV.process('/tmp/pets.csv', {:chunk_size => 2, :key_mapping => {:first_name => :first, :last_name => :last}}) do |chunk|
chunk.each do |h| # you can post-process the data from each row to your heart's content, and also create virtual attributes:
h[:full_name] = [h[:first],h[:last]].join(' ') # create a virtual attribute
h.delete(:first) ; h.delete(:last) # remove two keys
end
puts chunk.inspect # we could at this point pass the chunk to a Resque worker..
end
[{:dogs=>"2", :full_name=>"Dan McAllister"}, {:cats=>"5", :full_name=>"Lucy Laweless"}]
[{:fish=>"21", :full_name=>"Miles O'Brian"}, {:dogs=>"2", :birds=>"1", :full_name=>"Nancy Homes"}]
=> 2 filename = '/tmp/input_file.txt' # TAB delimited file, each row ending with Control-M
recordsA = SmarterCSV.process(filename, {:col_sep => "\t", :row_sep => "\cM"}) # no block given
=> returns an array of hashes # without using chunks:
filename = '/tmp/some.csv'
options = {:key_mapping => {:unwanted_row => nil, :old_row_name => :new_name}}
n = SmarterCSV.process(filename, options) do |array|
# we're passing a block in, to process each resulting hash / =row (the block takes array of hashes)
# when chunking is not enabled, there is only one hash in each array
MyModel.create( array.first )
end
=> returns number of chunks / rows we processed filename = '/tmp/input.csv' # CSV file containing ids or data to process
options = { :chunk_size => 100 }
n = SmarterCSV.process(filename, options) do |chunk|
Sidekiq::Client.push_bulk(
'class' => SidekiqIndividualWorkerClass,
'args' => chunk,
)
# OR:
# SidekiqBatchWorkerClass.process_async(chunk ) # pass an array of hashes to Sidekiq workers for parallel processing
end
=> returns number of chunks filename = '/tmp/strange_db_dump' # a file with CRTL-A as col_separator, and with CTRL-B\n as record_separator (hello iTunes!)
options = {
:col_sep => "\cA", :row_sep => "\cB\n", :comment_regexp => /^#/,
:chunk_size => 100 , :key_mapping => {:export_date => nil, :name => :genre}
}
n = SmarterCSV.process(filename, options) do |chunk|
SidekiqWorkerClass.process_async(chunk ) # pass an array of hashes to Sidekiq workers for parallel processing
end
=> returns number of chunks # using chunks:
filename = '/tmp/some.csv'
options = {:chunk_size => 100, :key_mapping => {:unwanted_row => nil, :old_row_name => :new_name}}
n = SmarterCSV.process(filename, options) do |chunk|
# we're passing a block in, to process each resulting hash / row (block takes array of hashes)
# when chunking is enabled, there are up to :chunk_size hashes in each chunk
MyModel.collection.insert( chunk ) # insert up to 100 records at a time
end
=> returns number of chunks we processedNOTE: If you use key_mappings and value_converters, make sure that the value converters has references the keys based on the final mapped name, not the original name in the CSV file.
$ 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
$ irb
> require 'smarter_csv'
> require 'date'
# define a custom converter class, which implements self.convert(value)
class DateConverter
def self.convert(value)
Date.strptime( value, '%m/%d/%Y') # parses custom date format into Date instance
end
end
class DollarConverter
def self.convert(value)
value.sub('$','').to_f
end
end
options = {:value_converters => {:date => DateConverter, :price => DollarConverter}}
data = SmarterCSV.process("spec/fixtures/with_dates.csv", options)
data[0][:date]
=> #<Date: 1998-10-30 ((2451117j,0s,0n),+0s,2299161j)>
data[0][:date].class
=> Date
data[0][:price]
=> 44.50
data[0][:price].class
=> FloatThe process method reads and processes a "generalized" CSV file and returns the contents either as an Array of Hashes,
or an Array of Arrays, which contain Hashes, or processes Chunks of Hashes via a given block.
SmarterCSV.process(filename, options={}, &block)
The options and the block are optional.
SmarterCSV.process supports the following options:
| Option | Default | Explanation |
---------------------------------------------------------------------------------------------------------------------------------
| :chunk_size | nil | if set, determines the desired chunk-size (defaults to nil, no chunk processing) |
| | | |
| :file_encoding | utf-8 | Set the file encoding eg.: 'windows-1252' or 'iso-8859-1' |
| :invalid_byte_sequence | '' | what to replace invalid byte sequences with |
| :force_utf8 | false | force UTF-8 encoding of all lines (including headers) in the CSV file |
| :skip_lines | nil | how many lines to skip before the first line or header line is processed |
| :comment_regexp | nil | regular expression to ignore comment lines (see NOTE on CSV header), e.g./\A#/ |
---------------------------------------------------------------------------------------------------------------------------------
| :col_sep | :auto | column separator (default was ',') |
| :force_simple_split | false | force simple splitting on :col_sep character for non-standard CSV-files. |
| | | e.g. when :quote_char is not properly escaped |
| :row_sep | :auto | row separator or record separator (previous default was system's $/ , which defaulted to "\n") |
| | | This can also be set to :auto, but will process the whole cvs file first (slow!) |
| :auto_row_sep_chars | 500 | How many characters to analyze when using `:row_sep => :auto`. nil or 0 means whole file. |
| :quote_char | '"' | quotation character |
---------------------------------------------------------------------------------------------------------------------------------
| :headers_in_file | true | Whether or not the file contains headers as the first line. |
| | | Important if the file does not contain headers, |
| | | otherwise you would lose the first line of data. |
| :duplicate_header_suffix | '' | Adds numbers to duplicated headers and separates them by the given suffix. |
| | | Set this to nil to raise `DuplicateHeaders` error instead (previous behavior) |
| :user_provided_headers | nil | *careful with that axe!* |
| | | user provided Array of header strings or symbols, to define |
| | | what headers should be used, overriding any in-file headers. |
| | | You can not combine the :user_provided_headers and :key_mapping options |
| :remove_empty_hashes | true | remove / ignore any hashes which don't have any key/value pairs or all empty values |
| :verbose | false | print out line number while processing (to track down problems in input files) |
| :with_line_numbers | false | add :csv_line_number to each data hash |
---------------------------------------------------------------------------------------------------------------------------------
There have been a lot of 1-offs and feature creep around these options, and going forward we'll have a simpler, but more flexible way to address these features.
Instead of these options, there will be a new and more flexible way to process the header fields, as well as the fields in each line of the CSV. And header and data validations will also be supported in 2.x
| Option | Default | Explanation |
---------------------------------------------------------------------------------------------------------------------------------
| :key_mapping | nil | a hash which maps headers from the CSV file to keys in the result hash |
| :silence_missing_keys | false | ignore missing keys in `key_mapping` |
| | | if set to true: makes all mapped keys optional |
| | | if given an array, makes only the keys listed in it optional |
| :required_keys | nil | An array. Specify the required names AFTER header transformation. |
| :required_headers | nil | (DEPRECATED / renamed) Use `required_keys` instead |
| | | or an exception is raised No validation if nil is given. |
| :remove_unmapped_keys | false | when using :key_mapping option, should non-mapped keys / columns be removed? |
| :downcase_header | true | downcase all column headers |
| :strings_as_keys | false | use strings instead of symbols as the keys in the result hashes |
| :strip_whitespace | true | remove whitespace before/after values and headers |
| :keep_original_headers | false | keep the original headers from the CSV-file as-is. |
| | | Disables other flags manipulating the header fields. |
| :strip_chars_from_headers | nil | RegExp to remove extraneous characters from the header line (e.g. if headers are quoted) |
---------------------------------------------------------------------------------------------------------------------------------
| :value_converters | nil | supply a hash of :header => KlassName; the class needs to implement self.convert(val)|
| :remove_empty_values | true | remove values which have nil or empty strings as values |
| :remove_zero_values | false | remove values which have a numeric value equal to zero / 0 |
| :remove_values_matching | nil | removes key/value pairs if value matches given regular expressions. e.g.: |
| | | /^\$0\.0+$/ to match $0.00 , or /^#VALUE!$/ to match errors in Excel spreadsheets |
| :convert_values_to_numeric | true | converts strings containing Integers or Floats to the appropriate class |
| | | also accepts either {:except => [:key1,:key2]} or {:only => :key3} |
---------------------------------------------------------------------------------------------------------------------------------
- if you have a CSV file which contains unicode characters, you can process it as follows:
File.open(filename, "r:bom|utf-8") do |f|
data = SmarterCSV.process(f);
end- if the CSV file with unicode characters is in a remote location, similarly you need to give the encoding as an option to the
opencall:
require 'open-uri'
file_location = 'http://your.remote.org/sample.csv'
open(file_location, 'r:utf-8') do |f| # don't forget to specify the UTF-8 encoding!!
data = SmarterCSV.process(f)
end- as this method parses CSV files, it is assumed that the first line of any file will contain a valid header
- the first line with the header might be commented out, in which case you will need to set
comment_regexp: /\A#/This is no longer handled automatically since 1.5.0. - any occurences of :comment_regexp or :row_sep will be stripped from the first line with the CSV header
- any of the keys in the header line will be downcased, spaces replaced by underscore, and converted to Ruby symbols before being used as keys in the returned Hashes
- you can not combine the :user_provided_headers and :key_mapping options
- if the incorrect number of headers are provided via :user_provided_headers, exception SmarterCSV::HeaderSizeMismatch is raised
As a corner case, it is possible that a CSV file contains multiple headers with the same name.
- If that happens, by default
smarter_csvwill raise aDuplicateHeaderserror. - If you set
duplicate_header_suffixto a non-nil string, it will use it to append numbers 2..n to the duplicate headers. To further disambiguate the headers, you can further usekey_mappingto assign meaningful names. - If your code will need to process arbitrary CSV files, please set
duplicate_header_suffix. - Another way to deal with duplicate headers it to use
user_assigned_headersto ignore any headers in the file.
- keys in the header line of the file can be re-mapped to a chosen set of symbols, so the resulting Hashes can be better used internally in your application (e.g. when directly creating MongoDB entries with them)
- if you want to completely delete a key, then map it to nil or to '', they will be automatically deleted from any result Hash
- if you have input files with a large number of columns, and you want to ignore all columns which are not specifically mapped with :key_mapping, then use option :remove_unmapped_keys => true
- chunking can be VERY USEFUL if used in combination with passing a block to File.read_csv FOR LARGE FILES
- if you pass a block to File.read_csv, that block will be executed and given an Array of Hashes as the parameter.
- if the chunk_size is not set, then the array will only contain one Hash.
- if the chunk_size is > 0 , then the array may contain up to chunk_size Hashes.
- this can be very useful when passing chunked data to a post-processing step, e.g. through Resque
- some CSV files use un-escaped quotation characters inside fields. This can cause the import to break. To get around this, use the
:force_simple_split => trueoption in combination with:strip_chars_from_headers => /[\-"]/. This will also significantly speed up the import. If you would force a different :quote_char instead (setting it to a non-used character), then the import would be up to 5-times slower than using:force_simple_split.
http://www.unixgods.org/Ruby/process_csv_as_hashes.html
Add this line to your application's Gemfile:
gem 'smarter_csv'And then execute:
$ bundleOr install it yourself as:
$ gem install smarter_csvPlease open an Issue on GitHub if you have feedback, new feature requests, or want to report a bug. Thank you!
For reporting issues, please:
- include a small sample CSV file
- open a pull-request adding a test that demonstrates the issue
- mention your version of SmarterCSV, Ruby, Rails
- Fork it
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Added some feature') - Push to the branch (
git push origin my-new-feature) - Create new Pull Request