gloo 0.5.3 → 0.7.1

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

@@ -0,0 +1,25 @@
+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

@@ -0,0 +1,24 @@
+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

@@ -0,0 +1,43 @@
+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

@@ -0,0 +1,33 @@
+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

@@ -0,0 +1,27 @@
+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

@@ -0,0 +1,34 @@
+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

@@ -0,0 +1,37 @@
+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

@@ -0,0 +1,34 @@
+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

@@ -0,0 +1,38 @@
+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

@@ -0,0 +1,42 @@
+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

@@ -0,0 +1,38 @@
+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

@@ -0,0 +1,25 @@
+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

@@ -0,0 +1,41 @@
+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