vedeu 0.2.3 → 0.2.4

data/lib/vedeu/repositories/interfaces.rb

@@ -37,15 +37,24 @@ module Vedeu
     # This will delete the interfaces themselves, and the client application
     # will need to either redefine interfaces before using them, or restart.
     #
+    # Note: It also resets repositories which depend on interfaces being
+    # registered.
+    #
     # @return [Hash]
     def reset
       @_storage = in_memory
+
+      Vedeu::Buffers.reset
+      Vedeu::Cursors.reset
+      Vedeu::Focus.reset
+      Vedeu::Groups.reset
+
+      @_storage
     end
 
     private
 
     # @see Vedeu::Refresh.register_event
-    # @api private
     # @param attributes [Hash]
     # @return [Boolean]
     def register_event(attributes)
@@ -55,13 +64,11 @@ module Vedeu
       Vedeu::Refresh.register_event(:by_name, name, delay)
     end
 
-    # @api private
     # @return [Hash]
     def in_memory
       {}
     end
 
-    # @api private
     # @param name [String]
     # @raise [InterfaceNotFound] When the entity cannot be found with this name.
     # @return [InterfaceNotFound]

data/lib/vedeu/repositories/keymaps.rb

@@ -150,7 +150,6 @@ module Vedeu
 
     # Registers the key.
     #
-    # @api private
     # @param attributes [Hash]
     # @param interface [String]
     # @return []
@@ -166,7 +165,6 @@ module Vedeu
 
     # Determine which interface to store the key with.
     #
-    # @api private
     # @param interface [String]
     # @return [String]
     def namespace(interface = '')
@@ -180,7 +178,6 @@ module Vedeu
       proc { :noop }
     end
 
-    # @api private
     # @return [Array]
     def in_memory
       { '_global_keymap_' => {} }

data/lib/vedeu/repositories/menus.rb

@@ -61,13 +61,11 @@ module Vedeu
     # Returns an empty collection ready for the storing of menus by name with
     # associated menu instance.
     #
-    # @api private
     # @return [Hash]
     def in_memory
       {}
     end
 
-    # @api private
     # @param name [String]
     # @raise [MenuNotFound] When the entity cannot be found with this name.
     # @return [MenuNotFound]

data/lib/vedeu/repositories/offsets.rb

@@ -0,0 +1,47 @@
+module Vedeu
+
+  # Repository for storing and retrieving content offsets; i.e. scroll
+  # position for a named interface.
+  #
+  # @api private
+  module Offsets
+
+    include Common
+    include Repository
+    extend self
+
+    # Add or update the offset coordinates for interface content.
+    #
+    # @param attributes [Hash]
+    # @return [Offset]
+    def add(attributes)
+      validate_attributes!(attributes)
+
+      Vedeu.log("#{action(__callee__)} offset: '#{attributes[:name]}'")
+
+      storage.store(attributes[:name], Offset.new(attributes))
+    end
+    alias_method :update, :add
+
+    # @param y [Fixnum]
+    # @param x [Fixnum]
+    # @return [Offset]
+    def move(y, x)
+      find_or_create(Focus.current).move(y, x)
+    end
+
+    private
+
+    # @return [Class]
+    def entity
+      Offset
+    end
+
+    # @return [Hash]
+    def in_memory
+      {}
+    end
+
+  end # Offsets
+
+end # Vedeu

data/lib/vedeu/{models/attributes → support}/colour_translator.rb

@@ -63,19 +63,16 @@ module Vedeu
 
     attr_reader :colour
 
-    # @api private
     # @return [Boolean]
     def no_colour?
       colour.nil? || colour.to_s.empty?
     end
 
-    # @api private
     # @return [Boolean]
     def named?
       colour.is_a?(Symbol) && valid_name?
     end
 
-    # @api private
     # @raise [NotImplemented] Subclasses of this class must implement this
     #   method.
     # @return [Exception]
@@ -83,19 +80,16 @@ module Vedeu
       fail NotImplemented, 'Subclasses implement this.'
     end
 
-    # @api private
     # @return [Boolean]
     def valid_name?
       codes.keys.include?(colour)
     end
 
-    # @api private
     # @return [Boolean]
     def numbered?
       colour.is_a?(Fixnum) && valid_range?
     end
 
-    # @api private
     # @raise [NotImplemented] Subclasses of this class must implement this
     #   method.
     # @return [NotImplemented]
@@ -103,19 +97,16 @@ module Vedeu
       fail NotImplemented, 'Subclasses implement this.'
     end
 
-    # @api private
     # @return [Boolean]
     def valid_range?
       colour >= 0 && colour <= 255
     end
 
-    # @api private
     # @return [Boolean]
     def rgb?
       colour.is_a?(String) && valid_rgb?
     end
 
-    # @api private
     # @raise [NotImplemented] Subclasses of this class must implement this
     #   method.
     # @return [NotImplemented]
@@ -123,13 +114,11 @@ module Vedeu
       fail NotImplemented, 'Subclasses implement this.'
     end
 
-    # @api private
     # @return [Boolean]
     def valid_rgb?
       !!(colour =~ /^#([A-Fa-f0-9]{6})$/)
     end
 
-    # @api private
     # @return [Array]
     def css_to_rgb
       [
@@ -139,7 +128,6 @@ module Vedeu
       ]
     end
 
-    # @api private
     # @return [Fixnum]
     def css_to_numbered
       if rgb?
@@ -151,25 +139,21 @@ module Vedeu
       end
     end
 
-    # @api private
     # @return [Fixnum]
     def red
       (css_to_rgb[0] / 51) * 36
     end
 
-    # @api private
     # @return [Fixnum]
     def green
       (css_to_rgb[1] / 51) * 6
     end
 
-    # @api private
     # @return [Fixnum]
     def blue
       (css_to_rgb[2] / 51) * 1
     end
 
-    # @api private
     # @return [Hash]
     def codes
       {

data/lib/vedeu/support/esc.rb

@@ -65,7 +65,6 @@ module Vedeu
 
     private
 
-    # @api private
     # @return [Hash]
     def sequences
       {
@@ -93,37 +92,31 @@ module Vedeu
       }
     end
 
-    # @api private
     # @return [String]
     def bg_reset
       "\e[48;2;49m"
     end
 
-    # @api private
     # @return [String]
     def blink
       "\e[5m"
     end
 
-    # @api private
     # @return [String]
     def blink_off
       "\e[25m"
     end
 
-    # @api private
     # @return [String]
     def bold
       "\e[1m"
     end
 
-    # @api private
     # @return [String]
     def bold_off
       "\e[22m"
     end
 
-    # @api private
     # @return [String]
     def clear
       [ string('fg_reset'),
@@ -131,7 +124,6 @@ module Vedeu
         "\e[2J" ].join
     end
 
-    # @api private
     # @return [String]
     def clear_line
       [ string('fg_reset'),
@@ -139,45 +131,38 @@ module Vedeu
         "\e[2K" ].join
     end
 
-    # @api private
     # @return [String]
     def clear_last_line
       [ set_position((Terminal.height - 1), 1),
         string('clear_line') ].join
     end
 
-    # @api private
     # @return [String]
     def colour_reset
       [ string('fg_reset'),
         string('bg_reset') ].join
     end
 
-    # @api private
     # @return [String]
     def dim
       "\e[2m"
     end
 
-    # @api private
     # @return [String]
     def fg_reset
       "\e[38;2;39m"
     end
 
-    # @api private
     # @return [String]
     def hide_cursor
       "\e[?25l"
     end
 
-    # @api private
     # @return [String]
     def negative
       "\e[7m"
     end
 
-    # @api private
     # @return [String]
     def normal
       [ string('underline_off'),
@@ -185,19 +170,16 @@ module Vedeu
         string('positive') ].join
     end
 
-    # @api private
     # @return [String]
     def positive
       "\e[27m"
     end
 
-    # @api private
     # @return [String]
     def reset
       "\e[0m"
     end
 
-    # @api private
     # @return [String]
     def screen_init
       [ string('reset'),
@@ -205,7 +187,6 @@ module Vedeu
         string('hide_cursor') ].join
     end
 
-    # @api private
     # @return [String]
     def screen_exit
       [ string('show_cursor'),
@@ -213,19 +194,16 @@ module Vedeu
         string('reset') ].join
     end
 
-    # @api private
     # @return [String]
     def show_cursor
       "\e[?25h"
     end
 
-    # @api private
     # @return [String]
     def underline
       "\e[4m"
     end
 
-    # @api private
     # @return [String]
     def underline_off
       "\e[24m"

data/lib/vedeu/support/event.rb

@@ -37,7 +37,7 @@ module Vedeu
 
     # Execute the code stored in the event closure.
     #
-    # @api private
+    # @param args []
     # @return []
     def execute(*args)
       reset_deadline
@@ -53,7 +53,6 @@ module Vedeu
     # event. Setting the delay option to any value greater than 0 will enable
     # throttling.
     #
-    # @api private
     # @return [Boolean]
     def throttling?
       set_time
@@ -63,7 +62,6 @@ module Vedeu
 
     # Returns a boolean indicating whether the throttle has expired.
     #
-    # @api private
     # @return [Boolean]
     def throttle_expired?
       if elapsed_time > delay
@@ -81,7 +79,6 @@ module Vedeu
     # event. Setting the debounce option to any value greater than 0 will
     # enable debouncing.
     #
-    # @api private
     # @return [Boolean]
     def debouncing?
       set_time
@@ -93,7 +90,6 @@ module Vedeu
 
     # Returns a boolean indicating whether the debounce has expired.
     #
-    # @api private
     # @return [Boolean]
     def debounce_expired?
       if set_executed > deadline
@@ -107,43 +103,36 @@ module Vedeu
       end
     end
 
-    # @api private
     # @return [Float]
     def elapsed_time
       now - @executed_at
     end
 
-    # @api private
     # @return [Float]
     def set_executed
       @executed_at = now
     end
 
-    # @api private
     # @return [Float]
     def set_time
       @now = Time.now.to_f
     end
 
-    # @api private
     # @return [Fixnum]
     def reset_time
       @now = 0
     end
 
-    # @api private
     # @return [Boolean]
     def has_deadline?
       @deadline > 0
     end
 
-    # @api private
     # @return [Fixnum]
     def reset_deadline
       @deadline = 0
     end
 
-    # @api private
     # @return [NilClass]
     def set_deadline
       @deadline = now + debounce
@@ -151,31 +140,26 @@ module Vedeu
       nil
     end
 
-    # @api private
     # @return [String]
     def event_name
       options[:event_name].to_s
     end
 
-    # @api private
     # @return [Fixnum|Float]
     def debounce
       options[:debounce] || defaults[:debounce]
     end
 
-    # @api private
     # @return [Fixnum|Float]
     def delay
       options[:delay] || defaults[:delay]
     end
 
-    # @api private
     # @return [Hash]
     def options
       defaults.merge!(@options)
     end
 
-    # @api private
     # @return [Hash]
     def defaults
       {

data/lib/vedeu/support/exceptions.rb

@@ -3,9 +3,6 @@ module Vedeu
   # Raised when Vedeu attempts to access a named buffer that does not exist.
   BufferNotFound = Class.new(StandardError)
 
-  # Raised when a cursor cannot be found by name.
-  CursorNotFound = Class.new(StandardError)
-
   # Raised when trying to access a group of interfaces which do not exist by
   # this name.
   GroupNotFound = Class.new(StandardError)

data/lib/vedeu/support/grid.rb

@@ -55,19 +55,16 @@ module Vedeu
 
     # Returns the width of a single column in characters.
     #
-    # @api private
     # @return [Fixnum]
     def column
       actual / 12
     end
 
-    # @api private
     # @return [Fixnum]
     def actual
       Terminal.width
     end
 
-    # @api private
     # @return [Boolean]
     def out_of_range?
       value < 1 || value > 12

data/lib/vedeu/support/log.rb

@@ -2,9 +2,10 @@ require 'fileutils'
 require 'time'
 
 module Vedeu
-  # :nocov:
+
   # @api private
   class MonoLogger < Logger
+
     # Create a trappable Logger instance.
     #
     # @param logdev [String|IO] The filename (String) or IO object (typically
@@ -83,6 +84,7 @@ module Vedeu
         )
       end
     end
+
   end
 
   # Provides the ability to Log anything to the Vedeu log file which is
@@ -97,28 +99,26 @@ module Vedeu
         log.formatter = proc do |_, time, _, message|
           utc_time = time.utc.iso8601
 
-          if @last_seen == utc_time
-            message + "\n"
-
-          else
-            @last_seen = utc_time
-
-            "\n\e[4m\e[31m" + utc_time + "\e[39m\e[24m\n" + message + "\n"
-
-          end
+          [timestamp(utc_time), message, "\n"].join
         end
       end
     end
 
     private
 
-    # @api private
+    def self.timestamp(utc_time)
+      return "" if @last_seen == utc_time
+
+      @last_seen = utc_time
+
+      "\n\e[4m\e[31m" + utc_time + "\e[39m\e[24m\n"
+    end
+
     # @return [String]
     def self.filename
       @_filename ||= directory + '/vedeu.log'
     end
 
-    # @api private
     # @return [String]
     def self.directory
       FileUtils.mkdir_p(path) unless File.directory?(path)
@@ -126,12 +126,11 @@ module Vedeu
       path
     end
 
-    # @api private
     # @return [String]
     def self.path
       Dir.home + '/.vedeu'
     end
 
   end # Log
-  # :nocov:
+
 end # Vedeu

data/lib/vedeu/support/move.rb

@@ -0,0 +1,50 @@
+module Vedeu
+
+  # Facade to access Offsets when a movement action occurs.
+  #
+  module Move
+
+    extend self
+
+    # @return [Array]
+    def down
+      move(1, 0)
+    end
+
+    # @return [Array]
+    def up
+      move(-1, 0)
+    end
+
+    # @return [Array]
+    def right
+      move(0, 1)
+    end
+
+    # @return [Array]
+    def left
+      move(0, -1)
+    end
+
+    private
+
+    # @param y [Fixnum]
+    # @param x [Fixnum]
+    # @return [Array]
+    def move(y, x)
+      Offsets.move(y, x)
+
+      Focus.refresh
+    end
+
+    # System events which when called will move in the direction specified;
+    # these will update the cursor position or content offset (scrolling)
+    # according to the interface in focus.
+    Vedeu.event(:_cursor_up_)      { up      }
+    Vedeu.event(:_cursor_right_)   { right   }
+    Vedeu.event(:_cursor_down_)    { down    }
+    Vedeu.event(:_cursor_left_)    { left    }
+
+  end # Move
+
+end # Vedeu

data/lib/vedeu/support/position.rb

@@ -1,17 +1,18 @@
 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
+  class Position < Array
 
     # Initializes a new instance of Position.
     #
     # @param y [Fixnum]
     # @param x [Fixnum]
     # @return [Position]
-    def initialize(y = 1, x = 1)
-      @y, @x = y, x
+    def initialize(y = 0, x = 0)
+      super([y, x])
     end
 
     # Returns an escape sequence to position the cursor. When passed a block,
@@ -31,22 +32,29 @@ module Vedeu
 
     private
 
-    # @api 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.
+    #
     # @return [String]
     def sequence
-      ["\e[", y, ';', x, 'H'].join
+      ["\e[", (y == 0 ? 1 : y), ';', (x == 0 ? 1 : x), 'H'].join
     end
 
-    # @api private
+    # Returns the y coordinate. Can be 0 as this class may also be used as an
+    # Offset.
+    #
     # @return [Fixnum]
     def y
-      (@y == 0 || @y == nil) ? 1 : @y
+      (first == nil) ? 0 : first
     end
 
-    # @api private
+    # Returns the x coordinate. Can be 0 as this class may also be used as an
+    # Offset.
+    #
     # @return [Fixnum]
     def x
-      (@x == 0 || @x == nil) ? 1 : @x
+      (last == nil) ? 0 : last
     end
 
   end # Position