RubyGems - vedeu - Versions diffs - 0.3.4 → 0.3.5 - Mend

vedeu 0.3.4 → 0.3.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (164) hide show

checksums.yaml +4 -4
data/README.md +1 -1
data/Rakefile +6 -0
data/bin/vedeu_drb_client +8 -3
data/bin/vedeu_drb_server +113 -0
data/bin/vedeu_test +1 -1
data/docs/events.md +0 -127
data/examples/borders_app.rb +17 -7
data/examples/configuration_app.rb +1 -1
data/examples/cursor_app.rb +4 -2
data/examples/drb_app.rb +113 -0
data/examples/focus_app.rb +1 -1
data/examples/geometry_app.rb +1 -1
data/examples/hello_world.rb +1 -1
data/examples/lines_app.rb +1 -1
data/features/start_stop.feature +1 -1
data/inch.yml +5 -0
data/lib/vedeu/all.rb +2 -0
data/lib/vedeu/api.rb +1 -0
data/lib/vedeu/application.rb +17 -36
data/lib/vedeu/bindings.rb +134 -27
data/lib/vedeu/buffers/display_buffer.rb +1 -4
data/lib/vedeu/configuration/api.rb +15 -14
data/lib/vedeu/configuration/cli.rb +17 -16
data/lib/vedeu/configuration/configuration.rb +3 -1
data/lib/vedeu/cursor/cursor.rb +6 -8
data/lib/vedeu/cursor/move_cursor.rb +1 -0
data/lib/vedeu/cursor/toggle_cursor.rb +1 -0
data/lib/vedeu/debug.rb +23 -0
data/lib/vedeu/distributed/all.rb +1 -1
data/lib/vedeu/distributed/client.rb +55 -13
data/lib/vedeu/distributed/server.rb +207 -0
data/lib/vedeu/distributed/subprocess.rb +22 -21
data/lib/vedeu/distributed/templates/default_application.vedeu +3 -1
data/lib/vedeu/distributed/test_application.rb +2 -1
data/lib/vedeu/distributed/uri.rb +1 -0
data/lib/vedeu/dsl/all.rb +4 -2
data/lib/vedeu/dsl/components/border.rb +11 -10
data/lib/vedeu/dsl/components/geometry.rb +1 -0
data/lib/vedeu/dsl/components/keymap.rb +1 -0
data/lib/vedeu/dsl/components/menu.rb +1 -0
data/lib/vedeu/dsl/interface.rb +1 -0
data/lib/vedeu/dsl/line.rb +3 -1
data/lib/vedeu/dsl/shared/colour.rb +1 -0
data/lib/vedeu/dsl/shared/style.rb +1 -0
data/lib/vedeu/dsl/shared/text.rb +2 -0
data/lib/vedeu/dsl/shared/use.rb +3 -0
data/lib/vedeu/dsl/stream.rb +3 -1
data/lib/vedeu/dsl/view.rb +1 -0
data/lib/vedeu/events/event.rb +9 -6
data/lib/vedeu/events/trigger.rb +18 -7
data/lib/vedeu/exceptions.rb +4 -1
data/lib/vedeu/input/input.rb +1 -0
data/lib/vedeu/input/key.rb +0 -1
data/lib/vedeu/input/keymap.rb +5 -3
data/lib/vedeu/input/keys.rb +1 -0
data/lib/vedeu/input/mapper.rb +1 -0
data/lib/vedeu/launcher.rb +35 -12
data/lib/vedeu/main_loop.rb +53 -0
data/lib/vedeu/models/collection.rb +11 -3
data/lib/vedeu/models/focus.rb +3 -3
data/lib/vedeu/models/geometry.rb +8 -16
data/lib/vedeu/models/group.rb +1 -0
data/lib/vedeu/models/menu.rb +2 -1
data/lib/vedeu/models/model.rb +7 -1
data/lib/vedeu/models/view/char.rb +52 -44
data/lib/vedeu/models/view/chars.rb +1 -0
data/lib/vedeu/models/view/composition.rb +2 -1
data/lib/vedeu/models/view/interface.rb +5 -3
data/lib/vedeu/models/view/interfaces.rb +1 -0
data/lib/vedeu/models/view/line.rb +2 -1
data/lib/vedeu/models/view/stream.rb +2 -1
data/lib/vedeu/models/view/streams.rb +1 -0
data/lib/vedeu/output/all.rb +4 -0
data/lib/vedeu/output/border.rb +75 -206
data/lib/vedeu/output/compositor.rb +1 -0
data/lib/vedeu/output/html_char.rb +119 -0
data/lib/vedeu/output/html_renderer.rb +89 -0
data/lib/vedeu/output/output.rb +48 -44
data/lib/vedeu/output/position_index.rb +12 -1
data/lib/vedeu/output/renderer.rb +28 -0
data/lib/vedeu/output/viewport.rb +14 -14
data/lib/vedeu/output/virtual_buffer.rb +56 -0
data/lib/vedeu/output/virtual_terminal.rb +42 -34
data/lib/vedeu/output/wordwrap.rb +3 -0
data/lib/vedeu/output/writer.rb +13 -1
data/lib/vedeu/presentation/background.rb +1 -0
data/lib/vedeu/presentation/colour.rb +8 -7
data/lib/vedeu/presentation/foreground.rb +1 -0
data/lib/vedeu/presentation/presentation.rb +43 -7
data/lib/vedeu/presentation/translator.rb +12 -0
data/lib/vedeu/repositories/repository.rb +8 -8
data/lib/vedeu/support/bounding_area.rb +2 -0
data/lib/vedeu/support/coercions.rb +2 -1
data/lib/vedeu/support/common.rb +1 -0
data/lib/vedeu/support/console.rb +17 -23
data/lib/vedeu/support/content_geometry.rb +2 -0
data/lib/vedeu/support/coordinate.rb +1 -0
data/lib/vedeu/support/esc.rb +58 -29
data/lib/vedeu/support/grid.rb +1 -0
data/lib/vedeu/support/limit.rb +9 -0
data/lib/vedeu/support/log.rb +31 -9
data/lib/vedeu/support/node.rb +8 -18
data/lib/vedeu/support/position.rb +13 -34
data/lib/vedeu/support/position_validator.rb +3 -0
data/lib/vedeu/support/read.rb +1 -0
data/lib/vedeu/support/refresh.rb +3 -2
data/lib/vedeu/support/terminal.rb +11 -5
data/lib/vedeu/support/trace.rb +16 -1
data/lib/vedeu/support/visible.rb +2 -0
data/lib/vedeu/support/write.rb +1 -0
data/lib/vedeu/traps.rb +1 -0
data/lib/vedeu.rb +2 -0
data/test/integration/distributed_test.rb +10 -8
data/test/lib/vedeu/api_test.rb +3 -7
data/test/lib/vedeu/application_test.rb +2 -5
data/test/lib/vedeu/configuration/api_test.rb +12 -0
data/test/lib/vedeu/cursor/cursor_test.rb +2 -0
data/test/lib/vedeu/distributed/client_test.rb +17 -7
data/test/lib/vedeu/distributed/server_test.rb +56 -0
data/test/lib/vedeu/distributed/test_application_test.rb +7 -3
data/test/lib/vedeu/dsl/components/border_test.rb +10 -2
data/test/lib/vedeu/dsl/interface_test.rb +6 -0
data/test/lib/vedeu/dsl/line_test.rb +19 -0
data/test/lib/vedeu/dsl/shared/colour_test.rb +4 -26
data/test/lib/vedeu/dsl/shared/text_test.rb +8 -1
data/test/lib/vedeu/dsl/stream_test.rb +13 -1
data/test/lib/vedeu/input/input_test.rb +1 -1
data/test/lib/vedeu/input/key_test.rb +3 -16
data/test/lib/vedeu/launcher_test.rb +11 -1
data/test/lib/vedeu/main_loop_test.rb +41 -0
data/test/lib/vedeu/models/geometry_test.rb +15 -34
data/test/lib/vedeu/models/view/char_test.rb +44 -45
data/test/lib/vedeu/models/view/interface_test.rb +6 -0
data/test/lib/vedeu/models/view/line_test.rb +1 -1
data/test/lib/vedeu/models/view/stream_test.rb +1 -1
data/test/lib/vedeu/output/border_test.rb +6 -5
data/test/lib/vedeu/output/compositor_test.rb +2 -20
data/test/lib/vedeu/output/html_char_test.rb +85 -0
data/test/lib/vedeu/output/html_renderer_test.rb +37 -0
data/test/lib/vedeu/output/position_index_test.rb +2 -10
data/test/lib/vedeu/output/renderer_test.rb +24 -0
data/test/lib/vedeu/output/virtual_buffer_test.rb +53 -0
data/test/lib/vedeu/output/virtual_terminal_test.rb +32 -2
data/test/lib/vedeu/presentation/background_test.rb +41 -1
data/test/lib/vedeu/presentation/colour_test.rb +10 -6
data/test/lib/vedeu/presentation/foreground_test.rb +46 -6
data/test/lib/vedeu/presentation/presentation_test.rb +44 -1
data/test/lib/vedeu/presentation/translator_test.rb +34 -0
data/test/lib/vedeu/repositories/repository_test.rb +1 -1
data/test/lib/vedeu/support/bounding_area_test.rb +4 -12
data/test/lib/vedeu/support/console_test.rb +9 -50
data/test/lib/vedeu/support/esc_test.rb +7 -7
data/test/lib/vedeu/support/position_test.rb +42 -0
data/test/lib/vedeu/support/terminal_test.rb +5 -20
data/test/lib/vedeu/support/write_test.rb +42 -18
data/test/support/helpers/all.rb +0 -1
data/test/support/helpers/repository_test_module.rb +1 -0
data/test/test_helper.rb +5 -2
data/vedeu.gemspec +7 -5
metadata +60 -14
data/lib/vedeu/distributed/application.rb +0 -91
data/test/lib/vedeu/distributed/application_test.rb +0 -24
data/test/support/helpers/presentation.rb +0 -16

data/lib/vedeu/output/html_char.rb ADDED Viewed

@@ -0,0 +1,119 @@
+require 'vedeu/support/common'
+module Vedeu
+  class HTMLChar
+    include Vedeu::Common
+    # @param char [Vedeu::Char]
+    # @return [String]
+    def self.render(char)
+      new(char).render
+    end
+    # @param char [Vedeu::Char]
+    # @return [Vedeu::HTMLChar]
+    def initialize(char)
+      @char = char
+    end
+    # @return [String]
+    def render
+      "<td#{td_style}>#{td_value}</td>"
+    end
+    private
+    attr_reader :char
+    # @return [String]
+    def td_style
+      return '' unless border || defined_value?(value)
+      " style='background:#{bg};color:#{fg};border:1px #{bg} solid;#{border_style}'"
+    end
+    # @return [String]
+    def td_value
+      return '&nbsp;' if border || !defined_value?(value)
+      value
+    end
+    # @return [String]
+    def border_style
+      case border
+      when nil                then ''
+      when :top_horizontal    then border_css('top')
+      when :left_vertical     then border_css('left')
+      when :right_vertical    then border_css('right')
+      when :bottom_horizontal then border_css('bottom')
+      when :top_left          then [border_css('top'), border_css('left')].join
+      when :top_right         then [border_css('top'), border_css('right')].join
+      when :bottom_left       then [border_css('bottom'), border_css('left')].join
+      when :bottom_right      then [border_css('bottom'), border_css('right')].join
+      when :horizontal        then ''
+      when :vertical          then ''
+      else
+        # ... should not get here
+        ''
+      end
+    end
+    # @return [String]
+    def border_css(direction = '')
+      "border-#{direction}:1px #{fg} solid;"
+    end
+    # @return [String]
+    def fg
+      @fg ||= colour_fg || parent_fg || '#222'
+    end
+    # @return [String]
+    def bg
+      @bg ||= colour_bg || parent_bg || '#000'
+    end
+    # @return [String|NilClass]
+    def colour_bg
+      if char.background && defined_value?(char.background.to_html)
+        char.background.to_html
+      end
+    end
+    # @return [String|NilClass]
+    def colour_fg
+      if char.foreground && defined_value?(char.foreground.to_html)
+        char.foreground.to_html
+      end
+    end
+    # @return [String|NilClass]
+    def parent_bg
+      if char.parent_background && defined_value?(char.parent_background.to_html)
+        char.parent_background.to_html
+      end
+    end
+    # @return [String|NilClass]
+    def parent_fg
+      if char.parent_foreground && defined_value?(char.parent_foreground.to_html)
+        char.parent_foreground.to_html
+      end
+    end
+    # @return [Symbol|NilClass]
+    def border
+      char.border
+    end
+    # @return [String]
+    def value
+      char.value
+    end
+  end # HTMLChar
+end # Vedeu

data/lib/vedeu/output/html_renderer.rb ADDED Viewed

@@ -0,0 +1,89 @@
+module Vedeu
+  class HTMLRenderer
+    # @param output [Array<Array<Vedeu::Char>>]
+    # @return [String]
+    def self.render(output)
+      new(output).render
+    end
+    # @param output [Array<Array<Vedeu::Char>>]
+    # @return [Vedeu::HTMLRenderer]
+    def initialize(output)
+      @output  = output
+    end
+    # @return [String]
+    def render
+      html_header + html_body + html_footer
+    end
+    # @param path [String]
+    # @return [String]
+    def to_file(path = file_path)
+      content = render
+      File.open(path, "w", 0644) { |file| file.write(content) }
+      content
+    end
+    private
+    attr_reader :output
+    # @return [String]
+    def html_body
+      out = ''
+      Array(output).each do |line|
+        out << "<tr>\n"
+        line.each do |char|
+          out << char.to_html
+          out << "\n"
+        end
+        out << "</tr>\n"
+      end
+      out
+    end
+    # @return [String]
+    def html_header
+      <<-HTML
+        <html>
+          <head>
+            <style type='text/css'>
+              body { background:#000; }
+              td { border:1px #171717 solid;
+                font-size:12px;
+                font-family:monospace;
+                height:18px;
+                margin:1px;
+                text-align:center;
+                vertical-align:center;
+                width:18px; }
+            </style>
+          </head>
+          <body>
+            <table>
+      HTML
+    end
+    # @return [String]
+    def html_footer
+      "</table></body></html>"
+    end
+    # @return [String]
+    def file_path
+      "/tmp/vedeu_html_#{timestamp}.html"
+    end
+    # return [Fixnum]
+    def timestamp
+      @timestamp ||= Time.now.to_i
+    end
+  end # HTMLRenderer
+end # Vedeu

data/lib/vedeu/output/output.rb CHANGED Viewed

@@ -25,9 +25,11 @@ module Vedeu
     #
     # @return [Array]
     def render
-      Vedeu.trigger(:_output_, virtual_view)
+      if Vedeu::Configuration.drb?
+        Vedeu.trigger(:_drb_store_output_, virtual_view)
+      end
-      Terminal.output(view, interface.cursor.to_s)
+      Terminal.output(Renderer.render(virtual_view, interface.cursor))
     end
     private
@@ -38,66 +40,45 @@ module Vedeu
     # colours to those specified when the interface was defined, then starting
     # write space characters over the area which the interface occupies.
     #
-    # @return [String]
-    def clear
-      Vedeu.log("Clearing view: '#{interface.name}'")
-      interface.height.times.inject([interface.colour]) do |line, index|
-        line << interface.origin(index) { ' ' * interface.width }
-      end.join
-    end
-    # Produces a single string which contains all content and escape sequences
-    # required to render this interface in the terminal window.
+    # @note
+    #   omg!
     #
-    # @return [String]
-    def view
-      out = [ clear ]
-      Vedeu.log("Rendering view: '#{interface.name}'")
-      viewport.each_with_index do |line, index|
-        out << interface.origin(index)
-        out << line.join
-      end
-      out.join
-    end
-    def viewport
-      @_viewport ||= Vedeu::Viewport.new(interface).render
-    end
-    # omg!
+    # @return [Array<Array<Vedeu::Char>>]
     def virtual_clear
+      Vedeu.log(type: :output, message: "Clearing: '#{interface.name}'")
       out = []
-      interface.height.times do |hi|
+      interface.height.times do |iy|
         row = []
-        interface.width.times do |wi|
-          v   = interface.raw_origin(hi)
-          pos = Vedeu::Position.new(v.first, (v.last + wi))
-          row << Vedeu::Char.new(' ', nil, interface.colour, nil, pos)
+        interface.width.times do |ix|
+          row << char_builder(' ', iy, ix)
         end
         out << row
       end
       out
     end
-    # omg!
+    # Builds up a virtual view; a grid of Vedeu::Char objects- each one holding
+    # one character along with its colour, style and position attributes.
+    #
+    # @note
+    #   omg!
+    #
+    # @return [Array<Array<Vedeu::Char>>]
     def virtual_view
       out = [ virtual_clear ]
-      viewport.each_with_index do |line, line_index|
+      Vedeu.log(type: :output, message: "Rendering: '#{interface.name}'")
+      viewport.each_with_index do |line, iy|
         row = []
-        line.each_with_index do |char, char_index|
-          v   = interface.raw_origin(line_index)
-          pos = Vedeu::Position.new(v.first, (v.last + char_index))
+        line.each_with_index do |char, ix|
           row << if char.is_a?(Vedeu::Char)
-            char.position=(pos)
+            char.position = position(iy, ix)
             char
           else
-            Vedeu::Char.new(char, nil, interface.colour, nil, pos)
+            char_builder(char, iy, ix)
           end
         end
@@ -106,6 +87,29 @@ module Vedeu
       out
     end
+    # @return [void]
+    def viewport
+      @_viewport ||= Vedeu::Viewport.new(interface).render
+    end
+    # @param iy [Fixnum]
+    # @param ix [Fixnum]
+    # @return [Vedeu::Position]
+    def position(iy, ix)
+      interface.origin(iy, ix)
+    end
+    # @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: position(iy, ix) })
+    end
   end # Output
 end # Vedeu

data/lib/vedeu/output/position_index.rb CHANGED Viewed

@@ -1,20 +1,31 @@
 module Vedeu
+  # Converts a position into an index for the terminal.
+  #
   class PositionIndex
-    attr_reader :y, :x
+    attr_reader :y,
+      :x
     alias_method :first, :y
     alias_method :last, :x
+    # @param y [Fixnum]
+    # @param x [Fixnum]
+    # @return [Array]
     def self.[](y, x)
       new(y, x).[]
     end
+    # @param y [Fixnum]
+    # @param x [Fixnum]
+    # @return [Vedeu::PositionIndex]
     def initialize(y, x)
       @y = [(y - 1), 1].max
       @x = [(x - 1), 1].max
     end
+    # @return [Array]
     def []
       [y, x]
     end

data/lib/vedeu/output/renderer.rb ADDED Viewed

@@ -0,0 +1,28 @@
+module Vedeu
+  class Renderer
+    # @param output [Array<Array<Vedeu::Char>>]
+    # @return [String]
+    def self.render(*output)
+      new(*output).render
+    end
+    # @param output [Array<Array<Vedeu::Char>>]
+    # @return [Vedeu::Renderer]
+    def initialize(*output)
+      @output = output
+    end
+    # @return [String]
+    def render
+      Array(output).flatten.map(&:to_s).join
+    end
+    private
+    attr_reader :output
+  end # Renderer
+end # Vedeu

data/lib/vedeu/output/viewport.rb CHANGED Viewed

@@ -114,18 +114,18 @@ module Vedeu
       end
     end
-    # Using the current cursor's x position, return a range of visible lines.
+    # Using the current cursor's y position, return a range of visible lines.
     #
-    # Scrolls the content horizontally when the stored cursor's x position for
-    # the interface is outside of the visible area.
+    # Scrolls the content vertically when the stored cursor's y position for the
+    # interface is outside of the visible area.
     #
     # @note
-    #   [value, 0].max # this allows us to set a left that is greater
-    #                  # than the content width.
+    #   [value, 0].max # this allows us to set a top that is greater than
+    #                  # the content height.
     #
-    #   [[value, (content_width - width)].min, 0].max
+    #   [[value, (content_height - height)].min, 0].max
     #                  # this does not allow us to have a position
-    #                  # greater than the content width.
+    #                  # greater than the content height.
     #
     # @return [Range]
     def rows
@@ -140,18 +140,18 @@ module Vedeu
       top..(top + (height - 1))
     end
-    # Using the current cursor's y position, return a range of visible columns.
+    # Using the current cursor's x position, return a range of visible columns.
     #
-    # Scrolls the content vertically when the stored cursor's y position for the
-    # interface is outside of the visible area.
+    # Scrolls the content horizontally when the stored cursor's x position for
+    # the interface is outside of the visible area.
     #
     # @note
-    #   [value, 0].max # this allows us to set a top that is greater than
-    #                  # the content height.
+    #   [value, 0].max # this allows us to set a left that is greater
+    #                  # than the content width.
     #
-    #   [[value, (content_height - height)].min, 0].max
+    #   [[value, (content_width - width)].min, 0].max
     #                  # this does not allow us to have a position
-    #                  # greater than the content height.
+    #                  # greater than the content width.
     #
     # @return [Range]
     def columns

data/lib/vedeu/output/virtual_buffer.rb ADDED Viewed

@@ -0,0 +1,56 @@
+module Vedeu
+  # Store and retrieve virtual terminals.
+  #
+  module VirtualBuffer
+    extend self
+    # Fetch the oldest stored virtual buffer first.
+    #
+    # @return [Array<Array<Vedeu::Char>>|NilClass]
+    def retrieve
+      storage.pop
+    end
+    # Store a new virtual buffer.
+    #
+    # @return [Array<Array<Vedeu::Char>>]
+    def store(data)
+      storage.unshift(data)
+    end
+    # Return the number of virtual buffers currently stored.
+    #
+    # @return [Fixnum]
+    def size
+      storage.size
+    end
+    # Destroy all virtual buffers currently stored.
+    #
+    # @return [Array]
+    def clear
+      @_storage = in_memory
+    end
+    alias_method :reset, :clear
+    private
+    # Access to the storage for this repository.
+    #
+    # @return [Array]
+    def storage
+      @_storage ||= in_memory
+    end
+    # Returns an empty collection ready for the storing of virtual buffers.
+    #
+    # @return [Array]
+    def in_memory
+      []
+    end
+  end # VirtualBuffer
+end # Vedeu

data/lib/vedeu/output/virtual_terminal.rb CHANGED Viewed

@@ -1,52 +1,28 @@
 module Vedeu
-  # class Cell < Struct.new(:value)
-  #   def initialize(value = [])
-  #     super
-  #   end
-  # end
-  # class Cells
-  #   attr_reader :size, :value
-  #   def initialize(size = 0, &block)
-  #     @size  = size
-  #     @value = if block_given?
-  #       [instance_eval(&block)] * size
-  #     else
-  #       [Cell.new] * size
-  #     end
-  #   end
-  #   def [](index)
-  #     value[index] || self
-  #   end
-  #   private
-  #   attr_reader :size, :value
-  # end
   class VirtualTerminal
+    attr_accessor :renderer
     attr_reader :cell_height, :cell_width, :height, :width
     # @param height [Fixnum]
     # @param width [Fixnum]
+    # @param renderer [Object|HTMLRenderer] An object responding to .render.
     # @return [Vedeu::VirtualTerminal]
-    def initialize(height, width)
+    def initialize(height, width, renderer = HTMLRenderer)
       @cell_height, @cell_width = Vedeu::PositionIndex[height, width]
-      @height = height
-      @width  = width
+      @height   = height
+      @width    = width
+      @renderer = renderer
     end
-    # @return [Array<Vedeu::Char>]
+    # @return [Array<Array<Vedeu::Char>>]
     def cells
-      Array.new(cell_height) { Array.new(cell_width) { Vedeu::Char.new } }
+      @cells ||= new_virtual_terminal
     end
+    # Read a single cell from the virtual terminal.
+    #
     # @param y [Fixnum]
     # @param x [Fixnum]
     # @return [Vedeu::Char]
@@ -59,6 +35,33 @@ module Vedeu
       cell
     end
+    # Write a collection of cells to the virtual terminal.
+    #
+    # @param data [Array<Array<Vedeu::Char>>]
+    # @return [Array<Array<Vedeu::Char>>]
+    def output(data)
+      Array(data).flatten.each do |char|
+        write(char.y, char.x, char) if char.is_a?(Vedeu::Char)
+      end
+      cells
+    end
+    # @return [void]
+    def render
+      renderer.render(cells)
+    end
+    # Removes all content from the virtual terminal; effectively clearing it.
+    #
+    # @return [Array<Array<Vedeu::Char>>]
+    def reset
+      @cells = new_virtual_terminal
+    end
+    alias_method :clear, :reset
+    # Write a single cell to the virtual terminal.
+    #
     # @param y [Fixnum]
     # @param x [Fixnum]
     # @param data [Vedeu::Char]
@@ -81,6 +84,11 @@ module Vedeu
       from[which] || []
     end
+    # @return [Array<Array<Vedeu::Char>>]
+    def new_virtual_terminal
+      Array.new(cell_height) { Array.new(cell_width) { Vedeu::Char.new } }
+    end
   end # VirtualTerminal
 end # Vedeu

data/lib/vedeu/output/wordwrap.rb CHANGED Viewed

@@ -99,6 +99,9 @@ module Vedeu
       text.split(/\n/)
     end
+    # @note
+    #   This may be unused. (GL 2015-02-20)
+    #
     # @return [String]
     def output
       processed.reduce([]) do |output, line|

data/lib/vedeu/output/writer.rb CHANGED Viewed

@@ -1,32 +1,44 @@
 module Vedeu
+  # Provides access to all possible mechanisms to write content.
+  #
+  # @note
+  #   Will be used to translate output into HTML, etc.
+  #
   class Writer
     attr_reader :writers
+    # @param args []
     # @return [Vedeu::Writer]
     def self.[](*args)
       new(args)
     end
+    # @param writers []
     # @return [Vedeu::Writer]
     def initialize(writers)
       @writers = writers
     end
+    # @param other []
+    # @return [Boolean]
     def ==(other)
       writers == other.writers
     end
+    # @param other []
     # @return [Vedeu::Writer]
     def +(other)
       Writer[*(writers + other.writers)]
     end
+    # @param stream []
+    # @return [Array]
     def write(stream)
       @writers.each { |writer| writer.write(stream) }
     end
-  end # Consoles
+  end # Writer
 end # Vedeu

data/lib/vedeu/presentation/background.rb CHANGED Viewed

@@ -4,6 +4,7 @@ module Vedeu
   # {Vedeu::Foreground}) of a terminal colour escape sequence.
   #
   # @api private
+  #
   class Background < Translator
     private