dor-services 9.1.0 → 9.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 136d61d182d9ce8c75cd211f5b1d76c5a27f7db15811939718ecf4257a025a9b
-  data.tar.gz: ddb8aaab834a7c7c78fe7da5388127bd8978740ac9fa5b59e1b25a34b6c0aca4
+  metadata.gz: f696769ddd2ceb91345d4d0b7aa5b3ebdfa1b84a3c990055187f058b2d422a66
+  data.tar.gz: 0d354e436399a02330fdd07db2fae0b0eddfa14c710d93807aadb925dfa57c0f
 SHA512:
-  metadata.gz: 904c66a42965b98fa202d6044d2e82557a673f520fb06d011dcc3e40a4d42ed5ccf0eeadf725743066b7087a664da0567a7cf0fb7ea0086e094e40ee4dbada2c
-  data.tar.gz: 73d3fb910e501d6c85e67d32d459f2af338e1373ffaed6dabb3ed00e2245b4e8534753c369cb5882785d065fee6b5e204b5e57a8a7a295b538fd016bcb75e1c8
+  metadata.gz: 4a645755fe069b45ed3f07f02b742990acc25234214f3968e997b5c76475b70df1c3bccc400f6831aab1fc2a6770d409b3cedcb65f4dd7a36e38fdf0e2752bbe
+  data.tar.gz: 88a519d69bea0c6a08ea8ce6569468778e10431595e759f8e38ee4c049674125cef29f0425f83f59597ba3b62bd4c7d348c5bc5115b5213167414e1991626db4

data/lib/dor-services.rb

@@ -92,7 +92,6 @@ module Dor
     autoload :OpenDataLicenseService
     autoload :SearchService
     autoload :SuriService
-    autoload :TagService
   end
 
   eager_load!

data/lib/dor/datastreams/embargo_metadata_ds.rb

@@ -8,7 +8,7 @@ module Dor
       t.root(path: 'embargoMetadata')
       t.status
       t.embargo_status(path: 'status', index_as: [:symbol])
-      t.release_date(path: 'releaseDate', index_as: [:dateable])
+      t.release_date(path: 'releaseDate', type: :time)
       t.release_access(path: 'releaseAccess') do
         t.use do
           t.human(attributes: { type: 'useAndReproduction' })
@@ -35,10 +35,8 @@ module Dor
 
     def to_solr(solr_doc = {}, *args)
       solr_doc = super
-      #::Solrizer.insert_field(solr_doc, field_name, value, *index_types)
-      rd1 = release_date
       rd20 = twenty_pct_release_date
-      ::Solrizer.insert_field(solr_doc, 'embargo_release', rd1.utc.strftime('%FT%TZ'), :dateable) unless rd1.blank?
+      ::Solrizer.insert_field(solr_doc, 'embargo_release', release_date.first.utc.strftime('%FT%TZ'), :dateable) unless release_date.first.blank?
       ::Solrizer.insert_field(solr_doc, 'twenty_pct_visibility_release', rd20.utc.strftime('%FT%TZ'), :dateable) unless rd20.blank?
       solr_doc
     end
@@ -60,19 +58,6 @@ module Dor
       term_values(:status).first
     end
 
-    # Sets the release date.  Does NOT convert to beginning-of-day.
-    # @param [Time] rd the release date object
-    def release_date=(rd = Time.now.utc)
-      update_values([:release_date] => rd.utc.xmlschema)
-    end
-
-    # Current releaseDate value
-    # @return [Time]
-    def release_date
-      rd = term_values(:release_date).first
-      rd.nil? || rd.empty? ? nil : Time.parse(rd)
-    end
-
     def twenty_pct_status=(new_status)
       update_values([:twenty_pct_status] => new_status)
     end

data/lib/dor/datastreams/identity_metadata_ds.rb

@@ -8,6 +8,7 @@ module Dor
     # ids for previous and current catkeys
     CATKEY_TYPE_ID = 'catkey'
     PREVIOUS_CATKEY_TYPE_ID = 'previous_catkey'
+    BARCODE_TYPE_ID = 'barcode'
 
     set_terminology do |t|
       t.root(path: 'identityMetadata')
@@ -69,16 +70,6 @@ module Dor
     end
     alias source_id= sourceId=
 
-    def tags
-      tag
-    end
-
-    # helper method to get just the content type tag
-    def content_type_tag
-      content_tag = tags.select { |tag| tag.include?('Process : Content Type') }
-      content_tag.size == 1 ? content_tag[0].split(':').last.strip : ''
-    end
-
     def otherId(type = nil)
       result = find_by_terms(:otherId).to_a
       if type.nil?
@@ -154,6 +145,25 @@ module Dor
       otherId(PREVIOUS_CATKEY_TYPE_ID)
     end
 
+    def barcode
+      otherId(BARCODE_TYPE_ID).first
+    end
+
+    # Convenience method to set the barcode
+    # @param  [String] val the new barcode
+    # @return [String] same value, as per Ruby assignment convention
+    def barcode=(val)
+      if val.blank? # if we are setting the barcode to blank, remove the node from XML
+        remove_other_Id(BARCODE_TYPE_ID)
+      elsif barcode.blank? # if there is no current barcode, then add it
+        add_other_Id(BARCODE_TYPE_ID, val)
+      else # if there is a current barcode, update the current barcode to the new value
+        update_other_Id(BARCODE_TYPE_ID, val)
+      end
+
+      val
+    end
+
     # Helper method to get the release tags as a nodeset
     # @return [Nokogiri::XML::NodeSet] all release tags and their attributes
     def release_tags
@@ -170,61 +180,6 @@ module Dor
       return_hash
     end
 
-    def to_solr(solr_doc = {}, *args)
-      solr_doc = super(solr_doc, *args)
-
-      if digital_object.respond_to?(:profile)
-        digital_object.profile.each_pair do |property, value|
-          add_solr_value(solr_doc, property.underscore, value, (property =~ /Date/ ? :date : :symbol), [:stored_searchable])
-        end
-      end
-
-      if sourceId.present?
-        (name, id) = sourceId.split(/:/, 2)
-        add_solr_value(solr_doc, 'dor_id', id, :symbol, [:stored_searchable])
-        add_solr_value(solr_doc, 'identifier', sourceId, :symbol, [:stored_searchable])
-        add_solr_value(solr_doc, 'source_id', sourceId, :symbol, [])
-      end
-      otherId.compact.each do |qid|
-        # this section will solrize barcode and catkey, which live in otherId
-        (name, id) = qid.split(/:/, 2)
-        add_solr_value(solr_doc, 'dor_id', id, :symbol, [:stored_searchable])
-        add_solr_value(solr_doc, 'identifier', qid, :symbol, [:stored_searchable])
-        add_solr_value(solr_doc, "#{name}_id", id, :symbol, [])
-      end
-
-      # do some stuff to make tags in general and project tags specifically more easily searchable and facetable
-      find_by_terms(:tag).each do |tag|
-        (prefix, rest) = tag.text.split(/:/, 2)
-        prefix = prefix.downcase.strip.gsub(/\s/, '_')
-        unless rest.nil?
-          # this part will index a value in a field specific to the tag, e.g. registered_by_tag_*,
-          # book_tag_*, project_tag_*, remediated_by_tag_*, etc.  project_tag_* and registered_by_tag_*
-          # definitley get used, but most don't.  we can limit the prefixes that get solrized if things
-          # get out of hand.
-          add_solr_value(solr_doc, "#{prefix}_tag", rest.strip, :symbol, [])
-        end
-
-        # solrize each possible prefix for the tag, inclusive of the full tag.
-        # e.g., for a tag such as "A : B : C", this will solrize to an _ssim field
-        # that contains ["A",  "A : B",  "A : B : C"].
-        tag_parts = tag.text.split(/:/)
-        progressive_tag_prefix = ''
-        tag_parts.each_with_index do |part, index|
-          progressive_tag_prefix += ' : ' if index > 0
-          progressive_tag_prefix += part.strip
-          add_solr_value(solr_doc, 'exploded_tag', progressive_tag_prefix, :symbol, [])
-        end
-      end
-
-      solr_doc
-    end
-
-    # maintain AF < 8 indexing behavior
-    def prefix
-      ''
-    end
-
     private
 
     # Convert one release element into a Hash

data/lib/dor/datastreams/rights_metadata_ds.rb

@@ -20,6 +20,14 @@ module Dor
         t.human
       end
 
+      t._read(path: 'access', attributes: { type: 'read' }) do
+        t.machine do
+          t.embargo_release_date(path: 'embargoReleaseDate', type: :time)
+        end
+      end
+
+      t.embargo_release_date(proxy: %i[_read machine embargo_release_date])
+
       t.creative_commons path: '/use/machine[@type=\'creativeCommons\']', type: 'creativeCommons' do
         t.uri path: '@uri'
       end
@@ -136,73 +144,6 @@ module Dor
       @dra_object = nil # until TODO complete, we'll expect to have to reparse after modification
     end
 
-    def to_solr(solr_doc = {}, *args)
-      solr_doc = super(solr_doc, *args)
-      dra = dra_object
-      solr_doc['rights_primary_ssi'] = dra.index_elements[:primary]
-      solr_doc['rights_errors_ssim'] = dra.index_elements[:errors] if dra.index_elements[:errors].size > 0
-      solr_doc['rights_characteristics_ssim'] = dra.index_elements[:terms] if dra.index_elements[:terms].size > 0
-
-      solr_doc['rights_descriptions_ssim'] = [
-        dra.index_elements[:primary],
-
-        (dra.index_elements[:obj_locations_qualified] || []).map do |rights_info|
-          rule_suffix = rights_info[:rule] ? " (#{rights_info[:rule]})" : ''
-          "location: #{rights_info[:location]}#{rule_suffix}"
-        end,
-        (dra.index_elements[:file_locations_qualified] || []).map do |rights_info|
-          rule_suffix = rights_info[:rule] ? " (#{rights_info[:rule]})" : ''
-          "location: #{rights_info[:location]} (file)#{rule_suffix}"
-        end,
-
-        (dra.index_elements[:obj_agents_qualified] || []).map do |rights_info|
-          rule_suffix = rights_info[:rule] ? " (#{rights_info[:rule]})" : ''
-          "agent: #{rights_info[:agent]}#{rule_suffix}"
-        end,
-        (dra.index_elements[:file_agents_qualified] || []).map do |rights_info|
-          rule_suffix = rights_info[:rule] ? " (#{rights_info[:rule]})" : ''
-          "agent: #{rights_info[:agent]} (file)#{rule_suffix}"
-        end,
-
-        (dra.index_elements[:obj_groups_qualified] || []).map do |rights_info|
-          rule_suffix = rights_info[:rule] ? " (#{rights_info[:rule]})" : ''
-          "#{rights_info[:group]}#{rule_suffix}"
-        end,
-        (dra.index_elements[:file_groups_qualified] || []).map do |rights_info|
-          rule_suffix = rights_info[:rule] ? " (#{rights_info[:rule]})" : ''
-          "#{rights_info[:group]} (file)#{rule_suffix}"
-        end,
-
-        (dra.index_elements[:obj_world_qualified] || []).map do |rights_info|
-          rule_suffix = rights_info[:rule] ? " (#{rights_info[:rule]})" : ''
-          "world#{rule_suffix}"
-        end,
-        (dra.index_elements[:file_world_qualified] || []).map do |rights_info|
-          rule_suffix = rights_info[:rule] ? " (#{rights_info[:rule]})" : ''
-          "world (file)#{rule_suffix}"
-        end
-      ].flatten.uniq
-
-      # these two values are returned by index_elements[:primary], but are just a less granular version of
-      # what the other more specific fields return, so discard them
-      solr_doc['rights_descriptions_ssim'] -= %w[access_restricted access_restricted_qualified world_qualified]
-      solr_doc['rights_descriptions_ssim'] += ['dark (file)'] if dra.index_elements[:terms].include? 'none_read_file'
-
-      solr_doc['obj_rights_locations_ssim'] = dra.index_elements[:obj_locations] unless dra.index_elements[:obj_locations].blank?
-      solr_doc['file_rights_locations_ssim'] = dra.index_elements[:file_locations] unless dra.index_elements[:file_locations].blank?
-      solr_doc['obj_rights_agents_ssim'] = dra.index_elements[:obj_agents] unless dra.index_elements[:obj_agents].blank?
-      solr_doc['file_rights_agents_ssim'] = dra.index_elements[:file_agents] unless dra.index_elements[:file_agents].blank?
-
-      # suppress empties
-      %w(use_statement_ssim copyright_ssim).each do |key|
-        solr_doc[key] = solr_doc[key].reject(&:blank?).flatten unless solr_doc[key].nil?
-      end
-      add_solr_value(solr_doc, 'use_license_machine', use_license.first, :string, [:stored_sortable])
-      add_solr_value(solr_doc, 'use_licenses_machine', use_license, :symbol, [:stored_searchable])
-
-      solr_doc
-    end
-
     def use_license
       use_license = []
       use_license += Array(creative_commons)
@@ -211,11 +152,6 @@ module Dor
       use_license.reject(&:blank?)
     end
 
-    # maintain AF < 8 indexing behavior
-    def prefix
-      ''
-    end
-
     def rights
       xml = ng_xml
       if xml.search('//rightsMetadata/access[@type=\'read\']/machine/group').length == 1

data/lib/dor/models/abstract.rb

@@ -76,11 +76,11 @@ module Dor
 
     delegate :full_title, :stanford_mods, to: :descMetadata
     delegate :rights, to: :rightsMetadata
-    delegate :catkey, :catkey=, :source_id, :source_id=,
+    delegate :catkey, :catkey=, :source_id, :source_id=, :barcode, :barcode=,
              :objectId, :objectId=, :objectCreator, :objectCreator=,
              :objectLabel, :objectLabel=, :objectType, :objectType=,
-             :other_ids=, :otherId, :tag=, :tags, :release_tags,
-             :previous_catkeys, :content_type_tag, to: :identityMetadata
+             :other_ids=, :otherId, :release_tags, :previous_catkeys,
+             to: :identityMetadata
 
     def read_rights=(rights)
       rightsMetadata.set_read_rights(rights)

data/lib/dor/models/admin_policy_object.rb

@@ -1,13 +1,16 @@
 # frozen_string_literal: true
 
+require 'deprecation'
+
 module Dor
   class AdminPolicyObject < Dor::Abstract
+    extend Deprecation
     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'
-    belongs_to :agreement_object, property: :referencesAgreement, class_name: 'Dor::Item'
+    belongs_to :agreement_object, property: :referencesAgreement, class_name: 'Dor::Agreement'
 
     delegate :add_roleplayer, :purge_roles, :roles, to: :roleMetadata
     delegate :mods_title, :mods_title=, to: :descMetadata
@@ -29,11 +32,13 @@ module Dor
     def agreement
       agreement_object ? agreement_object.pid : ''
     end
+    deprecation_deprecate agreement: 'use #agreement_object_id instead'
 
     def agreement=(val)
       raise ArgumentError, 'agreement must have a valid druid' if val.blank?
 
       self.agreement_object = Dor.find val.to_s, cast: true
     end
+    deprecation_deprecate :agreement= => 'use #agreement_object_id= instead'
   end
 end

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

@@ -17,10 +17,12 @@ module Dor
     def release_embargo(release_agent = 'unknown')
       embargo_service.release(release_agent)
     end
+    deprecation_deprecate release_embargo: 'this moved to dor-service-app'
 
     def release_20_pct_vis_embargo(release_agent = 'unknown')
       embargo_service.release_20_pct_vis(release_agent)
     end
+    deprecation_deprecate release_20_pct_vis_embargo: 'this moved to dor-service-app'
 
     def embargoed?
       embargoMetadata.status == 'embargoed'
@@ -29,6 +31,7 @@ module Dor
     def update_embargo(new_date)
       embargo_service.update(new_date)
     end
+    deprecation_deprecate update_embargo: 'Use the method in EmbargoService instead'
 
     def embargo_service
       EmbargoService.new(self)

data/lib/dor/models/etd.rb

@@ -22,10 +22,11 @@ module Dor
                    :regactiondttm, :documentaccess, :submit_date, :symphonyStatus,
                    datastream: 'properties', multiple: false
 
-    has_attributes :citation_verified, :abstract_provided, :dissertation_uploaded,
-                   :supplemental_files_uploaded, :permissions_provided,
-                   :permission_files_uploaded, :rights_selected,
-                   :cc_license_selected, :submitted_to_registrar,
+    has_attributes :citation_verified, :abstract_provided, :format_reviewed,
+                   :dissertation_uploaded, :supplemental_files_uploaded,
+                   :permissions_provided, :permission_files_uploaded,
+                   :rights_selected, :cc_license_selected,
+                   :submitted_to_registrar,
                    datastream: 'workflow', multiple: false
 
     has_metadata name: 'properties', type: ActiveFedora::SimpleDatastream, versionable: false do |m|
@@ -77,6 +78,7 @@ module Dor
     has_metadata name: 'workflow', type: ActiveFedora::SimpleDatastream, versionable: false do |m|
       m.field 'citation_verified', :string
       m.field 'abstract_provided', :string
+      m.field 'format_reviewed', :string
       m.field 'dissertation_uploaded', :string
       m.field 'supplemental_files_uploaded', :string
       m.field 'permissions_provided', :string

data/lib/dor/services/embargo_service.rb

@@ -35,6 +35,7 @@ module Dor
 
       events.add_event('embargo', release_agent, 'Embargo released')
     end
+    deprecation_deprecate release: 'this moved to dor-service-app'
 
     def release_20_pct_vis(release_agent)
       # Set status to released
@@ -55,25 +56,16 @@ module Dor
 
       events.add_event('embargo', release_agent, '20% Visibility Embargo released')
     end
+    deprecation_deprecate release_20_pct_vis: 'this moved to dor-service-app'
 
     def update(new_date)
       raise ArgumentError, 'You cannot change the embargo date of an item that is not embargoed.' if embargoMetadata.status != 'embargoed'
       raise ArgumentError, 'You cannot set the embargo date to a past date.' if new_date.past?
 
-      updated = false
-      rightsMetadata.ng_xml.search('//embargoReleaseDate').each do |node|
-        node.content = new_date.beginning_of_day.utc.xmlschema
-        updated = true
-      end
-      rightsMetadata.ng_xml_will_change!
-      rightsMetadata.save
-      raise 'No release date in rights metadata, cannot proceed!' unless updated
-
-      embargoMetadata.ng_xml.xpath('//releaseDate').each do |node|
-        node.content = new_date.beginning_of_day.utc.xmlschema
-      end
-      embargoMetadata.ng_xml_will_change!
-      embargoMetadata.save
+      time = new_date.beginning_of_day.utc
+      rightsMetadata.embargo_release_date = time
+      embargoMetadata.release_date = time
+      obj.save!
     end
 
     private

data/lib/dor/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Dor
-  VERSION = '9.1.0'
+  VERSION = '9.5.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dor-services
 version: !ruby/object:Gem::Version
-  version: 9.1.0
+  version: 9.5.0
 platform: ruby
 authors:
 - Michael Klein
@@ -20,7 +20,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-11 00:00:00.000000000 Z
+date: 2020-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active-fedora
@@ -450,7 +450,6 @@ files:
 - lib/dor/services/open_data_license_service.rb
 - lib/dor/services/search_service.rb
 - lib/dor/services/suri_service.rb
-- lib/dor/services/tag_service.rb
 - lib/dor/static_config.rb
 - lib/dor/static_config/fedora_config.rb
 - lib/dor/static_config/solr_config.rb

data/lib/dor/services/tag_service.rb

@@ -1,100 +0,0 @@
-# frozen_string_literal: true
-
-module Dor
-  # Manage tags on an object
-  class TagService
-    def self.add(item, tag)
-      new(item).add(tag)
-    end
-
-    def self.remove(item, tag)
-      new(item).remove(tag)
-    end
-
-    def self.update(item, old_tag, new_tag)
-      new(item).update(old_tag, new_tag)
-    end
-
-    def initialize(item)
-      @item = item
-    end
-
-    # Add an administrative tag to an item, you will need to seperately save the item to write it to fedora
-    # @param tag [string] The tag you wish to add
-    def add(tag)
-      normalized_tag = validate_and_normalize_tag(tag, identity_metadata.tags)
-      identity_metadata.add_value(:tag, normalized_tag)
-    end
-
-    def remove(tag)
-      normtag = normalize_tag(tag)
-      tag_nodes
-        .select { |node| normalize_tag(node.content) == normtag }
-        .each { identity_metadata.ng_xml_will_change! }
-        .each(&:remove)
-        .any?
-    end
-
-    def update(old_tag, new_tag)
-      normtag = normalize_tag(old_tag)
-      tag_nodes
-        .select { |node| normalize_tag(node.content) == normtag }
-        .each { identity_metadata.ng_xml_will_change! }
-        .each { |node| node.content = normalize_tag(new_tag) }
-        .any?
-    end
-
-    private
-
-    attr_reader :item
-    def identity_metadata
-      item.identityMetadata
-    end
-
-    def tag_nodes
-      identity_metadata.ng_xml.search('//tag')
-    end
-
-    # turns a tag string into an array with one element per tag part.
-    # split on ":", disregard leading and trailing whitespace on tokens.
-    def split_tag_to_arr(tag_str)
-      tag_str.split(':').map(&:strip)
-    end
-
-    # turn a tag array back into a tag string with a standard format
-    def normalize_tag_arr(tag_arr)
-      tag_arr.join(' : ')
-    end
-
-    # take a tag string and return a normalized tag string
-    def normalize_tag(tag_str)
-      normalize_tag_arr(split_tag_to_arr(tag_str))
-    end
-
-    # take a proposed tag string and a list of the existing tags for the object being edited.  if
-    # the proposed tag is valid, return it in normalized form.  if not, raise an exception with an
-    # explanatory message.
-    def validate_and_normalize_tag(tag_str, existing_tag_list)
-      tag_arr = validate_tag_format(tag_str)
-
-      # note that the comparison for duplicate tags is case-insensitive, but we don't change case as part of the normalized version
-      # we return, because we want to preserve the user's intended case.
-      normalized_tag = normalize_tag_arr(tag_arr)
-      dupe_existing_tag = existing_tag_list.detect { |existing_tag| normalize_tag(existing_tag).casecmp(normalized_tag) == 0 }
-      raise "An existing tag (#{dupe_existing_tag}) is the same, consider using update_tag?" if dupe_existing_tag
-
-      normalized_tag
-    end
-
-    # Ensure that an administrative tag meets the proper mininum format
-    # @param tag_str [String] the tag
-    # @return [Array] the tag split into an array via ':'
-    def validate_tag_format(tag_str)
-      tag_arr = split_tag_to_arr(tag_str)
-      raise ArgumentError, "Invalid tag structure: tag '#{tag_str}' must have at least 2 elements" if tag_arr.length < 2
-      raise ArgumentError, "Invalid tag structure: tag '#{tag_str}' contains empty elements" if tag_arr.detect(&:empty?)
-
-      tag_arr
-    end
-  end
-end