gloo-mysql 1.0 → 1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: beba2426ad60ec2727ed3486d9187bd19a47886316aa7e2eead82035f2c6f10e
-  data.tar.gz: 9b7c4869ff4e00bad57da63bdd0af0862230e9c3b03f3e7188fdf99a9282a7a5
+  metadata.gz: 1a1b5f86ddb44b51299e14599208fb5276529e7675e47decdee1d7572ce28745
+  data.tar.gz: 3589a40a1974de5cc576471bfbe5e73008b887157a851f9cde8ee834ed9ce224
 SHA512:
-  metadata.gz: c1f304466d3ee1f9cb1f4295d6bfc3b1adf1cab8c95fda234d1feba698efddf97251beb837ffcd9da4b1f7760b8869bbcff22eb6006e8ec41184bef90c2bfc98
-  data.tar.gz: d9893e456e7c933a4d4f6e7e456e1f079f13f577c8754ef426b3a53d83ba51bc745a0a6c166da54df339e9467b89392a3b0f152946f5025ca262582f09e9aa35
+  metadata.gz: 4778f6a9ec72070177b2059267d8421998c7b11f181594211ac9f49daa3c6b2ec2fa2f8105050ea615e285a416f52d317cc3d2017fafedbff36e38285944f990
+  data.tar.gz: 18bd34ada82a4fffb813066d3384f7d04f26010c2ddd3e7a149d048bec5423ac92d297162090538276221380131bf8123c62398eb45c57b7ef0f4e96673b9542

data/README.md

@@ -0,0 +1,22 @@
+# gloo-mysql
+
+A core gloo library for mysql.
+
+Use alongside `gloo-db` — this gem provides the MySQL driver, `gloo-db` provides `query`/`table`.
+
+## Usage
+
+Load this library in a gloo script:
+
+```gloo
+> load lib db
+> load lib mysql
+```
+
+## Objects
+
+- `mysql` — a MySQL database connection
+
+## Full Reference
+
+The object's children and messages are documented in-app once the library is loaded — `help> object mysql`.

data/lib/mysql.rb

@@ -17,9 +17,13 @@
 #   flags    = opts[:flags] || 0
 #
 require 'mysql2'
+require 'db_connection'
 
 class Mysql < Gloo::Core::Obj
 
+  # Shared driver behaviour from gloo-db: errors, verify, setup problems.
+  include DbConnection
+
   KEYWORD = 'mysql'.freeze
   KEYWORD_SHORT = 'mysql'.freeze
 
@@ -80,12 +84,22 @@ class Mysql < Gloo::Core::Obj
   end
 
   #
-  # SSH to the host and execute the command, then update result.
+  # Verify that the database connection can be established.
+  # It is true if it can, false if not (with the reason in the error).
   #
   def msg_verify
-    return unless connects?
+    verify_connection do
+      client = Mysql2::Client.new( connection_params )
+      client.close
+    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 [ Mysql2::Error ]
   end
 
 
@@ -112,13 +126,7 @@ class Mysql < Gloo::Core::Obj
       @engine.log.debug "Opening a new Connection."
     end
 
-    h = {
-      host: host_value,
-      database: db_value,
-      username: user_value,
-      password: passwd_value
-    }
-    client = Mysql2::Client.new( h )
+    client = Mysql2::Client.new( connection_params )
 
     app.cache_db_client( self, client ) if app
     
@@ -134,33 +142,30 @@ class Mysql < Gloo::Core::Obj
 
     heads = []
     data = []
-    begin
-      if params
-        pst = client.prepare( sql )
-        rs = pst.execute( *params, :as => :array )
-        if rs
-          rs.each do |row|
-            arr = []
-            row.each do |o| 
-              arr << o
-            end
-            data << arr
+    # Database errors come out as exceptions, for Query to report.
+    if params
+      pst = client.prepare( sql )
+      rs = pst.execute( *params, :as => :array )
+      if rs
+        rs.each do |row|
+          arr = []
+          row.each do |o| 
+            arr << o
           end
+          data << arr
         end
-      else
-        rs = client.query( sql, :as => :array ) 
-        if rs
-          rs.each do |row|
-            data << row
-          end
+      end
+    else
+      rs = client.query( sql, :as => :array ) 
+      if rs
+        rs.each do |row|
+          data << row
         end
       end
-
-      heads = rs.fields if rs
-    rescue => e
-      @engine.log_exception e
     end
 
+    heads = rs.fields if rs
+
     return [ heads, data ]
   end
 
@@ -227,24 +232,56 @@ class Mysql < Gloo::Core::Obj
   end
 
   #
-  # Try the connection and make sure it works.
-  # Returns true if we can establish a connection.
+  # The settings for a connection, from the children.
   #
-  def connects?
-    begin
-      h = {
-        host: host_value,
-        database: db_value,
-        username: user_value,
-        password: passwd_value
-      }
-      Mysql2::Client.new( h )
-    rescue => e
-      @engine.log_exception e
-      @engine.heap.it.set_to false
-      return false
-    end
-    return true
+  def connection_params
+    return {
+      host: host_value,
+      database: db_value,
+      username: user_value,
+      password: passwd_value
+    }
+  end
+
+  # ---------------------------------------------------------------------
+  #    Object Documentation
+  # ---------------------------------------------------------------------
+
+  #
+  # Get the object's documentation data.
+  #
+  def self.doc_data
+    {
+      :name => KEYWORD,
+      :shortcut => KEYWORD_SHORT,
+      :description => 'A MySQL database connection.',
+      :children => [
+        'host (string) — The database server host.',
+        'database (string) — The name of the database.',
+        'username (string) — The username with which to connect.',
+        "password (string) — The user's password."
+      ],
+      :messages => [
+        'verify — Verify that the database connection can be established. It is true if it can, false if not (with the reason in the error).'
+      ],
+      :examples => <<~EXAMPLES.strip
+        mysql [can] :
+          on_load [script] :
+            run mysql.get_passwd
+            run mysql.sql
+          db [mysql] :
+            host : localhost
+            database : my_database
+            username : my_user
+            password [alias] : mysql.get_passwd.result
+          sql [query] :
+            database [alias] : mysql.db
+            sql : SELECT first, last, phone FROM people
+          get_passwd [ask] :
+            prompt [string] : Database Password?
+            result [string] :
+      EXAMPLES
+    }
   end
 
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: gloo-mysql
 version: !ruby/object:Gem::Version
-  version: '1.0'
+  version: '1.2'
 platform: ruby
 authors:
 - Eric Crane
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-02-06 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mysql2
@@ -30,6 +29,88 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.5.3
+- !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 MySQL support to Gloo.
 email:
 - eric.crane@mac.com
@@ -37,14 +118,15 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
 - lib/gloo-mysql.rb
 - lib/mysql.rb
-homepage: https://gloo.ecrane.us/
+homepage: https://github.com/ecrane/gloo
 licenses:
 - MIT
 metadata:
   gloo.type: core-library
-post_install_message:
+  documentation_uri: https://github.com/ecrane/gloo
 rdoc_options: []
 require_paths:
 - lib
@@ -59,8 +141,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.16
-signing_key:
+rubygems_version: 4.0.17
 specification_version: 4
 summary: Gloo core library. MySQL support.
 test_files: []