vedeu 0.4.44 → 0.4.45

data/lib/vedeu/bootstrap.rb

@@ -6,12 +6,14 @@ module Vedeu
   # Vedeu with this data, then starts the client application.
   class Bootstrap
 
+    # :nocov:
     # @param argv [Array<String>]
     # @param entry_point [void]
     # @return [void]
     def self.start(argv = ARGV, entry_point = nil)
       new(argv, entry_point).start
     end
+    # :nocov:
 
     # Returns a new instance of Vedeu::Bootstrap.
     #
@@ -23,6 +25,10 @@ module Vedeu
       @entry_point = entry_point
     end
 
+    # Loads all of the client application files so that Vedeu has access to
+    # them, calls the 'entry_point' controller, ready to start the application,
+    # then launches the client application.
+    #
     # @return [void]
     def start
       Vedeu.configure { log('/tmp/vedeu_bootstrap.log') }
@@ -57,6 +63,8 @@ module Vedeu
 
     private
 
+    # Load each of the loadable files.
+    #
     # @param path [String]
     # @return [String]
     def load(path)
@@ -65,6 +73,9 @@ module Vedeu
       path
     end
 
+    # Collect each of the files from the client application directories by path
+    # excluding '.' and '..' and only loading files with the '.rb' extension.
+    #
     # @param path [String]
     # @return [Array<String>]
     def loadables(path)

data/lib/vedeu/buffers/buffer.rb

@@ -217,6 +217,8 @@ module Vedeu
       @clear_buffer ||= Vedeu::Clear.new(view).clear
     end
 
+    # Returns the default options/attributes for this class.
+    #
     # @return [Hash<Symbol => NilClass, String>]
     def defaults
       {

data/lib/vedeu/configuration/api.rb

@@ -281,7 +281,7 @@ module Vedeu
       # other resources). By default the base path is just cwd but this will
       # not work for many applications.
       #
-      # @param value [String]
+      # @param path [String]
       # @return [String]
       def base_path(path = nil)
         options[:base_path] = path
@@ -347,20 +347,6 @@ module Vedeu
         value.is_a?(Fixnum) && [8, 16, 256, 16_777_216].include?(value)
       end
 
-      # Checks that the value provided to {#exit_key}, {#focus_next_key},
-      # {#focus_prev_key} and {#mode_switch_key} is valid. Must be a Symbol or a
-      # non-empty String.
-      #
-      # @param value [String|Symbol]
-      # @return [Boolean]
-      def valid_key?(value)
-        return false unless value.is_a?(String) || value.is_a?(Symbol)
-
-        return false if value.is_a?(String) && value.size != 1
-
-        (value.is_a?(String) || value.is_a?(Symbol)) && present?(value)
-      end
-
     end # API
 
   end # Config

data/lib/vedeu/configuration/configuration.rb

@@ -280,6 +280,7 @@ module Vedeu
       end
     end
 
+    # @return [String]
     def set_base_path
       File.expand_path('.')
     end

data/lib/vedeu/cursor/cursor.rb

@@ -66,6 +66,8 @@ module Vedeu
       @position   = Vedeu::Position.new(@y, @x)
     end
 
+    # Override Ruby's Object#inspect method to provide a more helpful output.
+    #
     # @return [String]
     def inspect
       "<Vedeu::Cursor (#{name}, " \

data/lib/vedeu/geometry/dimension.rb

@@ -143,6 +143,8 @@ module Vedeu
       defaults.merge!(@options)
     end
 
+    # Returns the default options/attributes for this class.
+    #
     # @return [Hash<Symbol => Boolean>]
     def defaults
       {

data/lib/vedeu/geometry/geometry.rb

@@ -92,6 +92,8 @@ module Vedeu
       @attributes.each { |key, value| instance_variable_set("@#{key}", value) }
     end
 
+    # Override Ruby's Object#inspect method to provide a more helpful output.
+    #
     # @return [String]
     def inspect
       '<Vedeu::Geometry '   \
@@ -198,6 +200,8 @@ module Vedeu
       @xn.is_a?(Proc) ? @xn.call : @xn
     end
 
+    # Returns the default options/attributes for this class.
+    #
     # @return [Hash]
     def defaults
       {

data/lib/vedeu/input/keymap.rb

@@ -72,6 +72,8 @@ module Vedeu
 
     private
 
+    # Returns the default options/attributes for this class.
+    #
     # @return [Hash]
     def defaults
       {

data/lib/vedeu/launcher.rb

@@ -13,6 +13,7 @@ module Vedeu
     #   error occurred (1).
     attr_reader :exit_code
 
+    # :nocov:
     # @param (see #initialize)
     def self.execute!(argv = [],
                       stdin  = STDIN,
@@ -21,6 +22,7 @@ module Vedeu
                       kernel = Kernel)
       new(argv, stdin, stdout, stderr, kernel).debug_execute!
     end
+    # :nocov:
 
     # Returns a new instance of Vedeu::Launcher.
     #
@@ -43,6 +45,11 @@ module Vedeu
       @exit_code = 1
     end
 
+    # :nocov:
+    # If debugging is enabled, execute the application within the debugging
+    # context. At the moment, this simple uses 'ruby-prof' to profile the
+    # running application.
+    #
     # @return [void]
     def debug_execute!
       if configuration.debug?
@@ -55,7 +62,12 @@ module Vedeu
 
       terminate!
     end
+    # :nocov:
 
+    # Alters the STD[IN|OUT|ERR] to those requested by the client application,
+    # then starts the application. If an uncaught exception occurs during the
+    # application runtime, we exit ungracefully with the error message if any.
+    #
     # @return [void]
     def execute!
       $stdin  = @stdin
@@ -79,6 +91,7 @@ module Vedeu
 
     private
 
+    # :nocov:
     # Terminates the application after resetting $stdin, $stdout and $stderr.
     #
     # @return [void]
@@ -91,6 +104,7 @@ module Vedeu
 
       @kernel.exit(exit_code)
     end
+    # :nocov:
 
     # Use the arguments passed on the command-line along with those defined by
     # the client application and Vedeu's defaults to configure the client

data/lib/vedeu/main_loop.rb

@@ -38,6 +38,7 @@ module Vedeu
         @loop = false
       end
 
+      # :nocov:
       # Check the application has started and we wish to continue running.
       #
       # @raise [VedeuInterrupt] When we wish to terminate the running
@@ -46,6 +47,7 @@ module Vedeu
       def safe_exit_point!
         fail VedeuInterrupt if @started && !@loop
       end
+      # :nocov:
 
     end
 

data/lib/vedeu/models/cell.rb

@@ -54,6 +54,8 @@ module Vedeu
 
     private
 
+    # Returns the default options/attributes for this class.
+    #
     # @return [Hash<Symbol => void>]
     def defaults
       {

data/lib/vedeu/models/char.rb

@@ -72,6 +72,8 @@ module Vedeu
     end
     alias_method :==, :eql?
 
+    # Override Ruby's Object#inspect method to provide a more helpful output.
+    #
     # @return [String]
     def inspect
       "<Vedeu::Char '#{Vedeu::Esc.escape(to_s)}'>"

data/lib/vedeu/models/escape_char.rb

@@ -33,6 +33,8 @@ module Vedeu
     end
     alias_method :==, :eql?
 
+    # Override Ruby's Object#inspect method to provide a more helpful output.
+    #
     # @return [String]
     def inspect
       "<Vedeu::EscapeChar '#{Vedeu::Esc.escape(to_s)}'>"

data/lib/vedeu/models/group.rb

@@ -65,6 +65,8 @@ module Vedeu
 
     private
 
+    # Returns the default options/attributes for this class.
+    #
     # @return [Hash]
     def defaults
       {

data/lib/vedeu/output/clear.rb

@@ -137,6 +137,8 @@ module Vedeu
                   end
     end
 
+    # Returns the default options/attributes for this class.
+    #
     # @return [Hash<Symbol => Boolean>]
     def defaults
       {

data/lib/vedeu/output/esc.rb

@@ -122,11 +122,9 @@ module Vedeu
     # @param value [String|Symbol]
     # @return [String]
     def string(value = '')
-      name = value.to_sym
+      return '' if value.empty?
 
-      return '' if name.empty?
-
-      send(name)
+      send(value.to_sym)
 
     rescue NoMethodError
       ''
@@ -155,11 +153,6 @@ module Vedeu
       [colour_reset, "\e[2K"].join
     end
 
-    # @return [String]
-    def clear_last_line
-      Vedeu::Position.new((Vedeu::Terminal.height - 1), 1).to_s { clear_line }
-    end
-
     # @return [String]
     def colour_reset
       [fg_reset, bg_reset].join
@@ -177,13 +170,12 @@ module Vedeu
 
     # @return [String]
     def screen_exit
-      [
-        show_cursor,
-        colour_reset,
-        reset,
-        Vedeu::Position.new(Vedeu.height, Vedeu.width).to_s,
-        "\n",
-      ].join
+      [show_cursor, colour_reset, reset, last_character_position, "\n"].join
+    end
+
+    # @return [String]
+    def last_character_position
+      Vedeu::Position.new(Vedeu.height, Vedeu.width).to_s
     end
 
   end # Esc

data/lib/vedeu/output/render_border.rb

@@ -92,17 +92,43 @@ module Vedeu
                       border:   type)
     end
 
+    # @return [Array<Vedeu::Char>]
+    def build_bottom_horizontal
+      horizontal_border(:bottom_horizontal, yn)
+    end
+
+    # @return [Vedeu::Char]
+    def build_bottom_left
+      build(bottom_left, :bottom_left, *[yn, x]) if left?
+    end
+
+    # @return [Vedeu::Char]
+    def build_bottom_right
+      build(bottom_right, :bottom_right, *[yn, xn]) if right?
+    end
+
+    # @return [Array<Vedeu::Char>]
+    def build_top_horizontal
+      horizontal_border(:top_horizontal, y)
+    end
+
+    # @return [Vedeu::Char]
+    def build_top_left
+      build(top_left, :top_left, *[y, x]) if left?
+    end
+
+    # @return [Vedeu::Char]
+    def build_top_right
+      build(top_right, :top_right, *[y, xn]) if right?
+    end
+
     # Renders the bottom border for the interface.
     #
     # @return [String]
     def bottom
       return [] unless bottom?
 
-      out = []
-      out << build(bottom_left, :bottom_left, *[yn, x]) if left?
-      out << horizontal_border(:bottom_horizontal, yn)
-      out << build(bottom_right, :bottom_right, *[yn, xn]) if right?
-      out
+      [build_bottom_left, build_bottom_horizontal, build_bottom_right].compact
     end
 
     # @return [Vedeu::Geometry]
@@ -169,12 +195,22 @@ module Vedeu
       present?(title)
     end
 
+    # Return boolean indicating whether the title fits within the width of the
+    # top border.
+    #
+    # @return [Boolean]
+    def title_fits?
+      width > title_characters.size
+    end
+
     # From the second element of {#title_characters} remove the border from each
     # {#horizontal_border} Vedeu::Char, and add the title character.
     #
     # @return [Array<Vedeu::Char>]
     def titlebar
-      horizontal_border(:top_horizontal, y).each_with_index do |char, index|
+      return build_top_horizontal unless title? && title_fits?
+
+      build_top_horizontal.each_with_index do |char, index|
         if index >= 1 && index <= title_characters.size
           char.border = nil
           char.value  = title_characters[(index - 1)]
@@ -198,19 +234,7 @@ module Vedeu
     def top
       return [] unless top?
 
-      out = []
-      out << build(top_left, :top_left, *[y, x]) if left?
-
-      if title? && width > title_characters.size
-        out << titlebar
-
-      else
-        out << horizontal_border(:top_horizontal, y)
-
-      end
-
-      out << build(top_right, :top_right, *[y, xn]) if right?
-      out
+      [build_top_left, titlebar, build_top_right].compact
     end
 
     # Truncates the title to the width of the interface, minus characters needed

data/lib/vedeu/output/renderers/file.rb

@@ -75,6 +75,8 @@ module Vedeu
         defaults.merge!(@options)
       end
 
+      # Returns the default options/attributes for this class.
+      #
       # @return [Hash]
       def defaults
         {

data/lib/vedeu/output/wordwrap.rb

@@ -150,6 +150,8 @@ module Vedeu
       options.fetch(:width)
     end
 
+    # Returns the default options/attributes for this class.
+    #
     # @return [Hash<Symbol => Fixnum, String, Symbol>]
     def defaults
       {

data/lib/vedeu/repositories/repositories/backgrounds.rb

@@ -5,10 +5,8 @@ module Vedeu
   # @api public
   class Backgrounds < Colours
 
-    # @example
-    #   Vedeu.background_colours
-    #
     # @return [Vedeu::Backgrounds]
+    # @see Vedeu::Repository
     def self.background_colours
       @background_colours ||= new
     end

data/lib/vedeu/repositories/repositories/borders.rb

@@ -8,10 +8,6 @@ module Vedeu
 
     class << self
 
-      # @example
-      #   Vedeu.borders
-      #
-      # @return [Vedeu::Borders]
       alias_method :borders, :repository
 
       # Remove all stored models from the repository.