vedeu 0.6.8 → 0.6.9

data/lib/vedeu/output/{presentation.rb → presentation/presentation.rb}

@@ -1,4 +1,5 @@
 require 'vedeu/output/presentation/colour'
+require 'vedeu/output/presentation/styles'
 require 'vedeu/output/presentation/style'
 
 module Vedeu
@@ -9,7 +10,7 @@ module Vedeu
   module Presentation
 
     include Vedeu::Presentation::Colour
-    include Vedeu::Presentation::Style
+    include Vedeu::Presentation::Styles
 
     # Converts the colours and styles to escape sequences, and when the parent
     # model has previously set the colour and style, reverts back to that for

data/lib/vedeu/output/presentation/style.rb

@@ -2,34 +2,80 @@ module Vedeu
 
   module Presentation
 
-    # Provides style related presentation behaviour.
+    # Converts the style value or value collection into a terminal
+    # escape sequence. Unrecognised values are discarded- an empty
+    # string is returned.
     #
-    module Style
+    # 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
+
+      # @!attribute [rw] value
+      # @return [String|Symbol]
+      attr_accessor :value
 
-      # When the style for the model exists, return it, otherwise returns the
-      # parent style, or an empty Vedeu::Style.
+      # Produces new objects of the correct class from the value,
+      # ignores objects that have already been coerced.
       #
-      # @return [Vedeu::Style]
-      def style
-        @style ||= if attributes[:style]
-                     Vedeu::Style.coerce(attributes[:style])
+      # @param value [Object|NilClass]
+      # @return [Object]
+      def self.coerce(value)
+        if value.is_a?(self)
+          value
 
-                   elsif parent
-                     Vedeu::Style.coerce(parent.style)
+        else
+          new(value)
 
-                   else
-                     Vedeu::Style.new
+        end
+      end
 
-                   end
+      # Return a new instance of Vedeu::Presentation::Style.
+      #
+      # @param value [Array<String|Symbol>|String|Symbol]
+      #   The style value or a collection of values.
+      # @return [Vedeu::Presentation::Style]
+      def initialize(value = nil)
+        @value = value
       end
 
-      # Allows the setting of the style by coercing the given value into a
-      # Vedeu::Style.
+      # Return an attributes hash for this class.
       #
-      # @return [Vedeu::Style]
-      def style=(value)
-        @style = Vedeu::Style.coerce(value)
+      # @return [Hash<Symbol => Array<String|Symbol>|String|Symbol>]
+      def attributes
+        {
+          style: value,
+        }
+      end
+
+      # An object is equal when its values are the same.
+      #
+      # @param other [Vedeu::Views::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]
+      def to_s
+        return '' unless present?(value)
+
+        @sequences ||= Array(value).flatten.map do |v|
+          Vedeu::Esc.string(v)
+        end.join
       end
+      alias_method :escape_sequences, :to_s
+      alias_method :to_str, :to_s
 
     end # Style
 

data/lib/vedeu/output/presentation/styles.rb

@@ -0,0 +1,39 @@
+module Vedeu
+
+  module Presentation
+
+    # Provides style related presentation behaviour.
+    #
+    module Styles
+
+      # When the style for the model exists, return it, otherwise
+      # returns the parent style, or an empty
+      # {Vedeu::Presentation::Style}.
+      #
+      # @return [Vedeu::Presentation::Style]
+      def style
+        @style ||= if attributes[:style]
+                     Vedeu::Presentation::Style.coerce(attributes[:style])
+
+                   elsif parent
+                     Vedeu::Presentation::Style.coerce(parent.style)
+
+                   else
+                     Vedeu::Presentation::Style.new
+
+                   end
+      end
+
+      # Allows the setting of the style by coercing the given value
+      # into a {Vedeu::Presentation::Style}.
+      #
+      # @return [Vedeu::Presentation::Style]
+      def style=(value)
+        @style = Vedeu::Presentation::Style.coerce(value)
+      end
+
+    end # Style
+
+  end # Presentation
+
+end # Vedeu

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

@@ -2,8 +2,8 @@ module Vedeu
 
   module Renderers
 
-    # Renders a {Vedeu::VirtualBuffer} or {Vedeu::Output} as a HTML
-    # snippet; a table by default.
+    # Renders a {Vedeu::Buffers::VirtualBuffer} or
+    # {Vedeu::Output::Output} as a HTML snippet; a table by default.
     #
     class HTML < Vedeu::Renderers::File
 

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

@@ -2,7 +2,8 @@ module Vedeu
 
   module Renderers
 
-    # Renders a {Vedeu::VirtualBuffer} or {Vedeu::Output} as JSON.
+    # Renders a {Vedeu::Buffers::VirtualBuffer} or
+    # {Vedeu::Output::Output} as JSON.
     #
     class JSON < Vedeu::Renderers::File
 

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

@@ -2,8 +2,8 @@ module Vedeu
 
   module Renderers
 
-    # Converts a grid of {Vedeu::Views::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
 
@@ -31,7 +31,7 @@ module Vedeu
         store!(output)
 
         Vedeu.timer('Compression') do
-          Vedeu::Compressor.render(output)
+          Vedeu::Output::Compressor.render(output)
         end
       end
 

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

@@ -2,8 +2,8 @@ module Vedeu
 
   module Renderers
 
-    # Converts a grid of {Vedeu::Views::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
 
@@ -20,7 +20,7 @@ module Vedeu
       # @param output [Array<Array<Vedeu::Views::Char>>]
       # @return [String]
       def render(output)
-        Vedeu::Compressor.render(output)
+        Vedeu::Output::Compressor.render(output)
       end
 
     end # Text

data/lib/vedeu/output/text.rb

@@ -1,216 +1,222 @@
 module Vedeu
 
-  # Present a string (or object responding to `to_s`).
-  #
-  class Text
+  module Output
 
-    # @see Vedeu::DSL::Text#text
-    def self.add(value = '', options = {})
-      new(value, options).add
-    end
+    # Present a string (or object responding to `to_s`).
+    #
+    class Text
 
-    # @see Vedeu::DSL::Text#text
-    def self.with(value = '', options = {})
-      new(value, options).aligned
-    end
+      # @see Vedeu::DSL::Text#text
+      def self.add(value = '', options = {})
+        new(value, options).add
+      end
 
-    # Returns a new instance of Vedeu::Text.
-    #
-    # @param value [String]
-    # @param options [Hash]
-    # @option options anchor [Symbol] See {Text#anchor}
-    # @option options background [String]
-    # @option options colour [Hash|NilClass]
-    # @option options foreground [String]
-    # @option options model
-    #   [Vedeu::Views::View|Vedeu::Views::Line|Vedeu::Views::Stream]
-    # @option options pad [String]
-    # @option options width [Integer]
-    # @return [Vedeu::Text]
-    def initialize(value = '', options = {})
-      @value   = value
-      @options = defaults.merge!(options)
-    end
-
-    # Aligns the value.
-    #
-    # @return [String]
-    def aligned
-      return string unless width
+      # @see Vedeu::DSL::Text#text
+      def self.with(value = '', options = {})
+        new(value, options).aligned
+      end
 
-      return truncated if truncate?
+      # Returns a new instance of Vedeu::Output::Text.
+      #
+      # @param value [String]
+      # @param options [Hash]
+      # @option options anchor [Symbol] See {Text#anchor}
+      # @option options background [String]
+      # @option options colour [Hash|NilClass]
+      # @option options foreground [String]
+      # @option options model
+      #   [Vedeu::Views::View|Vedeu::Views::Line|Vedeu::Views::Stream]
+      # @option options pad [String]
+      # @option options width [Integer]
+      # @return [Vedeu::Output::Text]
+      def initialize(value = '', options = {})
+        @value   = value
+        @options = defaults.merge!(options)
+      end
 
-      case anchor
-      when :align, :left, :text then left
-      when :centre, :center     then centre
-      when :right               then right
-      else
-        left
+      # Aligns the value.
+      #
+      # @return [String]
+      def aligned
+        return string unless width
+
+        return truncated if truncate?
+
+        case anchor
+        when :align, :left, :text then left
+        when :centre, :center     then centre
+        when :right               then right
+        else
+          left
+        end
       end
-    end
 
-    # Adds the content to the model.
-    #
-    # @return [void]
-    def add
-      model.add(content)
-    end
+      # Adds the content to the model.
+      #
+      # @return [void]
+      def add
+        model.add(content)
+      end
 
-    protected
+      protected
 
-    # @!attribute [r] value
-    # @return [String]
-    attr_reader :value
+      # @!attribute [r] value
+      # @return [String]
+      attr_reader :value
 
-    # @!attribute [r] options
-    # @return [Hash]
-    attr_reader :options
+      # @!attribute [r] options
+      # @return [Hash]
+      attr_reader :options
 
-    private
+      private
 
-    # @return [Symbol] One of :align, :centre, :center, :left, :right, :text
-    def anchor
-      options[:anchor]
-    end
+      # @return [Symbol] One of :align, :centre, :center, :left,
+      #   :right, :text
+      def anchor
+        options[:anchor]
+      end
 
-    # The string padded to width, centralized.
-    #
-    # @return [String]
-    def centre
-      string.center(width, pad)
-    end
+      # The string padded to width, centralized.
+      #
+      # @return [String]
+      def centre
+        string.center(width, pad)
+      end
 
-    # If a colour, background or foreground option is set, use them as the
-    # colour settings for the new Vedeu::Views::Stream.
-    #
-    # @return [void]
-    def colour
-      if options[:colour] || options[:background] || options[:foreground]
-        Vedeu::Colours::Colour.coerce(options)
+      # If a colour, background or foreground option is set, use them
+      # as the colour settings for the new Vedeu::Views::Stream.
+      #
+      # @return [void]
+      def colour
+        if options[:colour] || options[:background] || options[:foreground]
+          Vedeu::Colours::Colour.coerce(options)
 
-      else
-        model.colour
+        else
+          model.colour
 
+        end
       end
-    end
 
-    # Returns either a Vedeu::Views::Line or Vedeu::Views::Stream containing the
-    # text value.
-    #
-    # @return [Vedeu::Views::Line|Vedeu::Views::Stream]
-    def content
-      if model.is_a?(Vedeu::Views::View)
-        stream.parent = line
-        line.add(stream)
-        line
+      # Returns either a Vedeu::Views::Line or Vedeu::Views::Stream
+      # containing the text value.
+      #
+      # @return [Vedeu::Views::Line|Vedeu::Views::Stream]
+      def content
+        if model.is_a?(Vedeu::Views::View)
+          stream.parent = line
+          line.add(stream)
+          line
 
-      else
-        stream
+        else
+          stream
 
+        end
       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,
-      }
-    end
-
-    # The string padded to width, left justified.
-    #
-    # @return [String]
-    def left
-      string.ljust(width, pad)
-    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,
+        }
+      end
 
-    # @return [Vedeu::Views::Line]
-    def line
-      @line ||= Vedeu::Views::Line.build(parent: parent)
-    end
+      # The string padded to width, left justified.
+      #
+      # @return [String]
+      def left
+        string.ljust(width, pad)
+      end
 
-    # Returns the model option when set.
-    #
-    # @return [Vedeu::Views::View|
-    #          Vedeu::Views::Line|
-    #          Vedeu::Null::Generic|
-    #          Vedeu::Views::Stream]
-    def model
-      @model ||= options[:model] || Vedeu::Null::Generic.new
-    end
-
-    # The character to use for padding the string.
-    #
-    # @return [String]
-    def pad
-      options[:pad]
-    end
+      # @return [Vedeu::Views::Line]
+      def line
+        @line ||= Vedeu::Views::Line.build(parent: parent)
+      end
 
-    # Returns the parent for the new Vedeu::Views::Stream.
-    #
-    # @return [void]
-    def parent
-      model.is_a?(Vedeu::Views::Stream) ? model.parent : model
-    end
+      # Returns the model option when set.
+      #
+      # @return [Vedeu::Views::View|
+      #          Vedeu::Views::Line|
+      #          Vedeu::Null::Generic|
+      #          Vedeu::Views::Stream]
+      def model
+        @model ||= options[:model] || Vedeu::Null::Generic.new
+      end
 
-    # The string padded to width, right justified.
-    #
-    # @return [String]
-    def right
-      string.rjust(width, pad)
-    end
+      # The character to use for padding the string.
+      #
+      # @return [String]
+      def pad
+        options[:pad]
+      end
 
-    # Builds and returns a new Vedeu::Views::Stream.
-    #
-    # @return [void]
-    def stream
-      @stream ||= Vedeu::Views::Stream.build(colour: colour,
-                                             parent: parent,
-                                             style:  style,
-                                             value:  aligned)
-    end
-
-    # The string, coerced.
-    #
-    # @return [String]
-    def string
-      value.to_s
-    end
+      # Returns the parent for the new Vedeu::Views::Stream.
+      #
+      # @return [void]
+      def parent
+        model.is_a?(Vedeu::Views::Stream) ? model.parent : model
+      end
 
-    # Returns the model's styles.
-    #
-    # @return [void]
-    def style
-      model.style
-    end
+      # The string padded to width, right justified.
+      #
+      # @return [String]
+      def right
+        string.rjust(width, pad)
+      end
 
-    # Return a boolean indicating that the string is greater than the width.
-    #
-    # @return [Boolean]
-    def truncate?
-      string.size > width
-    end
+      # Builds and returns a new Vedeu::Views::Stream.
+      #
+      # @return [void]
+      def stream
+        @stream ||= Vedeu::Views::Stream.build(colour: colour,
+                                               parent: parent,
+                                               style:  style,
+                                               value:  aligned)
+      end
 
-    # Return the string truncated to the width.
-    #
-    # @return [String]
-    def truncated
-      string.slice(0, width)
-    end
+      # The string, coerced.
+      #
+      # @return [String]
+      def string
+        value.to_s
+      end
 
-    # Return the width.
-    #
-    # @return [Fixnum]
-    def width
-      options[:width]
-    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]
+      def truncate?
+        string.size > width
+      end
+
+      # Return the string truncated to the width.
+      #
+      # @return [String]
+      def truncated
+        string.slice(0, width)
+      end
+
+      # Return the width.
+      #
+      # @return [Fixnum]
+      def width
+        options[:width]
+      end
+
+    end # Text
 
-  end # Align
+  end # Output
 
 end # Vedeu