dor-services 6.0.0 → 6.0.1

data/lib/dor/models/collection.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Dor
   class Collection < Dor::Set
     include Releaseable
@@ -5,6 +7,7 @@ module Dor
     has_object_type 'collection'
 
     self.resource_indexer = CompositeIndexer.new(
+      DataIndexer,
       DescribableIndexer,
       IdentifiableIndexer,
       ProcessableIndexer,

data/lib/dor/models/concerns/assembleable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Dor
   module Assembleable
     def initialize_workspace(source = nil)

data/lib/dor/models/concerns/contentable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Dor
   module Contentable
     extend ActiveSupport::Concern
@@ -7,6 +9,7 @@ module Dor
       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)
@@ -15,7 +18,7 @@ module Dor
       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}
+      file_hash = { :name => file_name, :md5 => md5, :publish => publish, :shelve => shelve, :preserve => preserve, :size => size.to_s, :sha1 => sha1, :mime_type => mime_type }
       begin
         sftp.stat!(location.gsub(file_name, ''))
         begin
@@ -49,7 +52,7 @@ module Dor
       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}
+      file_hash = { :name => file_name, :md5 => md5, :size => size.to_s, :sha1 => sha1 }
       begin
         sftp.stat!(location)
         sftp.upload!(file.path, location)

data/lib/dor/models/concerns/describable.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 module Dor
   module Describable
     extend ActiveSupport::Concern
 
     MODS_TO_DC_XSLT = Nokogiri::XSLT(File.new(File.expand_path(File.dirname(__FILE__) + "/mods2dc.xslt")))
-    XMLNS_OAI_DC = 'http://www.openarchives.org/OAI/2.0/oai_dc/'.freeze
-    XMLNS_DC = 'http://purl.org/dc/elements/1.1/'.freeze
+    XMLNS_OAI_DC = 'http://www.openarchives.org/OAI/2.0/oai_dc/'
+    XMLNS_DC = 'http://purl.org/dc/elements/1.1/'
 
     class CrosswalkError < Exception; end
 
@@ -35,6 +37,7 @@ module Dor
     def build_descMetadata_datastream(ds)
       content = fetch_descMetadata_datastream
       return nil if content.nil?
+
       ds.dsLabel = 'Descriptive Metadata'
       ds.ng_xml = Nokogiri::XML(content)
       ds.ng_xml.normalize_text!
@@ -56,6 +59,7 @@ module Dor
       dc_doc.xpath('/oai_dc:dc/*[count(text()) = 0]', oai_dc: XMLNS_OAI_DC).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
 
@@ -70,6 +74,7 @@ module Dor
       unless force || descMetadata.new?
         raise 'Cannot proceed, there is already content in the descriptive metadata datastream: ' + descMetadata.content.to_s
       end
+
       label = self.label
       builder = Nokogiri::XML::Builder.new { |xml|
         xml.mods(Dor::DescMetadataDS::MODS_HEADER_CONFIG) {

data/lib/dor/models/concerns/editable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Dor
   ## This is basically used just by APOs.  Arguably "editable" is the wrong name.
   module Editable
@@ -18,29 +20,29 @@ module Dor
     # TODO: need some way to do versioning.  for instance, what happens when a new version of an existing license comes
     # out, since it will presumably use the same license code, but a different title and URI?
     CREATIVE_COMMONS_USE_LICENSES = {
-      'by' =>       { :human_readable => 'Attribution 3.0 Unported',
-                      :uri => 'https://creativecommons.org/licenses/by/3.0/' },
-      'by-sa' =>    { :human_readable => 'Attribution Share Alike 3.0 Unported',
-                      :uri => 'https://creativecommons.org/licenses/by-sa/3.0/' },
-      'by_sa' =>    { :human_readable => 'Attribution Share Alike 3.0 Unported',
-                      :uri => 'https://creativecommons.org/licenses/by-sa/3.0/',
-                      :deprecation_warning => 'license code "by_sa" was a typo in argo, prefer "by-sa"' },
-      'by-nd' =>    { :human_readable => 'Attribution No Derivatives 3.0 Unported',
-                      :uri => 'https://creativecommons.org/licenses/by-nd/3.0/' },
-      'by-nc' =>    { :human_readable => 'Attribution Non-Commercial 3.0 Unported',
-                      :uri => 'https://creativecommons.org/licenses/by-nc/3.0/' },
+      'by' => { :human_readable => 'Attribution 3.0 Unported',
+                :uri => 'https://creativecommons.org/licenses/by/3.0/' },
+      'by-sa' => { :human_readable => 'Attribution Share Alike 3.0 Unported',
+                   :uri => 'https://creativecommons.org/licenses/by-sa/3.0/' },
+      'by_sa' => { :human_readable => 'Attribution Share Alike 3.0 Unported',
+                   :uri => 'https://creativecommons.org/licenses/by-sa/3.0/',
+                   :deprecation_warning => 'license code "by_sa" was a typo in argo, prefer "by-sa"' },
+      'by-nd' => { :human_readable => 'Attribution No Derivatives 3.0 Unported',
+                   :uri => 'https://creativecommons.org/licenses/by-nd/3.0/' },
+      'by-nc' => { :human_readable => 'Attribution Non-Commercial 3.0 Unported',
+                   :uri => 'https://creativecommons.org/licenses/by-nc/3.0/' },
       'by-nc-sa' => { :human_readable => 'Attribution Non-Commercial Share Alike 3.0 Unported',
                       :uri => 'https://creativecommons.org/licenses/by-nc-sa/3.0/' },
       'by-nc-nd' => { :human_readable => 'Attribution Non-Commercial, No Derivatives 3.0 Unported',
                       :uri => 'https://creativecommons.org/licenses/by-nc-nd/3.0/' },
-      'pdm' =>      { :human_readable => 'Public Domain Mark 1.0',
-                      :uri => 'https://creativecommons.org/publicdomain/mark/1.0/'}
+      'pdm' => { :human_readable => 'Public Domain Mark 1.0',
+                 :uri => 'https://creativecommons.org/publicdomain/mark/1.0/' }
     }.freeze
     OPEN_DATA_COMMONS_USE_LICENSES = {
-      'pddl' =>     { :human_readable => 'Open Data Commons Public Domain Dedication and License 1.0',
-                      :uri => 'http://opendatacommons.org/licenses/pddl/1.0/' },
-      'odc-by' =>   { :human_readable => 'Open Data Commons Attribution License 1.0',
-                      :uri => 'http://opendatacommons.org/licenses/by/1.0/' },
+      'pddl' => { :human_readable => 'Open Data Commons Public Domain Dedication and License 1.0',
+                  :uri => 'http://opendatacommons.org/licenses/pddl/1.0/' },
+      'odc-by' => { :human_readable => 'Open Data Commons Attribution License 1.0',
+                    :uri => 'http://opendatacommons.org/licenses/by/1.0/' },
       'odc-odbl' => { :human_readable => 'Open Data Commons Open Database License 1.0',
                       :uri => 'http://opendatacommons.org/licenses/odbl/1.0/' }
     }.freeze
@@ -87,7 +89,7 @@ module Dor
     end
 
     def mods_title=(val)
-      descMetadata.update_values({[:title_info, :main_title] => val})
+      descMetadata.update_values({ [:title_info, :main_title] => val })
     end
 
     # get all collections listed for this APO, used during registration
@@ -139,7 +141,7 @@ module Dor
         administrativeMetadata.ng_xml_will_change!
         administrativeMetadata.add_child_node(administrativeMetadata, :descMetadata)
       end
-      administrativeMetadata.update_values({[:descMetadata, :source] => val})
+      administrativeMetadata.update_values({ [:descMetadata, :source] => val })
     end
 
     def use_statement
@@ -177,18 +179,21 @@ module Dor
     def use_license
       return creative_commons_license unless creative_commons_license.blank?
       return open_data_commons_license unless open_data_commons_license.blank?
+
       nil
     end
 
     def use_license_uri
       return defaultObjectRights.creative_commons.uri.first unless defaultObjectRights.creative_commons.uri.blank?
       return defaultObjectRights.open_data_commons.uri.first unless defaultObjectRights.open_data_commons.uri.blank?
+
       nil
     end
 
     def use_license_human
       return creative_commons_license_human unless creative_commons_license_human.blank?
       return open_data_commons_license_human unless open_data_commons_license_human.blank?
+
       nil
     end
 
@@ -293,7 +298,7 @@ module Dor
         administrativeMetadata.ng_xml_will_change!
         administrativeMetadata.add_child_node(administrativeMetadata.ng_xml.root, :metadata_format)
       end
-      administrativeMetadata.update_values({[:metadata_format] => format})
+      administrativeMetadata.update_values({ [:metadata_format] => format })
     end
 
     def desc_metadata_source
@@ -306,7 +311,7 @@ module Dor
         administrativeMetadata.ng_xml_will_change!
         administrativeMetadata.add_child_node(administrativeMetadata.ng_xml.root, :metadata_source)
       end
-      administrativeMetadata.update_values({[:metadata_source] => format})
+      administrativeMetadata.update_values({ [:metadata_source] => format })
     end
 
     # List of default workflows, used to provide choices at registration
@@ -319,6 +324,7 @@ module Dor
     # @param wf [String] the name of the workflow, ex. 'digitizationWF'
     def default_workflow=(wf)
       fail ArgumentError, 'Must have a valid workflow for default' if wf.blank?
+
       xml = administrativeMetadata.ng_xml
       administrativeMetadata.ng_xml_will_change!
       nodes = xml.search('//registration/workflow')
@@ -343,6 +349,7 @@ module Dor
 
     def agreement=(val)
       fail ArgumentError, 'agreement must have a valid druid' if val.blank?
+
       self.agreement_object = Dor.find val.to_s, :cast => true
     end
   end

data/lib/dor/models/concerns/embargoable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Dor
   module Embargoable
     extend ActiveSupport::Concern
@@ -68,6 +70,7 @@ module Dor
       if new_date.past?
         raise ArgumentError, 'You cannot set the embargo date to a past date.'
       end
+
       updated = false
       rightsMetadata.ng_xml.search('//embargoReleaseDate').each do |node|
         node.content = new_date.beginning_of_day.utc.xmlschema
@@ -76,6 +79,7 @@ module Dor
       rightsMetadata.ng_xml_will_change!
       rightsMetadata.save
       raise 'No release date in rights metadata, cannot proceed!' unless updated
+
       embargoMetadata.ng_xml.xpath('//releaseDate').each do |node|
         node.content = new_date.beginning_of_day.utc.xmlschema
       end

data/lib/dor/models/concerns/eventable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Dor
   module Eventable
     extend ActiveSupport::Concern

data/lib/dor/models/concerns/geoable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Dor
   module Geoable
     extend ActiveSupport::Concern

data/lib/dor/models/concerns/governable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Dor
   module Governable
     extend ActiveSupport::Concern
@@ -16,13 +18,14 @@ module Dor
     #   and APO, or if the APO does not have a default_lane
     # @return [String] the lane id
     def default_workflow_lane
-      return 'default' if admin_policy_object.nil?  # TODO: log warning?
+      return 'default' if admin_policy_object.nil? # TODO: log warning?
 
       admin_md = admin_policy_object.datastreams['administrativeMetadata']
       return 'default' unless admin_md.respond_to?(:default_workflow_lane) # Some APOs don't have this datastream
 
       lane = admin_md.default_workflow_lane
       return 'default' if lane.blank?
+
       lane
     end
 
@@ -81,8 +84,10 @@ module Dor
     def rights
       return nil unless self.respond_to? :rightsMetadata
       return nil if rightsMetadata.nil?
+
       xml = rightsMetadata.ng_xml
-      return nil if xml.search('//rightsMetadata').length != 1      # ORLY?
+      return nil if xml.search('//rightsMetadata').length != 1 # ORLY?
+
       if xml.search('//rightsMetadata/access[@type=\'read\']/machine/group').length == 1
         'Stanford'
       elsif xml.search('//rightsMetadata/access[@type=\'read\']/machine/world').length == 1

data/lib/dor/models/concerns/identifiable.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 module Dor
   module Identifiable
     extend ActiveSupport::Concern
 
     # ids for previous and current catkeys
-    CATKEY_TYPE_ID = 'catkey'.freeze
-    PREVIOUS_CATKEY_TYPE_ID = 'previous_catkey'.freeze
+    CATKEY_TYPE_ID = 'catkey'
+    PREVIOUS_CATKEY_TYPE_ID = 'previous_catkey'
 
     included do
       has_metadata :name => 'DC', :type => SimpleDublinCoreDs, :label => 'Dublin Core Record for self object'
@@ -22,6 +24,7 @@ module Dor
       # than the default Fedora sequence
       def assign_pid(_obj)
         return Dor::SuriService.mint_id if Dor::Config.suri.mint_ids
+
         super
       end
     end
@@ -33,7 +36,7 @@ module Dor
 
     # helper method to get just the content type tag
     def content_type_tag
-      content_tag = tags.select {|tag| tag.include?('Process : Content Type')}
+      content_tag = tags.select { |tag| tag.include?('Process : Content Type') }
       content_tag.size == 1 ? content_tag[0].split(':').last.strip : ''
     end
 
@@ -62,7 +65,6 @@ module Dor
     # @param  [String] catkey the new source identifier
     # @return [String] same value, as per Ruby assignment convention
     def catkey=(val)
-
       if val != catkey && !catkey.blank? # if there was already a catkey in the record, store that in the "previous" spot (assuming there is no change)
         identityMetadata.add_otherId("#{PREVIOUS_CATKEY_TYPE_ID}:#{catkey}")
       end
@@ -70,9 +72,9 @@ module Dor
       if val.blank? # if we are setting the catkey to blank, remove the node from XML
         remove_other_Id(CATKEY_TYPE_ID)
       elsif catkey.blank? # if there is no current catkey, then add it
-        add_other_Id(CATKEY_TYPE_ID,val)
-      elsif # if there is a current catkey, update the current catkey to the new value
-        update_other_Id(CATKEY_TYPE_ID,val)
+        add_other_Id(CATKEY_TYPE_ID, val)
+      else # if there is a current catkey, update the current catkey to the new value
+        update_other_Id(CATKEY_TYPE_ID, val)
       end
 
       val
@@ -88,29 +90,30 @@ module Dor
       if identityMetadata.otherId(type).length > 0
         raise 'There is an existing entry for ' + type + ', consider using update_other_Id().'
       end
+
       identityMetadata.add_otherId(type + ':' + val)
     end
 
     def update_other_Id(type, new_val, val = nil)
       identityMetadata.ng_xml.search('//otherId[@name=\'' + type + '\']')
-        .select { |node| val.nil? || node.content == val }
-        .each { identityMetadata.ng_xml_will_change! }
-        .each  { |node| node.content = new_val }
-        .any?
+                      .select { |node| val.nil? || node.content == val }
+                      .each { identityMetadata.ng_xml_will_change! }
+                      .each { |node| node.content = new_val }
+                      .any?
     end
 
     def remove_other_Id(type, val = nil)
       identityMetadata.ng_xml.search('//otherId[@name=\'' + type + '\']')
-        .select { |node| val.nil? || node.content == val }
-        .each { identityMetadata.ng_xml_will_change! }
-        .each(&:remove)
-        .any?
+                      .select { |node| val.nil? || node.content == val }
+                      .each { identityMetadata.ng_xml_will_change! }
+                      .each(&:remove)
+                      .any?
     end
 
     # turns a tag string into an array with one element per tag part.
     # split on ":", disregard leading and trailing whitespace on tokens.
     def split_tag_to_arr(tag_str)
-      tag_str.split(':').map {|str| str.strip}
+      tag_str.split(':').map { |str| str.strip }
     end
 
     # turn a tag array back into a tag string with a standard format
@@ -136,6 +139,7 @@ module Dor
       if dupe_existing_tag
         raise "An existing tag (#{dupe_existing_tag}) is the same, consider using update_tag?"
       end
+
       normalized_tag
     end
 
@@ -147,9 +151,10 @@ module Dor
       if tag_arr.length < 2
         raise ArgumentError, "Invalid tag structure: tag '#{tag_str}' must have at least 2 elements"
       end
-      if tag_arr.detect {|str| str.empty?}
+      if tag_arr.detect { |str| str.empty? }
         raise ArgumentError, "Invalid tag structure: tag '#{tag_str}' contains empty elements"
       end
+
       tag_arr
     end
 
@@ -164,25 +169,19 @@ module Dor
     def remove_tag(tag)
       normtag = normalize_tag(tag)
       identityMetadata.ng_xml.search('//tag')
-        .select { |node| normalize_tag(node.content) == normtag }
-        .each { identityMetadata.ng_xml_will_change! }
-        .each(&:remove)
-        .any?
+                      .select { |node| normalize_tag(node.content) == normtag }
+                      .each { identityMetadata.ng_xml_will_change! }
+                      .each(&:remove)
+                      .any?
     end
 
     def update_tag(old_tag, new_tag)
       normtag = normalize_tag(old_tag)
       identityMetadata.ng_xml.search('//tag')
-        .select { |node| normalize_tag(node.content) == normtag }
-        .each { identityMetadata.ng_xml_will_change! }
-        .each  { |node| node.content = normalize_tag(new_tag)  }
-        .any?
-    end
-
-    def get_related_obj_display_title(related_obj, default_title)
-      return default_title unless related_obj
-
-      related_obj.full_title || default_title
+                      .select { |node| normalize_tag(node.content) == normtag }
+                      .each { identityMetadata.ng_xml_will_change! }
+                      .each { |node| node.content = normalize_tag(new_tag) }
+                      .any?
     end
 
     # a regex that can be used to identify the last part of a druid (e.g. oo000oo0001)
@@ -199,9 +198,9 @@ module Dor
 
     # Since purl does not use the druid: prefix but much of dor does, use this function to strip the druid: if needed
     # @return [String] the druid sans the druid: or if there was no druid: prefix, the entire string you passed
-    def remove_druid_prefix(druid=id)
-      result=druid.match(/#{pid_regex}/)
-      result.nil? ? druid : result[0]  # if no matches, return the string passed in, otherwise return the match
+    def remove_druid_prefix(druid = id)
+      result = druid.match(/#{pid_regex}/)
+      result.nil? ? druid : result[0] # if no matches, return the string passed in, otherwise return the match
     end
 
     # Override ActiveFedora::Core#adapt_to_cmodel (used with associations, among other places) to

data/lib/dor/models/concerns/itemizable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'fileutils'
 require 'uri'
 
@@ -9,13 +11,14 @@ module Dor
       has_metadata :name => 'contentMetadata', :type => Dor::ContentMetadataDS, :label => 'Content Metadata', :control_group => 'M'
     end
 
-    DIFF_FILENAME = 'cm_inv_diff'.freeze
+    DIFF_FILENAME = 'cm_inv_diff'
 
     # Deletes all cm_inv_diff files in the workspace for the Item
     def clear_diff_cache
       if Dor::Config.stacks.local_workspace_root.nil?
         raise ArgumentError, 'Missing Dor::Config.stacks.local_workspace_root'
       end
+
       druid = DruidTools::Druid.new(pid, Dor::Config.stacks.local_workspace_root)
       diff_pattern = File.join(druid.temp_dir, DIFF_FILENAME + '.*')
       FileUtils.rm_f Dir.glob(diff_pattern)