vedeu 0.6.71 → 0.7.0

data/lib/vedeu/borders/set_attribute.rb

@@ -12,9 +12,7 @@ module Vedeu
 
       include Vedeu::Common
 
-      # @param name [String|Symbol]
-      # @param attribute [Symbol]
-      # @param value [String]
+      # @param (see #initialize)
       # @return [Vedeu::Borders::Border]
       def self.update(name, attribute, value)
         new(name, attribute, value).update

data/lib/vedeu/borders/title.rb

@@ -6,33 +6,38 @@ module Vedeu
     # title is longer than the interface is wide, and pad with a space
     # either side.
     #
+    # The title is displayed within the top border of the interface/
+    # view.
+    #
     # @api private
     #
     class Title
 
-      # @param chars [Array<Vedeu::Views::Char>]
-      # @param value [String|Vedeu::Borders::Title|
-      #   Vedeu::Borders::Caption]
-      # @return [Array<Vedeu::Views::Char>]
-      def self.render(value = '', chars = [])
-        new(value, chars).render
+      include Vedeu::Common
+
+      # @param (see #initialize)
+      # @return (see #render)
+      def self.render(name, value = '', horizontal = [])
+        new(name, value, horizontal).render
       end
 
       # Returns a new instance of Vedeu::Borders::Title or
       # Vedeu::Borders::Caption.
       #
-      # @param chars [Array<Vedeu::Views::Char>]
+      # @param name [String|Symbol]
       # @param value [String|Vedeu::Borders::Title|
+      # @param horizontal [Array<Vedeu::Cells::Horizontal>]
       #   Vedeu::Borders::Caption]
       # @return [Vedeu::Borders::Title|Vedeu::Borders::Caption]
-      def initialize(value = '', chars = [])
-        @value = value
-        @chars = chars
+      def initialize(name, value = '', horizontal = [])
+        @name       = name
+        @value      = value
+        @horizontal = horizontal
       end
 
       # An object is equal when its values are the same.
       #
-      # @param other [Vedeu::Borders::Title]
+      # @param other [Vedeu::Borders::Title|Vedeu::Borders::Caption]
       # @return [Boolean]
       def eql?(other)
         self.class == other.class && value == other.value
@@ -43,16 +48,13 @@ module Vedeu
       # {Vedeu::Borders::Border#build_horizontal} on the top border to
       # include the title if given.
       #
-      # @return [Array<Vedeu::Views::Char>]
+      # @return [Array<Vedeu::Cells::Horizontal|Vedeu::Cells::Char>]
       def render
-        return chars if empty?
+        return horizontal if empty?
 
-        chars.each_with_index do |char, index|
-          next if index == start_index || index > size
+        horizontal[start_index..(start_index + (size - 1))] = chars
 
-          char.border = nil
-          char.value  = characters[index - 1]
-        end
+        horizontal
       end
 
       # Convert the value to a string.
@@ -74,13 +76,39 @@ module Vedeu
 
       protected
 
-      # @!attribute [r] chars
-      # @return [Array<Vedeu::Views::Char>] An array of border
+      # @!attribute [r] horizontal
+      # @return [Array<Vedeu::Cells::Horizontal>] An array of border
       #   characters.
-      attr_reader :chars
+      attr_reader :horizontal
+
+      # @!attribute [r] name
+      # @return [String|Symbol]
+      attr_reader :name
 
       private
 
+      # @param char [String]
+      # @param x [Fixnum]
+      # @return [Hash<Symbol => void>]
+      def attributes(char, x)
+        @_attributes ||= border.attributes
+
+        @_attributes.merge!(position: Vedeu::Geometries::Position.new(y, x),
+                            value:    char)
+      end
+
+      # @return [Vedeu::Borders::Border]
+      def border
+        @_border ||= Vedeu.borders.by_name(name)
+      end
+
+      # @return [Array<Vedeu::Cells::Horizontal|Vedeu::Cells::Char>]
+      def chars
+        characters.each_with_index.map do |char, index|
+          Vedeu::Cells::Char.new(attributes(char, x + index))
+        end
+      end
+
       # Return the padded, truncated value as an Array of String.
       #
       # @return [Array<String>]
@@ -95,6 +123,11 @@ module Vedeu
         value.empty?
       end
 
+      # @return [Vedeu::Geometries::Geometry]
+      def geometry
+        @_geometry ||= Vedeu.geometries.by_name(name)
+      end
+
       # Pads the value with a single whitespace either side.
       #
       # @example
@@ -120,7 +153,7 @@ module Vedeu
 
       # @return [Fixnum]
       def start_index
-        0
+        1
       end
 
       # Truncates the value to the width of the interface, minus
@@ -138,14 +171,24 @@ module Vedeu
       #
       # @return [String]
       def truncate
-        title.chomp.slice(0...(width - 4))
+        @_truncate ||= value.chomp.slice(0...(width - 4))
       end
 
-      # Return the size of the horizontal border given via #chars.
+      # Return the size of the horizontal border given.
       #
       # @return [Fixnum]
       def width
-        chars.size
+        horizontal.size
+      end
+
+      # @return [Fixnum]
+      def x
+        @_x ||= geometry.bx + start_index
+      end
+
+      # @return [Fixnum]
+      def y
+        @_y ||= geometry.y
       end
 
     end # Title

data/lib/vedeu/cells/all.rb

@@ -0,0 +1,23 @@
+module Vedeu
+
+  # Each available character space in the visible terminal is
+  # represented in Vedeu as a cell of some type. Each type of cell
+  # has specific behaviour when handled (including being rendered) by
+  # Vedeu.
+  #
+  # @api private
+  #
+  module Cells
+
+  end # Cells
+
+end # Vedeu
+
+require 'vedeu/cells/empty'
+require 'vedeu/cells/border'
+require 'vedeu/cells/borders/all'
+require 'vedeu/cells/char'
+require 'vedeu/cells/clear'
+require 'vedeu/cells/escape'
+require 'vedeu/cells/html'
+require 'vedeu/cells/json'

data/lib/vedeu/cells/border.rb

@@ -0,0 +1,72 @@
+module Vedeu
+
+  module Cells
+
+    # Provides the character/escape sequence to draw one cell of a
+    # border with a custom value, colour and style.
+    #
+    # @api private
+    #
+    class Border < Vedeu::Cells::Empty
+
+      extend Forwardable
+      include Vedeu::Presentation
+
+      def_delegators :geometry,
+                     :x,
+                     :xn,
+                     :y,
+                     :yn
+
+      # @return [Hash<Symbol => void>]
+      def attributes
+        {
+          colour: colour,
+          name:   @name,
+          style:  style,
+        }
+      end
+
+      # @return [Boolean]
+      def cell?
+        false
+      end
+
+      # @param value [String|Symbol]
+      # @return [Vedeu::Cells::Border]
+      def name=(value)
+        @name = value
+
+        self
+      end
+
+      # @return [Vedeu::Borders::Border|Vedeu::Interfaces::Interface]
+      def named_parent
+        if border
+          border
+
+        elsif interface
+          interface
+
+        end
+      end
+
+      # @return [String]
+      def value
+        return '' unless present?(@value)
+
+        Vedeu::EscapeSequences::Esc.border { @value }
+      end
+
+      private
+
+      # @return [Hash<Symbol => Hash<void>>]
+      def defaults
+        super
+      end
+
+    end # Border
+
+  end # Cells
+
+end # Vedeu

data/lib/vedeu/cells/borders/all.rb

@@ -0,0 +1,18 @@
+module Vedeu
+
+  module Cells
+
+  end # Cells
+
+end # Vedeu
+
+require 'vedeu/cells/borders/horizontal'
+require 'vedeu/cells/borders/bottom_horizontal'
+require 'vedeu/cells/borders/bottom_left'
+require 'vedeu/cells/borders/bottom_right'
+require 'vedeu/cells/borders/top_horizontal'
+require 'vedeu/cells/borders/top_left'
+require 'vedeu/cells/borders/top_right'
+require 'vedeu/cells/borders/vertical'
+require 'vedeu/cells/borders/left_vertical'
+require 'vedeu/cells/borders/right_vertical'

data/lib/vedeu/cells/borders/bottom_horizontal.rb

@@ -0,0 +1,28 @@
+module Vedeu
+
+  module Cells
+
+    # Provides the character/escape sequence to draw one cell of the
+    # bottom horizontal border with a custom value, colour and style.
+    #
+    # @api private
+    #
+    class BottomHorizontal < Vedeu::Cells::Horizontal
+
+      # @return [Symbol]
+      def type
+        :bottom_horizontal
+      end
+
+      private
+
+      # @return [Hash<Symbol => String>]
+      def defaults
+        super.merge!(value: Vedeu::EscapeSequences::Borders.horizontal)
+      end
+
+    end # BottomHorizontal
+
+  end # Cells
+
+end # Vedeu

data/lib/vedeu/cells/borders/bottom_left.rb

@@ -0,0 +1,34 @@
+module Vedeu
+
+  module Cells
+
+    # Provides the character/escape sequence to draw the bottom left
+    # border with a custom value, colour and style.
+    #
+    # @api private
+    #
+    class BottomLeft < Vedeu::Cells::Border
+
+      # @return [Vedeu::Geometries::Position]
+      def position
+        @position = defaults[:position]
+      end
+
+      # @return [Symbol]
+      def type
+        :bottom_left
+      end
+
+      private
+
+      # @return [Hash<Symbol => String>]
+      def defaults
+        super.merge!(position: Vedeu::Geometries::Position.coerce([yn, x]),
+                     value:    Vedeu::EscapeSequences::Borders.bottom_left)
+      end
+
+    end # BottomLeft
+
+  end # Cells
+
+end # Vedeu

data/lib/vedeu/cells/borders/bottom_right.rb

@@ -0,0 +1,34 @@
+module Vedeu
+
+  module Cells
+
+    # Provides the character/escape sequence to draw the bottom right
+    # border with a custom value, colour and style.
+    #
+    # @api private
+    #
+    class BottomRight < Vedeu::Cells::Border
+
+      # @return [Vedeu::Geometries::Position]
+      def position
+        @position = defaults[:position]
+      end
+
+      # @return [Symbol]
+      def type
+        :bottom_right
+      end
+
+      private
+
+      # @return [Hash<Symbol => String>]
+      def defaults
+        super.merge!(position: Vedeu::Geometries::Position.coerce([yn, xn]),
+                     value:    Vedeu::EscapeSequences::Borders.bottom_right)
+      end
+
+    end # BottomRight
+
+  end # Cells
+
+end # Vedeu

data/lib/vedeu/cells/borders/horizontal.rb

@@ -0,0 +1,28 @@
+module Vedeu
+
+  module Cells
+
+    # Provides the character/escape sequence to draw one cell of a
+    # horizontal border with a custom value, colour and style.
+    #
+    # @api private
+    #
+    class Horizontal < Vedeu::Cells::Border
+
+      # @return [Symbol]
+      def type
+        :horizontal
+      end
+
+      private
+
+      # @return [Hash<Symbol => String>]
+      def defaults
+        super.merge!(value: Vedeu::EscapeSequences::Borders.horizontal)
+      end
+
+    end # Horizontal
+
+  end # Cells
+
+end # Vedeu

data/lib/vedeu/cells/borders/left_vertical.rb

@@ -0,0 +1,28 @@
+module Vedeu
+
+  module Cells
+
+    # Provides the character/escape sequence to draw one cell of the
+    # left vertical border with a custom value, colour and style.
+    #
+    # @api private
+    #
+    class LeftVertical < Vedeu::Cells::Vertical
+
+      # @return [Symbol]
+      def type
+        :left_vertical
+      end
+
+      private
+
+      # @return [Hash<Symbol => String>]
+      def defaults
+        super.merge!(value: Vedeu::EscapeSequences::Borders.vertical)
+      end
+
+    end # LeftVertical
+
+  end # Cells
+
+end # Vedeu