vedeu 0.4.55 → 0.4.56

data/lib/vedeu/models/focus.rb

@@ -50,11 +50,13 @@ module Vedeu
     #   Vedeu.focus_by_name('name')
     #
     # @param name [String] The interface to focus; must be defined.
-    # @raise [ModelNotFound] When the interface cannot be found.
+    # @raise [Vedeu::ModelNotFound] When the interface cannot be found.
     # @return [String] The name of the interface now in focus.
     def by_name(name)
-      fail ModelNotFound, "Cannot focus '#{name}' as this interface has not " \
-                          'been registered.' unless registered?(name)
+      unless registered?(name)
+        fail Vedeu::ModelNotFound, "Cannot focus '#{name}' as this interface " \
+                                   'has not been registered.'
+      end
 
       storage.rotate!(storage.index(name))
 

data/lib/vedeu/models/groups.rb

@@ -5,7 +5,7 @@ module Vedeu
   # Allows the storing of view groups.
   #
   # @api public
-  class Groups < Repository
+  class Groups < Vedeu::Repository
 
     class << self
 

data/lib/vedeu/models/interface.rb

@@ -156,7 +156,7 @@ module Vedeu
       Vedeu.buffers.by_name(name).show
     end
 
-    # @return [Interface]
+    # @return [Vedeu::Interface]
     def store
       super
 

data/lib/vedeu/models/interfaces.rb

@@ -6,7 +6,7 @@ module Vedeu
   # Allows the storing of interfaces and views.
   #
   # @api public
-  class Interfaces < Repository
+  class Interfaces < Vedeu::Repository
 
     class << self
 

data/lib/vedeu/models/line.rb

@@ -14,7 +14,7 @@ module Vedeu
     member     Vedeu::Stream
 
     # @!attribute [rw] parent
-    # @return [Interface]
+    # @return [Vedeu::Interface]
     attr_accessor :parent
 
     # @!attribute [r] attributes
@@ -35,7 +35,7 @@ module Vedeu
       @attributes.each { |key, value| instance_variable_set("@#{key}", value) }
     end
 
-    # @param child []
+    # @param child [void]
     # @return [void]
     def add(child)
       @_streams = @streams = collection.coerce(streams, self).add(child)

data/lib/vedeu/models/menu.rb

@@ -50,10 +50,10 @@ module Vedeu
     #     # ...
     #   end
     #
-    # @raise [InvalidSyntax] The required block was not given.
+    # @raise [Vedeu::InvalidSyntax] The required block was not given.
     # @return [API::Menu]
     def self.menu(name = '', &block)
-      fail InvalidSyntax, 'block not given' unless block_given?
+      fail Vedeu::InvalidSyntax, 'block not given' unless block_given?
 
       build({ name: name }, &block).store
     end
@@ -65,7 +65,7 @@ module Vedeu
     # @option attributes name [String]
     # @option attributes current [Fixnum]
     # @option attributes selected [Fixnum|NilClass]
-    # @return [Menu]
+    # @return [Vedeu::Menu]
     def initialize(attributes = {})
       @attributes = defaults.merge!(attributes)
 

data/lib/vedeu/models/menus.rb

@@ -5,7 +5,7 @@ module Vedeu
   # Allows the storing of menus by name.
   #
   # @api public
-  class Menus < Repository
+  class Menus < Vedeu::Repository
 
     class << self
 

data/lib/vedeu/models/stream.rb

@@ -14,7 +14,7 @@ module Vedeu
     member     Vedeu::Char
 
     # @!attribute [rw] parent
-    # @return [Line]
+    # @return [Vedeu::Line]
     attr_accessor :parent
 
     # @!attribute [rw] value

data/lib/vedeu/output/border.rb

@@ -99,7 +99,7 @@ module Vedeu
     # @option attributes horizontal [String] The horizontal border character.
     # @option attributes name [String] The name of the interface to which this
     #   border relates.
-    # @option attributes style []
+    # @option attributes style [Vedeu::Style]
     # @option attributes show_bottom [Boolean] Indicate whether the bottom
     #   border is to be shown.
     # @option attributes show_left [Boolean] Indicate whether the left border
@@ -113,7 +113,7 @@ module Vedeu
     # @option attributes top_left [String] The top left border character.
     # @option attributes top_right [String] The top right border character.
     # @option attributes vertical [String] The vertical border character.
-    # @return [Border]
+    # @return [Vedeu::Border]
     def initialize(attributes = {})
       @attributes   = defaults.merge!(attributes)
 

data/lib/vedeu/output/borders.rb

@@ -7,7 +7,7 @@ module Vedeu
   # instance.
   #
   # @api public
-  class Borders < Repository
+  class Borders < Vedeu::Repository
 
     class << self
 

data/lib/vedeu/output/html_char.rb

@@ -2,7 +2,8 @@ require 'vedeu/common'
 
 module Vedeu
 
-  # Represents a {Vedeu::Char} as a HTML table cell.
+  # Represents a {Vedeu::Char} as a HTML tag with value. By default, a table
+  # cell is used.
   #
   # @api private
   class HTMLChar
@@ -10,22 +11,29 @@ module Vedeu
     include Vedeu::Common
 
     # @param char [Vedeu::Char]
+    # @param options [Hash<Symbol => String>]
+    # @option options start_tag [String]
+    # @option options end_tag [String]
     # @return [String]
-    def self.render(char)
-      new(char).render
+    def self.render(char, options = {})
+      new(char, options).render
     end
 
     # Returns a new instance of Vedeu::HTMLChar.
     #
     # @param char [Vedeu::Char]
+    # @param options [Hash<Symbol => String>]
+    # @option options start_tag [String]
+    # @option options end_tag [String]
     # @return [Vedeu::HTMLChar]
-    def initialize(char)
-      @char = char
+    def initialize(char, options = {})
+      @char    = char
+      @options = options
     end
 
     # @return [String]
     def render
-      "<td#{td_style}>#{td_value}</td>"
+      [start_tag, tag_style, '>', tag_value, end_tag].join
     end
 
     protected
@@ -37,7 +45,7 @@ module Vedeu
     private
 
     # @return [String]
-    def td_style
+    def tag_style
       return '' unless border || present?(value)
 
       " style='" \
@@ -48,7 +56,7 @@ module Vedeu
     end
 
     # @return [String]
-    def td_value
+    def tag_value
       return '&nbsp;' if border || !present?(value)
 
       value
@@ -77,25 +85,15 @@ module Vedeu
 
     # @return [String]
     def fg
-      @fg ||= colour_fg
+      @fg ||= colour(char, 'foreground', '#222')
     end
 
     # @return [String]
     def bg
-      @bg ||= colour_bg
+      @bg ||= colour(char, 'background', '#000')
     end
 
-    # @return [String]
-    def colour_bg
-      colour(char, 'background', '#000')
-    end
-
-    # @return [String]
-    def colour_fg
-      colour(char, 'foreground', '#222')
-    end
-
-    # @param char []
+    # @param char [Vedeu::Char]
     # @param type [String]
     # @param default [String]
     # @return [String]
@@ -126,6 +124,29 @@ module Vedeu
       char.value
     end
 
+    # @return [String]
+    def start_tag
+      options[:start_tag]
+    end
+
+    # @return [String]
+    def end_tag
+      options[:end_tag]
+    end
+
+    # @return [Hash<Symbol => String>]
+    def options
+      defaults.merge!(@options)
+    end
+
+    # @return [Hash<Symbol => String>]
+    def defaults
+      {
+        start_tag: '<td',
+        end_tag:   '</td>',
+      }
+    end
+
   end # HTMLChar
 
 end # Vedeu

data/lib/vedeu/output/refresh.rb

@@ -30,7 +30,7 @@ module Vedeu
 
     # Refresh the interface which is currently focussed.
     #
-    # @return [Array|ModelNotFound|NilClass]
+    # @return [Array|Vedeu::ModelNotFound|NilClass]
     def by_focus
       by_name(Vedeu.focus) if Vedeu.focus
     end
@@ -43,8 +43,8 @@ module Vedeu
     #   Vedeu::Refresh.by_group(group_name)
     #
     # @param group_name [String] The name of the group to be refreshed.
-    # @return [Array|ModelNotFound] A collection of the names of interfaces
-    #   refreshed, or an exception if the group was not found.
+    # @return [Array|Vedeu::ModelNotFound] A collection of the names of
+    #   interfaces refreshed, or an exception if the group was not found.
     def by_group(group_name)
       Vedeu.timer("Refresh Group: '#{group_name}'") do
         Vedeu::RefreshGroup.by_name(group_name)
@@ -60,7 +60,7 @@ module Vedeu
     #
     # @param name [String] The name of the interface to be refreshed using the
     #   named buffer.
-    # @return [Array|ModelNotFound]
+    # @return [Array|Vedeu::ModelNotFound]
     def by_name(name)
       Vedeu.timer("Refresh Interface: '#{name}'") do
         Vedeu.buffers.by_name(name).render

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

@@ -2,7 +2,8 @@ module Vedeu
 
   module Renderers
 
-    # Renders a {Vedeu::VirtualBuffer} or {Vedeu::Output} as a HTML table.
+    # Renders a {Vedeu::VirtualBuffer} or {Vedeu::Output} as a HTML snippet;
+    # a table by default.
     #
     # @api private
     class HTML < Vedeu::Renderers::File
@@ -10,6 +11,10 @@ module Vedeu
       # Returns a new instance of Vedeu::Renderers::HTML.
       #
       # @param options [Hash]
+      # @option options content [String]
+      # @option options end_row_tag [String]
+      # @option options start_row_tag [String]
+      # @option options template [String]
       # @return [Vedeu::Renderers::HTML]
       def initialize(options = {})
         @options = options || {}
@@ -33,14 +38,14 @@ module Vedeu
       def html_body
         out = ''
         Array(content).each do |line|
-          out << "<tr>\n"
+          out << "#{start_row_tag}\n"
           line.each do |char|
             if char.is_a?(Vedeu::Char)
               out << char.to_html
               out << "\n"
             end
           end
-          out << "</tr>\n"
+          out << "#{end_row_tag}\n"
         end
         out
       end
@@ -52,6 +57,16 @@ module Vedeu
         options[:content]
       end
 
+      # @return [String]
+      def end_row_tag
+        options[:end_row_tag]
+      end
+
+      # @return [String]
+      def start_row_tag
+        options[:start_row_tag]
+      end
+
       # @return [String]
       def template
         options[:template]
@@ -69,8 +84,10 @@ module Vedeu
       # @return [Hash<Symbol => void>]
       def defaults
         {
-          content:  '',
-          template: default_template,
+          content:       '',
+          end_row_tag:   '</tr>',
+          start_row_tag: '<tr>',
+          template:      default_template,
         }
       end
 

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

@@ -5,6 +5,8 @@ module Vedeu
   # @api private
   module RendererOptions
 
+    # :nocov:
+
     private
 
     # Combines the options provided at instantiation with the default values.
@@ -21,6 +23,8 @@ module Vedeu
       {}
     end
 
+    # :nocov
+
   end # RendererOptions
 
 end # Vedeu

data/lib/vedeu/output/style.rb

@@ -40,7 +40,7 @@ module Vedeu
     #
     # @param value [Array<String|Symbol>|String|Symbol]
     #   The style value or a collection of values.
-    # @return [Style]
+    # @return [Vedeu::Style]
     def initialize(value = nil)
       @value = value
     end

data/lib/vedeu/output/text.rb

@@ -26,7 +26,7 @@ module Vedeu
     # @option options model [Vedeu::Interface|Vedeu::Line|Vedeu::Stream]
     # @option options pad [String]
     # @option options width [Integer]
-    # @return [Text]
+    # @return [Vedeu::Text]
     def initialize(value = '', options = {})
       @value   = value
       @options = defaults.merge!(options)

data/lib/vedeu/output/viewport.rb

@@ -39,7 +39,7 @@ module Vedeu
 
     # Returns an instance of Vedeu::Viewport.
     #
-    # @param interface [Interface] An instance of interface.
+    # @param interface [Vedeu::Interface] An instance of interface.
     # @return [Viewport]
     def initialize(interface)
       @interface = interface

data/lib/vedeu/output/virtual_terminal.rb

@@ -21,7 +21,8 @@ module Vedeu
     #
     # @param height [Fixnum]
     # @param width [Fixnum]
-    # @param renderer [Object|Renderers::HTML] An object responding to .render.
+    # @param renderer [Object|Vedeu::Renderers::HTML] An object responding to
+    #   .render.
     # @return [Vedeu::VirtualTerminal]
     def initialize(height, width, renderer = Vedeu::Renderers::HTML.new)
       @height   = height

data/lib/vedeu/repositories/collection.rb

@@ -37,7 +37,7 @@ module Vedeu
 
     # Returns a new instance of Vedeu::Collection.
     #
-    # @param collection []
+    # @param collection [void]
     # @param parent [void]
     # @param name [String|NilClass]
     # @return [Vedeu::Collection]

data/lib/vedeu/repositories/repository.rb

@@ -92,10 +92,12 @@ module Vedeu
     # be found.
     #
     # @param name [String]
-    # @raise [ModelNotFound] When the model cannot be found with this name.
+    # @raise [Vedeu::ModelNotFound] When the model cannot be found with this
+    #   name.
     # @return [Hash<String => Object>]
     def find!(name)
-      find(name) || fail(ModelNotFound, "Cannot find model by name: '#{name}'")
+      find(name) || fail(Vedeu::ModelNotFound,
+                         "Cannot find model by name: '#{name}'")
     end
 
     # Find a model by name, registers the model by name if not found.
@@ -156,11 +158,13 @@ module Vedeu
     # Stores the model instance by name in the repository of the model.
     #
     # @param model [void] A model instance.
-    # @raise [MissingRequired] When the name attribute is not defined.
+    # @raise [Vedeu::MissingRequired] When the name attribute is not defined.
     # @return [void] The model instance which was stored.
     def store(model)
-      fail MissingRequired, "Cannot store model '#{model.class}' without a " \
-                            'name attribute.' unless present?(model.name)
+      unless present?(model.name)
+        fail Vedeu::MissingRequired, "Cannot store model '#{model.class}' " \
+                                     'without a name attribute.'
+      end
 
       log_store(model)