dor-services 6.0.5 → 6.1.0

data/lib/dor/indexers/data_indexer.rb

@@ -18,13 +18,7 @@ module Dor
       end
     end
 
-    # rubocop:disable Naming/PredicateName
-    def has_model
-      resource.class.inspect
-    end
-    # rubocop:enable Naming/PredicateName
-
     delegate :create_date, :modified_date, :state, :pid, :inner_object,
-             :datastreams, :relationships, to: :resource
+             :datastreams, :relationships, :has_model, to: :resource
   end
 end

data/lib/dor/indexers/describable_indexer.rb

@@ -28,7 +28,7 @@ module Dor
         topic_facet: %w(sw_topic_ssim sw_topic_tesim),
         era_facet: %w(sw_subject_temporal_ssim sw_subject_temporal_tesim),
         geographic_facet: %w(sw_subject_geographic_ssim sw_subject_geographic_tesim),
-        [:term_values, :typeOfResource] => %w(mods_typeOfResource_ssim mods_typeOfResource_tesim),
+        %i[term_values typeOfResource] => %w(mods_typeOfResource_ssim mods_typeOfResource_tesim),
         pub_year_sort_str: %w(sw_pub_date_sort_ssi),
         pub_year_int: %w(sw_pub_date_sort_isi),
         pub_year_display_str: %w(sw_pub_date_facet_ssi)

data/lib/dor/indexers/identifiable_indexer.rb

@@ -17,8 +17,6 @@ module Dor
     # @return [Hash] the partial solr document for identifiable concerns
     def to_solr
       solr_doc = {}
-      resource.assert_content_model
-
       solr_doc[Dor::INDEX_VERSION_FIELD] = Dor::VERSION
       solr_doc['indexed_at_dtsi'] = Time.now.utc.xmlschema
       resource.datastreams.values.each do |ds|

data/lib/dor/indexers/processable_indexer.rb

@@ -7,38 +7,62 @@ module Dor
     attr_reader :resource
     def initialize(resource:)
       @resource = resource
+      @status_service = StatusService.new(resource)
     end
 
     # @return [Hash] the partial solr document for processable concerns
     def to_solr
-      solr_doc = {}
-      sortable_milestones = {}
-      current_version = '1'
-      begin
-        current_version = resource.versionMetadata.current_version_id
-      rescue StandardError
+      {}.tap do |solr_doc|
+        add_versions(solr_doc)
+        add_milestones(solr_doc)
+        solr_doc['modified_latest_dttsi'] = resource.modified_date.to_datetime.utc.strftime('%FT%TZ')
+        add_solr_value(solr_doc, 'rights', resource.rights, :string, [:symbol]) if resource.respond_to? :rights
+        add_status(solr_doc)
       end
-      current_version_num = current_version.to_i
+    end
 
-      if resource.respond_to?('versionMetadata')
-        # add an entry with version id, tag and description for each version
-        while current_version_num > 0
-          new_val = "#{current_version_num};#{resource.versionMetadata.tag_for_version(current_version_num.to_s)};#{resource.versionMetadata.description_for_version(current_version_num.to_s)}"
-          add_solr_value(solr_doc, 'versions', new_val, :string, [:displayable])
-          current_version_num -= 1
-        end
-      end
+    private
+
+    attr_reader :status_service
+
+    def current_version
+      @current_version ||= begin
+                             resource.versionMetadata.current_version_id
+                           rescue StandardError
+                             '1'
+                           end
+    end
+
+    def add_status(solr_doc)
+      solr_doc['status_ssi'] = status_service.status # status is singular (i.e. the current one)
+      status_info_hash = status_service.status_info
+      status_code = status_info_hash[:status_code]
+      add_solr_value(solr_doc, 'processing_status_text', simplified_status_code_disp_txt(status_code), :string, [:stored_sortable])
+      solr_doc['processing_status_code_isi'] = status_code
+    end
 
-      resource.milestones.each do |milestone|
+    def add_milestones(solr_doc)
+      status_service.milestones.each do |milestone|
         timestamp = milestone[:at].utc.xmlschema
-        sortable_milestones[milestone[:milestone]] ||= []
-        sortable_milestones[milestone[:milestone]] << timestamp
         milestone[:version] ||= current_version
         solr_doc['lifecycle_ssim'] ||= []
         solr_doc['lifecycle_ssim'] << milestone[:milestone]
         add_solr_value(solr_doc, 'lifecycle', "#{milestone[:milestone]}:#{timestamp};#{milestone[:version]}", :symbol)
       end
 
+      add_sortable_milestones(solr_doc)
+    end
+
+    def sortable_milestones
+      sortable = {}
+      status_service.milestones.each do |milestone|
+        sortable[milestone[:milestone]] ||= []
+        sortable[milestone[:milestone]] << milestone[:at].utc.xmlschema
+      end
+      sortable
+    end
+
+    def add_sortable_milestones(solr_doc)
       sortable_milestones.each do |milestone, unordered_dates|
         dates = unordered_dates.sort
         # create the published_dttsi and published_day fields and the like
@@ -50,23 +74,26 @@ module Dor
         solr_doc["#{milestone}_earliest_dttsi"] = dates.first
         solr_doc["#{milestone}_latest_dttsi"] = dates.last
       end
-      solr_doc['status_ssi'] = resource.status # status is singular (i.e. the current one)
-      solr_doc['current_version_isi'] = current_version.to_i
-      solr_doc['modified_latest_dttsi'] = resource.modified_date.to_datetime.utc.strftime('%FT%TZ')
-      add_solr_value(solr_doc, 'rights', resource.rights, :string, [:symbol]) if resource.respond_to? :rights
+    end
 
-      status_info_hash = resource.status_info
-      status_code = status_info_hash[:status_code]
-      add_solr_value(solr_doc, 'processing_status_text', simplified_status_code_disp_txt(status_code), :string, [:stored_sortable])
-      solr_doc['processing_status_code_isi'] = status_code # no _isi in Solrizer's default descriptors
+    def add_versions(solr_doc)
+      current_version_num = current_version.to_i
+      solr_doc['current_version_isi'] = current_version_num
 
-      solr_doc
+      return unless resource.respond_to?('versionMetadata')
+
+      # add an entry with version id, tag and description for each version
+      while current_version_num > 0
+        new_val = "#{current_version_num};#{resource.versionMetadata.tag_for_version(current_version_num.to_s)};#{resource.versionMetadata.description_for_version(current_version_num.to_s)}"
+        add_solr_value(solr_doc, 'versions', new_val, :string, [:displayable])
+        current_version_num -= 1
+      end
     end
 
     # @return [String] text translation of the status code, minus any trailing parenthetical explanation
     # e.g. 'In accessioning (described)' and 'In accessioning (described, published)' both return 'In accessioning'
     def simplified_status_code_disp_txt(status_code)
-      Processable::STATUS_CODE_DISP_TXT[status_code].gsub(/\(.*\)$/, '').strip
+      StatusService::STATUS_CODE_DISP_TXT[status_code].gsub(/\(.*\)$/, '').strip
     end
   end
 end

data/lib/dor/indexers/releasable_indexer.rb

@@ -15,9 +15,9 @@ module Dor
 
       # TODO: sort of worried about the performance impact in bulk reindex
       # situations, since released_for recurses all parent collections.  jmartin 2015-07-14
-      resource.released_for(true).each { |release_target, release_info|
+      resource.released_for(true).each do |release_target, release_info|
         add_solr_value(solr_doc, 'released_to', release_target, :symbol, []) if release_info['release']
-      }
+      end
 
       # TODO: need to solrize whether item is released to purl?  does released_for return that?
       # logic is: "True when there is a published lifecycle and Access Rights is anything but Dark"

data/lib/dor/models/admin_policy_object.rb

@@ -4,11 +4,11 @@ module Dor
   class AdminPolicyObject < Dor::Abstract
     include Editable
 
-    has_many :things, :property => :is_governed_by, :class_name => 'ActiveFedora::Base'
+    has_many :things, property: :is_governed_by, class_name: 'ActiveFedora::Base'
     has_object_type 'adminPolicy'
-    has_metadata :name => 'administrativeMetadata', :type => Dor::AdministrativeMetadataDS, :label => 'Administrative Metadata'
-    has_metadata :name => 'roleMetadata',           :type => Dor::RoleMetadataDS,           :label => 'Role Metadata'
-    has_metadata :name => 'defaultObjectRights',    :type => Dor::DefaultObjectRightsDS,    :label => 'Default Object Rights'
+    has_metadata name: 'administrativeMetadata', type: Dor::AdministrativeMetadataDS, label: 'Administrative Metadata'
+    has_metadata name: 'roleMetadata',           type: Dor::RoleMetadataDS,           label: 'Role Metadata'
+    has_metadata name: 'defaultObjectRights',    type: Dor::DefaultObjectRightsDS,    label: 'Default Object Rights'
 
     self.resource_indexer = CompositeIndexer.new(
       DataIndexer,

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

@@ -2,6 +2,9 @@
 
 module Dor
   module Assembleable
+    extend Deprecation
+    self.deprecation_horizon = 'dor-services version 7.0.0'
+
     def initialize_workspace(source = nil)
       druid = DruidTools::Druid.new(pid, Config.stacks.local_workspace_root)
       if source.nil?
@@ -10,5 +13,6 @@ module Dor
         druid.mkdir_with_final_link(source)
       end
     end
+    deprecation_deprecate initialize_workspace: 'This functionality has moved to dor_services_app'
   end
 end

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

@@ -3,6 +3,8 @@
 module Dor
   module Contentable
     extend ActiveSupport::Concern
+    extend Deprecation
+    self.deprecation_horizon = 'dor-services version 7.0.0'
 
     # add a file to a resource, not to be confused with add a resource to an object
     def add_file(file, resource, file_name, mime_type = nil, publish = 'no', shelve = 'no', preserve = 'no')
@@ -10,7 +12,7 @@ module Dor
       # 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'])
+      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)
       oldlocation = location.gsub('/' + pid.gsub('druid:', ''), '')
@@ -18,7 +20,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
@@ -41,9 +43,10 @@ module Dor
       end
       # can only arrive at this point if a non status exception occurred.
     end
+    deprecation_deprecate add_file: 'will be removed without replacement'
 
     def replace_file(file, file_name)
-      sftp = Net::SFTP.start(Config.content.content_server, Config.content.content_user, :auth_methods => ['publickey'])
+      sftp = Net::SFTP.start(Config.content.content_server, Config.content.content_user, auth_methods: ['publickey'])
       item = Dor.find(pid)
       druid_tools = DruidTools::Druid.new(pid, Config.content.content_base_dir)
       location = druid_tools.path(file_name)
@@ -52,44 +55,47 @@ 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)
         # this doesnt allow renaming files
         item.contentMetadata.update_file(file_hash, file_name)
-      rescue
+      rescue StandardError
         sftp.upload!(file.path, oldlocation)
         item.contentMetadata.update_file(file_hash, file_name)
       end
     end
+    deprecation_deprecate replace_file: 'will be removed without replacement'
 
     def get_preserved_file(file, version)
       Sdr::Client.get_preserved_file_content(pid, file, version)
     end
+    deprecation_deprecate get_preserved_file: 'Use Dor::Services::Client.preserved_content instead'
 
     def get_file(file)
       druid_tools = DruidTools::Druid.new(pid, Config.content.content_base_dir)
       location = druid_tools.path(file)
       oldlocation = location.gsub('/' + file, '').gsub('/' + pid.gsub('druid:', ''), '') + '/' + file
-      sftp = Net::SFTP.start(Config.content.content_server, Config.content.content_user, :auth_methods => ['publickey'])
+      sftp = Net::SFTP.start(Config.content.content_server, Config.content.content_user, auth_methods: ['publickey'])
       begin
         data = sftp.download!(location)
-      rescue
+      rescue StandardError
         data = sftp.download!(oldlocation)
       end
       data
     end
+    deprecation_deprecate get_file: 'use dor-services-app:/v1/objects/:id/contents/*path instead'
 
     # @param [String] filename
     def remove_file(filename)
       druid_tools = DruidTools::Druid.new(pid, Config.content.content_base_dir)
       location = druid_tools.path(filename)
       oldlocation = location.gsub('/' + pid.gsub('druid:', ''), '')
-      sftp = Net::SFTP.start(Config.content.content_server, Config.content.content_user, :auth_methods => ['publickey'])
+      sftp = Net::SFTP.start(Config.content.content_server, Config.content.content_user, auth_methods: ['publickey'])
       begin
         sftp.remove!(location)
-      rescue
+      rescue StandardError
         # if the file doesnt exist, that is ok, not all files will be present in the workspace
         begin
           sftp.remove!(oldlocation)
@@ -98,6 +104,7 @@ module Dor
       end
       contentMetadata.remove_file filename
     end
+    deprecation_deprecate remove_file: 'will be removed without replacement'
 
     # @param [String] old_name
     # @param [String] new_name
@@ -105,14 +112,15 @@ module Dor
       druid_tools = DruidTools::Druid.new(pid, Config.content.content_base_dir)
       location = druid_tools.path(old_name)
       oldlocation = location.gsub('/' + pid.gsub('druid:', ''), '')
-      sftp = Net::SFTP.start(Config.content.content_server, Config.content.content_user, :auth_methods => ['publickey'])
+      sftp = Net::SFTP.start(Config.content.content_server, Config.content.content_user, auth_methods: ['publickey'])
       begin
         sftp.rename!(location, location.gsub(old_name, new_name))
-      rescue
+      rescue StandardError
         sftp.rename!(oldlocation, oldlocation.gsub(old_name, new_name))
       end
       contentMetadata.rename_file(old_name, new_name)
     end
+    deprecation_deprecate rename_file: 'will be removed without replacement'
 
     # @param [String] resource_name ID of the resource elememnt
     def remove_resource(resource_name)
@@ -123,13 +131,15 @@ module Dor
       # remove the resource record from the metadata and renumber the resource sequence
       contentMetadata.remove_resource resource_name
     end
+    deprecation_deprecate remove_resource: 'will be removed without replacement'
 
+    # TODO: Move to Argo
     # list files in the workspace
     # @return [Array] workspace files
     def list_files
       filename = 'none'
       files = []
-      sftp = Net::SFTP.start(Config.content.content_server, Config.content.content_user, :auth_methods => ['publickey'])
+      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(filename).gsub(filename, '')
       oldlocation = location.gsub('/' + pid.gsub('druid:', ''), '')
@@ -137,7 +147,7 @@ module Dor
         sftp.dir.entries(location, '*') do |file|
           files << file.name
         end
-      rescue
+      rescue StandardError
         begin
           sftp.dir.glob(oldlocation, '*') do |file|
             files << file.name
@@ -148,6 +158,7 @@ module Dor
       end
       files
     end
+    deprecation_deprecate list_files: 'use dor-services-app:/v1/objects/:id/contents instead'
 
     # @param [String] filename
     # @return [Boolean] whether the file in question is present in the object's workspace
@@ -155,58 +166,7 @@ module Dor
       druid_obj = DruidTools::Druid.new(pid, Dor::Config.stacks.local_workspace_root)
       !druid_obj.find_content(filename).nil?
     end
-
-    # Appends contentMetadata file resources from the source objects to this object
-    # @param [Array<String>] source_obj_pids ids of the secondary objects that will get their contentMetadata merged into this one
-    def copy_file_resources(source_obj_pids)
-      primary_cm = contentMetadata.ng_xml
-      contentMetadata.ng_xml_will_change!
-      base_id = primary_cm.at_xpath('/contentMetadata/@objectId').value
-      max_sequence = primary_cm.at_xpath('/contentMetadata/resource[last()]/@sequence').value.to_i
-
-      source_obj_pids.each do |src_pid|
-        source_obj = Dor.find src_pid
-        source_cm = source_obj.contentMetadata.ng_xml
-
-        # Copy the resources from each source object
-        source_cm.xpath('/contentMetadata/resource').each do |old_resource|
-          max_sequence += 1
-          resource_copy = old_resource.clone
-          resource_copy['sequence'] = "#{max_sequence}"
-
-          # Append sequence number to each secondary filename, then
-          # look for filename collisions with the primary object
-          resource_copy.xpath('file').each do |secondary_file|
-            secondary_file['id'] = new_secondary_file_name(secondary_file['id'], max_sequence)
-
-            if primary_cm.at_xpath("//file[@id = '#{secondary_file['id']}']")
-              raise Dor::Exception, "File '#{secondary_file['id']}' from secondary object #{src_pid} already exist in primary object: #{pid}"
-            end
-          end
-
-          if old_resource['type']
-            resource_copy['id'] = "#{old_resource['type']}_#{max_sequence}"
-          else
-            resource_copy['id'] = "#{base_id}_#{max_sequence}"
-          end
-
-          lbl = old_resource.at_xpath 'label'
-          if lbl && lbl.text =~ /^(.*)\s+\d+$/
-            resource_copy.at_xpath('label').content = "#{$1} #{max_sequence}"
-          end
-
-          primary_cm.at_xpath('/contentMetadata/resource[last()]').add_next_sibling resource_copy
-          attr_node = primary_cm.create_element 'attr', src_pid, :name => 'mergedFromPid'
-          resource_copy.first_element_child.add_previous_sibling attr_node
-          attr_node = primary_cm.create_element 'attr', old_resource['id'], :name => 'mergedFromResource'
-          resource_copy.first_element_child.add_previous_sibling attr_node
-        end
-      end
-    end
-
-    def new_secondary_file_name(old_name, sequence_num)
-      old_name =~ /^(.*)\.(.*)$/ ? "#{$1}_#{sequence_num}.#{$2}" : "#{old_name}_#{sequence_num}"
-    end
+    deprecation_deprecate is_file_in_workspace?: 'will be removed without replacement'
 
     # Clears RELS-EXT relationships, sets the isGovernedBy relationship to the SDR Graveyard APO
     # @param [String] tag optional String of text that is concatenated to the identityMetadata/tag "Decommissioned : "
@@ -223,12 +183,10 @@ module Dor
       contentMetadata.content = '<contentMetadata/>'
       # eliminate rightsMetadata. set it to <rightsMetadata/> ?
       rightsMetadata.content = '<rightsMetadata/>'
-      add_tag "Decommissioned : #{tag}"
+      TagService.add self, "Decommissioned : #{tag}"
     end
 
-    alias_method :decomission, :decommission
-    deprecate decomission: 'Use decommission instead'
-
+    # TODO: Move to Dor-Utils.
     # Adds a RELS-EXT constituent relationship to the given druid
     # @param [String] druid the parent druid of the constituent relationship
     #   e.g.: <fedora:isConstituentOf rdf:resource="info:fedora/druid:hj097bm8879" />

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

@@ -3,15 +3,11 @@
 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/'
-    XMLNS_DC = 'http://purl.org/dc/elements/1.1/'
-
-    class CrosswalkError < Exception; end
+    extend Deprecation
+    self.deprecation_horizon = 'dor-services version 7.0.0'
 
     included do
-      has_metadata :name => 'descMetadata', :type => Dor::DescMetadataDS, :label => 'Descriptive Metadata', :control_group => 'M'
+      has_metadata name: 'descMetadata', type: Dor::DescMetadataDS, label: 'Descriptive Metadata', control_group: 'M'
     end
 
     require 'stanford-mods'
@@ -29,7 +25,7 @@ module Dor
     end
 
     def fetch_descMetadata_datastream
-      candidates = datastreams['identityMetadata'].otherId.collect { |oid| oid.to_s }
+      candidates = datastreams['identityMetadata'].otherId.collect(&:to_s)
       metadata_id = Dor::MetadataService.resolvable(candidates).first
       metadata_id.nil? ? nil : Dor::MetadataService.fetch(metadata_id.to_s)
     end
@@ -49,40 +45,29 @@ module Dor
     # @raise [CrosswalkError] Raises an Exception if the generated DC is empty or has no children
     # @return [Nokogiri::Doc] the DublinCore XML document object
     def generate_dublin_core(include_collection_as_related_item: true)
-      desc_md = if include_collection_as_related_item
-                  Nokogiri::XML(generate_public_desc_md(include_access_conditions: false))
-                else
-                  descMetadata.ng_xml
-                end
-
-      dc_doc = MODS_TO_DC_XSLT.transform(desc_md)
-      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
+      DublinCoreService.new(self, include_collection_as_related_item: include_collection_as_related_item).to_xml
     end
+    deprecation_deprecate generate_dublin_core: 'Use DublinCoreService#to_xml instead'
 
     # @return [String] Public descriptive medatada XML
     def generate_public_desc_md(**options)
       PublicDescMetadataService.new(self).to_xml(**options)
     end
+    deprecation_deprecate generate_public_desc_md: 'Use PublicDescMetadataService#to_xml instead'
 
     # @param [Boolean] force Overwrite existing XML
     # @return [String] descMetadata.content XML
     def set_desc_metadata_using_label(force = false)
-      unless force || descMetadata.new?
-        raise 'Cannot proceed, there is already content in the descriptive metadata datastream: ' + descMetadata.content.to_s
-      end
+      raise 'Cannot proceed, there is already content in the descriptive metadata datastream: ' + descMetadata.content.to_s unless force || descMetadata.new?
 
       label = self.label
-      builder = Nokogiri::XML::Builder.new { |xml|
-        xml.mods(Dor::DescMetadataDS::MODS_HEADER_CONFIG) {
-          xml.titleInfo {
+      builder = Nokogiri::XML::Builder.new do |xml|
+        xml.mods(Dor::DescMetadataDS::MODS_HEADER_CONFIG) do
+          xml.titleInfo do
             xml.title label
-          }
-        }
-      }
+          end
+        end
+      end
       descMetadata.content = builder.to_xml
     end