vedeu 0.4.11 → 0.4.12

data/examples/borders_app.rb

@@ -5,11 +5,13 @@ $LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
 
 require 'vedeu'
 
+# An example application to demonstrate borders.
+#
 class VedeuBordersApp
   include Vedeu
 
   configure do
-    colour_mode 16777216
+    colour_mode 16_777_216
     debug!
     log '/tmp/vedeu_borders_app.log'
   end

data/examples/colours_app.rb

@@ -5,11 +5,13 @@ $LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
 
 require 'vedeu'
 
+# An example application to demonstrate colours.
+#
 class VedeuColoursApp
   include Vedeu
 
   configure do
-    colour_mode 16777216
+    colour_mode 16_777_216
     debug!
     log '/tmp/vedeu_colours_app.log'
   end

data/examples/configuration_app.rb

@@ -19,7 +19,7 @@ class VedeuConfigurationApp
   include Vedeu
 
   configure do
-    colour_mode 16777216
+    colour_mode 16_777_216
     debug!
     log '/tmp/vedeu_configuration_app.log'
   end

data/examples/cursor_app.rb

@@ -5,11 +5,14 @@ $LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
 
 require 'vedeu'
 
+# An example application to demonstrate cursors; their movement and effect on
+# the viewport of the interface in focus.
+#
 class VedeuCursorApp
   include Vedeu
 
   configure do
-    colour_mode 16777216
+    colour_mode 16_777_216
     debug!
     log '/tmp/vedeu_cursor_app.log'
   end

data/examples/drb_app.rb

@@ -5,11 +5,13 @@ $LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
 
 require 'vedeu'
 
+# An example application to demonstrate the DRb server.
+#
 class VedeuTestApplication
   # include Vedeu
 
 Vedeu.configure do
-  colour_mode 16777216
+  colour_mode 16_777_216
   log         '/tmp/vedeu_test_helper.log'
   debug!
   drb!

data/examples/focus_app.rb

@@ -17,7 +17,7 @@ class VedeuFocusApp
   include Vedeu
 
   configure do
-    colour_mode 16777216
+    colour_mode 16_777_216
     debug!
     log '/tmp/vedeu_focus_app.log'
   end

data/examples/geometry_app.rb

@@ -5,11 +5,13 @@ $LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
 
 require 'vedeu'
 
+# An example application to demonstrate geometry.
+#
 class VedeuGeometryApp
   include Vedeu
 
   configure do
-    colour_mode 16777216
+    colour_mode 16_777_216
     debug!
     log '/tmp/vedeu_geometry_app.log'
   end

data/examples/hello_world.rb

@@ -8,11 +8,13 @@ trap('INT') { exit! }
 # require 'bundler/setup' # uncomment to remove the need to do `bundle exec`.
 require 'vedeu'
 
+# An example application to demonstrate 'Hello World'.
+#
 class HelloWorldApp
   include Vedeu
 
   configure do
-    colour_mode 16777216
+    colour_mode 16_777_216
     debug!
     log '/tmp/vedeu_hello_world.log'
   end

data/examples/lines_app.rb

@@ -5,11 +5,13 @@ $LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
 
 require 'vedeu'
 
+# An example application to demonstrate interface lines.
+#
 class VedeuLinesApp
   include Vedeu
 
   configure do
-    colour_mode 16777216
+    colour_mode 16_777_216
     debug!
     log '/tmp/vedeu_lines_app.log'
   end

data/examples/typed_commands/typed_commands_app.rb

@@ -9,7 +9,7 @@ class VedeuTypedCommands
   include Vedeu
 
   configure do
-    colour_mode 16777216
+    colour_mode 16_777_216
     debug!
     log '/tmp/vedeu_typed_commands_app.log'
   end

data/examples/view_templates_app/view_templates_app.rb

@@ -5,11 +5,13 @@ $LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
 
 require 'vedeu'
 
+# An example application to demonstrate templates.
+#
 class VedeuViewTemplateApp
   include Vedeu
 
   configure do
-    colour_mode 16777216
+    colour_mode 16_777_216
     debug!
     log '/tmp/vedeu_view_templates_app.log'
   end

data/lib/vedeu/api.rb

@@ -92,14 +92,15 @@ module Vedeu
 
     # @!method bind
     #   @see Vedeu::Event.bind
-    # @!method trigger
-    #   @see Vedeu::Event.trigger
     # @!method unbind
     #   @see Vedeu::Event.unbind
     def_delegators Vedeu::Event, :bind,
-      :trigger,
       :unbind
 
+    # @!method trigger
+    #   @see Vedeu::Trigger.trigger
+    def_delegators Vedeu::Trigger, :trigger
+
     # @!method configure
     #   @see Vedeu::Configuration.configure
     # @!method configuration

data/lib/vedeu/bindings.rb

@@ -195,7 +195,7 @@ module Vedeu
 
     # Will cause the named cursor to refresh, or the cursor of the interface
     # which is currently in focus.
-    Vedeu.bind(:_refresh_cursor_) { |name| Vedeu::Refresh.cursor(name) }
+    Vedeu.bind(:_refresh_cursor_) { |name| Vedeu::RefreshCursor.render(name) }
 
     # Will cause all interfaces in the named group to refresh.
     Vedeu.bind(:_refresh_group_) { |name| Vedeu::Refresh.by_group(name) }

data/lib/vedeu/configuration/api.rb

@@ -398,7 +398,7 @@ module Vedeu
       # @param value [Fixnum]
       # @return [Boolean]
       def valid_colour_mode?(value)
-        value.is_a?(Fixnum) && [8, 16, 256, 16777216].include?(value)
+        value.is_a?(Fixnum) && [8, 16, 256, 16_777_216].include?(value)
       end
 
       # Checks that the value provided to {#exit_key}, {#focus_next_key},

data/lib/vedeu/configuration/cli.rb

@@ -75,7 +75,7 @@ module Vedeu
           opts.on('-C', '--colour-mode [COLOURS]', Integer,
                   'Run application in either `8`, `16`, `256` or `16777216` ' \
                   'colour mode.') do |colours|
-            if [8, 16, 256, 16777216].include?(colours)
+            if [8, 16, 256, 16_777_216].include?(colours)
               options[:colour_mode] = colours
 
             else
@@ -93,7 +93,8 @@ module Vedeu
             options[:drb] = true
           end
 
-          opts.on('--drb-host', 'Set the hostname/IP for the DRb server.') do |hostname|
+          opts.on('--drb-host',
+            'Set the hostname/IP for the DRb server.') do |hostname|
             #options[:drb]      = true
             options[:drb_host] = hostname
           end

data/lib/vedeu/configuration/configuration.rb

@@ -282,7 +282,7 @@ module Vedeu
     # @return [Fixnum]
     def detect_colour_mode
       case ENV['TERM']
-      when /-truecolor$/         then 16777216
+      when /-truecolor$/         then 16_777_216
       when /-256color$/, 'xterm' then 256
       when /-color$/, 'rxvt'     then 16
       else 256

data/lib/vedeu/cursor/cursor.rb

@@ -91,7 +91,7 @@ module Vedeu
     # @return [String]
     def to_s(&block)
       if block_given?
-        [ sequence, yield, sequence ].join
+        [sequence, yield, sequence].join
 
       else
         sequence
@@ -124,7 +124,7 @@ module Vedeu
     #
     # @return [String]
     def sequence
-      [ position, visibility ].join
+      [position, visibility].join
     end
 
     # Returns the escape sequence for setting the visibility of the cursor.

data/lib/vedeu/cursor/refresh_cursor.rb

@@ -6,7 +6,7 @@ module Vedeu
   class RefreshCursor
 
     # @param (see #initialize)
-    def self.render(name)
+    def self.render(name = Vedeu.focus)
       new(name).render
     end
 
@@ -20,6 +20,8 @@ module Vedeu
 
     # @return [Array]
     def render
+      Vedeu.log(type: :info, message: "Refreshing cursor: '#{name}'")
+
       Vedeu::Refresh.by_name(name) if refresh_view?
 
       Vedeu::Terminal.output(new_cursor.to_s)

data/lib/vedeu/distributed/templates/default_configuration.vedeu

@@ -1,5 +1,5 @@
 Vedeu.configure do
-  colour_mode 16777216
+  colour_mode 16_777_216
   log         '/tmp/vedeu_test_helper.log'
   debug!
   drb!

data/lib/vedeu/events/event.rb

@@ -102,12 +102,10 @@ module Vedeu
       end
       alias_method :unevent, :unbind
 
-    end
+      extend Forwardable
+
+      def_delegators Vedeu::Trigger, :trigger
 
-    # @param (see Vedeu::Trigger.trigger)
-    # @see Vedeu::Trigger.trigger
-    def self.trigger(name, *args)
-      Vedeu::Trigger.trigger(name, *args)
     end
 
     # Returns a new instance of Vedeu::Event.

data/lib/vedeu/geometry/position.rb

@@ -63,7 +63,7 @@ module Vedeu
     # @return [String]
     def to_s(&block)
       if block_given?
-        [ sequence, yield, sequence ].join
+        [sequence, yield, sequence].join
 
       else
         sequence

data/lib/vedeu/input/all.rb

@@ -10,7 +10,7 @@ module Vedeu
   # Vedeu to run effectively.
   Vedeu::DSL::Keymap.keymap('_system_') do |keymap|
     Vedeu::Configuration.system_keys.each do |label, keypress|
-      keymap.key(keypress) { Vedeu.trigger(("_" + label.to_s + "_").to_sym) }
+      keymap.key(keypress) { Vedeu.trigger(("_#{label}_").to_sym) }
     end
   end
 

data/lib/vedeu/input/key.rb

@@ -4,6 +4,11 @@ module Vedeu
   #
   class Key
 
+    # @!attribute [r] input
+    # @return [String|Symbol] Returns the key defined.
+    attr_reader :input
+    alias_method :key, :input
+
     # Returns a new instance of Vedeu::Key.
     #
     # @param input [String|Symbol]
@@ -17,14 +22,6 @@ module Vedeu
       @output = block
     end
 
-    # Returns the key defined.
-    #
-    # @return [String|Symbol]
-    def input
-      @input
-    end
-    alias_method :key, :input
-
     # Pressing the key will call the procedure.
     #
     # @return [|Symbol]

data/lib/vedeu/models/all.rb

@@ -1,15 +1,12 @@
 require 'vedeu/repositories/all'
 
-require 'vedeu/models/cell'
-require 'vedeu/models/char'
-require 'vedeu/models/stream'
-require 'vedeu/models/line'
-require 'vedeu/models/interface'
-require 'vedeu/models/composition'
+require_relative 'cell'
+require_relative 'char'
+require_relative 'stream'
+require_relative 'line'
+require_relative 'interface'
+require_relative 'composition'
 
-require 'vedeu/models/focus'
-require 'vedeu/models/group'
-require 'vedeu/models/menu'
-
-module Vedeu
-end # Vedeu
+require_relative 'focus'
+require_relative 'group'
+require_relative 'menu'

data/lib/vedeu/models/interface.rb

@@ -172,8 +172,8 @@ module Vedeu
     # @return [Array<Array<Vedeu::Char>>]
     def render
       [
-        clear,
         border.render,
+        clear,
         viewport
       ]
     end

data/lib/vedeu/models/menu.rb

@@ -95,7 +95,7 @@ module Vedeu
     # Returns a new collection of items.
     # Each element of the collection is of the format:
     #
-    #   [ selected, current, item ]
+    #   [selected, current, item]
     #
     # `selected` is a boolean indicating whether the item is selected.
     # `current`  is a boolean indicating whether the item is current.

data/lib/vedeu/output/border.rb

@@ -252,20 +252,20 @@ module Vedeu
     # @param prefix [String]
     # @return [String]
     def top_or_bottom(prefix)
-      predicate   = (prefix + '?').to_sym
-      _left       = (prefix + '_left').to_sym
-      _right      = (prefix + '_right').to_sym
-      _horizontal = (prefix + '_horizontal').to_sym
+      predicate         = (prefix + '?').to_sym
+      prefix_left       = (prefix + '_left').to_sym
+      prefix_right      = (prefix + '_right').to_sym
+      prefix_horizontal = (prefix + '_horizontal').to_sym
 
       return [] unless send(predicate)
 
       out = []
-      out << border(send(_left), _left) if left?
+      out << border(send(prefix_left), prefix_left) if left?
 
       if prefix == 'top' && defined_value?(title)
         title_out = []
         width.times do |ix|
-          title_out << border(horizontal, _horizontal, nil, ix)
+          title_out << border(horizontal, prefix_horizontal, nil, ix)
         end
 
         truncate = title.chomp.slice(0..(width - 5))
@@ -279,12 +279,12 @@ module Vedeu
 
       else
         width.times do |ix|
-          out << border(horizontal, _horizontal, nil, ix)
+          out << border(horizontal, prefix_horizontal, nil, ix)
         end
 
       end
 
-      out << border(send(_right), _right) if right?
+      out << border(send(prefix_right), prefix_right) if right?
       out
     end
 
@@ -309,15 +309,19 @@ module Vedeu
 
     # The default values for a new instance of this class.
     #
+    # @note
+    #   Using the '\uXXXX' variant produces gaps in the border, whilst the
+    #   '\xXX' renders 'nicely'.
+    #
     # @return [Hash]
     def defaults
       {
-        bottom_left:  "\x6D", # └
-        bottom_right: "\x6A", # ┘
+        bottom_left:  "\x6D", # └ # \u2514
+        bottom_right: "\x6A", # ┘ # \u2518
         client:       nil,
         colour:       {},
         enabled:      false,
-        horizontal:   "\x71", # ─
+        horizontal:   "\x71", # ─ # \u2500
         name:         '',
         show_bottom:  true,
         show_left:    true,
@@ -325,9 +329,9 @@ module Vedeu
         show_top:     true,
         style:        [],
         title:        '',
-        top_left:     "\x6C", # ┌
-        top_right:    "\x6B", # ┐
-        vertical:     "\x78", # │
+        top_left:     "\x6C", # ┌ # \u250C
+        top_right:    "\x6B", # ┐ # \u2510
+        vertical:     "\x78", # │ # \u2502
       }
     end
 

data/lib/vedeu/output/clear.rb

@@ -31,12 +31,12 @@ module Vedeu
     #
     # @return [Array<Array<Vedeu::Char>>]
     def clear
-      @clear ||= Array.new(interface.height) do |iy|
-        Array.new(interface.width) do |ix|
+      @clear ||= Array.new(interface.border.height) do |iy|
+        Array.new(interface.border.width) do |ix|
           Vedeu::Char.new({ value:    ' ',
                             colour:   interface.colour,
                             style:    interface.style,
-                            position: Vedeu::IndexPosition[iy, ix, interface.top, interface.left] })
+                            position: position(iy, ix) })
         end
       end
     end
@@ -64,6 +64,13 @@ module Vedeu
     # @return [Interface]
     attr_reader :interface
 
+    # @param iy [Fixnum]
+    # @param ix [Fixnum]
+    # @return [Vedeu::IndexPosition]
+    def position(iy, ix)
+      Vedeu::IndexPosition[iy, ix, interface.border.by, interface.border.bx]
+    end
+
   end # Clear
 
 end # Vedeu

data/lib/vedeu/output/esc.rb

@@ -121,7 +121,7 @@ module Vedeu
     def border(&block)
       return '' unless block_given?
 
-      [ border_on, yield, border_off ].join
+      [border_on, yield, border_off].join
     end
 
     private
@@ -167,18 +167,12 @@ module Vedeu
 
     # @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]
@@ -233,11 +227,7 @@ 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/output/html_char.rb

@@ -37,7 +37,11 @@ module Vedeu
     def td_style
       return '' unless border || defined_value?(value)
 
-      " style='background:#{bg};color:#{fg};border:1px #{bg} solid;#{border_style}'"
+      " style='" \
+      "background:#{bg};" \
+      "color:#{fg};" \
+      "border:1px #{bg} solid;" \
+      "#{border_style}'"
     end
 
     # @return [String]
@@ -55,12 +59,12 @@ module Vedeu
       when :left_vertical     then border_css('left')
       when :right_vertical    then border_css('right')
       when :bottom_horizontal then border_css('bottom')
-      when :top_left          then [border_css('top'), border_css('left')].join
-      when :top_right         then [border_css('top'), border_css('right')].join
-      when :bottom_left       then [border_css('bottom'), border_css('left')].join
-      when :bottom_right      then [border_css('bottom'), border_css('right')].join
-      when :horizontal        then ''
-      when :vertical          then ''
+      when :top_left     then [border_css('top'), border_css('left')].join
+      when :top_right    then [border_css('top'), border_css('right')].join
+      when :bottom_left  then [border_css('bottom'), border_css('left')].join
+      when :bottom_right then [border_css('bottom'), border_css('right')].join
+      when :horizontal   then ''
+      when :vertical     then ''
       else
         # ... should not get here
         ''

data/lib/vedeu/output/null_border.rb

@@ -33,11 +33,21 @@ module Vedeu
       interface.yn
     end
 
+    # @return [Fixnum]
+    def height
+      (by..byn).size
+    end
+
     # @return [Array]
     def render
       []
     end
 
+    # @return [Fixnum]
+    def width
+      (bx..bxn).size
+    end
+
     private
 
     # @!attribute [r] interface

data/lib/vedeu/output/presentation.rb

@@ -7,9 +7,7 @@ module Vedeu
 
     # @return [Vedeu::Background|NilClass]
     def background
-      if colour
-        colour.background
-      end
+      colour.background if colour
     end
 
     # @return [Vedeu::Colour]
@@ -24,16 +22,12 @@ module Vedeu
 
     # @return [Vedeu::Foreground|NilClass]
     def foreground
-      if colour
-        colour.foreground
-      end
+      colour.foreground if colour
     end
 
     # @return [Vedeu::Background|NilClass]
     def parent_background
-      if parent_colour
-        parent_colour.background
-      end
+      parent_colour.background if parent_colour
     end
 
     # @return [String|NilClass]
@@ -43,9 +37,7 @@ module Vedeu
 
     # @return [Vedeu::Foreground|NilClass]
     def parent_foreground
-      if parent_colour
-        parent_colour.foreground
-      end
+      parent_colour.foreground if parent_colour
     end
 
     # @return [String|NilClass]
@@ -91,11 +83,7 @@ module Vedeu
     #
     # @return [String]
     def render_colour
-      [
-        colour,
-        yield,
-        parent_colour
-      ].join
+      [colour, yield, parent_colour].join
     end
 
     # @return [String]
@@ -115,11 +103,7 @@ module Vedeu
     #
     # @return [String]
     def render_style
-      [
-        style,
-        yield,
-        parent_style
-      ].join
+      [style, yield, parent_style].join
     end
 
   end # Presentation