RubyGems - dbmlite3 - Versions diffs - 1.0.0 → 2.0.0.pre.alpha.3 - Mend

dbmlite3 1.0.0 → 2.0.0.pre.alpha.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (30) hide show

checksums.yaml +4 -4
data/README.md +70 -19
data/Rakefile +5 -4
data/dbmlite3.gemspec +32 -10
data/extras/benchmark.rb +172 -0
data/lib/dbmlite3.rb +9 -949
data/lib/internal_lite3/dbm.rb +542 -0
data/lib/internal_lite3/error.rb +27 -0
data/lib/internal_lite3/handle.rb +284 -0
data/lib/internal_lite3/sql.rb +87 -0
data/spec/dbmlite3_spec.rb +113 -72
metadata +30 -29
data/doc/Lite3/DBM.html +0 -2653
data/doc/Lite3/Error.html +0 -135
data/doc/Lite3/SQL.html +0 -390
data/doc/Lite3.html +0 -117
data/doc/_index.html +0 -152
data/doc/class_list.html +0 -51
data/doc/css/common.css +0 -1
data/doc/css/full_list.css +0 -58
data/doc/css/style.css +0 -496
data/doc/file.README.html +0 -212
data/doc/file_list.html +0 -56
data/doc/frames.html +0 -17
data/doc/index.html +0 -212
data/doc/js/app.js +0 -314
data/doc/js/full_list.js +0 -216
data/doc/js/jquery.js +0 -4
data/doc/method_list.html +0 -307
data/doc/top-level-namespace.html +0 -110

data/doc/Lite3/Error.html DELETED Viewed

@@ -1,135 +0,0 @@
-<!DOCTYPE html>
-<html>
-  <head>
-    <meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1.0">
-<title>
-  Exception: Lite3::Error
-    &mdash; Documentation by YARD 0.9.25
-</title>
-  <link rel="stylesheet" href="../css/style.css" type="text/css" />
-  <link rel="stylesheet" href="../css/common.css" type="text/css" />
-<script type="text/javascript">
-  pathId = "Lite3::Error";
-  relpath = '../';
-</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 class="nav_wrap">
-      <iframe id="nav" src="../class_list.html?1"></iframe>
-      <div id="resizer"></div>
-    </div>
-    <div id="main" tabindex="-1">
-      <div id="header">
-        <div id="menu">
-    <a href="../_index.html">Index (E)</a> &raquo;
-    <span class='title'><span class='object_link'><a href="../Lite3.html" title="Lite3 (module)">Lite3</a></span></span>
-     &raquo;
-    <span class="title">Error</span>
-</div>
-        <div id="search">
-    <a class="full_list_link" id="class_list_link"
-        href="../class_list.html">
-        <svg width="24" height="24">
-          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
-          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
-          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
-        </svg>
-    </a>
-</div>
-        <div class="clear"></div>
-      </div>
-      <div id="content"><h1>Exception: Lite3::Error
-</h1>
-<div class="box_info">
-  <dl>
-    <dt>Inherits:</dt>
-    <dd>
-      <span class="inheritName">StandardError</span>
-        <ul class="fullTree">
-          <li>Object</li>
-            <li class="next">StandardError</li>
-            <li class="next">Lite3::Error</li>
-        </ul>
-        <a href="#" class="inheritanceTree">show all</a>
-    </dd>
-  </dl>
-  <dl>
-    <dt>Defined in:</dt>
-    <dd>lib/dbmlite3.rb</dd>
-  </dl>
-</div>
-<h2>Overview</h2><div class="docstring">
-  <div class="discussion">
-    <p>Exception class for errors specific <code>Lite3::DBM</code>.  Note that
-<code>Lite3::*</code> methods may also throw <code>SQLite3</code> exceptions.</p>
-  </div>
-</div>
-<div class="tags">
-</div>
-</div>
-      <div id="footer">
-  Generated on Sun Feb 27 17:44:19 2022 by
-  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.25 (ruby-2.7.0).
-</div>
-    </div>
-  </body>
-</html>

data/doc/Lite3/SQL.html DELETED Viewed

@@ -1,390 +0,0 @@
-<!DOCTYPE html>
-<html>
-  <head>
-    <meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1.0">
-<title>
-  Module: Lite3::SQL
-    &mdash; Documentation by YARD 0.9.25
-</title>
-  <link rel="stylesheet" href="../css/style.css" type="text/css" />
-  <link rel="stylesheet" href="../css/common.css" type="text/css" />
-<script type="text/javascript">
-  pathId = "Lite3::SQL";
-  relpath = '../';
-</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 class="nav_wrap">
-      <iframe id="nav" src="../class_list.html?1"></iframe>
-      <div id="resizer"></div>
-    </div>
-    <div id="main" tabindex="-1">
-      <div id="header">
-        <div id="menu">
-    <a href="../_index.html">Index (S)</a> &raquo;
-    <span class='title'><span class='object_link'><a href="../Lite3.html" title="Lite3 (module)">Lite3</a></span></span>
-     &raquo;
-    <span class="title">SQL</span>
-</div>
-        <div id="search">
-    <a class="full_list_link" id="class_list_link"
-        href="../class_list.html">
-        <svg width="24" height="24">
-          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
-          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
-          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
-        </svg>
-    </a>
-</div>
-        <div class="clear"></div>
-      </div>
-      <div id="content"><h1>Module: Lite3::SQL
-</h1>
-<div class="box_info">
-  <dl>
-    <dt>Defined in:</dt>
-    <dd>lib/dbmlite3.rb</dd>
-  </dl>
-</div>
-<h2>Overview</h2><div class="docstring">
-  <div class="discussion">
-    <p>This module provides some basic access to the underlying
-<code>SQLite3::Database</code> objects used by <code>Lite3::DBM</code> to actually store
-and retrieve data.</p>
-<p>Things you need to care about are:</p>
-<ol>
-<li><p>Use <code>threadsafe?</code> to see if the underlying <code>SQLite3</code> lib was
-compiled to be threadsafe.</p></li>
-<li><p>Invoke <code>Lite3::SQL.close_all</code> before forking the process if you
-have ever opened a <code>Lite3::DBM</code> object and intend on using
-<code>Lite3</code> in both the parent and the child process.</p></li>
-</ol>
-<p>More details:</p>
-<p><code>Lite3</code> maintains a pool of private handle objects (private class
-<code>Lite3::Handle</code>) which in turn manage the <code>SQLite3::Database</code>
-objects that actually do the work.  There is one handle per
-SQLite3 database file; since each <code>DBM</code> represents one table in a
-SQLite3 file, multiple <code>DBM</code> objects will use the same handle.</p>
-<p>Handle objects can themselves close and replace their
-<code>SQLite3::Database</code> objects transparently.</p>
-<p>The underlying system keeps track of which <code>DBM</code> objects reference
-which files and will close a file&#39;s <code>SQLite3::Database</code> when all
-of the <code>DBM</code>s using it have been closed.  (It does <strong>not</strong> handle
-the case where a <code>DBM</code> object remains open and goes out of scope;
-that object will be kept around for the life of the process.)</p>
-<p>Mostly, you don&#39;t need to care about this.  However, it affects
-you in two ways:</p>
-<ol>
-<li><p>Transactions are done at the file level and not the table level.
-This means that you can access separate tables in the same
-transaction, which is a Very Good Thing.</p></li>
-<li><p>You can safely fork the current process and keep using existing
-<code>DBM</code> objects in both processes, provided you&#39;ve invoked
-<code>close_all</code> before the fork.  This will have closed the actual
-database handles (which can&#39;t tolerate being carried across a
-fork) and opens new ones the next time they&#39;re needed.</p></li>
-</ol>
-<p>If you find yourself needing to be sure that you don&#39;t have any
-unexpected open file handles (e.g. before forking or if you need
-Windows to unlock it), you should call <code>close_all</code>.</p>
-<p>Otherwise, it&#39;s safe to ignore this stuff.</p>
-  </div>
-</div>
-<div class="tags">
-</div>
-    <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="#close_all-class_method" title="close_all (class method)">.<strong>close_all</strong>  &#x21d2; Object </a>
-  </span>
-    <span class="summary_desc"><div class='inline'><p>Close and remove the underlying <code>SQLite3::Database</code> associated with each <code>DBM</code>.</p>
-</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#gc-class_method" title="gc (class method)">.<strong>gc</strong>  &#x21d2; Object </a>
-  </span>
-    <span class="summary_desc"><div class='inline'><p>Clean up lingering unused database handle metadata.</p>
-</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#threadsafe%3F-class_method" title="threadsafe? (class method)">.<strong>threadsafe?</strong>  &#x21d2; Boolean </a>
-  </span>
-    <span class="summary_desc"><div class='inline'><p>Test if the SQLite3 lib we are using has been compiled to be thread safe.</p>
-</div></span>
-</li>
-    </ul>
-  <div id="class_method_details" class="method_details_list">
-    <h2>Class Method Details</h2>
-      <div class="method_details first">
-  <h3 class="signature first" id="close_all-class_method">
-    .<strong>close_all</strong>  &#x21d2; <tt>Object</tt>
-</h3><div class="docstring">
-  <div class="discussion">
-    <p>Close and remove the underlying <code>SQLite3::Database</code> associated
-with each <code>DBM</code>. A new <code>SQLite3::Database</code> will be created on
-the file the first time the <code>DBM</code> is used.</p>
-<p>This <strong>should not</strong> be called while a database operation is in
-progress.  (E.g. do <strong>not</strong> call this from the block of
-<code>DBM.each</code>.)</p>
-  </div>
-</div>
-<div class="tags">
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-309</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/dbmlite3.rb', line 309</span>
-<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_close_all'>close_all</span><span class='lparen'>(</span><span class='rparen'>)</span>    <span class='kw'>return</span> <span class='const'>HandlePool</span><span class='period'>.</span><span class='id identifier rubyid_close_all'>close_all</span>     <span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <h3 class="signature " id="gc-class_method">
-    .<strong>gc</strong>  &#x21d2; <tt>Object</tt>
-</h3><div class="docstring">
-  <div class="discussion">
-    <p>Clean up lingering unused database handle metadata.</p>
-<p>This is usually not a significant amount of space unless you
-have opened and closed a lot of different database files, but
-it&#39;s here if you need it.</p>
-<p>Returns a hash mapping each remaining handle&#39;s canonical file
-path to a list of <code>DBM</code> objects that reference it.  This is
-probably not useful to you; it&#39;s there for the unit tests.</p>
-  </div>
-</div>
-<div class="tags">
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-300</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/dbmlite3.rb', line 300</span>
-<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_gc'>gc</span><span class='lparen'>(</span><span class='rparen'>)</span>           <span class='kw'>return</span> <span class='const'>HandlePool</span><span class='period'>.</span><span class='id identifier rubyid_gc'>gc</span><span class='semicolon'>;</span>           <span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-      <div class="method_details ">
-  <h3 class="signature " id="threadsafe?-class_method">
-    .<strong>threadsafe?</strong>  &#x21d2; <tt>Boolean</tt>
-</h3><div class="docstring">
-  <div class="discussion">
-    <p>Test if the SQLite3 lib we are using has been compiled to be
-thread safe.  Just a wrapper around <code>SQLite3.threadsafe?</code></p>
-  </div>
-</div>
-<div class="tags">
-<p class="tag_title">Returns:</p>
-<ul class="return">
-    <li>
-        <span class='type'>(<tt>Boolean</tt>)</span>
-    </li>
-</ul>
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-287
-288
-289</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/dbmlite3.rb', line 287</span>
-<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_threadsafe?'>threadsafe?</span>
-  <span class='kw'>return</span> <span class='const'>SQLite3</span><span class='period'>.</span><span class='id identifier rubyid_threadsafe?'>threadsafe?</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-  </div>
-</div>
-      <div id="footer">
-  Generated on Sun Feb 27 17:44:19 2022 by
-  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.25 (ruby-2.7.0).
-</div>
-    </div>
-  </body>
-</html>

data/doc/Lite3.html DELETED Viewed

@@ -1,117 +0,0 @@
-<!DOCTYPE html>
-<html>
-  <head>
-    <meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1.0">
-<title>
-  Module: Lite3
-    &mdash; Documentation by YARD 0.9.25
-</title>
-  <link rel="stylesheet" href="css/style.css" type="text/css" />
-  <link rel="stylesheet" href="css/common.css" type="text/css" />
-<script type="text/javascript">
-  pathId = "Lite3";
-  relpath = '';
-</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 class="nav_wrap">
-      <iframe id="nav" src="class_list.html?1"></iframe>
-      <div id="resizer"></div>
-    </div>
-    <div id="main" tabindex="-1">
-      <div id="header">
-        <div id="menu">
-    <a href="_index.html">Index (L)</a> &raquo;
-    <span class="title">Lite3</span>
-</div>
-        <div id="search">
-    <a class="full_list_link" id="class_list_link"
-        href="class_list.html">
-        <svg width="24" height="24">
-          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
-          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
-          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
-        </svg>
-    </a>
-</div>
-        <div class="clear"></div>
-      </div>
-      <div id="content"><h1>Module: Lite3
-</h1>
-<div class="box_info">
-  <dl>
-    <dt>Defined in:</dt>
-    <dd>lib/dbmlite3.rb</dd>
-  </dl>
-</div>
-<h2>Defined Under Namespace</h2>
-<p class="children">
-      <strong class="modules">Modules:</strong> <span class='object_link'><a href="Lite3/SQL.html" title="Lite3::SQL (module)">SQL</a></span>
-      <strong class="classes">Classes:</strong> <span class='object_link'><a href="Lite3/DBM.html" title="Lite3::DBM (class)">DBM</a></span>, <span class='object_link'><a href="Lite3/Error.html" title="Lite3::Error (class)">Error</a></span>
-</p>
-</div>
-      <div id="footer">
-  Generated on Sun Feb 27 17:44:19 2022 by
-  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.25 (ruby-2.7.0).
-</div>
-    </div>
-  </body>
-</html>