gloo 0.5.3 → 0.7.1

data/lib/gloo/help/objs/cli/confirm.txt

@@ -0,0 +1,26 @@
+CONFIRM OBJECT TYPE
+  NAME: confirm
+  SHORTCUT: confirm
+
+  DESCRIPTION
+    CLI confirmation prompt.
+
+  CHILDREN
+    prompt - string - '> '
+      The confirmation prompt.
+    result - boolean - none
+      The result of the prompt.
+
+  MESSAGES
+    run - Prompt the user and then set the result.
+
+  EXAMPLE
+
+    confirm [confirm] :
+    	prompt [string] : Are you sure?
+    	result [boolean] :
+    	on_load [script] :
+    		run confirm
+    		show 'Confirmed: ' + confirm.result
+
+  SEE ALSO

data/lib/gloo/help/objs/cli/menu.txt

@@ -0,0 +1,44 @@
+MENU OBJECT TYPE
+  NAME: menu
+  SHORTCUT: menu
+
+  DESCRIPTION
+    A CLI menu.
+    This can be used for the main loop of a CLI application.
+
+  CHILDREN
+    prompt - string - '> '
+      The shortcut may be used to select the  menu item.
+    items - container
+      A textual description of the menu item action.
+    loop - boolean
+      The script that will be run if the menu item is selected.
+    default - script
+      Optional script element. Run this if no other option selected.
+
+  MESSAGES
+    run - Show the options and the the prompt.
+      Then run the script for the user's selection.
+      Optionally repeat as long as the loop child is true.
+
+  EXAMPLE
+
+    menu [menu] :
+    	on_load [script] :
+    		run menu
+    	prompt [string] : >
+    	loop [bool] : true
+    	items [can] :
+    		hw [mitem] :
+    			shortcut [str] : hw
+    			description [str] : Run Hello World
+    			do [script] :
+            show 'Hello World!'
+    		q [mitem] :
+    			shortcut [str] : q
+    			description [str] : Quit this menu
+    			do [script] :
+            put false into menu.loop
+
+  SEE ALSO
+    menu_item

data/lib/gloo/help/objs/cli/menu_item.txt

@@ -0,0 +1,26 @@
+MENU_ITEM OBJECT TYPE
+  NAME: menu_item
+  SHORTCUT: mitem
+
+  DESCRIPTION
+    A CLI menu item.  One element in a CLI menu.
+
+  CHILDREN
+    shortcut - string
+      The shortcut may be used to select the  menu item.
+      The shortcut child is optional.  If it is not provided,
+      the name of the menu item will be used instead.
+    description - string
+      A textual description of the menu item action.
+      The description child is optional.  If it is not provided,
+      the value of the menu item will be used instead.
+    do - script
+      The script that will be run if the menu item is selected.
+
+  MESSAGES
+    None
+
+  EXAMPLE
+
+  SEE ALSO
+    menu

data/lib/gloo/help/objs/cli/pastel.txt

@@ -0,0 +1,43 @@
+PASTEL OBJECT TYPE
+  NAME: pastel
+  SHORTCUT: pastel
+
+  DESCRIPTION
+    Show colorized text with the pastel gem.
+
+  CHILDREN
+    text - string
+      The text that will be colorized.
+    color - string
+      The colors.  See pastel for options.
+
+  MESSAGES
+    show - Show the colorized text.
+
+  EXAMPLE
+
+    pastel [can] :
+      on_load [script] :
+        tell pastel.one to show
+        tell pastel.two to show
+        tell pastel.three to show
+        tell pastel.four to show
+        tell pastel.five to show
+      one [pastel] :
+        text [string] : Something New
+        color [string] : white on_green
+      two [pastel] :
+        text [string] : Star Wars
+        color [string] : red
+      three [pastel] :
+        text [string] : Many_Dimensions
+        color [string] : blue
+      four [pastel] :
+        text [string] : As An Arrow
+        color [string] : yellow on_blue
+      five [pastel] :
+        text [string] : Cranium
+        color [string] : white on_yellow
+
+  SEE ALSO
+    colorize

data/lib/gloo/help/objs/cli/prompt.txt

@@ -0,0 +1,27 @@
+PROMPT OBJECT TYPE
+  NAME: prompt
+  SHORTCUT: ask
+
+  DESCRIPTION
+    CLI prompt for user input.
+
+  CHILDREN
+    prompt - string - '> '
+      The prompt displayed to the user.
+    result - string - none
+      The result with the user's input.
+
+  MESSAGES
+    run - Prompt the user and then set the result.
+    multiline - Show a multiline prompt.
+
+  EXAMPLE
+
+    ask [ask] :
+    	prompt [string] : What is your name?
+    	result [string] :
+    	on_load [script] :
+    		run ask
+    		show 'Hello, ' + ask.result + '!  Thanks for playing'
+
+  SEE ALSO

data/lib/gloo/help/objs/cli/select.txt

@@ -0,0 +1,34 @@
+SELECT OBJECT TYPE
+  NAME: select
+  SHORTCUT: sel
+
+  DESCRIPTION
+    Prompt for user to select from a list of options.
+
+  CHILDREN
+    prompt - string - '> '
+      The prompt displayed to the user.
+    options - container
+      The list of options for the selection list.
+      The name of each option will be presented to the user, but
+      the value will be put in the result.
+    result - string - none
+      The result with the user's selection.
+
+  MESSAGES
+    run - Prompt the user for a selection and then set the result.
+
+  EXAMPLE
+
+    select [select] :
+    	prompt [string] : What is your favorite color?
+      options [can] :
+        red : r
+        green : g
+        blue : b
+    	result [string] :
+    	on_load [script] :
+    		run select
+    		show select.result
+
+  SEE ALSO

data/lib/gloo/help/objs/ctrl/each.txt

@@ -0,0 +1,48 @@
+EACH OBJECT TYPE
+  NAME: each
+  SHORTCUT: each
+
+  DESCRIPTION
+    Perform an action for each item in a collection.
+
+  CHILDREN
+    child | word | line | repo - string - none
+      The entity we want to loop for.
+      It will hold the current value while the script is running.
+    in - string - none
+      The collection we will iterate in.
+      In the case of <word> or <line> this will be a string or text.
+      In the case of <repo> this will be the root path.
+    do - script - none
+      The action we want to perform for each found item.
+
+  MESSAGES
+    run - Look through the collecion and perform this for each
+      found item.
+
+  EXAMPLE
+
+    #
+    # Show each child in a container.
+    #
+
+    for [each] :
+    	child [alias] :
+    	in [alias] : objs
+    	do [script] : show for.child
+    objs [can] :
+      1 [string] : one
+      2 [string] : two
+      3 [string] : three
+
+    #
+    # Show each word in a string.
+    #
+
+    for [each] :
+    	word [string] :
+    	in [string] : one word at a time
+    	do [script] : show for.word
+
+
+  SEE ALSO

data/lib/gloo/help/objs/ctrl/repeat.txt

@@ -0,0 +1,38 @@
+REPEAT OBJECT TYPE
+  NAME: repeat
+  SHORTCUT: repeat
+
+  DESCRIPTION
+    Run a script a given number of times.
+
+  CHILDREN
+    times integer - 0
+      The number of times to run the script.
+    index integer - 0
+      The current iteration when the repeat loop is running.
+    do - script - none
+      The action we want to perform for iteration of the loop.
+
+  MESSAGES
+    run - Run the script for the given number of times.
+
+  EXAMPLE
+
+    repeat [can] :
+      s [string] :
+      on_load [script] :
+        put $.screen_cols / 2 into repeat.x.times
+        tell repeat.x to run
+        show repeat.s
+        tell repeat.y to run
+        show repeat.s
+      x [repeat] :
+        times [integer] : 30
+        index [integer] : 0
+        do [script] : put repeat.s + '-' into repeat.s
+      y [repeat] :
+        times [integer] : 10
+        index [integer] : 0
+        do [script] : show repeat.y.index
+
+  SEE ALSO

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

@@ -0,0 +1,25 @@
+MARKDOWN OBJECT TYPE
+  NAME: markdown
+  SHORTCUT: md
+
+  DESCRIPTION
+    Markdown data in a text string.
+
+  CHILDREN
+    None
+
+  MESSAGES
+    show - Show the markdown data in the terminal.
+    page - Show the markdown data in the terminal, paginated.
+
+  EXAMPLE
+
+    md [can] :
+      f [file] : 
+      on_load [script] :
+        put $.gloo.projects + "/o/data/txt.md" into md.f
+        tell md.f to read (md.data)
+    		tell md.data to show
+    	data [md] :
+
+  SEE ALSO

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

@@ -0,0 +1,46 @@
+TABLE OBJECT TYPE
+  NAME: table
+  SHORTCUT: tbl
+
+  DESCRIPTION
+    A data table.
+
+  CHILDREN
+    headers - container
+      A list of headers.
+      The name of the header object needs to be the same as the
+      name of the object in the data container.
+      The value of the header is what will be displayed.
+    data - container
+      The table's data.
+      The data container will have one or more containers, each
+      of which represents one row of data.
+
+  MESSAGES
+    show - Show the contents of the table in the CLI.
+
+  EXAMPLE
+
+    t [tbl] :
+    	on_load [script] :
+    		tell t to show
+    	headers [can] :
+        name : Name
+        phone : Tel
+        notes : Notes
+    	data [alias] : table_data
+    table_data [can] :
+      1 [can] :
+        name : Joe
+        phone : 312-555-1212
+        notes : Play golf with Joe
+      2 [can] :
+        name : Sally
+        phone : 708-555-1212
+        notes : met Sally at the meetup last week
+      3 [can] :
+        name : Frank
+        phone : 312-555-1213
+        notes : Frank Lee Speaking
+
+  SEE ALSO

data/lib/gloo/help/objs/dev/git_repo.txt

@@ -0,0 +1,35 @@
+GIT OBJECT TYPE
+  NAME: git_repo
+  SHORTCUT: git
+
+  DESCRIPTION
+    Reference to a git repository in the file system.
+    The value of the git_repo objectd is a string.
+    There are no children needed.
+
+  CHILDREN
+    None
+
+  MESSAGES
+    validate - Validate that this is a git repo.
+    check_changes - Check to see if there are any pending changes.
+    get_changes - Get the list of pending changes.
+    commit - Commit changes.
+    get_branch - Get the current branch.
+
+  EXAMPLE
+
+    changes [can] :
+    	on_load [script] :
+    		show "Finding repos with local changes..."
+    		put $.user.home + "/dev" into changes.for.in
+    		run changes.for
+    		show  "Done."
+    	for [each] :
+    		repo [git] :
+    		in [string] :
+    		do [script] :
+    			tell changes.for.repo to check_changes
+    			if it then show changes.for.repo
+
+  SEE ALSO

data/lib/gloo/help/objs/dt/date.txt

@@ -0,0 +1,23 @@
+DATE OBJECT TYPE
+  NAME: date
+  SHORTCUT: date
+
+  DESCRIPTION
+    A reference to a date, but without time.
+
+  CHILDREN
+    None
+
+  MESSAGES
+    now - Set to the current system date.
+
+  EXAMPLE
+
+    time [can] :
+    	t [time] :
+    	on_load [script] :
+    		tell time.t to now
+    		show time.t
+
+  SEE ALSO
+    datetime, time

data/lib/gloo/help/objs/dt/datetime.txt

@@ -0,0 +1,24 @@
+DATETIME OBJECT TYPE
+  NAME: datetime
+  SHORTCUT: dt
+
+  DESCRIPTION
+    A reference to a date and time.
+
+  CHILDREN
+    None
+
+  MESSAGES
+    now - Set to the current system date and time.
+
+  EXAMPLE
+
+    dt [can] :
+    	d [datetime] :
+    	on_load [script] :
+    		tell dt.d to now
+    		show dt.d
+      next [script] : put '1 week from now' into dt.d
+
+  SEE ALSO
+    date, time