vedeu 0.6.6 → 0.6.7

data/lib/vedeu/bindings/application.rb

@@ -9,8 +9,8 @@ module Vedeu
 
       extend self
 
-      # Setup events relating to client applications. This method is called by
-      # Vedeu.
+      # Setup events relating to client applications. This method is
+      # called by Vedeu.
       #
       # @return [TrueClass]
       def setup!
@@ -22,7 +22,10 @@ module Vedeu
       # Call a client application controller's action with parameters.
       #
       # @example
-      #   Vedeu.trigger(:_goto_, :your_controller, :some_action, { id: 7 })
+      #   Vedeu.trigger(:_goto_,
+      #                 :your_controller,
+      #                 :some_action,
+      #                 { id: 7 })
       #   Vedeu.goto(:your_controller, :some_action, { id: 7 })
       #
       # @return [TrueClass]

data/lib/vedeu/bindings/bindings.rb

@@ -3,13 +3,14 @@ module Vedeu
   # Binds various events for running and manipulating Vedeu.
   #
   # @note
-  #   The methods these modules use are private, and should not be called
-  #   directly, however the produced events are all public and are highly
-  #   recommended to be used.
+  #   The methods these modules use are private, and should not be
+  #   called directly, however the produced events are all public and
+  #   are highly recommended to be used.
   #
-  #   Unbinding any of these events is likely to cause problems, so I would
-  #   advise leaving them alone. A safe rule: when the name starts and ends with
-  #   an underscore, it's probably used by Vedeu internally.
+  #   Unbinding any of these events is likely to cause problems, so I
+  #   would advise leaving them alone. A safe rule: when the name
+  #   starts and ends with an underscore, it's probably used by Vedeu
+  #   internally.
   #
   module Bindings
 

data/lib/vedeu/bindings/document.rb

@@ -10,8 +10,8 @@ module Vedeu
 
       extend self
 
-      # Setup events relating to the document/editor/fake terminal. This method
-      # is called by Vedeu.
+      # Setup events relating to the document/editor/fake terminal.
+      # This method is called by Vedeu.
       #
       # @return [TrueClass]
       def setup!
@@ -38,8 +38,8 @@ module Vedeu
         end
       end
 
-      # This event attempts to delete the character in the named document at the
-      # current virtual cursor position.
+      # This event attempts to delete the character in the named
+      # document at the current virtual cursor position.
       #
       # @example
       #   Vedeu.trigger(:_editor_delete_character_, name)
@@ -51,8 +51,8 @@ module Vedeu
         end
       end
 
-      # This event attempts to delete the line in the named document at the
-      # current virtual cursor position.
+      # This event attempts to delete the line in the named document
+      # at the current virtual cursor position.
       #
       # @example
       #   Vedeu.trigger(:_editor_delete_line_, name)
@@ -64,8 +64,8 @@ module Vedeu
         end
       end
 
-      # This event attempts to move the virtual cursor down by one line in the
-      # named document.
+      # This event attempts to move the virtual cursor down by one
+      # line in the named document.
       #
       # @example
       #   Vedeu.trigger(:_editor_down_, name)
@@ -77,8 +77,8 @@ module Vedeu
         end
       end
 
-      # This event attempts to insert the given character in the named document
-      # at the current virtual cursor position.
+      # This event attempts to insert the given character in the named
+      # document at the current virtual cursor position.
       #
       # @example
       #   Vedeu.trigger(:_editor_insert_character_, name, character)
@@ -90,8 +90,8 @@ module Vedeu
         end
       end
 
-      # This event attempts to insert a new line in the named document at the
-      # current virtual cursor position.
+      # This event attempts to insert a new line in the named document
+      # at the current virtual cursor position.
       #
       # @example
       #   Vedeu.trigger(:_editor_insert_line_, name)
@@ -103,8 +103,8 @@ module Vedeu
         end
       end
 
-      # This event attempts to move the virtual cursor left by one character in
-      # the named document.
+      # This event attempts to move the virtual cursor left by one
+      # character in the named document.
       #
       # @example
       #   Vedeu.trigger(:_editor_left_, name)
@@ -114,8 +114,8 @@ module Vedeu
         Vedeu.bind(:_editor_left_) { |name| Vedeu.documents.by_name(name).left }
       end
 
-      # This event attempts to move the virtual cursor right by one character in
-      # the named document.
+      # This event attempts to move the virtual cursor right by one
+      # character in the named document.
       #
       # @example
       #   Vedeu.trigger(:_editor_right_, name)
@@ -127,8 +127,8 @@ module Vedeu
         end
       end
 
-      # This event attempts to move the virtual cursor up by one line in the
-      # named document.
+      # This event attempts to move the virtual cursor up by one line
+      # in the named document.
       #
       # @example
       #   Vedeu.trigger(:_editor_up_, name)

data/lib/vedeu/bindings/drb.rb

@@ -9,7 +9,8 @@ module Vedeu
 
       extend self
 
-      # Setup events relating to the DRb server. This method is called by Vedeu.
+      # Setup events relating to the DRb server. This method is called
+      # by Vedeu.
       #
       # @return [TrueClass]
       def setup!
@@ -24,8 +25,8 @@ module Vedeu
 
       private
 
-      # Triggering this event will send input to the running application as long
-      # as it has the DRb server running.
+      # Triggering this event will send input to the running
+      # application as long as it has the DRb server running.
       #
       # @example
       #   Vedeu.trigger(:_drb_input_, data, type)
@@ -47,15 +48,16 @@ module Vedeu
       # @example
       #   Vedeu.trigger(:_drb_retrieve_output_)
       #
-      # @todo This event queries Vedeu. Events should only be commands.
+      # @todo This event queries Vedeu. Events should only be
+      #   commands.
       #
       # @return [TrueClass]
       def drb_retrieve_output!
         Vedeu.bind(:_drb_retrieve_output_) { Vedeu::VirtualBuffers.retrieve }
       end
 
-      # Triggering this event with 'data' will push data into the running
-      # application's virtual buffer.
+      # Triggering this event with 'data' will push data into the
+      # running application's virtual buffer.
       #
       # @example
       #   Vedeu.trigger(:_drb_store_output_, data)
@@ -67,7 +69,8 @@ module Vedeu
         end
       end
 
-      # Use the DRb server to request the client application to restart.
+      # Use the DRb server to request the client application to
+      # restart.
       #
       # @example
       #   Vedeu.trigger(:_drb_restart_)
@@ -89,7 +92,8 @@ module Vedeu
         Vedeu.bind(:_drb_start_) { Vedeu::Distributed::Server.start }
       end
 
-      # Use the DRb server to request the status of the client application.
+      # Use the DRb server to request the status of the client
+      # application.
       #
       # @example
       #   Vedeu.trigger(:_drb_status_)

data/lib/vedeu/bindings/focus.rb

@@ -2,15 +2,17 @@ module Vedeu
 
   module Bindings
 
-    # Creates system events which when called provide a variety of core
-    # functions and behaviours. They are soft-namespaced using underscores.
+    # Creates system events which when called provide a variety of
+    # core functions and behaviours. They are soft-namespaced using
+    # underscores.
     #
     # :nocov:
     module Focus
 
       extend self
 
-      # Setup events relating to running Vedeu. This method is called by Vedeu.
+      # Setup events relating to running Vedeu. This method is called
+      # by Vedeu.
       #
       # @return [TrueClass]
       def setup!
@@ -21,8 +23,8 @@ module Vedeu
 
       private
 
-      # When triggered with an interface name will focus that interface and
-      # restore the cursor position and visibility.
+      # When triggered with an interface name will focus that
+      # interface and restore the cursor position and visibility.
       #
       # @example
       #   Vedeu.trigger(:_focus_by_name_, name)
@@ -32,8 +34,8 @@ module Vedeu
         Vedeu.bind(:_focus_by_name_) { |name| Vedeu.focus_by_name(name) }
       end
 
-      # When triggered will focus the next interface and restore the cursor
-      # position and visibility.
+      # When triggered will focus the next interface and restore the
+      # cursor position and visibility.
       #
       # @example
       #   Vedeu.trigger(:_focus_next_)
@@ -43,11 +45,12 @@ module Vedeu
         Vedeu.bind(:_focus_next_) { Vedeu.focus_next }
       end
 
-      # When triggered will focus the previous interface and restore the cursor
-      # position and visibility.
+      # When triggered will focus the previous interface and restore
+      # the cursor position and visibility.
       #
       # @example
       #   Vedeu.trigger(:_focus_prev_)
+      #   Vedeu.focus_previous
       #
       # @return [TrueClass]
       def focus_prev!

data/lib/vedeu/bindings/menus.rb

@@ -2,15 +2,16 @@ module Vedeu
 
   module Bindings
 
-    # Each of the Bindings::Menus events require a target menu name as an
-    # argument.
+    # Each of the Bindings::Menus events require a target menu name as
+    # an argument.
     #
     # :nocov:
     module Menus
 
       extend self
 
-      # Setup events relating to menus. This method is called by Vedeu.
+      # Setup events relating to menus. This method is called by
+      # Vedeu.
       #
       # @return [TrueClass]
       def setup!
@@ -64,8 +65,8 @@ module Vedeu
         end
       end
 
-      # Returns all the menu items with respective `current` or `selected`
-      # boolean indicators.
+      # Returns all the menu items with respective `current` or
+      # `selected` boolean indicators.
       #
       # @example
       #   Vedeu.trigger(:_menu_items_, name)
@@ -75,8 +76,8 @@ module Vedeu
         Vedeu.bind(:_menu_items_) { |name| Vedeu.menus.by_name(name).items }
       end
 
-      # Makes the next menu item the current menu item, until it reaches the
-      # last item.
+      # Makes the next menu item the current menu item, until it
+      # reaches the last item.
       #
       # @example
       #   Vedeu.trigger(:_menu_next_, name)
@@ -86,8 +87,8 @@ module Vedeu
         Vedeu.bind(:_menu_next_) { |name| Vedeu.menus.by_name(name).next_item }
       end
 
-      # Makes the previous menu item the current menu item, until it reaches the
-      # first item.
+      # Makes the previous menu item the current menu item, until it
+      # reaches the first item.
       #
       # @example
       #   Vedeu.trigger(:_menu_prev_, name)
@@ -131,8 +132,8 @@ module Vedeu
         Vedeu.bind(:_menu_top_) { |name| Vedeu.menus.by_name(name).top_item }
       end
 
-      # Returns a subset of the menu items; starting at the current item to the
-      # last item.
+      # Returns a subset of the menu items; starting at the current
+      # item to the last item.
       #
       # @example
       #   Vedeu.trigger(:_menu_view_, name)

data/lib/vedeu/bindings/movement.rb

@@ -9,7 +9,8 @@ module Vedeu
 
       extend self
 
-      # Setup events relating to movement. This method is called by Vedeu.
+      # Setup events relating to movement. This method is called by
+      # Vedeu.
       #
       # @return [TrueClass]
       def setup!
@@ -26,23 +27,21 @@ module Vedeu
       # @example
       #   Vedeu.trigger(:_cursor_down_)
       #
-      #   Vedeu.trigger(:_cursor_left_) # When a name is not given, the cursor
-      #                                 # in the interface which is currently in
-      #                                 # focus should move to the left.
+      #   Vedeu.trigger(:_cursor_left_)
+      #   # When a name is not given, the cursor in the interface
+      #   # which is currently in focus should move to the left.
       #
       #   Vedeu.trigger(:_cursor_left_, 'my_interface')
-      #                                 # When a name is given, the cursor
-      #                                 # instance belonging to this interface
-      #                                 # moves to the left.
+      #   # When a name is given, the cursor instance belonging to
+      #   # this interface moves to the left.
       #
       #   Vedeu.trigger(:_cursor_right_)
       #   Vedeu.trigger(:_cursor_up_)
       #
       #   Vedeu.trigger(:_cursor_origin_)                 # /or/
       #   Vedeu.trigger(:_cursor_origin_, 'my_interface')
-      #                                 # Moves the cursor to the top left of
-      #                                 # the named or current interface in
-      #                                 # focus.
+      #   # Moves the cursor to the top left of the named or current
+      #   # interface in focus.
       #
       #   Vedeu.trigger(:_view_down_,  'my_interface')
       #   Vedeu.trigger(:_view_left_,  'my_interface')
@@ -52,15 +51,16 @@ module Vedeu
       #   Each of the :_view_* events has an alias, :_geometry_*
       #
       # @note
-      #   The cursor or view may not be visible, but it will still move if
-      #     requested.
-      #   The cursor will not exceed the border or boundary of the interface, or
-      #     boundary of the visible terminal.
-      #   The cursor will move freely within the bounds of the interface,
-      #     irrespective of content.
-      #   The view will not exceed the boundary of the visible terminal.
-      #   The view will move freely within the bounds of the interface,
-      #     irrespective of content.
+      #   The cursor or view may not be visible, but it will still
+      #     move if requested.
+      #   The cursor will not exceed the border or boundary of the
+      #     interface, or boundary of the visible terminal.
+      #   The cursor will move freely within the bounds of the
+      #     interface, irrespective of content.
+      #   The view will not exceed the boundary of the visible
+      #     terminal.
+      #   The view will move freely within the bounds of the
+      #     interface, irrespective of content.
       #
       # @return [TrueClass]
       def directional!
@@ -85,8 +85,8 @@ module Vedeu
         end
       end
 
-      # This event moves the cursor to the interface origin; the top left corner
-      # of the named interface.
+      # This event moves the cursor to the interface origin; the top
+      # left corner of the named interface.
       #
       # @example
       #   Vedeu.trigger(:_cursor_origin_, name)
@@ -107,7 +107,8 @@ module Vedeu
       # @example
       #   Vedeu.trigger(:_cursor_position_, name)
       #
-      # @todo This event queries Vedeu. Events should only be commands.
+      # @todo This event queries Vedeu. Events should only be
+      #   commands.
       #
       # @return [TrueClass]
       # @see Vedeu::Move

data/lib/vedeu/bindings/refresh.rb

@@ -2,15 +2,17 @@ module Vedeu
 
   module Bindings
 
-    # Creates system events which when called provide a variety of core
-    # functions and behaviours. They are soft-namespaced using underscores.
+    # Creates system events which when called provide a variety of
+    # core functions and behaviours. They are soft-namespaced using
+    # underscores.
     #
     # :nocov:
     module Refresh
 
       extend self
 
-      # Setup events relating to running Vedeu. This method is called by Vedeu.
+      # Setup events relating to running Vedeu. This method is called
+      # by Vedeu.
       #
       # @return [TrueClass]
       def setup!
@@ -24,10 +26,11 @@ module Vedeu
       # Refreshes all registered interfaces or the named interface.
       #
       # @note
-      #   The interfaces will be refreshed in z-index order, meaning that
-      #   interfaces with a lower z-index will be drawn first. This means
-      #   overlapping interfaces will be drawn as specified.
-      #   Hidden interfaces will be still refreshed in memory but not shown.
+      #   The interfaces will be refreshed in z-index order, meaning
+      #   that interfaces with a lower z-index will be drawn first.
+      #   This means overlapping interfaces will be drawn as
+      #   specified. Hidden interfaces will be still refreshed in
+      #   memory but not shown.
       #
       # @example
       #   Vedeu.trigger(:_refresh_)
@@ -36,12 +39,12 @@ module Vedeu
       # @return [TrueClass]
       def refresh!
         Vedeu.bind(:_refresh_) do |name|
-          name ? Vedeu::RefreshBuffer.by_name(name) : Vedeu::Refresh.all
+          name ? Vedeu::Buffers::Refresh.by_name(name) : Vedeu::Refresh.all
         end
       end
 
-      # Will cause the named cursor to refresh, or the cursor of the interface
-      # which is currently in focus.
+      # Will cause the named cursor to refresh, or the cursor of the
+      # interface which is currently in focus.
       #
       # @example
       #   Vedeu.trigger(:_refresh_cursor_, name)