vedeu 0.8.10 → 0.8.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2b0005acf22666df61aa974c5fa63a7a2efe5e8b
-  data.tar.gz: 1534526ad0f0118be2c7d56513bc879a8d3da466
+  metadata.gz: 0bb5fc66d38ef9dbbdad8ea2209c510b335a4fb8
+  data.tar.gz: da7ea21b8fc9004bd0db6661b89b526cc40a10ce
 SHA512:
-  metadata.gz: 19ef391ed3888dde03e08ca67767adb96d46a623d1b7a472b53eb55dc3bf6835caaf790610a88275b16162c79bad110e0338a122dff7ebb2bdd648fd530c7af2
-  data.tar.gz: 7cae3f72bfc99f04dbd03dc9b6f4b20e620bb18d3850395da822b506856b6a61b2c98095fa33f338825d90c87d4203887212d66abcef100e321b7f008dad6e86
+  metadata.gz: 4b3cf2c29c24ddf35b1da2926b8d172035c3592e95e00f2ec589bc0d82c373b3d4471b1df6695afa15097f5e483c2cf3689c82e3db83271126d730c254895cc7
+  data.tar.gz: cf9b359cf05f70b9ea6093712fc57efae2379e6864a8311f64e6c0896b86441d2629e70b4f9683d7f7945826c57c5d494a2e7e51410c51135bed9b469c975733

data/.yardopts

@@ -1,6 +1,5 @@
 --private
 --protected
---embed-mixins
 --tag api_method:"API Method"
 --tag api_event:"API Event"
 -

data/docs/api.md

@@ -143,7 +143,7 @@ Repository method. Access registered events.
 
     Vedeu.events # [Vedeu::Events::Repository]
 
-    Vedeu.events.all # [Array<Vedeu::Events::Collection>]
+    Vedeu.events.all # [Array<Vedeu::Events::Events>]
 
 ### Vedeu.foreground_colours
 

data/docs/dsl/by_method/add_command.md

@@ -1,3 +1,4 @@
+### Vedeu.add_command
 Add a command (a collection of characters/keypresses from a
 Vedeu::Editor::Document) to the store. Used by Vedeu internally to
 store commands entered.

data/docs/dsl/by_method/add_keypress.md

@@ -1,3 +1,4 @@
+### Vedeu.add_keypress
 Add a keypress to the store. Used by Vedeu internally to store a
 keypress entered.
 

data/docs/dsl/by_method/all_commands.md

@@ -1,3 +1,4 @@
+### Vedeu.all_commands
 Returns an array of all commands received by Vedeu.
 
     Vedeu.all_commands

data/docs/dsl/by_method/all_keypresses.md

@@ -1,3 +1,4 @@
+### Vedeu.all_keypresses
 Returns an array of all keypresses received by Vedeu.
 
     Vedeu.all_keypresses

data/docs/dsl/by_method/background_colours.md

@@ -1,3 +1,4 @@
+### Vedeu.background_colours
 Manipulate the repository of background colours.
 
     Vedeu.background_colours

data/docs/dsl/by_method/bind.md

@@ -1,3 +1,4 @@
+### Vedeu.bind
 Register an event by name with optional delay (throttling)
 which when triggered will execute the code contained within
 the passed block.

data/docs/dsl/by_method/bind_alias.md

@@ -1,3 +1,4 @@
+### Vedeu.bind_alias
 Add events by name to the alias name group. When an alias is
 triggered, all the events stored in the group are also triggered.
 

data/docs/dsl/by_method/borders.md

@@ -1,3 +1,4 @@
+### `borders`
 Repository method. Access registered borders.
 
     Vedeu.borders # [Vedeu::Borders::Repository]

data/docs/dsl/by_method/bottom.md

@@ -1,3 +1,4 @@
+### `bottom`
 Enable/disable the bottom border.
 
     Vedeu.border :border_demo do

data/docs/dsl/by_method/bottom_horizontal.md

@@ -1,3 +1,4 @@
+### `bottom_horizontal`
 Set the character to be used to draw the bottom horizontal
 part of the border.
 

data/docs/dsl/by_method/bottom_left.md

@@ -1,3 +1,4 @@
+### `bottom_left`
 Set the character to be used to draw the bottom left corner of the
 border.
 

data/docs/dsl/by_method/bottom_right.md

@@ -1,3 +1,4 @@
+### `bottom_right`
 Set the character to be used to draw the bottom right corner
 of the border.
 

data/docs/dsl/by_method/bound.md

@@ -1,3 +1,4 @@
+### Vedeu.bound?
 Check if an event by name has been registered.
 
     Vedeu.bound?(:some_event)

data/docs/dsl/by_method/buffer_update.md

@@ -1,3 +1,6 @@
-Write the given output to the configured or default renderers.
+### Vedeu.buffer_update
+
+Update the terminal buffer with the given output ready to be rendered
+by the configured or default renderers.
 
     Vedeu.buffer_update(output)

data/docs/dsl/by_method/buffer_write.md

@@ -1,3 +1,7 @@
-Write the given output to the configured or default renderers.
+### Vedeu.buffer_write
+
+Write the given output to the terminal buffer. Once written, the
+terminal buffer is then refreshed- sending its contents to the
+configured or default renderers.
 
     Vedeu.buffer_write(output)

data/docs/dsl/by_method/buffers.md

@@ -1,3 +1,4 @@
+### Vedeu.buffers
 Repository method. Access registered borders.
 
     Vedeu.buffers # [Vedeu::Buffers::Repository]

data/docs/dsl/by_method/caption.md

@@ -1,3 +1,4 @@
+### `caption`
 If you have you are showing a bottom border, you could add a caption.
 
     Vedeu.border :border_demo do

data/docs/dsl/by_method/clear.md

@@ -1,3 +1,4 @@
+### Vedeu.clear
 Clears the whole terminal space.
 
     Vedeu.clear

data/docs/dsl/by_method/clear_by_group.md

@@ -1 +1,2 @@
+### Vedeu.clear_by_group
 @todo Add more documentation.

data/docs/dsl/by_method/clear_by_name.md

@@ -1 +1,2 @@
+### Vedeu.clear_by_name
 @todo Add more documentation.

data/docs/dsl/by_method/clear_content_by_name.md

@@ -1 +1,2 @@
+### Vedeu.clear_content_by_name
 @todo Add more documentation.

data/docs/dsl/by_method/configuration.md

@@ -1,3 +1,4 @@
+### Vedeu.configuration
 Returns the configuration singleton.
 
 Append configuration methods to access the configuration variable.

data/docs/dsl/by_method/configure.md

@@ -1,3 +1,4 @@
+### Vedeu.configure
 Provides the mechanism to configure Vedeu. If the client application
 sets options, override the defaults with those.
 

data/docs/dsl/by_method/cursor.md

@@ -1,3 +1,4 @@
+### Vedeu.cursor
 Fetch the cursor of the currently focussed interface/view.
 
     Vedeu.cursor

data/docs/dsl/by_method/cursors.md

@@ -1,3 +1,4 @@
+### Vedeu.cursors
 Manipulate the repository of cursors.
 
     Vedeu.cursors

data/docs/dsl/by_method/debug.md

@@ -1,3 +1,4 @@
+### Vedeu.debug
 Drop into a debugging session within a running client application,
 courtesy of 'pry'. Will raise an exception if 'pry' is not available.
 

data/docs/dsl/by_method/direct_write.md

@@ -1,3 +1,8 @@
-Write the given output to the configured or default renderers.
+### Vedeu.direct_write
+
+Write the given output directly to the configured or default
+renderers. Using this method will not write the output to the terminal
+buffer. It is used mainly for sending individual escape sequences to
+the terminal- such as those which hide and show the cursor.
 
     Vedeu.direct_write(output)

data/docs/dsl/by_method/disable.md

@@ -1,3 +1,4 @@
+### `disable!`
 Disable the border:
 
     Vedeu.border :border_demo do

data/docs/dsl/by_method/documents.md

@@ -1 +1,2 @@
+### Vedeu.documents
 @todo Add more documentation.

data/docs/dsl/by_method/drb_restart.md

@@ -1 +1,2 @@
+### Vedeu.drb_restart
 @todo Add more documentation.

data/docs/dsl/by_method/drb_start.md

@@ -1 +1,2 @@
+### Vedeu.drb_start
 @todo Add more documentation.

data/docs/dsl/by_method/drb_status.md

@@ -1 +1,2 @@
+### Vedeu.drb_status
 @todo Add more documentation.

data/docs/dsl/by_method/drb_stop.md

@@ -1 +1,2 @@
+### Vedeu.drb_stop
 @todo Add more documentation.

data/docs/dsl/by_method/enable.md

@@ -1,3 +1,4 @@
+### `enable!`
 Enable the border:
 (Borders are enabled by default when defined for an interface).
 

data/docs/dsl/by_method/esc.md

@@ -0,0 +1,50 @@
+### Vedeu.esc
+Provides access to various escape sequences defined by Vedeu.
+
+#### Colour escape sequences
+The examples below show two ways to use the escape sequences defined
+by Vedeu.
+
+- When a block is given, the background or foreground is reset back to
+  the default background or foreground when the block exits.
+- When a block is given, we can nest.
+- When a block is not given, the escape sequence for the respective
+  background or foreground is returned.
+
+    ```ruby
+    # Produces the `\e[31m` foreground escape sequence for 'red'.
+    Vedeu.esc.red
+
+    # Produces `\e[32mgrass\e[39m`; effectively rendering the word
+    # 'grass' as green, and returning to the default terminal
+    # foreground colour.
+    Vedeu.esc.green { 'grass' }
+
+    # Produces `\e[31mred \e32mgreen\e[39m\e[39m`; as nesting is
+    # permitted with these directives.
+    Vedeu.esc.red { 'red ' + Vedeu.esc.green { 'green' } }
+    ```
+
+- Valid named colours are:
+
+    ```ruby
+    | Foreground    | Code | Background       | Code |
+    |---------------|------|------------------|------|
+    | black         | 30   | on_black         | 40   |
+    | red           | 31   | on_red           | 41   |
+    | green         | 32   | on_green         | 42   |
+    | yellow        | 33   | on_yellow        | 43   |
+    | blue          | 34   | on_blue          | 44   |
+    | magenta       | 35   | on_magenta       | 45   |
+    | cyan          | 36   | on_cyan          | 46   |
+    | light_grey    | 37   | on_light_grey    | 47   |
+    | default       | 39   | on_default       | 49   |
+    | dark_grey     | 90   | on_dark_grey     | 100  |
+    | light_red     | 91   | on_light_red     | 101  |
+    | light_green   | 92   | on_light_green   | 102  |
+    | light_yellow  | 93   | on_light_yellow  | 103  |
+    | light_blue    | 94   | on_light_blue    | 104  |
+    | light_magenta | 95   | on_light_magenta | 105  |
+    | light_cyan    | 96   | on_light_cyan    | 106  |
+    | white         | 97   | on_white         | 107  |
+    ```

data/docs/dsl/by_method/events.md

@@ -1 +1,2 @@
+### Vedeu.events
 @todo Add more documentation.

data/docs/dsl/by_method/exit.md

@@ -1 +1,2 @@
+### Vedeu.exit
 @todo Add more documentation.

data/docs/dsl/by_method/focus.md

@@ -1 +1,2 @@
+### Vedeu.focus
 @todo Add more documentation.

data/docs/dsl/by_method/focus_by_name.md

@@ -1,3 +1,4 @@
+### Vedeu.focus_by_name
 Instruct Vedeu to focus the view with the given name.
 
 @todo Add more documentation

data/docs/dsl/by_method/focus_next.md

@@ -1,3 +1,4 @@
+### Vedeu.focus_next
 Instruct Vedeu to focus the next visible view.
 
     Vedeu.focus_next

data/docs/dsl/by_method/focus_previous.md

@@ -1,3 +1,4 @@
+### Vedeu.focus_previous
 Instruct Vedeu to focus the previous visible view.
 
     Vedeu.focus_previous

data/docs/dsl/by_method/focussed.md

@@ -1 +1,2 @@
+### Vedeu.focussed
 @todo Add more documentation.

data/docs/dsl/by_method/foreground_colours.md

@@ -1,3 +1,4 @@
+### Vedeu.foreground_colours
 Manipulate the repository of foreground colours.
 
     Vedeu.foreground_colours

data/docs/dsl/by_method/geometries.md

@@ -1 +1,2 @@
+### Vedeu.geometries
 @todo Add more documentation.

data/docs/dsl/by_method/geometry.md

@@ -1,3 +1,4 @@
+### Vedeu.geometry
 Specify the geometry of an interface or view with a simple DSL.
 
     # Standalone (preferred):

data/docs/dsl/by_method/goto.md

@@ -1,3 +1,4 @@
+### Vedeu.goto
 Instruct Vedeu to load the client application controller action with
 parameters.
 

data/docs/dsl/by_method/group.md

@@ -1 +1,2 @@
+### Vedeu.group
 @todo Add more documentation.

data/docs/dsl/by_method/groups.md

@@ -1 +1,2 @@
+### Vedeu.group
 @todo Add more documentation.

data/docs/dsl/by_method/height.md

@@ -1,3 +1,4 @@
+### Vedeu.height
 Returns the total height (number of rows/lines) of the current
 terminal.
 

data/docs/dsl/by_method/hide_cursor.md

@@ -1 +1,2 @@
+### Vedeu.hide_cursor
 @todo Add more documentation.

data/docs/dsl/by_method/hide_group.md

@@ -1 +1,2 @@
+### Vedeu.hide_group
 @todo Add more documentation.

data/docs/dsl/by_method/hide_interface.md

@@ -1 +1,2 @@
+### Vedeu.hide_interface
 @todo Add more documentation.

data/docs/dsl/by_method/horizontal.md

@@ -1,3 +1,4 @@
+### `horizontal`
 Set the character to be used to draw a horizontal part of the border.
 
     Vedeu.border :border_demo do

data/docs/dsl/by_method/interface.md

@@ -1 +1,2 @@
+### Vedeu.interface
 @todo Add more documentation.

data/docs/dsl/by_method/interfaces.md

@@ -1 +1,2 @@
+### Vedeu.interfaces
 @todo Add more documentation.

data/docs/dsl/by_method/keymap.md

@@ -1 +1,2 @@
+### Vedeu.keymap
 @todo Add more documentation.

data/docs/dsl/by_method/keymaps.md

@@ -1 +1,2 @@
+### Vedeu.keymaps
 @todo Add more documentation.

data/docs/dsl/by_method/keypress.md

@@ -0,0 +1,2 @@
+### Vedeu.keypress
+@todo Add more documentation.

data/docs/dsl/by_method/last_command.md

@@ -1,3 +1,4 @@
+### Vedeu.last_command
 Access the last command stored. If no commands have been entered since
 the client application started, then this will return nil.
 

data/docs/dsl/by_method/last_keypress.md

@@ -1,3 +1,4 @@
+### Vedeu.last_keypress
 Access the last keypress stored. If no keys have been pressed since
 the client application started, then this will return nil.
 

data/docs/dsl/by_method/left.md

@@ -1,3 +1,4 @@
+### `left`
 Enable/disable the left border.
 
     Vedeu.border :border_demo do

data/docs/dsl/by_method/left_vertical.md

@@ -1,3 +1,4 @@
+### `left_vertical`
 Set the character to be used to draw the left vertical part of
 the border.
 

data/docs/dsl/by_method/log.md

@@ -1 +1,2 @@
+### Vedeu.log
 @todo Add more documentation.

data/docs/dsl/by_method/log_stderr.md

@@ -1,3 +1,4 @@
+### Vedeu.log_stderr
 Write a message to STDERR. Will also attempt to write to the log file
 if configured for later reference.
 

data/docs/dsl/by_method/log_stdout.md

@@ -1,3 +1,4 @@
+### Vedeu.log_stdout
 Write a message to STDOUT. Will also attempt to write to the log file
 if configured for later reference.
 

data/docs/dsl/by_method/log_timestamp.md

@@ -1,3 +1,4 @@
+### Vedeu.log_timestamp
 Returns a formatted timestamp indicating the number of seconds the
 client application has been running.
 

data/docs/dsl/by_method/menu.md

@@ -1 +1,2 @@
+### Vedeu.menu
 @todo Add more documentation.

data/docs/dsl/by_method/menus.md

@@ -1 +1,2 @@
+### Vedeu.menus
 @todo Add more documentation.

data/docs/dsl/by_method/profile.md

@@ -1,3 +1,4 @@
+### Vedeu.profile
 Allow debugging via the creation of stack traces courtesy of
 'ruby-prof'. Will raise an exception if 'ruby-prof' is not available.
 

data/docs/dsl/by_method/ready.md

@@ -1 +1,2 @@
+### Vedeu.ready
 @todo Add more documentation.

data/docs/dsl/by_method/refresh.md

@@ -1,3 +1,4 @@
+### Vedeu.refresh
 Send the cells to the renderer and return the rendered result.
 
     Vedeu.refresh

data/docs/dsl/by_method/render_output.md

@@ -1,3 +1,7 @@
-Write the given output to the configured or default renderers.
+### Vedeu.render_output
+
+When the given output is an escape sequence, it is directly written to
+the terminal, bypassing the buffer. Otherwise, it is written to the
+terminal buffer, and then the terminal buffer is refreshed.
 
     Vedeu.render_output(output)

data/docs/dsl/by_method/renderer.md

@@ -1 +1,2 @@
+### Vedeu.renderer
 @todo Add more documentation.

data/docs/dsl/by_method/renderers.md

@@ -1 +1,2 @@
+### Vedeu.renderers
 @todo Add more documentation.

data/docs/dsl/by_method/resize.md

@@ -1,3 +1,4 @@
+### Vedeu.resize
 When the terminal emit the 'SIGWINCH' signal, Vedeu can intercept this
 and attempt to redraw the current interface with varying degrees of
 success. Can also be used to simulate a terminal resize.

data/docs/dsl/by_method/right.md

@@ -1,3 +1,4 @@
+### `right`
 Enable/disable the right border.
 
     Vedeu.border :border_demo do

data/docs/dsl/by_method/right_vertical.md

@@ -1,3 +1,4 @@
+### `right_vertical`
 Set the character to be used to draw the right vertical part
 of the border.
 

data/docs/dsl/by_method/show_cursor.md

@@ -1 +1,2 @@
+### Vedeu.show_cursor
 @todo Add more documentation.

data/docs/dsl/by_method/show_group.md

@@ -1 +1,2 @@
+### Vedeu.show_group
 @todo Add more documentation.

data/docs/dsl/by_method/show_interface.md

@@ -1 +1,2 @@
+### Vedeu.show_interface
 @todo Add more documentation.

data/docs/dsl/by_method/timer.md

@@ -1,3 +1,4 @@
+### Vedeu.timer
 Measure the execution time of the code in the given block.
 
 The optional message provided will have ' took <time>ms.' appended and

data/docs/dsl/by_method/title.md

@@ -1,3 +1,4 @@
+### `title`
 If you have you are showing a top border, you could add a
 title.
 

data/docs/dsl/by_method/toggle_cursor.md

@@ -1 +1,2 @@
+### Vedeu.cursor
 @todo Add more documentation.

data/docs/dsl/by_method/toggle_group.md

@@ -1 +1,2 @@
+### Vedeu.toggle_group
 @todo Add more documentation.

data/docs/dsl/by_method/toggle_interface.md

@@ -1 +1,2 @@
+### Vedeu.toggle_interface
 @todo Add more documentation.

data/docs/dsl/by_method/top.md

@@ -1,3 +1,4 @@
+### `top`
 Enable/disable the top border.
 
     Vedeu.border :border_demo do

data/docs/dsl/by_method/top_horizontal.md

@@ -1,3 +1,4 @@
+### `top_horizontal`
 Set the character to be used to draw the top horizontal part
 of the border.
 

data/docs/dsl/by_method/top_left.md

@@ -1,3 +1,4 @@
+### `top_left`
 Set the character to be used to draw the top left corner of
 the border.
 

data/docs/dsl/by_method/top_right.md

@@ -1,3 +1,4 @@
+### `top_right`
 Set the character to be used to draw the top right corner of
 the border.
 

data/docs/dsl/by_method/trigger.md

@@ -1 +1,2 @@
+### Vedeu.trigger
 @todo Add more documentation.

data/docs/dsl/by_method/unbind.md

@@ -1,3 +1,4 @@
+### Vedeu.unbind
 Unbind events from a named handler.
 
 Removes all events associated with the given name.

data/docs/dsl/by_method/unbind_alias.md

@@ -1,3 +1,4 @@
+### Vedeu.unbind_alias
 Remove an alias by name. The alias name group is destroyed, but events
 stored within this alias are not.
 

data/docs/dsl/by_method/vertical.md

@@ -1,3 +1,4 @@
+### `vertical`
 Set the character to be used to draw a vertical part of the border.
 
     Vedeu.border :border_demo do

data/docs/dsl/by_method/width.md

@@ -1,3 +1,4 @@
+### Vedeu.width
 Returns the total width (number of columns/characters) of the
 current terminal.
 

data/docs/dsl/by_method/write.md

@@ -1,3 +1,4 @@
+### Vedeu.write
 This allows the direct writing to the terminal, unencumbered by the
 framework.