gloo-db 1.1 → 1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 778e0ec24cdb55d18047a73c5d5b125b1c9e079b378b7e8611a90890cf66ba8b
-  data.tar.gz: 30d8e53743f29cd3aa24f58e93fcd475c29ad8150f3c6377500a8c48eaae0c4e
+  metadata.gz: a5f869d21a951e0e316359c444255d44fdae07b64bf9991eb1739ba9df90431c
+  data.tar.gz: 64f9bc0c6aeb28f99779a9addacbf3fbc4bcb3265c3b096d93c9db8d19b5c40e
 SHA512:
-  metadata.gz: 8922b35f3b17002743dfd0d8366ccda1ebff342e78adcd5a1d60cb37cd3723a16ff4f0c6db4227f342a3067c57ee97aa1efc1a94f447c906909a8eeb6e45f1b2
-  data.tar.gz: 10e12ef81de0fa63e309bff21257c3f9f66ffb66dc62f9b4001d2cc275ef402676aac3e88806a0da9a8a069561bc75bdc7f30349023e5aeaf30b1281c89f8b01
+  metadata.gz: e7af37a53fdc0b250306bf723ae92181cca7958aa7dedbf78c61e1f9c660bcc3ee1f46ac52082df6647a3f55ea077ac05ebf659dd309f7c5900348521d71b035
+  data.tar.gz: 25b3ec859468892ac5ed7572790b6400259e52241eca8ef18e0170f6db0cc0fa3a683bb6c27903efbd2513cd0ea4a18a2653ad0e011ccbb3a7e87c3e76641193

data/README.md

@@ -0,0 +1,23 @@
+# gloo-db
+
+A core gloo library for database operations.
+
+Use this library and one of the database-specific driver libraries (`gloo-pg`, `gloo-mysql`, `gloo-sqlite`) to interact with databases.
+
+## Usage
+
+Load this library, plus a driver, in a gloo script:
+
+```gloo
+> load lib db
+> load lib sqlite
+```
+
+## Objects
+
+- `query` — a SQL query (SELECT, INSERT, UPDATE, or other statement)
+- `table` — a data table
+
+## Full Reference
+
+Every object's children and messages are documented in-app once the library is loaded — e.g. `help> object query`.

data/lib/query.rb

@@ -262,4 +262,38 @@ class Query < Gloo::Core::Obj
     end
   end
 
+  # ---------------------------------------------------------------------
+  #    Object Documentation
+  # ---------------------------------------------------------------------
+
+  #
+  # Get the object's documentation data.
+  #
+  def self.doc_data
+    {
+      :name => KEYWORD,
+      :shortcut => KEYWORD_SHORT,
+      :description => 'A SQL Query — a SELECT, INSERT, UPDATE or other ' \
+        'SQL statement. The query requires a valid database connection.',
+      :children => [
+        'database (alias) — Reference to the database we\'re going to query.',
+        'sql (string) — The SQL query to execute.',
+        'result (container) — Optional. The result of the query will be a container for each row, with an object for each column. If not present, results are displayed in the console instead.',
+        'params (container) — Optional list of parameters for the query.'
+      ],
+      :messages => [
+        'run — Run the query and get back the data.'
+      ],
+      :examples => <<~EXAMPLES.strip
+        sqlite [can] :
+          on_load [script] : run sqlite.sql
+          db [sqlite] :
+            database : test.db
+          sql [query] :
+            database [alias] : sqlite.db
+            sql : SELECT id, key, value FROM key_values
+      EXAMPLES
+    }
+  end
+
 end

data/lib/table.rb

@@ -266,4 +266,51 @@ class Table < Gloo::Core::Obj
     return columns.sort_by { |hsh| hsh[ :display_index ] }
   end
 
+  # ---------------------------------------------------------------------
+  #    Object Documentation
+  # ---------------------------------------------------------------------
+
+  #
+  # Get the object's documentation data.
+  #
+  def self.doc_data
+    {
+      :name => KEYWORD,
+      :shortcut => KEYWORD_SHORT,
+      :description => 'A data table.',
+      :children => [
+        'headers (container) — A list of headers. The name of each header object must match the name of the object in the data container; the value of the header is what will be displayed.',
+        'data (container) — The table\'s data. Contains one or more containers, each representing one row of data.',
+        'cells (container) — Optional. If present, cells can be formatted with a child per column you want to format; you don\'t need to specify a child for every column.',
+        'always_rows (boolean) — Optional. By default, if a table\'s data is only 1 row, it shows that row in a vertical table. Marking this true means a horizontal table is shown even if only one row is returned.'
+      ],
+      :messages => [
+        'show — Show the contents of the table in the CLI.'
+      ],
+      :examples => <<~EXAMPLES.strip
+        t [tbl] :
+          on_load [script] :
+            tell t to show
+          headers [can] :
+            name : Name
+            phone : Tel
+            notes : Notes
+          data [alias] : table_data
+        table_data [can] :
+          1 [can] :
+            name : Joe
+            phone : 312-555-1212
+            notes : Play golf with Joe
+          2 [can] :
+            name : Sally
+            phone : 708-555-1212
+            notes : met Sally at the meetup last week
+          3 [can] :
+            name : Frank
+            phone : 312-555-1213
+            notes : Frank Lee Speaking
+      EXAMPLES
+    }
+  end
+
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: gloo-db
 version: !ruby/object:Gem::Version
-  version: '1.1'
+  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: []
 description: Adds database support to Gloo.
 email:
@@ -17,16 +16,17 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
 - lib/gloo-db.rb
 - lib/query.rb
 - lib/query_result.rb
 - lib/table.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
@@ -41,8 +41,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. Database support.
 test_files: []