<?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>
<head>
<title>Class: Folio::Document</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
<script language="JavaScript" type="text/javascript">
// <![CDATA[
function toggleSource( id )
{
var elem
var link
if( document.getElementById )
{
elem = document.getElementById( id )
link = document.getElementById( "l_" + id )
}
else if ( document.all )
{
elem = eval( "document.all." + id )
link = eval( "document.all.l_" + id )
}
else
return false;
if( elem.style.display == "block" )
{
elem.style.display = "none"
link.innerHTML = "show source"
}
else
{
elem.style.display = "block"
link.innerHTML = "hide source"
}
}
function openCode( url )
{
window.open( url, "SOURCE_CODE", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=480,width=750" ).focus();
}
// ]]>
</script>
</head>
<body>
<table width="100%" border='0' cellpadding='0' cellspacing='0' class='banner'><tr>
<td class="file-title"><span class="file-title-prefix">Class</span><br />Folio::Document</td>
<td align="right">
<table cellspacing="0" cellpadding="2">
<tr valign="top">
<td>In:</td>
<td>
<a href="../../files/lib/folio/document_rb.html">lib/folio/document.rb</a>
</td>
</tr>
<tr>
<td>Parent:</td>
<td>
<a href="FileObject.html">
FileObject
</a>
</td>
</tr>
</table>
</td>
</tr>
</table>
<!-- banner header -->
<div id="bodyContent">
<div id="content">
<div class="sectiontitle">Methods</div>
<ul>
<li><a href="#M000136">delete</a></li>
<li><a href="#M000131">executable?</a></li>
<li><a href="#M000132">executable_real?</a></li>
<li><a href="#M000130">file?</a></li>
<li><a href="#M000129">intialize</a></li>
<li><a href="#M000137">open</a></li>
<li><a href="#M000133">read</a></li>
<li><a href="#M000134">readlines</a></li>
<li><a href="#M000138">truncate</a></li>
<li><a href="#M000135">unlink</a></li>
</ul>
<div class="sectiontitle">Public Instance methods</div>
<div class="method">
<div class="title">
<a name="M000136"></a><b>delete</b>()
</div>
<div class="sourcecode">
<p class="source-link">[ <a href="javascript:toggleSource('M000136_source')" id="l_M000136_source">show source</a> ]</p>
<div id="M000136_source" class="dyn-source">
<pre>
<span class="ruby-comment cmt"># File lib/folio/document.rb, line 36</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">delete</span> ; <span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">path</span>) ; <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div class="method">
<div class="title">
<a name="M000131"></a><b>executable?</b>()
</div>
<div class="sourcecode">
<p class="source-link">[ <a href="javascript:toggleSource('M000131_source')" id="l_M000131_source">show source</a> ]</p>
<div id="M000131_source" class="dyn-source">
<pre>
<span class="ruby-comment cmt"># File lib/folio/document.rb, line 23</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">executable?</span> ; <span class="ruby-operator">::</span><span class="ruby-constant">FileTest</span>.<span class="ruby-identifier">executable?</span>(<span class="ruby-identifier">path</span>) ; <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div class="method">
<div class="title">
<a name="M000132"></a><b>executable_real?</b>()
</div>
<div class="sourcecode">
<p class="source-link">[ <a href="javascript:toggleSource('M000132_source')" id="l_M000132_source">show source</a> ]</p>
<div id="M000132_source" class="dyn-source">
<pre>
<span class="ruby-comment cmt"># File lib/folio/document.rb, line 24</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">executable_real?</span> ; <span class="ruby-operator">::</span><span class="ruby-constant">FileTest</span>.<span class="ruby-identifier">executable_real?</span>(<span class="ruby-identifier">path</span>) ; <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div class="method">
<div class="title">
<a name="M000130"></a><b>file?</b>()
</div>
<div class="sourcecode">
<p class="source-link">[ <a href="javascript:toggleSource('M000130_source')" id="l_M000130_source">show source</a> ]</p>
<div id="M000130_source" class="dyn-source">
<pre>
<span class="ruby-comment cmt"># File lib/folio/document.rb, line 17</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">file?</span> ; <span class="ruby-keyword kw">true</span> ; <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div class="method">
<div class="title">
<a name="M000129"></a><b>intialize</b>(path)
</div>
<div class="sourcecode">
<p class="source-link">[ <a href="javascript:toggleSource('M000129_source')" id="l_M000129_source">show source</a> ]</p>
<div id="M000129_source" class="dyn-source">
<pre>
<span class="ruby-comment cmt"># File lib/folio/document.rb, line 7</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">intialize</span>(<span class="ruby-identifier">path</span>)
<span class="ruby-keyword kw">super</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">FileNotFound</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">file?</span>(<span class="ruby-ivar">@path</span>)
<span class="ruby-identifier">raise</span> <span class="ruby-constant">FileNotFound</span> <span class="ruby-keyword kw">if</span> <span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">symlink?</span>(<span class="ruby-ivar">@path</span>)
<span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div class="method">
<div class="title">
<a name="M000137"></a><b>open</b>(mode, &block)
</div>
<div class="sourcecode">
<p class="source-link">[ <a href="javascript:toggleSource('M000137_source')" id="l_M000137_source">show source</a> ]</p>
<div id="M000137_source" class="dyn-source">
<pre>
<span class="ruby-comment cmt"># File lib/folio/document.rb, line 42</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">open</span>(<span class="ruby-identifier">mode</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-identifier">path</span>, <span class="ruby-identifier">mode</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
<span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div class="method">
<div class="title">
<a name="M000133"></a><b>read</b>()
</div>
<div class="sourcecode">
<p class="source-link">[ <a href="javascript:toggleSource('M000133_source')" id="l_M000133_source">show source</a> ]</p>
<div id="M000133_source" class="dyn-source">
<pre>
<span class="ruby-comment cmt"># File lib/folio/document.rb, line 30</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">read</span> ; <span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">read</span>(<span class="ruby-identifier">path</span>) ; <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div class="method">
<div class="title">
<a name="M000134"></a><b>readlines</b>()
</div>
<div class="sourcecode">
<p class="source-link">[ <a href="javascript:toggleSource('M000134_source')" id="l_M000134_source">show source</a> ]</p>
<div id="M000134_source" class="dyn-source">
<pre>
<span class="ruby-comment cmt"># File lib/folio/document.rb, line 32</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">readlines</span> ; <span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">readlines</span>(<span class="ruby-identifier">path</span>) ; <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div class="method">
<div class="title">
<a name="M000138"></a><b>truncate</b>(size)
</div>
<div class="sourcecode">
<p class="source-link">[ <a href="javascript:toggleSource('M000138_source')" id="l_M000138_source">show source</a> ]</p>
<div id="M000138_source" class="dyn-source">
<pre>
<span class="ruby-comment cmt"># File lib/folio/document.rb, line 46</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">truncate</span>(<span class="ruby-identifier">size</span>)
<span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-identifier">path</span>, <span class="ruby-value str">'w'</span>){<span class="ruby-operator">|</span><span class="ruby-identifier">f</span><span class="ruby-operator">|</span> <span class="ruby-identifier">f</span>.<span class="ruby-identifier">truncate</span>(<span class="ruby-identifier">size</span>)}
<span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div class="method">
<div class="title">
<a name="M000135"></a><b>unlink</b>()
</div>
<div class="description">
<p>
TODO: how to handle unkinking (b/c file no longer exists)
</p>
</div>
<div class="sourcecode">
<p class="source-link">[ <a href="javascript:toggleSource('M000135_source')" id="l_M000135_source">show source</a> ]</p>
<div id="M000135_source" class="dyn-source">
<pre>
<span class="ruby-comment cmt"># File lib/folio/document.rb, line 35</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">unlink</span> ; <span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">unlink</span>(<span class="ruby-identifier">path</span>) ; <span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
</div>
</div>
</body>
</html>