vedeu 0.5.4 → 0.5.5

data/lib/vedeu/output/html_char.rb

@@ -1,13 +1,13 @@
 module Vedeu
 
-  # Represents a {Vedeu::Char} as a HTML tag with value. By default, a table
-  # cell is used.
+  # Represents a {Vedeu::Views::Char} as a HTML tag with value. By default, a
+  # table cell is used.
   #
   class HTMLChar
 
     include Vedeu::Common
 
-    # @param char [Vedeu::Char]
+    # @param char [Vedeu::Views::Char]
     # @param options [Hash<Symbol => String>]
     # @option options start_tag [String]
     # @option options end_tag [String]
@@ -18,7 +18,7 @@ module Vedeu
 
     # Returns a new instance of Vedeu::HTMLChar.
     #
-    # @param char [Vedeu::Char]
+    # @param char [Vedeu::Views::Char]
     # @param options [Hash<Symbol => String>]
     # @option options start_tag [String]
     # @option options end_tag [String]
@@ -36,7 +36,7 @@ module Vedeu
     protected
 
     # @!attribute [r] char
-    # @return [Vedeu::Char]
+    # @return [Vedeu::Views::Char]
     attr_reader :char
 
     private
@@ -90,7 +90,7 @@ module Vedeu
       @bg ||= colour(char, 'background', '#000')
     end
 
-    # @param char [Vedeu::Char]
+    # @param char [Vedeu::Views::Char]
     # @param type [String]
     # @param default [String]
     # @return [String]

data/lib/vedeu/output/output.rb

@@ -14,7 +14,7 @@ module Vedeu
 
     # Return a new instance of Vedeu::Output.
     #
-    # @param output [Array<Array<Vedeu::Char>>]
+    # @param output [Array<Array<Vedeu::Views::Char>>]
     # @return [Output]
     def initialize(output)
       @output = output
@@ -30,13 +30,13 @@ module Vedeu
         # Vedeu::Renderers::HTML.to_file(Vedeu::VirtualBuffer.retrieve)
       end
 
-      Vedeu.renderers.render(output)
+      Vedeu.renderers.render(output) if Vedeu.ready?
     end
 
     protected
 
     # @!attribute [r] output
-    # @return [Array<Array<Vedeu::Char>>]
+    # @return [Array<Array<Vedeu::Views::Char>>]
     attr_reader :output
 
   end # Output

data/lib/vedeu/output/presentation.rb

@@ -4,7 +4,7 @@ require 'vedeu/output/presentation/style'
 module Vedeu
 
   # This module allows the sharing of presentation concerns between the models:
-  # Interface, Line and Stream.
+  # Interface, View, Line and Stream.
   #
   module Presentation
 

data/lib/vedeu/output/renderers/escape_sequence.rb

@@ -17,7 +17,7 @@ module Vedeu
 
       # Render the output with the escape sequences escaped.
       #
-      # @param output [Array<Array<Vedeu::Char>>]
+      # @param output [Array<Array<Vedeu::Views::Char>>]
       # @return [String]
       def render(output)
         @parsed ||= Array(output).flatten.map do |char|

data/lib/vedeu/output/renderers/file.rb

@@ -17,7 +17,7 @@ module Vedeu
         @options = options || {}
       end
 
-      # @param output [Array<Array<Vedeu::Char>>]
+      # @param output [Array<Array<Vedeu::Views::Char>>]
       # @return [String]
       def render(output)
         ::File.write(filename, output) if write_file?

data/lib/vedeu/output/renderers/html.rb

@@ -19,7 +19,7 @@ module Vedeu
         @options = options || {}
       end
 
-      # @param output [Array<Array<Vedeu::Char>>]
+      # @param output [Array<Array<Vedeu::Views::Char>>]
       # @return [String]
       def render(output)
         @options[:content] = output
@@ -39,7 +39,7 @@ module Vedeu
         Array(content).each do |line|
           out << "#{start_row_tag}\n"
           line.each do |char|
-            if char.is_a?(Vedeu::Char)
+            if char.is_a?(Vedeu::Views::Char)
               out << char.to_html
               out << "\n"
             end
@@ -51,7 +51,7 @@ module Vedeu
 
       private
 
-      # @return [Array<Array<Vedeu::Char>>]
+      # @return [Array<Array<Vedeu::Views::Char>>]
       def content
         options[:content]
       end

data/lib/vedeu/output/renderers/json.rb

@@ -14,7 +14,7 @@ module Vedeu
         @options = options || {}
       end
 
-      # @param output [Array<Array<Vedeu::Char>>]
+      # @param output [Array<Array<Vedeu::Views::Char>>]
       # @return [String]
       def render(output)
         super(parsed(output))
@@ -22,7 +22,7 @@ module Vedeu
 
       private
 
-      # @param output [Array<Array<Vedeu::Char>>]
+      # @param output [Array<Array<Vedeu::Views::Char>>]
       # @return [String]
       def parsed(output)
         return '' if output.nil? || output.empty?
@@ -30,13 +30,13 @@ module Vedeu
         ::JSON.pretty_generate(as_hash(output))
       end
 
-      # @param output [Array<Array<Vedeu::Char>>]
+      # @param output [Array<Array<Vedeu::Views::Char>>]
       # @return [Array]
       def as_hash(output)
         sorted(output).map(&:to_hash)
       end
 
-      # @param output [Array<Array<Vedeu::Char>>]
+      # @param output [Array<Array<Vedeu::Views::Char>>]
       # @return [Array]
       def sorted(output)
         Array(output).flatten.sort { |a, b| a.position <=> b.position }

data/lib/vedeu/output/renderers/null.rb

@@ -16,7 +16,7 @@ module Vedeu
         @options = options || {}
       end
 
-      # @param output [Array<Array<Vedeu::Char>>]
+      # @param output [Array<Array<Vedeu::Views::Char>>]
       # @return [String]
       def render(output)
         output

data/lib/vedeu/output/renderers/terminal.rb

@@ -2,8 +2,8 @@ module Vedeu
 
   module Renderers
 
-    # Converts a grid of {Vedeu::Char} objects into a stream of escape sequences
-    # and content suitable for a terminal.
+    # Converts a grid of {Vedeu::Views::Char} objects into a stream of escape
+    # sequences and content suitable for a terminal.
     #
     class Terminal
 
@@ -17,7 +17,7 @@ module Vedeu
         @options = options || {}
       end
 
-      # @param output [Array<Array<Vedeu::Char>>]
+      # @param output [Array<Array<Vedeu::Views::Char>>]
       # @return [Array<String>]
       def render(output)
         Vedeu::Terminal.output(parsed(output))
@@ -25,8 +25,8 @@ module Vedeu
 
       private
 
-      # @param output [Array<Array<Vedeu::Char>>]
-      # @return [Array<Array<Vedeu::Char>>]
+      # @param output [Array<Array<Vedeu::Views::Char>>]
+      # @return [Array<Array<Vedeu::Views::Char>>]
       def parsed(output)
         Vedeu.timer('Compression') do
           Vedeu::Compressor.render(output)

data/lib/vedeu/output/renderers/text.rb

@@ -2,8 +2,8 @@ module Vedeu
 
   module Renderers
 
-    # Converts a grid of {Vedeu::Char} objects into a stream of escape sequences
-    # and content.
+    # Converts a grid of {Vedeu::Views::Char} objects into a stream of escape
+    # sequences and content.
     #
     class Text
 
@@ -17,7 +17,7 @@ module Vedeu
         @options = options || {}
       end
 
-      # @param output [Array<Array<Vedeu::Char>>]
+      # @param output [Array<Array<Vedeu::Views::Char>>]
       # @return [String]
       def render(output)
         Vedeu::Compressor.render(output)

data/lib/vedeu/output/style.rb

@@ -56,7 +56,7 @@ module Vedeu
 
     # An object is equal when its values are the same.
     #
-    # @param other [Vedeu::Char]
+    # @param other [Vedeu::Views::Char]
     # @return [Boolean]
     def eql?(other)
       self.class == other.class && value == other.value

data/lib/vedeu/output/text.rb

@@ -22,7 +22,8 @@ module Vedeu
     # @option options background [String]
     # @option options colour [Hash|NilClass]
     # @option options foreground [String]
-    # @option options model [Vedeu::Interface|Vedeu::Line|Vedeu::Stream]
+    # @option options model
+    #   [Vedeu::Views::View|Vedeu::Views::Line|Vedeu::Views::Stream]
     # @option options pad [String]
     # @option options width [Integer]
     # @return [Vedeu::Text]
@@ -80,7 +81,7 @@ module Vedeu
     end
 
     # If a colour, background or foreground option is set, use them as the
-    # colour settings for the new Vedeu::Stream.
+    # colour settings for the new Vedeu::Views::Stream.
     #
     # @return [void]
     def colour
@@ -93,11 +94,12 @@ module Vedeu
       end
     end
 
-    # Returns either a Vedeu::Line or Vedeu::Stream containing the text value.
+    # Returns either a Vedeu::Views::Line or Vedeu::Views::Stream containing the
+    # text value.
     #
-    # @return [Vedeu::Line|Vedeu::Stream]
+    # @return [Vedeu::Views::Line|Vedeu::Views::Stream]
     def content
-      if model.is_a?(Vedeu::Interface)
+      if model.is_a?(Vedeu::Views::View)
         stream.parent = line
         line.add(stream)
         line
@@ -128,14 +130,17 @@ module Vedeu
       string.ljust(width, pad)
     end
 
-    # @return [Vedeu::Line]
+    # @return [Vedeu::Views::Line]
     def line
-      @line ||= Vedeu::Line.build(parent: parent)
+      @line ||= Vedeu::Views::Line.build(parent: parent)
     end
 
     # Returns the model option when set.
     #
-    # @return [Vedeu::Interface|Vedeu::Line|Vedeu::Null::Generic|Vedeu::Stream]
+    # @return [Vedeu::Views::View|
+    #          Vedeu::Views::Line|
+    #          Vedeu::Null::Generic|
+    #          Vedeu::Views::Stream]
     def model
       @model ||= options[:model] || Vedeu::Null::Generic.new
     end
@@ -147,11 +152,11 @@ module Vedeu
       options[:pad]
     end
 
-    # Returns the parent for the new Vedeu::Stream.
+    # Returns the parent for the new Vedeu::Views::Stream.
     #
     # @return [void]
     def parent
-      model.is_a?(Vedeu::Stream) ? model.parent : model
+      model.is_a?(Vedeu::Views::Stream) ? model.parent : model
     end
 
     # The string padded to width, right justified.
@@ -161,14 +166,14 @@ module Vedeu
       string.rjust(width, pad)
     end
 
-    # Builds and returns a new Vedeu::Stream.
+    # Builds and returns a new Vedeu::Views::Stream.
     #
     # @return [void]
     def stream
-      @stream ||= Vedeu::Stream.build(colour: colour,
-                                      parent: parent,
-                                      style:  style,
-                                      value:  aligned)
+      @stream ||= Vedeu::Views::Stream.build(colour: colour,
+                                             parent: parent,
+                                             style:  style,
+                                             value:  aligned)
     end
 
     # The string, coerced.

data/lib/vedeu/output/viewport.rb

@@ -10,7 +10,7 @@ module Vedeu
 
     extend Forwardable
 
-    def_delegators :interface,
+    def_delegators :view,
                    :lines,
                    :lines?,
                    :name,
@@ -24,28 +24,21 @@ module Vedeu
                    :ox,
                    :oy
 
-    # @param interface [Vedeu::Interface]
-    # @return [Array<Array<Vedeu::Char>>]
-    def self.render(interface)
-      if interface.visible?
-        new(interface).render
-
-      else
-        []
-
-      end
+    # @param view [Vedeu::Views::View]
+    # @return [Array<Array<Vedeu::Views::Char>>]
+    def self.render(view)
+      new(view).render
     end
 
     # Returns an instance of Vedeu::Viewport.
     #
-    # @param interface [Vedeu::Interface] An instance of interface.
-    # @return [Viewport]
-    def initialize(interface)
-      @interface = interface
+    # @param view [Vedeu::Views::View]
+    # @return [Vedeu::Viewport]
+    def initialize(view)
+      @view = view
     end
 
-    # Returns the interface with border (when enabled) and the content for the
-    # interface.
+    # Returns the content for the view.
     #
     # @return [Array<Array<String>>]
     def render
@@ -75,13 +68,13 @@ module Vedeu
 
     protected
 
-    # @!attribute [r] interface
-    # @return [Vedeu::Interface]
-    attr_reader :interface
+    # @!attribute [r] view
+    # @return [Vedeu::Views::View]
+    attr_reader :view
 
     private
 
-    # Returns the visible content for the interface.
+    # Returns the visible content for the view.
     #
     # @note If there are no lines of content, we return an empty array. If there
     #   are no more columns of content we return a space enclosed in an array;
@@ -148,7 +141,7 @@ module Vedeu
       end
     end
 
-    # Return the border associated with the interface we are drawing.
+    # Return the border associated with the interface/view we are drawing.
     #
     # @return (see Vedeu::Borders#by_name)
     def border
@@ -165,7 +158,7 @@ module Vedeu
       @by ||= border.by
     end
 
-    # Fetch the cursor associated with the interface we are drawing.
+    # Fetch the cursor associated with the interface/view we are drawing.
     #
     # @return (see Vedeu::Cursors#by_name)
     def cursor

data/lib/vedeu/output/virtual_buffer.rb

@@ -3,14 +3,15 @@ module Vedeu
   # Store and retrieve {Vedeu::VirtualTerminal} objects.
   #
   # Each {Vedeu::VirtualTerminal} object is a copy of the current terminal
-  # including content but not as String objects but {Vedeu::Char} objects. Using
-  # {Vedeu::Char} objects means that we can store the data used to make up the
-  # displayed character, complete with its colour, position and style.
+  # including content but not as String objects but {Vedeu::Views::Char}
+  # objects. Using {Vedeu::Views::Char} objects means that we can store the data
+  # used to make up the displayed character, complete with its colour, position
+  # and style.
   #
-  # Once a {Vedeu::Char} has been converted to a String, it is tricky to
+  # Once a {Vedeu::Views::Char} has been converted to a String, it is tricky to
   # separate the escape sequences and string data. By deferring this conversion
-  # we can display the {Vedeu::Char} in multiple ways (e.g. HTML) or in multiple
-  # formats (e.g. JSON), and render/use that in an appropriate way.
+  # we can display the {Vedeu::Views::Char} in multiple ways (e.g. HTML) or in
+  # multiple formats (e.g. JSON), and render/use that in an appropriate way.
   #
   module VirtualBuffer
 
@@ -18,7 +19,7 @@ module Vedeu
 
     # Fetch the oldest stored virtual buffer first.
     #
-    # @return [Array<Array<Vedeu::Char>>|NilClass]
+    # @return [Array<Array<Vedeu::Views::Char>>|NilClass]
     def retrieve
       Vedeu.log(type: :drb, message: 'Retrieving output')
 
@@ -27,7 +28,7 @@ module Vedeu
 
     # Store a new virtual buffer.
     #
-    # @return [Array<Array<Vedeu::Char>>]
+    # @return [Array<Array<Vedeu::Views::Char>>]
     def store(data)
       Vedeu.log(type: :drb, message: 'Storing output')
 

data/lib/vedeu/output/virtual_terminal.rb

@@ -29,10 +29,10 @@ module Vedeu
       @renderer = renderer
     end
 
-    # Return a grid of {Vedeu::Char} objects defined by the height and width of
-    # this virtual terminal.
+    # Return a grid of {Vedeu::Views::Char} objects defined by the height and
+    # width of this virtual terminal.
     #
-    # @return [Array<Array<Vedeu::Char>>]
+    # @return [Array<Array<Vedeu::Views::Char>>]
     def cells
       @cells ||= new_virtual_terminal
     end
@@ -46,7 +46,7 @@ module Vedeu
     #
     # @param y [Fixnum] The row/line coordinate.
     # @param x [Fixnum] The column/character coordinate.
-    # @return [Vedeu::Char]
+    # @return [Vedeu::Views::Char]
     def read(y, x)
       cy, cx = Vedeu::PositionIndex[y, x]
 
@@ -58,11 +58,11 @@ module Vedeu
 
     # Write a collection of cells to the virtual terminal.
     #
-    # @param data [Array<Array<Vedeu::Char>>]
-    # @return [Array<Array<Vedeu::Char>>]
+    # @param data [Array<Array<Vedeu::Views::Char>>]
+    # @return [Array<Array<Vedeu::Views::Char>>]
     def output(data)
       Array(data).flatten.each do |char|
-        write(char.y, char.x, char) if char.is_a?(Vedeu::Char)
+        write(char.y, char.x, char) if char.is_a?(Vedeu::Views::Char)
       end
 
       cells
@@ -77,7 +77,7 @@ module Vedeu
 
     # Removes all content from the virtual terminal; effectively clearing it.
     #
-    # @return [Array<Array<Vedeu::Char>>]
+    # @return [Array<Array<Vedeu::Views::Char>>]
     def reset
       @cells = new_virtual_terminal
     end
@@ -91,8 +91,8 @@ module Vedeu
     #
     # @param y [Fixnum] The row/line coordinate.
     # @param x [Fixnum] The column/character coordinate.
-    # @param data [Vedeu::Char]
-    # @return [Vedeu::Char]
+    # @param data [Vedeu::Views::Char]
+    # @return [Vedeu::Views::Char]
     def write(y, x, data)
       return false unless read(y, x).is_a?(Vedeu::Cell)
 
@@ -107,7 +107,7 @@ module Vedeu
     # @param from [Array] An Array of rows, or an Array of cells.
     # @param which [Fixnum] A Fixnum representing the index; the row number or
     #   the cell number for a row.
-    # @return [Array<Vedeu::Char>|Array]
+    # @return [Array<Vedeu::Views::Char>|Array]
     def fetch(from, which)
       from[which] || []
     end