vedeu 0.4.13 → 0.4.14

data/lib/vedeu/output/presentation.rb

@@ -12,7 +12,16 @@ module Vedeu
 
     # @return [Vedeu::Colour]
     def colour
-      @colour ||= Vedeu::Colour.coerce(@colour)
+      if @colour
+        @colour ||= Vedeu::Colour.coerce(@colour)
+
+      elsif parent && parent.colour
+        @colour ||= Vedeu::Colour.coerce(parent.colour)
+
+      else
+        Vedeu::Colour.coerce(nil)
+
+      end
     end
 
     # @return [Vedeu::Colour]
@@ -47,7 +56,16 @@ module Vedeu
 
     # @return [Vedeu::Style]
     def style
-      @style ||= Vedeu::Style.coerce(@style)
+      if @style
+        @style ||= Vedeu::Style.coerce(@style)
+
+      elsif parent && parent.style
+        @style ||= Vedeu::Style.coerce(parent.style)
+
+      else
+        Vedeu::Style.coerce(nil)
+
+      end
     end
 
     # @return [Vedeu::Style]
@@ -61,34 +79,22 @@ module Vedeu
     #
     # @return [String] An escape sequence with value interpolated.
     def to_s
-      render_position { render_colour { render_style { render_border { value } } } }
+      render_position { render_colour { render_style { value } } }
     end
 
     private
 
-    # @return [String]
-    def render_border
-      if self.respond_to?(:border) && !border.nil?
-        Vedeu::Esc.border { yield }
-
-      else
-        yield
-
-      end
-    end
-
-    # Renders the colour attributes of the receiver, yields (to then render the
-    # the styles) and once returned, attempts to set the colours back to the
-    # those of the receiver's parent.
+    # Renders the colour attributes of the receiver and yields (to then render
+    # the styles).
     #
     # @return [String]
     def render_colour
-      [colour, yield, parent_colour].join
+      [colour, yield].join
     end
 
     # @return [String]
     def render_position
-      if self.respond_to?(:position) && self.position.is_a?(Vedeu::Position)
+      if self.respond_to?(:position) && position.is_a?(Vedeu::Position)
         position.to_s { yield }
 
       else
@@ -97,13 +103,12 @@ module Vedeu
       end
     end
 
-    # Renders the style attributes of the receiver, yields (to then render the
-    # next model, or finally, the content) and once returned, attempts to set
-    # the style back to that of the receiver's parent.
+    # Renders the style attributes of the receiver and yields (to then render
+    # the next model, or finally, the content).
     #
     # @return [String]
     def render_style
-      [style, yield, parent_style].join
+      [style, yield].join
     end
 
   end # Presentation

data/lib/vedeu/output/refresh.rb

@@ -28,7 +28,7 @@ module Vedeu
     def by_group(group_name)
       Vedeu.log(type: :info, message: "Refreshing group: '#{group_name}'")
 
-      Vedeu.groups.find(group_name).members.each { |name| by_name(name) }
+      Vedeu.groups.find!(group_name).members.each { |name| by_name(name) }
     end
 
     # Refresh an interface by name.
@@ -39,7 +39,7 @@ module Vedeu
     def by_name(name)
       Vedeu.log(type: :info, message: "Refreshing interface: '#{name}'")
 
-      Vedeu::Compositor.compose(name)
+      Vedeu.buffers.render(name)
     end
 
   end # Refresh

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

@@ -1,3 +1,80 @@
-require 'vedeu/output/renderers/file_renderer'
-require 'vedeu/output/renderers/html_renderer'
-require 'vedeu/output/renderers/terminal_renderer'
+require_relative 'file_renderer'
+require_relative 'html_renderer'
+require_relative 'json_renderer'
+require_relative 'null_renderer'
+require_relative 'terminal_renderer'
+
+module Vedeu
+
+  # Provides a single interface to all registered renderers.
+  #
+  module Renderers
+
+    extend Enumerable
+    extend self
+
+    # Provides access to the list of renderers.
+    #
+    # @return [Module]
+    def renderers
+      self
+    end
+
+    # @return [Array<void>]
+    def render(*args)
+      # acc = []
+      threads = storage.map do |renderer|
+        Thread.new(renderer) do
+          mutex.synchronize do
+            Vedeu.log(type: :debug,
+                      message: "Sending to renderer: '#{renderer}'")
+            # acc << renderer.render(*args)
+            renderer.render(*args)
+          end
+        end
+      end
+      threads.each(&:join)
+      # acc
+
+      # storage.inject([]) do |acc, renderer|
+      #   acc << renderer.render(*args)
+      #   acc
+      # end
+    end
+
+    # Adds the given renderer class(es) to the list of renderers.
+    #
+    # @example
+    #   Vedeu.renderer SomeRenderer
+    #
+    # @note
+    #   A renderer class must respond to the '.render' class method.
+    #
+    # @param renderers [Class]
+    # @return [Set]
+    def renderer(*renderers)
+      renderers.each { |renderer| storage.add(renderer) unless renderer.nil? }
+
+      storage
+    end
+
+    # @return [Set]
+    def reset
+      @storage = Set.new
+    end
+
+    # @return [Set]
+    def storage
+      @storage ||= reset
+    end
+
+    private
+
+    # @return [Mutex]
+    def mutex
+      @mutex ||= Mutex.new
+    end
+
+  end # Renderers
+
+end # Vedeu

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

@@ -18,11 +18,12 @@ module Vedeu
     # @return [Vedeu::FileRenderer]
     def initialize(*output)
       @output  = output
+      @options = {}
     end
 
     # @return [String]
     def render
-      File.open("/tmp/out_#{Time.now.to_f}", 'w') { |f| f.write(parsed) }
+      File.open("/tmp/#{filename}", 'w') { |f| f.write(parsed) }
     end
 
     private
@@ -31,9 +32,44 @@ module Vedeu
     # @return [Array<Array<Vedeu::Char>>]
     attr_reader :output
 
+    # @return [String]
+    def filename
+      if timestamp?
+        "out_#{timestamp}"
+
+      else
+        'out'
+
+      end
+    end
+
     # @return [String]
     def parsed
-      Array(output).flatten.map(&:to_s).join
+      Vedeu::Compressor.new(output).render
+    end
+
+    # @return [Float]
+    def timestamp
+      Time.now.to_f
+    end
+
+    # @return [Boolean]
+    def timestamp?
+      return true if options[:timestamp]
+
+      false
+    end
+
+    # @return [Hash]
+    def options
+      defaults.merge!(@options)
+    end
+
+    # @return [Hash]
+    def defaults
+      {
+        timestamp: false,
+      }
     end
 
   end # FileRenderer

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

@@ -7,7 +7,7 @@ module Vedeu
     # @param output [Array<Array<Vedeu::Char>>]
     # @return [String]
     def self.render(output)
-      new(output).render
+      new(output).to_file
     end
 
     # @param output [Array<Array<Vedeu::Char>>]
@@ -38,7 +38,7 @@ module Vedeu
     def to_file(path = file_path)
       content = render
 
-      File.open(path, "w", 0644) { |file| file.write(content) }
+      File.open(path, 'w', 0644) { |file| file.write(content) }
 
       content
     end
@@ -49,8 +49,10 @@ module Vedeu
       Array(output).each do |line|
         out << "<tr>\n"
         line.each do |char|
-          out << char.to_html
-          out << "\n"
+          if char.is_a?(Vedeu::Char)
+            out << char.to_html
+            out << "\n"
+          end
         end
         out << "</tr>\n"
       end

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

@@ -0,0 +1,52 @@
+module Vedeu
+
+  # Renders a {Vedeu::VirtualBuffer} or {Vedeu::Output} as JSON.
+  #
+  class JSONRenderer
+
+    # @param output [Array<Array<Vedeu::Char>>]
+    # @return [String]
+    def self.render(output)
+      new(output).render
+    end
+
+    # @param output [Array<Array<Vedeu::Char>>]
+    # @param path [String]
+    # @return [String]
+    # def self.to_file(output, path = nil)
+    #   new(output).to_file(path)
+    # end
+
+    # Returns a new instance of Vedeu::JSONRenderer.
+    #
+    # @param output [Array<Array<Vedeu::Char>>]
+    # @return [Vedeu::JSONRenderer]
+    def initialize(output)
+      @output = output
+    end
+
+    # @return [String]
+    def render
+      return '' if output.nil? || output.empty?
+
+      out = ''
+      Array(output).each do |line|
+        out << ''
+        line.each do |char|
+          out << char.to_json
+          out << "\n"
+        end
+        out << "\n"
+      end
+      out
+    end
+
+    private
+
+    # @!attribute [r] output
+    # @return [Array<Array<Vedeu::Char>>]
+    attr_reader :output
+
+  end # JSONRenderer
+
+end # Vedeu

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

@@ -0,0 +1,14 @@
+module Vedeu
+
+  # A renderer which returns nothing.
+  #
+  class NullRenderer
+
+    # @return [NilClass]
+    def self.render(*)
+      nil
+    end
+
+  end # NullRenderer
+
+end # Vedeu

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

@@ -21,7 +21,7 @@ module Vedeu
 
     # @return [Array<String>]
     def render
-      Vedeu::Terminal.output(hide_cursor, parsed, show_cursor)
+      Vedeu::Terminal.output(parsed)
     end
 
     private
@@ -30,19 +30,9 @@ module Vedeu
     # @return [Array<Array<Vedeu::Char>>]
     attr_reader :output
 
-    # @return [String]
-    def show_cursor
-      Vedeu::Esc.string(:show_cursor)
-    end
-
     # @return [String]
     def parsed
-      output.flatten.map(&:to_s).join
-    end
-
-    # @return [String]
-    def hide_cursor
-      Vedeu::Esc.string(:hide_cursor)
+      Vedeu::Compressor.new(output).render
     end
 
   end # TerminalRenderer

data/lib/vedeu/output/style.rb

@@ -1,20 +1,43 @@
 require 'vedeu/support/common'
-require 'vedeu/support/coercions'
 
 module Vedeu
 
   # Converts the style value or value collection into a terminal escape
   # sequence. Unrecognised values are discarded- an empty string is returned.
   #
+  # Vedeu has a range of symbol styles which are compatible with most terminals
+  # which are ANSI compatible. Like colours, they can be defined in either
+  # interfaces, for specific lines or within streams.
+  # Styles are applied as encountered.
+  #
+  # @see Vedeu::Esc
+  #
   class Style
 
     include Vedeu::Common
-    include Vedeu::Coercions
 
     # @!attribute [rw] value
     # @return [String|Symbol]
     attr_accessor :value
 
+    # Produces new objects of the correct class from the value, ignores objects
+    # that have already been coerced.
+    #
+    # @param value [Object|NilClass]
+    # @return [Object]
+    def self.coerce(value)
+      if value.nil?
+        new
+
+      elsif value.is_a?(self)
+        value
+
+      else
+        new(value)
+
+      end
+    end
+
     # Return a new instance of Vedeu::Style.
     #
     # @param value [Array<String|Symbol>|String|Symbol]
@@ -29,10 +52,17 @@ module Vedeu
     # @return [Array<String|Symbol>|String|Symbol]
     def attributes
       {
-        style: value
+        style: value,
       }
     end
 
+    # @param other [Vedeu::Char]
+    # @return [Boolean]
+    def eql?(other)
+      self.class == other.class && value == other.value
+    end
+    alias_method :==, :eql?
+
     # Return the terminal escape sequences after converting the style or styles.
     #
     # @return [String]

data/lib/vedeu/output/text.rb

@@ -4,6 +4,11 @@ module Vedeu
   #
   class Text
 
+    # @see Vedeu::DSL::Text#text
+    def self.add(value = '', options = {})
+      new(value, options).add
+    end
+
     # @see Vedeu::DSL::Text#text
     def self.with(value = '', options = {})
       new(value, options).aligned
@@ -13,9 +18,13 @@ module Vedeu
     #
     # @param value [String]
     # @param options [Hash]
-    # @option options width [Integer]
     # @option options anchor [Symbol] See {Text#anchor}
+    # @option options background [String]
+    # @option options colour [Hash|NilClass]
+    # @option options foreground [String]
+    # @option options model [Vedeu::Interface|Vedeu::Line|Vedeu::Stream]
     # @option options pad [String]
+    # @option options width [Integer]
     # @return [Text]
     def initialize(value = '', options = {})
       @value   = value
@@ -39,6 +48,13 @@ module Vedeu
       end
     end
 
+    # Adds the content to the model.
+    #
+    # @return [void]
+    def add
+      model.add(content)
+    end
+
     private
 
     # @!attribute [r] value
@@ -61,12 +77,57 @@ module Vedeu
       string.center(width, pad)
     end
 
+    # If a colour, background or foreground option is set, use them as the
+    # colour settings for the new Vedeu::Stream.
+    #
+    # @return [void]
+    def colour
+      if options[:colour] || options[:background] || options[:foreground]
+        attrs = if options[:colour] && options[:colour].is_a?(Hash)
+                  options[:colour]
+
+                elsif options[:background] || options[:foreground]
+                  {
+                    background: options[:background],
+                    foreground: options[:foreground],
+                  }
+
+                else
+                  {}
+
+                end
+
+        Vedeu::Colour.coerce(attrs)
+
+      else
+        model.colour
+
+      end
+    end
+
+    # Returns either a Vedeu::Line or Vedeu::Stream containing the text value.
+    #
+    # @return [Vedeu::Line|Vedeu::Stream]
+    def content
+      if model.is_a?(Vedeu::Interface)
+        stream.parent = line
+        line.add(stream)
+        line
+
+      else
+        stream
+
+      end
+    end
+
     # The default values for a new instance of this class.
     #
     # @return [Hash<Symbol => NilClass, String, Symbol>]
     def defaults
       {
         anchor: :left,
+        colour: nil,
+        model:  nil,
         pad:    ' ',
         width:  nil,
       }
@@ -79,6 +140,18 @@ module Vedeu
       string.ljust(width, pad)
     end
 
+    # @return [Vedeu::Line]
+    def line
+      @line ||= Vedeu::Line.build(parent: parent)
+    end
+
+    # Returns the model option if set.
+    #
+    # @return [Vedeu::Interface|Vedeu::Line|Vedeu::Null|Vedeu::Stream]
+    def model
+      @model ||= options[:model] || Vedeu::Null.new
+    end
+
     # The character to use for padding the string.
     #
     # @return [String]
@@ -86,6 +159,13 @@ module Vedeu
       options[:pad]
     end
 
+    # Returns the parent for the new Vedeu::Stream.
+    #
+    # @return [void]
+    def parent
+      model.is_a?(Vedeu::Stream) ? model.parent : model
+    end
+
     # The string padded to width, right justified.
     #
     # @return [String]
@@ -93,6 +173,16 @@ module Vedeu
       string.rjust(width, pad)
     end
 
+    # Builds and returns a new Vedeu::Stream.
+    #
+    # @return [void]
+    def stream
+      @stream ||= Vedeu::Stream.build(colour: colour,
+                                      parent: parent,
+                                      style:  style,
+                                      value:  aligned)
+    end
+
     # The string, coerced.
     #
     # @return [String]
@@ -100,6 +190,13 @@ module Vedeu
       value.to_s
     end
 
+    # Returns the model's styles.
+    #
+    # @return [void]
+    def style
+      model.style
+    end
+
     # Return a boolean indicating that the string is greater than the width.
     #
     # @return [Boolean]

data/lib/vedeu/output/translator.rb

@@ -1,5 +1,3 @@
-require 'vedeu/support/coercions'
-
 module Vedeu
 
   # Convert a CSS/HTML colour string into a terminal escape sequence.
@@ -23,13 +21,29 @@ module Vedeu
   # @todo More documentation required (create a fancy chart!)
   class Translator
 
-    include Vedeu::Coercions
-
     # @!attribute [r] colour
     # @return [String]
     attr_reader :colour
     alias_method :value, :colour
 
+    # Produces new objects of the correct class from the value, ignores objects
+    # that have already been coerced.
+    #
+    # @param value [Object|NilClass]
+    # @return [Object]
+    def self.coerce(value)
+      if value.nil?
+        new
+
+      elsif value.is_a?(self)
+        value
+
+      else
+        new(value)
+
+      end
+    end
+
     # Convert a CSS/HTML colour string into a terminal escape sequence.
     #
     # @param colour [Fixnum|String|Symbol]
@@ -46,6 +60,13 @@ module Vedeu
       @colour = colour
     end
 
+    # @param other [Vedeu::Char]
+    # @return [Boolean]
+    def eql?(other)
+      self.class == other.class && colour == other.colour
+    end
+    alias_method :==, :eql?
+
     # @return [String]
     # @see Vedeu::Translator
     def escape_sequence
@@ -147,7 +168,9 @@ module Vedeu
     #
     # @return [Boolean]
     def rgb?
-      !!(colour =~ /^#([A-Fa-f0-9]{6})$/)
+      return true if colour =~ /^#([A-Fa-f0-9]{6})$/
+
+      false
     end
 
     # Returns an escape sequence.
@@ -155,7 +178,7 @@ module Vedeu
     # @return [String]
     def rgb
       if Vedeu::Configuration.colour_mode == 16_777_216
-        register(colour, sprintf(rgb_prefix, *css_to_rgb))
+        register(colour, format(rgb_prefix, *css_to_rgb))
 
       else
         numbered
@@ -183,7 +206,7 @@ module Vedeu
       [
         colour[1..2].to_i(16),
         colour[3..4].to_i(16),
-        colour[5..6].to_i(16)
+        colour[5..6].to_i(16),
       ]
     end