vedeu 0.8.2 → 0.8.3

data/lib/vedeu/cursors/cursor.rb

@@ -162,7 +162,7 @@ module Vedeu
 
       # Renders the cursor.
       #
-      # @return [Array<Vedeu::Cells::Escape>]
+      # @return [Array<Vedeu::Cells::Cursor>]
       def render
         Vedeu.render_output(escape_sequence)
       end
@@ -196,7 +196,7 @@ module Vedeu
       #   Vedeu.hide_cursor(Vedeu.focus)
       #   Vedeu.hide_cursor
       #
-      # @return [Vedeu::Cells::Escape]
+      # @return [Vedeu::Cells::Cursor]
       def hide
         super
 
@@ -233,7 +233,7 @@ module Vedeu
       #   Vedeu.show_cursor(Vedeu.focus)
       #   Vedeu.show_cursor
       #
-      # @return [Vedeu::Cells::Escape]
+      # @return [Vedeu::Cells::Cursor]
       def show
         super
 
@@ -290,9 +290,9 @@ module Vedeu
         }
       end
 
-      # @return [Vedeu::Cells::Escape]
+      # @return [Vedeu::Cells::Cursor]
       def escape_sequence
-        Vedeu::Cells::Escape.new(position: position, value: visibility)
+        Vedeu::Cells::Cursor.new(position: position, value: visibility)
       end
 
       # @return [Hash<Symbol => Fixnum>]

data/lib/vedeu/dsl/elements.rb

@@ -69,9 +69,28 @@ module Vedeu
 
         attrs = Vedeu::DSL::Attributes.build(self, model, nil, {}, &block)
 
-        l = Vedeu::Views::View.build(attrs, &block)
-        model.value = l.value
+        if view_model?
+          if model.lines?
+            l = Vedeu::Views::Line.build(attrs, &block)
+            model.add(l)
+
+          else
+            l = Vedeu::Views::View.build(attrs, &block)
+            model.value = l.value
+
+          end
+
+        elsif line_model?
+          l = Vedeu::Views::Line.build(attrs, &block)
+          model.value = l.value
+
+        else
+          l = Vedeu::Views::View.build(attrs, &block)
+          model.value = l.value
+
+        end
       end
+      alias_method :streams, :lines
 
       # @todo This documentation needs editing. (GL: 2015-12-17)
       #
@@ -121,83 +140,7 @@ module Vedeu
 
         end
       end
-
-      # @todo This documentation needs editing. (GL: 2015-12-17)
-      #
-      # Define multiple streams (a stream is a subset of a line).
-      # Uses {Vedeu::DSL::Stream} for all directives within the
-      # required block.
-      #
-      #   Vedeu.renders do
-      #     view :my_interface do
-      #       lines do
-      #         line do
-      #           streams do
-      #             # ... some code
-      #           end
-      #
-      #           stream do
-      #             # ... some code
-      #           end
-      #         end
-      #       end
-      #     end
-      #   end
-      #
-      # @param block [Proc]
-      # @macro raise_requires_block
-      # @raise [Vedeu::Error::Fatal]
-      # @return [void]
-      def streams(&block)
-        requires_block!(&block)
-        requires_model!
-
-        attrs = Vedeu::DSL::Attributes.build(self, model, nil, {}, &block)
-
-        l = Vedeu::Views::Line.build(attrs, &block)
-
-        if view_model?
-          model.add(l)
-
-        elsif line_model?
-          model.value = l.value
-
-        end
-      end
-
-      # @todo This documentation needs editing. (GL: 2015-12-17)
-      #
-      # @param value [String]
-      # @param opts [Hash]
-      # @option opts ... [void]
-      # @param block [Proc]
-      # @raise [Vedeu::Error::Fatal]
-      # @return [void]
-      def stream(value = '', opts = {}, &block)
-        requires_model!
-
-        attrs = Vedeu::DSL::Attributes.build(self, model, value, opts, &block)
-
-        l = if block_given?
-              Vedeu::Views::Line.build(attrs, &block)
-
-            else
-              s  = Vedeu::Views::Stream.new(attrs)
-              ss = Vedeu::Views::Streams.coerce([s])
-
-              Vedeu::Views::Line.new(attrs.merge!(value: ss))
-
-            end
-
-        if view_model? || line_model?
-          model.add(l)
-
-        else
-          fail Vedeu::Error::Fatal,
-               "Cannot add line to '#{model.class.name}' model."
-
-        end
-      end
+      alias_method :stream, :line
 
       # @todo This documentation needs editing. (GL: 2015-12-17)
       #

data/lib/vedeu/dsl/string/text.rb

@@ -21,7 +21,7 @@ module Vedeu
         @options = options || {}
       end
 
-      # @return [Array<Vedeu::Views::Char>]
+      # @return [Array<Vedeu::Cells::Char>]
       def chars
         return [] unless present?(value) && string?(value)
 
@@ -63,9 +63,9 @@ module Vedeu
         }
       end
 
-      # @return [Array<Vedeu::Views::Char>]
+      # @return [Array<Vedeu::Cells::Char>]
       def collection
-        text.chars.map { |char| Vedeu::Views::Char.new(attributes(char)) }
+        text.chars.map { |char| Vedeu::Cells::Char.new(attributes(char)) }
       end
 
       # @return [NilClass|String|Symbol]

data/lib/vedeu/editor/cropper.rb

@@ -36,7 +36,7 @@ module Vedeu
         @oy    = oy
       end
 
-      # Returns the visible lines as a sequence of {Vedeu::View::Char}
+      # Returns the visible lines as a sequence of {Vedeu::Cells::Char}
       # objects.
       #
       # @return [Array<void>]
@@ -45,7 +45,7 @@ module Vedeu
 
         visible.each_with_index do |line, iy|
           line.chars.each_with_index do |char, ix|
-            out << Vedeu::Views::Char.new(name:     name,
+            out << Vedeu::Cells::Char.new(name:     name,
                                           position: [(by + iy), (bx + ix)],
                                           value:    char)
           end

data/lib/vedeu/editor/cursor.rb

@@ -91,7 +91,7 @@ module Vedeu
       # document being edited.
       #
       # @return [Vedeu::Editor::Cursor]
-      # @todo GL 2015-10-02 Should ox/oy be 0; or set to @ox/@oy?
+      # @todo Should ox/oy be 0; or set to @ox/@oy? (GL: 2015-10-02)
       def refresh
         Vedeu::Cursors::Cursor.store(name:    name,
                                      x:       real_x,

data/lib/vedeu/editor/document.rb

@@ -257,7 +257,7 @@ module Vedeu
       # representation of the full document depending on the size of
       # the interface.
       #
-      # @return [Array<Vedeu::Views::Char>]
+      # @return [Array<Vedeu::Cells::Char>]
       def output
         Vedeu::Editor::Cropper.new(lines: lines,
                                    name:  name,

data/lib/vedeu/geometries/area/dimension.rb

@@ -115,7 +115,7 @@ module Vedeu
       # length from the values provided.
       #
       # @return [Boolean]
-      # @todo GL 2015-10-16 Investigate: should this be && or ||.
+      # @todo Investigate: should this be && or ||. (GL: 2015-10-16)
       def length?
         default && length
       end

data/lib/vedeu/geometries/position.rb

@@ -103,10 +103,13 @@ module Vedeu
       # @return [Hash<Symbol => Fixnum|NilClass>]
       def to_h
         {
-          y: y,
-          x: x,
+          position: {
+            y: y,
+            x: x,
+          }
         }
       end
+      alias_method :to_hash, :to_h
 
       # Return the escape sequence required to position the cursor at
       # a particular point on the screen. When passed a block, will do

data/lib/vedeu/interfaces/clear.rb

@@ -18,7 +18,7 @@ module Vedeu
         #   Vedeu.trigger(:_clear_view_, name)
         #   Vedeu.clear_by_name(name)
         #
-        # @return [Array<Array<Vedeu::Views::Char>>]
+        # @return [Array<Array<Vedeu::Cells::Char>>]
         # @see #initialize
         def render(name = Vedeu.focus)
           name || Vedeu.focus
@@ -34,7 +34,7 @@ module Vedeu
         #   Vedeu.trigger(:_clear_view_content_, name)
         #   Vedeu.clear_content_by_name(name)
         #
-        # @return [Array<Array<Vedeu::Views::Char>>]
+        # @return [Array<Array<Vedeu::Cells::Char>>]
         # @see #initialize
         def clear_content_by_name(name = Vedeu.focus)
           name || Vedeu.focus
@@ -55,14 +55,14 @@ module Vedeu
       #   to the terminal using a faster mechanism. The virtual buffer
       #   will still be updated. This improves the refresh time for
       #   Vedeu as we will not be building a grid of
-      #   {Vedeu::Views::Char} objects.
+      #   {Vedeu::Cells::Char} objects.
       # @return [Vedeu::Interfaces::Clear]
       def initialize(name, options = {})
         @name    = present?(name) ? name : Vedeu.focus
         @options = options
       end
 
-      # @return [Array<Array<Vedeu::Views::Char>>]
+      # @return [Array<Array<Vedeu::Cells::Char>>]
       def render
         if direct?
           Vedeu.direct_write(optimised_output)
@@ -157,7 +157,7 @@ module Vedeu
       # defined, then starting write space characters over the area
       # which the interface occupies.
       #
-      # @return [Array<Array<Vedeu::Views::Char>>]
+      # @return [Array<Array<Vedeu::Cells::Char>>]
       def output
         Vedeu.timer("Clearing #{clearing}: '#{name}'") do
           @clear ||= Array.new(height) do |iy|

data/lib/vedeu/models/row.rb

@@ -9,6 +9,7 @@ module Vedeu
     class Row
 
       include Enumerable
+      include Vedeu::Common
 
       # @!attribute [r] cells
       # @return [Array<NilClass|void>]
@@ -43,7 +44,7 @@ module Vedeu
       # @param index [Fixnum]
       # @return [NilClass|void]
       def cell(index)
-        return nil if index.nil?
+        return nil if index.nil? || empty?
 
         cells[index]
       end
@@ -79,9 +80,9 @@ module Vedeu
       # reset colour and style information to prevent colour bleed on
       # the next line.
       #
-      # @return [Vedeu::Views::Char]
+      # @return [Vedeu::Cells::Escape]
       def reset_character
-        Vedeu::Views::Char.new(value: Vedeu.esc.reset)
+        Vedeu::Cells::Escape.new(value: Vedeu.esc.reset)
       end
 
       # @return [Fixnum]

data/lib/vedeu/output/compressor.rb

@@ -4,7 +4,7 @@ module Vedeu
 
   module Output
 
-    # During the conversion of a Vedeu::Views::Char object into a
+    # During the conversion of a Vedeu::Cells::Char object into a
     # string of escape sequences, this class removes multiple
     # occurences of the same escape sequence, resulting in a smaller
     # payload being sent to the renderer.
@@ -24,7 +24,7 @@ module Vedeu
 
       # Returns a new instance of Vedeu::Output::Compressor.
       #
-      # @param output [Array<Array<Vedeu::Views::Char>>]
+      # @param output [Array<Array<Vedeu::Cells::Char>>]
       # @param options [Hash]
       # @option options compression [Boolean]
       # @return [Vedeu::Output::Compressor]
@@ -40,7 +40,7 @@ module Vedeu
       #   - Takes approximately ~25ms for 2100 chars. (2015-07-25)
       # @return [String]
       def render
-        return cached if compress?
+        return cached if compression?
 
         uncompress
       end
@@ -48,7 +48,7 @@ module Vedeu
       protected
 
       # @!attribute [r] output
-      # @return [Array<Array<Vedeu::Views::Char>>]
+      # @return [Array<Array<Vedeu::Cells::Char>>]
       attr_reader :output
 
       private
@@ -117,7 +117,7 @@ module Vedeu
       # coordinate has changed; i.e. we are on the same line, just
       # advancing a character.
       #
-      # @param char [Vedeu::Views::Char]
+      # @param char [Vedeu::Cells::Char]
       # @return [String]
       def position_for(char)
         return '' unless char.position
@@ -131,7 +131,7 @@ module Vedeu
       # character which has the same colours as the last character
       # output.
       #
-      # @param char [Vedeu::Views::Char]
+      # @param char [Vedeu::Cells::Char]
       # @return [String]
       def colour_for(char)
         return '' if char.colour == @colour
@@ -144,7 +144,7 @@ module Vedeu
       # character which has the same style(s) as the last character
       # output.
       #
-      # @param char [Vedeu::Views::Char]
+      # @param char [Vedeu::Cells::Char]
       # @return [String]
       def style_for(char)
         return '' if char.style == @style

data/lib/vedeu/output/output.rb

@@ -11,8 +11,7 @@ module Vedeu
     #
     class Output
 
-      # @param output [Array<Array<Vedeu::Views::Char>>|
-      #   NilClass|Vedeu::Cells::Escape]
+      # @param output (see #output)
       # @return [Array]
       def self.buffer_update(output)
         return nil if output.nil?
@@ -20,8 +19,7 @@ module Vedeu
         new(output).buffer_update
       end
 
-      # @param output [Array<Array<Vedeu::Views::Char>>|
-      #   NilClass|Vedeu::Cells::Escape]
+      # @param output (see #output)
       # @return [Array]
       def self.buffer_write(output)
         return nil if output.nil?
@@ -29,8 +27,7 @@ module Vedeu
         new(output).buffer_write
       end
 
-      # @param output [Array<Array<Vedeu::Views::Char>>|
-      #   NilClass|Vedeu::Cells::Escape]
+      # @param output (see #output)
       # @return [Array<String>]
       def self.direct_write(output)
         return nil if output.nil?
@@ -40,8 +37,7 @@ module Vedeu
 
       # Writes output to the defined renderers.
       #
-      # @param output [Array<Array<Vedeu::Views::Char>>|
-      #   NilClass|Vedeu::Cells::Escape]
+      # @param output (see #output)
       # @return [Array|NilClass|String]
       def self.render_output(output)
         return nil if output.nil?
@@ -51,8 +47,7 @@ module Vedeu
 
       # Return a new instance of Vedeu::Output::Output.
       #
-      # @param output [Array<Array<Vedeu::Views::Char>>|
-      #   NilClass|Vedeu::Cells::Escape]
+      # @param output (see #output)
       # @return [Vedeu::Output::Output]
       def initialize(output)
         @output = output
@@ -94,15 +89,15 @@ module Vedeu
       protected
 
       # @!attribute [r] output
-      # @return [Array<Array<Vedeu::Views::Char>>|
-      #   NilClass|Vedeu::Cells::Escape]
+      # @return [Array<Array<Vedeu::Cells::Char>>|
+      #   NilClass|Vedeu::Cells::Escape|Vedeu::Cells::Cursor]
       attr_reader :output
 
       private
 
       # @return [Boolean]
       def escape_sequence?
-        output.is_a?(Vedeu::Cells::Escape)
+        output.is_a?(Vedeu::Cells::Escape) || output.is_a?(Vedeu::Cells::Cursor)
       end
 
     end # Output

data/lib/vedeu/output/viewport.rb

@@ -67,7 +67,7 @@ module Vedeu
 
       private
 
-      # @return [Array<Array<Vedeu::Views::Char>>]
+      # @return [Array<Array<Vedeu::Cells::Char>>]
       def output
         Vedeu.timer("Rendering content: '#{name}'") do
           out = []