dor-services 6.0.0 → 6.0.1

data/lib/dor/datastreams/identity_metadata_ds.rb

@@ -1,139 +1,142 @@
+# frozen_string_literal: true
+
 module Dor
-class IdentityMetadataDS < ActiveFedora::OmDatastream
-  include SolrDocHelper
-
-  set_terminology do |t|
-    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' })
+  class IdentityMetadataDS < ActiveFedora::OmDatastream
+    include SolrDocHelper
+
+    set_terminology do |t|
+      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' })
+      end
+      t.agreementId :index_as => [:stored_searchable, :symbol]
+      t.tag :index_as => [:symbol]
+      t.citationTitle
+      t.objectCreator :index_as => [:stored_searchable, :symbol]
+      t.adminPolicy   :index_as => [:not_searchable]
+    end
+
+    define_template :value do |builder, name, value, attrs|
+      builder.send(name.to_sym, value, attrs)
+    end
+
+    def self.xml_template
+      Nokogiri::XML('<identityMetadata/>')
     end
-    t.agreementId :index_as => [:stored_searchable, :symbol]
-    t.tag :index_as => [:symbol]
-    t.citationTitle
-    t.objectCreator :index_as => [:stored_searchable, :symbol]
-    t.adminPolicy   :index_as => [:not_searchable]
-  end
-
-  define_template :value do |builder, name, value, attrs|
-    builder.send(name.to_sym, value, attrs)
-  end
-
-  def self.xml_template
-    Nokogiri::XML('<identityMetadata/>')
-  end
-
-  def add_value(name, value, attrs = {})
-    ng_xml_will_change!
-    add_child_node(ng_xml.root, :value, name, value, attrs)
-  end
-
-  def objectId
-    find_by_terms(:objectId).text
-  end
-
-  def sourceId
-    node = find_by_terms(:sourceId).first
-    node ? [node['source'], node.text].join(':') : nil
-  end
-
-  # @param  [String, Nil] value, or nil/empty string to delete sourceId node
-  # @return [String, Nil] The same value, as per Ruby convention for assignment operators
-  # @note The actual values assigned will have leading/trailing whitespace stripped.
-  def sourceId=(value)
-    ng_xml_will_change!
-    node = find_by_terms(:sourceId).first
-    unless value.present? # so setting it to '' is the same as removal: worth documenting maybe?
-      node.remove unless node.nil?
-      return nil
+
+    def add_value(name, value, attrs = {})
+      ng_xml_will_change!
+      add_child_node(ng_xml.root, :value, name, value, attrs)
     end
-    parts = value.split(':', 2).map(&:strip)
-    raise ArgumentError, "Source ID must follow the format 'namespace:value', not '#{value}'" unless
-      parts.length == 2 && parts[0].present? && parts[1].present?
-    node ||= ng_xml.root.add_child('<sourceId/>').first
-    node['source'] = parts[0]
-    node.content = parts[1]
-  end
-
-  def tags
-    ng_xml.search('//tag').collect(&:content)
-  end
-
-  def otherId(type = nil)
-    result = find_by_terms(:otherId).to_a
-    if type.nil?
-      result.collect { |n| [n['name'], n.text].join(':') }
-    else
-      result.select { |n| n['name'] == type }.collect { |n| n.text }
+
+    def objectId
+      find_by_terms(:objectId).text
+    end
+
+    def sourceId
+      node = find_by_terms(:sourceId).first
+      node ? [node['source'], node.text].join(':') : nil
     end
-  end
-
-  def add_otherId(other_id)
-    ng_xml_will_change!
-    (name, val) = other_id.split(/:/, 2)
-    node = ng_xml.root.add_child('<otherId/>').first
-    node['name'] = name
-    node.content = val
-    node
-  end
-
-  def to_solr(solr_doc = {}, *args)
-    solr_doc = super(solr_doc, *args)
-
-    if digital_object.respond_to?(:profile)
-      digital_object.profile.each_pair do |property, value|
-        add_solr_value(solr_doc, property.underscore, value, (property =~ /Date/ ? :date : :symbol), [:stored_searchable])
+
+    # @param  [String, Nil] value, or nil/empty string to delete sourceId node
+    # @return [String, Nil] The same value, as per Ruby convention for assignment operators
+    # @note The actual values assigned will have leading/trailing whitespace stripped.
+    def sourceId=(value)
+      ng_xml_will_change!
+      node = find_by_terms(:sourceId).first
+      unless value.present? # so setting it to '' is the same as removal: worth documenting maybe?
+        node&.remove
+        return nil
       end
+      parts = value.split(':', 2).map(&:strip)
+      raise ArgumentError, "Source ID must follow the format 'namespace:value', not '#{value}'" unless
+        parts.length == 2 && parts[0].present? && parts[1].present?
+
+      node ||= ng_xml.root.add_child('<sourceId/>').first
+      node['source'] = parts[0]
+      node.content = parts[1]
     end
 
-    if sourceId.present?
-      (name, id) = sourceId.split(/:/, 2)
-      add_solr_value(solr_doc, 'dor_id', id, :symbol, [:stored_searchable])
-      add_solr_value(solr_doc, 'identifier', sourceId, :symbol, [:stored_searchable])
-      add_solr_value(solr_doc, 'source_id', sourceId, :symbol, [])
+    def tags
+      ng_xml.search('//tag').collect(&:content)
     end
-    otherId.compact.each { |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, [])
-    }
-
-    # do some stuff to make tags in general and project tags specifically more easily searchable and facetable
-    find_by_terms(:tag).each { |tag|
-      (prefix, rest) = tag.text.split(/:/, 2)
-      prefix = prefix.downcase.strip.gsub(/\s/, '_')
-      unless rest.nil?
-        # this part will index a value in a field specific to the tag, e.g. registered_by_tag_*,
-        # book_tag_*, project_tag_*, remediated_by_tag_*, etc.  project_tag_* and registered_by_tag_*
-        # definitley get used, but most don't.  we can limit the prefixes that get solrized if things
-        # get out of hand.
-        add_solr_value(solr_doc, "#{prefix}_tag", rest.strip, :symbol, [])
+
+    def otherId(type = nil)
+      result = find_by_terms(:otherId).to_a
+      if type.nil?
+        result.collect { |n| [n['name'], n.text].join(':') }
+      else
+        result.select { |n| n['name'] == type }.collect { |n| n.text }
       end
+    end
+
+    def add_otherId(other_id)
+      ng_xml_will_change!
+      (name, val) = other_id.split(/:/, 2)
+      node = ng_xml.root.add_child('<otherId/>').first
+      node['name'] = name
+      node.content = val
+      node
+    end
+
+    def to_solr(solr_doc = {}, *args)
+      solr_doc = super(solr_doc, *args)
 
-      # solrize each possible prefix for the tag, inclusive of the full tag.
-      # e.g., for a tag such as "A : B : C", this will solrize to an _ssim field
-      # that contains ["A",  "A : B",  "A : B : C"].
-      tag_parts = tag.text.split(/:/)
-      progressive_tag_prefix = ''
-      tag_parts.each_with_index do |part, index|
-        progressive_tag_prefix += ' : ' if index > 0
-        progressive_tag_prefix += part.strip
-        add_solr_value(solr_doc, 'exploded_tag', progressive_tag_prefix, :symbol, [])
+      if digital_object.respond_to?(:profile)
+        digital_object.profile.each_pair do |property, value|
+          add_solr_value(solr_doc, property.underscore, value, (property =~ /Date/ ? :date : :symbol), [:stored_searchable])
+        end
       end
-    }
 
-    solr_doc
-  end
+      if sourceId.present?
+        (name, id) = sourceId.split(/:/, 2)
+        add_solr_value(solr_doc, 'dor_id', id, :symbol, [:stored_searchable])
+        add_solr_value(solr_doc, 'identifier', sourceId, :symbol, [:stored_searchable])
+        add_solr_value(solr_doc, 'source_id', sourceId, :symbol, [])
+      end
+      otherId.compact.each { |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, [])
+      }
+
+      # do some stuff to make tags in general and project tags specifically more easily searchable and facetable
+      find_by_terms(:tag).each { |tag|
+        (prefix, rest) = tag.text.split(/:/, 2)
+        prefix = prefix.downcase.strip.gsub(/\s/, '_')
+        unless rest.nil?
+          # this part will index a value in a field specific to the tag, e.g. registered_by_tag_*,
+          # book_tag_*, project_tag_*, remediated_by_tag_*, etc.  project_tag_* and registered_by_tag_*
+          # definitley get used, but most don't.  we can limit the prefixes that get solrized if things
+          # get out of hand.
+          add_solr_value(solr_doc, "#{prefix}_tag", rest.strip, :symbol, [])
+        end
+
+        # solrize each possible prefix for the tag, inclusive of the full tag.
+        # e.g., for a tag such as "A : B : C", this will solrize to an _ssim field
+        # that contains ["A",  "A : B",  "A : B : C"].
+        tag_parts = tag.text.split(/:/)
+        progressive_tag_prefix = ''
+        tag_parts.each_with_index do |part, index|
+          progressive_tag_prefix += ' : ' if index > 0
+          progressive_tag_prefix += part.strip
+          add_solr_value(solr_doc, 'exploded_tag', progressive_tag_prefix, :symbol, [])
+        end
+      }
+
+      solr_doc
+    end
 
-  # maintain AF < 8 indexing behavior
-  def prefix
-    ''
-  end
-end # class
+    # maintain AF < 8 indexing behavior
+    def prefix
+      ''
+    end
+  end # class
 end

data/lib/dor/datastreams/provenance_metadata_ds.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 module Dor
   # Represents the Fedora 3 datastream that hold provenance metadata
   class ProvenanceMetadataDS < ActiveFedora::OmDatastream
     # This provides the prefix for the solr fields generated by ActiveFedora.
     # Since we don't want a prefix, we override this to return an empty string.
     def prefix
-      ''.freeze
+      ''
     end
   end
 end

data/lib/dor/datastreams/rights_metadata_ds.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Dor
   class RightsMetadataDS < ActiveFedora::OmDatastream
     require 'dor/rights_auth'
@@ -35,7 +37,7 @@ module Dor
             xml.machine { xml.none }
           }
           xml.access(:type => 'read') {
-            xml.machine { xml.none }   # dark default
+            xml.machine { xml.none } # dark default
           }
           xml.use {
             xml.human(:type => 'useAndReproduction')
@@ -64,7 +66,6 @@ module Dor
       'none' => 'Citation Only'
     }.freeze
 
-
     # just a wrapper to invalidate @dra_object
     def content=(xml)
       @dra_object = nil
@@ -112,7 +113,7 @@ module Dor
           loc_node = Nokogiri::XML::Node.new('location', rights_xml)
           loc_node.content = rights_type.split(':').last
           machine_node.add_child(loc_node)
-        else  # we know it is none or dark by the argument filter (first line)
+        else # we know it is none or dark by the argument filter (first line)
           machine_node.add_child Nokogiri::XML::Node.new('none', rights_xml)
         end
       end
@@ -215,6 +216,5 @@ module Dor
     def prefix
       ''
     end
-
   end # class
 end

data/lib/dor/datastreams/role_metadata_ds.rb

@@ -1,55 +1,55 @@
+# frozen_string_literal: true
+
 module Dor
-class RoleMetadataDS < ActiveFedora::OmDatastream
-  include SolrDocHelper
+  class RoleMetadataDS < ActiveFedora::OmDatastream
+    include SolrDocHelper
 
-  set_terminology do |t|
-    t.root :path => 'roleMetadata'
+    set_terminology do |t|
+      t.root :path => 'roleMetadata'
 
-    t.actor do
-      t.identifier do
-        t.type_ :path => {:attribute => 'type'}
+      t.actor do
+        t.identifier do
+          t.type_ :path => { :attribute => 'type' }
+        end
+        t.name
       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]
-    end
+      t.role do
+        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'}
-  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' }
+    end
 
-  def self.xml_template
-    Nokogiri::XML::Builder.new do |xml|
-      xml.roleMetadata {
-      }
-    end.doc
-  end
+    def self.xml_template
+      Nokogiri::XML::Builder.new do |xml|
+        xml.roleMetadata {}
+      end.doc
+    end
 
-  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])
+    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
       end
+      solr_doc
     end
-    solr_doc
-  end
 
-  # maintain AF < 8 indexing behavior
-  def prefix
-    ''
+    # maintain AF < 8 indexing behavior
+    def prefix
+      ''
+    end
   end
-
-end
 end

data/lib/dor/datastreams/simple_dublin_core_ds.rb

@@ -1,57 +1,59 @@
-module Dor
-class SimpleDublinCoreDs < ActiveFedora::OmDatastream
-
-  set_terminology do |t|
-    t.root(
-      path: 'dc',
-      xmlns: 'http://www.openarchives.org/OAI/2.0/oai_dc/',
-      schema: 'http://cosimo.stanford.edu/standards/oai_dc/v2/oai_dc.xsd',
-      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')
-  end
+# frozen_string_literal: true
 
-  def self.xml_template
-    builder = Nokogiri::XML::Builder.new do |xml|
-      xml['oai_dc'].dc(
-        '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',
+module Dor
+  class SimpleDublinCoreDs < ActiveFedora::OmDatastream
+    set_terminology do |t|
+      t.root(
+        path: 'dc',
+        xmlns: 'http://www.openarchives.org/OAI/2.0/oai_dc/',
+        schema: 'http://cosimo.stanford.edu/standards/oai_dc/v2/oai_dc.xsd',
+        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')
     end
 
-    builder.doc
-  end
+    def self.xml_template
+      builder = Nokogiri::XML::Builder.new do |xml|
+        xml['oai_dc'].dc(
+          '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',
+        )
+      end
+
+      builder.doc
+    end
 
-  def to_solr(solr_doc = {}, *args)
-    # There are a whole bunch of namespace-related things that can go
-    # wrong with this terminology. Until it's fixed in OM, ignore them all.
+    def to_solr(solr_doc = {}, *args)
+      # There are a whole bunch of namespace-related things that can go
+      # wrong with this terminology. Until it's fixed in OM, ignore them all.
 
-    doc = super solr_doc, *args
+      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, [:stored_sortable, :stored_searchable])
+      add_solr_value(doc, 'dc_creator', creator.first, :string, [:stored_sortable, :stored_searchable])
 
-    identifiers = {}
+      identifiers = {}
 
-    identifier.each { |i| ns, val = i.split(':'); identifiers[ns] ||= val }
+      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])
-    end
+      identifiers.each do |ns, val|
+        add_solr_value(doc, "dc_identifier_#{ns}", val, :string, [:stored_sortable, :stored_searchable])
+      end
 
-    return doc
-  rescue Exception => e
-    warn "ERROR in SimpleDublinCoreDs to_solr()! #{e}"
-    solr_doc
-  end
+      return doc
+    rescue Exception => e
+      warn "ERROR in SimpleDublinCoreDs to_solr()! #{e}"
+      solr_doc
+    end
 
-  # maintain AF < 8 indexing behavior
-  def prefix
-    ''
+    # maintain AF < 8 indexing behavior
+    def prefix
+      ''
+    end
   end
 end
-end