vedeu 0.4.18 → 0.4.19

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

@@ -1,86 +1,91 @@
 module Vedeu
 
-  # Converts a grid of {Vedeu::Char} objects into a stream of escape sequences
-  # and content suitable for a terminal, and writes them to a file in the /tmp
-  # directory.
-  #
-  class Renderers::File
-
-    # @param output [Array<Array<Vedeu::Char>>]
-    # @param options [Hash]
-    # @return [String]
-    def self.render(output, options = {})
-      new(output, options).render
-    end
-
-    # Returns a new instance of Vedeu::Renderers::File.
-    #
-    # @param output [Array<Array<Vedeu::Char>>]
-    # @param options [Hash]
-    # @return [Vedeu::Renderers::File]
-    def initialize(output, options = {})
-      @output  = output
-      @options = options
-    end
-
-    # @return [String]
-    def render
-      File.open(path, 'w') { |f| f.write(parsed) }
-
-      parsed
-    end
-
-    private
-
-    # @!attribute [r] output
-    # @return [Array<Array<Vedeu::Char>>]
-    attr_reader :output
-
-    # @return [String]
-    def path
-      "/tmp/#{filename}"
-    end
-
-    # @return [String]
-    def filename
-      if timestamp?
-        "out_#{timestamp}"
-
-      else
-        'out'
+  module Renderers
+
+    # Converts a grid of {Vedeu::Char} objects into a stream of escape sequences
+    # and content suitable for a terminal, and writes them to a file in the /tmp
+    # directory.
+    class File
+
+      # @param output [Array<Array<Vedeu::Char>>]
+      # @param options [Hash]
+      # @return [String]
+      def self.render(output, options = {})
+        new(output, options).render
+      end
+
+      # Returns a new instance of Vedeu::Renderers::File.
+      #
+      # @param output [Array<Array<Vedeu::Char>>]
+      # @param options [Hash]
+      # @return [Vedeu::Renderers::File]
+      def initialize(output, options = {})
+        @output  = output
+        @options = options
+      end
+
+      # @return [String]
+      def render
+        ::File.open(path, 'w') { |f| f.write(parsed) }
+
+        parsed
+      end
+
+      protected
+
+      # @!attribute [r] output
+      # @return [Array<Array<Vedeu::Char>>]
+      attr_reader :output
+
+      private
+
+      # @return [String]
+      def path
+        "/tmp/#{filename}"
+      end
+
+      # @return [String]
+      def filename
+        if timestamp?
+          "out_#{timestamp}"
+
+        else
+          'out'
 
+        end
       end
-    end
-
-    # @return [String]
-    def parsed
-      @parsed ||= Vedeu::Compressor.new(output).render
-    end
-
-    # @return [Float]
-    def timestamp
-      @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 # Renderers::File
+
+      # @return [String]
+      def parsed
+        @parsed ||= Vedeu::Compressor.new(output).render
+      end
+
+      # @return [Float]
+      def timestamp
+        @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 # File
+
+  end # Renderers
 
 end # Vedeu

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

@@ -1,85 +1,90 @@
 module Vedeu
 
-  # Renders a {Vedeu::VirtualBuffer} or {Vedeu::Output} as a HTML table.
-  #
-  class Renderers::HTML
-
-    # @param output [Array<Array<Vedeu::Char>>]
-    # @return [String]
-    def self.render(output)
-      new(output).to_file
-    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::Renderers::HTML.
-    #
-    # @param output [Array<Array<Vedeu::Char>>]
-    # @return [Vedeu::Renderers::HTML]
-    def initialize(output)
-      @output = output
-    end
-
-    # @return [String]
-    def render
-      Vedeu::Template.parse(self, template)
-    end
-
-    # Writes the parsed template to a file (at the given path) and returns the
-    # contents.
-    #
-    # @param path [String]
-    # @return [String]
-    def to_file(path = file_path)
-      content = render
-
-      File.open(path, 'w') { |file| file.write(content) }
-
-      content
-    end
-
-    # @return [String]
-    def html_body
-      out = ''
-      Array(output).each do |line|
-        out << "<tr>\n"
-        line.each do |char|
-          if char.is_a?(Vedeu::Char)
-            out << char.to_html
-            out << "\n"
+  module Renderers
+
+    # Renders a {Vedeu::VirtualBuffer} or {Vedeu::Output} as a HTML table.
+    class HTML
+
+      # @param output [Array<Array<Vedeu::Char>>]
+      # @return [String]
+      def self.render(output)
+        new(output).to_file
+      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::Renderers::HTML.
+      #
+      # @param output [Array<Array<Vedeu::Char>>]
+      # @return [Vedeu::Renderers::HTML]
+      def initialize(output)
+        @output = output
+      end
+
+      # @return [String]
+      def render
+        Vedeu::Template.parse(self, template)
+      end
+
+      # Writes the parsed template to a file (at the given path) and returns the
+      # contents.
+      #
+      # @param path [String]
+      # @return [String]
+      def to_file(path = file_path)
+        content = render
+
+        ::File.open(path, 'w') { |file| file.write(content) }
+
+        content
+      end
+
+      # @return [String]
+      def html_body
+        out = ''
+        Array(output).each do |line|
+          out << "<tr>\n"
+          line.each do |char|
+            if char.is_a?(Vedeu::Char)
+              out << char.to_html
+              out << "\n"
+            end
           end
+          out << "</tr>\n"
         end
-        out << "</tr>\n"
+        out
       end
-      out
-    end
 
-    private
+      protected
 
-    # @!attribute [r] output
-    # @return [Array<Array<Vedeu::Char>>]
-    attr_reader :output
+      # @!attribute [r] output
+      # @return [Array<Array<Vedeu::Char>>]
+      attr_reader :output
 
-    # @return [String]
-    def template
-      File.dirname(__FILE__) + '/../templates/html_renderer.vedeu'
-    end
+      private
 
-    # @return [String]
-    def file_path
-      "/tmp/vedeu_html_#{timestamp}.html"
-    end
+      # @return [String]
+      def template
+        ::File.dirname(__FILE__) + '/../templates/html_renderer.vedeu'
+      end
+
+      # @return [String]
+      def file_path
+        "/tmp/vedeu_html_#{timestamp}.html"
+      end
+
+      # return [Fixnum]
+      def timestamp
+        @timestamp ||= Time.now.to_i
+      end
 
-    # return [Fixnum]
-    def timestamp
-      @timestamp ||= Time.now.to_i
-    end
+    end # HTML
 
-  end # Renderers::HTML
+  end # Renderers
 
 end # Vedeu

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

@@ -1,52 +1,55 @@
 module Vedeu
 
-  # Renders a {Vedeu::VirtualBuffer} or {Vedeu::Output} as JSON.
-  #
-  class Renderers::JSON
-
-    # @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::Renderers::JSON.
-    #
-    # @param output [Array<Array<Vedeu::Char>>]
-    # @return [Vedeu::Renderers::JSON]
-    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
+  module Renderers
+
+    # Renders a {Vedeu::VirtualBuffer} or {Vedeu::Output} as JSON.
+    class JSON
+
+      # @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::Renderers::JSON.
+      #
+      # @param output [Array<Array<Vedeu::Char>>]
+      # @return [Vedeu::Renderers::JSON]
+      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 << "\n"
+        out
       end
-      out
-    end
 
-    private
+      protected
+
+      # @!attribute [r] output
+      # @return [Array<Array<Vedeu::Char>>]
+      attr_reader :output
 
-    # @!attribute [r] output
-    # @return [Array<Array<Vedeu::Char>>]
-    attr_reader :output
+    end # JSON
 
-  end # Renderers::JSON
+  end # Renderers
 
 end # Vedeu

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

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

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

@@ -1,40 +1,45 @@
 module Vedeu
 
-  # Converts a grid of {Vedeu::Char} objects into a stream of escape sequences
-  # and content suitable for a terminal.
-  #
-  class Renderers::Terminal
-
-    # @param output [Array<Array<Vedeu::Char>>]
-    # @return [String]
-    def self.render(*output)
-      new(*output).render
-    end
-
-    # Returns a new instance of Vedeu::Renderers::Terminal.
-    #
-    # @param output [Array<Array<Vedeu::Char>>]
-    # @return [Vedeu::Renderers::Terminal]
-    def initialize(*output)
-      @output = output
-    end
-
-    # @return [Array<String>]
-    def render
-      Vedeu::Terminal.output(parsed)
-    end
-
-    private
-
-    # @!attribute [r] output
-    # @return [Array<Array<Vedeu::Char>>]
-    attr_reader :output
-
-    # @return [String]
-    def parsed
-      Vedeu::Compressor.new(output).render
-    end
-
-  end # Renderers::Terminal
+  module Renderers
+
+    # Converts a grid of {Vedeu::Char} objects into a stream of escape sequences
+    # and content suitable for a terminal.
+    class Terminal
+
+      # @param output [Array<Array<Vedeu::Char>>]
+      # @return [String]
+      def self.render(*output)
+        new(*output).render
+      end
+
+      # Returns a new instance of Vedeu::Renderers::Terminal.
+      #
+      # @param output [Array<Array<Vedeu::Char>>]
+      # @return [Vedeu::Renderers::Terminal]
+      def initialize(*output)
+        @output = output
+      end
+
+      # @return [Array<String>]
+      def render
+        Vedeu::Terminal.output(parsed)
+      end
+
+      protected
+
+      # @!attribute [r] output
+      # @return [Array<Array<Vedeu::Char>>]
+      attr_reader :output
+
+      private
+
+      # @return [String]
+      def parsed
+        Vedeu::Compressor.new(output).render
+      end
+
+    end # Terminal
+
+  end # Renderers
 
 end # Vedeu

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

@@ -1,40 +1,45 @@
 module Vedeu
 
-  # Converts a grid of {Vedeu::Char} objects into a stream of escape sequences
-  # and content.
-  #
-  class Renderers::Text
-
-    # @param output [Array<Array<Vedeu::Char>>]
-    # @return [String]
-    def self.render(*output)
-      new(*output).render
-    end
-
-    # Returns a new instance of Vedeu::Renderers::Text.
-    #
-    # @param output [Array<Array<Vedeu::Char>>]
-    # @return [Vedeu::Renderers::Text]
-    def initialize(*output)
-      @output  = output
-    end
-
-    # @return [String]
-    def render
-      parsed
-    end
-
-    private
-
-    # @!attribute [r] output
-    # @return [Array<Array<Vedeu::Char>>]
-    attr_reader :output
-
-    # @return [String]
-    def parsed
-      Vedeu::Compressor.new(output).render
-    end
-
-  end # Renderers::Text
+  module Renderers
+
+    # Converts a grid of {Vedeu::Char} objects into a stream of escape sequences
+    # and content.
+    class Text
+
+      # @param output [Array<Array<Vedeu::Char>>]
+      # @return [String]
+      def self.render(*output)
+        new(*output).render
+      end
+
+      # Returns a new instance of Vedeu::Renderers::Text.
+      #
+      # @param output [Array<Array<Vedeu::Char>>]
+      # @return [Vedeu::Renderers::Text]
+      def initialize(*output)
+        @output  = output
+      end
+
+      # @return [String]
+      def render
+        parsed
+      end
+
+      protected
+
+      # @!attribute [r] output
+      # @return [Array<Array<Vedeu::Char>>]
+      attr_reader :output
+
+      private
+
+      # @return [String]
+      def parsed
+        Vedeu::Compressor.new(output).render
+      end
+
+    end # Text
+
+  end # Renderers
 
 end # Vedeu

data/lib/vedeu/output/style.rb

@@ -1,5 +1,3 @@
-require 'vedeu/support/common'
-
 module Vedeu
 
   # Converts the style value or value collection into a terminal escape
@@ -11,7 +9,6 @@ module Vedeu
   # Styles are applied as encountered.
   #
   # @see Vedeu::Esc
-  #
   class Style
 
     include Vedeu::Common

data/lib/vedeu/output/text.rb

@@ -1,7 +1,6 @@
 module Vedeu
 
   # Present a string (or object responding to `to_s`).
-  #
   class Text
 
     # @see Vedeu::DSL::Text#text
@@ -55,7 +54,7 @@ module Vedeu
       model.add(content)
     end
 
-    private
+    protected
 
     # @!attribute [r] value
     # @return [String]
@@ -65,6 +64,8 @@ module Vedeu
     # @return [Hash]
     attr_reader :options
 
+    private
+
     # @return [Symbol] One of :align, :centre, :center, :left, :right, :text
     def anchor
       options[:anchor]