darlingtonia 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a2fc4e8abdff2180e2ef7ff1303661e806c4c304
+  data.tar.gz: 7d0f74053c870263e63ff9b84dc72f77c3f923eb
+SHA512:
+  metadata.gz: 752c341d5200f4bdb1c9a59a3f0188a31522558d20ea6e0d2c7f01eec36e4581aea4e6b6ffbc73c6fbc3dbce81db17e0af80a1c29ddf54bc7b0d453567f36351
+  data.tar.gz: 2ebc1641f150f1e34316a4a60f6fbb16d8fd6cf13a3a5a624f9b0d92707817662df32cdf8ff20512c4efb4ce9924f6c16fde9cef9f674174c6ab3f6483109771

data/.gitignore

@@ -0,0 +1,2 @@
+tmp
+Gemfile.lock

data/.rubocop.yml

@@ -0,0 +1,13 @@
+inherit_gem:
+  bixby: bixby_default.yml
+
+AllCops:
+  TargetRubyVersion: 2.3
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+
+RSpec/DescribeClass:
+  Exclude:
+    - 'spec/integration/**/*'

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+sudo:     false
+cache:    bundler
+dist:     trusty
+
+rvm:
+  - 2.3.4
+  - 2.4
+  - 2.5
+script:
+  - bundle exec rake
+matrix:
+  allow_failures:
+    - rvm: 2.5

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+gemspec
+
+unless ENV['CI']
+  gem 'guard'
+  gem 'pry'
+end

data/README.md

@@ -0,0 +1,15 @@
+Darlingtonia
+============
+
+Object import for Hyrax.
+
+Development
+-----------
+
+```sh
+git clone https://github.com/curationexperts/darlingtonia
+cd darlingtonia
+
+bundle install
+bundle exec rspec
+```

data/Rakefile

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'fcrepo_wrapper'
+require 'solr_wrapper'
+require 'active_fedora/rake_support'
+
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+Bundler::GemHelper.install_tasks
+
+desc 'Run style checker'
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.fail_on_error = true
+end
+
+desc 'Run specs'
+RSpec::Core::RakeTask.new(:spec)
+
+desc 'Run specs with Fedora & Solr servers'
+task :spec_with_server do
+  with_test_server { Rake::Task['spec'].invoke }
+end
+
+desc 'Check style and run specs'
+task ci: %w[rubocop spec_with_server]
+
+task default: :ci

data/darlingtonia.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+require 'darlingtonia/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'darlingtonia'
+  gem.version       = Darlingtonia::VERSION
+  gem.platform      = Gem::Platform::RUBY
+  gem.authors       = ['Tom Johnson', 'Data Curation Experts']
+  gem.email         = 'tom@curationexperts.com'
+  gem.summary       = 'Hyrax importers.'
+  gem.license       = 'Apache-2.0'
+  gem.files         = %w[AUTHORS CHANGELOG.md README.md LICENSE] +
+                      Dir.glob('lib/**/*.rb')
+  gem.require_paths = %w[lib]
+  gem.has_rdoc      = false
+
+  gem.required_ruby_version = '>= 2.3.4'
+
+  gem.add_dependency 'active-fedora', '>= 11.0', '<= 12.99'
+
+  gem.add_development_dependency 'yard',           '~> 0.9'
+  gem.add_development_dependency 'bixby',          '~> 0.3'
+  gem.add_development_dependency 'hyrax-spec',     '~> 0.2'
+  gem.add_development_dependency 'rspec',          '~> 3.6'
+  gem.add_development_dependency 'coveralls',      '~> 0.8'
+  gem.add_development_dependency 'solr_wrapper',   '~> 0.3'
+  gem.add_development_dependency 'fcrepo_wrapper', '~> 0.9'
+
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {spec}/*`.split("\n")
+end

data/lib/darlingtonia.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'active_fedora'
+
+##
+# Bulk object import for Hyrax
+module Darlingtonia
+  require 'darlingtonia/version'
+  require 'darlingtonia/hash_mapper'
+
+  require 'darlingtonia/importer'
+  require 'darlingtonia/record_importer'
+
+  require 'darlingtonia/input_record'
+
+  require 'darlingtonia/parser'
+  require 'darlingtonia/parsers/csv_parser'
+
+  require 'darlingtonia/validator'
+  require 'darlingtonia/validators/csv_format_validator'
+end

data/lib/darlingtonia/always_invalid_validator.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Darlingtonia
+  ##
+  # A Validator that always gives an error named `:everytime`.
+  #
+  # @example
+  #   validator = AlwaysInvalidValidator.new
+  #   validator.validate(:anything, :at, :all) # => [Error<#...>]
+  class AlwaysInvalidValidator < Validator
+    ##
+    # @return [Array<Validator::Error>]
+    def validate(*)
+      [Error.new(self, :everytime)]
+    end
+  end
+end

data/lib/darlingtonia/hash_mapper.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Darlingtonia
+  ##
+  # A generic metadata mapper for input records
+  #
+  # Maps from hash accessor syntax (`['title']`) to method call dot syntax (`.title`)
+  class HashMapper
+    ##
+    # @!attribute [r] meadata
+    #   @return [Hash<String, String>]
+    attr_reader :metadata
+
+    ##
+    # @param meta [#to_h]
+    # @return [Hash<String, String>]
+    def metadata=(meta)
+      @metadata = meta.to_h
+    end
+
+    ##
+    # @param name [Symbol]
+    #
+    # @return [Boolean]
+    def field?(name)
+      fields.include?(name)
+    end
+
+    ##
+    # @return [Enumerable<Symbol>] The fields the mapper can process
+    def fields
+      return [] if metadata.nil?
+      metadata.keys.map(&:to_sym)
+    end
+
+    def method_missing(method_name, *args, &block)
+      return Array(metadata[method_name.to_s]) if fields.include?(method_name)
+      super
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      field?(method_name) || super
+    end
+  end
+end

data/lib/darlingtonia/importer.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Darlingtonia
+  class Importer
+    extend Forwardable
+
+    ##
+    # @!attribute [rw] parser
+    #   @return [Parser]
+    # @!attribute [rw] record_importer
+    #   @return [RecordImporter]
+    attr_accessor :parser, :record_importer
+
+    ##
+    # @!method records()
+    #   @see Parser#records
+    def_delegator :parser, :records, :records
+
+    ##
+    # @param parser [Parser]
+    def initialize(parser:, record_importer: RecordImporter.new)
+      self.parser          = parser
+      self.record_importer = record_importer
+    end
+
+    ##
+    # @return [void]
+    def import
+      records.each { |record| record_importer.import(record: record) }
+    end
+  end
+end

data/lib/darlingtonia/input_record.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Darlingtonia
+  class InputRecord
+    ##
+    # @!attribute [rw] mapper
+    #   @return [#map_fields]
+    attr_accessor :mapper
+
+    ##
+    # @param metadata [Object]
+    # @param mapper   [#map_fields]
+    def initialize(mapper: HashMapper.new)
+      self.mapper = mapper
+    end
+
+    class << self
+      def from(metadata:, mapper: HashMapper.new)
+        mapper.metadata = metadata
+        new(mapper: mapper)
+      end
+    end
+
+    ##
+    # @return [Hash<Symbol, Object>]
+    def attributes
+      mapper.fields.each_with_object({}) do |field, attrs|
+        attrs[field] = public_send(field)
+      end
+    end
+
+    ##
+    # Respond to methods matching mapper fields
+    def method_missing(method_name, *args, &block)
+      return super unless mapper.field?(method_name)
+      mapper.public_send(method_name)
+    end
+
+    ##
+    # @see #method_missing
+    def respond_to_missing?(method_name, include_private = false)
+      mapper.field?(method_name) || super
+    end
+  end
+end

data/lib/darlingtonia/parser.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+module Darlingtonia
+  ##
+  # A generic parser
+  #
+  # @example
+  #   file = File.open('path/to/import/manifest.csv')
+  #
+  #   Parser.for(file: file).records
+  #
+  class Parser
+    @subclasses = [] # @private
+
+    ##
+    # @!attribute [rw] file
+    #   @return [File]
+    # @!attribute [rw] validators
+    #   @return [Array<Validator>]
+    # @!attribute [r] errors
+    #   @return [Array]
+    attr_accessor :file, :validators
+    attr_reader   :errors
+
+    ##
+    # @param file [File]
+    def initialize(file:, **_opts)
+      self.file     = file
+      @errors       = []
+      @validators ||= []
+
+      yield self if block_given?
+    end
+
+    class << self
+      ##
+      # @param file [Object]
+      #
+      # @return [Darlingtonia::Parser] a parser instance appropriate for
+      #   the arguments
+      #
+      # @raise [NoParserError]
+      def for(file:)
+        klass =
+          @subclasses.find { |k| k.match?(file: file) } ||
+          raise(NoParserError)
+
+        klass.new(file: file)
+      end
+
+      ##
+      # @abstract
+      # @return [Boolean]
+      def match?(**_opts); end
+
+      private
+
+      ##
+      # @private Register a new class when inherited
+      def inherited(subclass)
+        @subclasses << subclass
+        super
+      end
+    end
+
+    ##
+    # @abstract
+    #
+    # @yield [record] gives each record in the file to the block
+    # @yieldparam record [ImportRecord]
+    #
+    # @return [Enumerable<ImportRecord>]
+    def records
+      raise NotImplementedError
+    end
+
+    ##
+    # @return [Boolean] true if the
+    def valid?
+      errors.empty?
+    end
+
+    ##
+    # @return [Boolean]
+    def validate
+      validators.each_with_object(errors) do |validator, errs|
+        errs.concat(validator.validate(parser: self))
+      end
+
+      valid?
+    end
+
+    ##
+    # @return [true]
+    # @raise [ValidationError] if the file to parse is invalid
+    def validate!
+      validate || raise(ValidationError)
+    end
+
+    class NoParserError < TypeError; end
+    class ValidationError < RuntimeError; end
+  end
+end

data/lib/darlingtonia/parsers/csv_parser.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'csv'
+
+module Darlingtonia
+  ##
+  # A parser for CSV files
+  class CsvParser < Parser
+    EXTENSION = '.csv'
+
+    class << self
+      ##
+      # Matches all '.csv' filenames.
+      def match?(file:, **_opts)
+        File.extname(file) == EXTENSION
+      rescue TypeError
+        false
+      end
+    end
+
+    ##
+    # Gives a record for each line in the .csv
+    #
+    # @see Parser#records
+    def records
+      return enum_for(:records) unless block_given?
+
+      file.rewind
+
+      CSV.parse(file.read, headers: true).each do |row|
+        yield InputRecord.from(metadata: row)
+      end
+    end
+  end
+end

data/lib/darlingtonia/record_importer.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Darlingtonia
+  class RecordImporter
+    ##
+    # @param record [ImportRecord]
+    #
+    # @return [void]
+    def import(record:)
+      import_type.create(record.attributes)
+    end
+
+    def import_type
+      raise 'No curation_concern found for import' unless
+        defined?(Hyrax) && Hyrax&.config&.curation_concerns&.any?
+
+      Hyrax.config.curation_concerns.first
+    end
+  end
+end

data/lib/darlingtonia/validator.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Darlingtonia
+  ##
+  # @abstract A null validator; always returns an empty error collection
+  class Validator
+    Error = Struct.new(:validator, :name, :description, :lineno)
+
+    ##
+    # @param parser       [Parser]
+    # @param error_stream [#add]
+    #
+    # @return [Enumerator<Error>] a collection of errors found in validation
+    #
+    # rubocop:disable Lint/UnusedMethodArgument
+    def validate(parser:, **)
+      []
+    end
+    # rubocop:enable Lint/UnusedMethodArgument
+  end
+end

data/lib/darlingtonia/validators/csv_format_validator.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Darlingtonia
+  ##
+  # A validator for correctly formatted CSV
+  class CsvFormatValidator < Validator
+  end
+end

data/lib/darlingtonia/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Darlingtonia
+  VERSION = '0.1.0'
+end

data/spec/darlingtonia/csv_format_validator_spec.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Darlingtonia::CsvFormatValidator do
+  it_behaves_like 'a Darlingtonia::Validator'
+end

data/spec/darlingtonia/csv_parser_spec.rb

@@ -0,0 +1,48 @@
+# coding: utf-8
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Darlingtonia::CsvParser do
+  subject(:parser) { described_class.new(file: file) }
+  let(:file)       { Tempfile.new(['fake', '.csv']) }
+
+  shared_context 'with content' do
+    let(:csv_content) do
+      <<-EOS
+title,description,date
+The Moomins and the Great Flood,"The Moomins and the Great Flood (Swedish: Småtrollen och den stora översvämningen, literally The Little Trolls and the Great Flood) is a book written by Finnish author Tove Jansson in 1945, during the end of World War II. It was the first book to star the Moomins, but is often seen as a prelude to the main Moomin books, as most of the main characters are introduced in the next book.",1945
+Comet in Moominland,"Comet in Moominland is the second in Tove Jansson's series of Moomin books. Published in 1946, it marks the first appearance of several main characters, like Snufkin and the Snork Maiden.",1946
+EOS
+    end
+
+    let(:record_count) { 2 }
+
+    before do
+      file.write(csv_content)
+      file.rewind
+    end
+  end
+
+  it_behaves_like 'a Darlingtonia::Parser' do
+    include_context 'with content'
+  end
+
+  it 'matches .csv files' do
+    expect(Darlingtonia::Parser.for(file: file)).to be_a described_class
+  end
+
+  describe '#records' do
+    include_context 'with content'
+
+    it 'has the correct titles' do
+      expect(parser.records.map(&:title))
+        .to contain_exactly(['The Moomins and the Great Flood'],
+                            ['Comet in Moominland'])
+    end
+
+    it 'has correct other fields' do
+      expect(parser.records.map(&:date)).to contain_exactly(['1945'], ['1946'])
+    end
+  end
+end

data/spec/darlingtonia/hash_mapper_spec.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+describe Darlingtonia::HashMapper do
+  it_behaves_like 'a Darlingtonia::Mapper' do
+    let(:expected_fields) { metadata.keys.map(&:to_sym) }
+    let(:metadata) { { 'a_field' => 'a', 'b_field' => 'b', 'c_field' => 'c' } }
+  end
+end

data/spec/darlingtonia/importer_spec.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Darlingtonia::Importer do
+  subject(:importer) { described_class.new(parser: parser) }
+  let(:parser)       { FakeParser.new(file: input) }
+  let(:input)        { [{ 'title' => '1' }, { 'title' => '2' }, { 'title' => '3' }] }
+
+  let(:fake_record_importer) do
+    Class.new do
+      def import(record:)
+        records << record.attributes
+      end
+
+      def records
+        @records ||= []
+      end
+    end
+  end
+
+  describe '#records' do
+    it 'reflects the parsed records' do
+      expect(importer.records.map(&:attributes))
+        .to contain_exactly(*parser.records.map(&:attributes))
+    end
+  end
+
+  describe '#import' do
+    let(:record_importer) { fake_record_importer.new }
+
+    before { importer.record_importer = record_importer }
+
+    it 'sends records to the record importer' do
+      expect { importer.import }
+        .to change { record_importer.records }
+        .from(be_empty)
+        .to a_collection_containing_exactly(*importer.records.map(&:attributes))
+    end
+  end
+end

data/spec/darlingtonia/input_record_spec.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+describe Darlingtonia::InputRecord do
+  subject(:record) { described_class.from(metadata: metadata) }
+
+  let(:metadata) do
+    { 'title'       => 'Comet in Moominland',
+      'description' => 'A book about moomins.' }
+  end
+
+  it 'has metadata and a mapper' do
+    is_expected
+      .to have_attributes(mapper: an_instance_of(Darlingtonia::HashMapper))
+  end
+
+  describe '#attributes' do
+    it 'handles basic text fields' do
+      expect(record.attributes).to include(:title, :description)
+    end
+  end
+
+  describe 'mapped fields' do
+    it 'has methods for metadata fields' do
+      expect(record.title).to contain_exactly metadata['title']
+    end
+
+    it 'has methods for additional mapped metadata fields' do
+      expect(record.description).to contain_exactly metadata['description']
+    end
+
+    it 'knows it responds to methods for metadata fields' do
+      expect(record).to respond_to :title
+    end
+
+    it 'knows it responds to methods for additional metadata fields' do
+      expect(record).to respond_to :description
+    end
+  end
+end

data/spec/darlingtonia/parser_spec.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Darlingtonia::Parser do
+  subject(:parser) { described_class.new(file: file) }
+  let(:file)       { :fake_file }
+
+  it_behaves_like 'a Darlingtonia::Parser'
+
+  describe '.for' do
+    it 'raises an error' do
+      expect { described_class.for(file: file) }.to raise_error TypeError
+    end
+
+    context 'with a matching parser subclass' do
+      before(:context) do
+        ##
+        # An importer that matches all types
+        class FakeParser < described_class
+          class << self
+            def match?(**_opts)
+              true
+            end
+          end
+        end
+      end
+
+      after(:context) { Object.send(:remove_const, :FakeParser) }
+
+      it 'returns an importer instance' do
+        expect(described_class.for(file: file)).to be_a FakeParser
+      end
+    end
+  end
+
+  describe '#records' do
+    it 'raises NotImplementedError' do
+      expect { parser.records }.to raise_error NotImplementedError
+    end
+  end
+end

data/spec/darlingtonia/validator_spec.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Darlingtonia::Validator do
+  it_behaves_like 'a Darlingtonia::Validator'
+end

data/spec/darlingtonia/version_spec.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Darlingtonia::VERSION do
+  it { is_expected.to be_a String }
+end

data/spec/fixtures/example.csv

@@ -0,0 +1,4 @@
+title,description
+Fake Item,A description of a fake item.
+Fake Item with Quoted Description,"Lorem ipsum dolor sit amet, cu mel habeo antiopam, id pri mucius oporteat. No graeco accumsan deterruisset est. Vix te sonet doctus perpetua, mei at odio eius nostrum. Ex postea quidam menandri duo. Rebum ullum cu mel.\nAperiam malorum indoctum ad nec.\nIn duo nonumes accusata, detraxit adipisci philosophia quo id. Ei usu volutpat vituperatoribus. Ut veniam dolorem qui. Ei legendos erroribus usu. Mentitum moderatius ei est, mei eius magna alterum no. Legere vivendum per ad, vim ei putent facilis."
+Fake Item with Unicode Description,"Лорем ипсум долор сит амет, ех мовет толлит модератиус ест. Еу яуидам сенсерит цонсецтетуер про, при иисяуе ерудити цоррумпит ат. Ех усу нусяуам пхаедрум темпорибус, ест ат омнесяуе инструцтиор.\nЯуо ех мелиоре инсоленс праесент, иудицо тантас еурипидис хис ут. Аццусам урбанитас инструцтиор ан еам. Но хас вениам дицунт дебитис, нец ут суас аццусам перицула, нец риденс аетерно виртуте не.\nАт про еним вереар, ут солум юсто меи."

data/spec/integration/import_csv_spec.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe 'importing a csv batch' do
+  subject(:importer) { Darlingtonia::Importer.new(parser: parser) }
+  let(:parser)       { Darlingtonia::CsvParser.new(file: file) }
+  let(:file)         { File.open('spec/fixtures/example.csv') }
+
+  # A work type must be defined for the default `RecordImporter` to save objects
+  before do
+    class Work < ActiveFedora::Base
+      property :title,       predicate: ::RDF::URI('http://example.com/title')
+      property :description, predicate: ::RDF::URI('http://example.com/description')
+    end
+
+    module Hyrax
+      def self.config
+        Config.new
+      end
+
+      class Config
+        def curation_concerns
+          [Work]
+        end
+      end
+    end
+  end
+
+  after do
+    Object.send(:remove_const, :Hyrax)
+    Object.send(:remove_const, :Work)
+  end
+
+  it 'creates a record for each CSV line' do
+    expect { importer.import }.to change { Work.count }.to 3
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'pry' unless ENV['CI']
+ENV['environment'] ||= 'test'
+
+require 'bundler/setup'
+require 'darlingtonia'
+
+Dir['./spec/support/**/*.rb'].each { |f| require f }
+
+RSpec.configure do |config|
+  config.filter_run focus: true
+  config.run_all_when_everything_filtered = true
+end

data/spec/support/fakes/fake_parser.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+class FakeParser < Darlingtonia::Parser
+  METADATA = [{ 'title' => '1' }, { 'title' => '2' }, { 'title' => '3' }].freeze
+
+  def initialize(file: METADATA)
+    super
+  end
+
+  def records
+    return enum_for(:records) unless block_given?
+
+    file.each { |hsh| yield Darlingtonia::InputRecord.from(metadata: hsh) }
+  end
+end
+
+require 'support/shared_examples/a_parser'
+
+# rubocop:disable RSpec/FilePath
+describe FakeParser do
+  it_behaves_like 'a Darlingtonia::Parser' do
+    subject(:parser)   { described_class.new }
+    let(:record_count) { 3 }
+  end
+end
+# rubocop:enable RSpec/FilePath

data/spec/support/shared_examples/a_mapper.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+shared_examples 'a Darlingtonia::Mapper' do
+  subject(:mapper) { described_class.new }
+
+  before { mapper.metadata = metadata }
+
+  describe '#metadata' do
+    it 'can be set' do
+      expect { mapper.metadata = nil }
+        .to change { mapper.metadata }
+    end
+  end
+
+  describe '#field?' do
+    it 'does not have bogus fields' do
+      expect(mapper.field?(:NOT_A_REAL_FIELD)).to be_falsey
+    end
+
+    it 'has fields that are expected' do
+      if defined?(expected_fields)
+        expected_fields.each do |field|
+          expect(mapper.field?(field)).to be_truthy
+        end
+      end
+    end
+  end
+
+  describe '#fields' do
+    it { expect(mapper.fields).to contain_exactly(*expected_fields) }
+  end
+end

data/spec/support/shared_examples/a_parser.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require 'darlingtonia/always_invalid_validator'
+
+shared_examples 'a Darlingtonia::Parser' do
+  describe '#file' do
+    it 'is an accessor' do
+      expect { parser.file = :a_new_file }
+        .to change { parser.file }
+        .to(:a_new_file)
+    end
+  end
+
+  describe '#records' do
+    it 'yields records' do
+      unless described_class == Darlingtonia::Parser
+        expect { |b| parser.records(&b) }
+          .to yield_control.exactly(record_count).times
+      end
+    end
+  end
+
+  describe '#valid?' do
+    it 'is valid' do
+      expect(parser).to be_valid
+    end
+
+    context 'when not valid' do
+      before do
+        parser.validators = [Darlingtonia::AlwaysInvalidValidator.new]
+      end
+
+      it 'is invalid' do
+        expect { parser.validate }
+          .to change { parser.valid? }
+          .to be_falsey
+      end
+    end
+  end
+
+  describe '#validate' do
+    it 'is true when valid' do
+      expect(parser.validate).to be_truthy
+    end
+
+    context 'when not valid' do
+      before do
+        parser.validators = [Darlingtonia::AlwaysInvalidValidator.new]
+      end
+
+      it 'is invalid' do
+        expect(parser.validate).to be_falsey
+      end
+    end
+  end
+
+  describe '#validate!' do
+    it 'is true when valid' do
+      expect(parser.validate).to be_truthy
+    end
+
+    context 'when not valid' do
+      before do
+        parser.validators = [Darlingtonia::AlwaysInvalidValidator.new]
+      end
+
+      it 'raises a ValidationError' do
+        expect { parser.validate! }
+          .to raise_error Darlingtonia::Parser::ValidationError
+      end
+    end
+  end
+end

data/spec/support/shared_examples/a_validator.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+shared_examples 'a Darlingtonia::Validator' do
+  subject(:validator) { described_class.new }
+
+  define :be_a_validator_error do # |expected|
+    match { false } # { |actual| some_condition }
+  end
+
+  describe '#validate' do
+    context 'without a parser' do
+      it 'raises ArgumentError' do
+        expect { validator.validate }.to raise_error ArgumentError
+      end
+    end
+
+    it 'gives an empty error collection for a valid parser' do
+      expect(validator.validate(parser: valid_parser)).to be_empty if
+        defined?(valid_parser)
+    end
+
+    context 'for an invalid parser' do
+      it 'gives an non-empty error collection' do
+        expect(validator.validate(parser: invalid_parser)).not_to be_empty if
+          defined?(invalid_parser)
+      end
+
+      it 'gives usable errors' do
+        pending 'we need to clarify the error type and usage'
+
+        validator.validate(parser: invalid_parser).each do |error|
+          expect(error).to be_a_validator_error
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,195 @@
+--- !ruby/object:Gem::Specification
+name: darlingtonia
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tom Johnson
+- Data Curation Experts
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-01-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: active-fedora
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '11.0'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '12.99'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '11.0'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '12.99'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: bixby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: hyrax-spec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: solr_wrapper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: fcrepo_wrapper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: 
+email: tom@curationexperts.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- darlingtonia.gemspec
+- lib/darlingtonia.rb
+- lib/darlingtonia/always_invalid_validator.rb
+- lib/darlingtonia/hash_mapper.rb
+- lib/darlingtonia/importer.rb
+- lib/darlingtonia/input_record.rb
+- lib/darlingtonia/parser.rb
+- lib/darlingtonia/parsers/csv_parser.rb
+- lib/darlingtonia/record_importer.rb
+- lib/darlingtonia/validator.rb
+- lib/darlingtonia/validators/csv_format_validator.rb
+- lib/darlingtonia/version.rb
+- spec/darlingtonia/csv_format_validator_spec.rb
+- spec/darlingtonia/csv_parser_spec.rb
+- spec/darlingtonia/hash_mapper_spec.rb
+- spec/darlingtonia/importer_spec.rb
+- spec/darlingtonia/input_record_spec.rb
+- spec/darlingtonia/parser_spec.rb
+- spec/darlingtonia/validator_spec.rb
+- spec/darlingtonia/version_spec.rb
+- spec/fixtures/example.csv
+- spec/integration/import_csv_spec.rb
+- spec/spec_helper.rb
+- spec/support/fakes/fake_parser.rb
+- spec/support/shared_examples/a_mapper.rb
+- spec/support/shared_examples/a_parser.rb
+- spec/support/shared_examples/a_validator.rb
+homepage: 
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.4
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Hyrax importers.
+test_files: []