vedeu 0.4.45 → 0.4.46

data/lib/vedeu/bindings/drb.rb

@@ -5,10 +5,9 @@ module Vedeu
     # System events relating to the DRb server implementation.
     #
     # @api public
+    # {include:file:docs/events/drb.md}
     module DRB
 
-      # Triggering this event will send input to the running application as long
-      # as it has the DRb server running.
       Vedeu.bind(:_drb_input_) do |data, type|
         Vedeu.log(type: :drb, message: "Sending input (#{type})")
 
@@ -18,24 +17,16 @@ module Vedeu
         end
       end
 
+      # @todo This event queries Vedeu. Events should only be commands.
       Vedeu.bind(:_drb_retrieve_output_) { Vedeu::VirtualBuffer.retrieve }
 
-      # Triggering this event with 'data' will push data into the running
-      # application's virtual buffer.
       Vedeu.bind(:_drb_store_output_) do |data|
         Vedeu::VirtualBuffer.store(Vedeu::Terminal.virtual.output(data))
       end
 
-      # Use the DRb server to request the client application to restart.
       Vedeu.bind(:_drb_restart_) { Vedeu::Distributed::Server.restart }
-
-      # Use the DRb server to request the client application to start.
       Vedeu.bind(:_drb_start_) { Vedeu::Distributed::Server.start }
-
-      # Use the DRb server to request the status of the client application.
       Vedeu.bind(:_drb_status_) { Vedeu::Distributed::Server.status }
-
-      # Use the DRb server to request the client application to stop.
       Vedeu.bind(:_drb_stop_) { Vedeu::Distributed::Server.stop }
 
     end # DRB

data/lib/vedeu/bindings/menus.rb

@@ -6,44 +6,26 @@ module Vedeu
     # argument.
     #
     # @api public
+    # {include:file:docs/events/menus.md}
     module Menus
 
-      # Makes the last menu item the current menu item.
       Vedeu.bind(:_menu_bottom_) { |name| Vedeu.menus.find(name).bottom_item }
-
-      # Returns the current menu item.
       Vedeu.bind(:_menu_current_) { |name| Vedeu.menus.find(name).current_item }
 
-      # Deselects all menu items.
       Vedeu.bind(:_menu_deselect_) do |name|
         Vedeu.menus.find(name).deselect_item
       end
 
-      # Returns all the menu items with respective `current` or `selected`
-      # boolean indicators.
       Vedeu.bind(:_menu_items_) { |name| Vedeu.menus.find(name).items }
-
-      # Makes the next menu item the current menu item, until it reaches the
-      # last item.
       Vedeu.bind(:_menu_next_) { |name| Vedeu.menus.find(name).next_item }
-
-      # Makes the previous menu item the current menu item, until it reaches the
-      # first item.
       Vedeu.bind(:_menu_prev_) { |name| Vedeu.menus.find(name).prev_item }
 
-      # Returns the selected menu item.
       Vedeu.bind(:_menu_selected_) do |name|
         Vedeu.menus.find(name).selected_item
       end
 
-      # Makes the current menu item also the selected menu item.
       Vedeu.bind(:_menu_select_) { |name| Vedeu.menus.find(name).select_item }
-
-      # Makes the first menu item the current menu item.
       Vedeu.bind(:_menu_top_) { |name| Vedeu.menus.find(name).top_item }
-
-      # Returns a subset of the menu items; starting at the current item to the
-      # last item.
       Vedeu.bind(:_menu_view_) { |name| Vedeu.menus.find(name).view }
 
     end # Menus

data/lib/vedeu/bindings/movement.rb

@@ -5,66 +5,54 @@ module Vedeu
     # System events relating to movement of cursors or interfaces.
     #
     # @api public
+    # {include:file:docs/events/movement.md}
     module Movement
 
-      # @see {Vedeu::Move}
       Vedeu.bind(:_cursor_down_) do |name|
         Vedeu::Move.by_name(Vedeu::Cursor, :down, name)
       end
 
-      # @see {Vedeu::Move}
       Vedeu.bind(:_cursor_left_) do |name|
         Vedeu::Move.by_name(Vedeu::Cursor, :left, name)
       end
 
-      # @see {Vedeu::Move}
       Vedeu.bind(:_cursor_origin_) do |name|
         Vedeu::Move.by_name(Vedeu::Cursor, :origin, name)
       end
 
-      # Move the cursor to a relative position inside the interface.
-      #
-      # @todo
-      #   - The content of the interface needs to be a consideration.
-      #   - If the screen size changes, what should happen to the cursor.
-      #   - How do we represent cursors which are deliberately positioned
-      #     outside of the viewable area?
-      #
+      # @todo This event queries Vedeu. Events should only be commands.
+      Vedeu.bind(:_cursor_position_) do |name|
+        Vedeu.cursors.by_name(name).position
+      end
+
       Vedeu.bind(:_cursor_reposition_) do |name, y, x|
         Vedeu::Reposition.to(Vedeu::Cursor, name, y, x)
       end
 
-      # @see {Vedeu::Move}
       Vedeu.bind(:_cursor_reset_) do |name|
         Vedeu.trigger(:_cursor_origin_, name)
       end
 
-      # @see {Vedeu::Move}
       Vedeu.bind(:_cursor_right_) do |name|
         Vedeu::Move.by_name(Vedeu::Cursor, :right, name)
       end
 
-      # @see {Vedeu::Move}
       Vedeu.bind(:_cursor_up_) do |name|
         Vedeu::Move.by_name(Vedeu::Cursor, :up, name)
       end
 
-      # @see {Vedeu::Move}
       Vedeu.bind(:_geometry_down_) do |name|
         Vedeu::Move.by_name(Vedeu::Geometry, :down, name)
       end
 
-      # @see {Vedeu::Move}
       Vedeu.bind(:_geometry_left_) do |name|
         Vedeu::Move.by_name(Vedeu::Geometry, :left, name)
       end
 
-      # @see {Vedeu::Move}
       Vedeu.bind(:_geometry_right_) do |name|
         Vedeu::Move.by_name(Vedeu::Geometry, :right, name)
       end
 
-      # @see {Vedeu::Move}
       Vedeu.bind(:_geometry_up_) do |name|
         Vedeu::Move.by_name(Vedeu::Geometry, :up, name)
       end

data/lib/vedeu/bindings/visibility.rb

@@ -5,43 +5,22 @@ module Vedeu
     # System events relating to the visibility of cursors or interfaces.
     #
     # @api public
+    # {include:file:docs/events/visibility.md}
     module Visibility
 
-      # Hide the cursor of the named interface or interface currently in focus.
-      Vedeu.bind(:_hide_cursor_) do |name|
-        Vedeu::Visibility.for_cursor(name).hide
-      end
+      Vedeu.bind(:_hide_cursor_) { |name| Vedeu::Visibility.hide_cursor(name) }
       Vedeu.bind(:_cursor_hide_) { |name| Vedeu.trigger(:_hide_cursor_, name) }
-
-      # 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_) { |name| Vedeu.trigger(:_clear_group_, name) }
-
-      # @see Vedeu::Buffer#hide
-      Vedeu.bind(:_hide_interface_) { |name| Vedeu.buffers.by_name(name).hide }
-
-      # Show the cursor of the named interface or interface currently in focus.
-      Vedeu.bind(:_show_cursor_) do |name|
-        Vedeu::Visibility.for_cursor(name).show
-      end
+      Vedeu.bind(:_show_cursor_) { |name| Vedeu::Visibility.show_cursor(name) }
       Vedeu.bind(:_cursor_show_) { |name| Vedeu.trigger(:_show_cursor_, name) }
 
-      # Will clear the terminal and then show all of the interfaces belonging to
-      # the named group.
+      Vedeu.bind(:_hide_group_) { |name| Vedeu.trigger(:_clear_group_, name) }
       Vedeu.bind(:_show_group_) do |name|
         Vedeu.trigger(:_clear_)
         Vedeu.trigger(:_refresh_group_, name)
       end
 
-      # @see Vedeu::Buffer#show
+      Vedeu.bind(:_hide_interface_) { |name| Vedeu.buffers.by_name(name).hide }
       Vedeu.bind(:_show_interface_) { |name| Vedeu.buffers.by_name(name).show }
-
-      # @see Vedeu::Buffer#toggle
       Vedeu.bind(:_toggle_interface_) do |name|
         Vedeu.buffers.by_name(name).toggle
       end

data/lib/vedeu/configuration/configuration.rb

@@ -202,7 +202,7 @@ module Vedeu
         instance.reset!
       end
 
-    end # Configuration eigenclass
+    end # Eigenclass
 
     # @!attribute [r] options
     # @return [Hash]

data/lib/vedeu/distributed/server.rb

@@ -10,36 +10,43 @@ module Vedeu
       include Singleton
 
       # @param (see #input)
+      # @see #input
       def self.input(data, type = :key)
         instance.input(data, type)
       end
 
       # @return [void]
+      # @see #output
       def self.output
         instance.output
       end
 
       # @return [void]
+      # @see #restart
       def self.restart
         instance.restart
       end
 
       # @return [void]
+      # @see #shutdown
       def self.shutdown
         instance.shutdown
       end
 
       # @return [void]
+      # @see #start
       def self.start
         instance.start
       end
 
       # @return [Symbol]
+      # @see #status
       def self.status
         instance.status
       end
 
       # @return [void]
+      # @see #stop
       def self.stop
         instance.stop
       end
@@ -63,6 +70,8 @@ module Vedeu
         Process.pid
       end
 
+      # Restart the DRb server.
+      #
       # @return [void]
       def restart
         log('Attempting to restart')
@@ -102,6 +111,8 @@ module Vedeu
         Vedeu::Terminal.restore_screen
       end
 
+      # Start the DRb server.
+      #
       # @return [Vedeu::Distributed::Server]
       def start
         log('Attempting to start')
@@ -120,6 +131,8 @@ module Vedeu
         end
       end
 
+      # Fetch the status of the DRb server.
+      #
       # @return [Symbol]
       def status
         log('Fetching status')
@@ -139,6 +152,8 @@ module Vedeu
         end
       end
 
+      # Stop the DRb server.
+      #
       # @return [void]
       def stop
         log('Attempting to stop')

data/lib/vedeu/dsl/presentation.rb

@@ -38,18 +38,14 @@ module Vedeu
       #
       # @return [String]
       def background(value = '')
-        model.colour = Vedeu::Colour.coerce(
-          background: Vedeu::Background.coerce(value),
-          foreground: model.colour.foreground)
+        colour(background: Vedeu::Background.coerce(value))
       end
       alias_method :bg,      :background
       alias_method :bgcolor, :background
 
       # @see Vedeu::DSL::Presentation#background
       def foreground(value = '')
-        model.colour = Vedeu::Colour.coerce(
-          foreground: Vedeu::Foreground.coerce(value),
-          background: model.colour.background)
+        colour(foreground: Vedeu::Foreground.coerce(value))
       end
       alias_method :fg,      :foreground
       alias_method :fgcolor, :foreground
@@ -81,7 +77,7 @@ module Vedeu
       #
       # @return [Vedeu::Colour]
       def colour(attributes = {})
-        model.colour = Vedeu::Colour.coerce(attributes)
+        model.colour = Vedeu::Colour.coerce(colour_attributes.merge(attributes))
       end
 
       # Define a style or styles for an interface, line or a stream.
@@ -110,6 +106,16 @@ module Vedeu
       end
       alias_method :styles, :style
 
+      private
+
+      # @return [Hash<Symbol => String>]
+      def colour_attributes
+        {
+          background: model.colour.background,
+          foreground: model.colour.foreground,
+        }
+      end
+
     end # Presentation
 
   end # DSL

data/lib/vedeu/dsl/view.rb

@@ -131,7 +131,7 @@ module Vedeu
           end
         end
 
-      end
+      end # Eigenclass
 
     end # View
 

data/lib/vedeu/events/event.rb

@@ -111,7 +111,7 @@ module Vedeu
 
       def_delegators Vedeu::Trigger, :trigger
 
-    end
+    end # Eigenclass
 
     # Returns a new instance of Vedeu::Event.
     #

data/lib/vedeu/main_loop.rb

@@ -49,7 +49,7 @@ module Vedeu
       end
       # :nocov:
 
-    end
+    end # Eigenclass
 
   end # MainLoop
 

data/lib/vedeu/models/interface.rb

@@ -1,3 +1,6 @@
+require 'vedeu/models/char'
+require 'vedeu/models/stream'
+require 'vedeu/models/line'
 require 'vedeu/buffers/display_buffer'
 
 module Vedeu

data/lib/vedeu/null/interface.rb

@@ -1,3 +1,5 @@
+require 'vedeu/output/presentation'
+
 module Vedeu
 
   module Null
@@ -7,6 +9,8 @@ module Vedeu
     # @api private
     class Interface
 
+      include Vedeu::Presentation
+
       # Returns a new instance of Vedeu::Null::Interface.
       #
       # @param name [String]
@@ -22,6 +26,13 @@ module Vedeu
         }
       end
 
+      # The null interface should not have a parent.
+      #
+      # @return [NilClass]
+      def parent
+        nil
+      end
+
       # Pretend to store this model in the repository.
       #
       # @return [Vedeu::Null::Interface]

data/lib/vedeu/output/clear.rb

@@ -30,6 +30,7 @@ module Vedeu
 
         Vedeu.groups.find(group).members.each { |name| clear(name) }
       end
+      alias_method :clear_by_group, :by_group
 
       # @param name [String]
       # @return [void]
@@ -40,6 +41,7 @@ module Vedeu
               clear_border: true,
               use_terminal_colours: true)
       end
+      alias_method :clear_by_name, :by_name
 
       # Clears the area defined by the interface.
       #
@@ -56,7 +58,7 @@ module Vedeu
       end
       alias_method :render, :clear
 
-    end
+    end # Eigenclass
 
     # Return a new instance of Vedeu::Clear.
     #

data/lib/vedeu/repositories/repositories/borders.rb

@@ -1,3 +1,6 @@
+require 'vedeu/null/border'
+require 'vedeu/output/border'
+
 module Vedeu
 
   # Allows the storing of interface/view borders independent of the interface
@@ -13,17 +16,18 @@ module Vedeu
       # Remove all stored models from the repository.
       #
       # @example
-      #   Vedeu.borders.reset
+      #   Vedeu.borders.reset!
       #
       # @return [Vedeu::Borders]
       def reset!
         @borders = register(Vedeu::Border)
       end
+      alias_method :reset, :reset!
 
-    end
+    end # Eigenclass
 
     null Vedeu::Null::Border
-    # real Vedeu::Border
+    real Vedeu::Border
 
   end # Borders
 

data/lib/vedeu/repositories/repositories/buffers.rb

@@ -1,3 +1,6 @@
+require 'vedeu/null/buffer'
+require 'vedeu/buffers/buffer'
+
 module Vedeu
 
   # Allows the storing of view buffers.
@@ -12,17 +15,18 @@ module Vedeu
       # Remove all stored models from the repository.
       #
       # @example
-      #   Vedeu.buffers.reset
+      #   Vedeu.buffers.reset!
       #
       # @return [Vedeu::Buffers]
       def reset!
         @buffers = register(Vedeu::Buffer)
       end
+      alias_method :reset, :reset!
 
-    end
+    end # Eigenclass
 
     null Vedeu::Null::Buffer
-    # real Vedeu::Buffer
+    real Vedeu::Buffer
 
   end # Buffers
 

data/lib/vedeu/repositories/repositories/cursors.rb

@@ -18,14 +18,15 @@ module Vedeu
       # Remove all stored models from the repository.
       #
       # @example
-      #   Vedeu.cursors.reset
+      #   Vedeu.cursors.reset!
       #
       # @return [Vedeu::Cursors]
       def reset!
         @cursors = register(Vedeu::Cursor)
       end
+      alias_method :reset, :reset!
 
-    end
+    end # Eigenclass
 
     # @example
     #   Vedeu.cursors.by_name('some_name')

data/lib/vedeu/repositories/repositories/events.rb

@@ -12,14 +12,15 @@ module Vedeu
       # Remove all stored models from the repository.
       #
       # @example
-      #   Vedeu.events.reset
+      #   Vedeu.events.reset!
       #
       # @return [Vedeu::Events]
       def reset!
         @events = new(Vedeu::EventCollection)
       end
+      alias_method :reset, :reset!
 
-    end
+    end # Eigenclass
 
   end # Events
 

data/lib/vedeu/repositories/repositories/geometries.rb

@@ -1,3 +1,6 @@
+require 'vedeu/null/geometry'
+require 'vedeu/geometry/geometry'
+
 module Vedeu
 
   # Allows the storing of interface/view geometry independent of the interface
@@ -19,11 +22,12 @@ module Vedeu
       def reset!
         @geometries = register(Vedeu::Geometry)
       end
+      alias_method :reset, :reset!
 
-    end
+    end # Eigenclass
 
     null Vedeu::Null::Geometry
-    # real Vedeu::Geometry
+    real Vedeu::Geometry
 
   end # Geometries
 

data/lib/vedeu/repositories/repositories/groups.rb

@@ -18,8 +18,9 @@ module Vedeu
       def reset!
         @groups = register(Vedeu::Group)
       end
+      alias_method :reset, :reset!
 
-    end
+    end # Eigenclass
 
     # @example
     #   Vedeu.groups.by_name('name')

data/lib/vedeu/repositories/repositories/interfaces.rb

@@ -1,3 +1,6 @@
+require 'vedeu/null/interface'
+require 'vedeu/models/interface'
+
 module Vedeu
 
   # Allows the storing of interfaces and views.
@@ -18,11 +21,12 @@ module Vedeu
       def reset!
         @interfaces = register(Vedeu::Interface)
       end
+      alias_method :reset, :reset!
 
-    end
+    end # Eigenclass
 
     null Vedeu::Null::Interface
-    # real Vedeu::Interface
+    real Vedeu::Interface
 
     # Returns the interfaces in zindex order.
     #

data/lib/vedeu/repositories/repositories/keymaps.rb

@@ -18,8 +18,9 @@ module Vedeu
       def reset!
         @keymaps = register(Vedeu::Keymap)
       end
+      alias_method :reset, :reset!
 
-    end
+    end # Eigenclass
 
   end # Keymaps
 

data/lib/vedeu/repositories/repositories/menus.rb

@@ -18,8 +18,9 @@ module Vedeu
       def reset!
         @menus = register(Vedeu::Menu)
       end
+      alias_method :reset, :reset!
 
-    end
+    end # Eigenclass
 
   end # Menus
 

data/lib/vedeu/support/log.rb

@@ -189,7 +189,7 @@ module Vedeu
         "[#{format('%7.4f', @time.to_s)}] ".rjust(7)
       end
 
-    end # Log eigenclass
+    end # Eigenclass
 
   end # Log
 

data/lib/vedeu/support/timer.rb

@@ -19,7 +19,7 @@ module Vedeu
         new(message).measure(&block)
       end
 
-    end
+    end # Eigenclass
 
     # Returns a new instance of Vedeu::Timer.
     #