gloo 1.0.0 → 1.2.2

data/lib/gloo/help/objs/web/teams.txt

@@ -1,30 +0,0 @@
-TEAMS OBJECT TYPE
-  NAME: teams
-  SHORTCUT: team
-
-  DESCRIPTION
-    Send message to channel in Teams.
-
-  CHILDREN
-    uri - string - 'https://outlook.office.com/webhook/...'
-      The URI with access to the Teams channel.
-    title - string
-      Message title; header.
-    color - string - '008000'
-      Color theme for the message.
-    message - string
-      The message to post in Teams.
-
-  MESSAGES
-    run - Post the message to Teams.
-
-  EXAMPLE
-
-    team [teams] :
-    	uri [string] : https://outlook.office.com/webhook/MYTOKEN/IncomingWebhook/MYTOKEN
-    	title [string] : Success
-    	color [string] : 008000
-    	message [string] : This worked!
-
-  SEE ALSO
-    http_get, http_post, json, uri

data/lib/gloo/help/objs/web/uri.txt

@@ -1,38 +0,0 @@
-URI OBJECT TYPE
-  NAME: uri
-  SHORTCUT: url
-
-  DESCRIPTION
-    A URI or URL.
-
-  CHILDREN
-    None
-
-  MESSAGES
-    open - open the URL in the default browser
-    get_scheme - get the URI scheme; example:  http
-    get_host - get the URI host; example:  google.com
-    get_path - get the URI resource path; example:  /post
-    get_query - get the URI query parameters; example:  id=121
-    get_fragment - get the URI fragment
-    get_cert_expires - get the web site's certificate expiration date
-
-  EXAMPLE
-
-    url [can] :
-      on_load [script] :
-        tell url.u to get_scheme
-        show "scheme: " + it
-
-        tell url.u to get_host
-        show "host: " + it
-
-        tell url.u to get_path
-        show "path: " + it
-
-        show "opening URL: " + url.u
-        tell url.u to open
-      u [uri] : https://my.url/path/1234
-
-  SEE ALSO
-    http_get, http_post, json

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

@@ -1,33 +0,0 @@
-ALERT VERB
-  NAME: alert
-  SHORTCUT: !
-
-  DESCRIPTION
-    Show a pop-up notification.
-    This has only been implemented for the Mac OS X as of yet.
-
-  SYNTAX
-    alert <messsage>
-
-  PARAMETERS
-    messsage - The message that will be displayed in the alert.
-
-  RESULT
-    On the Mac, a notification will popup on screen.
-    <it> will be set to the message.
-
-  ERRORS
-    Missing Expression!
-      - No expression is provided as parameter to the verb.
-    Expression evaluated with no result!
-      - Expression is provided but evaluates to nil.
-
-  EXAMPLE
-
-    > create s as string : "boo"
-    > alert s
-
-    > alert "important message!"
-
-  SEE ALSO
-    show

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

@@ -1,25 +0,0 @@
-BEEP VERB
-  NAME: beep
-  SHORTCUT: b
-
-  DESCRIPTION
-    Play a standard system beep sound.
-
-  SYNTAX
-    beep
-
-  PARAMETERS
-    None
-
-  RESULT
-    None
-
-  ERRORS
-    None
-
-  EXAMPLE
-
-    > beep
-
-  SEE ALSO
-    play, say

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

@@ -1,24 +0,0 @@
-CLS VERB
-  NAME: cls
-  SHORTCUT: cls
-
-  DESCRIPTION
-    Clear the console screen.
-
-  SYNTAX
-    cls
-
-  PARAMETERS
-    None
-
-  RESULT
-    The screen is cleared and cursor set to the top.
-
-  ERRORS
-    None
-
-  EXAMPLE
-
-    > cls
-
-  SEE ALSO

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

@@ -1,43 +0,0 @@
-CONTEXT VERB
-  NAME: context
-  SHORTCUT: @
-
-  DESCRIPTION
-    Get or set the current context.
-    When no parameter is provided, the context will be shown.
-    The the optional path parameter is provided, the context will
-    be set to that path.
-    Use 'context root' to set the context back to the root level.
-
-  SYNTAX
-    context <path.to.new.context>
-
-  PARAMETERS
-    path.to.new.context - Optional.  The path to the new context.
-
-  RESULT
-    Context is optionally set.
-    <it> will be set to the new context path when we are changing context.
-    Context is show in either case.
-
-  ERRORS
-    None
-
-    Note that providing a context does not exist will not initially
-    be a problem.  In other words, you can set the context to an
-    object before it exists.  However use of context that doesn't exist
-    will be a problem.
-
-  EXAMPLE
-
-    > context
-      Context: root
-
-    > context my.object.path
-      Context: my.object.path
-
-    > context root
-      Context: root
-
-  SEE ALSO
-    list

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

@@ -1,33 +0,0 @@
-CREATE VERB
-  NAME: create
-  SHORTCUT: `
-
-  DESCRIPTION
-    Create a new object of given type with given value.
-    Both type and value are optional when creating an object.
-
-  SYNTAX
-    create <new.object.path> as <type> : <value>
-
-  PARAMETERS
-    new.object.path - The path and name of the new object
-    type - The type of the new object
-    value - The initial value for the new object
-
-  RESULT
-    The new object will be created and added to the object heap.
-    <it> will be set to the new object's initial value.
-
-  ERRORS
-    Object name is missing!
-      - The name of the object was not specified and the object
-      cannot be created.
-
-  EXAMPLE
-
-    > create x as integer : 1
-    > create s : "abc"
-    > create t
-
-  SEE ALSO
-    objects

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

@@ -1,27 +0,0 @@
-EXECUTE VERB
-  NAME: execute
-  SHORTCUT: exec
-
-  DESCRIPTION
-    Execute a shell command.
-
-  SYNTAX
-    exec <expression>
-
-  PARAMETERS
-    expression
-      - Evaluate the expression and execute in the shell.
-
-  RESULT
-    none
-
-  ERRORS
-    Missing Expression!
-      - No expression is provided as parameter to the verb.
-
-  EXAMPLE
-
-    > exec 'rake test'
-
-  SEE ALSO
-    system, eval, erb

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

@@ -1,34 +0,0 @@
-HELP VERB
-  NAME: help
-  SHORTCUT: ?
-
-  DESCRIPTION
-    Show information about the application.
-    The help command can also be used to show a list of objects,
-    verbs, or to show detail about a single object or a
-    single verb.
-
-  SYNTAX
-    help <topic>
-
-  PARAMETERS
-    about - Optional parameter.
-      If no parameter is given, shows the default help screen
-      keywords - List all keywords
-      verbs    - List available verbs
-      objects  - List available objects
-      settings - List application settings
-      topics   - List all help topics
-      <verb>   - Look up detail about a verb
-      <object> - Look up detail about an object
-
-  RESULT
-    The help screen will be shown with relevant information.
-
-  ERRORS
-    Help command could not be found
-      - Trying to access a help topic that does not exist will result
-      in an error.
-
-  SEE ALSO
-    application

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

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

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

@@ -1,34 +0,0 @@
-LIST VERB
-  NAME: list
-  SHORTCUT: .
-
-  DESCRIPTION
-    List out objects (and children) at the current context.
-    When a path is provided, it will be listed instead of the
-    current context.
-
-    When using context, the current context will be shown, but
-    when context has not been set, the root will be shown.
-
-  SYNTAX
-    list <path.to.object>
-
-  PARAMETERS
-    path.to.object - Optional path to object that will be listed.
-                     When no path is provided, the current context is used.
-
-  RESULT
-    Object and children are listed out in the CLI.
-
-  ERRORS
-    Object does not exist
-      - The object specified that is to be listed could not be found.
-
-  EXAMPLE
-
-    > list
-    > list my.container
-    > list root
-
-  SEE ALSO
-    context

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

@@ -1,38 +0,0 @@
-LOAD VERB
-  NAME: load
-  SHORTCUT: <
-
-  DESCRIPTION
-    Load an object file.
-    There are two ways to specify the file.  Give either the full path
-    and file name or use a relative path from the gloo project folder.
-    For the latter, the extension is not needed.  For the former, the
-    file extension is necessary.
-    
-    Using * instead of a file name will load all gloo files in the folder.
-
-  SYNTAX
-    load <file_name>
-
-  PARAMETERS
-    file_name - Name of the object file that is to be loaded.
-
-  RESULT
-    Objects are loaded into the heap.
-    on_load scripts are run within the loaded objects.
-
-  ERRORS
-    Missing Expression!
-      - No expression is provided as parameter to the verb.
-
-    If the file specified can't be found or can't be loaded,
-    an error condition will result.
-
-  EXAMPLE
-
-    > load my/project/file
-    > load my/app/*
-    > load ~/.my_app/settings.gloo
-
-  SEE ALSO
-    save

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