hydra-pbcore 3.0.2 → 3.1.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    hydra-pbcore (3.0.2)
+    hydra-pbcore (3.1.0)
       active-fedora
       solrizer
 

data/README.md

@@ -72,6 +72,23 @@ according to the PBCore XML v.2 schema:
     > pbcore.valid_pbcore?
     => true
 
+## New Changes
+
+### version 3.1
+
+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
+be valid.  You may specify this either by simply setting the value:
+
+    doc.pbc_id = "1234"
+
+Or by inserting a new one via the template:
+
+    doc.insert_identifier("5678")
+
+All identifiers will include the source attribute, which is required by the PBCore schema, and is given in the config.yml file.
+An annotation may be added as a second argument to the identifier template.
+
 ## Testing
 
 To run all the rspec tests, use:

data/Rakefile

@@ -5,7 +5,7 @@ require 'rspec/core/rake_task'
 # Rake task for getting an irb session
 desc "Open an irb session preloaded with this library"
 task :console do
-  sh "bin/pry -rubygems -I lib -e \"require 'hydra-pbcore'\""
+  sh "pry -rubygems -I lib -e \"require 'hydra-pbcore'\""
 end
 
 RSpec::Core::RakeTask.new(:spec)

data/lib/hydra_pbcore/datastream/document.rb

@@ -7,9 +7,7 @@ class Document < ActiveFedora::OmDatastream
   set_terminology do |t|
     t.root(:path=>"pbcoreDescriptionDocument")
 
-    t.pbc_id(:path=>"pbcoreIdentifier", 
-      :attributes=>{ :source=>HydraPbcore.config["institution"], :annotation=>"PID" }
-    )
+    t.pbc_id(:path=>"pbcoreIdentifier", :attributes=>{ :source=>HydraPbcore.config["institution"] })
 
     t.title(:path=>"pbcoreTitle", :attributes=>{ :titleType=>"Main" }, :index_as => [:searchable, :displayable, :sortable])
     t.alternative_title(:path=>"pbcoreTitle", :attributes=>{ :titleType=>"Alternative" },
@@ -160,7 +158,6 @@ class Document < ActiveFedora::OmDatastream
       xml.pbcoreDescriptionDocument("xmlns:xsi"=>"http://www.w3.org/2001/XMLSchema-instance",
         "xsi:schemaLocation"=>"http://www.pbcore.org/PBCore/PBCoreNamespace.html") {
 
-        xml.pbcoreIdentifier(:source=>HydraPbcore.config["institution"], :annotation=>"PID")
         xml.pbcoreTitle(:titleType=>"Main")
         xml.pbcoreDescription(:descriptionType=>"Description",
           :descriptionTypeSource=>"pbcoreDescription/descriptionType",

data/lib/hydra_pbcore/templates.rb

@@ -68,6 +68,11 @@ module HydraPbcore::Templates
         }
       end
 
+      define_template :identifier do |xml, identifier, source, annotation|
+        attributes = {source: source}
+        attributes[:annotation] = annotation if annotation
+        xml.pbcoreIdentifier(identifier, attributes)
+      end
     end
   end
 
@@ -109,6 +114,10 @@ module HydraPbcore::Templates
     add_child_node(ng_xml.root, :relation, value, annotation)
   end
 
+  def insert_identifier(identifier, annotation=nil, source=HydraPbcore.config["institution"])
+    add_child_node(ng_xml.root, :identifier, identifier, source, annotation)
+  end
+
   def digital_instantiation
     builder = Nokogiri::XML::Builder.new do |xml|
 

data/lib/hydra_pbcore/version.rb

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

data/spec/document_spec.rb

@@ -122,6 +122,7 @@ describe HydraPbcore::Datastream::Document do
 
     before(:each) do
       # insert additional nodes
+      @object_ds.insert_identifier("inserted", "PID")
       @object_ds.insert_publisher("inserted", "inserted")
       @object_ds.insert_contributor("inserted", "inserted")
       @object_ds.insert_publisher("inserted")
@@ -137,7 +138,6 @@ describe HydraPbcore::Datastream::Document do
       @object_ds.insert_relation("inserted", 'Accession Number')
       @object_ds.insert_relation("inserted", 'Collection Number')
 
-      @object_ds.pbc_id               = "inserted"
       @object_ds.title                = "inserted"
       @object_ds.alternative_title    = "inserted"
       @object_ds.chapter              = "inserted"

data/spec/fixtures/document_template.xml

@@ -1,5 +1,4 @@
 <pbcoreDescriptionDocument xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.pbcore.org/PBCore/PBCoreNamespace.html">
-  <pbcoreIdentifier source="Rock and Roll Hall of Fame and Museum" annotation="PID"/>
   <pbcoreTitle titleType="Main"/>
   <pbcoreDescription descriptionType="Description" descriptionTypeSource="pbcoreDescription/descriptionType" descriptionTypeRef="http://pbcore.org/vocabularies/pbcoreDescription/descriptionType#description" annotation="Summary"/>
   <pbcoreDescription descriptionType="Table of Contents" descriptionTypeSource="pbcoreDescription/descriptionType" descriptionTypeRef="http://pbcore.org/vocabularies/pbcoreDescription/descriptionType#table-of-contents" annotation="Parts List"/>

data/spec/templates_spec.rb

@@ -96,4 +96,19 @@ describe HydraPbcore::Templates do
     end
   end
 
+  describe "#insert_identifier" do
+    it "should take a one arg constructor" do
+      subject.insert_identifier('foo')
+      xml.xpath('//pbcoreIdentifier[@source="Rock and Roll Hall of Fame and Museum"]').text.should == "foo"
+    end
+    it "should take a two arg constructor" do
+      subject.insert_identifier('foo', 'bar')
+      xml.xpath('//pbcoreIdentifier[@source="Rock and Roll Hall of Fame and Museum"][@annotation="bar"]').text.should == "foo"
+    end
+    it "should take a three arg constructor" do
+      subject.insert_identifier('foo', 'bar', 'baz')
+      xml.xpath('//pbcoreIdentifier[@source="baz"][@annotation="bar"]').text.should == "foo"
+    end
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hydra-pbcore
 version: !ruby/object:Gem::Version
-  version: 3.0.2
+  version: 3.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-15 00:00:00.000000000 Z
+date: 2013-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active-fedora
@@ -224,7 +224,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3327218333988344874
+      hash: -856777105880337948
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -233,7 +233,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3327218333988344874
+      hash: -856777105880337948
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23