dor-services 5.1.1 → 5.2.0

data/lib/dor/models/editable.rb

@@ -99,7 +99,7 @@ module Dor
       self.administrativeMetadata.metadata_source.first
     end
     def metadata_source=(val)
-      if self.administrativeMetadata.descMetadata == nil
+      if self.administrativeMetadata.descMetadata.nil?
         self.administrativeMetadata.add_child_node(self.administrativeMetadata, :descMetadata)
       end
       self.administrativeMetadata.update_values({[:descMetadata, :source] => val})
@@ -124,13 +124,13 @@ module Dor
     end
     def creative_commons_license=(val)
       (machine, human)=val
-      if creative_commons_license == nil
+      if creative_commons_license.nil?
         self.defaultObjectRights.add_child_node(self.defaultObjectRights.ng_xml.root, :creative_commons)
       end
       self.defaultObjectRights.update_values({[:creative_commons] => val})
     end
     def creative_commons_license_human=(val)
-      if creative_commons_license_human == nil
+      if creative_commons_license_human.nil?
         #add the nodes
        self.defaultObjectRights.add_child_node(self.defaultObjectRights.ng_xml.root, :creative_commons)
       end

data/lib/dor/models/embargoable.rb

@@ -28,7 +28,7 @@ module Dor
       release_access = embargo_md.release_access_node
       release_access.xpath('//releaseAccess/access').each do |new_access|
         access_sibling = rights_xml.at_xpath("//rightsMetadata/access[last()]")
-        if(access_sibling)
+        if access_sibling
           access_sibling.add_next_sibling(new_access.clone)
         else
           rights_xml.root.add_child(new_access.clone)
@@ -50,7 +50,7 @@ module Dor
 
       # Replace rights <access> nodes with 1 machine/world node
       access_sibling = rights_xml.at_xpath("//rightsMetadata/access[last()]")
-      if(access_sibling)
+      if access_sibling
         access_sibling.add_next_sibling(world_doc.root.clone)
       else
         rights_xml.root.add_child(world_doc.root.clone)

data/lib/dor/models/eventable.rb

@@ -4,9 +4,9 @@ module Dor
     included do
       has_metadata :name => 'events', :type => Dor::EventsDS, :label => 'Events'
     end
-    
+
     def add_event *args
       self.datastreams['events'].add_event *args
     end
   end
-end
+end

data/lib/dor/models/geoable.rb

@@ -2,34 +2,30 @@ module Dor
   module Geoable
     extend ActiveSupport::Concern
 
-    class CrosswalkError < Exception; end    
-    
+    class CrosswalkError < Exception; end
+
     included do
-      has_metadata  :name => 'geoMetadata', 
-                    :type => Dor::GeoMetadataDS, 
-                    :label => 'Geographic Information Metadata in ISO 19139', 
+      has_metadata  :name => 'geoMetadata',
+                    :type => Dor::GeoMetadataDS,
+                    :label => 'Geographic Information Metadata in ISO 19139',
                     :control_group => 'M'
     end
-    
-    # @return [String] XML
+
+    # @return [String, nil] XML
     def fetch_geoMetadata_datastream
       candidates = self.datastreams['identityMetadata'].otherId.collect { |oid| oid.to_s }
       metadata_id = Dor::MetadataService.resolvable(candidates).first
-      unless metadata_id.nil?
-        return Dor::MetadataService.fetch(metadata_id.to_s)
-      else
-        return nil
-      end
+      return nil if metadata_id.nil?
+      return Dor::MetadataService.fetch(metadata_id.to_s)
     end
 
     def build_geoMetadata_datastream(ds)
       content = fetch_geoMetadata_datastream
-      unless content.nil?
-        ds.dsLabel = self.label
-        ds.ng_xml = Nokogiri::XML(content)
-        ds.ng_xml.normalize_text!
-        ds.content = ds.ng_xml.to_xml
-      end
+      return nil if content.nil?
+      ds.dsLabel = self.label
+      ds.ng_xml = Nokogiri::XML(content)
+      ds.ng_xml.normalize_text!
+      ds.content = ds.ng_xml.to_xml
     end
   end
 end

data/lib/dor/models/governable.rb

@@ -26,7 +26,7 @@ module Dor
       lane
     end
 
-    def reset_to_apo_default()
+    def reset_to_apo_default
       self.rightsMetadata.content = admin_policy_object.rightsMetadata.ng_xml
     end
 

data/lib/dor/models/identifiable.rb

@@ -19,10 +19,8 @@ module Dor
     end
 
     def initialize attrs={}
-      if Dor::Config.suri.mint_ids
-        unless attrs[:pid]
-          attrs = attrs.merge!({:pid=>Dor::SuriService.mint_id, :new_object => true})
-        end
+      if Dor::Config.suri.mint_ids && !attrs[:pid]
+        attrs = attrs.merge!({:pid=>Dor::SuriService.mint_id, :new_object => true})
       end
       super
     end
@@ -80,7 +78,7 @@ module Dor
       return solr_doc
     end
 
-    #@return [String] calculated value for Solr index
+    # @return [String] calculated value for Solr index
     def identity_metadata_source
       if self.identityMetadata.otherId('catkey').first ||
          self.identityMetadata.otherId('barcode').first
@@ -104,25 +102,17 @@ module Dor
     end
 
     def update_other_Id(type, new_val, val=nil)
-      updated=false
-      self.identityMetadata.ng_xml.search('//otherId[@name=\''+type+'\']').each do |node|
-        if node.content==val || val.nil?
-          node.content=new_val
-          updated=true
-        end
-      end
-      return updated
+      self.identityMetadata.ng_xml.search('//otherId[@name=\''+type+'\']')
+        .select{ |node| val.nil? || node.content == val }
+        .each  { |node| node.content = new_val }
+        .any?
     end
 
     def remove_other_Id(type, val=nil)
-      removed=false
-      self.identityMetadata.ng_xml.search('//otherId[@name=\''+type+'\']').each do |node|
-        if node.content===val || val.nil?
-          node.remove
-          removed=true
-        end
-      end
-      return removed
+      self.identityMetadata.ng_xml.search('//otherId[@name=\''+type+'\']')
+        .select{ |node| val.nil? || node.content == val }
+        .each(&:remove)
+        .any?
     end
 
     # turns a tag string into an array with one element per tag part.
@@ -158,11 +148,9 @@ module Dor
       return 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 ':'
+    # 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)
 
@@ -176,9 +164,8 @@ module Dor
       return tag_arr
     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
+    # 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(tag)
         identity_metadata_ds = self.identityMetadata
         normalized_tag = validate_and_normalize_tag(tag, identity_metadata_ds.tags)
@@ -186,37 +173,30 @@ module Dor
     end
 
     def remove_tag(tag)
-      removed = false
-      self.identityMetadata.ng_xml.search('//tag').each do |node|
-        if normalize_tag(node.content) === normalize_tag(tag)
-          node.remove
-          removed = true
-        end
-      end
-      return removed
+      normtag = normalize_tag(tag)
+      self.identityMetadata.ng_xml.search('//tag')
+        .select{ |node| normalize_tag(node.content) == normtag }
+        .each(&:remove)
+        .any?
     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
+
+    # 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
+      nodes = self.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
 
     def update_tag(old_tag, new_tag)
-      updated = false
-      self.identityMetadata.ng_xml.search('//tag').each do |node|
-        if normalize_tag(node.content) == normalize_tag(old_tag)
-          node.content = normalize_tag(new_tag)
-          updated = true
-        end
-      end
-      return updated
+      normtag = normalize_tag(old_tag)
+      self.identityMetadata.ng_xml.search('//tag')
+        .select{ |node| normalize_tag(node.content) == normtag }
+        .each  { |node| node.content = normalize_tag(new_tag)  }
+        .any?
     end
 
     def get_related_obj_display_title(related_obj, default_title)
@@ -231,7 +211,6 @@ module Dor
       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
@@ -240,7 +219,7 @@ module Dor
         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)
+        if title_hash.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)

data/lib/dor/models/itemizable.rb

@@ -8,20 +8,20 @@ module Dor
     included do
       has_metadata :name => "contentMetadata", :type => Dor::ContentMetadataDS, :label => 'Content Metadata', :control_group => 'M'
     end
-    
+
     DIFF_FILENAME = 'cm_inv_diff'
     DIFF_QUERY = DIFF_FILENAME.gsub('_', '-')
 
     # Deletes all cm_inv_diff files in the workspace for the Item
     def clear_diff_cache
       if Dor::Config.stacks.local_workspace_root.nil?
-        raise ArgumentError, 'Missing Dor::Config.stacks.local_workspace_root' 
+        raise ArgumentError, 'Missing Dor::Config.stacks.local_workspace_root'
       end
       druid = DruidTools::Druid.new(self.pid, Dor::Config.stacks.local_workspace_root)
       diff_pattern = File.join(druid.temp_dir, DIFF_FILENAME + '.*')
       FileUtils.rm_f Dir.glob(diff_pattern)
     end
-    
+
     # Retrieves file difference manifest for contentMetadata from SDR
     #
     # @param [String] subset keyword for file attributes :shelve, :preserve, :publish. Default is :all.
@@ -29,7 +29,7 @@ module Dor
     # @return [String] XML contents of cm_inv_diff manifest
     def get_content_diff(subset = :all, version = nil)
       if Dor::Config.stacks.local_workspace_root.nil?
-        raise Dor::ParameterError, 'Missing Dor::Config.stacks.local_workspace_root' 
+        raise Dor::ParameterError, 'Missing Dor::Config.stacks.local_workspace_root'
       end
       unless %w{all shelve preserve publish}.include?(subset.to_s)
         raise Dor::ParameterError, "Invalid subset value: #{subset}"
@@ -51,6 +51,6 @@ module Dor
       response = sdr_client[sdr_query].post(current_content, :content_type => 'application/xml')
       response
     end
-    
+
   end
-end
+end

data/lib/dor/models/presentable.rb

@@ -6,9 +6,9 @@ module Dor
     DC_NS = {"dc"=>"http://purl.org/dc/elements/1.1/", "oai_dc"=>"http://www.openarchives.org/OAI/2.0/oai_dc/"}
 
     def iiif_presentation_manifest_needed? pub_obj_doc
-      if(pub_obj_doc.at_xpath('/publicObject/contentMetadata[contains(@type,"image") or contains(@type,"map")]/resource[@type="image"]'))
+      if pub_obj_doc.at_xpath('/publicObject/contentMetadata[contains(@type,"image") or contains(@type,"map")]/resource[@type="image"]')
         return true
-      elsif(pub_obj_doc.at_xpath('/publicObject/contentMetadata[@type="book"]/resource[@type="page"]'))
+      elsif pub_obj_doc.at_xpath('/publicObject/contentMetadata[@type="book"]/resource[@type="page"]')
         return true
       else
         return false
@@ -32,13 +32,13 @@ module Dor
         '@id'   => "#{purl_base_uri}/iiif/manifest.json",
         'label' => lbl,
         'attribution' => 'Provided by the Stanford University Libraries',
-        'logo' => { 
-          '@id' => "http://stacks.stanford.edu/image/iiif/wy534zh7137%2FSULAIR_rosette/full/400,/0/default.jpg", 
-          'service' => { 
-            '@context' => "http://iiif.io/api/image/2/context.json", 
-            '@id' => "http://stacks.stanford.edu/image/iiif/wy534zh7137%2FSULAIR_rosette", 
-            'profile' => "http://iiif.io/api/image/2/level1.json" 
-            } 
+        'logo' => {
+          '@id' => "https://stacks.stanford.edu/image/iiif/wy534zh7137%2FSULAIR_rosette/full/400,/0/default.jpg",
+          'service' => {
+            '@context' => "http://iiif.io/api/image/2/context.json",
+            '@id' => "https://stacks.stanford.edu/image/iiif/wy534zh7137%2FSULAIR_rosette",
+            'profile' => "http://iiif.io/api/image/2/level1.json"
+            }
           },
         'seeAlso' => {
           '@id' => "#{purl_base_uri}.mods",
@@ -46,14 +46,14 @@ module Dor
         }
       }
       # Use the human copyright statement for attribution if present
-      if(cr = pub_obj_doc.at_xpath('/publicObject/rightsMetadata/copyright/human[@type="copyright"]'))
+      if (cr = pub_obj_doc.at_xpath('/publicObject/rightsMetadata/copyright/human[@type="copyright"]'))
         manifest_data['attribution'] = cr.text
       end
 
       manifest = IIIF::Presentation::Manifest.new manifest_data
 
       # Set viewingHint to paged if this is a book
-      if(pub_obj_doc.at_xpath('/publicObject/contentMetadata[@type="book"]'))
+      if pub_obj_doc.at_xpath('/publicObject/contentMetadata[@type="book"]')
         manifest.viewingHint = "paged"
       end
 
@@ -65,7 +65,7 @@ module Dor
       add_metadata 'Date', '//oai_dc:dc/dc:date', metadata, pub_obj_doc
 
       # Save off the first dc:description without displayLabel
-      if(desc = pub_obj_doc.at_xpath('//oai_dc:dc/dc:description[not(@displayLabel)]', DC_NS))
+      if (desc = pub_obj_doc.at_xpath('//oai_dc:dc/dc:description[not(@displayLabel)]', DC_NS))
         manifest.description = desc.text
       end
 

data/lib/dor/models/preservable.rb

@@ -13,11 +13,9 @@ module Dor
       workflow_provenance = create_workflow_provenance(workflow_id, event_text)
       dsname = 'provenanceMetadata'
       ds = datastreams[dsname]
-      unless datastreams.keys.include?(dsname)
-        ds.label = 'Provenance Metadata'
-      end
+      ds.label = 'Provenance Metadata' unless datastreams.keys.include?(dsname)
       ds.ng_xml = workflow_provenance
-			ds.content=ds.ng_xml.to_s
+      ds.content=ds.ng_xml.to_s
       ds.save
     end
 
@@ -29,7 +27,6 @@ module Dor
       SdrIngestService.transfer(self,agreement_id)
     end
 
-
     # @return [Nokogiri::Document]
     def create_workflow_provenance(workflow_id, event_text)
       builder = Nokogiri::XML::Builder.new do |xml|

data/lib/dor/models/processable.rb

@@ -38,23 +38,21 @@ module Dor
       'opened' => 1
     }
 
+    # This is a work-around for some strange logic in ActiveFedora that
+    # don't allow self.workflows.new? to work if we load the object using
+    # .load_instance_from_solr.
     def set_workflows_datastream_location
-      # This is a work-around for some strange logic in ActiveFedora that
-      # don't allow self.workflows.new? to work if we load the object using
-      # .load_instance_from_solr.
-      return if self.respond_to? :inner_object and self.inner_object.is_a? ActiveFedora::SolrDigitalObject
-
-      if self.workflows.new?
-        workflows.mimeType = 'application/xml'
-        workflows.dsLocation = File.join(Dor::Config.workflow.url,"dor/objects/#{self.pid}/workflows")
-      end
+      return if self.respond_to?(:inner_object) && self.inner_object.is_a?(ActiveFedora::SolrDigitalObject)
+      return unless self.workflows.new?
+      workflows.mimeType   = 'application/xml'
+      workflows.dsLocation = File.join(Dor::Config.workflow.url,"dor/objects/#{self.pid}/workflows")
     end
 
     def empty_datastream?(datastream)
       if datastream.new?
         true
       elsif datastream.class.respond_to?(:xml_template)
-        datastream.content.to_s.empty? or EquivalentXml.equivalent?(datastream.content, datastream.class.xml_template)
+        datastream.content.to_s.empty? || EquivalentXml.equivalent?(datastream.content, datastream.class.xml_template)
       else
         datastream.content.to_s.empty?
       end
@@ -84,7 +82,7 @@ module Dor
         ds.content = content
         ds.ng_xml = Nokogiri::XML(content) if ds.respond_to?(:ng_xml)
         ds.save unless ds.digital_object.new?
-      elsif force or empty_datastream?(ds)
+      elsif force || empty_datastream?(ds)
         meth = "build_#{datastream}_datastream".to_sym
         if respond_to?(meth)
           content = self.send(meth, ds)
@@ -98,7 +96,7 @@ module Dor
       return ds
     end
 
-    def cleanup()
+    def cleanup
       CleanupService.cleanup(self)
     end
 
@@ -107,7 +105,7 @@ module Dor
     end
 
     # @return [Hash] including :current_version, :status_code and :status_time
-    def status_info()
+    def status_info
       current_version = '1'
       begin
         current_version = self.versionMetadata.current_version_id
@@ -118,8 +116,8 @@ module Dor
       #only get steps that are part of accessioning and part of the current version. That can mean they were archived with the current version
       #number, or they might be active (no version number).
       milestones.each do |m|
-        if STEPS.keys.include?(m[:milestone]) and (m[:version].nil? or m[:version] == current_version)
-          current_milestones << m unless m[:milestone] == 'registered' and current_version.to_i > 1
+        if STEPS.keys.include?(m[:milestone]) && (m[:version].nil? || m[:version] == current_version)
+          current_milestones << m unless m[:milestone] == 'registered' && current_version.to_i > 1
         end
       end
 
@@ -129,12 +127,9 @@ module Dor
       current_milestones.each do |m|
         name = m[:milestone]
         time = m[:at].utc.xmlschema
-        if STEPS.keys.include? name
-          if STEPS[name] > status_code
-            status_code = STEPS[name]
-            status_time = time
-          end
-        end
+        next unless STEPS.keys.include?(name) && STEPS[name] > status_code
+        status_code = STEPS[name]
+        status_time = time
       end
 
       return {:current_version => current_version, :status_code => status_code, :status_time => status_time}
@@ -220,7 +215,7 @@ module Dor
     def initialize_workflow(name, create_ds=true, priority=0)
       priority = workflows.current_priority if priority == 0
       opts = { :create_ds => create_ds, :lane_id => default_workflow_lane }
-      opts[:priority] = priority if(priority > 0)
+      opts[:priority] = priority if priority > 0
       Dor::WorkflowService.create_workflow(Dor::WorkflowObject.initial_repo(name), self.pid, name, Dor::WorkflowObject.initial_workflow(name), opts)
     end
 
@@ -228,16 +223,15 @@ module Dor
     #handles formating utc date/time to human readable
     # XXX: bad form to hardcode TZ here.  Code smell abounds.
     def format_date datetime
-      begin
+
         d = datetime.is_a?(Time) ? datetime :
             DateTime.parse(datetime).in_time_zone(ActiveSupport::TimeZone.new("Pacific Time (US & Canada)"))
         I18n.l(d).strftime('%Y-%m-%d %I:%M%p')
       rescue
         d = datetime.is_a?(Time) ? datetime : Time.parse(datetime.to_s)
         d.strftime('%Y-%m-%d %I:%M%p')
-      end
+
     end
   end
 
-
 end