dor-services 5.1.0 → 5.1.1

data/lib/dor/models/admin_policy_object.rb

@@ -10,7 +10,7 @@ module Dor
     has_many :things, :property => :is_governed_by, :inbound => :true, :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 => "roleMetadata",           :type => Dor::RoleMetadataDS,           :label => 'Role Metadata'
+    has_metadata :name => "defaultObjectRights",    :type => Dor::DefaultObjectRightsDS,    :label => 'Default Object Rights'
   end
-end
+end

data/lib/dor/models/describable.rb

@@ -125,8 +125,8 @@ module Dor
         collection_title = Dor::Describable.get_collection_title(collection_obj)
         related_item_node=Nokogiri::XML::Node.new('relatedItem',doc)
         related_item_node['type']='host'
-        title_info_node=Nokogiri::XML::Node.new('titleInfo',doc)
-        title_node=Nokogiri::XML::Node.new('title',doc)
+        title_info_node = Nokogiri::XML::Node.new('titleInfo',doc)
+        title_node      = Nokogiri::XML::Node.new('title',doc)
         title_node.content=collection_title
 
         id_node=Nokogiri::XML::Node.new('identifier',doc)
@@ -185,7 +185,7 @@ module Dor
           title=node.text
         end
         creator_title=creator+title
-        add_solr_value(solr_doc, 'creator_title', creator_title , :string, [:sortable])
+        add_solr_value(solr_doc, 'creator_title', creator_title , :string, [:stored_sortable])
       rescue CrosswalkError => e
         ActiveFedora.logger.warn "Cannot index #{self.pid}.descMetadata: #{e.message}"
       end
@@ -197,7 +197,8 @@ module Dor
           solr_doc[solr_key].push *vals unless (vals.nil? || vals.empty?)
           # asterisk to avoid multi-dimensional array: push values, not the array
         end
-        solr_doc['sw_pub_date_sort_ssi'] = mods.pub_date_sort
+        solr_doc['sw_pub_date_sort_ssi' ] = mods.pub_date_sort  # e.g. '0800'
+        solr_doc['sw_pub_date_facet_ssi'] = mods.pub_date_facet # e.g. '9th century'
       end
       # some fields get explicit "(none)" placeholder values, mostly for faceting
       %w[sw_language_tesim sw_genre_tesim sw_format_tesim].each { |key| solr_doc[key] = ['(none)'] if solr_doc[key].empty? }

data/lib/dor/models/editable.rb

@@ -1,22 +1,25 @@
-module Dor  
+module Dor
+
+  ## This is basically used just by APOs.  Arguably "editable" is the wrong name.
   module Editable
     extend ActiveSupport::Concern
 
     included do
       belongs_to :agreement_object, :property => :referencesAgreement, :class_name => "Dor::Item"
     end
-    
+
     def to_solr(solr_doc=Hash.new, *args)
       super(solr_doc, *args)
-      add_solr_value(solr_doc, "default_rights", default_rights, :string, [:facetable])
-      add_solr_value(solr_doc, "agreement", agreement, :string, [:facetable]) if agreement_object
+      add_solr_value(solr_doc, "default_rights", default_rights, :string, [:symbol])
+      add_solr_value(solr_doc, "agreement", agreement, :string, [:symbol]) if agreement_object
       solr_doc
     end
+
     #Adds a person or group to a role in the APO role metadata datastream
     #
-    #@param role [String] the role the group or person will be filed under, ex. dor-apo-manager
+    #@param role   [String] the role the group or person will be filed under, ex. dor-apo-manager
     #@param entity [String] the name of the person or group, ex dlss:developers or sunetid:someone
-    #@param type [Symbol] :workgroup for a group or :person for a person
+    #@param type   [Symbol] :workgroup for a group or :person for a person
     def add_roleplayer role, entity, type=:workgroup
       xml=self.roleMetadata.ng_xml
       group = type == :workgroup ? 'group' : 'person'
@@ -41,8 +44,9 @@ module Dor
       end
       self.roleMetadata.content=xml.to_s
     end
+
     #remove all people groups and roles from the APO role metadata datastream
-    def purge_roles 
+    def purge_roles
       self.roleMetadata.ng_xml.search('/roleMetadata/role').each do |node|
         node.remove
       end
@@ -56,10 +60,10 @@ module Dor
     end
     #get all collections listed for this APO, used during registration
     #@return [Array] array of pids
-    def default_collections 
+    def default_collections
       return administrativeMetadata.term_values(:registration, :default_collection)
     end
-    #Add a collection to the listing of collections for items governed by this apo. 
+    #Add a collection to the listing of collections for items governed by this apo.
     #@param val [String] pid of the collection, ex. druid:ab123cd4567
     def add_default_collection val
       xml = self.administrativeMetadata.ng_xml
@@ -73,7 +77,7 @@ module Dor
       reg.add_child(node)
       self.administrativeMetadata.content=xml.to_s
     end
-    
+
     def remove_default_collection val
       xml = self.administrativeMetadata.ng_xml
       xml.search('//administrativeMetadata/registration/collection[@id=\''+val+'\']').remove
@@ -91,7 +95,7 @@ module Dor
       end
       roles
     end
-    def metadata_source 
+    def metadata_source
       self.administrativeMetadata.metadata_source.first
     end
     def metadata_source=(val)
@@ -131,23 +135,18 @@ module Dor
        self.defaultObjectRights.add_child_node(self.defaultObjectRights.ng_xml.root, :creative_commons)
       end
       self.defaultObjectRights.update_values({[:creative_commons_human] => val})
-      
     end
     #@return [String] A description of the rights defined in the default object rights datastream. Can be 'Stanford', 'World', 'Dark' or 'None'
     def default_rights
       xml=self.defaultObjectRights.ng_xml
       if xml.search('//rightsMetadata/access[@type=\'read\']/machine/group').length == 1
         'Stanford'
+      elsif xml.search('//rightsMetadata/access[@type=\'read\']/machine/world').length ==1
+        'World'
+      elsif xml.search('//rightsMetadata/access[@type=\'discover\']/machine/none').length == 1
+        'Dark'
       else
-        if xml.search('//rightsMetadata/access[@type=\'read\']/machine/world').length ==1
-          'World'
-        else
-          if xml.search('//rightsMetadata/access[@type=\'discover\']/machine/none').length == 1
-            'Dark'
-          else
-            'None'
-          end
-        end
+        'None'
       end
     end
     #Set the rights in default object rights
@@ -157,36 +156,33 @@ module Dor
       rights_xml = self.defaultObjectRights.ng_xml
       rights_xml.search('//rightsMetadata/access[@type=\'discover\']/machine').each do |node|
         node.children.remove
-        if rights=='dark'
-            world_node=Nokogiri::XML::Node.new('none',rights_xml)
-            node.add_child(world_node)
-        else
-            world_node=Nokogiri::XML::Node.new('world',rights_xml)
-          node.add_child(world_node)
-        end
+        world_node=Nokogiri::XML::Node.new((rights=='dark' ? 'none' : 'world'),rights_xml)
+        node.add_child(world_node)
       end
       rights_xml.search('//rightsMetadata/access[@type=\'read\']').each do |node|
         node.children.remove
         machine_node=Nokogiri::XML::Node.new('machine',rights_xml)
-        if(rights=='world')
+        if rights == 'world'
           world_node=Nokogiri::XML::Node.new(rights,rights_xml)
           node.add_child(machine_node)
           machine_node.add_child(world_node)
-        elsif rights=='stanford'
+        elsif rights == 'stanford'
           world_node=Nokogiri::XML::Node.new(rights,rights_xml)
           node.add_child(machine_node)
           group_node=Nokogiri::XML::Node.new('group',rights_xml)
           group_node.content="Stanford"
           node.add_child(machine_node)
           machine_node.add_child(group_node)
-        elsif rights=='none' || rights == 'dark'
+        elsif rights == 'none' || rights == 'dark'
           none_node=Nokogiri::XML::Node.new('none',rights_xml)
           node.add_child(machine_node)
           machine_node.add_child(none_node)
+        else
+          raise ArgumentError, "Unrecognized rights value '#{rights}'"
         end
       end
     end
-    
+
     def desc_metadata_format
       self.administrativeMetadata.metadata_format.first
     end
@@ -220,7 +216,7 @@ module Dor
         wfs
       else
         []
-      end      
+      end
     end
     #set a single default workflow
     #@param wf [String] the name of the workflow, ex. 'digitizationWF'

data/lib/dor/models/embargoable.rb

@@ -39,17 +39,6 @@ module Dor
       datastreams['events'].add_event("embargo", release_agent, "Embargo released")
     end
 
-    def world_doc
-      builder = Nokogiri::XML::Builder.new do |xml|
-        xml.access(:type => 'read') {
-          xml.machine {
-            xml.world
-          }
-        }
-      end
-      return builder.doc
-    end
-
     def release_20_pct_vis_embargo(release_agent="unknown")
       # Set status to released
       embargo_md = datastreams['embargoMetadata']
@@ -73,7 +62,7 @@ module Dor
 
     def update_embargo(new_date)
       if embargoMetadata.status != 'embargoed'
-        raise ArgumentError, 'You cannot change the embargo date of an item thant isnt embargoed.'
+        raise ArgumentError, 'You cannot change the embargo date of an item that is not embargoed.'
       end
       if new_date.past?
         raise ArgumentError, 'You cannot set the embargo date to a past date.'

data/lib/dor/models/governable.rb

@@ -1,6 +1,7 @@
 module Dor
   module Governable
     extend ActiveSupport::Concern
+    include Rightsable
 
     included do
       belongs_to :admin_policy_object, :property => :is_governed_by, :class_name => "Dor::AdminPolicyObject"
@@ -26,36 +27,11 @@ module Dor
     end
 
     def reset_to_apo_default()
-      rights_metadata_ds = self.rightsMetadata
-      rights_metadata_ds.content = admin_policy_object.rightsMetadata.ng_xml
+      self.rightsMetadata.content = admin_policy_object.rightsMetadata.ng_xml
     end
 
-    # slight misnomer: also sets discover rights!
     def set_read_rights(rights)
-      raise(ArgumentError, "Argument '#{rights}' is not a recognized value") unless ['world','stanford','none','dark'].include? rights
-      rights_xml = self.rightsMetadata.ng_xml
-      if (rights_xml.search('//rightsMetadata/access[@type=\'read\']').length==0)
-        raise('The rights metadata stream doesnt contain an entry for machine read permissions. Consider populating it from the APO before trying to change it.')
-      end
-      label = rights=='dark' ? 'none' : 'world'
-      rights_xml.search('//rightsMetadata/access[@type=\'discover\']/machine').each do |node|
-        node.children.remove
-        node.add_child Nokogiri::XML::Node.new(label,rights_xml)
-      end
-      rights_xml.search('//rightsMetadata/access[@type=\'read\']').each do |node|
-        node.children.remove
-        machine_node = Nokogiri::XML::Node.new('machine',rights_xml)
-        node.add_child(machine_node)
-        if rights == 'world'
-          machine_node.add_child Nokogiri::XML::Node.new(rights,rights_xml)
-        elsif rights == 'stanford'
-          group_node = Nokogiri::XML::Node.new('group',rights_xml)
-          group_node.content = "Stanford"
-          machine_node.add_child(group_node)
-        else  # we know it is none or dark by the argument filter (first line)
-          machine_node.add_child Nokogiri::XML::Node.new('none',rights_xml)
-        end
-      end
+      self.rightsMetadata.set_read_rights(rights)
     end
 
     def add_collection(collection_or_druid)
@@ -87,6 +63,7 @@ module Dor
     end
     def rights
       return nil unless self.respond_to? :rightsMetadata
+      return nil if self.rightsMetadata.nil?
       xml = self.rightsMetadata.ng_xml
       return nil if xml.search('//rightsMetadata').length != 1      # ORLY?
       if xml.search('//rightsMetadata/access[@type=\'read\']/machine/group').length == 1

data/lib/dor/models/identifiable.rb

@@ -53,73 +53,31 @@ module Dor
       end
     end
 
-    ## Module-level variables, shared between ALL mixin includers!
+    ## Module-level variables, shared between ALL mixin includers (and ALL *their* includers/extenders)!
+    ## used for caching found values
     @@collection_hash={}
     @@apo_hash={}
-    @@hydrus_apo_hash={}
-    @@hydrus_collection_hash={}
 
     def to_solr(solr_doc=Hash.new, *args)
       self.assert_content_model
       super(solr_doc, *args)
+
       solr_doc[Dor::INDEX_VERSION_FIELD] = Dor::VERSION
-      solr_doc['indexed_at_dtsi' ] = Time.now.utc.xmlschema
-      solr_doc['indexed_day_dtsi'] = Time.now.beginning_of_day.utc.xmlschema  # technically unnecessary, but convenient
+      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,[:displayable]) unless ds.new?
+        add_solr_value(solr_doc, 'ds_specs', ds.datastream_spec_string, :string, [:symbol]) unless ds.new?
       end
-      add_solr_value(solr_doc, 'title_sort', self.label, :string, [:sortable])
-      title_attrs = [:searchable, :facetable, :displayable]
+
+      add_solr_value(solr_doc, 'title_sort', self.label, :string, [:stored_sortable])
+
       rels_doc = Nokogiri::XML(self.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   # TODO: a warning about the bad APO would be nice
-        druid=druid.gsub('info:fedora/','')
-        # check cache first
-        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, title_attrs) if @@hydrus_apo_hash.has_key? druid
-          add_solr_value(solr_doc, "apo_title", @@apo_hash[druid] , :string, title_attrs) 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, title_attrs)
-              @@hydrus_apo_hash[druid]=apo_object.label
-            else
-              add_solr_value(solr_doc, "apo_title", apo_object.label, :string, title_attrs)
-              @@apo_hash[druid]=apo_object.label
-            end
-          rescue
-            add_solr_value(solr_doc, "apo_title", druid, :string, title_attrs)
-          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     ## TODO: warning here would also be useful
-        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, title_attrs) if @@hydrus_collection_hash.has_key? druid
-          add_solr_value(solr_doc, "collection_title", @@collection_hash[druid], :string, title_attrs) 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, title_attrs)
-              @@hydrus_collection_hash[druid]=collection_object.label
-            else
-              add_solr_value(solr_doc, "collection_title", collection_object.label, :string, title_attrs)
-              @@collection_hash[druid]=collection_object.label
-            end
-          rescue
-            add_solr_value(solr_doc, "collection_title", druid, :string, title_attrs)
-          end
-        end
-      end
+      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")
+      solrize_related_obj_titles(solr_doc, collections, @@collection_hash, "collection_title")
+
       solr_doc["metadata_source_ssi"] = self.identity_metadata_source
-      solr_doc
+      return solr_doc
     end
 
     #@return [String] calculated value for Solr index
@@ -202,7 +160,7 @@ module Dor
 
     #Ensure that an administrative tag meets the proper mininum format
     #
-    #@params tag_str [String] the tag
+    #@param tag_str [String] the tag
     #
     #@return [Array] the tag split into an array via ':'
     def validate_tag_format(tag_str)
@@ -220,7 +178,7 @@ module Dor
 
     #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
+    #@param tag [string] The tag you wish to add
     def add_tag(tag)
         identity_metadata_ds = self.identityMetadata
         normalized_tag = validate_and_normalize_tag(tag, identity_metadata_ds.tags)
@@ -237,6 +195,18 @@ module Dor
       end
       return removed
     end
+    
+    #Removes all displayTypes from an item in preparation of adding a new display type
+    #
+    #@return Boolean True if displayTypes were removed, False if no displayTypes were removed
+    def remove_displayTypes
+      removed = false
+      self.identityMetadata.ng_xml.search('//displayType').each do |node|
+          node.remove
+          removed = true
+      end
+      return removed
+    end
 
     def update_tag(old_tag, new_tag)
       updated = false
@@ -248,5 +218,37 @@ module Dor
       end
       return updated
     end
+
+    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
+
+      return default_title
+    end
+
+
+    private
+    def solrize_related_obj_titles(solr_doc, relationships, title_hash, field_name)
+      title_type = :symbol  # we'll get an _ssim because of the type
+      title_attrs = [:stored_searchable]  # we'll also get a _tesim from this attr
+      relationships.each do |rel_node|
+        rel_druid = rel_node['rdf:resource']
+        next unless rel_druid   # TODO: warning here would also be useful
+        rel_druid = rel_druid.gsub('info:fedora/', '')
+        if title_hash.has_key?(rel_druid)
+          add_solr_value(solr_doc, field_name, title_hash[rel_druid], title_type, title_attrs)
+        else
+          related_obj = Dor.find(rel_druid)
+          related_obj_title = get_related_obj_display_title(related_obj, rel_druid)
+          add_solr_value(solr_doc, field_name, related_obj_title, title_type, title_attrs)
+          title_hash[rel_druid] = related_obj_title
+        end
+      end
+    end
   end
 end

data/lib/dor/models/item.rb

@@ -1,23 +1,19 @@
 module Dor
   module BasicItem
     extend ActiveSupport::Concern
-    
-    include Identifiable
+
     include Processable
-    include Governable
-    include Describable
-    include Publishable
     include Shelvable
-    include Embargoable
+    include Embargoable # implies Publishable implies Identifiable, Describable, Governable, Rightsable ...
     include Preservable
     include Assembleable
     include Versionable
     include Contentable
     include Geoable
-    include Releasable
-    
+    include Releaseable
+
   end
-  
+
   class Abstract < ::ActiveFedora::Base
     include Identifiable
   end