vedeu 0.2.4 → 0.2.5

data/lib/vedeu/output/render.rb

@@ -7,10 +7,6 @@ module Vedeu
   # @api private
   class Render
 
-    extend Forwardable
-
-    def_delegators :interface, :viewport
-
     # Create a new instance of Render with the provided {Vedeu::Interface} and
     # then convert the interface into a single string of content and escape
     # sequences.
@@ -38,7 +34,7 @@ module Vedeu
 
       Vedeu.log("Rendering view: '#{interface.name}'")
 
-      viewport.each_with_index do |line, index|
+      interface.viewport.each_with_index do |line, index|
         out << interface.origin(index)
         out << line.join
       end

data/lib/vedeu/output/viewport.rb

@@ -29,6 +29,11 @@ module Vedeu
 
     # Returns the visible content for the interface.
     #
+    # @note If there are no lines of content, we return an empty array. If there
+    #   are no more columns of content we return a space enclosed in an array;
+    #   this prevents a weird line hopping bug which occurs when the current
+    #   line has no more content, but subsequent lines do.
+    #
     # @return [Array]
     def show
       line_adjustment
@@ -36,13 +41,18 @@ module Vedeu
 
       return [] unless content?
 
-      content[lines].map { |line| line.chars[columns] }.compact
+      (content[lines] || []).map do |line|
+        line.chars[columns] || [" "]
+      end.compact
     end
 
     private
 
     attr_reader :interface
 
+    # Scrolls the content vertically when the stored y offset for the interface
+    # is outside of the visible area.
+    #
     # @return [Fixnum]
     def line_adjustment
       if offset.y < lines.min
@@ -57,6 +67,9 @@ module Vedeu
       end
     end
 
+    # Scrolls the content horizontally when the stored x offset for the
+    # interface is outside of the visible area.
+    #
     # @return [Fixnum]
     def column_adjustment
       if offset.x < columns.min
@@ -71,23 +84,45 @@ module Vedeu
       end
     end
 
+    #
+    # @note
+    #   @top = [value, 0].max # this allows us to set a top that is greater than
+    #                         # the content height.
+    #
+    #   @top = [[value, (content_height - height)].min, 0].max
+    #                         # this does not allow us to have an offset greater
+    #                         # than the content height.
+    #
     # @param value [Fixnum]
     # @return [Fixnum]
     def set_top(value)
-      @top = [[value, (content_height - height)].min, 0].max
+      @top = [value, 0].max
     end
 
+    #
+    # @note
+    #   @left = [value, 0].max # this allows us to set a left that is greater
+    #                          # than the content width.
+    #
+    #   @left = [[value, (content_width - width)].min, 0].max
+    #                         # this does not allow us to have an offset greater
+    #                         # than the content width.
+    #
     # @param value [Fixnum]
     # @return [Fixnum]
     def set_left(value)
       @left = [value, 0].max
     end
 
+    # Using the current x offset, return a range of visible lines.
+    #
     # @return [Range]
     def lines
       @top..(@top + height - 1)
     end
 
+    # Using the current y offset, return a range of visible columns.
+    #
     # @return [Range]
     def columns
       @left..(@left + width - 1)

data/lib/vedeu/repositories/buffers.rb

@@ -35,6 +35,24 @@ module Vedeu
       attributes[:name]
     end
 
+    # Return the named back buffer.
+    #
+    # @param name [String]
+    # @raise [BufferNotFound] When the named buffer cannot be found.
+    # @return [Hash|Nil]
+    def back(name)
+      find(name)[:back_buffer]
+    end
+
+    # Return the named front buffer.
+    #
+    # @param name [String]
+    # @raise [BufferNotFound] When the named buffer cannot be found.
+    # @return [Hash|Nil]
+    def front(name)
+      find(name)[:front_buffer]
+    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.
@@ -53,7 +71,7 @@ module Vedeu
     def latest(name)
       swap_buffers(name) if new_content?(name)
 
-      front_buffer(name)
+      front(name)
     end
 
     private
@@ -80,31 +98,7 @@ module Vedeu
     # @param name [String]
     # @return [Boolean]
     def new_content?(name)
-      defined_value?(back_buffer(name))
-    end
-
-    # Return a boolean indicating whether the named front buffer has content.
-    #
-    # @param name [String]
-    # @return [Boolean]
-    # def old_content?(name)
-    #   defined_value?(front_buffer(name))
-    # end
-
-    # Return the named back buffer.
-    #
-    # @param name [String]
-    # @return [Hash|Nil]
-    def back_buffer(name)
-      find(name)[:back_buffer]
-    end
-
-    # Return the named front buffer.
-    #
-    # @param name [String]
-    # @return [Hash|Nil]
-    def front_buffer(name)
-      find(name)[:front_buffer]
+      defined_value?(back(name))
     end
 
     # @return [Hash]
@@ -121,7 +115,7 @@ module Vedeu
     # @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}."
+      fail BufferNotFound, "Cannot find buffer with this name: #{name}."
     end
 
   end # Buffers

data/lib/vedeu/repositories/cursors.rb

@@ -8,25 +8,13 @@ module Vedeu
 
     include Common
     include Repository
+    include Positional
     extend self
 
     # System events which when called will update the cursor visibility
     # accordingly for the interface in focus.
-    Vedeu.event(:_cursor_hide_)    { Cursors.hide }
-    Vedeu.event(:_cursor_show_)    { Cursors.show }
-
-    # Adds an interface to the cursors repository.
-    #
-    # @param attributes [Hash]
-    # @return [Hash]
-    def add(attributes)
-      validate_attributes!(attributes)
-
-      Vedeu.log("#{action(__callee__)} cursor: '#{attributes[:name]}'")
-
-      storage.store(attributes[:name], Cursor.new(attributes))
-    end
-    alias_method :update, :add
+    Vedeu.event(:_cursor_hide_) { Cursors.hide }
+    Vedeu.event(:_cursor_show_) { Cursors.show }
 
     # Make the cursor of this interface invisible.
     #

data/lib/vedeu/repositories/focus.rb

@@ -25,13 +25,9 @@ module Vedeu
     def add(attributes)
       validate_attributes!(attributes)
 
-      if registered?(attributes[:name])
-        storage
+      return storage << attributes[:name] unless registered?(attributes[:name])
 
-      else
-        storage << attributes[:name]
-
-      end
+      storage
     end
 
     # Focus an interface by name.

data/lib/vedeu/repositories/groups.rb

@@ -48,7 +48,7 @@ module Vedeu
     # @return [GroupNotFound]
     def not_found(name)
       fail GroupNotFound,
-        "Cannot find interface group with this name: #{name.to_s}."
+        "Cannot find interface group with this name: #{name}."
     end
 
   end # Groups

data/lib/vedeu/repositories/interfaces.rb

@@ -74,7 +74,7 @@ module Vedeu
     # @return [InterfaceNotFound]
     def not_found(name)
       fail InterfaceNotFound,
-        "Interface was not found with this name: #{name.to_s}."
+        "Interface was not found with this name: #{name}."
     end
 
   end # Interfaces

data/lib/vedeu/repositories/keymaps.rb

@@ -12,6 +12,9 @@ module Vedeu
     # Stores the keymap attributes defined by the API.
     #
     # @param attributes [Hash]
+    # @option attributes :interfaces [Array] A list of the names of interfaces for which the
+    #   keys are active for.
+    # @option attributes :keys [Array] A collection of key/action pairs.
     # @return [TrueClass|KeyInUse|FalseClass]
     def add(attributes)
       return false unless defined_value?(attributes[:keys])
@@ -72,10 +75,15 @@ module Vedeu
       end
     end
 
-    # Return a collection of interface keys.
+    # Return a collection of interface keys. When the optional 'name' parameter
+    # is provided, then only the keys associated with that interface are
+    # returned.
     #
+    # @param interface [String]
     # @return [Hash]
-    def interface_keys
+    def interface_keys(interface = nil)
+      return find(interface).keys if interface
+
       storage.reject do |k, _|
         k == '_global_keymap_'
       end.map { |_, v| v.keys }.flatten.uniq
@@ -89,7 +97,7 @@ module Vedeu
       system_keys.include?(key)
     end
 
-    # Return a collection of system keys.
+    # Return the collection of system keys.
     #
     # @return [Array]
     def system_keys
@@ -121,10 +129,10 @@ module Vedeu
       focussed_interface = Vedeu::Focus.current
 
       if interface_key?(key, focussed_interface)
-        find(focussed_interface).fetch(key, noop).call
+        find(focussed_interface).fetch(key, noop).call(:noop_interface)
 
       elsif global_key?(key)
-        find('_global_keymap_').fetch(key, noop).call
+        find('_global_keymap_').fetch(key, noop).call(:noop_global)
 
       elsif system_key?(key)
         system_key(key)
@@ -134,13 +142,14 @@ module Vedeu
 
       end
     end
+    alias_method :keypress, :use
 
     private
 
     # Triggers the system event defined for this key.
     #
     # @param key [String|Symbol]
-    # @return []
+    # @return [] The result(s) of triggering the event.
     def system_key(key)
       action = Vedeu::Configuration.system_keys.key(key)
       event  = ['_', action, '_'].join.to_sym
@@ -153,34 +162,29 @@ module Vedeu
     # @param attributes [Hash]
     # @param interface [String]
     # @return []
-    def register(attributes, interface = '')
+    def register(attributes, interface = '_global_keymap_')
       attributes[:keys].map do |keymap|
         KeymapValidator.check(storage, keymap[:key], interface)
 
-        Vedeu.log("Registering key: '#{keymap[:key]}' with '#{namespace(interface)}'")
+        Vedeu.log("Registering key: '#{keymap[:key]}' with '#{interface}'")
 
-        storage[namespace(interface)].merge!({ keymap[:key] => keymap[:action] })
+        storage[interface].merge!({ keymap[:key] => keymap[:action] })
       end
     end
 
-    # Determine which interface to store the key with.
-    #
-    # @param interface [String]
-    # @return [String]
-    def namespace(interface = '')
-      return defined_value?(interface) ? interface : '_global_keymap_'
-    end
-
-    # Returns a noop proc which when called returns :noop.
+    # Returns a noop proc which when called returns the argument or :noop.
     #
+    # @param value [Symbol]
     # @return [Proc]
-    def noop
-      proc { :noop }
+    def noop(value = :noop)
+      proc { value }
     end
 
-    # @return [Array]
+    # @return [Hash]
     def in_memory
-      { '_global_keymap_' => {} }
+      {
+        '_global_keymap_' => {}
+      }
     end
 
   end # Keymaps

data/lib/vedeu/repositories/menus.rb

@@ -70,7 +70,7 @@ module Vedeu
     # @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}."
+      fail MenuNotFound, "Menu was not found with this name: #{name}."
     end
 
   end # Menus

data/lib/vedeu/repositories/offsets.rb

@@ -8,29 +8,39 @@ module Vedeu
 
     include Common
     include Repository
+    include Positional
     extend self
 
-    # Add or update the offset coordinates for interface content.
-    #
-    # @param attributes [Hash]
-    # @return [Offset]
-    def add(attributes)
-      validate_attributes!(attributes)
+    # @return [Array]
+    def down
+      move(1, 0)
+    end
 
-      Vedeu.log("#{action(__callee__)} offset: '#{attributes[:name]}'")
+    # @return [Array]
+    def up
+      move(-1, 0)
+    end
 
-      storage.store(attributes[:name], Offset.new(attributes))
+    # @return [Array]
+    def right
+      move(0, 1)
     end
-    alias_method :update, :add
+
+    # @return [Array]
+    def left
+      move(0, -1)
+    end
+
+    private
 
     # @param y [Fixnum]
     # @param x [Fixnum]
-    # @return [Offset]
+    # @return [Array]
     def move(y, x)
       find_or_create(Focus.current).move(y, x)
-    end
 
-    private
+      Focus.refresh
+    end
 
     # @return [Class]
     def entity
@@ -42,6 +52,14 @@ module Vedeu
       {}
     end
 
+    # System events which when called will move in the direction specified;
+    # these will update the cursor position or content offset (scrolling)
+    # according to the interface in focus.
+    Vedeu.event(:_cursor_up_)    { up    }
+    Vedeu.event(:_cursor_right_) { right }
+    Vedeu.event(:_cursor_down_)  { down  }
+    Vedeu.event(:_cursor_left_)  { left  }
+
   end # Offsets
 
 end # Vedeu

data/lib/vedeu/repositories/positional.rb

@@ -0,0 +1,23 @@
+module Vedeu
+
+  # Repository helper module which reduces duplication in Offsets and Cursors.
+  #
+  module Positional
+
+    # Add or update the offset or cursor coordinates.
+    #
+    # @param attributes [Hash]
+    # @return [Offset]
+    def add(attributes)
+      validate_attributes!(attributes)
+
+      Vedeu.log("#{action(__callee__)} positional (#{entity}): " \
+                "'#{attributes[:name]}'")
+
+      storage.store(attributes[:name], entity.new(attributes))
+    end
+    alias_method :update, :add
+
+  end # Positional
+
+end # Vedeu