gloo 0.8.0 → 1.2.0

data/lib/gloo/help/objs/snd/say.txt

@@ -1,28 +0,0 @@
-SAY OBJECT TYPE
-  NAME: say
-  SHORTCUT: say
-
-  DESCRIPTION
-    Use the Mac text to speech function to convert text to audio.
-    From the Mac CLI, run this to get a list of voices:
-      say -v '?'
-
-  CHILDREN
-    voice - string
-      The Voice to use.  If left blank, the default voice will be used.
-    message - string - 'talk to me'
-      The message to speak.
-
-  MESSAGES
-    run - Speak the message, optionally in the voice specified.
-
-  EXAMPLE
-
-    say [say] :
-    	voice [string] : Moira
-    	message [string] : So long, and thanks for all the fish!
-    	on_load [script] :
-    		tell say to run
-
-  SEE ALSO
-    play, beep

data/lib/gloo/help/objs/system/file.txt

@@ -1,48 +0,0 @@
-FILE OBJECT TYPE
-  NAME: file
-  SHORTCUT: dir
-
-  DESCRIPTION
-    Reference to a file or folder (directory) on disk.
-    The string value of the file object is the path and name
-    of the file.
-
-  CHILDREN
-    None.
-
-  MESSAGES
-    read <into.obj> - Read file and put data in the specified object.
-      If the <into.obj> is not specified, the data will be in <it>.
-    write <from.obj> - Write the data in the <from.object> into
-      the file.
-    show - Show the contents of the file.
-    page - Show the contents of the file, paginated
-    open - Open the file with the default application for the type.
-    check_exists - Check to see if the file exists.
-      <It> will be true or false.
-    check_is_file - Check to see if the file specified is a
-      regular file.  <It> will be true or false.
-    check_is_dir - Check to see if the file specified is a
-      diretory.  <It> will be true or false.
-    find_match - Look for the existence of a file matching
-      the file's pattern.  <It> will be true or false.
-
-  EXAMPLE
-
-    exists [can] :
-    	f [file] : /Users/me/tmp
-    	on_load [script] :
-    		show "Checking to see if file exists:  " + exists.f
-    		tell exists.f to check_exists
-    		show it
-    		tell exists.f to check_is_dir
-    		show "is a directory?  " + it
-    		tell exists.f to check_is_file
-    		show "is a file?  " + it
-
-    f [file] : /Users/me/gloo/*.gemspec
-    pattern [script] :
-      tell f to find_match
-      show it
-
-  SEE ALSO

data/lib/gloo/help/objs/system/ssh_exec.txt

@@ -1,30 +0,0 @@
-SYSTEM OBJECT TYPE
-  NAME: ssh_exec
-  SHORTCUT: ssh
-
-  DESCRIPTION
-    Open an SSH session to host and execute a system command.
-
-  CHILDREN
-    host - string - 'localhost'
-      The remote host to which to open a connection.
-      The object assumes that the user has password-less SSH
-      set up to the remote host.
-    cmd - string
-      The command to execute on the remote system.
-    result - string
-      The result of running the command.
-
-  MESSAGES
-    run - Open the connection and execute the command.
-      Set the result value to the output of the command.
-
-  EXAMPLE
-
-    remote [ssh_exec] :
-      host [string] : localhost
-      cmd [string] : hostname
-      result [string] :
-
-  SEE ALSO
-    execute, system

data/lib/gloo/help/objs/system/system.txt

@@ -1,32 +0,0 @@
-SYSTEM OBJECT TYPE
-  NAME: system
-  SHORTCUT: sys
-
-  DESCRIPTION
-    Execute a system command.
-
-  CHILDREN
-    command - string - 'date'
-      The command that will be sent to the system.
-    get_output - boolean - true
-      Should executing the command get the output and put it
-      in the result object?
-    result - string
-      The result of running the command.
-      The result will only be set if the 'get_output' child
-      is set to true.
-
-  MESSAGES
-    run - Run the system level command.
-      Set the result value to the output of the command if the
-      'get_output' child is marked as true.
-
-  EXAMPLE
-
-    date [system] :
-      command [string] : date
-      get_output [bool] : true
-      result [string] :
-
-  SEE ALSO
-    execute, eval, erb

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

@@ -1,35 +0,0 @@
-HTTP_GET OBJECT TYPE
-  NAME: http_get
-  SHORTCUT: get
-
-  DESCRIPTION
-    Perform an HTTP Get.
-
-  CHILDREN
-    uri - string - 'https://web.site/'
-      The URI for the HTTP Get request.
-    params - container
-      Collection of parameters for the HTTP Get.
-    result - string
-      The result of the request.  Whatever was returned from
-      the HTTP Get call.
-    skip_ssl_verify - boolean (optional)
-      Skip the SSL verification as part of the request.
-
-  MESSAGES
-    run - Run the HTTP Get and update the result.
-
-  EXAMPLE
-
-    g [http_get] :
-    	uri [string] : http://api.sunrise-sunset.org/json
-    	params [container] :
-    		lat [string] : 36.7201600
-    		lng [string] : -4.4203400
-    		date [string] : today
-    	result [string] :
-
-    > run g
-
-  SEE ALSO
-    http_post, json, uri

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

@@ -1,34 +0,0 @@
-HTTP_POST OBJECT TYPE
-  NAME: http_post
-  SHORTCUT: post
-
-  DESCRIPTION
-    Perform an HTTP Post.
-
-  CHILDREN
-    uri - string - 'https://web.site/'
-      The URI for the HTTP Post.
-    body - container
-      Collection of parameters for the HTTP Post.
-    result - string - Optional parameter
-      The result of the request.  Whatever was returned in the body
-      of the HTTP POST.
-    skip_ssl_verify - boolean (optional)
-      Skip the SSL verification as part of the request.
-
-  MESSAGES
-    run - Run the HTTP Post sending the body data to the
-      endpoint specified in the URI.
-
-  EXAMPLE
-
-    post [post] :
-      txt [str] : Message from gloo!
-    	uri [str] : https://my.service.com/my-long-token
-    	body [can] :
-    		text [alias] : post.txt
-    		username [str] : me
-    	on_load [script] : run post
-
-  SEE ALSO
-    http_get, json, uri

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

@@ -1,34 +0,0 @@
-JSON OBJECT TYPE
-  NAME: json
-  SHORTCUT: json
-
-  DESCRIPTION
-    JSON data in a text string.
-
-  CHILDREN
-    None
-
-  MESSAGES
-    get - get a value from the JSON data
-      Example: tell myjson to get ("title")
-      The additional parameter is the path to the value.
-    parse - parse the JSON data and put values in the
-      object specified by the additional parameter
-      Example: tell myjson to parse ("path.to.objects")
-    pretty - make the JSON format pretty
-
-  EXAMPLE
-
-    json [can] :
-      on_load [script] :
-        list json.objs
-        show json.j
-        tell json.j to parse (json.objs)
-        list json.objs
-      j [json] : {"title":"Brute Force","quotation":"When in doubt, use brute force.","author":"Eric Steven Raymond","source":"The Art of Unix Programming"}
-      objs [can] :
-        title [string] :
-        quotation [string] :
-
-  SEE ALSO
-    http_get, http_post, uri

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

@@ -1,33 +0,0 @@
-SLACK OBJECT TYPE
-  NAME: slack
-  SHORTCUT: slack
-
-  DESCRIPTION
-    Send message to channel in Slack.
-
-  CHILDREN
-    uri - string - 'https://hooks.slack.com/services/...'
-      The URI with access to the Slack channel.
-    message - string - 'textual message'
-      Message to send to Slack.
-    username - string - 'Slack Bot'
-      Attribute the message to this user.
-    channel - string - 'general'
-      The name of the channel for the post.
-    icon_emoji - string - ':ghost:'
-      The emoji to use for the attribution.
-
-  MESSAGES
-    run - Post the message to Slack.
-
-  EXAMPLE
-
-    slack [slack] :
-    	uri [string] : https://hooks.slack.com/services/MYTOKEN
-    	message [string] : Slackbot is here to help!
-    	username [string] : SlackBot
-    	channel [string] : general
-    	icon_emoji [string] : :ghost:
-
-  SEE ALSO
-    http_get, http_post, json, uri

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