vedeu 0.2.0 → 0.2.1

data/lib/vedeu/output/render.rb

@@ -50,7 +50,10 @@ module Vedeu
 
     # The client application may have created a line that us too long for the
     # interface. This code tries to truncate streams whilst preserving styles
-    # and colours.
+    # and colours. To achieve this, it successively checks each stream length
+    # against remaining line length and truncates the stream data if it
+    # exceeds the line length. Further stream data that does not fit is
+    # discarded.
     #
     # @api private
     # @return [Array]
@@ -60,32 +63,24 @@ module Vedeu
       lines.map do |line|
         if exceeds_width?(line)
           line_length = 0
-          processed   = []
-          line.streams.each do |stream|
+          new_streams = []
+
+          new_streams = line.streams.map do |stream|
             next if stream.text.empty?
 
             if (line_length += stream.text.size) >= width
               remainder = width - line_length
+              truncated = truncate(stream.text, remainder)
 
-              processed << Stream.new({
-                             colour: stream.colour.attributes,
-                             style:  stream.style.values,
-                             text:   truncate(stream.text, remainder),
-                             parent: line.view_attributes,
-                           })
+              build_stream(line, stream, truncated)
 
             else
-              processed << stream
+              stream
 
             end
           end
 
-          Line.new({
-            colour:  line.colour.attributes,
-            streams: processed,
-            style:   line.style.values,
-            parent:  interface.view_attributes,
-          })
+          build_line(line, new_streams)
 
         else
           line
@@ -94,13 +89,45 @@ module Vedeu
       end
     end
 
+    # Builds a new Stream object with the newly truncated text and previous
+    # attributes.
+    #
+    # @api private
+    # @param line [Line]
+    # @param stream [Stream]
+    # @param text [String]
+    # @return [Stream]
+    def build_stream(line, stream, text)
+      attributes = stream.view_attributes.merge!({
+        parent: line.view_attributes,
+        text:   text,
+      })
+
+      Stream.new(attributes)
+    end
+
+    # Builds a new Line object with the new streams and previous attributes.
+    #
+    # @api private
+    # @param line [Line]
+    # @param streams [Array]
+    # @return [Line]
+    def build_line(line, streams)
+      attributes = line.view_attributes.merge!({
+        parent:  interface.view_attributes,
+        streams: streams,
+      })
+
+      Line.new(attributes)
+    end
+
     # Converts all streams within a line into a single line of text to then
     # check that this line (without formatting, as that is not visible) exceeds
     # the width of the interface.
     #
     # @api private
     # @param line [Line]
-    # @return [TrueClass|FalseClass]
+    # @return [Boolean]
     def exceeds_width?(line)
       line.streams.map(&:text).join.size > width
     end

data/lib/vedeu/output/view.rb

@@ -4,6 +4,9 @@ module Vedeu
   # This method should contain attributes required to build a view or views.
   # These attributes will be added to the back buffer of each interface
   # mentioned, to be rendered upon next refresh.
+  #
+  # @deprecated May disappear in 0.3.0. Prefer {Vedeu::API#render} instead.
+  # @see Vedeu::API#render
   class View
 
     include Vedeu::API

data/lib/vedeu/repositories/buffers.rb

@@ -9,28 +9,16 @@ module Vedeu
     include Vedeu::Common
     extend self
 
-    # @param attributes [Hash]
-    # @return [Hash]
-    def create(attributes)
-      add(attributes)
-
-      Vedeu::Interfaces.add(attributes)
-      Vedeu::Refresh.add_interface(attributes)
-
-      Vedeu::Groups.add(attributes)
-      Vedeu::Refresh.add_group(attributes)
-
-      Vedeu::Focus.add(attributes)
-    end
-
     # Add an interface view into the back buffer. If the buffer is already
-    # registered, then we preserve its front buffer.
+    # registered, then we preserve its front buffer. Returns the name of the
+    # buffer added to storage.
     #
     # @param attributes [Hash]
-    # @return [Hash]
+    # @return [String]
     def add(attributes)
       if registered?(attributes[:name])
         buffer = find(attributes[:name])
+
         buffer[:back_buffer] = attributes
 
       else
@@ -41,7 +29,7 @@ module Vedeu
 
       end
 
-      storage
+      attributes[:name]
     end
 
     # Find the buffer by name.
@@ -72,10 +60,10 @@ module Vedeu
     def latest(name)
       if new_content?(name)
         swap_buffers(name)
-        content(name)
+        front_buffer(name)
 
       elsif old_content?(name)
-        content(name)
+        front_buffer(name)
 
       else
         nil
@@ -83,16 +71,35 @@ module Vedeu
       end
     end
 
-    # Returns the named front buffer.
+    # Returns a collection of the names of all registered buffers.
+    #
+    # @return [Array]
+    def registered
+      storage.keys
+    end
+
+    # Returns a boolean indicating whether the named buffer is registered.
     #
+    # @api private
     # @param name [String]
+    # @return [Boolean]
+    def registered?(name)
+      storage.key?(name)
+    end
+
+    # Reset the buffers repository; removing all buffers. This does not delete
+    # the interfaces themselves.
+    #
     # @return [Hash]
-    def content(name)
-      front_buffer(name)
+    def reset
+      @_storage = in_memory
     end
 
+    private
+
     # Swap the named back buffer into the front buffer of the same name.
     #
+    # @api private
     # @param name [String]
     # @return [Hash]
     def swap_buffers(name)
@@ -104,21 +111,11 @@ module Vedeu
       })
     end
 
-    # Reset the buffers repository; removing all buffers. This does not delete
-    # the interfaces themselves.
-    #
-    # @return [Hash]
-    def reset
-      @_storage = in_memory
-    end
-
-    private
-
     # Return a boolean indicating whether the named back buffer has new content.
     #
     # @api private
     # @param name [String]
-    # @return [TrueClass|FalseClass]
+    # @return [Boolean]
     def new_content?(name)
       defined_value?(back_buffer(name))
     end
@@ -127,7 +124,7 @@ module Vedeu
     #
     # @api private
     # @param name [String]
-    # @return [TrueClass|FalseClass]
+    # @return [Boolean]
     def old_content?(name)
       defined_value?(front_buffer(name))
     end
@@ -150,15 +147,8 @@ module Vedeu
       find(name).fetch(:front_buffer, nil)
     end
 
-    # Returns a boolean indicating whether the named buffer is registered.
+    # Access to the storage for this repository.
     #
-    # @api private
-    # @param name [String]
-    # @return [TrueClass|FalseClass]
-    def registered?(name)
-      storage.key?(name)
-    end
-
     # @api private
     # @return [Hash]
     def storage

data/lib/vedeu/repositories/events.rb

@@ -16,18 +16,13 @@ module Vedeu
       instance_eval(&block) if block_given?
     end
 
-    # @param object []
-    # @param block [Proc]
-    # @return []
-    def add(object, &block)
-      @self_before_instance_eval = eval('self', block.binding)
-
-      instance_eval(&block)
-    end
-
     # @see Vedeu::API#event
     def event(name, opts = {}, &block)
-      handlers[name][:events] << Event.new(block, opts)
+      Vedeu.log("Registering event '#{name}'")
+
+      options = opts.merge!({ event_name: name })
+
+      handlers[name][:events] << Event.new(block, options)
       handlers[name]
     end
 
@@ -45,7 +40,9 @@ module Vedeu
 
     # Returns a Boolean indicating whether the named event is registered.
     #
-    # @return [TrueClass|FalseClass]
+    # @api private
+    # @param name [Symbol] The name of the event to check.
+    # @return [Boolean]
     def registered?(name)
       handlers.key?(name)
     end

data/lib/vedeu/repositories/focus.rb

@@ -41,6 +41,8 @@ module Vedeu
     def current
       fail NoInterfacesDefined if storage.empty?
 
+      Vedeu.log("Interface in focus: '#{storage.first}'")
+
       storage.first
     end
 
@@ -69,32 +71,32 @@ module Vedeu
       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]
+    # @return [Boolean]
     def registered?(name)
       return false if storage.empty?
 
       storage.include?(name)
     end
 
-    # Provides accessor to the in-memory storage.
+    # Reset the focus repository; removing all items. This does not delete
+    # the interfaces themselves.
+    #
+    # @return [Hash]
+    def reset
+      @_storage = in_memory
+    end
+
+    private
+
+    # Access to the storage for this repository.
     #
     # @api private
     # @return [Array]
     def storage
-      @storage ||= in_memory
+      @_storage ||= in_memory
     end
 
     # Returns an empty collection ready for the storing of interface names.

data/lib/vedeu/repositories/groups.rb

@@ -5,6 +5,7 @@ module Vedeu
   # @api private
   module Groups
 
+    include Vedeu::Common
     extend self
 
     # Add an interface name to a group, creating the group if it doesn't already
@@ -13,9 +14,13 @@ module Vedeu
     # @param attributes [Hash]
     # @return [Groups|FalseClass]
     def add(attributes)
-      return false if attributes[:group].empty?
+      return false unless defined_value?(attributes[:group])
 
       storage[attributes[:group]] << attributes[:name]
+
+      register_event(attributes)
+
+      true
     end
 
     # Return the whole repository.
@@ -45,7 +50,7 @@ module Vedeu
 
     # Returns a Boolean indicating whether the named group is registered.
     #
-    # @return [TrueClass|FalseClass]
+    # @return [Boolean]
     def registered?(name)
       storage.key?(name)
     end
@@ -60,6 +65,19 @@ module Vedeu
 
     private
 
+    # @see Vedeu::Refresh.register_event
+    # @api private
+    # @param attributes [Hash]
+    # @return [Boolean]
+    def register_event(attributes)
+      name       = attributes[:group]
+      delay      = attributes[:delay] || 0.0
+
+      Vedeu::Refresh.register_event(:by_group, name, delay)
+    end
+
+    # Access to the storage for this repository.
+    #
     # @api private
     # @return [Hash]
     def storage

data/lib/vedeu/repositories/interfaces.rb

@@ -5,6 +5,7 @@ module Vedeu
   # @api private
   module Interfaces
 
+    include Vedeu::Common
     extend self
 
     # Stores the interface attributes defined by the API.
@@ -12,9 +13,15 @@ module Vedeu
     # @param attributes [Hash]
     # @return [Hash|FalseClass]
     def add(attributes)
-      return false if attributes[:name].empty?
+      return false unless defined_value?(attributes[:name])
+
+      Vedeu.log("Registering interface '#{attributes[:name]}'")
 
       storage.store(attributes[:name], attributes)
+
+      register_event(attributes)
+
+      true
     end
 
     # Return the whole repository.
@@ -44,7 +51,7 @@ module Vedeu
 
     # Returns a boolean indicating whether the named interface is registered.
     #
-    # @return [TrueClass|FalseClass]
+    # @return [Boolean]
     def registered?(name)
       storage.key?(name)
     end
@@ -60,6 +67,19 @@ module Vedeu
 
     private
 
+    # @see Vedeu::Refresh.register_event
+    # @api private
+    # @param attributes [Hash]
+    # @return [Boolean]
+    def register_event(attributes)
+      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

data/lib/vedeu/repositories/keymap_validator.rb

@@ -0,0 +1,104 @@
+module Vedeu
+
+  # Validates that a given key is can be used and is not already in-use, either
+  # by the same interface, globally or as a system key.
+  #
+  class KeymapValidator
+
+    include Common
+
+    # Checks the key is not in use by the system, is not already defined as a
+    # global key, is not already defined for the interface specified.
+    #
+    # @param storage [Hash]
+    # @param key [String|Symbol]
+    # @param interface [String]
+    # @return [Array] A boolean indicating validity, and a helpful message.
+    def self.check(storage, key, interface = '')
+      new(storage, key, interface).check
+    end
+
+    # Instantiates a new KeymapValidator instance.
+    #
+    # @param storage [Hash]
+    # @param key [String|Symbol]
+    # @param interface [String]
+    # @return [KeymapValidator]
+    def initialize(storage, key, interface = '')
+      @storage, @key, @interface = storage, key, interface
+    end
+
+    # @see KeymapValidator.check
+    def check
+      if system_key?(key)
+        [false, "#{fail_message(key)} by the system."]
+
+      elsif global_key?(key)
+        [false, "#{fail_message(key)} as a global key."]
+
+      elsif interface_key?(key, interface)
+        if defined_value?(interface)
+          [false, "#{fail_message(key)} by this interface."]
+
+        else
+          [false, "#{fail_message(key)} by another interface and therefore " \
+                  'cannot be global.']
+
+        end
+      else
+        [true, 'Key can be registered.']
+
+      end
+    end
+
+    private
+
+    attr_reader :storage, :key, :interface
+
+    # Returns a boolean indicating whether the key has been registered for the
+    # named interface's keymap. If no interface is specified, then it is
+    # assumed that the key is attempting to be registered globally, and so all
+    # interfaces are checked for this key. (A key cannot be global if an
+    # interface is using it.)
+    #
+    # @param key [String|Symbol]
+    # @param interface [String]
+    # @return [Boolean]
+    def interface_key?(key, interface = '')
+      if defined_value?(interface)
+        return false unless storage.key?(interface)
+
+        storage.fetch(interface).keys.include?(key)
+
+      else
+        storage.keys.reject do |keymap|
+          keymap == '_global_keymap_'
+        end.map { |name| storage[name].keys.include?(key) }.any?
+
+      end
+    end
+
+    # Returns a boolean indicating whether the key is in the global keymap.
+    #
+    # @param key [String|Symbol]
+    # @return [Boolean]
+    def global_key?(key)
+      storage.fetch('_global_keymap_').keys.include?(key)
+    end
+
+    # Returns a boolean indicating whether the key is in the system keymap.
+    # At present, it is not possible to redefine system keys.
+    #
+    # @param key [String|Symbol]
+    # @return [Boolean]
+    def system_key?(key)
+      Configuration.system_keys.values.include?(key)
+    end
+
+    def fail_message(key)
+      "Cannot register key '#{key.to_s}' as already in use"
+    end
+
+  end
+
+end