ruby-kuzu 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7efba3eca4a268d102e73e5d356fcdd530b40a5cc4cdeadf8089ef6ef7eb54b5
-  data.tar.gz: 473c82d2a4ceaa1c6b9a21a8c031382ca689f0954f941778473319c75271af8b
+  metadata.gz: 23c8abe4e594088573be5779b99b9a4670fc29722ab0840bf23b2eee5320ab26
+  data.tar.gz: 83d38c89dcadedcf493668246b9ce024380497941e70d0babecaeadd9d0f66b4
 SHA512:
-  metadata.gz: 8a8f267516b68f4ab6684f9a9d3b7df2d49b4788d45140649128d83547f27ee696d2f6359428448b72a48cdafde8126830d7ebe6ec0e292f5b188ec1bb96e8ce
-  data.tar.gz: 996a8d10076b0452fad789ae564c640af8b77c52df5d157aed6a38ef7d0001034cf35976b69d22f25333f289284c9526d2a95fd9ffa53a737d9c46878d357a83
+  metadata.gz: '04881e4a458dff96f29cde3a6c761848f868f9aa19e093dd21899a6f374ca5783ae3d967f6900f95ed59618a0f7ab242a8cbdbbd37366a045488ac64b5e3bbe4'
+  data.tar.gz: 1071575ae8d53bcc79d5a4cdacfe1d94b13d7e5b8c6e93301c7c5ea0ba922797594ddb5efbcee14c4bcf6721aab81a0e713de2c83380ddc12392d7e58b97922d

data/History.md

@@ -1,6 +1,15 @@
 # Release History for ruby-kuzu
 
 ---
+
+## v0.0.2 [2025-05-15] Michael Granger <ged@FaerieMUD.org>
+
+Fixes:
+
+- Fix an RDoc failure
+- Add a bit more documentation
+
+
 ## v0.0.1 [2025-05-01] Michael Granger <ged@FaerieMUD.org>
 
 Initial release

data/README.md

@@ -17,7 +17,36 @@ docs
 
 A Ruby binding for the Kùzu embedded graph database.
 
-### Connecting To/Creating A Database
+
+### Creating A Database and Connecting To It
+
+To create an in-memory database:
+
+    database = Kuzu.database
+    # => #<Kuzu::Database:0x000000012917ec68 path:nil read-only:false>
+
+Or explicitly via an empty string:
+
+    database = Kuzu.database( '' )
+    # => #<Kuzu::Database:0x000000012144edb0 path:nil read-only:false>
+
+If you pass a non-empty string, it is assumed to be the path to a database:
+
+    database = Kuzu.database( 'path/to/mydb' )
+    # => #<Kuzu::Database:0x0000000121624d10 path:"path/to/mydb" read-only:false>
+
+There's also support for passing configuration options to the database
+handle as keyword arguments to the `.database` method:
+
+    database = Kuzu.database( 'mydb', read_only: true )
+    # => #<Kuzu::Database:0x00000001227aa5a8 path:"mydb" read-only:true>
+
+Once you have a Kuzu::Database object, you need a connection to actually use it:
+
+    conn = db.connect
+    # => #<Kuzu::Connection:0x0000000122a41f28 threads:16>
+
+
 
 ### Querying
 

data/lib/kuzu.rb

@@ -11,7 +11,7 @@ module Kuzu
 
 
 	# Library version
-	VERSION = '0.0.1'
+	VERSION = '0.0.2'
 
 
 	# Set up a logger for Kuzu classes
@@ -75,5 +75,3 @@ module Kuzu
 
 end # module Kuzu
 
-# Fancy alias
-Kùzu = Kuzu

data/spec/kuzu/types_spec.rb

@@ -31,7 +31,7 @@ RSpec.describe( "data types" ) do
 		expect( x.day ).to eq( 1 )
 
 		result.finish
-end
+	end
 
 
 	it "converts STRUCT values to OpenStructs" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-kuzu
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Michael Granger
@@ -34,7 +34,7 @@ cert_chain:
   8qAqdfV+4u6Huu1KzAuDQCheyEyISsLST37sU/irV3czV6BiFipWag1XiJciRT3A
   wZqCfTNVHTdtsCbfdA1DsA3RdG2iEH3TOHzv1Rqzqh4=
   -----END CERTIFICATE-----
-date: 2025-05-13 00:00:00.000000000 Z
+date: 2025-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake-compiler