vedeu 0.1.17 → 0.1.18

data/lib/vedeu/models/stream.rb

@@ -35,10 +35,14 @@ module Vedeu
 
     private
 
+    # @api private
+    # @return [String]
     def data
       width? ? aligned : text
     end
 
+    # @api private
+    # @return [String]
     def aligned
       case align
       when :right  then text.rjust(width,  ' ')
@@ -47,10 +51,14 @@ module Vedeu
       end
     end
 
+    # @api private
+    # @return [TrueClass|FalseClass]
     def width?
       !!width
     end
 
+    # @api private
+    # @return [Hash]
     def defaults
       {
         colour: {},
@@ -61,6 +69,8 @@ module Vedeu
       }
     end
 
+    # @api private
+    # @return []
     def method_missing(method, *args, &block)
       @self_before_instance_eval.send(method, *args, &block)
     end

data/lib/vedeu/models/style.rb

@@ -16,6 +16,8 @@ module Vedeu
 
     private
 
+    # @api private
+    # @return [String]
     def escape_sequences
       @_sequences ||= if values.nil? || values.empty?
         ''

data/lib/vedeu/support/buffer.rb

@@ -3,7 +3,11 @@ module Vedeu
 
     attr_reader :back, :front, :interface
 
-    # @param attributes [Hash]
+    # @param [Hash] attributes The buffer attributes.
+    # @option attributes :back [Hash] The next view to be rendered.
+    # @option attributes :front [Hash] The view which is currently on screen.
+    # @option attributes :interface [Hash] An attribute form of the interface from
+    #   which we can create a new front or back.
     # @return [Buffer]
     def initialize(attributes = {})
       @attributes = attributes
@@ -42,14 +46,21 @@ module Vedeu
 
     private
 
+    # @api private
+    # @param new_attributes [Hash]
+    # @return [Buffer]
     def merge(new_attributes)
       Buffer.new(@attributes.merge(new_attributes))
     end
 
+    # @api private
+    # @return [TrueClass|FalseClass]
     def content_available?
       !!(back)
     end
 
+    # @api private
+    # @return [TrueClass|FalseClass]
     def no_content_available?
       front.nil?
     end

data/lib/vedeu/support/buffers.rb

@@ -72,22 +72,32 @@ module Vedeu
 
     private
 
+    # @api private
+    # @return []
     def update(name, buffer)
       buffers.store(name, buffer)
     end
 
+    # @api private
+    # @return [Focus]
     def focus
       @_focus ||= Focus.new
     end
 
+    # @api private
+    # @return [Groups]
     def groups
       @_groups ||= Groups.new
     end
 
+    # @api private
+    # @return [Hash]
     def buffers
       @_buffers ||= {}
     end
 
+    # @api private
+    # @return [Hash]
     def storage
       @_storage ||= {}
     end

data/lib/vedeu/support/clear.rb

@@ -24,10 +24,14 @@ module Vedeu
 
     attr_reader :interface
 
+    # @api private
+    # @return [String]
     def colours
       interface.colour.to_s
     end
 
+    # @api private
+    # @return [Enumerator]
     def rows
       interface.viewport_height.times
     end

data/lib/vedeu/support/esc.rb

@@ -3,10 +3,14 @@ module Vedeu
 
     extend self
 
-    # @param y [Fixnum]
-    # @param x [Fixnum]
+    # 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]
+    # @return      [String]
     def set_position(y = 1, x = 1, &block)
       Position.new(y, x).to_s(&block)
     end
@@ -22,16 +26,30 @@ module Vedeu
       when 'bold_off'      then "\e[22m"
       when 'clear'         then "\e[38;2;39m\e[48;2;49m\e[2J"
       when 'clear_line'    then "\e[38;2;39m\e[48;2;49m\e[2K"
-      when 'colour_reset'  then "\e[38;2;39m\e[48;2;49m"
+      when 'colour_reset'  then
+        [ string('fg_reset'),
+          string('bg_reset') ].join
+
+      when 'dim'           then "\e[2m"
       when 'fg_reset'      then "\e[38;2;39m"
       when 'hide_cursor'   then "\e[?25l"
-      when 'screen_init'   then "\e[0m\e[38;2;39m\e[48;2;49m\e[2J\e[?25l"
-      when 'screen_exit'   then "\e[?25h\e[38;2;39m\e[48;2;49m\e[0m"
       when 'negative'      then "\e[7m"
+      when 'normal'        then
+        [ string('underline_off'),
+          string('bold_off'),
+          string('positive') ].join
+
       when 'positive'      then "\e[27m"
       when 'reset'         then "\e[0m"
-      when 'normal'        then "\e[24m\e[22m\e[27m"
-      when 'dim'           then "\e[2m"
+      when 'screen_init'   then
+        [ string('reset'),
+          string('clear'),
+          string('hide_cursor') ].join
+
+      when 'screen_exit'   then
+        [ string('show_cursor'),
+          string('colour_reset'),
+          string('reset') ].join
       when 'show_cursor'   then "\e[?25h"
       when 'underline'     then "\e[4m"
       when 'underline_off' then "\e[24m"

data/lib/vedeu/support/event.rb

@@ -27,6 +27,8 @@ module Vedeu
     attr_reader   :closure
     attr_accessor :deadline, :executed_at, :now
 
+    # @api private
+    # @return []
     def execute(*args)
       reset_deadline
 
@@ -37,12 +39,16 @@ module Vedeu
       closure.call(*args)
     end
 
+    # @api private
+    # @return [TrueClass|FalseClass]
     def throttling?
       set_time
 
       options[:delay] > 0
     end
 
+    # @api private
+    # @return [TrueClass|FalseClass]
     def debouncing?
       set_time
 
@@ -51,48 +57,70 @@ module Vedeu
       options[:debounce] > 0
     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 [TrueClass|FalseClass]
     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
 
       nil
     end
 
+    # @api private
+    # @return [Fixnum|Float]
     def debounce
       options[:debounce]
     end
 
+    # @api private
+    # @return [Fixnum|Float]
     def delay
       options[:delay]
     end
 
+    # @api private
+    # @return [Hash]
     def options
       defaults.merge!(@options)
     end
 
+    # @api private
+    # @return [Hash]
     def defaults
       {
         delay:    0,

data/lib/vedeu/support/events.rb

@@ -56,6 +56,8 @@ module Vedeu
 
     attr_reader :handlers
 
+    # @api private
+    # @return []
     def method_missing(method, *args, &block)
       @self_before_instance_eval.send(method, *args, &block)
     end

data/lib/vedeu/support/focus.rb

@@ -3,6 +3,7 @@ module Vedeu
   # Maintains which interface is current in focus.
   class Focus
 
+    # @return [Focus]
     def initialize
       register_events
 
@@ -10,7 +11,7 @@ module Vedeu
     end
 
     # @param name [String]
-    # @return []
+    # @return [Array]
     def add(name)
       if registered?(name)
         storage
@@ -22,7 +23,7 @@ module Vedeu
     end
 
     # @param name [String]
-    # @return []
+    # @return [String]
     def by_name(name)
       fail InterfaceNotFound unless storage.include?(name)
 
@@ -31,42 +32,49 @@ module Vedeu
       current
     end
 
-    # @return []
+    # @return [String]
     def current
       fail NoInterfacesDefined if storage.empty?
 
       storage.first
     end
 
-    # @return []
+    # @return [String]
     def next_item
       storage.rotate!
 
       current
     end
 
-    # @return []
+    # @return [String]
     def prev_item
       storage.rotate!(-1)
 
       current
     end
 
-    # @return []
+    # @return [TrueClass]
     def register_events
       Vedeu.event(:_focus_next_)    { next_item }
       Vedeu.event(:_focus_prev_)    { prev_item }
       Vedeu.event(:_focus_by_name_) { |name| by_name(name) }
+      Vedeu.event(:_focussed_)      { current }
+
+      true
     end
 
     private
 
+    # @api private
+    # @return [TrueClass|FalseClass]
     def registered?(name)
       return false if storage.empty?
 
       storage.include?(name)
     end
 
+    # @api private
+    # @return [Array]
     def storage
       @storage ||= []
     end

data/lib/vedeu/support/grid.rb

@@ -42,14 +42,20 @@ module Vedeu
 
     attr_reader :value
 
+    # @api private
+    # @return [Fixnum]
     def column
       actual / 12
     end
 
+    # @api private
+    # @return [Fixnum]
     def actual
       Terminal.width
     end
 
+    # @api private
+    # @return [TrueClass|FalseClass]
     def out_of_range?
       value < 1 || value > 12
     end

data/lib/vedeu/support/groups.rb

@@ -26,9 +26,7 @@ module Vedeu
 
       storage[group] << name
 
-      Vedeu.event("_refresh_group_#{group}_".to_sym, { delay: delay }) do
-        Buffers.refresh_group(group)
-      end
+      register_group_refresh_event(group, delay)
 
       self
     end
@@ -40,10 +38,22 @@ module Vedeu
 
     private
 
+    # @api private
+    # @return []
+    def register_group_refresh_event(group, delay = 0.0)
+      Vedeu.event("_refresh_group_#{group}_".to_sym, { delay: delay }) do
+        Buffers.refresh_group(group)
+      end
+    end
+
+    # @api private
+    # @return [Hash]
     def storage
       @_storage ||= in_memory
     end
 
+    # @api private
+    # @return [Hash]
     def in_memory
       Hash.new { |hash, key| hash[key] = Set.new }
     end

data/lib/vedeu/support/input.rb

@@ -1,12 +1,12 @@
 module Vedeu
   class Input
 
-    # @return []
+    # @return [String|Symbol]
     def self.capture
       new.capture
     end
 
-    # @return []
+    # @return [Input]
     def initialize; end
 
     # @return []
@@ -16,10 +16,14 @@ module Vedeu
 
     private
 
+    # @api private
+    # @return [String]
     def input
       @_input ||= Terminal.input
     end
 
+    # @api private
+    # @return [String|Symbol]
     def keypress
       key        = input
       translated = case key
@@ -35,6 +39,7 @@ module Vedeu
       when "\e[H"    then :home
       when "\e[3~"   then :delete
       when "\e[F"    then :end
+      when "\e[Z"    then :shift_tab
       when "\eOP"    then :f1
       when "\eOQ"    then :f2
       when "\eOR"    then :f3