gloo 0.8.0 → 1.0.0

data/lib/gloo/objs/data/query.rb

@@ -1,176 +0,0 @@
-# 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.
-#
-
-module Gloo
-  module Objs
-    class Query < Gloo::Core::Obj
-
-      KEYWORD = 'query'.freeze
-      KEYWORD_SHORT = 'sql'.freeze
-
-      DB = 'database'.freeze
-      SQL = 'sql'.freeze
-      RESULT = 'result'.freeze
-      PARAMS = 'params'.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
-
-      # ---------------------------------------------------------------------
-      #    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
-
-      #
-      # SSH to the host and execute the command, then update result.
-      #
-      def msg_run
-        db = db_obj
-        unless db
-          $engine.err DB_MISSING_ERR
-          return
-        end
-
-        result = db.query( sql_value, param_array )
-        process_result result
-      end
-
-      # ---------------------------------------------------------------------
-      #    Private functions
-      # ---------------------------------------------------------------------
-
-      private
-
-      #
-      # Get the database connection.
-      #
-      def db_obj
-        o = find_child DB
-        return Gloo::Objs::Alias.resolve_alias( 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
-
-        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( data )
-        r = find_child RESULT
-        if r
-          update_result_contaier data
-        else
-          show_result data
-        end
-      end
-
-      #
-      # Get the arrya 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|
-          params << p.value
-        end
-
-        return params
-      end
-
-      #
-      # Show the result of the query in the console.
-      #
-      def show_result( data )
-        return if data.nil?
-
-        data.each_with_index do |row, i|
-          # Show header for the first row
-          puts row.map { |k, _| k }.join( " \t " ).white if i.zero?
-
-          # Show the row data
-          puts row.map { |_, v| v }.join( " \t " )
-        end
-      end
-
-      #
-      # Update the result container with the data from the query.
-      #
-      def update_result_contaier( data )
-        r = find_child RESULT
-        r = Gloo::Objs::Alias.resolve_alias( r )
-        data.each_with_index do |row, i|
-          can = r.find_add_child( i.to_s, 'can' )
-          row.each do |k, v|
-            o = can.find_add_child( k, 'untyped' )
-            o.set_value v
-          end
-        end
-      end
-
-    end
-  end
-end

data/lib/gloo/objs/data/sqlite.rb

@@ -1,159 +0,0 @@
-# Author::    Eric Crane  (mailto:eric.crane@mac.com)
-# Copyright:: Copyright (c) 2020 Eric Crane.  All rights reserved.
-#
-# A Sqlite3 database connection.
-#
-# https://www.rubydoc.info/gems/sqlite3/1.3.11
-# https://www.devdungeon.com/content/ruby-sqlite-tutorial
-#
-# db.results_as_hash = true
-#   Set results to return as Hash object.
-#   This is slower but offers a huge convenience.
-#   Consider turning it off for high performance situations.
-#   Each row will have the column name as the hash key.
-#
-# # Alternatively, to only get one row and discard the rest,
-# replace `db.query()` with `db.get_first_value()`.
-#
-require 'sqlite3'
-
-module Gloo
-  module Objs
-    class Sqlite < Gloo::Core::Obj
-
-      KEYWORD = 'sqlite'.freeze
-      KEYWORD_SHORT = 'sqlite'.freeze
-
-      DB = 'database'.freeze
-      DEFAULT_DB = 'test.db'.freeze
-
-      DB_REQUIRED_ERR = 'The database name is required!'.freeze
-      DB_NOT_FOUND_ERR = 'The database file was not found!'.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
-
-      # ---------------------------------------------------------------------
-      #    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_string DB, DEFAULT_DB, self
-      end
-
-      # ---------------------------------------------------------------------
-      #    Messages
-      # ---------------------------------------------------------------------
-
-      #
-      # Get a list of message names that this object receives.
-      #
-      def self.messages
-        return super + [ 'verify' ]
-      end
-
-      #
-      # Verify access to the Sqlite database specified.
-      #
-      def msg_verify
-        name = db_value
-        if name.empty?
-          $engine.err DB_REQUIRED_ERR
-          $engine.heap.it.set_to false
-          return
-        end
-
-        unless File.exist? name
-          $engine.err DB_NOT_FOUND_ERR
-          $engine.heap.it.set_to false
-          return
-        end
-
-        return unless connects?
-
-        $engine.heap.it.set_to true
-      end
-
-      # ---------------------------------------------------------------------
-      #    DB functions (all database connections)
-      # ---------------------------------------------------------------------
-
-      #
-      # Open a connection and execute the SQL statement.
-      # Return the resulting data.
-      #
-      def query( sql, params = nil )
-        name = db_value
-        unless name
-          $engine.err DB_REQUIRED_ERR
-          return
-        end
-
-        db = SQLite3::Database.open name
-        db.results_as_hash = true
-        return db.query( sql, params )
-      end
-
-      # ---------------------------------------------------------------------
-      #    Private functions
-      # ---------------------------------------------------------------------
-
-      private
-
-      #
-      # Get the Database file from the child object.
-      # Returns nil if there is none.
-      #
-      def db_value
-        o = find_child DB
-        return nil 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.err e.message
-          $engine.heap.it.set_to false
-          return false
-        end
-        return true
-      end
-
-    end
-  end
-end

data/lib/gloo/objs/data/table.rb

@@ -1,140 +0,0 @@
-# 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.
-#
-require 'tty-table'
-require 'pastel'
-
-module Gloo
-  module Objs
-    class Table < Gloo::Core::Obj
-
-      KEYWORD = 'table'.freeze
-      KEYWORD_SHORT = 'tbl'.freeze
-      HEADERS = 'headers'.freeze
-      DATA = 'data'.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
-
-      #
-      # 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( o )
-        cols = self.columns
-        return o.children.map do |e|
-          cols.map { |h| e.find_child( h ).value }
-        end
-      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]
-      end
-
-      #
-      # Show the table in the CLI.
-      #
-      def msg_show
-        title = self.value
-        Gloo::Objs::Table.show headers, data, title
-      end
-
-      # ---------------------------------------------------------------------
-      #    Static table helper
-      # ---------------------------------------------------------------------
-
-      #
-      # Show the given table data.
-      #
-      def self.show( headers, data, title = nil )
-        pastel = ::Pastel.new
-        table = TTY::Table.new headers, data
-        pad = [ 0, 1, 0, 1 ]
-        rendered = table.render( :ascii, indent: 2, padding: pad ) do |r|
-          r.border.style = :blue
-          r.filter = proc do |val, row_index, _col_index|
-            # col_index % 2 == 1 ? pastel.red.on_green(val) : val
-            if row_index.zero?
-              pastel.blue( val )
-            else
-              row_index.odd? ? pastel.white( val ) : pastel.yellow( val )
-            end
-          end
-        end
-        puts "\n#{title.white}"
-        puts "#{rendered}\n\n"
-      end
-
-    end
-  end
-end

data/lib/gloo/objs/dt/date.rb

@@ -1,50 +0,0 @@
-# Author::    Eric Crane  (mailto:eric.crane@mac.com)
-# Copyright:: Copyright (c) 2020 Eric Crane.  All rights reserved.
-#
-# A Date object (does not include a time).
-#
-
-module Gloo
-  module Objs
-    class Date < Gloo::Core::Obj
-
-      KEYWORD = 'date'.freeze
-      KEYWORD_SHORT = 'date'.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
-
-      # ---------------------------------------------------------------------
-      #    Messages
-      # ---------------------------------------------------------------------
-
-      #
-      # Get a list of message names that this object receives.
-      #
-      def self.messages
-        return super + %w[now]
-      end
-
-      #
-      # Set to the current date.
-      #
-      def msg_now
-        t = DateTime.now.strftime( '%Y.%m.%d' )
-        self.value = t
-        $engine.heap.it.set_to t
-      end
-
-    end
-  end
-end

data/lib/gloo/objs/dt/datetime.rb

@@ -1,62 +0,0 @@
-# Author::    Eric Crane  (mailto:eric.crane@mac.com)
-# Copyright:: Copyright (c) 2020 Eric Crane.  All rights reserved.
-#
-# A Date and Time object.
-#
-
-module Gloo
-  module Objs
-    class Datetime < Gloo::Core::Obj
-
-      KEYWORD = 'datetime'.freeze
-      KEYWORD_SHORT = 'dt'.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
-
-      #
-      # Set the value with any necessary type conversions.
-      #
-      def set_value( new_value )
-        unless new_value.is_a? DateTime
-          self.value = $engine.converter.convert( new_value, 'DateTime', nil )
-          return
-        end
-
-        self.value = new_value
-      end
-
-      # ---------------------------------------------------------------------
-      #    Messages
-      # ---------------------------------------------------------------------
-
-      #
-      # Get a list of message names that this object receives.
-      #
-      def self.messages
-        return super + %w[now]
-      end
-
-      #
-      # Set to the current date and time.
-      #
-      def msg_now
-        t = DateTime.now.strftime( '%Y.%m.%d %I:%M:%S %P' )
-        self.value = t
-        $engine.heap.it.set_to t
-      end
-
-    end
-  end
-end

data/lib/gloo/objs/dt/time.rb

@@ -1,50 +0,0 @@
-# Author::    Eric Crane  (mailto:eric.crane@mac.com)
-# Copyright:: Copyright (c) 2020 Eric Crane.  All rights reserved.
-#
-# A Time object (does not include a date).
-#
-
-module Gloo
-  module Objs
-    class Time < Gloo::Core::Obj
-
-      KEYWORD = 'time'.freeze
-      KEYWORD_SHORT = 'time'.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
-
-      # ---------------------------------------------------------------------
-      #    Messages
-      # ---------------------------------------------------------------------
-
-      #
-      # Get a list of message names that this object receives.
-      #
-      def self.messages
-        return super + %w[now]
-      end
-
-      #
-      # Set to the current time.
-      #
-      def msg_now
-        t = DateTime.now.strftime( '%I:%M:%S %P' )
-        self.value = t
-        $engine.heap.it.set_to t
-      end
-
-    end
-  end
-end