gloo 0.7.7 → 1.1.0

data/lib/gloo/help/verbs/move.txt

@@ -1,42 +0,0 @@
-MOVE VERB
-  NAME: move
-  SHORTCUT: mv
-
-  DESCRIPTION
-    Move an object to a new parent.
-
-  SYNTAX
-    move <path.to.object> to <new.parent>
-
-  PARAMETERS
-    path.to.object - The object that we want to move.
-    new.parent - The new location for the object.
-
-  RESULT
-    The object will now be in the new location.
-
-  ERRORS
-    Object to move was not specified
-      - The <path.to.object> is not specified.
-
-    Could not find object to move
-      - The <path.to.object> cannot be resolved.
-
-    Move' must include 'to' parent object
-      - The 'to' keyword is missing.
-      - The <new.parent> is not specified.
-
-    Could not resolve target
-      - The <new.parent> cannot be resolved.
-
-  EXAMPLE
-
-    can [can] :
-      two [string] : def
-      data [can] :
-        one [string] : abc
-      on_load [script] :
-        move can.two to can.data
-
-  SEE ALSO
-    create

data/lib/gloo/help/verbs/put.txt

@@ -1,38 +0,0 @@
-PUT VERB
-  NAME: put
-  SHORTCUT: p
-
-  DESCRIPTION
-    Put a value into an object.
-    The value is the result of an expression.
-
-  SYNTAX
-    put <expression> into <dst.path>
-
-  PARAMETERS
-    expression - The expression that is evaluated.
-    dst.path - The path to the destination object.
-
-  RESULT
-    <it> will contain the result of the evaluation.
-
-  ERRORS
-    Missing Expression
-      - The 'into' keyword is missing.
-      - No source expression is provided.
-
-    Target (into) missing
-      - The destination is not specified.
-
-    Target could not be resolved
-      - The destination of the put cannot be resolved.
-
-  EXAMPLE
-
-    > put 'one' into str
-    > put "two" into str
-    > put 123 into x
-    > put 3 + 5 into x
-    > put TRUE into flag
-
-  SEE ALSO

data/lib/gloo/help/verbs/quit.txt

@@ -1,25 +0,0 @@
-QUIT VERB
-  NAME: quit
-  SHORTCUT: q
-
-  DESCRIPTION
-    Stop running the gloo application.
-    Cleanup and shutdown.
-
-  SYNTAX
-    quit
-
-  PARAMETERS
-    None
-
-  RESULT
-    None
-
-  ERRORS
-    None
-
-  EXAMPLE
-
-    > quit
-
-  SEE ALSO

data/lib/gloo/help/verbs/run.txt

@@ -1,41 +0,0 @@
-RUN VERB
-  NAME: run
-  SHORTCUT: r
-
-  DESCRIPTION
-    Run a script or other object.
-    This is the same as sending a 'run' message to the object.
-
-  SYNTAX
-    run <path.to.object>
-    run ~> <expression>
-
-  PARAMETERS
-    path.to.object
-      - Reference to the object which will be run.
-      - The object must be a runnable object such as a script.
-
-    expression
-      - Evaluate the expression and run it.
-
-
-  RESULT
-    The result depends on the object that is run.
-
-  ERRORS
-    Missing Expression!
-      - No expression is provided as parameter to the verb.
-
-  EXAMPLE
-
-    > run my.script
-
-    > create s as script : "show 3 + 4"
-    > run s
-
-    Run a script in an evaluated expression:
-    > create s as string : "show 3 + 4"
-    > run ~> s
-
-  SEE ALSO
-    tell

data/lib/gloo/help/verbs/save.txt

@@ -1,26 +0,0 @@
-SAVE VERB
-  NAME: save
-  SHORTCUT: >
-
-  DESCRIPTION
-    Save a previously loaded object to .gloo file.  The path will be for the
-    root level object that was loaded earlier.
-
-  SYNTAX
-    save <path.to.object>
-
-  PARAMETERS
-    path.to.object - Name of the object file that is to be saved.
-
-  RESULT
-    The file is updated with the latest object state.
-
-  ERRORS
-    None
-
-  EXAMPLE
-
-    > save my_obj
-
-  SEE ALSO
-    load

data/lib/gloo/help/verbs/show.txt

@@ -1,30 +0,0 @@
-SHOW VERB
-  NAME: show
-  SHORTCUT: =
-
-  DESCRIPTION
-    Show an object's value.
-
-  SYNTAX
-    show <path.to.object>
-
-  PARAMETERS
-    path.to.object - The object that we want to see.
-
-  RESULT
-    The object's value is shown.
-    <it> will contain the object's value.
-
-  ERRORS
-    None
-
-  EXAMPLE
-
-    > show "me"
-    > show "hello " "world"
-    > show 132 * 23
-
-    > create x : "boo"
-    > show x
-
-  SEE ALSO

data/lib/gloo/help/verbs/tell.txt

@@ -1,34 +0,0 @@
-TELL VERB
-  NAME: tell
-  SHORTCUT: ->
-
-  DESCRIPTION
-    Send a message to an object.
-    Ask the object to perform an action.
-
-  SYNTAX
-    tell <path.to.object> to <message>
-
-  PARAMETERS
-    path.to.object - The object that we want to see.
-    message - The message to send.
-
-  RESULT
-    The result depends on the message that is sent.
-
-  ERRORS
-    Missing message!
-      - No message was specified, or the 'to' keyword is missing.
-
-    Object was not found
-      - The target of the message was not found.
-
-  EXAMPLE
-
-    > tell an.obj to unload
-    > tell the.script to run
-    > tell my.str to up
-    > tell the.container to count
-    
-  SEE ALSO
-    run

data/lib/gloo/help/verbs/unless.txt

@@ -1,38 +0,0 @@
-UNLESS VERB
-  NAME: unless
-  SHORTCUT: if!
-
-  DESCRIPTION
-    Unless an expression is true, do something.
-    This is the opposite of the if verb.
-
-  SYNTAX
-    unless <true> do <command>
-
-  PARAMETERS
-    true - Does the expression evaluate to true?
-    command - Execute command if the expression is not true.
-
-  RESULT
-    Unchanged if the expression is true.
-    If not true, then the result will be based on the command
-    specified after the 'do' keyword.
-
-  ERRORS
-    Missing Expression!
-      - No expression is provided as parameter to the verb.
-
-    Other errors depend on the command that is run.
-
-  EXAMPLE
-
-    unless [container] :
-      x [bool] : true
-      false_msg [string] : It is NOT true!
-      on_load [script] :
-        unless unless.x do show "first time: " + unless.false_msg
-        put false into unless.x
-        unless unless.x do show "second time: " +  unless.false_msg
-
-  SEE ALSO
-    if

data/lib/gloo/help/verbs/version.txt

@@ -1,32 +0,0 @@
-VERSION VERB
-  NAME: version
-  SHORTCUT: v
-
-  DESCRIPTION
-    Show the application version information.
-
-    This is the same as showing the version by running gloo
-    with the --version command line parameter.
-
-  SYNTAX
-    version
-
-  PARAMETERS
-    None
-
-  RESULT
-    None
-
-  ERRORS
-    None
-
-  EXAMPLE
-
-    > version
-    > v
-
-    This is the same as running this from the command line:
-
-    > gloo --version
-
-  SEE ALSO

data/lib/gloo/help/verbs/wait.txt

@@ -1,29 +0,0 @@
-WAIT VERB
-  NAME: wait
-  SHORTCUT: w
-
-  DESCRIPTION
-    Wait for the given number of seconds.
-
-  SYNTAX
-    wait <seconds>
-
-  PARAMETERS
-    seconds - The number of seconds.
-      If no value is given, we'll wait for 1 second.
-
-  RESULT
-    None
-
-  ERRORS
-    None
-
-  EXAMPLE
-
-    > wait
-    > wait 3
-
-    > create x as int : 10
-    > wait x
-
-  SEE ALSO

data/lib/gloo/objs/basic/alias.rb

@@ -1,78 +0,0 @@
-# Author::    Eric Crane  (mailto:eric.crane@mac.com)
-# Copyright:: Copyright (c) 2020 Eric Crane.  All rights reserved.
-#
-# A String.
-#
-
-module Gloo
-  module Objs
-    class Alias < Gloo::Core::Obj
-
-      KEYWORD = 'alias'.freeze
-      KEYWORD_SHORT = 'ln'.freeze
-      ALIAS_REFERENCE = '*'.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
-
-      # ---------------------------------------------------------------------
-      #    Messages
-      # ---------------------------------------------------------------------
-
-      #
-      # Get a list of message names that this object receives.
-      #
-      def self.messages
-        return super + %w[resolve]
-      end
-
-      #
-      # Check to see if the referenced object exists.
-      #
-      def msg_resolve
-        pn = Gloo::Core::Pn.new( self.value )
-        s = pn.exists?
-        $engine.heap.it.set_to s
-        return s
-      end
-
-      # ---------------------------------------------------------------------
-      #    Resolve
-      # ---------------------------------------------------------------------
-
-      #
-      # Is the object an alias  If so, then resolve it.
-      # The ref_name is the name used to refer to the object.
-      # If it ends with the * then we won't resolve the alias since
-      # we are trying to refer to the alias itself.
-      #
-      def self.resolve_alias( obj, ref_name = nil )
-        return nil unless obj
-        return obj unless obj.type_display == Gloo::Objs::Alias.typename
-        return obj if ref_name&.end_with?( ALIAS_REFERENCE )
-
-        ln = Gloo::Core::Pn.new( obj.value )
-        return ln.resolve
-      end
-
-    end
-  end
-end

data/lib/gloo/objs/basic/boolean.rb

@@ -1,120 +0,0 @@
-# Author::    Eric Crane  (mailto:eric.crane@mac.com)
-# Copyright:: Copyright (c) 2019 Eric Crane.  All rights reserved.
-#
-# An object with an boolean value.
-#
-
-module Gloo
-  module Objs
-    class Boolean < Gloo::Core::Obj
-
-      KEYWORD = 'boolean'.freeze
-      KEYWORD_SHORT = 'bool'.freeze
-      TRUE = 'true'.freeze
-      FALSE = 'false'.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 = Gloo::Objs::Boolean.coerse_to_bool( new_value )
-      end
-
-      #
-      # Coerse the new value to a boolean value.
-      #
-      def self.coerse_to_bool( new_value )
-        return false if new_value.nil?
-
-        # I should be able to use this:
-        # if new_value.kind_of?( String )
-        # but it doesn't work.  I don't know why.
-        if new_value.class.name == 'String'
-          return true if new_value.strip.downcase == TRUE
-          return false if new_value.strip.downcase == FALSE
-          return true if new_value.strip.downcase == 't'
-          return false if new_value.strip.downcase == 'f'
-        elsif new_value.class.name == 'Integer'
-          return new_value.zero? ? false : true
-        end
-
-        return new_value == true
-      end
-
-      #
-      # Is the given token a boolean?
-      #
-      def self.boolean?( token )
-        return true if token == true
-        return true if token == false
-
-        if token.class.name == 'String'
-          return true if token.strip.downcase == TRUE
-          return true if token.strip.downcase == FALSE
-        end
-        return false
-      end
-
-      #
-      # Get the value for display purposes.
-      #
-      def value_display
-        return value ? TRUE : FALSE
-      end
-
-      # ---------------------------------------------------------------------
-      #    Messages
-      # ---------------------------------------------------------------------
-
-      #
-      # Get a list of message names that this object receives.
-      #
-      def self.messages
-        return super + %w[not true false]
-      end
-
-      #
-      # Set the value to the opposite of what it is.
-      #
-      def msg_not
-        v = !value
-        set_value v
-        $engine.heap.it.set_to v
-        return v
-      end
-
-      #
-      # Set the value to true.
-      #
-      def msg_true
-        set_value true
-        $engine.heap.it.set_to true
-        return true
-      end
-
-      #
-      # Set the value to false.
-      #
-      def msg_false
-        set_value false
-        $engine.heap.it.set_to false
-        return false
-      end
-
-    end
-  end
-end

data/lib/gloo/objs/basic/container.rb

@@ -1,76 +0,0 @@
-# Author::    Eric Crane  (mailto:eric.crane@mac.com)
-# Copyright:: Copyright (c) 2019 Eric Crane.  All rights reserved.
-#
-# An object that contains a collection of other objects.
-#
-require 'tty-table'
-require 'pastel'
-
-module Gloo
-  module Objs
-    class Container < Gloo::Core::Obj
-
-      KEYWORD = 'container'.freeze
-      KEYWORD_SHORT = 'can'.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[count delete_children show_key_value_table]
-      end
-
-      #
-      # Count the number of children in the container.
-      #
-      def msg_count
-        i = child_count
-        $engine.heap.it.set_to i
-        return i
-      end
-
-      #
-      # Delete all children in the container.
-      #
-      def msg_delete_children
-        self.delete_children
-      end
-
-      #
-      # Show the given table data.
-      #
-      def msg_show_key_value_table
-        data = self.children.map { |o| [ o.name, o.value ] }
-        pastel = ::Pastel.new
-        table = TTY::Table.new rows: 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.zero? ? pastel.blue( val ) : pastel.white( val )
-          end
-        end
-        puts "\n  #{rendered}\n\n"
-      end
-
-    end
-  end
-end

data/lib/gloo/objs/basic/decimal.rb

@@ -1,76 +0,0 @@
-# Author::    Eric Crane  (mailto:eric.crane@mac.com)
-# Copyright:: Copyright (c) 2020 Eric Crane.  All rights reserved.
-#
-# An object with a decimal value.
-#
-
-module Gloo
-  module Objs
-    class Decimal < Gloo::Core::Obj
-
-      KEYWORD = 'decimal'.freeze
-      KEYWORD_SHORT = 'num'.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 )
-        if new_value.nil?
-          self.value = 0.0
-          return
-        end
-
-        unless new_value.is_a? Numeric
-          self.value = $engine.converter.convert( new_value, 'Decimal', 0.0 )
-          return
-        end
-
-        self.value = new_value.to_f
-      end
-
-      # ---------------------------------------------------------------------
-      #    Messages
-      # ---------------------------------------------------------------------
-
-      #
-      # Get a list of message names that this object receives.
-      #
-      def self.messages
-        return super + %w[round]
-      end
-
-      #
-      # Round the value to a whole value.
-      # If a parameter is included in the message,
-      # round to the precision given.
-      #
-      def msg_round
-        data = 0
-        if @params&.token_count&.positive?
-          expr = Gloo::Expr::Expression.new( @params.tokens )
-          data = expr.evaluate.to_i
-        end
-
-        i = self.value.round( data )
-        set_value i
-        $engine.heap.it.set_to i
-        return i
-      end
-
-    end
-  end
-end