dor-services 6.0.5 → 6.1.0

data/lib/dor/datastreams/geo_metadata_ds.rb

@@ -1,4 +1,3 @@
-# encoding: UTF-8
 # frozen_string_literal: true
 
 require 'scanf'
@@ -13,10 +12,10 @@ module Dor
   class GeoMetadataDS < ActiveFedora::OmDatastream
     # namespaces
     NS = {
-      :rdf => 'http://www.w3.org/1999/02/22-rdf-syntax-ns#',
-      :gco => 'http://www.isotc211.org/2005/gco',
-      :gmd => 'http://www.isotc211.org/2005/gmd',
-      :gfc => 'http://www.isotc211.org/2005/gfc'
+      rdf: 'http://www.w3.org/1999/02/22-rdf-syntax-ns#',
+      gco: 'http://www.isotc211.org/2005/gco',
+      gmd: 'http://www.isotc211.org/2005/gmd',
+      gfc: 'http://www.isotc211.org/2005/gfc'
     }.freeze
 
     # hash with all namespaces

data/lib/dor/datastreams/identity_metadata_ds.rb

@@ -5,20 +5,20 @@ module Dor
     include SolrDocHelper
 
     set_terminology do |t|
-      t.root(:path => 'identityMetadata')
-      t.objectId   :index_as => [:symbol]
-      t.objectType :index_as => [:symbol]
+      t.root(path: 'identityMetadata')
+      t.objectId   index_as: [:symbol]
+      t.objectType index_as: [:symbol]
       t.objectLabel
       t.citationCreator
       t.sourceId
-      t.otherId(:path => 'otherId') do
-        t.name_(:path => { :attribute => 'name' })
+      t.otherId(path: 'otherId') do
+        t.name_(path: { attribute: 'name' })
       end
-      t.agreementId :index_as => [:stored_searchable, :symbol]
-      t.tag :index_as => [:symbol]
+      t.agreementId index_as: %i[stored_searchable symbol]
+      t.tag index_as: [:symbol]
       t.citationTitle
-      t.objectCreator :index_as => [:stored_searchable, :symbol]
-      t.adminPolicy   :index_as => [:not_searchable]
+      t.objectCreator index_as: %i[stored_searchable symbol]
+      t.adminPolicy   index_as: [:not_searchable]
     end
 
     define_template :value do |builder, name, value, attrs|
@@ -71,7 +71,7 @@ module Dor
       if type.nil?
         result.collect { |n| [n['name'], n.text].join(':') }
       else
-        result.select { |n| n['name'] == type }.collect { |n| n.text }
+        result.select { |n| n['name'] == type }.collect(&:text)
       end
     end
 
@@ -99,16 +99,16 @@ module Dor
         add_solr_value(solr_doc, 'identifier', sourceId, :symbol, [:stored_searchable])
         add_solr_value(solr_doc, 'source_id', sourceId, :symbol, [])
       end
-      otherId.compact.each { |qid|
+      otherId.compact.each do |qid|
         # this section will solrize barcode and catkey, which live in otherId
         (name, id) = qid.split(/:/, 2)
         add_solr_value(solr_doc, 'dor_id', id, :symbol, [:stored_searchable])
         add_solr_value(solr_doc, 'identifier', qid, :symbol, [:stored_searchable])
         add_solr_value(solr_doc, "#{name}_id", id, :symbol, [])
-      }
+      end
 
       # do some stuff to make tags in general and project tags specifically more easily searchable and facetable
-      find_by_terms(:tag).each { |tag|
+      find_by_terms(:tag).each do |tag|
         (prefix, rest) = tag.text.split(/:/, 2)
         prefix = prefix.downcase.strip.gsub(/\s/, '_')
         unless rest.nil?
@@ -129,7 +129,7 @@ module Dor
           progressive_tag_prefix += part.strip
           add_solr_value(solr_doc, 'exploded_tag', progressive_tag_prefix, :symbol, [])
         end
-      }
+      end
 
       solr_doc
     end

data/lib/dor/datastreams/rights_metadata_ds.rb

@@ -11,43 +11,43 @@ module Dor
     # Ultimately, default_object_rights should go away and APOs also use an instantation of this class
 
     set_terminology do |t|
-      t.root :path => 'rightsMetadata', :index_as => [:not_searchable]
-      t.copyright :path => 'copyright/human', :index_as => [:symbol]
-      t.use_statement :path => '/use/human[@type=\'useAndReproduction\']', :index_as => [:symbol]
+      t.root path: 'rightsMetadata', index_as: [:not_searchable]
+      t.copyright path: 'copyright/human', index_as: [:symbol]
+      t.use_statement path: '/use/human[@type=\'useAndReproduction\']', index_as: [:symbol]
 
       t.use do
         t.machine
         t.human
       end
 
-      t.creative_commons :path => '/use/machine[@type=\'creativeCommons\']', :type => 'creativeCommons' do
-        t.uri :path => '@uri'
+      t.creative_commons path: '/use/machine[@type=\'creativeCommons\']', type: 'creativeCommons' do
+        t.uri path: '@uri'
       end
-      t.creative_commons_human :path => '/use/human[@type=\'creativeCommons\']'
-      t.open_data_commons :path => '/use/machine[@type=\'openDataCommons\']', :type => 'openDataCommons' do
-        t.uri :path => '@uri'
+      t.creative_commons_human path: '/use/human[@type=\'creativeCommons\']'
+      t.open_data_commons path: '/use/machine[@type=\'openDataCommons\']', type: 'openDataCommons' do
+        t.uri path: '@uri'
       end
-      t.open_data_commons_human :path => '/use/human[@type=\'openDataCommons\']'
+      t.open_data_commons_human path: '/use/human[@type=\'openDataCommons\']'
     end
 
     def self.xml_template
       Nokogiri::XML::Builder.new do |xml|
-        xml.rightsMetadata {
-          xml.access(:type => 'discover') {
+        xml.rightsMetadata do
+          xml.access(type: 'discover') do
             xml.machine { xml.none }
-          }
-          xml.access(:type => 'read') {
+          end
+          xml.access(type: 'read') do
             xml.machine { xml.none } # dark default
-          }
-          xml.use {
-            xml.human(:type => 'useAndReproduction')
-            xml.human(:type => 'creativeCommons')
-            xml.machine(:type => 'creativeCommons', :uri => '')
-            xml.human(:type => 'openDataCommons')
-            xml.machine(:type => 'openDataCommons', :uri => '')
-          }
+          end
+          xml.use do
+            xml.human(type: 'useAndReproduction')
+            xml.human(type: 'creativeCommons')
+            xml.machine(type: 'creativeCommons', uri: '')
+            xml.human(type: 'openDataCommons')
+            xml.machine(type: 'openDataCommons', uri: '')
+          end
           xml.copyright { xml.human }
-        }
+        end
       end.doc
     end
 
@@ -186,7 +186,7 @@ module Dor
 
       # these two values are returned by index_elements[:primary], but are just a less granular version of
       # what the other more specific fields return, so discard them
-      solr_doc['rights_descriptions_ssim'] -= ['access_restricted', 'access_restricted_qualified', 'world_qualified']
+      solr_doc['rights_descriptions_ssim'] -= %w[access_restricted access_restricted_qualified world_qualified]
       solr_doc['rights_descriptions_ssim'] += ['dark (file)'] if dra.index_elements[:terms].include? 'none_read_file'
 
       solr_doc['obj_rights_locations_ssim'] = dra.index_elements[:obj_locations] unless dra.index_elements[:obj_locations].blank?

data/lib/dor/datastreams/role_metadata_ds.rb

@@ -5,27 +5,27 @@ module Dor
     include SolrDocHelper
 
     set_terminology do |t|
-      t.root :path => 'roleMetadata'
+      t.root path: 'roleMetadata'
 
       t.actor do
         t.identifier do
-          t.type_ :path => { :attribute => 'type' }
+          t.type_ path: { attribute: 'type' }
         end
         t.name
       end
-      t.person :ref => [:actor], :path => 'person'
-      t.group  :ref => [:actor], :path => 'group'
+      t.person ref: [:actor], path: 'person'
+      t.group  ref: [:actor], path: 'group'
 
       t.role do
-        t.type_ :path => { :attribute => 'type' }
-        t.person :ref => [:person]
-        t.group  :ref => [:group]
+        t.type_ path: { attribute: 'type' }
+        t.person ref: [:person]
+        t.group  ref: [:group]
       end
 
-      t.manager    :ref => [:role], :attributes => { :type => 'manager' }
-      t.depositor  :ref => [:role], :attributes => { :type => 'depositor' }
-      t.reviewer   :ref => [:role], :attributes => { :type => 'reviewer' }
-      t.viewer     :ref => [:role], :attributes => { :type => 'viewer' }
+      t.manager    ref: [:role], attributes: { type: 'manager' }
+      t.depositor  ref: [:role], attributes: { type: 'depositor' }
+      t.reviewer   ref: [:role], attributes: { type: 'reviewer' }
+      t.viewer     ref: [:role], attributes: { type: 'viewer' }
     end
 
     def self.xml_template
@@ -34,19 +34,65 @@ module Dor
       end.doc
     end
 
-    def to_solr(solr_doc = {}, *args)
+    def to_solr(solr_doc = {}, *_args)
       find_by_xpath('/roleMetadata/role/*').each do |actor|
         role_type = actor.parent['type']
         val = [actor.at_xpath('identifier/@type'), actor.at_xpath('identifier/text()')].join ':'
         add_solr_value(solr_doc, "apo_role_#{actor.name}_#{role_type}", val, :string, [:symbol])
         add_solr_value(solr_doc, "apo_role_#{role_type}", val, :string, [:symbol])
-        if ['dor-apo-manager', 'dor-apo-depositor'].include? role_type
-          add_solr_value(solr_doc, 'apo_register_permissions', val, :string, [:symbol, :stored_searchable])
-        end
+        add_solr_value(solr_doc, 'apo_register_permissions', val, :string, %i[symbol stored_searchable]) if ['dor-apo-manager', 'dor-apo-depositor'].include? role_type
       end
       solr_doc
     end
 
+    # Adds a person or group to a role in the APO role metadata datastream
+    #
+    # @param role   [String] the role the group or person will be filed under, ex. dor-apo-manager
+    # @param entity [String] the name of the person or group, ex dlss:developers or sunetid:someone
+    # @param type   [Symbol] :workgroup for a group or :person for a person
+    def add_roleplayer(role, entity, type = :workgroup)
+      xml = ng_xml
+      ng_xml_will_change!
+      group = type == :workgroup ? 'group' : 'person'
+      nodes = xml.search('/roleMetadata/role[@type=\'' + role + '\']')
+      if nodes.length > 0
+        group_node = Nokogiri::XML::Node.new(group, xml)
+        id_node = Nokogiri::XML::Node.new('identifier', xml)
+        group_node.add_child(id_node)
+        id_node.content = entity
+        id_node['type'] = type.to_s
+        nodes.first.add_child(group_node)
+      else
+        node = Nokogiri::XML::Node.new('role', xml)
+        node['type'] = role
+        group_node = Nokogiri::XML::Node.new(group, xml)
+        node.add_child group_node
+        id_node = Nokogiri::XML::Node.new('identifier', xml)
+        group_node.add_child(id_node)
+        id_node.content = entity
+        id_node['type'] = type.to_s
+        xml.search('/roleMetadata').first.add_child(node)
+      end
+    end
+
+    # remove all people groups and roles from the APO role metadata datastream
+    def purge_roles
+      ng_xml.search('/roleMetadata/role').each(&:remove)
+    end
+
+    # Get all roles defined in the role metadata, and the people or groups in those roles. Groups are prefixed with 'workgroup:'
+    # @return [Hash] role => ['person','group'] ex. {"dor-apo-manager" => ["workgroup:dlss:developers", "sunetid:lmcrae"]
+    def roles
+      {}.tap do |roles|
+        ng_xml.search('/roleMetadata/role').each do |role|
+          roles[role['type']] = []
+          role.search('identifier').each do |entity|
+            roles[role['type']] << entity['type'] + ':' + entity.text
+          end
+        end
+      end
+    end
+
     # maintain AF < 8 indexing behavior
     def prefix
       ''

data/lib/dor/datastreams/simple_dublin_core_ds.rb

@@ -10,9 +10,9 @@ module Dor
         namespace_prefix: 'oai_dc',
         index_as: [:not_searchable]
       )
-      t.title(:index_as => [:stored_sortable, :stored_searchable], :xmlns => 'http://purl.org/dc/elements/1.1/', :namespace_prefix => 'dc')
-      t.creator(:index_as => [:stored_sortable, :stored_searchable], :xmlns => 'http://purl.org/dc/elements/1.1/', :namespace_prefix => 'dc')
-      t.identifier(:index_as => [:symbol, :stored_searchable], :xmlns => 'http://purl.org/dc/elements/1.1/', :namespace_prefix => 'dc')
+      t.title(index_as: %i[stored_sortable stored_searchable], xmlns: 'http://purl.org/dc/elements/1.1/', namespace_prefix: 'dc')
+      t.creator(index_as: %i[stored_sortable stored_searchable], xmlns: 'http://purl.org/dc/elements/1.1/', namespace_prefix: 'dc')
+      t.identifier(index_as: %i[symbol stored_searchable], xmlns: 'http://purl.org/dc/elements/1.1/', namespace_prefix: 'dc')
     end
 
     def self.xml_template
@@ -21,7 +21,7 @@ module Dor
           'xmlns:oai_dc' => 'http://www.openarchives.org/OAI/2.0/oai_dc/',
           'xmlns:dc' => 'http://purl.org/dc/elements/1.1/',
           'xmlns:xsi' => 'http://www.w3.org/2001/XMLSchema-instance',
-          'xsi:schemaLocation' => 'http://www.openarchives.org/OAI/2.0/oai_dc/ http://www.openarchives.org/OAI/2.0/oai_dc.xsd',
+          'xsi:schemaLocation' => 'http://www.openarchives.org/OAI/2.0/oai_dc/ http://www.openarchives.org/OAI/2.0/oai_dc.xsd'
         )
       end
 
@@ -34,18 +34,18 @@ module Dor
 
       doc = super solr_doc, *args
 
-      add_solr_value(doc, 'dc_title',   title.first,   :string, [:stored_sortable, :stored_searchable])
-      add_solr_value(doc, 'dc_creator', creator.first, :string, [:stored_sortable, :stored_searchable])
+      add_solr_value(doc, 'dc_title',   title.first,   :string, %i[stored_sortable stored_searchable])
+      add_solr_value(doc, 'dc_creator', creator.first, :string, %i[stored_sortable stored_searchable])
 
       identifiers = {}
 
       identifier.each { |i| ns, val = i.split(':'); identifiers[ns] ||= val }
 
       identifiers.each do |ns, val|
-        add_solr_value(doc, "dc_identifier_#{ns}", val, :string, [:stored_sortable, :stored_searchable])
+        add_solr_value(doc, "dc_identifier_#{ns}", val, :string, %i[stored_sortable stored_searchable])
       end
 
-      return doc
+      doc
     rescue Exception => e
       warn "ERROR in SimpleDublinCoreDs to_solr()! #{e}"
       solr_doc

data/lib/dor/datastreams/version_metadata_ds.rb

@@ -55,10 +55,10 @@ module Dor
     before_create :ensure_non_versionable
 
     set_terminology do |t|
-      t.root(:path => 'versionMetadata')
+      t.root(path: 'versionMetadata')
       t.version do
-        t.version_id :path => { :attribute => 'versionID' }
-        t.tag :path => { :attribute => 'tag' }
+        t.version_id path: { attribute: 'versionID' }
+        t.tag path: { attribute: 'tag' }
         t.description
       end
     end
@@ -66,11 +66,11 @@ module Dor
     # Default EventsDS xml
     def self.xml_template
       builder = Nokogiri::XML::Builder.new do |xml|
-        xml.versionMetadata {
-          xml.version(:versionId => '1', :tag => '1.0.0') {
+        xml.versionMetadata do
+          xml.version(versionId: '1', tag: '1.0.0') do
             xml.description 'Initial Version'
-          }
-        }
+          end
+        end
       end
       builder.doc
     end
@@ -86,7 +86,7 @@ module Dor
       ng_xml_will_change!
       if find_by_terms(:version).size == 0
         v = ng_xml.create_element 'version',
-                                  :versionId => '1', :tag => '1.0.0'
+                                  versionId: '1', tag: '1.0.0'
         d = ng_xml.create_element 'description', 'Initial Version'
         ng_xml.root['objectId'] = pid
         ng_xml.root.add_child(v)
@@ -96,10 +96,8 @@ module Dor
         current_id = current[:versionId].to_i
         current_tag = VersionTag.parse(current[:tag])
 
-        v = ng_xml.create_element 'version', :versionId => (current_id + 1).to_s
-        if significance && current_tag
-          v[:tag] = current_tag.increment(significance).to_s
-        end
+        v = ng_xml.create_element 'version', versionId: (current_id + 1).to_s
+        v[:tag] = current_tag.increment(significance).to_s if significance && current_tag
         ng_xml.root['objectId'] = pid
         ng_xml.root.add_child(v)
 

data/lib/dor/datastreams/workflow_definition_ds.rb

@@ -5,8 +5,8 @@ module Dor
     include SolrDocHelper
 
     set_terminology do |t|
-      t.root(:path => 'workflow-def', :index_as => [:not_searchable])
-      t.process(:index_as => [:not_searchable])
+      t.root(path: 'workflow-def', index_as: [:not_searchable])
+      t.process(index_as: [:not_searchable])
     end
 
     define_template :process do |builder, workflow, attrs|
@@ -24,7 +24,7 @@ module Dor
             repo = nil
             wf = nil
           end
-          attrs = (repo.nil? && wf.nil?) ? {} : { :repository => repo, :workflow => wf }
+          attrs = repo.nil? && wf.nil? ? {} : { repository: repo, workflow: wf }
           node.prereq(attrs) { node.text prereq_name }
         end
       end
@@ -59,7 +59,7 @@ module Dor
       doc = Nokogiri::XML('<workflow/>')
       root = doc.root
       root['id'] = name
-      processes.each { |proc|
+      processes.each do |proc|
         doc.create_element 'process' do |node|
           node['name'] = proc.name
           if proc.status
@@ -71,8 +71,8 @@ module Dor
           node['lifecycle'] = proc.lifecycle if proc.lifecycle
           root.add_child node
         end
-      }
-      Nokogiri::XML(doc.to_xml) { |x| x.noblanks }.to_xml { |config| config.no_declaration }
+      end
+      Nokogiri::XML(doc.to_xml, &:noblanks).to_xml(&:no_declaration)
     end
 
     def to_solr(solr_doc = {}, *args)

data/lib/dor/datastreams/workflow_ds.rb

@@ -5,18 +5,18 @@ module Dor
   class WorkflowDs < ActiveFedora::OmDatastream
     before_save :build_location
     set_terminology do |t|
-      t.root(:path => 'workflows')
-      t.workflow {
-        t.workflowId(:path => { :attribute => 'id' })
-        t.process {
-          t.name_(:path => { :attribute => 'name' }, :index_as => [:displayable, :not_searchable])
-          t.status(:path => { :attribute => 'status' }, :index_as => [:displayable, :not_searchable])
-          t.timestamp(:path => { :attribute => 'datetime' }, :index_as => [:displayable, :not_searchable]) # , :data_type => :date)
-          t.elapsed(:path => { :attribute => 'elapsed' }, :index_as => [:displayable, :not_searchable])
-          t.lifecycle(:path => { :attribute => 'lifecycle' }, :index_as => [:displayable, :not_searchable])
-          t.attempts(:path => { :attribute => 'attempts' }, :index_as => [:displayable, :not_searchable])
-        }
-      }
+      t.root(path: 'workflows')
+      t.workflow do
+        t.workflowId(path: { attribute: 'id' })
+        t.process do
+          t.name_(path: { attribute: 'name' }, index_as: %i[displayable not_searchable])
+          t.status(path: { attribute: 'status' }, index_as: %i[displayable not_searchable])
+          t.timestamp(path: { attribute: 'datetime' }, index_as: %i[displayable not_searchable]) # , :data_type => :date)
+          t.elapsed(path: { attribute: 'elapsed' }, index_as: %i[displayable not_searchable])
+          t.lifecycle(path: { attribute: 'lifecycle' }, index_as: %i[displayable not_searchable])
+          t.attempts(path: { attribute: 'attempts' }, index_as: %i[displayable not_searchable])
+        end
+      end
     end
 
     # Called before saving, but after a pid has been assigned
@@ -39,7 +39,7 @@ module Dor
       Workflow::Document.new(xml.to_s)
     end
 
-    alias :[] :get_workflow
+    alias [] get_workflow
 
     def ng_xml
       @ng_xml ||= Nokogiri::XML::Document.parse(content)

data/lib/dor/exceptions.rb

@@ -2,8 +2,8 @@
 
 module Dor
   class Exception < ::StandardError; end
-  class ParameterError < Exception; end
-  class DuplicateIdError < Exception
+  class ParameterError < RuntimeError; end
+  class DuplicateIdError < RuntimeError
     attr_reader :pid
 
     def initialize(pid)