vedeu 0.6.71 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e6f85cb55a50d53c490a1a1f8f0bb3adbf38035d
-  data.tar.gz: 98154c75cbe858bb6ec6810f8a9887ebca55ffbb
+  metadata.gz: 3bb700b808027ae0199e3f275aa59204c356e2c4
+  data.tar.gz: 269a2f124899846454acefe97fe50a95dc28ef8d
 SHA512:
-  metadata.gz: 23e2508ccb6cac4af70ef49caa6cd8be4c13cb71233f3b121a78979fbda7956a4e0efa79c7b518558bb3054d11a6cb9c69b6bfe263afa4bdd1a9ed9941b9e5ce
-  data.tar.gz: ee5c80b253f55995582811f1f579ce8c2a408be5adb5ec699d1ddd87ae36f3a13dce1c4a4616a3831a1336758b0cf69555b8274fde96a2ca5d4ab6f0e36d4a3b
+  metadata.gz: 79c2059ccd86e0afdf0b4998bb4528ff5a9d0cdf9266583db8b8ae976f7a04c2079e3f362cf503f42e6193f32cbcd95a96edefe47ed9bb5f4fd051b76ad7bf8a
+  data.tar.gz: fc2a6a223a6e9a8b098d02b0c74f08d07d56a3ee0cef6870229ba87f1756d7075e393cd3eb8a409159afc3b8249ce64a1c298e997458000097a385cd033c40e1

data/docs/api.md

@@ -175,7 +175,7 @@ Repository method. Access registered background colours.
 
 ### Vedeu.border
 
-@todo Add more documentation.
+See {Vedeu::Borders::DSL.border}
 
 ### Vedeu.borders
 

data/lib/vedeu/all.rb

@@ -16,6 +16,7 @@ require 'vedeu/renderers/all'
 require 'vedeu/esc/all'
 require 'vedeu/null/all'
 require 'vedeu/views/all'
+require 'vedeu/cells/all'
 require 'vedeu/models/all'
 require 'vedeu/application/all'
 require 'vedeu/cursors/all'

data/lib/vedeu/borders/border.rb

@@ -21,16 +21,6 @@ module Vedeu
       include Vedeu::Repositories::Model
       include Vedeu::Presentation
 
-      def_delegators :geometry,
-                     :bx,
-                     :bxn,
-                     :by,
-                     :byn,
-                     :x,
-                     :xn,
-                     :y,
-                     :yn
-
       # @!attribute [rw] bottom_left
       # @return [String] The character to be used for the bottom left
       #   border if enabled.
@@ -41,6 +31,11 @@ module Vedeu
       #   border if enabled.
       attr_accessor :bottom_right
 
+      # @!attribute [rw] bottom_horizontal
+      # @return [String] The character to be used for the bottom
+      #   horizontal border if enabled.
+      attr_accessor :bottom_horizontal
+
       # @!attribute [rw] caption
       # @return [String] An optional caption for when the bottom
       #   border is to be shown.
@@ -90,11 +85,26 @@ module Vedeu
       #   border if enabled.
       attr_accessor :top_right
 
+      # @!attribute [rw] top_horizontal
+      # @return [String] The character to be used for the top
+      #   horizontal border if enabled.
+      attr_accessor :top_horizontal
+
       # @!attribute [rw] vertical
       # @return [String] The character to be used for the vertical
       #   side border.
       attr_accessor :vertical
 
+      # @!attribute [rw] left_vertical
+      # @return [String] The character to be used for the left
+      #   vertical side border.
+      attr_accessor :left_vertical
+
+      # @!attribute [rw] right_vertical
+      # @return [String] The character to be used for the right
+      #   vertical side border.
+      attr_accessor :right_vertical
+
       # @!attribute [r] name
       # @return [String|Symbol] Associates the border with the
       #   same-named interface/view.
@@ -157,25 +167,29 @@ module Vedeu
       #   Vedeu::Borders::Repository|Vedeu::Presentation::Style>]
       def attributes
         {
-          bottom_left:  @bottom_left,
-          bottom_right: @bottom_right,
-          caption:      @caption,
-          client:       @client,
-          colour:       @colour,
-          enabled:      @enabled,
-          horizontal:   @horizontal,
-          name:         @name,
-          parent:       @parent,
-          repository:   @repository,
-          show_bottom:  @show_bottom,
-          show_left:    @show_left,
-          show_right:   @show_right,
-          show_top:     @show_top,
-          style:        @style,
-          title:        @title,
-          top_left:     @top_left,
-          top_right:    @top_right,
-          vertical:     @vertical,
+          bottom_horizontal: @bottom_horizontal,
+          bottom_left:       @bottom_left,
+          bottom_right:      @bottom_right,
+          caption:           @caption,
+          client:            @client,
+          colour:            @colour,
+          enabled:           @enabled,
+          horizontal:        @horizontal,
+          left_vertical:     @left_vertical,
+          name:              @name,
+          parent:            @parent,
+          repository:        @repository,
+          right_vertical:    @right_vertical,
+          show_bottom:       @show_bottom,
+          show_left:         @show_left,
+          show_right:        @show_right,
+          show_top:          @show_top,
+          style:             @style,
+          title:             @title,
+          top_horizontal:    @top_horizontal,
+          top_left:          @top_left,
+          top_right:         @top_right,
+          vertical:          @vertical,
         }
       end
 
@@ -193,13 +207,6 @@ module Vedeu
 
       private
 
-      # Returns the geometry for the interface.
-      #
-      # @return (see Vedeu::Geometries::Repository#by_name)
-      def geometry
-        Vedeu.geometries.by_name(name)
-      end
-
       # The default values for a new instance of this class.
       #
       # @return [Hash<Symbol => Boolean|Hash|NilClass|String|Symbol|
@@ -207,25 +214,29 @@ module Vedeu
       # @see Vedeu::EscapeSequences::Borders
       def defaults
         {
-          bottom_left:  Vedeu::EscapeSequences::Borders.bottom_left,
-          bottom_right: Vedeu::EscapeSequences::Borders.bottom_right,
-          caption:      '',
-          client:       nil,
-          colour:       nil,
-          enabled:      false,
-          horizontal:   Vedeu::EscapeSequences::Borders.horizontal,
-          name:         '',
-          parent:       nil,
-          repository:   Vedeu.borders,
-          show_bottom:  true,
-          show_left:    true,
-          show_right:   true,
-          show_top:     true,
-          style:        nil,
-          title:        '',
-          top_left:     Vedeu::EscapeSequences::Borders.top_left,
-          top_right:    Vedeu::EscapeSequences::Borders.top_right,
-          vertical:     Vedeu::EscapeSequences::Borders.vertical,
+          bottom_horizontal: nil,
+          bottom_left:       nil,
+          bottom_right:      nil,
+          caption:           '',
+          client:            nil,
+          colour:            nil,
+          enabled:           false,
+          horizontal:        Vedeu::EscapeSequences::Borders.horizontal,
+          left_vertical:     nil,
+          name:              '',
+          parent:            nil,
+          repository:        Vedeu.borders,
+          right_vertical:    nil,
+          show_bottom:       true,
+          show_left:         true,
+          show_right:        true,
+          show_top:          true,
+          style:             nil,
+          title:             '',
+          top_horizontal:    nil,
+          top_left:          nil,
+          top_right:         nil,
+          vertical:          Vedeu::EscapeSequences::Borders.vertical,
         }
       end
 

data/lib/vedeu/borders/caption.rb

@@ -6,33 +6,23 @@ module Vedeu
     # the caption is longer than the interface is wide, and pad with a
     # space either side.
     #
+    # The caption is displayed within the bottom border of the
+    # interface/view.
+    #
     # @api private
     #
-    class Caption < Title
-
-      # Overwrite the border from
-      # {Vedeu::Borders::Border#build_horizontal} on the bottom border
-      # to include the caption if given.
-      #
-      # @return [Array<Vedeu::Views::Char>]
-      def render
-        return chars if empty?
-
-        caption_index = 0
-        chars.each_with_index do |char, index|
-          next if index <= start_index || index > (width - 2)
-
-          char.border   = nil
-          char.value    = characters[caption_index]
-          caption_index += 1
-        end
-      end
+    class Caption < Vedeu::Borders::Title
 
       private
 
       # @return [Fixnum]
       def start_index
-        (width - size) - 2
+        (width - size) - 1
+      end
+
+      # @return [Fixnum]
+      def y
+        @_y ||= geometry.yn
       end
 
     end # Caption

data/lib/vedeu/borders/dsl.rb

@@ -19,9 +19,12 @@ module Vedeu
       # @param name [String|Symbol] The name of the interface or view
       #   to which this border belongs.
       # @param block [Proc]
-      # @raise [Vedeu::Error::RequiresBlock]
+      # @raise [Vedeu::Error::MissingRequired|
+      #   Vedeu::Error::RequiresBlock] When a name or block
+      #   respectively are not given.
       # @return [Vedeu::Borders::Border]
       def self.border(name, &block)
+        fail Vedeu::Error::MissingRequired unless name
         fail Vedeu::Error::RequiresBlock unless block_given?
 
         Vedeu::Borders::Border.build(enabled: true, name: name, &block).store
@@ -37,9 +40,13 @@ module Vedeu
       #
       # @param char [String] Character to be used as the bottom left
       #   border character.
+      # @param options [Hash<Symbol => Hash<Symbol => String>|String|
+      #   Symbol]
+      # @option options colour [Hash<Symbol => String>]
+      # @option options style [String|Symbol]
       # @return [String]
-      def bottom_left(char)
-        model.bottom_left = char
+      def bottom_left(char, options = {})
+        model.bottom_left = Vedeu::Cells::BottomLeft.new(attrs(char, options))
       end
       alias_method :bottom_left=, :bottom_left
 
@@ -53,9 +60,13 @@ module Vedeu
       #
       # @param char [String] Character to be used as the bottom right
       #   border character.
+      # @param options [Hash<Symbol => Hash<Symbol => String>|String|
+      #   Symbol]
+      # @option options colour [Hash<Symbol => String>]
+      # @option options style [String|Symbol]
       # @return [String]
-      def bottom_right(char)
-        model.bottom_right = char
+      def bottom_right(char, options = {})
+        model.bottom_right = Vedeu::Cells::BottomRight.new(attrs(char, options))
       end
       alias_method :bottom_right=, :bottom_right
 
@@ -109,9 +120,13 @@ module Vedeu
       #
       # @param char [String] Character to be used as the horizontal
       #   border character.
+      # @param options [Hash<Symbol => Hash<Symbol => String>|String|
+      #   Symbol]
+      # @option options colour [Hash<Symbol => String>]
+      # @option options style [String|Symbol]
       # @return [String]
-      def horizontal(char)
-        model.horizontal = char
+      def horizontal(char, options = {})
+        model.horizontal = Vedeu::Cells::Horizontal.new(attrs(char, options))
       end
       alias_method :horizontal=, :horizontal
 
@@ -305,9 +320,13 @@ module Vedeu
       #
       # @param char [String] Character to be used as the top left
       #   border character.
+      # @param options [Hash<Symbol => Hash<Symbol => String>|String|
+      #   Symbol]
+      # @option options colour [Hash<Symbol => String>]
+      # @option options style [String|Symbol]
       # @return [String]
-      def top_left(char)
-        model.top_left = char
+      def top_left(char, options = {})
+        model.top_left = Vedeu::Cells::TopLeft.new(attrs(char, options))
       end
       alias_method :top_left=, :top_left
 
@@ -321,9 +340,13 @@ module Vedeu
       #
       # @param char [String] Character to be used as the top right
       #   border character.
+      # @param options [Hash<Symbol => Hash<Symbol => String>|String|
+      #   Symbol]
+      # @option options colour [Hash<Symbol => String>]
+      # @option options style [String|Symbol]
       # @return [String]
-      def top_right(char)
-        model.top_right = char
+      def top_right(char, options = {})
+        model.top_right = Vedeu::Cells::TopRight.new(attrs(char, options))
       end
       alias_method :top_right=, :top_right
 
@@ -337,12 +360,33 @@ module Vedeu
       #
       # @param char [String] Character to be used as the vertical
       #   border character.
+      # @param options [Hash<Symbol => Hash<Symbol => String>|String|
+      #   Symbol]
+      # @option options colour [Hash<Symbol => String>]
+      # @option options style [String|Symbol]
       # @return [String]
-      def vertical(char)
-        model.vertical = char
+      def vertical(char, options = {})
+        model.vertical = Vedeu::Cells::Vertical.new(attrs(char, options))
       end
       alias_method :vertical=, :vertical
 
+      private
+
+      # @return [Hash<Symbol => void>]
+      def attrs(value, options)
+        default_options.merge!(value: value).merge!(options)
+      end
+
+      # @return [Hash<Symbol => NilClass|String|Symbol>]
+      def default_options
+        {
+          colour: model.colour,
+          name:   model.name,
+          style:  model.style,
+          value:  nil,
+        }
+      end
+
     end # Border
 
   end # DSL

data/lib/vedeu/borders/refresh.rb

@@ -15,6 +15,7 @@ module Vedeu
                      :bottom?,
                      :bottom_left,
                      :bottom_right,
+                     :bottom_horizontal,
                      :caption,
                      :colour,
                      :enabled?,
@@ -26,7 +27,10 @@ module Vedeu
                      :top?,
                      :top_left,
                      :top_right,
-                     :vertical
+                     :top_horizontal,
+                     :vertical,
+                     :left_vertical,
+                     :right_vertical
 
       def_delegators :geometry,
                      :bordered_height,
@@ -79,6 +83,15 @@ module Vedeu
 
       private
 
+      # @return [Hash<Symbol => void>]
+      def attributes
+        {
+          colour: colour,
+          name:   name,
+          style:  style,
+        }
+      end
+
       # Returns the border for the interface.
       #
       # @return (see Vedeu::Borders::Repository#by_name)
@@ -89,69 +102,48 @@ module Vedeu
       # @return [Array<Array<Vedeu::Views::Char>>]
       def output
         Vedeu.timer("Drawing border: '#{name}'".freeze) do
-          out = [top, bottom]
-
-          bordered_height.times { |y| out << [left(y), right(y)] }
-
-          out.flatten
+          [top, left, right, bottom].flatten
         end
       end
 
-      # @param value [String]
-      # @param type [Symbol|NilClass]
-      # @param iy [Fixnum]
-      # @param ix [Fixnum]
-      # @return [Vedeu::Views::Char]
-      def build(value, type = :border, iy = 0, ix = 0)
-        Vedeu::Views::Char.new(value:    value,
-                               parent:   interface,
-                               colour:   colour,
-                               name:     name,
-                               style:    style,
-                               position: [iy, ix],
-                               border:   type)
-      end
-
       # Creates the bottom left border character.
       #
-      # @return [Vedeu::Views::Char]
+      # @return [NilClass|Vedeu::Cells::Border|Vedeu::Views::Char]
       def build_bottom_left
-        build(bottom_left, :bottom_left, yn, x) if left?
+        return nil unless left?
+        return bottom_left if bottom_left
+
+        Vedeu::Cells::BottomLeft.new(attributes)
       end
 
       # Creates the bottom right border character.
       #
-      # @return [Vedeu::Views::Char]
+      # @return [NilClass|Vedeu::Cells::Border|Vedeu::Views::Char]
       def build_bottom_right
-        build(bottom_right, :bottom_right, yn, xn) if right?
-      end
+        return nil unless right?
+        return bottom_right if bottom_right
 
-      # Creates a top border character.
-      #
-      # @return [Array<Vedeu::Views::Char>]
-      def build_top
-        build_horizontal(:top_horizontal, y)
-      end
-
-      # Creates a bottom border character.
-      #
-      # @return [Array<Vedeu::Views::Char>]
-      def build_bottom
-        build_horizontal(:bottom_horizontal, yn)
+        Vedeu::Cells::BottomRight.new(attributes)
       end
 
       # Creates the top left border character.
       #
-      # @return [Vedeu::Views::Char]
+      # @return [NilClass|Vedeu::Cells::Border|Vedeu::Views::Char]
       def build_top_left
-        build(top_left, :top_left, y, x) if left?
+        return nil unless left?
+        return top_left if top_left
+
+        Vedeu::Cells::TopLeft.new(attributes)
       end
 
       # Creates the top right border character.
       #
-      # @return [Vedeu::Views::Char]
+      # @return [NilClass|Vedeu::Cells::Border|Vedeu::Views::Char]
       def build_top_right
-        build(top_right, :top_right, y, xn) if right?
+        return nil unless right?
+        return top_right if top_right
+
+        Vedeu::Cells::TopRight.new(attributes)
       end
 
       # Renders the bottom border for the interface.
@@ -175,16 +167,6 @@ module Vedeu
         Vedeu.geometries.by_name(name)
       end
 
-      # @param position [Symbol] Either :top_horizontal, or
-      #   :bottom_horizontal.
-      # @param y_coordinate [Fixnum] The value of either y or yn.
-      # @return [Array<Vedeu::Views::Char>]
-      def build_horizontal(position, y_coordinate)
-        Array.new(bordered_width) do |ix|
-          build(horizontal, position, y_coordinate, (bx + ix))
-        end
-      end
-
       # Returns the interface by name.
       #
       # @note
@@ -198,22 +180,28 @@ module Vedeu
 
       # Renders the left border for the interface.
       #
-      # @param iy [Fixnum]
-      # @return [String]
-      def left(iy = 0)
+      # @return [Array<void>]
+      def left
         return [] unless left?
 
-        build(vertical, :left_vertical, (by + iy), x)
+        build_collection(bordered_height) do |iy|
+          cell = left_vertical_cell.dup
+          cell.position = [by + iy, x]
+          cell
+        end
       end
 
       # Renders the right border for the interface.
       #
-      # @param iy [Fixnum]
-      # @return [String]
-      def right(iy = 0)
+      # @return [Array<void>]
+      def right
         return [] unless right?
 
-        build(vertical, :right_vertical, (by + iy), xn)
+        build_collection(bordered_height) do |iy|
+          cell = right_vertical_cell.dup
+          cell.position = [by + iy, xn]
+          cell
+        end
       end
 
       # Renders the top border for the interface.
@@ -235,9 +223,20 @@ module Vedeu
       # @return [Array<Vedeu::Views::Char>]
       # @see [Vedeu::Borders::Caption#render]
       def captionbar
-        return nil unless caption
+        return build_bottom unless present?(caption)
 
-        @_caption ||= Vedeu::Borders::Caption.render(caption, build_bottom)
+        Vedeu::Borders::Caption.render(name, caption, build_bottom)
+      end
+
+      # Creates a bottom border character.
+      #
+      # @return [Array<Vedeu::Views::Char>]
+      def build_bottom
+        build_collection(bordered_width) do |ix|
+          cell = bottom_horizontal_cell.dup
+          cell.position = [yn, bx + ix]
+          cell
+        end
       end
 
       # An optional title for when the top border is to be shown.
@@ -245,9 +244,69 @@ module Vedeu
       # @return [Array<Vedeu::Views::Char>]
       # @see [Vedeu::Borders::Title#render]
       def titlebar
-        return nil unless title
+        return build_top unless present?(title)
+
+        Vedeu::Borders::Title.render(name, title, build_top)
+      end
+
+      # Creates a top border character.
+      #
+      # @return [Array<Vedeu::Views::Char>]
+      def build_top
+        build_collection(bordered_width) do |ix|
+          cell = top_horizontal_cell.dup
+          cell.position = [y, bx + ix]
+          cell
+        end
+      end
+
+      # Return the client application configured left vertical cell
+      # character, or the default if not set.
+      #
+      # @return [Vedeu::Cells::LeftVertical]
+      def left_vertical_cell
+        return left_vertical if left_vertical
 
-        @_title ||= Vedeu::Borders::Title.render(title, build_top)
+        Vedeu::Cells::LeftVertical.new(attributes)
+      end
+
+      # Return the client application configured right vertical cell
+      # character, or the default if not set.
+      #
+      # @return [Vedeu::Cells::RightVertical]
+      def right_vertical_cell
+        return right_vertical if right_vertical
+
+        Vedeu::Cells::RightVertical.new(attributes)
+      end
+
+      # Return the client application configured top horizontal cell
+      # character, or the default if not set.
+      #
+      # @return [Vedeu::Cells::TopHorizontal]
+      def top_horizontal_cell
+        return top_horizontal if top_horizontal
+
+        Vedeu::Cells::TopHorizontal.new(attributes)
+      end
+
+      # Return the client application configured bottom horizontal
+      # cell character, or the default if not set.
+      #
+      # @return [Vedeu::Cells::BottomHorizontal]
+      def bottom_horizontal_cell
+        return bottom_horizontal if bottom_horizontal
+
+        Vedeu::Cells::BottomHorizontal.new(attributes)
+      end
+
+      # Build a collection with the given size of objects given within
+      # the block.
+      #
+      # @param size [Fixnum]
+      # @return [Array<void>]
+      def build_collection(size)
+        Array.new(size) { |e| yield(e) }
       end
 
     end # Refresh