vedeu 0.4.17 → 0.4.18

data/lib/vedeu/null/buffer.rb

@@ -0,0 +1,44 @@
+module Vedeu
+
+  module Null
+
+    # Provides a non-existent Vedeu::Buffer that acts like the real thing, but
+    # does nothing.
+    #
+    class Buffer
+
+      # @!attribute [r] name
+      # @return [String]
+      attr_reader :name
+
+      # @param name [String]
+      # @return [Vedeu::Null::Buffer]
+      def initialize(name)
+        @name = name
+      end
+
+      # @return [NilClass]
+      def clear
+        nil
+      end
+
+      # @return [NilClass]
+      def hide
+        nil
+      end
+
+      # @return [NilClass]
+      def render
+        nil
+      end
+
+      # @return [NilClass]
+      def show
+        nil
+      end
+
+    end # Buffer
+
+  end # Null
+
+end # Vedeu

data/lib/vedeu/null/generic.rb

@@ -0,0 +1,52 @@
+module Vedeu
+
+  module Null
+
+    # Provides a non-existent model to swallow messages.
+    #
+    class Generic
+
+      # @return [Vedeu::Null::Generic]
+      def initialize; end
+
+      # @return [NilClass]
+      def add(*)
+        nil
+      end
+
+      # @return [NilClass]
+      def colour
+        nil
+      end
+
+      # @return [NilClass]
+      def parent
+        nil
+      end
+
+      # @return [Vedeu::Null::Generic]
+      def store
+        self
+      end
+
+      # @return [NilClass]
+      def style
+        nil
+      end
+
+      # @return [FalseClass]
+      def visible?
+        false
+      end
+      alias_method :visible, :visible?
+
+      # @return [FalseClass]
+      def visible=(*)
+        false
+      end
+
+    end # Generic
+
+  end # Null
+
+end # Vedeu

data/lib/vedeu/null/geometry.rb

@@ -0,0 +1,70 @@
+module Vedeu
+
+  module Null
+
+    # Provides a non-existent model to swallow messages.
+    #
+    class Geometry
+
+      extend Forwardable
+
+      def_delegators :area,
+                     :north,
+                     :east,
+                     :south,
+                     :west,
+                     :top,
+                     :right,
+                     :bottom,
+                     :left,
+                     :y,
+                     :xn,
+                     :yn,
+                     :x,
+                     :height,
+                     :width
+
+      # @!attribute [r] name
+      # @return [String|NilClass]
+      attr_reader :name
+
+      # Returns a new instance of Vedeu::Null::Geometry.
+      #
+      # @param name [String|NilClass]
+      # @return [Vedeu::Null::Geometry]
+      def initialize(name = nil)
+        @name = name
+      end
+
+      # @return [FalseClass]
+      def centred
+        false
+      end
+
+      # @return [Vedeu::Null::Geometry]
+      def store
+        self
+      end
+
+      private
+
+      # @return [Vedeu::Area]
+      def area
+        @area ||= Vedeu::Area.from_dimensions(y_yn: y_yn, x_xn: x_xn)
+      end
+
+      # @return [Array<Fixnum>]
+      def x_xn
+        @x_xn ||= Vedeu::Dimension.pair(default: Vedeu::Terminal.width)
+      end
+
+      # @return [Array<Fixnum>]
+      def y_yn
+        @y_yn ||= Vedeu::Dimension.pair(default: Vedeu::Terminal.height)
+      end
+
+    end # Geometry
+
+  end # Null
+
+end # Vedeu

data/lib/vedeu/null/interface.rb

@@ -0,0 +1,23 @@
+module Vedeu
+
+  module Null
+
+    # Provides a non-existent model to swallow messages.
+    #
+    class Interface
+
+      # @!attribute [r] attributes
+      # @return [Hash]
+      attr_reader :attributes
+
+      # @param attributes [Hash]
+      # @return [Vedeu::Null::Interface]
+      def initialize(attributes = {})
+        @attributes = attributes
+      end
+
+    end # Interface
+
+  end # Null
+
+end # Vedeu

data/lib/vedeu/output/all.rb

@@ -3,7 +3,6 @@ require_relative 'translator'
 require_relative 'background'
 require_relative 'foreground'
 require_relative 'border'
-require_relative 'null_border'
 require_relative 'colour'
 require_relative 'compressor'
 require_relative 'clear'

data/lib/vedeu/output/border.rb

@@ -174,7 +174,7 @@ module Vedeu
 
     # @return [String]
     def to_s
-      Vedeu::TextRenderer.render(render)
+      Vedeu::Renderers::Text.render(render)
     end
 
     # Renders the bottom border for the interface.
@@ -364,14 +364,14 @@ module Vedeu
     # @return [Vedeu::Position]
     def position(name, iy = 0, ix = 0)
       case name
-      when :top_horizontal    then Vedeu::Position[y, (bx + ix)]
-      when :bottom_horizontal then Vedeu::Position[yn, (bx + ix)]
-      when :left_vertical     then Vedeu::Position[(by + iy), x]
-      when :right_vertical    then Vedeu::Position[(by + iy), xn]
-      when :bottom_left       then geometry.bottom_left
-      when :bottom_right      then geometry.bottom_right
-      when :top_left          then geometry.top_left
-      when :top_right         then geometry.top_right
+      when :top_horizontal    then [y, (bx + ix)]
+      when :bottom_horizontal then [yn, (bx + ix)]
+      when :left_vertical     then [(by + iy), x]
+      when :right_vertical    then [(by + iy), xn]
+      when :bottom_left       then [yn, x]
+      when :bottom_right      then [yn, xn]
+      when :top_left          then [y, x]
+      when :top_right         then [y, xn]
       end
     end
 

data/lib/vedeu/output/clear.rb

@@ -105,7 +105,8 @@ module Vedeu
     #   the terminal, or the colours of the interface.
     def clear_colour
       if use_terminal_colours?
-        Vedeu::Colour.new(background: :default, foreground: :default)
+        @colour ||= Vedeu::Colour.new(background: :default,
+                                      foreground: :default)
 
       else
         colour

data/lib/vedeu/output/output.rb

@@ -30,7 +30,7 @@ module Vedeu
       if Vedeu::Configuration.drb?
         Vedeu.trigger(:_drb_store_output_, content)
 
-        Vedeu::HTMLRenderer.to_file(Vedeu::VirtualBuffer.retrieve)
+        Vedeu::Renderers::HTML.to_file(Vedeu::VirtualBuffer.retrieve)
       end
 
       Vedeu.renderers.render(content)

data/lib/vedeu/output/refresh.rb

@@ -39,7 +39,7 @@ module Vedeu
     def by_name(name)
       Vedeu.log(type: :info, message: "Refreshing interface: '#{name}'")
 
-      Vedeu.buffers.render(name)
+      Vedeu.buffers.by_name(name).render
     end
 
   end # Refresh

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

@@ -1,10 +1,10 @@
-require_relative 'escape_sequence_renderer'
-require_relative 'file_renderer'
-require_relative 'html_renderer'
-require_relative 'json_renderer'
-require_relative 'null_renderer'
-require_relative 'terminal_renderer'
-require_relative 'text_renderer'
+require_relative 'escape_sequence'
+require_relative 'file'
+require_relative 'html'
+require_relative 'json'
+require_relative 'null'
+require_relative 'terminal'
+require_relative 'text'
 
 module Vedeu
 

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

@@ -0,0 +1,47 @@
+module Vedeu
+
+  module Renderers
+
+    # A renderer which returns the escape sequence for each character.
+    #
+    class EscapeSequence
+
+      # @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: "#{self.class.name}:\n#{parsed}")
+
+        parsed
+      end
+
+      private
+
+      # @!attribute [r] output
+      # @return [Array<Array<Vedeu::Char>>]
+      attr_reader :output
+
+      # Escapes the escape sequences.
+      #
+      # @return [String]
+      def parsed
+        @parsed ||= Array(output).flatten.map do |char|
+          Esc.escape(char.to_s) + "\n"
+        end.join
+      end
+
+    end # EscapeSequence
+
+  end # Renderers
+
+end # Vedeu

data/lib/vedeu/output/renderers/{file_renderer.rb → file.rb}

@@ -4,7 +4,7 @@ module Vedeu
   # and content suitable for a terminal, and writes them to a file in the /tmp
   # directory.
   #
-  class FileRenderer
+  class Renderers::File
 
     # @param output [Array<Array<Vedeu::Char>>]
     # @param options [Hash]
@@ -13,11 +13,11 @@ module Vedeu
       new(output, options).render
     end
 
-    # Returns a new instance of Vedeu::FileRenderer.
+    # Returns a new instance of Vedeu::Renderers::File.
     #
     # @param output [Array<Array<Vedeu::Char>>]
     # @param options [Hash]
-    # @return [Vedeu::FileRenderer]
+    # @return [Vedeu::Renderers::File]
     def initialize(output, options = {})
       @output  = output
       @options = options
@@ -25,7 +25,7 @@ module Vedeu
 
     # @return [String]
     def render
-      File.open("/tmp/#{filename}", 'w') { |f| f.write(parsed) }
+      File.open(path, 'w') { |f| f.write(parsed) }
 
       parsed
     end
@@ -36,6 +36,11 @@ module Vedeu
     # @return [Array<Array<Vedeu::Char>>]
     attr_reader :output
 
+    # @return [String]
+    def path
+      "/tmp/#{filename}"
+    end
+
     # @return [String]
     def filename
       if timestamp?
@@ -54,7 +59,7 @@ module Vedeu
 
     # @return [Float]
     def timestamp
-      Time.now.to_f
+      @timestamp ||= Time.now.to_f
     end
 
     # @return [Boolean]
@@ -76,6 +81,6 @@ module Vedeu
       }
     end
 
-  end # FileRenderer
+  end # Renderers::File
 
 end # Vedeu

data/lib/vedeu/output/renderers/{html_renderer.rb → html.rb}

@@ -2,7 +2,7 @@ module Vedeu
 
   # Renders a {Vedeu::VirtualBuffer} or {Vedeu::Output} as a HTML table.
   #
-  class HTMLRenderer
+  class Renderers::HTML
 
     # @param output [Array<Array<Vedeu::Char>>]
     # @return [String]
@@ -17,10 +17,10 @@ module Vedeu
       new(output).to_file(path)
     end
 
-    # Returns a new instance of Vedeu::HTMLRenderer.
+    # Returns a new instance of Vedeu::Renderers::HTML.
     #
     # @param output [Array<Array<Vedeu::Char>>]
-    # @return [Vedeu::HTMLRenderer]
+    # @return [Vedeu::Renderers::HTML]
     def initialize(output)
       @output = output
     end
@@ -80,6 +80,6 @@ module Vedeu
       @timestamp ||= Time.now.to_i
     end
 
-  end # HTMLRenderer
+  end # Renderers::HTML
 
 end # Vedeu

data/lib/vedeu/output/renderers/{json_renderer.rb → json.rb}

@@ -2,7 +2,7 @@ module Vedeu
 
   # Renders a {Vedeu::VirtualBuffer} or {Vedeu::Output} as JSON.
   #
-  class JSONRenderer
+  class Renderers::JSON
 
     # @param output [Array<Array<Vedeu::Char>>]
     # @return [String]
@@ -17,10 +17,10 @@ module Vedeu
     #   new(output).to_file(path)
     # end
 
-    # Returns a new instance of Vedeu::JSONRenderer.
+    # Returns a new instance of Vedeu::Renderers::JSON.
     #
     # @param output [Array<Array<Vedeu::Char>>]
-    # @return [Vedeu::JSONRenderer]
+    # @return [Vedeu::Renderers::JSON]
     def initialize(output)
       @output = output
     end
@@ -47,6 +47,6 @@ module Vedeu
     # @return [Array<Array<Vedeu::Char>>]
     attr_reader :output
 
-  end # JSONRenderer
+  end # Renderers::JSON
 
 end # Vedeu

data/lib/vedeu/output/renderers/{null_renderer.rb → null.rb}

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

data/lib/vedeu/output/renderers/{terminal_renderer.rb → terminal.rb}

@@ -3,7 +3,7 @@ module Vedeu
   # Converts a grid of {Vedeu::Char} objects into a stream of escape sequences
   # and content suitable for a terminal.
   #
-  class TerminalRenderer
+  class Renderers::Terminal
 
     # @param output [Array<Array<Vedeu::Char>>]
     # @return [String]
@@ -11,10 +11,10 @@ module Vedeu
       new(*output).render
     end
 
-    # Returns a new instance of Vedeu::TerminalRenderer.
+    # Returns a new instance of Vedeu::Renderers::Terminal.
     #
     # @param output [Array<Array<Vedeu::Char>>]
-    # @return [Vedeu::TerminalRenderer]
+    # @return [Vedeu::Renderers::Terminal]
     def initialize(*output)
       @output = output
     end
@@ -35,6 +35,6 @@ module Vedeu
       Vedeu::Compressor.new(output).render
     end
 
-  end # TerminalRenderer
+  end # Renderers::Terminal
 
 end # Vedeu

data/lib/vedeu/output/renderers/{text_renderer.rb → text.rb}

@@ -3,7 +3,7 @@ module Vedeu
   # Converts a grid of {Vedeu::Char} objects into a stream of escape sequences
   # and content.
   #
-  class TextRenderer
+  class Renderers::Text
 
     # @param output [Array<Array<Vedeu::Char>>]
     # @return [String]
@@ -11,10 +11,10 @@ module Vedeu
       new(*output).render
     end
 
-    # Returns a new instance of Vedeu::TextRenderer.
+    # Returns a new instance of Vedeu::Renderers::Text.
     #
     # @param output [Array<Array<Vedeu::Char>>]
-    # @return [Vedeu::TextRenderer]
+    # @return [Vedeu::Renderers::Text]
     def initialize(*output)
       @output  = output
     end
@@ -35,6 +35,6 @@ module Vedeu
       Vedeu::Compressor.new(output).render
     end
 
-  end # TextRenderer
+  end # Renderers::Text
 
 end # Vedeu

data/lib/vedeu/output/text.rb

@@ -133,9 +133,9 @@ module Vedeu
 
     # Returns the model option if set.
     #
-    # @return [Vedeu::Interface|Vedeu::Line|Vedeu::Null|Vedeu::Stream]
+    # @return [Vedeu::Interface|Vedeu::Line|Vedeu::Null::Generic|Vedeu::Stream]
     def model
-      @model ||= options[:model] || Vedeu::Null.new
+      @model ||= options[:model] || Vedeu::Null::Generic.new
     end
 
     # The character to use for padding the string.

data/lib/vedeu/output/virtual_terminal.rb

@@ -20,9 +20,9 @@ module Vedeu
     #
     # @param height [Fixnum]
     # @param width [Fixnum]
-    # @param renderer [Object|HTMLRenderer] An object responding to .render.
+    # @param renderer [Object|Renderers::HTML] An object responding to .render.
     # @return [Vedeu::VirtualTerminal]
-    def initialize(height, width, renderer = Vedeu::HTMLRenderer)
+    def initialize(height, width, renderer = Vedeu::Renderers::HTML)
       @height   = height
       @width    = width
       @renderer = renderer

data/lib/vedeu/repositories/all.rb

@@ -18,6 +18,8 @@ module Vedeu
       storage.add(klass)
     end
 
+    # Remove all stored models from the repository.
+    #
     # @return [TrueClass]
     def reset!
       storage.map(&:repository).map { |repository| repository.send(:reset) }

data/lib/vedeu/repositories/repositories/borders.rb

@@ -13,6 +13,8 @@ module Vedeu
       end
       alias_method :repository, :borders
 
+      # Remove all stored models from the repository.
+      #
       # @return [Vedeu::Borders]
       def reset!
         @borders = Vedeu::Borders.register_repository(Vedeu::Border)
@@ -21,13 +23,13 @@ module Vedeu
     end
 
     # @param name [String] The name of the stored border.
-    # @return [Vedeu::Border|Vedeu::NullBorder]
+    # @return [Vedeu::Border|Vedeu::Null::Border]
     def by_name(name)
       if registered?(name)
         find(name)
 
       else
-        Vedeu::NullBorder.new(name)
+        Vedeu::Null::Border.new(name)
 
       end
     end

data/lib/vedeu/repositories/repositories/buffers.rb

@@ -12,6 +12,8 @@ module Vedeu
       end
       alias_method :repository, :buffers
 
+      # Remove all stored models from the repository.
+      #
       # @return [Vedeu::Buffers]
       def reset!
         @buffers = Vedeu::Buffers.register_repository(Vedeu::Buffer)
@@ -19,16 +21,16 @@ module Vedeu
 
     end
 
-    # @param name [String] The name of buffer to clear.
-    # @return [void]
-    def clear(name)
-      find!(name).clear
-    end
+    # @param name [String] The name of the stored buffer.
+    # @return [Vedeu::Buffer|Vedeu::Null::Buffer]
+    def by_name(name)
+      if registered?(name)
+        find(name)
+
+      else
+        Vedeu::Null::Buffer.new(name)
 
-    # @param name [String] The name of buffer to render.
-    # @return [void]
-    def render(name)
-      find!(name).render
+      end
     end
 
   end # Buffers

data/lib/vedeu/repositories/repositories/cursors.rb

@@ -17,6 +17,8 @@ module Vedeu
         cursors.by_name(Vedeu.focus) if Vedeu.focus
       end
 
+      # Remove all stored models from the repository.
+      #
       # @return [Vedeu::Cursors]
       def reset!
         @cursors = Vedeu::Cursors.register_repository(Vedeu::Cursor)

data/lib/vedeu/repositories/repositories/events_repository.rb

@@ -12,6 +12,8 @@ module Vedeu
       end
       alias_method :repository, :events
 
+      # Remove all stored models from the repository.
+      #
       # @return [Vedeu::EventsRepository]
       def reset!
         @events = Vedeu::EventsRepository.new(Vedeu::Events)

data/lib/vedeu/repositories/repositories/geometries.rb

@@ -13,6 +13,8 @@ module Vedeu
       end
       alias_method :repository, :geometries
 
+      # Remove all stored models from the repository.
+      #
       # @return [Vedeu::Geometries]
       def reset!
         @geometries = Vedeu::Geometries.register_repository(Vedeu::Geometry)
@@ -21,13 +23,13 @@ module Vedeu
     end
 
     # @param name [String] The name of the stored geometry.
-    # @return [Vedeu::Geometry|Vedeu::NullGeometry]
+    # @return [Vedeu::Geometry|Vedeu::Null::Geometry]
     def by_name(name)
       if registered?(name)
         find(name)
 
       else
-        Vedeu::NullGeometry.new(name)
+        Vedeu::Null::Geometry.new(name)
 
       end
     end

data/lib/vedeu/repositories/repositories/groups.rb

@@ -12,6 +12,8 @@ module Vedeu
       end
       alias_method :repository, :groups
 
+      # Remove all stored models from the repository.
+      #
       # @return [Vedeu::Groups]
       def reset!
         @groups = Vedeu::Groups.register_repository(Vedeu::Group)