gloo-db 1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8103ee6d8fd76866fec307a477c10bc663ab8a4ec22630d7c6a7ac84a504ffc7
+  data.tar.gz: de20b8674829888238469725e8243ab78427fb1019ae6769546c38214bf3a094
+SHA512:
+  metadata.gz: c358924ba730e80f0ee3102db7edae06e4efd9e20a67029fd2687dfe170583ee3229857c90b897d447cf276f6a5d45b1f5b1e1c756058be855968ef9708dd90f
+  data.tar.gz: 62bed0c0675a00d55f28e830795a65f47653534002b9a1cfe87d456b395e9ecdd0912b0c8d20d76f939d523036f2bdcb98ce3cf99a05ab3133e6ffee110a7599

data/lib/gloo-db.rb

@@ -0,0 +1,23 @@
+# 
+# Shim to allow `require 'gloo-mysql'`
+# 
+# This file is loaded when someone does `require 'gloo-mysql'`
+# 
+require 'query'
+require 'query_result'
+require 'table'
+
+# 
+# Registers the extension.
+# 
+class DbInit < Gloo::Plugin::Base
+
+    # 
+    # Register verbs and objects.
+    # 
+    def register( callback )
+      callback.register_obj( Query )
+      callback.register_obj( Table )
+    end
+
+end

data/lib/query.rb

@@ -0,0 +1,265 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2020 Eric Crane.  All rights reserved.
+#
+# A SQL database query.
+# Relies on a database connection object.
+#
+
+class Query < Gloo::Core::Obj
+
+  KEYWORD = 'query'.freeze
+  KEYWORD_SHORT = 'sql'.freeze
+
+  DB = 'database'.freeze
+  SQL = 'sql'.freeze
+  RESULT = 'result'.freeze
+  PARAMS = 'params'.freeze
+  SIMPLE_LIST = 'simple_list'.freeze
+
+  DB_MISSING_ERR = 'The database connection is missing!'.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
+
+  # 
+  # Get the result container if it exists.
+  # 
+  def get_result_can
+    result_can = find_child RESULT
+    result_can = Gloo::Objs::Alias.resolve_alias( @engine, result_can )
+    return result_can
+  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_alias DB, nil, self
+    fac.create_string SQL, nil, self
+    fac.create_can RESULT, self
+  end
+
+  # ---------------------------------------------------------------------
+  #    Messages
+  # ---------------------------------------------------------------------
+
+  #
+  # Get a list of message names that this object receives.
+  #
+  def self.messages
+    return super + [ 'run' ]
+  end
+
+  #
+  # Run the query and process the results.
+  #
+  def msg_run
+    db = db_obj
+    return unless db
+
+    begin
+      clear_results
+
+      log_query sql_value, param_array
+      result = db.query( sql_value, param_array )
+      process_result( result, db )
+    rescue => e
+      @engine.log_exception e
+      return
+    end
+  end
+
+  #
+  # Run the query and return the results.
+  #
+  def run_query
+    db = db_obj
+    return unless db
+
+    begin
+      log_query sql_value, param_array
+
+      db_start = ::Time.now
+      result = db.query( sql_value, param_array )
+      db_done = ::Time.now
+      elapsed = ( ( db_done - db_start ) * 1000.0 ).round(2)
+
+      app = @engine.running_app
+      app.add_db_time elapsed if app
+      return result
+    rescue => e
+      @engine.log_exception e
+      return
+    end
+  end
+
+  # 
+  # Write the query to the log.
+  # 
+  def log_query sql, params
+    @engine.log.info "SQL PARAMS: #{params}" if params
+    @engine.log.info "SQL: #{sql}"
+  end
+
+
+  # ---------------------------------------------------------------------
+  #    Output as simple list
+  # ---------------------------------------------------------------------
+
+  # 
+  # Should the output be put in a simple list?
+  # 
+  def simple_list?
+    o = find_child SIMPLE_LIST
+    return false unless o
+
+    return o.value
+  end
+
+
+  # ---------------------------------------------------------------------
+  #    Private functions
+  # ---------------------------------------------------------------------
+
+  private
+
+  #
+  # Get the database connection.
+  #
+  def db_obj
+    o = find_child DB
+
+    unless o
+      @engine.err DB_MISSING_ERR
+      return nil
+    end
+
+    return Gloo::Objs::Alias.resolve_alias( @engine, o )
+  end
+
+  #
+  # Get the SQL from the child object.
+  # Returns nil if there is none.
+  #
+  def sql_value
+    o = find_child SQL
+    return nil unless o
+
+    o = Gloo::Objs::Alias.resolve_alias( @engine, o )
+    return o.value
+  end
+
+  #
+  # Do something with the result of the SQL Query call.
+  # If there's a result container, we'll create objects in it.
+  # If not, we'll just show the output in the console.
+  #
+  def process_result( result, db )
+    return if result.nil?
+
+    query_result = db.get_query_result( result )
+    return unless query_result
+    return unless query_result.has_data_to_show?
+
+    result_can = get_result_can
+
+    if result_can
+      if simple_list?
+        query_result.update_result_container_simple result_can
+      else
+        query_result.update_result_container result_can
+      end
+    else
+      query_result.show
+    end
+  end
+
+  #
+  # Get the array of parameters.
+  # If there is no PARAM container of if it is empty,
+  # we'll return a nil value.
+  #
+  def param_array
+    o = find_child PARAMS
+    return nil unless o
+
+    return nil if o.child_count.zero?
+
+    params = []
+    o.children.each do |p|
+      p = Gloo::Objs::Alias.resolve_alias( @engine, p )
+      params << p.sql_value
+    end
+
+    return params
+  end
+
+  # 
+  # Clear out results container.
+  # Prevents data from the last use being used in this 
+  # one if no data was found.
+  # 
+  def clear_results
+    result_can = get_result_can
+    return unless result_can
+    return unless result_can.child_count.positive?
+
+    if result_is_values?
+      clear_values
+    else
+      get_result_can.delete_children
+    end
+  end
+
+  # 
+  # Is the result container a list of values?
+  # If not it is a list of rows.
+  # 
+  def result_is_values?
+    first_child = get_result_can.children.first
+
+    if first_child && first_child&.is_container?
+      return false
+    end
+
+    return true
+  end
+
+  # 
+  # Clear out the values in the results container.
+  # 
+  def clear_values
+    get_result_can.children.each do |c|
+      c = Gloo::Objs::Alias.resolve_alias( @engine, c )
+      c.value = nil
+    end
+  end
+
+end

data/lib/query_result.rb

@@ -0,0 +1,152 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2022 Eric Crane.  All rights reserved.
+#
+# The result of a SQL database query.
+#
+
+class QueryResult
+
+  DB = 'database'.freeze
+  SQL = 'sql'.freeze
+  RESULT = 'result'.freeze
+  PARAMS = 'params'.freeze
+
+
+  # ---------------------------------------------------------------------
+  #    Set up the Result
+  # ---------------------------------------------------------------------
+
+  # 
+  # Create the Result object
+  def initialize( heads, data, engine=nil )
+    @heads = heads
+    @data = data
+    @engine = engine
+  end
+
+
+  # ---------------------------------------------------------------------
+  #    Helper Functions
+  # ---------------------------------------------------------------------
+
+  # 
+  # Does the data contain a single row?
+  # OR, if the result is empty, return false.
+  # 
+  def single_row_result?
+    if @result_can && ( @result_can.child_count == 0 )
+      return false
+    end
+
+    return @data.count == 1
+  end
+
+  # 
+  # Does this query result have data to show?
+  # 
+  def has_data_to_show?
+    return false unless @heads
+    return false unless @data
+    return false if @heads.count == 0
+    return false if @data.count == 0
+
+    return true
+  end
+
+
+  # ---------------------------------------------------------------------
+  #    Show Results
+  # ---------------------------------------------------------------------
+
+  # 
+  # Show the result of the query
+  # 
+  def show
+    single_row_result? ? show_single_row : show_rows
+  end
+
+  # 
+  # Show a single row in a vertical, form style view.
+  # 
+  def show_single_row
+    arr = []
+    row = @data[0]
+    @heads.each_with_index do |h, i|
+      arr << [ h, row[i] ]
+    end
+    @engine.platform.table.show [ 'Field', 'Value' ], arr
+  end
+
+  # 
+  # Show multiple rows in a table view.
+  # 
+  def show_rows
+    @engine.platform.table.show @heads, @data
+  end
+
+  # ---------------------------------------------------------------------
+  #    Update results in object(s)
+  # ---------------------------------------------------------------------
+
+  #
+  # Update the result container with the data from the query.
+  #
+  def update_result_container( in_can )
+    @result_can = in_can
+    single_row_result? ? update_single_row : update_rows
+  end
+
+  #
+  # Update the result container with the data from the query.
+  #
+  def update_result_container_simple( in_can )
+    @result_can = in_can
+    single_row_result? ? update_single_row : update_rows_simple
+  end
+
+  # 
+  # The result has a single row.
+  # Map values from the result set to objects that are present.
+  # 
+  def update_single_row
+    row = @data[0]
+    @heads.each_with_index do |h, i|
+      child = @result_can.find_child h
+      child = Gloo::Objs::Alias.resolve_alias( @engine, child )
+      child.set_value row[i] if child
+    end
+  end
+
+  # 
+  # Put all rows in the result object.
+  # 
+  def update_rows
+    @data.each_with_index do |row, i|
+      can = @result_can.find_add_child( i.to_s, 'can' )
+      row.each_with_index do |v, i|
+        o = can.find_add_child( @heads[i], 'untyped' )
+        o.set_value v
+      end
+    end
+  end
+
+  # 
+  # Put all rows in the result object.
+  # 
+  def update_rows_simple
+    @data.each do |row|
+      row.each do |val|
+        o = @result_can.find_add_child( val, 'untyped' )
+        o.set_value val
+      end
+    end
+  end
+
+
+  # ---------------------------------------------------------------------
+  #    Private functions
+  # ---------------------------------------------------------------------
+
+  private
+
+end

data/lib/table.rb

@@ -0,0 +1,263 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2020 Eric Crane.  All rights reserved.
+#
+# A data table.
+# The table container headers and data.
+#
+
+class Table < Gloo::Core::Obj
+
+  KEYWORD = 'table'.freeze
+  KEYWORD_SHORT = 'tbl'.freeze
+  HEADERS = 'headers'.freeze
+  DATA = 'data'.freeze
+  CELLS = 'cells'.freeze
+  STYLES = 'styles'.freeze
+  ALWAYS_ROWS = 'always_rows'.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
+
+  #
+  # Get the list of headers.
+  # Returns nil if there is none.
+  #
+  def headers
+    o = find_child HEADERS
+    return [] unless o
+
+    return o.children.map( &:value )
+  end
+
+  #
+  # Always show rows, even if only 1 row is found.
+  #
+  def always_rows
+    o = find_child ALWAYS_ROWS
+
+    return false unless o
+    return o.value
+  end
+
+  #
+  # Get the list of column names.
+  # Returns nil if there is none.
+  #
+  def columns
+    o = find_child HEADERS
+    return [] unless o
+
+    return o.children.map( &:name )
+  end
+
+  #
+  # Get the list of data elements.
+  #
+  def data
+    o = find_child DATA
+    return [] unless o
+    
+    o = Gloo::Objs::Alias.resolve_alias( @engine, o )
+    return [] unless o
+    
+    if o.is_a? Query
+      @engine.log.debug "Table getting data from query."
+      begin
+        result = o.run_query
+        return result
+      rescue => e
+        @engine.log_exception e
+        return nil
+      end
+    else
+      cols = self.columns
+
+      if o.children&.first.children.empty?
+        # It is a simgle row table.
+        rows = [ cols.map { |h| o.find_child( h )&.value } ]
+      else
+        rows = o.children.map do |e|
+          cols.map { |h| e.find_child( h )&.value }
+        end
+      end
+
+      return [ cols, rows ]
+    end
+  end
+
+  # 
+  # Get the styles for the table, if any.
+  # 
+  def styles
+    style_h = {} 
+    o = find_child STYLES
+    return style_h unless o
+    o = Gloo::Objs::Alias.resolve_alias( @engine, o )
+
+    o.children.each do |c|
+      style_h[ c.name ] = c.value
+    end
+
+    return style_h
+  end
+
+  # 
+  # Get cell renderer hash keyed by column name.
+  # 
+  def cell_renderers
+    h = {}
+    o = find_child CELLS
+    return h unless o
+
+    o.children.each do |c|
+      h[ c.name ] = c.value
+    end
+
+    return h
+  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_can HEADERS, self
+    fac.create_can DATA, self
+  end
+
+
+  # ---------------------------------------------------------------------
+  #    Messages
+  # ---------------------------------------------------------------------
+
+  #
+  # Get a list of message names that this object receives.
+  #
+  def self.messages
+    return super + %w[show render]
+  end
+
+  #
+  # Show the table in the CLI.
+  #
+  def msg_show
+    title = self.value
+    @engine.platform.table.show headers, data[1], title
+  end
+
+  def msg_render
+    return render
+  end
+
+
+  # ---------------------------------------------------------------------
+  #    Render
+  # ---------------------------------------------------------------------
+
+  # 
+  # Render the table.
+  # The render_ƒ is 'render_html', 'render_text', 'render_json', etc.
+  # 
+  def render render_ƒ
+    begin
+      result = self.data
+      head = self.headers 
+      head = result[0] if head.empty?
+      rows = result[1]
+
+      columns = build_columns result[0]
+
+      params = { 
+        head: head, 
+        cols: result[0],
+        columns: columns,
+        rows: rows,
+        styles: self.styles,
+        cell_renderers: self.cell_renderers
+      }
+
+      if self.always_rows
+        params[ :always_rows ] = true
+      end
+
+      helper = Gloo::WebSvr::TableRenderer.new( @engine )
+      return helper.data_to_table params
+    rescue => e
+      @engine.log_exception e
+      return nil
+    end
+  end
+
+  # 
+  # Build the column list based on the result data and
+  # the headers defined in the table object.
+  # 
+  def build_columns result_data
+    head_children = find_child HEADERS
+    cell_renderers = find_child CELLS
+
+    columns = []
+    return columns unless result_data
+    
+    result_data.each_with_index do |c,index|
+      visible = true
+      name = c
+      title = c
+      display_index = index
+
+      if head_children
+        child = head_children.find_child c
+        if child
+          title = child.value
+          display_index = head_children.child_index( c )
+        else
+          visible = false
+        end
+      end
+
+      cell_renderer = nil
+      if cell_renderers
+        this_cr = cell_renderers.find_child( c )
+        cell_renderer = this_cr.value if this_cr
+      end
+
+      columns << { 
+        name: name, 
+        title: title, 
+        visible: visible, 
+        data_index: index,
+        display_index: display_index,
+        cell_renderer: cell_renderer
+      }
+    end
+    return columns.sort_by { |hsh| hsh[ :display_index ] }
+  end
+
+end

metadata

@@ -0,0 +1,48 @@
+--- !ruby/object:Gem::Specification
+name: gloo-db
+version: !ruby/object:Gem::Version
+  version: '1.0'
+platform: ruby
+authors:
+- Eric Crane
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-02-06 00:00:00.000000000 Z
+dependencies: []
+description: Adds database support to Gloo.
+email:
+- eric.crane@mac.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/gloo-db.rb
+- lib/query.rb
+- lib/query_result.rb
+- lib/table.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. Database support.
+test_files: []