vedeu 0.3.4 → 0.3.5

data/lib/vedeu/presentation/colour.rb

@@ -7,6 +7,7 @@ module Vedeu
   # characters.
   #
   # @api private
+  #
   class Colour
 
     include Vedeu::Coercions
@@ -24,24 +25,24 @@ module Vedeu
     def initialize(attributes = {})
       @attributes = defaults.merge(attributes)
 
-      @background = Background.escape_sequence(@attributes[:background])
-      @foreground = Foreground.escape_sequence(@attributes[:foreground])
+      @background = Background.coerce(@attributes[:background])
+      @foreground = Foreground.coerce(@attributes[:foreground])
     end
 
-    # Converts the value into a terminal escape sequence.
+    # Converts the value into a Vedeu::Foreground.
     #
     # @param value [String]
     # @return [String]
     def foreground=(value)
-      @foreground = Foreground.escape_sequence(value)
+      @foreground = Foreground.coerce(value)
     end
 
-    # Converts the value into a terminal escape sequence.
+    # Converts the value into a Vedeu::Background.
     #
     # @param value [String]
     # @return [String]
     def background=(value)
-      @background = Background.escape_sequence(value)
+      @background = Background.coerce(value)
     end
 
     # Returns both or either of the converted attributes into a single escape
@@ -49,7 +50,7 @@ module Vedeu
     #
     # @return [String]
     def to_s
-      foreground + background
+      foreground.to_s + background.to_s
     end
 
     private

data/lib/vedeu/presentation/foreground.rb

@@ -8,6 +8,7 @@ module Vedeu
   # {Vedeu::Background}) of a terminal colour escape sequence.
   #
   # @api private
+  #
   class Foreground < Translator
 
     private

data/lib/vedeu/presentation/presentation.rb

@@ -4,8 +4,37 @@ module Vedeu
   # Interface, Line and Stream.
   #
   # @api private
+  #
   module Presentation
 
+    # @return [Vedeu::Background|NilClass]
+    def background
+      if colour
+        colour.background
+      end
+    end
+
+    # @return [Vedeu::Foreground|NilClass]
+    def foreground
+      if colour
+        colour.foreground
+      end
+    end
+
+    # @return [Vedeu::Background|NilClass]
+    def parent_background
+      if parent_colour
+        parent_colour.background
+      end
+    end
+
+    # @return [Vedeu::Foreground|NilClass]
+    def parent_foreground
+      if parent_colour
+        parent_colour.foreground
+      end
+    end
+
     # @return [Vedeu::Colour]
     def colour
       Vedeu::Colour.coerce(@colour)
@@ -32,23 +61,30 @@ module Vedeu
     #
     # @return [String] An escape sequence with value interpolated.
     def to_s
-      render_position { render_colour { render_style { value } } }
+      render_position { render_colour { render_style { render_border { value } } } }
     end
 
     private
 
-    # @return [String]
+    # @return [String|NilClass]
     def parent_colour
-      return '' unless parent
+      parent.colour if parent
+    end
 
-      parent.colour
+    # @return [String|NilClass]
+    def parent_style
+      parent.style if parent
     end
 
     # @return [String]
-    def parent_style
-      return '' unless parent
+    def render_border
+      if self.respond_to?(:border) && !border.nil?
+        Esc.border { yield }
 
-      parent.style
+      else
+        yield
+
+      end
     end
 
     # Renders the colour attributes of the receiver, yields (to then render the

data/lib/vedeu/presentation/translator.rb

@@ -22,6 +22,7 @@ module Vedeu
   #
   # @todo More documentation required (create a fancy chart!)
   # @api private
+  #
   class Translator
 
     include Vedeu::Coercions
@@ -67,6 +68,17 @@ module Vedeu
     end
     alias_method :to_s, :escape_sequence
 
+    # @return [String]
+    def to_html
+      if rgb?
+        colour
+
+      else
+        ''
+
+      end
+    end
+
     private
 
     # @return [Boolean]

data/lib/vedeu/repositories/repository.rb

@@ -12,6 +12,7 @@ module Vedeu
   #   { 'models' => [Model] }
   #
   # @api private
+  #
   class Repository
 
     include Vedeu::Common
@@ -74,13 +75,13 @@ module Vedeu
     # Find a model by name, registers the model by name if not found.
     #
     # @param name [String]
-    # @return []
+    # @return [void]
     def find_or_create(name)
       if registered?(name)
         find(name)
 
       else
-        Vedeu.log("Model (#{model}) not found, registering: '#{name}'")
+        Vedeu.log(type: :store, message: "Model (#{model}) not found, registering: '#{name}'")
 
         model.new(name).store
       end
@@ -141,12 +142,13 @@ module Vedeu
     # Stores the model instance by name in the repository of the model.
     #
     # @param model [void] A model instance.
+    # @raise [MissingRequired] When the name attribute is not defined.
     # @return [void] The model instance which was stored.
     def store(model)
       fail MissingRequired, "Cannot store model '#{model.class}' without a " \
                             "name attribute." unless defined_value?(model.name)
 
-      Vedeu.log(_log_store(model))
+      Vedeu.log(type: log_type(model), message: "#{model.class.name}: '#{model.name}'")
 
       storage[model.name] = model
     end
@@ -174,14 +176,12 @@ module Vedeu
     end
 
     # @return [String]
-    def _log_store(model)
-      message = "Storing #{model.class.name}: '#{model.name}' "
-
+    def log_type(model)
       if registered?(model.name)
-        message + '(updating)'
+        :update
 
       else
-        message + '(creating)'
+        :create
 
       end
     end

data/lib/vedeu/support/bounding_area.rb

@@ -1,5 +1,7 @@
 module Vedeu
 
+  # Provides coordinates based on the height and width provided.
+  #
   class BoundingArea
 
     attr_reader :height,

data/lib/vedeu/support/coercions.rb

@@ -5,6 +5,7 @@ module Vedeu
   # Provides means to convert attributes into the correct model.
   #
   # @api private
+  #
   module Coercions
 
     include Vedeu::Common
@@ -48,7 +49,7 @@ module Vedeu
     # directly.
     #
     # @param receiver [Class] The class in which this module is included.
-    # @return []
+    # @return [void]
     def self.included(receiver)
       receiver.extend(self)
     end

data/lib/vedeu/support/common.rb

@@ -3,6 +3,7 @@ module Vedeu
   # A module for common methods used throughout Vedeu.
   #
   # @api private
+  #
   module Common
 
     # Returns a boolean indicating whether a variable has a useful value.

data/lib/vedeu/support/console.rb

@@ -3,13 +3,30 @@ require 'vedeu/support/write'
 
 module Vedeu
 
+  # An abstract terminal class.
+  #
   class Console
 
+    attr_reader :height,
+      :origin,
+      :width
+
+    alias_method :tyn, :height
+    alias_method :yn, :height
+    alias_method :x, :origin
+    alias_method :y, :origin
+    alias_method :tx, :origin
+    alias_method :ty, :origin
+    alias_method :txn, :width
+    alias_method :xn, :width
+
     # @param height [Fixnum]
     # @param width [Fixnum]
+    # @return [Vedeu::Console]
     def initialize(height = 25, width = 80)
       @height = height || 25
       @width  = width  || 80
+      @origin = 1
     end
 
     # @param data [String|NilClass]
@@ -56,22 +73,6 @@ module Vedeu
       yield
     end
 
-    # @return [Fixnum]
-    def height
-      @height
-    end
-    alias_method :tyn, :height
-    alias_method :yn, :height
-
-    # @return [Fixnum]
-    def origin
-      1
-    end
-    alias_method :x, :origin
-    alias_method :y, :origin
-    alias_method :tx, :origin
-    alias_method :ty, :origin
-
     # @param block [Proc]
     # @return [Proc]
     def raw(&block)
@@ -84,13 +85,6 @@ module Vedeu
     end
     alias_method :winsize, :size
 
-    # @return [Fixnum]
-    def width
-      @width
-    end
-    alias_method :txn, :width
-    alias_method :xn, :width
-
   end # Console
 
 end # Vedeu

data/lib/vedeu/support/content_geometry.rb

@@ -1,5 +1,7 @@
 module Vedeu
 
+  # Provides information about the content within an interface or view.
+  #
   class ContentGeometry
 
     extend Forwardable

data/lib/vedeu/support/coordinate.rb

@@ -1,6 +1,7 @@
 module Vedeu
 
   # Crudely corrects out of range values.
+  #
   class Coordinate
 
     attr_reader :height,

data/lib/vedeu/support/esc.rb

@@ -4,6 +4,7 @@ module Vedeu
   # display related functions.
   #
   # @api private
+  #
   module Esc
 
     extend self
@@ -13,15 +14,23 @@ module Vedeu
     # @return [Hash]
     def codes
       {
-        black:   30,
-        red:     31,
-        green:   32,
-        yellow:  33,
-        blue:    34,
-        magenta: 35,
-        cyan:    36,
-        white:   37,
-        default: 39,
+        black:         30,
+        red:           31,
+        green:         32,
+        yellow:        33,
+        blue:          34,
+        magenta:       35,
+        cyan:          36,
+        light_grey:    37,
+        default:       39,
+        dark_grey:     90,
+        light_red:     91,
+        light_green:   92,
+        light_yellow:  93,
+        light_blue:    94,
+        light_magenta: 95,
+        light_cyan:    96,
+        white:         97,
       }
     end
     alias_method :foreground_codes, :codes
@@ -72,18 +81,6 @@ module Vedeu
       stream.gsub(/\e/, '\\e')
     end
 
-    # Return the escape sequence required to position the cursor at a particular
-    # point on the screen. When passed a block, will do the aforementioned,
-    # call the block and then reposition to this location.
-    #
-    # @param y     [Fixnum] The row/line position.
-    # @param x     [Fixnum] The column/character position.
-    # @param block [Proc]
-    # @return      [String]
-    def set_position(y = 1, x = 1, &block)
-      Position.new(y, x).to_s(&block)
-    end
-
     # Return the escape sequence string from the list of recognised sequence
     # 'commands', or an empty string if the 'command' cannot be found.
     #
@@ -95,6 +92,16 @@ module Vedeu
       sequences.fetch(value.to_sym, proc { '' }).call
     end
 
+    # Return the escape sequence to render a border character.
+    #
+    # @param block [Proc]
+    # @return [String]
+    def border(&block)
+      return '' unless block_given?
+
+      [ border_on, yield, border_off ].join
+    end
+
     private
 
     # @return [Hash]
@@ -126,7 +133,7 @@ module Vedeu
 
     # @return [String]
     def bg_reset
-      "\e[48;2;49m"
+      "\e[49m"
     end
 
     # @return [String]
@@ -149,21 +156,39 @@ module Vedeu
       "\e[22m"
     end
 
+    # Returns the escape sequence to start a border.
+    #
+    # @return [String]
+    def border_on
+      "\e(0"
+    end
+
+    # Returns the escape sequence to end a border.
+    #
+    # @return [String]
+    def border_off
+      "\e(B"
+    end
+
     # @return [String]
     def clear
-      [ colour_reset,
-        "\e[2J" ].join
+      [
+        colour_reset,
+        "\e[2J"
+      ].join
     end
 
     # @return [String]
     def clear_line
-      [ colour_reset,
-        "\e[2K" ].join
+      [
+        colour_reset,
+        "\e[2K"
+      ].join
     end
 
     # @return [String]
     def clear_last_line
-      [set_position((Terminal.height - 1), 1), clear_line].join
+      Vedeu::Position.new((Terminal.height - 1), 1).to_s { clear_line }
     end
 
     # @return [String]
@@ -178,7 +203,7 @@ module Vedeu
 
     # @return [String]
     def fg_reset
-      "\e[38;2;39m"
+      "\e[39m"
     end
 
     # @return [String]
@@ -213,7 +238,11 @@ module Vedeu
 
     # @return [String]
     def screen_exit
-      [show_cursor, colour_reset, reset].join
+      [
+        show_cursor,
+        colour_reset,
+        reset
+      ].join
     end
 
     # @return [String]

data/lib/vedeu/support/grid.rb

@@ -25,6 +25,7 @@ module Vedeu
   # the remainder.
   #
   # @api private
+  #
   class Grid
 
     # @param value [Fixnum]

data/lib/vedeu/support/limit.rb

@@ -1,11 +1,19 @@
 module Vedeu
 
+  # Forces the value within defined limits.
+  #
   class Limit
 
+    # @see #new, #apply
     def self.apply(v, vn, max, min = 1)
       new(v, vn, max, min).apply
     end
 
+    # @param v [Fixnum]
+    # @param vn [Fixnum]
+    # @param max [Fixnum]
+    # @param min [Fixnum]
+    # @return [Vedeu::Limit]
     def initialize(v, vn, max, min = 1)
       @v   = v
       @vn  = vn
@@ -13,6 +21,7 @@ module Vedeu
       @min = min || 1
     end
 
+    # @return [Fixnum]
     def apply
       if (v + vn) > max
         applied = vn - ((v + vn) - max)

data/lib/vedeu/support/log.rb

@@ -5,25 +5,26 @@ module Vedeu
   # Provides the ability to log anything to the Vedeu log file.
   #
   # @api private
+  #
   class Log
 
     class << self
 
       # Write a message to the Vedeu log file.
       #
-      # @param message [String] The message you wish to emit to the log
-      #   file, useful for debugging.
-      # @param force   [Boolean] When evaluates to true will attempt to
-      #   write to the log file regardless of the Configuration setting.
+      # @param message [String] The message you wish to emit to the log file,
+      #   useful for debugging.
+      # @param force   [Boolean] When evaluates to true will attempt to write to
+      #   the log file regardless of the Configuration setting.
+      # @param type    [Symbol] Colour code messages in the log file depending
+      #   on their source.
       #
       # @example
-      #   Vedeu.log('A useful debugging message: Error!')
+      #   Vedeu.log(message: 'A useful debugging message: Error!')
       #
       # @return [TrueClass]
-      def log(message, force = false)
-        colour = [:red, :green, :yellow, :blue, :magenta, :cyan, :white].sample
-
-        logger.debug(Esc.send(colour) { message }) if enabled? || force
+      def log(message:, force: false, type: :info)
+        logger.debug([message_type(type), message]) if enabled? || force
       end
 
       # @return [TrueClass]
@@ -52,6 +53,27 @@ module Vedeu
         Vedeu::Configuration.log
       end
 
+      # @return [String]
+      def message_type(type)
+        Esc.send(message_types.fetch(type, :default)) { "[#{type}]".ljust(9) }
+      end
+
+      # @return [Hash]
+      def message_types
+        {
+          create: :green,
+          debug:  :red,
+          drb:    :blue,
+          event:  :magenta,
+          info:   :default,
+          input:  :yellow,
+          output: :green,
+          store:  :cyan,
+          test:   :white,
+          update: :cyan,
+        }
+      end
+
       # Returns a formatted (red, underlined) UTC timestamp,
       # eg. 2014-10-24T12:34:56Z
       #

data/lib/vedeu/support/node.rb

@@ -1,5 +1,7 @@
 module Vedeu
 
+  # A composition class.
+  #
   class Node
 
     attr_accessor :name,
@@ -7,11 +9,13 @@ module Vedeu
 
     attr_reader   :children
 
+    # @return [void]
     def initialize(name)
       @name     = name
       @children = []
     end
 
+    # @return [void]
     def add_child(node)
       children << node
 
@@ -19,14 +23,17 @@ module Vedeu
     end
     alias :<< :add_child
 
+    # @return [void]
     def remove_child(node)
       children.delete(node)
     end
 
+    # @return [void]
     def [](index)
       children[index]
     end
 
+    # @return [void]
     def []=(index, node)
       replaced_child        = @children[index]
       children[index]       = node
@@ -34,28 +41,11 @@ module Vedeu
       node.parent           = self
     end
 
+    # @return [void]
     def leaf?
       children.empty?
     end
 
   end # Node
 
-  class Task < Node
-
-    def initialize(name, time_required = nil)
-      super(name)
-      @time_required = time_required
-    end
-    def time_required
-      if leaf?
-        @time_required
-      else
-        time = 0.0
-        children.each { |child_task| time += child_task.time_required }
-        time
-      end
-    end
-
-  end # Task
-
 end # Vedeu