vedeu 0.2.12 → 0.3.0

data/lib/vedeu/support/log.rb

@@ -1,3 +1,5 @@
+require 'vedeu/configuration/configuration'
+
 module Vedeu
 
   # Provides the ability to log anything to the Vedeu log file.
@@ -7,17 +9,49 @@ module Vedeu
 
     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.
+      #
+      # @example
+      #   Vedeu.log('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
+      end
+
       # @return [TrueClass]
       def logger
-        Logger.new(Configuration.log).tap do |log|
+        Logger.new(log_file).tap do |log|
           log.formatter = proc do |_, time, _, message|
-            [timestamp(time.utc.iso8601), message, "\n"].join
+            formatted_message(message, time)
           end
         end
       end
 
       private
 
+      # @return [String]
+      def formatted_message(message, time = Time.now)
+        [timestamp(time.utc.iso8601), message, "\n"].join
+      end
+
+      # @return [Boolean]
+      def enabled?
+        Vedeu::Configuration.debug?
+      end
+
+      # @return [String]
+      def log_file
+        Vedeu::Configuration.log
+      end
+
       # Returns a formatted (red, underlined) UTC timestamp,
       # eg. 2014-10-24T12:34:56Z
       #

data/lib/vedeu/support/node.rb

@@ -0,0 +1,61 @@
+module Vedeu
+
+  class Node
+
+    attr_accessor :name,
+      :parent
+
+    attr_reader   :children
+
+    def initialize(name)
+      @name     = name
+      @children = []
+    end
+
+    def add_child(node)
+      children << node
+
+      node.parent = self
+    end
+    alias :<< :add_child
+
+    def remove_child(node)
+      children.delete(node)
+    end
+
+    def [](index)
+      children[index]
+    end
+
+    def []=(index, node)
+      replaced_child        = @children[index]
+      children[index]       = node
+      replaced_child.parent = nil
+      node.parent           = self
+    end
+
+    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

data/lib/vedeu/support/position.rb

@@ -1,18 +1,24 @@
 module Vedeu
 
   # Change coordinates into an escape sequence to set the cursor position.
-  # Also used as the basis of an Offset.
   #
   # @api private
-  class Position < Array
+  class Position
+
+    attr_reader  :y,
+      :x
+
+    alias_method :first, :y
+    alias_method :last, :x
 
     # Initializes a new instance of Position.
     #
     # @param y [Fixnum]
     # @param x [Fixnum]
     # @return [Position]
-    def initialize(y = 0, x = 0)
-      super([y, x])
+    def initialize(y = 1, x = 1)
+      @y = y
+      @x = x
     end
 
     # Returns an escape sequence to position the cursor. When passed a block,
@@ -33,28 +39,37 @@ module Vedeu
     private
 
     # Returns the escape sequence to reposition the cursors at the coordinates
-    # specified by x and y. If either of these values are 0, then we use 1,
-    # as ANSI terminals do not have a 0, 0 coordinate.
+    # specified by x and y.
     #
     # @return [String]
     def sequence
-      ["\e[", (y == 0 ? 1 : y), ';', (x == 0 ? 1 : x), 'H'].join
+      ["\e[", y, ';', x, 'H'].join
     end
 
-    # Returns the y coordinate. Can be 0 as this class may also be used as an
-    # Offset.
+    # Returns the y coordinate.
     #
     # @return [Fixnum]
     def y
-      (first == nil) ? 0 : first
+      if @y < 1 || @y.nil?
+        1
+
+      else
+        @y
+
+      end
     end
 
-    # Returns the x coordinate. Can be 0 as this class may also be used as an
-    # Offset.
+    # Returns the x coordinate.
     #
     # @return [Fixnum]
     def x
-      (last == nil) ? 0 : last
+      if @x < 1 || @x.nil?
+        1
+
+      else
+        @x
+
+      end
     end
 
   end # Position

data/lib/vedeu/support/position_validator.rb

@@ -0,0 +1,79 @@
+module Vedeu
+
+  class PositionValidator
+
+    extend Forwardable
+
+    def_delegators Vedeu::Terminal,
+      :tx,
+      :ty,
+      :txn,
+      :tyn
+
+    def_delegators :interface,
+      :border?,
+      :border,
+      :geometry
+
+    def_delegators :border,
+      :left?,
+      :right?,
+      :top?,
+      :bottom?
+
+    def_delegators :geometry,
+      :left,
+      :right,
+      :top,
+      :bottom
+
+    attr_accessor :x, :y
+
+    def self.validate(interface, x, y)
+      new(interface, x, y).validate
+    end
+
+    def initialize(interface, x, y)
+      @interface = interface
+      @x         = x
+      @y         = y
+    end
+
+    def validate
+      terminal_validation
+      interface_validation
+      border_validation
+
+      self
+    end
+
+    private
+
+    attr_reader :interface
+
+    def terminal_validation
+      @x = tx  if x < tx
+      @x = txn if x > txn
+      @y = ty  if y < ty
+      @y = tyn if y > tyn
+    end
+
+    def interface_validation
+      @x = left   if x < left
+      @x = right  if x > right
+      @y = top    if y < top
+      @y = bottom if y > bottom
+    end
+
+    def border_validation
+      if border?
+        @x = left + 1   if left?   && x < (left + 1)
+        @x = right - 2  if right?  && x > (right - 1)
+        @y = top + 1    if top?    && y < (top + 1)
+        @y = bottom - 2 if bottom? && y > (bottom - 1)
+      end
+    end
+
+  end # PositionValidator
+
+end # Vedeu

data/lib/vedeu/support/read.rb

@@ -0,0 +1,65 @@
+module Vedeu
+
+  # The basis of a fake input device.
+  class Read
+
+    # @param console []
+    # @param data [String|NilClass]
+    # @return [String]
+    def self.from(console, data = nil)
+      new(console, data).read
+    end
+
+    # @param console []
+    # @param data [String|NilClass]
+    # @return [Vedeu::Read]
+    def initialize(console, data = nil)
+      @console = console
+      @data    = data
+    end
+
+    # Provides IO.console emulation of #getch.
+    #
+    # @return [String]
+    def getch(string = nil)
+      @data = string[0] unless string.nil?
+
+      read
+    end
+
+    # Provides IO.console emulation of #gets.
+    #
+    # @return [String]
+    def gets(string = nil)
+      @data = string.chomp unless string.nil?
+
+      read
+    end
+
+    # Provides IO.console emulation of #read_nonblock.
+    #
+    # @return [String]
+    def read_nonblock(bytes = 1, string = nil)
+      @data = string unless string.nil?
+
+      read
+    end
+
+    # @return [String]
+    def read
+      if data
+        data
+
+      else
+        ''
+
+      end
+    end
+
+    private
+
+    attr_reader :console, :data
+
+  end # Read
+
+end # Vedeu

data/lib/vedeu/support/refresh.rb

@@ -5,21 +5,20 @@ module Vedeu
   # @api private
   module Refresh
 
-    include Common
     extend self
 
     # Refresh all registered interfaces.
     #
     # @return [Array]
     def all
-      Vedeu::Interfaces.registered.each { |name| by_name(name) }
+      Vedeu.interfaces.registered.each { |name| by_name(name) }
     end
 
     # Refresh the interface which is currently focussed.
     #
-    # @return [|NoInterfacesDefined]
+    # @return [|NilClass]
     def by_focus
-      by_name(Focus.current)
+      by_name(Vedeu.focus) if Vedeu.focus
     end
 
     # Refresh an interface, or collection of interfaces belonging to a group.
@@ -28,7 +27,9 @@ module Vedeu
     # @return [Array|ModelNotFound] A collection of the names of interfaces
     #   refreshed, or an exception if the group was not found.
     def by_group(group_name)
-      Groups.find(group_name).each { |name| by_name(name) }
+      Vedeu.log("Refreshing group: '#{group_name}'")
+
+      Vedeu.groups.find(group_name).members.each { |name| by_name(name) }
     end
 
     # Refresh an interface by name.
@@ -37,34 +38,9 @@ module Vedeu
     #   named buffer.
     # @return [Array|ModelNotFound]
     def by_name(name)
-      interface = Interfaces.find(name)
-      buffer    = Buffers.find(name)
-
-      Compositor.compose(interface, buffer)
-    end
-
-    # Register a refresh event for an interface or group of interfaces by name.
-    # When the event is called, the interface, or all interfaces belonging to
-    # the group with this name will be refreshed.
-    #
-    # @param type [Symbol]
-    # @param name [String]
-    # @param delay [Float]
-    # @return [Boolean]
-    def register_event(type, name, delay = 0.0)
-      event = if type == :by_group
-        "_refresh_group_#{name}_".to_sym
-
-      else
-        "_refresh_#{name}_".to_sym
-
-      end
-
-      return false if Events.registered?(event)
-
-      Events.add(event, { delay: delay }) { Refresh.send(type, name) }
+      Vedeu.log("Refreshing interface: '#{name}'")
 
-      true
+      Vedeu::Compositor.compose(name)
     end
 
   end # Refresh

data/lib/vedeu/support/terminal.rb

@@ -1,3 +1,8 @@
+require 'vedeu/configuration/configuration'
+require 'vedeu/support/common'
+require 'vedeu/support/esc'
+require 'vedeu/support/log'
+
 module Vedeu
 
   # This module is the direct interface between Vedeu and your terminal/
@@ -6,16 +11,17 @@ module Vedeu
   # @api private
   module Terminal
 
+    include Vedeu::Common
     extend self
 
     # Opens a terminal screen in either `raw` or `cooked` mode. On exit,
     # attempts to restore the screen. See {Vedeu::Terminal#restore_screen}.
     #
     # @param block [Proc]
-    # @raise [InvalidSyntax] When the required block is not given.
+    # @raise [InvalidSyntax] The required block was not given.
     # @return [Array]
     def open(&block)
-      fail InvalidSyntax, '`open` requires a block.' unless block_given?
+      fail InvalidSyntax, 'block not given' unless block_given?
 
       if raw_mode?
         Vedeu.log("Terminal entering 'raw' mode")
@@ -58,10 +64,30 @@ module Vedeu
     # @param streams [String|Array]
     # @return [Array]
     def output(*streams)
-      streams.each { |stream| console.print(stream) }
+      streams.each do |stream|
+        # Vedeu.log(Esc.escape(stream))
+
+        console.print(stream)
+
+        # Vedeu::Console.write(stream)
+      end
 
       streams
     end
+    alias_method :write, :output
+
+    # When the terminal emit the 'SIGWINCH' signal, Vedeu can intercept this
+    # and attempt to redraw the current interface with varying degrees of
+    # success. Can also be used to simulate a terminal resize.
+    #
+    # @return [TrueClass]
+    def resize
+      Vedeu.trigger(:_clear_)
+
+      Vedeu.trigger(:_refresh_)
+
+      true
+    end
 
     # @param block [Proc]
     # @return []
@@ -74,7 +100,7 @@ module Vedeu
     # Clears the entire terminal space.
     #
     # @return [String]
-    def clear_screen
+    def clear
       output(Esc.string('clear'))
     end
 
@@ -180,6 +206,8 @@ module Vedeu
     end
     alias_method :x, :origin
     alias_method :y, :origin
+    alias_method :tx, :origin
+    alias_method :ty, :origin
 
     # Returns the total width (number of columns/characters) of the current
     # terminal.
@@ -192,6 +220,7 @@ module Vedeu
       size.last
     end
     alias_method :xn, :width
+    alias_method :txn, :width
 
     # Returns the total height (number of rows/lines) of the current terminal.
     #
@@ -203,6 +232,7 @@ module Vedeu
       size.first
     end
     alias_method :yn, :height
+    alias_method :tyn, :height
 
     # Returns a tuple containing the height and width of the current terminal.
     #

data/lib/vedeu/support/text.rb

@@ -0,0 +1,104 @@
+module Vedeu
+
+  # Present a string (or object responding to `to_s`).
+  #
+  class Text
+
+    # @see Vedeu::DSL::Text#text
+    def self.with(value = '', options = {})
+      new(value, options).aligned
+    end
+
+    # Returns a new instance of Text.
+    #
+    # @param value [String]
+    # @param options [Hash]
+    # @option options width [Integer]
+    # @option options anchor [Symbol] See {Text#anchor}
+    # @option options pad [String]
+    # @return [Text]
+    def initialize(value = '', options = {})
+      @value   = value
+      @options = defaults.merge(options)
+    end
+
+    # Aligns the value.
+    #
+    # @return [String]
+    def aligned
+      return string unless width
+
+      return truncated if truncate?
+
+      case anchor
+      when :align, :left, :text then left
+      when :centre, :center     then centre
+      when :right               then right
+      else
+        left
+      end
+    end
+
+    private
+
+    attr_reader :value, :options
+
+    # @return [Symbol] One of :align, :centre, :center, :left, :right, :text
+    def anchor
+      options[:anchor]
+    end
+
+    # @return [String]
+    def centre
+      string.center(width, pad)
+    end
+
+    # The default values for a new instance of this class.
+    #
+    # @return [Hash]
+    def defaults
+      {
+        anchor: :left,
+        pad:    ' ',
+        width:  nil,
+      }
+    end
+
+    # @return [String]
+    def left
+      string.ljust(width, pad)
+    end
+
+    # @return [String]
+    def pad
+      options[:pad]
+    end
+
+    # @return [String]
+    def right
+      string.rjust(width, pad)
+    end
+
+    # @return [String]
+    def string
+      value.to_s
+    end
+
+    # @return [Boolean]
+    def truncate?
+      string.size > width
+    end
+
+    # @return [String]
+    def truncated
+      string.slice(0, width)
+    end
+
+    # @return [Fixnum]
+    def width
+      options[:width]
+    end
+
+  end # Align
+
+end # Vedeu

data/lib/vedeu/support/trace.rb

@@ -1,3 +1,7 @@
+require 'vedeu/configuration/configuration'
+require 'vedeu/support/esc'
+require 'vedeu/support/log'
+
 module Vedeu
 
   # This class currently provides the means to trace each method call which
@@ -28,7 +32,7 @@ module Vedeu
     #
     # @todo Deprecate, and use TracePoint instead.
     #
-    # @return []
+    # @return [NilClass|String]
     def trace
       set_trace_func proc { |event, _file, _line, id, binding, classname|
         if event == watched && id != :log && classes.include?(classname.to_s)
@@ -52,9 +56,11 @@ module Vedeu
     # Writes the message to the log file.
     #
     # @param message [String]
-    # @return [Boolean]
+    # @return [String]
     def log_this(message)
       Vedeu::Log.logger.debug(message)
+
+      message
     end
 
     # Provides inspection of the local variables set within the method being
@@ -96,6 +102,8 @@ module Vedeu
       defaults.merge(@options)
     end
 
+    # The default values for a new instance of this class.
+    #
     # @return [Hash]
     def defaults
       {
@@ -145,16 +153,7 @@ module Vedeu
     #
     # @return [Set]
     def vedeu_exceptions
-      Set.new [
-        'Vedeu::ModelNotFound',
-        'Vedeu::InvalidSyntax',
-        'Vedeu::KeyInUse',
-        'Vedeu::MissingRequired',
-        'Vedeu::ModeSwitch',
-        'Vedeu::NoInterfacesDefined',
-        'Vedeu::NotImplemented',
-        'Vedeu::OutOfRange',
-      ]
+      Vedeu::Exceptions.to_set
     end
 
     # Returns a set of classes to ignore during tracing.
@@ -167,8 +166,6 @@ module Vedeu
         # 'Vedeu::API',
         # 'Vedeu::Application',
         # 'Vedeu::Background',
-        # 'Vedeu::Buffers',
-        # 'Vedeu::Clear',
         'Vedeu::Coercions',
         'Vedeu::Colour',
         'Vedeu::Translator',
@@ -180,30 +177,21 @@ module Vedeu
         # 'Vedeu::Cursors',
         'Vedeu::Esc',
         'Vedeu::Event',
-        # 'Vedeu::Events',
         # 'Vedeu::Focus',
         # 'Vedeu::Foreground',
         'Vedeu::Geometry',
         # 'Vedeu::Grid',
-        # 'Vedeu::Groups',
         # 'Vedeu::Input',
         # 'Vedeu::Interface',
-        # 'Vedeu::Interfaces',
         # 'Vedeu::Keymap',
-        # 'Vedeu::Keymaps',
-        # 'Vedeu::KeymapValidator',
         # 'Vedeu::Launcher',
         # 'Vedeu::Line',
         'Vedeu::Log',
         # 'Vedeu::Menu',
         # 'Vedeu::Menus',
-        'Vedeu::MonoLogger',
-        # 'Vedeu::Offset',
-        # 'Vedeu::Offsets',
         'Vedeu::Position',
         'Vedeu::Presentation',
         # 'Vedeu::Refresh',
-        # 'Vedeu::Registrar',
         # 'Vedeu::Render',
         'Vedeu::Repository',
         'Vedeu::Stream',