dor-services 5.1.1 → 5.2.0

data/lib/dor/models/publishable.rb

@@ -33,7 +33,7 @@ module Dor
 
       im=self.datastreams['identityMetadata'].ng_xml.clone
       im.search('//release').each {|node| node.remove} # remove any <release> tags from public xml which have full history
-      im.root.add_child(release_xml) 
+      im.root.add_child(release_xml)
 
       pub.add_child(im.root) # add in modified identityMetadata datastream
       pub.add_child(self.datastreams['contentMetadata'].public_xml.root.clone)
@@ -54,7 +54,7 @@ module Dor
     #  otherwise, it prunes the object's metadata from the document cache
     def publish_metadata
       rights = datastreams['rightsMetadata'].ng_xml.clone.remove_namespaces!
-      if(rights.at_xpath("//rightsMetadata/access[@type='discover']/machine/world"))
+      if rights.at_xpath("//rightsMetadata/access[@type='discover']/machine/world")
         dc_xml = self.generate_dublin_core.to_xml {|config| config.no_declaration}
         DigitalStacksService.transfer_to_document_store(pid, dc_xml, 'dc')
         DigitalStacksService.transfer_to_document_store(pid, self.datastreams['identityMetadata'].to_xml, 'identityMetadata')

data/lib/dor/models/releaseable.rb

@@ -5,126 +5,113 @@ module Dor
   module Releaseable
     extend ActiveSupport::Concern
     include Itemizable
-        
-    #Add release tags to an item and initialize the item release workflow
-    #
-    #@params release_tags [Hash or Array] Either a hash of a single release tag.  Each tag should be in the form of {:tag=>'Fitch : Batch2',:what=>'self',:to=>'Searchworks',:who=>'petucket', :release=>true/false}
-    #
-    #@raise [ArgumentError] Raised if the tags are improperly supplied
-    #
-    #
+
+    # Add release tags to an item and initialize the item release workflow
+    # Each tag should be of the form !{:tag => 'Fitch : Batch2', :what => 'self', :to => 'Searchworks', :who => 'petucket', :release => true}
+    # @param release_tags [Hash, Array<Hash>] hash of a single release tag or an array of many such hashes
+    # @raise [ArgumentError] Raised if the tags are improperly supplied
     def add_release_nodes_and_start_releaseWF(release_tags)
       release_tags = [release_tags] unless release_tags.class == Array
-      
+
       #Add in each tag
       release_tags.each do |r_tag|
         self.add_release_node(r_tag[:release],r_tag)
       end
-      
+
       #Save the item to dor so the robots work with the latest data
-      self.save 
-      
+      self.save
+
       #Intialize the release workflow
-      self.initialize_workflow('releaseWF') 
+      self.initialize_workflow('releaseWF')
     end
 
-    #Generate XML structure for inclusion to Purl
-    #
-    #@return [String] The XML release node as a string, with ReleaseDigest as the root document
+    # Generate XML structure for inclusion to Purl
+    # @return [String] The XML release node as a string, with ReleaseDigest as the root document
     def generate_release_xml
       builder = Nokogiri::XML::Builder.new do |xml|
         xml.releaseData {
-          self.released_for.each do |project,released_value|
+          self.released_for.each do |project, released_value|
             xml.release(released_value["release"],:to=>project)
-          end  
+          end
         }
         end
       return builder.to_xml
     end
-    
-    #Determine which projects an item is released for
-    #
-    #@return [Hash] all namespaces in the form of {"Project" => Boolean}
+
+    # Determine which projects an item is released for
+    # @return [Hash{String => Boolean}] all namespaces, keys are Project name Strings, values are Boolean
     def released_for
       released_hash = {}
-      
-      #Get release tags on the item itself 
+
+      #Get release tags on the item itself
       release_tags_on_this_item = self.release_nodes
-      
+
       #Get any self tags on this item
       self_release_tags = self.get_self_release_tags(release_tags_on_this_item)
-      
+
       #Get the most recent self tag for all targets and save their result since most recent self always trumps any other non self tags
       latest_self_tags = self.get_newest_release_tag(self_release_tags)
       latest_self_tags.keys.each do |target|
         released_hash[target] =  self.clean_release_tag_for_purl(latest_self_tags[target])
       end
-      
-      #With Self Tags Resolved We Now need to deal with tags on all sets this object is part of 
-      
+
+      #With Self Tags Resolved We Now need to deal with tags on all sets this object is part of
+
       potential_applicable_release_tags = {}  #This will be where we store all tags that apply, regardless of their timestamp
-       
-      #Get all release tags on the item and strip out the what = self ones, we've already processed all the self tags on this item 
+
+      #Get all release tags on the item and strip out the what = self ones, we've already processed all the self tags on this item
       potential_applicable_release_tags = get_tags_for_what_value(self.get_release_tags_for_item_and_all_governing_sets, 'collection')
-      
+
       administrative_tags = self.tags  #Get them once here and pass them down
-      
+
       #We now have the keys for all potential releases, we need to check the tags and the most recent time stamp with an explicit true or false wins, in a nil case, the lack of an explicit false tag we do nothing
       (potential_applicable_release_tags.keys-released_hash.keys).each do |key|  #don't bother checking the ones already added to the release hash, they were added due to a self tag and that has won
         latest_applicable_tag_for_key = latest_applicable_release_tag_in_array(potential_applicable_release_tags[key], administrative_tags)
-        if latest_applicable_tag_for_key != nil #We have a valid tag, record it
-          released_hash[key] = self.clean_release_tag_for_purl(latest_applicable_tag_for_key) 
+        unless latest_applicable_tag_for_key.nil? #We have a valid tag, record it
+          released_hash[key] = self.clean_release_tag_for_purl(latest_applicable_tag_for_key)
         end
-        
+
       end
-      
+
       #See what the application is currently released for on Purl.  If something is released in purl but not listed here, it needs to be added as a false
       released_hash = self.add_tags_from_purl(released_hash)
-        
+
       return released_hash
     end
-    
-    #Take a hash of tags as obtained via Dor::Item.release_tags and returns all self tags
-    #
-    #@param tags [Hash] a hash of tags obtained via Dor::Item.release_tags or matching format
-    #
-    #@return [Hash] a hash of self tags for each to value
+
+    # Take a hash of tags as obtained via Dor::Item.release_tags and returns all self tags
+    # @param tags [Hash] a hash of tags obtained via Dor::Item.release_tags or matching format
+    # @return [Hash] a hash of self tags for each to value
     def get_self_release_tags(tags)
       return get_tags_for_what_value(tags, 'self')
     end
-    
-    #Take an item and get all of its release tags and all tags on collections it is a member of it
-    #
-    #
-    #@return [Hash] a hash of all tags
+
+    # Take an item and get all of its release tags and all tags on collections it is a member of it
+    # @return [Hash] a hash of all tags
     def get_release_tags_for_item_and_all_governing_sets
       return_tags = self.release_nodes || {}
       self.collections.each do |collection|
         return_tags = combine_two_release_tag_hashes(return_tags, Dor::Item.find(collection.id).get_release_tags_for_item_and_all_governing_sets) #this will function recurvisely so parents of parents are found
       end
-      return return_tags  
+      return return_tags
     end
-    
-    #Take two hashes of tags and combine them, will not overwrite but will enforce uniqueness of the tags
-    #
-    #@param hash_one [Hash] a hash of tags obtained via Dor::Item.release_tags or matching format
-    #@param hash_two [Hash] a hash of tags obtained via Dor::Item.release_tags or matching format
-    #
-    #@return [Hash] the combined hash with uniquiness enforced 
+
+    # Take two hashes of tags and combine them, will not overwrite but will enforce uniqueness of the tags
+    # @param hash_one [Hash] a hash of tags obtained via Dor::Item.release_tags or matching format
+    # @param hash_two [Hash] a hash of tags obtained via Dor::Item.release_tags or matching format
+    # @return [Hash] the combined hash with uniquiness enforced
     def combine_two_release_tag_hashes(hash_one, hash_two)
       hash_two.keys.each do |key|
-        hash_one[key] = hash_two[key] if hash_one[key] == nil
-        hash_one[key] = (hash_one[key] + hash_two[key]).uniq if hash_one[key] != nil
+        hash_one[key] = hash_two[key] if hash_one[key].nil?
+        hash_one[key] = (hash_one[key] + hash_two[key]).uniq unless hash_one[key].nil?
       end
       return hash_one
     end
-    
-    #Take a hash of tags and return all tags with the matching what target
-    #
-    #@param tags [Hash] a hash of tags obtained via Dor::Item.release_tags or matching format
-    #@param what_target [String] the target for the 'what' key, self or collection
-    #
-    #@return [Hash] a hash of self tags for each to value
+
+    # Take a hash of tags and return all tags with the matching what target
+    # @param tags [Hash] a hash of tags obtained via Dor::Item.release_tags or matching format
+    # @param what_target [String] the target for the 'what' key, self or collection
+    # @return [Hash] a hash of self tags for each to value
     def get_tags_for_what_value(tags, what_target)
       return_hash = {}
       tags.keys.each do |key|
@@ -133,26 +120,22 @@ module Dor
       end
       return return_hash
     end
-    
-    #Take a hash of tags as obtained via Dor::Item.release_tags and returns the newest tag for each namespace
-    #
-    #@params tags [Hash] a hash of tags obtained via Dor::Item.release_tags or matching format
-    #
-    #@return [Hash] a hash of latest tags for each to value
+
+    # Take a hash of tags as obtained via Dor::Item.release_tags and returns the newest tag for each namespace
+    # @param tags [Hash] a hash of tags obtained via Dor::Item.release_tags or matching format
+    # @return [Hash] a hash of latest tags for each to value
     def get_newest_release_tag(tags)
       return_hash = {}
       tags.keys.each do |key|
         latest_for_key = newest_release_tag_in_an_array(tags[key])
-        return_hash[key] = latest_for_key         
+        return_hash[key] = latest_for_key
       end
       return return_hash
     end
-    
-    #Take a tag and return only the attributes  we want to put into purl
-    #
-    #@param tag [Hash] a tag
-    #
-    #@return [Hash] a hash of the attributes we want for purl
+
+    # Take a tag and return only the attributes  we want to put into purl
+    # @param tag [Hash] a tag
+    # @return [Hash] a hash of the attributes we want for purl
     def clean_release_tag_for_purl(tag)
       for_purl = ['release']
       return_hash = {}
@@ -161,12 +144,10 @@ module Dor
       end
       return return_hash
     end
-    
-    #Takes an array of release tags and returns the most recent one
-    #
-    #@params tags [Array] an array of hashes, with the hashes being release tags
-    #
-    #@return [Hash] the most recent tag
+
+    # Takes an array of release tags and returns the most recent one
+    # @param array_of_tags [Array] an array of hashes, each hash a release tag
+    # @return [Hash] the most recent tag
     def newest_release_tag_in_an_array(array_of_tags)
       latest_tag_in_array = array_of_tags[0] || {}
       array_of_tags.each do |tag|
@@ -174,62 +155,54 @@ module Dor
       end
       return latest_tag_in_array
     end
-    
-    #Takes a tag and returns true or false if it applies to the specific item
-    #
-    #@param release_tag [Hash] the tag in a hashed form
-    #@param Optional admin_tags [Array] the administrative tags on an item, if not supplied it will attempt to retrieve them
-    #
-    #@return [Boolean] true or false if it applies (not true or false if it is released, that is the release_tag data)
+
+    # Takes a tag and returns true or false if it applies to the specific item
+    # @param release_tag [Hash] the tag in a hashed form
+    # @param admin_tags [Array] the administrative tags on an item, if not supplied it will attempt to retrieve them
+    # @return [Boolean] true or false if it applies (not true or false if it is released, that is the release_tag data)
     def does_release_tag_apply(release_tag, admin_tags=false)
-      #Is the tag global or restricted 
-      return true if release_tag['tag'] == nil  #there is no specific tag specificied, so that means this tag is global to all members of the collection, it applies, return true
-        
-      admin_tags = self.tags if ! admin_tags #We use false instead of [], since an item can have no admin_tags that which point we'd be passing down this variable as [] and would not an attempt to retrieve it
+      #Is the tag global or restricted
+      return true if release_tag['tag'].nil?  #there is no specific tag specificied, so that means this tag is global to all members of the collection, it applies, return true
+
+      admin_tags = self.tags unless admin_tags #We use false instead of [], since an item can have no admin_tags that which point we'd be passing down this variable as [] and would not an attempt to retrieve it
       return admin_tags.include?(release_tag['tag'])
     end
-    
-    #Takes an array of release tags and returns the most recent one that applies to this item
-    #
-    #@param release_tags [Array] an array of release tags in hashed form
-    #param admin_tags [Array] the administrative tags on an on item
-    #
-    #@return [Hash] the tag
+
+    # Takes an array of release tags and returns the most recent one that applies to this item
+    # @param release_tags [Array] an array of release tags in hashed form
+    # @param admin_tags [Array] the administrative tags on an on item
+    # @return [Hash] the tag
     def latest_applicable_release_tag_in_array(release_tags, admin_tags)
       newest_tag = newest_release_tag_in_an_array(release_tags)
       return newest_tag if does_release_tag_apply(newest_tag, admin_tags) #Return true if we have it
-      
+
       #The latest tag wasn't applicable, slice it off and try again
       #This could be optimized by reordering on the timestamp and just running down it instead of constantly resorting, at least if we end up getting numerous release tags on an item
       release_tags.slice!(release_tags.index(newest_tag))
-      
-      return latest_applicable_release_tag_in_array(release_tags, admin_tags) if release_tags.size > 0 #Try again after dropping the one that wasn't applicable 
-      
+
+      return latest_applicable_release_tag_in_array(release_tags, admin_tags) if release_tags.size > 0 #Try again after dropping the one that wasn't applicable
       return nil #We're out of tags, no applicable ones
     end
-    
-    #helper method to get the release tags as a nodeset
-    #
-    #@return [Nokogiri::XML::NodeSet] of all release tags and their attributes
+
+    # Helper method to get the release tags as a nodeset
+    # @return [Nokogiri::XML::NodeSet] all release tags and their attributes
     def release_tags
       release_tags = self.identityMetadata.ng_xml.xpath('//release')
       return_hash = {}
       release_tags.each do |release_tag|
         hashed_node = self.release_tag_node_to_hash(release_tag)
-        if return_hash[hashed_node[:to]] != nil
+        if !return_hash[hashed_node[:to]].nil?
           return_hash[hashed_node[:to]] << hashed_node[:attrs]
         else
-           return_hash[hashed_node[:to]] = [hashed_node[:attrs]]
+          return_hash[hashed_node[:to]] = [hashed_node[:attrs]]
         end
       end
       return return_hash
     end
 
-    #method to convert one release element into an array
-    #
-    #@param rtag [Nokogiri::XML::Element] the release tag element
-    #
-    #return [Hash] in the form of {:to => String :attrs = Hash}
+    # Convert one release element into a Hash
+    # @param rtag [Nokogiri::XML::Element] the release tag element
+    # @return [Hash{:to, :attrs => String, Hash}] in the form of !{:to => String :attrs = Hash}
     def release_tag_node_to_hash(rtag)
       to = 'to'
       release = 'release'
@@ -249,90 +222,84 @@ module Dor
 
       return return_hash
     end
-    
-    #Determine if the supplied tag is a valid release tag that meets all requirements
-    #
-    #@raises [RuntimeError]  Raises an error of the first fault in the release tag
-    #
-    #@return [Boolean] Returns true if no errors found
+
+    # Determine if the supplied tag is a valid release tag that meets all requirements
     #
-    #@params attrs [hash] A hash of attributes for the tag, must contain: :when, a ISO 8601 timestamp; :who, to identify who or what added the tag; and :to, a string identifying the release target
+    # @param attrs [hash] A hash of attributes for the tag, must contain: :when, a ISO 8601 timestamp; :who, to identify who or what added the tag; and :to, a string identifying the release target
+    # @raise [RuntimeError]  Raises an error of the first fault in the release tag
+    # @return [Boolean] Returns true if no errors found
     def valid_release_attributes_and_tag(tag, attrs={})
-      raise ArgumentError, ":when is not iso8601" if attrs[:when].match('\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z') == nil
+      raise ArgumentError, ":when is not iso8601" if attrs[:when].match('\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z').nil?
       [:who, :to, :what].each do |check_attr|
         raise ArgumentError, "#{check_attr} not supplied as a String" if attrs[check_attr].class != String
       end
 
       what_correct = false
-      ['self', 'collection'].each do |allowed_what_value|
+      %w(self collection).each do |allowed_what_value|
         what_correct = true if attrs[:what] == allowed_what_value
       end
-      raise ArgumentError, ":what must be self or collection" if ! what_correct
+      raise ArgumentError, ":what must be self or collection" unless what_correct
       raise ArgumentError, "the value set for this tag is not a boolean" if !!tag != tag
-      validate_tag_format(attrs[:tag]) if attrs[:tag] != nil #Will Raise exception if invalid tag
+      validate_tag_format(attrs[:tag]) unless attrs[:tag].nil? #Will Raise exception if invalid tag
       return true
     end
-    
-    #Add a release node for the item
-    #Will use the current time to add in the timestamp if you do not supply a timestamp, you can supply a timestap for correcting history, etc if desired
-    #
-    #@return [Nokogiri::XML::Element] the tag added if successful 
-    #
-    #@raise [ArgumentError] Raised if attributes are improperly supplied
+
+    # Add a release node for the item
+    # Will use the current time if timestamp not supplied. You can supply a timestap for correcting history, etc if desired
+    # Timestamp will be calculated by the function, if no displayType is passed in, it will default to file
     #
-    #@params tag [Boolean] True or false for the release node
-    #@params attrs [hash]  A hash of any attributes to be placed onto the tag 
-    #Timestamp will be calculated by the function, if no displayType is passed in, it will default to file
+    # @param release [Boolean] True or false for the release node
+    # @param attrs [hash]  A hash of any attributes to be placed onto the tag
+    # @return [Nokogiri::XML::Element] the tag added if successful
+    # @raise [ArgumentError] Raised if attributes are improperly supplied
     #
-    #@example
+    # @example
     #  item.add_tag(true,:release,{:tag=>'Fitch : Batch2',:what=>'self',:to=>'Searchworks',:who=>'petucket', :displayType='filmstrip'})
     def add_release_node(release, attrs={})
       identity_metadata_ds = self.identityMetadata
       attrs[:when] = Time.now.utc.iso8601 if attrs[:when].nil? #add the timestamp
       attrs[:displayType] = 'file' if attrs[:displayType].nil? #default to file is no display type is passed
       valid_release_attributes(release, attrs)
-  
+
       #Remove the old displayType and then add the one for this tag
       remove_displayTypes
       identity_metadata_ds.add_value(:displayType, attrs[:displayType], {})
-      
+
       return identity_metadata_ds.add_value(:release, release.to_s, attrs)
     end
 
-    #Determine if the supplied tag is a valid release node that meets all requirements
-    #
-    #@raises [ArgumentError]  Raises an error of the first fault in the release tag
+    # Determine if the supplied tag is a valid release node that meets all requirements
     #
-    #@return [Boolean] Returns true if no errors found 
-    #
-    #@params attrs [hash] A hash of attributes for the tag, must contain :when, a ISO 8601 timestamp and :who to identify who or what added the tag, :to, 
+    # @param tag [Boolean] True or false for the release node
+    # @param attrs [hash] A hash of attributes for the tag, must contain :when, a ISO 8601 timestamp and :who to identify who or what added the tag, :to,
+    # @raise [ArgumentError]  Raises an error of the first fault in the release tag
+    # @return [Boolean] Returns true if no errors found
     def valid_release_attributes(tag, attrs={})
-      raise ArgumentError, ":when is not iso8601" if attrs[:when].match('\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z') == nil
+      raise ArgumentError, ":when is not iso8601" if attrs[:when].match('\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z').nil?
       [:who, :to, :what].each do |check_attr|
         raise ArgumentError, "#{check_attr} not supplied as a String" if attrs[check_attr].class != String
       end
 
       what_correct = false
-      ['self', 'collection'].each do |allowed_what_value|
+      %w(self collection).each do |allowed_what_value|
         what_correct = true if attrs[:what] == allowed_what_value
       end
-      raise ArgumentError, ":what must be self or collection" if ! what_correct
+      raise ArgumentError, ":what must be self or collection" unless what_correct
       raise ArgumentError, "the value set for this tag is not a boolean" if !!tag != tag
       raise ArgumentError, ":displayType must be passed in as a String" unless attrs[:displayType].class == String
-      
-      validate_tag_format(attrs[:tag]) if attrs[:tag] != nil #Will Raise exception if invalid tag
+
+      validate_tag_format(attrs[:tag]) unless attrs[:tag].nil? #Will Raise exception if invalid tag
       return true
     end
 
-    #helper method to get the release nodes as a nodeset
-    #
-    #@return [Nokogiri::XML::NodeSet] of all release tags and their attributes
+    # Helper method to get the release nodes as a nodeset
+    # @return [Nokogiri::XML::NodeSet] of all release tags and their attributes
     def release_nodes
       release_tags = self.identityMetadata.ng_xml.xpath('//release')
       return_hash = {}
       release_tags.each do |release_tag|
         hashed_node = self.release_tag_node_to_hash(release_tag)
-        if return_hash[hashed_node[:to]] != nil
+        if !return_hash[hashed_node[:to]].nil?
           return_hash[hashed_node[:to]] << hashed_node[:attrs]
         else
            return_hash[hashed_node[:to]] = [hashed_node[:attrs]]
@@ -340,81 +307,67 @@ module Dor
       end
       return return_hash
     end
-    
-    #Get a list of all release nodes found in a purl document
-    #
-    #@params druid [String]
-    #
-    #@raises [OpenURI::HTTPError]
-    #
-    #Fetches purl xml for a druid
-    #
-    #@return [Nokogiri::HTML::Document] the parsed xml for the druid or an empty document if no purl is found
+
+    # Get a list of all release nodes found in a purl document
+    # Fetches purl xml for a druid
+    # @raise [OpenURI::HTTPError]
+    # @return [Nokogiri::HTML::Document] parsed XML for the druid or an empty document if no purl is found
     def get_xml_from_purl
-        handler = Proc.new do |exception, attempt_number, total_delay|
-          #We assume a 404 means the document has never been published before and thus has no purl
-          #The strip is needed before the actual message is "404 "
-          return Nokogiri::HTML::Document.new if exception.message.strip == "404"
-        end
+      handler = Proc.new do |exception, attempt_number, total_delay|
+        #We assume a 404 means the document has never been published before and thus has no purl
+        #The strip is needed before the actual message is "404 "
+        return Nokogiri::HTML::Document.new if exception.message.strip == "404"
+      end
 
-        with_retries(:max_retries => 5, :base_sleep_seconds => 3, :max_sleep_seconds=> 5, :rescue => OpenURI::HTTPError, :handler => handler) {
-           #If you change the method used for opening the webpage, you can change the :rescue param to handle the new method's errors
-           return Nokogiri::HTML(open(self.form_purl_url))
-         }
-       
+      with_retries(:max_retries => 5, :base_sleep_seconds => 3, :max_sleep_seconds=> 5, :rescue => OpenURI::HTTPError, :handler => handler) {
+         #If you change the method used for opening the webpage, you can change the :rescue param to handle the new method's errors
+         return Nokogiri::HTML(open(self.form_purl_url))
+       }
     end
-    
-    #Since purl does not use the druid: prefix but much of dor does, use this function to strip the druid: if needed
-    #
-    #@return [String] the druid sans the druid: or if there was no druid: prefix, the entire string you passed
+
+    # Since purl does not use the druid: prefix but much of dor does, use this function to strip the druid: if needed
+    # @return [String] the druid sans the druid: or if there was no druid: prefix, the entire string you passed
     def remove_druid_prefix
       druid_prefix = "druid:"
       return self.id.split(druid_prefix)[1] if self.id.split(druid_prefix).size > 1
       return druid
     end
-    
-    #Take the and create the entire purl url that will usable for the open method in open-uri, returns http
-    #
-    #params druid [String], the druid without or without the driud prefix
-    #
-    #return [String], the full url
+
+    # Take the and create the entire purl url that will usable for the open method in open-uri, returns http
+    # @return [String], the full url
     def form_purl_url
-      prefix = "http://" 
+      prefix = "http://"
       return prefix + Dor::Config.stacks.document_cache_host + "/#{self.remove_druid_prefix}.xml"
     end
-    
-    #Pull all release nodes from the public xml obtained via the purl query
-    #
-    #@params druid [Nokogiri::HTML::Document] The druid of the object you want
-    #
-    #@return [Array] An array containing all the release tags 
+
+    # Pull all release nodes from the public xml obtained via the purl query
+    # @param doc [Nokogiri::HTML::Document] The druid of the object you want
+    # @return [Array] An array containing all the release tags
     def get_release_tags_from_purl_xml(doc)
-      nodes = doc.xpath("//html/body/publicobject/releasedata").children 
+      nodes = doc.xpath("//html/body/publicobject/releasedata").children
       #We only want the nodes with a name that isn't text
       return_array = []
       nodes.each do |n|
-        return_array << n.attr('to') if n.name != nil and n.name.downcase != "text"
+        return_array << n.attr('to') if !n.name.nil? && n.name.downcase != "text"
       end
-      return return_array.uniq 
+      return return_array.uniq
     end
-    
-    #Pull all release nodes from the public xml obtained via the purl query
-    #
-    #@return [Array] An array containing all the release tags 
+
+    # Pull all release nodes from the public xml obtained via the purl query
+    # @return [Array] An array containing all the release tags
     def get_release_tags_from_purl
       xml = self.get_xml_from_purl
       return self.get_release_tags_from_purl_xml(xml)
     end
-    
-    #This function calls purl and gets a list of all release tags currently in purl.  It then compares to the list you have generated.
-    #Any tag that is on purl, but not in the newly generated list is added to the new list with a value of false.
-    #
-    #params new_tags [Hash] a hash of all new tags in the form of {Project => Boolean}, where Project is a string
+
+    # This function calls purl and gets a list of all release tags currently in purl.  It then compares to the list you have generated.
+    # Any tag that is on purl, but not in the newly generated list is added to the new list with a value of false.
     #
-    #return [Hash], a hash in the same form as new_tags, with all missing tags not in new_tags, but in current_tag_names, added in with a Boolean value of false
-    def add_tags_from_purl(new_tags) 
+    # @param new_tags [Hash{String => Boolean}] all new tags in the form of !{"Project" => Boolean}
+    # @return [Hash], a hash in the same form as new_tags, with all missing tags not in new_tags, but in current_tag_names, added in with a Boolean value of false
+    def add_tags_from_purl(new_tags)
       tags_currently_in_purl = self.get_release_tags_from_purl
-      missing_tags = tags_currently_in_purl.map(&:downcase) - new_tags.keys.map(&:downcase) 
+      missing_tags = tags_currently_in_purl.map(&:downcase) - new_tags.keys.map(&:downcase)
       missing_tags.each do |missing_tag|
         new_tags[missing_tag.capitalize] = {"release"=>false}
       end
@@ -424,14 +377,14 @@ module Dor
     def to_solr(solr_doc=Hash.new, *args)
       super(solr_doc, *args)
 
-      #TODO: sort of worried about the performance impact in bulk reindex 
+      #TODO: sort of worried about the performance impact in bulk reindex
       # situations, since released_for recurses all parent collections.  jmartin 2015-07-14
       released_for().each { |key, val|
         add_solr_value(solr_doc, "released_to", key, :symbol, []) if val
       }
 
-      #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 
+      #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"
 
       return solr_doc