pho 0.7.8 → 0.7.9

data/doc/rdoc/classes/Pho/FileManagement/RDFManager.html

@@ -82,11 +82,11 @@
 
     <div id="description">
       <p>
-Provides a simple mechanism for managing a directory of RDF/XML documents
-and uploading them to platform store.
+Provides a simple mechanism for managing a directory of RDF documents and
+uploading them to platform store.
 </p>
 <p>
-Allows a collection to be mirrored into the platform
+Currently supports RDF, Turtle and NTriples
 </p>
 
     </div>
@@ -98,9 +98,9 @@ Allows a collection to be mirrored into the platform
       <h3 class="section-bar">Methods</h3>
 
       <div class="name-list">
-      <a href="#M000003">list</a>&nbsp;&nbsp;
-      <a href="#M000002">new</a>&nbsp;&nbsp;
-      <a href="#M000004">store_file</a>&nbsp;&nbsp;
+      <a href="#M000006">list</a>&nbsp;&nbsp;
+      <a href="#M000005">new</a>&nbsp;&nbsp;
+      <a href="#M000007">store_file</a>&nbsp;&nbsp;
       </div>
     </div>
 
@@ -150,19 +150,19 @@ Allows a collection to be mirrored into the platform
     <div id="methods">
       <h3 class="section-bar">Public Class methods</h3>
 
-      <div id="method-M000002" class="method-detail">
-        <a name="M000002"></a>
+      <div id="method-M000005" class="method-detail">
+        <a name="M000005"></a>
 
         <div class="method-heading">
-          <a href="#M000002" class="method-signature">
+          <a href="#M000005" class="method-signature">
           <span class="method-name">new</span><span class="method-args">(store, dir, rdf_suffixes=ALL_RDF, ok_suffix=OK, fail_suffix=FAIL)</span>
           </a>
         </div>
       
         <div class="method-description">
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000002-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000002-source">
+            onclick="toggleCode('M000005-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000005-source">
 <pre>
 <span class="ruby-comment cmt"># File lib/pho/rdf_collection.rb, line 17</span>
         <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">store</span>, <span class="ruby-identifier">dir</span>, <span class="ruby-identifier">rdf_suffixes</span>=<span class="ruby-constant">ALL_RDF</span>, <span class="ruby-identifier">ok_suffix</span>=<span class="ruby-constant">OK</span>, <span class="ruby-identifier">fail_suffix</span>=<span class="ruby-constant">FAIL</span>)
@@ -176,11 +176,11 @@ Allows a collection to be mirrored into the platform
 
       <h3 class="section-bar">Public Instance methods</h3>
 
-      <div id="method-M000003" class="method-detail">
-        <a name="M000003"></a>
+      <div id="method-M000006" class="method-detail">
+        <a name="M000006"></a>
 
         <div class="method-heading">
-          <a href="#M000003" class="method-signature">
+          <a href="#M000006" class="method-signature">
           <span class="method-name">list</span><span class="method-args">(recursive=false)</span>
           </a>
         </div>
@@ -190,8 +190,8 @@ Allows a collection to be mirrored into the platform
 List files being managed
 </p>
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000003-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000003-source">
+            onclick="toggleCode('M000006-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000006-source">
 <pre>
 <span class="ruby-comment cmt"># File lib/pho/rdf_collection.rb, line 23</span>
         <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">list</span>(<span class="ruby-identifier">recursive</span>=<span class="ruby-keyword kw">false</span>)
@@ -209,19 +209,19 @@ List files being managed
 
       <h3 class="section-bar">Protected Instance methods</h3>
 
-      <div id="method-M000004" class="method-detail">
-        <a name="M000004"></a>
+      <div id="method-M000007" class="method-detail">
+        <a name="M000007"></a>
 
         <div class="method-heading">
-          <a href="#M000004" class="method-signature">
+          <a href="#M000007" class="method-signature">
           <span class="method-name">store_file</span><span class="method-args">(file, filename)</span>
           </a>
         </div>
       
         <div class="method-description">
           <p><a class="source-toggle" href="#"
-            onclick="toggleCode('M000004-source');return false;">[Source]</a></p>
-          <div class="method-source-code" id="M000004-source">
+            onclick="toggleCode('M000007-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000007-source">
 <pre>
 <span class="ruby-comment cmt"># File lib/pho/rdf_collection.rb, line 34</span>
         <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">store_file</span>(<span class="ruby-identifier">file</span>, <span class="ruby-identifier">filename</span>)
@@ -233,7 +233,7 @@ List files being managed
           <span class="ruby-keyword kw">else</span>
             <span class="ruby-identifier">response</span> = <span class="ruby-ivar">@store</span>.<span class="ruby-identifier">store_file</span>(<span class="ruby-identifier">file</span>)
           <span class="ruby-keyword kw">end</span>
-                    
+          <span class="ruby-identifier">create_tracking_dir</span>(<span class="ruby-identifier">filename</span>)                              
           <span class="ruby-keyword kw">if</span> (<span class="ruby-identifier">response</span>.<span class="ruby-identifier">status</span> <span class="ruby-operator">&lt;</span> <span class="ruby-value">300</span> )
             <span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-identifier">get_ok_file_for</span>(<span class="ruby-identifier">filename</span>), <span class="ruby-value str">&quot;w&quot;</span>) <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">file</span><span class="ruby-operator">|</span>
               <span class="ruby-identifier">file</span>.<span class="ruby-identifier">print</span>( <span class="ruby-value str">&quot;OK&quot;</span> )            

data/doc/rdoc/classes/Pho/FileManagement/StatementHandler.html

@@ -0,0 +1,152 @@
+<?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: Pho::FileManagement::StatementHandler</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">Pho::FileManagement::StatementHandler</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../../../files/lib/pho/upload_rb.html">
+                lib/pho/upload.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 id="description">
+      <p>
+Default statement handler, does nothing
+</p>
+
+    </div>
+
+
+   </div>
+
+    <div id="method-list">
+      <h3 class="section-bar">Methods</h3>
+
+      <div class="name-list">
+      <a href="#M000004">handle</a>&nbsp;&nbsp;
+      </div>
+    </div>
+
+  </div>
+
+
+    <!-- if includes -->
+
+    <div id="section">
+
+
+
+
+
+      
+
+
+    <!-- if method_list -->
+    <div id="methods">
+      <h3 class="section-bar">Public Instance methods</h3>
+
+      <div id="method-M000004" class="method-detail">
+        <a name="M000004"></a>
+
+        <div class="method-heading">
+          <a href="#M000004" class="method-signature">
+          <span class="method-name">handle</span><span class="method-args">(statement)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000004-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000004-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/pho/upload.rb, line 7</span>
+      <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">handle</span>(<span class="ruby-identifier">statement</span>)
+        <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">statement</span>
+      <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </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>

data/doc/rdoc/classes/Pho/FileManagement/Util.html

@@ -0,0 +1,212 @@
+<?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: Pho::FileManagement::Util</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">Pho::FileManagement::Util</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../../../files/lib/pho/upload_rb.html">
+                lib/pho/upload.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="#M000003">prepare_and_store_upload</a>&nbsp;&nbsp;
+      <a href="#M000002">prepare_platform_upload</a>&nbsp;&nbsp;
+      </div>
+    </div>
+
+  </div>
+
+
+    <!-- if includes -->
+
+    <div id="section">
+
+
+
+
+
+      
+
+
+    <!-- if method_list -->
+    <div id="methods">
+      <h3 class="section-bar">Public Class methods</h3>
+
+      <div id="method-M000003" class="method-detail">
+        <a name="M000003"></a>
+
+        <div class="method-heading">
+          <a href="#M000003" class="method-signature">
+          <span class="method-name">prepare_and_store_upload</span><span class="method-args">(store, src_dir, collection_dir, triples=FileSplitter::DEFAULT_CHUNK_SIZE)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+Prepares a batch of files for uploading into the platform, then posts that
+collection to the designated store
+</p>
+<p>
+Returns an <a href="RDFManager.html">RDFManager</a> instance that can be
+inspected to check for successes
+</p>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000003-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000003-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/pho/upload.rb, line 145</span>
+      <span class="ruby-keyword kw">def</span> <span class="ruby-constant">Util</span>.<span class="ruby-identifier">prepare_and_store_upload</span>(<span class="ruby-identifier">store</span>, <span class="ruby-identifier">src_dir</span>, <span class="ruby-identifier">collection_dir</span>, 
+          <span class="ruby-identifier">triples</span>=<span class="ruby-constant">FileSplitter</span><span class="ruby-operator">::</span><span class="ruby-constant">DEFAULT_CHUNK_SIZE</span>)
+          
+        <span class="ruby-identifier">prepare_platform_upload</span>(<span class="ruby-identifier">store</span>, <span class="ruby-identifier">src_dir</span>, <span class="ruby-identifier">collection_dir</span>)
+        <span class="ruby-identifier">collection</span> = <span class="ruby-constant">Pho</span><span class="ruby-operator">::</span><span class="ruby-constant">FileManagement</span><span class="ruby-operator">::</span><span class="ruby-constant">RDFManager</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">store</span>, <span class="ruby-identifier">collection_dir</span>)
+        <span class="ruby-identifier">collection</span>.<span class="ruby-identifier">store</span>()
+        <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">collection</span>
+      <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </div>
+      </div>
+
+      <div id="method-M000002" class="method-detail">
+        <a name="M000002"></a>
+
+        <div class="method-heading">
+          <a href="#M000002" class="method-signature">
+          <span class="method-name">prepare_platform_upload</span><span class="method-args">(store, src_dir, collection_dir, triples=FileSplitter::DEFAULT_CHUNK_SIZE)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+Take a directory of files, copy them to temporary directory, splitting
+where necessary, in preparation for uploading to a platform store.
+</p>
+<p>
+Source directory is scanned for ntriple, turtle and RDF/XML files. All of
+these are automatically chunked into 10,000 triple chunks and re-serialized
+as ntriples
+</p>
+<p>
+BNodes are automatically re-written to full uris.
+</p>
+<pre>
+  store:: Pho::Store into which data will be posted. Used to normalizing bnodes
+  src_dir:: directory containing source data.
+</pre>
+          <p><a class="source-toggle" href="#"
+            onclick="toggleCode('M000002-source');return false;">[Source]</a></p>
+          <div class="method-source-code" id="M000002-source">
+<pre>
+<span class="ruby-comment cmt"># File lib/pho/upload.rb, line 124</span>
+      <span class="ruby-keyword kw">def</span> <span class="ruby-constant">Util</span>.<span class="ruby-identifier">prepare_platform_upload</span>(<span class="ruby-identifier">store</span>, <span class="ruby-identifier">src_dir</span>, <span class="ruby-identifier">collection_dir</span>, 
+          <span class="ruby-identifier">triples</span>=<span class="ruby-constant">FileSplitter</span><span class="ruby-operator">::</span><span class="ruby-constant">DEFAULT_CHUNK_SIZE</span>)
+          
+          <span class="ruby-identifier">handler</span> = <span class="ruby-constant">BNodeRewritingHandler</span>.<span class="ruby-identifier">new</span>( <span class="ruby-identifier">store</span>.<span class="ruby-identifier">build_uri</span>(<span class="ruby-value str">&quot;/items&quot;</span>) )
+          <span class="ruby-identifier">splitter</span> = <span class="ruby-constant">FileSplitter</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">collection_dir</span>, <span class="ruby-identifier">triples</span>, <span class="ruby-identifier">handler</span> )
+          
+          <span class="ruby-identifier">formats</span> = [ [<span class="ruby-value str">&quot;*.rdf&quot;</span>, <span class="ruby-identifier">:rdfxml</span>], [<span class="ruby-value str">&quot;*.nt&quot;</span>, <span class="ruby-identifier">:ntriples</span>], [<span class="ruby-value str">&quot;*.ttl&quot;</span>, <span class="ruby-identifier">:turtle</span>] ]
+          <span class="ruby-identifier">formats</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">format</span><span class="ruby-operator">|</span>
+            
+            <span class="ruby-identifier">files</span> = <span class="ruby-constant">Dir</span>.<span class="ruby-identifier">glob</span>( <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-identifier">src_dir</span>, <span class="ruby-identifier">format</span>[<span class="ruby-value">0</span>] ) )
+            <span class="ruby-identifier">splitter</span>.<span class="ruby-identifier">split_files</span>(<span class="ruby-identifier">files</span>, <span class="ruby-identifier">format</span>[<span class="ruby-value">1</span>] )
+            
+          <span class="ruby-keyword kw">end</span>
+          <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">true</span>
+          
+      <span class="ruby-keyword kw">end</span>
+</pre>
+          </div>
+        </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>