vedeu 0.4.52 → 0.4.53

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2cd921c8f76dab6e9fb3b972420e1bc86dcfb33c
-  data.tar.gz: f01800caf43bfcc0a9a50ae8825f3c96acd257ae
+  metadata.gz: af96b5d6c566e54996cf3c560a60650c5aec5492
+  data.tar.gz: 29d0ba76490206ea43cfb3d24a17a6f81fb9ff8f
 SHA512:
-  metadata.gz: 33e373ad6fddc14a6ecbdf27645890dc4598b542b258b6a0f1d623fdf129c1afb10e1ba8056ba7aed4fb2d734687b8ab2539c5dd588f3e78e7a18779d1f9d708
-  data.tar.gz: 647940089d7ade5c1ef030898561eb542e08265b8d4c7975712780fcdc4fe7a44afa954f5a5d8830fb02db9bf57a134c02857f50847f7d121b215ac13f9a653b
+  metadata.gz: f9f76c20306185777104a808a6f23a3b3c6199e6712207c7246e8758cbd2be8a456d132bfb0a2c3afce79285d3d2b8661ee8a60d592137ec21149f5cfea71edd
+  data.tar.gz: a7e80e7662f4c59de7ede8cea19b2feeb847a544a583d6de92888cda507794a2c96de1e8b6af19fb6e1f74dab04876f47a5c95aa77a4890729110d10ec2a9d20

data/docs/events.md

@@ -2,12 +2,22 @@
 
 # Vedeu Events
 
-{include:file:docs/events/main.md}
+## System Events
 
-{include:file:docs/events/drb.md}
+See {Vedeu::Bindings::System}
 
-{include:file:docs/events/menus.md}
+## DRB Events
 
-{include:file:docs/events/movement.md}
+See {Vedeu::Bindings::DRB}
 
-{include:file:docs/events/visibility.md}
+## Menu Events
+
+See {Vedeu::Bindings::Menus}
+
+## Movement Events
+
+See {Vedeu::Bindings::Movement}
+
+## Visibility Events
+
+See {Vedeu::Bindings::Visibility}

data/lib/vedeu/application/application_view.rb

@@ -32,10 +32,6 @@ module Vedeu
     # @return [void]
     attr_reader :args
 
-    # # @!attribute [r] template
-    # # @return [void]
-    # attr_reader :template
-
     private
 
     # Provides the path to the template file using the base_path configuration

data/lib/vedeu/bindings/all.rb

@@ -2,4 +2,25 @@ require_relative 'visibility'
 require_relative 'movement'
 require_relative 'menus'
 require_relative 'drb'
-require_relative 'bindings'
+require_relative 'system'
+
+module Vedeu
+
+  module Bindings
+
+    # Setup events for running Vedeu. This method is called by Vedeu.
+    #
+    # @return [void]
+    def self.setup!
+      Vedeu::Bindings::Visibility.setup!
+      Vedeu::Bindings::Movement.setup!
+      Vedeu::Bindings::Menus.setup!
+      Vedeu::Bindings::DRB.setup!
+      Vedeu::Bindings::System.setup!
+    end
+
+  end # Bindings
+
+end # Vedeu
+
+Vedeu::Bindings.setup!

data/lib/vedeu/bindings/drb.rb

@@ -5,30 +5,106 @@ module Vedeu
     # System events relating to the DRb server implementation.
     #
     # @api public
-    # {include:file:docs/events/drb.md}
     # :nocov:
     module DRB
 
-      Vedeu.bind(:_drb_input_) do |data, type|
-        Vedeu.log(type: :drb, message: "Sending input (#{type})")
+      extend self
 
-        case type
-        when :command then Vedeu.trigger(:_command_, data)
-        else Vedeu.trigger(:_keypress_, data)
+      # Setup events relating to the DRb server. This method is called by Vedeu.
+      #
+      # @return [void]
+      def setup!
+        drb_input!
+        drb_retrieve_output!
+        drb_store_output!
+        drb_restart!
+        drb_start!
+        drb_status!
+        drb_stop!
+      end
+
+      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 [void]
+      def drb_input!
+        Vedeu.bind(:_drb_input_) do |data, type|
+          Vedeu.log(type: :drb, message: "Sending input (#{type})")
+
+          case type
+          when :command then Vedeu.trigger(:_command_, data)
+          else Vedeu.trigger(:_keypress_, data)
+          end
         end
       end
 
+      # @example
+      #   Vedeu.trigger(:_drb_retrieve_output_)
+      #
       # @todo This event queries Vedeu. Events should only be commands.
-      Vedeu.bind(:_drb_retrieve_output_) { Vedeu::VirtualBuffer.retrieve }
+      #
+      # @return [void]
+      def drb_retrieve_output!
+        Vedeu.bind(:_drb_retrieve_output_) { Vedeu::VirtualBuffer.retrieve }
+      end
 
-      Vedeu.bind(:_drb_store_output_) do |data|
-        Vedeu::VirtualBuffer.store(Vedeu::Terminal.virtual.output(data))
+      # Triggering this event with 'data' will push data into the running
+      # application's virtual buffer.
+      #
+      # @example
+      #   Vedeu.trigger(:_drb_store_output_, data)
+      #
+      # @return [void]
+      def drb_store_output!
+        Vedeu.bind(:_drb_store_output_) do |data|
+          Vedeu::VirtualBuffer.store(Vedeu::Terminal.virtual.output(data))
+        end
       end
 
-      Vedeu.bind(:_drb_restart_) { Vedeu::Distributed::Server.restart }
-      Vedeu.bind(:_drb_start_) { Vedeu::Distributed::Server.start }
-      Vedeu.bind(:_drb_status_) { Vedeu::Distributed::Server.status }
-      Vedeu.bind(:_drb_stop_) { Vedeu::Distributed::Server.stop }
+      # Use the DRb server to request the client application to restart.
+      #
+      # @example
+      #   Vedeu.trigger(:_drb_restart_)
+      #
+      # @return [void]
+      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_)
+      #
+      # @return [void]
+      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_)
+      #
+      # @return [void]
+      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_)
+      #
+      # @return [void]
+      def drb_stop!
+        Vedeu.bind(:_drb_stop_) { Vedeu::Distributed::Server.stop }
+      end
 
     end # DRB
     # :nocov:

data/lib/vedeu/bindings/menus.rb

@@ -6,28 +6,138 @@ module Vedeu
     # argument.
     #
     # @api public
-    # {include:file:docs/events/menus.md}
     # :nocov:
     module Menus
 
-      Vedeu.bind(:_menu_bottom_) { |name| Vedeu.menus.find(name).bottom_item }
-      Vedeu.bind(:_menu_current_) { |name| Vedeu.menus.find(name).current_item }
+      extend self
 
-      Vedeu.bind(:_menu_deselect_) do |name|
-        Vedeu.menus.find(name).deselect_item
+      # Setup events relating to menus. This method is called by Vedeu.
+      #
+      # @return [void]
+      def setup!
+        menu_bottom!
+        menu_current!
+        menu_deselect!
+        menu_items!
+        menu_next!
+        menu_prev!
+        menu_selected!
+        menu_select!
+        menu_top!
+        menu_view!
       end
 
-      Vedeu.bind(:_menu_items_) { |name| Vedeu.menus.find(name).items }
-      Vedeu.bind(:_menu_next_) { |name| Vedeu.menus.find(name).next_item }
-      Vedeu.bind(:_menu_prev_) { |name| Vedeu.menus.find(name).prev_item }
+      private
 
-      Vedeu.bind(:_menu_selected_) do |name|
-        Vedeu.menus.find(name).selected_item
+      # Makes the last menu item the current menu item.
+      #
+      # @example
+      #   Vedeu.trigger(:_menu_bottom_, name)
+      #
+      # @return [void]
+      def menu_bottom!
+        Vedeu.bind(:_menu_bottom_) { |name| Vedeu.menus.find(name).bottom_item }
       end
 
-      Vedeu.bind(:_menu_select_) { |name| Vedeu.menus.find(name).select_item }
-      Vedeu.bind(:_menu_top_) { |name| Vedeu.menus.find(name).top_item }
-      Vedeu.bind(:_menu_view_) { |name| Vedeu.menus.find(name).view }
+      # Returns the current menu item.
+      #
+      # @example
+      #   Vedeu.trigger(:_menu_current_, name)
+      #
+      # @return [void]
+      def menu_current!
+        Vedeu.bind(:_menu_current_) do |name|
+          Vedeu.menus.find(name).current_item
+        end
+      end
+
+      # Deselects all menu items.
+      #
+      # @example
+      #   Vedeu.trigger(:_menu_deselect_, name)
+      #
+      # @return [void]
+      def menu_deselect!
+        Vedeu.bind(:_menu_deselect_) do |name|
+          Vedeu.menus.find(name).deselect_item
+        end
+      end
+
+      # Returns all the menu items with respective `current` or `selected`
+      # boolean indicators.
+      #
+      # @example
+      #   Vedeu.trigger(:_menu_items_, name)
+      #
+      # @return [void]
+      def menu_items!
+        Vedeu.bind(:_menu_items_) { |name| Vedeu.menus.find(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 [void]
+      def menu_next!
+        Vedeu.bind(:_menu_next_) { |name| Vedeu.menus.find(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 [void]
+      def menu_prev!
+        Vedeu.bind(:_menu_prev_) { |name| Vedeu.menus.find(name).prev_item }
+      end
+
+      # Returns the selected menu item.
+      #
+      # @example
+      #   Vedeu.trigger(:_menu_selected_, name)
+      #
+      # @return [void]
+      def menu_selected!
+        Vedeu.bind(:_menu_selected_) do |name|
+          Vedeu.menus.find(name).selected_item
+        end
+      end
+
+      # Makes the current menu item also the selected menu item.
+      #
+      # @example
+      #   Vedeu.trigger(:_menu_select_, name)
+      #
+      # @return [void]
+      def menu_select!
+        Vedeu.bind(:_menu_select_) { |name| Vedeu.menus.find(name).select_item }
+      end
+
+      # Makes the first menu item the current menu item.
+      #
+      # @example
+      #   Vedeu.trigger(:_menu_top_, name)
+      #
+      # @return [void]
+      def menu_top!
+        Vedeu.bind(:_menu_top_) { |name| Vedeu.menus.find(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 [void]
+      def menu_view!
+        Vedeu.bind(:_menu_view_) { |name| Vedeu.menus.find(name).view }
+      end
 
     end # Menus
     # :nocov:

data/lib/vedeu/bindings/movement.rb

@@ -5,57 +5,178 @@ module Vedeu
     # System events relating to movement of cursors or interfaces.
     #
     # @api public
-    # {include:file:docs/events/movement.md}
     # :nocov:
     module Movement
 
-      Vedeu.bind(:_cursor_down_) do |name|
-        Vedeu::Move.by_name(Vedeu::Cursor, :down, name)
+      extend self
+
+      # Setup events relating to movement. This method is called by Vedeu.
+      #
+      # @return [void]
+      def setup!
+        cursor_down!
+        cursor_left!
+        cursor_origin!
+        cursor_position!
+        cursor_reposition!
+        cursor_right!
+        cursor_up!
+        geometry_down!
+        geometry_left!
+        geometry_right!
+        geometry_up!
       end
 
-      Vedeu.bind(:_cursor_left_) do |name|
-        Vedeu::Move.by_name(Vedeu::Cursor, :left, name)
+      private
+
+      # Move the cursor down by one character.
+      #
+      # @example
+      #   Vedeu.trigger(:_cursor_down_, name)
+      #
+      # @return [void]
+      # @see Vedeu::Move
+      def cursor_down!
+        Vedeu.bind(:_cursor_down_) do |name|
+          Vedeu::Move.by_name(Vedeu::Cursor, :down, name)
+        end
       end
 
-      Vedeu.bind(:_cursor_origin_) do |name|
-        Vedeu::Move.by_name(Vedeu::Cursor, :origin, name)
+      # Move the cursor left by one character.
+      #
+      # @example
+      #   Vedeu.trigger(:_cursor_left_, name)
+      #
+      # @return [void]
+      # @see Vedeu::Move
+      def cursor_left!
+        Vedeu.bind(:_cursor_left_) do |name|
+          Vedeu::Move.by_name(Vedeu::Cursor, :left, name)
+        end
       end
 
-      # @todo This event queries Vedeu. Events should only be commands.
-      Vedeu.bind(:_cursor_position_) do |name|
-        Vedeu.cursors.by_name(name).position
+      # 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 [void]
+      # @see Vedeu::Move
+      def cursor_origin!
+        Vedeu.bind(:_cursor_origin_) do |name|
+          Vedeu::Move.by_name(Vedeu::Cursor, :origin, name)
+        end
+        Vedeu.bind(:_cursor_reset_) do |name|
+          Vedeu.trigger(:_cursor_origin_, name)
+        end
       end
 
-      Vedeu.bind(:_cursor_reposition_) do |name, y, x|
-        Vedeu::Reposition.to(Vedeu::Cursor, name, y, x)
+      # 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 [void]
+      # @see Vedeu::Move
+      def cursor_position!
+        Vedeu.bind(:_cursor_position_) do |name|
+          Vedeu.cursors.by_name(name).position
+        end
       end
 
-      Vedeu.bind(:_cursor_reset_) do |name|
-        Vedeu.trigger(:_cursor_origin_, name)
+      # Moves the cursor to a relative position inside the interface.
+      #
+      # @example
+      #   Vedeu.trigger(:_cursor_reposition_, name, y, x)
+      #
+      # @return [void]
+      # @see Vedeu::Move
+      def cursor_reposition!
+        Vedeu.bind(:_cursor_reposition_) do |name, y, x|
+          Vedeu::Reposition.to(Vedeu::Cursor, name, y, x)
+        end
       end
 
-      Vedeu.bind(:_cursor_right_) do |name|
-        Vedeu::Move.by_name(Vedeu::Cursor, :right, name)
+      # Move the cursor right by one character.
+      #
+      # @example
+      #   Vedeu.trigger(:_cursor_right_, name)
+      #
+      # @return [void]
+      # @see Vedeu::Move
+      def cursor_right!
+        Vedeu.bind(:_cursor_right_) do |name|
+          Vedeu::Move.by_name(Vedeu::Cursor, :right, name)
+        end
       end
 
-      Vedeu.bind(:_cursor_up_) do |name|
-        Vedeu::Move.by_name(Vedeu::Cursor, :up, name)
+      # Move the cursor up by one character.
+      #
+      # @example
+      #   Vedeu.trigger(:_cursor_up, name)
+      #
+      # @return [void]
+      # @see Vedeu::Move
+      def cursor_up!
+        Vedeu.bind(:_cursor_up_) do |name|
+          Vedeu::Move.by_name(Vedeu::Cursor, :up, name)
+        end
       end
 
-      Vedeu.bind(:_geometry_down_) do |name|
-        Vedeu::Move.by_name(Vedeu::Geometry, :down, name)
+      # Move the geometry down by one character.
+      #
+      # @example
+      #   Vedeu.trigger(:_geometry_down_, name)
+      #
+      # @return [void]
+      # @see Vedeu::Move
+      def geometry_down!
+        Vedeu.bind(:_geometry_down_) do |name|
+          Vedeu::Move.by_name(Vedeu::Geometry, :down, name)
+        end
       end
 
-      Vedeu.bind(:_geometry_left_) do |name|
-        Vedeu::Move.by_name(Vedeu::Geometry, :left, name)
+      # Move the geometry left by one character.
+      #
+      # @example
+      #   Vedeu.trigger(:_geometry_left_, name)
+      #
+      # @return [void]
+      # @see Vedeu::Move
+      def geometry_left!
+        Vedeu.bind(:_geometry_left_) do |name|
+          Vedeu::Move.by_name(Vedeu::Geometry, :left, name)
+        end
       end
 
-      Vedeu.bind(:_geometry_right_) do |name|
-        Vedeu::Move.by_name(Vedeu::Geometry, :right, name)
+      # Move the geometry right by one character.
+      #
+      # @example
+      #   Vedeu.trigger(:_geometry_right_, name)
+      #
+      # @return [void]
+      # @see Vedeu::Move
+      def geometry_right!
+        Vedeu.bind(:_geometry_right_) do |name|
+          Vedeu::Move.by_name(Vedeu::Geometry, :right, name)
+        end
       end
 
-      Vedeu.bind(:_geometry_up_) do |name|
-        Vedeu::Move.by_name(Vedeu::Geometry, :up, name)
+      # Move the geometry up by one character.
+      #
+      # @example
+      #   Vedeu.trigger(:_geometry_up_, name)
+      #
+      # @return [void]
+      # @see Vedeu::Move
+      def geometry_up!
+        Vedeu.bind(:_geometry_up_) do |name|
+          Vedeu::Move.by_name(Vedeu::Geometry, :up, name)
+        end
       end
 
     end # Movement