vedeu 0.6.56 → 0.6.57

data/lib/vedeu/colours/repository.rb

@@ -50,21 +50,6 @@ module Vedeu
         storage.fetch(colour, '')
       end
 
-      # Retrieves the escape sequence of a registered colour, or
-      # registers the colour with its respective escape sequence.
-      #
-      # @return [String]
-      # @todo Unused - GL 2015-09-26
-      def retrieve_or_register(colour, escape_sequence)
-        if registered?(colour)
-          retrieve(colour)
-
-        else
-          register(colour, escape_sequence)
-
-        end
-      end
-
     end # Repository
 
   end # Colours

data/lib/vedeu/cursors/cursor.rb

@@ -13,7 +13,7 @@ module Vedeu
       include Vedeu::Toggleable
       extend Forwardable
 
-      def_delegators :border,
+      def_delegators :geometry,
                      :bx,
                      :bxn,
                      :by,
@@ -47,7 +47,7 @@ module Vedeu
 
       # Returns a new instance of Vedeu::Cursors::Cursor.
       #
-      # @params attributes [Hash<Symbol => Boolean|Fixnum|String|
+      # @param attributes [Hash<Symbol => Boolean|Fixnum|String|
       #   Vedeu::Cursors::Repository>]
       # @option attributes name [String|Symbol] The name of the
       #   interface this cursor belongs to.
@@ -253,11 +253,11 @@ module Vedeu
 
       private
 
-      # Returns the border for the interface.
+      # Returns the geometry for the interface.
       #
-      # @return (see Vedeu::Borders::Repository#by_name)
-      def border
-        @border ||= Vedeu.borders.by_name(name)
+      # @return (see Vedeu::Geometry::Repository#by_name)
+      def geometry
+        @geometry ||= Vedeu.geometries.by_name(name)
       end
 
       # Determine correct x and y related coordinates.

data/lib/vedeu/cursors/refresh.rb

@@ -13,9 +13,9 @@ module Vedeu
       extend Forwardable
       include Vedeu::Common
 
-      def_delegators :border,
-                     :height,
-                     :width
+      def_delegators :geometry,
+                     :bordered_height,
+                     :bordered_width
 
       # @example
       #   Vedeu.trigger(:_refresh_cursor_, name)
@@ -61,11 +61,13 @@ module Vedeu
 
       # Returns true when the view should be refreshed. This is
       # determined by checking that the offsets for x and y are
-      # outside the width and height of the named interface.
+      # outside the (bordered) width and (bordered) height of the
+      # named interface.
       #
       # @return [Boolean]
       def refresh_view?
-        cursor.visible? && cursor.ox >= width || cursor.oy >= height
+        cursor.visible? && (cursor.ox >= bordered_width ||
+                            cursor.oy >= bordered_height)
       end
 
       # @return [Vedeu::Cursors::Cursor]
@@ -74,21 +76,11 @@ module Vedeu
         @cursor ||= Vedeu.cursors.by_name(name)
       end
 
-      # Fetch the border by name.
+      # Fetch the geometry by name.
       #
-      # @note
-      #   {Vedeu::Borders::Border} is used in this way because when
-      #   there is not a border defined, it will fallback to a
-      #   {Vedeu::Borders::Null} which uses
-      #   {Vedeu::Geometry::Geometry} to determine it's dimensions
-      #   based on the name also. When a {Vedeu::Geometry::Geometry}
-      #   cannot be found, this falls back to a
-      #   {Vedeu::Geometry::Null} which uses the dimensions of the
-      #   current terminal.
-      #
-      # @return (see Vedeu::Borders::Repository#by_name)
-      def border
-        @border ||= Vedeu.borders.by_name(name)
+      # @return (see Vedeu::Geometry::Repository#by_name)
+      def geometry
+        @geometry ||= Vedeu.geometries.by_name(name)
       end
 
     end # Refresh

data/lib/vedeu/cursors/reposition.rb

@@ -27,11 +27,9 @@ module Vedeu
 
       # @return [Vedeu::Cursors::Cursor]
       def reposition
-        cursor = Vedeu::Cursors::Cursor.store(new_attributes)
-
-        Vedeu.trigger(:_refresh_cursor_, name)
-
-        cursor
+        Vedeu::Cursors::Cursor.store(new_attributes) do
+          Vedeu.trigger(:_refresh_cursor_, name)
+        end
       end
 
       protected

data/lib/vedeu/editor/cropper.rb

@@ -12,13 +12,13 @@ module Vedeu
       extend Forwardable
       include Vedeu::Common
 
-      def_delegators :border,
+      def_delegators :geometry,
+                     :bordered_height,
+                     :bordered_width,
                      :bx,
                      :bxn,
                      :by,
-                     :byn,
-                     :height,
-                     :width
+                     :byn
 
       # Returns a new instance of Vedeu::Editor::Cropper.
       #
@@ -87,7 +87,7 @@ module Vedeu
       #
       # @return [Vedeu::Editor::Lines]
       def lines
-        @lines[oy...(oy + height)] || []
+        @lines[oy...(oy + bordered_height)] || []
       end
 
       # Returns the interface by name.
@@ -101,14 +101,14 @@ module Vedeu
       #
       # @return [String]
       def columns(line)
-        line[ox...(ox + width)] || ''
+        line[ox...(ox + bordered_width)] || ''
       end
 
       # Returns the border for the interface.
       #
-      # @return (see Vedeu::Borders::Repository#by_name)
-      def border
-        @border ||= Vedeu.borders.by_name(name)
+      # @return (see Vedeu::Geometry::Repository#by_name)
+      def geometry
+        @geometry ||= Vedeu.geometries.by_name(name)
       end
 
     end # Editor

data/lib/vedeu/editor/cursor.rb

@@ -11,7 +11,7 @@ module Vedeu
 
       extend Forwardable
 
-      def_delegators :border,
+      def_delegators :geometry,
                      :bx,
                      :bxn,
                      :by,
@@ -162,11 +162,11 @@ module Vedeu
 
       private
 
-      # Returns the border for the interface.
+      # Returns the geometry for the interface.
       #
-      # @return (see Vedeu::Borders::Repository#by_name)
-      def border
-        @border ||= Vedeu.borders.by_name(name)
+      # @return (see Vedeu::Geometry::Repository#by_name)
+      def geometry
+        @border ||= Vedeu.geometries.by_name(name)
       end
 
       # Returns the default options/attributes for this class.

data/lib/vedeu/editor/editor.rb

@@ -71,7 +71,7 @@ module Vedeu
       attr_reader :input
 
       # @!attribute [r] name
-      # @return [String]
+      # @return [String|Symbol]
       attr_reader :name
 
       private

data/lib/vedeu/events/event.rb

@@ -180,7 +180,7 @@ module Vedeu
       attr_reader :closure
 
       # @!attribute [r] name
-      # @return [String]
+      # @return [String|Symbol]
       attr_reader :name
 
       private

data/lib/vedeu/events/trigger.rb

@@ -49,7 +49,7 @@ module Vedeu
       protected
 
       # @!attribute [r] name
-      # @return [Symbol]
+      # @return [Symbol|String]
       attr_reader :name
 
       # @!attribute [r] args

data/lib/vedeu/geometry/area.rb

@@ -8,6 +8,15 @@ module Vedeu
     #
     class Area
 
+      extend Forwardable
+
+      def_delegators :border,
+                     :bottom?,
+                     :enabled?,
+                     :left?,
+                     :right?,
+                     :top?
+
       # @!attribute [r] y
       # @return [Fixnum] Returns the top coordinate (row/line start
       #   position) of the interface.
@@ -33,51 +42,58 @@ module Vedeu
       alias_method :right, :xn
 
       # @param attributes [Hash<Symbol => Boolean|Fixnum|Symbol>]
-      # @option attributes y [Fixnum]
-      # @option attributes yn [Fixnum]
-      # @option attributes y_yn [Fixnum]
-      # @option attributes y_default [Fixnum]
+      # @option attributes horizontal_alignment [Symbol]
+      # @option attributes maximised [Boolean]
+      # @option attributes name [String|Symbol]
+      # @option attributes vertical_alignment [Symbol]
       # @option attributes x [Fixnum]
       # @option attributes xn [Fixnum]
       # @option attributes x_xn [Fixnum]
       # @option attributes x_default [Fixnum]
-      # @option attributes maximised [Boolean]
-      # @option attributes horizontal_alignment [Symbol]
-      # @option attributes vertical_alignment [Symbol]
+      # @option attributes y [Fixnum]
+      # @option attributes yn [Fixnum]
+      # @option attributes y_yn [Fixnum]
+      # @option attributes y_default [Fixnum]
       # @return [Vedeu::Geometry::Area]
       def self.from_attributes(attributes = {})
         y_attributes = {
+          alignment: attributes[:vertical_alignment],
           d:         attributes[:y],
           dn:        attributes[:yn],
           d_dn:      attributes[:y_yn],
           maximised: attributes[:maximised],
-          alignment: attributes[:vertical_alignment],
         }
         x_attributes = {
+          alignment: attributes[:horizontal_alignment],
           d:         attributes[:x],
           dn:        attributes[:xn],
           d_dn:      attributes[:x_xn],
           maximised: attributes[:maximised],
-          alignment: attributes[:horizontal_alignment],
         }
         y_yn = Vedeu::Geometry::YDimension.pair(y_attributes)
         x_xn = Vedeu::Geometry::XDimension.pair(x_attributes)
 
-        new(y: y_yn[0], yn: y_yn[-1], x: x_xn[0], xn: x_xn[-1])
+        new(name: attributes[:name],
+            y:    y_yn[0],
+            yn:   y_yn[-1],
+            x:    x_xn[0],
+            xn:   x_xn[-1])
       end
 
       # Returns a new instance of Vedeu::Area.
       #
+      # @param name [Symbol|String]
       # @param y [Fixnum] The starting row/line position.
       # @param yn [Fixnum] The ending row/line position.
       # @param x [Fixnum] The starting column/character position.
       # @param xn [Fixnum] The ending column/character position.
       # @return [Vedeu::Geometry::Area]
-      def initialize(y:, yn:, x:, xn:)
-        @y  = y
-        @yn = yn
-        @x  = x
-        @xn = xn
+      def initialize(name:, y:, yn:, x:, xn:)
+        @name = name
+        @y    = y
+        @yn   = yn
+        @x    = x
+        @xn   = xn
       end
 
       # An object is equal when its values are the same.
@@ -90,6 +106,54 @@ module Vedeu
       end
       alias_method :==, :eql?
 
+      # Returns the width of the interface determined by whether a
+      # left, right, both or neither borders are shown.
+      #
+      # @return [Fixnum]
+      def bordered_width
+        (bxn - bx) + 1
+      end
+
+      # Returns the height of the interface determined by whether a
+      # top, bottom, both or neither borders are shown.
+      #
+      # @return [Fixnum]
+      def bordered_height
+        (byn - by) + 1
+      end
+
+      # Return the column position for 1 character right of the left
+      #   border.
+      #
+      # @return [Fixnum]
+      def bx
+        (enabled? && left?) ? x + 1 : x
+      end
+
+      # Return the column position for 1 character left of the right
+      #   border.
+      #
+      # @return [Fixnum]
+      def bxn
+        (enabled? && right?) ? xn - 1 : xn
+      end
+
+      # Return the row position for 1 character under of the top
+      #   border.
+      #
+      # @return [Fixnum]
+      def by
+        (enabled? && top?) ? y + 1 : y
+      end
+
+      # Return the column position for 1 character above of the bottom
+      #   border.
+      #
+      # @return [Fixnum]
+      def byn
+        (enabled? && bottom?) ? yn - 1 : yn
+      end
+
       # Returns an array containing the centred y and x coordinates of
       # the interface.
       #
@@ -118,14 +182,14 @@ module Vedeu
       #
       # @return [Fixnum]
       def height
-        (y..yn).size
+        (yn - y) + 1
       end
 
       # Returns the width of the interface.
       #
       # @return [Fixnum]
       def width
-        (x..xn).size
+        (xn - x) + 1
       end
 
       # Returns the row above the top by default.
@@ -188,6 +252,19 @@ module Vedeu
         x - offset
       end
 
+      protected
+
+      # @!attribute [r] name
+      # @return [String|Symbol]
+      attr_reader :name
+
+      private
+
+      # @return [Vedeu::Borders::Border]
+      def border
+        @border = Vedeu.borders.by_name(name)
+      end
+
     end # Area
 
   end # Geometry

data/lib/vedeu/geometry/coordinate.rb

@@ -69,7 +69,7 @@ module Vedeu
       protected
 
       # @!attribute [r] name
-      # @return [String]
+      # @return [String|Symbol]
       attr_reader :name
 
       # @!attribute [r] offset
@@ -82,39 +82,39 @@ module Vedeu
 
       private
 
-      # Returns the border for the interface.
+      # Returns the geometry for the interface.
       #
-      # @return (see Vedeu::Borders::Repository#by_name)
-      def border
-        @border ||= Vedeu.borders.by_name(name)
+      # @return (see Vedeu::Geometry::Repository#by_name)
+      def geometry
+        @geometry ||= Vedeu.geometries.by_name(name)
       end
 
-      # Return the :x or :y value from the border.
+      # Return the :x or :y value from the geometry.
       #
       # @return [Fixnum]
       def d
-        border.send(coordinate_type[0])
+        geometry.send(coordinate_type[0])
       end
 
-      # Return the :bx or :by value from the border.
+      # Return the :bx or :by value from the geometry.
       #
       # @return [Fixnum]
       def bd
-        border.send(coordinate_type[1])
+        geometry.send(coordinate_type[1])
       end
 
-      # Return the :bxn or :byn value from the border.
+      # Return the :bxn or :byn value from the geometry.
       #
       # @return [Fixnum]
       def bdn
-        border.send(coordinate_type[2])
+        geometry.send(coordinate_type[2])
       end
 
-      # Return the :width or :height value from the border.
+      # Return the :width or :height value from the geometry.
       #
       # @return [Fixnum]
       def d_dn
-        border.send(coordinate_type[3])
+        geometry.send(coordinate_type[3])
       end
 
       # Ascertain the correct methods to use for determining the
@@ -125,8 +125,8 @@ module Vedeu
       # @return [Fixnum]
       def coordinate_type
         @_type ||= case type
-                   when :x then [:x, :bx, :bxn, :width]
-                   when :y then [:y, :by, :byn, :height]
+                   when :x then [:x, :bx, :bxn, :bordered_width]
+                   when :y then [:y, :by, :byn, :bordered_height]
                    else
                      fail Vedeu::Error::InvalidSyntax,
                           'Coordinate type not given, cannot continue.'.freeze