vedeu 0.4.15 → 0.4.16

data/lib/vedeu/models/line.rb

@@ -22,9 +22,12 @@ module Vedeu
     # @!attribute [rw] streams
     # @return [Streams]
     attr_accessor :streams
-
     alias_method :value, :streams
 
+    # @!attribute [r] attributes
+    # @return [Hash]
+    attr_reader :attributes
+
     # Returns a new instance of Vedeu::Line.
     #
     # @param attributes [Hash]
@@ -35,10 +38,8 @@ module Vedeu
     # @return [Vedeu::Line]
     def initialize(attributes = {})
       @attributes = defaults.merge!(attributes)
-      @colour     = @attributes[:colour]
       @parent     = @attributes[:parent]
       @streams    = @attributes[:streams]
-      @style      = @attributes[:style]
     end
 
     # @param child []

data/lib/vedeu/models/null_interface.rb

@@ -0,0 +1,15 @@
+module Vedeu
+
+  class NullInterface
+
+    # @!attribute [r] attributes
+    # @return [Hash]
+    attr_reader :attributes
+
+    def initialize(attributes = {})
+      @attributes = attributes
+    end
+
+  end # NullInterface
+
+end # Vedeu

data/lib/vedeu/models/stream.rb

@@ -22,11 +22,14 @@ module Vedeu
     # @!attribute [rw] value
     # @return [String]
     attr_accessor :value
-
     alias_method :content, :value
     alias_method :data,    :value
     alias_method :text,    :value
 
+    # @!attribute [r] attributes
+    # @return [Hash]
+    attr_reader :attributes
+
     # Returns a new instance of Vedeu::Stream.
     #
     # @param attributes [Hash]
@@ -37,9 +40,7 @@ module Vedeu
     # @return [Vedeu::Stream]
     def initialize(attributes = {})
       @attributes = defaults.merge!(attributes)
-      @colour     = @attributes[:colour]
       @parent     = @attributes[:parent]
-      @style      = @attributes[:style]
       @value      = @attributes[:value]
     end
 

data/lib/vedeu/output/border.rb

@@ -82,19 +82,11 @@ module Vedeu
     # @return [String]
     attr_reader :name
 
-    # @!attribute [r] colour
-    # @return [Vedeu::Colour]
-    attr_reader :colour
-
     # @!attribute [r] enabled
     # @return [Boolean]
     attr_reader :enabled
     alias_method :enabled?, :enabled
 
-    # @!attribute [r] style
-    # @return [Style]
-    attr_reader :style
-
     # Returns a new instance of Vedeu::Border.
     #
     # @param attributes [Hash]
@@ -138,8 +130,6 @@ module Vedeu
       @vertical     = @attributes[:vertical]
       @name         = @attributes[:name]
       @repository   = Vedeu.borders
-      @colour       = @attributes[:colour]
-      @style        = @attributes[:style]
     end
 
     # @return [Fixnum]
@@ -231,6 +221,13 @@ module Vedeu
       top_or_bottom('top')
     end
 
+    # The parent of a border is always an interface.
+    #
+    # @return [Vedeu::Interface]
+    def parent
+      interface
+    end
+
     private
 
     # @param prefix [String]
@@ -361,7 +358,7 @@ module Vedeu
         bottom_left:  "\x6D", # └ # \u2514
         bottom_right: "\x6A", # ┘ # \u2518
         client:       nil,
-        colour:       {},
+        colour:       nil,
         enabled:      false,
         horizontal:   "\x71", # ─ # \u2500
         name:         '',
@@ -369,7 +366,7 @@ module Vedeu
         show_left:    true,
         show_right:   true,
         show_top:     true,
-        style:        [],
+        style:        nil,
         title:        '',
         top_left:     "\x6C", # ┌ # \u250C
         top_right:    "\x6B", # ┐ # \u2510

data/lib/vedeu/output/clear.rb

@@ -122,8 +122,8 @@ module Vedeu
     # @return [Hash<Symbol => Boolean>]
     def defaults
       {
-        clear_border:         true,
-        use_terminal_colours: true,
+        clear_border:         false,
+        use_terminal_colours: false,
       }
     end
 

data/lib/vedeu/output/colour.rb

@@ -6,7 +6,8 @@ module Vedeu
   #
   # Vedeu uses HTML/CSS style notation (i.e. '#aadd00'), they can be used at the
   # stream level, the line level or for the whole interface. Terminals generally
-  # support either 8, 16 or 256 colours, with few supporting full 24-bit colour.
+  # support either 8, 16 or 256 colours, with few supporting full 24-bit colour
+  # (see notes below).
   #
   # Vedeu attempts to detect the colour depth using the `$TERM` environment
   # variable.
@@ -17,6 +18,19 @@ module Vedeu
   # echo "export TERM=xterm-256color" >> ~/.bashrc
   # ```
   #
+  # Notes:
+  # Terminals which support the 24-bit colour mode include (but are not limited
+  # to): iTerm2 (OSX), Gnome Terminal (Linux).
+  #
+  # Setting your `$TERM` environment variable as above gets you up to 256
+  # colours, but if you then add the `colour_mode 16_777_216` configuration to
+  # your client application, it's really a hit and miss affair. iTerm2 renders
+  # all the colours correctly as does Gnome Terminal. Terminator (Linux) goes
+  # crazy though and defaults to 16 colours despite the `$TERM` setting. This
+  # area needs more work in Vedeu.
+  #
+  # @todo Fix colours in all terminals. (GL: 2015-04-13)
+  #
   class Colour
 
     # @!attribute [r] attributes
@@ -26,21 +40,27 @@ module Vedeu
     # @param value []
     # @return [Object]
     def self.coerce(value)
-      if value.is_a?(self)
-        value
+      return value if value.is_a?(self)
+      return new unless value.is_a?(Hash)
+      return new unless value[:colour] ||
+                        value[:background] ||
+                        value[:foreground]
 
-      elsif value.is_a?(Hash)
-        if value.key?(:colour) && value[:colour].is_a?(self)
-          value
+      if value[:colour]
+        return value[:colour] if value[:colour].is_a?(self)
 
-        elsif value.key?(:background) || value.key?(:foreground)
-          new(value)
+        if value[:colour].is_a?(Hash) && (value[:colour][:background] ||
+                                          value[:colour][:foreground])
+          new(value[:colour])
 
         else
           new
 
         end
 
+      elsif value[:background] || value[:foreground]
+        new(value)
+
       else
         new
 
@@ -69,6 +89,7 @@ module Vedeu
     # @param value [String]
     # @return [String]
     def background=(value)
+      @attributes[:background] = value
       @background = Vedeu::Background.coerce(value)
     end
 
@@ -92,6 +113,7 @@ module Vedeu
     # @param value [String]
     # @return [String]
     def foreground=(value)
+      @attributes[:foreground] = value
       @foreground = Vedeu::Foreground.coerce(value)
     end
 

data/lib/vedeu/output/esc.rb

@@ -116,8 +116,9 @@ module Vedeu
 
     # Return the escape sequence to render a border character.
     #
-    # @param block [Proc]
     # @return [String]
+    # @yieldreturn [void] The border character to wrap with border on and off
+    #   escape sequences.
     def border
       return '' unless block_given?
 

data/lib/vedeu/output/presentation.rb

@@ -16,22 +16,20 @@ module Vedeu
       end
     end
 
+    # @return [Vedeu::Background]
+    def background=(value)
+      attributes[:background] = value
+      colour.background = value
+    end
+
     # @return [Vedeu::Colour]
     def colour
-      if @colour
-        @colour ||= Vedeu::Colour.coerce(@colour)
-
-      elsif parent && parent.colour
-        @colour ||= Vedeu::Colour.coerce(parent.colour)
-
-      else
-        Vedeu::Colour.coerce(nil)
-
-      end
+      @colour ||= Vedeu::Colour.coerce(_colour)
     end
 
     # @return [Vedeu::Colour]
     def colour=(value)
+      attributes[:colour] = value
       @colour = Vedeu::Colour.coerce(value)
     end
 
@@ -46,6 +44,12 @@ module Vedeu
       end
     end
 
+    # @return [Vedeu::Foreground]
+    def foreground=(value)
+      attributes[:foreground] = value
+      colour.foreground = value
+    end
+
     # @return [Vedeu::Background]
     def parent_background
       if parent_colour
@@ -80,16 +84,7 @@ module Vedeu
 
     # @return [Vedeu::Style]
     def style
-      if @style
-        @style ||= Vedeu::Style.coerce(@style)
-
-      elsif parent && parent.style
-        @style ||= Vedeu::Style.coerce(parent.style)
-
-      else
-        Vedeu::Style.coerce(nil)
-
-      end
+      @style ||= Vedeu::Style.coerce(_style)
     end
 
     # @return [Vedeu::Style]
@@ -108,6 +103,17 @@ module Vedeu
 
     private
 
+    # @return [void]
+    def _colour
+      if attributes[:colour]
+        attributes[:colour]
+
+      elsif parent_colour
+        parent_colour
+
+      end
+    end
+
     # Renders the colour attributes of the receiver and yields (to then render
     # the styles).
     #
@@ -135,6 +141,17 @@ module Vedeu
       [style, yield].join
     end
 
+    # @return [void]
+    def _style
+      if attributes[:style]
+        attributes[:style]
+
+      elsif parent_style
+        parent_style
+
+      end
+    end
+
   end # Presentation
 
 end # Vedeu

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

@@ -1,3 +1,4 @@
+require_relative 'escape_sequence_renderer'
 require_relative 'file_renderer'
 require_relative 'html_renderer'
 require_relative 'json_renderer'

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

@@ -0,0 +1,40 @@
+module Vedeu
+
+  # A renderer which returns the escape sequence for each character.
+  #
+  class EscapeSequenceRenderer
+
+    # @param output [Array<Array<Vedeu::Char>>]
+    # @return [String]
+    def self.render(output)
+      new(output).render
+    end
+
+    # @param output [Array<Array<Vedeu::Char>>]
+    def initialize(output)
+      @output = output
+    end
+
+    # @return [String]
+    def render
+      Vedeu.log(type:    :debug,
+                message: "Vedeu::EscapeSequenceRenderer:\n#{parsed}")
+
+      parsed
+    end
+
+    private
+
+    # @!attribute [r] output
+    # @return [Array<Array<Vedeu::Char>>]
+    attr_reader :output
+
+    def parsed
+      @parsed ||= Array(output).flatten.map do |char|
+        Esc.escape(char.to_s) + "\n"
+      end.join
+    end
+
+  end # EscapeSequenceRenderer
+
+end # Vedeu

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

@@ -7,23 +7,27 @@ module Vedeu
   class FileRenderer
 
     # @param output [Array<Array<Vedeu::Char>>]
+    # @param options [Hash]
     # @return [String]
-    def self.render(*output)
-      new(*output).render
+    def self.render(output, options = {})
+      new(output, options).render
     end
 
     # Returns a new instance of Vedeu::FileRenderer.
     #
     # @param output [Array<Array<Vedeu::Char>>]
+    # @param options [Hash]
     # @return [Vedeu::FileRenderer]
-    def initialize(*output)
+    def initialize(output, options = {})
       @output  = output
-      @options = {}
+      @options = options
     end
 
     # @return [String]
     def render
       File.open("/tmp/#{filename}", 'w') { |f| f.write(parsed) }
+
+      parsed
     end
 
     private
@@ -45,7 +49,7 @@ module Vedeu
 
     # @return [String]
     def parsed
-      Vedeu::Compressor.new(output).render
+      @parsed ||= Vedeu::Compressor.new(output).render
     end
 
     # @return [Float]

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

@@ -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') { |file| file.write(content) }
 
       content
     end

data/lib/vedeu/output/text.rb

@@ -83,21 +83,7 @@ module Vedeu
     # @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)
+        Vedeu::Colour.coerce(options)
 
       else
         model.colour