vedeu 0.8.2 → 0.8.3

data/examples/views/runner.sh

@@ -2,26 +2,72 @@
 
 set -e
 
-function test_output() {
-  "$@"
-  local status=$?
-  if [ $status -ne 0 ]; then
-    echo "Error with $1" >&2
-  fi
-  return $status
+function expected {
+  printf "\e[32mExpected:\e[39m "
 }
+function actual {
+  printf "\e[31mActual:\e[39m   "
+}
+
+./line.rb
+./lines.rb
+./lines_alignment.rb
+./full_screen.rb
+
+echo -ne "\e[34mline out\e[39m\n"
+echo -ne "$(expected) $(du -b ./expected/vedeu_line.out | cut -f1)\n"
+echo -ne "$(actual) $(du -b /tmp/vedeu_line.out | cut -f1)\n"
+echo -ne "\e[33mhtml\e[39m\n"
+echo -ne "$(expected) $(du -b ./expected/vedeu_line.html | cut -f1)\n"
+echo -ne "$(actual) $(du -b /tmp/vedeu_line.html | cut -f1)\n"
+echo -ne "\e[33mjson\e[39m\n"
+echo -ne "$(expected) $(du -b ./expected/vedeu_line.json | cut -f1)\n"
+echo -ne "$(actual) $(du -b /tmp/vedeu_line.json | cut -f1)\n"
+echo -ne "\e[33mtxt\e[39m\n"
+echo -ne "$(expected) $(du -b ./expected/vedeu_line.txt | cut -f1)\n"
+echo -ne "$(actual) $(du -b /tmp/vedeu_line.txt | cut -f1)\n"
+
+echo -ne "\n"
+
+echo -ne "\e[34mlines out\e[39m\n"
+echo -ne "$(expected) $(du -b ./expected/vedeu_lines.out | cut -f1)\n"
+echo -ne "$(actual) $(du -b /tmp/vedeu_lines.out | cut -f1)\n"
+echo -ne "\e[33mhtml\e[39m\n"
+echo -ne "$(expected) $(du -b ./expected/vedeu_lines.html | cut -f1)\n"
+echo -ne "$(actual) $(du -b /tmp/vedeu_lines.html | cut -f1)\n"
+echo -ne "\e[33mjson\e[39m\n"
+echo -ne "$(expected) $(du -b ./expected/vedeu_lines.json | cut -f1)\n"
+echo -ne "$(actual) $(du -b /tmp/vedeu_lines.json | cut -f1)\n"
+echo -ne "\e[33mtxt\e[39m\n"
+echo -ne "$(expected) $(du -b ./expected/vedeu_lines.txt | cut -f1)\n"
+echo -ne "$(actual) $(du -b /tmp/vedeu_lines.txt | cut -f1)\n"
+
+echo -ne "\n"
 
-test_output ./line.rb
-test_output diff -q /tmp/line.out ./expected/line.out
-du -b /tmp/line.out | cut -f1
-du -b ./expected/line.out | cut -f1
+echo -ne "\e[34mlines alignment out\e[39m\n"
+echo -ne "$(expected) $(du -b ./expected/vedeu_lines_alignment.out | cut -f1)\n"
+echo -ne "$(actual) $(du -b /tmp/vedeu_lines_alignment.out | cut -f1)\n"
+echo -ne "\e[33mhtml\e[39m\n"
+echo -ne "$(expected) $(du -b ./expected/vedeu_lines_alignment.html | cut -f1)\n"
+echo -ne "$(actual) $(du -b /tmp/vedeu_lines_alignment.html | cut -f1)\n"
+echo -ne "\e[33mjson\e[39m\n"
+echo -ne "$(expected) $(du -b ./expected/vedeu_lines_alignment.json | cut -f1)\n"
+echo -ne "$(actual) $(du -b /tmp/vedeu_lines_alignment.json | cut -f1)\n"
+echo -ne "\e[33mtxt\e[39m\n"
+echo -ne "$(expected) $(du -b ./expected/vedeu_lines_alignment.txt | cut -f1)\n"
+echo -ne "$(actual) $(du -b /tmp/vedeu_lines_alignment.txt | cut -f1)\n"
 
-test_output ./lines.rb
-test_output diff -q /tmp/lines.out ./expected/lines.out
-du -b /tmp/lines.out | cut -f1
-du -b ./expected/lines.out | cut -f1
+echo -ne "\n"
 
-test_output ./lines_alignment.rb
-test_output diff -q /tmp/lines_alignment.out ./expected/lines_alignment.out
-du -b /tmp/lines_alignment.out | cut -f1
-du -b ./expected/lines_alignment.out | cut -f1
+echo -ne "\e[34mfull screen out\e[39m\n"
+echo -ne "$(expected) $(du -b ./expected/vedeu_full_screen.out | cut -f1)\n"
+echo -ne "$(actual) $(du -b /tmp/vedeu_full_screen.out | cut -f1)\n"
+echo -ne "\e[33mhtml\e[39m\n"
+echo -ne "$(expected) $(du -b ./expected/vedeu_full_screen.html | cut -f1)\n"
+echo -ne "$(actual) $(du -b /tmp/vedeu_full_screen.html | cut -f1)\n"
+echo -ne "\e[33mjson\e[39m\n"
+echo -ne "$(expected) $(du -b ./expected/vedeu_full_screen.json | cut -f1)\n"
+echo -ne "$(actual) $(du -b /tmp/vedeu_full_screen.json | cut -f1)\n"
+echo -ne "\e[33mtxt\e[39m\n"
+echo -ne "$(expected) $(du -b ./expected/vedeu_full_screen.txt | cut -f1)\n"
+echo -ne "$(actual) $(du -b /tmp/vedeu_full_screen.txt | cut -f1)\n"

data/lib/vedeu/borders/border.rb

@@ -179,11 +179,11 @@ module Vedeu
           bottom_right:      bottom_right,
           caption:           @caption,
           client:            @client,
-          colour:            @colour,
+          colour:            colour,
           enabled:           @enabled,
           horizontal:        @horizontal,
           left_vertical:     left_vertical,
-          name:              @name,
+          name:              name,
           parent:            @parent,
           repository:        @repository,
           right_vertical:    right_vertical,
@@ -191,7 +191,7 @@ module Vedeu
           show_left:         @show_left,
           show_right:        @show_right,
           show_top:          @show_top,
-          style:             @style,
+          style:             style,
           title:             @title,
           top_horizontal:    top_horizontal,
           top_left:          top_left,
@@ -282,9 +282,9 @@ module Vedeu
       # @return [Hash<Symbol => void>]
       def cell_attributes
         {
-          colour: @colour,
-          name:   @name,
-          style:  @style,
+          colour: colour,
+          name:   name,
+          style:  style,
         }
       end
 

data/lib/vedeu/borders/refresh.rb

@@ -71,7 +71,7 @@ module Vedeu
         @name = present?(name) ? name : Vedeu.focus
       end
 
-      # @return [Array<Array<Vedeu::Views::Char>>]
+      # @return [Array<Array<Vedeu::Cells::Char>>]
       def by_name
         Vedeu.render_output(output) if enabled? && visible?
       end
@@ -101,7 +101,7 @@ module Vedeu
         @border ||= Vedeu.borders.by_name(name)
       end
 
-      # @return [Array<Array<Vedeu::Views::Char>>]
+      # @return [Array<Array<Vedeu::Cells::Char>>]
       def output
         Vedeu.timer("Drawing border: '#{name}'") do
           [
@@ -179,8 +179,7 @@ module Vedeu
 
       # An optional caption for when the bottom border is to be shown.
       #
-      # @return [Array<Vedeu::Views::Char>]
-      # @see [Vedeu::Borders::Caption#render]
+      # @return (see Vedeu::Borders::Caption#render)
       def captionbar
         characters = build_collection(bordered_width) do |ix|
           cell = bottom_horizontal.dup
@@ -195,8 +194,7 @@ module Vedeu
 
       # An optional title for when the top border is to be shown.
       #
-      # @return [Array<Vedeu::Views::Char>]
-      # @see [Vedeu::Borders::Title#render]
+      # @return (see Vedeu::Borders::Title#render)
       def titlebar
         characters = build_collection(bordered_width) do |ix|
           cell = top_horizontal.dup

data/lib/vedeu/buffers/buffer.rb

@@ -131,7 +131,7 @@ module Vedeu
       # - If the 'previous' buffer is empty, return an empty
       #   collection.
       #
-      # @return [Array<Array<Array<Vedeu::Views::Char>>>]
+      # @return [Array<Array<Array<Vedeu::Cells::Char>>>]
       def render
         current = if back?
                     swap

data/lib/vedeu/buffers/terminal.rb

@@ -52,8 +52,8 @@ module Vedeu
       # Write a collection of cells to the virtual terminal, but do
       # not send to a renderer.
       #
-      # @param value_or_values [Array<Array<Vedeu::Views::Char>>]
-      # @return [Array<Array<Vedeu::Views::Char>>]
+      # @param value_or_values [Array<Array<Vedeu::Cells::Char>>]
+      # @return [Array<Array<Vedeu::Cells::Char>>]
       def update(value_or_values)
         buffer.update(value_or_values)
       end
@@ -67,8 +67,8 @@ module Vedeu
       # @example
       #   Vedeu.trigger(:_drb_store_output_, value_or_values)
       #
-      # @param value_or_values [Array<Array<Vedeu::Views::Char>>]
-      # @return [Array<Array<Vedeu::Views::Char>>]
+      # @param value_or_values [Array<Array<Vedeu::Cells::Char>>]
+      # @return [Array<Array<Vedeu::Cells::Char>>]
       def write(value_or_values)
         buffer.update(value_or_values)
 

data/lib/vedeu/buffers/view.rb

@@ -35,8 +35,8 @@ module Vedeu
         Vedeu::Buffers::View.new(attributes)
       end
 
-      # @param value_or_values [Array<Array<Vedeu::Views::Char>>|
-      #   Vedeu::Views::Char]
+      # @param value_or_values [Array<Array<Vedeu::Cells::Char>>|
+      #   Vedeu::Cells::Char]
       # @return [Vedeu::Buffers::View]
       def update(value_or_values)
         Array(value_or_values).flatten.each do |value|

data/lib/vedeu/cells/all.rb

@@ -15,11 +15,11 @@ module Vedeu
 
 end # Vedeu
 
+require 'vedeu/cells/support/all'
 require 'vedeu/cells/empty'
 require 'vedeu/cells/border'
 require 'vedeu/cells/borders/all'
 require 'vedeu/cells/char'
 require 'vedeu/cells/clear'
+require 'vedeu/cells/cursor'
 require 'vedeu/cells/escape'
-require 'vedeu/cells/html'
-require 'vedeu/cells/json'

data/lib/vedeu/cells/border.rb

@@ -42,6 +42,11 @@ module Vedeu
         self
       end
 
+      # @return [Symbol]
+      def type
+        :border
+      end
+
       # @return [String]
       def value
         return '' unless present?(@value)

data/lib/vedeu/cells/borders/all.rb

@@ -10,12 +10,6 @@ end # Vedeu
 
 require 'vedeu/cells/borders/corner'
 require 'vedeu/cells/borders/horizontal'
-require 'vedeu/cells/borders/bottom_horizontal'
-require 'vedeu/cells/borders/bottom_left'
-require 'vedeu/cells/borders/bottom_right'
-require 'vedeu/cells/borders/top_horizontal'
-require 'vedeu/cells/borders/top_left'
-require 'vedeu/cells/borders/top_right'
 require 'vedeu/cells/borders/vertical'
-require 'vedeu/cells/borders/left_vertical'
-require 'vedeu/cells/borders/right_vertical'
+require 'vedeu/cells/borders/vertices/all'
+require 'vedeu/cells/borders/edges/all'

data/lib/vedeu/cells/borders/edges/all.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require 'vedeu/cells/borders/edges/bottom_horizontal'
+require 'vedeu/cells/borders/edges/top_horizontal'
+require 'vedeu/cells/borders/edges/left_vertical'
+require 'vedeu/cells/borders/edges/right_vertical'

data/lib/vedeu/cells/borders/horizontal.rb

@@ -11,6 +11,11 @@ module Vedeu
     #
     class Horizontal < Vedeu::Cells::Border
 
+      # @return [String]
+      def as_html
+        '&#x2500;'
+      end
+
       # @return [String]
       def text
         '-'

data/lib/vedeu/cells/borders/vertical.rb

@@ -11,6 +11,11 @@ module Vedeu
     #
     class Vertical < Vedeu::Cells::Border
 
+      # @return [String]
+      def as_html
+        '&#x2502;'
+      end
+
       # @return [String]
       def text
         '|'

data/lib/vedeu/cells/borders/vertices/all.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require 'vedeu/cells/borders/vertices/bottom_left'
+require 'vedeu/cells/borders/vertices/bottom_right'
+require 'vedeu/cells/borders/vertices/top_left'
+require 'vedeu/cells/borders/vertices/top_right'

data/lib/vedeu/cells/borders/{bottom_left.rb → vertices/bottom_left.rb}

@@ -11,6 +11,11 @@ module Vedeu
     #
     class BottomLeft < Vedeu::Cells::Corner
 
+      # @return [String]
+      def as_html
+        '&#x2514;'
+      end
+
       # @return [Symbol]
       def type
         :bottom_left

data/lib/vedeu/cells/borders/{bottom_right.rb → vertices/bottom_right.rb}

@@ -11,6 +11,11 @@ module Vedeu
     #
     class BottomRight < Vedeu::Cells::Corner
 
+      # @return [String]
+      def as_html
+        '&#x2518;'
+      end
+
       # @return [Symbol]
       def type
         :bottom_right

data/lib/vedeu/cells/borders/{top_left.rb → vertices/top_left.rb}

@@ -11,6 +11,11 @@ module Vedeu
     #
     class TopLeft < Vedeu::Cells::Corner
 
+      # @return [String]
+      def as_html
+        '&#x250C;'
+      end
+
       # @return [Symbol]
       def type
         :top_left

data/lib/vedeu/cells/borders/{top_right.rb → vertices/top_right.rb}

@@ -11,6 +11,11 @@ module Vedeu
     #
     class TopRight < Vedeu::Cells::Corner
 
+      # @return [String]
+      def as_html
+        '&#x2510;'
+      end
+
       # @return [Symbol]
       def type
         :top_right

data/lib/vedeu/cells/char.rb

@@ -14,6 +14,17 @@ module Vedeu
     #
     class Char < Vedeu::Cells::Empty
 
+      # @return [String]
+      def as_html
+        if present?(value)
+          value
+
+        else
+          super
+
+        end
+      end
+
       # @return [Boolean]
       def cell?
         false
@@ -24,6 +35,11 @@ module Vedeu
         @value || ' '
       end
 
+      # @return [Symbol]
+      def type
+        :char
+      end
+
     end # Char
 
   end # Cells

data/lib/vedeu/cells/clear.rb

@@ -19,6 +19,11 @@ module Vedeu
         false
       end
 
+      # @return [Symbol]
+      def type
+        :clear
+      end
+
       # @return [String]
       def value
         ' '

data/lib/vedeu/cells/cursor.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module Vedeu
+
+  module Cells
+
+    # Provides the position and visibility escape sequence for a
+    # {Vedeu::Cursors::Cursor}
+    #
+    # @api private
+    #
+    class Cursor < Vedeu::Cells::Empty
+
+      include Vedeu::Geometries::Positionable
+
+      # @return [Boolean]
+      def cell?
+        false
+      end
+
+      # @return [NilClass]
+      def null
+        nil
+      end
+      alias_method :background, :null
+      alias_method :colour,     :null
+      alias_method :foreground, :null
+      alias_method :style,      :null
+
+      # Return an empty hash as most escape sequences won't make
+      # sense as JSON.
+      #
+      # @return [Hash<void>]
+      def to_h
+        {}.merge!(position.to_h).merge!(value: value)
+      end
+      alias_method :to_hash, :to_h
+
+      # Return an empty string as most escape sequences won't make
+      # sense as HTML.
+      #
+      # @param _options [Hash] Ignored.
+      # @return [String]
+      def to_html(_options = {})
+        ''
+      end
+
+      # @return [String]
+      def to_s
+        "#{position}#{value}"
+      end
+      alias_method :to_str, :to_s
+
+      # @return [Symbol]
+      def type
+        :cursor
+      end
+
+      private
+
+      # @return [Hash]
+      def defaults
+        super.merge!(position: [1, 1])
+      end
+
+    end # Cursor
+
+  end # Cells
+
+end # Vedeu