ruby-ladybug 0.1.0

data/spec/ladybug/types_spec.rb

@@ -0,0 +1,285 @@
+# -*- ruby -*-
+
+require_relative '../spec_helper'
+
+require 'ladybug'
+
+
+RSpec.describe( "data types" ) do
+
+	let( :db ) { Ladybug.database }
+	let( :connection ) { db.connect }
+
+
+	#
+	# Specs
+	#
+
+	it "converts TIMESTAMP values to Time objects" do
+		result = connection.query( %{RETURN timestamp("1970-01-01 00:00:00.004666-10") as x;} )
+
+		expect( result ).to be_a( Ladybug::Result )
+		expect( result ).to be_success
+
+		value = result.first
+		expect( value ).to include( 'x' )
+
+		x = value['x']
+		expect( x ).to be_a( Time )
+		expect( x.year ).to eq( 1970 )
+		expect( x.month ).to eq( 1 )
+		expect( x.day ).to eq( 1 )
+
+		result.finish
+	end
+
+
+	it "coverts DATE values to Date objects" do
+		result = connection.query( %{RETURN CAST('2025-07-14', 'DATE') as x;} )
+
+		expect( result ).to be_a( Ladybug::Result )
+		expect( result ).to be_success
+
+		value = result.first
+		expect( value ).to include( 'x' )
+
+		x = value['x']
+		expect( x ).to be_a( Date )
+		expect( x.year ).to eq( 2025 )
+		expect( x.month ).to eq( 7 )
+		expect( x.day ).to eq( 14 )
+
+		result.finish
+	end
+
+
+	it "converts STRUCT values to OpenStructs" do
+		result = connection.query( "RETURN {first: 'Adam', last: 'Smith'} AS record;" )
+
+		expect( result ).to be_a( Ladybug::Result )
+		expect( result ).to be_success
+		Ladybug.logger.debug "Result is: %p" % [ result ]
+
+		value = result.first
+		expect( value ).to include( 'record' )
+
+		record = value['record']
+		expect( record ).to be_a( OpenStruct )
+		expect( record.first ).to eq( "Adam" )
+		expect( record.first.encoding ).to eq( Encoding::UTF_8 )
+		expect( record.last ).to eq( "Smith" )
+		expect( record.last.encoding ).to eq( Encoding::UTF_8 )
+
+		result.finish
+	end
+
+
+	it "converts MAP values to Hashes" do
+		result = connection.query( "RETURN map([1, 2], ['a', 'b']) AS m;" )
+
+		expect( result ).to be_a( Ladybug::Result )
+		expect( result ).to be_success
+		Ladybug.logger.debug "Result is: %p" % [ result ]
+
+		value = result.first
+		expect( value ).to include( 'm' )
+
+		record = value['m']
+		expect( record ).to be_a( Hash )
+		expect( record ).to eq({ 1 => 'a', 2 => 'b' })
+
+		result.finish
+	end
+
+
+	it "converts LIST values to Arrays" do
+		result = connection.query( 'RETURN ["Alice", "Bob"] AS l;' )
+
+		expect( result ).to be_a( Ladybug::Result )
+		expect( result ).to be_success
+		Ladybug.logger.debug "Result is: %p" % [ result ]
+
+		value = result.first
+		expect( value ).to include( 'l' )
+
+		record = value['l']
+		expect( record ).to be_an( Array )
+		expect( record ).to eq( ['Alice', 'Bob'] )
+
+		result.finish
+	end
+
+
+	it "converts ARRAY values to Arrays" do
+		result = connection.query( "RETURN CAST([3,4,12,11], 'INT64[4]') as a;" )
+
+		expect( result ).to be_a( Ladybug::Result )
+		expect( result ).to be_success
+		Ladybug.logger.debug "Result is: %p" % [ result ]
+
+		value = result.first
+		expect( value ).to include( 'a' )
+
+		record = value['a']
+		expect( record ).to be_an( Array )
+		expect( record ).to eq( [3, 4, 12, 11] )
+
+		result.finish
+	end
+
+
+	it "converts ARRAYs of LIST values correctly" do
+		result = connection.query( "RETURN CAST([[5,2,1],[2,3],[15,64,74]], 'INT64[][3]') as a;" )
+
+		expect( result ).to be_a( Ladybug::Result )
+		expect( result ).to be_success
+		Ladybug.logger.debug "Result is: %p" % [ result ]
+
+		value = result.first
+		expect( value ).to include( 'a' )
+
+		record = value['a']
+		expect( record ).to be_an( Array )
+		expect( record ).to eq( [ [5, 2, 1], [2, 3], [15, 64, 74] ] )
+
+		result.finish
+	end
+
+
+	it "converts NODE values to Ladybug::Node objects" do
+		connection.run( <<~END_OF_SCHEMA )
+			CREATE NODE TABLE Person(id INT64, name STRING, age INT64, PRIMARY KEY(id));
+			COPY Person FROM 'spec/data/test/Person.csv';
+		END_OF_SCHEMA
+		result = connection.query( "MATCH (a:Person) RETURN a;" )
+
+		expect( result ).to be_a( Ladybug::Result )
+		expect( result ).to be_success
+		expect( result.num_tuples ).to eq( 120 )
+
+		result.each do |value|
+			expect( value ).to include( 'a' )
+
+			node = value['a']
+			expect( node ).to be_a( Ladybug::Node )
+
+			expect( node.properties.keys ).to contain_exactly( :id, :name, :age )
+		end
+
+		result.finish
+	end
+
+
+	it "converts REL values to Ladybug::Rel objects" do
+		connection.run( <<~END_OF_SCHEMA )
+			CREATE NODE TABLE Person(id INT64, name STRING, age INT64, PRIMARY KEY(id));
+			CREATE REL TABLE Follows (from Person to Person, since INT64);
+			COPY Person FROM 'spec/data/test/Person.csv';
+			COPY Follows FROM 'spec/data/test/Follows.csv';
+		END_OF_SCHEMA
+		result = connection.query( "MATCH (a:Person)-[r:Follows]->(b:Person) RETURN r;" )
+
+		expect( result ).to be_a( Ladybug::Result )
+		expect( result ).to be_success
+		expect( result.num_tuples ).to eq( 5 )
+
+		result.each do |value|
+			expect( value ).to include( 'r' )
+
+			rel = value['r']
+			expect( rel ).to be_a( Ladybug::Rel )
+
+			expect( rel.id ).to_not be_nil
+			expect( rel.src_id ).to_not be_nil
+			expect( rel.dst_id ).to_not be_nil
+
+			expect( rel.properties.keys ).to contain_exactly( :since )
+		end
+
+		result.finish
+	end
+
+
+	it "converts RECURSIVE_REL values to Ladybug::RecursiveRel objects" do
+		connection.run( <<~END_OF_SCHEMA )
+			CREATE NODE TABLE Person(id INT64, name STRING, age INT64, PRIMARY KEY(id));
+			CREATE REL TABLE Follows (from Person to Person, since INT64);
+			COPY Person FROM 'spec/data/test/Person.csv';
+			COPY Follows FROM 'spec/data/test/Follows.csv';
+		END_OF_SCHEMA
+		result = connection.query( <<~END_OF_QUERY )
+			MATCH p = (a:Person)-[:Follows]->(b:Person)
+			WHERE a.name = 'Jake Kling' AND b.name = 'Joaquin Schamberger'
+			RETURN p;
+		END_OF_QUERY
+
+		expect( result ).to be_a( Ladybug::Result )
+		expect( result ).to be_success
+
+		result.each do |value|
+			expect( value ).to include( 'p' )
+
+			rel = value['p']
+			expect( rel ).to be_a( Ladybug::RecursiveRel )
+
+			expect( rel.nodes ).to be_an( Array ).and have_attributes( length: 2 )
+			expect( rel.nodes[0] ).to be_a( Ladybug::Node )
+			expect( rel.nodes[0][:name] ).to eq( 'Jake Kling' )
+			expect( rel.nodes[1] ).to be_a( Ladybug::Node )
+			expect( rel.nodes[1][:name] ).to eq( 'Joaquin Schamberger' )
+
+			expect( rel.rels ).to be_an( Array ).and have_attributes( length: 1 )
+			expect( rel.rels[0][:since] ).to eq( 2012 )
+		end
+
+		result.finish
+	end
+
+
+	it "converts UNIONs to something"
+
+
+	it "converts between nil and NULL" do
+		stmt = connection.prepare( "RETURN $the_value AS value;" )
+		result = stmt.execute( the_value: nil )
+
+		expect( result.first ).to eq( {'value' => nil} )
+
+		result.finish
+	end
+
+
+	it "converts UUIDs to Strings" do
+		result = connection.query( "RETURN UUID('A0EEBC99-9C0B-4EF8-BB6D-6BB9BD380A11') as u;" )
+		uuid = result.first['u']
+
+		expect( uuid ).to be_a( String )
+		expect( uuid ).to eq( 'a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11' )
+
+		result.finish
+	end
+
+
+	it "converts DECIMAL types to Float objects" do
+		result = connection.query( %{RETURN CAST(127.3, "DECIMAL(5, 2)") AS d;} )
+		rval = result.first['d']
+
+		expect( rval ).to be_a( Float )
+		expect( rval ).to eq( 127.3 )
+
+		result.finish
+	end
+
+
+	it "converts SERIAL types to Integer objects" do
+		result = connection.query( %{RETURN CAST(133, "SERIAL") AS s;} )
+		rval = result.first['s']
+
+		expect( rval ).to be_an( Integer )
+		expect( rval ).to eq( 133 )
+
+		result.finish
+	end
+
+
+end

data/spec/ladybug_spec.rb

@@ -0,0 +1,83 @@
+#!/usr/bin/env ruby -S rspec
+
+require_relative 'spec_helper'
+require 'ladybug'
+
+
+RSpec.describe( Ladybug ) do
+
+	let( :spec_tmpdir ) do
+		path = tmpfile_pathname()
+		path.mkpath
+		return path
+	end
+
+
+	it "should have a VERSION constant" do
+		expect( subject.const_get('VERSION') ).to_not be_empty
+	end
+
+
+	it "knows what version of Ladybug it's linked with" do
+		expect( described_class.ladybug_version ).to match( /\A\d+\.\d+\.\d+/ )
+	end
+
+
+	it "knows what version of the storage scheme it's using" do
+		result = described_class.storage_version
+
+		expect( result ).to be_an( Integer )
+		expect( result ).to be > 0
+	end
+
+
+	it "can construct an in-memory database with reasonable defaults" do
+		expect( described_class.database ).to be_a( Ladybug::Database )
+	end
+
+
+	it "can construct an in-memory database with a nil path" do
+		expect( described_class.database(nil) ).to be_a( Ladybug::Database )
+	end
+
+
+	it "can construct an in-memory database explicitly" do
+		expect( described_class.database(:memory) ).to be_a( Ladybug::Database )
+	end
+
+
+	it "can construct a on-disk database with reasonable defaults" do
+		filename = spec_tmpdir + 'spec_db'
+		result = described_class.database( filename )
+
+		expect( result ).to be_a( Ladybug::Database )
+		if Ladybug.storage_version <= 38
+			expect( filename ).to be_a_directory
+		else
+			expect( filename ).to be_a_file
+		end
+	end
+
+
+	it "can tell whether a string looks like a path to a Ladybug database" do
+		path = spec_tmpdir + 'spec_db'
+
+		expect {
+			described_class.database( path )
+		}.to change {
+			described_class.is_database?( path.to_s )
+		}.from( false ).to( true )
+	end
+
+
+	it "can tell whether a Pathname looks like a path to a Ladybug database" do
+		path = spec_tmpdir + 'spec_db'
+
+		expect {
+			described_class.database( path )
+		}.to change {
+			described_class.is_database?( path )
+		}.from( false ).to( true )
+	end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,101 @@
+# -*- ruby -*-
+
+require 'pathname'
+require 'simplecov' if ENV['COVERAGE'] || ENV['CI']
+
+require 'tmpdir'
+require 'rspec'
+require 'loggability/spechelpers'
+
+require 'ladybug'
+
+begin
+	require 'observability'
+	$have_observability = true
+
+	Observability::Sender.configure( type: :testing )
+rescue LoadError => err
+	$have_observability = false
+end
+
+
+module Ladybug::SpecHelpers
+
+	# The directory to look in for fixture data
+	TEST_DATA_DIR = Pathname( 'spec/data' ).expand_path
+
+
+
+	### Inclusion callback -- install some hooks
+	def self::included( context )
+
+		context.after( :all ) do
+			Ladybug::SpecHelpers.cleanup_tmpfiles
+		end
+
+		context.before( :each ) do
+			GC.start
+		end
+
+	end
+
+
+	### Clean any files generated during a spec run.
+	def self::cleanup_tmpfiles
+		Pathname( Dir::Tmpname.tmpdir ).children.
+			select{|f| f.basename.to_s.start_with?(/lbug.*\-test\-/) }.
+			each( &:rmtree )
+	end
+
+
+	###############
+	module_function
+	###############
+
+	### Return a Pathname pointing to a temporary file.
+	def tmpfile_pathname( filetype='spec' )
+		return Pathname( Dir::Tmpname.create(['lbug-', '-test-' + filetype]) {} )
+	end
+
+
+	### Return a Pathname containing the path to the test data with the given +name+.
+	def test_data_pathname( name )
+		return TEST_DATA_DIR / name
+	end
+
+
+	### Load and return the contents of the test data with the given +name+.
+	def load_test_data( name )
+		file = test_data_pathname( name )
+		return file.read
+	end
+
+end # module Ladybug::SpecHelpers
+
+
+
+RSpec.configure do |config|
+	config.expect_with :rspec do |expectations|
+		expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+		expectations.syntax = :expect
+	end
+
+	config.mock_with( :rspec ) do |mock|
+		mock.syntax = :expect
+		mock.verify_partial_doubles = true
+	end
+
+	config.disable_monkey_patching!
+	config.example_status_persistence_file_path = "spec/.status"
+	config.filter_run :focus
+	config.filter_run_excluding :observability unless $have_observability
+	config.filter_run_when_matching :focus
+	config.order = :random
+	config.profile_examples = 5
+	config.run_all_when_everything_filtered = true
+	config.shared_context_metadata_behavior = :apply_to_host_groups
+	config.warnings = true
+
+	config.include( Ladybug::SpecHelpers )
+	config.include( Loggability::SpecHelpers )
+end

metadata

@@ -0,0 +1,177 @@
+--- !ruby/object:Gem::Specification
+name: ruby-ladybug
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michael Granger
+bindir: bin
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIEMDCCApigAwIBAgIBAjANBgkqhkiG9w0BAQsFADA+MQwwCgYDVQQDDANnZWQx
+  GTAXBgoJkiaJk/IsZAEZFglGYWVyaWVNVUQxEzARBgoJkiaJk/IsZAEZFgNvcmcw
+  HhcNMjYwMjAyMjExMjQ0WhcNMjcwMjAyMjExMjQ0WjA+MQwwCgYDVQQDDANnZWQx
+  GTAXBgoJkiaJk/IsZAEZFglGYWVyaWVNVUQxEzARBgoJkiaJk/IsZAEZFgNvcmcw
+  ggGiMA0GCSqGSIb3DQEBAQUAA4IBjwAwggGKAoIBgQC/JWGRHO+USzR97vXjkFgt
+  83qeNf2KHkcvrRTSnR64i6um/ziin0I0oX23H7VYrDJC9A/uoUa5nGRJS5Zw/+wW
+  ENcvWVZS4iUzi4dsYJGY6yEOsXh2CcF46+QevV8iE+UmbkU75V7Dy1JCaUOyizEt
+  TH5UHsOtUU7k9TYARt/TgYZKuaoAMZZd5qyVqhF1vV+7/Qzmp89NGflXf2xYP26a
+  4MAX2qqKX/FKXqmFO+AGsbwYTEds1mksBF3fGsFgsQWxftG8GfZQ9+Cyu2+l1eOw
+  cZ+lPcg834G9DrqW2zhqUoLr1MTly4pqxYGb7XoDhoR7dd1kFE2a067+DzWC/ADt
+  +QkcqWUm5oh1fN0eqr7NsZlVJDulFgdiiYPQiIN7UNsii4Wc9aZqBoGcYfBeQNPZ
+  soo/6za/bWajOKUmDhpqvaiRv9EDpVLzuj53uDoukMMwxCMfgb04+ckQ0t2G7wqc
+  /D+K9JW9DDs3Yjgv9k4h7YMhW5gftosd+NkNC/+Y2CkCAwEAAaM5MDcwCQYDVR0T
+  BAIwADALBgNVHQ8EBAMCBLAwHQYDVR0OBBYEFHKN/nkRusdqCJEuq3lgB3fJvyTg
+  MA0GCSqGSIb3DQEBCwUAA4IBgQAQwvsRIJ8FV1bYadOnOg2jcSzZXjt0FVPbOQG9
+  eQ9UM7+bTPU0eRCGZuOPrEp8ROc1s5zwZNFv7qHWv/zWWC6sIj4gEnCZkUugK03k
+  bYDsSlkyjiQ4ApVV00+h/Vhxcw+RLIZuqy2QFl8YAfMJm+JS8G7SuoqpFjbv3UUF
+  vrObIiO7LbhJxpYzTGkGzMFigcnm6vIGMex4AgtArc2RpWOvtAXQrU7CZHUkcdQM
+  4n5eVK+m3IZlD7dd4HoPT2jF2cOGmk8XFclT0GcPVYmEWFFmotN2aiMj4sqVm/Ob
+  V+FmyTUy4gVtcNOFO/sBnFRiQW0fxV9/97Dog9ciYesfiAhm4EpcuTmatdAuMrZR
+  WBmf+jXIub5S7RBw+m0mk2xhmcSkg1vY5w6IEIhSo2e2gE9rA0rIkZO5wP4sCouE
+  XdaRMEnt/AVHUzroBR3CWAz/6ZnDF8GS7EK1bOfM+YWqJL30g7PoxpT+UJTqWJtM
+  CCC1LSoBD7OEUiaIMWUo4h7xWIs=
+  -----END CERTIFICATE-----
+date: 2026-03-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: ostruct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: rake-deveiate
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.25'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.25'
+- !ruby/object:Gem::Dependency
+  name: rdoc-generator-sixfish
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: ruby-lsp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.23'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.23'
+description: A Ruby binding for the LadybugDB embedded graph database.
+email:
+- ged@FaerieMUD.org
+executables: []
+extensions:
+- ext/ladybug_ext/extconf.rb
+extra_rdoc_files: []
+files:
+- History.md
+- LICENSE.txt
+- README.md
+- ext/ladybug_ext/config.c
+- ext/ladybug_ext/connection.c
+- ext/ladybug_ext/database.c
+- ext/ladybug_ext/extconf.rb
+- ext/ladybug_ext/ladybug_ext.c
+- ext/ladybug_ext/ladybug_ext.h
+- ext/ladybug_ext/node.c
+- ext/ladybug_ext/prepared_statement.c
+- ext/ladybug_ext/query_summary.c
+- ext/ladybug_ext/recursive_rel.c
+- ext/ladybug_ext/rel.c
+- ext/ladybug_ext/result.c
+- ext/ladybug_ext/types.c
+- lib/ladybug.rb
+- lib/ladybug/config.rb
+- lib/ladybug/connection.rb
+- lib/ladybug/database.rb
+- lib/ladybug/node.rb
+- lib/ladybug/prepared_statement.rb
+- lib/ladybug/query_summary.rb
+- lib/ladybug/recursive_rel.rb
+- lib/ladybug/rel.rb
+- lib/ladybug/result.rb
+- spec/ladybug/config_spec.rb
+- spec/ladybug/connection_spec.rb
+- spec/ladybug/database_spec.rb
+- spec/ladybug/prepared_statement_spec.rb
+- spec/ladybug/query_summary_spec.rb
+- spec/ladybug/result_spec.rb
+- spec/ladybug/types_spec.rb
+- spec/ladybug_spec.rb
+- spec/spec_helper.rb
+homepage: https://sr.ht/~ged/Ruby-Ladybug
+licenses:
+- BSD-3-Clause
+metadata:
+  homepage_uri: https://sr.ht/~ged/Ruby-Ladybug
+  documentation_uri: https://deveiate.org/code/ruby-ladybug
+  changelog_uri: https://deveiate.org/code/ruby-ladybug/History_md.html
+  source_uri: https://hg.sr.ht/~ged/Ruby-Ladybug
+  bug_tracker_uri: https://todo.sr.ht/~ged/Ruby-Ladybug
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.3
+specification_version: 4
+summary: A Ruby binding for the LadybugDB embedded graph database.
+test_files: []