Skip to content
A simple DSL for reading, generating and transforming CSV data
Ruby Shell
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin
lib
spec
tmp
.gitignore
.rspec
.rubocop.yml
.travis.yml
CODE_OF_CONDUCT.md
Gemfile
LICENSE.txt
README.md
Rakefile
simple_csv.gemspec

README.md

SimpleCsv

SimpleCsv is a simple gem that allows you to interact with CSV's in a more friendly way. See the examples given below for more details :)

Status

Licence Gem Version Issues Build Status Coverage Status


Installation

Add this line to your application's Gemfile:

gem 'simple_csv'

And then execute:

$ bundle

Or install it yourself as:

$ gem install simple_csv

Usage

General

By default, the settings used will be those of CSV::DEFAULT_OPTIONS generally. SimpleCsv sets the :headers property to true by default, this is due to the nature of SimpleCsv.

Headers have to be defined either before reading or generating a CSV. Since :headers is now true by default, SimpleCsv will allow CSV to parse the first line as headers. These headers are then converted in method calls to use within an SimpleCsv::Reader#each_row loop.

If however, your file lacks headers, you have the ability to set :has_headers to false and supply headers manually before calling SimpleCsv::Reader#each_row. The headers will be picked up and used instead of the first line.

SimpleCsv default settings

These are the settings that will be merged with settings passed through either SimpleCsv#generate or SimpleCsv#read

setting value
:col_sep ","
:row_sep :auto
:quote_char "\"
:field_size_limit nil
:converters [:all, :blank_to_nil, :null_to_nil]
:unconverted_fields nil
:headers true
:return_headers false
:header_converters nil
:skip_blanks false
:force_quotes true
:skip_lines nil

The following settings differ from the CSV::DEFAULT_OPTIONS

  • :converters is set to [:all, :blank_to_nil, :null_to_nil]
  • :headers is true by default
  • :force_quotes is true by default

This essentially means that when reading a CSV file, headers are required otherwise a SimpleCsv::HeadersNotSet exception will be thrown. Also, when reading a CSV, all values will be parsed to their respective types, so "1" would become 1 as end value.

SimpleCsv::Writer additional default settings

Additionally, SimpleCsv::Writer has one additional default setting that ensures an entire row is written before being able to write another one. This setting enforces you to call each method once before calling one of them again, if this condition is not met a SimpleCsv::RowNotComplete exception will be thrown

setting value
:force_row_completion true

Setting aliasses

An alias can be used instead of it's respective setting.

setting alias
:col_sep :seperator
headers has_headers

Converters

The above :converters option is set to include :all converters and additionally, :blank_to_nil and :null_to_nil The code for these two can be summed up in two lines:

CSV::Converters[:blank_to_nil] = ->(f) { f && f.empty? ? nil : f }
CSV::Converters[:null_to_nil] = ->(f) { f && f == 'NULL' ? nil : f }

What they do replace empty values or the string 'NULL' by nil within a column when it's being parsed. For now, these are the default two and they are always used unless the :converters option is set to nil within SimpleCsv#generate or SimpleCsv#read

Generating a CSV file

SimpleCsv.generate path, options = { ... }, &block

The SimpleCsv#generate method takes a (required) path, an (optional) hash of options and a (required) block to start building a CSV file. To generate a CSV file we use SimpleCsv#generate (using the faker gem to provide fake data)

While writing a row to a CSV, the value of a set property can be accessed by calling that property method again without arguments (See the "inspect a value" comment in the following example).

require 'faker'

# use SimpleCsv.generate('output.csv', seperator: '|') to generate a CSV with a pipe character as seperator
SimpleCsv.generate('output.csv') do
  # first define the headers
  headers :first_name, :last_name, :birth_date, :employed_at

  # loop something
  100.times do
    # insert data in each field defined in headers to insert a row.
    first_name Faker::Name.first_name
    # inspect a value
    p first_name
    last_name Faker::Name.last_name
    birth_date Faker::Date.between(Date.today << 900, Date.today << 200)
    employed_at [Faker::Company.name, nil].sample
  end
end

This method passes any unknown method to its caller (main Object if none). If you need a reference to the instance of the current writer from within the block, it takes an optional argument:

SimpleCsv.generate ... do |writer|
  # writer is a reference to the self of this block.
  # the following two are equivelant (assuming 'name' column exists in the CSV):

  writer.name 'SidOfc'
  name 'SidOfc'
end

Reading a CSV file

SimpleCsv.read path, options = { ... }, &block

The SimpleCsv#read method takes a (required) path, an (optional) hash of options and a (required) block to start reading a CSV file.

To read a CSV file we use SimpleCsv#read, we will pass it a file path and a block as arguments. Within the block we define the headers present in the file, these will be transformed into methods you can call within SimpleCsv::Reader#each_row to get that property's current value

SimpleCsv.read('input.csv') do
  # assumes headers are set, they will be read and callable within each_row

  each_row do
    puts [first_name, last_name, birth_date, employed_at].compact.join ', '
  end
end

This method passes any unknown method to its caller (main Object if none). If you need a reference to the instance of the current reader from within the block, it takes an optional argument:

SimpleCsv.read ... do |reader|
  # reader is a reference to the self of this block.
  # all the following are equivelant:

  # the 'each_row' and `in_groups_of` methods also get a reference to self.
  each_row do |reader_too|
    puts reader_too.name
    puts reader.name
    puts name
  end

  in_groups_of 100 do |other_reader|
    puts other_reader.name
    puts reader.name
    puts name
  end
end

Reading a CSV file without headers

If we have a CSV file that does not contain headers we can use the following setup. Setting :has_headers to false means we do not expect the first line to be headers. Therefore we have to explicitly define the headers before looping the CSV.

SimpleCsv.read('headerless.csv', has_headers: false) do
  # first define the headers in the file manually if the file does not have them
  headers :first_name, :last_name, :birth_date, :employed_at

  each_row do
    # print each field defined in headers (that is not nil)
    puts [first_name, last_name, birth_date, employed_at].compact.join ', '
  end
end

Transforming s CSV file

When you want to alter or reduce the output of a given CSV file, SimpleCsv#transform can be used. This allows you to apply a block on each value in a specified column, you can also control the output headers to remove clutter from the input file.

A transformation is defined by calling the header you wish to modify with a block that performs the modification. In below example, a CSV with columns :name, :username, :age and :interests is assumed. The :age of every row will be incremented because age was defined with the block. Only headers and output_headers are supported within the transform block.

SimpleCsv.transform('people.csv', output: 'people2.csv') do
  # define specific output headers, other columns will not be added to output csv file
  output_headers :name, :username, :age, :interests

  # everyone got one year older, increment all ages.
  age { |n| n + 1 }

  # replace all names with "#{name}_old".
  name { |s| "#{name}_old" }
end

The above example will create a file called people2.csv that contains the result data. The original file is not destroyed. There is one additional option for SimpleCsv#transform which is the :output option. When this option not set, the returned file will have the same name as the input CSV followed by a timestamp formatted in the following format: [input_csv]-[%d-%m-%Y-%S&7N].csv ([input_csv] will have .csv extension stripped and reapplied). See Ruby's Time#strftime documentation for more information on formatting flags used.

If you need a reference to the instance of the current reader from within the block, it takes an optional argument:

SimpleCsv.transform ... do |transformer|
  # transformer is a reference to the self of this block.
  # all the following are equivelant (assuming "age" property exists):

  transformer.age { |n| n * 2 }
  age { |n| n * 2 }
end

Batch operations

If we have a large CSV we might want to batch operations (say, if we are inserting this data into a database or through an API). For this we can use SimpleCsv::Reader#in_groups_of and pass the size of the group. Within that we call SimpleCsv::Reader#each_row as usual

SimpleCsv.read('input.csv') do
  # assumes headers are set, they will be read and callable within each_row

  in_groups_of(100) do
    each_row do
      puts [first_name, last_name, birth_date, employed_at].compact.join ', '
    end
    # execute after every 100 rows
    sleep 2
  end
end

Aliassing existing headers

Should you want to map existing headers to different names, this is possible by passing a hash at the end with key value pairs. When generating a CSV file, aliasses are ignored and therefore should not be passed.

When defining columns manually using headers for a file without headers, ALL columns must be named before defining aliasses. This means that if your CSV exists of 3 columns, 3 headers must be defined before aliassing any of those to something shorter or more concise.

To create an alias date_of_birth of birth_date (In a CSV file without headers) we would write (notice :birth_date is present twice, once as column entry, and once more as key for an alias):

headers :first_name, :last_name, :employed_at, :birth_date, birth_date: :date_of_birth

This allows you to use a method #date_of_birth inside any #each_row in addition to #birth_date:

SimpleCsv.read ... do
  headers :name, :age, :employed_at, employed_at: :job

  each_row do
    puts "#{name} is #{age} old and works at #{job}"
  end
end

Development

After checking out the repo, run bundle to install dependencies. Then, run rspec to run the tests. You can also use the bin/console file to play around and debug.

To install this gem onto your local machine, run rake install.

To release a new version:

  • Run CI in dev branch, if tests pass, merge into master
  • Update version number in lib/simple_csv/version.rb according to symver
  • Update README.md to reflect your changes
  • run rake release to push commits, create a tag for the current commit and push the .gem file to RubyGems

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/sidofc/simple_csv. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

You can’t perform that action at this time.