vedeu 0.6.8 → 0.6.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 43c20341c0356017348e3f761aa1b1371b5d5d53
-  data.tar.gz: bc914cbb3ca7912bc37b6d519edd74caafc71945
+  metadata.gz: aa52a712311446668b8375072ffb067393505997
+  data.tar.gz: 27a321fa1c2ee654042819f339e5cb59a004a472
 SHA512:
-  metadata.gz: bc099e2bab2c7849429e57de5de0549889195bfc19833ee93644a45d609e8426cae6289c3df6e97846fe8d4a2eaecf3219ff4d1d32688387e69c4c2bf76e68af
-  data.tar.gz: 2c28487ea4337f6887775d6eeedf9d77f70766a3e7db89e915f9e61577c7b9103574cf537536b1fac39b0b1ca9762832282fc06de0ed775bae0f6ea868ae410a
+  metadata.gz: f0a88fdd9757f20a6b4533b0e623c442b86487fbe3786293fd34323e1d5435352e73c41f6fe153bab9759eb1183615df21a8de50769aa43db1d57fa18e56b901
+  data.tar.gz: 8d1182b45e8085ce541777444a813919b65f61e2afd0cbfd46d0c6a75cce0743e4e2cea163516240d969def501b6ed3356d3b4235afc75f72cc987c0512a4470

data/.yardopts

@@ -8,3 +8,12 @@ docs/dsl.md
 docs/events.md
 docs/getting_started.md
 docs/object_graph.md
+docs/events/application.md
+docs/events/document.md
+docs/events/drb.md
+docs/events/focus.md
+docs/events/menu.md
+docs/events/movement.md
+docs/events/refresh.md
+docs/events/system.md
+docs/events/visibility.md

data/README.md

@@ -25,7 +25,7 @@ have any problems with either of these operating systems.
 
 To install Vedeu, simply:
 
-    gem install 'vedeu'
+    gem install vedeu
 
 To use Vedeu's application scaffolding, see the
 [RubyDoc](http://www.rubydoc.info/gems/vedeu/file/docs/getting_started.md)

data/docs/api.md

@@ -4,55 +4,47 @@
 Vedeu provides a simple DSL for the creation of terminal/console based
 applications. Below is a list of all the API methods:
 
-```ruby
-class OtherClassInYourApplication
-  # ...
+    class OtherClassInYourApplication
+      # ...
 
-  def some_method
-    Vedeu.some_api_method
-  end
+      def some_method
+        Vedeu.some_api_method
+      end
 
-  # ...
-```
+      # ...
+    end
 
-Note: Nesting indicates where an API method is allowed/supposed to be used.
+## Configuration
 
-### Borders
+See {file:docs/configuration.md}
 
-- Vedeu.border
+## Events
 
-### Configuration
+See {file:docs/events.md}
 
-- Vedeu.configure
-- Vedeu.configuration
+## Borders
 
-### Events
+### Vedeu.border
 
-- Vedeu.bind
-- Vedeu.bind_alias
-- Vedeu.trigger
-- Vedeu.unbind
-- Vedeu.unbind_alias
+## Geometry
 
-### Geometry
+### Vedeu.geometry
 
-- Vedeu.geometry
+## Groups
 
-### Groups
+### Vedeu.group
 
-- Vedeu.group
+## Input
 
-### Input
-
-- Vedeu.keypress
-- Vedeu.keymap
+### Vedeu.keypress
+### Vedeu.keymap
   - key
   - name
   - interface
 
-### Interfaces
+## Interfaces
 
-- Vedeu.interface
+### Vedeu.interface
   - background
   - border
   - cursor
@@ -76,10 +68,10 @@ Note: Nesting indicates where an API method is allowed/supposed to be used.
   - style
   - use
 
-### Views
+## Views
 
-- Vedeu.renders
-- Vedeu.render
+### Vedeu.renders
+### Vedeu.render
   - view
     - colour
     - cursor
@@ -109,48 +101,49 @@ Note: Nesting indicates where an API method is allowed/supposed to be used.
     - name
     - style
   - use
-- Vedeu.views
+
+### Vedeu.views
   - ... as #renders
 
-### Menus
+## Menus
 
-- Vedeu.menu
+### Vedeu.menu
   - items
   - name
 
-### Renderers
+## Renderers
 
-- Vedeu.renderer
-- Vedeu.renderers
+### Vedeu.renderer
+### Vedeu.renderers
 
-### Repositories
+## Repositories
 
 These are collections which you can access:
 
-- Vedeu.background_colours
-- Vedeu.foreground_colours
-- Vedeu.borders
-- Vedeu.buffers
-- Vedeu.cursors
-- Vedeu.events
-- Vedeu.geometries
-- Vedeu.groups
-- Vedeu.interfaces
-- Vedeu.keymaps
-- Vedeu.menus
-
-### Miscellany
-
-- Vedeu.cursor
-- Vedeu.focus
-- Vedeu.focus_by_name
-- Vedeu.focussed?
-- Vedeu.focus_next
-- Vedeu.focus_previous
-- Vedeu.height
-- Vedeu.log
-- Vedeu.log_stdout
-- Vedeu.log_stderr
-- Vedeu.resize
-- Vedeu.timer
-- Vedeu.width
+### Vedeu.background_colours
+### Vedeu.foreground_colours
+### Vedeu.borders
+### Vedeu.buffers
+### Vedeu.cursors
+### Vedeu.events
+### Vedeu.geometries
+### Vedeu.groups
+### Vedeu.interfaces
+### Vedeu.keymaps
+### Vedeu.menus
+
+## Miscellany
+
+### Vedeu.cursor
+### Vedeu.focus
+### Vedeu.focus_by_name
+### Vedeu.focussed?
+### Vedeu.focus_next
+### Vedeu.focus_previous
+### Vedeu.height
+### Vedeu.log
+### Vedeu.log_stdout
+### Vedeu.log_stderr
+### Vedeu.resize
+### Vedeu.timer
+### Vedeu.width

data/docs/configuration.md

@@ -3,13 +3,16 @@
 
 Vedeu provides a simple DSL for configuration.
 
-```ruby
-Vedeu.configure do
+    Vedeu.configure do
 
-  # add configuration options here...
+      # add configuration options here, each of which are listed below...
 
-end
-```
+    end
+
+If you need to access the value of Vedeu's configuration for whatever reason,
+simply ask for it:
+
+    Vedeu.configuration.base_path # => The current value of 'base_path'
 
 ## Configuration Options
 

data/docs/events.md

@@ -1,28 +1,44 @@
 # @title Vedeu Events
-# Vedeu Events
 
-## Application Events
+# Vedeu Provided Events
 
-See {Vedeu::Bindings::Application}
+Vedeu provides a bunch of events which you can use to control its
+behaviour. These are listed below:
 
-## System Events
+### Application Events
+See {file:docs/events/application.md}
 
-See {Vedeu::Bindings::Focus}
-See {Vedeu::Bindings::Refresh}
-See {Vedeu::Bindings::System}
+### Document Events
+See {file:docs/events/document.md}
 
-## DRB Events
+### Focus Events
+See {file:docs/events/focus.md}
 
-See {Vedeu::Bindings::DRB}
+### Refresh Events
+See {file:docs/events/refresh.md}
 
-## Menu Events
+### System Events
+See {file:docs/events/system.md}
 
-See {Vedeu::Bindings::Menus}
+### DRB Events
+See {file:docs/events/drb.md}
 
-## Movement Events
+### Menu Events
+See {file:docs/events/menu.md}
 
-See {Vedeu::Bindings::Movement}
+### Movement Events
+See {file:docs/events/movement.md}
 
-## Visibility Events
+### Visibility Events
+See {file:docs/events/visibility.md}
 
-See {Vedeu::Bindings::Visibility}
+# Vedeu Custom Events
+
+You can bind or unbind your own events using Vedeu's event system. It
+provides:
+
+### Vedeu.bind
+### Vedeu.bind_alias
+### Vedeu.trigger
+### Vedeu.unbind
+### Vedeu.unbind_alias

data/docs/events/application.md

@@ -0,0 +1,12 @@
+# @title Vedeu Application Events
+
+## Application Events
+
+### :_goto_
+Call a client application controller's action with parameters.
+
+    Vedeu.trigger(:_goto_,
+                  :your_controller,
+                  :some_action,
+                  { id: 7 })
+    Vedeu.goto(:your_controller, :some_action, { id: 7 })

data/docs/events/document.md

@@ -0,0 +1,57 @@
+# @title Vedeu Document Events
+
+## Document Events
+
+### :_editor_execute_
+
+    Vedeu.trigger(:_editor_execute_, name)
+
+### :_editor_delete_character_
+This event attempts to delete the character in the named
+document at the current virtual cursor position.
+
+    Vedeu.trigger(:_editor_delete_character_, name)
+
+### :_editor_delete_line_
+This event attempts to delete the line in the named document
+at the current virtual cursor position.
+
+    Vedeu.trigger(:_editor_delete_line_, name)
+
+### :_editor_down_
+This event attempts to move the virtual cursor down by one
+line in the named document.
+
+    Vedeu.trigger(:_editor_down_, name)
+
+### :_editor_insert_character_
+This event attempts to insert the given character in the named
+document at the current virtual cursor position.
+
+    Vedeu.trigger(:_editor_insert_character_, name, character)
+
+### :_editor_insert_line_
+This event attempts to insert a new line in the named document
+at the current virtual cursor position.
+
+    Vedeu.trigger(:_editor_insert_line_, name)
+
+### :_editor_left_
+This event attempts to move the virtual cursor left by one
+character in the named document.
+
+    Vedeu.trigger(:_editor_left_, name)
+
+
+### :_editor_right_
+This event attempts to move the virtual cursor right by one
+character in the named document.
+
+    Vedeu.trigger(:_editor_right_, name)
+
+
+### :_editor_up_
+This event attempts to move the virtual cursor up by one line
+in the named document.
+
+    Vedeu.trigger(:_editor_up_, name)

data/docs/events/drb.md

@@ -0,0 +1,43 @@
+# @title Vedeu DRb Events
+
+## DRB Events
+
+### :_drb_input_
+Triggering this event will send input to the running application as
+long as it has the DRb server running.
+
+    Vedeu.trigger(:_drb_input_, data, type)
+
+### :_drb_retrieve_output_
+
+    Vedeu.trigger(:_drb_retrieve_output_)
+
+### :_drb_store_output_
+Triggering this event with 'data' will push data into the running
+application's virtual buffer.
+
+    Vedeu.trigger(:_drb_store_output_, data)
+
+### :_drb_restart_
+Use the DRb server to request the client application to restart.
+
+    Vedeu.trigger(:_drb_restart_)
+    Vedeu.drb_restart
+
+### :_drb_start_
+Use the DRb server to request the client application to start.
+
+    Vedeu.trigger(:_drb_start_)
+    Vedeu.drb_start
+
+### :_drb_status_
+Use the DRb server to request the status of the client application.
+
+    Vedeu.trigger(:_drb_status_)
+    Vedeu.drb_status
+
+### :_drb_stop_
+Use the DRb server to request the client application to stop.
+
+    Vedeu.trigger(:_drb_stop_)
+    Vedeu.drb_stop

data/docs/events/focus.md

@@ -0,0 +1,24 @@
+# @title Vedeu Focus Events
+
+## Focus Events
+
+### :_focus_by_name_
+When triggered with an interface name will focus that interface and
+restore the cursor position and visibility.
+
+    Vedeu.trigger(:_focus_by_name_, name) # or
+    Vedeu.focus_by_name(name)
+
+### :_focus_next_
+When triggered will focus the next visible interface and restore the
+cursor position and visibility.
+
+    Vedeu.trigger(:_focus_next_) # or
+    Vedeu.focus_next
+
+### :_focus_prev_
+When triggered will focus the previous visible interface and restore
+the cursor position and visibility.
+
+    Vedeu.trigger(:_focus_prev_) # or
+    Vedeu.focus_previous

data/docs/events/menu.md

@@ -0,0 +1,57 @@
+# @title Vedeu Menu Events
+
+## Menu Events
+
+### :_menu_bottom_
+Makes the last menu item the current menu item.
+
+    Vedeu.trigger(:_menu_bottom_, name)
+
+### :_menu_current_
+Returns the current menu item.
+
+    Vedeu.trigger(:_menu_current_, name)
+
+### :_menu_deselect_
+Deselects all menu items.
+
+    Vedeu.trigger(:_menu_deselect_, name)
+
+### :_menu_items_
+Returns all the menu items with respective `current` or `selected`
+boolean indicators.
+
+    Vedeu.trigger(:_menu_items_, name)
+
+### :_menu_next_
+Makes the next menu item the current menu item, until it reaches the
+last item.
+
+    Vedeu.trigger(:_menu_next_, name)
+
+### :_menu_prev_
+Makes the previous menu item the current menu item, until it reaches
+the first item.
+
+    Vedeu.trigger(:_menu_prev_, name)
+
+### :_menu_selected_
+Returns the selected menu item.
+
+    Vedeu.trigger(:_menu_selected_, name)
+
+### :_menu_select_
+Makes the current menu item also the selected menu item.
+
+    Vedeu.trigger(:_menu_select_, name)
+
+### :_menu_top_
+Makes the first menu item the current menu item.
+
+    Vedeu.trigger(:_menu_top_, name)
+
+### :_menu_view_
+Returns a subset of the menu items; starting at the current item to
+the last item.
+
+    Vedeu.trigger(:_menu_view_, name)