dor-services 5.6.0 → 5.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ff194a7c8f4523d03cae50e749ca4347aef2ce63
-  data.tar.gz: 0187ff1e3f17f874cbc1412aa3ee1d0a2726284d
+  metadata.gz: 5bcf35abdc1bd0a65db743cf5d878cd69407c844
+  data.tar.gz: 50ae2af9196a9e6c2fce640653dd8dbbb317c348
 SHA512:
-  metadata.gz: a78df8989f349a9b1d20fd940dd54437d2d756343b56fe1124e1ddad13e0933a076c434ec4db61829989154b50a3f12b51efd7198bb670784add5ed68848a91a
-  data.tar.gz: 9bd63d841e4a4bc0324ace233c5f72ef9b9a67c36e90fcc17eb5477be1ac59d3afbf70c93aa5af289831afe280558fa8399d7d811249c06239fadb0fac4d71a3
+  metadata.gz: 17d5f020c434ca6fe2279ff74091495aad6195570a0a729a4bdd5fd378b905e826dcc9cca53c46ee138a03ca3243b6ccb1b25a41cc0718a5844cb24e9db04b40
+  data.tar.gz: eeb1e14c56abb72485ed20367cf28f2b1a07d04ac1a7e01d7812c00ea6db984027b972c3eda6daf35eec09cf4f7fcf716b327252afd40fdb7f04b552b0965611

data/lib/dor-services.rb

@@ -1,13 +1,12 @@
 require 'active_fedora'
 require 'active_support/core_ext/module/attribute_accessors'
 require 'modsulator'
-require 'nokogiri-pretty'
 require 'dor/utils/sdr_client'
 
 module Dor
   @@registered_classes = {}
   mattr_reader :registered_classes
-  INDEX_VERSION_FIELD = 'dor_services_version_ssi'
+  INDEX_VERSION_FIELD = 'dor_services_version_ssi'.freeze
 
   class << self
 

data/lib/dor/config.rb

@@ -30,7 +30,7 @@ module Dor
 
     def autoconfigure(url, cert_file = Config.ssl.cert_file, key_file = Config.ssl.key_file, key_pass = Config.ssl.key_pass)
       client = make_rest_client(url, cert_file, key_file, key_pass)
-      config = Confstruct::Configuration.symbolize_hash JSON.parse(client.get :accept => 'application/json')
+      config = Confstruct::Configuration.symbolize_hash JSON.parse(client.get(accept: 'application/json'))
       configure(config)
     end
 

data/lib/dor/datastreams/default_object_rights_ds.rb

@@ -94,7 +94,7 @@ module Dor
     end
 
     def content
-      ng_xml.human
+      prettify(ng_xml).to_s
     end
 
     # Purge the XML of any empty or duplicate elements -- keeps <rightsMetadata> clean
@@ -127,7 +127,16 @@ module Dor
         doc.xpath('/rightsMetadata/copyright').each { |node| norm.remove_empty_nodes(node) }
         doc.xpath('/rightsMetadata/use').each { |node| norm.remove_empty_nodes(node) }
       end
-      self.content = doc.human
+      self.content = prettify(doc)
+    end
+
+    # Returns a nicely indented XML document.
+    # Note that the XSL file was taken from the (apparently defunct) nokogiri-pretty project:
+    # https://github.com/tobym/nokogiri-pretty/blob/master/lib/indent.xsl
+    # The only modification made was to declare UTF-8 to be the encoding, instead of ISO-8859-1.
+    def prettify(xml_doc)
+      template = Nokogiri::XSLT(File.read(File.expand_path('../human.xslt', __FILE__)))
+      template.apply_to(xml_doc)
     end
   end
 end

data/lib/dor/datastreams/desc_metadata_ds.rb

@@ -1,7 +1,7 @@
 module Dor
   class DescMetadataDS < ActiveFedora::OmDatastream
 
-    MODS_NS = 'http://www.loc.gov/mods/v3'
+    MODS_NS = 'http://www.loc.gov/mods/v3'.freeze
     set_terminology do |t|
       t.root :path => 'mods', :xmlns => MODS_NS, :index_as => [:not_searchable]
       t.originInfo  :index_as => [:not_searchable] do

data/lib/dor/datastreams/embargo_metadata_ds.rb

@@ -99,7 +99,7 @@ class EmbargoMetadataDS < ActiveFedora::OmDatastream
   # Sets the embargaAccess node
   # @param [Nokogiri::XML::Document] new_doc Document that will replace the existing releaseAccess node
   def release_access_node=(new_doc)
-    if (new_doc.root.name != 'releaseAccess')
+    if new_doc.root.name != 'releaseAccess'
       raise 'Trying to replace releaseAccess with a non-releaseAccess document'
     end
 

data/lib/dor/datastreams/geo_metadata_ds.rb

@@ -17,7 +17,7 @@ module Dor
       :gco => 'http://www.isotc211.org/2005/gco',
       :gmd => 'http://www.isotc211.org/2005/gmd',
       :gfc => 'http://www.isotc211.org/2005/gfc'
-    }
+    }.freeze
 
     # hash with all namespaces
     XMLNS = Hash[NS.map {|k, v| ["xmlns:#{k}", v]}]

data/lib/dor/datastreams/human.xslt

@@ -0,0 +1,46 @@
+<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
+  <xsl:output method="xml" encoding="UTF-8"/>
+  <xsl:param name="indent-increment" select="'   '"/>
+
+  <xsl:template name="newline">
+    <xsl:text disable-output-escaping="yes">
+</xsl:text>
+  </xsl:template>
+
+  <xsl:template match="comment() | processing-instruction()">
+    <xsl:param name="indent" select="''"/>
+    <xsl:call-template name="newline"/>
+    <xsl:value-of select="$indent"/>
+    <xsl:copy />
+  </xsl:template>
+
+  <xsl:template match="text()">
+    <xsl:param name="indent" select="''"/>
+    <xsl:call-template name="newline"/>
+    <xsl:value-of select="$indent"/>
+    <xsl:value-of select="normalize-space(.)"/>
+  </xsl:template>
+
+  <xsl:template match="text()[normalize-space(.)='']"/>
+
+  <xsl:template match="*">
+    <xsl:param name="indent" select="''"/>
+    <xsl:call-template name="newline"/>
+    <xsl:value-of select="$indent"/>
+      <xsl:choose>
+       <xsl:when test="count(child::*) > 0">
+        <xsl:copy>
+         <xsl:copy-of select="@*"/>
+         <xsl:apply-templates select="*|text()">
+           <xsl:with-param name="indent" select="concat ($indent, $indent-increment)"/>
+         </xsl:apply-templates>
+         <xsl:call-template name="newline"/>
+         <xsl:value-of select="$indent"/>
+        </xsl:copy>
+       </xsl:when>
+       <xsl:otherwise>
+        <xsl:copy-of select="."/>
+       </xsl:otherwise>
+     </xsl:choose>
+  </xsl:template>
+</xsl:stylesheet>

data/lib/dor/datastreams/version_metadata_ds.rb

@@ -201,10 +201,10 @@ module Dor
     # @option opts [Symbol] :significance which part of the version tag to increment
     def sync_then_increment_version(known_version, opts = {})
       cv = current_version_id.to_i
-      raise Dor::Exception.new("Cannot sync to a version greater than current: #{cv}, requested #{known_version}") if cv < known_version
+      raise Dor::Exception, "Cannot sync to a version greater than current: #{cv}, requested #{known_version}" if cv < known_version
 
       while cv != known_version &&
-        current_version_node.remove
+            current_version_node.remove
         cv = current_version_id.to_i
       end
 

data/lib/dor/migrations/content_metadata_ds/change_content_type.rb

@@ -1,7 +1,7 @@
 Dor::ContentMetadataDS.on_upgrade '3.6.0', 'Change contentMetadata type attribute' do |ds|
   translations = { 'googleScannedBook' => 'book', 'etd' => 'file', 'eem' => 'file' }
   translations.any? do |old_type, new_type|
-    current_type = (ds.contentType.to_ary.first) rescue ds.contentType
+    current_type = ds.contentType.to_ary.first rescue ds.contentType
     (current_type == old_type) && (ds.contentType = new_type)
   end
 end

data/lib/dor/models/contentable.rb

@@ -181,7 +181,7 @@ module Dor
             secondary_file['id'] = new_secondary_file_name(secondary_file['id'], max_sequence)
 
             if primary_cm.at_xpath("//file[@id = '#{secondary_file['id']}']")
-              raise Dor::Exception.new "File '#{secondary_file['id']}' from secondary object #{src_pid} already exist in primary object: #{pid}"
+              raise Dor::Exception, "File '#{secondary_file['id']}' from secondary object #{src_pid} already exist in primary object: #{pid}"
             end
           end
 

data/lib/dor/models/describable.rb

@@ -5,7 +5,7 @@ module Dor
     DESC_MD_FORMATS = {
       'http://www.tei-c.org/ns/1.0' => 'tei',
       'http://www.loc.gov/mods/v3'  => 'mods'
-    }
+    }.freeze
     class CrosswalkError < Exception; end
 
     included do
@@ -211,7 +211,7 @@ module Dor
     def to_solr(solr_doc = {}, *args)
       super solr_doc, *args
       mods_sources = {
-        'sw_language_ssim'           => :sw_language_facet,
+        'sw_language_ssim'            => :sw_language_facet,
         'sw_language_tesim'           => :sw_language_facet,
         'sw_genre_ssim'               => :sw_genre,
         'sw_genre_tesim'              => :sw_genre,
@@ -244,7 +244,7 @@ module Dor
           title = node.text
         end
         creator_title = creator + title
-        add_solr_value(solr_doc, 'creator_title', creator_title , :string, [:stored_sortable])
+        add_solr_value(solr_doc, 'creator_title', creator_title, :string, [:stored_sortable])
       rescue CrosswalkError => e
         ActiveFedora.logger.warn "Cannot index #{pid}.descMetadata: #{e.message}"
       end

data/lib/dor/models/editable.rb

@@ -35,7 +35,7 @@ module Dor
                       :uri => 'https://creativecommons.org/licenses/by-nc-nd/3.0/' },
       'pdm' =>      { :human_readable => 'Public Domain Mark 1.0',
                       :uri => 'https://creativecommons.org/publicdomain/mark/1.0/'}
-    }
+    }.freeze
     OPEN_DATA_COMMONS_USE_LICENSES = {
       'pddl' =>     { :human_readable => 'Open Data Commons Public Domain Dedication and License 1.0',
                       :uri => 'http://opendatacommons.org/licenses/pddl/1.0/' },
@@ -43,7 +43,7 @@ module Dor
                       :uri => 'http://opendatacommons.org/licenses/by/1.0/' },
       'odc-odbl' => { :human_readable => 'Open Data Commons Open Database License 1.0',
                       :uri => 'http://opendatacommons.org/licenses/odbl/1.0/' }
-    }
+    }.freeze
 
     def to_solr(solr_doc = {}, *args)
       super(solr_doc, *args)

data/lib/dor/models/identifiable.rb

@@ -209,12 +209,10 @@ module Dor
     end
 
     def get_related_obj_display_title(related_obj, default_title)
-      # desc_md_ds_title will be nil if related_obj is nil
-      desc_md_ds_title = if related_obj
-        desc_md_ds = related_obj.datastreams['descMetadata']
-        desc_md_ds ? desc_md_ds.title_info.main_title.first : nil
-      end
+      return default_title unless related_obj
 
+      desc_md_ds = related_obj.datastreams['descMetadata']
+      desc_md_ds_title = desc_md_ds ? desc_md_ds.title_info.main_title.first : nil
       desc_md_ds_title.present? ? desc_md_ds_title : default_title
     end
 

data/lib/dor/models/itemizable.rb

@@ -9,7 +9,7 @@ module Dor
       has_metadata :name => 'contentMetadata', :type => Dor::ContentMetadataDS, :label => 'Content Metadata', :control_group => 'M'
     end
 
-    DIFF_FILENAME = 'cm_inv_diff'
+    DIFF_FILENAME = 'cm_inv_diff'.freeze
 
     # Deletes all cm_inv_diff files in the workspace for the Item
     def clear_diff_cache
@@ -23,20 +23,19 @@ module Dor
 
     # Retrieves file difference manifest for contentMetadata from SDR
     #
-    # @param [String] subset keyword for file attributes :shelve, :preserve, :publish. Default is :all.
+    # @param [Symbol] subset keyword for file attributes :shelve, :preserve, :publish. Default is :all.
     # @param [String] version
-    # @return [String] XML contents of cm_inv_diff manifest
+    # @return [Moab::FileInventoryDifference] 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'
       end
 
-      current_content = datastreams['contentMetadata'].content
-      if current_content.nil?
+      if contentMetadata.nil?
         raise Dor::Exception, 'Missing contentMetadata datastream'
       end
 
-      Sdr::Client.get_content_diff(pid, current_content, subset, version)
+      Sdr::Client.get_content_diff(pid, contentMetadata.content, subset, version)
     end
   end
 end

data/lib/dor/models/processable.rb

@@ -23,7 +23,7 @@ module Dor
       7 => 'Accessioned (indexed)',
       8 => 'Accessioned (indexed, ingested)',
       9 => 'Opened'
-    }
+    }.freeze
 
     # milestones from accessioning and the order they happen in
     STEPS = {
@@ -36,7 +36,7 @@ module Dor
       'indexed'     => 7,
       'shelved'     => 8,
       'opened'      => 9
-    }
+    }.freeze
 
     # 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
@@ -138,7 +138,9 @@ module Dor
     # @return [String] single composed status from status_info
     def status(include_time = false)
       status_info_hash = status_info
-      current_version, status_code, status_time = status_info_hash[:current_version], status_info_hash[:status_code], status_info_hash[:status_time]
+      current_version = status_info_hash[:current_version]
+      status_code = status_info_hash[:status_code]
+      status_time = status_info_hash[:status_time]
 
       # use the translation table to get the appropriate verbage for the latest step
       result = "v#{current_version} #{STATUS_CODE_DISP_TXT[status_code]}"
@@ -229,8 +231,12 @@ module Dor
     # handles formating utc date/time to human readable
     # XXX: bad form to hardcode TZ here.  Code smell abounds.
     def format_date(datetime)
-      d = datetime.is_a?(Time) ? datetime :
-        DateTime.parse(datetime).in_time_zone(ActiveSupport::TimeZone.new('Pacific Time (US & Canada)'))
+      d =
+        if datetime.is_a?(Time)
+          datetime
+        else
+          DateTime.parse(datetime).in_time_zone(ActiveSupport::TimeZone.new('Pacific Time (US & Canada)'))
+        end
       I18n.l(d).strftime('%Y-%m-%d %I:%M%p')
     rescue
       d = datetime.is_a?(Time) ? datetime : Time.parse(datetime.to_s)

data/lib/dor/services/digital_stacks_service.rb

@@ -101,7 +101,7 @@ module Dor
     def self.copy_file(workspace_pathname, stacks_pathname, moab_signature)
       if stacks_pathname.exist?
         file_signature = Moab::FileSignature.new.signature_from_file(stacks_pathname)
-        stacks_pathname.delete if (file_signature != moab_signature)
+        stacks_pathname.delete if file_signature != moab_signature
       end
       unless stacks_pathname.exist?
         stacks_pathname.parent.mkpath

data/lib/dor/services/merge_service.rb

@@ -23,9 +23,9 @@ module Dor
     end
 
     def check_objects_editable
-      raise Dor::Exception.new("Primary object is not editable: #{@primary.pid}") unless @primary.allows_modification?
+      raise Dor::Exception, "Primary object is not editable: #{@primary.pid}" unless @primary.allows_modification?
       non_editable = @secondary_objs.detect {|obj| !obj.allows_modification? }
-      raise Dor::Exception.new "Secondary object is not editable: #{non_editable.pid}" if non_editable
+      raise Dor::Exception, "Secondary object is not editable: #{non_editable.pid}" if non_editable
     end
 
     def move_metadata_and_content

data/lib/dor/services/search_service.rb

@@ -4,7 +4,7 @@ require 'active_support/core_ext'
 module Dor
   class SearchService
 
-    RISEARCH_TEMPLATE = "select $object from <#ri> where $object <dc:identifier> '%s'"
+    RISEARCH_TEMPLATE = "select $object from <#ri> where $object <dc:identifier> '%s'".freeze
     @@index_version = nil
 
     class << self

data/lib/dor/services/suri_service.rb

@@ -17,7 +17,7 @@ module Dor
         ids = resource["identifiers?quantity=#{quantity}"].post('').chomp.split(/\n/).collect { |id| "#{Config.suri.id_namespace}:#{id.strip}" }
       else
         repo = ActiveFedora::Base.respond_to?(:connection_for_pid) ? ActiveFedora::Base.connection_for_pid(0) : ActiveFedora.fedora.connection
-        resp = Nokogiri::XML(repo.next_pid :numPIDs => quantity)
+        resp = Nokogiri::XML(repo.next_pid(numPIDs: quantity))
         ids = resp.xpath('/pidList/pid').collect { |node| node.text }
       end
       want_array ? ids : ids.first

data/lib/dor/services/technical_metadata_service.rb

@@ -50,6 +50,8 @@ module Dor
     def self.get_content_group_diff(dor_item)
       inventory_diff = dor_item.get_content_diff('all')
       inventory_diff.group_difference('content')
+    rescue Dor::Exception # no contentMetadata
+      Moab::FileGroupDifference.new
     end
 
     # @param [FileGroupDifference] content_group_diff

data/lib/dor/utils/sdr_client.rb

@@ -33,6 +33,7 @@ module Sdr
         Moab::SignatureCatalog.new(:digital_object_id => druid, :version_id => 0)
       end
 
+      # @return [Moab::FileInventoryDifference] the differences for the given content and subset
       def get_content_diff(druid, current_content, subset = :all, version = nil)
         unless %w(all shelve preserve publish).include?(subset.to_s)
           raise Dor::ParameterError, "Invalid subset value: #{subset}"

data/lib/dor/version.rb

@@ -1,3 +1,3 @@
 module Dor
-  VERSION = '5.6.0'
+  VERSION = '5.7.0'.freeze
 end

data/lib/dor/workflow/graph.rb

@@ -4,10 +4,10 @@ module Dor
 module Workflow
 class Graph
 
-  FILL_COLORS = { 'waiting' => 'white', 'ready' => 'white', 'error' => '#8B0000', 'blocked' => 'white', 'completed' => 'darkgreen', 'unknown' => '#CFCFCF' }
-  TEXT_COLORS = { 'waiting' => 'black', 'ready' => 'black', 'error' => 'white', 'blocked' => '#8B0000', 'completed' => 'white', 'unknown' => 'black' }
-  PATTERNS    = { 'waiting' => 'diagonals', 'ready' => 'filled', 'error' => 'filled', 'blocked' => 'diagonals', 'completed' => 'filled', 'unknown' => 'filled' }
-  RESERVED_KEYS = %w(repository name)
+  FILL_COLORS = { 'waiting' => 'white', 'ready' => 'white', 'error' => '#8B0000', 'blocked' => 'white', 'completed' => 'darkgreen', 'unknown' => '#CFCFCF' }.freeze
+  TEXT_COLORS = { 'waiting' => 'black', 'ready' => 'black', 'error' => 'white', 'blocked' => '#8B0000', 'completed' => 'white', 'unknown' => 'black' }.freeze
+  PATTERNS    = { 'waiting' => 'diagonals', 'ready' => 'filled', 'error' => 'filled', 'blocked' => 'diagonals', 'completed' => 'filled', 'unknown' => 'filled' }.freeze
+  RESERVED_KEYS = %w(repository name).freeze
 
   attr_reader :repo, :name, :processes, :graph, :root
 
@@ -142,7 +142,7 @@ class Graph
         edge.dir = 'both'
         edge.arrowhead = 'none'
         edge.arrowtail = 'none'
-        edge.style = 'dashed' if (wf1 != wf2)
+        edge.style = 'dashed' if wf1 != wf2
         prerequisites << process
       }
       self

data/lib/dor/workflow/process.rb

@@ -53,11 +53,11 @@ module Workflow
     end
 
     def ready?
-      self.waiting? && (!prerequisite.nil?) && prerequisite.all? { |pr| (prq = owner[pr]) && prq.completed? }
+      self.waiting? && !prerequisite.nil? && prerequisite.all? { |pr| (prq = owner[pr]) && prq.completed? }
     end
 
     def blocked?
-      self.waiting? && (!prerequisite.nil?) && prerequisite.any? { |pr| (prq = owner[pr]) && (prq.error? || prq.blocked?) }
+      self.waiting? && !prerequisite.nil? && prerequisite.any? { |pr| (prq = owner[pr]) && (prq.error? || prq.blocked?) }
     end
 
     def state

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dor-services
 version: !ruby/object:Gem::Version
-  version: 5.6.0
+  version: 5.7.0
 platform: ruby
 authors:
 - Michael Klein
@@ -14,7 +14,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-11 00:00:00.000000000 Z
+date: 2016-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active-fedora
@@ -120,20 +120,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
-- !ruby/object:Gem::Dependency
-  name: nokogiri-pretty
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.1'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: om
   requirement: !ruby/object:Gem::Requirement
@@ -579,6 +565,7 @@ files:
 - lib/dor/datastreams/embargo_metadata_ds.rb
 - lib/dor/datastreams/events_ds.rb
 - lib/dor/datastreams/geo_metadata_ds.rb
+- lib/dor/datastreams/human.xslt
 - lib/dor/datastreams/identity.xsl
 - lib/dor/datastreams/identity_metadata_ds.rb
 - lib/dor/datastreams/rights_metadata_ds.rb
@@ -665,7 +652,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Ruby implmentation of DOR services used by the SULAIR Digital Library