vedeu 0.4.5 → 0.4.6

data/lib/vedeu/models/char.rb

@@ -0,0 +1,157 @@
+require 'vedeu/geometry/position'
+require 'vedeu/output/esc'
+require 'vedeu/output/html_char'
+require 'vedeu/output/presentation'
+
+module Vedeu
+
+  # A Char represents a single character of the terminal. It is a container for
+  # the a single character in a {Vedeu::Stream}.
+  #
+  # Though a multi-character String can be passed as a value, only the first
+  # character is returned in the escape sequence.
+  #
+  class Char
+
+    include Vedeu::Presentation
+
+    # @!attribute [rw] border
+    # @return [NilClass|Symbol]
+    attr_accessor :border
+
+    # @!attribute [rw] parent
+    # @return [Vedeu::Line]
+    attr_accessor :parent
+
+    # @!attribute [r] value
+    # @return [String]
+    attr_reader :value
+
+    # Returns a new instance of Vedeu::Char.
+    #
+    # @param attributes [Hash]
+    # @option attributes value    [String]
+    # @option attributes parent   [Vedeu::Line]
+    # @option attributes colour   [Vedeu::Colour]
+    # @option attributes style    [Vedeu::Style]
+    # @option attributes position [Vedeu::Position]
+    # @option attributes border   [NilClass|Symbol] A symbol representing the
+    #   border 'piece' this Char represents.
+    # @return [Char]
+    def initialize(attributes = {})
+      @attributes = defaults.merge!(attributes)
+
+      @border   = @attributes[:border]
+      @colour   = @attributes[:colour]
+      @parent   = @attributes[:parent]
+      @style    = @attributes[:style]
+      @value    = @attributes[:value]
+    end
+
+    # @param other [Vedeu::Char]
+    # @return [Boolean]
+    def ==(other)
+      eql?(other)
+    end
+
+    # When {Vedeu::Viewport#padded_lines} has less lines that required to fill
+    # the visible area of the interface, it creates a line that contains a
+    # single {Vedeu::Char} containing a space (0x20); later,
+    # {Vedeu::Viewport#padded_columns} will attempts to call `#chars` on an
+    # expected {Vedeu::Line} and fail; this method fixes that.
+    #
+    # @return [Array]
+    def chars
+      []
+    end
+
+    # @param other [Vedeu::Char]
+    # @return [Boolean]
+    def eql?(other)
+      self.class == other.class && value == other.value
+    end
+
+    # @return [String]
+    def inspect
+      "<Vedeu::Char '#{Vedeu::Esc.escape(self.to_s)}'>"
+    end
+
+    # @return [Vedeu::Position]
+    def position
+      @position ||= Vedeu::Position.coerce(attributes[:position])
+    end
+
+    # Sets the position of the Char.
+    #
+    # @param value [Vedeu::Position]
+    # @return [Vedeu::Position]
+    def position=(value)
+      @position = Vedeu::Position.coerce(value)
+    end
+
+    # Returns the x position for the Char if set.
+    #
+    # @return [Fixnum|NilClass]
+    def x
+      position.x if position
+    end
+
+    # Returns the y position for the Char if set.
+    #
+    # @return [Fixnum|NilClass]
+    def y
+      position.y if position
+    end
+
+    # Returns a Hash of all the values before coercion.
+    #
+    # @note
+    #   From this hash we should be able to construct a new instance of
+    #   Vedeu::Char, however, at the moment, `:parent` cannot be coerced.
+    #
+    # @return [Hash]
+    def to_hash
+      {
+        parent:     {
+          background: parent_background,
+          foreground: parent_foreground,
+          style:      parent_style,
+        },
+        background: '',
+        border:     '',
+        foreground: '',
+        style:      '',
+        value:      value,
+        x:          x,
+        y:          y,
+      }
+    end
+
+    # @return [String]
+    def to_html
+      @to_html ||= Vedeu::HTMLChar.render(self)
+    end
+
+    private
+
+    # @!attribute [r] attributes
+    # @return [Hash]
+    attr_reader :attributes
+
+    # The default values for a new instance of this class.
+    #
+    # @return [Hash]
+    def defaults
+      {
+        border:   nil,
+        colour:   nil,
+        parent:   nil,
+        position: nil,
+        style:    nil,
+        value:    '',
+      }
+    end
+
+  end # Char
+
+end # Vedeu

data/lib/vedeu/models/{view/composition.rb → composition.rb}

@@ -1,11 +1,8 @@
 require 'vedeu/dsl/composition'
-require 'vedeu/models/collection'
+require 'vedeu/repositories/all'
 require 'vedeu/output/presentation'
 require 'vedeu/support/common'
 
-require 'vedeu/models/view/interfaces'
-require 'vedeu/models/view/interface'
-
 module Vedeu
 
   # A composition is a collection of interfaces.

data/lib/vedeu/models/geometry.rb

@@ -1,5 +1,5 @@
 require 'vedeu/dsl/components/all'
-require 'vedeu/models/model'
+require 'vedeu/repositories/model'
 
 require 'vedeu/geometry/limit'
 require 'vedeu/geometry/position'
@@ -31,9 +31,33 @@ module Vedeu
 
     include Vedeu::Model
 
-    attr_accessor :centred, :height, :name, :width
-    attr_reader   :attributes
-    attr_writer   :x, :y
+    # @!attribute [rw] centred
+    # @return [Boolean]
+    attr_accessor :centred
+
+    # @!attribute [rw] height
+    # @return [Fixnum]
+    attr_accessor :height
+
+    # @!attribute [rw] name
+    # @return [String]
+    attr_accessor :name
+
+    # @!attribute [rw] width
+    # @return [Fixnum]
+    attr_accessor :width
+
+    # @!attribute [r] attributes
+    # @return [Hash]
+    attr_reader :attributes
+
+    # @!attribute [w] x
+    # @return [Fixnum]
+    attr_writer :x
+
+    # @!attribute [w] y
+    # @return [Fixnum]
+    attr_writer :y
 
     # Returns a new instance of Geometry.
     #
@@ -124,12 +148,12 @@ module Vedeu
     #
     # @return [Fixnum]
     def width
-      Vedeu::Limit.apply(x, @width, Terminal.width, Terminal.origin)
+      Vedeu::Limit.apply(x, @width, Vedeu::Terminal.width, Vedeu::Terminal.origin)
     end
 
     # @see Vedeu::Geometry#width
     def height
-      Vedeu::Limit.apply(y, @height, Terminal.height, Terminal.origin)
+      Vedeu::Limit.apply(y, @height, Vedeu::Terminal.height, Vedeu::Terminal.origin)
     end
 
     # Returns the top coordinate of the interface, a fixed or dynamic value
@@ -141,7 +165,7 @@ module Vedeu
     # @return [Fixnum]
     def top
       if centred
-        Terminal.centre_y - (height / 2)
+        Vedeu::Terminal.centre_y - (height / 2)
 
       else
         y
@@ -173,7 +197,7 @@ module Vedeu
     # @return [Fixnum]
     def left
       if centred
-        Terminal.centre_x - (width / 2)
+        Vedeu::Terminal.centre_x - (width / 2)
 
       else
         x
@@ -251,13 +275,13 @@ module Vedeu
       {
         centred: false,
         client:  nil,
-        height:  Terminal.height,
+        height:  Vedeu::Terminal.height,
         name:    '',
-        width:   Terminal.width,
+        width:   Vedeu::Terminal.width,
         x:       1,
-        xn:      Terminal.width,
+        xn:      Vedeu::Terminal.width,
         y:       1,
-        yn:      Terminal.height,
+        yn:      Vedeu::Terminal.height,
       }
     end
 

data/lib/vedeu/models/group.rb

@@ -1,3 +1,5 @@
+require 'vedeu/repositories/model'
+
 module Vedeu
 
   # Interfaces can be associated with one another by being members of the same
@@ -7,6 +9,8 @@ module Vedeu
 
     include Vedeu::Model
 
+    # @!attribute [rw] name
+    # @return [String]
     attr_accessor :name
 
     # Return a new instance of Group.
@@ -33,7 +37,7 @@ module Vedeu
     def add(member)
       @members = members.add(member)
 
-      Group.new({ name: name, members: @members }).store
+      Vedeu::Group.new({ name: name, members: @members }).store
     end
 
     # Return the members as a Set.
@@ -50,14 +54,14 @@ module Vedeu
     def remove(member)
       @members = members.delete(member)
 
-      Group.new({ name: name, members: @members }).store
+      Vedeu::Group.new({ name: name, members: @members }).store
     end
 
     # Remove all members from the group.
     #
     # @return [Group]
     def reset
-      Group.new(defaults.merge!({ name: name })).store
+      Vedeu::Group.new(defaults.merge!({ name: name })).store
     end
 
     private

data/lib/vedeu/models/{view/interface.rb → interface.rb}

@@ -1,12 +1,9 @@
 require 'vedeu/geometry/content_geometry'
-require 'vedeu/models/model'
+require 'vedeu/models/all'
 require 'vedeu/output/presentation'
 require 'vedeu/buffers/display_buffer'
 require 'vedeu/buffers/buffer'
 
-require 'vedeu/models/view/lines'
-require 'vedeu/models/view/line'
-
 module Vedeu
 
   # An Interface represents a portion of the terminal defined by
@@ -24,13 +21,32 @@ module Vedeu
     collection Vedeu::Lines
     member     Vedeu::Line
 
-    attr_accessor :colour,
-      :delay,
-      :group,
-      :name,
-      :parent,
-      :style
+    # @!attribute [rw] colour
+    # @return [void]
+    attr_accessor :colour
+
+    # @!attribute [rw] delay
+    # @return [Fixnum|Float]
+    attr_accessor :delay
+
+    # @!attribute [rw] group
+    # @return [void]
+    attr_accessor :group
+
+    # @!attribute [rw] name
+    # @return [String]
+    attr_accessor :name
+
+    # @!attribute [rw] parent
+    # @return [Vedeu::Composition]
+    attr_accessor :parent
+
+    # @!attribute [rw] style
+    # @return [String|Symbol]
+    attr_accessor :style
 
+    # @!attribute [w] lines
+    # @return [Array<Vedeu::Line>]
     attr_writer :lines
 
     def_delegators :geometry,

data/lib/vedeu/models/{view/line.rb → line.rb}

@@ -1,6 +1,5 @@
 require 'vedeu/output/presentation'
-require 'vedeu/models/view/streams'
-require 'vedeu/models/view/stream'
+require 'vedeu/models/all'
 
 module Vedeu
 
@@ -16,8 +15,13 @@ module Vedeu
     collection Vedeu::Streams
     member     Vedeu::Stream
 
-    attr_accessor :parent,
-      :streams
+    # @!attribute [rw] parent
+    # @return [Interface]
+    attr_accessor :parent
+
+    # @!attribute [rw] streams
+    # @return [Streams]
+    attr_accessor :streams
 
     alias_method :value, :streams
 

data/lib/vedeu/models/menu.rb

@@ -1,4 +1,4 @@
-require 'vedeu/models/model'
+require 'vedeu/repositories/model'
 
 module Vedeu
 
@@ -9,25 +9,33 @@ module Vedeu
 
     include Vedeu::Model
 
+    # @!attribute [rw] collection
+    # @return [Array]
     attr_accessor :collection
 
     # Returns the index of the value in the collection which is current.
     #
+    # @!attribute [rw] current
     # @return [Fixnum]
     attr_accessor :current
 
+    # The name of the menu. Used to reference the menu throughout the
+    # application's execution lifetime.
+    #
+    # @!attribute [rw] name
+    # @return [String]
     attr_accessor :name
 
     # Returns the index of the value in the collection which is selected.
     #
+    # @!attribute [rw] selected
     # @return [Fixnum]
     attr_accessor :selected
 
     # Register a menu by name which will display a collection of items for
     # your users to select; and provide interactivity within your application.
     #
-    # @param name  [String] The name of the menu. Used to reference the
-    #   menu throughout your application's execution lifetime.
+    # @param name [String]
     # @param block [Proc] A set of attributes which define the features of the
     #   menu. See {Vedeu::DSL::Menu#items} and {Vedeu::DSL::Menu#name}.
     #

data/lib/vedeu/models/{view/stream.rb → stream.rb}

@@ -1,5 +1,5 @@
 require 'vedeu/output/presentation'
-require 'vedeu/models/view/char'
+require 'vedeu/models/all'
 
 module Vedeu
 
@@ -15,8 +15,13 @@ module Vedeu
     collection Vedeu::Chars
     member     Vedeu::Char
 
-    attr_accessor :parent,
-      :value
+    # @!attribute [rw] parent
+    # @return [Line]
+    attr_accessor :parent
+
+    # @!attribute [rw] value
+    # @return [String]
+    attr_accessor :value
 
     alias_method :content, :value
     alias_method :data,    :value
@@ -58,7 +63,7 @@ module Vedeu
                      parent:   parent,
                      colour:   colour,
                      style:    style,
-                     position: nil }).to_s
+                     position: nil })
       end
     end
 

data/lib/vedeu/output/all.rb

@@ -8,11 +8,12 @@ require 'vedeu/output/border'
 require 'vedeu/output/colour'
 require 'vedeu/output/compositor'
 
+require 'vedeu/output/char_builder'
+require 'vedeu/output/clear'
+
 require 'vedeu/output/presentation'
 require 'vedeu/output/style'
 require 'vedeu/output/text'
-require 'vedeu/output/position_index'
-require 'vedeu/output/index_position'
 require 'vedeu/output/virtual_buffer'
 require 'vedeu/output/html_char'
 require 'vedeu/output/html_renderer'

data/lib/vedeu/output/background.rb

@@ -3,13 +3,13 @@ module Vedeu
   # The class represents one half (the other, can be found at
   # {Vedeu::Foreground}) of a terminal colour escape sequence.
   #
-  class Background < Translator
+  class Background < Vedeu::Translator
 
     private
 
     # @return [String]
     def named_codes
-      Esc.background_codes[colour]
+      Vedeu::Esc.background_codes[colour]
     end
 
     # @return [String]

data/lib/vedeu/output/border.rb

@@ -14,22 +14,65 @@ module Vedeu
 
     include Vedeu::Model
 
-    attr_accessor :attributes,
-      :bottom_left,
-      :bottom_right,
-      :horizontal,
-      :show_bottom,
-      :show_left,
-      :show_right,
-      :show_top,
-      :top_left,
-      :top_right,
-      :vertical
-
-    attr_reader :name,
-      :colour,
-      :enabled,
-      :style
+    # @!attribute [rw] attributes
+    # @return [Hash]
+    attr_accessor :attributes
+
+    # @!attribute [rw] bottom_left
+    # @return [String]
+    attr_accessor :bottom_left
+
+    # @!attribute [rw] bottom_right
+    # @return [String]
+    attr_accessor :bottom_right
+
+    # @!attribute [rw] horizontal
+    # @return [String]
+    attr_accessor :horizontal
+
+    # @!attribute [rw] show_bottom
+    # @return [Boolean]
+    attr_accessor :show_bottom
+
+    # @!attribute [rw] show_left
+    # @return [Boolean]
+    attr_accessor :show_left
+
+    # @!attribute [rw] show_right
+    # @return [Boolean]
+    attr_accessor :show_right
+
+    # @!attribute [rw] show_top
+    # @return [Boolean]
+    attr_accessor :show_top
+
+    # @!attribute [rw] top_left
+    # @return [String]
+    attr_accessor :top_left
+
+    # @!attribute [rw] top_right
+    # @return [String]
+    attr_accessor :top_right
+
+    # @!attribute [rw] vertical
+    # @return [String]
+    attr_accessor :vertical
+
+    # @!attribute [r] name
+    # @return [String]
+    attr_reader :name
+
+    # @!attribute [r] colour
+    # @return [Vedeu::Colour]
+    attr_reader :colour
+
+    # @!attribute [r] enabled
+    # @return [Boolean]
+    attr_reader :enabled
+
+    # @!attribute [r] style
+    # @return [Style]
+    attr_reader :style
 
     alias_method :enabled?, :enabled
     alias_method :bottom?,  :show_bottom
@@ -43,12 +86,12 @@ module Vedeu
     # @option attributes bottom_left [String] The bottom left border character.
     # @option attributes bottom_right [String] The bottom right border
     #   character.
-    # @option attributes colour
+    # @option attributes colour []
     # @option attributes enabled [Boolean] Indicate whether the border is to be
     #   shown for this interface.
     # @option attributes horizontal [String] The horizontal border character.
     # @option attributes name [String]
-    # @option attributes style
+    # @option attributes style []
     # @option attributes show_bottom [Boolean] Indicate whether the bottom
     #   border is to be shown.
     # @option attributes show_left [Boolean] Indicate whether the left border
@@ -120,26 +163,26 @@ module Vedeu
 
     # @return [Vedeu::Colour]
     def colour
-      Colour.coerce(@colour)
+      Vedeu::Colour.coerce(@colour)
     end
 
     # Set the border colour.
     #
     # @return [Vedeu::Colour]
     def colour=(value)
-      @colour = Colour.coerce(value)
+      @colour = Vedeu::Colour.coerce(value)
     end
 
     # @return [Vedeu::Style]
     def style
-      Style.coerce(@style)
+      Vedeu::Style.coerce(@style)
     end
 
     # Set the border style.
     #
     # @return [Vedeu::Style]
     def style=(value)
-      @style = Style.coerce(value)
+      @style = Vedeu::Style.coerce(value)
     end
 
     # Returns a string representation of the border for the interface without

data/lib/vedeu/output/char_builder.rb

@@ -0,0 +1,36 @@
+module Vedeu
+
+  # Included in {Vedeu::Clear} and {Vedeu::Output}, this module builds
+  # {Vedeu::Char} objects.
+  #
+  module CharBuilder
+
+    # Builds a new Vedeu::Char object.
+    #
+    # @param value [String]
+    # @param iy [Fixnum]
+    # @param ix [Fixnum]
+    # @return [Vedeu::Char]
+    def char_builder(value, iy, ix)
+      Vedeu::Char.new({ value:    value,
+                        colour:   interface.colour,
+                        style:    interface.style,
+                        position: origin(iy, ix) })
+    end
+
+    # Returns the position of the cursor at the top-left coordinate, relative to
+    # the interface's position.
+    #
+    # @param y_index [Fixnum]
+    # @param x_index [Fixnum]
+    # @return [Vedeu::Position]
+    def origin(y_index = 0, x_index = 0)
+      Vedeu::IndexPosition.new(y_index,
+                               x_index,
+                               interface.top,
+                               interface.left).to_position
+    end
+
+  end # CharBuilder
+
+end # Vedeu