vedeu 0.4.3 → 0.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f37a301576d737c906c07425d431588426023bbe
-  data.tar.gz: a8ed33815c9a7343b85470d6f88130495e7d93be
+  metadata.gz: ce46fbb0f483168f5c1817fc857b4f1134afdc48
+  data.tar.gz: fe7eeaa6731a12dc572479b89f88de211cdf0c05
 SHA512:
-  metadata.gz: 1b2a87c244d2b5e3e2bd6d39f8eb6f72184065794e9897fa5bd39c0af08b2ac9add00ed93538d5685f9188c450994fa2b60d96f95ff7564cdf8dad8693a9edcf
-  data.tar.gz: 680a31c67bb5f046b09f52e8709e2ee8fa5a9e5f4cc63fc387d67608cab30ba364419c1beb0db343f753af216b34593934326e3549c9da6899718d0b07777fe9
+  metadata.gz: d996c0a1dc1ddb48cc050343ac91ee2d8ecba8035d833796d4a1fb0c07cc5cce75c265a12bd8b3c6c22de2e3b477805b602e20dcb8e4cc98112bf7e5cf31731c
+  data.tar.gz: 0d42cd88c6680854c1cd322762182d90f0dff970230db9064f709b382c36089a1c01cd406e24a74b9db6262055723eb37bd0cff64d06b4e5fe72cc923f39b23d

data/lib/vedeu/api.rb

@@ -3,9 +3,10 @@ require 'vedeu/support/terminal'
 require 'vedeu/events/all'
 require 'vedeu/models/all'
 require 'vedeu/input/all'
-require 'vedeu/dsl/components/border'
+require 'vedeu/dsl/components/all'
 require 'vedeu/dsl/composition'
 require 'vedeu/dsl/shared/all'
+require 'vedeu/dsl/group'
 require 'vedeu/dsl/view'
 
 module Vedeu
@@ -38,6 +39,7 @@ module Vedeu
     def_delegators Vedeu::DSL::Border,   :border
     def_delegators Vedeu::DSL::Geometry, :geometry
     def_delegators Vedeu::DSL::Keymap,   :keymap
+    def_delegators Vedeu::DSL::Group,    :group
     def_delegators Vedeu::DSL::Use,      :use
     def_delegators Vedeu::DSL::View,     :interface, :renders, :views
 

data/lib/vedeu/application.rb

@@ -59,7 +59,7 @@ module Vedeu
         runner { main_sequence }
       end
 
-      Vedeu.trigger(:_drb_stop_, 'via Vedeu::Application#start')
+      Vedeu.trigger(:_drb_stop_)
 
       output
     end

data/lib/vedeu/bindings.rb

@@ -14,18 +14,11 @@ module Vedeu
   #
   module Bindings
 
-    # Clears the whole terminal space.
-    Vedeu.bind(:_clear_) do
-      Vedeu::Terminal.virtual.clear if Vedeu::Configuration.drb?
-
-      Vedeu::Terminal.clear
-    end
-
     # Vedeu triggers this event when `:_exit_` is triggered. You can hook into
     # this to perform a special action before the application terminates. Saving
     # the user's work, session or preferences might be popular here.
     Vedeu.bind(:_cleanup_) do
-      Vedeu.trigger(:_drb_stop_, 'via :cleanup')
+      Vedeu.trigger(:_drb_stop_)
       Vedeu.trigger(:cleanup)
     end
 
@@ -34,51 +27,40 @@ module Vedeu
       Vedeu.trigger(:_keypress_, data)
     end
 
-    Vedeu.bind(:_drb_retrieve_output_)  do
+    Vedeu.bind(:_drb_retrieve_output_) do
       Vedeu.log(type: :drb, message: 'Retrieving output')
       Vedeu::VirtualBuffer.retrieve
     end
 
-    Vedeu.bind(:_drb_store_output_)  do |data|
+    Vedeu.bind(:_drb_store_output_) do |data|
       Vedeu.log(type: :drb, message: 'Storing output')
       Vedeu::VirtualBuffer.store(Vedeu::Terminal.virtual.output(data))
     end
 
-    Vedeu.bind(:_drb_restart_) do
-      Vedeu.log(type: :drb, message: 'Attempting to restart')
-      Vedeu::Distributed::Server.restart
-    end
-
-    Vedeu.bind(:_drb_start_)   do
-      Vedeu.log(type: :drb, message: 'Attempting to start')
-      Vedeu::Distributed::Server.start
-    end
-
-    Vedeu.bind(:_drb_status_)  do
-      Vedeu.log(type: :drb, message: 'Fetching status')
-      Vedeu::Distributed::Server.status
-    end
-
-    Vedeu.bind(:_drb_stop_) do |message|
-      Vedeu.log(type: :drb, message: "Attempting to stop (#{message})")
-      Vedeu::Distributed::Server.stop
-    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 }
 
     # When triggered, Vedeu will trigger a `:cleanup` event which you can define
     # (to save files, etc) and attempt to exit.
-    Vedeu.bind(:_exit_)                    { Vedeu::Application.stop      }
+    Vedeu.bind(:_exit_) { Vedeu::Application.stop }
 
     # Vedeu triggers this event when it is ready to enter the main loop. Client
     # applications can listen for this event and perform some action(s), like
     # render the first screen, interface or make a sound. When Vedeu triggers
     # this event, the :_refresh_ event is also triggered automatically.
-    Vedeu.bind(:_initialize_)              { Vedeu.trigger(:_refresh_)    }
+    Vedeu.bind(:_initialize_) { Vedeu.trigger(:_refresh_) }
 
-    # Triggering this event will cause the triggering of the `:key` event; which
+    # Will cause the triggering of the `:key` event; which
     # you should define to 'do things'. If the `escape` key is pressed, then
     # `key` is triggered with the argument `:escape`, also an internal event
     # `_mode_switch_` is triggered.
-    Vedeu.bind(:_keypress_) { |key| Vedeu.keypress(key) }
+    Vedeu.bind(:_keypress_) do |key|
+      Vedeu.trigger(:key, key)
+
+      Vedeu.keypress(key)
+    end
 
     # When triggered with a message will cause Vedeu to log the message if
     # logging is enabled in the configuration.
@@ -96,79 +78,35 @@ module Vedeu
 
     # Hide the cursor of the named interface or interface currently in focus.
     Vedeu.bind(:_cursor_hide_) do |name|
-      named = if name
-        Vedeu.cursors.by_name(name)
-
-      else
-        Vedeu.cursor
-
-      end
+      named = name ? Vedeu.cursors.by_name(name) : Vedeu.cursor
 
       ToggleCursor.hide(named)
     end
 
     # Show the cursor of the named interface or interface currently in focus.
     Vedeu.bind(:_cursor_show_) do |name|
-      named = if name
-        Vedeu.cursors.by_name(name)
-
-      else
-        Vedeu.cursor
-
-      end
+      named = name ? Vedeu.cursors.by_name(name) : Vedeu.cursor
 
       ToggleCursor.show(named)
     end
 
-    # Move the cursor down one character in the interface currently in focus.
-    # Will not exceed the border or boundary of the interface.
-    Vedeu.bind(:_cursor_down_) do
-      interface = Vedeu.interfaces.current
+    # @see {Vedeu::MoveCursor}
+    Vedeu.bind(:_cursor_down_) { |name| MoveCursor.by_name(:down, name) }
 
-      MoveCursor.down(Vedeu.cursor, interface)
+    # @see {Vedeu::MoveCursor}
+    Vedeu.bind(:_cursor_left_) { |name| MoveCursor.by_name(:left, name) }
 
-      Refresh.by_focus
-    end
+    # @see {Vedeu::MoveCursor}
+    Vedeu.bind(:_cursor_right_) { |name| MoveCursor.by_name(:right, name) }
 
-    # Move the cursor left one character in the interface currently in focus.
-    # Will not exceed the border or boundary of the interface.
-    Vedeu.bind(:_cursor_left_) do
-      interface = Vedeu.interfaces.current
+    # @see {Vedeu::MoveCursor}
+    Vedeu.bind(:_cursor_up_) { |name| MoveCursor.by_name(:up, name) }
 
-      MoveCursor.left(Vedeu.cursor, interface)
-
-      Refresh.by_focus
-    end
+    # @see {Vedeu::MoveCursor}
+    Vedeu.bind(:_cursor_origin_) { |name| MoveCursor.by_name(:origin, name) }
 
-    # Move the cursor right one character in the interface currently in focus.
-    # Will not exceed the border or boundary of the interface.
-    Vedeu.bind(:_cursor_right_) do
-      interface = Vedeu.interfaces.current
-
-      MoveCursor.right(Vedeu.cursor, interface)
-
-      Refresh.by_focus
-    end
-
-    # Move the cursor up one character in the interface currently in focus.
-    # Will not exceed the border or boundary of the interface.
-    Vedeu.bind(:_cursor_up_) do
-      interface = Vedeu.interfaces.current
-
-      MoveCursor.up(Vedeu.cursor, interface)
-
-      Refresh.by_focus
-    end
-
-    # Moves the cursor to the top left position of the interface currently in
-    # focus; respecting a border if present.
-    Vedeu.bind(:_cursor_origin_) do
-      interface = Vedeu.interfaces.current
-
-      MoveCursor.origin(Vedeu.cursor, interface)
-
-      Refresh.by_focus
-    end
+    # @see {Vedeu::MoveCursor}
+    Vedeu.bind(:_cursor_reset_) { |name| Vedeu.trigger(:_cursor_origin_, name) }
 
     # When triggered with an interface name will focus that interface and
     # restore the cursor position and visibility.
@@ -219,22 +157,51 @@ module Vedeu
     # starting at the current item to the last item.
     Vedeu.bind(:_menu_view_) { |name| Vedeu.menus.find(name).view }
 
-    # Triggering this event will cause all interfaces to refresh, or the named
-    # interface if one is given.
-    Vedeu.bind(:_refresh_) do |name|
-      if name
-        Vedeu::Refresh.by_name(name)
+    # Clears the whole terminal space, or the named interface area to be cleared
+    # if given.
+    Vedeu.bind(:_clear_) do |name|
+      if name && Vedeu.interfaces.registered?(name)
+        Vedeu::Output.clear(Vedeu.interfaces.find(name))
 
       else
-        Vedeu::Refresh.all
+        Vedeu::Terminal.virtual.clear if Vedeu::Configuration.drb?
+
+        Vedeu::Terminal.clear
+      end
+    end
 
+    # Clears the spaces occupied by the interfaces belonging to the named group.
+    Vedeu.bind(:_clear_group_) do |name|
+      Vedeu.groups.find(name).members.each do |group_name|
+        Vedeu.trigger(:_clear_, group_name)
       end
     end
 
-    # Triggering this event will cause all interfaces in the named group to
-    # refresh.
-    Vedeu.bind(:_refresh_group_) do |name|
-      Vedeu::Refresh.by_group(name)
+    # Will cause all interfaces to refresh, or the named interface if given.
+    Vedeu.bind(:_refresh_) do |name|
+      name ? Vedeu::Refresh.by_name(name) : Vedeu::Refresh.all
+    end
+
+    # Will cause all interfaces in the named group to refresh.
+    Vedeu.bind(:_refresh_group_) { |name| Vedeu::Refresh.by_group(name) }
+
+    # Will clear the terminal and then show all of the interfaces belonging to
+    # the named group.
+    Vedeu.bind(:_show_group_) do |name|
+      Vedeu.trigger(:_clear_)
+
+      Vedeu.trigger(:_refresh_group_, name)
+    end
+
+    # Will hide all of the interfaces belonging to the named group. Useful for
+    # hiding part of that which is currently displaying in the terminal.
+    #
+    # @note
+    #   This may be rarely used, since the action of showing a group using
+    #   `Vedeu.trigger(:_show_group_, group_name)` will effectively clear the
+    #   terminal and show the new group.
+    Vedeu.bind(:_hide_group_) do |name|
+      Vedeu.trigger(:_clear_group_, name)
     end
 
   end # Bindings

data/lib/vedeu/cursor/cursor.rb

@@ -18,7 +18,7 @@ module Vedeu
 
     attr_reader :attributes, :name, :ox, :oy, :state, :x, :y
 
-    # Provides a new instance of Cursor.
+    # Returns a new instance of Cursor.
     #
     # @param attributes [Hash]
     # @option attributes name [String] The name of the interface this cursor

data/lib/vedeu/cursor/move_cursor.rb

@@ -4,7 +4,34 @@ require 'vedeu/geometry/position_validator'
 
 module Vedeu
 
-  # Adjusts the position of the cursor.
+  # Adjusts the position of the cursor. To use this class, call the appropriate
+  # event:
+  #
+  # @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.
+  #
+  # @note
+  #   The cursor may not be visible, but it will still move if requested.
+  #   The cursor will not exceed the border or boundary of the interface.
+  #   The cursor will move freely within the bounds of the interface,
+  #     irrespective of content.
   #
   class MoveCursor
 
@@ -19,6 +46,8 @@ module Vedeu
                               :height,
                               :width
 
+    # Returns an instance of MoveCursor.
+    #
     # @param cursor    [Cursor]
     # @param interface [Interface]
     # @param dy        [Fixnum] Move up (-1), or down (1), or no action (0).
@@ -31,8 +60,37 @@ module Vedeu
       @interface = interface
     end
 
+    # Move the named cursor, or that which is currently in focus in the
+    # specified direction.
+    #
+    # @param direction [Symbol] The direction of travel. Directions include:
+    #   (:down, :left, :right, :up, :origin). When ':origin' the cursor is moved
+    #   to the top left of the interface.
+    # @param name [String|NilClass] The name of the interface/cursor to be
+    #   moved; when not given, the interface currently in focus determines which
+    #   cursor instance to move.
+    # @return [Cursor]
+    def self.by_name(direction, name = nil)
+      if name
+        cursor     = Vedeu.cursors.by_name(name)
+        interface  = Vedeu.interfaces.find(name)
+        new_cursor = MoveCursor.send(direction, cursor, interface)
+        Refresh.by_name(name)
+
+      else
+        cursor     = Vedeu.cursor
+        interface  = Vedeu.interfaces.current
+        new_cursor = MoveCursor.send(direction, cursor, interface)
+        Refresh.by_focus
+
+      end
+      new_cursor
+    end
+
     # Moves the cursor down by one row.
     #
+    # @param cursor    [Cursor]
+    # @param interface [Interface]
     # @return [Cursor]
     def self.down(cursor, interface)
       new(cursor, interface, 1, 0).move
@@ -40,6 +98,8 @@ module Vedeu
 
     # Moves the cursor left by one column.
     #
+    # @param cursor    [Cursor]
+    # @param interface [Interface]
     # @return [Cursor]
     def self.left(cursor, interface)
       return cursor unless cursor.ox > 0
@@ -49,6 +109,8 @@ module Vedeu
 
     # Moves the cursor right by one column.
     #
+    # @param cursor    [Cursor]
+    # @param interface [Interface]
     # @return [Cursor]
     def self.right(cursor, interface)
       new(cursor, interface, 0, 1).move
@@ -56,6 +118,8 @@ module Vedeu
 
     # Moves the cursor up by one row.
     #
+    # @param cursor    [Cursor]
+    # @param interface [Interface]
     # @return [Cursor]
     def self.up(cursor, interface)
       return cursor unless cursor.oy > 0
@@ -65,6 +129,8 @@ module Vedeu
 
     # Moves the cursor to the top left coordinate of the interface.
     #
+    # @param cursor    [Cursor]
+    # @param interface [Interface]
     # @return [Cursor]
     def self.origin(cursor, interface)
       new(cursor, interface, (0 - cursor.y), (0 - cursor.x)).move
@@ -98,6 +164,9 @@ module Vedeu
                                                       coordinate.y_position(oy))
     end
 
+    # Apply the direction amount to the cursor offset. If the offset is less
+    # than 0, correct to 0.
+    #
     # @return [Fixnum]
     def ox
       ox = cursor.ox + dx
@@ -105,6 +174,9 @@ module Vedeu
       ox
     end
 
+    # Apply the direction amount to the cursor offset. If the offset is less
+    # than 0, correct to 0.
+    #
     # @return [Fixnum]
     def oy
       oy = cursor.oy + dy
@@ -120,6 +192,8 @@ module Vedeu
                                             top)
     end
 
+    # Return the height of the interface, minus any borders.
+    #
     # @return [Fixnum]
     def bordered_height
       return border.height if border?
@@ -127,6 +201,8 @@ module Vedeu
       height
     end
 
+    # Return the width of the interface, minus any borders.
+    #
     # @return [Fixnum]
     def bordered_width
       return border.width if border?

data/lib/vedeu/cursor/toggle_cursor.rb

@@ -4,6 +4,8 @@ module Vedeu
   #
   class ToggleCursor
 
+    # Returns an instance of ToggleCursor.
+    #
     # @param cursor [Cursor]
     # @return [ToggleCursor]
     def initialize(cursor)