vedeu 0.2.2 → 0.2.3

data/lib/vedeu/repositories/interfaces.rb

@@ -5,7 +5,8 @@ module Vedeu
   # @api private
   module Interfaces
 
-    include Vedeu::Common
+    include Common
+    include Repository
     extend self
 
     # Stores the interface attributes defined by the API.
@@ -13,9 +14,9 @@ module Vedeu
     # @param attributes [Hash]
     # @return [Hash|FalseClass]
     def add(attributes)
-      return false unless defined_value?(attributes[:name])
+      validate_attributes!(attributes)
 
-      Vedeu.log("Registering interface '#{attributes[:name]}'")
+      Vedeu.log("Registering interface: '#{attributes[:name]}'")
 
       storage.store(attributes[:name], attributes)
 
@@ -24,36 +25,12 @@ module Vedeu
       true
     end
 
-    # Return the whole repository.
-    #
-    # @return [Hash]
-    def all
-      storage
-    end
-
-    # Find an interface by name and return the attributes used to define it.
+    # Create an instance of Interface from the stored attributes.
     #
     # @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 [Boolean]
-    def registered?(name)
-      storage.key?(name)
+    # @return [Interface]
+    def build(name)
+      Interface.new(find(name))
     end
 
     # Reset the interfaces repository; removing all registered interfaces.
@@ -72,25 +49,27 @@ module Vedeu
     # @param attributes [Hash]
     # @return [Boolean]
     def register_event(attributes)
-      name       = attributes[:name]
-      delay      = attributes[:delay] || 0.0
+      name  = attributes[:name]
+      delay = attributes[:delay] || 0.0
 
       Vedeu::Refresh.register_event(:by_name, name, delay)
     end
 
-    # Access to the storage for this repository.
-    #
     # @api private
     # @return [Hash]
-    def storage
-      @_storage ||= in_memory
+    def in_memory
+      {}
     end
 
     # @api private
-    # @return [Hash]
-    def in_memory
-      {}
+    # @param name [String]
+    # @raise [InterfaceNotFound] When the entity cannot be found with this name.
+    # @return [InterfaceNotFound]
+    def not_found(name)
+      fail InterfaceNotFound,
+        "Interface was not found with this name: #{name.to_s}."
     end
 
-  end
-end
+  end # Interfaces
+
+end # Vedeu

data/lib/vedeu/repositories/keymaps.rb

@@ -5,7 +5,8 @@ module Vedeu
   # @api private
   module Keymaps
 
-    include Vedeu::Common
+    include Common
+    include Repository
     extend self
 
     # Stores the keymap attributes defined by the API.
@@ -30,14 +31,8 @@ module Vedeu
       true
     end
 
-    # Return the whole repository of keymaps.
-    #
-    # @return [Hash]
-    def all
-      storage
-    end
-
-    # Find a keymap by interface name.
+    # Find a keymap by named interface. Return an empty collection when there =
+    # are no specific keys defined for the named interface.
     #
     # @param name [String]
     # @return [Hash]
@@ -86,30 +81,6 @@ module Vedeu
       end.map { |_, v| v.keys }.flatten.uniq
     end
 
-    # Returns a collection of the interface names of all the registered keymaps.
-    #
-    # @return [Array]
-    def registered
-      storage.keys
-    end
-
-    # Returns a boolean indicating whether the named interface has a keymap
-    # registered.
-    #
-    # @param name [String]
-    # @return [Boolean]
-    def registered?(name)
-      storage.key?(name)
-    end
-
-    # Reset the keymaps repository; removing all registered keymaps. Only the
-    # system keymap will remain.
-    #
-    # @return [Hash]
-    def reset
-      @_storage = in_memory
-    end
-
     # Return a boolean indicating whether the key is registered as a system key.
     #
     # @param key [String|Symbol]
@@ -177,13 +148,6 @@ module Vedeu
       Vedeu.trigger(event)
     end
 
-    # @param key [String|Symbol]
-    # @param interface [String]
-    # @return []
-    def validate(key, interface = '')
-      Vedeu::KeymapValidator.check(storage, key, interface)
-    end
-
     # Registers the key.
     #
     # @api private
@@ -192,15 +156,11 @@ module Vedeu
     # @return []
     def register(attributes, interface = '')
       attributes[:keys].map do |keymap|
-        valid, message = validate(keymap[:key], interface)
-
-        fail KeyInUse, message unless valid
+        KeymapValidator.check(storage, keymap[:key], interface)
 
-        Vedeu.log("Registering key '#{keymap[:key]}' with " \
-                  "'#{namespace(interface)}'")
+        Vedeu.log("Registering key: '#{keymap[:key]}' with '#{namespace(interface)}'")
 
-        storage[namespace(interface)]
-          .merge!({ keymap[:key] => keymap[:action] })
+        storage[namespace(interface)].merge!({ keymap[:key] => keymap[:action] })
       end
     end
 
@@ -220,20 +180,12 @@ module Vedeu
       proc { :noop }
     end
 
-    # Access to the storage for this repository.
-    #
-    # @api private
-    # @return [Array]
-    def storage
-      @_storage ||= in_memory
-    end
-
     # @api private
     # @return [Array]
     def in_memory
       { '_global_keymap_' => {} }
     end
 
-  end
+  end # Keymaps
 
-end
+end # Vedeu

data/lib/vedeu/repositories/menus.rb

@@ -6,6 +6,7 @@ module Vedeu
   module Menus
 
     include Common
+    include Repository
     extend self
 
     # System events which when called with the appropriate menu name will
@@ -24,50 +25,17 @@ module Vedeu
     # Stores the menu attributes defined by the API.
     #
     # @param attributes [Hash]
-    # @return [Hash|FalseClass]
+    # @return [Hash|MissingRequired]
     def add(attributes)
-      return false unless defined_value?(attributes[:name])
+      validate_attributes!(attributes)
 
-      Vedeu.log("Registering menu '#{attributes[:name]}'")
+      Vedeu.log("Registering menu: '#{attributes[:name]}'")
 
       attributes.merge!({ items: Vedeu::Menu.new(attributes[:items]) })
 
       storage.store(attributes[:name], attributes)
     end
 
-    # Return the whole repository of menus.
-    #
-    # @return [Hash]
-    def all
-      storage
-    end
-
-    # Find a menu by name.
-    #
-    # @param name [String]
-    # @return [Hash]
-    def find(name)
-      storage.fetch(name) do
-        fail MenuNotFound,
-          "Menu was not found with this name: #{name.to_s}."
-      end
-    end
-
-    # Returns a collection of the names of all the registered menus.
-    #
-    # @return [Array]
-    def registered
-      storage.keys
-    end
-
-    # Returns a boolean indicating whether the named menu is registered.
-    #
-    # @param name [String]
-    # @return [Boolean]
-    def registered?(name)
-      storage.key?(name)
-    end
-
     # Removes the menu from the repository and associated events.
     #
     # @param name [String]
@@ -80,15 +48,6 @@ module Vedeu
       true
     end
 
-    # Reset the menus repository; removing all registered menus.
-    # This will delete the menus themselves, and the client application
-    # will need to either redefine menus before using them, or restart.
-    #
-    # @return [Hash]
-    def reset
-      @_storage = in_memory
-    end
-
     # Access a menu by name.
     #
     # @param name [String]
@@ -99,14 +58,6 @@ module Vedeu
 
     private
 
-    # Access to the storage for this repository.
-    #
-    # @api private
-    # @return [Hash]
-    def storage
-      @_storage ||= in_memory
-    end
-
     # Returns an empty collection ready for the storing of menus by name with
     # associated menu instance.
     #
@@ -116,5 +67,14 @@ module Vedeu
       {}
     end
 
-  end
-end
+    # @api private
+    # @param name [String]
+    # @raise [MenuNotFound] When the entity cannot be found with this name.
+    # @return [MenuNotFound]
+    def not_found(name)
+      fail MenuNotFound, "Menu was not found with this name: #{name.to_s}."
+    end
+
+  end # Menus
+
+end # Vedeu

data/lib/vedeu/support/common.rb

@@ -16,6 +16,6 @@ module Vedeu
       false
     end
 
-  end
-end
+  end # Common
 
+end # Vedeu

data/lib/vedeu/support/esc.rb

@@ -8,6 +8,38 @@ module Vedeu
 
     extend self
 
+    # Dynamically creates methods for each terminal named colour. When a block
+    # is given, then the colour is reset to 'default' once the block is called.
+    #
+    # @example
+    #   Esc.red                     # => "\e[31m"
+    #
+    #   Esc.red { 'some text' }     # => "\e[31msome text\e[39m"
+    #
+    #   Esc.on_blue                 # => "\e[44m"
+    #
+    #   Esc.on_blue { 'some text' } # => "\e[44msome text\e[49m"
+    #
+    # @return [String]
+    {
+      black:   30,
+      red:     31,
+      green:   32,
+      yellow:  33,
+      blue:    34,
+      magenta: 35,
+      cyan:    36,
+      white:   37,
+      default: 39,
+    }.each do |key, code|
+      define_method(key) do |&blk|
+        "\e[#{code}m" + (blk ? blk.call + "\e[39m" : '')
+      end
+      define_method('on_' + key.to_s) do |&blk|
+        "\e[#{code + 10}m" + (blk ? blk.call + "\e[49m" : '')
+      end
+    end
+
     # Return the escape sequence required to position the cursor at a particular
     # point on the screen. When passed a block, will do the aforementioned,
     # call the block and then reposition to this location.
@@ -199,5 +231,6 @@ module Vedeu
       "\e[24m"
     end
 
-  end
-end
+  end # Esc
+
+end # Vedeu

data/lib/vedeu/support/event.rb

@@ -67,12 +67,11 @@ module Vedeu
     # @return [Boolean]
     def throttle_expired?
       if elapsed_time > delay
-        Vedeu.log("Event throttle has expired for '#{event_name}', executing " \
-                  "event.")
         true
 
       else
-        Vedeu.log("Event throttle not yet expired for '#{event_name}'.")
+        Vedeu.log("Throttling event '#{event_name}'")
+
         false
 
       end
@@ -98,12 +97,11 @@ module Vedeu
     # @return [Boolean]
     def debounce_expired?
       if set_executed > deadline
-        Vedeu.log("Event debounce has expired for '#{event_name}', executing " \
-                  "event.")
         true
 
       else
-        Vedeu.log("Event debounce not yet expired for '#{event_name}'.")
+        Vedeu.log("Debouncing event '#{event_name}'")
+
         false
 
       end
@@ -187,5 +185,6 @@ module Vedeu
       }
     end
 
-  end
-end
+  end # Event
+
+end # Vedeu

data/lib/vedeu/support/exceptions.rb

@@ -0,0 +1,47 @@
+module Vedeu
+
+  # Raised when Vedeu attempts to access a named buffer that does not exist.
+  BufferNotFound = Class.new(StandardError)
+
+  # Raised when a cursor cannot be found by name.
+  CursorNotFound = Class.new(StandardError)
+
+  # Raised when trying to access a group of interfaces which do not exist by
+  # this name.
+  GroupNotFound = Class.new(StandardError)
+
+  # Raised when an interface cannot be found by name.
+  InterfaceNotFound = Class.new(StandardError)
+
+  # Raised when Vedeu attempts to parse a {Vedeu.view} or {Vedeu.interface} and
+  # encounters a problem.
+  InvalidSyntax = Class.new(StandardError)
+
+  # Raised when attempting to assign a key which is already in use.
+  KeyInUse = Class.new(StandardError)
+
+  # Raised when a menu cannot be found by name.
+  MenuNotFound = Class.new(StandardError)
+
+  # Raised when the attributes argument to {Vedeu::Registrar} does not contain
+  # a required key or the value to that key is nil or empty.
+  MissingRequired = Class.new(StandardError)
+
+  # Raised intentionally when the client application wishes to switch between
+  # cooked and raw (or vice versa) terminal modes. Vedeu is hard-wired to use
+  # the `Escape` key to trigger this change for the time being.
+  ModeSwitch = Class.new(StandardError)
+
+  # Raised when attempting to reach the currently in focus interface, when no
+  # interfaces have been defined yet.
+  NoInterfacesDefined = Class.new(StandardError)
+
+  # Raised to remind me (or client application developers) that the subclass
+  # implements the functionality sought.
+  NotImplemented = Class.new(StandardError)
+
+  # Raised when trying to access an interface column less than 1 or greater
+  # than 12. Vedeu is hard-wired to a 12-column layout for the time being.
+  OutOfRange = Class.new(StandardError)
+
+end # Vedeu

data/lib/vedeu/support/grid.rb

@@ -16,7 +16,8 @@ class Fixnum
   def columns
     Vedeu::Grid.columns(self)
   end
-end
+
+end # Fixnum
 
 module Vedeu
 
@@ -38,9 +39,12 @@ module Vedeu
       @value = value
     end
 
+    # @raise [OutOfRange] When the value parameter is not between 1 and 12
+    #   inclusive.
     # @return [Fixnum|OutOfRange]
     def columns
-      fail OutOfRange, 'Valid range is 1..12.' if out_of_range?
+      fail OutOfRange,
+        'Valid value between 1 and 12 inclusive.' if out_of_range?
 
       column * value
     end
@@ -49,6 +53,8 @@ module Vedeu
 
     attr_reader :value
 
+    # Returns the width of a single column in characters.
+    #
     # @api private
     # @return [Fixnum]
     def column
@@ -67,5 +73,6 @@ module Vedeu
       value < 1 || value > 12
     end
 
-  end
-end
+  end # Grid
+
+end # Vedeu

data/lib/vedeu/support/keymap_validator.rb

@@ -29,27 +29,26 @@ module Vedeu
       @storage, @key, @interface = storage, key, interface
     end
 
+    # @raise [KeyInUse] When the key is already in use.
     # @see KeymapValidator.check
     def check
       if system_key?(key)
-        [false, fail_message(key) + ' by the system.']
+        fail KeyInUse, "'#{key}' is already in use by the system."
 
       elsif global_key?(key)
-        [false, fail_message(key) + ' as a global key.']
+        fail KeyInUse, "'#{key}' is already in use as a global key."
 
       elsif interface_key?(key, interface)
         if defined_value?(interface)
-          [false, fail_message(key) + ' by this interface.']
+          fail KeyInUse, "'#{key}' is already in use by this interface."
 
         else
-          [false, fail_message(key) + ' by another interface and therefore ' \
-                  'cannot be global.']
+          fail KeyInUse, "'#{key}' is already in use and cannot be global."
 
         end
-      else
-        [true, 'Key can be registered.']
-
       end
+
+      true
     end
 
     private
@@ -96,10 +95,6 @@ module Vedeu
       Configuration.system_keys.values.include?(key)
     end
 
-    def fail_message(key)
-      "Cannot register key '#{key.to_s}' as already in use"
-    end
-
-  end
+  end # KeymapValidator
 
-end
+end # Vedeu

data/lib/vedeu/support/log.rb

@@ -95,7 +95,17 @@ module Vedeu
     def self.logger
       @logger ||= MonoLogger.new(filename).tap do |log|
         log.formatter = proc do |_, time, _, message|
-          time.utc.iso8601 + ": " + message + "\n"
+          utc_time = time.utc.iso8601
+
+          if @last_seen == utc_time
+            message + "\n"
+
+          else
+            @last_seen = utc_time
+
+            "\n\e[4m\e[31m" + utc_time + "\e[39m\e[24m\n" + message + "\n"
+
+          end
         end
       end
     end
@@ -122,6 +132,6 @@ module Vedeu
       Dir.home + '/.vedeu'
     end
 
-  end
+  end # Log
   # :nocov:
-end
+end # Vedeu

data/lib/vedeu/support/menu.rb

@@ -157,5 +157,6 @@ module Vedeu
       @collection.size
     end
 
-  end
-end
+  end # Menu
+
+end # Vedeu

data/lib/vedeu/support/position.rb

@@ -49,5 +49,6 @@ module Vedeu
       (@x == 0 || @x == nil) ? 1 : @x
     end
 
-  end
-end
+  end # Position
+
+end # Vedeu

data/lib/vedeu/support/registrar.rb

@@ -24,8 +24,6 @@ module Vedeu
     #
     # @return [TrueClass|MissingRequired]
     def record
-      validate_attributes!
-
       Vedeu::Buffers.add(attributes)
 
       Vedeu::Interfaces.add(attributes)
@@ -43,25 +41,6 @@ module Vedeu
 
     attr_reader :attributes
 
-    # At present, validates that attributes has a `:name` key that is not nil or
-    # empty.
-    #
-    # @api private
-    # @return [TrueClass|MissingRequired]
-    def validate_attributes!
-      return exception unless attributes.key?(:name)
-      return exception unless defined_value?(attributes[:name])
-
-      true
-    end
-
-    # Raises the MissingRequired exception.
-    #
-    # @see Vedeu::MissingRequired
-    def exception
-      fail MissingRequired, 'Cannot store data without a name attribute.'
-    end
-
-  end
+  end # Registrar
 
-end
+end # Vedeu