Module: Dor::Identifiable

Extended by:
ActiveSupport::Concern
Includes:
Eventable, Upgradable, SolrDocHelper
Included in:
Abstract, AdminPolicyObject, Collection, Publishable, Set, WorkflowObject
Defined in:
lib/dor/models/identifiable.rb

Defined Under Namespace

Modules: ClassMethods

Constant Summary collapse

@@collection_hash =

Module-level variables, shared between ALL mixin includers (and ALL their includers/extenders)! used for caching found values

{}
@@apo_hash = 
{}

Instance Method Summary collapse

Methods included from Upgradable

add_upgrade_callback, included, run_upgrade_callbacks, #upgrade!

Methods included from Eventable

#add_event

Methods included from SolrDocHelper

#add_solr_value

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(sym, *args) ⇒ Object

Syntactic sugar for identifying applied DOR Concerns e.g., obj.is_identifiable? is the same as obj.is_a?(Dor::Identifiable)



41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/dor/models/identifiable.rb', line 41

def method_missing(sym, *args)
  if sym.to_s =~ /^is_(.+)\?$/
    begin
      klass = Dor.const_get $1.capitalize.to_sym
      return self.is_a?(klass)
    rescue NameError
      return false
    end
  else
    super
  end
end

Instance Method Details

#add_other_Id(type, val) ⇒ Object 



108
109
110
111
112
113
 
# File 'lib/dor/models/identifiable.rb', line 108

def add_other_Id(type, val)
  if identityMetadata.otherId(type).length > 0
    raise 'There is an existing entry for ' + type + ', consider using update_other_Id().'
  end
  identityMetadata.add_otherId(type + ':' + val)
end

#add_tag(tag) ⇒ Object

Add an administrative tag to an item, you will need to seperately save the item to write it to fedora

Parameters:

  • tag (string) —

    The tag you wish to add



177
178
179
180
181
 
# File 'lib/dor/models/identifiable.rb', line 177

def add_tag(tag)
  identity_metadata_ds = identityMetadata
  normalized_tag = validate_and_normalize_tag(tag, identity_metadata_ds.tags)
  identity_metadata_ds.add_value(:tag, normalized_tag)
end

#content_type_tag ⇒ Object

helper method to get just the content type tag



34
35
36
37
 
# File 'lib/dor/models/identifiable.rb', line 34

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

#get_related_obj_display_title(related_obj, default_title) ⇒ Object 



210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/dor/models/identifiable.rb', line 210

def get_related_obj_display_title(related_obj, default_title)
  if related_obj
    if related_obj.datastreams['DC'] && related_obj.datastreams['DC'].title
      return related_obj.datastreams['DC'].title
    else
      return related_obj.label
    end
  end

  default_title
end

#identity_metadata_source ⇒ String

Returns calculated value for Solr index.

Returns:

  • (String) —

    calculated value for Solr index



82
83
84
85
86
87
88
89
90
91
 
# File 'lib/dor/models/identifiable.rb', line 82

def identity_metadata_source
  if identityMetadata.otherId('catkey').first ||
     identityMetadata.otherId('barcode').first
    'Symphony'
  elsif identityMetadata.otherId('mdtoolkit').first
    'Metadata Toolkit'
  else
    'DOR'
  end
end

#initialize(attrs = {}) ⇒ Object 



21
22
23
24
25
26
 
# File 'lib/dor/models/identifiable.rb', line 21

def initialize(attrs = {})
  if Dor::Config.suri.mint_ids && !attrs[:pid]
    attrs = attrs.merge!({:pid => Dor::SuriService.mint_id, :new_object => true})
  end
  super
end

#normalize_tag(tag_str) ⇒ Object

take a tag string and return a normalized tag string



141
142
143
 
# File 'lib/dor/models/identifiable.rb', line 141

def normalize_tag(tag_str)
  normalize_tag_arr(split_tag_to_arr(tag_str))
end

#normalize_tag_arr(tag_arr) ⇒ Object

turn a tag array back into a tag string with a standard format



136
137
138
 
# File 'lib/dor/models/identifiable.rb', line 136

def normalize_tag_arr(tag_arr)
  tag_arr.join(' : ')
end

#remove_displayTypes ⇒ Object

Removes all displayTypes from an item in preparation of adding a new display type

Returns:

  • Boolean True if displayTypes were removed, False if no displayTypes were removed



193
194
195
196
197
198
199
200
 
# File 'lib/dor/models/identifiable.rb', line 193

def remove_displayTypes
  nodes = identityMetadata.ng_xml.search('//displayType')
  # NOTE: .each after search is different than normal ruby enumerator:
  # ~ ng_xml.search('//nonexistant_tag').each(&:foo) == 0
  # ~ [].each(&:foo) == []
  nodes.each(&:remove)
  nodes.any?
end

#remove_other_Id(type, val = nil) ⇒ Object 



122
123
124
125
126
127
 
# File 'lib/dor/models/identifiable.rb', line 122

def remove_other_Id(type, val = nil)
  identityMetadata.ng_xml.search('//otherId[@name=\'' + type + '\']')
    .select { |node| val.nil? || node.content == val }
    .each(&:remove)
    .any?
end

#remove_tag(tag) ⇒ Object 



183
184
185
186
187
188
189
 
# File 'lib/dor/models/identifiable.rb', line 183

def remove_tag(tag)
  normtag = normalize_tag(tag)
  identityMetadata.ng_xml.search('//tag')
    .select { |node| normalize_tag(node.content) == normtag }
    .each(&:remove)
    .any?
end

#source_id ⇒ Object

Convenience method



94
95
96
 
# File 'lib/dor/models/identifiable.rb', line 94

def source_id
  identityMetadata.sourceId
end

#source_id=(source_id) ⇒ String Also known as: set_source_id

Convenience method

Parameters:

  • source_id (String) —

    the new source identifier

Returns:

  • (String) —

    same value, as per Ruby assignment convention

Raises:

  • (ArgumentError) —

    see IdentityMetadataDS for logic



102
103
104
 
# File 'lib/dor/models/identifiable.rb', line 102

def source_id=(source_id)
  identityMetadata.sourceId = source_id
end

#split_tag_to_arr(tag_str) ⇒ Object

turns a tag string into an array with one element per tag part. split on “:”, disregard leading and trailing whitespace on tokens.



131
132
133
 
# File 'lib/dor/models/identifiable.rb', line 131

def split_tag_to_arr(tag_str)
  tag_str.split(':').map {|str| str.strip}
end

#tags ⇒ Object

helper method to get the tags as an array



29
30
31
 
# File 'lib/dor/models/identifiable.rb', line 29

def tags
  identityMetadata.tag
end

#to_solr(solr_doc = {}, *args) ⇒ Object 



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/dor/models/identifiable.rb', line 59

def to_solr(solr_doc = {}, *args)
  assert_content_model
  super(solr_doc, *args)

  solr_doc[Dor::INDEX_VERSION_FIELD] = Dor::VERSION
  solr_doc['indexed_at_dtsi'] = Time.now.utc.xmlschema
  datastreams.values.each do |ds|
    add_solr_value(solr_doc, 'ds_specs', ds.datastream_spec_string, :string, [:symbol]) unless ds.new?
  end

  add_solr_value(solr_doc, 'title_sort', label, :string, [:stored_sortable])

  rels_doc = Nokogiri::XML(datastreams['RELS-EXT'].content)
  apos = rels_doc.search('//rdf:RDF/rdf:Description/hydra:isGovernedBy', 'hydra' => 'http://projecthydra.org/ns/relations#', 'fedora' => 'info:fedora/fedora-system:def/relations-external#', 'rdf' => 'http://www.w3.org/1999/02/22-rdf-syntax-ns#')
  collections = rels_doc.search('//rdf:RDF/rdf:Description/fedora:isMemberOfCollection', 'fedora' => 'info:fedora/fedora-system:def/relations-external#', 'rdf' => 'http://www.w3.org/1999/02/22-rdf-syntax-ns#')
  solrize_related_obj_titles(solr_doc, apos, @@apo_hash, 'apo_title', 'nonhydrus_apo_title', 'hydrus_apo_title')
  solrize_related_obj_titles(solr_doc, collections, @@collection_hash, 'collection_title', 'nonhydrus_collection_title', 'hydrus_collection_title')

  solr_doc['metadata_source_ssi'] = identity_metadata_source
  solr_doc
end

#update_other_Id(type, new_val, val = nil) ⇒ Object 



115
116
117
118
119
120
 
# File 'lib/dor/models/identifiable.rb', line 115

def update_other_Id(type, new_val, val = nil)
  identityMetadata.ng_xml.search('//otherId[@name=\'' + type + '\']')
    .select { |node| val.nil? || node.content == val }
    .each  { |node| node.content = new_val }
    .any?
end

#update_tag(old_tag, new_tag) ⇒ Object 



202
203
204
205
206
207
208
 
# File 'lib/dor/models/identifiable.rb', line 202

def update_tag(old_tag, new_tag)
  normtag = normalize_tag(old_tag)
  identityMetadata.ng_xml.search('//tag')
    .select { |node| normalize_tag(node.content) == normtag }
    .each  { |node| node.content = normalize_tag(new_tag)  }
    .any?
end

#validate_and_normalize_tag(tag_str, existing_tag_list) ⇒ Object

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.



148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/dor/models/identifiable.rb', line 148

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).downcase == normalized_tag.downcase }
  if dupe_existing_tag
    raise "An existing tag (#{dupe_existing_tag}) is the same, consider using update_tag?"
  end
  normalized_tag
end

#validate_tag_format(tag_str) ⇒ Array

Ensure that an administrative tag meets the proper mininum format

Parameters:

  • tag_str (String) —

    the tag

Returns:

  • (Array) —

    the tag split into an array via ‘:’



164
165
166
167
168
169
170
171
172
173
 
# File 'lib/dor/models/identifiable.rb', line 164

def validate_tag_format(tag_str)
  tag_arr = split_tag_to_arr(tag_str)
  if tag_arr.length < 2
    raise ArgumentError, "Invalid tag structure: tag '#{tag_str}' must have at least 2 elements"
  end
  if tag_arr.detect {|str| str.empty?}
    raise ArgumentError, "Invalid tag structure: tag '#{tag_str}' contains empty elements"
  end
  tag_arr
end