Hyrax importers
Clone or download
mark-dce Merge pull request #29 from curationexperts/update-readme
adding close file to README import example
Latest commit 375cda9 May 1, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
lib
spec Provide a `FormattedMessageStream` as a wrapper around other streams Feb 3, 2018
.gitignore Ignore `pkg` directory Jan 17, 2018
.rubocop.yml Provide a `FormattedMessageStream` as a wrapper around other streams Feb 3, 2018
.travis.yml Configure travis for CI Jan 8, 2018
CHANGELOG.md
Gemfile Initial commit Jan 8, 2018
README.md adding close file to README import example Apr 13, 2018
Rakefile Support saving `ActiveFedora::Base` objects with an `Importer` Jan 11, 2018
darlingtonia.gemspec

README.md

Darlingtonia

Yard Docs

Object import for Hyrax. See the API documentation for more information.

Usage

In your project's Gemfile, add: gem 'darlingtonia', '~> 0.1', then do bundle install.

This software is primarily intended for use in a Hyrax project. However, its dependency on hyrax is kept strictly optional so most of its code can be reused to good effect elsewhere.

To do a basic Hyrax import, first ensure that a work type is registered with your Hyrax application. You need to provide a Parser (out of the box, we support simple CSV import with CsvParser).

file = File.open('path/to/import.csv')
parser = Darlingtonia::CsvParser.new(file: file)

Darlingtonia::Importer.new(parser: parser).import

file.close # unless a block is passed to File.open, the file must be explicitly closed

Development

git clone https://github.com/curationexperts/darlingtonia
cd darlingtonia

bundle install
bundle exec rake ci

RSpec Support

This gem ships with RSpec shared examples and other support tools intended to ease testing and ensure interoperability of client code. These can be included by adding require 'darlingtonia/spec' to a spec_helper.rb or rails_helper.rb file in your application's test suite.