gloo-lang 0.9.0 → 0.9.3

data/lib/gloo_lang/objs/ctrl/repeat.rb

@@ -0,0 +1,108 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2020 Eric Crane.  All rights reserved.
+#
+# A looping construct...do something x times.
+#
+
+module GlooLang
+  module Objs
+    class Repeat < GlooLang::Core::Obj
+
+      KEYWORD = 'repeat'.freeze
+      KEYWORD_SHORT = 'repeat'.freeze
+      TIMES = 'times'.freeze
+      INDEX = 'index'.freeze
+      DO = 'do'.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 URI from the child object.
+      # Returns nil if there is none.
+      #
+      def times
+        o = find_child TIMES
+        return o ? o.value : 0
+      end
+
+      #
+      # Run the do script once.
+      #
+      def run_do
+        o = find_child DO
+        return unless o
+
+        GlooLang::Exec::Dispatch.message 'run', o
+      end
+
+      #
+      # Set the index of the current iteration.
+      #
+      def set_index( index )
+        o = find_child INDEX
+        return unless o
+
+        o.set_value index
+      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_int TIMES, 0, self
+        fac.create_int INDEX, 0, self
+        fac.create_script DO, '', self
+      end
+
+      # ---------------------------------------------------------------------
+      #    Messages
+      # ---------------------------------------------------------------------
+
+      #
+      # Get a list of message names that this object receives.
+      #
+      def self.messages
+        return super + [ 'run' ]
+      end
+
+      #
+      # Run the repeat loop.
+      #
+      def msg_run
+        times.times do |index|
+          set_index index
+          run_do
+        end
+      end
+
+    end
+  end
+end

data/lib/gloo_lang/objs/data/markdown.rb

@@ -0,0 +1,84 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2020 Eric Crane.  All rights reserved.
+#
+# Markdown data.
+#
+require 'tty-markdown'
+require 'tty-pager'
+
+module GlooLang
+  module Objs
+    class Markdown < GlooLang::Core::Obj
+
+      KEYWORD = 'markdown'.freeze
+      KEYWORD_SHORT = 'md'.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 )
+        self.value = new_value.to_s
+      end
+
+      #
+      # Does this object support multi-line values?
+      # Initially only true for scripts.
+      #
+      def multiline_value?
+        return false
+      end
+
+      #
+      # Get the number of lines of text.
+      #
+      def line_count
+        return value.split( "\n" ).count
+      end
+
+      # ---------------------------------------------------------------------
+      #    Messages
+      # ---------------------------------------------------------------------
+
+      #
+      # Get a list of message names that this object receives.
+      #
+      def self.messages
+        return super + %w[show page]
+      end
+
+      #
+      # Show the markdown data in the terminal.
+      #
+      def msg_show
+        puts TTY::Markdown.parse self.value
+      end
+
+      #
+      # Show the markdown data in the terminal, paginated.
+      #
+      def msg_page
+        return unless self.value
+
+        md = TTY::Markdown.parse self.value
+        # pager = TTY::Pager::SystemPager.new command: 'less -R'
+        pager = TTY::Pager.new
+        pager.page( md )
+      end
+
+    end
+  end
+end

data/lib/gloo_lang/objs/data/mysql.rb

@@ -0,0 +1,192 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2020 Eric Crane.  All rights reserved.
+#
+# A MySQL database connection.
+#
+#
+# https://github.com/brianmario/mysql2
+# https://www.rubydoc.info/gems/mysql2/0.2.3/Mysql2/Client
+#
+# Connection Parameters
+#   user     = opts[:username]
+#   pass     = opts[:password]
+#   host     = opts[:host] || 'localhost'
+#   port     = opts[:port] || 3306
+#   database = opts[:database]
+#   socket   = opts[:socket]
+#   flags    = opts[:flags] || 0
+#
+require 'mysql2'
+
+module GlooLang
+  module Objs
+    class Mysql < GlooLang::Core::Obj
+
+      KEYWORD = 'mysql'.freeze
+      KEYWORD_SHORT = 'mysql'.freeze
+
+      HOST = 'host'.freeze
+      DB = 'database'.freeze
+      USER = 'username'.freeze
+      PASSWD = 'password'.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 HOST, nil, self
+        fac.create_string DB, nil, self
+        fac.create_string USER, nil, self
+        fac.create_string PASSWD, nil, self
+      end
+
+      # ---------------------------------------------------------------------
+      #    Messages
+      # ---------------------------------------------------------------------
+
+      #
+      # Get a list of message names that this object receives.
+      #
+      def self.messages
+        return super + [ 'verify' ]
+      end
+
+      #
+      # SSH to the host and execute the command, then update result.
+      #
+      def msg_verify
+        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 )
+        h = {
+          host: host_value,
+          database: db_value,
+          username: user_value,
+          password: passwd_value
+        }
+        client = Mysql2::Client.new( h )
+        return client.query( sql ) unless params
+
+        pst = client.prepare( sql )
+        return pst.execute( *params )
+      end
+
+      # ---------------------------------------------------------------------
+      #    Private functions
+      # ---------------------------------------------------------------------
+
+      private
+
+      #
+      # Get the host from the child object.
+      # Returns nil if there is none.
+      #
+      def host_value
+        o = find_child HOST
+        return nil unless o
+
+        o = GlooLang::Objs::Alias.resolve_alias( o )
+        return o.value
+      end
+
+      #
+      # Get the Database name from the child object.
+      # Returns nil if there is none.
+      #
+      def db_value
+        o = find_child DB
+        return nil unless o
+
+        o = GlooLang::Objs::Alias.resolve_alias( o )
+        return o.value
+      end
+
+      #
+      # Get the Username from the child object.
+      # Returns nil if there is none.
+      #
+      def user_value
+        o = find_child USER
+        return nil unless o
+
+        o = GlooLang::Objs::Alias.resolve_alias( o )
+        return o.value
+      end
+
+      #
+      # Get the Password name from the child object.
+      # Returns nil if there is none.
+      #
+      def passwd_value
+        o = find_child PASSWD
+        return nil unless o
+
+        o = GlooLang::Objs::Alias.resolve_alias( o )
+        return o.value
+      end
+
+      #
+      # Try the connection and make sure it works.
+      # Returns true if we can establish a connection.
+      #
+      def connects?
+        begin
+          h = {
+            host: host_value,
+            database: db_value,
+            username: user_value,
+            password: passwd_value
+          }
+          Mysql2::Client.new( h )
+        rescue => e
+          $engine.err e.message
+          $engine.heap.it.set_to false
+          return false
+        end
+        return true
+      end
+
+    end
+  end
+end

data/lib/gloo_lang/objs/data/query.rb

@@ -0,0 +1,176 @@
+# 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 GlooLang
+  module Objs
+    class Query < GlooLang::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 GlooLang::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 = GlooLang::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_lang/objs/data/sqlite.rb

@@ -0,0 +1,159 @@
+# 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 GlooLang
+  module Objs
+    class Sqlite < GlooLang::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