gloo 0.6.1 → 0.7.0

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

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

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

data/lib/gloo/help/objs/ror/erb.txt

@@ -0,0 +1,37 @@
+ERB OBJECT TYPE
+  NAME: erb
+  SHORTCUT: erb
+
+  DESCRIPTION
+    Use the ERB templating system to generate content.
+
+  CHILDREN
+    template - text
+      The template that will be used the the ERB object is run.
+    params - container
+      The collection of children values that will be used
+      when the template object is rendered.
+    result - text
+      The result of the template rendering.
+
+  MESSAGES
+    run - Render the result based on the template and the
+          parameter values.
+
+  EXAMPLE
+
+    e [can] :
+    	erb [erb] :
+    		template [text] : BEGIN
+    			Hello <%= first %> <%= last %>!
+    			END
+    		params [container] :
+    			first [string] : Eric
+    			last [string] : Crane
+    		result [text] :
+    	on_load [script] :
+    		run e.erb
+    		show e.erb.result
+
+  SEE ALSO
+    eval, system

data/lib/gloo/help/objs/ror/eval.txt

@@ -0,0 +1,24 @@
+EVAL OBJECT TYPE
+  NAME: eval
+  SHORTCUT: ruby
+
+  DESCRIPTION
+    Execute a ruby expression.
+
+  CHILDREN
+    command - string
+      The ruby expression or command that will be run.
+    result - string
+      The result of the command or expression after it is run.
+
+  MESSAGES
+    run - Execute the ruby command and update the result.
+
+  EXAMPLE
+
+    eval [ruby] :
+      command [string] : 3 * 7
+  	  result [string] : 21
+
+  SEE ALSO
+    system, erb

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

@@ -0,0 +1,23 @@
+PLAY OBJECT TYPE
+  NAME: play
+  SHORTCUT: play
+
+  DESCRIPTION
+    Play an audio file, an MP3 for example.
+    The value of the play object is the path to the audio file.
+
+  CHILDREN
+    None.
+
+  MESSAGES
+    run - Play the audio file.
+
+  EXAMPLE
+
+    play [can] :
+    	snd [play] : ~/path/to/snd.mp3
+    	on_load [script] :
+    		run play.snd
+
+  SEE ALSO
+    say, beep

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

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

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

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

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