vedeu 0.2.2 → 0.2.3

data/lib/vedeu/output/compositor.rb

@@ -76,5 +76,7 @@ module Vedeu
     def buffer
       @_buffer ||= Vedeu::Buffers.latest(name)
     end
-  end
-end
+
+  end # Compositor
+
+end # Vedeu

data/lib/vedeu/output/refresh.rb

@@ -60,15 +60,13 @@ module Vedeu
 
       end
 
-      return false if Vedeu.events.registered?(event)
+      return false if Events.registered?(event)
 
-      Vedeu.event(event, { delay: delay }) do
-        Vedeu::Refresh.send(type, name)
-      end
+      Events.add(event, { delay: delay }) { Vedeu::Refresh.send(type, name) }
 
       true
     end
 
-  end
+  end # Refresh
 
-end
+end # Vedeu

data/lib/vedeu/output/render.rb

@@ -34,6 +34,8 @@ module Vedeu
     #
     # @return [String]
     def render
+      Vedeu.log("Rendering view: '#{interface.name}'")
+
       out = [ Clear.call(interface) ]
       processed_lines.each_with_index do |line, index|
         out << interface.origin(index)
@@ -64,11 +66,11 @@ module Vedeu
           new_streams = []
 
           new_streams = line.streams.map do |stream|
-            next if stream.text.empty?
+            next if stream.content.empty?
 
-            if (line_length += stream.text.size) >= width
+            if (line_length += stream.content.size) >= width
               remainder = width - line_length
-              truncated = truncate(stream.text, remainder)
+              truncated = truncate(stream.content, remainder)
 
               build_stream(line, stream, truncated)
 
@@ -93,12 +95,12 @@ module Vedeu
     # @api private
     # @param line [Line]
     # @param stream [Stream]
-    # @param text [String]
+    # @param content [String]
     # @return [Stream]
-    def build_stream(line, stream, text)
+    def build_stream(line, stream, content)
       attributes = stream.view_attributes.merge!({
         parent: line.view_attributes,
-        text:   text,
+        text:   content,
       })
 
       Stream.new(attributes)
@@ -127,17 +129,17 @@ module Vedeu
     # @param line [Line]
     # @return [Boolean]
     def exceeds_width?(line)
-      line.streams.map(&:text).join.size > width
+      line.streams.map(&:content).join.size > width
     end
 
-    # Truncates the provided text.
+    # Truncates the provided string.
     #
     # @api private
-    # @param text [String] The text to be truncated.
-    # @param value [Fixnum] The total length of the text after truncation.
+    # @param string [String] The string to be truncated.
+    # @param value [Fixnum] The total length of the string after truncation.
     # @return [String]
-    def truncate(text, value)
-      text.chomp.slice(0...value)
+    def truncate(string, value)
+      string.chomp.slice(0...value)
     end
 
     # Provides the collection of visible lines associated with the interface.
@@ -199,5 +201,6 @@ module Vedeu
       }
     end
 
-  end
-end
+  end # Render
+
+end # Vedeu

data/lib/vedeu/output/view.rb

@@ -33,6 +33,8 @@ module Vedeu
       end
     end
 
+    # @raise [NotImplemented] Subclasses of this class must implement this
+    #   method.
     # @return [Exception]
     def render
       fail NotImplemented, 'Implement #render on your subclass of Vedeu::View.'
@@ -59,5 +61,6 @@ module Vedeu
       render
     end
 
-  end
-end
+  end # View
+
+end # Vedeu

data/lib/vedeu/repositories/buffers.rb

@@ -6,7 +6,8 @@ module Vedeu
   # @api private
   module Buffers
 
-    include Vedeu::Common
+    include Common
+    include Repository
     extend self
 
     # Add an interface view into the back buffer. If the buffer is already
@@ -16,6 +17,8 @@ module Vedeu
     # @param attributes [Hash]
     # @return [String]
     def add(attributes)
+      validate_attributes!(attributes)
+
       if registered?(attributes[:name])
         buffer = find(attributes[:name])
 
@@ -32,16 +35,6 @@ module Vedeu
       attributes[:name]
     end
 
-    # Find the buffer by name.
-    #
-    # @param name [String]
-    # @return [Hash]
-    def find(name)
-      storage.fetch(name) do
-        fail BufferNotFound, "Cannot find buffer with this name: #{name.to_s}."
-      end
-    end
-
     # Returns the latest content for the named buffer. The latest content always
     # goes on to the back buffer. The content which was last output is on the
     # front buffer.
@@ -71,30 +64,6 @@ module Vedeu
       end
     end
 
-    # 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 reset
-      @_storage = in_memory
-    end
-
     private
 
     # Swap the named back buffer into the front buffer of the same name.
@@ -135,7 +104,7 @@ module Vedeu
     # @param name [String]
     # @return [Hash|Nil]
     def back_buffer(name)
-      find(name).fetch(:back_buffer, nil)
+      find(name)[:back_buffer]
     end
 
     # Return the named front buffer.
@@ -144,15 +113,7 @@ module Vedeu
     # @param name [String]
     # @return [Hash|Nil]
     def front_buffer(name)
-      find(name).fetch(:front_buffer, nil)
-    end
-
-    # Access to the storage for this repository.
-    #
-    # @api private
-    # @return [Hash]
-    def storage
-      @_storage ||= in_memory
+      find(name)[:front_buffer]
     end
 
     # @api private
@@ -166,6 +127,14 @@ module Vedeu
       end
     end
 
-  end
+    # @api private
+    # @param name [String]
+    # @raise [BufferNotFound] When the entity cannot be found with this name.
+    # @return [BufferNotFound]
+    def not_found(name)
+      fail BufferNotFound, "Cannot find buffer with this name: #{name.to_s}."
+    end
+
+  end # Buffers
 
-end
+end # Vedeu

data/lib/vedeu/repositories/cursors.rb

@@ -7,6 +7,7 @@ module Vedeu
   module Cursors
 
     include Common
+    include Repository
     extend self
 
     # System events which when called will update the cursor position or
@@ -24,7 +25,9 @@ module Vedeu
     # @param attributes [Hash]
     # @return [Hash]
     def add(attributes)
-      return false unless defined_value?(attributes[:name])
+      validate_attributes!(attributes)
+
+      Vedeu.log("Registering cursor: '#{attributes[:name]}'")
 
       storage.store(attributes[:name], {
         name: attributes[:name],
@@ -34,25 +37,16 @@ module Vedeu
       })
     end
 
-    # Find the cursor attributes by name.
+    # Saves the attributes in the repository for future use.
     #
-    # @param name [String]
+    # @param attributes [Hash]
     # @return [Hash]
-    def find(name)
-      storage.fetch(name) do
-        fail CursorNotFound,
-          "Cursor was not found with this name: #{name.to_s}."
-      end
-    end
+    def update(attributes)
+      return false unless defined_value?(attributes[:name])
 
-    # Returns a boolean indicating whether the named interface is registered.
-    #
-    # @api private
-    # @return [Boolean]
-    def registered?(name)
-      return false if storage.empty?
+      Vedeu.log("Updating cursor: '#{attributes[:name]}'")
 
-      storage.keys.include?(name)
+      storage.store(attributes[:name], attributes)
     end
 
     # Perform an action (moving, showing or hiding) and save the new cursor
@@ -73,26 +67,30 @@ module Vedeu
 
     private
 
-    # Access to the storage for this repository.
+    # Returns an empty collection ready for the storing of cursors by name with
+    # current attributes.
     #
     # @api private
     # @example
-    #   { 'holmium' => { name: 'holmium', y: 12, x: 6, state: :show } }
+    #   { 'holmium' => {
+    #                    name:     'holmium',
+    #                    state:    :show,
+    #                    x:        1,
+    #                    y:        1 } }
     #
     # @return [Hash]
-    def storage
-      @_storage ||= in_memory
+    def in_memory
+      {}
     end
 
-    # Returns an empty collection ready for the storing of cursors by name with
-    # current attributes.
-    #
     # @api private
-    # @return [Hash]
-    def in_memory
-      {}
+    # @param name [String]
+    # @raise [CursorNotFound] When the entity cannot be found with this name.
+    # @return [CursorNotFound]
+    def not_found(name)
+      fail CursorNotFound, "Cursor was not found with this name: #{name.to_s}."
     end
 
-  end
+  end # Cursors
 
-end
+end # Vedeu

data/lib/vedeu/repositories/events.rb

@@ -1,55 +1,36 @@
 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
+  # name can contain many events. Also, an event can trigger other events.
+  module Events
 
-    # Initializes a new Events class.
-    #
-    # @param block [Proc]
-    # @return [Events]
-    def initialize(&block)
-      @handlers = Hash.new { |hash, key| hash[key] = { events: [] } }
-
-      instance_eval(&block) if block_given?
-    end
+    include Repository
+    extend self
 
     # @see Vedeu::API#event
-    def event(name, opts = {}, &block)
-      Vedeu.log("Registering event '#{name}'")
+    def add(name, opts = {}, &block)
+      Vedeu.log("Registering event: '#{name}'")
 
       options = opts.merge!({ event_name: name })
 
-      handlers[name][:events] << Event.new(block, options)
-      handlers[name]
+      storage[name][:events] << Event.new(block, options)
+      storage[name]
     end
+    alias_method :event, :add
 
     # @see Vedeu::API#unevent
-    def unevent(name)
-      handlers.delete_if { |k, v| k == name }
-    end
+    def remove(name)
+      return false unless registered?(name)
 
-    # Returns a collection of the names of all the registered events.
-    #
-    # @return [Array]
-    def registered
-      handlers.keys
-    end
+      storage.delete(name) { false }
 
-    # Returns a Boolean indicating whether the named event is registered.
-    #
-    # @api private
-    # @param name [Symbol] The name of the event to check.
-    # @return [Boolean]
-    def registered?(name)
-      handlers.key?(name)
+      true
     end
+    alias_method :unevent, :remove
 
     # @see Vedeu::API#trigger
-    def trigger(name, *args)
-      results = handlers[name][:events].map { |event| event.trigger(*args) }
+    def use(name, *args)
+      results = storage[name][:events].map { |event| event.trigger(*args) }
 
       if results.one?
         results.first
@@ -59,23 +40,27 @@ module Vedeu
 
       end
     end
+    alias_method :trigger, :use
 
-    # Remove all registered events. Used for testing purposes.
+    private
+
+    # Returns an empty collection ready for the storing of events by name with
+    # associated event instance.
     #
+    # @api private
     # @return [Hash]
-    def reset
-      @handlers = Hash.new { |hash, key| hash[key] = { events: [] } }
+    def in_memory
+      Hash.new { |hash, key| hash[key] = { events: [] } }
     end
 
-    private
+    # System events needed by Vedeu to run.
+    add(:_clear_)                   { Terminal.clear_screen     }
+    add(:_exit_)                    { Vedeu::Application.stop   }
+    add(:_keypress_)                { |key| Vedeu.keypress(key) }
+    add(:_log_)                     { |msg| Vedeu.log(msg)      }
+    add(:_mode_switch_)             { fail ModeSwitch           }
+    add(:_resize_, { delay: 0.25 }) { Vedeu.resize              }
 
-    attr_reader :handlers
-
-    # @api private
-    # @return []
-    def method_missing(method, *args, &block)
-      @self_before_instance_eval.send(method, *args, &block)
-    end
+  end # Events
 
-  end
-end
+end # Vedeu

data/lib/vedeu/repositories/focus.rb

@@ -7,6 +7,8 @@ module Vedeu
   # @api private
   module Focus
 
+    include Common
+    include Repository
     extend self
 
     # System events which when called will change which interface is currently
@@ -32,6 +34,8 @@ module Vedeu
     # @param attributes [String]
     # @return [Array]
     def add(attributes)
+      validate_attributes!(attributes)
+
       if registered?(attributes[:name])
         storage
 
@@ -44,32 +48,45 @@ module Vedeu
     # Focus an interface by name.
     #
     # @param name [String]
+    # @raise [InterfaceNotFound] When the interface cannot be found.
     # @return [String]
     def by_name(name)
       fail InterfaceNotFound unless storage.include?(name)
 
       storage.rotate!(storage.index(name))
 
+      Vedeu.log("Interface in focus: '#{current}'")
+
       current
     end
 
     # Return the interface currently focussed.
     #
+    # @raise [NoInterfacesDefined] When no interfaces are defined, we cannot
+    #   make one focussed.
     # @return [String]
     def current
       fail NoInterfacesDefined if storage.empty?
 
-      Vedeu.log("Interface in focus: '#{storage.first}'")
-
       storage.first
     end
 
+    # Returns a boolean indicating whether the named interface is focussed.
+    #
+    # @param name [String]
+    # @return [Boolean]
+    def current?(name)
+      current == name
+    end
+
     # Put the next interface relative to the current interfaces in focus.
     #
     # @return [String]
     def next_item
       storage.rotate!
 
+      Vedeu.log("Interface in focus: '#{current}'")
+
       current
     end
 
@@ -79,6 +96,8 @@ module Vedeu
     def prev_item
       storage.rotate!(-1)
 
+      Vedeu.log("Interface in focus: '#{current}'")
+
       current
     end
 
@@ -99,24 +118,8 @@ module Vedeu
       storage.include?(name)
     end
 
-    # 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
-    end
-
     # Returns an empty collection ready for the storing of interface names.
     #
     # @api private
@@ -125,5 +128,6 @@ module Vedeu
       []
     end
 
-  end
-end
+  end # Focus
+
+end # Vedeu

data/lib/vedeu/repositories/groups.rb

@@ -5,7 +5,8 @@ module Vedeu
   # @api private
   module Groups
 
-    include Vedeu::Common
+    include Common
+    include Repository
     extend self
 
     # Add an interface name to a group, creating the group if it doesn't already
@@ -14,6 +15,8 @@ module Vedeu
     # @param attributes [Hash]
     # @return [Groups|FalseClass]
     def add(attributes)
+      validate_attributes!(attributes)
+
       return false unless defined_value?(attributes[:group])
 
       storage[attributes[:group]] << attributes[:name]
@@ -23,46 +26,6 @@ module Vedeu
       true
     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 [Boolean]
-    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
 
     # @see Vedeu::Refresh.register_event
@@ -70,25 +33,27 @@ module Vedeu
     # @param attributes [Hash]
     # @return [Boolean]
     def register_event(attributes)
-      name       = attributes[:group]
-      delay      = attributes[:delay] || 0.0
+      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
-      @_storage ||= in_memory
+    def in_memory
+      Hash.new { |hash, key| hash[key] = Set.new }
     end
 
     # @api private
-    # @return [Hash]
-    def in_memory
-      Hash.new { |hash, key| hash[key] = Set.new }
+    # @param name [String]
+    # @raise [GroupNotFound] When the entity cannot be found with this name.
+    # @return [GroupNotFound]
+    def not_found(name)
+      fail GroupNotFound,
+        "Cannot find interface group with this name: #{name.to_s}."
     end
 
-  end
-end
+  end # Groups
+
+end # Vedeu