vedeu 0.6.8 → 0.6.9

data/lib/vedeu/buffers/null.rb

@@ -2,8 +2,8 @@ module Vedeu
 
   module Buffers
 
-    # Provides a non-existent Vedeu::Buffers::Buffer that acts like the real
-    # thing, but does nothing.
+    # Provides a non-existent Vedeu::Buffers::Buffer that acts like
+    # the real thing, but does nothing.
     #
     class Null
 

data/lib/vedeu/buffers/refresh.rb

@@ -11,8 +11,8 @@ module Vedeu
 
       include Vedeu::Common
 
-      # @param name [String] The name of the interface to be refreshed using the
-      #   named buffer.
+      # @param name [String] The name of the interface to be refreshed
+      #   using the named buffer.
       # @return [Array|Vedeu::Error::ModelNotFound]
       def self.by_name(name)
         new(name).by_name
@@ -41,7 +41,8 @@ module Vedeu
 
       private
 
-      # @raise [Vedeu::Error::MissingRequired] When the name is empty or nil.
+      # @raise [Vedeu::Error::MissingRequired] When the name is empty
+      #   or nil.
       # @return [String]
       def buffer_name
         return name if present?(name)

data/lib/vedeu/buffers/virtual_buffer.rb

@@ -1,132 +1,136 @@
 module Vedeu
 
-  # Represents a {Vedeu::Terminal} view as a grid of
-  # {Vedeu::Models::Cell} objects.
-  #
-  class VirtualBuffer
-
-    # @!attribute [rw] renderer
-    # @return [void]
-    attr_accessor :renderer
-
-    # @!attribute [r] height
-    # @return [Fixnum]
-    attr_reader :height
-
-    # @!attribute [r] width
-    # @return [Fixnum]
-    attr_reader :width
-
-    # @param data [Array<Array<Vedeu::Views::Char>>]
-    # @return [Array<Array<Vedeu::Views::Char>>]
-    # @see Vedeu::VirtualBuffer#output
-    def self.output(data)
-      new(Vedeu.height, Vedeu.width, Vedeu::Renderers::HTML.new).output(data)
-    end
-
-    # Returns a new instance of Vedeu::VirtualBuffer.
-    #
-    # @param height [Fixnum]
-    # @param width [Fixnum]
-    # @param renderer [Object|Vedeu::Renderers::HTML] An object
-    #   responding to .render.
-    # @return [Vedeu::VirtualBuffer]
-    def initialize(height, width, renderer = Vedeu::Renderers::HTML.new)
-      @height   = height
-      @width    = width
-      @renderer = renderer
-    end
-
-    # Return a grid of {Vedeu::Views::Char} objects defined by the
-    # height and width of this virtual terminal.
-    #
-    # @return [Array<Array<Vedeu::Views::Char>>]
-    def cells
-      @cells ||= new_virtual_buffer
-    end
+  module Buffers
 
-    # Read a single cell from the virtual terminal.
+    # Represents a {Vedeu::Terminal} view as a grid of
+    # {Vedeu::Models::Cell} objects.
     #
-    # @note
-    #   Given two actual coordinates (y, x) e.g. (1, 1)
-    #   Convert to coordinate indices (cy, cx) e.g. (0, 0)
-    #   Fetch the row at cy and return the cell from cx
-    #
-    # @param y [Fixnum] The row/line coordinate.
-    # @param x [Fixnum] The column/character coordinate.
-    # @return [Vedeu::Views::Char]
-    def read(y, x)
-      cy, cx = Vedeu::Geometry::Position[y, x].as_indices
+    class VirtualBuffer
 
-      row  = fetch(cells, cy)
-      cell = fetch(row, cx)
+      # @!attribute [rw] renderer
+      # @return [void]
+      attr_accessor :renderer
 
-      cell
-    end
+      # @!attribute [r] height
+      # @return [Fixnum]
+      attr_reader :height
 
-    # Write a collection of cells to the virtual terminal.
-    #
-    # @param data [Array<Array<Vedeu::Views::Char>>]
-    # @return [Array<Array<Vedeu::Views::Char>>]
-    def output(data)
-      Array(data).flatten.each do |char|
-        write(char.y, char.x, char) if char.is_a?(Vedeu::Views::Char)
+      # @!attribute [r] width
+      # @return [Fixnum]
+      attr_reader :width
+
+      # @param data [Array<Array<Vedeu::Views::Char>>]
+      # @return [Array<Array<Vedeu::Views::Char>>]
+      # @see Vedeu::Buffers::VirtualBuffer#output
+      def self.output(data)
+        new(Vedeu.height, Vedeu.width, Vedeu::Renderers::HTML.new).output(data)
       end
 
-      cells
-    end
+      # Returns a new instance of Vedeu::Buffers::VirtualBuffer.
+      #
+      # @param height [Fixnum]
+      # @param width [Fixnum]
+      # @param renderer [Object|Vedeu::Renderers::HTML] An object
+      #   responding to .render.
+      # @return [Vedeu::Buffers::VirtualBuffer]
+      def initialize(height, width, renderer = Vedeu::Renderers::HTML.new)
+        @height   = height
+        @width    = width
+        @renderer = renderer
+      end
 
-    # Send the cells to the renderer and return the rendered result.
-    #
-    # @return [String|void] Most likely to be a String.
-    def render
-      renderer.render(cells)
-    end
+      # Return a grid of {Vedeu::Views::Char} objects defined by the
+      # height and width of this virtual terminal.
+      #
+      # @return [Array<Array<Vedeu::Views::Char>>]
+      def cells
+        @cells ||= new_virtual_buffer
+      end
 
-    # Removes all content from the virtual terminal; effectively
-    # clearing it.
-    #
-    # @return [Array<Array<Vedeu::Views::Char>>]
-    def reset
-      @cells = new_virtual_buffer
-    end
-    alias_method :clear, :reset
+      # Read a single cell from the virtual terminal.
+      #
+      # @note
+      #   Given two actual coordinates (y, x) e.g. (1, 1)
+      #   Convert to coordinate indices (cy, cx) e.g. (0, 0)
+      #   Fetch the row at cy and return the cell from cx
+      #
+      # @param y [Fixnum] The row/line coordinate.
+      # @param x [Fixnum] The column/character coordinate.
+      # @return [Vedeu::Views::Char]
+      def read(y, x)
+        cy, cx = Vedeu::Geometry::Position[y, x].as_indices
+
+        row  = fetch(cells, cy)
+        cell = fetch(row, cx)
+
+        cell
+      end
 
-    # Write a single cell to the virtual terminal.
-    #
-    # @note
-    #   If the position (y, x) is nil; we're out of bounds.
-    #   Otherwise, write the data to (cy, cx).
-    #
-    # @param y [Fixnum] The row/line coordinate.
-    # @param x [Fixnum] The column/character coordinate.
-    # @param data [Vedeu::Views::Char]
-    # @return [Vedeu::Views::Char]
-    def write(y, x, data)
-      return false unless read(y, x).is_a?(Vedeu::Models::Cell)
-
-      cy, cx = Vedeu::Geometry::Position[y, x].as_indices
-      cells[cy][cx] = data
-
-      true
-    end
-
-    private
-
-    # @param from [Array] An Array of rows, or an Array of cells.
-    # @param which [Fixnum] A Fixnum representing the index; the row
-    #   number or the cell number for a row.
-    # @return [Array<Vedeu::Views::Char>|Array]
-    def fetch(from, which)
-      from[which] || []
-    end
-
-    # @return [Array<Array<Vedeu::Models::Cell>>]
-    # @see Vedeu::VirtualBuffer#cells
-    def new_virtual_buffer
-      Array.new(height) { Array.new(width) { Vedeu::Models::Cell.new } }
-    end
-
-  end # VirtualBuffer
+      # Write a collection of cells to the virtual terminal.
+      #
+      # @param data [Array<Array<Vedeu::Views::Char>>]
+      # @return [Array<Array<Vedeu::Views::Char>>]
+      def output(data)
+        Array(data).flatten.each do |char|
+          write(char.y, char.x, char) if char.is_a?(Vedeu::Views::Char)
+        end
+
+        cells
+      end
+
+      # Send the cells to the renderer and return the rendered result.
+      #
+      # @return [String|void] Most likely to be a String.
+      def render
+        renderer.render(cells)
+      end
+
+      # Removes all content from the virtual terminal; effectively
+      # clearing it.
+      #
+      # @return [Array<Array<Vedeu::Views::Char>>]
+      def reset
+        @cells = new_virtual_buffer
+      end
+      alias_method :clear, :reset
+
+      # Write a single cell to the virtual terminal.
+      #
+      # @note
+      #   If the position (y, x) is nil; we're out of bounds.
+      #   Otherwise, write the data to (cy, cx).
+      #
+      # @param y [Fixnum] The row/line coordinate.
+      # @param x [Fixnum] The column/character coordinate.
+      # @param data [Vedeu::Views::Char]
+      # @return [Vedeu::Views::Char]
+      def write(y, x, data)
+        return false unless read(y, x).is_a?(Vedeu::Models::Cell)
+
+        cy, cx = Vedeu::Geometry::Position[y, x].as_indices
+        cells[cy][cx] = data
+
+        true
+      end
+
+      private
+
+      # @param from [Array] An Array of rows, or an Array of cells.
+      # @param which [Fixnum] A Fixnum representing the index; the row
+      #   number or the cell number for a row.
+      # @return [Array<Vedeu::Views::Char>|Array]
+      def fetch(from, which)
+        from[which] || []
+      end
+
+      # @return [Array<Array<Vedeu::Models::Cell>>]
+      # @see Vedeu::Buffers::VirtualBuffer#cells
+      def new_virtual_buffer
+        Array.new(height) { Array.new(width) { Vedeu::Models::Cell.new } }
+      end
+
+    end # VirtualBuffer
+
+  end # Buffers
 
 end # Vedeu

data/lib/vedeu/buffers/virtual_buffers.rb

@@ -1,71 +1,77 @@
 module Vedeu
 
-  # Store and retrieve {Vedeu::VirtualBuffer} objects.
-  #
-  # Each {Vedeu::VirtualBuffer} object is a copy of the current terminal
-  # including content but not as String objects but {Vedeu::Views::Char}
-  # objects. Using {Vedeu::Views::Char} objects means that we can store the data
-  # used to make up the displayed character, complete with its colour, position
-  # and style.
-  #
-  # Once a {Vedeu::Views::Char} has been converted to a String, it is tricky to
-  # separate the escape sequences and string data. By deferring this conversion
-  # we can display the {Vedeu::Views::Char} in multiple ways (e.g. HTML) or in
-  # multiple formats (e.g. JSON), and render/use that in an appropriate way.
-  #
-  module VirtualBuffers
+  module Buffers
 
-    extend self
-
-    # Fetch the oldest stored virtual buffer first.
+    # Store and retrieve {Vedeu::Buffers::VirtualBuffer} objects.
+    #
+    # Each {Vedeu::Buffers::VirtualBuffer} object is a copy of the
+    # current terminal including content but not as String objects but
+    # {Vedeu::Views::Char} objects. Using {Vedeu::Views::Char} objects
+    # means that we can store the data used to make up the displayed
+    # character, complete with its colour, position and style.
+    #
+    # Once a {Vedeu::Views::Char} has been converted to a String, it
+    # is tricky to separate the escape sequences and string data. By
+    # deferring this conversion we can display the
+    # {Vedeu::Views::Char} in multiple ways (e.g. HTML) or in multiple
+    # formats (e.g. JSON), and render/use that in an appropriate way.
     #
-    # @return [Array<Array<Vedeu::Views::Char>>|NilClass]
-    def retrieve
-      Vedeu.log(type: :drb, message: 'Retrieving output')
+    module VirtualBuffers
 
-      storage.pop
-    end
+      extend self
 
-    # Store a new virtual buffer.
-    #
-    # @return [Array<Array<Vedeu::Views::Char>>]
-    def store(data)
-      Vedeu.log(type: :drb, message: 'Storing output')
+      # Fetch the oldest stored virtual buffer first.
+      #
+      # @return [Array<Array<Vedeu::Views::Char>>|NilClass]
+      def retrieve
+        Vedeu.log(type: :drb, message: 'Retrieving output')
 
-      storage.unshift(data)
-    end
+        storage.pop
+      end
 
-    # Return the number of virtual buffers currently stored.
-    #
-    # @return [Fixnum]
-    def size
-      storage.size
-    end
+      # Store a new virtual buffer.
+      #
+      # @return [Array<Array<Vedeu::Views::Char>>]
+      def store(data)
+        Vedeu.log(type: :drb, message: 'Storing output')
 
-    # Destroy all virtual buffers currently stored.
-    #
-    # @return [Array]
-    def clear
-      @storage = in_memory
-    end
-    alias_method :reset, :clear
+        storage.unshift(data)
+      end
 
-    private
+      # Return the number of virtual buffers currently stored.
+      #
+      # @return [Fixnum]
+      def size
+        storage.size
+      end
 
-    # Access to the storage for this repository.
-    #
-    # @return [Array]
-    def storage
-      @storage ||= in_memory
-    end
+      # Destroy all virtual buffers currently stored.
+      #
+      # @return [Array]
+      def clear
+        @storage = in_memory
+      end
+      alias_method :reset, :clear
 
-    # Returns an empty collection ready for the storing of virtual buffers.
-    #
-    # @return [Array]
-    def in_memory
-      []
-    end
+      private
+
+      # Access to the storage for this repository.
+      #
+      # @return [Array]
+      def storage
+        @storage ||= in_memory
+      end
+
+      # Returns an empty collection ready for the storing of virtual
+      # buffers.
+      #
+      # @return [Array]
+      def in_memory
+        []
+      end
+
+    end # VirtualBuffers
 
-  end # VirtualBuffers
+  end # Buffers
 
 end # Vedeu

data/lib/vedeu/colours/background.rb

@@ -3,7 +3,8 @@ module Vedeu
   module Colours
 
     # The class represents one half (the other, can be found at
-    # {Vedeu::Colours::Foreground}) of a terminal colour escape sequence.
+    # {Vedeu::Colours::Foreground}) of a terminal colour escape
+    # sequence.
     #
     class Background < Vedeu::Colours::Translator
 

data/lib/vedeu/colours/colour.rb

@@ -2,17 +2,18 @@ module Vedeu
 
   module Colours
 
-    # Provides a container for terminal escape sequences controlling the
-    # foreground and background colours of a character or collection of
-    # characters.
+    # Provides a container for terminal escape sequences controlling
+    # the foreground and background colours of a character or
+    # collection of characters.
     #
-    # 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 (see notes below).
+    # 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 (see notes
+    # below).
     #
-    # Vedeu attempts to detect the colour depth using the `$TERM` environment
-    # variable.
+    # Vedeu attempts to detect the colour depth using the `$TERM`
+    # environment variable.
     #
     # To set your `$TERM` variable to allow 256 colour support:
     #
@@ -21,15 +22,16 @@ module Vedeu
     # ```
     #
     # Notes:
-    # Terminals which support the 24-bit colour mode include (but are not
-    # limited to): iTerm2 (OSX), Gnome Terminal (Linux).
+    # 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 when 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.
+    # Setting your `$TERM` environment variable as above gets you up
+    # to 256 colours, but when 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)
     #
@@ -101,8 +103,8 @@ module Vedeu
         @foreground = Vedeu::Colours::Foreground.coerce(value)
       end
 
-      # Returns both or either of the converted attributes into a single escape
-      # sequence.
+      # Returns both or either of the converted attributes into a
+      # single escape sequence.
       #
       # @return [String]
       def to_s