druid-tools 0.2.6

data/.gitignore

@@ -0,0 +1,16 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+InstalledFiles
+_yardoc
+coverage
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+Gemfile.lock

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.8.7@druid-tools --create

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in druid-tools.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Stanford University Library
+
+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,80 @@
+# Druid::Tools
+
+Tools to manipulate DRUID trees and content directories
+
+## Usage
+
+### Get attributes and paths
+
+    d = DruidTools.new('druid:ab123cd4567', '/dor/workspace')
+    d.druid
+    => "druid:ab123cd4567"
+    d.id
+    => "ab123cd4567"
+    d.path
+    => "/dor/workspace/ab/123/cd/4567/ab123cd4567"
+    d.content_dir
+    => "/dor/workspace/ab/123/cd/4567/ab123cd4567/content"
+    d.path('content/my_file.jpg')
+    => "/dor/workspace/ab/123/cd/4567/ab123cd4567/content/my_file.jpg"
+
+### Check whether a druid is valid
+
+    d = DruidTools::Druid.valid?('druid:ab123cd4567')
+    => true
+    d = DruidTools::Druid.valid?('blah')
+    => false
+
+### Manipulate directories and symlinks
+
+    # Make the druid tree
+    d.mkdir
+    # Make a directory within the druid triee
+    d.mkdir('temp')
+    # Remove a druid tree, but only up to the last shared branch directory
+    d.rmdir
+    # Link content from another source into a druid tree
+    d.mkdir_with_final_link('/some/other/content/location')
+    
+### Content-specific methods create the relevant directories if they don't exist
+
+Pass `false` as a parameter to prevent directory creation, or `true` (default) to create directories.
+
+    d.content_dir(false)
+    => "/dor/workspace/ab/123/cd/4567/ab123cd4567/content"
+    File.directory?(d.content_dir(false))
+    => false
+    File.directory?(d.content_dir)
+    => true
+    d.metadata_dir(false)
+    => "/dor/workspace/ab/123/cd/4567/ab123cd4567/metadata"
+    d.temp_dir(false)
+    => "/dor/workspace/ab/123/cd/4567/ab123cd4567/temp"
+    
+### Locate existing content within the druid tree
+
+    # In the correct directory
+    d.find_metadata('contentMetadata.xml')
+    => "/dor/workspace/ab/123/cd/4567/ab123cd4567/metadata/contentMetadata.xml"
+    
+    # In other known previous locations, for backward compatibility
+    d.find_metadata('contentMetadata.xml')
+    => "/dor/workspace/ab/123/cd/4567/ab123cd4567/contentMetadata.xml"
+
+    d.find_metadata('contentMetadata.xml')
+    => "/dor/workspace/ab/123/cd/4567/contentMetadata.xml"
+    
+    d.find_content('this/file/does/not/exist.jpg')
+    => nil
+    
+## History
+
+- <b>0.2.6</b> - Fixed VERSION warning message, and documentation cleanup
+- <b>0.2.5</b> - Added glob pattern as DruidTools::Druid.glob
+- <b>0.2.4</b> - Allow non-String as .new parameter and added InvalidDruidError
+- <b>0.2.3</b> - Fine tune behavior of find_filelist_parent
+- <b>0.2.2</b> - Added find_filelist_parent method allowing search for a set of files
+- <b>0.2.1</b> - Do not error out during symlink creation if it already exists
+- <b>0.2.0</b> - Added DruidTools::Druid.valid?
+- <b>0.1.0</b> - Additional support for alternate content locations
+- <b>0.0.1</b> - Initial Release 

data/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/VERSION

@@ -0,0 +1 @@
+0.2.6

data/doc/classes/DruidTools.html

@@ -0,0 +1,132 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>Module: DruidTools</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+
+    elemStyle = elem.style;
+    
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+
+    return true;
+  }
+  
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  
+  // ]]>
+  </script>
+
+</head>
+<body>
+
+
+
+    <div id="classHeader">
+        <table class="header-table">
+        <tr class="top-aligned-row">
+          <td><strong>Module</strong></td>
+          <td class="class-name-in-header">DruidTools</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../files/lib/druid_tools/druid_rb.html">
+                lib/druid_tools/druid.rb
+                </a>
+        <br />
+                <a href="../files/lib/druid_tools/version_rb.html">
+                lib/druid_tools/version.rb
+                </a>
+        <br />
+                <a href="../files/lib/druid_tools_rb.html">
+                lib/druid_tools.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+
+        </table>
+    </div>
+  <!-- banner header -->
+
+  <div id="bodyContent">
+
+
+
+  <div id="contextContent">
+
+
+
+   </div>
+
+
+  </div>
+
+
+    <!-- if includes -->
+
+    <div id="section">
+
+    <div id="class-list">
+      <h3 class="section-bar">Classes and Modules</h3>
+
+      Class <a href="DruidTools/Druid.html" class="link">DruidTools::Druid</a><br />
+
+    </div>
+
+    <div id="constants-list">
+      <h3 class="section-bar">Constants</h3>
+
+      <div class="name-list">
+        <table summary="Constants">
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">VERSION</td>
+          <td>=</td>
+          <td class="context-item-value">File.read(File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'VERSION'))).to_s.strip</td>
+        </tr>
+        </table>
+      </div>
+    </div>
+
+
+
+      
+
+
+    <!-- if method_list -->
+
+
+  </div>
+
+
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
+</html>

data/doc/classes/DruidTools/DifferentContentExistsError.html

@@ -0,0 +1,111 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>Class: DruidTools::DifferentContentExistsError</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+
+    elemStyle = elem.style;
+    
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+
+    return true;
+  }
+  
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  
+  // ]]>
+  </script>
+
+</head>
+<body>
+
+
+
+    <div id="classHeader">
+        <table class="header-table">
+        <tr class="top-aligned-row">
+          <td><strong>Class</strong></td>
+          <td class="class-name-in-header">DruidTools::DifferentContentExistsError</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../../files/lib/druid_tools/exceptions_rb.html">
+                lib/druid_tools/exceptions.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+
+        <tr class="top-aligned-row">
+            <td><strong>Parent:</strong></td>
+            <td>
+                Exception
+            </td>
+        </tr>
+        </table>
+    </div>
+  <!-- banner header -->
+
+  <div id="bodyContent">
+
+
+
+  <div id="contextContent">
+
+
+
+   </div>
+
+
+  </div>
+
+
+    <!-- if includes -->
+
+    <div id="section">
+
+
+
+
+
+      
+
+
+    <!-- if method_list -->
+
+
+  </div>
+
+
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
+</html>

data/doc/classes/DruidTools/Druid.html

@@ -0,0 +1,352 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>Class: DruidTools::Druid</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+
+    elemStyle = elem.style;
+    
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+
+    return true;
+  }
+  
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  
+  // ]]>
+  </script>
+
+</head>
+<body>
+
+
+
+    <div id="classHeader">
+        <table class="header-table">
+        <tr class="top-aligned-row">
+          <td><strong>Class</strong></td>
+          <td class="class-name-in-header">DruidTools::Druid</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../../files/lib/druid_tools/druid_rb.html">
+                lib/druid_tools/druid.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+
+        <tr class="top-aligned-row">
+            <td><strong>Parent:</strong></td>
+            <td>
+                Object
+            </td>
+        </tr>
+        </table>
+    </div>
+  <!-- banner header -->
+
+  <div id="bodyContent">
+
+
+
+  <div id="contextContent">
+
+
+
+   </div>
+
+    <div id="method-list">
+      <h3 class="section-bar">Methods</h3>
+
+      <div class="name-list">
+      <a href="#M000009">find</a>&nbsp;&nbsp;
+      <a href="#M000010">find_filelist_parent</a>&nbsp;&nbsp;
+      <a href="#M000002">glob</a>&nbsp;&nbsp;
+      <a href="#M000005">id</a>&nbsp;&nbsp;
+      <a href="#M000008">mkdir</a>&nbsp;&nbsp;
+      <a href="#M000011">mkdir_with_final_link</a>&nbsp;&nbsp;
+      <a href="#M000004">new</a>&nbsp;&nbsp;
+      <a href="#M000007">path</a>&nbsp;&nbsp;
+      <a href="#M000001">pattern</a>&nbsp;&nbsp;
+      <a href="#M000012">rmdir</a>&nbsp;&nbsp;
+      <a href="#M000006">tree</a>&nbsp;&nbsp;
+      <a href="#M000003">valid?</a>&nbsp;&nbsp;
+      </div>
+    </div>
+
+  </div>
+
+
+    <!-- if includes -->
+
+    <div id="section">
+
+
+
+
+
+    <div id="attribute-list">
+      <h3 class="section-bar">Attributes</h3>
+
+      <div class="name-list">
+        <table>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">base</td>
+          <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
+          <td class="context-item-desc"></td>
+        </tr>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">druid</td>
+          <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
+          <td class="context-item-desc"></td>
+        </tr>
+        <tr class="top-aligned-row context-row">
+          <td class="context-item-name">prefix</td>
+          <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
+          <td class="context-item-desc"></td>
+        </tr>
+        </table>
+      </div>
+    </div>
+      
+
+
+    <!-- if method_list -->
+    <div id="methods">
+      <h3 class="section-bar">Public Class methods</h3>
+
+      <div id="method-M000002" class="method-detail">
+        <a name="M000002"></a>
+
+        <div class="method-heading">
+          <a href="Druid.src/M000002.html" target="Code" class="method-signature"
+            onclick="popupCode('Druid.src/M000002.html');return false;">
+          <span class="method-name">glob</span><span class="method-args">()</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+@return [String] suitable for use in [Dir#glob]
+</p>
+        </div>
+      </div>
+
+      <div id="method-M000004" class="method-detail">
+        <a name="M000004"></a>
+
+        <div class="method-heading">
+          <a href="Druid.src/M000004.html" target="Code" class="method-signature"
+            onclick="popupCode('Druid.src/M000004.html');return false;">
+          <span class="method-name">new</span><span class="method-args">(druid, base='.')</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+@param druid [String] A valid druid @param base [String] The directory used
+by <a href="Druid.html#M000007">path</a>
+</p>
+        </div>
+      </div>
+
+      <div id="method-M000001" class="method-detail">
+        <a name="M000001"></a>
+
+        <div class="method-heading">
+          <a href="Druid.src/M000001.html" target="Code" class="method-signature"
+            onclick="popupCode('Druid.src/M000001.html');return false;">
+          <span class="method-name">pattern</span><span class="method-args">()</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+@return [Regexp] matches druid:aa111aa1111 or aa111aa1111
+</p>
+        </div>
+      </div>
+
+      <div id="method-M000003" class="method-detail">
+        <a name="M000003"></a>
+
+        <div class="method-heading">
+          <a href="Druid.src/M000003.html" target="Code" class="method-signature"
+            onclick="popupCode('Druid.src/M000003.html');return false;">
+          <span class="method-name">valid?</span><span class="method-args">(druid)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+@param [String] druid <a href="Druid.html#M000005">id</a> @return [Boolean]
+true if druid matches <a href="Druid.html#M000001">pattern</a>; otherwise
+false
+</p>
+        </div>
+      </div>
+
+      <h3 class="section-bar">Public Instance methods</h3>
+
+      <div id="method-M000009" class="method-detail">
+        <a name="M000009"></a>
+
+        <div class="method-heading">
+          <a href="Druid.src/M000009.html" target="Code" class="method-signature"
+            onclick="popupCode('Druid.src/M000009.html');return false;">
+          <span class="method-name">find</span><span class="method-args">(type, path)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+        </div>
+      </div>
+
+      <div id="method-M000010" class="method-detail">
+        <a name="M000010"></a>
+
+        <div class="method-heading">
+          <a href="Druid.src/M000010.html" target="Code" class="method-signature"
+            onclick="popupCode('Druid.src/M000010.html');return false;">
+          <span class="method-name">find_filelist_parent</span><span class="method-args">(type, filelist)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+@param [String] type The type of directory being sought
+(&#8216;content&#8217;, &#8216;metadata&#8217;, or &#8216;temp&#8217;)
+@param [Array&lt;String&gt;,String] filelist The files that are expected to
+be present in the directory @return [Pathname] Search for and return the
+pathname of the directory that contains the list of files.
+</p>
+<pre>
+   Raises an exception unless a directory is found that contains all the files in the list.
+</pre>
+        </div>
+      </div>
+
+      <div id="method-M000005" class="method-detail">
+        <a name="M000005"></a>
+
+        <div class="method-heading">
+          <a href="Druid.src/M000005.html" target="Code" class="method-signature"
+            onclick="popupCode('Druid.src/M000005.html');return false;">
+          <span class="method-name">id</span><span class="method-args">()</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+        </div>
+      </div>
+
+      <div id="method-M000008" class="method-detail">
+        <a name="M000008"></a>
+
+        <div class="method-heading">
+          <a href="Druid.src/M000008.html" target="Code" class="method-signature"
+            onclick="popupCode('Druid.src/M000008.html');return false;">
+          <span class="method-name">mkdir</span><span class="method-args">(extra=nil)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+        </div>
+      </div>
+
+      <div id="method-M000011" class="method-detail">
+        <a name="M000011"></a>
+
+        <div class="method-heading">
+          <a href="Druid.src/M000011.html" target="Code" class="method-signature"
+            onclick="popupCode('Druid.src/M000011.html');return false;">
+          <span class="method-name">mkdir_with_final_link</span><span class="method-args">(source, extra=nil)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+        </div>
+      </div>
+
+      <div id="method-M000007" class="method-detail">
+        <a name="M000007"></a>
+
+        <div class="method-heading">
+          <a href="Druid.src/M000007.html" target="Code" class="method-signature"
+            onclick="popupCode('Druid.src/M000007.html');return false;">
+          <span class="method-name">path</span><span class="method-args">(extra=nil, create=false)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+        </div>
+      </div>
+
+      <div id="method-M000012" class="method-detail">
+        <a name="M000012"></a>
+
+        <div class="method-heading">
+          <a href="Druid.src/M000012.html" target="Code" class="method-signature"
+            onclick="popupCode('Druid.src/M000012.html');return false;">
+          <span class="method-name">rmdir</span><span class="method-args">(extra=nil)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+        </div>
+      </div>
+
+      <div id="method-M000006" class="method-detail">
+        <a name="M000006"></a>
+
+        <div class="method-heading">
+          <a href="Druid.src/M000006.html" target="Code" class="method-signature"
+            onclick="popupCode('Druid.src/M000006.html');return false;">
+          <span class="method-name">tree</span><span class="method-args">()</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+        </div>
+      </div>
+
+
+    </div>
+
+
+  </div>
+
+
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
+</html>