dor-services 5.2.0 → 5.3.0

data/lib/dor/exceptions.rb

@@ -1,5 +1,4 @@
 module Dor
-
   class Exception < ::StandardError; end
   class ParameterError < Exception; end
   class DuplicateIdError < Exception

data/lib/dor/migrations/identifiable/uriify_augmented_contentlocation_refs.rb

@@ -1,6 +1,6 @@
 Dor::Identifiable.on_upgrade '3.14.8', 'Fix up invalid URIs in content-augmented datastreams' do |obj|
   bad_content_location_uri = begin
-    URI.parse(obj.send("content-augmented").dsLocation)
+    URI.parse(obj.send('content-augmented').dsLocation)
     false
   rescue URI::InvalidURIError
     true
@@ -10,9 +10,9 @@ Dor::Identifiable.on_upgrade '3.14.8', 'Fix up invalid URIs in content-augmented
 
   next unless bad_content_location_uri
 
-  parts = obj.send("content-augmented").dsLocation.split('/')
+  parts = obj.send('content-augmented').dsLocation.split('/')
   parts[parts.length - 1] = URI.escape(parts.last)
-  obj.send("content-augmented").dsLocation = parts.join('/')
+  obj.send('content-augmented').dsLocation = parts.join('/')
 
-  obj.send("content-augmented").save
+  obj.send('content-augmented').save
 end

data/lib/dor/migrations/processable/unify_workflows.rb

@@ -7,7 +7,7 @@ Dor::Processable.on_upgrade '3.5.0', 'Replace individual *WF datastreams with un
   end
 
   # Remove individual *WF datastreams
-  obj.datastreams.each_pair do |dsid,ds|
+  obj.datastreams.each_pair do |dsid, ds|
     if ds.controlGroup == 'E' && dsid =~ /WF$/
       ds.delete
       run = true

data/lib/dor/models/admin_policy_object.rb

@@ -7,10 +7,10 @@ module Dor
     include Processable
     include Versionable
 
-    has_many :things, :property => :is_governed_by, :inbound => :true, :class_name => "ActiveFedora::Base"
+    has_many :things, :property => :is_governed_by, :inbound => :true, :class_name => 'ActiveFedora::Base'
     has_object_type 'adminPolicy'
-    has_metadata :name => "administrativeMetadata", :type => Dor::AdministrativeMetadataDS, :label => 'Administrative Metadata'
-    has_metadata :name => "roleMetadata",           :type => Dor::RoleMetadataDS,           :label => 'Role Metadata'
-    has_metadata :name => "defaultObjectRights",    :type => Dor::DefaultObjectRightsDS,    :label => 'Default Object Rights'
+    has_metadata :name => 'administrativeMetadata', :type => Dor::AdministrativeMetadataDS, :label => 'Administrative Metadata'
+    has_metadata :name => 'roleMetadata',           :type => Dor::RoleMetadataDS,           :label => 'Role Metadata'
+    has_metadata :name => 'defaultObjectRights',    :type => Dor::DefaultObjectRightsDS,    :label => 'Default Object Rights'
   end
 end

data/lib/dor/models/assembleable.rb

@@ -1,8 +1,7 @@
 module Dor
   module Assembleable
-
-    def initialize_workspace(source=nil)
-      druid = DruidTools::Druid.new(self.pid, Config.stacks.local_workspace_root)
+    def initialize_workspace(source = nil)
+      druid = DruidTools::Druid.new(pid, Config.stacks.local_workspace_root)
       if source.nil?
         druid.mkdir
       else

data/lib/dor/models/collection.rb

@@ -8,7 +8,7 @@ module Dor
     include Versionable
     include Releaseable
 
-    has_many :members, :property => :is_member_of_collection, :inbound => true, :class_name => "ActiveFedora::Base"
+    has_many :members, :property => :is_member_of_collection, :inbound => true, :class_name => 'ActiveFedora::Base'
     has_object_type 'collection'
   end
 end

data/lib/dor/models/contentable.rb

@@ -2,163 +2,165 @@ module Dor
   module Contentable
     extend ActiveSupport::Concern
 
-    #add a file to a resource, not to be confused with add a resource to an object
-    def add_file file, resource, file_name, mime_type=nil,publish='no', shelve='no', preserve='no'
-      contentMD=self.datastreams['contentMetadata']
-      xml=contentMD.ng_xml
-      #make sure the resource exists
-      if xml.search('//resource[@id=\''+resource+'\']').length == 0
-        raise 'resource doesnt exist.'
-      end
-      sftp=Net::SFTP.start(Config.content.content_server,Config.content.content_user,:auth_methods=>['publickey'])
-      druid_tools=DruidTools::Druid.new(self.pid,Config.content.content_base_dir)
-      location=druid_tools.path(file_name)
-      oldlocation=location.gsub('/'+self.pid.gsub('druid:',''),'')
-      md5=Digest::MD5.file(file.path).hexdigest
-      sha1=Digest::SHA1.file(file.path).hexdigest
-      size=File.size?(file.path)
-      #update contentmd
-      file_hash={:name=>file_name,:md5 => md5, :publish=>publish, :shelve=> shelve, :preserve => preserve, :size=>size.to_s, :sha1=>sha1, :mime_type => mime_type}
+    # add a file to a resource, not to be confused with add a resource to an object
+    def add_file(file, resource, file_name, mime_type = nil, publish = 'no', shelve = 'no', preserve = 'no')
+      xml = datastreams['contentMetadata'].ng_xml
+      # make sure the resource exists
+      raise 'resource doesnt exist.' if xml.search('//resource[@id=\'' + resource + '\']').length == 0
+      sftp = Net::SFTP.start(Config.content.content_server, Config.content.content_user, :auth_methods => ['publickey'])
+      druid_tools = DruidTools::Druid.new(pid, Config.content.content_base_dir)
+      location = druid_tools.path(file_name)
+      oldlocation = location.gsub('/' + pid.gsub('druid:', ''), '')
+      md5  = Digest::MD5.file(file.path).hexdigest
+      sha1 = Digest::SHA1.file(file.path).hexdigest
+      size = File.size?(file.path)
+      # update contentmd
+      file_hash = {:name => file_name, :md5 => md5, :publish => publish, :shelve => shelve, :preserve => preserve, :size => size.to_s, :sha1 => sha1, :mime_type => mime_type}
       begin
-        request=sftp.stat!(location.gsub(file_name,''))
+        sftp.stat!(location.gsub(file_name, ''))
         begin
-          request=sftp.stat!(location)
-          raise 'The file '+file_name+' already exists!'
+          sftp.stat!(location)
+          raise "The file #{file_name} already exists!"
         rescue Net::SFTP::StatusException
-          sftp.upload!(file.path,location)
-          self.contentMetadata.add_file file_hash,resource
+          sftp.upload!(file.path, location)
+          contentMetadata.add_file file_hash, resource
         end
       rescue Net::SFTP::StatusException
-        #the directory layout doesnt match the new style, so use the old style.
+        # directory layout doesn't match the new style, so use the old style.
         begin
-          request=sftp.stat!(oldlocation)
-          raise 'The file '+file_name+' already exists!'
+          sftp.stat!(oldlocation)
+          raise "The file #{file_name} already exists!"
         rescue Net::SFTP::StatusException
-          #the file doesnt already exist, which is good. Add it
-          sftp.upload!(file.path,oldlocation)
-          self.contentMetadata.add_file file_hash,resource
+          # file doesn't already exist, which is good. Add it
+          sftp.upload!(file.path, oldlocation)
+          contentMetadata.add_file file_hash, resource
         end
       end
-      #can only arrive at this point if a non status exception occurred.
+      # can only arrive at this point if a non status exception occurred.
     end
 
-    def replace_file file,file_name
-      sftp=Net::SFTP.start(Config.content.content_server,Config.content.content_user,:auth_methods=>['publickey'])
-      item=Dor::Item.find(self.pid)
-      druid_tools=DruidTools::Druid.new(self.pid,Config.content.content_base_dir)
-      location=druid_tools.path(file_name)
-      oldlocation=location.gsub('/'+self.pid.gsub('druid:',''),'')
-
-      md5=Digest::MD5.file(file.path).hexdigest
-      sha1=Digest::SHA1.file(file.path).hexdigest
-      size=File.size?(file.path)
-      #update contentmd
-      file_hash={:name=>file_name,:md5 => md5, :size=>size.to_s, :sha1=>sha1}
+    def replace_file(file, file_name)
+      sftp = Net::SFTP.start(Config.content.content_server, Config.content.content_user, :auth_methods => ['publickey'])
+      item = Dor::Item.find(pid)
+      druid_tools = DruidTools::Druid.new(pid, Config.content.content_base_dir)
+      location = druid_tools.path(file_name)
+      oldlocation = location.gsub('/' + pid.gsub('druid:', ''), '')
+      md5  = Digest::MD5.file(file.path).hexdigest
+      sha1 = Digest::SHA1.file(file.path).hexdigest
+      size = File.size?(file.path)
+      # update contentmd
+      file_hash = {:name => file_name, :md5 => md5, :size => size.to_s, :sha1 => sha1}
       begin
-        request=sftp.stat!(location)
-        sftp.upload!(file.path,location)
-        #this doesnt allow renaming files
+        sftp.stat!(location)
+        sftp.upload!(file.path, location)
+        # this doesnt allow renaming files
         item.contentMetadata.update_file(file_hash, file_name)
       rescue
-        sftp.upload!(file.path,oldlocation)
+        sftp.upload!(file.path, oldlocation)
         item.contentMetadata.update_file(file_hash, file_name)
       end
     end
 
-    def get_preserved_file file, version
-      preservation_server=Config.content.sdr_server+'/sdr/objects/'+self.pid+"/content/"
-      file=URI.encode(file)
-      add=preservation_server+file+"?version="+version
-      uri = URI(add)
+    def get_preserved_file(file, version)
+      uri = URI(Config.content.sdr_server + "/sdr/objects/#{pid}/content/" + URI.encode(file) + "?version=#{version}")
       req = Net::HTTP::Get.new(uri.request_uri)
       req.basic_auth Config.content.sdr_user, Config.content.sdr_pass
-      res = Net::HTTP.start(uri.hostname, uri.port, :use_ssl => uri.scheme == 'https') {|http|
+      Net::HTTP.start(uri.hostname, uri.port, :use_ssl => uri.scheme == 'https') {|http|
         http.request(req)
       }
     end
 
-    def get_file file
-      druid_tools=DruidTools::Druid.new(self.pid,Config.content.content_base_dir)
-      location=druid_tools.path(file)
-      oldlocation=location.gsub('/'+file,'').gsub('/'+self.pid.gsub('druid:',''),'')+'/'+file
-      sftp=Net::SFTP.start(Config.content.content_server,Config.content.content_user,:auth_methods=>['publickey'])
+    def get_file(file)
+      druid_tools = DruidTools::Druid.new(pid, Config.content.content_base_dir)
+      location = druid_tools.path(file)
+      oldlocation = location.gsub('/' + file, '').gsub('/' + pid.gsub('druid:', ''), '') + '/' + file
+      sftp = Net::SFTP.start(Config.content.content_server, Config.content.content_user, :auth_methods => ['publickey'])
       begin
-        data=sftp.download!(location)
+        data = sftp.download!(location)
       rescue
-        data=sftp.download!(oldlocation)
+        data = sftp.download!(oldlocation)
       end
+      data
     end
-    def remove_file filename
-      druid_tools=DruidTools::Druid.new(self.pid,Config.content.content_base_dir)
-      location=druid_tools.path(filename)
-      oldlocation=location.gsub('/'+self.pid.gsub('druid:',''),'')
-      sftp=Net::SFTP.start(Config.content.content_server,Config.content.content_user,:auth_methods=>['publickey'])
+
+    # @param [String] filename
+    def remove_file(filename)
+      druid_tools = DruidTools::Druid.new(pid, Config.content.content_base_dir)
+      location = druid_tools.path(filename)
+      oldlocation = location.gsub('/' + pid.gsub('druid:', ''), '')
+      sftp = Net::SFTP.start(Config.content.content_server, Config.content.content_user, :auth_methods => ['publickey'])
       begin
-        data=sftp.remove!(location)
+        sftp.remove!(location)
       rescue
-        #if the file doesnt exist, that is ok, not all files will be present in the workspace
+        # if the file doesnt exist, that is ok, not all files will be present in the workspace
         begin
-          data=sftp.remove!(oldlocation)
+          sftp.remove!(oldlocation)
         rescue Net::SFTP::StatusException
         end
       end
-      self.contentMetadata.remove_file filename
+      contentMetadata.remove_file filename
     end
-    def rename_file old_name, new_name
-      druid_tools=DruidTools::Druid.new(self.pid,Config.content.content_base_dir)
-      location=druid_tools.path(old_name)
-      oldlocation=location.gsub('/'+self.pid.gsub('druid:',''),'')
-      sftp=Net::SFTP.start(Config.content.content_server,Config.content.content_user,:auth_methods=>['publickey'])
+
+    # @param [String] old_name
+    # @param [String] new_name
+    def rename_file(old_name, new_name)
+      druid_tools = DruidTools::Druid.new(pid, Config.content.content_base_dir)
+      location = druid_tools.path(old_name)
+      oldlocation = location.gsub('/' + pid.gsub('druid:', ''), '')
+      sftp = Net::SFTP.start(Config.content.content_server, Config.content.content_user, :auth_methods => ['publickey'])
       begin
-        data=sftp.rename!(location,location.gsub(old_name,new_name))
+        sftp.rename!(location, location.gsub(old_name, new_name))
       rescue
-        data=sftp.rename!(oldlocation,oldlocation.gsub(old_name,new_name))
+        sftp.rename!(oldlocation, oldlocation.gsub(old_name, new_name))
       end
-      self.contentMetadata.rename_file(old_name, new_name)
+      contentMetadata.rename_file(old_name, new_name)
     end
-    def remove_resource resource_name
-      #run delete for all of the files in the resource
-      xml=self.contentMetadata.ng_xml
-      files=xml.search('//resource[@id=\''+resource_name+'\']/file').each do |file|
-        self.remove_file(file['id'])
+
+    # @param [String] resource_name ID of the resource elememnt
+    def remove_resource(resource_name)
+      # run delete for all of the files in the resource
+      contentMetadata.ng_xml.search('//resource[@id=\'' + resource_name + '\']/file').each do |file|
+        remove_file(file['id'])
       end
-      #remove the resource record from the metadata and renumber the resource sequence
-      self.contentMetadata.remove_resource resource_name
+      # remove the resource record from the metadata and renumber the resource sequence
+      contentMetadata.remove_resource resource_name
     end
 
-    #list files in the workspace
+    # list files in the workspace
+    # @return [Array] workspace files
     def list_files
-      filename='none'
-      files=[]
-      sftp=Net::SFTP.start(Config.content.content_server,Config.content.content_user,:auth_methods=>['publickey'])
-      druid_tools=DruidTools::Druid.new(self.pid,Config.content.content_base_dir)
-      location=druid_tools.path(filename).gsub(filename,'')
-      oldlocation=location.gsub('/'+self.pid.gsub('druid:',''),'')
+      filename = 'none'
+      files = []
+      sftp = Net::SFTP.start(Config.content.content_server, Config.content.content_user, :auth_methods => ['publickey'])
+      druid_tools = DruidTools::Druid.new(pid, Config.content.content_base_dir)
+      location = druid_tools.path(filename).gsub(filename, '')
+      oldlocation = location.gsub('/' + pid.gsub('druid:', ''), '')
       begin
-        sftp.dir.entries(location, "*") do |file|
-          files<<file.name
+        sftp.dir.entries(location, '*') do |file|
+          files << file.name
         end
       rescue
         begin
-          sftp.dir.glob(oldlocation, "*") do |file|
-            files<<file.name
+          sftp.dir.glob(oldlocation, '*') do |file|
+            files << file.name
           end
         rescue Net::SFTP::StatusException
           return files
         end
       end
-      return files
+      files
     end
 
-    # determine whether the file in question is present in the object's workspace.
-    def is_file_in_workspace? filename
-      druid_obj = DruidTools::Druid.new(self.pid, Dor::Config.stacks.local_workspace_root)
-      return !druid_obj.find_content(filename).nil?
+    # @param [String] filename
+    # @return [Boolean] whether the file in question is present in the object's workspace
+    def is_file_in_workspace?(filename)
+      druid_obj = DruidTools::Druid.new(pid, Dor::Config.stacks.local_workspace_root)
+      !druid_obj.find_content(filename).nil?
     end
 
     # Appends contentMetadata file resources from the source objects to this object
     # @param [Array<String>] source_obj_pids ids of the secondary objects that will get their contentMetadata merged into this one
-    def copy_file_resources source_obj_pids
+    def copy_file_resources(source_obj_pids)
       primary_cm = contentMetadata.ng_xml
       base_id = primary_cm.at_xpath('/contentMetadata/@objectId').value
       max_sequence = primary_cm.at_xpath('/contentMetadata/resource[last()]/@sequence').value.to_i
@@ -179,7 +181,7 @@ module Dor
             secondary_file['id'] = new_secondary_file_name(secondary_file['id'], max_sequence)
 
             if primary_cm.at_xpath("//file[@id = '#{secondary_file['id']}']")
-              raise Dor::Exception.new "File '#{secondary_file['id']}' from secondary object #{src_pid} already exist in primary object: #{self.pid}"
+              raise Dor::Exception.new "File '#{secondary_file['id']}' from secondary object #{src_pid} already exist in primary object: #{pid}"
             end
           end
 
@@ -201,20 +203,16 @@ module Dor
           resource_copy.first_element_child.add_previous_sibling attr_node
         end
       end
-      self.contentMetadata.content_will_change!
+      contentMetadata.content_will_change!
     end
 
-    def new_secondary_file_name old_name, sequence_num
-      if old_name =~ /^(.*)\.(.*)$/
-        return "#{$1}_#{sequence_num}.#{$2}"
-      else
-        return "#{old_name}_#{sequence_num}"
-      end
+    def new_secondary_file_name(old_name, sequence_num)
+      old_name =~ /^(.*)\.(.*)$/ ? "#{$1}_#{sequence_num}.#{$2}" : "#{old_name}_#{sequence_num}"
     end
 
     # Clears RELS-EXT relationships, sets the isGovernedBy relationship to the SDR Graveyard APO
     # @param [String] tag optional String of text that is concatenated to the identityMetadata/tag "Decomissioned : "
-    def decomission tag
+    def decomission(tag)
       # remove isMemberOf and isMemberOfCollection relationships
       clear_relationship :is_member_of
       clear_relationship :is_member_of_collection
@@ -229,5 +227,12 @@ module Dor
       rightsMetadata.content = '<rightsMetadata/>'
       add_tag "Decommissioned : #{tag}"
     end
+
+    # Adds a RELS-EXT constituent relationship to the given druid
+    # @param [String] druid the parent druid of the constituent relationship
+    #   e.g.: <fedora:isConstituentOf rdf:resource="info:fedora/druid:hj097bm8879" />
+    def add_constituent(druid)
+      add_relationship :is_constituent_of, ActiveFedora::Base.find(druid)
+    end
   end
 end

data/lib/dor/models/describable.rb

@@ -3,13 +3,13 @@ module Dor
     extend ActiveSupport::Concern
 
     DESC_MD_FORMATS = {
-      "http://www.tei-c.org/ns/1.0" => 'tei',
-      "http://www.loc.gov/mods/v3"  => 'mods'
+      'http://www.tei-c.org/ns/1.0' => 'tei',
+      'http://www.loc.gov/mods/v3'  => 'mods'
     }
     class CrosswalkError < Exception; end
 
     included do
-      has_metadata :name => "descMetadata", :type => Dor::DescMetadataDS, :label => 'Descriptive Metadata', :control_group => 'M'
+      has_metadata :name => 'descMetadata', :type => Dor::DescMetadataDS, :label => 'Descriptive Metadata', :control_group => 'M'
     end
 
     require 'stanford-mods/searchworks'
@@ -17,17 +17,17 @@ module Dor
     # intended for read-access, "as SearchWorks would see it", mostly for to_solr()
     # @param [Nokogiri::XML::Document] content Nokogiri descMetadata document (overriding internal data)
     # @param [boolean] ns_aware namespace awareness toggle for from_nk_node()
-    def stanford_mods(content=nil, ns_aware=true)
+    def stanford_mods(content = nil, ns_aware = true)
       m = Stanford::Mods::Record.new
-      desc = content.nil? ? self.descMetadata.ng_xml : content
+      desc = content.nil? ? descMetadata.ng_xml : content
       m.from_nk_node(desc.root, ns_aware)
       m
     end
 
     def fetch_descMetadata_datastream
-      candidates = self.datastreams['identityMetadata'].otherId.collect { |oid| oid.to_s }
+      candidates = datastreams['identityMetadata'].otherId.collect { |oid| oid.to_s }
       metadata_id = Dor::MetadataService.resolvable(candidates).first
-      return metadata_id.nil? ? nil : Dor::MetadataService.fetch(metadata_id.to_s)
+      metadata_id.nil? ? nil : Dor::MetadataService.fetch(metadata_id.to_s)
     end
 
     def build_descMetadata_datastream(ds)
@@ -41,28 +41,27 @@ module Dor
 
     # Generates Dublin Core from the MODS in the descMetadata datastream using the LoC mods2dc stylesheet
     #    Should not be used for the Fedora DC datastream
-    # @raise [Exception] Raises an Exception if the generated DC is empty or has no children
+    # @raise [CrosswalkError] Raises an Exception if the generated DC is empty or has no children
+    # @return [Nokogiri::Doc] the DublinCore XML document object
     def generate_dublin_core
-      format = self.metadata_format
-      if format.nil?
-        raise CrosswalkError, "Unknown descMetadata namespace: #{metadata_namespace.inspect}"
-      end
-      xslt = Nokogiri::XSLT(File.new(File.expand_path(File.dirname(__FILE__) + "/#{format}2dc.xslt")) )
-      desc_md = self.descMetadata.ng_xml.dup(1)
-      self.add_collection_reference(desc_md)
+      raise CrosswalkError, "Unknown descMetadata namespace: #{metadata_namespace.inspect}" if metadata_format.nil?
+      xslt = Nokogiri::XSLT(File.new(File.expand_path(File.dirname(__FILE__) + "/#{metadata_format}2dc.xslt")) )
+      desc_md = descMetadata.ng_xml.dup(1)
+      add_collection_reference(desc_md)
       dc_doc = xslt.transform(desc_md)
-      # Remove empty nodes
-      dc_doc.xpath('/oai_dc:dc/*[count(text()) = 0]').remove
-      if dc_doc.root.nil? || dc_doc.root.children.size == 0
-        raise CrosswalkError, "Dor::Item#generate_dublin_core produced incorrect xml:\n#{dc_doc.to_xml}"
-      end
+      dc_doc.xpath('/oai_dc:dc/*[count(text()) = 0]').remove # Remove empty nodes
+      raise CrosswalkError, "Dor::Item#generate_dublin_core produced incorrect xml (no root):\n#{dc_doc.to_xml}" if dc_doc.root.nil?
+      raise CrosswalkError, "Dor::Item#generate_dublin_core produced incorrect xml (no children):\n#{dc_doc.to_xml}" if dc_doc.root.children.size == 0
       dc_doc
     end
 
+    # @return [String] Public descriptive medatada XML
     def generate_public_desc_md
-      doc = self.descMetadata.ng_xml.dup(1)
+      doc = descMetadata.ng_xml.dup(1)
       add_collection_reference(doc)
       add_access_conditions(doc)
+      add_constituent_relations(doc)
+      doc.xpath('//comment()').remove
       new_doc = Nokogiri::XML(doc.to_xml) { |x| x.noblanks }
       new_doc.encoding = 'UTF-8'
       new_doc.to_xml
@@ -74,40 +73,42 @@ module Dor
     def add_access_conditions(doc)
       # clear out any existing accessConditions
       doc.xpath('//mods:accessCondition', 'mods' => 'http://www.loc.gov/mods/v3').each {|n| n.remove}
-      rights = self.datastreams['rightsMetadata'].ng_xml
+      rights = datastreams['rightsMetadata'].ng_xml
 
       rights.xpath('//use/human[@type="useAndReproduction"]').each do |use|
         txt = use.text.strip
         next if txt.empty?
-        doc.root.element_children.last.add_next_sibling doc.create_element("accessCondition", txt, :type => 'useAndReproduction')
+        doc.root.element_children.last.add_next_sibling doc.create_element('accessCondition', txt, :type => 'useAndReproduction')
       end
       rights.xpath('//copyright/human[@type="copyright"]').each do |cr|
         txt = cr.text.strip
         next if txt.empty?
-        doc.root.element_children.last.add_next_sibling doc.create_element("accessCondition", txt, :type => 'copyright')
+        doc.root.element_children.last.add_next_sibling doc.create_element('accessCondition', txt, :type => 'copyright')
       end
       rights.xpath("//use/machine[#{ci_compare('type', 'creativecommons')}]").each do |lic_type|
         next if lic_type.text =~ /none/i
         lic_text = rights.at_xpath("//use/human[#{ci_compare('type', 'creativecommons')}]").text.strip
         next if lic_text.empty?
         new_text = "CC #{lic_type.text}: #{lic_text}"
-        doc.root.element_children.last.add_next_sibling doc.create_element("accessCondition", new_text, :type => 'license')
+        doc.root.element_children.last.add_next_sibling doc.create_element('accessCondition', new_text, :type => 'license')
       end
       rights.xpath("//use/machine[#{ci_compare('type', 'opendatacommons')}]").each do |lic_type|
         next if lic_type.text =~ /none/i
         lic_text = rights.at_xpath("//use/human[#{ci_compare('type', 'opendatacommons')}]").text.strip
         next if lic_text.empty?
         new_text = "ODC #{lic_type.text}: #{lic_text}"
-        doc.root.element_children.last.add_next_sibling doc.create_element("accessCondition", new_text, :type => 'license')
+        doc.root.element_children.last.add_next_sibling doc.create_element('accessCondition', new_text, :type => 'license')
       end
     end
 
-    # returns the desc metadata a relatedItem with information about the collection this object belongs to for use in published mods and mods to DC conversion
-    # @param [Nokogiri::XML::Document] doc A copy of the descriptiveMetadata of the object
+    # Adds to desc metadata a relatedItem with information about the collection this object belongs to.
+    # For use in published mods and mods-to-DC conversion.
+    # @param [Nokogiri::XML::Document] doc A copy of the descriptiveMetadata of the object, to be modified
+    # @return [Void]
     # @note this method modifies the passed in doc
     def add_collection_reference(doc)
-      return unless self.methods.include? :public_relationships
-      collections=self.public_relationships.search('//rdf:RDF/rdf:Description/fedora:isMemberOfCollection',
+      return unless methods.include? :public_relationships
+      collections = public_relationships.search('//rdf:RDF/rdf:Description/fedora:isMemberOfCollection',
                                        'fedora' => 'info:fedora/fedora-system:def/relations-external#',
                                        'rdf' => 'http://www.w3.org/1999/02/22-rdf-syntax-ns#' )
       return if collections.empty?
@@ -118,43 +119,81 @@ module Dor
       end
 
       collections.each do |collection_node|
-        druid=collection_node['rdf:resource']
-        druid=druid.gsub('info:fedora/','')
-        collection_obj=Dor::Item.find(druid)
+        druid = collection_node['rdf:resource']
+        druid = druid.gsub('info:fedora/', '')
+        collection_obj = Dor::Item.find(druid)
         collection_title = Dor::Describable.get_collection_title(collection_obj)
-        related_item_node=Nokogiri::XML::Node.new('relatedItem',doc)
-        related_item_node['type']='host'
-        title_info_node = Nokogiri::XML::Node.new('titleInfo',doc)
-        title_node      = Nokogiri::XML::Node.new('title',doc)
-        title_node.content=collection_title
+        related_item_node = Nokogiri::XML::Node.new('relatedItem', doc)
+        related_item_node['type'] = 'host'
+        title_info_node = Nokogiri::XML::Node.new('titleInfo', doc)
+        title_node      = Nokogiri::XML::Node.new('title', doc)
+        title_node.content = collection_title
 
-        id_node=Nokogiri::XML::Node.new('identifier',doc)
-        id_node['type'] = 'uri'
-        id_node.content = "http://#{Dor::Config.stacks.document_cache_host}/#{druid.split(':').last}"
+        # e.g.:
+        #   <location>
+        #     <url>http://purl.stanford.edu/rh056sr3313</url>
+        #   </location>
+        loc_node = doc.create_element('location')
+        url_node = doc.create_element('url')
+        url_node.content = "https://#{Dor::Config.stacks.document_cache_host}/#{druid.split(':').last}"
+        loc_node << url_node
 
-        type_node=Nokogiri::XML::Node.new('typeOfResource',doc)
+        type_node = Nokogiri::XML::Node.new('typeOfResource', doc)
         type_node['collection'] = 'yes'
         doc.root.add_child(related_item_node)
         related_item_node.add_child(title_info_node)
         title_info_node.add_child(title_node)
-        related_item_node.add_child(id_node)
+        related_item_node.add_child(loc_node)
         related_item_node.add_child(type_node)
       end
     end
-    def metadata_namespace
-      desc_md = self.datastreams['descMetadata'].ng_xml
-      if desc_md.nil? || desc_md.root.nil? || desc_md.root.namespace.nil?
-        return nil
-      else
-        return desc_md.root.namespace.href
+
+    # expand constituent relations into relatedItem references -- see JUMBO-18
+    # @param [Nokogiri::XML] doc public MODS XML being built
+    # @return [Void]
+    def add_constituent_relations(doc)
+      public_relationships.search('//rdf:RDF/rdf:Description/fedora:isConstituentOf',
+                                       'fedora' => 'info:fedora/fedora-system:def/relations-external#',
+                                       'rdf' => 'http://www.w3.org/1999/02/22-rdf-syntax-ns#' ).each do |parent|
+        # fetch the parent object to get title
+        druid = parent['rdf:resource'].gsub(/^info:fedora\//, '')
+        parent_item = Dor::Item.find(druid)
+
+        # create the MODS relation
+        relatedItem = doc.create_element 'relatedItem'
+        relatedItem['type'] = 'host'
+        relatedItem['displayLabel'] = 'Appears in'
+
+        # load the title from the parent's DC.title
+        titleInfo = doc.create_element 'titleInfo'
+        title = doc.create_element 'title'
+        title.content = parent_item.datastreams['DC'].title.first
+        titleInfo << title
+        relatedItem << titleInfo
+
+        # point to the PURL for the parent
+        location = doc.create_element 'location'
+        url = doc.create_element 'url'
+        url.content = "http://#{Dor::Config.stacks.document_cache_host}/#{druid.split(':').last}"
+        location << url
+        relatedItem << location
+
+        # finish up by adding relation to public MODS
+        doc.root << relatedItem
       end
     end
 
+    def metadata_namespace
+      desc_md = datastreams['descMetadata'].ng_xml
+      return nil if desc_md.nil? || desc_md.root.nil? || desc_md.root.namespace.nil?
+      desc_md.root.namespace.href
+    end
+
     def metadata_format
       DESC_MD_FORMATS[metadata_namespace]
     end
 
-    def to_solr(solr_doc=Hash.new, *args)
+    def to_solr(solr_doc = {}, *args)
       super solr_doc, *args
       mods_sources = {
         'sw_language_ssim'           => :sw_language_facet,
@@ -170,33 +209,33 @@ module Dor
         'mods_typeOfResource_ssim'    => [:term_values, :typeOfResource],
         'mods_typeOfResource_tesim'   => [:term_values, :typeOfResource]
       }
-      keys = mods_sources.keys.concat(%w[ metadata_format_ssim ])
+      keys = mods_sources.keys.concat(%w( metadata_format_ssim ))
       keys.each { |key|
         solr_doc[key] ||= []     # initialize multivalue targts if necessary
       }
 
-      solr_doc["metadata_format_ssim"] << self.metadata_format
+      solr_doc['metadata_format_ssim'] << metadata_format
       begin
-        dc_doc = self.generate_dublin_core
+        dc_doc = generate_dublin_core
         dc_doc.xpath('/oai_dc:dc/*').each do |node|
           add_solr_value(solr_doc, "public_dc_#{node.name}", node.text, :string, [:stored_searchable])
         end
-        creator=''
+        creator = ''
         dc_doc.xpath('//dc:creator').each do |node|
-          creator=node.text
+          creator = node.text
         end
-        title=''
+        title = ''
         dc_doc.xpath('//dc:title').each do |node|
-          title=node.text
+          title = node.text
         end
-        creator_title=creator+title
+        creator_title = creator + title
         add_solr_value(solr_doc, 'creator_title', creator_title , :string, [:stored_sortable])
       rescue CrosswalkError => e
-        ActiveFedora.logger.warn "Cannot index #{self.pid}.descMetadata: #{e.message}"
+        ActiveFedora.logger.warn "Cannot index #{pid}.descMetadata: #{e.message}"
       end
 
       begin
-        mods = self.stanford_mods
+        mods = stanford_mods
         mods_sources.each_pair do |solr_key, meth|
           vals = meth.is_a?(Array) ? mods.send(meth.shift, *meth) : mods.send(meth)
           solr_doc[solr_key].push *vals unless vals.nil? || vals.empty?
@@ -206,82 +245,84 @@ module Dor
         solr_doc['sw_pub_date_facet_ssi'] = mods.pub_date_facet # e.g. '9th century'
       end
       # some fields get explicit "(none)" placeholder values, mostly for faceting
-      %w[sw_language_tesim sw_genre_tesim sw_format_tesim].each { |key| solr_doc[key] = ['(none)'] if solr_doc[key].empty? }
+      %w(sw_language_tesim sw_genre_tesim sw_format_tesim).each { |key| solr_doc[key] = ['(none)'] if solr_doc[key].empty? }
       # otherwise remove empties
-      keys.each{ |key| solr_doc.delete(key) if solr_doc[key].nil? || solr_doc[key].empty?}
+      keys.each { |key| solr_doc.delete(key) if solr_doc[key].nil? || solr_doc[key].empty?}
       solr_doc
     end
 
     def update_title(new_title)
       raise 'Descriptive metadata has no title to update!' unless update_simple_field('mods:mods/mods:titleInfo/mods:title', new_title)
     end
+
     def add_identifier(type, value)
-      ds_xml=self.descMetadata.ng_xml
-      ds_xml.search('//mods:mods','mods' => 'http://www.loc.gov/mods/v3').each do |node|
-        new_node=Nokogiri::XML::Node.new('identifier',ds_xml) #this ends up being mods:identifier without having to specify the namespace
-        new_node['type']=type
-        new_node.content=value
+      ds_xml = descMetadata.ng_xml
+      ds_xml.search('//mods:mods', 'mods' => 'http://www.loc.gov/mods/v3').each do |node|
+        new_node = Nokogiri::XML::Node.new('identifier', ds_xml) # this ends up being mods:identifier without having to specify the namespace
+        new_node['type'] = type
+        new_node.content = value
         node.add_child(new_node)
       end
     end
-    def delete_identifier(type,value=nil)
-      ds_xml=self.descMetadata.ng_xml
-      ds_xml.search('//mods:identifier','mods' => 'http://www.loc.gov/mods/v3').each do |node|
+
+    def delete_identifier(type, value = nil)
+      ds_xml = descMetadata.ng_xml
+      ds_xml.search('//mods:identifier', 'mods' => 'http://www.loc.gov/mods/v3').each do |node|
         if node.content == value || value.nil?
           node.remove
           return true
         end
       end
-      return false
+      false
     end
 
-    def set_desc_metadata_using_label(force=false)
-      ds=self.descMetadata
-      unless force || ds.new?
-        raise 'Cannot proceed, there is already content in the descriptive metadata datastream: '+ds.content.to_s
+    # @param [Boolean] force Overwrite existing XML
+    # @return [String] descMetadata.content XML
+    def set_desc_metadata_using_label(force = false)
+      unless force || descMetadata.new?
+        raise 'Cannot proceed, there is already content in the descriptive metadata datastream: ' + descMetadata.content.to_s
       end
-      label=self.label
+      label = self.label
       builder = Nokogiri::XML::Builder.new { |xml|
-        xml.mods( 'xmlns' => 'http://www.loc.gov/mods/v3', 'xmlns:xsi' => 'http://www.w3.org/2001/XMLSchema-instance',:version => '3.3', "xsi:schemaLocation" => 'http://www.loc.gov/mods/v3 http://www.loc.gov/standards/mods/v3/mods-3-3.xsd'){
-          xml.titleInfo{
+        xml.mods( 'xmlns' => 'http://www.loc.gov/mods/v3', 'xmlns:xsi' => 'http://www.w3.org/2001/XMLSchema-instance', :version => '3.3', 'xsi:schemaLocation' => 'http://www.loc.gov/mods/v3 http://www.loc.gov/standards/mods/v3/mods-3-3.xsd') {
+          xml.titleInfo {
             xml.title label
           }
         }
       }
-      self.descMetadata.content=builder.to_xml
+      descMetadata.content = builder.to_xml
     end
 
     def self.get_collection_title(obj)
-      xml=obj.descMetadata.ng_xml
-      title=''
-      title_node = xml.at_xpath('//mods:mods/mods:titleInfo/mods:title','mods' => 'http://www.loc.gov/mods/v3')
+      xml = obj.descMetadata.ng_xml
+      title = ''
+      title_node = xml.at_xpath('//mods:mods/mods:titleInfo/mods:title', 'mods' => 'http://www.loc.gov/mods/v3')
       if title_node
         title = title_node.content
-        subtitle=xml.at_xpath('//mods:mods/mods:titleInfo/mods:subTitle','mods' => 'http://www.loc.gov/mods/v3')
+        subtitle = xml.at_xpath('//mods:mods/mods:titleInfo/mods:subTitle', 'mods' => 'http://www.loc.gov/mods/v3')
         title += " (#{subtitle.content})" if subtitle
       end
       title
     end
 
     private
-    #generic updater useful for updating things like title or subtitle which can only have a single occurance and must be present
-    def update_simple_field(field,new_val)
-      ds_xml=self.descMetadata.ng_xml
-      ds_xml.search('//'+field,'mods' => 'http://www.loc.gov/mods/v3').each do |node|
-        node.content=new_val
+
+    # generic updater useful for updating things like title or subtitle which can only have a single occurance and must be present
+    def update_simple_field(field, new_val)
+      descMetadata.ng_xml.search('//' + field, 'mods' => 'http://www.loc.gov/mods/v3').each do |node|
+        node.content = new_val
         return true
       end
-      return false
+      false
     end
 
     # Builds case-insensitive xpath translate function call that will match the attribute to a value
     def ci_compare(attribute, value)
-        "translate(
-            @#{attribute},
-            'ABCDEFGHIJKLMNOPQRSTUVWXYZ',
-            'abcdefghijklmnopqrstuvwxyz'
-          ) = '#{value}' "
+      "translate(
+        @#{attribute},
+        'ABCDEFGHIJKLMNOPQRSTUVWXYZ',
+        'abcdefghijklmnopqrstuvwxyz'
+       ) = '#{value}' "
     end
-
   end
 end