vedeu 0.2.4 → 0.2.5

data/lib/vedeu/models/foreground.rb

@@ -34,7 +34,7 @@ module Vedeu
     #
     # @return [Hash]
     def foreground_codes
-      codes
+      Esc.codes
     end
 
   end # Foreground

data/lib/vedeu/models/geometry.rb

@@ -95,8 +95,6 @@ module Vedeu
     # Returns an escape sequence to position the cursor at the top-left
     # coordinate, relative to the interface's position.
     #
-    # @todo I think this method belongs with Area.
-    #
     # @param index [Fixnum]
     # @param block [Proc]
     # @return [String]
@@ -117,6 +115,7 @@ module Vedeu
 
       end
     end
+    alias_method :y_min, :top
 
     # Returns the row above the top by default.
     #
@@ -146,6 +145,7 @@ module Vedeu
 
       end
     end
+    alias_method :x_min, :left
 
     # Returns the column before left by default.
     #
@@ -210,8 +210,6 @@ module Vedeu
 
     # Provides a virtual y position within the interface's dimensions.
     #
-    # @todo I think this method belongs with Area.
-    #
     # @example
     #   # top = 3
     #   # bottom = 6
@@ -224,8 +222,6 @@ module Vedeu
 
     # Provides a virtual x position within the interface's dimensions.
     #
-    # @todo I think this method belongs with Area.
-    #
     # @example
     #   # left = 9
     #   # right = 13
@@ -236,6 +232,56 @@ module Vedeu
       (left...right).to_a
     end
 
+    # Returns the actual position of y for a given index. Crudely corrects out
+    # of range values.
+    #
+    # @example
+    #   # y_range = [7, 8, 9, 10, 11]
+    #   y_position     # => 7
+    #   y_position(-2) # => 7
+    #   y_position(2)  # => 9
+    #   y_position(7)  # => 11
+    #
+    # @param index [Fixnum]
+    # @return [Fixnum]
+    def y_position(index = 0)
+      if index <= 0
+        y_min
+
+      elsif index >= y_max_index
+        y_max
+
+      else
+        y_range[index]
+
+      end
+    end
+
+    # Returns the actual position of x for a given index. Crudely corrects out
+    # of range values.
+    #
+    # @example
+    #   # x_range = [4, 5, 6, 7, 8, 9, 10, 11, 12, 13]
+    #   x_position     # => 4
+    #   x_position(-2) # => 4
+    #   x_position(2)  # => 6
+    #   x_position(15) # => 13
+    #
+    # @param index [Fixnum]
+    # @return [Fixnum]
+    def x_position(index = 0)
+      if index <= 0
+        x_min
+
+      elsif index >= x_max_index
+        x_max
+
+      else
+        x_range[index]
+
+      end
+    end
+
     # Provides all the geometry in a convenient hash.
     #
     # @return [Hash]
@@ -261,6 +307,170 @@ module Vedeu
 
     private
 
+    # Returns the y coordinate as an offset index in the area's y range. When a
+    # value is provided, the y coordinate is overridden. Crudely corrects out of
+    # range values.
+    #
+    # @example
+    #   # y_range  = [7, 8, 9, 10]
+    #   # y = 8
+    #   y_index     # => 1
+    #   y_index(10) # => 3
+    #   y_index(5)  # => 0
+    #   y_index(15) # => 3
+    #
+    # @param value [Fixnum]
+    # @return [Fixnum]
+    def y_index(value = y)
+      if height <= 0 || value <= y_min
+        0
+
+      elsif value >= y_max
+        y_max_index
+
+      else
+        y_range.index(value)
+
+      end
+    end
+
+    # Returns the x coordinate as an offset index in the area's x range. When a
+    # value is provided, the x coordinate is overridden. Crudely corrects out of
+    # range values.
+    #
+    # @example
+    #   # x_range = [4, 5, 6, 7, 8, 9, 10, 11, 12, 13]
+    #   # x = 8
+    #   x_index     # => 4
+    #   x_index(11) # => 7
+    #   x_index(2)  # => 0
+    #   x_index(15) # => 9
+    #
+    # @param value [Fixnum]
+    # @return [Fixnum]
+    def x_index(value = x)
+      if width <= 0 || value <= x_min
+        0
+
+      elsif value >= x_max
+        x_max_index
+
+      else
+        x_range.index(value)
+
+      end
+    end
+
+    # Returns the maximum y index for an area.
+    #
+    # @example
+    #   # height = 3
+    #   y_max_index # => 2
+    #
+    # @return [Fixnum]
+    def y_max_index
+      return 0 if y_indices.empty?
+
+      y_indices.last
+    end
+
+    # Returns the maximum x index for an area.
+    #
+    # @example
+    #   # width = 6
+    #   x_max_index # => 5
+    #
+    # @return [Fixnum]
+    def x_max_index
+      return 0 if x_indices.empty?
+
+      x_indices.last
+    end
+
+    # Returns the same as #y_range, except as indices of an array.
+    #
+    # @example
+    #   # height = 4
+    #   y_indices # => [0, 1, 2, 3]
+    #
+    # @return [Array]
+    def y_indices
+      (0...height).to_a
+    end
+
+    # Returns the same as #x_range, except as indices of an array.
+    #
+    # @example
+    #   # width = 10
+    #   x_indices # => [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]
+    #
+    # @return [Array]
+    def x_indices
+      (0...width).to_a
+    end
+
+    # Returns an array with all coordinates from x to x_max.
+    #
+    # @example
+    #   # width = 10
+    #   # x_min = 4
+    #   # x_max = 14
+    #   x_range # => [4, 5, 6, 7, 8, 9, 10, 11, 12, 13]
+    #
+    # @return [Array]
+    def x_range
+      (x_min...x_max).to_a
+    end
+
+    # Returns an array with all coordinates from y to y_max.
+    #
+    # @example
+    #   # height = 4
+    #   # y_min  = 7
+    #   # y_max  = 11
+    #   y_range # => [7, 8, 9, 10]
+    #
+    # @return [Array]
+    def y_range
+      (y_min...y_max).to_a
+    end
+
+    # Returns the maximum y coordinate for an area.
+    #
+    # @example
+    #   # y_min = 2
+    #   # height = 4
+    #   y_max # => 6
+    #
+    # @return [Fixnum]
+    def y_max
+      if height <= 0
+        0
+
+      else
+        y_min + height
+
+      end
+    end
+
+    # Returns the maximum x coordinate for an area.
+    #
+    # @example
+    #   # x_min = 5
+    #   # width = 20
+    #   x_max # => 25
+    #
+    # @return [Fixnum]
+    def x_max
+      if width <= 0
+        0
+
+      else
+        x_min + width
+
+      end
+    end
+
     # The default geometry of an interface- full screen.
     #
     # @return [Hash]

data/lib/vedeu/models/interface.rb

@@ -43,9 +43,10 @@ module Vedeu
     def initialize(attributes = {}, &block)
       @attributes = defaults.merge!(attributes)
 
-      @name  = @attributes[:name]
-      @group = @attributes[:group]
+      @cursor = @attributes[:cursor]
       @delay = @attributes[:delay]
+      @group = @attributes[:group]
+      @name  = @attributes[:name]
       @parent = @attributes[:parent]
 
       if block_given?
@@ -71,9 +72,10 @@ module Vedeu
     # @return [Cursor]
     def cursor
       @_cursor ||= Cursor.new({
-        name: name,
-        x:    area.x_position(offset.x),
-        y:    area.y_position(offset.y),
+        name:  name,
+        state: attributes[:cursor],
+        x:     geometry.x_position(offset.x),
+        y:     geometry.y_position(offset.y),
       })
     end
 
@@ -115,24 +117,20 @@ module Vedeu
 
     private
 
-    # @return [Area]
-    def area
-      @_area ||= Area.from_interface(self)
-    end
-
     # The default values for a new instance of Interface.
     #
     # @return [Hash]
     def defaults
       {
-        name:     '',
-        group:    '',
-        lines:    [],
         colour:   {},
-        style:    '',
-        geometry: {},
+        cursor:   :hide,
         delay:    0.0,
+        geometry: {},
+        group:    '',
+        lines:    [],
+        name:     '',
         parent:   nil,
+        style:    '',
       }
     end
 
@@ -141,7 +139,7 @@ module Vedeu
     # @param block [Proc] The optional block provided to the method.
     # @return []
     def method_missing(method, *args, &block)
-      Vedeu.log("Interface#method_missing '#{method.to_s}' (args: #{args.inspect})")
+      Vedeu.log("Interface#method_missing '#{method}' (args: #{args.inspect})")
 
       @self_before_instance_eval.send(method, *args, &block) if @self_before_instance_eval
     end

data/lib/vedeu/models/keymap.rb

@@ -10,12 +10,44 @@ module Vedeu
 
     attr_reader :attributes
 
+    # Define actions for keypresses for when specific interfaces are in focus.
+    # Unless an interface is specified, the key will be assumed to be global,
+    # meaning its action will happen regardless of the interface in focus.
+    #
+    # @param name_or_names [String] The name or names of the interface(s) which
+    #   will handle these keys.
+    # @param block [Proc]
+    #
+    # @example
+    #   keys do                    # => will be global
+    #     key('s') { :something }
+    #     ...
+    #
+    #   keys 'my_interface' do     # => will only function when 'my_interface'
+    #     ...                      #    is in focus
+    #
+    #   keys('main', 'other') do   # => will function for both 'main' and
+    #     ...                      #    'other' interfaces
+    #
+    #   keys do
+    #     interface 'my_interface' # => will only function when 'my_interface'
+    #     ...                      #    is in focus
+    #
+    # @raise [InvalidSyntax] When the required block is not given.
+    # @return [Keymap]
+    def self.keys(*name_or_names, &block)
+      fail InvalidSyntax, '`keys` requires a block.' unless block_given?
+
+      define({ interfaces: name_or_names }, &block)
+    end
+
     # Define a keymap for an interface or interfaces to perform an action when
     # a key is pressed whilst an aforementioned interface is in focus.
     #
     # @param attributes [Hash] The attributes to register the keymap with.
-    # @option attributes :interfaces []
-    # @option attributes :keys []
+    # @option attributes :interfaces [] the interface(s) which will respond to
+    #   the keypress(es)
+    # @option attributes :keys [] the keypress/action pairs for this keymap
     # @param block [Proc]
     # @return [Keymap]
     def self.define(attributes = {}, &block)
@@ -33,7 +65,7 @@ module Vedeu
     # Adds the attributes to the Keymaps repository.
     #
     # @param block [Proc]
-    # @return [Interface]
+    # @return [Keymap]
     def define(&block)
       if block_given?
         @self_before_instance_eval = eval('self', block.binding)
@@ -53,8 +85,8 @@ module Vedeu
     # @return [Hash]
     def defaults
       {
-        interfaces: [], # the interface(s) which will respond to the keypress(es)
-        keys: [], # the keypress/action pairs for this keymap
+        interfaces: [],
+        keys:       [],
       }
     end
 
@@ -63,7 +95,7 @@ module Vedeu
     # @param block [Proc] The optional block provided to the method.
     # @return []
     def method_missing(method, *args, &block)
-      Vedeu.log("Keymap#method_missing '#{method.to_s}' (args: #{args.inspect})")
+      Vedeu.log("Keymap#method_missing '#{method}' (args: #{args.inspect})")
 
       @self_before_instance_eval.send(method, *args, &block) if @self_before_instance_eval
     end

data/lib/vedeu/models/line.rb

@@ -90,7 +90,7 @@ module Vedeu
     # @param block [Proc] The optional block provided to the method.
     # @return []
     def method_missing(method, *args, &block)
-      Vedeu.log("Line#method_missing '#{method.to_s}' (args: #{args.inspect})")
+      Vedeu.log("Line#method_missing '#{method}' (args: #{args.inspect})")
 
       @self_before_instance_eval.send(method, *args, &block) if @self_before_instance_eval
     end

data/lib/vedeu/models/stream.rb

@@ -120,7 +120,7 @@ module Vedeu
     # @param block [Proc] The optional block provided to the method.
     # @return []
     def method_missing(method, *args, &block)
-      Vedeu.log("Stream#method_missing '#{method.to_s}' (args: #{args.inspect})")
+      Vedeu.log("Stream#method_missing '#{method}' (args: #{args.inspect})")
 
       @self_before_instance_eval.send(method, *args, &block) if @self_before_instance_eval
     end

data/lib/vedeu/output/compositor.rb

@@ -68,7 +68,7 @@ module Vedeu
 
     # Returns the attributes of the latest buffer (view).
     #
-    # @return [Hash]
+    # @return [Hash|NilClass]
     def buffer
       @_buffer ||= Vedeu::Buffers.latest(name)
     end