gloo 0.6.1 → 0.7.0

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

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

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

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

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

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

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

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

@@ -73,39 +73,6 @@ module Gloo
         return ln.resolve
       end
 
-      # ---------------------------------------------------------------------
-      #    Help
-      # ---------------------------------------------------------------------
-
-      #
-      # Get help for this object type.
-      #
-      def self.help
-        return <<~TEXT
-          ALIAS OBJECT TYPE
-            NAME: alias
-            SHORTCUT: ln
-
-          DESCRIPTION
-            A pointer to another object.
-            Normal path-name references will refere to the aliased object.
-            To refer to the alias itself, add an * at the end of the path-name.
-            This is neeed, for example, to set the value of the alias.
-            The value of the alias is merely the path-name of the
-            referenced object.
-
-          CHILDREN
-            None
-
-          MESSAGES
-            The alias will reflect the mesages of the object to which
-            it points.
-            The alias itself can receive the following message:
-            resolve - Check to see if the object referenced exists.
-                  Sets it to true or false.
-        TEXT
-      end
-
     end
   end
 end