gloo-mysql 1.0 → 1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: beba2426ad60ec2727ed3486d9187bd19a47886316aa7e2eead82035f2c6f10e
-  data.tar.gz: 9b7c4869ff4e00bad57da63bdd0af0862230e9c3b03f3e7188fdf99a9282a7a5
+  metadata.gz: e9d45a88a3a1eb006e70be0d3b54874923e1f4dd02ac2f3c297cd1921975d1f9
+  data.tar.gz: b5e02252e4201e5ded230d69171304126c287570b3cd0c8af2e02cf742a3e26c
 SHA512:
-  metadata.gz: c1f304466d3ee1f9cb1f4295d6bfc3b1adf1cab8c95fda234d1feba698efddf97251beb837ffcd9da4b1f7760b8869bbcff22eb6006e8ec41184bef90c2bfc98
-  data.tar.gz: d9893e456e7c933a4d4f6e7e456e1f079f13f577c8754ef426b3a53d83ba51bc745a0a6c166da54df339e9467b89392a3b0f152946f5025ca262582f09e9aa35
+  metadata.gz: 5b1addd1be16de2b24a32cdd92b8d5048483370c291315409eae5bd247c6479428a5c3968392ec4d2bcf1afe6495a868a180d7937b0f75322d4c12c201b117cf
+  data.tar.gz: cf786e9a6d8ab705f5d679e97ee55b57a1c9c1ca05e262ac95c651a3e9265c3c080513ca33188eace2a4a9ac2bf946c11e77011d06b5594df5c436c2a804a7d7

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

@@ -247,4 +247,45 @@ class Mysql < Gloo::Core::Obj
     return true
   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.'
+      ],
+      :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.1'
 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
@@ -37,14 +36,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 +59,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: []