gloo-lang 1.0.1 → 1.2.0

data/lib/gloo_lang/help/objs/basic/untyped.txt

@@ -1,22 +0,0 @@
-UNTYPED OBJECT TYPE
-  NAME: untyped
-  SHORTCUT: un
-
-  DESCRIPTION
-    An untyped object.
-    If no type is specified when an object is created it
-    will be of this type.
-
-  CHILDREN
-    None
-
-  MESSAGES
-    None
-
-  EXAMPLE
-
-    > create x
-    > put 1 into x
-    > put 'string' into x
-
-  SEE ALSO

data/lib/gloo_lang/help/objs/cli/banner.txt

@@ -1,49 +0,0 @@
-BANNER OBJECT TYPE
-  NAME: banner
-  SHORTCUT: ban
-
-  DESCRIPTION
-    Banner text in large, colored font.
-
-  CHILDREN
-    text - string
-      The text for the banner.
-    style - string
-      The banner style.  See tty-font for options.
-    color - string
-      The color for the banner.  See pastel for options.
-
-  MESSAGES
-    show - Show the text banner.
-
-  EXAMPLE
-
-    ban [can] :
-      on_load [script] :
-        tell ban.one to show
-        tell ban.two to show
-        tell ban.three to show
-        tell ban.four to show
-        tell ban.five to show
-      one [banner] :
-        text [string] : Something New
-        style [string] : standard
-        color [string] : white on_green
-      two [banner] :
-        text [string] : Star Wars
-        style [string] : starwars
-        color [string] : red
-      three [banner] :
-        text [string] : Many_Dimensions
-        style [string] : 3d
-        color [string] : blue
-      four [banner] :
-        text [string] : As An Arrow
-        style [string] : straight
-        color [string] : yellow
-      five [banner] :
-        text [string] : Cranium
-        style [string] : block
-        color [string] : white on_yellow
-
-  SEE ALSO

data/lib/gloo_lang/help/objs/cli/bar.txt

@@ -1,37 +0,0 @@
-BAR OBJECT TYPE
-  NAME: bar
-  SHORTCUT: bar
-
-  DESCRIPTION
-    CLI progress bar
-
-  CHILDREN
-    name - string
-      The name of the progress bar.
-    total - integer - 100
-      The total for the bar.
-
-  MESSAGES
-    start - Start the bar.
-    advance <amount> - Advance by the given amount.
-    stop - Complete the bar.
-    run <seconds> - Run for the given number of seconds
-      and advance the bar so that it completes at the end
-      of the time specified.
-
-  EXAMPLE
-
-    bar [can] :
-      on_load [script] :
-        tell bar.progress to start
-        tell bar.progress to advance
-        wait
-        tell bar.progress to advance (30)
-        wait
-        tell bar.progress to advance (40)
-        wait
-        tell bar.progress to stop
-      progress [bar] :
-        name [string] : going
-
-  SEE ALSO

data/lib/gloo_lang/help/objs/cli/colorize.txt

@@ -1,33 +0,0 @@
-COLORIZE OBJECT TYPE
-  NAME: colorize
-  SHORTCUT: color
-
-  DESCRIPTION
-    The Colorize object can be used to write output in color.
-    The Colorize container can contain multiple strings, each
-    one can have a different color as specified by the names
-    of the children.
-
-  CHILDREN
-    <color> - string - no default value
-      The name of the child or children is the color.
-      The string's value is what will be written out.
-
-  MESSAGES
-    run - Output the string in the color specified.
-
-  EXAMPLE
-
-    color [can] :
-    	w [colorize] :
-    		white [string] : This is white!
-    	m [colorize] :
-    		red [string] : red -
-    		green [string] : green -
-    		blue [string] : blue
-    	on_load [script] :
-    		run color.w
-    		run color.m
-
-  SEE ALSO
-    pastel

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

@@ -1,26 +0,0 @@
-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_lang/help/objs/cli/menu.txt

@@ -1,44 +0,0 @@
-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_lang/help/objs/cli/menu_item.txt

@@ -1,26 +0,0 @@
-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_lang/help/objs/cli/pastel.txt

@@ -1,43 +0,0 @@
-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_lang/help/objs/cli/prompt.txt

@@ -1,27 +0,0 @@
-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_lang/help/objs/cli/select.txt

@@ -1,34 +0,0 @@
-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_lang/help/objs/ctrl/each.txt

@@ -1,48 +0,0 @@
-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_lang/help/objs/ctrl/repeat.txt

@@ -1,38 +0,0 @@
-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_lang/help/objs/data/markdown.txt

@@ -1,25 +0,0 @@
-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_lang/help/objs/data/mysql.txt

@@ -1,40 +0,0 @@
-SYSTEM OBJECT TYPE
-  NAME: mysql
-  SHORTCUT: mysql
-
-  DESCRIPTION
-    A MySQL database connection.
-
-  CHILDREN
-    host - string
-      The database server host
-    database - string
-      The name of the database.
-    username - string
-      The username with which to connect.
-    pasword - string
-      The user's password.
-
-  MESSAGES
-    verify - Verify that the database connection can be established.
-
-  EXAMPLE
-
-    mysql [can] :
-      on_load [script] :
-        run mysql.get_passwd
-        run mysql.sql
-      db [mysql] :
-        host : localhost
-        database : my_database
-        username : my_user
-        password [alias] : mysql.get_passwd.result
-      sql [query] :
-        database [alias] : mysql.db
-        sql : SELECT first, last, phone FROM people
-      get_passwd [ask] :
-        prompt [string] : Database Password?
-        result [string] :
-
-  SEE ALSO
-    query, sqlite

data/lib/gloo_lang/help/objs/data/query.txt

@@ -1,37 +0,0 @@
-SYSTEM OBJECT TYPE
-  NAME: query
-  SHORTCUT: sql
-
-  DESCRIPTION
-    A SQL Query.
-    A SELECT, INSERT, UPDATE or other SQL statement.
-    The query requires a valid database connection.
-
-  CHILDREN
-    database - string
-      The name of the database.
-    sql - string
-      The SQL query to execute.
-    result - container
-      The result of the query will be a container for each row,
-      with an object for each column.
-      The result container is optional.  If it is not present,
-      the results will be displayed in the console.
-    params - container
-      Optional list of parameters for the query.
-
-  MESSAGES
-    run - Run the query and get back the data.
-
-  EXAMPLE
-
-    sqlite [can] :
-      on_load [script] : run sqlite.sql
-      db [sqlite] :
-        database : test.db
-      sql [query] :
-        database [alias] : sqlite.db
-        sql : SELECT id, key, value FROM key_values
-
-  SEE ALSO
-    mysql, sqlite

data/lib/gloo_lang/help/objs/data/sqlite.txt

@@ -1,26 +0,0 @@
-SYSTEM OBJECT TYPE
-  NAME: sqlite
-  SHORTCUT: sqlite
-
-  DESCRIPTION
-    A Sqlite3 database connection.
-
-  CHILDREN
-    database - string - 'test.db'
-      The path to the database file.
-
-  MESSAGES
-    verify - Verify that the database connection can be established.
-
-  EXAMPLE
-
-    sqlite [can] :
-      on_load [script] : run sqlite.sql
-      db [sqlite] :
-        database : test.db
-      sql [query] :
-        database [alias] : sqlite.db
-        sql : SELECT id, key, value FROM key_values
-
-  SEE ALSO
-    query, mysql

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

@@ -1,46 +0,0 @@
-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_lang/help/objs/dev/git_repo.txt

@@ -1,36 +0,0 @@
-GIT OBJECT TYPE
-  NAME: git_repo
-  SHORTCUT: git
-
-  DESCRIPTION
-    Reference to a git repository in the file system.
-    The value of the git_repo object 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.
-    review - Review pending changes.
-
-  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_lang/help/objs/dev/stats.txt

@@ -1,36 +0,0 @@
-GIT OBJECT TYPE
-  NAME: stats
-  SHORTCUT: stats
-
-  DESCRIPTION
-    Development project statistics.
-
-  CHILDREN
-    folder - file
-      The project's root folder.
-    types - string
-      The list of code file types.
-      We'll use this to count lines of code and to find the
-      longest files.
-      The list is a string of space-delimited file extensions.
-      For example:  rb erb js
-    skip - string
-      List of files or folders we'll skip while building stats.
-      For example: .git tmp
-
-  MESSAGES
-    show_all - Show all project statistics
-    show_busy_folders - Show a list of folders with the most files
-    show_types - Show file types and counts
-
-  EXAMPLE
-
-    main [can] :
-      stats [stats] :
-        folder [file] : /Users/me/dev/project
-        types [string] : rb erb js
-        skip [string] : .git tmp
-      on_load [script] :
-        tell main.stats to show_all
-
-  SEE ALSO