dor-services 6.0.0 → 6.0.1

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'tmpdir'
 
 module Dor

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'equivalent-xml'
 
 module Dor
@@ -25,15 +27,15 @@ module Dor
 
     # milestones from accessioning and the order they happen in
     STEPS = {
-      'registered'  => 1,
-      'submitted'   => 2,
-      'described'   => 3,
-      'published'   => 4,
-      'deposited'   => 5,
+      'registered' => 1,
+      'submitted' => 2,
+      'described' => 3,
+      'published' => 4,
+      'deposited' => 5,
       'accessioned' => 6,
-      'indexed'     => 7,
-      'shelved'     => 8,
-      'opened'      => 9
+      'indexed' => 7,
+      'shelved' => 8,
+      'opened' => 9
     }.freeze
 
     # This is a work-around for some strange logic in ActiveFedora that
@@ -42,12 +44,14 @@ module Dor
     def set_workflows_datastream_location
       return if self.respond_to?(:inner_object) && inner_object.is_a?(ActiveFedora::SolrDigitalObject)
       return unless workflows.new?
+
       workflows.mimeType   = 'application/xml'
       workflows.dsLocation = File.join(Dor::Config.workflow.url, "dor/objects/#{pid}/workflows")
     end
 
     def empty_datastream?(datastream)
       return true if datastream.new?
+
       if datastream.class.respond_to?(:xml_template)
         datastream.content.to_s.empty? || EquivalentXml.equivalent?(datastream.content, datastream.class.xml_template)
       else
@@ -90,6 +94,7 @@ module Dor
       end
       # Check for success.
       raise "Required datastream #{datastream} could not be populated!" if is_required && empty_datastream?(ds)
+
       ds
     end
 
@@ -125,11 +130,12 @@ module Dor
         m_name = m[:milestone]
         m_time = m[:at].utc.xmlschema
         next unless STEPS.keys.include?(m_name) && (!status_time || m_time > status_time)
+
         status_code = STEPS[m_name]
         status_time = m_time
       end
 
-      {:current_version => current_version, :status_code => status_code, :status_time => status_time}
+      { :current_version => current_version, :status_code => status_code, :status_time => status_time }
     end
 
     # @param [Boolean] include_time

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'dor/datastreams/content_metadata_ds'
 require 'fileutils'
 
@@ -20,8 +22,9 @@ module Dor
     def encoded_thumb
       thumb_image = thumb # store the result locally, so we don't have to compute each time we use it below
       return unless thumb_image
-      thumb_druid=thumb_image.split('/').first # the druid (before the first slash)
-      thumb_filename=thumb_image.split(/#{pid_regex}[\/]/).last # everything after the druid
+
+      thumb_druid = thumb_image.split('/').first # the druid (before the first slash)
+      thumb_filename = thumb_image.split(/#{pid_regex}[\/]/).last # everything after the druid
       "#{thumb_druid}%2F#{ERB::Util.url_encode(thumb_filename)}"
     end
     deprecation_deprecate :encoded_thumb
@@ -30,7 +33,8 @@ module Dor
     # @return [String] fully qualified image URL for the computed thumbnail, e.g. https://stacks.stanford.edu/image/iiif/oo000oo0001%2Ffilenamewith%20space/full
     def thumb_url
       return unless encoded_thumb
-      thumb_basename=File.basename(encoded_thumb, File.extname(encoded_thumb)) # strip the extension for URL generation
+
+      thumb_basename = File.basename(encoded_thumb, File.extname(encoded_thumb)) # strip the extension for URL generation
       "https://#{Dor::Config.stacks.host}/image/iiif/#{thumb_basename}/full/!400,400/0/default.jpg"
     end
     deprecation_deprecate :thumb_url
@@ -60,7 +64,7 @@ module Dor
     def publish_metadata
       rights = datastreams['rightsMetadata'].ng_xml.clone.remove_namespaces!
       if rights.at_xpath("//rightsMetadata/access[@type='discover']/machine/world")
-        dc_xml = generate_dublin_core.to_xml {|config| config.no_declaration}
+        dc_xml = generate_dublin_core.to_xml { |config| config.no_declaration }
         DigitalStacksService.transfer_to_document_store(pid, dc_xml, 'dc')
         %w(identityMetadata contentMetadata rightsMetadata).each do |stream|
           DigitalStacksService.transfer_to_document_store(pid, datastreams[stream].content.to_s, stream) if datastreams[stream]
@@ -111,6 +115,7 @@ module Dor
     # When publishing a PURL, we notify purl-fetcher of changes.
     def publish_delete_on_success
       return unless Dor::Config.purl_services.url
+
       id = pid.gsub(/^druid:/, '')
 
       purl_services = Dor::Config.purl_services.rest_client

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'open-uri'
 require 'retries'
 
@@ -31,21 +33,22 @@ module Dor
       # Get the most recent self tag for all targets and retain their result since most recent self always trumps any other non self tags
       latest_self_tags = get_newest_release_tag get_self_release_tags(release_nodes)
       latest_self_tags.each do |key, payload|
-        released_hash[key] = {'release' => payload['release']}
+        released_hash[key] = { 'release' => payload['release'] }
       end
 
       # With Self Tags resolved we now need to deal with tags on all sets this object is part of.
       # Get all release tags on the item and strip out the what = self ones, we've already processed all the self tags on this item.
       # This will be where we store all tags that apply, regardless of their timestamp:
       potential_applicable_release_tags = get_tags_for_what_value(get_release_tags_for_item_and_all_governing_sets, 'collection')
-      administrative_tags = tags  # Get admin tags once here and pass them down
+      administrative_tags = tags # Get admin tags once here and pass them down
 
       # We now have the keys for all potential releases, we need to check the tags: the most recent timestamp with an explicit true or false wins.
       # In a nil case, the lack of an explicit false tag we do nothing.
-      (potential_applicable_release_tags.keys - released_hash.keys).each do |key|  # don't bother checking if already added to the release hash, they were added due to a self tag so that has won
+      (potential_applicable_release_tags.keys - released_hash.keys).each do |key| # don't bother checking if already added to the release hash, they were added due to a self tag so that has won
         latest_tag = latest_applicable_release_tag_in_array(potential_applicable_release_tags[key], administrative_tags)
         next if latest_tag.nil? # Otherwise, we have a valid tag, record it
-        released_hash[key] = {'release' => latest_tag['release']}
+
+        released_hash[key] = { 'release' => latest_tag['release'] }
       end
 
       # See what the application is currently released for on Purl.  If released in purl but not listed here, it needs to be added as a false
@@ -65,7 +68,8 @@ module Dor
     def get_release_tags_for_item_and_all_governing_sets
       return_tags = release_nodes || {}
       collections.each do |collection|
-        next if collection.id == id  # recursive, so parents of parents are found, but we need to avoid an infinite loop if the collection references itself (i.e. bad data)
+        next if collection.id == id # recursive, so parents of parents are found, but we need to avoid an infinite loop if the collection references itself (i.e. bad data)
+
         return_tags = combine_two_release_tag_hashes(return_tags, collection.get_release_tags_for_item_and_all_governing_sets)
       end
       return_tags
@@ -90,7 +94,7 @@ module Dor
     def get_tags_for_what_value(tags, what_target)
       return_hash = {}
       tags.keys.each do |key|
-        self_tags = tags[key].select {|tag| tag['what'].casecmp(what_target) == 0}
+        self_tags = tags[key].select { |tag| tag['what'].casecmp(what_target) == 0 }
         return_hash[key] = self_tags if self_tags.size > 0
       end
       return_hash
@@ -100,7 +104,7 @@ module Dor
     # @param tags [Hash] a hash of tags obtained via Dor::Item.release_tags or matching format
     # @return [Hash] a hash of latest tags for each to value
     def get_newest_release_tag(tags)
-      Hash[tags.map {|key, val| [key, newest_release_tag_in_an_array(val)]}]
+      Hash[tags.map { |key, val| [key, newest_release_tag_in_an_array(val)] }]
     end
 
     # Takes an array of release tags and returns the most recent one
@@ -121,6 +125,7 @@ module Dor
     def does_release_tag_apply(release_tag, admin_tags = false)
       # Is the tag global or restricted
       return true if release_tag['tag'].nil?  # no specific tag specificied means this tag is global to all members of the collection
+
       admin_tags = tags unless admin_tags     # We use false instead of [], since an item can have no admin_tags at which point we'd be passing this var as [] and would not attempt to retrieve it
       admin_tags.include?(release_tag['tag'])
     end
@@ -138,6 +143,7 @@ module Dor
       release_tags.slice!(release_tags.index(newest_tag))
 
       return latest_applicable_release_tag_in_array(release_tags, admin_tags) if release_tags.size > 0 # Try again after dropping the inapplicable
+
       nil # We're out of tags, no applicable ones
     end
 
@@ -186,6 +192,7 @@ module Dor
     # @return [Boolean] Returns true if no errors found
     def valid_release_attributes_and_tag(tag, attrs = {})
       raise ArgumentError, ':when is not iso8601' if attrs[:when].match('\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z').nil?
+
       [:who, :to, :what].each do |check_attr|
         raise ArgumentError, "#{check_attr} not supplied as a String" if attrs[check_attr].class != String
       end
@@ -196,6 +203,7 @@ module Dor
       end
       raise ArgumentError, ':what must be self or collection' unless what_correct
       raise ArgumentError, 'the value set for this tag is not a boolean' if !!tag != tag # rubocop:disable Style/DoubleNegation
+
       true
     end
 
@@ -211,7 +219,7 @@ module Dor
     # @example
     #  item.add_release_node(true,{:what=>'self',:to=>'Searchworks',:who=>'petucket'})
     def add_release_node(release, attrs = {})
-      allowed_release_attributes=[:what,:to,:who,:when] # any other release attributes sent in will be rejected and not stored
+      allowed_release_attributes = [:what, :to, :who, :when] # any other release attributes sent in will be rejected and not stored
       identity_metadata_ds = identityMetadata
       attrs.delete_if { |key, value| !allowed_release_attributes.include?(key) }
       attrs[:when] = Time.now.utc.iso8601 if attrs[:when].nil? # add the timestamp
@@ -227,11 +235,13 @@ module Dor
     # @return [Boolean] Returns true if no errors found
     def valid_release_attributes(tag, attrs = {})
       raise ArgumentError, ':when is not iso8601' if attrs[:when].match('\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z').nil?
+
       [:who, :to, :what].each do |check_attr|
         raise ArgumentError, "#{check_attr} not supplied as a String" if attrs[check_attr].class != String
       end
       raise ArgumentError, ':what must be self or collection' unless %w(self collection).include? attrs[:what]
-      raise ArgumentError, 'the value set for this tag is not a boolean' unless [true,false].include? tag
+      raise ArgumentError, 'the value set for this tag is not a boolean' unless [true, false].include? tag
+
       true
     end
 
@@ -283,7 +293,7 @@ module Dor
     def get_release_tags_from_purl_xml(doc)
       nodes = doc.xpath('//html/body/publicobject/releasedata').children
       # We only want the nodes with a name that isn't text
-      nodes.reject {|n| n.name.nil? || n.name.casecmp('text') == 0 }.map {|n| n.attr('to')}.uniq
+      nodes.reject { |n| n.name.nil? || n.name.casecmp('text') == 0 }.map { |n| n.attr('to') }.uniq
     end
 
     # Pull all release nodes from the public xml obtained via the purl query
@@ -300,7 +310,7 @@ module Dor
       tags_currently_in_purl = get_release_tags_from_purl
       missing_tags = tags_currently_in_purl.map(&:downcase) - new_tags.keys.map(&:downcase)
       missing_tags.each do |missing_tag|
-        new_tags[missing_tag.capitalize] = {'release' => false}
+        new_tags[missing_tag.capitalize] = { 'release' => false }
       end
       new_tags
     end

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

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

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'moab/stanford'
 
 module Dor
@@ -35,8 +37,9 @@ module Dor
     # @return [Pathname] The location of the object's content files in the workspace area
     def workspace_content_dir(content_diff, workspace_druid)
       deltas = content_diff.file_deltas
-      filelist = deltas[:modified] + deltas[:added] + deltas[:copyadded].collect {|old, new| new}
+      filelist = deltas[:modified] + deltas[:added] + deltas[:copyadded].collect { |old, new| new }
       return nil if filelist.empty?
+
       content_pathname = Pathname(workspace_druid.find_filelist_parent('content', filelist))
       content_pathname
     end
@@ -47,7 +50,8 @@ module Dor
       contentMetadataDS = datastreams['contentMetadata']
       unless contentMetadataDS.nil? || contentMetadataDS.stacks.length == 0
         stacks_location = contentMetadataDS.stacks[0]
-        return stacks_location if stacks_location.start_with? '/'  # Absolute stacks path
+        return stacks_location if stacks_location.start_with? '/' # Absolute stacks path
+
         raise 'stacks attribute for item: ' + id + ' contentMetadata should start with /. The current value is ' + stacks_location
       end
       Config.stacks.local_stacks_root # Default stacks

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Dor
   module Versionable
     extend ActiveSupport::Concern
@@ -35,8 +37,9 @@ module Dor
 
       vmd_upd_info = opts[:vers_md_upd_info]
       return unless vmd_upd_info
+
       add_event('open', vmd_upd_info[:opening_user_name], "Version #{vmd_ds.current_version_id} opened")
-      vmd_ds.update_current_version({:description => vmd_upd_info[:description], :significance => vmd_upd_info[:significance].to_sym})
+      vmd_ds.update_current_version({ :description => vmd_upd_info[:description], :significance => vmd_upd_info[:significance].to_sym })
       save
     end
 
@@ -63,12 +66,13 @@ module Dor
       raise Dor::Exception, 'Trying to close version on an object not opened for versioning' unless new_version_open?
       raise Dor::Exception, 'accessionWF already created for versioned object' if Dor::Config.workflow.client.get_active_lifecycle('dor', pid, 'submitted')
 
-      Dor::Config.workflow.client.close_version 'dor', pid, opts.fetch(:start_accession, true)  # Default to creating accessionWF when calling close_version
+      Dor::Config.workflow.client.close_version 'dor', pid, opts.fetch(:start_accession, true) # Default to creating accessionWF when calling close_version
     end
 
     # @return [Boolean] true if 'opened' lifecycle is active, false otherwise
     def new_version_open?
       return true if Dor::Config.workflow.client.get_active_lifecycle('dor', pid, 'opened')
+
       false
     end
 
@@ -76,8 +80,8 @@ module Dor
     #  States that will allow modification are: has not been submitted for accessioning, has an open version or has sdr-ingest set to hold
     def allows_modification?
       if Dor::Config.workflow.client.get_lifecycle('dor', pid, 'submitted') &&
-          !new_version_open? &&
-          Dor::Config.workflow.client.get_workflow_status('dor', pid, 'accessionWF', 'sdr-ingest-transfer') != 'hold'
+         !new_version_open? &&
+         Dor::Config.workflow.client.get_workflow_status('dor', pid, 'accessionWF', 'sdr-ingest-transfer') != 'hold'
         false
       else
         true

data/lib/dor/models/item.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Dor
   class Item < Dor::Abstract
     include Shelvable

data/lib/dor/models/set.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Dor
   class Set < Dor::Abstract
     include Publishable

data/lib/dor/models/workflow_object.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'dor/datastreams/workflow_definition_ds'
 
 module Dor
@@ -26,6 +28,7 @@ module Dor
     # @return [String] the initial workflow xml
     def self.initial_workflow(name)
       return @@xml_cache[name] if @@xml_cache.include?(name)
+
       find_and_cache_workflow_xml_and_repo name
       @@xml_cache[name]
     end
@@ -36,6 +39,7 @@ module Dor
     # @return [String] the initial workflow xml
     def self.initial_repo(name)
       return @@repo_cache[name] if @@repo_cache.include?(name)
+
       find_and_cache_workflow_xml_and_repo name
       @@repo_cache[name]
     end
@@ -57,10 +61,10 @@ module Dor
     def self.find_and_cache_workflow_xml_and_repo(name)
       wobj = find_by_name(name)
       raise "Failed to find workflow via find_by_name('#{name}')" if wobj.nil?
+
       @@repo_cache[name] = wobj.definition.repo
       @@xml_cache[name]  = wobj.generate_initial_workflow
       wobj
     end
-
   end
 end

data/lib/dor/rest_resource_factory.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Creates RestClient::Resources for various connections
 module Dor
   class RestResourceFactory

data/lib/dor/services/cleanup_reset_service.rb

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
+
 require 'pathname'
 
 module Dor
   # Remove all traces of the object's data files from the workspace and export areas
   class CleanupResetService
-
     # @param [String] druid The identifier for the object whose reset data is to be removed
     # @return [void] remove copy of the reset data that was exported to preservation core
     def self.cleanup_by_reset_druid(druid)

data/lib/dor/services/cleanup_service.rb

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
+
 require 'pathname'
 
 module Dor
   # Remove all traces of the object's data files from the workspace and export areas
   class CleanupService
-
     # @param [LyberCore::Robots::WorkItem] dor_item The DOR work item whose workspace should be cleaned up
     # @return [void] Delete all workspace and export entities for the druid
     def self.cleanup(dor_item)

data/lib/dor/services/digital_stacks_service.rb

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
+
 require 'net/ssh'
 require 'net/sftp'
 
 module Dor
   class DigitalStacksService
-
     # Delete files from stacks that have change type 'deleted', 'copydeleted', or 'modified'
     # @param [Pathname] stacks_object_pathname the stacks location of the digital object
     # @param [Moab::FileGroupDifference] content_diff the content file version differences report
@@ -80,6 +81,7 @@ module Dor
     # @param [Moab::FileGroupDifference] content_diff the content file version differences report
     def self.shelve_to_stacks(workspace_content_pathname, stacks_object_pathname, content_diff)
       return false if workspace_content_pathname.nil?
+
       [:added, :copyadded, :modified].each do |change_type|
         subset = content_diff.subset(change_type) # {Moab::FileGroupDifferenceSubset
         subset.files.each do |moab_file| # {Moab::FileInstanceDifference}

data/lib/dor/services/indexing_service.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'benchmark'
 
 module Dor
@@ -38,7 +40,7 @@ module Dor
     def self.reindex_pid_remotely(pid)
       pid = "druid:#{pid}" unless pid =~ /^druid:/
       realtime = Benchmark.realtime do
-        with_retries(max_tries: 3, rescue: [ RestClient::Exception, Errno::ECONNREFUSED ]) do
+        with_retries(max_tries: 3, rescue: [RestClient::Exception, Errno::ECONNREFUSED]) do
           RestClient.post("#{Config.dor_indexing_app.url}/reindex/#{pid}", '')
         end
       end

data/lib/dor/services/merge_service.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
+
 module Dor
   class MergeService
-
     def self.merge_into_primary(primary_druid, secondary_druids, tag, logger = nil)
       # TODO: test the secondary_obj to see if we've processed it already
       merge_service = Dor::MergeService.new primary_druid, secondary_druids, tag, logger
@@ -13,7 +14,7 @@ module Dor
     def initialize(primary_druid, secondary_pids, tag, logger = nil)
       @primary = Dor.find primary_druid
       @secondary_pids = secondary_pids
-      @secondary_objs = secondary_pids.map {|pid|  Dor.find pid }
+      @secondary_objs = secondary_pids.map { |pid| Dor.find pid }
       if logger.nil?
         @logger = Logger.new(STDERR)
       else
@@ -24,7 +25,8 @@ module Dor
 
     def check_objects_editable
       raise Dor::Exception, "Primary object is not editable: #{@primary.pid}" unless @primary.allows_modification?
-      non_editable = @secondary_objs.detect {|obj| !obj.allows_modification? }
+
+      non_editable = @secondary_objs.detect { |obj| !obj.allows_modification? }
       raise Dor::Exception, "Secondary object is not editable: #{non_editable.pid}" if non_editable
     end
 
@@ -48,7 +50,7 @@ module Dor
           primary_resource = primary_cm.at_xpath "//resource[attr[@name = 'mergedFromPid']/text() = '#{secondary.pid}' and
                                                              attr[@name = 'mergedFromResource']/text() = '#{src_resource['id']}' ]"
           sequence = primary_resource['sequence']
-          src_resource.xpath('//file/@id').map {|id| id.value }.each do |file_id|
+          src_resource.xpath('//file/@id').map { |id| id.value }.each do |file_id|
             copy_path = sec_druid.find_content file_id
             new_name = secondary.new_secondary_file_name(file_id, sequence)
             # TODO: verify new_name exists in primary_cm?