dor-services 4.22.3 → 4.22.4

data/lib/dor/models/versionable.rb

@@ -63,7 +63,7 @@ module Dor
     # @option opts [Boolean] :start_accesion set to true if you want accessioning to start (default), false otherwise
     # @raise [Dor::Exception] if the object hasn't been opened for versioning, or if accessionWF has
     #   already been instantiated or the current version is missing a tag or description
-    def close_version(opts={})
+    def close_version(opts = {})
       unless(opts.empty?)
         datastreams['versionMetadata'].update_current_version opts
         datastreams['versionMetadata'].save
@@ -84,7 +84,7 @@ module Dor
 
     # @return [Boolean] true if the object is in a state that allows it to be modified. 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::WorkflowService.get_lifecycle('dor', pid, 'submitted' ) and not new_version_open? and not Dor::WorkflowService.get_workflow_status('dor', pid, 'accessionWF', 'sdr-ingest-transfer')=='hold'
+      if Dor::WorkflowService.get_lifecycle('dor', pid, 'submitted' ) && !new_version_open? && Dor::WorkflowService.get_workflow_status('dor', pid, 'accessionWF', 'sdr-ingest-transfer') != 'hold'
         false
       else
         true

data/lib/dor/models/workflow_object.rb

@@ -12,7 +12,7 @@ module Dor
     has_metadata :name => "workflowDefinition", :type => Dor::WorkflowDefinitionDs, :label => 'Workflow Definition'
 
     def self.find_by_name(name, opts = {})
-      Dor.find_all(%{objectType_t:"#{self.object_type}" workflow_name_s:"#{name}"}, opts).first
+      Dor.find_all(%{objectType_t:"#{object_type}" workflow_name_s:"#{name}"}, opts).first
     end
 
     # Searches for the workflow definition object in DOR, then
@@ -22,7 +22,7 @@ module Dor
     # @return [String] the initial workflow xml
     def self.initial_workflow(name)
       return @@xml_cache[name] if @@xml_cache.include?(name)
-      self.find_and_cache_workflow_xml_and_repo name
+      find_and_cache_workflow_xml_and_repo name
       @@xml_cache[name]
     end
 
@@ -32,7 +32,7 @@ module Dor
     # @return [String] the initial workflow xml
     def self.initial_repo(name)
       return @@repo_cache[name] if @@repo_cache.include?(name)
-      self.find_and_cache_workflow_xml_and_repo name
+      find_and_cache_workflow_xml_and_repo name
       @@repo_cache[name]
     end
 
@@ -41,7 +41,7 @@ module Dor
     end
 
     def graph(*args)
-      self.definition.graph *args
+      definition.graph *args
     end
 
     def to_solr(solr_doc = {}, *args)

data/lib/dor/services/cleanup_reset_service.rb

@@ -4,27 +4,27 @@ 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)
-      last_version = get_druid_last_version(druid) 
+      last_version = get_druid_last_version(druid)
       cleanup_reset_workspace_content(druid, last_version, Config.cleanup.local_workspace_root)
       cleanup_assembly_content(druid, Config.cleanup.local_assembly_root)
       cleanup_reset_export(druid, last_version)
     end
-    
+
     def self.get_druid_last_version(druid)
       druid_obj = Dor::Item.find(druid)
       last_version = druid_obj.current_version.to_i
-      
+
       #if the current version is still open, avoid this versioned directory
-      if Dor::WorkflowService.get_lifecycle('dor', druid, 'accessioned').nil? then 
-        last_version = last_version - 1 
+      if Dor::WorkflowService.get_lifecycle('dor', druid, 'accessioned').nil? then
+        last_version -= 1
       end
-      return last_version
+      last_version
     end
-    
+
     # @param [String] druid The identifier for the object whose reset data is to be removed
     # @param [String] base The base directory to delete from
     # @param [Integer] last_version The last version that the data should be removed until version 1
@@ -32,28 +32,28 @@ module Dor
     def self.cleanup_reset_workspace_content(druid,last_version, base)
       base_druid = DruidTools::Druid.new(druid, base)
       base_druid_tree = base_druid.pathname.to_s
-      #if it is truncated tree /aa/111/aaa/1111/content, 
+      #if it is truncated tree /aa/111/aaa/1111/content,
       #we should follow the regular cleanup technique
 
       reset_directories = get_reset_dir_list(last_version, base_druid_tree)
-      reset_directories.each do |path| 
+      reset_directories.each do |path|
         FileUtils.rm_rf(path)
       end
       base_druid.prune_ancestors(base_druid.pathname.parent)
     end
-    
-    
+
+
     # @param [String] druid The identifier for the object whose reset data is to be removed
     # @param [String] base The base directory to delete from
     # @param [Integer] last_version The last version that the data should be removed until version 1
     # @return [void] prepares a list of reset directories that should be removed
     def self.get_reset_dir_list(last_version, base_druid_tree)
-      reset_directories = []    
-      for i in 1..last_version 
+      reset_directories = []
+      for i in 1..last_version
         reset_path = "#{base_druid_tree}_v#{i}"
-        reset_directories.append(reset_path) if File.exists?(reset_path) 
+        reset_directories.append(reset_path) if File.exists?(reset_path)
       end
-      return reset_directories      
+      reset_directories
     end
 
     # @param [String] druid The identifier for the object whose reset bags data is to be removed
@@ -61,40 +61,40 @@ module Dor
     def self.cleanup_reset_export(druid, last_version)
       id = druid.split(':').last
       base_bag_directory = File.join(Config.cleanup.local_export_home, id)
-      
+
       bag_dir_list = get_reset_bag_dir_list(last_version, base_bag_directory)
-      bag_dir_list.each do |bag_dir| 
+      bag_dir_list.each do |bag_dir|
         Pathname(bag_dir).rmtree
       end
-      
+
       bag_tar_list = get_reset_bag_tar_list(last_version, base_bag_directory)
-      bag_tar_list.each do |bag_tar| 
+      bag_tar_list.each do |bag_tar|
         Pathname(bag_tar).rmtree
       end
     end
-    
+
     # @param [Integer] last_version The last version that the data should be removed until version 1
     # @param [String] base_bag_directory The base bag directory including the export home and druid id
     # @return [void] prepares a list of reset bag directories that should be removed
     def self.get_reset_bag_dir_list(last_version, base_bag_directory)
-      reset_bags = []    
+      reset_bags = []
       for i in 1..last_version do
         reset_path = "#{base_bag_directory}_v#{i}"
-        reset_bags.append(reset_path) if File.exists?(reset_path) 
+        reset_bags.append(reset_path) if File.exists?(reset_path)
       end
-      return reset_bags      
+      reset_bags
     end
 
     # @param [String] base_bag_directory The base bag directory including the export home and druid id
     # @param [Integer] last_version The last version that the data should be removed until version 1
     # @return [void] prepares a list of reset bag tars that should be removed
     def self.get_reset_bag_tar_list(last_version, base_bag_directory)
-      reset_bags = []    
+      reset_bags = []
       for i in 1..last_version do
         reset_path = "#{base_bag_directory}_v#{i}.tar"
-        reset_bags.append(reset_path)  if File.exists?(reset_path) 
+        reset_bags.append(reset_path)  if File.exists?(reset_path)
       end
-      return reset_bags      
+      reset_bags
     end
 
     # @param [String] druid The identifier for the object whose data is to be removed

data/lib/dor/services/cleanup_service.rb

@@ -24,15 +24,15 @@ module Dor
     def self.cleanup_workspace_content(druid, base)
       DruidTools::Druid.new(druid, base).prune!
     end
-    
+
     # @param [String] druid The identifier for the object whose data is to be removed
     # @return [void] remove copy of the data that was exported to preservation core
     def self.cleanup_export(druid)
       id = druid.split(':').last
       bag_dir = File.join(Config.cleanup.local_export_home, id)
-      self.remove_branch(bag_dir)
+      remove_branch(bag_dir)
       tarfile = "#{bag_dir}.tar"
-      self.remove_branch(tarfile)
+      remove_branch(tarfile)
     end
 
     # @param [Pathname,String] pathname The full path of the branch to be removed
@@ -83,9 +83,6 @@ module Dor
       Dor::SearchService.solr.delete_by_id(pid)
       Dor::SearchService.solr.commit
     end
-  end 
+  end
 
 end
-
-
-    

data/lib/dor/services/digital_stacks_service.rb

@@ -14,7 +14,7 @@ module Dor
         subset.files.each do |moab_file| # {Moab::FileInstanceDifference}
           moab_signature = moab_file.signatures.first # {Moab::FileSignature}
           file_pathname = stacks_object_pathname.join(moab_file.basis_path)
-          self.delete_file(file_pathname, moab_signature)
+          delete_file(file_pathname, moab_signature)
         end
       end
     end
@@ -24,14 +24,14 @@ module Dor
     # @param [Moab::FileSignature] moab_signature The fixity values of the file
     # @return [Boolean] true if file deleted, false otherwise
     def self.delete_file(file_pathname, moab_signature)
-      if file_pathname.exist? and (file_pathname.size == moab_signature.size)
+      if file_pathname.exist? && (file_pathname.size == moab_signature.size)
         file_signature = Moab::FileSignature.new.signature_from_file(file_pathname)
         if (file_signature == moab_signature)
           file_pathname.delete
           return true
         end
       end
-      return false
+      false
     end
 
     # Rename files from stacks that have change type 'renamed' using an intermediate temp filename.
@@ -46,7 +46,7 @@ module Dor
         moab_signature = moab_file.signatures.first # {Moab::FileSignature}
         original_pathname = stacks_object_pathname.join(moab_file.basis_path)
         temp_pathname = stacks_object_pathname.join(moab_signature.checksums.values.last)
-        self.rename_file(original_pathname, temp_pathname, moab_signature)
+        rename_file(original_pathname, temp_pathname, moab_signature)
       end
 
       # 2nd Pass - rename files from checksum-based name to new name
@@ -54,7 +54,7 @@ module Dor
         moab_signature = moab_file.signatures.first # {Moab::FileSignature}
         temp_pathname = stacks_object_pathname.join(moab_signature.checksums.values.last)
         new_pathname = stacks_object_pathname.join(moab_file.other_path)
-        self.rename_file(temp_pathname, new_pathname, moab_signature)
+        rename_file(temp_pathname, new_pathname, moab_signature)
       end
 
     end
@@ -65,7 +65,7 @@ module Dor
     # @param [Moab::FileSignature] moab_signature The fixity values of the file
     # @return [Boolean] true if file renamed, false otherwise
     def self.rename_file(old_pathname, new_pathname, moab_signature)
-      if old_pathname.exist? and (old_pathname.size == moab_signature.size)
+      if old_pathname.exist? && (old_pathname.size == moab_signature.size)
         file_signature = Moab::FileSignature.new.signature_from_file(old_pathname)
         if (file_signature == moab_signature)
           new_pathname.parent.mkpath
@@ -73,7 +73,7 @@ module Dor
           return true
         end
       end
-      return false
+      false
     end
 
     # Add files to stacks that have change type 'added', 'copyadded' or 'modified'.
@@ -82,14 +82,14 @@ 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|
+      [:added, :copyadded, :modified].each do |change_type|
         subset = content_diff.subset(change_type) # {Moab::FileGroupDifferenceSubset
         subset.files.each do |moab_file| # {Moab::FileInstanceDifference}
           moab_signature = moab_file.signatures.last # {Moab::FileSignature}
           filename = (change_type == :modified) ? moab_file.basis_path : moab_file.other_path
           workspace_pathname = workspace_content_pathname.join(filename)
           stacks_pathname = stacks_object_pathname.join(filename)
-          self.copy_file(workspace_pathname, stacks_pathname, moab_signature)
+          copy_file(workspace_pathname, stacks_pathname, moab_signature)
         end
       end
       true
@@ -110,7 +110,7 @@ module Dor
         FileUtils.cp workspace_pathname.to_s, stacks_pathname.to_s
         return true
       end
-      return false
+      false
     end
 
     ### depricated ???

data/lib/dor/services/merge_service.rb

@@ -27,7 +27,7 @@ module Dor
       unless @primary.allows_modification?
         raise Dor::Exception.new "Primary object is not editable: #{@primary.pid}"
       end
-      if ( non_editable = (@secondary_objs.detect {|obj| ! obj.allows_modification? } ))
+      if ( non_editable = (@secondary_objs.detect {|obj| !obj.allows_modification? } ))
         raise Dor::Exception.new "Secondary object is not editable: #{non_editable.pid}"
       end
     end

data/lib/dor/services/metadata_handlers/mdtoolkit_handler.rb

@@ -26,7 +26,7 @@ handler = Class.new do
     end
     case xml.root.name
     when 'msDesc' then xml.xpath('/msDesc/msIdentifier/collection').text
-    when 'mods'   then 
+    when 'mods'   then
       xml.root.add_namespace_definition('mods','http://www.loc.gov/mods/v3')
       xml.xpath('/mods:mods/mods:titleInfo[1]').xpath('mods:title|mods:nonSort').collect { |n| n.text }.join(' ').strip
     end
@@ -37,4 +37,4 @@ handler = Class.new do
   end
 end
 
-Dor::MetadataService.register(handler)
+Dor::MetadataService.register(handler)

data/lib/dor/services/metadata_service.rb

@@ -3,27 +3,27 @@ require 'cache'
 module Dor
 
   class MetadataError < Exception ; end
-  
+
 #  class MetadataHandler
-#  
+#
 #    def fetch(prefix, identifier)
 #      ### Return metadata for prefix/identifier combo
 #    end
-#    
+#
 #    def label(metadata)
 #      ### Return a Fedora-compatible label from the metadata format returned by #fetch
 #    end
-#    
+#
 #  end
-  
+
   class MetadataService
-    
+
     class << self
       @@cache = Cache.new(nil, nil, 250, 300)
-      
+
       def register(handler_class)
         ['fetch', 'label', 'prefixes'].each do |method|
-          unless handler_class.instance_methods.include?(method) or handler_class.instance_methods.include?(method.to_sym) 
+          unless handler_class.instance_methods.include?(method) or handler_class.instance_methods.include?(method.to_sym)
             raise TypeError, "Metadata handlers must define ##{method.to_s}"
           end
         end
@@ -31,23 +31,23 @@ module Dor
         handler.prefixes.each do |prefix|
           handlers[prefix.to_sym] = handler
         end
-        return handler
+        handler
       end
-      
+
       def known_prefixes
-        return handlers.keys
+        handlers.keys
       end
-      
+
       def can_resolve?(identifier)
         (prefix, identifier) = identifier.split(/:/,2)
         handlers.keys.include?(prefix.to_sym)
       end
-      
+
       # TODO: Return a prioritized list
       def resolvable(identifiers)
         identifiers.select { |identifier| self.can_resolve?(identifier) }
       end
-      
+
       def fetch(identifier)
         @@cache.fetch(identifier) do
           (prefix, identifier) = identifier.split(/:/,2)
@@ -61,24 +61,24 @@ module Dor
         handler = handler_for(prefix)
         handler.label(handler.fetch(prefix, identifier))
       end
-      
+
       def handler_for(prefix)
         handler = handlers[prefix.to_sym]
         if handler.nil?
           raise MetadataError, "Unkown metadata prefix: #{prefix}"
         end
-        return handler
+        handler
       end
-      
+
       private
       def handlers
         @handlers ||= {}
       end
-      
+
     end
-    
+
   end
-  
+
 end
 
 Dir[File.join(File.dirname(__FILE__),'metadata_handlers','*.rb')].each { |handler_file|

data/lib/dor/services/registration_service.rb

@@ -1,23 +1,23 @@
 require 'uuidtools'
 
 module Dor
-  
+
   class RegistrationService
-    
+
     class << self
       def register_object(params = {})
         Dor.ensure_models_loaded!
         [:object_type, :label].each do |required_param|
-          raise Dor::ParameterError, "#{required_param.inspect} must be specified in call to #{self.name}.register_object" unless params[required_param]
+          raise Dor::ParameterError, "#{required_param.inspect} must be specified in call to #{name}.register_object" unless params[required_param]
         end
         metadata_source=params[:metadata_source]
-        if params[:label].length<1 and (metadata_source=='label' || metadata_source=='none')
-          raise Dor::ParameterError, "label cannot be empty to call #{self.name}.register_object"
+        if params[:label].length<1 && (metadata_source=='label' || metadata_source=='none')
+          raise Dor::ParameterError, "label cannot be empty to call #{name}.register_object"
         end
-        object_type = params[:object_type]        
+        object_type = params[:object_type]
         item_class = Dor.registered_classes[object_type]
         raise Dor::ParameterError, "Unknown item type: '#{object_type}'" if item_class.nil?
-        
+
         content_model = params[:content_model]
         admin_policy = params[:admin_policy]
         label = params[:label]
@@ -37,12 +37,12 @@ module Dor
         else
           pid = Dor::SuriService.mint_id
         end
-        
+
         rights=nil
         if params[:rights]
           rights=params[:rights]
-          if not ['world','stanford','dark','default','none'].include? rights
-            raise Dor::ParameterError,"Unknown rights setting" + rights + "when calling #{self.name}.register_object"
+          unless ['world','stanford','dark','default','none'].include? rights
+            raise Dor::ParameterError,"Unknown rights setting" + rights + "when calling #{name}.register_object"
           end
         end
 
@@ -54,17 +54,17 @@ module Dor
           end
         end
 
-        if (other_ids.has_key?(:uuid) or other_ids.has_key?('uuid')) == false
+        if (other_ids.has_key?(:uuid) || other_ids.has_key?('uuid')) == false
           other_ids[:uuid] = UUIDTools::UUID.timestamp_create.to_s
         end
         short_label=label
         if label.length>254
           short_label=label[0,254]
         end
-        
+
         apo_object = Dor.find(admin_policy, :lightweight => true)
         adm_xml = apo_object.administrativeMetadata.ng_xml
-        
+
         new_item = item_class.new(:pid => pid)
         new_item.label = short_label
         idmd = new_item.identityMetadata
@@ -76,7 +76,7 @@ module Dor
         other_ids.each_pair { |name,value| idmd.add_otherId("#{name}:#{value}") }
         tags.each { |tag| idmd.add_value(:tag, tag) }
         new_item.admin_policy_object = apo_object
-        
+
         adm_xml.xpath('/administrativeMetadata/relationships/*').each do |rel|
           short_predicate = ActiveFedora::RelsExtDatastream.short_predicate rel.namespace.href+rel.name
           if short_predicate.nil?
@@ -89,7 +89,7 @@ module Dor
         if collection
           new_item.add_collection(collection)
         end
-        if(rights and ['item','collection'].include? object_type  )
+        if(rights && ['item','collection'].include?(object_type)  )
           rights_xml=apo_object.defaultObjectRights.ng_xml
           new_item.datastreams['rightsMetadata'].content=rights_xml.to_s
           new_item.set_read_rights(rights)
@@ -104,13 +104,13 @@ module Dor
               }
             }
           }
-      
+
       ds.content=builder.to_xml
-         
+
       end
-        
+
         workflow_priority = params[:workflow_priority] ? params[:workflow_priority].to_i : 0
-        
+
         Array(params[:seed_datastream]).each { |datastream_name| new_item.build_datastream(datastream_name) }
         Array(params[:initiate_workflow]).each { |workflow_id| new_item.initialize_workflow(workflow_id, !new_item.new_object?, workflow_priority)}
 
@@ -121,9 +121,9 @@ module Dor
         rescue StandardError => e
           Dor.logger.warn "Dor::RegistrationService.register_object failed to update solr index for #{new_item.pid}: #<#{e.class.name}: #{e.message}>"
         end
-        return(new_item)
+        (new_item)
       end
-      
+
       def create_from_request(params)
         other_ids = Array(params[:other_id]).collect do |id|
           if id =~ /^symphony:(.+)$/
@@ -132,14 +132,14 @@ module Dor
             id
           end
         end
-    
+
         if params[:label] == ':auto'
           params.delete(:label)
           params.delete('label')
           metadata_id = Dor::MetadataService.resolvable(other_ids).first
           params[:label] = Dor::MetadataService.label_for(metadata_id)
         end
-          
+
         dor_params = {
           :pid                => params[:pid],
           :admin_policy       => params[:admin_policy],
@@ -158,13 +158,13 @@ module Dor
           :workflow_priority  => params[:workflow_priority]
         }
         dor_params.delete_if { |k,v| v.nil? }
-    
-        dor_obj = self.register_object(dor_params)
+
+        dor_obj = register_object(dor_params)
         pid = dor_obj.pid
         location = URI.parse(Dor::Config.fedora.safeurl.sub(/\/*$/,'/')).merge("objects/#{pid}").to_s
         reg_response = dor_params.dup.merge({ :location => location, :pid => pid })
       end
-      
+
       private
       def ids_to_hash(ids)
         if ids.nil?
@@ -174,7 +174,7 @@ module Dor
         end
       end
     end
-    
+
   end
 
 end