dor-services 5.2.0 → 5.3.0

data/lib/dor/models/rightsable.rb

@@ -7,19 +7,18 @@ module Dor
     end
 
     def build_rightsMetadata_datastream(ds)
-      content_ds = self.admin_policy_object.datastreams['defaultObjectRights']
+      content_ds = admin_policy_object.datastreams['defaultObjectRights']
       ds.dsLabel = 'Rights Metadata'
       ds.ng_xml = content_ds.ng_xml.clone
       ds.content = ds.ng_xml.to_xml
     end
 
     def world_doc
-      return Nokogiri::XML::Builder.new do |xml|
+      Nokogiri::XML::Builder.new do |xml|
         xml.access(:type => 'read') {
           xml.machine { xml.world }
         }
       end.doc
     end
-
   end
 end

data/lib/dor/models/set.rb

@@ -7,7 +7,7 @@ module Dor
     include Publishable
     include Versionable
 
-    has_many :members, :property => :is_member_of_collection, :inbound => true, :class_name => "ActiveFedora::Base"
+    has_many :members, :property => :is_member_of_collection, :inbound => true, :class_name => 'ActiveFedora::Base'
     has_object_type 'set'
   end
 end

data/lib/dor/models/shelvable.rb

@@ -14,7 +14,7 @@ module Dor
       stacks_druid = DruidTools::StacksDruid.new id, stacks_object_pathname
       stacks_object_pathname = Pathname(stacks_druid.path)
       # determine the location of the object's content files in the workspace area
-      workspace_druid = DruidTools::Druid.new(id,Config.stacks.local_workspace_root)
+      workspace_druid = DruidTools::Druid.new(id, Config.stacks.local_workspace_root)
       workspace_content_pathname = workspace_content_dir(shelve_diff, workspace_druid)
       # delete, rename, or copy files to the stacks area
       DigitalStacksService.remove_from_stacks(stacks_object_pathname, shelve_diff)
@@ -25,9 +25,9 @@ module Dor
     # retrieve the differences between the current contentMetadata and the previously ingested version
     # (filtering to select only the files that should be shelved to stacks)
     def get_shelve_diff
-      inventory_diff_xml = self.get_content_diff(:shelve)
+      inventory_diff_xml = get_content_diff(:shelve)
       inventory_diff = Moab::FileInventoryDifference.parse(inventory_diff_xml)
-      shelve_diff = inventory_diff.group_difference("content")
+      shelve_diff = inventory_diff.group_difference('content')
       shelve_diff
     end
 
@@ -37,7 +37,7 @@ 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
@@ -46,15 +46,13 @@ module Dor
     # 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']
+      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
-        raise "stacks attribute for item: "+self.id+ " contentMetadata should start with /. The current value is "+stacks_location
+        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
-      return Config.stacks.local_stacks_root #Default stacks
-
+      Config.stacks.local_stacks_root # Default stacks
     end
   end
 end

data/lib/dor/models/upgradable.rb

@@ -1,6 +1,5 @@
 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
     # Chimera/DOR content standards.
@@ -25,7 +24,7 @@ module Dor
 
     mattr_accessor :__upgrade_callbacks
     @@__upgrade_callbacks = []
-    def self.add_upgrade_callback c, v, d, &b
+    def self.add_upgrade_callback(c, v, d, &b)
       @@__upgrade_callbacks << Callback.new(c, Gem::Version.new(v), d, b)
     end
 
@@ -46,11 +45,11 @@ module Dor
 
     def self.included(base)
       base.instance_eval do
-        def self.on_upgrade version, desc, &block
+        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|
+        Dir[File.join(Dor.root, 'dor', 'migrations', base.name.split(/::/).last.underscore, '*.rb')].each do |migration|
           require migration
         end
       end
@@ -59,13 +58,13 @@ module Dor
     def upgrade!
       results = [Dor::Upgradable.run_upgrade_callbacks(self, self)]
       if self.respond_to?(:datastreams)
-        self.datastreams.each_pair do |dsid, ds|
+        datastreams.each_pair do |dsid, ds|
           results << Dor::Upgradable.run_upgrade_callbacks(ds, self) unless ds.new?
         end
       end
 
       if results.any?
-        self.save
+        save
       else
         false
       end

data/lib/dor/models/versionable.rb

@@ -39,7 +39,7 @@ module Dor
 
       vmd_upd_info = opts[:vers_md_upd_info]
       return unless vmd_upd_info
-      datastreams['events'].add_event("open", vmd_upd_info[:opening_user_name], "Version #{vmd_ds.current_version_id} opened")
+      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
@@ -57,7 +57,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
@@ -78,7 +78,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') && !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
@@ -88,6 +88,5 @@ module Dor
     # Following chart of processes on this consul page: https://consul.stanford.edu/display/chimera/Versioning+workflows
     alias_method :start_version,  :open_new_version
     alias_method :submit_version, :close_version
-
   end
 end

data/lib/dor/models/workflow_object.rb

@@ -3,16 +3,15 @@ require 'dor/datastreams/workflow_definition_ds'
 module Dor
   class WorkflowObject < ::ActiveFedora::Base
     include Identifiable
-    include SolrDocHelper
     include Governable
-    @@xml_cache = {}
+    @@xml_cache  = {}
     @@repo_cache = {}
 
     has_object_type 'workflow'
-    has_metadata :name => "workflowDefinition", :type => Dor::WorkflowDefinitionDs, :label => 'Workflow Definition'
+    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
+    def self.find_by_name(name, opts = {})
+      Dor.find_all(%(#{Solrizer.solr_name 'objectType', :symbol}:"#{object_type}" #{Solrizer.solr_name 'workflow_name', :symbol}:"#{name}"), opts).first
     end
 
     # Searches for the workflow definition object in DOR, then
@@ -22,8 +21,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
 
@@ -33,8 +31,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
 
@@ -42,11 +39,11 @@ module Dor
       datastreams['workflowDefinition']
     end
 
-    def graph *args
-      self.definition.graph *args
+    def graph(*args)
+      definition.graph *args
     end
 
-    def to_solr solr_doc=Hash.new, *args
+    def to_solr(solr_doc = {}, *args)
       super solr_doc, *args
       client = Dor::WorkflowService.workflow_resource
       xml = client["workflow_archive?repository=#{definition.repo}&workflow=#{definition.name}&count-only=true"].get
@@ -63,11 +60,13 @@ module Dor
 
     # Searches DOR for the workflow definition object.  It then caches the workflow repository and xml
     # @param [String] name the name of the workflow
-    def self.find_and_cache_workflow_xml_and_repo name
-      wobj = self.find_by_name(name)
-      wf_xml = wobj.generate_initial_workflow
+    # @return [Object] a Dor::xxxx object, e.g. a Dor::Item object
+    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] = wf_xml
+      @@xml_cache[name]  = wobj.generate_initial_workflow
+      wobj
     end
 
   end

data/lib/dor/services/cleanup_reset_service.rb

@@ -1,7 +1,6 @@
 require 'pathname'
 
 module Dor
-
   # Remove all traces of the object's data files from the workspace and export areas
   class CleanupResetService
 
@@ -18,22 +17,22 @@ module Dor
       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
+      # if the current version is still open, avoid this versioned directory
+      if Dor::WorkflowService.get_lifecycle('dor', druid, 'accessioned').nil?
         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
     # @return [void] remove all the object's reset data files from the workspace area equal to less than the last_version
-    def self.cleanup_reset_workspace_content(druid,last_version, base)
+    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,
-      #we should follow the regular cleanup technique
+      # 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|
@@ -47,11 +46,11 @@ module Dor
     # @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
+      (1..last_version).each do |i|
         reset_path = "#{base_druid_tree}_v#{i}"
-        reset_directories.append(reset_path) if File.exists?(reset_path)
+        reset_directories.append(reset_path) if File.exist?(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
@@ -76,11 +75,11 @@ module Dor
     # @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 = []
-      for i in 1..last_version do
+      (1..last_version).each do |i|
         reset_path = "#{base_bag_directory}_v#{i}"
-        reset_bags.append(reset_path) if File.exists?(reset_path)
+        reset_bags.append(reset_path) if File.exist?(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
@@ -88,11 +87,11 @@ module Dor
     # @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 = []
-      for i in 1..last_version do
+      (1..last_version).each do |i|
         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.exist?(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

@@ -1,7 +1,6 @@
 require 'pathname'
 
 module Dor
-
   # Remove all traces of the object's data files from the workspace and export areas
   class CleanupService
 
@@ -30,9 +29,9 @@ module Dor
     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
@@ -84,5 +83,4 @@ module Dor
       Dor::SearchService.solr.commit
     end
   end
-
 end

data/lib/dor/services/digital_stacks_service.rb

@@ -2,7 +2,6 @@ require 'net/ssh'
 require 'net/sftp'
 
 module Dor
-
   class DigitalStacksService
 
     # Delete files from stacks that have change type 'deleted', 'copydeleted', or 'modified'
@@ -14,7 +13,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
@@ -26,12 +25,12 @@ module Dor
     def self.delete_file(file_pathname, moab_signature)
       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)
+        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 +45,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,9 +53,8 @@ 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
 
     # Rename a file, but only if it exists and has the expected signature
@@ -67,13 +65,13 @@ module Dor
     def self.rename_file(old_pathname, new_pathname, moab_signature)
       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)
+        if file_signature == moab_signature
           new_pathname.parent.mkpath
           old_pathname.rename(new_pathname)
           return true
         end
       end
-      return false
+      false
     end
 
     # Add files to stacks that have change type 'added', 'copyadded' or 'modified'.
@@ -89,7 +87,7 @@ module Dor
           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 +108,7 @@ module Dor
         FileUtils.cp workspace_pathname.to_s, stacks_pathname.to_s
         return true
       end
-      return false
+      false
     end
 
     ### depricated ???
@@ -127,7 +125,7 @@ module Dor
     end
 
     # Assumes the digital stacks storage root is mounted to the local file system
-    # TODO since this is delegating to the Druid, this method may not be necessary
+    # TODO: since this is delegating to the Druid, this method may not be necessary
     def self.prune_stacks_dir(id)
       stacks_druid_tree = DruidTools::StacksDruid.new(id, Config.stacks.local_stacks_root)
       stacks_druid_tree.prune!
@@ -138,5 +136,4 @@ module Dor
       druid.prune!
     end
   end
-
 end

data/lib/dor/services/merge_service.rb

@@ -1,9 +1,8 @@
 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
+    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
       merge_service.move_metadata_and_content
@@ -11,7 +10,7 @@ module Dor
       # kick off commonAccessioning for the primary?
     end
 
-    def initialize primary_druid, secondary_pids, tag, logger = nil
+    def initialize(primary_druid, secondary_pids, tag, logger = nil)
       @primary = Dor::Item.find primary_druid
       @secondary_pids = secondary_pids
       @secondary_objs = secondary_pids.map {|pid|  Dor::Item.find pid }
@@ -45,14 +44,14 @@ module Dor
 
       @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|
+        secondary.contentMetadata.ng_xml.xpath('//resource').each do |src_resource|
           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?
+            # TODO: verify new_name exists in primary_cm?
             FileUtils.cp(copy_path, File.join(dest_path, "/#{new_name}"))
           end
         end
@@ -78,13 +77,13 @@ module Dor
     end
 
     # Remove content from stacks
-    # TODO might set workflow status in future for robot to do
+    # TODO: might set workflow status in future for robot to do
     def unshelve
       DigitalStacksService.prune_stacks_dir @current_secondary.pid
     end
 
     # Withdraw item from Purl
-    # TODO might set workflow status in future for robot to do
+    # TODO: might set workflow status in future for robot to do
     def unpublish
       @current_secondary.publish_metadata
     end