Module: Dor::Identifiable

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

Defined Under Namespace

Modules: ClassMethods

Constant Summary collapse

@@collection_hash = 
{}
@@apo_hash = 
{}
@@hydrus_apo_hash = 
{}
@@hydrus_collection_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 



132
133
134
135
136
137
138
 
# File 'lib/dor/models/identifiable.rb', line 132

def add_other_Id(type, val)
  if identityMetadata.otherId(type).length > 0
    raise 'There is an existing entry for '+node_name+', consider using update_other_identifier.'
  end
  identity_metadata_ds = identityMetadata
  identity_metadata_ds.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



206
207
208
209
210
 
# File 'lib/dor/models/identifiable.rb', line 206

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

#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 = attrs.merge!({:pid => Dor::SuriService.mint_id, :new_object => true}) unless attrs[:pid]
  end
  super
end

#normalize_tag(tag_str) ⇒ Object

take a tag string and return a normalized tag string



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

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



172
173
174
 
# File 'lib/dor/models/identifiable.rb', line 172

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



227
228
229
230
231
232
233
234
 
# File 'lib/dor/models/identifiable.rb', line 227

def remove_displayTypes
  removed = false
  identityMetadata.ng_xml.search('//displayType').each do |node|
    node.remove
    removed = true
  end
  removed
end

#remove_other_Id(type, val = nil) ⇒ Object 



153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/dor/models/identifiable.rb', line 153

def remove_other_Id(type, val = nil)
  ds_xml = identityMetadata.ng_xml
  # split the thing they sent in to find the node name
  removed = false
  ds_xml.search('//otherId[@name=\''+type+'\']').each do |node|
    next unless node.content === val || val.nil?
    node.remove
    removed = true
  end
  removed
end

#remove_tag(tag) ⇒ Object 



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

def remove_tag(tag)
  identity_metadata_ds = identityMetadata
  ds_xml = identity_metadata_ds.ng_xml
  removed = false
  ds_xml.search('//tag').each do |node|
    if normalize_tag(node.content) === normalize_tag(tag)
      node.remove
      removed = true
    end
  end
  removed
end

#set_source_id(source_id) ⇒ Object 



128
129
130
 
# File 'lib/dor/models/identifiable.rb', line 128

def set_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.



167
168
169
 
# File 'lib/dor/models/identifiable.rb', line 167

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 



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/dor/models/identifiable.rb', line 58

def to_solr(solr_doc = {}, *args)
  assert_content_model
  super(solr_doc)
  solr_doc[Dor::INDEX_VERSION_FIELD] = Dor::VERSION
  solr_doc[solr_name('indexed_at', :date)] = Time.now.utc.xmlschema
  add_solr_value(solr_doc, 'indexed_day', Time.now.beginning_of_day.utc.xmlschema, :string, [:searchable, :facetable])
  datastreams.values.each do |ds|
    next if ds.new?
    add_solr_value(solr_doc, 'ds_specs', ds.datastream_spec_string, :string, [:displayable])
  end
  add_solr_value(solr_doc, 'title_sort', label, :string, [: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#' )
  apos.each do |apo_node|
    druid = apo_node['rdf:resource']
    next unless druid
    druid = druid.gsub('info:fedora/','')
    if @@apo_hash.has_key?(druid) || @@hydrus_apo_hash.has_key?(druid)
      add_solr_value(solr_doc, 'hydrus_apo_title', @@hydrus_apo_hash[druid], :string, [:searchable, :facetable]) if @@hydrus_apo_hash.has_key? druid
      add_solr_value(solr_doc, 'apo_title', @@apo_hash[druid] , :string, [:searchable, :facetable]) if @@apo_hash.has_key? druid
    else
      begin
        apo_object = Dor.find(druid)
        if apo_object.tags.include? 'Project : Hydrus'
          add_solr_value(solr_doc, 'hydrus_apo_title', apo_object.label, :string, [:searchable, :facetable])
          @@hydrus_apo_hash[druid] = apo_object.label
        else
          add_solr_value(solr_doc, 'apo_title', apo_object.label, :string, [:searchable, :facetable])
          @@apo_hash[druid] = apo_object.label
        end
      rescue
        add_solr_value(solr_doc, 'apo_title', druid, :string, [:searchable, :facetable])
      end
    end
  end
  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#')
  collections.each do |collection_node|
    druid = collection_node['rdf:resource']
    next unless druid
    druid = druid.gsub('info:fedora/', '')
    if @@collection_hash.has_key?(druid) || @@hydrus_collection_hash.has_key?(druid)
      add_solr_value(solr_doc, 'hydrus_collection_title', @@hydrus_collection_hash[druid], :string, [:searchable, :facetable]) if @@hydrus_collection_hash.has_key? druid
      add_solr_value(solr_doc, 'collection_title', @@collection_hash[druid], :string, [:searchable, :facetable]) if @@collection_hash.has_key? druid
    else
      begin
        collection_object = Dor.find(druid)
        if collection_object.tags.include? 'Project : Hydrus'
          add_solr_value(solr_doc, 'hydrus_collection_title', collection_object.label, :string, [:searchable, :facetable])
          @@hydrus_collection_hash[druid] = collection_object.label
        else
          add_solr_value(solr_doc, 'collection_title', collection_object.label, :string, [:searchable, :facetable])
          @@collection_hash[druid] = collection_object.label
        end
      rescue
        add_solr_value(solr_doc, 'collection_title', druid, :string, [:searchable, :facetable])
      end
    end
  end
  # Fix for ActiveFedora 3.3 to ensure all date fields are properly formatted as UTC XML Schema datetime strings
  solr_doc.each_pair { |k, v|
    next unless k =~ /(_dt|_date)$/
    if v.is_a?(Array)
      solr_doc[k] = v.collect { |t| Time.parse(t.to_s).utc.xmlschema }
    else
      solr_doc[k] = Time.parse(v.to_s).utc.xmlschema
    end
  }
  solr_doc
end

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



140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/dor/models/identifiable.rb', line 140

def update_other_Id(type, new_val, val = nil)
  identity_metadata_ds = identityMetadata
  ds_xml = identity_metadata_ds.ng_xml
  # split the thing they sent in to find the node name
  updated = false
  ds_xml.search('//otherId[@name=\''+type+'\']').each do |node|
    next unless node.content == val || val.nil?
    node.content = new_val
    updated = true
  end
  updated
end

#update_tag(old_tag, new_tag) ⇒ Object 



236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/dor/models/identifiable.rb', line 236

def update_tag(old_tag, new_tag)
  identity_metadata_ds = identityMetadata
  ds_xml = identity_metadata_ds.ng_xml
  updated = false
  ds_xml.search('//tag').each do |node|
    next unless normalize_tag(node.content) == normalize_tag(old_tag)
    node.content = normalize_tag(new_tag)
    updated = true
  end
  updated
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.



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

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 }
  raise "An existing tag (#{dupe_existing_tag}) is the same, consider using update_tag?" if dupe_existing_tag
  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 ‘:’



197
198
199
200
201
202
 
# File 'lib/dor/models/identifiable.rb', line 197

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