RubyGems - dbmlite3 - Versions diffs - 2.0.0.pre.alpha.4 → 2.0.0 - Mend

dbmlite3 2.0.0.pre.alpha.4 → 2.0.0

Files changed (30) hide show

checksums.yaml +4 -4
data/LICENSE.txt +1 -1
data/Rakefile +2 -2
data/dbmlite3.gemspec +11 -10
data/doc/Lite3/DBM.html +2560 -0
data/doc/Lite3/Error.html +139 -0
data/doc/Lite3/InternalError.html +143 -0
data/doc/Lite3/SQL.html +343 -0
data/doc/Lite3.html +119 -0
data/doc/_index.html +167 -0
data/doc/class_list.html +51 -0
data/doc/css/common.css +1 -0
data/doc/css/full_list.css +58 -0
data/doc/css/style.css +497 -0
data/doc/file.README.html +217 -0
data/doc/file_list.html +56 -0
data/doc/frames.html +17 -0
data/doc/index.html +217 -0
data/doc/js/app.js +314 -0
data/doc/js/full_list.js +216 -0
data/doc/js/jquery.js +4 -0
data/doc/method_list.html +307 -0
data/doc/top-level-namespace.html +110 -0
data/lib/internal_lite3/dbm.rb +8 -6
data/lib/internal_lite3/error.rb +0 -4
data/lib/internal_lite3/handle.rb +7 -3
data/lib/internal_lite3/sql.rb +4 -1
data/spec/dbmlite3_spec.rb +28 -10
metadata +29 -11
data/extras/benchmark.rb +0 -172

data/doc/top-level-namespace.html ADDED Viewed

@@ -0,0 +1,110 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  Top Level Namespace
+    &mdash; Documentation by YARD 0.9.34
+</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 = "";
+  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</a> &raquo;
+    <span class="title">Top Level Namespace</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>Top Level Namespace
+</h1>
+<div class="box_info">
+</div>
+<h2>Defined Under Namespace</h2>
+<p class="children">
+      <strong class="modules">Modules:</strong> <span class='object_link'><a href="Lite3.html" title="Lite3 (module)">Lite3</a></span>
+</p>
+</div>
+      <div id="footer">
+  Generated on Sat Aug 19 13:22:01 2023 by
+  <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.34 (ruby-3.2.1).
+</div>
+    </div>
+  </body>
+</html>

data/lib/internal_lite3/dbm.rb CHANGED Viewed

@@ -1,6 +1,6 @@
 module Lite3
   # Lite3::DBM encapsulates a single table in a single SQLite3
   # database file and lets you access it as easily as a Hash.
   # Multiple instances may be opened on different tables in the same
@@ -202,7 +202,7 @@ module Lite3
     # Begins a transaction, evaluates the given block and then ends
     # the transaction.  If no error occurred (i.e. an exception was
     # thrown), the transaction is committed; otherwise, it is rolled
-    # back.
+    # back.  Returns the block's result.
     #
     # It is safe to call `DBM.transaction` within another
     # `DBM.transaction` block's call chain because `DBM` will not
@@ -220,8 +220,10 @@ module Lite3
     # transactions were always executed in `:deferred` mode via the
     # `sqlite3` gem.
     #
-    # @yield [db] The block takes a reference to the receiver as an
-    #             argument.
+    # @return [obj] Returns the block's result.
+    #
+    # @yield [db]   The block takes a reference to the receiver as an
+    #               argument.
     #
     def transaction(&block)
       return @handle.transaction { block.call(self) }
@@ -265,7 +267,7 @@ module Lite3
     #
     # `key` **must** be a String or a Symbol; Symbols are
     # transparently converted to Strings.
-    #
+    #
     # If it is not present and a block is given, evaluate the block
     # with the key as its argument and return that.
     #
@@ -368,7 +370,7 @@ module Lite3
       }
     end
     # Calls the given block with each key-value pair in the usual
     # order, then return self.  The entire call takes place in its own
     # transaction.

data/lib/internal_lite3/error.rb CHANGED Viewed

@@ -10,18 +10,14 @@ module Lite3
   private
   module ErrUtil
     # Error check: if block evaluates to false, raise a Lite3::DBM::Error
     # with the given message.
     def check(message, &block)
       return if block && block.call
       raise InternalError.new(message)
     end
   end
   private_constant :ErrUtil
 end

data/lib/internal_lite3/handle.rb CHANGED Viewed

@@ -41,7 +41,7 @@ module Lite3
     end
     alias inspect to_s
     #
     # References to the DBM object(s) using this handle.
     #
@@ -85,10 +85,14 @@ module Lite3
     #
     # Transactions
     #
     # Perform &block in a transaction.  See DBM.transaction.
     def transaction(&block)
-      @db.transaction({}, &block)
+      result = nil
+      @db.transaction({}) {
+        result = block.call
+      }
+      return result
     end
     # Test if there is currently a transaction in progress

data/lib/internal_lite3/sql.rb CHANGED Viewed

@@ -64,7 +64,10 @@ module Lite3
     # corresponding `DBM`s have been closed or reclaimed).
     #
     # Returns a hash mapping the path to each open database file to
-    # the number of live DBM objects referencing it.
+    # the number of live DBM objects referencing it.  (Note that DBM
+    # objects that have gone out of scope but are not yet finalized
+    # count as "live"; as a result, this will differ across Ruby
+    # implementations due to differing garbage collector semantics.)
     #
     # You normally won't need to explicitly call this, but it's
     # useful for testing and debugging.

data/spec/dbmlite3_spec.rb CHANGED Viewed

@@ -5,6 +5,10 @@ require_relative '../lib/dbmlite3.rb'
 require 'fileutils'
 require 'set'
+def jruby?
+  return RUBY_PLATFORM == "java"
+end
 module Tmp
   @root = File.join( File.dirname(__FILE__), "tmpdata")
   @count = 0
@@ -468,6 +472,13 @@ Serializations = Set.new
       db.close
     end
+    it "transaction returns the result of the transaction block" do
+      db = newdb.call(Tmp.file, "floop")
+      result = db.transaction { db['foo'] = 42 }
+      expect( result ) .to be 42
+    end
     it "provides the rest of DBM's interface as convenience methods." do
       db = newdb.call(Tmp.file, "blopp")
       vv = {
@@ -877,7 +888,8 @@ describe Lite3::SQL do
   }
   it "lets you close the actual handle without impeding database use" do
-    expect( Lite3::SQL.gc.size ) .to eq 0
+    jruby? or   # JRuby GC semantics throw this off
+      expect( Lite3::SQL.gc.size ) .to eq 0
     file = Tmp.file
     db1 = newbasic.call(file, "first")
@@ -885,14 +897,17 @@ describe Lite3::SQL do
     # The above should be using the same handle, which is currently
     # open.
-    stats = Lite3::SQL.gc
-    expect( stats.keys.size ) .to eq 1
-    # Referencing DBM objects should be db1 and db2
-    path, refs = stats.to_a[0]
-    expect( path ) .to eq file
-    expect( refs ) .to eq 2
+    #
+    # (Depends on GC wierdness so we skip this part for JRuby.)
+    unless jruby?
+      stats = Lite3::SQL.gc
+      expect( stats.keys.size ) .to eq 1
+      # Referencing DBM objects should be db1 and db2
+      path, refs = stats.to_a[0]
+      expect( path ) .to eq file
+      expect( refs ) .to eq 2
+    end
     # We can no longer test if the underlying file handles are still
     # open, so we don't.
@@ -908,7 +923,8 @@ describe Lite3::SQL do
     db1.close
     db2.close
-    expect( Lite3::SQL.gc.keys.size ) .to eq 0
+    jruby? or
+      expect( Lite3::SQL.gc.keys.size ) .to eq 0
   end
   it "allows multiple table accesses in the same transaction" do
@@ -971,6 +987,7 @@ describe Lite3::SQL do
     #
     # (Dropping into the debugger after GC.start seems to help.)
+    skip "JRuby GC is capricious" if jruby?
     file = Tmp.file
     db1 = newbasic.call(file, "first")
@@ -1010,6 +1027,7 @@ end
 describe self do
   it "(this test) closes all handles when done with them" do
+    skip "JRuby GC is capricious"if jruby?
     expect( Lite3::SQL.gc.size ) .to eq 0
   end
 end

metadata CHANGED Viewed

@@ -1,11 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: dbmlite3
 version: !ruby/object:Gem::Version
-  version: 2.0.0.pre.alpha.4
+  version: 2.0.0
 platform: ruby
 authors:
 - Chris Reuter
-autorequire:
+autorequire:
 bindir: bin
 cert_chain: []
 date: 2022-02-21 00:00:00.000000000 Z
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.65.0
+        version: 5.71.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.65.0
+        version: 5.71.0
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -87,7 +87,7 @@ description: |2
       (almost) any Ruby type to be stored.  In addition, there is
       rudimentary support for transactions with emphasis on simplicity
       and safety.
-email: chris@isplitonyourgrave.com
+email: chris@remove-this-part.blit.ca
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -97,7 +97,25 @@ files:
 - README.md
 - Rakefile
 - dbmlite3.gemspec
-- extras/benchmark.rb
+- doc/Lite3.html
+- doc/Lite3/DBM.html
+- doc/Lite3/Error.html
+- doc/Lite3/InternalError.html
+- doc/Lite3/SQL.html
+- doc/_index.html
+- doc/class_list.html
+- doc/css/common.css
+- doc/css/full_list.css
+- doc/css/style.css
+- doc/file.README.html
+- doc/file_list.html
+- doc/frames.html
+- doc/index.html
+- doc/js/app.js
+- doc/js/full_list.js
+- doc/js/jquery.js
+- doc/method_list.html
+- doc/top-level-namespace.html
 - lib/dbmlite3.rb
 - lib/internal_lite3/dbm.rb
 - lib/internal_lite3/error.rb
@@ -109,7 +127,7 @@ homepage: https://codeberg.org/suetanvil/dbmlite3
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -120,13 +138,13 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements:
 - Sequel, sqlite3, Ruby MRI
-rubygems_version: 3.2.15
-signing_key:
+rubygems_version: 3.4.6
+signing_key:
 specification_version: 4
 summary: A DBM-style key-value store using SQLite3
 test_files: []

data/extras/benchmark.rb DELETED Viewed

@@ -1,172 +0,0 @@
-#!/usr/bin/env ruby
-# Low-effort benchmark comparing Lite3::DBM in various modes against
-# other equivalent Hash-like Ruby storage mechanisms.
-require 'dbmlite3'
-require 'yaml/dbm' unless RUBY_PLATFORM == "java"
-require 'fileutils'
-require 'optparse'
-COUNT = 10000
-Opts = proc do
-  opt_defaults = {
-    count: COUNT,
-    transaction_only: true,
-  }
-  opts = Struct.new(*opt_defaults.keys).new(*opt_defaults.values)
-  OptionParser.new do |opo|
-    opo.banner = "Usage: bench_1.rb [options]"
-    opo.on("-t", "--multi-transaction",
-           "Don't batch Lite3 accesses in one big transaction.") {
-      opts.transaction_only = false
-    }
-    opo.on("-c", "--count N", Integer, "Set test count.") { |c|
-      opts.count = c
-    }
-  end.parse!
-  next opts
-end.call
-module Tmp
-  @root = File.join( File.dirname(__FILE__), "tmpdata")
-  @count = 0
-  def self.file
-    FileUtils.mkdir(@root) unless File.directory?(@root)
-    file = "testfile_#{@count}_#{$$}.sqlite3"
-    @count += 1
-    return File.join(@root, file)
-  end
-  def self.cleanup
-    return unless File.directory?(@root)
-    FileUtils.rm_rf(@root)
-  end
-end
-def insert(count, db, offset)
-  for n in 0 .. count
-    db["k_#{n}"] = "#{n + offset}"
-  end
-end
-def lookup(count, db)
-  rnd = Random.new(69_420)
-  sz = db.size
-  for _ in 0 .. count * 3
-    idx = rnd.rand(sz)
-    v = db["k_#{idx}"]
-    raise "Invalid value: #{v}" unless v.to_s == "#{idx + 1}"
-  end
-end
-Times = {}
-def time_it(type, task, db, use_tr, &block)
-  print "#{type} #{task} - "
-  STDOUT.flush
-  start = Time.now
-  if use_tr && db.respond_to?(:transaction)
-    db.transaction { block.call }
-  else
-    block.call
-  end
-  finish = Time.now
-  elapsed = (finish - start).to_f
-  Times[type] = Times.fetch(type, 0) + elapsed
-  puts "#{elapsed.round(4)}"
-end
-def bench(count, desc, db, use_tr)
-  time_it(desc, "insert", db, use_tr) {
-    insert(count, db, 0)
-  }
-  time_it(desc, "upsert", db, use_tr) {
-    insert(count, db, 1)
-  }
-  time_it(desc, "lookup", db, use_tr) {
-    lookup(count, db)
-  }
-  time_it(desc, "delete_if", db, use_tr) {
-    rnd = Random.new(69_420)
-    db.delete_if{|k,v| rnd.rand(2) == 0}
-  }
-  puts
-end
-def main
-  puts "Count = #{Opts.count}\n"
-  Tmp.cleanup
-  bench(Opts.count, "hash", {}, false)
-  if RUBY_PLATFORM != "java"
-    DBM.open(Tmp.file) {|dbm|
-      bench(Opts.count, "DBM", dbm, false)
-    }
-    YAML::DBM.open(Tmp.file) {|dbm|
-      bench(Opts.count, "YAML::DBM", dbm, false)
-    }
-  end
-  Lite3::DBM.open(Tmp.file, "benchmark", :yaml) { |dbm|
-    bench(Opts.count, "Lite3::DBM(yaml)", dbm, true)
-  }
-  Lite3::DBM.open(Tmp.file, "benchmark", :marshal) { |dbm|
-    bench(Opts.count, "Lite3::DBM(marshal)", dbm, true)
-  }
-  Lite3::DBM.open(Tmp.file, "benchmark", :string) { |dbm|
-    bench(Opts.count, "Lite3::DBM(string)", dbm, true)
-  }
-  if !Opts.transaction_only
-    Lite3::DBM.open(Tmp.file, "benchmark", :yaml) { |dbm|
-      bench(Opts.count, "Lite3::DBM(yaml, single-trans)", dbm, false)
-    }
-    Lite3::DBM.open(Tmp.file, "benchmark", :marshal) { |dbm|
-      bench(Opts.count, "Lite3::DBM(marshal, single-trans)", dbm, false)
-    }
-    Lite3::DBM.open(Tmp.file, "benchmark", :string) { |dbm|
-      bench(Opts.count, "Lite3::DBM(string, single-trans)", dbm, false)
-    }
-  end
-  puts
-  puts "Totals:"
-  Times.each{|k,v|
-    puts "    #{k} - #{v.round(4)}"
-  }
-  Tmp.cleanup
-end
-main