vedeu 0.4.7 → 0.4.8

data/lib/vedeu/geometry/area.rb

@@ -0,0 +1,151 @@
+module Vedeu
+
+  # Define an area from dimensions or points.
+  #
+  class Area
+
+    # @!attribute [r] y
+    # @return [Fixnum]
+    attr_reader :y
+    alias_method :top, :y
+
+    # @!attribute [r] yn
+    # @return [Fixnum]
+    attr_reader :yn
+    alias_method :bottom, :yn
+
+    # @!attribute [r] x
+    # @return [Fixnum]
+    attr_reader :x
+    alias_method :left, :x
+
+    # @!attribute [r] xn
+    # @return [Fixnum]
+    attr_reader :xn
+    alias_method :right, :xn
+
+    # @param y_yn [Array<Fixnum>]
+    # @param x_xn [Array<Fixnum>]
+    # @return [Vedeu::Area]
+    def self.from_dimensions(y_yn:, x_xn:)
+      new(y: y_yn.first, yn: y_yn.last, x: x_xn.first, xn: x_xn.last)
+    end
+
+    # @param height [Fixnum]
+    # @param width [Fixnum]
+    # @return [Vedeu::Area]
+    def self.from_height_and_width(height:, width:)
+      new(y: 1, yn: height, x: 1, xn: width)
+    end
+
+    # @param (see #initialize)
+    # @return [Vedeu::Area]
+    def self.from_points(y:, yn:, x:, xn:)
+      new(y: y, yn: yn, x: x, xn: xn)
+    end
+
+    # @param y [Fixnum]
+    # @param yn [Fixnum]
+    # @param x [Fixnum]
+    # @param xn [Fixnum]
+    # @return [Vedeu::Area]
+    def initialize(y:, yn:, x:, xn:)
+      @y, @yn, @x, @xn  = y, yn, x, xn
+    end
+
+    # @param other [Vedeu::Area]
+    # @return [Boolean]
+    def ==(other)
+      eql?(other)
+    end
+
+    # @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
+    end
+
+    # @return [Array<Fixnum>]
+    def centre
+      [centre_y, centre_x]
+    end
+
+    # @return [Fixnum]
+    def centre_y
+      ((yn - y) / 2) + y
+    end
+
+    # @return [Fixnum]
+    def centre_x
+      ((xn - x) / 2) + x
+    end
+
+    # Returns the row above the top by default.
+    #
+    # @example
+    #   `top` / `y` is 4.
+    #
+    #   north     # => 3
+    #   north(2)  # => 2
+    #   north(-4) # => 8
+    #
+    # @param offset [Fixnum]
+    # @return [Fixnum]
+    def north(offset = 1)
+      y - offset
+    end
+
+    # Returns the column after right by default.
+    #
+    # @example
+    #   `right` / `xn` is 19.
+    #
+    #   east     # => 20
+    #   east(2)  # => 21
+    #   east(-4) # => 15
+    #
+    # @param offset [Fixnum]
+    # @return [Fixnum]
+    def east(offset = 1)
+      xn + offset
+    end
+
+    # Returns the row below the bottom by default.
+    #
+    # @example
+    #   `bottom` / `yn` is 12.
+    #
+    #   south     # => 13
+    #   south(2)  # => 14
+    #   south(-4) # => 8
+    #
+    # @param offset [Fixnum]
+    # @return [Fixnum]
+    def south(offset = 1)
+      yn + offset
+    end
+
+    # Returns the column before left by default.
+    #
+    # @example
+    #   `left` / `x` is 8.
+    #
+    #   west      # => 7
+    #   west(2)   # => 6
+    #   west(-4)  # => 12
+    #
+    # @param offset [Fixnum]
+    # @return [Fixnum]
+    def west(offset = 1)
+      x - offset
+    end
+
+    private
+
+  end # Area
+
+end # Vedeu

data/lib/vedeu/geometry/canvas.rb

@@ -0,0 +1,79 @@
+require 'singleton'
+
+module Vedeu
+
+  # The size of the terminal is a limitation. Defining a canvas means we have
+  # more space to 'do stuff'.
+  #
+  class Canvas
+
+    include Singleton
+
+    # @return [Vedeu::Canvas]
+    def self.canvas
+      instance
+    end
+
+    # @param yn [Fixnum]
+    # @param xn [Fixnum]
+    # @return [Vedeu::Canvas]
+    def configure(yn, xn)
+      @yn = yn
+      @xn = xn
+
+      self
+    end
+
+    # @return [Array]
+    def c
+      [cy, cx]
+    end
+    alias_method :centre, :c
+
+    # @return [Fixnum]
+    def cy
+      ((yn - y) / 2) + y
+    end
+    alias_method :centre_y, :cy
+
+    # @return [Fixnum]
+    def cx
+      ((xn - x) / 2) + x
+    end
+    alias_method :centre_x, :cx
+
+    # @return [Fixnum]
+    def o
+      1
+    end
+    alias_method :origin, :o
+
+    # @return [Fixnum]
+    def y
+      1
+    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/centre.rb

@@ -0,0 +1,83 @@
+module Vedeu
+
+  # Return the centre character position for a value (width or height), or
+  # starting and ending coordinate.
+  #
+  # @example
+  #   Vedeu::Centre.for_value(27) # => 13
+  #
+  #   Vedeu::Centre.for_points(3, 17) # => 10
+  #
+  # @note
+  #   If initialized with a `:value` in the attributes, then :v and :vn are
+  #   ignored.
+  #
+  class Centre
+
+    # @param value [Fixnum] A width of height.
+    # @return [Fixnum]
+    def self.for_value(value)
+      new({ value: value }).centre
+    end
+
+    # @param v [Fixnum] The starting coordinate value.
+    # @param vn [Fixnum] The ending coordinate value.
+    # @return [Fixnum]
+    def self.for_points(v, vn)
+      new({ v: v, vn: vn }).centre
+    end
+
+    # @param attributes [Hash<Symbol => Fixnum>]
+    # @option attributes v [Fixnum] The starting coordinate value.
+    # @option attributes vn [Fixnum] The ending coordinate value.
+    # @option attributes value [Fixnum] A width of height.
+    # @return [Vedeu::Centre]
+    def initialize(attributes = {})
+      @v     = attributes[:v]
+      @vn    = attributes[:vn]
+      @value = attributes[:value]
+    end
+
+    # @raise [InvalidSyntax] When :v or :vn is missing, or :vn is less than :v.
+    # @return [Fixnum]
+    def centre
+      if value
+        value / 2
+
+      else
+        v + (v_vn / 2)
+
+      end
+    end
+
+    private
+
+    # @!attribute [r] v
+    # @return [Fixnum]
+    attr_reader :v
+
+    # @!attribute [r] vn
+    # @return [Fixnum]
+    attr_reader :vn
+
+    # @!attribute [r] value
+    # @return [Fixnum]
+    attr_reader :value
+
+    # @return [Fixnum]
+    def v_vn
+      if vn.nil? || v.nil?
+        fail InvalidSyntax, 'Missing values for :v, :vn.'
+
+      elsif vn < v
+        fail InvalidSyntax, "Values invalid for :v (#{v}), :vn (#{vn})."
+
+      else
+        vn - v
+
+      end
+    end
+
+  end # Centre
+
+end # Vedeu

data/lib/vedeu/geometry/{content_geometry.rb → content.rb}

@@ -2,7 +2,7 @@ module Vedeu
 
   # Provides information about the content within an interface or view.
   #
-  class ContentGeometry
+  class Content
 
     extend Forwardable
 
@@ -18,7 +18,7 @@ module Vedeu
       :y
 
     # @param interface [Vedeu::Interface]
-    # @return [Vedeu::ContentGeometry]
+    # @return [Vedeu::Content]
     def initialize(interface)
       @interface = interface
     end
@@ -63,6 +63,6 @@ module Vedeu
       lines.map { |line| line.size }.max
     end
 
-  end # ContentGeometry
+  end # Content
 
 end # Vedeu

data/lib/vedeu/geometry/dimension.rb

@@ -0,0 +1,81 @@
+module Vedeu
+
+  # A Dimension is either the height or width of an entity.
+  #
+  class Dimension
+
+    # @param (see #initialize)
+    # @return [Array<Fixnum>]
+    def self.pair(attributes = {})
+      new(attributes).pair
+    end
+
+    # @param attributes [Hash<Symbol => Fixnum, NilClass>]
+    # @option attributes d [Fixnum|NilClass] The starting value (y or x).
+    # @option attributes dn [Fixnum|NilClass] The ending value (yn or xn).
+    # @option attributes d_dn [Fixnum|NilClass] A width or a height.
+    # @option attributes default [Fixnum|NilClass] The terminal width or height.
+    # @return [Vedeu::Dimension]
+    def initialize(attributes = {})
+      @d       = attributes[:d]
+      @dn      = attributes[:dn]
+      @d_dn    = attributes[:d_dn]
+      @default = attributes[:default]
+    end
+
+    # @return [Fixnum]
+    def d1
+      dimension.first
+    end
+
+    # @return [Fixnum]
+    def d2
+      dimension.last
+    end
+
+    # @return [Array<Fixnum>]
+    def pair
+      dimension
+    end
+
+    private
+
+    # @return [Array<Fixnum>]
+    def dimension
+      @dimension ||= if @d && @dn
+        [@d, @dn]
+
+      elsif @d && @d_dn
+        [@d, (@d + @d_dn)]
+
+      elsif @d_dn
+        [1, @d_dn]
+
+      elsif @d
+        [@d, @default]
+
+      else
+        [1, @default]
+
+      end
+    end
+
+    # @!attribute [r] d
+    # @return [Fixnum]
+    attr_reader :d
+
+    # @!attribute [r] dn
+    # @return [Fixnum]
+    attr_reader :dn
+
+    # @!attribute [r] d_dn
+    # @return [Fixnum]
+    attr_reader :d_dn
+
+    # @!attribute [r] default
+    # @return [Fixnum]
+    attr_reader :default
+
+  end # Dimension
+
+end # Vedeu

data/lib/vedeu/{models → geometry}/geometry.rb

@@ -29,6 +29,7 @@ module Vedeu
   #
   class Geometry
 
+    extend Forwardable
     include Vedeu::Model
 
     # @!attribute [rw] centred
@@ -59,6 +60,14 @@ module Vedeu
     # @return [Fixnum]
     attr_writer :y
 
+    # @!attribute [w] xn
+    # @return [Fixnum]
+    attr_writer :xn
+
+    # @!attribute [w] yn
+    # @return [Fixnum]
+    attr_writer :yn
+
     # Returns a new instance of Geometry.
     #
     # @param attributes [Hash]
@@ -266,8 +275,31 @@ module Vedeu
       right + value
     end
 
+    # def_delegators :area, :north, :east, :south, :west
+
     private
 
+    # @return [Vedeu::Area]
+    def area
+      @area ||= Vedeu::Area.from_dimensions(y_yn, x_xn)
+    end
+
+    # @return [Array<Fixnum>]
+    def x_xn
+      @x_xn ||= Vedeu::Dimension.pair({ v:       @x,
+                                        vn:      @xn,
+                                        v_vn:    @width,
+                                        default: Vedeu::Terminal.width })
+    end
+
+    # @return [Array<Fixnum>]
+    def y_yn
+      @y_yn ||= Vedeu::Dimension.pair({ v:       @y,
+                                        vn:      @yn,
+                                        v_vn:    @height,
+                                        default: Vedeu::Terminal.height })
+    end
+
     # The default values for a new instance of this class.
     #
     # @return [Hash]

data/lib/vedeu/geometry/grid.rb

@@ -26,8 +26,7 @@ module Vedeu
   #
   class Grid
 
-    # @param value [Fixnum]
-    # @return [Fixnum]
+    # @see (#initialize)
     def self.columns(value)
       new(value).columns
     end

data/lib/vedeu/geometry/index_position.rb

@@ -7,11 +7,8 @@ module Vedeu
   #
   class IndexPosition
 
-    # @param iy [Fixnum]
-    # @param ix [Fixnum]
-    # @param oy [Fixnum]
-    # @param ox [Fixnum]
-    # @return [Array]
+    # @param (see #initialize)
+    # @return [Vedeu::Position]
     def self.[](iy, ix, oy = 1, ox = 1)
       new(iy, ix, oy, ox).[]
     end
@@ -28,13 +25,8 @@ module Vedeu
       @ox = ox
     end
 
-    # @return [Array]
-    def []
-      [y, x]
-    end
-
     # @return [Vedeu::Position]
-    def to_position
+    def []
       Vedeu::Position.new(y, x)
     end
 

data/lib/vedeu/geometry/limit.rb

@@ -4,7 +4,7 @@ module Vedeu
   #
   class Limit
 
-    # @see #new, #apply
+    # @param (see #initialize)
     def self.apply(v, vn, max, min = 1)
       new(v, vn, max, min).apply
     end

data/lib/vedeu/geometry/position.rb

@@ -15,6 +15,11 @@ module Vedeu
     alias_method :first, :y
     alias_method :last, :x
 
+    # @param (see #initialize)
+    def self.[](y, x)
+      new(y, x)
+    end
+
     # @param value [Array<Fixnum>|Vedeu::Position]
     # @return [void]
     def self.coerce(value)

data/lib/vedeu/geometry/position_index.rb

@@ -15,9 +15,7 @@ module Vedeu
     alias_method :first, :y
     alias_method :last, :x
 
-    # @param y [Fixnum]
-    # @param x [Fixnum]
-    # @return [Array]
+    # @param (see #initialize)
     def self.[](y, x)
       new(y, x).[]
     end
@@ -26,8 +24,8 @@ module Vedeu
     # @param x [Fixnum]
     # @return [Vedeu::PositionIndex]
     def initialize(y, x)
-      @y = ((y - 1) <= 1) ? 1 : (y - 1)
-      @x = ((x - 1) <= 1) ? 1 : (x - 1)
+      @y = ((y - 1) <= 1) ? 0 : (y - 1)
+      @x = ((x - 1) <= 1) ? 0 : (x - 1)
     end
 
     # @return [Array]

data/lib/vedeu/geometry/position_validator.rb

@@ -40,10 +40,7 @@ module Vedeu
     # @return [Fixnum]
     attr_accessor :y
 
-    # @param interface [Interface]
-    # @param x [Fixnum]
-    # @param y [Fixnum]
-    # @return [PositionValidator]
+    # @param (see #initialize)
     def self.validate(interface, x, y)
       new(interface, x, y).validate
     end

data/lib/vedeu/input/input.rb

@@ -7,8 +7,7 @@ module Vedeu
 
     # Instantiate Input and capture keypress(es).
     #
-    # @param reader [IO] An object that responds to `#read`. Typically, this is
-    #   Vedeu::Terminal.
+    # @param (see #initialize)
     # @return [String|Symbol]
     def self.capture(reader)
       new(reader).capture

data/lib/vedeu/input/mapper.rb

@@ -8,8 +8,7 @@ module Vedeu
     # the associated action is fired, if not, we move to the next keymap or
     # return false.
     #
-    # @param key [NilClass|String|Symbol]
-    # @param name [NilClass|String]
+    # @param (see #initialize)
     # @return [Boolean]
     def self.keypress(key = nil, name = nil)
       return false unless key
@@ -20,8 +19,7 @@ module Vedeu
     # Checks a key is valid; i.e. not already registered to a keymap. If the
     # key is registered, then the key is invalid and cannot be used again.
     #
-    # @param key [NilClass|String|Symbol]
-    # @param name [NilClass|String]
+    # @param (see #initialize)
     # @return [Boolean]
     def self.valid?(key = nil, name = nil)
       return false unless key

data/lib/vedeu/launcher.rb

@@ -14,7 +14,7 @@ module Vedeu
     #   error occurred (1).
     attr_reader :exit_code
 
-    # @see Vedeu::Launcher#initialize
+    # @param (see #initialize)
     def self.execute!(argv = [],
                       stdin  = STDIN,
                       stdout = STDOUT,

data/lib/vedeu/main_loop.rb

@@ -12,6 +12,7 @@ module Vedeu
     trap('TERM')    { stop! }
     trap('INT')     { stop! }
 
+    # :nocov:
     # Start the main loop.
     #
     # @param block [Proc]
@@ -30,6 +31,7 @@ module Vedeu
     rescue VedeuInterrupt
 
     end
+    # :nocov:
 
     # Signal that we wish to terminate the running application.
     #

data/lib/vedeu/models/all.rb

@@ -1,5 +1,6 @@
 require 'vedeu/repositories/all'
 
+require 'vedeu/models/cell'
 require 'vedeu/models/char'
 require 'vedeu/models/stream'
 require 'vedeu/models/line'
@@ -7,7 +8,6 @@ require 'vedeu/models/interface'
 require 'vedeu/models/composition'
 
 require 'vedeu/models/focus'
-require 'vedeu/models/geometry'
 require 'vedeu/models/group'
 require 'vedeu/models/menu'