vedeu 0.4.1 → 0.4.2

data/lib/vedeu/output/foreground.rb

@@ -13,34 +13,19 @@ module Vedeu
 
     private
 
-    # Returns an escape sequence for a named foreground colour.
-    #
-    # Valid names are: `:black`, `:red`, `:green`, `:yellow`, `:blue`,
-    # `:magenta`, `:cyan`, `:white` and `:default`.
-    #
     # @return [String]
-    def named
-      ["\e[", Esc.foreground_codes[colour], 'm'].join
+    def named_codes
+      Esc.foreground_codes[colour]
     end
 
-    # Returns an escape sequence.
-    #
     # @return [String]
-    def numbered
-      ["\e[38;5;", css_to_numbered, 'm'].join
+    def numbered_prefix
+      "\e[38;5;"
     end
 
-    # Returns an escape sequence.
-    #
     # @return [String]
-    def rgb
-      if Configuration.colour_mode == 16777216
-        sprintf("\e[38;2;%s;%s;%sm", *css_to_rgb)
-
-      else
-        numbered
-
-      end
+    def rgb_prefix
+      "\e[38;2;%s;%s;%sm"
     end
 
   end # Foreground

data/lib/vedeu/output/html_renderer.rb

@@ -12,12 +12,11 @@ module Vedeu
     # @return [Vedeu::HTMLRenderer]
     def initialize(output)
       @output = output
-      @object = self
     end
 
     # @return [String]
     def render
-      ERB.new(html_output, nil, '-').result(binding)
+      Template.parse(self, template)
     end
 
     # @param path [String]
@@ -48,8 +47,8 @@ module Vedeu
 
     attr_reader :output
 
-    def html_output
-      @html_output ||= read('html_renderer.vedeu')
+    def template
+      File.dirname(__FILE__) + '/templates/html_renderer.vedeu'
     end
 
     # @return [String]
@@ -62,11 +61,6 @@ module Vedeu
       @timestamp ||= Time.now.to_i
     end
 
-    # @return [String]
-    def read(filename)
-      File.read(File.dirname(__FILE__) + '/templates/' + filename)
-    end
-
   end # HTMLRenderer
 
 end # Vedeu

data/lib/vedeu/output/output.rb

@@ -73,8 +73,8 @@ module Vedeu
       viewport.each_with_index do |line, iy|
         row = []
         line.each_with_index do |char, ix|
-          row << if char.is_a?(Vedeu::Char)
-            char.position = position(iy, ix)
+          row << if char.is_a?(Vedeu::Char) && char.position.nil?
+            char.position = origin(iy, ix)
             char
 
           else
@@ -89,14 +89,7 @@ module Vedeu
 
     # @return [void]
     def viewport
-      @_viewport ||= Vedeu::Viewport.new(interface).render
-    end
-
-    # @param iy [Fixnum]
-    # @param ix [Fixnum]
-    # @return [Vedeu::Position]
-    def position(iy, ix)
-      interface.origin(iy, ix)
+      @viewport ||= Vedeu::Viewport.new(interface).render
     end
 
     # @param value [String]
@@ -107,7 +100,41 @@ module Vedeu
       Vedeu::Char.new({ value:    value,
                         colour:   interface.colour,
                         style:    interface.style,
-                        position: position(iy, ix) })
+                        position: origin(iy, ix) })
+    end
+
+    # Returns the position of the cursor at the top-left coordinate, relative to
+    # the interface's position.
+    #
+    # @param y_index [Fixnum]
+    # @param x_index [Fixnum]
+    # @return [Vedeu::Position]
+    def origin(y_index = 0, x_index = 0)
+      Vedeu::Position.new(virtual_y[y_index], virtual_x[x_index])
+    end
+
+    # Provides a virtual y position within the interface's dimensions.
+    #
+    # @example
+    #   # top = 3
+    #   # bottom = 6
+    #   # virtual_y # => [3, 4, 5]
+    #
+    # @return [Array]
+    def virtual_y
+      @virtual_y ||= (interface.top...interface.bottom).to_a
+    end
+
+    # Provides a virtual x position within the interface's dimensions.
+    #
+    # @example
+    #   # left = 9
+    #   # right = 13
+    #   # virtual_x # => [9, 10, 11, 12]
+    #
+    # @return [Array]
+    def virtual_x
+      @virtual_x ||= (interface.left...interface.right).to_a
     end
 
   end # Output

data/lib/vedeu/output/style.rb

@@ -38,7 +38,7 @@ module Vedeu
     def to_s
       return '' unless defined_value?(value)
 
-      @_sequences ||= Array(value).flatten.map { |v| Esc.string(v) }.join
+      @sequences ||= Array(value).flatten.map { |v| Esc.string(v) }.join
     end
     alias_method :escape_sequences, :to_s
 

data/lib/vedeu/output/translator.rb

@@ -91,11 +91,14 @@ module Vedeu
       colour.is_a?(Symbol) && valid_name?
     end
 
-    # @raise [NotImplemented] Subclasses of this class must implement this
-    #   method.
-    # @return [Exception]
+    # Returns an escape sequence for a named background colour.
+    #
+    # @note
+    #   Valid names can be found at {Vedeu::Esc#codes}
+    #
+    # @return [String]
     def named
-      fail NotImplemented, 'Subclasses implement this.'
+      ["\e[", named_codes, 'm'].join
     end
 
     # Returns a boolean indicating whether the colour provided is a valid named
@@ -114,11 +117,24 @@ module Vedeu
       colour.is_a?(Fixnum) && valid_range?
     end
 
-    # @raise [NotImplemented] Subclasses of this class must implement this
-    #   method.
-    # @return [NotImplemented]
+    # Returns an escape sequence.
+    #
+    # @return [String]
     def numbered
-      fail NotImplemented, 'Subclasses implement this.'
+      [numbered_prefix, css_to_numbered, 'm'].join
+    end
+
+    # Returns an escape sequence.
+    #
+    # @return [String]
+    def rgb
+      if Configuration.colour_mode == 16777216
+        sprintf(rgb_prefix, *css_to_rgb)
+
+      else
+        numbered
+
+      end
     end
 
     # Returns a boolean indicating whether the numbered colour is within the
@@ -136,13 +152,6 @@ module Vedeu
       colour.is_a?(String) && valid_rgb?
     end
 
-    # @raise [NotImplemented] Subclasses of this class must implement this
-    #   method.
-    # @return [NotImplemented]
-    def rgb
-      fail NotImplemented, 'Subclasses implement this.'
-    end
-
     # Returns a boolean indicated whether the colour is a valid HTML/CSS colour.
     #
     # @return [Boolean]
@@ -201,6 +210,27 @@ module Vedeu
       (css_to_rgb[2] / 51) * 1
     end
 
+    # @raise [NotImplemented] Subclasses of this class must implement this
+    #   method.
+    # @return [Exception]
+    def named_codes
+      fail NotImplemented, 'Subclasses implement this.'
+    end
+
+    # @raise [NotImplemented] Subclasses of this class must implement this
+    #   method.
+    # @return [NotImplemented]
+    def numbered_prefix
+      fail NotImplemented, 'Subclasses implement this.'
+    end
+
+    # @raise [NotImplemented] Subclasses of this class must implement this
+    #   method.
+    # @return [NotImplemented]
+    def rgb_prefix
+      fail NotImplemented, 'Subclasses implement this.'
+    end
+
   end # Translator
 
 end # Vedeu

data/lib/vedeu/output/viewport.rb

@@ -182,7 +182,7 @@ module Vedeu
 
     # @return [Vedeu::Border]
     def border
-      @_border ||= Vedeu.borders.find(interface.name)
+      @border ||= Vedeu.borders.find(interface.name)
     end
 
     # @return [Boolean]

data/lib/vedeu/output/virtual_buffer.rb

@@ -31,7 +31,7 @@ module Vedeu
     #
     # @return [Array]
     def clear
-      @_storage = in_memory
+      @storage = in_memory
     end
     alias_method :reset, :clear
 
@@ -41,7 +41,7 @@ module Vedeu
     #
     # @return [Array]
     def storage
-      @_storage ||= in_memory
+      @storage ||= in_memory
     end
 
     # Returns an empty collection ready for the storing of virtual buffers.

data/lib/vedeu/output/wordwrap.rb

@@ -11,7 +11,7 @@ module Vedeu
     # @return [Vedeu::Wordwrap]
     def initialize(text, options = {})
       @text    = text
-      @options = defaults.merge(options)
+      @options = defaults.merge!(options)
     end
 
     # @return [Array<String>|String]

data/lib/vedeu/repositories/all.rb

@@ -9,7 +9,7 @@ module Vedeu
 
     # @return [Vedeu::Borders]
     def self.borders
-      @_borders ||= Vedeu::Borders.new(Vedeu::Border)
+      @borders ||= Vedeu::Borders.new(Vedeu::Border)
     end
 
   end # Borders
@@ -20,7 +20,7 @@ module Vedeu
 
     # @return [Vedeu::Buffers]
     def self.buffers
-      @_buffers ||= Vedeu::Buffers.new(Vedeu::Buffer)
+      @buffers ||= Vedeu::Buffers.new(Vedeu::Buffer)
     end
 
   end # Buffers
@@ -31,7 +31,7 @@ module Vedeu
 
     # @return [Vedeu::Cursors]
     def self.cursors
-      @_cursors ||= Vedeu::Cursors.new(Vedeu::Cursor)
+      @cursors ||= Vedeu::Cursors.new(Vedeu::Cursor)
     end
 
     # @return [Vedeu::Cursor]
@@ -47,7 +47,7 @@ module Vedeu
 
     # @return [Vedeu::Events]
     def self.events
-      @_events ||= Vedeu::Events.new(Vedeu::Model::Collection)
+      @events ||= Vedeu::Events.new(Vedeu::Model::Collection)
     end
 
   end # Events
@@ -59,7 +59,7 @@ module Vedeu
 
     # @return [Vedeu::Geometries]
     def self.geometries
-      @_geometries ||= Vedeu::Geometries.new(Vedeu::Geometry)
+      @geometries ||= Vedeu::Geometries.new(Vedeu::Geometry)
     end
 
   end # Geometries
@@ -70,7 +70,7 @@ module Vedeu
 
     # @return [Vedeu::Groups]
     def self.groups
-      @_groups ||= Vedeu::Groups.new(Vedeu::Group)
+      @groups ||= Vedeu::Groups.new(Vedeu::Group)
     end
 
   end # Groups
@@ -81,7 +81,7 @@ module Vedeu
 
     # @return [Vedeu::InterfacesRepository]
     def self.interfaces
-      @_interfaces ||= Vedeu::InterfacesRepository.new(Vedeu::Interface)
+      @interfaces ||= Vedeu::InterfacesRepository.new(Vedeu::Interface)
     end
 
   end # InterfacesRepository
@@ -92,7 +92,7 @@ module Vedeu
 
     # @return [Vedeu::Keymaps]
     def self.keymaps
-      @_keymaps ||= Vedeu::Keymaps.new(Vedeu::Keymap)
+      @keymaps ||= Vedeu::Keymaps.new(Vedeu::Keymap)
     end
 
   end # Keymaps
@@ -103,7 +103,7 @@ module Vedeu
 
     # @return [Vedeu::Menus]
     def self.menus
-      @_menus ||= Vedeu::Menus.new(Vedeu::Menu)
+      @menus ||= Vedeu::Menus.new(Vedeu::Menu)
     end
 
   end # Menus

data/lib/vedeu/repositories/repository.rb

@@ -28,13 +28,6 @@ module Vedeu
       @storage = storage
     end
 
-    # Returns log friendly output.
-    #
-    # @return [String]
-    def inspect
-      "<#{self.class.name} (#{storage.size})>"
-    end
-
     # Return the whole repository.
     #
     # @return [Array|Hash|Set]

data/lib/vedeu/support/all.rb

@@ -1,18 +1,12 @@
-require 'vedeu/support/bounding_area'
 require 'vedeu/support/coercions'
 require 'vedeu/support/common'
 require 'vedeu/support/console'
-require 'vedeu/support/content_geometry'
-require 'vedeu/support/coordinate'
 require 'vedeu/support/esc'
-require 'vedeu/support/grid'
-require 'vedeu/support/limit'
 require 'vedeu/support/log'
-require 'vedeu/support/position'
-require 'vedeu/support/position_validator'
 require 'vedeu/support/read'
 require 'vedeu/support/refresh'
 require 'vedeu/support/sentence'
+require 'vedeu/support/template'
 require 'vedeu/support/terminal'
 require 'vedeu/support/text'
 require 'vedeu/support/trace'

data/lib/vedeu/support/esc.rb

@@ -9,7 +9,38 @@ module Vedeu
 
     extend self
 
-    # Produces the foreground named colour escape sequence hash.
+    # Produces the foreground named colour escape sequence hash. The background
+    # escape sequences are also generated from this by adding 10 to the values.
+    # This hash gives rise to methods you can call directly on `Esc` to produce
+    # the desired colours:
+    #
+    # @example
+    #   Esc.red                     # => "\e[31m"
+    #
+    #   Esc.red { 'some text' }     # => "\e[31msome text\e[39m"
+    #
+    #   Esc.on_blue                 # => "\e[44m"
+    #
+    #   Esc.on_blue { 'some text' } # => "\e[44msome text\e[49m"
+    #
+    #   # Valid names:
+    #   :black
+    #   :red
+    #   :green
+    #   :yellow
+    #   :blue
+    #   :magenta
+    #   :cyan
+    #   :light_grey
+    #   :default
+    #   :dark_grey
+    #   :light_red
+    #   :light_green
+    #   :light_yellow
+    #   :light_blue
+    #   :light_magenta
+    #   :light_cyan
+    #   :white
     #
     # @return [Hash]
     def codes
@@ -40,21 +71,12 @@ module Vedeu
     #
     # @return [Hash]
     def background_codes
-      Esc.codes.inject({}) { |h, (k, v)| h.merge(k => v + 10) }
+      Esc.codes.inject({}) { |h, (k, v)| h.merge!(k => v + 10) }
     end
 
     # Dynamically creates methods for each terminal named colour. When a block
     # is given, then the colour is reset to 'default' once the block is called.
     #
-    # @example
-    #   Esc.red                     # => "\e[31m"
-    #
-    #   Esc.red { 'some text' }     # => "\e[31msome text\e[39m"
-    #
-    #   Esc.on_blue                 # => "\e[44m"
-    #
-    #   Esc.on_blue { 'some text' } # => "\e[44msome text\e[49m"
-    #
     # @return [String]
     foreground_codes.each do |key, code|
       define_method(key) do |&blk|