gloo-sqlite 1.4 → 1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c91d85a4fa16e10d1d47166aa8397246a4c6015a8a260023bb905d513eebc881
-  data.tar.gz: 42c48e02697430e7a3aa7922a0772a5060d153c14f5d6188e8ae4718f78c103b
+  metadata.gz: 898b3e180f152ac26fb226f77030e2f3217b0a3a382465e07856cb1d0759e224
+  data.tar.gz: 60d2b107df04b32b3dfa8ca8d4eedc9724c9f3bba0ef16a5c4dff97a11e91558
 SHA512:
-  metadata.gz: 295488d614f14d56ec3821084caa1f78f71a864cc9f289b6e2e8d42643fe9a62dcd2ef4bfedbc3ef23ddc08b0bfb84a074380487bdc149271f9794473d1fe695
-  data.tar.gz: 0713fb14a914a7bbb709bd2fcce02b233adc9c1d3e10c9196d1796e8a9b330eca5c87107f32362251f79b4153d8ef4c92bc91be88e11f9b1e995d4aa4513276f
+  metadata.gz: ca86fe1d4d42834e656e2132fe37e7ef683df49fd4fc611c6908ffc25328cd195b4edab30616dba8c80954d408f20de2fb83653e14ab1bbf3217f3b09b0dc5c1
+  data.tar.gz: e6b11b592cde0167104d0f66b420b98c538606a46456adf8b233f77f1672c917d64fac8c7057036119017a5a7efc273a99912b154d7fa705e3c44b4ca15aaf36

data/lib/sqlite.rb

@@ -16,9 +16,13 @@
 # replace `db.query()` with `db.get_first_value()`.
 #
 require 'sqlite3'
+require 'db_connection'
 
 class Sqlite < Gloo::Core::Obj
 
+  # Shared driver behaviour from gloo-db: errors, verify, setup problems.
+  include DbConnection
+
   KEYWORD = 'sqlite'.freeze
   KEYWORD_SHORT = 'sqlite'.freeze
 
@@ -93,9 +97,22 @@ class Sqlite < Gloo::Core::Obj
       return
     end
 
-    return unless connects?
+    verify_connection do
+      db = SQLite3::Database.open name
+      begin
+        db.get_first_value "SELECT COUNT(name) FROM sqlite_master WHERE type='table'"
+      ensure
+        db.close
+      end
+    end
+  end
 
-    @engine.heap.it.set_to true
+  #
+  # The exception classes that are database errors (DbConnection):
+  # Query reports these as 'Query failed: …'.
+  #
+  def database_errors
+    return [ SQLite3::Exception ]
   end
 
   # ---------------------------------------------------------------------
@@ -108,28 +125,32 @@ class Sqlite < Gloo::Core::Obj
   #
   def query( sql, params = nil )
     name = db_value
-    unless name
-      @engine.err DB_REQUIRED_ERR
-      return
-    end
+    return setup_err( DB_REQUIRED_ERR ) if name.empty?
 
+    # A database file that doesn't exist is created.
     db = SQLite3::Database.open name
-    # db.results_as_hash = true
-    results = db.query( sql, params )
-
-    return results
+    begin
+      results = db.query( sql, params )
+
+      rows = []
+      while ( row = results.next ) do
+        rows << row
+      end
+
+      # Return [ column names, rows ] - the same shape as gloo-mysql and
+      # gloo-pg, so callers (Query, Table) can treat every backend alike.
+      return [ results.columns, rows ]
+    ensure
+      results&.close
+      db.close
+    end
   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 )
+    return QueryResult.new( result[0], result[1], @engine )
   end
 
 
@@ -141,30 +162,13 @@ class Sqlite < Gloo::Core::Obj
 
   #
   # Get the Database file from the child object.
-  # Returns nil if there is none.
+  # Returns '' if there is none.
   #
   def db_value
     o = find_child DB
-    return nil unless o
+    return '' 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
+    return o.value.to_s
   end
 
   # ---------------------------------------------------------------------
@@ -180,10 +184,10 @@ class Sqlite < Gloo::Core::Obj
       :shortcut => KEYWORD_SHORT,
       :description => 'A Sqlite3 database connection.',
       :children => [
-        "database (string) — Default: '#{DEFAULT_DB}'. The path to the database file."
+        "database (string) — Default: '#{DEFAULT_DB}'. The path to the database file. A query on a file that does not exist creates a new, empty database there."
       ],
       :messages => [
-        'verify — Verify that the database connection can be established.'
+        'verify — Verify that the database connection can be established. It is true if it can, false if not: no database name, a file that does not exist, or a file that is not a database (with the reason in the error).'
       ],
       :examples => <<~EXAMPLES.strip
         sqlite [can] :

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gloo-sqlite
 version: !ruby/object:Gem::Version
-  version: '1.4'
+  version: '1.6'
 platform: ruby
 authors:
 - Eric Crane
@@ -29,6 +29,88 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.4.2
+- !ruby/object:Gem::Dependency
+  name: gloo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: gloo-db
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.14.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.14.2
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.0.1
 description: Adds SQLite support to Gloo.
 email:
 - eric.crane@mac.com