dor-services 5.1.1 → 5.2.0

data/lib/dor/models/shelvable.rb

@@ -35,30 +35,26 @@ module Dor
     # @param [Moab::FileGroupDifference] content_diff The differences between the current contentMetadata and the previously ingested version
     # @param [DruidTools::Druid] workspace_druid the location of the object's files in the workspace area
     # @return [Pathname] The location of the object's content files in the workspace area
-    def workspace_content_dir (content_diff, workspace_druid)
+    def workspace_content_dir(content_diff, workspace_druid)
       deltas = content_diff.file_deltas
       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
-    
-    
-    # get the stack location based on the contentMetadata stacks attribute 
+
+    # get the stack location based on the contentMetadata stacks attribute
     # or using the default value from the config file if it doesn't exist
     def get_stacks_location
-      
+
       contentMetadataDS = self.datastreams['contentMetadata']
-      unless contentMetadataDS.nil? or contentMetadataDS.stacks.length == 0
-        stacks_location = contentMetadataDS.stacks[0]        
-        if stacks_location.start_with?"/"  #Absolute stacks path
-          return stacks_location
-        else        
-          raise "stacks attribute for item: "+self.id+ " contentMetadata should start with /. The current value is "+stacks_location
-        end
-      end      
+      unless contentMetadataDS.nil? || contentMetadataDS.stacks.length == 0
+        stacks_location = contentMetadataDS.stacks[0]
+        return stacks_location if stacks_location.start_with? "/"  #Absolute stacks path
+        raise "stacks attribute for item: "+self.id+ " contentMetadata should start with /. The current value is "+stacks_location
+      end
       return Config.stacks.local_stacks_root #Default stacks
-       
+
     end
   end
 end

data/lib/dor/models/upgradable.rb

@@ -1,16 +1,16 @@
 module Dor
   module Upgradable
 
-    # The Upgradable mixin is responsible for making sure all DOR objects, 
-    # concerns, and datastreams know how to upgrade themselves to the latest 
+    # The Upgradable mixin is responsible for making sure all DOR objects,
+    # concerns, and datastreams know how to upgrade themselves to the latest
     # Chimera/DOR content standards.
     #
     # To add a new upgrade:
     # 1) include Dor::Upgradable within whatever model, datastream, or mixin
     #    you want to make upgradable.
     # 2) Add a block to the model, datastream, or mixin as follows:
-    # 
-    #    on_upgrade(v) do |obj| 
+    #
+    #    on_upgrade(v) do |obj|
     #      # Do whatever needs to be done to obj
     #    end
     #
@@ -20,7 +20,7 @@ module Dor
     # The block can either be defined on the model itself, or in a file
     # in the dor/migrations/[model] directory. See Dor::Identifiable and
     # dor/migrations/identifiable/* for an example.
-      
+
     Callback = Struct.new :module, :version, :description, :block
 
     mattr_accessor :__upgrade_callbacks
@@ -28,12 +28,12 @@ module Dor
     def self.add_upgrade_callback c, v, d, &b
       @@__upgrade_callbacks << Callback.new(c, Gem::Version.new(v), d, b)
     end
-    
+
     def self.run_upgrade_callbacks(obj, event_handler)
       relevant = @@__upgrade_callbacks.select { |c| obj.is_a?(c.module) }.sort_by(&:version)
-      results = relevant.collect do |c| 
+      results = relevant.collect do |c|
         result = c.block.call(obj)
-        if result and event_handler.respond_to?(:add_event)
+        if result && event_handler.respond_to?(:add_event)
           event_handler.add_event 'remediation', "#{c.module.name} #{c.version}", c.description
         end
         if result
@@ -43,19 +43,19 @@ module Dor
       end
       results.any?
     end
-    
+
     def self.included(base)
       base.instance_eval do
         def self.on_upgrade version, desc, &block
           Dor::Upgradable.add_upgrade_callback self, version, desc, &block
         end
-        
+
         Dir[File.join(Dor.root,'dor','migrations',base.name.split(/::/).last.underscore,'*.rb')].each do |migration|
           require migration
         end
       end
     end
-    
+
     def upgrade!
       results = [Dor::Upgradable.run_upgrade_callbacks(self, self)]
       if self.respond_to?(:datastreams)

data/lib/dor/models/versionable.rb

@@ -16,14 +16,11 @@ module Dor
     # @option opts [Hash] :vers_md_upd_info If present, used to add to the events datastream and set the desc and significance on the versionMetadata datastream
     # @raise [Dor::Exception] if the object hasn't been accessioned, or if a version is already opened
     def open_new_version(opts = {})
-      # During local development, we need a way to open a new version
-      # even if the object has not been accessioned.
+      # During local development, we need a way to open a new version even if the object has not been accessioned.
       raise(Dor::Exception, 'Object net yet accessioned') unless
-        opts[:assume_accessioned] ||
-        Dor::WorkflowService.get_lifecycle('dor', pid, 'accessioned')
-
-      raise Dor::Exception, 'Object already opened for versioning' if(new_version_open?)
-      raise Dor::Exception, 'Object currently being accessioned' if(Dor::WorkflowService.get_active_lifecycle('dor', pid, 'submitted'))
+        opts[:assume_accessioned] || Dor::WorkflowService.get_lifecycle('dor', pid, 'accessioned')
+      raise Dor::Exception, 'Object already opened for versioning' if new_version_open?
+      raise Dor::Exception, 'Object currently being accessioned' if Dor::WorkflowService.get_active_lifecycle('dor', pid, 'submitted')
 
       sdr_version = Sdr::Client.current_version pid
 
@@ -33,20 +30,18 @@ module Dor
       vmd_ds.save unless self.new_object?
 
       k = :create_workflows_ds
-      if opts.has_key?(k)
-        # During local development, Hydrus (or some other app running Fedora locally)
-        # does not want this call to initialize the workflows datastream.
+      if opts.key?(k)
+        # During local development, Hydrus (or another app w/ local Fedora) does not want to initialize workflows datastream.
         initialize_workflow('versioningWF', opts[k])
       else
         initialize_workflow('versioningWF')
       end
 
       vmd_upd_info = opts[:vers_md_upd_info]
-      if vmd_upd_info
-        datastreams['events'].add_event("open", vmd_upd_info[:opening_user_name], "Version #{vmd_ds.current_version_id.to_s} opened")
-        vmd_ds.update_current_version({:description => vmd_upd_info[:description], :significance => vmd_upd_info[:significance].to_sym})
-        save
-      end
+      return unless vmd_upd_info
+      datastreams['events'].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})
+      save
     end
 
     def current_version
@@ -63,27 +58,27 @@ module Dor
     # @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={})
-      unless(opts.empty?)
+      unless opts.empty?
         datastreams['versionMetadata'].update_current_version opts
         datastreams['versionMetadata'].save
       end
 
-      raise Dor::Exception, 'latest version in versionMetadata requires tag and description before it can be closed' unless(datastreams['versionMetadata'].current_version_closeable?)
-      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::WorkflowService.get_active_lifecycle('dor', pid, 'submitted'))
+      raise Dor::Exception, 'latest version in versionMetadata requires tag and description before it can be closed' unless datastreams['versionMetadata'].current_version_closeable?
+      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::WorkflowService.get_active_lifecycle('dor', pid, 'submitted')
 
       Dor::WorkflowService.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::WorkflowService.get_active_lifecycle('dor', pid, 'opened'))
+      return true if Dor::WorkflowService.get_active_lifecycle('dor', pid, 'opened')
       false
     end
 
     # @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') && ! new_version_open? && 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(%{#{Solrizer.solr_name "objectType", :symbol}:"#{self.object_type}" #{Solrizer.solr_name "workflow_name", :symbol}:"#{name}"}, opts).first
+      Dor.find_all(%{#{Solrizer.solr_name 'objectType', :symbol}:"#{self.object_type}" #{Solrizer.solr_name 'workflow_name', :symbol}:"#{name}"}, opts).first
     end
 
     # Searches for the workflow definition object in DOR, then
@@ -21,7 +21,7 @@ module Dor
     # @param [String] name the name of the workflow
     # @return [String] the initial workflow xml
     def self.initial_workflow(name)
-      return @@xml_cache[name] if(@@xml_cache.include?(name))
+      return @@xml_cache[name] if @@xml_cache.include?(name)
 
       self.find_and_cache_workflow_xml_and_repo name
       @@xml_cache[name]
@@ -32,7 +32,7 @@ module Dor
     # @param [String] name the name of the workflow
     # @return [String] the initial workflow xml
     def self.initial_repo(name)
-      return @@repo_cache[name] if(@@repo_cache.include?(name))
+      return @@repo_cache[name] if @@repo_cache.include?(name)
 
       self.find_and_cache_workflow_xml_and_repo name
       @@repo_cache[name]

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_reset_workspace_content(druid, last_version, Config.cleanup.local_assembly_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
     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,27 +32,26 @@ 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] base_druid_tree 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      
+      return reset_directories
     end
 
     # @param [String] druid The identifier for the object whose reset bags data is to be removed
@@ -60,41 +59,47 @@ 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      
+      return 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      
+      return reset_bags
     end
 
+    # @param [String] druid The identifier for the object whose data is to be removed
+    # @param [String] base The base directory to delete from
+    # @return [void] remove the object's data files from the assembly area
+    def self.cleanup_assembly_content(druid, base)
+      DruidTools::Druid.new(druid, base).prune!
+    end
   end
 end

data/lib/dor/services/digital_stacks_service.rb

@@ -24,7 +24,7 @@ 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
@@ -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
@@ -82,7 +82,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|
+      [: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}

data/lib/dor/services/merge_service.rb

@@ -2,7 +2,7 @@ module Dor
 
   class MergeService
 
-    def MergeService.merge_into_primary primary_druid, secondary_druids, tag, logger = nil
+    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
       merge_service.check_objects_editable
@@ -24,12 +24,9 @@ module Dor
     end
 
     def check_objects_editable
-      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? } ))
-        raise Dor::Exception.new "Secondary object is not editable: #{non_editable.pid}"
-      end
+      raise Dor::Exception.new("Primary object is not editable: #{@primary.pid}") unless @primary.allows_modification?
+      non_editable = @secondary_objs.detect {|obj| !obj.allows_modification? }
+      raise Dor::Exception.new "Secondary object is not editable: #{non_editable.pid}" if non_editable
     end
 
     def move_metadata_and_content
@@ -47,7 +44,6 @@ module Dor
       primary_cm = @primary.contentMetadata.ng_xml
 
       @secondary_objs.each do |secondary|
-
         sec_druid = DruidTools::Druid.new secondary.pid, Dor::Config.stacks.local_workspace_root
         secondary.contentMetadata.ng_xml.xpath("//resource").each do |src_resource|
           primary_resource = primary_cm.at_xpath "//resource[attr[@name = 'mergedFromPid']/text() = '#{secondary.pid}' and

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

@@ -13,7 +13,7 @@ handler = Class.new do
   end
 
   def prefixes
-    ['catkey','barcode']
+    %w(catkey barcode)
   end
 end
 

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

@@ -21,20 +21,18 @@ handler = Class.new do
 
   def label(metadata)
     xml = Nokogiri::XML(metadata)
-    if xml.root.nil?
-      return ""
-    end
+    return "" if xml.root.nil?
     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
   end
 
   def prefixes
-    ['mdtoolkit','druid']
+    %w(mdtoolkit druid)
   end
 end
 
-Dor::MetadataService.register(handler)
+Dor::MetadataService.register(handler)

data/lib/dor/services/metadata_service.rb

@@ -3,28 +3,28 @@ 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) || handler_class.instance_methods.include?(method.to_sym) 
-            raise TypeError, "Metadata handlers must define ##{method.to_s}"
+        %w(fetch label prefixes).each do |method|
+          unless handler_class.instance_methods.include?(method) || handler_class.instance_methods.include?(method.to_sym)
+            raise TypeError, "Metadata handlers must define ##{method}"
           end
         end
         handler = handler_class.new
@@ -33,21 +33,21 @@ module Dor
         end
         return handler
       end
-      
+
       def known_prefixes
         return 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,22 @@ 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
+        raise MetadataError, "Unkown metadata prefix: #{prefix}" if handler.nil?
         return handler
       end
-      
+
       private
       def handlers
         @handlers ||= {}
       end
-      
+
     end
-    
+
   end
-  
+
 end
 
 Dir[File.join(File.dirname(__FILE__),'metadata_handlers','*.rb')].each { |handler_file|