A simple gem to help you import CSVs into your ActiveRecord models.
It uses SmarterCSV and activerecord-import
to import database records from your CSVs.
Add this line to your application's Gemfile:
gem "row_boat", "~> 0.4"
And then execute:
$ bundle
Below we're defining the required methods (import_into
and column_mapping
) and a few additional options as well (via value_converters
and options
). Checkout API.md for the full documentation for more details :)
class ImportProduct < RowBoat::Base
# required
def import_into
Product # The ActiveRecord class we want to import records into.
end
# required
def column_mapping
{
# `:prdct_name` is the downcased and symbolized version
# of our column header, while `:name` is the attribute
# of our model we want to receive `:prdct_name`'s value
prdct_name: :name,
dllr_amnt: :price_in_cents,
desc: :description
}
end
# optional
def value_converters
{
# Allows us to change values we want to import
# before we import them
price_in_cents: -> (value) { value * 1000 }
}
end
# optional
def preprocess_row(row)
if row[:name] && row[:description] && row[:price]
row
else
nil # return nil to skip a row
end
# we could also remove some attributes or do any
# other kind of work we want with the given row.
end
#optional
def options
{
# These are additional configurations that
# are generally passed through to SmarterCSV
# and activerecord-import
validate: false, # this defaults to `true`
wrap_in_transaction: false # this defaults to `true`
}
end
end
After checking out the repo, run bin/setup
to install dependencies. Then, run rake
to run the tests (run appraisal install
and appraisal rake
to run the tests against different combinations of dependencies). You can also run bin/console
for an interactive prompt that will allow you to experiment.
Bug reports and pull requests are welcome on GitHub at https://github.com/devmynd/row_boat. 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.
The gem is available as open source under the terms of the MIT License.