vedeu 0.1.18 → 0.1.19

data/lib/vedeu/{support → repositories}/events.rb

@@ -1,6 +1,13 @@
 module Vedeu
+
+  # Provides a mechanism for storing and retrieving events by name. A single
+  # name can contain many events. Also an event can trigger other events.
+  #
+  # @api private
   class Events
 
+    # Initializes a new Events class.
+    #
     # @param block [Proc]
     # @return [Events]
     def initialize(&block)
@@ -24,11 +31,7 @@ module Vedeu
       handlers[name]
     end
 
-    # Unregisters the event by name, effectively deleting the associated events
-    # bound with it also.
-    #
-    # @param name [Symbol]
-    # @return []
+    # @see Vedeu::API#unevent
     def unevent(name)
       handlers.delete_if { |k, v| k == name }
     end
@@ -40,6 +43,13 @@ module Vedeu
       handlers.keys
     end
 
+    # Returns a Boolean indicating whether the named event is registered.
+    #
+    # @return [TrueClass|FalseClass]
+    def registered?(name)
+      handlers.key?(name)
+    end
+
     # @see Vedeu::API#trigger
     def trigger(name, *args)
       handlers[name][:events].each { |event| event.trigger(*args) }
@@ -47,7 +57,7 @@ module Vedeu
 
     # Remove all registered events. Used for testing purposes.
     #
-    # @return []
+    # @return [Hash]
     def reset
       @handlers = Hash.new { |hash, key| hash[key] = { events: [] } }
     end

data/lib/vedeu/repositories/focus.rb

@@ -0,0 +1,109 @@
+module Vedeu
+
+  # The Focus repository is simply a collection of interface names, this module
+  # serving to store and manipulate the which interface is currently being
+  # focussed.
+  #
+  # @api private
+  module Focus
+
+    extend self
+
+    # Add an interface name to the focus list unless it is already registered.
+    #
+    # @param attributes [String]
+    # @return [Array]
+    def add(attributes)
+      if registered?(attributes[:name])
+        storage
+
+      else
+        storage << attributes[:name]
+
+      end
+    end
+
+    # Focus an interface by name.
+    #
+    # @param name [String]
+    # @return [String]
+    def by_name(name)
+      fail InterfaceNotFound unless storage.include?(name)
+
+      storage.rotate!(storage.index(name))
+
+      current
+    end
+
+    # Return the interface currently focussed.
+    #
+    # @return [String]
+    def current
+      fail NoInterfacesDefined if storage.empty?
+
+      storage.first
+    end
+
+    # Put the next interface relative to the current interfaces in focus.
+    #
+    # @return [String]
+    def next_item
+      storage.rotate!
+
+      current
+    end
+
+    # Put the previous interface relative to the current interface in focus.
+    #
+    # @return [String]
+    def prev_item
+      storage.rotate!(-1)
+
+      current
+    end
+
+    # Returns all registered interfaces by name.
+    #
+    # @return [Array]
+    def registered
+      storage
+    end
+
+    # Reset the focus repository; removing all items. This does not delete
+    # the interfaces themselves.
+    #
+    # @return [Hash]
+    def reset
+      @storage = in_memory
+    end
+
+    private
+
+    # Returns a boolean indicating whether the named interface is registered.
+    #
+    # @api private
+    # @return [TrueClass|FalseClass]
+    def registered?(name)
+      return false if storage.empty?
+
+      storage.include?(name)
+    end
+
+    # Provides accessor to the in-memory storage.
+    #
+    # @api private
+    # @return [Array]
+    def storage
+      @storage ||= in_memory
+    end
+
+    # Returns an empty collection ready for the storing of interface names.
+    #
+    # @api private
+    # @return [Array]
+    def in_memory
+      []
+    end
+
+  end
+end

data/lib/vedeu/repositories/groups.rb

@@ -0,0 +1,76 @@
+module Vedeu
+
+  # Repository for storing and retrieving interfaces by their group name.
+  #
+  # @api private
+  module Groups
+
+    extend self
+
+    # Add an interface name to a group, creating the group if it doesn't already
+    # exist, and rejecting the interface if it is already known.
+    #
+    # @param attributes [Hash]
+    # @return [Groups|FalseClass]
+    def add(attributes)
+      return false if attributes[:group].empty?
+
+      storage[attributes[:group]] << attributes[:name]
+    end
+
+    # Return the whole repository.
+    #
+    # @return [Set]
+    def all
+      storage
+    end
+
+    # Find a group by name and return all of its associated interfaces.
+    #
+    # @param name [String]
+    # @return [Set]
+    def find(name)
+      storage.fetch(name) do
+        fail GroupNotFound,
+          "Cannot find interface group with this name: #{name.to_s}."
+      end
+    end
+
+    # Returns a collection of the names of all registered groups.
+    #
+    # @return [Array]
+    def registered
+      storage.keys
+    end
+
+    # Returns a Boolean indicating whether the named group is registered.
+    #
+    # @return [TrueClass|FalseClass]
+    def registered?(name)
+      storage.key?(name)
+    end
+
+    # Reset the groups repository; removing all groups. This does not delete
+    # the interfaces themselves.
+    #
+    # @return [Hash]
+    def reset
+      @_storage = in_memory
+    end
+
+    private
+
+    # @api private
+    # @return [Hash]
+    def storage
+      @_storage ||= in_memory
+    end
+
+    # @api private
+    # @return [Hash]
+    def in_memory
+      Hash.new { |hash, key| hash[key] = Set.new }
+    end
+
+  end
+end

data/lib/vedeu/repositories/interfaces.rb

@@ -0,0 +1,74 @@
+module Vedeu
+
+  # Repository for storing and retrieving defined interfaces.
+  #
+  # @api private
+  module Interfaces
+
+    extend self
+
+    # Stores the interface attributes defined by the API.
+    #
+    # @param attributes [Hash]
+    # @return [Hash]
+    def add(attributes)
+      storage.store(attributes[:name], attributes)
+    end
+
+    # Return the whole repository.
+    #
+    # @return [Hash]
+    def all
+      storage
+    end
+
+    # Find an interface by name and return the attributes used to define it.
+    #
+    # @param name [String]
+    # @return [Hash]
+    def find(name)
+      storage.fetch(name) do
+        fail InterfaceNotFound,
+          "Interface was not found with this name: #{name.to_s}."
+      end
+    end
+
+    # Returns a collection of the names of all the registered interfaces.
+    #
+    # @return [Array]
+    def registered
+      storage.keys
+    end
+
+    # Returns a boolean indicating whether the named interface is registered.
+    #
+    # @return [TrueClass|FalseClass]
+    def registered?(name)
+      storage.key?(name)
+    end
+
+    # Reset the interfaces repository; removing all registered interfaces.
+    # This will delete the interfaces themselves, and the client application
+    # will need to either redefine interfaces before using them, or restart.
+    #
+    # @return [Hash]
+    def reset
+      @_storage = in_memory
+    end
+
+    private
+
+    # @api private
+    # @return [Hash]
+    def storage
+      @_storage ||= in_memory
+    end
+
+    # @api private
+    # @return [Hash]
+    def in_memory
+      {}
+    end
+
+  end
+end

data/lib/vedeu/support/common.rb

@@ -0,0 +1,20 @@
+module Vedeu
+
+  # A module for common methods used throughout Vedeu.
+  #
+  # @api private
+  module Common
+
+    # Returns a boolean indicating whether a variable has a useful value.
+    #
+    # @param variable [String|Array] The variable to check.
+    # @return [TrueClass|FalseClass]
+    def defined_value?(variable)
+      return true unless variable.nil? || variable.empty?
+
+      false
+    end
+
+  end
+end
+

data/lib/vedeu/support/cursor.rb

@@ -0,0 +1,77 @@
+module Vedeu
+
+  # Stores and manipulates the position of the current cursor.
+  #
+  # @api private
+  class Cursor
+
+    attr_reader :top, :bottom, :left, :right, :cursor_x, :cursor_y
+
+    # Provides a new instance of Cursor.
+    #
+    # @param attributes [Hash]
+    # @return [Cursor]
+    def initialize(attributes = {})
+      @attributes = attributes
+
+      @top        = attributes.fetch(:top)
+      @bottom     = attributes.fetch(:bottom)
+      @left       = attributes.fetch(:left)
+      @right      = attributes.fetch(:right)
+      @cursor_y   = attributes.fetch(:cursor_y, @top)
+      @cursor_x   = attributes.fetch(:cursor_x, @left)
+    end
+
+    # Reports the position of the cursor.
+    #
+    # @return [Array]
+    def position
+      [ @cursor_y, @cursor_x ]
+    end
+
+    # Move the cursor up one row.
+    #
+    # @return [Cursor]
+    def move_up
+      unless @cursor_y == top || @cursor_y - 1 < top
+        @cursor_y -= 1
+      end
+
+      self
+    end
+
+    # Move the cursor down one row.
+    #
+    # @return [Cursor]
+    def move_down
+      unless @cursor_y == bottom || @cursor_y + 1 > bottom
+        @cursor_y += 1
+      end
+
+      self
+    end
+
+    # Move the cursor left one column.
+    #
+    # @return [Cursor]
+    def move_left
+      unless @cursor_x == left || @cursor_x - 1 < left
+        @cursor_x -= 1
+      end
+
+      self
+    end
+
+    # Move the cursor right one column.
+    #
+    # @return [Cursor]
+    def move_right
+      unless @cursor_x == right || @cursor_x + 1 > right
+        @cursor_x += 1
+      end
+
+      self
+    end
+
+  end
+end

data/lib/vedeu/support/esc.rb

@@ -1,4 +1,9 @@
 module Vedeu
+
+  # Provides escape sequence strings for setting the cursor position and various
+  # display related functions.
+  #
+  # @api private
   module Esc
 
     extend self
@@ -15,54 +20,184 @@ module Vedeu
       Position.new(y, x).to_s(&block)
     end
 
-    # @param value [String]
+    # Return the escape sequence string from the list of recognised sequence
+    # 'commands', or an empty string if the 'command' cannot be found.
+    #
+    # @param value [String|Symbol]
     # @return [String]
     def string(value = '')
-      case value
-      when 'bg_reset'      then "\e[48;2;49m"
-      when 'blink'         then "\e[5m"
-      when 'blink_off'     then "\e[25m"
-      when 'bold'          then "\e[1m"
-      when 'bold_off'      then "\e[22m"
-      when 'clear'         then "\e[38;2;39m\e[48;2;49m\e[2J"
-      when 'clear_line'    then "\e[38;2;39m\e[48;2;49m\e[2K"
-      when 'colour_reset'  then
-        [ string('fg_reset'),
-          string('bg_reset') ].join
-
-      when 'dim'           then "\e[2m"
-      when 'fg_reset'      then "\e[38;2;39m"
-      when 'hide_cursor'   then "\e[?25l"
-      when 'negative'      then "\e[7m"
-      when 'normal'        then
-        [ string('underline_off'),
-          string('bold_off'),
-          string('positive') ].join
-
-      when 'positive'      then "\e[27m"
-      when 'reset'         then "\e[0m"
-      when 'screen_init'   then
-        [ string('reset'),
-          string('clear'),
-          string('hide_cursor') ].join
-
-      when 'screen_exit'   then
-        [ string('show_cursor'),
-          string('colour_reset'),
-          string('reset') ].join
-      when 'show_cursor'   then "\e[?25h"
-      when 'underline'     then "\e[4m"
-      when 'underline_off' then "\e[24m"
-      else
-        ''
-      end
-    end
-
-    # private
-
-    # def method_missing(method, *args, &block)
-    #   self.send(:string, method, &block)
-    # end
+      return '' if value.to_sym.empty?
+
+      sequences.fetch(value.to_sym, proc { '' }).call
+    end
+
+    private
+
+    # @api private
+    # @return [Hash]
+    def sequences
+      {
+        bg_reset:        proc { bg_reset },
+        blink:           proc { blink },
+        blink_off:       proc { blink_off },
+        bold:            proc { bold },
+        bold_off:        proc { bold_off },
+        clear:           proc { clear },
+        clear_line:      proc { clear_line },
+        clear_last_line: proc { clear_last_line },
+        colour_reset:    proc { colour_reset },
+        dim:             proc { dim },
+        fg_reset:        proc { fg_reset },
+        hide_cursor:     proc { hide_cursor },
+        negative:        proc { negative },
+        normal:          proc { normal },
+        positive:        proc { positive },
+        reset:           proc { reset },
+        screen_init:     proc { screen_init },
+        screen_exit:     proc { screen_exit },
+        show_cursor:     proc { show_cursor },
+        underline:       proc { underline },
+        underline_off:   proc { underline_off },
+      }
+    end
+
+    # @api private
+    # @return [String]
+    def bg_reset
+      "\e[48;2;49m"
+    end
+
+    # @api private
+    # @return [String]
+    def blink
+      "\e[5m"
+    end
+
+    # @api private
+    # @return [String]
+    def blink_off
+      "\e[25m"
+    end
+
+    # @api private
+    # @return [String]
+    def bold
+      "\e[1m"
+    end
+
+    # @api private
+    # @return [String]
+    def bold_off
+      "\e[22m"
+    end
+
+    # @api private
+    # @return [String]
+    def clear
+      [ string('fg_reset'),
+        string('bg_reset'),
+        "\e[2J" ].join
+    end
+
+    # @api private
+    # @return [String]
+    def clear_line
+      [ string('fg_reset'),
+        string('bg_reset'),
+        "\e[2K" ].join
+    end
+
+    # @api private
+    # @return [String]
+    def clear_last_line
+      [ set_position((Terminal.height - 1), 1),
+        string('clear_line') ].join
+    end
+
+    # @api private
+    # @return [String]
+    def colour_reset
+      [ string('fg_reset'),
+        string('bg_reset') ].join
+    end
+
+    # @api private
+    # @return [String]
+    def dim
+      "\e[2m"
+    end
+
+    # @api private
+    # @return [String]
+    def fg_reset
+      "\e[38;2;39m"
+    end
+
+    # @api private
+    # @return [String]
+    def hide_cursor
+      "\e[?25l"
+    end
+
+    # @api private
+    # @return [String]
+    def negative
+      "\e[7m"
+    end
+
+    # @api private
+    # @return [String]
+    def normal
+      [ string('underline_off'),
+        string('bold_off'),
+        string('positive') ].join
+    end
+
+    # @api private
+    # @return [String]
+    def positive
+      "\e[27m"
+    end
+
+    # @api private
+    # @return [String]
+    def reset
+      "\e[0m"
+    end
+
+    # @api private
+    # @return [String]
+    def screen_init
+      [ string('reset'),
+        string('clear'),
+        string('hide_cursor') ].join
+    end
+
+    # @api private
+    # @return [String]
+    def screen_exit
+      [ string('show_cursor'),
+        string('colour_reset'),
+        string('reset') ].join
+    end
+
+    # @api private
+    # @return [String]
+    def show_cursor
+      "\e[?25h"
+    end
+
+    # @api private
+    # @return [String]
+    def underline
+      "\e[4m"
+    end
+
+    # @api private
+    # @return [String]
+    def underline_off
+      "\e[24m"
+    end
 
   end
 end