Skip to content

matt-morris/importa

Repository files navigation

Importa

A flexible toolkit for importing, transforming, and validating data from external sources.

Installation

Install the gem and add to the application's Gemfile by executing:

$ bundle add importa

If bundler is not being used to manage dependencies, install the gem by executing:

$ gem install importa

Usage

require 'importa'
require 'csv'

class ClientTransformer < Importa::BaseTransformer
  field :first_name
  field :last_name
  field :email do |value|
    value.downcase if value.match?(/\A[^@]+@[^@]+\z/)
  end
  field :phone_number, :phone
  field :date_of_birth, :date, optional: true
end

input = CSV.read('clients.csv', headers: true)
output = ClientTransformer.transform_batch(input)

CSV.open('clients-transformed.csv', 'w', headers: output.headers, write_headers: true) do |csv|
  output.each do |row|
    csv << row
  end
end

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.

Contributing

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

License

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

Code of Conduct

Everyone interacting in the Importa project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

About

because it matters

Resources

Code of conduct

Stars

Watchers

Forks

Packages

No packages published