vedeu 0.6.9 → 0.6.10

data/lib/vedeu/models/escape.rb

@@ -34,7 +34,7 @@ module Vedeu
 
       # An object is equal when its values are the same.
       #
-      # @param other [Vedeu::Views::Char]
+      # @param other [Vedeu::Models::Escape]
       # @return [Boolean]
       def eql?(other)
         self.class == other.class && value == other.value
@@ -46,6 +46,23 @@ module Vedeu
         Vedeu::Geometry::Position.coerce(@position)
       end
 
+      # Return an empty hash as most escape sequences won't make
+      # sense as JSON.
+      #
+      # @return [Hash<void>]
+      def to_hash
+        {}
+      end
+
+      # 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}"

data/lib/vedeu/models/page.rb

@@ -52,6 +52,21 @@ module Vedeu
         @rows = rows || []
       end
 
+      # @return [Array<void>]
+      def content
+        rows.map(&:content).flatten
+      end
+
+      # @param row_index [Fixnum]
+      # @param cell_index [Fixnum]
+      # @return [NilClass|void]
+      def cell(row_index = nil, cell_index = nil)
+        return nil if row_index.nil? || cell_index.nil?
+        return nil unless row(row_index)
+
+        row(row_index)[cell_index]
+      end
+
       # Provides iteration over the collection.
       #
       # @param block [Proc]
@@ -60,6 +75,11 @@ module Vedeu
         rows.each(&block)
       end
 
+      # @return [Boolean]
+      def empty?
+        rows.empty?
+      end
+
       # An object is equal when its values are the same.
       #
       # @param other [Vedeu::Models::Page]
@@ -77,16 +97,6 @@ module Vedeu
         rows[index]
       end
 
-      # @param row_index [Fixnum]
-      # @param cell_index [Fixnum]
-      # @return [NilClass|void]
-      def cell(row_index = nil, cell_index = nil)
-        return nil if row_index.nil? || cell_index.nil?
-        return nil unless row(row_index)
-
-        row(row_index)[cell_index]
-      end
-
     end # Page
 
   end # Models

data/lib/vedeu/models/row.rb

@@ -38,6 +38,19 @@ module Vedeu
         @cells = cells || []
       end
 
+      # @param index [Fixnum]
+      # @return [NilClass|void]
+      def cell(index)
+        return nil if index.nil?
+
+        cells[index]
+      end
+
+      # @return [Array<void>]
+      def content
+        cells.flatten
+      end
+
       # Provides iteration over the collection.
       #
       # @param block [Proc]
@@ -46,6 +59,11 @@ module Vedeu
         cells.each(&block)
       end
 
+      # @return [Boolean]
+      def empty?
+        cells.empty?
+      end
+
       # An object is equal when its values are the same.
       #
       # @param other [Vedeu::Models::Row]
@@ -55,14 +73,6 @@ module Vedeu
       end
       alias_method :==, :eql?
 
-      # @param index [Fixnum]
-      # @return [NilClass|void]
-      def cell(index)
-        return nil if index.nil?
-
-        cells[index]
-      end
-
     end # Row
 
   end # Models

data/lib/vedeu/models/views/char.rb

@@ -47,7 +47,7 @@ module Vedeu
         @value      = @attributes[:value]
       end
 
-      # When {Vedeu::Viewport#show} has less lines that required to fill
+      # When {Vedeu::Output::Viewport#show} has less lines that required to fill
       # the visible area of the interface, it creates a line that contains a
       # single {Vedeu::Views::Char} containing a space (0x20); later, attempts
       # to call `#chars` on an expected {Vedeu::Views::Line} and fail; this
@@ -114,7 +114,7 @@ module Vedeu
       #   Vedeu::Views::Char, however, at the moment, `:parent` cannot be
       #   coerced.
       #
-      # @return [Hash]
+      # @return [Hash<Symbol => Hash, String>]
       def to_hash
         {
           border:   border.to_s,
@@ -126,14 +126,16 @@ module Vedeu
         }
       end
 
+      # @param options [Hash<Symbol => String>]
+      #   See {Vedeu::Views::HTMLChar#initialize}
       # @return [String]
-      def to_html
-        @to_html ||= Vedeu::Views::HTMLChar.render(self)
+      def to_html(options = {})
+        @to_html ||= Vedeu::Views::HTMLChar.render(self, options)
       end
 
       private
 
-      # @return [Hash]
+      # @return [Hash<Symbol => String>]
       def colour_to_hash
         {
           background: background.to_s,
@@ -141,7 +143,7 @@ module Vedeu
         }
       end
 
-      # @return [Hash]
+      # @return [Hash<Symbol => String>]
       def parent_to_hash
         if parent
           {
@@ -156,7 +158,7 @@ module Vedeu
         end
       end
 
-      # @return [Hash]
+      # @return [Has<Symbol => Fixnum>]
       def position_to_hash
         {
           y: y,

data/lib/vedeu/models/views/view.rb

@@ -76,7 +76,7 @@ module Vedeu
         output = [
           Vedeu::Cursors::Cursor.hide_cursor(name),
           Vedeu::Clear::NamedInterface.render(name),
-          Vedeu::Viewport.render(self),
+          Vedeu::Output::Viewport.render(self),
           Vedeu.borders.by_name(name).render,
           Vedeu::Cursors::Cursor.show_cursor(name),
         ]

data/lib/vedeu/output/compressor.rb

@@ -29,13 +29,9 @@ module Vedeu
       #   Takes approximately ~25ms for 2100 chars. (2015-07-25)
       # @return [String]
       def render
-        if Vedeu::Configuration.compression?
-          compress
+        return compress if Vedeu::Configuration.compression?
 
-        else
-          uncompress
-
-        end
+        uncompress
       end
 
       protected
@@ -46,22 +42,34 @@ module Vedeu
 
       private
 
+      def content
+        return [] if output.nil? || output.empty?
+
+        output.content.delete_if { |cell| cell.is_a?(Vedeu::Models::Cell) }
+      end
+
       # @return [String]
       def compress
-        out = ''
-        Array(output).flatten.each do |char|
-          out << char.position.to_s
-          out << colour_for(char)
-          out << style_for(char)
-          out << char.value
+        Vedeu.timer('Compression') do
+          out = ''
+
+          content.each do |cell|
+            out << cell.position.to_s
+            out << colour_for(cell)
+            out << style_for(cell)
+            out << cell.value
+          end
+
+          out
         end
-        out
       end
 
       # @return [String]
       def uncompress
         out = ''
-        Array(output).flatten.each { |char| out << char.to_s }
+
+        content.each { |cell| out << cell.to_s }
+
         out
       end
 

data/lib/vedeu/output/output.rb

@@ -26,18 +26,9 @@ module Vedeu
       #
       # @return [Array]
       def render
-        if Vedeu::Configuration.drb?
-          Vedeu.trigger(:_drb_store_output_, output)
-
-          # Vedeu::Renderers::HTML.
-          # to_file(Vedeu::Buffers::VirtualBuffers.retrieve)
-        end
-
-        Vedeu.renderers.render(output) if Vedeu.ready?
+        Vedeu::Terminal::Buffer.write(output).render
       end
 
-      protected
-
       # @!attribute [r] output
       # @return [Array<Array<Vedeu::Views::Char>>]
       attr_reader :output

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

@@ -18,12 +18,16 @@ module Vedeu
 
       # Render the output with the escape sequences escaped.
       #
-      # @param output [Array<Array<Vedeu::Views::Char>>]
+      # @param output [Vedeu::Models::Page]
       # @return [String]
       def render(output)
-        @parsed ||= Array(output).flatten.map do |char|
-          Esc.escape(char.to_s) + "\n"
-        end.join
+        out = ''
+
+        output.each do |row|
+          row.each { |cell| out << Vedeu::Esc.escape(cell.to_s) }
+        end
+
+        out
       end
 
     end # EscapeSequence

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

@@ -6,18 +6,22 @@ module Vedeu
     #
     class File
 
+      include Vedeu::RendererOptions
+
       # Returns a new instance of Vedeu::Renderers::File.
       #
       # @param options [Hash]
       # @option options filename [String] Provide a filename for the output.
       #   Defaults to 'out'.
       # @option options timestamp [Boolean] Append a timestamp to the filename.
+      # @option options write_file [Boolean] Whether to write the file to the
+      #   given filename.
       # @return [Vedeu::Renderers::File]
       def initialize(options = {})
         @options = options || {}
       end
 
-      # @param output [Array<Array<Vedeu::Views::Char>>]
+      # @param output [Vedeu::Models::Page]
       # @return [String]
       def render(output)
         ::File.write(filename, output) if write_file?
@@ -29,25 +33,12 @@ module Vedeu
 
       # @return [String]
       def filename
-        if timestamp?
-          "#{options[:filename]}_#{timestamp}"
-
-        else
-          options[:filename]
-
-        end
+        options[:filename] + "_#{timestamp}"
       end
 
       # @return [Float]
       def timestamp
-        @timestamp ||= Time.now.to_f
-      end
-
-      # @return [Boolean]
-      def timestamp?
-        return true if options[:timestamp]
-
-        false
+        Time.now.to_f if options[:timestamp]
       end
 
       # @return [Boolean]
@@ -55,13 +46,6 @@ module Vedeu
         options[:write_file]
       end
 
-      # Combines the options provided at instantiation with the default values.
-      #
-      # @return [Hash]
-      def options
-        defaults.merge!(@options)
-      end
-
       # Returns the default options/attributes for this class.
       #
       # @return [Hash]

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

@@ -2,55 +2,74 @@ module Vedeu
 
   module Renderers
 
-    # Renders a {Vedeu::Buffers::VirtualBuffer} or
-    # {Vedeu::Output::Output} as a HTML snippet; a table by default.
+    # Renders a {Vedeu::Terminal::Buffer} as a HTML snippet; a table
+    # by default.
     #
     class HTML < Vedeu::Renderers::File
 
       # Returns a new instance of Vedeu::Renderers::HTML.
       #
       # @param options [Hash]
-      # @option options content [String]
-      # @option options end_row_tag [String]
-      # @option options start_row_tag [String]
+      # @option options content [String] Defaults to an empty string.
+      # @option options end_tag [String] Defaults to '</td>'.
+      # @option options end_row_tag [String] Defaults to '</tr>'.
+      # @option options filename [String] Provide a filename for the output.
+      #   Defaults to 'out'.
+      # @option options start_tag [String] Defaults to '<td' (note the end of
+      #   the tag is missing, this is so that inline styles can be added later).
+      # @option options start_row_tag [String] Defaults to '<tr>'.
       # @option options template [String]
+      # @option options timestamp [Boolean] Append a timestamp to the filename.
+      # @option options write_file [Boolean] Whether to write the file to the
+      #   given filename.
       # @return [Vedeu::Renderers::HTML]
       def initialize(options = {})
         @options = options || {}
+        @output  = nil
       end
 
-      # @param output [Array<Array<Vedeu::Views::Char>>]
+      # @param output [Vedeu::Models::Page]
       # @return [String]
       def render(output)
-        @options[:content] = output
+        @output = output
 
-        super(Vedeu::Templating::Template.parse(self, template))
+        super(Vedeu::Templating::Template.parse(self, template)) unless escape?
       end
 
       # @return [String]
       def html_body
-        return '' if content.is_a?(Vedeu::Models::Escape)
+        return '' if output.is_a?(Vedeu::Models::Escape)
 
         out = ''
 
-        Array(content).each do |line|
+        output.each do |line|
           out << "#{start_row_tag}\n"
-          line.each do |char|
-            if char.is_a?(Vedeu::Views::Char)
-              out << char.to_html
-              out << "\n"
-            end
-          end
+          line.each { |char| out << char.to_html(options) }
           out << "#{end_row_tag}\n"
         end
+
         out
       end
 
       private
 
+      # Returns a boolean indicating whether the output is a
+      # {Vedeu::Models::Escape}. If it is, it won't be rendered in
+      # HTML.
+      #
+      # @return [Boolean]
+      def escape?
+        output.is_a?(Vedeu::Models::Escape)
+      end
+
       # @return [Array<Array<Vedeu::Views::Char>>]
-      def content
-        options[:content]
+      def output
+        @output || options[:output]
+      end
+
+      # @return [String]
+      def end_tag
+        options[:end_tag]
       end
 
       # @return [String]
@@ -58,6 +77,11 @@ module Vedeu
         options[:end_row_tag]
       end
 
+      # @return [String]
+      def start_tag
+        options[:start_tag]
+      end
+
       # @return [String]
       def start_row_tag
         options[:start_row_tag]
@@ -68,23 +92,20 @@ module Vedeu
         options[:template]
       end
 
-      # Combines the options provided at instantiation with the
-      # default values.
-      #
-      # @return [Hash<Symbol => void>]
-      def options
-        defaults.merge!(@options)
-      end
-
       # The default values for a new instance of this class.
       #
       # @return [Hash<Symbol => void>]
       def defaults
         {
           content:       '',
+          end_tag:       '</td>',
           end_row_tag:   '</tr>',
+          filename:      'out',
+          start_tag:     '<td',
           start_row_tag: '<tr>',
           template:      default_template,
+          timestamp:     false,
+          write_file:    true,
         }
       end
 

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

@@ -2,8 +2,7 @@ module Vedeu
 
   module Renderers
 
-    # Renders a {Vedeu::Buffers::VirtualBuffer} or
-    # {Vedeu::Output::Output} as JSON.
+    # Renders a {Vedeu::Terminal::Buffer} as JSON.
     #
     class JSON < Vedeu::Renderers::File
 
@@ -15,32 +14,28 @@ module Vedeu
         @options = options || {}
       end
 
-      # @param output [Array<Array<Vedeu::Views::Char>>]
+      # @param output [Vedeu::Models::Page]
       # @return [String]
       def render(output)
-        super(parsed(output))
+        json = parse(output)
+
+        super(json)
+
+        json
       end
 
       private
 
-      # @param output [Array<Array<Vedeu::Views::Char>>]
+      # @param output [Vedeu::Models::Page]
       # @return [String]
-      def parsed(output)
-        return '' if output.nil? || output.empty?
-
+      def parse(output)
         ::JSON.pretty_generate(as_hash(output))
       end
 
-      # @param output [Array<Array<Vedeu::Views::Char>>]
+      # @param output [Vedeu::Models::Page]
       # @return [Array]
       def as_hash(output)
-        sorted(output).map(&:to_hash)
-      end
-
-      # @param output [Array<Array<Vedeu::Views::Char>>]
-      # @return [Array]
-      def sorted(output)
-        Array(output).flatten.sort_by(&:position)
+        output.content.map(&:to_hash)
       end
 
     end # JSON

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

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

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

@@ -7,7 +7,8 @@ module Vedeu
 
     private
 
-    # Combines the options provided at instantiation with the default values.
+    # Combines the options provided at instantiation with the default
+    # values.
     #
     # @return [Hash<Symbol => void>]
     def options

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

@@ -17,28 +17,20 @@ module Vedeu
         @options = options || {}
       end
 
-      # @param output [Array<Array<Vedeu::Views::Char>>]
+      # @param output [Vedeu::Models::Page]
       # @return [Array<String>]
       def render(output)
-        Vedeu::Terminal.output(parsed(output))
+        output = parse(output)
+
+        Vedeu::Terminal.output(output)
       end
 
       private
 
-      # @param output [Array<Array<Vedeu::Views::Char>>]
+      # @param output [Vedeu::Models::Page]
       # @return [Array<Array<Vedeu::Views::Char>>]
-      def parsed(output)
-        store!(output)
-
-        Vedeu.timer('Compression') do
-          Vedeu::Output::Compressor.render(output)
-        end
-      end
-
-      # @param output [Array<Array<Vedeu::Views::Char>>]
-      # @return [Array<Vedeu::Views::Char>]
-      def store!(output)
-        Vedeu::Terminal::Content.stores(output)
+      def parse(output)
+        Vedeu::Output::Compressor.render(output)
       end
 
     end # Terminal

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

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