vedeu 0.4.13 → 0.4.14

data/lib/vedeu/events/event.rb

@@ -40,7 +40,7 @@ module Vedeu
       # Register an event by name with optional delay (throttling) which when
       # triggered will execute the code contained within the passed block.
       #
-      # @param name [Symbol] The name of the event which will be triggered later.
+      # @param name [Symbol] The name of the event to be triggered later.
       # @param options [Hash] The options to register the event with.
       # @option options :delay [Fixnum|Float] Limits the execution of the
       #   triggered event to only execute when first triggered, with subsequent
@@ -49,8 +49,8 @@ module Vedeu
       #   triggered event to only execute once the debounce has expired.
       #   Subsequent triggers before debounce expiry are ignored.
       # @param block [Proc] The event to be executed when triggered. This block
-      #   could be a method call, or the triggering of another event, or sequence
-      #   of either/both.
+      #   could be a method call, or the triggering of another event, or
+      #   sequence of either/both.
       #
       # @example
       #   Vedeu.bind :my_event do |some, args|
@@ -218,7 +218,7 @@ module Vedeu
     def debouncing?
       set_time
 
-      set_deadline unless has_deadline?
+      set_deadline unless deadline?
 
       options[:debounce] > 0
     end
@@ -259,7 +259,7 @@ module Vedeu
     # Returns a boolean indicating if this event has a deadline.
     #
     # @return [Boolean]
-    def has_deadline?
+    def deadline?
       @deadline > 0
     end
 

data/lib/vedeu/geometry/all.rb

@@ -1,16 +1,11 @@
-require 'vedeu/geometry/area'
-require 'vedeu/geometry/canvas'
-require 'vedeu/geometry/centre'
-require 'vedeu/geometry/content'
-require 'vedeu/geometry/coordinate'
-require 'vedeu/geometry/dimension'
-require 'vedeu/geometry/geometry'
-require 'vedeu/geometry/grid'
-require 'vedeu/geometry/index_position'
-require 'vedeu/geometry/limit'
-require 'vedeu/geometry/position_index'
-require 'vedeu/geometry/position'
-require 'vedeu/geometry/position_validator'
-
-module Vedeu
-end # Vedeu
+require_relative 'area'
+require_relative 'canvas'
+require_relative 'coordinate'
+require_relative 'dimension'
+require_relative 'geometry'
+require_relative 'grid'
+require_relative 'index_position'
+require_relative 'null_geometry'
+require_relative 'position_index'
+require_relative 'position'
+require_relative 'position_validator'

data/lib/vedeu/geometry/area.rb

@@ -58,11 +58,8 @@ module Vedeu
     # @param other [Vedeu::Area]
     # @return [Boolean]
     def eql?(other)
-      self.class == other.class &&
-      y          == other.y     &&
-      yn         == other.yn    &&
-      x          == other.x     &&
-      xn         == other.xn
+      self.class == other.class && y == other.y && yn == other.yn &&
+        x == other.x && xn == other.xn
     end
     alias_method :==, :eql?
 

data/lib/vedeu/geometry/canvas.rb

@@ -1,5 +1,3 @@
-require 'singleton'
-
 module Vedeu
 
   # The size of the terminal is a limitation. Defining a canvas means we have
@@ -9,6 +7,18 @@ module Vedeu
 
     include Singleton
 
+    # @!attribute [r] yn
+    # @return [Fixnum]
+    attr_reader :yn
+    alias_method :bottom, :yn
+    alias_method :height, :yn
+
+    # @!attribute [r] xn
+    # @return [Fixnum]
+    attr_reader :xn
+    alias_method :right, :xn
+    alias_method :width, :xn
+
     # @return [Vedeu::Canvas]
     def self.canvas
       instance
@@ -64,26 +74,12 @@ module Vedeu
     end
     alias_method :top, :y
 
-    # @return [Fixnum]
-    def yn
-      @yn
-    end
-    alias_method :bottom, :yn
-    alias_method :height, :yn
-
     # @return [Fixnum]
     def x
       1
     end
     alias_method :left, :x
 
-    # @return [Fixnum]
-    def xn
-      @xn
-    end
-    alias_method :right, :xn
-    alias_method :width, :xn
-
   end # Canvas
 
 end # Vedeu

data/lib/vedeu/geometry/dimension.rb

@@ -45,50 +45,51 @@ module Vedeu
     private
 
     # @!attribute [r] d
-    # @return [Fixnum]
+    # @return [Fixnum|NilClass]
     attr_reader :d
 
     # @!attribute [r] dn
-    # @return [Fixnum]
+    # @return [Fixnum|NilClass]
     attr_reader :dn
 
     # @!attribute [r] d_dn
-    # @return [Fixnum]
+    # @return [Fixnum|NilClass]
     attr_reader :d_dn
 
     # @!attribute [r] default
-    # @return [Fixnum]
+    # @return [Fixnum|NilClass]
     attr_reader :default
 
     # @return [Array<Fixnum>]
     def dimension
       @dimension ||= if centred? && length?
-        [(default / 2) - (length / 2), (default / 2) + (length / 2)]
+                       [(default / 2) - (length / 2),
+                        (default / 2) + (length / 2)]
 
-      elsif d && dn
-        [d, dn]
+                     elsif d && dn
+                       [d, dn]
 
-      elsif d && d_dn
-        [d, (d + d_dn)]
+                     elsif d && d_dn
+                       [d, ((d + d_dn) - 1)]
 
-      elsif d_dn
-        [1, d_dn]
+                     elsif d_dn
+                       [1, d_dn]
 
-      elsif d
-        [d, default]
+                     elsif d
+                       [d, default]
 
-      elsif dn
-        [1, dn]
+                     elsif dn
+                       [1, dn]
 
-      else
-        [1, default]
+                     else
+                       [1, default]
 
-      end
+                     end
     end
 
     # @return [Boolean]
     def length?
-      !!(default) && !!(length)
+      default && length
     end
 
     # @return [Fixnum|NilClass]
@@ -102,9 +103,6 @@ module Vedeu
       elsif default
         default
 
-      else
-        nil
-
       end
     end
 

data/lib/vedeu/geometry/geometry.rb

@@ -33,24 +33,24 @@ module Vedeu
     include Vedeu::Model
 
     def_delegators :area,
-      :north,
-      :east,
-      :south,
-      :west,
-      :top,
-      :right,
-      :bottom,
-      :left,
-      :y,
-      :xn,
-      :yn,
-      :x,
-      :height,
-      :width,
-      :top_left,
-      :top_right,
-      :bottom_left,
-      :bottom_right
+                   :north,
+                   :east,
+                   :south,
+                   :west,
+                   :top,
+                   :right,
+                   :bottom,
+                   :left,
+                   :y,
+                   :xn,
+                   :yn,
+                   :x,
+                   :height,
+                   :width,
+                   :top_left,
+                   :top_right,
+                   :bottom_left,
+                   :bottom_right
 
     # @!attribute [rw] centred
     # @return [Boolean]
@@ -122,22 +122,20 @@ module Vedeu
 
     # @return [Array<Fixnum>]
     def x_xn
-      @x_xn ||= Vedeu::Dimension.pair({ d:        _x,
-                                        dn:      _xn,
-                                        d_dn:    @width,
-                                        default: Vedeu::Terminal.width,
-                                        options: { centred: centred }
-                                      })
+      @x_xn ||= Vedeu::Dimension.pair(d:        _x,
+                                      dn:      _xn,
+                                      d_dn:    @width,
+                                      default: Vedeu::Terminal.width,
+                                      options: { centred: centred })
     end
 
     # @return [Array<Fixnum>]
     def y_yn
-      @y_yn ||= Vedeu::Dimension.pair({ d:       _y,
-                                        dn:      _yn,
-                                        d_dn:    @height,
-                                        default: Vedeu::Terminal.height,
-                                        options: { centred: centred }
-                                      })
+      @y_yn ||= Vedeu::Dimension.pair(d:       _y,
+                                      dn:      _yn,
+                                      d_dn:    @height,
+                                      default: Vedeu::Terminal.height,
+                                      options: { centred: centred })
     end
 
     # Returns the row/line start position for the interface.

data/lib/vedeu/geometry/grid.rb

@@ -44,7 +44,7 @@ module Vedeu
     # @return [Fixnum|OutOfRange]
     def columns
       fail OutOfRange,
-        'Valid value between 1 and 12 inclusive.' if out_of_range?
+           'Valid value between 1 and 12 inclusive.' if out_of_range?
 
       column * value
     end

data/lib/vedeu/geometry/index_position.rb

@@ -51,6 +51,13 @@ module Vedeu
       Vedeu::Position.new(y, x)
     end
 
+    # @param other [Vedeu::IndexPosition]
+    # @return [Boolean]
+    def eql?(other)
+      self.class == other.class && (x == other.x && y == other.y)
+    end
+    alias_method :==, :eql?
+
     # @return [Fixnum]
     def y
       (iy <= 0) ? oy : (iy + oy)

data/lib/vedeu/geometry/null_geometry.rb

@@ -0,0 +1,61 @@
+module Vedeu
+
+  # Provides geometry for interfaces that do not have geometry defined.
+  #
+  class NullGeometry
+
+    extend Forwardable
+
+    def_delegators :area,
+                   :north,
+                   :east,
+                   :south,
+                   :west,
+                   :top,
+                   :right,
+                   :bottom,
+                   :left,
+                   :y,
+                   :xn,
+                   :yn,
+                   :x,
+                   :height,
+                   :width,
+                   :top_left,
+                   :top_right,
+                   :bottom_left,
+                   :bottom_right
+
+    # @return [Vedeu::NullGeometry]
+    def initialize; end
+
+    # @return [FalseClass]
+    def centred
+      false
+    end
+
+    # @return [Vedeu::NullGeometry]
+    def store
+      self
+    end
+
+    private
+
+    # @return [Vedeu::Area]
+    def area
+      @area ||= Vedeu::Area.from_dimensions(y_yn: y_yn, x_xn: x_xn)
+    end
+
+    # @return [Array<Fixnum>]
+    def x_xn
+      @x_xn ||= Vedeu::Dimension.pair(default: Vedeu::Terminal.width)
+    end
+
+    # @return [Array<Fixnum>]
+    def y_yn
+      @y_yn ||= Vedeu::Dimension.pair(default: Vedeu::Terminal.height)
+    end
+
+  end # NullGeometry
+
+end # Vedeu

data/lib/vedeu/geometry/position.rb

@@ -32,9 +32,6 @@ module Vedeu
       elsif value.is_a?(Hash)
         new(value.fetch(:y, 1), value.fetch(:x, 1))
 
-      else
-        # not sure how to proceed
-
       end
     end
 

data/lib/vedeu/geometry/position_index.rb

@@ -35,6 +35,13 @@ module Vedeu
       [y, x]
     end
 
+    # @param other [Vedeu::PositionIndex]
+    # @return [Boolean]
+    def eql?(other)
+      self.class == other.class && (x == other.x && y == other.y)
+    end
+    alias_method :==, :eql?
+
     # @return [Vedeu::Position]
     def to_position
       Vedeu::Position.new(y, x)

data/lib/vedeu/geometry/position_validator.rb

@@ -3,34 +3,30 @@ require 'vedeu/support/terminal'
 module Vedeu
 
   # Validates that the provided coordinates are within the terminal and
-  # interface (with or without a border).
+  # interface's geometry (with or without a border).
   #
   class PositionValidator
 
     extend Forwardable
 
-    def_delegators Vedeu::Terminal,
-      :tx,
-      :ty,
-      :txn,
-      :tyn
-
-    def_delegators :interface,
-      :border?,
-      :border,
-      :geometry
+    def_delegators :terminal,
+                   :tx,
+                   :ty,
+                   :txn,
+                   :tyn
 
     def_delegators :border,
-      :left?,
-      :right?,
-      :top?,
-      :bottom?
+                   :enabled?,
+                   :left?,
+                   :right?,
+                   :top?,
+                   :bottom?
 
     def_delegators :geometry,
-      :left,
-      :right,
-      :top,
-      :bottom
+                   :left,
+                   :right,
+                   :top,
+                   :bottom
 
     # @!attribute [rw] x
     # @return [Fixnum]
@@ -41,36 +37,41 @@ module Vedeu
     attr_accessor :y
 
     # @param (see #initialize)
-    def self.validate(interface, x, y)
-      new(interface, x, y).validate
+    def self.validate(name, x, y)
+      new(name, x, y).validate
     end
 
     # Returns a new instance of Vedeu::PositionValidator.
     #
-    # @param interface [Interface]
+    # @param name [String]
     # @param x [Fixnum]
     # @param y [Fixnum]
     # @return [PositionValidator]
-    def initialize(interface, x, y)
-      @interface = interface
-      @x         = x
-      @y         = y
+    def initialize(name, x, y)
+      @name = name
+      @x    = x
+      @y    = y
     end
 
     # @return [PositionValidator]
     def validate
       terminal_validation
       interface_validation
-      border_validation if border?
+      border_validation if enabled?
 
       self
     end
 
     private
 
-    # @!attribute [r] interface
-    # @return [Vedeu::Interface]
-    attr_reader :interface
+    # @!attribute [r] name
+    # @return [String]
+    attr_reader :name
+
+    # @return [Vedeu::Terminal]
+    def terminal
+      Vedeu::Terminal
+    end
 
     # Validate the x and y coordinates are within the dimensions of the
     # terminal.
@@ -103,14 +104,24 @@ module Vedeu
     #
     # @return [PositionValidator]
     def border_validation
-      @x = left + 1   if left?   && x < (left + 1)
-      @x = right - 2  if right?  && x > (right - 1)
-      @y = top + 1    if top?    && y < (top + 1)
+      @x = left + 1   if left? && x < (left + 1)
+      @x = right - 2  if right? && x > (right - 1)
+      @y = top + 1    if top? && y < (top + 1)
       @y = bottom - 2 if bottom? && y > (bottom - 1)
 
       self
     end
 
+    # @return [Vedeu::Border|Vedeu::NullBorder|NilClass]
+    def border
+      @border ||= Vedeu.borders.by_name(name)
+    end
+
+    # @return [Vedeu::Geometry|Vedeu::NullGeometry]
+    def geometry
+      @geometry ||= Vedeu.geometries.by_name(name)
+    end
+
   end # PositionValidator
 
 end # Vedeu

data/lib/vedeu/input/all.rb

@@ -1,8 +1,9 @@
 require 'vedeu/repositories/all'
-require 'vedeu/input/mapper'
-require 'vedeu/input/key'
-require 'vedeu/input/input'
-require 'vedeu/input/keymap'
+
+require_relative 'mapper'
+require_relative 'key'
+require_relative 'input'
+require_relative 'keymap'
 
 module Vedeu
 

data/lib/vedeu/input/keymap.rb

@@ -1,4 +1,3 @@
-require 'vedeu/exceptions'
 require 'vedeu/repositories/all'
 require 'vedeu/dsl/components/all'
 require 'vedeu/input/key'

data/lib/vedeu/input/mapper.rb

@@ -60,9 +60,7 @@ module Vedeu
     #
     # @return [Boolean]
     def valid?
-      return false unless key
-
-      return false if key_defined? || global_key? || system_key?
+      return false if !key || key_defined? || global_key? || system_key?
 
       true
     end

data/lib/vedeu/launcher.rb

@@ -20,11 +20,7 @@ module Vedeu
                       stdout = STDOUT,
                       stderr = STDERR,
                       kernel = Kernel)
-      new(argv,
-          stdin  = STDIN,
-          stdout = STDOUT,
-          stderr = STDERR,
-          kernel = Kernel).debug_execute!
+      new(argv, stdin, stdout, stderr, kernel).debug_execute!
     end
 
     # Returns a new instance of Vedeu::Launcher.
@@ -72,7 +68,6 @@ module Vedeu
     rescue StandardError => uncaught_exception
       puts uncaught_exception.message
       puts uncaught_exception.backtrace.join("\n") if configuration.debug?
-
     end
 
     private
@@ -85,13 +80,17 @@ module Vedeu
     #
     # @return [void]
     def terminate!
-      Vedeu.log(type: :info, message: "Exiting gracefully.")
+      Vedeu.log(type: :info, message: 'Exiting gracefully.')
 
       $stdin, $stdout, $stderr = STDIN, STDOUT, STDERR
 
       @kernel.exit(exit_code)
     end
 
+    # Use the arguments passed on the command-line along with those defined by
+    # the client application and Vedeu's defaults to configure the client
+    # application.
+    #
     # @return [Vedeu::Configuration]
     def configuration
       Vedeu::Configuration.configure(argv)

data/lib/vedeu/main_loop.rb

@@ -21,13 +21,12 @@ module Vedeu
       @started = true
       @loop    = true
 
-      while(@loop) do
+      while @loop
         yield
 
         safe_exit_point!
       end
     rescue VedeuInterrupt
-
     end
     # :nocov:
 

data/lib/vedeu/models/all.rb

@@ -1,5 +1,6 @@
 require 'vedeu/repositories/all'
 
+require_relative 'null'
 require_relative 'cell'
 require_relative 'char'
 require_relative 'stream'

data/lib/vedeu/models/cell.rb

@@ -30,7 +30,8 @@ module Vedeu
 
     # Returns a new instance of Vedeu::Cell.
     #
-    # @param attributes [Hash<Symbol => Array<Symbol|String>, Fixnum, String, Symbol]
+    # @param attributes [Hash<Symbol => Array<Symbol|String>,
+    #                                   Fixnum, String, Symbol]
     # @option attributes background [NilClass|String]
     # @option attributes foreground [NilClass|String]
     # @option attributes style [NilClass|Array<Symbol|String>|Symbol|String]
@@ -50,13 +51,9 @@ module Vedeu
     # @param other [Vedeu::Cell]
     # @return [Boolean]
     def eql?(other)
-      self.class == other.class      &&
-      background == other.background &&
-      foreground == other.foreground &&
-      style      == other.style      &&
-      value      == other.value      &&
-      x          == other.x          &&
-      y          == other.y
+      self.class == other.class && background == other.background &&
+        foreground == other.foreground && style == other.style &&
+        value == other.value && x == other.x && y == other.y
     end
     alias_method :==, :eql?