audumbla 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 85d96776f960b63fce1a6e0533f8e53d9afe9ae8
+  data.tar.gz: c9fa438ae3c3ff6e6ae06395f188b18872b44a6b
+SHA512:
+  metadata.gz: f409960eca0091c5405aecbdafb6dab5d1eaf1e3383ac23c3ac32a40a38b24210ec57f8456be9d4f949498537d4e2bc4b678551c836f121f8c255ddc9b627571
+  data.tar.gz: d0d5b93cad7e668c0faae99ad5dca370baa9d3e15d7d22becb917aa62acfb438428bd66b9f9ab29c79aececd376950b52b244ce26c0b5c623a6f018685626d66

data/README.md

@@ -0,0 +1,22 @@
+Auðumbla
+========
+
+[![Build Status](https://travis-ci.org/dpla/audumbla.svg?branch=develop)](https://travis-ci.org/dpla/audumbla)
+
+Auðumbla provides the basic functionality for defining and running
+metadata enrichments in [KriKri](https://github.com/dpla/KriKri).
+
+Contribution Guidelines
+-----------------------
+Please observe the following guidelines:
+
+- Write tests for your contributions.
+- Document methods you add using YARD annotations.
+- Follow the included style guidelines (i.e. run `rubocop` before committing).
+- Use well formed commit messages.
+
+Copyright & License
+--------------------
+
+- Copyright Digital Public Library of America, 2014-2015
+- License: MIT

data/lib/audumbla.rb

@@ -0,0 +1,4 @@
+module Audumbla
+  autoload :Enrichment, 'audumbla/enrichment'
+  autoload :FieldEnrichment, 'audumbla/field_enrichment'
+end

data/lib/audumbla.rb~

@@ -0,0 +1,4 @@
+module Audumbla
+  autoload :Enrichment
+  autoload :FieldEnrichment
+end

data/lib/audumbla/enrichment.rb

@@ -0,0 +1,148 @@
+module Audumbla
+  ##
+  # Mixin module for enriching a set of input_fields and setting the resulting
+  # values to a set of output fields.
+  module Enrichment
+    ##
+    # The main enrichment method; passes specified input fields to
+    # #enrich_values, which must return an array of values with length equal to
+    # the number of output fields. The values of the output fields are set to
+    # the corresponding result from the enrichment.
+    #
+    # Pass fields to `input_fields` and `output_fields`. Fields are formatted
+    # as symbols in nested hashes, targeting a particular field in an
+    # ActiveTriples Resource property hierarchy:
+    #
+    #   :sourceResource
+    #   {:sourceResource => :spatial}
+    #   {:sourceResource => {:creator => :name}}
+    #
+    # The record passed in is not altered, but cloned before the enrichment is
+    # applied. A common pattern may be:
+    #
+    #   record = my_enrichment.enrich(record, input, output)
+    #   record.persist!
+    #
+    # Input fields create an array selecting the values of all matching fields.
+    # For example:
+    #
+    # an array of values from record.sourceResource:
+    #   :sourceResource
+    #
+    # an array of values combining spatial fields from the values of
+    # record.sourceResource:
+    #   {:sourceResource => :spatial}
+    #
+    # an array of values combining name fields from the creators in
+    # record.sourceResource:
+    #   {:sourceResource => {:creator => :name}}
+    #
+    #
+    # Output fields should be specified at a high enough level that the
+    # enrichment can build a complete value set from the input values provided.
+    # An enrichment for mapping names to LCSH URIs, that alters all creator
+    # fields might be formatted:
+    #
+    #   my_enrichment.enrich(record,
+    #     [{:sourceResource => {:creator => :providedLabel}}],
+    #     [{:sourceResource => :creator}])
+    #
+    # This would pass the values like the following, sourced from the
+    # providedLabel, to #enrich_value:
+    #
+    #   [['Moomintroll', 'Moomin Papa', 'Moomin Mama']]
+    #
+    # And it would expect to receive an array of values set directly to creator,
+    # overwriting all existing creator values:
+    #
+    #   [DPLA::MAP::Agent:0x3ff(default),
+    #    DPLA::MAP::Agent:0x9f5(default),
+    #    DPLA::MAP::Agent:0x3a8(default)]
+    #
+    # @param record [ActiveTriples::Resource] the record to enrich
+    # @param input_fields [Array] the fields whose values to pass to the
+    #   enrichment method
+    # @param output_fields [Array] the fields on which to apply the enrichment
+    # @return [ActiveTriples::Resource] the enriched record
+    def enrich(record, input_fields, output_fields)
+      enrich!(record.clone, input_fields, output_fields)
+    end
+
+    ##
+    # Runs the enrichment directly on the given record.
+    #
+    # @see Audumbla::Enrichment#enrich
+    def enrich!(record, input_fields, output_fields)
+      output_fields.map! { |f| field_to_chain(f) }
+
+      values = values_from_fields(record, input_fields)
+      values = enrich_value(values).dup
+
+      raise 'field/value mismatch.' \
+        "#{values.count} values for #{output_fields.count} fields." unless
+        values.count == output_fields.count
+
+      output_fields.each { |field| set_field(record, field, values.shift) }
+      record
+    end
+
+    ##
+    # @abstract Runs the enrichment against a field
+    #
+    # Accept an array of values from an ActiveTriples::Resource property, and
+    # return an array of values to set to output fields.
+    #
+    # @param [ActiveTriples::Resource, RDF::Literal] the value(s) to process
+    # @return [ActiveTriples::Resource] the enriched record
+    def enrich_value(_)
+      raise NotImplementedError
+    end
+
+    def list_fields(record)
+      fields = []
+      record.class.properties.each do |prop, _|
+        fields << prop.to_sym
+
+        objs = resources(record.send(fields.last)).map { |r| list_fields(r) }
+        next if objs.empty?
+
+        objs.flatten.each { |obj| fields << { prop => obj } }
+      end
+      fields
+    end
+
+    private
+
+    def values_for_field(record, field_chain)
+      values = record.send(field_chain.first)
+      return values if field_chain.length == 1
+      resources(values).map { |v| values_for_field(v, field_chain[1..-1]) }
+        .flatten.compact
+    end
+
+    def set_field(record, field_chain, values)
+      field = field_chain.pop
+      return record.send("#{field}=".to_sym, values) if field_chain.length == 0
+      values_for_field(record, field_chain).each do |obj|
+        obj.send("#{field}=".to_sym, values)
+      end
+    end
+
+    def resources(values)
+      values.select { |v| v.is_a? ActiveTriples::Resource }
+    end
+
+    def literals(values)
+      values.select { |v| !v.is_a?(ActiveTriples::Resource) }
+    end
+
+    def field_to_chain(field)
+      return Array(field) if field.is_a? Symbol
+      [field.keys.first, field_to_chain(field.values.first)].flatten
+    end
+
+    def values_from_fields(record, input_fields)
+      input_fields.map { |f| values_for_field(record, field_to_chain(f)) }
+    end
+  end
+end

data/lib/audumbla/enrichment.rb~

@@ -0,0 +1,148 @@
+module Audumbla
+  ##
+  # Mixin module for enriching a set of input_fields and setting the resulting
+  # values to a set of output fields.
+  module Enrichment
+    ##
+    # The main enrichment method; passes specified input fields to
+    # #enrich_values, which must return an array of values with length equal to
+    # the number of output fields. The values of the output fields are set to
+    # the corresponding result from the enrichment.
+    #
+    # Pass fields to `input_fields` and `output_fields`. Fields are formatted
+    # as symbols in nested hashes, targeting a particular field in an
+    # ActiveTriples Resource property hierarchy:
+    #
+    #   :sourceResource
+    #   {:sourceResource => :spatial}
+    #   {:sourceResource => {:creator => :name}}
+    #
+    # The record passed in is not altered, but cloned before the enrichment is
+    # applied. A common pattern may be:
+    #
+    #   record = my_enrichment.enrich(record, input, output)
+    #   record.persist!
+    #
+    # Input fields create an array selecting the values of all matching fields.
+    # For example:
+    #
+    # an array of values from record.sourceResource:
+    #   :sourceResource
+    #
+    # an array of values combining spatial fields from the values of
+    # record.sourceResource:
+    #   {:sourceResource => :spatial}
+    #
+    # an array of values combining name fields from the creators in
+    # record.sourceResource:
+    #   {:sourceResource => {:creator => :name}}
+    #
+    #
+    # Output fields should be specified at a high enough level that the
+    # enrichment can build a complete value set from the input values provided.
+    # An enrichment for mapping names to LCSH URIs, that alters all creator
+    # fields might be formatted:
+    #
+    #   my_enrichment.enrich(record,
+    #     [{:sourceResource => {:creator => :providedLabel}}],
+    #     [{:sourceResource => :creator}])
+    #
+    # This would pass the values like the following, sourced from the
+    # providedLabel, to #enrich_value:
+    #
+    #   [['Moomintroll', 'Moomin Papa', 'Moomin Mama']]
+    #
+    # And it would expect to receive an array of values set directly to creator,
+    # overwriting all existing creator values:
+    #
+    #   [DPLA::MAP::Agent:0x3ff(default),
+    #    DPLA::MAP::Agent:0x9f5(default),
+    #    DPLA::MAP::Agent:0x3a8(default)]
+    #
+    # @param record [ActiveTriples::Resource] the record to enrich
+    # @param input_fields [Array] the fields whose values to pass to the
+    #   enrichment method
+    # @param output_fields [Array] the fields on which to apply the enrichment
+    # @return [ActiveTriples::Resource] the enriched record
+    def enrich(record, input_fields, output_fields)
+      enrich!(record.clone, input_fields, output_fields)
+    end
+
+    ##
+    # Runs the enrichment directly on the given record.
+    #
+    # @see Krikri::Enrichment#enrich
+    def enrich!(record, input_fields, output_fields)
+      output_fields.map! { |f| field_to_chain(f) }
+
+      values = values_from_fields(record, input_fields)
+      values = enrich_value(values).dup
+
+      raise 'field/value mismatch.' \
+        "#{values.count} values for #{output_fields.count} fields." unless
+        values.count == output_fields.count
+
+      output_fields.each { |field| set_field(record, field, values.shift) }
+      record
+    end
+
+    ##
+    # @abstract Runs the enrichment against a field
+    #
+    # Accept an array of values from an ActiveTriples::Resource property, and
+    # return an array of values to set to output fields.
+    #
+    # @param [ActiveTriples::Resource, RDF::Literal] the value(s) to process
+    # @return [ActiveTriples::Resource] the enriched record
+    def enrich_value(_)
+      raise NotImplementedError
+    end
+
+    def list_fields(record)
+      fields = []
+      record.class.properties.each do |prop, _|
+        fields << prop.to_sym
+
+        objs = resources(record.send(fields.last)).map { |r| list_fields(r) }
+        next if objs.empty?
+
+        objs.flatten.each { |obj| fields << { prop => obj } }
+      end
+      fields
+    end
+
+    private
+
+    def values_for_field(record, field_chain)
+      values = record.send(field_chain.first)
+      return values if field_chain.length == 1
+      resources(values).map { |v| values_for_field(v, field_chain[1..-1]) }
+        .flatten.compact
+    end
+
+    def set_field(record, field_chain, values)
+      field = field_chain.pop
+      return record.send("#{field}=".to_sym, values) if field_chain.length == 0
+      values_for_field(record, field_chain).each do |obj|
+        obj.send("#{field}=".to_sym, values)
+      end
+    end
+
+    def resources(values)
+      values.select { |v| v.is_a? ActiveTriples::Resource }
+    end
+
+    def literals(values)
+      values.select { |v| !v.is_a?(ActiveTriples::Resource) }
+    end
+
+    def field_to_chain(field)
+      return Array(field) if field.is_a? Symbol
+      [field.keys.first, field_to_chain(field.values.first)].flatten
+    end
+
+    def values_from_fields(record, input_fields)
+      input_fields.map { |f| values_for_field(record, field_to_chain(f)) }
+    end
+  end
+end

data/lib/audumbla/enrichments.rb

@@ -0,0 +1,4 @@
+module Audumbla
+  module Enrichments
+  end
+end

data/lib/audumbla/enrichments.rb~

@@ -0,0 +1,7 @@
+module Krikri
+  autoload :Enrichment, 'krikri/enrichment'
+  autoload :FieldEnrichment, 'krikri/field_enrichment'
+
+  module Enrichments
+  end
+end

data/lib/audumbla/enrichments/geocode.rb~

@@ -0,0 +1,11 @@
+module Krikri::Enrichments
+  ##
+  #
+  class Geocode
+    include Krikri::FieldEnrichment
+
+    def enrich_value(value)
+      value
+    end
+  end
+end

data/lib/audumbla/enrichments/version.rb~

@@ -0,0 +1,5 @@
+module Krikri
+  module Enrichments
+    VERSION = '0.0.1'.final
+  end
+end

data/lib/audumbla/field_enrichment.rb

@@ -0,0 +1,60 @@
+module Audumbla
+  ##
+  # Enrich a specific field or list of fields, setting the property to the
+  # supplied value
+  module FieldEnrichment
+    include Enrichment
+
+    ##
+    # The main enrichment method; runs the enrichment against a stated
+    # set of fields for a record.
+    #
+    # This is a narrower case of `Audumbla::Enrichment` which runs the
+    # enrichment against each of the specified fields in turn, setting
+    # the field's value to the result.
+    #
+    # For example:
+    #
+    #   delete_empty_string_literals.enrich(record,
+    #     {:sourceResource => {:creator => :name}})
+    #
+    # To apply the enrichment across all fields, leave the fields parameter
+    # empty, or use `:all`:
+    #
+    #   delete_empty_string_literals.enrich(record)
+    #   delete_empty_string_literals.enrich(record, :all)
+    #
+    # @see Audumbla::Enrichment#enrich for documentation about field
+    #   formatting
+    #
+    # @param record [ActiveTriples::Resource] the record to enrich
+    # @param fields [Array] the fields on which to apply the enrichment
+    # @return [ActiveTriples::Resource] the enriched record
+    def enrich(record, *fields)
+      record = record.clone
+      return enrich_all(record) if fields.empty? || fields == [:all]
+      fields.each { |f| enrich_field(record, field_to_chain(f)) }
+      record
+    end
+
+    def enrich_field(record, field_chain)
+      field = field_chain.first
+      return record unless record.respond_to? field
+      values = record.send(field)
+      if field_chain.length == 1
+        new_values = values.map { |v| enrich_value(v) }.flatten.compact
+        record.send("#{field}=".to_sym, new_values)
+      else
+        resources(values).each { |v| enrich_field(v, field_chain[1..-1]) }
+      end
+      record
+    end
+
+    def enrich_all(record)
+      list_fields(record).each do |field|
+        enrich_field(record, field_to_chain(field))
+      end
+      record
+    end
+  end
+end

data/lib/audumbla/field_enrichment.rb~

@@ -0,0 +1,60 @@
+module Krikri
+  ##
+  # Enrich a specific field or list of fields, setting the property to the
+  # supplied value
+  module FieldEnrichment
+    include Enrichment
+
+    ##
+    # The main enrichment method; runs the enrichment against a stated
+    # set of fields for a record.
+    #
+    # This is a narrower case of `Krikri::Enrichment` which runs the
+    # enrichment against each of the specified fields in turn, setting
+    # the field's value to the result.
+    #
+    # For example:
+    #
+    #   delete_empty_string_literals.enrich(record,
+    #     {:sourceResource => {:creator => :name}})
+    #
+    # To apply the enrichment across all fields, leave the fields parameter
+    # empty, or use `:all`:
+    #
+    #   delete_empty_string_literals.enrich(record)
+    #   delete_empty_string_literals.enrich(record, :all)
+    #
+    # @see Krikri::Enrichment#enrich for documentation about field
+    #   formatting
+    #
+    # @param record [ActiveTriples::Resource] the record to enrich
+    # @param fields [Array] the fields on which to apply the enrichment
+    # @return [ActiveTriples::Resource] the enriched record
+    def enrich(record, *fields)
+      record = record.clone
+      return enrich_all(record) if fields.empty? || fields == [:all]
+      fields.each { |f| enrich_field(record, field_to_chain(f)) }
+      record
+    end
+
+    def enrich_field(record, field_chain)
+      field = field_chain.first
+      return record unless record.respond_to? field
+      values = record.send(field)
+      if field_chain.length == 1
+        new_values = values.map { |v| enrich_value(v) }.flatten.compact
+        record.send("#{field}=".to_sym, new_values)
+      else
+        resources(values).each { |v| enrich_field(v, field_chain[1..-1]) }
+      end
+      record
+    end
+
+    def enrich_all(record)
+      list_fields(record).each do |field|
+        enrich_field(record, field_to_chain(field))
+      end
+      record
+    end
+  end
+end

data/lib/audumbla/spec/enrichment.rb

@@ -0,0 +1,242 @@
+shared_context 'with record' do
+  let(:record) { build(:aggregation) }
+end
+
+shared_examples 'an enrichment' do
+  include_context 'with record'
+
+  it { is_expected.to be_a Audumbla::Enrichment }
+  it { is_expected.to respond_to :enrich_value }
+
+  describe '#list_fields' do
+    let(:list) { subject.list_fields(record) }
+
+    it 'generates a list of fields' do
+      expect(list).to include(an_instance_of(Symbol), an_instance_of(Hash))
+    end
+  end
+
+  describe '#enrich' do
+    before { allow(subject).to receive(:enrich_value).and_return(new_value) }
+
+    let(:new_value) { ['Christmas in Moominvalley'] }
+    let(:args) do
+      subject.class.instance_method(:enrich).arity > 1 ? enrich_args : [record]
+    end
+
+    it 'returns a record eql to the input record' do
+      expect(subject.enrich(*args)).to eq record
+    end
+
+    it 'copies the input record' do
+      expect(subject.enrich(*args)).not_to eql record
+    end
+
+    it 'does not change the record object passed in' do
+      expect { subject.enrich(*args) }.not_to change { record }
+    end
+  end
+end
+
+shared_examples 'a generic enrichment' do
+  it_behaves_like 'an enrichment'
+  include_context 'with record'
+
+  let(:enrich_args) do
+    [record, [{ :sourceResource => :title }], [{ :sourceResource => :creator }]]
+  end
+
+  describe '#enrich' do
+    before do
+      allow(subject).to receive(:enrich_value).and_return(new_value)
+    end
+
+    shared_examples 'multiple input fields' do
+      before do
+        record.sourceResource.first.spatial.first.name = 'NY'
+        enrich_args[1] << { :sourceResource => { :spatial => :name } }
+      end
+
+      let(:input_values) do
+        [record.sourceResource.map(&:title).flatten,
+         record.sourceResource.map { |sr| sr.spatial.map(&:name) }.flatten]
+      end
+
+      it 'enriches with values for input fields' do
+        expect(subject).to receive(:enrich_value).with(input_values)
+        subject.enrich(*enrich_args)
+      end
+    end
+
+    context 'with single output field' do
+      include_examples 'multiple input fields'
+
+      let(:new_value) { ['snufkin'] }
+
+      it 'enriches targeted field' do
+        subject.enrich(*enrich_args).sourceResource.map do |cho|
+          expect(cho.creator).to eq new_value
+        end
+      end
+    end
+
+    context 'with multiple output fields' do
+      include_examples 'multiple input fields'
+
+      before do
+        enrich_args[2] << { :sourceResource => :spatial }
+      end
+
+      let(:new_value) { [['snufkin'], ['moominvalley']] }
+
+      it 'enriches targeted fields' do
+        subject.enrich(*enrich_args).sourceResource.map do |cho|
+          expect(cho.creator).to eq new_value.first
+          expect(cho.spatial).to eq new_value[1]
+        end
+      end
+    end
+  end
+end
+
+shared_examples 'a field enrichment' do
+  it_behaves_like 'an enrichment'
+  include_context 'with record'
+
+  let(:updated_value) { 'Christmas in Moominvalley' }
+
+  describe '#enrich_field' do
+    let(:field_chain) { [:sourceResource, :creator, :providedLabel] }
+    let(:klass) { record.sourceResource.first.creator.first.class }
+    let(:enriched) { subject.enrich_field(record, field_chain) }
+
+    before do
+      allow(subject).to receive(:enrich_value).and_return(updated_value)
+    end
+
+    it 'updates value with enriched version' do
+      expect(enriched.sourceResource.first.creator.first.providedLabel)
+        .to eq [updated_value]
+    end
+
+    context 'when targeted value is empty' do
+      before do
+        enriched.sourceResource.first.creator.first.providedLabel = nil
+      end
+
+      it 'passes over value' do
+        expect(enriched.sourceResource.first.creator.first.providedLabel)
+          .to eq []
+      end
+    end
+
+    context 'with multiple values' do
+      before do
+        new_creator = klass.new
+        new_creator.providedLabel = 'old value'
+        record.sourceResource.first.creator << new_creator
+        record.sourceResource.first.creator << 'literal value'
+      end
+
+      it 'retains literal values' do
+        expect(enriched.sourceResource.first.creator)
+          .to contain_exactly('literal value',
+                              an_instance_of(klass),
+                              an_instance_of(klass))
+      end
+
+      it 'updates values with enriched versions' do
+        creators = enriched.sourceResource.first.creator.select do |o|
+          o.is_a?(klass)
+        end
+        creators.each { |val| expect(val.providedLabel).to eq [updated_value] }
+      end
+
+      context 'when node is missing property' do
+        before do
+          record.sourceResource.first.creator << node
+        end
+
+        let(:node) do
+          creator = ActiveTriples::Resource.new
+          creator.set_value(RDF::DC.title, 'moomin')
+          creator
+        end
+
+        it 'leaves node unaltered' do
+          expect(record.sourceResource.first.creator).to include node
+        end
+      end
+    end
+  end
+
+  describe '#enrich_all' do
+    it 'runs enrichment over all fields' do
+      expect(subject).to receive(:enrich_field)
+        .exactly(subject.list_fields(record).count).times
+      subject.enrich_all(record)
+    end
+
+    it 'sets fields to new value' do
+      allow(subject).to receive(:enrich_value).and_return(updated_value)
+      subject.enrich_all(record)
+      record.class.properties.each do |prop, _|
+        expect(record.send(prop)).to eq [updated_value]
+      end
+    end
+
+    it 'returns the record' do
+      expect(subject.enrich_all(record)).to eq record
+    end
+  end
+
+  describe 'enrich' do
+    it 'defaults to all fields' do
+      expect(subject).to receive(:enrich_all)
+      subject.enrich(record)
+    end
+
+    it 'accepts :all for fields' do
+      expect(subject).to receive(:enrich_all)
+      subject.enrich(record, :all)
+    end
+
+    context 'with field arguments' do
+      let(:simple_field) { :preview }
+      let(:deep_field) do
+        { :sourceResource => { :creator => :providedLabel } }
+      end
+      let(:deep_field_2) do
+        { :sourceResource => { :spatial => :parentFeature } }
+      end
+
+      let(:deep_field_chain)   { [:sourceResource, :creator, :providedLabel] }
+      let(:deep_field_2_chain)   { [:sourceResource, :spatial, :parentFeature] }
+
+      it 'runs against simple fields' do
+        expect(subject).to receive(:enrich_field).with(record, [simple_field])
+        subject.enrich(record, simple_field)
+      end
+
+      it 'runs against deep fields' do
+        expect(subject).to receive(:enrich_field).with(record, deep_field_chain)
+        subject.enrich(record, deep_field)
+      end
+
+      it 'runs against multiple fields' do
+        expect(subject).to receive(:enrich_field).with(record, [simple_field])
+        expect(subject).to receive(:enrich_field).with(record, deep_field_chain)
+        expect(subject).to receive(:enrich_field)
+          .with(record, deep_field_2_chain)
+        subject.enrich(record, simple_field, deep_field, deep_field_2)
+      end
+
+      it 'is a copy of the input record' do
+        expect(subject.enrich(record, simple_field, deep_field, deep_field_2))
+          .to eq record
+        expect(subject.enrich(record, simple_field, deep_field, deep_field_2))
+          .not_to eql record
+      end
+    end
+  end
+end

data/lib/audumbla/version.rb

@@ -0,0 +1,3 @@
+module Audumbla
+  VERSION = '0.1.0'.freeze
+end

data/lib/audumbla/version.rb~

@@ -0,0 +1,5 @@
+module Krikri
+  module Enrichments
+    VERSION = '0.0.1'.freeze
+  end
+end

data/spec/lib/audumbla/enrichment_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe Audumbla::Enrichment do
+  subject { klass.new }
+
+  let(:klass) { Class.new { include Audumbla::Enrichment } }
+
+  it_behaves_like 'a generic enrichment'
+
+  describe '#enrich_value' do
+    it 'is abstract' do
+      expect { subject.enrich_value(nil) }.to raise_error NotImplementedError
+    end
+  end
+end

data/spec/lib/audumbla/enrichment_spec.rb~

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe Krikri::Enrichment do
+  subject { klass.new }
+
+  let(:klass) { Class.new { include Krikri::Enrichment } }
+
+  it_behaves_like 'a generic enrichment'
+
+  describe '#enrich_value' do
+    it 'is abstract' do
+      expect { subject.enrich_value(nil) }.to raise_error NotImplementedError
+    end
+  end
+end

data/spec/lib/audumbla/enrichments/geocode_spec.rb~

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+describe Krikri::Enrichments::Geocode do
+  it_behaves_like 'a field enrichment'
+
+  it '' do
+    require 'pry'
+    binding.pry
+  end
+end

data/spec/lib/audumbla/field_enrichment_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe Audumbla::FieldEnrichment do
+  subject { enrichment_class.new }
+
+  let(:enrichment_class) { Class.new { include Audumbla::FieldEnrichment } }
+
+  context 'with implementation' do
+    before { allow(subject).to receive(:enrich_value).and_return('moomin') }
+
+    it_behaves_like 'a field enrichment'
+  end
+
+  describe '#enrich_value' do
+    it 'is abstract' do
+      expect { subject.enrich_value(nil) }.to raise_error NotImplementedError
+    end
+  end
+end

data/spec/lib/audumbla/field_enrichment_spec.rb~

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe Krikri::FieldEnrichment do
+  subject { enrichment_class.new }
+
+  let(:enrichment_class) { Class.new { include Krikri::FieldEnrichment } }
+
+  context 'with implementation' do
+    before { allow(subject).to receive(:enrich_value).and_return('moomin') }
+
+    it_behaves_like 'a field enrichment'
+  end
+
+  describe '#enrich_value' do
+    it 'is abstract' do
+      expect { subject.enrich_value(nil) }.to raise_error NotImplementedError
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+require 'audumbla'
+require 'audumbla/spec/enrichment'
+
+if ENV['COVERAGE'] == 'yes'
+  require 'simplecov'
+  SimpleCov.start
+end
+
+require 'codeclimate-test-reporter'
+CodeClimate::TestReporter.start
+
+require 'rspec'
+require 'factory_girl'
+require 'dpla/map/factories'
+
+RSpec.configure do |config|
+  config.color = true
+  config.formatter = :progress
+  config.mock_with :rspec
+
+  config.include FactoryGirl::Syntax::Methods
+
+  config.order = 'random'
+end

data/spec/spec_helper.rb~

@@ -0,0 +1,23 @@
+if ENV['COVERAGE'] == 'yes'
+  require 'simplecov'
+  SimpleCov.start
+end
+
+require 'codeclimate-test-reporter'
+CodeClimate::TestReporter.start
+
+require 'rspec'
+require 'factory_girl'
+
+# Load support files
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+RSpec.configure do |config|
+  config.color = true
+  config.formatter = :progress
+  config.mock_with :rspec
+
+  config.include FactoryGirl::Syntax::Methods
+
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: audumbla
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Audrey Altman
+- Mark Breedlove
+- Tom Johnson
+- Mark Matienzo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dpla-map
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.0.0.pre.10
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.0.0.pre.10
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+description: Metadata enrichment for cultural heritage institutions.
+email:
+- tech@dp.la
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/audumbla.rb
+- lib/audumbla.rb~
+- lib/audumbla/enrichment.rb
+- lib/audumbla/enrichment.rb~
+- lib/audumbla/enrichments.rb
+- lib/audumbla/enrichments.rb~
+- lib/audumbla/enrichments/geocode.rb~
+- lib/audumbla/enrichments/version.rb~
+- lib/audumbla/field_enrichment.rb
+- lib/audumbla/field_enrichment.rb~
+- lib/audumbla/spec/enrichment.rb
+- lib/audumbla/version.rb
+- lib/audumbla/version.rb~
+- spec/lib/audumbla/enrichment_spec.rb
+- spec/lib/audumbla/enrichment_spec.rb~
+- spec/lib/audumbla/enrichments/geocode_spec.rb~
+- spec/lib/audumbla/field_enrichment_spec.rb
+- spec/lib/audumbla/field_enrichment_spec.rb~
+- spec/spec_helper.rb
+- spec/spec_helper.rb~
+homepage: http://github.com/dpla/audumbla
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.1
+signing_key: 
+specification_version: 4
+summary: A toolkit for enhancement of RDF Metadata
+test_files:
+- spec/lib/audumbla/enrichment_spec.rb
+- spec/lib/audumbla/field_enrichment_spec.rb
+- spec/lib/audumbla/field_enrichment_spec.rb~
+- spec/lib/audumbla/enrichment_spec.rb~
+- spec/lib/audumbla/enrichments/geocode_spec.rb~
+- spec/spec_helper.rb
+- spec/spec_helper.rb~
+has_rdoc: