vedeu 0.6.8 → 0.6.9

data/lib/vedeu/bindings/drb.rb

@@ -4,7 +4,6 @@ module Vedeu
 
     # System events relating to the DRb server implementation.
     #
-    # :nocov:
     module DRB
 
       extend self
@@ -25,14 +24,7 @@ module Vedeu
 
       private
 
-      # 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)
-      #
-      # @return [TrueClass]
-      # @see Vedeu::Distributed::Server#input
+      # See {file:docs/events/drb.md#\_drb_input_}
       def drb_input!
         Vedeu.bind(:_drb_input_) do |data, type|
           Vedeu.log(type: :drb, message: "Sending input (#{type})")
@@ -45,78 +37,42 @@ module Vedeu
         end
       end
 
-      # @example
-      #   Vedeu.trigger(:_drb_retrieve_output_)
-      #
-      # @todo This event queries Vedeu. Events should only be
-      #   commands.
-      #
-      # @return [TrueClass]
+      # See {file:docs/events/drb.md#\_drb_retrieve_output_}
       def drb_retrieve_output!
-        Vedeu.bind(:_drb_retrieve_output_) { Vedeu::VirtualBuffers.retrieve }
+        Vedeu.bind(:_drb_retrieve_output_) do
+          Vedeu::Buffers::VirtualBuffers.retrieve
+        end
       end
 
-      # Triggering this event with 'data' will push data into the
-      # running application's virtual buffer.
-      #
-      # @example
-      #   Vedeu.trigger(:_drb_store_output_, data)
-      #
-      # @return [TrueClass]
+      # See {file:docs/events/drb.md#\_drb_store_output_}
       def drb_store_output!
         Vedeu.bind(:_drb_store_output_) do |data|
-          Vedeu::VirtualBuffers.store(Vedeu::VirtualBuffer.output(data))
+          Vedeu::Buffers::VirtualBuffers
+            .store(Vedeu::Buffers::VirtualBuffer.output(data))
         end
       end
 
-      # Use the DRb server to request the client application to
-      # restart.
-      #
-      # @example
-      #   Vedeu.trigger(:_drb_restart_)
-      #   Vedeu.drb_restart
-      #
-      # @return [TrueClass]
+      # See {file:docs/events/drb.md#\_drb_restart_}
       def drb_restart!
         Vedeu.bind(:_drb_restart_) { Vedeu::Distributed::Server.restart }
       end
 
-      # Use the DRb server to request the client application to start.
-      #
-      # @example
-      #   Vedeu.trigger(:_drb_start_)
-      #   Vedeu.drb_start
-      #
-      # @return [TrueClass]
+      # See {file:docs/events/drb.md#\_drb_start_}
       def drb_start!
         Vedeu.bind(:_drb_start_) { Vedeu::Distributed::Server.start }
       end
 
-      # Use the DRb server to request the status of the client
-      # application.
-      #
-      # @example
-      #   Vedeu.trigger(:_drb_status_)
-      #   Vedeu.drb_status
-      #
-      # @return [TrueClass]
+      # See {file:docs/events/drb.md#\_drb_status_}
       def drb_status!
         Vedeu.bind(:_drb_status_) { Vedeu::Distributed::Server.status }
       end
 
-      # Use the DRb server to request the client application to stop.
-      #
-      # @example
-      #   Vedeu.trigger(:_drb_stop_)
-      #   Vedeu.drb_stop
-      #
-      # @return [TrueClass]
+      # See {file:docs/events/drb.md#\_drb_stop_}
       def drb_stop!
         Vedeu.bind(:_drb_stop_) { Vedeu::Distributed::Server.stop }
       end
 
     end # DRB
-    # :nocov:
 
   end # Bindings
 

data/lib/vedeu/bindings/focus.rb

@@ -2,11 +2,6 @@ module Vedeu
 
   module Bindings
 
-    # 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
@@ -23,42 +18,22 @@ module Vedeu
 
       private
 
-      # When triggered with an interface name will focus that
-      # interface and restore the cursor position and visibility.
-      #
-      # @example
-      #   Vedeu.trigger(:_focus_by_name_, name)
-      #
-      # @return [TrueClass]
+      # See {file:docs/events/focus.md#\_focus_by_name_}
       def focus_by_name!
         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.
-      #
-      # @example
-      #   Vedeu.trigger(:_focus_next_)
-      #
-      # @return [TrueClass]
+      # See {file:docs/events/focus.md#\_focus_next_}
       def focus_next!
         Vedeu.bind(:_focus_next_) { Vedeu.focus_next }
       end
 
-      # When triggered will focus the previous interface and restore
-      # the cursor position and visibility.
-      #
-      # @example
-      #   Vedeu.trigger(:_focus_prev_)
-      #   Vedeu.focus_previous
-      #
-      # @return [TrueClass]
+      # See {file:docs/events/focus.md#\_focus_prev_}
       def focus_prev!
         Vedeu.bind(:_focus_prev_) { Vedeu.focus_previous }
       end
 
     end # Focus
-    # :nocov:
 
   end # Bindings
 

data/lib/vedeu/bindings/menus.rb

@@ -5,7 +5,6 @@ module Vedeu
     # Each of the Bindings::Menus events require a target menu name as
     # an argument.
     #
-    # :nocov:
     module Menus
 
       extend self
@@ -29,122 +28,67 @@ module Vedeu
 
       private
 
-      # Makes the last menu item the current menu item.
-      #
-      # @example
-      #   Vedeu.trigger(:_menu_bottom_, name)
-      #
-      # @return [TrueClass]
+      # See {file:docs/events/menu.md#\_menu_bottom_}
       def menu_bottom!
         Vedeu.bind(:_menu_bottom_) do |name|
           Vedeu.menus.by_name(name).bottom_item
         end
       end
 
-      # Returns the current menu item.
-      #
-      # @example
-      #   Vedeu.trigger(:_menu_current_, name)
-      #
-      # @return [TrueClass]
+      # See {file:docs/events/menu.md#\_menu_current_}
       def menu_current!
         Vedeu.bind(:_menu_current_) do |name|
           Vedeu.menus.by_name(name).current_item
         end
       end
 
-      # Deselects all menu items.
-      #
-      # @example
-      #   Vedeu.trigger(:_menu_deselect_, name)
-      #
-      # @return [TrueClass]
+      # See {file:docs/events/menu.md#\_menu_deselect_}
       def menu_deselect!
         Vedeu.bind(:_menu_deselect_) do |name|
           Vedeu.menus.by_name(name).deselect_item
         end
       end
 
-      # Returns all the menu items with respective `current` or
-      # `selected` boolean indicators.
-      #
-      # @example
-      #   Vedeu.trigger(:_menu_items_, name)
-      #
-      # @return [TrueClass]
+      # See {file:docs/events/menu.md#\_menu_items_}
       def menu_items!
         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.
-      #
-      # @example
-      #   Vedeu.trigger(:_menu_next_, name)
-      #
-      # @return [TrueClass]
+      # See {file:docs/events/menu.md#\_menu_next_}
       def menu_next!
         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.
-      #
-      # @example
-      #   Vedeu.trigger(:_menu_prev_, name)
-      #
-      # @return [TrueClass]
+      # See {file:docs/events/menu.md#\_menu_prev_}
       def menu_prev!
         Vedeu.bind(:_menu_prev_) { |name| Vedeu.menus.by_name(name).prev_item }
       end
 
-      # Returns the selected menu item.
-      #
-      # @example
-      #   Vedeu.trigger(:_menu_selected_, name)
-      #
-      # @return [TrueClass]
+      # See {file:docs/events/menu.md#\_menu_selected_}
       def menu_selected!
         Vedeu.bind(:_menu_selected_) do |name|
           Vedeu.menus.by_name(name).selected_item
         end
       end
 
-      # Makes the current menu item also the selected menu item.
-      #
-      # @example
-      #   Vedeu.trigger(:_menu_select_, name)
-      #
-      # @return [TrueClass]
+      # See {file:docs/events/menu.md#\_menu_select_}
       def menu_select!
         Vedeu.bind(:_menu_select_) do |name|
           Vedeu.menus.by_name(name).select_item
         end
       end
 
-      # Makes the first menu item the current menu item.
-      #
-      # @example
-      #   Vedeu.trigger(:_menu_top_, name)
-      #
-      # @return [TrueClass]
+      # See {file:docs/events/menu.md#\_menu_top_}
       def menu_top!
         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.
-      #
-      # @example
-      #   Vedeu.trigger(:_menu_view_, name)
-      #
-      # @return [TrueClass]
+      # See {file:docs/events/menu.md#\_menu_view_}
       def menu_view!
         Vedeu.bind(:_menu_view_) { |name| Vedeu.menus.by_name(name).view }
       end
 
     end # Menus
-    # :nocov:
 
   end # Bindings
 

data/lib/vedeu/bindings/movement.rb

@@ -4,7 +4,6 @@ module Vedeu
 
     # System events relating to movement of cursors or interfaces.
     #
-    # :nocov:
     module Movement
 
       extend self
@@ -22,47 +21,7 @@ module Vedeu
 
       private
 
-      # Adjusts the position of the cursor or view.
-      #
-      # @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_, 'my_interface')
-      #   # 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.
-      #
-      #   Vedeu.trigger(:_view_down_,  'my_interface')
-      #   Vedeu.trigger(:_view_left_,  'my_interface')
-      #   Vedeu.trigger(:_view_right_, 'my_interface')
-      #   Vedeu.trigger(:_view_up_,    'my_interface')
-      #
-      #   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.
-      #
-      # @return [TrueClass]
+      # See {file:docs/events/movement.md#\_cursor_up_down_left_right_}
       def directional!
         [:down, :left, :right, :up].each do |direction|
           Vedeu.bind("_cursor_#{direction}_".to_sym) do |name|
@@ -85,15 +44,7 @@ module Vedeu
         end
       end
 
-      # This event moves the cursor to the interface origin; the top
-      # left corner of the named interface.
-      #
-      # @example
-      #   Vedeu.trigger(:_cursor_origin_, name)
-      #   Vedeu.trigger(:_cursor_reset_, name)
-      #
-      # @return [TrueClass]
-      # @see Vedeu::Move
+      # See {file:docs/events/movement.md#\_cursor_origin_}
       def cursor_origin!
         Vedeu.bind(:_cursor_origin_) do |name|
           Vedeu.cursors.by_name(name).move_origin
@@ -102,29 +53,14 @@ module Vedeu
         Vedeu.bind_alias(:_cursor_reset_, :_cursor_origin_)
       end
 
-      # When triggered will return the current position of the cursor.
-      #
-      # @example
-      #   Vedeu.trigger(:_cursor_position_, name)
-      #
-      # @todo This event queries Vedeu. Events should only be
-      #   commands.
-      #
-      # @return [TrueClass]
-      # @see Vedeu::Move
+      # See {file:docs/events/movement.md#\_cursor_position_}
       def cursor_position!
         Vedeu.bind(:_cursor_position_) do |name|
           Vedeu.cursors.by_name(name).position
         end
       end
 
-      # Moves the cursor to a relative position inside the interface.
-      #
-      # @example
-      #   Vedeu.trigger(:_cursor_reposition_, name, y, x)
-      #
-      # @return [TrueClass]
-      # @see Vedeu::Move
+      # See {file:docs/events/movement.md#\_cursor_reposition_}
       def cursor_reposition!
         Vedeu.bind(:_cursor_reposition_) do |name, y, x|
           Vedeu.cursors.by_name(name).reposition(y, x)
@@ -136,7 +72,6 @@ module Vedeu
       end
 
     end # Movement
-    # :nocov:
 
   end # Bindings
 

data/lib/vedeu/bindings/refresh.rb

@@ -2,11 +2,6 @@ module Vedeu
 
   module Bindings
 
-    # 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
@@ -23,45 +18,21 @@ module Vedeu
 
       private
 
-      # 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.
-      #
-      # @example
-      #   Vedeu.trigger(:_refresh_)
-      #   Vedeu.trigger(:_refresh_, name)
-      #
-      # @return [TrueClass]
+      # See {file:docs/events/refresh.md#\_refresh_}
       def refresh!
         Vedeu.bind(:_refresh_) do |name|
           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.
-      #
-      # @example
-      #   Vedeu.trigger(:_refresh_cursor_, name)
-      #
-      # @return [TrueClass]
+      # See {file:docs/events/refresh.md#\_refresh_cursor_}
       def refresh_cursor!
         Vedeu.bind(:_refresh_cursor_) do |name|
           Vedeu::Cursors::Refresh.by_name(name)
         end
       end
 
-      # Will cause all interfaces in the named group to refresh.
-      #
-      # @example
-      #   Vedeu.trigger(:_refresh_group_, name)
-      #
-      # @return [TrueClass]
+      # See {file:docs/events/refresh.md#\_refresh_group_}
       def refresh_group!
         Vedeu.bind(:_refresh_group_) do |name|
           Vedeu::RefreshGroup.by_name(name)
@@ -69,7 +40,6 @@ module Vedeu
       end
 
     end # Refresh
-    # :nocov:
 
   end # Bindings