gloo-sqlite 1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 358f0d80e1879440453c4c01311f055fefb9a87e92125ccc42122dcb6905c62c
+  data.tar.gz: 01ff74b4fad261755fb71a12c8f2666b890399404a4545cbc63f2990003701ba
+SHA512:
+  metadata.gz: 94194965ec358dee75e36af958f95b8429e92439159e9753762452d6097129a17589c263befcefdf45a12f8b3cdcc972711bf17c079997e9860b9e0adc4d6fe7
+  data.tar.gz: 79f858e490a8441d4d9e4c7b062f32191cad2f352c5e698017f90003138b68881647f16c830cfc2884510fe18dd783b93cf1c1fcc55f8e65765fdebdaa35742f

data/lib/gloo-sqlite.rb

@@ -0,0 +1,20 @@
+# 
+# Shim to allow `require 'gloo-sqlite'`
+# 
+# This file is loaded when someone does `require 'gloo-sqlite'`
+# 
+require 'sqlite3'
+
+# 
+# Registers the extension.
+# 
+class SqliteInit < Gloo::Plugin::Base
+
+    # 
+    # Register verbs and objects.
+    # 
+    def register( callback )
+      callback.register_obj( Sqlite )
+    end
+
+end

data/lib/sqlite.rb

@@ -0,0 +1,170 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2020 Eric Crane.  All rights reserved.
+#
+# A Sqlite3 database connection.
+#
+# https://www.rubydoc.info/gems/sqlite3/1.3.11
+# https://www.devdungeon.com/content/ruby-sqlite-tutorial
+#
+# db.results_as_hash = true
+#   Set results to return as Hash object.
+#   This is slower but offers a huge convenience.
+#   Consider turning it off for high performance situations.
+#   Each row will have the column name as the hash key.
+#
+# # Alternatively, to only get one row and discard the rest,
+# replace `db.query()` with `db.get_first_value()`.
+#
+require 'sqlite3'
+
+class Sqlite < Gloo::Core::Obj
+
+  KEYWORD = 'sqlite'.freeze
+  KEYWORD_SHORT = 'sqlite'.freeze
+
+  DB = 'database'.freeze
+  DEFAULT_DB = 'test.db'.freeze
+
+  DB_REQUIRED_ERR = 'The database name is required!'.freeze
+  DB_NOT_FOUND_ERR = 'The database file was not found!'.freeze
+
+  #
+  # The name of the object type.
+  #
+  def self.typename
+    return KEYWORD
+  end
+
+  #
+  # The short name of the object type.
+  #
+  def self.short_typename
+    return KEYWORD_SHORT
+  end
+
+  # ---------------------------------------------------------------------
+  #    Children
+  # ---------------------------------------------------------------------
+
+  #
+  # Does this object have children to add when an object
+  # is created in interactive mode?
+  # This does not apply during obj load, etc.
+  #
+  def add_children_on_create?
+    return true
+  end
+
+  #
+  # Add children to this object.
+  # This is used by containers to add children needed
+  # for default configurations.
+  #
+  def add_default_children
+    fac = @engine.factory
+    fac.create_string DB, DEFAULT_DB, self
+  end
+
+  # ---------------------------------------------------------------------
+  #    Messages
+  # ---------------------------------------------------------------------
+
+  #
+  # Get a list of message names that this object receives.
+  #
+  def self.messages
+    return super + [ 'verify' ]
+  end
+
+  #
+  # Verify access to the Sqlite database specified.
+  #
+  def msg_verify
+    name = db_value
+    if name.empty?
+      @engine.err DB_REQUIRED_ERR
+      @engine.heap.it.set_to false
+      return
+    end
+
+    unless File.exist? name
+      @engine.err DB_NOT_FOUND_ERR
+      @engine.heap.it.set_to false
+      return
+    end
+
+    return unless connects?
+
+    @engine.heap.it.set_to true
+  end
+
+  # ---------------------------------------------------------------------
+  #    DB functions (all database connections)
+  # ---------------------------------------------------------------------
+
+  #
+  # Open a connection and execute the SQL statement.
+  # Return the resulting data.
+  #
+  def query( sql, params = nil )
+    name = db_value
+    unless name
+      @engine.err DB_REQUIRED_ERR
+      return
+    end
+
+    db = SQLite3::Database.open name
+    # db.results_as_hash = true
+    results = db.query( sql, params )
+
+    return results
+  end
+
+  # 
+  # Based on the result set, build a QueryResult object.
+  # 
+  def get_query_result( result )
+    rows = []        
+    while ( row = result.next ) do
+      rows << row
+    end
+
+    return QueryResult.new( result.columns, rows )
+  end
+
+
+  # ---------------------------------------------------------------------
+  #    Private functions
+  # ---------------------------------------------------------------------
+
+  private
+
+  #
+  # Get the Database file from the child object.
+  # Returns nil if there is none.
+  #
+  def db_value
+    o = find_child DB
+    return nil unless o
+
+    return o.value
+  end
+
+  #
+  # Try the connection and make sure it works.
+  # Returns true if we can connect and do a query.
+  #
+  def connects?
+    begin
+      db = SQLite3::Database.open db_value
+      sql = "SELECT COUNT(name) FROM sqlite_master WHERE type='table'"
+      db.get_first_value sql
+    rescue => e
+      @engine.log_exception e
+      @engine.heap.it.set_to false
+      return false
+    end
+    return true
+  end
+
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: gloo-sqlite
+version: !ruby/object:Gem::Version
+  version: '1.0'
+platform: ruby
+authors:
+- Eric Crane
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-01-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.2
+description: Adds SQLite support to Gloo.
+email:
+- eric.crane@mac.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/gloo-sqlite.rb
+- lib/sqlite.rb
+homepage: https://gloo.ecrane.us/
+licenses:
+- MIT
+metadata:
+  gloo.type: core-library
+post_install_message:
+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: 3.5.16
+signing_key:
+specification_version: 4
+summary: Gloo core library. SQLite support.
+test_files: []