vedeu 0.4.23 → 0.4.24

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 365b29b26543c213bcb8ca54063e55261dca7d47
-  data.tar.gz: 8fbbb26db13f252b6cdba3ccaaf851718335a854
+  metadata.gz: d53834cae0f1a3dc8708b3706bf87d4014f16c90
+  data.tar.gz: 08bc9cd02ad0672be13d272172912d6b7975fd41
 SHA512:
-  metadata.gz: 224fd3df8947ad37738184011a53c1814530cb8ee923f3e634a8e398710b42399aa15d9ad95cc57c2356da16208fb3c972dc9b0a92c0c2e9cb73d059074f1c86
-  data.tar.gz: 2d99311229522afc70142dbca1f15d05f2cce5954548cf1f05d275a51545d7b729e67748c48b9ead6578457d503097418239826fd658501a8d2c5c59c1a5cec9
+  metadata.gz: 522ba5bc35cfb89d15c28b8784da90634a80106e3aaa463e039c9b1c01c310a4cec9e87dccc7b9fba55a6b5f81bd39573cf854241e203c7400bbe8652cc593d1
+  data.tar.gz: 44e0de6a4e2541b1672e0c79bfdf183bd4b2ce9e408525c41c79c9772ca160a6e6387d46950201ef05eb925672e3b6329347eaa61db186d08525af144fed640e

data/examples/cursor_app.rb

@@ -28,10 +28,15 @@ class VedeuCursorApp
   end
 
   keymap('_global_') do
-    key(:up,    'k') { Vedeu.trigger(:_cursor_up_)    }
-    key(:right, 'l') { Vedeu.trigger(:_cursor_right_) }
-    key(:down,  'j') { Vedeu.trigger(:_cursor_down_)  }
-    key(:left,  'h') { Vedeu.trigger(:_cursor_left_)  }
+    key(:up)    { Vedeu.trigger(:_cursor_up_)    }
+    key(:right) { Vedeu.trigger(:_cursor_right_) }
+    key(:down)  { Vedeu.trigger(:_cursor_down_)  }
+    key(:left)  { Vedeu.trigger(:_cursor_left_)  }
+
+    key('k') { Vedeu.trigger(:_geometry_up_, 'main_interface')    }
+    key('l') { Vedeu.trigger(:_geometry_right_, 'main_interface') }
+    key('j') { Vedeu.trigger(:_geometry_down_, 'main_interface')  }
+    key('h') { Vedeu.trigger(:_geometry_left_, 'main_interface')  }
 
     key('m') { Vedeu.trigger(:_maximise_, 'main_interface') }
     key('u') { Vedeu.trigger(:_unmaximise_, 'main_interface') }

data/lib/vedeu/bindings.rb

@@ -58,10 +58,7 @@ module Vedeu
     # you should define to 'do things'. If the `escape` key is pressed, then
     # `key` is triggered with the argument `:escape`, also an internal event
     # `_mode_switch_` is triggered.
-    Vedeu.bind(:_keypress_) do |key|
-      Vedeu.trigger(:key, key)
-      Vedeu.keypress(key)
-    end
+    Vedeu.bind(:_keypress_) { |key| Vedeu.keypress(key) }
 
     # Will cause the triggering of the `:command` event; which you should define
     # to 'do things'.
@@ -95,19 +92,49 @@ module Vedeu
     end
 
     # @see {Vedeu::Move}
-    Vedeu.bind(:_cursor_down_) { |name| Vedeu::Move.by_name(:down, name) }
+    Vedeu.bind(:_cursor_down_) do |name|
+      Vedeu::Move.by_name(Vedeu::Cursor, :down, name)
+    end
+
+    # @see {Vedeu::Move}
+    Vedeu.bind(:_cursor_left_) do |name|
+      Vedeu::Move.by_name(Vedeu::Cursor, :left, name)
+    end
+
+    # @see {Vedeu::Move}
+    Vedeu.bind(:_cursor_right_) do |name|
+      Vedeu::Move.by_name(Vedeu::Cursor, :right, name)
+    end
+
+    # @see {Vedeu::Move}
+    Vedeu.bind(:_cursor_up_) do |name|
+      Vedeu::Move.by_name(Vedeu::Cursor, :up, name)
+    end
 
     # @see {Vedeu::Move}
-    Vedeu.bind(:_cursor_left_) { |name| Vedeu::Move.by_name(:left, name) }
+    Vedeu.bind(:_cursor_origin_) do |name|
+      Vedeu::Move.by_name(Vedeu::Cursor, :origin, name)
+    end
 
     # @see {Vedeu::Move}
-    Vedeu.bind(:_cursor_right_) { |name| Vedeu::Move.by_name(:right, name) }
+    Vedeu.bind(:_geometry_down_) do |name|
+      Vedeu.geometries.by_name(name).move(1, 0)
+    end
 
     # @see {Vedeu::Move}
-    Vedeu.bind(:_cursor_up_) { |name| Vedeu::Move.by_name(:up, name) }
+    Vedeu.bind(:_geometry_left_) do |name|
+      Vedeu.geometries.by_name(name).move(0, -1)
+    end
 
     # @see {Vedeu::Move}
-    Vedeu.bind(:_cursor_origin_) { |name| Vedeu::Move.by_name(:origin, name) }
+    Vedeu.bind(:_geometry_right_) do |name|
+      Vedeu.geometries.by_name(name).move(0, 1)
+    end
+
+    # @see {Vedeu::Move}
+    Vedeu.bind(:_geometry_up_) do |name|
+      Vedeu.geometries.by_name(name).move(-1, 0)
+    end
 
     # @see {Vedeu::Move}
     Vedeu.bind(:_cursor_reset_) { |name| Vedeu.trigger(:_cursor_origin_, name) }

data/lib/vedeu/cursor/move.rb

@@ -30,26 +30,6 @@ module Vedeu
   #     irrespective of content.
   class Move
 
-    extend Forwardable
-
-    def_delegators :border,
-                   :height,
-                   :width,
-                   :x,
-                   :y
-
-    # Returns an instance of Vedeu::Move.
-    #
-    # @param name [String] The name of the cursor.
-    # @param dy [Fixnum] Move up (-1), or down (1), or no action (0).
-    # @param dx [Fixnum] Move left (-1), or right (1), or no action (0).
-    # @return [Move]
-    def initialize(name, dy = 0, dx = 0)
-      @name = name
-      @dy   = dy
-      @dx   = dx
-    end
-
     # Move the named cursor, or that which is currently in focus in the
     # specified direction.
     #
@@ -60,61 +40,88 @@ module Vedeu
     #   moved; when not given, the interface currently in focus determines which
     #   cursor instance to move.
     # @return [Cursor]
-    def self.by_name(direction, name = nil)
+    def self.by_name(entity, direction, name = nil)
       name = name ? name : Vedeu.focus
 
-      Vedeu::Move.send(direction, name)
+      Vedeu::Move.send(direction, entity, name)
     end
 
     # Moves the cursor down by one row.
     #
+    # @param entity [Class]
     # @param name [String]
     # @return [Cursor]
-    def self.down(name)
-      new(name, 1, 0).move
+    def self.down(entity, name)
+      new(entity, name, 1, 0).move
     end
 
     # Moves the cursor left by one column.
     #
+    # @param entity [Class]
     # @param name [String]
     # @return [Cursor]
-    def self.left(name)
-      new(name, 0, -1).move
+    def self.left(entity, name)
+      new(entity, name, 0, -1).move
     end
 
     # Moves the cursor right by one column.
     #
+    # @param entity [Class]
     # @param name [String]
     # @return [Cursor]
-    def self.right(name)
-      new(name, 0, 1).move
+    def self.right(entity, name)
+      new(entity, name, 0, 1).move
     end
 
     # Moves the cursor up by one row.
     #
+    # @param entity [Class]
     # @param name [String]
     # @return [Cursor]
-    def self.up(name)
-      new(name, -1, 0).move
+    def self.up(entity, name)
+      new(entity, name, -1, 0).move
     end
 
     # Moves the cursor to the top left coordinate of the interface.
     #
+    # @param entity [Class]
     # @param name [String]
     # @return [Cursor]
-    def self.origin(name)
-      new(name, -2000, -2000).move
+    def self.origin(entity, name)
+      new(entity, name, -2000, -2000).move
+    end
+
+    # Returns an instance of Vedeu::Move.
+    #
+    # @param entity [Class]
+    # @param name [String] The name of the cursor.
+    # @param dy [Fixnum] Move up (-1), or down (1), or no action (0).
+    # @param dx [Fixnum] Move left (-1), or right (1), or no action (0).
+    # @return [Move]
+    def initialize(entity, name, dy = 0, dx = 0)
+      @entity = entity
+      @name   = name
+      @dy     = dy
+      @dx     = dx
     end
 
     # Returns a newly positioned and stored Cursor.
     #
     # @return [Cursor]
     def move
-      cursor = Vedeu::Cursor.new(attributes.merge!(new_attributes)).store
+      attrs = attributes.merge!(new_attributes)
+
+      model = entity.new(attrs).store
 
-      Vedeu.trigger(:_refresh_cursor_, name)
+      if model.is_a?(Vedeu::Cursor)
+        Vedeu.trigger(:_refresh_cursor_, name)
 
-      cursor
+      else
+        Vedeu.trigger(:_refresh_, name)
+
+      end
+
+      model
     end
 
     protected
@@ -127,6 +134,10 @@ module Vedeu
     # @return [Fixnum]
     attr_reader :dy
 
+    # @!attribute [r] entity
+    # @return [Fixnum]
+    attr_reader :entity
+
     # @!attribute [r] name
     # @return [String]
     attr_reader :name
@@ -145,22 +156,13 @@ module Vedeu
     # @return [Hash<Symbol => Fixnum>]
     def new_attributes
       {
-        x:  validator.x,
-        y:  validator.y,
+        x:  x_position,
+        y:  y_position,
         ox: ox,
         oy: oy,
       }
     end
 
-    # Validates the new position of the cursor.
-    #
-    # @return [PositionValidator]
-    def validator
-      @validator ||= Vedeu::PositionValidator.validate(name,
-                                                       x_position,
-                                                       y_position)
-    end
-
     # Returns the cursors x position based on its current offset.
     #
     # @return [Fixnum]
@@ -175,17 +177,9 @@ module Vedeu
       coordinate.y_position(oy)
     end
 
-    # Retrieve the border for the named view: this will provide the geometry for
-    # the cursor, ensuring it displays within the interface boundaries.
-    #
-    # @return (see Vedeu::Borders#by_name)
-    def border
-      @border ||= Vedeu.borders.by_name(name)
-    end
-
     # @return [Coordinate]
     def coordinate
-      @coordinate ||= Vedeu::Coordinate.new(height, width, x, y)
+      @coordinate ||= Vedeu::Coordinate.new(name)
     end
 
     # @return (see Vedeu::Cursors#by_name)

data/lib/vedeu/geometry/coordinate.rb

@@ -3,34 +3,24 @@ module Vedeu
   # Crudely corrects out of range values.
   class Coordinate
 
-    # @!attribute [r] height
-    # @return [Fixnum]
-    attr_reader :height
-
-    # @!attribute [r] width
-    # @return [Fixnum]
-    attr_reader :width
-
-    # @!attribute [r] x
-    # @return [Fixnum]
-    attr_reader :x
-
-    # @!attribute [r] y
-    # @return [Fixnum]
-    attr_reader :y
+    extend Forwardable
+
+    def_delegators :border,
+                   :bx,
+                   :bxn,
+                   :by,
+                   :byn,
+                   :height,
+                   :width,
+                   :x,
+                   :y
 
     # Returns a new instance of Vedeu::Coordinate.
     #
-    # @param height [Fixnum]
-    # @param width [Fixnum]
-    # @param x [Fixnum]
-    # @param y [Fixnum]
+    # @param name [String]
     # @return [Vedeu::Coordinate]
-    def initialize(height, width, x, y)
-      @height = height
-      @width  = width
-      @x      = x
-      @y      = y
+    def initialize(name)
+      @name = name
     end
 
     # Returns the maximum y coordinate for an area.
@@ -81,16 +71,17 @@ module Vedeu
     # @param index [Fixnum]
     # @return [Fixnum]
     def y_position(index = 0)
-      if index <= 0
-        y
+      value = if index <= 0
+                y
 
-      elsif index > yn_index
-        yn
+              elsif index > yn_index
+                yn
 
-      else
-        y_range[index]
+              else
+                y_range[index]
 
-      end
+              end
+      validate_y(value)
     end
 
     # Returns the x coordinate for a given index.
@@ -105,16 +96,17 @@ module Vedeu
     # @param index [Fixnum]
     # @return [Fixnum]
     def x_position(index = 0)
-      if index <= 0
-        x
+      value = if index <= 0
+                x
 
-      elsif index > xn_index
-        xn
+              elsif index > xn_index
+                xn
 
-      else
-        x_range[index]
+              else
+                x_range[index]
 
-      end
+              end
+      validate_x(value)
     end
 
     protected
@@ -125,6 +117,27 @@ module Vedeu
 
     private
 
+    # @return (see Vedeu::Borders#by_name)
+    def border
+      @border ||= Vedeu.borders.by_name(name)
+    end
+
+    # @param value [Fixnum]
+    # @return [Fixnum]
+    def validate_x(value)
+      value = value < bx ? bx : value
+      value = value > bxn ? bxn : value
+      value
+    end
+
+    # @param value [Fixnum]
+    # @return [Fixnum]
+    def validate_y(value)
+      value = value < by ? by : value
+      value = value > byn ? byn : value
+      value
+    end
+
     # Returns the maximum y index for an area.
     #
     # @example

data/lib/vedeu/geometry/geometry.rb

@@ -105,35 +105,63 @@ module Vedeu
 
     # @return [String]
     def inspect
-      "<Vedeu::Geometry x:#{x} xn:#{xn} y:#{y} yn:#{yn} maximise:#{maximised}>"
+      '<Vedeu::Geometry '   \
+      "x:#{x} "             \
+      "xn:#{xn} "           \
+      "y:#{y} "             \
+      "yn:#{yn} "           \
+      "centred:#{centred} " \
+      "maximise:#{maximised}>"
     end
 
-    # @return [Vedeu::Geometry]
+    # @return [Vedeu::Geometry|NilClass]
     def maximise
-      unless maximised?
-        @maximised = true
+      return self if maximised?
+
+      @maximised = true
 
-        work = store
+      work = store
 
-        Vedeu.trigger(:_refresh_, name)
+      Vedeu.trigger(:_refresh_, name)
 
-        work
-      end
+      work
     end
 
-    # @return [Vedeu::Geometry]
+    # @return [Vedeu::Geometry|NilClass]
     def unmaximise
-      if maximised?
-        Vedeu.trigger(:_clear_, name)
+      return self unless maximised?
+
+      Vedeu.trigger(:_clear_, name)
+
+      @maximised = false
+
+      work = store
 
-        @maximised = false
+      Vedeu.trigger(:_refresh_, name)
+
+      work
+    end
+
+    # @param dy [Fixnum]
+    # @param dx [Fixnum]
+    # @return [Vedeu::Geometry]
+    def move(dy = 0, dx = 0)
+      new_attrs = {
+        centred:    false,
+        maximised:  false,
+        name:       name,
+        x:          (area.x + dx),
+        y:          (area.y + dy),
+        xn:         (area.xn + dx),
+        yn:         (area.yn + dy),
+      }
 
-        work = store
+      work = Vedeu::Geometry.new(new_attrs).store
 
-        Vedeu.trigger(:_refresh_, name)
+      Vedeu.trigger(:_clear_)
+      Vedeu.trigger(:_refresh_, name)
 
-        work
-      end
+      work
     end
 
     private

data/lib/vedeu/geometry/position.rb

@@ -70,13 +70,9 @@ module Vedeu
     # @yieldreturn [void] Returns the block wrapped in position escape
     #   sequences.
     def to_s
-      if block_given?
-        [sequence, yield, sequence].join
+      return sequence unless block_given?
 
-      else
-        sequence
-
-      end
+      [sequence, yield, sequence].join
     end
 
     private

data/lib/vedeu/input/mapper.rb

@@ -10,6 +10,8 @@ module Vedeu
     # @param (see #initialize)
     # @return [Boolean]
     def self.keypress(key = nil, name = nil)
+      Vedeu.trigger(:key, key)
+
       return false unless key
 
       new(key, name).keypress

data/lib/vedeu/models/char.rb

@@ -76,7 +76,7 @@ module Vedeu
 
     # @return [Vedeu::Position]
     def position
-      @position ||= Vedeu::Position.coerce(attributes[:position])
+      @position ||= Vedeu::Position.coerce(@attributes[:position])
     end
 
     # Sets the position of the Char.
@@ -84,7 +84,7 @@ module Vedeu
     # @param value [Vedeu::Position]
     # @return [Vedeu::Position]
     def position=(value)
-      @position = Vedeu::Position.coerce(value)
+      @position = @attributes[:position] = Vedeu::Position.coerce(value)
     end
 
     # @return [String]

data/lib/vedeu/output/all.rb

@@ -2,11 +2,11 @@ require_relative 'esc'
 require_relative 'translator'
 require_relative 'background'
 require_relative 'foreground'
+require_relative 'presentation'
 require_relative 'border'
 require_relative 'colour'
 require_relative 'compressor'
 require_relative 'clear'
-require_relative 'presentation'
 require_relative 'style'
 require_relative 'text'
 require_relative 'virtual_buffer'

data/lib/vedeu/output/border.rb

@@ -159,13 +159,15 @@ module Vedeu
       return [] unless visible?
       return [] unless enabled?
 
-      out = [top, bottom]
+      Vedeu::Timer.for(:debug, "Border rendering: #{name}") do
+        out = [top, bottom]
 
-      height.times do |y|
-        out << [left(y), right(y)]
-      end
+        height.times do |y|
+          out << [left(y), right(y)]
+        end
 
-      out.flatten
+        out.flatten
+      end
     end
 
     # @return [String]
@@ -316,7 +318,7 @@ module Vedeu
 
     # @return [Vedeu::Geometry]
     def geometry
-      @geometry ||= Vedeu.geometries.by_name(name)
+      Vedeu.geometries.by_name(name)
     end
 
     # @return [Vedeu::Interface]

data/lib/vedeu/output/clear.rb

@@ -58,14 +58,14 @@ module Vedeu
     # @return [Array<Array<Vedeu::Char>>]
     def clear
       if visible?
-        Vedeu.log(type: :output, message: "Clearing: '#{name}'")
-
-        @clear ||= Array.new(height) do |iy|
-          Array.new(width) do |ix|
-            Vedeu::Char.new(value:    ' ',
-                            colour:   clear_colour,
-                            style:    style,
-                            position: Vedeu::IndexPosition[iy, ix, *position])
+        Vedeu::Timer.for(:debug, "Clearing: #{name}") do
+          @clear ||= Array.new(height) do |iy|
+            Array.new(width) do |ix|
+              Vedeu::Char.new(value:    ' ',
+                              colour:   clear_colour,
+                              style:    style,
+                              position: Vedeu::IndexPosition[iy, ix, *position])
+            end
           end
         end
       else
@@ -106,13 +106,13 @@ module Vedeu
     #   the terminal, or the colours of the interface.
     def clear_colour
       @colour ||= if use_terminal_colours?
-        Vedeu::Colour.new(background: :default,
-                          foreground: :default)
+                    Vedeu::Colour.new(background: :default,
+                                      foreground: :default)
 
-      else
-        colour
+                  else
+                    colour
 
-      end
+                  end
     end
 
     # @return [Hash<Symbol => Boolean>]
@@ -146,17 +146,15 @@ module Vedeu
       @_options ||= defaults.merge!(@options)
     end
 
-    # @param iy [Fixnum]
-    # @param ix [Fixnum]
     # @return [Vedeu::IndexPosition]
     def position
       @position ||= if clear_border?
-        [y, x]
+                      [y, x]
 
-      else
-        [by, bx]
+                    else
+                      [by, bx]
 
-      end
+                    end
     end
 
     # @return [Boolean] Indicates whether the default terminal colours should be

data/lib/vedeu/output/refresh.rb

@@ -10,11 +10,9 @@ module Vedeu
     #
     # @return [Array]
     def all
-      message = "Refreshing all interfaces"
+      message = 'Refreshing all interfaces'
 
-      Vedeu.log(type: :info, message: message)
-
-      Vedeu::Timer.for(message) do
+      Vedeu::Timer.for(:info, message) do
         Vedeu.interfaces.registered.each { |name| by_name(name) }
       end
     end
@@ -34,9 +32,7 @@ module Vedeu
     def by_group(group_name)
       message = "Refreshing group: '#{group_name}'"
 
-      Vedeu.log(type: :info, message: message)
-
-      Vedeu::Timer.for(message) do
+      Vedeu::Timer.for(:info, message) do
         Vedeu.groups.find!(group_name).members.each { |name| by_name(name) }
       end
     end
@@ -49,9 +45,7 @@ module Vedeu
     def by_name(name)
       message = "Refreshing interface: '#{name}'"
 
-      Vedeu.log(type: :info, message: message)
-
-      Vedeu::Timer.for(message) { Vedeu.buffers.by_name(name).render }
+      Vedeu::Timer.for(:info, message) { Vedeu.buffers.by_name(name).render }
     end
 
   end # Refresh