RubyGems - workbook - Versions diffs - 0.4.13 → 0.4.14 - Mend

workbook 0.4.13 → 0.4.14

Files changed (50) hide show

checksums.yaml +4 -4
data/.gitignore +2 -1
data/lib/workbook/modules/cell.rb +14 -0
data/lib/workbook/version.rb +1 -1
data/test/test_modules_cache.rb +14 -14
data/test/test_modules_cell.rb +9 -2
data/test/test_readers_xls_reader.rb +1 -1
metadata +4 -46
data/doc/RubyXL/Cell.html +0 -201
data/doc/RubyXL/Workbook.html +0 -449
data/doc/RubyXL.html +0 -128
data/doc/Workbook/Book.html +0 -1852
data/doc/Workbook/Cell.html +0 -1553
data/doc/Workbook/Format.html +0 -1168
data/doc/Workbook/Modules/RawObjectsStorage.html +0 -502
data/doc/Workbook/Modules/TableDiffSort.html +0 -758
data/doc/Workbook/Modules/TypeParser.html +0 -1063
data/doc/Workbook/Modules.html +0 -117
data/doc/Workbook/NilValue.html +0 -434
data/doc/Workbook/Readers/CsvReader.html +0 -324
data/doc/Workbook/Readers/OdsReader.html +0 -1066
data/doc/Workbook/Readers/TxtReader.html +0 -236
data/doc/Workbook/Readers/XlsReader.html +0 -378
data/doc/Workbook/Readers/XlsShared.html +0 -188
data/doc/Workbook/Readers/XlsxReader.html +0 -302
data/doc/Workbook/Readers.html +0 -117
data/doc/Workbook/Row.html +0 -2392
data/doc/Workbook/Sheet.html +0 -875
data/doc/Workbook/Table.html +0 -1732
data/doc/Workbook/Template.html +0 -634
data/doc/Workbook/Writers/CsvTableWriter.html +0 -200
data/doc/Workbook/Writers/HtmlWriter.html +0 -407
data/doc/Workbook/Writers/XlsWriter.html +0 -905
data/doc/Workbook/Writers.html +0 -117
data/doc/Workbook.html +0 -142
data/doc/_index.html +0 -381
data/doc/class_list.html +0 -53
data/doc/css/common.css +0 -1
data/doc/css/full_list.css +0 -57
data/doc/css/style.css +0 -338
data/doc/file.README.html +0 -245
data/doc/file_list.html +0 -55
data/doc/frames.html +0 -28
data/doc/index.html +0 -245
data/doc/js/app.js +0 -214
data/doc/js/full_list.js +0 -173
data/doc/js/jquery.js +0 -4
data/doc/method_list.html +0 -1308
data/doc/top-level-namespace.html +0 -112
data/test/artifacts/floats_problem.xls +0 -0

data/doc/Workbook/Book.html DELETED Viewed

@@ -1,1852 +0,0 @@
-<!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>
-    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-<title>
-  Class: Workbook::Book
-    &mdash; Documentation by YARD 0.8.5.2
-</title>
-  <link rel="stylesheet" href="../css/style.css" type="text/css" media="screen" charset="utf-8" />
-  <link rel="stylesheet" href="../css/common.css" type="text/css" media="screen" charset="utf-8" />
-<script type="text/javascript" charset="utf-8">
-  hasFrames = window.top.frames.main ? true : false;
-  relpath = '../';
-  framesUrl = "../frames.html#!" + escape(window.location.href);
-</script>
-  <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
-  <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
-  </head>
-  <body>
-    <div id="header">
-      <div id="menu">
-    <a href="../_index.html">Index (B)</a> &raquo;
-    <span class='title'><span class='object_link'><a href="../Workbook.html" title="Workbook (module)">Workbook</a></span></span>
-     &raquo;
-    <span class="title">Book</span>
-  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
-</div>
-      <div id="search">
-    <a class="full_list_link" id="class_list_link"
-        href="../class_list.html">
-      Class List
-    </a>
-    <a class="full_list_link" id="method_list_link"
-        href="../method_list.html">
-      Method List
-    </a>
-    <a class="full_list_link" id="file_list_link"
-        href="../file_list.html">
-      File List
-    </a>
-</div>
-      <div class="clear"></div>
-    </div>
-    <iframe id="search_frame"></iframe>
-    <div id="content"><h1>Class: Workbook::Book
-</h1>
-<dl class="box">
-    <dt class="r1">Inherits:</dt>
-    <dd class="r1">
-      <span class="inheritName">Array</span>
-        <ul class="fullTree">
-          <li>Object</li>
-            <li class="next">Array</li>
-            <li class="next">Workbook::Book</li>
-        </ul>
-        <a href="#" class="inheritanceTree">show all</a>
-      </dd>
-      <dt class="r2">Includes:</dt>
-      <dd class="r2"><span class='object_link'><a href="Readers/CsvReader.html" title="Workbook::Readers::CsvReader (module)">Readers::CsvReader</a></span>, <span class='object_link'><a href="Readers/OdsReader.html" title="Workbook::Readers::OdsReader (module)">Readers::OdsReader</a></span>, <span class='object_link'><a href="Readers/TxtReader.html" title="Workbook::Readers::TxtReader (module)">Readers::TxtReader</a></span>, <span class='object_link'><a href="Readers/XlsReader.html" title="Workbook::Readers::XlsReader (module)">Readers::XlsReader</a></span>, <span class='object_link'><a href="Readers/XlsShared.html" title="Workbook::Readers::XlsShared (module)">Readers::XlsShared</a></span>, <span class='object_link'><a href="Readers/XlsxReader.html" title="Workbook::Readers::XlsxReader (module)">Readers::XlsxReader</a></span>, <span class='object_link'><a href="Writers/HtmlWriter.html" title="Workbook::Writers::HtmlWriter (module)">Writers::HtmlWriter</a></span>, <span class='object_link'><a href="Writers/XlsWriter.html" title="Workbook::Writers::XlsWriter (module)">Writers::XlsWriter</a></span></dd>
-    <dt class="r1 last">Defined in:</dt>
-    <dd class="r1 last">lib/workbook/book.rb</dd>
-</dl>
-<div class="clear"></div>
-<h2>Overview</h2><div class="docstring">
-  <div class="discussion">
-<p>The Book class is the container of sheets. It can be inialized by either
-the standard initalizer or the open method. The Book class can also keep a
-reference to a template class, storing shared formatting options.</p>
-  </div>
-</div>
-<div class="tags">
-</div>
-  <h2>Constant Summary</h2>
-  <h2>Constant Summary</h2>
-  <h3 class="inherited">Constants included
-     from <span class='object_link'><a href="Readers/XlsShared.html" title="Workbook::Readers::XlsShared (module)">Readers::XlsShared</a></span></h3>
-  <p class="inherited"><span class='object_link'><a href="Readers/XlsShared.html#XLS_COLORS-constant" title="Workbook::Readers::XlsShared::XLS_COLORS (constant)">Readers::XlsShared::XLS_COLORS</a></span></p>
-  <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
-  <ul class="summary">
-      <li class="public ">
-  <span class="summary_signature">
-      <a href="#template-instance_method" title="#template (instance method)">- (Workbook::Format) <strong>template</strong> </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>
-<p>Returns the template describing how the document should be/is formatted.</p>
-</div></span>
-</li>
-      <li class="public ">
-  <span class="summary_signature">
-      <a href="#title-instance_method" title="#title (instance method)">- (String) <strong>title</strong> </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>
-<p>The title of the workbook.</p>
-</div></span>
-</li>
-  </ul>
-    <h2>
-      Class Method Summary
-      <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
-    </h2>
-    <ul class="summary">
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#open-class_method" title="open (class method)">+ (Workbook::Book) <strong>open</strong>(filename, extension = nil) </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>
-<p>Create an instance from a file, using open.</p>
-</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#read-class_method" title="read (class method)">+ (Workbook::Book) <strong>read</strong>(stringio_or_string, filetype) </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>
-<p>Create an instance from the given stream or string, which should be in CSV
-or TXT format.</p>
-</div></span>
-</li>
-    </ul>
-    <h2>
-      Instance Method Summary
-      <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
-    </h2>
-    <ul class="summary">
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#create_or_open_sheet_at-instance_method" title="#create_or_open_sheet_at (instance method)">- (Object) <strong>create_or_open_sheet_at</strong>(index) </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>
-<p>Create or open the existing sheet at an index value.</p>
-</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#file_extension-instance_method" title="#file_extension (instance method)">- (String) <strong>file_extension</strong>(filename) </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>
-<p>The file extension.</p>
-</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#has_contents%3F-instance_method" title="#has_contents? (instance method)">- (Boolean) <strong>has_contents?</strong> </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>
-<p>If the first sheet has any contents.</p>
-</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#initialize-instance_method" title="#initialize (instance method)">- (Workbook::Book) <strong>initialize</strong>(sheet = Workbook::Sheet.new([], self, options={})) </a>
-  </span>
-    <span class="note title constructor">constructor</span>
-    <span class="summary_desc"><div class='inline'></div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#open-instance_method" title="#open (instance method)">- (Workbook::Book) <strong>open</strong>(filename, extension = nil) </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>
-<p>Loads an external file into an existing worbook.</p>
-</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#open_binary-instance_method" title="#open_binary (instance method)">- (Workbook::Book) <strong>open_binary</strong>(filename, extension = nil) </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>
-<p>Open the file in binary, read-only mode, do not read it, but pas it throug
-to the extension determined loaded.</p>
-</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#open_text-instance_method" title="#open_text (instance method)">- (Object) <strong>open_text</strong>(filename, extension = nil) </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>
-<p>Open the file in non-binary, read-only mode, read it and parse it to UTF-8.</p>
-</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#push-instance_method" title="#push (instance method)">- (Object) <strong>push</strong>(sheet = Workbook::Sheet.new) </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>
-<p>Push (like in array) a sheet to the workbook (parameter is optional,
-default is a new sheet).</p>
-</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#read-instance_method" title="#read (instance method)">- (Object) <strong>read</strong>(stringio_or_string, filetype) </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>
-<p>Load the CSV data contained in the given StringIO or String object.</p>
-</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#sheet-instance_method" title="#sheet (instance method)">- (Workbook::Sheet) <strong>sheet</strong> </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>
-<p>Sheet returns the first sheet of a workbook, or an empty one.</p>
-</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#text_to_utf8-instance_method" title="#text_to_utf8 (instance method)">- (Object) <strong>text_to_utf8</strong>(text) </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>
-<p>Helper method to convert text in a file to UTF-8.</p>
-</div></span>
-</li>
-    </ul>
-  <h3 class="inherited">Methods included from <span class='object_link'><a href="Readers/TxtReader.html" title="Workbook::Readers::TxtReader (module)">Readers::TxtReader</a></span></h3>
-  <p class="inherited"><span class='object_link'><a href="Readers/TxtReader.html#load_txt-instance_method" title="Workbook::Readers::TxtReader#load_txt (method)">#load_txt</a></span>, <span class='object_link'><a href="Readers/TxtReader.html#parse_txt-instance_method" title="Workbook::Readers::TxtReader#parse_txt (method)">#parse_txt</a></span></p>
-  <h3 class="inherited">Methods included from <span class='object_link'><a href="Readers/CsvReader.html" title="Workbook::Readers::CsvReader (module)">Readers::CsvReader</a></span></h3>
-  <p class="inherited"><span class='object_link'><a href="Readers/CsvReader.html#csv_lib-instance_method" title="Workbook::Readers::CsvReader#csv_lib (method)">#csv_lib</a></span>, <span class='object_link'><a href="Readers/CsvReader.html#load_csv-instance_method" title="Workbook::Readers::CsvReader#load_csv (method)">#load_csv</a></span>, <span class='object_link'><a href="Readers/CsvReader.html#parse_csv-instance_method" title="Workbook::Readers::CsvReader#parse_csv (method)">#parse_csv</a></span></p>
-  <h3 class="inherited">Methods included from <span class='object_link'><a href="Readers/XlsxReader.html" title="Workbook::Readers::XlsxReader (module)">Readers::XlsxReader</a></span></h3>
-  <p class="inherited"><span class='object_link'><a href="Readers/XlsxReader.html#load_xlsx-instance_method" title="Workbook::Readers::XlsxReader#load_xlsx (method)">#load_xlsx</a></span>, <span class='object_link'><a href="Readers/XlsxReader.html#parse_xlsx-instance_method" title="Workbook::Readers::XlsxReader#parse_xlsx (method)">#parse_xlsx</a></span></p>
-  <h3 class="inherited">Methods included from <span class='object_link'><a href="Readers/OdsReader.html" title="Workbook::Readers::OdsReader (module)">Readers::OdsReader</a></span></h3>
-  <p class="inherited"><span class='object_link'><a href="Readers/OdsReader.html#get_column_count-instance_method" title="Workbook::Readers::OdsReader#get_column_count (method)">#get_column_count</a></span>, <span class='object_link'><a href="Readers/OdsReader.html#get_repeat-instance_method" title="Workbook::Readers::OdsReader#get_repeat (method)">#get_repeat</a></span>, <span class='object_link'><a href="Readers/OdsReader.html#load_ods-instance_method" title="Workbook::Readers::OdsReader#load_ods (method)">#load_ods</a></span>, <span class='object_link'><a href="Readers/OdsReader.html#parse_local_cell-instance_method" title="Workbook::Readers::OdsReader#parse_local_cell (method)">#parse_local_cell</a></span>, <span class='object_link'><a href="Readers/OdsReader.html#parse_local_row-instance_method" title="Workbook::Readers::OdsReader#parse_local_row (method)">#parse_local_row</a></span>, <span class='object_link'><a href="Readers/OdsReader.html#parse_local_table-instance_method" title="Workbook::Readers::OdsReader#parse_local_table (method)">#parse_local_table</a></span>, <span class='object_link'><a href="Readers/OdsReader.html#parse_local_value-instance_method" title="Workbook::Readers::OdsReader#parse_local_value (method)">#parse_local_value</a></span>, <span class='object_link'><a href="Readers/OdsReader.html#parse_ods-instance_method" title="Workbook::Readers::OdsReader#parse_ods (method)">#parse_ods</a></span>, <span class='object_link'><a href="Readers/OdsReader.html#parse_ods_style-instance_method" title="Workbook::Readers::OdsReader#parse_ods_style (method)">#parse_ods_style</a></span>, <span class='object_link'><a href="Readers/OdsReader.html#set_cell_attributes-instance_method" title="Workbook::Readers::OdsReader#set_cell_attributes (method)">#set_cell_attributes</a></span>, <span class='object_link'><a href="Readers/OdsReader.html#set_format_property-instance_method" title="Workbook::Readers::OdsReader#set_format_property (method)">#set_format_property</a></span></p>
-  <h3 class="inherited">Methods included from <span class='object_link'><a href="Readers/XlsReader.html" title="Workbook::Readers::XlsReader (module)">Readers::XlsReader</a></span></h3>
-  <p class="inherited"><span class='object_link'><a href="Readers/XlsReader.html#load_xls-instance_method" title="Workbook::Readers::XlsReader#load_xls (method)">#load_xls</a></span>, <span class='object_link'><a href="Readers/XlsReader.html#parse_xls-instance_method" title="Workbook::Readers::XlsReader#parse_xls (method)">#parse_xls</a></span></p>
-  <h3 class="inherited">Methods included from <span class='object_link'><a href="Writers/HtmlWriter.html" title="Workbook::Writers::HtmlWriter (module)">Writers::HtmlWriter</a></span></h3>
-  <p class="inherited"><span class='object_link'><a href="Writers/HtmlWriter.html#to_html-instance_method" title="Workbook::Writers::HtmlWriter#to_html (method)">#to_html</a></span>, <span class='object_link'><a href="Writers/HtmlWriter.html#write_to_html-instance_method" title="Workbook::Writers::HtmlWriter#write_to_html (method)">#write_to_html</a></span></p>
-  <h3 class="inherited">Methods included from <span class='object_link'><a href="Writers/XlsWriter.html" title="Workbook::Writers::XlsWriter (module)">Writers::XlsWriter</a></span></h3>
-  <p class="inherited"><span class='object_link'><a href="Writers/XlsWriter.html#format_to_xls_format-instance_method" title="Workbook::Writers::XlsWriter#format_to_xls_format (method)">#format_to_xls_format</a></span>, <span class='object_link'><a href="Writers/XlsWriter.html#html_color_to_xls_color-instance_method" title="Workbook::Writers::XlsWriter#html_color_to_xls_color (method)">#html_color_to_xls_color</a></span>, <span class='object_link'><a href="Writers/XlsWriter.html#init_spreadsheet_template-instance_method" title="Workbook::Writers::XlsWriter#init_spreadsheet_template (method)">#init_spreadsheet_template</a></span>, <span class='object_link'><a href="Writers/XlsWriter.html#strftime_to_ms_format-instance_method" title="Workbook::Writers::XlsWriter#strftime_to_ms_format (method)">#strftime_to_ms_format</a></span>, <span class='object_link'><a href="Writers/XlsWriter.html#to_xls-instance_method" title="Workbook::Writers::XlsWriter#to_xls (method)">#to_xls</a></span>, <span class='object_link'><a href="Writers/XlsWriter.html#write_to_xls-instance_method" title="Workbook::Writers::XlsWriter#write_to_xls (method)">#write_to_xls</a></span>, <span class='object_link'><a href="Writers/XlsWriter.html#xls_sheet-instance_method" title="Workbook::Writers::XlsWriter#xls_sheet (method)">#xls_sheet</a></span>, <span class='object_link'><a href="Writers/XlsWriter.html#xls_template-instance_method" title="Workbook::Writers::XlsWriter#xls_template (method)">#xls_template</a></span></p>
-  <div id="constructor_details" class="method_details_list">
-  <h2>Constructor Details</h2>
-    <div class="method_details first">
-  <h3 class="signature first" id="initialize-instance_method">
-    - (<tt><span class='object_link'><a href="" title="Workbook::Book (class)">Workbook::Book</a></span></tt>) <strong>initialize</strong>(sheet = Workbook::Sheet.new([], self, options={}))
-</h3><div class="docstring">
-  <div class="discussion">
-  </div>
-</div>
-<div class="tags">
-  <p class="tag_title">Parameters:</p>
-<ul class="param">
-    <li>
-        <span class='name'>sheet</span>
-        <span class='type'>(<tt><span class='object_link'><a href="Sheet.html" title="Workbook::Sheet (class)">Workbook::Sheet</a></span></tt>, <tt>Array</tt>)</span>
-        <em class="default">(defaults to: <tt>Workbook::Sheet.new([], self, options={})</tt>)</em>
-        &mdash;
-        <div class='inline'>
-<p>create a new workbook based on an existing sheet, or initialize a sheet
-based on the array</p>
-</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-30
-31
-32
-33
-34
-35
-36</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/workbook/book.rb', line 30</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span> <span class='id identifier rubyid_sheet'>sheet</span><span class='op'>=</span><span class='const'>Workbook</span><span class='op'>::</span><span class='const'>Sheet</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
-  <span class='kw'>if</span> <span class='id identifier rubyid_sheet'>sheet</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span> <span class='const'>Workbook</span><span class='op'>::</span><span class='const'>Sheet</span>
-    <span class='id identifier rubyid_push'>push</span> <span class='id identifier rubyid_sheet'>sheet</span>
-  <span class='kw'>else</span>
-    <span class='id identifier rubyid_push'>push</span> <span class='const'>Workbook</span><span class='op'>::</span><span class='const'>Sheet</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_sheet'>sheet</span><span class='comma'>,</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
-  <span class='kw'>end</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-</div>
-  <div id="instance_attr_details" class="attr_details">
-    <h2>Instance Attribute Details</h2>
-      <span id="template=-instance_method"></span>
-      <div class="method_details first">
-  <h3 class="signature first" id="template-instance_method">
-    - (<tt><span class='object_link'><a href="Format.html" title="Workbook::Format (class)">Workbook::Format</a></span></tt>) <strong>template</strong>
-</h3><div class="docstring">
-  <div class="discussion">
-<p>Returns the template describing how the document should be/is formatted</p>
-  </div>
-</div>
-<div class="tags">
-<p class="tag_title">Returns:</p>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt><span class='object_link'><a href="Format.html" title="Workbook::Format (class)">Workbook::Format</a></span></tt>)</span>
-        &mdash;
-        <div class='inline'>
-<p>returns the template describing how the document should be/is formatted</p>
-</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-39
-40
-41</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/workbook/book.rb', line 39</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_template'>template</span>
-  <span class='ivar'>@template</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <span id="title=-instance_method"></span>
-      <div class="method_details ">
-  <h3 class="signature " id="title-instance_method">
-    - (<tt>String</tt>) <strong>title</strong>
-</h3><div class="docstring">
-  <div class="discussion">
-<p>The title of the workbook</p>
-  </div>
-</div>
-<div class="tags">
-<p class="tag_title">Returns:</p>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt>String</tt>)</span>
-        &mdash;
-        <div class='inline'>
-<p>the title of the workbook</p>
-</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-52
-53
-54</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/workbook/book.rb', line 52</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_title'>title</span>
-  <span class='ivar'>@title</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-  </div>
-  <div id="class_method_details" class="method_details_list">
-    <h2>Class Method Details</h2>
-      <div class="method_details first">
-  <h3 class="signature first" id="open-class_method">
-    + (<tt><span class='object_link'><a href="" title="Workbook::Book (class)">Workbook::Book</a></span></tt>) <strong>open</strong>(filename, extension = nil)
-</h3><div class="docstring">
-  <div class="discussion">
-<p>Create an instance from a file, using open.</p>
-  </div>
-</div>
-<div class="tags">
-  <p class="tag_title">Parameters:</p>
-<ul class="param">
-    <li>
-        <span class='name'>filename</span>
-        <span class='type'>(<tt>String</tt>)</span>
-        &mdash;
-        <div class='inline'>
-<p>of the document</p>
-</div>
-    </li>
-    <li>
-        <span class='name'>extension</span>
-        <span class='type'>(<tt>String</tt>)</span>
-        <em class="default">(defaults to: <tt>nil</tt>)</em>
-        &mdash;
-        <div class='inline'>
-<p>of the document (not required). The parser used is based on the extension
-of the file, this option allows you to override the default.</p>
-</div>
-    </li>
-</ul>
-<p class="tag_title">Returns:</p>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt><span class='object_link'><a href="" title="Workbook::Book (class)">Workbook::Book</a></span></tt>)</span>
-        &mdash;
-        <div class='inline'>
-<p>A new instance, based on the filename</p>
-</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-150
-151
-152
-153
-154</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/workbook/book.rb', line 150</span>
-<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_open'>open</span> <span class='id identifier rubyid_filename'>filename</span><span class='comma'>,</span> <span class='id identifier rubyid_extension'>extension</span><span class='op'>=</span><span class='kw'>nil</span>
-  <span class='id identifier rubyid_wb'>wb</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
-  <span class='id identifier rubyid_wb'>wb</span><span class='period'>.</span><span class='id identifier rubyid_open'>open</span> <span class='id identifier rubyid_filename'>filename</span><span class='comma'>,</span> <span class='id identifier rubyid_extension'>extension</span>
-  <span class='kw'>return</span> <span class='id identifier rubyid_wb'>wb</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <h3 class="signature " id="read-class_method">
-    + (<tt><span class='object_link'><a href="" title="Workbook::Book (class)">Workbook::Book</a></span></tt>) <strong>read</strong>(stringio_or_string, filetype)
-</h3><div class="docstring">
-  <div class="discussion">
-<p>Create an instance from the given stream or string, which should be in CSV
-or TXT format</p>
-  </div>
-</div>
-<div class="tags">
-  <p class="tag_title">Parameters:</p>
-<ul class="param">
-    <li>
-        <span class='name'>stringio_or_string</span>
-        <span class='type'>(<tt>StringIO</tt>)</span>
-        &mdash;
-        <div class='inline'>
-<p>StringIO stream or String object, with data in CSV or TXT format</p>
-</div>
-    </li>
-    <li>
-        <span class='name'>filetype</span>
-        <span class='type'>(<tt>Symbol</tt>)</span>
-        &mdash;
-        <div class='inline'>
-<p>(currently only :csv or :txt), indicating the format of the first parameter</p>
-</div>
-    </li>
-</ul>
-<p class="tag_title">Returns:</p>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt><span class='object_link'><a href="" title="Workbook::Book (class)">Workbook::Book</a></span></tt>)</span>
-        &mdash;
-        <div class='inline'>
-<p>A new instance</p>
-</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-161
-162
-163
-164
-165</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/workbook/book.rb', line 161</span>
-<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_read'>read</span><span class='lparen'>(</span><span class='id identifier rubyid_stringio_or_string'>stringio_or_string</span><span class='comma'>,</span> <span class='id identifier rubyid_filetype'>filetype</span><span class='rparen'>)</span>
-  <span class='id identifier rubyid_wb'>wb</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
-  <span class='id identifier rubyid_wb'>wb</span><span class='period'>.</span><span class='id identifier rubyid_read'>read</span><span class='lparen'>(</span><span class='id identifier rubyid_stringio_or_string'>stringio_or_string</span><span class='comma'>,</span> <span class='id identifier rubyid_filetype'>filetype</span><span class='rparen'>)</span>
-  <span class='id identifier rubyid_wb'>wb</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-  </div>
-  <div id="instance_method_details" class="method_details_list">
-    <h2>Instance Method Details</h2>
-      <div class="method_details first">
-  <h3 class="signature first" id="create_or_open_sheet_at-instance_method">
-    - (<tt>Object</tt>) <strong>create_or_open_sheet_at</strong>(index)
-</h3><div class="docstring">
-  <div class="discussion">
-<p>Create or open the existing sheet at an index value</p>
-  </div>
-</div>
-<div class="tags">
-  <p class="tag_title">Parameters:</p>
-<ul class="param">
-    <li>
-        <span class='name'>index</span>
-        <span class='type'>(<tt>Integer</tt>)</span>
-        &mdash;
-        <div class='inline'>
-<p>the index of the sheet</p>
-</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-181
-182
-183
-184
-185
-186</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/workbook/book.rb', line 181</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_create_or_open_sheet_at'>create_or_open_sheet_at</span> <span class='id identifier rubyid_index'>index</span>
-  <span class='id identifier rubyid_s'>s</span> <span class='op'>=</span> <span class='kw'>self</span><span class='lbracket'>[</span><span class='id identifier rubyid_index'>index</span><span class='rbracket'>]</span>
-  <span class='id identifier rubyid_s'>s</span> <span class='op'>=</span> <span class='kw'>self</span><span class='lbracket'>[</span><span class='id identifier rubyid_index'>index</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='const'>Workbook</span><span class='op'>::</span><span class='const'>Sheet</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='kw'>if</span> <span class='id identifier rubyid_s'>s</span> <span class='op'>==</span> <span class='kw'>nil</span>
-  <span class='id identifier rubyid_s'>s</span><span class='period'>.</span><span class='id identifier rubyid_book'>book</span> <span class='op'>=</span> <span class='kw'>self</span>
-  <span class='id identifier rubyid_s'>s</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <h3 class="signature " id="file_extension-instance_method">
-    - (<tt>String</tt>) <strong>file_extension</strong>(filename)
-</h3><div class="docstring">
-  <div class="discussion">
-<p>The file extension</p>
-  </div>
-</div>
-<div class="tags">
-  <p class="tag_title">Parameters:</p>
-<ul class="param">
-    <li>
-        <span class='name'>filename</span>
-        <span class='type'>(<tt>String</tt>)</span>
-        &mdash;
-        <div class='inline'>
-<p>The full filename, or path</p>
-</div>
-    </li>
-</ul>
-<p class="tag_title">Returns:</p>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt>String</tt>)</span>
-        &mdash;
-        <div class='inline'>
-<p>The file extension</p>
-</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-141
-142
-143</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/workbook/book.rb', line 141</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_file_extension'>file_extension</span><span class='lparen'>(</span><span class='id identifier rubyid_filename'>filename</span><span class='rparen'>)</span>
-  <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_extname'>extname</span><span class='lparen'>(</span><span class='id identifier rubyid_filename'>filename</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_gsub'>gsub</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>.</span><span class='tstring_end'>'</span></span><span class='comma'>,</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_downcase'>downcase</span> <span class='kw'>if</span> <span class='id identifier rubyid_filename'>filename</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <h3 class="signature " id="has_contents?-instance_method">
-    - (<tt>Boolean</tt>) <strong>has_contents?</strong>
-</h3><div class="docstring">
-  <div class="discussion">
-<p>If the first sheet has any contents</p>
-  </div>
-</div>
-<div class="tags">
-<p class="tag_title">Returns:</p>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt>Boolean</tt>)</span>
-        &mdash;
-        <div class='inline'>
-<p>returns true if the first sheet has contents</p>
-</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-74
-75
-76</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/workbook/book.rb', line 74</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_has_contents?'>has_contents?</span>
-  <span class='id identifier rubyid_sheet'>sheet</span><span class='period'>.</span><span class='id identifier rubyid_has_contents?'>has_contents?</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <h3 class="signature " id="open-instance_method">
-    - (<tt><span class='object_link'><a href="" title="Workbook::Book (class)">Workbook::Book</a></span></tt>) <strong>open</strong>(filename, extension = nil)
-</h3><div class="docstring">
-  <div class="discussion">
-<p>Loads an external file into an existing worbook</p>
-  </div>
-</div>
-<div class="tags">
-  <p class="tag_title">Parameters:</p>
-<ul class="param">
-    <li>
-        <span class='name'>filename</span>
-        <span class='type'>(<tt>String</tt>)</span>
-        &mdash;
-        <div class='inline'>
-<p>a string with a reference to the file to be opened</p>
-</div>
-    </li>
-    <li>
-        <span class='name'>extension</span>
-        <span class='type'>(<tt>String</tt>)</span>
-        <em class="default">(defaults to: <tt>nil</tt>)</em>
-        &mdash;
-        <div class='inline'>
-<p>an optional string enforcing a certain parser (based on the file extension,
-e.g. ‘txt’, ‘csv’ or ‘xls’)</p>
-</div>
-    </li>
-</ul>
-<p class="tag_title">Returns:</p>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt><span class='object_link'><a href="" title="Workbook::Book (class)">Workbook::Book</a></span></tt>)</span>
-        &mdash;
-        <div class='inline'>
-<p>A new instance, based on the filename</p>
-</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-83
-84
-85
-86
-87
-88
-89
-90</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/workbook/book.rb', line 83</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_open'>open</span> <span class='id identifier rubyid_filename'>filename</span><span class='comma'>,</span> <span class='id identifier rubyid_extension'>extension</span><span class='op'>=</span><span class='kw'>nil</span>
-  <span class='id identifier rubyid_extension'>extension</span> <span class='op'>=</span> <span class='id identifier rubyid_file_extension'>file_extension</span><span class='lparen'>(</span><span class='id identifier rubyid_filename'>filename</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id identifier rubyid_extension'>extension</span>
-  <span class='kw'>if</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>txt</span><span class='tstring_end'>'</span></span><span class='comma'>,</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>csv</span><span class='tstring_end'>'</span></span><span class='comma'>,</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>xml</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='id identifier rubyid_extension'>extension</span><span class='rparen'>)</span>
-    <span class='id identifier rubyid_open_text'>open_text</span> <span class='id identifier rubyid_filename'>filename</span><span class='comma'>,</span> <span class='id identifier rubyid_extension'>extension</span>
-  <span class='kw'>else</span>
-    <span class='id identifier rubyid_open_binary'>open_binary</span> <span class='id identifier rubyid_filename'>filename</span><span class='comma'>,</span> <span class='id identifier rubyid_extension'>extension</span>
-  <span class='kw'>end</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <h3 class="signature " id="open_binary-instance_method">
-    - (<tt><span class='object_link'><a href="" title="Workbook::Book (class)">Workbook::Book</a></span></tt>) <strong>open_binary</strong>(filename, extension = nil)
-</h3><div class="docstring">
-  <div class="discussion">
-<p>Open the file in binary, read-only mode, do not read it, but pas it throug
-to the extension determined loaded</p>
-  </div>
-</div>
-<div class="tags">
-  <p class="tag_title">Parameters:</p>
-<ul class="param">
-    <li>
-        <span class='name'>filename</span>
-        <span class='type'>(<tt>String</tt>)</span>
-        &mdash;
-        <div class='inline'>
-<p>a string with a reference to the file to be opened</p>
-</div>
-    </li>
-    <li>
-        <span class='name'>extension</span>
-        <span class='type'>(<tt>String</tt>)</span>
-        <em class="default">(defaults to: <tt>nil</tt>)</em>
-        &mdash;
-        <div class='inline'>
-<p>an optional string enforcing a certain parser (based on the file extension,
-e.g. ‘txt’, ‘csv’ or ‘xls’)</p>
-</div>
-    </li>
-</ul>
-<p class="tag_title">Returns:</p>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt><span class='object_link'><a href="" title="Workbook::Book (class)">Workbook::Book</a></span></tt>)</span>
-        &mdash;
-        <div class='inline'>
-<p>A new instance, based on the filename</p>
-</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-97
-98
-99
-100
-101</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/workbook/book.rb', line 97</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_open_binary'>open_binary</span> <span class='id identifier rubyid_filename'>filename</span><span class='comma'>,</span> <span class='id identifier rubyid_extension'>extension</span><span class='op'>=</span><span class='kw'>nil</span>
-  <span class='id identifier rubyid_extension'>extension</span> <span class='op'>=</span> <span class='id identifier rubyid_file_extension'>file_extension</span><span class='lparen'>(</span><span class='id identifier rubyid_filename'>filename</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id identifier rubyid_extension'>extension</span>
-  <span class='id identifier rubyid_f'>f</span> <span class='op'>=</span> <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_open'>open</span><span class='lparen'>(</span><span class='id identifier rubyid_filename'>filename</span><span class='comma'>,</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>rb</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
-  <span class='id identifier rubyid_send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>load_</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_extension'>extension</span><span class='rbrace'>}</span><span class='tstring_end'>&quot;</span></span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span><span class='comma'>,</span><span class='id identifier rubyid_f'>f</span><span class='rparen'>)</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <h3 class="signature " id="open_text-instance_method">
-    - (<tt>Object</tt>) <strong>open_text</strong>(filename, extension = nil)
-</h3><div class="docstring">
-  <div class="discussion">
-<p>Open the file in non-binary, read-only mode, read it and parse it to UTF-8</p>
-  </div>
-</div>
-<div class="tags">
-  <p class="tag_title">Parameters:</p>
-<ul class="param">
-    <li>
-        <span class='name'>filename</span>
-        <span class='type'>(<tt>String</tt>)</span>
-        &mdash;
-        <div class='inline'>
-<p>a string with a reference to the file to be opened</p>
-</div>
-    </li>
-    <li>
-        <span class='name'>extension</span>
-        <span class='type'>(<tt>String</tt>)</span>
-        <em class="default">(defaults to: <tt>nil</tt>)</em>
-        &mdash;
-        <div class='inline'>
-<p>an optional string enforcing a certain parser (based on the file extension,
-e.g. ‘txt’, ‘csv’ or ‘xls’)</p>
-</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-107
-108
-109
-110
-111
-112
-113</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/workbook/book.rb', line 107</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_open_text'>open_text</span> <span class='id identifier rubyid_filename'>filename</span><span class='comma'>,</span> <span class='id identifier rubyid_extension'>extension</span><span class='op'>=</span><span class='kw'>nil</span>
-  <span class='id identifier rubyid_extension'>extension</span> <span class='op'>=</span> <span class='id identifier rubyid_file_extension'>file_extension</span><span class='lparen'>(</span><span class='id identifier rubyid_filename'>filename</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id identifier rubyid_extension'>extension</span>
-  <span class='id identifier rubyid_f'>f</span> <span class='op'>=</span> <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_open'>open</span><span class='lparen'>(</span><span class='id identifier rubyid_filename'>filename</span><span class='comma'>,</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>r</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
-  <span class='id identifier rubyid_t'>t</span> <span class='op'>=</span> <span class='id identifier rubyid_f'>f</span><span class='period'>.</span><span class='id identifier rubyid_read'>read</span>
-  <span class='id identifier rubyid_t'>t</span> <span class='op'>=</span> <span class='id identifier rubyid_text_to_utf8'>text_to_utf8</span><span class='lparen'>(</span><span class='id identifier rubyid_t'>t</span><span class='rparen'>)</span>
-  <span class='id identifier rubyid_send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>load_</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_extension'>extension</span><span class='rbrace'>}</span><span class='tstring_end'>&quot;</span></span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span><span class='comma'>,</span><span class='id identifier rubyid_t'>t</span><span class='rparen'>)</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <h3 class="signature " id="push-instance_method">
-    - (<tt>Object</tt>) <strong>push</strong>(sheet = Workbook::Sheet.new)
-</h3><div class="docstring">
-  <div class="discussion">
-<p>Push (like in array) a sheet to the workbook (parameter is optional,
-default is a new sheet)</p>
-  </div>
-</div>
-<div class="tags">
-  <p class="tag_title">Parameters:</p>
-<ul class="param">
-    <li>
-        <span class='name'>sheet</span>
-        <span class='type'>(<tt><span class='object_link'><a href="Sheet.html" title="Workbook::Sheet (class)">Workbook::Sheet</a></span></tt>)</span>
-        <em class="default">(defaults to: <tt>Workbook::Sheet.new</tt>)</em>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-59
-60
-61</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/workbook/book.rb', line 59</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_push'>push</span> <span class='id identifier rubyid_sheet'>sheet</span><span class='op'>=</span><span class='const'>Workbook</span><span class='op'>::</span><span class='const'>Sheet</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
-  <span class='kw'>super</span><span class='lparen'>(</span><span class='id identifier rubyid_sheet'>sheet</span><span class='rparen'>)</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <h3 class="signature " id="read-instance_method">
-    - (<tt>Object</tt>) <strong>read</strong>(stringio_or_string, filetype)
-</h3><div class="docstring">
-  <div class="discussion">
-<p>Load the CSV data contained in the given StringIO or String object</p>
-  </div>
-</div>
-<div class="tags">
-  <p class="tag_title">Parameters:</p>
-<ul class="param">
-    <li>
-        <span class='name'>stringio_or_string</span>
-        <span class='type'>(<tt>StringIO</tt>)</span>
-        &mdash;
-        <div class='inline'>
-<p>StringIO stream or String object, with data in CSV format</p>
-</div>
-    </li>
-    <li>
-        <span class='name'>filetype</span>
-        <span class='type'>(<tt>Symbol</tt>)</span>
-        &mdash;
-        <div class='inline'>
-<p>(currently only :csv or :txt), indicating the format of the first parameter</p>
-</div>
-    </li>
-</ul>
-<p class="tag_title">Raises:</p>
-<ul class="raise">
-    <li>
-        <span class='type'>(<tt>ArgumentError</tt>)</span>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-171
-172
-173
-174
-175
-176</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/workbook/book.rb', line 171</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_read'>read</span><span class='lparen'>(</span><span class='id identifier rubyid_stringio_or_string'>stringio_or_string</span><span class='comma'>,</span> <span class='id identifier rubyid_filetype'>filetype</span><span class='rparen'>)</span>
-  <span class='id identifier rubyid_raise'>raise</span> <span class='const'>ArgumentError</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>The filetype parameter should be either :csv or :txt</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='lbracket'>[</span><span class='symbol'>:csv</span><span class='comma'>,</span> <span class='symbol'>:txt</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='id identifier rubyid_filetype'>filetype</span><span class='rparen'>)</span>
-  <span class='id identifier rubyid_t'>t</span> <span class='op'>=</span> <span class='id identifier rubyid_stringio_or_string'>stringio_or_string</span><span class='period'>.</span><span class='id identifier rubyid_respond_to?'>respond_to?</span><span class='lparen'>(</span><span class='symbol'>:read</span><span class='rparen'>)</span> <span class='op'>?</span> <span class='id identifier rubyid_stringio_or_string'>stringio_or_string</span><span class='period'>.</span><span class='id identifier rubyid_read'>read</span> <span class='op'>:</span> <span class='id identifier rubyid_stringio_or_string'>stringio_or_string</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span>
-  <span class='id identifier rubyid_t'>t</span> <span class='op'>=</span> <span class='id identifier rubyid_text_to_utf8'>text_to_utf8</span><span class='lparen'>(</span><span class='id identifier rubyid_t'>t</span><span class='rparen'>)</span>
-  <span class='id identifier rubyid_send'>send</span><span class='lparen'>(</span><span class='symbol'>:parse_</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_filetype'>filetype</span><span class='rbrace'>}</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_t'>t</span><span class='rparen'>)</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <h3 class="signature " id="sheet-instance_method">
-    - (<tt><span class='object_link'><a href="Sheet.html" title="Workbook::Sheet (class)">Workbook::Sheet</a></span></tt>) <strong>sheet</strong>
-</h3><div class="docstring">
-  <div class="discussion">
-<p>Sheet returns the first sheet of a workbook, or an empty one.</p>
-  </div>
-</div>
-<div class="tags">
-<p class="tag_title">Returns:</p>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt><span class='object_link'><a href="Sheet.html" title="Workbook::Sheet (class)">Workbook::Sheet</a></span></tt>)</span>
-        &mdash;
-        <div class='inline'>
-<p>The first sheet, and creates an empty one if one doesn’t exists</p>
-</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-66
-67
-68
-69</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/workbook/book.rb', line 66</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_sheet'>sheet</span>
-  <span class='id identifier rubyid_push'>push</span> <span class='const'>Workbook</span><span class='op'>::</span><span class='const'>Sheet</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='kw'>unless</span> <span class='id identifier rubyid_first'>first</span>
-  <span class='id identifier rubyid_first'>first</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <h3 class="signature " id="text_to_utf8-instance_method">
-    - (<tt>Object</tt>) <strong>text_to_utf8</strong>(text)
-</h3><div class="docstring">
-  <div class="discussion">
-<p>Helper method to convert text in a file to UTF-8</p>
-  </div>
-</div>
-<div class="tags">
-  <p class="tag_title">Parameters:</p>
-<ul class="param">
-    <li>
-        <span class='name'>text</span>
-        <span class='type'>(<tt>String</tt>)</span>
-        &mdash;
-        <div class='inline'>
-<p>a string to convert</p>
-</div>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-119
-120
-121
-122
-123
-124
-125
-126
-127
-128
-129
-130
-131
-132
-133
-134
-135
-136</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/workbook/book.rb', line 119</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_text_to_utf8'>text_to_utf8</span> <span class='id identifier rubyid_text'>text</span>
-  <span class='kw'>if</span> <span class='const'>RUBY_VERSION</span> <span class='op'>&lt;</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>1.9</span><span class='tstring_end'>'</span></span>
-    <span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>rchardet</span><span class='tstring_end'>'</span></span>
-    <span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>iconv</span><span class='tstring_end'>'</span></span>
-    <span class='id identifier rubyid_detected_encoding'>detected_encoding</span> <span class='op'>=</span> <span class='const'>CharDet</span><span class='period'>.</span><span class='id identifier rubyid_detect'>detect</span><span class='lparen'>(</span><span class='id identifier rubyid_text'>text</span><span class='rparen'>)</span>
-    <span class='id identifier rubyid_detected_encoding'>detected_encoding</span> <span class='op'>=</span> <span class='id identifier rubyid_detected_encoding'>detected_encoding</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>encoding</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span>
-    <span class='id identifier rubyid_text'>text</span> <span class='op'>=</span> <span class='const'>Iconv</span><span class='period'>.</span><span class='id identifier rubyid_conv'>conv</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>UTF-8//TRANSLIT//IGNORE</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span><span class='id identifier rubyid_detected_encoding'>detected_encoding</span><span class='comma'>,</span><span class='id identifier rubyid_text'>text</span><span class='rparen'>)</span>
-    <span class='id identifier rubyid_text'>text</span> <span class='op'>=</span> <span class='id identifier rubyid_text'>text</span><span class='period'>.</span><span class='id identifier rubyid_gsub'>gsub</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\xEF\xBB\xBF</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='comment'># removing the BOM...
-</span>  <span class='kw'>else</span>
-    <span class='kw'>unless</span> <span class='id identifier rubyid_text'>text</span><span class='period'>.</span><span class='id identifier rubyid_valid_encoding?'>valid_encoding?</span> <span class='kw'>and</span> <span class='id identifier rubyid_text'>text</span><span class='period'>.</span><span class='id identifier rubyid_encoding'>encoding</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>UTF-8</span><span class='tstring_end'>&quot;</span></span>
-      <span class='comment'># TODO: had some ruby 1.9 problems with rchardet ... but ideally it or a similar functionality will be reintroduced
-</span>      <span class='id identifier rubyid_source_encoding'>source_encoding</span> <span class='op'>=</span> <span class='id identifier rubyid_text'>text</span><span class='period'>.</span><span class='id identifier rubyid_valid_encoding?'>valid_encoding?</span> <span class='op'>?</span> <span class='id identifier rubyid_text'>text</span><span class='period'>.</span><span class='id identifier rubyid_encoding'>encoding</span> <span class='op'>:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>US-ASCII</span><span class='tstring_end'>&quot;</span></span>
-      <span class='id identifier rubyid_text'>text</span> <span class='op'>=</span> <span class='id identifier rubyid_text'>text</span><span class='period'>.</span><span class='id identifier rubyid_encode'>encode</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>UTF-8</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='id identifier rubyid_source_encoding'>source_encoding</span><span class='comma'>,</span> <span class='lbrace'>{</span><span class='symbol'>:invalid</span><span class='op'>=&gt;</span><span class='symbol'>:replace</span><span class='comma'>,</span> <span class='symbol'>:undef</span><span class='op'>=&gt;</span><span class='symbol'>:replace</span><span class='comma'>,</span> <span class='symbol'>:replace</span><span class='op'>=&gt;</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='rbrace'>}</span><span class='rparen'>)</span>
-      <span class='id identifier rubyid_text'>text</span> <span class='op'>=</span> <span class='id identifier rubyid_text'>text</span><span class='period'>.</span><span class='id identifier rubyid_gsub'>gsub</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\u0000</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span> <span class='comment'># TODO: this cleanup of nil values isn't supposed to be needed...
-</span>    <span class='kw'>end</span>
-  <span class='kw'>end</span>
-  <span class='kw'>return</span> <span class='id identifier rubyid_text'>text</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-  </div>
-</div>
-    <div id="footer">
-  Generated on Sun May 19 23:16:31 2013 by
-  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.8.5.2 (ruby-1.9.3).
-</div>
-  </body>
-</html>