hydra-pbcore 3.1.0 → 3.2.0

data/.gitignore

@@ -20,4 +20,5 @@ test/version_tmp
 tmp/*
 !tmp/.gitkeep
 *.sw[opn]
-config/*
+config/*
+Gemfile.lock

data/README.md

@@ -1,6 +1,7 @@
 # HydraPbcore
 
 [![Build Status](https://travis-ci.org/awead/hydra-pbcore.png)](https://travis-ci.org/awead/hydra-pbcore)
+[![Gem Version](https://badge.fury.io/rb/hydra-pbcore.png)](http://badge.fury.io/rb/hydra-pbcore)
 
 A Hydra gem that offers PBCore datastream definitions using OM, as well as some other convenience
 methods such as inserting xml templates into existing documents and reordering your PBCore xml 
@@ -74,7 +75,9 @@ according to the PBCore XML v.2 schema:
 
 ## New Changes
 
-### version 3.1
+In 3.2, the `is_part_of` method should be used for inserting pcbcoreRelation nodes instead of `insert_relation`.
+There is also now a `HydraPbcore::Datastream::GenericFile` datastream with will allow you to create PBCore
+xml OM datastreams with Sufia.
 
 As of 3.1, the pbcoreIdentifier is not included in the xml template.  This is so users may add their own identifier,
 or multiple identifiers, with an optional annotation.  Documents will require at least one pbcoreIdentifier in order to

data/lib/hydra_pbcore/datastream.rb

@@ -2,4 +2,5 @@ module HydraPbcore::Datastream
   extend ActiveSupport::Autoload
   autoload :Document
   autoload :Instantiation
+  autoload :GenericFile
 end

data/lib/hydra_pbcore/datastream/document.rb

@@ -100,9 +100,11 @@ class Document < ActiveFedora::OmDatastream
       t.arch_ser(:path=>"pbcoreRelationIdentifier", :attributes=>{ :annotation=>"Archival Series" })
       t.coll_num(:path=>"pbcoreRelationIdentifier", :attributes=>{ :annotation=>"Collection Number" })
       t.acc_num(:path=>"pbcoreRelationIdentifier", :attributes=>{ :annotation=>"Accession Number" })
+      t.addl_coll(:path=>"pbcoreRelationIdentifier", :attributes=>{ :annotation=>"Additional Collection" })
     end
     t.series(:ref=>[:pbcoreRelation, :event_series], :index_as => [:searchable, :displayable, :facetable])
     t.collection(:ref=>[:pbcoreRelation, :arch_coll], :index_as => [:searchable, :displayable, :facetable])
+    t.additional_collection(:ref=>[:pbcoreRelation, :addl_coll], :index_as => [:searchable, :displayable, :facetable])
     t.archival_series(:ref=>[:pbcoreRelation, :arch_ser], :index_as => [:searchable, :displayable])
     t.collection_number(:ref=>[:pbcoreRelation, :coll_num], :index_as => [:searchable, :displayable])
     t.accession_number(:ref=>[:pbcoreRelation, :acc_num], :index_as => [:searchable, :displayable])

data/lib/hydra_pbcore/datastream/generic_file.rb

@@ -0,0 +1,23 @@
+module HydraPbcore::Datastream
+class GenericFile < HydraPbcore::Datastream::Document
+
+  # Use our existing HydraPbcore::Datastream::Document terminology
+  use_terminology HydraPbcore::Datastream::Document
+
+  # Add in the extra bits required for Sufia
+  extend_terminology do |t|
+    t.resource_type(:proxy=>[:asset_type])
+    t.description(:proxy=>[:summary])
+    t.date_created(:proxy=>[:asset_date])
+    t.tag(:proxy=>[:rh_subject])
+    t.rights(:proxy=>[:rights_summary])
+    t.identifier(:proxy=>[:pbc_id])
+
+    t.related_url(:path=>"pbcoreAnnotation", :atttributes=>{ :annotationType=>"Related Url" }, :index_as => [:displayable])
+    t.based_near(:path=>"pbcoreAnnotation", :atttributes=>{ :annotationType=>"Based Near" }, :index_as => [:displayable])
+    t.part_of(:path=>"pbcoreAnnotation", :atttributes=>{ :annotationType=>"Part Of" }, :index_as => [:displayable])
+    t.language(:path=>"pbcoreAnnotation", :atttributes=>{ :annotationType=>"Language" }, :index_as => [:displayable])
+  end
+
+end
+end

data/lib/hydra_pbcore/templates.rb

@@ -68,6 +68,13 @@ module HydraPbcore::Templates
         }
       end
 
+      define_template :is_part_of do |xml, value, opts={}|
+        xml.pbcoreRelation {
+          xml.pbcoreRelationType("Is Part Of", :source=>"PBCore relationType", :ref=>"http://pbcore.org/vocabularies/relationType#is-part-of")
+          xml.pbcoreRelationIdentifier(value, opts)
+        }
+      end
+
       define_template :identifier do |xml, identifier, source, annotation|
         attributes = {source: source}
         attributes[:annotation] = annotation if annotation
@@ -110,10 +117,16 @@ module HydraPbcore::Templates
     add_child_node(ng_xml.root, :event_date, date, *type)
   end
 
+  # deprecated
   def insert_relation(value, annotation)
+    puts "insert_relation is deprecated. Use is_part_of instead."
     add_child_node(ng_xml.root, :relation, value, annotation)
   end
 
+  def is_part_of(value, opts={})
+    add_child_node(ng_xml.root, :is_part_of, value, opts)
+  end
+
   def insert_identifier(identifier, annotation=nil, source=HydraPbcore.config["institution"])
     add_child_node(ng_xml.root, :identifier, identifier, source, annotation)
   end

data/lib/hydra_pbcore/version.rb

@@ -1,3 +1,3 @@
 module HydraPbcore
-  VERSION = "3.1.0"
+  VERSION = "3.2.0"
 end

data/spec/document_spec.rb

@@ -47,6 +47,7 @@ describe HydraPbcore::Datastream::Document do
         [:asset_type],
         [:rights_summary],
         [:collection],
+        [:additional_collection],
         [:archival_series],
         [:collection_number],
         [:accession_number],
@@ -77,19 +78,28 @@ describe HydraPbcore::Datastream::Document do
       end
     end
 
-    it "should have insert_relation" do
-      @object_ds = HydraPbcore::Datastream::Document.new(nil, nil)
-      @object_ds.insert_relation("My Collection", 'Archival Collection')
-      @object_ds.collection.should == ['My Collection']
-
-      @object_ds.insert_relation("My event", 'Event Series')
-      @object_ds.series.should == ['My event']
-
-      @object_ds.insert_relation("My series", 'Archival Series')
-      @object_ds.archival_series.should == ['My series']
-
-      @object_ds.insert_relation("My Acces Num", 'Accession Number')
-      @object_ds.accession_number.should == ['My Acces Num']
+    describe "#is_part_of" do
+      it "includes archival colletions" do
+        @object_ds = HydraPbcore::Datastream::Document.new(nil, nil)
+        @object_ds.is_part_of("My Collection", {:annotation => 'Archival Collection'})
+        @object_ds.collection.should == ['My Collection']
+      end
+      it "includes event series" do
+        @object_ds.is_part_of("My event", {:annotation => 'Event Series'})
+        @object_ds.series.should == ['My event']
+      end
+      it "includes archival series" do
+        @object_ds.is_part_of("My series", {:annotation => 'Archival Series'})
+        @object_ds.archival_series.should == ['My series']
+      end
+      it "includes accession numbers" do
+        @object_ds.is_part_of("My Acces Num", {:annotation => 'Accession Number'})
+        @object_ds.accession_number.should == ['My Acces Num']
+      end
+      it "includes additional colletions" do
+        @object_ds.is_part_of("Some other collection", {:annotation => 'Additional Collection'})
+        @object_ds.additional_collection.should == ['Some other collection']
+      end
     end
 
 
@@ -132,11 +142,12 @@ describe HydraPbcore::Datastream::Document do
       @object_ds.insert_date("2012-11-11")
       @object_ds.insert_date("2012-11-12")
 
-      @object_ds.insert_relation("inserted", 'Archival Collection')
-      @object_ds.insert_relation("inserted", 'Event Series')
-      @object_ds.insert_relation("inserted", 'Archival Series')
-      @object_ds.insert_relation("inserted", 'Accession Number')
-      @object_ds.insert_relation("inserted", 'Collection Number')
+      @object_ds.is_part_of("inserted", {:annotation => 'Archival Collection'})
+      @object_ds.is_part_of("inserted", {:annotation => 'Event Series'})
+      @object_ds.is_part_of("inserted", {:annotation => 'Archival Series'})
+      @object_ds.is_part_of("inserted", {:annotation => 'Accession Number'})
+      @object_ds.is_part_of("inserted", {:annotation => 'Collection Number'})
+      @object_ds.is_part_of("inserted", {:annotation => 'Additional Collection'})
 
       @object_ds.title                = "inserted"
       @object_ds.alternative_title    = "inserted"

data/spec/fixtures/document.xml

@@ -59,6 +59,10 @@
     <pbcoreRelationType source="PBCore relationType" ref="http://pbcore.org/vocabularies/relationType#is-part-of">Is Part Of</pbcoreRelationType>
     <pbcoreRelationIdentifier annotation="Collection Number">inserted</pbcoreRelationIdentifier>
   </pbcoreRelation>
+  <pbcoreRelation>
+    <pbcoreRelationType source="PBCore relationType" ref="http://pbcore.org/vocabularies/relationType#is-part-of">Is Part Of</pbcoreRelationType>
+    <pbcoreRelationIdentifier annotation="Additional Collection">inserted</pbcoreRelationIdentifier>
+  </pbcoreRelation>
   <pbcoreTitle titleType="Alternative">inserted</pbcoreTitle>
   <pbcoreTitle titleType="Chapter">inserted</pbcoreTitle>
   <pbcoreTitle titleType="Episode">inserted</pbcoreTitle>

data/spec/fixtures/document_solr.xml

@@ -400,6 +400,15 @@
   <collection-sim type="array">
     <collection-sim>inserted</collection-sim>
   </collection-sim>
+  <additional-collection-teim type="array">
+    <additional-collection-teim>inserted</additional-collection-teim>
+  </additional-collection-teim>
+  <additional-collection-ssm type="array">
+    <additional-collection-ssm>inserted</additional-collection-ssm>
+  </additional-collection-ssm>
+  <additional-collection-sim type="array">
+    <additional-collection-sim>inserted</additional-collection-sim>
+  </additional-collection-sim>
   <archival-series-teim type="array">
     <archival-series-teim>inserted</archival-series-teim>
   </archival-series-teim>

data/spec/generic_file_spec.rb

@@ -0,0 +1,120 @@
+require 'spec_helper'
+
+describe HydraPbcore::Datastream::GenericFile do
+
+  before :each do
+    @object_ds = HydraPbcore::Datastream::GenericFile.new nil, nil
+  end
+
+  describe "extending Sufia::GenericFile field" do
+    
+    describe "#related_url" do
+      it "should have getter and setters" do
+        @object_ds.related_url.should == [""]
+        @object_ds.related_url = "a related url"
+        @object_ds.related_url.should == ["a related url"]
+      end
+    end
+
+    describe "#based_near" do
+      it "should have getter and setters" do
+        @object_ds.based_near.should == [""]
+        @object_ds.based_near = "a related url"
+        @object_ds.based_near.should == ["a related url"]
+      end
+    end
+
+    describe "#part_of" do
+      it "should have getter and setters" do
+        @object_ds.part_of.should == [""]
+        @object_ds.part_of = "part of annotation"
+        @object_ds.part_of.should == ["part of annotation"]
+      end      
+    end
+
+    describe "#language" do
+      it "should have getter and setters" do
+        @object_ds.language.should == [""]
+        @object_ds.language = "language"
+        @object_ds.language.should == ["language"]
+      end      
+    end
+
+    describe "#tag" do
+      before :each do
+        @object_ds.tag = "a tag"
+      end
+      it "should have getter and setters" do
+        @object_ds.tag.should == ["a tag"]
+      end
+      it "should be a kind of subject" do
+        @object_ds.subject.should == ["a tag"]
+      end
+      it "should be the same as rh_subject" do
+        @object_ds.rh_subject.should == ["a tag"]
+      end
+    end
+
+    describe "#description" do
+      before :each do
+        @object_ds.description = "foo"
+      end
+      it "should have getter and setters" do
+        @object_ds.description.should == ["foo"]
+      end
+      it "should be the same as #summary" do
+        @object_ds.summary.should == ["foo"]
+      end
+    end
+
+    describe "#rights" do
+      before :each do
+        @object_ds.rights = "rights statement"
+      end
+      it "should have getters and setters" do
+        @object_ds.rights.should == ["rights statement"]
+      end
+      it "should be the same as #rights_summary" do
+        @object_ds.rights_summary.should == ["rights statement"]
+      end
+    end
+
+    describe "#date_created" do
+      before :each do
+        @object_ds.date_created = "2001-11-13"
+      end
+      it "should have getters and setters" do
+        @object_ds.date_created.should == ["2001-11-13"]
+      end
+      it "should be the same as #asset_date" do
+        @object_ds.date_created.should == ["2001-11-13"]
+      end
+    end
+
+    describe "#resource_type" do
+      before :each do
+        @object_ds.resource_type = "a resource type"
+      end
+      it "should be a term" do
+        @object_ds.resource_type.should == ["a resource type"]
+      end
+      it "should be the same as #asset_type" do
+        @object_ds.asset_type.should == ["a resource type"]
+      end
+    end
+
+    describe "#identifier" do
+      before :each do
+        @object_ds.identifier = "a Sufia identifier"
+      end
+      it "should have getters and setters" do
+        @object_ds.identifier.should == ["a Sufia identifier"]
+      end
+      it "should be the same as #pbc_id" do
+        @object_ds.pbc_id.should == ["a Sufia identifier"]
+      end
+    end
+
+  end
+
+end

data/spec/methods_spec.rb

@@ -16,7 +16,7 @@ describe HydraPbcore::Methods do
     end
 
     it "should delete nodes all with their parents" do
-      @object.insert_relation("foo", "Archival Collection")
+      @object.is_part_of("foo", {:annotation => "Archival Collection"})
       @object.collection.first.should == "foo"
       @object.remove_node :collection, 0, {:include_parent? => TRUE} 
       @object.find_by_terms(:pbcoreRelation).should be_empty

data/spec/templates_spec.rb

@@ -43,6 +43,21 @@ describe HydraPbcore::Templates do
     end
   end
 
+  describe "#is_part_of" do
+    it "should default with only a value" do
+      subject.add_child_node(subject.ng_xml.root, :is_part_of, 'foo')
+      xml.xpath('//pbcoreRelation/pbcoreRelationIdentifier').text.should == "foo"
+      xml.xpath('//pbcoreRelation/pbcoreRelationIdentifier/@annotation').text.should be_empty
+    end
+    it "should take a hash of options" do
+      subject.add_child_node(subject.ng_xml.root, :is_part_of, 'foo', {:annotation => "bar", :source => "source", :ref => "reference"})
+      xml.xpath('//pbcoreRelation/pbcoreRelationIdentifier').text.should == "foo"
+      xml.xpath('//pbcoreRelation/pbcoreRelationIdentifier[@annotation="bar"]').text.should == "foo"
+      xml.xpath('//pbcoreRelation/pbcoreRelationIdentifier/@source').text.should == "source"
+      xml.xpath('//pbcoreRelation/pbcoreRelationIdentifier/@ref').text.should == "reference"
+    end
+  end
+
   describe "#event_place" do
     it "should take a one arg constructor" do
       subject.add_child_node(subject.ng_xml.root, :event_place, 'foo')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hydra-pbcore
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-20 00:00:00.000000000 Z
+date: 2013-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active-fedora
@@ -181,7 +181,6 @@ files:
 - .gitignore
 - .travis.yml
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
@@ -190,6 +189,7 @@ files:
 - lib/hydra_pbcore/behaviors.rb
 - lib/hydra_pbcore/datastream.rb
 - lib/hydra_pbcore/datastream/document.rb
+- lib/hydra_pbcore/datastream/generic_file.rb
 - lib/hydra_pbcore/datastream/instantiation.rb
 - lib/hydra_pbcore/methods.rb
 - lib/hydra_pbcore/templates.rb
@@ -205,6 +205,7 @@ files:
 - spec/fixtures/physical_instantiation.xml
 - spec/fixtures/physical_instantiation_solr.xml
 - spec/fixtures/physical_instantiation_template.xml
+- spec/generic_file_spec.rb
 - spec/instantiation_spec.rb
 - spec/methods_spec.rb
 - spec/spec_helper.rb
@@ -222,18 +223,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -856777105880337948
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -856777105880337948
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -252,6 +247,7 @@ test_files:
 - spec/fixtures/physical_instantiation.xml
 - spec/fixtures/physical_instantiation_solr.xml
 - spec/fixtures/physical_instantiation_template.xml
+- spec/generic_file_spec.rb
 - spec/instantiation_spec.rb
 - spec/methods_spec.rb
 - spec/spec_helper.rb

data/Gemfile.lock

@@ -1,135 +0,0 @@
-PATH
-  remote: .
-  specs:
-    hydra-pbcore (3.1.0)
-      active-fedora
-      solrizer
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    active-fedora (6.4.5)
-      activesupport (>= 3.0.0)
-      deprecation
-      mediashelf-loggable
-      nom-xml (>= 0.5.1)
-      om (~> 3.0.0)
-      rdf
-      rdf-rdfxml (= 1.0.1)
-      rsolr
-      rubydora (~> 1.6, >= 1.6.5)
-    activemodel (4.0.0)
-      activesupport (= 4.0.0)
-      builder (~> 3.1.0)
-    activesupport (4.0.0)
-      i18n (~> 0.6, >= 0.6.4)
-      minitest (~> 4.2)
-      multi_json (~> 1.3)
-      thread_safe (~> 0.1)
-      tzinfo (~> 0.3.37)
-    addressable (2.3.5)
-    atomic (1.1.13)
-    builder (3.1.4)
-    coderay (1.0.9)
-    columnize (0.3.6)
-    daemons (1.1.9)
-    debugger (1.6.1)
-      columnize (>= 0.3.1)
-      debugger-linecache (~> 1.2.0)
-      debugger-ruby_core_source (~> 1.2.3)
-    debugger-linecache (1.2.0)
-    debugger-ruby_core_source (1.2.3)
-    deprecation (0.0.5)
-      activesupport
-    diff-lcs (1.2.4)
-    equivalent-xml (0.3.0)
-      nokogiri (>= 1.4.3)
-    fastercsv (1.5.5)
-    hooks (0.3.1)
-    i18n (0.6.5)
-    json (1.8.0)
-    mediashelf-loggable (0.4.9)
-    method_source (0.8.2)
-    mime-types (1.24)
-    mini_portile (0.5.1)
-    minitest (4.7.5)
-    multi_json (1.7.9)
-    nokogiri (1.6.0)
-      mini_portile (~> 0.5.0)
-    nom-xml (0.5.1)
-      activesupport
-      i18n
-      nokogiri
-    om (3.0.3)
-      activemodel
-      activesupport
-      deprecation
-      mediashelf-loggable
-      nokogiri (>= 1.4.2)
-      solrizer (~> 3.1.0)
-    pry (0.9.12.2)
-      coderay (~> 1.0.5)
-      method_source (~> 0.8)
-      slop (~> 3.4)
-    rake (10.1.0)
-    rdf (1.0.7)
-      addressable (>= 2.2)
-    rdf-rdfxml (1.0.1)
-      rdf (>= 1.0)
-      rdf-xsd (>= 1.0)
-    rdf-xsd (1.0.2.1)
-      nokogiri (>= 1.5.0)
-      rdf (>= 0.3.4)
-    rdoc (4.0.1)
-      json (~> 1.4)
-    redcarpet (3.0.0)
-    rest-client (1.6.7)
-      mime-types (>= 1.16)
-    rsolr (1.0.9)
-      builder (>= 2.1.2)
-    rspec (2.14.1)
-      rspec-core (~> 2.14.0)
-      rspec-expectations (~> 2.14.0)
-      rspec-mocks (~> 2.14.0)
-    rspec-core (2.14.5)
-    rspec-expectations (2.14.2)
-      diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.14.3)
-    rubydora (1.6.5)
-      activemodel
-      activesupport
-      deprecation
-      equivalent-xml
-      fastercsv
-      hooks (~> 0.3.0)
-      mime-types
-      nokogiri
-      rest-client
-    slop (3.4.6)
-    solrizer (3.1.1)
-      activesupport
-      daemons
-      mediashelf-loggable (~> 0.4.7)
-      nokogiri
-      stomp
-      xml-simple
-    stomp (1.2.12)
-    thread_safe (0.1.2)
-      atomic
-    tzinfo (0.3.37)
-    xml-simple (1.1.2)
-    yard (0.8.7)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  debugger
-  equivalent-xml
-  hydra-pbcore!
-  pry
-  rake
-  rdoc
-  redcarpet
-  rspec
-  yard