<?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: Dumper</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">Dumper</td>
</tr>
<tr class="top-aligned-row">
<td><strong>In:</strong></td>
<td>
<a href="../files/dbdump_rb.html">
dbdump.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="diagram">
<map id="map" name="map">
<area shape="rect" coords="5,5,77,53" href="Dumper.html" alt="Dumper
" />
</map>
<img src="../dot/f_6.png" usemap="#map" border="0" alt="dot/f_6.png">
</div>
<div id="description">
<p>
This utility program dumps a database to yaml
</p>
</div>
</div>
<div id="method-list">
<h3 class="section-bar">Methods</h3>
<div class="name-list">
<a href="#M000181">get_options</a>
<a href="#M000180">new</a>
<a href="#M000183">run</a>
<a href="#M000182">store</a>
</div>
</div>
</div>
<!-- if includes -->
<div id="section">
<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">"0.2.0"</td>
</tr>
<tr class="top-aligned-row context-row">
<td class="context-item-name">DATABASES</td>
<td>=</td>
<td class="context-item-value">[:dbm, :gdbm, :sdbm, :sqlite, :sqlite3]</td>
</tr>
</table>
</div>
</div>
<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">opts</td>
<td class="context-item-value"> [RW] </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-M000180" class="method-detail">
<a name="M000180"></a>
<div class="method-heading">
<a href="#M000180" class="method-signature">
<span class="method-name">new</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000180-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000180-source">
<pre>
<span class="ruby-comment cmt"># File dbdump.rb, line 37</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>
<span class="ruby-ivar">@opts</span> = <span class="ruby-identifier">get_options</span>
<span class="ruby-keyword kw">case</span> <span class="ruby-ivar">@opts</span>.<span class="ruby-identifier">dbtype</span>
<span class="ruby-keyword kw">when</span> <span class="ruby-identifier">:dbm</span>
<span class="ruby-identifier">require</span> <span class="ruby-value str">'dbm'</span>
<span class="ruby-keyword kw">when</span> <span class="ruby-identifier">:gdbm</span>
<span class="ruby-identifier">require</span> <span class="ruby-value str">'gdbm'</span>
<span class="ruby-keyword kw">when</span> <span class="ruby-identifier">:sdbm</span>
<span class="ruby-identifier">require</span> <span class="ruby-value str">'sdbm'</span>
<span class="ruby-keyword kw">when</span> <span class="ruby-identifier">:sqlite</span>
<span class="ruby-identifier">require</span> <span class="ruby-value str">'sqlite'</span>
<span class="ruby-keyword kw">when</span> <span class="ruby-identifier">:sqlite3</span>
<span class="ruby-identifier">require</span> <span class="ruby-value str">'sqlite3'</span>
<span class="ruby-keyword kw">end</span>
<span class="ruby-ivar">@dbtop</span> = <span class="ruby-value">0</span>
<span class="ruby-ivar">@db</span> = {}
<span class="ruby-ivar">@count</span> = <span class="ruby-value">0</span>
<span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<h3 class="section-bar">Public Instance methods</h3>
<div id="method-M000181" class="method-detail">
<a name="M000181"></a>
<div class="method-heading">
<a href="#M000181" class="method-signature">
<span class="method-name">get_options</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
Processes command line arguments
</p>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000181-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000181-source">
<pre>
<span class="ruby-comment cmt"># File dbdump.rb, line 59</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">get_options</span>
<span class="ruby-comment cmt"># The myopts specified on the command line will be collected in *myopts*.
</span>
<span class="ruby-comment cmt"># We set default values here.
</span>
<span class="ruby-identifier">myopts</span> = <span class="ruby-constant">OpenStruct</span>.<span class="ruby-identifier">new</span>
<span class="ruby-identifier">myopts</span>.<span class="ruby-identifier">ifile</span> = <span class="ruby-keyword kw">nil</span>
<span class="ruby-identifier">myopts</span>.<span class="ruby-identifier">ofile</span> = <span class="ruby-keyword kw">nil</span>
<span class="ruby-identifier">myopts</span>.<span class="ruby-identifier">dbtype</span> = <span class="ruby-keyword kw">nil</span>
<span class="ruby-identifier">opts</span> = <span class="ruby-constant">OptionParser</span>.<span class="ruby-identifier">new</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">opts</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">opts</span>.<span class="ruby-identifier">banner</span> = <span class="ruby-node">"Database Dumper #{VERSION}"</span>
<span class="ruby-identifier">opts</span>.<span class="ruby-identifier">separator</span> <span class="ruby-value str">""</span>
<span class="ruby-identifier">opts</span>.<span class="ruby-identifier">separator</span> <span class="ruby-node">"Usage: ruby #{$0} [options]"</span>
<span class="ruby-identifier">opts</span>.<span class="ruby-identifier">separator</span> <span class="ruby-value str">""</span>
<span class="ruby-identifier">opts</span>.<span class="ruby-identifier">separator</span> <span class="ruby-value str">"Options:"</span>
<span class="ruby-identifier">opts</span>.<span class="ruby-identifier">on</span>(<span class="ruby-value str">"-i"</span>, <span class="ruby-value str">"--ifile FILE"</span>, <span class="ruby-constant">String</span>,
<span class="ruby-value str">"Select the database file to read"</span>,
<span class="ruby-value str">" extension determined automatically"</span>) {<span class="ruby-operator">|</span><span class="ruby-identifier">myopts</span>.<span class="ruby-identifier">ifile</span><span class="ruby-operator">|</span>}
<span class="ruby-identifier">opts</span>.<span class="ruby-identifier">on</span>(<span class="ruby-value str">"-o"</span>, <span class="ruby-value str">"--ofile FILE"</span>, <span class="ruby-constant">String</span>,
<span class="ruby-value str">"Select the yaml file to write"</span>,
<span class="ruby-value str">" defaults to same as database"</span>) {<span class="ruby-operator">|</span><span class="ruby-identifier">myopts</span>.<span class="ruby-identifier">ofile</span><span class="ruby-operator">|</span>}
<span class="ruby-identifier">opts</span>.<span class="ruby-identifier">on</span>(<span class="ruby-value str">"-t"</span>, <span class="ruby-value str">"--type DBTYPE"</span>, <span class="ruby-constant">DATABASES</span>,
<span class="ruby-value str">"Select the database type - required (no default)"</span>,
<span class="ruby-node">" One of: #{DATABASES.join(", ")}"</span>,
<span class="ruby-value str">" Example: -t gdbm"</span>) {<span class="ruby-operator">|</span><span class="ruby-identifier">myopts</span>.<span class="ruby-identifier">dbtype</span><span class="ruby-operator">|</span>}
<span class="ruby-identifier">opts</span>.<span class="ruby-identifier">on_tail</span>(<span class="ruby-value str">"-h"</span>, <span class="ruby-value str">"--help"</span>, <span class="ruby-value str">"Show this message"</span>) <span class="ruby-keyword kw">do</span>
<span class="ruby-identifier">puts</span> <span class="ruby-identifier">opts</span>.<span class="ruby-identifier">help</span>
<span class="ruby-identifier">exit</span>
<span class="ruby-keyword kw">end</span>
<span class="ruby-identifier">opts</span>.<span class="ruby-identifier">on_tail</span>(<span class="ruby-value str">"-v"</span>, <span class="ruby-value str">"--version"</span>, <span class="ruby-value str">"Show version"</span>) <span class="ruby-keyword kw">do</span>
<span class="ruby-identifier">puts</span> <span class="ruby-node">"Database Dumper #{VERSION}"</span>
<span class="ruby-identifier">exit</span>
<span class="ruby-keyword kw">end</span>
<span class="ruby-keyword kw">end</span>
<span class="ruby-identifier">opts</span>.<span class="ruby-identifier">parse!</span>(<span class="ruby-constant">ARGV</span>)
<span class="ruby-identifier">raise</span>(<span class="ruby-constant">OptionParser</span><span class="ruby-operator">::</span><span class="ruby-constant">MissingArgument</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">"-t"</span>)) <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">myopts</span>.<span class="ruby-identifier">dbtype</span> <span class="ruby-operator">==</span> <span class="ruby-keyword kw">nil</span>
<span class="ruby-identifier">raise</span>(<span class="ruby-constant">OptionParser</span><span class="ruby-operator">::</span><span class="ruby-constant">ParseError</span>, <span class="ruby-value str">"Must specify input file!"</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">myopts</span>.<span class="ruby-identifier">ifile</span>.<span class="ruby-identifier">nil?</span>
<span class="ruby-identifier">myopts</span>.<span class="ruby-identifier">ofile</span> = <span class="ruby-identifier">myopts</span>.<span class="ruby-identifier">ifile</span>.<span class="ruby-identifier">dup</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">myopts</span>.<span class="ruby-identifier">ofile</span>.<span class="ruby-identifier">nil?</span>
<span class="ruby-identifier">myopts</span>.<span class="ruby-identifier">ifile</span> <span class="ruby-operator"><<</span> <span class="ruby-value str">".gdbm"</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">myopts</span>.<span class="ruby-identifier">dbtype</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">:gdbm</span>
<span class="ruby-identifier">myopts</span>.<span class="ruby-identifier">ifile</span> <span class="ruby-operator"><<</span> <span class="ruby-value str">".sqlite"</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">myopts</span>.<span class="ruby-identifier">dbtype</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">:sqlite</span>
<span class="ruby-identifier">myopts</span>.<span class="ruby-identifier">ifile</span> <span class="ruby-operator"><<</span> <span class="ruby-value str">".sqlite3"</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">myopts</span>.<span class="ruby-identifier">dbtype</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">:sqlite3</span>
<span class="ruby-identifier">myopts</span>.<span class="ruby-identifier">ofile</span> <span class="ruby-operator"><<</span> <span class="ruby-value str">".yaml"</span>
<span class="ruby-keyword kw">return</span> <span class="ruby-identifier">myopts</span>
<span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">OptionParser</span><span class="ruby-operator">::</span><span class="ruby-constant">ParseError</span>
<span class="ruby-identifier">puts</span> <span class="ruby-node">"ERROR - #{$!}"</span>
<span class="ruby-identifier">puts</span> <span class="ruby-value str">"For help..."</span>
<span class="ruby-identifier">puts</span> <span class="ruby-node">" ruby #{$0} --help"</span>
<span class="ruby-identifier">exit</span>
<span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000183" class="method-detail">
<a name="M000183"></a>
<div class="method-heading">
<a href="#M000183" class="method-signature">
<span class="method-name">run</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
Launches the dumper
</p>
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000183-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000183-source">
<pre>
<span class="ruby-comment cmt"># File dbdump.rb, line 121</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">run</span>
<span class="ruby-keyword kw">case</span> <span class="ruby-ivar">@opts</span>.<span class="ruby-identifier">dbtype</span>
<span class="ruby-keyword kw">when</span> <span class="ruby-identifier">:sdbm</span>
<span class="ruby-constant">SDBM</span>.<span class="ruby-identifier">open</span>(<span class="ruby-ivar">@opts</span>.<span class="ruby-identifier">ifile</span>, <span class="ruby-value">0666</span>) <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">db</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">db</span>.<span class="ruby-identifier">each_value</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">v</span><span class="ruby-operator">|</span> <span class="ruby-identifier">store</span> <span class="ruby-identifier">v</span>}
<span class="ruby-keyword kw">end</span>
<span class="ruby-keyword kw">when</span> <span class="ruby-identifier">:gdbm</span>
<span class="ruby-constant">GDBM</span>.<span class="ruby-identifier">open</span>(<span class="ruby-ivar">@opts</span>.<span class="ruby-identifier">ifile</span>, <span class="ruby-value">0666</span>) <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">db</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">db</span>.<span class="ruby-identifier">each_value</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">v</span><span class="ruby-operator">|</span> <span class="ruby-identifier">store</span> <span class="ruby-identifier">v</span>}
<span class="ruby-keyword kw">end</span>
<span class="ruby-keyword kw">when</span> <span class="ruby-identifier">:dbm</span>
<span class="ruby-constant">DBM</span>.<span class="ruby-identifier">open</span>(<span class="ruby-ivar">@opts</span>.<span class="ruby-identifier">ifile</span>, <span class="ruby-value">0666</span>) <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">db</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">db</span>.<span class="ruby-identifier">each_value</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">v</span><span class="ruby-operator">|</span> <span class="ruby-identifier">store</span> <span class="ruby-identifier">v</span>}
<span class="ruby-keyword kw">end</span>
<span class="ruby-keyword kw">when</span> <span class="ruby-identifier">:sqlite</span>
<span class="ruby-identifier">db</span> = <span class="ruby-constant">SQLite</span><span class="ruby-operator">::</span><span class="ruby-constant">Database</span>.<span class="ruby-identifier">open</span>(<span class="ruby-ivar">@opts</span>.<span class="ruby-identifier">ifile</span>)
<span class="ruby-identifier">db</span>.<span class="ruby-identifier">execute</span>(<span class="ruby-value str">"select data from tmud;"</span>) <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">v</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">store</span> <span class="ruby-identifier">v</span>.<span class="ruby-identifier">first</span>
<span class="ruby-keyword kw">end</span>
<span class="ruby-identifier">db</span>.<span class="ruby-identifier">close</span>
<span class="ruby-keyword kw">when</span> <span class="ruby-identifier">:sqlite3</span>
<span class="ruby-identifier">db</span> = <span class="ruby-constant">SQLite3</span><span class="ruby-operator">::</span><span class="ruby-constant">Database</span>.<span class="ruby-identifier">open</span>(<span class="ruby-ivar">@opts</span>.<span class="ruby-identifier">ifile</span>)
<span class="ruby-identifier">db</span>.<span class="ruby-identifier">execute</span>(<span class="ruby-value str">"select data from tmud;"</span>) <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">v</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">store</span> <span class="ruby-identifier">v</span>.<span class="ruby-identifier">first</span>
<span class="ruby-keyword kw">end</span>
<span class="ruby-identifier">db</span>.<span class="ruby-identifier">close</span>
<span class="ruby-keyword kw">end</span>
<span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-ivar">@opts</span>.<span class="ruby-identifier">ofile</span>,<span class="ruby-value str">'wb'</span>) <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">f</span><span class="ruby-operator">|</span>
<span class="ruby-constant">YAML</span><span class="ruby-operator">::</span><span class="ruby-identifier">dump</span>(<span class="ruby-ivar">@db</span>.<span class="ruby-identifier">values</span>,<span class="ruby-identifier">f</span>)
<span class="ruby-keyword kw">end</span>
<span class="ruby-identifier">puts</span> <span class="ruby-node">"Highest object in use : #{@dbtop}"</span>
<span class="ruby-identifier">puts</span> <span class="ruby-node">"Count of objects dumped : #{@count}"</span>
<span class="ruby-keyword kw">end</span>
</pre>
</div>
</div>
</div>
<div id="method-M000182" class="method-detail">
<a name="M000182"></a>
<div class="method-heading">
<a href="#M000182" class="method-signature">
<span class="method-name">store</span><span class="method-args">(v)</span>
</a>
</div>
<div class="method-description">
<p><a class="source-toggle" href="#"
onclick="toggleCode('M000182-source');return false;">[Source]</a></p>
<div class="method-source-code" id="M000182-source">
<pre>
<span class="ruby-comment cmt"># File dbdump.rb, line 111</span>
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">store</span>(<span class="ruby-identifier">v</span>)
<span class="ruby-identifier">o</span> = <span class="ruby-constant">Utility</span>.<span class="ruby-identifier">decode</span>(<span class="ruby-identifier">v</span>)
<span class="ruby-ivar">@dbtop</span> = <span class="ruby-identifier">o</span>.<span class="ruby-identifier">id</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">o</span>.<span class="ruby-identifier">id</span> <span class="ruby-operator">></span> <span class="ruby-ivar">@dbtop</span>
<span class="ruby-ivar">@db</span>[<span class="ruby-identifier">o</span>.<span class="ruby-identifier">id</span>]=<span class="ruby-identifier">o</span>
<span class="ruby-ivar">@count</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1</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>