gloo 1.0.0 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be2491c8754aeb5997318b86f7a6b3f8473178c41aa4af8a36e78b4efcd662e5
-  data.tar.gz: bd6ba3f319a58164b3ce7aed2b9a68201fde3a8220407850af1c9eacbddf9311
+  metadata.gz: 1b5ba7fb72c8c2c7d708feaefa39cdbf3729e8aeb406fd7cd164518efa1ae813
+  data.tar.gz: 463d279308f9ac258c802a79355c1b7af3df01c7dbbdc7e7a0952f17aa6e6f08
 SHA512:
-  metadata.gz: c48baf591661121a625dea69ea38e8913e8a01beac350024e7b0844ec9564ee9645900c8ef25b0f1de49f45ea89bffeecd8266c992d3ff34461a9f713f6b819f
-  data.tar.gz: c65e8f1c3aa5af175336ad4ea9d97fd224132c59793a58c77850985da0f90bb519370a3a86e24b4486f8defaadb6950af57983936c5c2a9c1680858e69b0c8a9
+  metadata.gz: ff67da493c051dfd83eab40f4e2c325e9cf541417164d9863e1bd63669907adf3ac049c326d3ab19168cb0b678b2d4bab9ec84c85a6b0818e0ec73b48cff073c
+  data.tar.gz: 2fab95b182a3311bb7ff6c7a0449c23b892869a7c07bf7358f8a9d80ce597ced0950d199db1688dea7e41a88609ff627407a80633033fbb4ed39b93ee32f8d98

data/.gitignore

@@ -9,4 +9,5 @@
 *.gem
 *.log
 test/gloo/debug/*
-.DS_Store
+Gemfile.lock
+*.DS_Store

data/.ruby-gemset

@@ -0,0 +1 @@
+gloo-gem

data/.ruby-version

@@ -0,0 +1 @@
+ruby-3.0.2

data/gloo.gemspec

@@ -27,14 +27,17 @@ Gem::Specification.new do |spec|
   spec.executables << 'o'
   spec.executables << 'gloo'
 
+  # 
+  # tty uses an older version of bundle
+  # 
   # spec.add_development_dependency 'bundler', '~> 2.2.22'
-  # spec.add_development_dependency 'bundler', '~> 2.3.9'
+  # spec.add_development_dependency 'bundler', '~> 2.3.17'
   spec.add_development_dependency 'bundler', '~> 1.17.3'
   spec.add_development_dependency 'minitest', '~> 5.1', '>= 5.14.2'
   # spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency "rake", '~> 13.0', '>= 13.0.1'
 
-  spec.add_dependency "gloo-lang", '~> 1.0', ">= 1.0.1"
+  spec.add_dependency "gloo-lang", '~> 1.1', ">= 1.2.2"
 
   spec.add_dependency "activesupport", '~> 6.1', ">= 6.1.5"
   # spec.add_dependency "activesupport", '~> 6.1', ">= 6.1.4.6"
@@ -46,6 +49,6 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'json', '~> 2.1', '>= 2.1.0'
   spec.add_dependency 'openssl', '~> 2.1', '>= 2.1.0'
   spec.add_dependency 'net-ssh', '~> 6.1', '>= 6.1.0'
-  # spec.add_dependency 'mysql2', '~> 0.5', '>= 0.5.3'
-  # spec.add_dependency 'sqlite3', '~> 1.4', '>= 1.4.2'
+  spec.add_dependency 'mysql2', '~> 0.5', '>= 0.5.3'
+  spec.add_dependency 'sqlite3', '~> 1.4', '>= 1.4.2'
 end

data/lib/VERSION

@@ -1 +1 @@
-1.0.0
+1.2.2

data/lib/gloo/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 Gloo
+  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( @engine, 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( @engine, 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( @engine, 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( @engine, 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/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 Gloo
+  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

data/lib/gloo/verbs/help.rb

@@ -0,0 +1,82 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2019 Eric Crane.  All rights reserved.
+#
+# Show the help information.
+#
+
+module Gloo
+  module Verbs
+    class Help < GlooLang::Core::Verb
+
+      KEYWORD = 'help'.freeze
+      KEYWORD_SHORT = '?'.freeze
+      DEFAULT_HELP = 'default_help'.freeze
+      HELP_NOT_FOUND_ERR = 'Help command could not be found:'.freeze
+
+      DISPATCH = {
+        settings: 'show_settings',
+        keywords: 'show_keywords',
+        verb: 'show_verbs',
+        verbs: 'show_verbs',
+        v: 'show_verbs',
+        obj: 'show_objs',
+        object: 'show_objs',
+        objects: 'show_objs',
+        o: 'show_objs',
+        topics: 'show_topics'
+      }.freeze
+
+      #
+      # Run the verb.
+      #
+      def run
+        data = "\n For documentation use the gloo website. \n\n"
+        @engine.log.show data
+      end
+
+      #
+      # Get the Verb's keyword.
+      #
+      def self.keyword
+        return KEYWORD
+      end
+
+      #
+      # Get the Verb's keyword shortcut.
+      #
+      def self.keyword_shortcut
+        return KEYWORD_SHORT
+      end
+
+      # ---------------------------------------------------------------------
+      #    Private functions
+      # ---------------------------------------------------------------------
+
+      private
+
+      #
+      # Write output to it and show it unless we are in
+      # silent mode.
+      #
+      def show_output( out )
+        @engine.heap.it.set_to out
+        puts out unless @engine.args.quiet?
+      end
+
+      #
+      # Show application settings.
+      #
+      def show_settings
+        @engine.settings.show
+      end
+
+      #
+      # Show all keywords: verbs and objects.
+      #
+      def show_keywords
+        @engine.dictionary.show_keywords
+      end
+
+    end
+  end
+end

data/lib/gloo/verbs/version.rb

@@ -0,0 +1,37 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2019 Eric Crane.  All rights reserved.
+#
+# Show the current application version.
+#
+
+module GlooLang
+  module Verbs
+    class Version < GlooLang::Core::Verb
+
+      KEYWORD = 'version'.freeze
+      KEYWORD_SHORT = 'v'.freeze
+
+      #
+      # Run the verb.
+      #
+      def run
+        @engine.log.show GlooLang::App::Info.full_version
+      end
+
+      #
+      # Get the Verb's keyword.
+      #
+      def self.keyword
+        return KEYWORD
+      end
+
+      #
+      # Get the Verb's keyword shortcut.
+      #
+      def self.keyword_shortcut
+        return KEYWORD_SHORT
+      end
+
+    end
+  end
+end