vedeu 0.6.4 → 0.6.5

data/lib/vedeu/borders/borders.rb

@@ -1,15 +0,0 @@
-module Vedeu
-
-  # Allows the storing of interface/view borders independent of the interface
-  # instance.
-  #
-  class Borders < Vedeu::Repository
-
-    singleton_class.send(:alias_method, :borders, :repository)
-
-    null Vedeu::Null::Border
-    real Vedeu::Border
-
-  end # Borders
-
-end # Vedeu

data/lib/vedeu/borders/render_border.rb

@@ -1,331 +0,0 @@
-module Vedeu
-
-  # Renders the provided border.
-  #
-  class RenderBorder
-
-    extend Forwardable
-    include Vedeu::Common
-
-    def_delegators :border,
-                   :bottom?,
-                   :bottom_left,
-                   :bottom_right,
-                   :bx,
-                   :bxn,
-                   :by,
-                   :byn,
-                   :caption,
-                   :colour,
-                   :enabled?,
-                   :height,
-                   :horizontal,
-                   :left?,
-                   :name,
-                   :right?,
-                   :style,
-                   :title,
-                   :top?,
-                   :top_left,
-                   :top_right,
-                   :width,
-                   :vertical
-
-    def_delegators :geometry,
-                   :x,
-                   :xn,
-                   :y,
-                   :yn
-
-    # @return [Array<Array<Vedeu::Views::Char>>]
-    # @see Vedeu::RenderBorder#initialize
-    def self.with(border)
-      new(border).render
-    end
-
-    # Returns a new instance of Vedeu::RenderBorder.
-    #
-    # @param border [Vedeu::Border]
-    # @return [Vedeu::RenderBorder]
-    def initialize(border)
-      @border = border
-    end
-
-    # @return [Array<Array<Vedeu::Views::Char>>]
-    def render
-      return [] unless enabled?
-
-      Vedeu.timer("Bordering: '#{name}'") do
-        out = [top, bottom]
-
-        height.times { |y| out << [left(y), right(y)] }
-
-        out.flatten
-      end
-    end
-
-    protected
-
-    # @!attribute [r] border
-    # @return [Vedeu::Border]
-    attr_reader :border
-
-    private
-
-    # @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,
-                             style:    style,
-                             position: [iy, ix],
-                             border:   type)
-    end
-
-    # @return [Vedeu::Views::Char]
-    def build_bottom_left
-      build(bottom_left, :bottom_left, yn, x) if left?
-    end
-
-    # @return [Vedeu::Views::Char]
-    def build_bottom_right
-      build(bottom_right, :bottom_right, yn, xn) if right?
-    end
-
-    # @return [Array<Vedeu::Views::Char>]
-    def build_top
-      build_horizontal(:bottom_horizontal, y)
-    end
-
-    # @return [Array<Vedeu::Views::Char>]
-    def build_bottom
-      build_horizontal(:bottom_horizontal, yn)
-    end
-
-    # @return [Vedeu::Views::Char]
-    def build_top_left
-      build(top_left, :top_left, y, x) if left?
-    end
-
-    # @return [Vedeu::Views::Char]
-    def build_top_right
-      build(top_right, :top_right, y, xn) if right?
-    end
-
-    # Renders the bottom border for the interface.
-    #
-    # @note
-    #   If a caption has been specified, then the bottom border will include
-    #   this caption unless the size of the interface is smaller than the padded
-    #   caption length.
-    #
-    # @return [String]
-    def bottom
-      return [] unless bottom?
-
-      [build_bottom_left, captionbar, build_bottom_right].compact
-    end
-
-    # @return [Vedeu::Geometry]
-    def geometry
-      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(width) do |ix|
-        build(horizontal, position, y_coordinate, (bx + ix))
-      end
-    end
-
-    # The parent of a border is always an interface.
-    #
-    # @return [Vedeu::Interface]
-    def interface
-      @interface ||= Vedeu.interfaces.by_name(name)
-    end
-    alias_method :parent, :interface
-
-    # Renders the left border for the interface.
-    #
-    # @param iy [Fixnum]
-    # @return [String]
-    def left(iy = 0)
-      return [] unless left?
-
-      build(vertical, :left_vertical, (by + iy), x)
-    end
-
-    # Renders the right border for the interface.
-    #
-    # @param iy [Fixnum]
-    # @return [String]
-    def right(iy = 0)
-      return [] unless right?
-
-      build(vertical, :right_vertical, (by + iy), xn)
-    end
-
-    # Renders the top border for the interface.
-    #
-    # @note
-    #   If a title has been specified, then the top border will include this
-    #   title unless the size of the interface is smaller than the padded title
-    #   length.
-    #
-    # @return [String]
-    def top
-      return [] unless top?
-
-      [build_top_left, titlebar, build_top_right].compact
-    end
-
-    # Overwrite the border from {#build_horizontal} on the bottom border to
-    # include the caption if given.
-    #
-    # @return [Array<Vedeu::Views::Char>]
-    def captionbar
-      return build_bottom unless caption? && caption_fits?
-
-      caption_starts_at = (width - caption_characters.size) - 2
-
-      caption_char = 0
-      build_bottom.each_with_index do |char, index|
-        next if index <= caption_starts_at || index > (width - 2)
-
-        char.border  = nil
-        char.value   = caption_characters[caption_char]
-        caption_char += 1
-      end
-    end
-
-    # Overwrite the border from {#build_horizontal} on the top border to
-    # include the title if given.
-    #
-    # @return [Array<Vedeu::Views::Char>]
-    def titlebar
-      return build_top unless title? && title_fits?
-
-      build_top.each_with_index do |char, index|
-        next if index == 0 || index > title_characters.size
-
-        char.border = nil
-        char.value  = title_characters[(index - 1)]
-      end
-    end
-
-    # Return boolean indicating whether this border has a non-empty title.
-    #
-    # @return [Boolean]
-    def title?
-      present?(title)
-    end
-
-    # Return boolean indicating whether this border has a non-empty caption.
-    #
-    # @return [Boolean]
-    def caption?
-      present?(caption)
-    end
-
-    # Return boolean indicating whether the title fits within the width of the
-    # top border.
-    #
-    # @return [Boolean]
-    def title_fits?
-      width > title_characters.size
-    end
-
-    # Return boolean indicating whether the caption fits within the width of the
-    # bottom border.
-    #
-    # @return [Boolean]
-    def caption_fits?
-      width > caption_characters.size
-    end
-
-    # @return [Array<String>]
-    def title_characters
-      @title_characters ||= title_padded.chars
-    end
-
-    # @return [Array<String>]
-    def caption_characters
-      @caption_characters ||= caption_padded.chars
-    end
-
-    # Pads the title with a single whitespace either side.
-    #
-    # @example
-    #   title = 'Truncated!'
-    #   width = 20
-    #   # => ' Truncated! '
-    #
-    #   width = 10
-    #   # => ' Trunca '
-    #
-    # @return [String]
-    # @see #truncated_title
-    def title_padded
-      truncated_title.center(truncated_title.size + 2)
-    end
-
-    # Pads the caption with a single whitespace either side.
-    #
-    # @example
-    #   caption = 'Truncated!'
-    #   width = 20
-    #   # => ' Truncated! '
-    #
-    #   width = 10
-    #   # => ' Trunca '
-    #
-    # @return [String]
-    # @see #truncated_caption
-    def caption_padded
-      truncated_caption.center(truncated_caption.size + 2)
-    end
-
-    # Truncates the title to the width of the interface, minus characters needed
-    # to ensure there is at least a single character of horizontal border and a
-    # whitespace on either side of the title.
-    #
-    # @example
-    #   title = 'Truncated!'
-    #   width = 20
-    #   # => 'Truncated!'
-    #
-    #   width = 10
-    #   # => 'Trunca'
-    #
-    # @return [String]
-    def truncated_title
-      title.chomp.slice(0..(width - 5))
-    end
-
-    # Truncates the caption to the width of the interface, minus characters
-    # needed to ensure there is at least a single character of horizontal border
-    # and a whitespace on either side of the caption.
-    #
-    # @example
-    #   caption = 'Truncated!'
-    #   width = 20
-    #   # => 'Truncated!'
-    #
-    #   width = 10
-    #   # => 'Trunca'
-    #
-    # @return [String]
-    def truncated_caption
-      caption.chomp.slice(0..(width - 5))
-    end
-
-  end # RenderBorder
-
-end # Vedeu

data/lib/vedeu/buffers/buffers.rb

@@ -1,20 +0,0 @@
-module Vedeu
-
-  # Allows the storing of view buffers.
-  #
-  class Buffers < Vedeu::Repository
-
-    singleton_class.send(:alias_method, :buffers, :repository)
-
-    null Vedeu::Null::Buffer
-    real Vedeu::Buffer
-
-  end # Buffers
-
-  class Buffer
-
-    repo Vedeu::Buffers.repository
-
-  end # Buffer
-
-end # Vedeu

data/lib/vedeu/cursor/cursor.rb

@@ -1,174 +0,0 @@
-module Vedeu
-
-  # Each interface has its own Cursor which maintains the position and
-  # visibility of the cursor within that interface.
-  #
-  class Cursor
-
-    include Vedeu::Model
-    include Vedeu::Toggleable
-    extend Forwardable
-
-    def_delegators :border,
-                   :bx,
-                   :bxn,
-                   :by,
-                   :byn
-
-    # @!attribute [r] attributes
-    # @return [Hash]
-    attr_reader :attributes
-
-    # @!attribute [r] name
-    # @return [String]
-    attr_reader :name
-
-    # @!attribute [rw] ox
-    # @return [Fixnum]
-    attr_accessor :ox
-
-    # @!attribute [rw] oy
-    # @return [Fixnum]
-    attr_accessor :oy
-
-    # @!attribute [r] state
-    # @return [Boolean|Symbol]
-    attr_reader :state
-
-    # @!attribute [w] x
-    # @return [Fixnum]
-    attr_writer :x
-
-    # @!attribute [sw] y
-    # @return [Fixnum]
-    attr_writer :y
-
-    # Returns a new instance of Vedeu::Cursor.
-    #
-    # @param attributes [Hash]
-    # @option attributes name [String] The name of the interface this cursor
-    #   belongs to.
-    # @option attributes ox [Fixnum] The offset x coordinate.
-    # @option attributes oy [Fixnum] The offset y coordinate.
-    # @option attributes repository [Vedeu::Repository]
-    # @option attributes visible [Boolean] The visibility of the cursor.
-    # @option attributes x [Fixnum] The terminal x coordinate for the cursor.
-    # @option attributes y [Fixnum] The terminal y coordinate for the cursor.
-    #
-    # @return [Vedeu::Cursor]
-    def initialize(attributes = {})
-      @attributes = defaults.merge!(attributes)
-
-      @attributes.each { |key, value| instance_variable_set("@#{key}", value) }
-    end
-
-    # Renders the cursor.
-    #
-    # @return [Array<Vedeu::Escape>]
-    def render
-      Vedeu::Output.render(visibility)
-    end
-
-    # Returns an escape sequence to position the cursor and set its visibility.
-    # When passed a block, will position the cursor, yield and return the
-    # original position.
-    #
-    # @return [String]
-    def to_s
-      if block_given?
-        "#{position}#{yield}#{visibility}"
-
-      else
-        "#{visibility}"
-
-      end
-    end
-    alias_method :to_str, :to_s
-
-    # Hide a named cursor, or without a name, the cursor of the currently
-    # focussed interface.
-    #
-    # @example
-    #   Vedeu.hide_cursor(name)
-    #
-    # @return [Vedeu::Escape]
-    def hide
-      super
-
-      render
-    end
-
-    # Return the position of this cursor.
-    #
-    # @return [Vedeu::Position]
-    def position
-      @position = Vedeu::Position[y, x]
-    end
-
-    # Show a named cursor, or without a name, the cursor of the currently
-    # focussed interface.
-    #
-    # @example
-    #   Vedeu.show_cursor(name)
-    #
-    # @return [Vedeu::Escape]
-    def show
-      super
-
-      render
-    end
-
-    # @return [Fixnum] The column/character coordinate.
-    def x
-      @x = bx  if @x < bx
-      @x = bxn if @x > bxn
-
-      @attributes[:x] = @x
-
-      @x
-    end
-
-    # @return [Fixnum] The row/line coordinate.
-    def y
-      @y = by  if @y < by
-      @y = byn if @y > byn
-
-      @attributes[:y] = @y
-
-      @y
-    end
-
-    private
-
-    # @see Vedeu::Borders#by_name
-    def border
-      @border ||= Vedeu.borders.by_name(name)
-    end
-
-    # The default values for a new instance of this class.
-    #
-    # @return [Hash]
-    def defaults
-      {
-        name:       '',
-        ox:         0,
-        oy:         0,
-        repository: Vedeu.cursors,
-        visible:    false,
-        x:          1,
-        y:          1,
-      }
-    end
-
-    # Returns the escape sequence for setting the visibility of the cursor.
-    #
-    # @return [String]
-    def visibility
-      value = visible? ? Vedeu::Esc.show_cursor : Vedeu::Esc.hide_cursor
-
-      Vedeu::Escape.new(position: position, value: value)
-    end
-
-  end # Cursor
-
-end # Vedeu