fedora_2_to_3_pid_renamer 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 32a1feca267687e4004907cff55c5600d2f91567
+  data.tar.gz: 9db15e938991fae0bf87d1027ef5d5a38efad5b6
+SHA512:
+  metadata.gz: 5ceb7ef9e389863a7efba063a63b45de307a38ab94d4de64b0df837448fd52efb14df4bb99fb5b27179acb0982a35bd590b2ef3783859775ddd67e7a5a67de1e
+  data.tar.gz: e4d6212a162251f325bc47d8ed4a5b2a103cd30abbb257e0ef82b63a73aa90c747f990af7422e1be68f73bfa4ae7d6d80b0028a081d9624c3c79082ecf809cae

data/.gitignore

@@ -0,0 +1,35 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gem 'nokogiri'

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Rob Nichols
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

data/README.md

@@ -0,0 +1,104 @@
+# fedora_2_to_3_pid_renamer
+A small Ruby app used to apply alternative pid names to configuration files 
+created during the migration of fedora 2 data to fedora 3
+
+## Migration process
+
+[Fedora](https://wiki.duraspace.org/display/FF/Fedora+Repository+Home) is an 
+open source repository system for the management and dissemination of digital content.
+
+When [migrating from version 2 to 3](http://fedorarepository.org/sites/fedorarepository.org/files/documentation/3.2.1/index.html)
+the process involves running an Analyzer, that outputs a series of files. 
+Among these files are a some XML files that describe the data objects that 
+are in the existing Fedora 2 database. These files need to be manipulated
+so as to modify the Fedora 2 objects so that they will suitable to be inserted
+into a Fedora 3 database.
+
+This app will carry out the manipulation of the XML files generated by the 
+Analyser
+
+## Installation
+
+Within an environment with ruby installed:
+
+    gem install fedora_2_to_3_pid_renamer
+
+## Configuration
+
+To use this app, you must first create a config.yml file. For example:
+
+```
+changes:
+  CModel1: thesis
+  CModel1-SDep1: thesis-SDep1
+
+changeme: foo
+
+folders:
+  input: 'path/to/analyser/files'
+  output: 'path/to/output/location'
+
+locations:
+  - "//foxml:digitalObject/@PID"
+  - "//rdf:Description/@rdf:about"
+  - "//fedora-model:isContractorOf/@rdf:resource"
+
+namespaces:
+  foxml: "info:fedora/fedora-system:def/foxml#"
+  rdf: "http://www.w3.org/1999/02/22-rdf-syntax-ns#"
+  fedora-model: "info:fedora/fedora-system:def/model#"
+```
+
+### changes
+
+The Analyzer will create model names from the Fedora 2 data. These often need to 
+be changed to domain specific names. 
+
+Each change has a key and value where the key is the Analyzer generated name and 
+the value is the domain specific name that should replace it.
+
+### changeme
+
+The Analyser flags the elements that need to be changed by adding a 'changeme'
+namespace to each one. This needs to be replaced with a domain specific
+namespace.
+
+### folders
+
+Defines the paths to the input and output folders. 
+
+The input folder should contain the XML files generated by the Analyser
+
+An output folder is used so that Analyser files are not directly modified by
+this process. The files can be deleted and the process repeated any number
+of times until the output is satisfactory.
+
+### locations
+
+The locations in the XML files, where the content should be modified. Each 
+location is defined via [XPath](http://www.w3.org/TR/xpath20/). If no suitable
+content is found (as defined in changes and changeme), that location will be
+ignored. 
+
+The locations given in the example above should work for most cases.
+
+### namespaces
+
+For the XML file to be parsed correctly, the namespaces for the locations need
+to be specified.
+
+The namespaces in the example above should work in most cases.
+
+## Execution
+
+To run the process, enter the following command in the same location as the
+config.yml file:
+
+```
+fedora_2_to_3_pid_renamer
+```
+
+Alternatively, you can specify the location of the config.yml:
+
+```
+fedora_2_to_3_pid_renamer -c /path/to/config.yml

data/Rakefile

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'rake'
+require 'rake/clean'
+require 'rdoc/task'
+require 'rake/testtask'
+
+Rake::RDocTask.new do |rdoc|
+  files =['README.rdoc', 'MIT-LICENSE', 'lib/**/*.rb']
+  rdoc.rdoc_files.add(files)
+  rdoc.main = "README.rdoc" # page to start on
+  rdoc.title = "Dibber Docs"
+  rdoc.rdoc_dir = 'doc/rdoc' # rdoc output folder
+  rdoc.options << '--line-numbers'
+end
+
+Rake::TestTask.new do |t|
+  t.test_files = FileList['test/**/*_test.rb']
+end

data/bin/fedora_2_to_3_pid_renamer

@@ -0,0 +1,46 @@
+#!/usr/bin/env ruby
+
+require 'fedora_2_to_3_pid_renamer'
+require 'optparse'
+
+options = {}
+
+opt_parser = OptionParser.new do |opt|  
+
+  opt.banner = "Usage: fedora_2_to_3_pid_renamer [OPTIONS]"
+  opt.separator  ""
+  opt.separator  "Options"
+
+  opt.on("-c","--config PATH","the PATH to the config file") do |config|
+    options[:config] = config
+  end
+
+  opt.on("-h","--help","help") do
+    options[:help] = true
+  end
+end
+
+opt_parser.parse!  
+
+config_path = options[:config] || 'config.yml'
+
+if options[:help]
+
+  puts opt_parser
+
+elsif !File.exist?(config_path)
+
+  puts "Config file not found: #{config_path}\n"
+  puts opt_parser
+
+else
+
+  config = Fedora2To3PidRenamer::Config.load config_path
+
+  puts 'Creating files:'
+  manager = Fedora2To3PidRenamer::Manager.new config
+  manager.run_manipulation
+
+  puts 'Process complete'
+
+end

data/fedora_2_to_3_pid_renamer.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/fedora_2_to_3_pid_renamer/version', __FILE__)
+
+Gem::Specification.new do |gem|  
+  gem.authors       = ["Rob Nichols"]
+  gem.email         = ["rob@undervale.com"]
+  gem.description   = %q{Interates through a series of xml files and modifies their content based on the setting defined in a configuration file}
+  gem.summary       = %q{A small Ruby app used to apply alternative pid names to configuration files created during the migration of fedora 2 data to fedora 3}
+  gem.homepage      = "https://github.com/reggieb/fedora_2_to_3_pid_renamer"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = ["fedora_2_to_3_pid_renamer"]
+  gem.test_files    = gem.files.grep(%r{^test/})
+  gem.name          = "fedora_2_to_3_pid_renamer"
+  gem.require_paths = ["lib"]
+  gem.version       = Fedora2To3PidRenamer::VERSION
+end

data/lib/fedora_2_to_3_pid_renamer.rb

@@ -0,0 +1,7 @@
+require_relative 'fedora_2_to_3_pid_renamer/config'
+require_relative 'fedora_2_to_3_pid_renamer/manipulator'
+require_relative 'fedora_2_to_3_pid_renamer/manager'
+
+module Fedora2To3PidRenamer
+  # TODO Put your code here
+end

data/lib/fedora_2_to_3_pid_renamer/config.rb

@@ -0,0 +1,58 @@
+require 'yaml'
+module Fedora2To3PidRenamer
+  class Config
+
+    attr_reader :source
+
+    def self.load(path)
+      new File.read(path)
+    end
+
+    def initialize(source)
+      @source = source
+    end
+
+    def namespaces
+      @namespaces ||= yaml['namespaces']
+    end
+
+    def locations
+      @locations ||= yaml['locations']
+    end
+
+    def changes
+      @changes ||= yaml['changes']
+    end
+    
+    def folders
+      yaml['folders']
+    end
+
+    def change_for(original)
+      changes[original]
+    end
+
+    def changeme_replacement
+      yaml['changeme']
+    end
+    
+    def input_folder
+      return unless folders
+      @input_folder ||= path_relative_to_working_directory folders['input']
+    end
+    
+    def output_folder
+      return unless folders
+      @output_folder ||= path_relative_to_working_directory folders['output']
+    end
+
+    def yaml
+      @yaml ||= YAML.load(source)
+    end
+    
+    def path_relative_to_working_directory(folder)
+      File.expand_path folder, Dir.pwd
+    end
+
+  end
+end

data/lib/fedora_2_to_3_pid_renamer/manager.rb

@@ -0,0 +1,31 @@
+
+module Fedora2To3PidRenamer
+  class Manager
+    
+    attr_accessor :config
+    
+    def initialize(config)
+      @config = config
+    end
+    
+    def create_output_folder
+      return false if Dir.exist?(config.output_folder)
+      FileUtils.mkdir config.output_folder
+    end
+    
+    def run_manipulation
+      create_output_folder
+      Dir.glob(input_file_pattern).each do |input_file|
+        file_name = File.basename input_file
+        input = File.read input_file        
+        output_file = File.join config.output_folder, file_name
+        File.write output_file, Manipulator.output_for(input, config)
+        puts output_file
+      end
+    end
+    
+    def input_file_pattern
+      File.join config.input_folder, '*.xml'
+    end
+  end
+end

data/lib/fedora_2_to_3_pid_renamer/manipulator.rb

@@ -0,0 +1,50 @@
+require 'nokogiri'
+module Fedora2To3PidRenamer
+  class Manipulator
+
+    attr_accessor :raw_xml, :config
+    
+    def self.output_for(raw_xml, config)
+      manipulator = new(raw_xml, config)
+      manipulator.run
+      manipulator.output
+    end
+
+    def initialize(raw_xml, config)
+      @raw_xml = raw_xml
+      @config = config
+    end
+
+    def run
+      modify_text_at_each_location_in_config
+    end
+
+    def xml
+      @xml ||= Nokogiri::XML(raw_xml)
+    end
+    
+    def output
+      xml.to_s
+    end
+    
+    private
+    def modify_text_at_each_location_in_config
+      config.locations.each do |location|
+
+        node = xml.xpath(location, config.namespaces).first
+        next unless node
+        
+        text = node.value
+        config.changes.each do |before, after|
+          text.gsub! before, after
+        end
+
+        text.gsub! 'changeme:', (config.changeme_replacement + ':')
+        
+        node.value = text
+
+      end
+    end
+
+  end
+end

data/lib/fedora_2_to_3_pid_renamer/version.rb

@@ -0,0 +1,3 @@
+module Fedora2To3PidRenamer
+  VERSION = '0.0.1'
+end

data/test/data/cmodel-1.deployment1.xml

@@ -0,0 +1,181 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<foxml:digitalObject VERSION="1.1" PID="changeme:CModel1-SDep1"
+xmlns:foxml="info:fedora/fedora-system:def/foxml#"
+xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+xsi:schemaLocation="info:fedora/fedora-system:def/foxml# http://www.fedora.info/definitions/1/0/foxml1-1.xsd">
+<foxml:objectProperties>
+<foxml:property NAME="info:fedora/fedora-system:def/model#label" VALUE="Generated deployment for changeme:CModel1 (copy of demo:9)"/>
+</foxml:objectProperties>
+<foxml:datastream ID="DSINPUTSPEC" STATE="A" CONTROL_GROUP="X" VERSIONABLE="true">
+<foxml:datastreamVersion ID="DSINPUTSPEC1.0" LABEL="Datastream Input Specification for UVA MrSID service" CREATED="2015-09-15T13:08:26.575Z" MIMETYPE="text/xml" FORMAT_URI="info:fedora/fedora-system:FedoraDSInputSpec-1.1" SIZE="480">
+<foxml:xmlContent>
+<fbs:DSInputSpec xmlns:fbs="http://fedora.comm.nsdlib.org/service/bindspec" label="MrSID Service Datastream Input Specification">
+					<fbs:DSInput DSMax="1" DSMin="1" DSOrdinality="false" wsdlMsgPartName="DS1">
+						<fbs:DSInputLabel>MrSid file</fbs:DSInputLabel>
+						<fbs:DSMIME>image/x-mrsid-image</fbs:DSMIME>
+						<fbs:DSInputInstruction>MrSid wavelet encoded image file</fbs:DSInputInstruction>
+					</fbs:DSInput>
+				</fbs:DSInputSpec>
+</foxml:xmlContent>
+</foxml:datastreamVersion>
+</foxml:datastream>
+<foxml:datastream ID="METHODMAP" STATE="A" CONTROL_GROUP="X" VERSIONABLE="true">
+<foxml:datastreamVersion ID="METHODMAP1.0" LABEL="Mapping of WSDL to Fedora notion of Method Definitions" CREATED="2015-09-15T13:08:26.575Z" MIMETYPE="text/xml" FORMAT_URI="info:fedora/fedora-system:FedoraSDepMethodMap-1.1" SIZE="1477">
+<foxml:xmlContent>
+<fmm:MethodMap xmlns:fmm="http://fedora.comm.nsdlib.org/service/methodmap" name="MethodMap - MrSID BMech for UserInput Image BDEF">
+					<fmm:Method operationName="getThumbnail" wsdlMsgName="getThumbRequest" wsdlMsgOutput="mrsid_response">
+						<fmm:DatastreamInputParm parmName="DS1" passBy="URL_REF" required=""/>
+						<fmm:MethodReturnType wsdlMsgName="mrsid_response" wsdlMsgTOMIME="image/gif"/>
+					</fmm:Method>
+					<fmm:Method operationName="getImage" wsdlMsgName="getImageRequest" wsdlMsgOutput="mrsid_response">
+						<fmm:UserInputParm defaultValue="yes" parmName="ZOOM" passBy="VALUE" required="true">
+							<fmm:ValidParmValues>
+								<fmm:ValidParm value="yes"/>
+								<fmm:ValidParm value="no"/>
+							</fmm:ValidParmValues>
+						</fmm:UserInputParm>
+						<fmm:UserInputParm defaultValue="medium1" parmName="SIZE" passBy="VALUE" required="true">
+							<fmm:ValidParmValues>
+								<fmm:ValidParm value="small"/>
+								<fmm:ValidParm value="medium1"/>
+								<fmm:ValidParm value="medium2"/>
+							</fmm:ValidParmValues>
+						</fmm:UserInputParm>
+						<fmm:DatastreamInputParm parmName="DS1" passBy="URL_REF" required=""/>
+						<fmm:MethodReturnType wsdlMsgName="mrsid_response" wsdlMsgTOMIME="application/java image/gif"/>
+					</fmm:Method>
+				</fmm:MethodMap>
+</foxml:xmlContent>
+</foxml:datastreamVersion>
+</foxml:datastream>
+<foxml:datastream ID="WSDL" STATE="A" CONTROL_GROUP="X" VERSIONABLE="true">
+<foxml:datastreamVersion ID="WSDL1.0" LABEL="WSDL definition for UVA&apos;s MrSid service" CREATED="2015-09-15T13:08:26.575Z" MIMETYPE="text/xml" FORMAT_URI="http://schemas.xmlsoap.org/wsdl/" SIZE="3325">
+<foxml:xmlContent>
+<wsdl:definitions xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/" xmlns:http="http://schemas.xmlsoap.org/wsdl/http/" xmlns:mime="http://schemas.xmlsoap.org/wsdl/mime/" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap" xmlns:soapenc="http://schemas.xmlsoap.org/wsdl/soap/encoding" xmlns:this="mrsid" xmlns:xsd="http://www.w3.org/2001/XMLSchema" name="MrSID Service" targetNamespace="mrsid">
+					<wsdl:types>
+						<xsd:schema targetNamespace="mrsid">
+							<xsd:simpleType name="MRSIDType">
+								<xsd:restriction base="xsd:string"/>
+							</xsd:simpleType>
+							<xsd:simpleType name="ZOOMType">
+								<xsd:restriction base="xsd:string">
+									<xsd:enumeration value="yes"/>
+									<xsd:enumeration value="no"/>
+								</xsd:restriction>
+							</xsd:simpleType>
+							<xsd:simpleType name="SIZEType">
+								<xsd:restriction base="xsd:string">
+									<xsd:enumeration value="small"/>
+									<xsd:enumeration value="medium1"/>
+									<xsd:enumeration value="medium2"/>
+								</xsd:restriction>
+							</xsd:simpleType>
+						</xsd:schema>
+					</wsdl:types>
+					<wsdl:message name="getThumbRequest">
+						<wsdl:part name="DS1" type="this:MRSIDType"/>
+					</wsdl:message>
+					<wsdl:message name="getImageRequest">
+						<wsdl:part name="DS1" type="this:MRSIDType"/>
+						<wsdl:part name="SIZE" type="this:SIZEType"/>
+						<wsdl:part name="ZOOM" type="this:ZOOMType"/>
+					</wsdl:message>
+					<wsdl:message name="mrsid_response">
+						<wsdl:part name="image" type="xsd:base64Binary"/>
+					</wsdl:message>
+					<wsdl:portType name="MrSIDPortType">
+						<wsdl:operation name="getThumbnail">
+							<wsdl:input message="this:getThumbRequest"/>
+							<wsdl:output message="this:mrsid_response"/>
+						</wsdl:operation>
+						<wsdl:operation name="getImage">
+							<wsdl:input message="this:getImageRequest"/>
+							<wsdl:output message="this:mrsid_response"/>
+						</wsdl:operation>
+					</wsdl:portType>
+					<wsdl:service name="MrSID">
+						<wsdl:port binding="this:MrSID_http" name="MrSID_port">
+							<http:address location="http://iris.lib.virginia.edu/mrsid/bin/"/>
+						</wsdl:port>
+					</wsdl:service>
+					<wsdl:binding name="MrSID_http" type="this:MrSIDPortType">
+						<http:binding verb="GET"/>
+						<wsdl:operation name="getThumbnail">
+							<http:operation location="get_mrsid_url.pl?image=(DS1)&amp;size=thumbnail"/>
+							<wsdl:input>
+								<http:urlReplacement/>
+							</wsdl:input>
+							<wsdl:output>
+								<mime:content type="image/gif"/>
+							</wsdl:output>
+						</wsdl:operation>
+						<wsdl:operation name="getImage">
+							<http:operation location="get_mrsid_url.pl?image=(DS1)&amp;size=(SIZE)&amp;zoom=(ZOOM)"/>
+							<wsdl:input>
+								<http:urlReplacement/>
+							</wsdl:input>
+							<wsdl:output>
+								<mime:content type="text/html"/>
+								<mime:content type="image/jpeg"/>
+							</wsdl:output>
+						</wsdl:operation>
+					</wsdl:binding>
+				</wsdl:definitions>
+</foxml:xmlContent>
+</foxml:datastreamVersion>
+</foxml:datastream>
+<foxml:datastream ID="RELS-EXT" STATE="A" CONTROL_GROUP="X" VERSIONABLE="true">
+<foxml:datastreamVersion ID="RELS-EXT1.0" LABEL="RDF Statements about this object" CREATED="2015-09-16T10:16:38.426Z" MIMETYPE="application/rdf+xml" FORMAT_URI="info:fedora/fedora-system:FedoraRELSExt-1.0">
+<foxml:xmlContent>
+<rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns:fedora-model="info:fedora/fedora-system:def/model#">
+  <rdf:Description rdf:about="info:fedora/changeme:CModel1-SDep1">
+    <fedora-model:isDeploymentOf rdf:resource="info:fedora/demo:8"/>
+    <fedora-model:isContractorOf rdf:resource="info:fedora/changeme:CModel1"/>
+    <fedora-model:hasModel rdf:resource="info:fedora/fedora-system:ServiceDeployment-3.0"/>
+  </rdf:Description>
+</rdf:RDF>
+</foxml:xmlContent>
+</foxml:datastreamVersion>
+</foxml:datastream>
+<foxml:datastream ID="DS1" STATE="A" CONTROL_GROUP="E" VERSIONABLE="true">
+<foxml:datastreamVersion ID="DS1.0" LABEL="Programmer documentation" CREATED="2015-09-15T13:08:26.575Z" MIMETYPE="text/html">
+<foxml:contentLocation TYPE="URL" REF=" http://uva.lib.edu/mech/mrsid/doc/mrsid.html"/>
+</foxml:datastreamVersion>
+</foxml:datastream>
+<foxml:datastream ID="DC" STATE="A" CONTROL_GROUP="X" VERSIONABLE="true">
+<foxml:datastreamVersion ID="DC1.0" LABEL="Dublin Core Metadata" CREATED="2015-09-15T13:08:26.575Z" MIMETYPE="text/xml" FORMAT_URI="http://www.openarchives.org/OAI/2.0/oai_dc/" SIZE="306">
+<foxml:xmlContent>
+<oai_dc:dc xmlns:oai_dc="http://www.openarchives.org/OAI/2.0/oai_dc/" xmlns:dc="http://purl.org/dc/elements/1.1/">
+  <dc:title>Behavior Mechanism Object implementing the UserInput Image BDEF contract using the UVA MrSID Service.</dc:title>
+  <dc:identifier>demo:9</dc:identifier>
+</oai_dc:dc>
+</foxml:xmlContent>
+</foxml:datastreamVersion>
+</foxml:datastream>
+<foxml:datastream ID="SERVICE-PROFILE" STATE="A" CONTROL_GROUP="X" VERSIONABLE="true">
+<foxml:datastreamVersion ID="SERVICE-PROFILE1.0" LABEL="Service Profile - Technical description of the service" CREATED="2015-09-15T13:08:26.575Z" MIMETYPE="text/xml" SIZE="1310">
+<foxml:xmlContent>
+<fsvp:serviceProfile xmlns:fsvp="http://fedora.comm.nsdlib.org/service/profile" bDefPID="demo:8" name="MrSID Service">
+					<fsvp:serviceDescription>MrSID service for providing different image resolutions from a wavelet encoded file, along with zoom capability </fsvp:serviceDescription>
+					<fsvp:serviceImplementation>
+						<fsvp:serviceLiveTestURL>http://iris.lib.virginia.edu/mrsid</fsvp:serviceLiveTestURL>
+						<fsvp:serviceMessagingProtocol>HTTP GET</fsvp:serviceMessagingProtocol>
+						<fsvp:serviceInputFormats>
+							<fsvp:MIMEType>image/x-mrsid-image</fsvp:MIMEType>
+						</fsvp:serviceInputFormats>
+						<fsvp:serviceOutputFormats>
+							<fsvp:MIMEType>text/html</fsvp:MIMEType>
+							<fsvp:MIMEType>image/gif</fsvp:MIMEType>
+							<fsvp:MIMEType>image/jpeg</fsvp:MIMEType>
+							<fsvp:MIMEType>application/java</fsvp:MIMEType>
+						</fsvp:serviceOutputFormats>
+						<fsvp:serviceImplDependencies>
+							<fsvp:software license="Commercial" name="MrSID Image Server" opensource="false" type="Server_Application" version="2.2"></fsvp:software>
+							<fsvp:software license="GNU_GPL" name="perl" opensource="true" type="Programming_Language" version="5.6"></fsvp:software>
+						</fsvp:serviceImplDependencies>
+					</fsvp:serviceImplementation>
+				</fsvp:serviceProfile>
+</foxml:xmlContent>
+</foxml:datastreamVersion>
+</foxml:datastream>
+</foxml:digitalObject>

data/test/data/cmodel-1.xml

@@ -0,0 +1,79 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<foxml:digitalObject VERSION="1.1" PID="changeme:CModel1"
+xmlns:foxml="info:fedora/fedora-system:def/foxml#"
+xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+xsi:schemaLocation="info:fedora/fedora-system:def/foxml# http://www.fedora.info/definitions/1/0/foxml1-1.xsd">
+<foxml:objectProperties>
+<foxml:property NAME="info:fedora/fedora-system:def/model#label" VALUE="Generated CModel"/>
+</foxml:objectProperties>
+<foxml:datastream ID="RELS-EXT" STATE="A" CONTROL_GROUP="X" VERSIONABLE="true">
+<foxml:datastreamVersion ID="RELS-EXT1.0" LABEL="RDF Statements about this object" CREATED="2015-09-16T10:16:15.130Z" MIMETYPE="application/rdf+xml" FORMAT_URI="info:fedora/fedora-system:FedoraRELSExt-1.0">
+<foxml:xmlContent>
+<rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns:fedora-model="info:fedora/fedora-system:def/model#">
+  <rdf:Description rdf:about="info:fedora/changeme:CModel1">
+    <fedora-model:hasService rdf:resource="info:fedora/demo:8"/>
+    <fedora-model:hasModel rdf:resource="info:fedora/fedora-system:ContentModel-3.0"/>
+  </rdf:Description></rdf:RDF>
+</foxml:xmlContent>
+</foxml:datastreamVersion>
+</foxml:datastream>
+<foxml:datastream ID="DS-COMPOSITE-MODEL" STATE="A" CONTROL_GROUP="X" VERSIONABLE="true">
+<foxml:datastreamVersion ID="DS-COMPOSITE-MODEL1.0" LABEL="Datastream Composite Model" CREATED="2015-09-16T10:16:15.130Z" MIMETYPE="text/xml" FORMAT_URI="info:fedora/fedora-system:FedoraDSCompositeModel-1.0">
+<foxml:xmlContent>
+<dsCompositeModel xmlns="info:fedora/fedora-system:def/dsCompositeModel#">
+  <dsTypeModel ID="DIGIPROV1">
+    <form MIME="text/xml"/>
+  </dsTypeModel>
+  <dsTypeModel ID="DS1">
+    <form MIME="image/x-mrsid-image"/>
+  </dsTypeModel>
+  <dsTypeModel ID="SOURCE1">
+    <form MIME="text/xml"/>
+  </dsTypeModel>
+  <dsTypeModel ID="DESC1">
+    <form MIME="text/xml"/>
+  </dsTypeModel>
+  <dsTypeModel ID="RIGHTS1">
+    <form MIME="text/xml"/>
+  </dsTypeModel>
+  <dsTypeModel ID="TECH1">
+    <form MIME="text/xml"/>
+  </dsTypeModel>
+</dsCompositeModel>
+</foxml:xmlContent>
+</foxml:datastreamVersion>
+</foxml:datastream>
+<foxml:datastream ID="CLASS-DESCRIPTION" STATE="A" CONTROL_GROUP="X" VERSIONABLE="true">
+<foxml:datastreamVersion ID="CLASS-DESCRIPTION1.0" LABEL="Technical description of the class of objects assigned to this content model" CREATED="2015-09-16T10:16:15.130Z" MIMETYPE="text/xml">
+<foxml:xmlContent>
+<class-description>
+OrigContentModel
+  'UVA_MRSID_IMAGE'
+BDefPIDs
+  'demo:8'
+BMechPIDs
+  'demo:9'
+BindingKeyAssignments
+  for demo:9
+    'MRSID=DS1'
+DatastreamIDs
+  'DIGIPROV1', 'DS1', 'SOURCE1', 'DESC1', 'RIGHTS1', 'TECH1'
+MIMETypes
+  for DIGIPROV1, 'text/xml'
+  for DS1, 'image/x-mrsid-image'
+  for SOURCE1, 'text/xml'
+  for DESC1, 'text/xml'
+  for RIGHTS1, 'text/xml'
+  for TECH1, 'text/xml'
+FormatURIs
+  for DIGIPROV1, none
+  for DS1, none
+  for SOURCE1, none
+  for DESC1, none
+  for RIGHTS1, none
+  for TECH1, none
+</class-description>
+</foxml:xmlContent>
+</foxml:datastreamVersion>
+</foxml:datastream>
+</foxml:digitalObject>

data/test/data/config.yml

@@ -0,0 +1,27 @@
+# See http://fedorarepository.org/sites/fedorarepository.org/files/documentation/3.2.1/index.html
+# How names generated by migration analyser will be converted to local names
+changes:
+  CModel1: thesis
+  CModel1-SDep1: thesis-SDep1
+
+# How changeme text will be renamed
+changeme: foo
+
+# folders where target files are located (input), 
+# and where the modified files will be placed (output)
+# relative paths will be relative to the working directory
+folders:
+  input: 'test/data/input'
+  output: 'test/data/output'
+
+# Xpath locations where elements need to be renamed
+locations:
+  - "//foxml:digitalObject/@PID"
+  - "//rdf:Description/@rdf:about"
+  - "//fedora-model:isContractorOf/@rdf:resource"
+  
+# Namespaces within documents - needed to process XML
+namespaces:
+  foxml: "info:fedora/fedora-system:def/foxml#"
+  rdf: "http://www.w3.org/1999/02/22-rdf-syntax-ns#"
+  fedora-model: "info:fedora/fedora-system:def/model#"

data/test/data/simple.xml

@@ -0,0 +1,3 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<foo ID="bar">
+</foo>

data/test/test_helper.rb

@@ -0,0 +1,30 @@
+require 'minitest/autorun'
+require 'nokogiri'
+require_relative '../lib/fedora_2_to_3_pid_renamer'
+
+class Minitest::Test
+  def xml_load(file_name)
+    file = file_read(file_name)
+    Nokogiri::XML file
+  end
+
+  def data_file_path(file_name)
+    File.expand_path("data/#{file_name}", File.dirname(__FILE__))
+  end
+
+  def file_read(file_name)
+    File.read data_file_path(file_name)
+  end
+  
+  def config
+    @config ||= Fedora2To3PidRenamer::Config.new(config_source)
+  end
+
+  def config_source
+    @config_source ||= File.read config_file_path
+  end
+  
+  def config_file_path
+    data_file_path 'config.yml'
+  end
+end

data/test/units/fedora_2_to_3_pid_renamer/config_test.rb

@@ -0,0 +1,49 @@
+require_relative '../../test_helper'
+
+module Fedora2To3PidRenamer
+  class ConfigTest < Minitest::Test
+
+    def test_namespaces
+      assert_equal config_yml['namespaces'], config.namespaces
+    end
+
+    def test_locations
+      assert_equal config_yml['locations'], config.locations
+    end
+
+    def test_changes
+      assert_equal config_yml['changes'], config.changes
+    end
+
+    def test_change_for
+      changes = config_yml['changes']
+      changes.each do |original, becomes|
+        assert_equal becomes, config.change_for(original), "#{original} should become #{becomes}"
+      end
+    end
+
+    def test_changeme_replacement
+      assert_equal config_yml['changeme'], config.changeme_replacement
+    end
+
+    def test_load
+      config = Config.load(config_file_path)
+      assert_equal config_yml['changes'], config.changes
+    end
+    
+    def test_input_folder
+      assert_match File.join('test', 'data', 'input'), config.input_folder 
+    end
+    
+    def test_input_folder
+      assert_match File.join('test', 'data', 'output'), config.output_folder 
+    end
+
+    private
+
+    def config_yml
+      @config_yml ||= YAML.load(config_source)
+    end
+
+  end
+end

data/test/units/fedora_2_to_3_pid_renamer/manager_test.rb

@@ -0,0 +1,65 @@
+require_relative '../../test_helper'
+require 'fileutils'
+
+module Fedora2To3PidRenamer
+  class ManagerTest < Minitest::Test
+    
+    def setup
+      FileUtils.mkdir data_file_path('input')
+      FileUtils.mkdir data_file_path('output')
+      target_files.each do |file|
+        destination = File.join 'input', file
+        FileUtils.cp data_file_path(file), data_file_path(destination)
+      end
+    end
+
+    def teardown
+      FileUtils.remove_dir data_file_path('input'), true
+      FileUtils.remove_dir data_file_path('output'), true
+    end
+    
+    def test_before
+      output_files = Dir.glob(data_file_path 'output/*.xml')
+      assert output_files.empty?, "There should be no files in output: #{output_files}"
+    end
+    
+    def test_create_output_folder
+      assert_equal false, manager.create_output_folder
+      assert_equal true, Dir.exist?(config.output_folder)
+    end
+    
+    def test_create_output_folder_when_none_exists
+      FileUtils.remove_dir data_file_path('output'), true
+      assert manager.create_output_folder, 'Should return truthy if folder created'
+      assert_equal true, Dir.exist?(config.output_folder)
+    end
+    
+    def test_run_manipulation
+      manager.run_manipulation
+      target_files.each do |file|
+        output_file = data_file_path(File.join('output', file))
+        assert File.exist?(output_file), "#{output_file} should exist"
+      end
+    end
+    
+    def test_run_manipulation_alters_content
+      manager.run_manipulation
+      xml = xml_load File.join('output', target_files.first)
+      xpath = config.locations.first
+      text = xml.xpath(xpath).text
+      assert_match config.changeme_replacement, text
+    end   
+    
+    def manager
+      @manager ||= Manager.new(config)
+    end
+    
+    def target_files
+      [
+        'cmodel-1.xml', 
+        'cmodel-1.deployment1.xml'
+      ]
+    end
+
+  end
+end

data/test/units/fedora_2_to_3_pid_renamer/manipulator_test.rb

@@ -0,0 +1,62 @@
+require_relative '../../test_helper'
+
+module Fedora2To3PidRenamer
+  class ManipulatorTest < Minitest::Test
+
+    def test_run
+      before, after = config.changes.first      
+      assert_at_xpath_text_changes(before, after) { manipulator.run }
+    end
+    
+    def test_run_modifies_changeme_namespace
+      before = 'changeme:'
+      after = config.changeme_replacement + ':'      
+      assert_at_xpath_text_changes(before, after) { manipulator.run }
+    end
+    
+    def test_output
+      assert_equal Nokogiri::XML(xml_raw).to_s, manipulator.output
+    end
+    
+    def test_run_alters_output
+      manipulator.run
+      refute_equal Nokogiri::XML(xml_raw).to_s, manipulator.output
+    end
+    
+    def test_run_produces_well_formed_xml
+      manipulator.run
+      doc = Nokogiri::XML manipulator.output
+      assert doc.errors.empty?, "Nokogiri should not find errors: #{doc.errors}"
+    end
+    
+    def test_output_for
+      manipulator.run
+      assert_equal manipulator.output, Manipulator.output_for(xml_raw, config)
+    end
+    
+    private
+    def assert_at_xpath_text_changes(before, after)
+      xpath = config.locations.first
+      
+      text_before = manipulator.xml.xpath(xpath, config.namespaces).text
+      assert_match before, text_before
+      refute_match after, text_before
+      
+      yield
+      
+      text_after = manipulator.xml.xpath(xpath, config.namespaces).text
+      refute_match before, text_after
+      assert_match after, text_after
+    end
+    
+
+    def manipulator
+      @manipulator ||= Manipulator.new(xml_raw, config)
+    end
+
+    def xml_raw
+      @xml_raw ||= file_read 'cmodel-1.xml'
+    end
+
+  end
+end

data/test/units/fedora_2_to_3_pid_renamer_test.rb

@@ -0,0 +1,45 @@
+require_relative '../test_helper'
+
+class Fedora2To3PidRenamerTest < Minitest::Test
+
+  def test_environment
+    assert_equal true, true
+  end
+
+  def test_data_can_be_loaded
+    lines = File.readlines(xml_file_path)
+    expected = '<?xml version="1.0" encoding="UTF-8"?>'
+    assert_equal expected, lines.first.strip
+  end
+
+  def test_xml_load
+    file = File.read(xml_file_path)
+    xml = Nokogiri::XML(file)
+    assert_equal Nokogiri::XML::Document, xml_load(xml_file_name).class
+    assert_equal xml.children.size, xml_load(xml_file_name).children.size
+    assert_equal xml.to_s, xml_load(xml_file_name).to_s
+  end
+
+  def test_get_xml_attribute
+    expected = 'changeme:CModel1'
+    xml = xml_load(xml_file_name)
+    namespaces = {'foxml' => 'info:fedora/fedora-system:def/foxml#'}
+    node = xml.xpath('//foxml:digitalObject/@PID', namespaces)
+    assert_equal expected, node.text
+  end
+
+  def test_get_xml_attribute_from_simple
+    xml = xml_load('simple.xml')
+    node = xml.xpath('//foo/@ID')
+    assert_equal 'bar', node.text
+  end
+
+  def xml_file_path
+    File.expand_path("../data/#{xml_file_name}", File.dirname(__FILE__))
+  end
+
+  def xml_file_name
+    'cmodel-1.xml'
+  end
+
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: fedora_2_to_3_pid_renamer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Rob Nichols
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-24 00:00:00.000000000 Z
+dependencies: []
+description: Interates through a series of xml files and modifies their content based
+  on the setting defined in a configuration file
+email:
+- rob@undervale.com
+executables:
+- fedora_2_to_3_pid_renamer
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/fedora_2_to_3_pid_renamer
+- fedora_2_to_3_pid_renamer.gemspec
+- lib/fedora_2_to_3_pid_renamer.rb
+- lib/fedora_2_to_3_pid_renamer/config.rb
+- lib/fedora_2_to_3_pid_renamer/manager.rb
+- lib/fedora_2_to_3_pid_renamer/manipulator.rb
+- lib/fedora_2_to_3_pid_renamer/version.rb
+- test/data/cmodel-1.deployment1.xml
+- test/data/cmodel-1.xml
+- test/data/config.yml
+- test/data/simple.xml
+- test/test_helper.rb
+- test/units/fedora_2_to_3_pid_renamer/config_test.rb
+- test/units/fedora_2_to_3_pid_renamer/manager_test.rb
+- test/units/fedora_2_to_3_pid_renamer/manipulator_test.rb
+- test/units/fedora_2_to_3_pid_renamer_test.rb
+homepage: https://github.com/reggieb/fedora_2_to_3_pid_renamer
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: A small Ruby app used to apply alternative pid names to configuration files
+  created during the migration of fedora 2 data to fedora 3
+test_files:
+- test/data/cmodel-1.deployment1.xml
+- test/data/cmodel-1.xml
+- test/data/config.yml
+- test/data/simple.xml
+- test/test_helper.rb
+- test/units/fedora_2_to_3_pid_renamer/config_test.rb
+- test/units/fedora_2_to_3_pid_renamer/manager_test.rb
+- test/units/fedora_2_to_3_pid_renamer/manipulator_test.rb
+- test/units/fedora_2_to_3_pid_renamer_test.rb