vedeu 0.6.8 → 0.6.9

data/lib/vedeu/borders/dsl.rb

@@ -16,8 +16,8 @@ module Vedeu
       #     # ...
       #   end
       #
-      # @param name [String] The name of the interface or view to which this
-      #   border belongs.
+      # @param name [String] The name of the interface or view to
+      #   which this border belongs.
       # @param block [Proc]
       # @raise [Vedeu::Error::InvalidSyntax]
       #   The required block was not given.
@@ -38,32 +38,32 @@ module Vedeu
         @client = client
       end
 
-      # Set the character to be used to draw the bottom left corner of the
-      # border.
+      # Set the character to be used to draw the bottom left corner of
+      # the border.
       #
       #   Vedeu.border 'border_demo' do
       #     bottom_left '+'
       #     # ... some code
       #   end
       #
-      # @param char [String] Character to be used as the bottom left border
-      #   character.
+      # @param char [String] Character to be used as the bottom left
+      #   border character.
       # @return [String]
       def bottom_left(char)
         model.bottom_left = char
       end
       alias_method :bottom_left=, :bottom_left
 
-      # Set the character to be used to draw the bottom right corner of the
-      # border.
+      # Set the character to be used to draw the bottom right corner
+      # of the border.
       #
       #   Vedeu.border 'border_demo' do
       #     bottom_right '+'
       #     # ... some code
       #   end
       #
-      # @param char [String] Character to be used as the bottom right border
-      #   character.
+      # @param char [String] Character to be used as the bottom right
+      #   border character.
       # @return [String]
       def bottom_right(char)
         model.bottom_right = char
@@ -90,7 +90,8 @@ module Vedeu
       end
 
       # Enable the border:
-      # (Borders are enabled by default when defined for an interface).
+      # (Borders are enabled by default when defined for an
+      # interface).
       #
       #   Vedeu.border 'border_demo' do
       #     enable!
@@ -109,15 +110,16 @@ module Vedeu
         model.enabled
       end
 
-      # Set the character to be used to draw a horizontal part of the border.
+      # Set the character to be used to draw a horizontal part of the
+      # border.
       #
       #   Vedeu.border 'border_demo' do
       #     horizontal '-'
       #     # ... some code
       #   end
       #
-      # @param char [String] Character to be used as the horizontal border
-      #   character.
+      # @param char [String] Character to be used as the horizontal
+      #   border character.
       # @return [String]
       def horizontal(char)
         model.horizontal = char
@@ -134,8 +136,8 @@ module Vedeu
       #     # ... some code
       #   end
       #
-      # @param value [Boolean] All values evaluate as true except nil and
-      #   false.
+      # @param value [Boolean] All values evaluate as true except nil
+      # and false.
       # @return [Boolean]
       def bottom(value)
         boolean = value ? true : false
@@ -169,8 +171,8 @@ module Vedeu
       #     # ... some code
       #   end
       #
-      # @param value [Boolean] All values evaluate as true except nil and
-      #   false.
+      # @param value [Boolean] All values evaluate as true except nil
+      #   and false.
       # @return [Boolean]
       def left(value)
         boolean = value ? true : false
@@ -204,8 +206,8 @@ module Vedeu
       #     # ... some code
       #   end
       #
-      # @param value [Boolean] All values evaluate as true except nil and
-      #   false.
+      # @param value [Boolean] All values evaluate as true except nil
+      #   and false.
       # @return [Boolean]
       def right(value)
         boolean = value ? true : false
@@ -229,7 +231,8 @@ module Vedeu
         right(true)
       end
 
-      # If you have you are showing a top border, you could add a title.
+      # If you have you are showing a top border, you could add a
+      # title.
       #
       #   Vedeu.border 'border_demo' do
       #     title 'My Cool Title'
@@ -247,7 +250,8 @@ module Vedeu
       end
       alias_method :title=, :title
 
-      # If you have you are showing a bottom border, you could add a caption.
+      # If you have you are showing a bottom border, you could add a
+      # caption.
       #
       #   Vedeu.border 'border_demo' do
       #     caption 'My Cool Caption'
@@ -275,8 +279,8 @@ module Vedeu
       #     # ... some code
       #   end
       #
-      # @param value [Boolean] All values evaluate as true except nil and
-      #   false.
+      # @param value [Boolean] All values evaluate as true except nil
+      #   and false.
       # @return [Boolean]
       def top(value)
         boolean = value ? true : false
@@ -300,45 +304,48 @@ module Vedeu
         top(true)
       end
 
-      # Set the character to be used to draw the top left corner of the border.
+      # Set the character to be used to draw the top left corner of
+      # the border.
       #
       #   Vedeu.border 'border_demo' do
       #     top_left '+'
       #     # ... some code
       #   end
       #
-      # @param char [String] Character to be used as the top left border
-      #   character.
+      # @param char [String] Character to be used as the top left
+      #   border character.
       # @return [String]
       def top_left(char)
         model.top_left = char
       end
       alias_method :top_left=, :top_left
 
-      # Set the character to be used to draw the top right corner of the border.
+      # Set the character to be used to draw the top right corner of
+      # the border.
       #
       #   Vedeu.border 'border_demo' do
       #     top_right '+'
       #     # ... some code
       #   end
       #
-      # @param char [String] Character to be used as the top right border
-      #   character.
+      # @param char [String] Character to be used as the top right
+      #   border character.
       # @return [String]
       def top_right(char)
         model.top_right = char
       end
       alias_method :top_right=, :top_right
 
-      # Set the character to be used to draw a vertical part of the border.
+      # Set the character to be used to draw a vertical part of the
+      # border.
       #
       #   Vedeu.border 'border_demo' do
       #     vertical '|'
       #     # ... some code
       #   end
       #
-      # @param char [String] Character to be used as the vertical border
-      #   character.
+      # @param char [String] Character to be used as the vertical
+      #   border character.
       # @return [String]
       def vertical(char)
         model.vertical = char

data/lib/vedeu/borders/null.rb

@@ -2,8 +2,8 @@ module Vedeu
 
   module Borders
 
-    # Provides a non-existent Vedeu::Borders::Border that acts like the real
-    # thing, but does nothing.
+    # Provides a non-existent Vedeu::Borders::Border that acts like
+    # the real thing, but does nothing.
     #
     class Null
 

data/lib/vedeu/borders/render.rb

@@ -133,9 +133,9 @@ module Vedeu
       # Renders the bottom border for the interface.
       #
       # @note
-      #   If a caption has been specified, then the bottom border will include
-      #   this caption unless the size of the interface is smaller than the
-      #   padded caption length.
+      #   If a caption has been specified, then the bottom border will
+      #   include this caption unless the size of the interface is
+      #   smaller than the padded caption length.
       #
       # @return [String]
       def bottom
@@ -149,7 +149,8 @@ module Vedeu
         Vedeu.geometries.by_name(name)
       end
 
-      # @param position [Symbol] Either :top_horizontal, or :bottom_horizontal.
+      # @param position [Symbol] Either :top_horizontal, or
+      #   :bottom_horizontal.
       # @param y_coordinate [Fixnum] The value of either y or yn.
       # @return [Array<Vedeu::Views::Char>]
       def build_horizontal(position, y_coordinate)
@@ -160,7 +161,7 @@ module Vedeu
 
       # The parent of a border is always an interface.
       #
-      # @return [Vedeu::Interface]
+      # @return [Vedeu::Models::Interface]
       def interface
         @interface ||= Vedeu.interfaces.by_name(name)
       end
@@ -189,9 +190,9 @@ module Vedeu
       # Renders the top border for the interface.
       #
       # @note
-      #   If a title has been specified, then the top border will include this
-      #   title unless the size of the interface is smaller than the padded
-      #   title length.
+      #   If a title has been specified, then the top border will
+      #   include this title unless the size of the interface is
+      #   smaller than the padded title length.
       #
       # @return [String]
       def top
@@ -200,8 +201,8 @@ module Vedeu
         [build_top_left, titlebar, build_top_right].compact
       end
 
-      # Overwrite the border from {#build_horizontal} on the bottom border to
-      # include the caption if given.
+      # Overwrite the border from {#build_horizontal} on the bottom
+      # border to include the caption if given.
       #
       # @return [Array<Vedeu::Views::Char>]
       def captionbar
@@ -219,8 +220,8 @@ module Vedeu
         end
       end
 
-      # Overwrite the border from {#build_horizontal} on the top border to
-      # include the title if given.
+      # Overwrite the border from {#build_horizontal} on the top
+      # border to include the title if given.
       #
       # @return [Array<Vedeu::Views::Char>]
       def titlebar
@@ -234,30 +235,32 @@ module Vedeu
         end
       end
 
-      # Return boolean indicating whether this border has a non-empty title.
+      # Return boolean indicating whether this border has a non-empty
+      # title.
       #
       # @return [Boolean]
       def title?
         present?(title)
       end
 
-      # Return boolean indicating whether this border has a non-empty caption.
+      # Return boolean indicating whether this border has a non-empty
+      # caption.
       #
       # @return [Boolean]
       def caption?
         present?(caption)
       end
 
-      # Return boolean indicating whether the title fits within the width of the
-      # top border.
+      # Return boolean indicating whether the title fits within the
+      # width of the top border.
       #
       # @return [Boolean]
       def title_fits?
         width > title_characters.size
       end
 
-      # Return boolean indicating whether the caption fits within the width of
-      # the bottom border.
+      # Return boolean indicating whether the caption fits within the
+      # width of the bottom border.
       #
       # @return [Boolean]
       def caption_fits?
@@ -306,9 +309,10 @@ module Vedeu
         truncated_caption.center(truncated_caption.size + 2)
       end
 
-      # Truncates the title to the width of the interface, minus characters
-      # needed to ensure there is at least a single character of horizontal
-      # border and a whitespace on either side of the title.
+      # Truncates the title to the width of the interface, minus
+      # characters needed to ensure there is at least a single
+      # character of horizontal border and a whitespace on either side
+      # of the title.
       #
       # @example
       #   title = 'Truncated!'
@@ -323,9 +327,10 @@ module Vedeu
         title.chomp.slice(0..(width - 5))
       end
 
-      # Truncates the caption to the width of the interface, minus characters
-      # needed to ensure there is at least a single character of horizontal
-      # border and a whitespace on either side of the caption.
+      # Truncates the caption to the width of the interface, minus
+      # characters needed to ensure there is at least a single
+      # character of horizontal border and a whitespace on either
+      # side of the caption.
       #
       # @example
       #   caption = 'Truncated!'

data/lib/vedeu/borders/repository.rb

@@ -2,8 +2,8 @@ module Vedeu
 
   module Borders
 
-    # Allows the storing of interface/view borders independent of the interface
-    # instance.
+    # Allows the storing of interface/view borders independent of the
+    # interface instance.
     #
     class Repository < Vedeu::Repository
 

data/lib/vedeu/buffers/all.rb

@@ -1,15 +1,16 @@
 module Vedeu
 
-  # The Buffer object represents the states of display for an interface. The
-  # states are 'front', 'back' and 'previous'.
+  # The Buffer object represents the states of display for an
+  # interface. The states are 'front', 'back' and 'previous'.
   #
   # [Back] -> [Front] -> [Previous]
   #
-  # The content on the screen, or last output will always be the 'Front'
-  # buffer. Content due to be displayed on next refresh will come from the
-  # 'Back' buffer when available, otherwise from the current 'Front' buffer.
-  # When new content is copied to the 'Front' buffer, the current 'Front'
-  # buffer is also copied to the 'Previous' buffer.
+  # The content on the screen, or last output will always be the
+  # 'Front' buffer. Content due to be displayed on next refresh will
+  # come from the 'Back' buffer when available, otherwise from the
+  # current 'Front' buffer. When new content is copied to the 'Front'
+  # buffer, the current 'Front' buffer is also copied to the
+  # 'Previous' buffer.
   #
   module Buffers
 

data/lib/vedeu/buffers/buffer.rb

@@ -2,28 +2,29 @@ module Vedeu
 
   module Buffers
 
-    # Used by Vedeu internally to manage the buffers of each interface defined.
+    # Used by Vedeu internally to manage the buffers of each interface
+    # defined.
     #
     class Buffer
 
       include Vedeu::Model
 
-      # The next buffer to be displayed; contains the content which will be
-      # shown on next refresh.
+      # The next buffer to be displayed; contains the content which
+      # will be shown on next refresh.
       #
       # @!attribute [rw] back
       # @return [Vedeu::Views::View]
       attr_accessor :back
 
-      # The currently displayed buffer, contains the content which was last
-      # output.
+      # The currently displayed buffer, contains the content which was
+      # last output.
       #
       # @!attribute [rw] front
       # @return [Vedeu::Views::View]
       attr_accessor :front
 
-      # The previous buffer which was displayed; contains the content that was
-      # shown before 'front'.
+      # The previous buffer which was displayed; contains the content
+      # that was shown before 'front'.
       #
       # @!attribute [rw] previous
       # @return [Vedeu::Views::View]
@@ -33,11 +34,11 @@ module Vedeu
       # @return [String]
       attr_reader :name
 
-      # Return a new instance of Buffer. Generally a Buffer is initialized with
-      # only a 'name' and 'back' parameter.
+      # Return a new instance of Buffer. Generally a Buffer is
+      # initialized with only a 'name' and 'back' parameter.
       #
-      # @option attributes name [String] The name of the interface for which the
-      #   buffer belongs.
+      # @option attributes name [String] The name of the interface for
+      #   which the buffer belongs.
       # @option attributes back [Vedeu::Views::View]
       # @option attributes front [Vedeu::Views::View]
       # @option attributes previous [Vedeu::Views::View]
@@ -51,8 +52,9 @@ module Vedeu
         end
       end
 
-      # Add the content to the back buffer, then update the repository.
-      # Returns boolean indicating that the repository was updated.
+      # Add the content to the back buffer, then update the
+      # repository. Returns boolean indicating that the repository was
+      # updated.
       #
       # @param content [Vedeu::Views::View]
       # @return [Boolean]
@@ -64,7 +66,8 @@ module Vedeu
         true
       end
 
-      # Return a boolean indicating content presence on the buffer type.
+      # Return a boolean indicating content presence on the buffer
+      # type.
       #
       # @return [Boolean] Whether the buffer targetted has content.
       def back?
@@ -77,10 +80,11 @@ module Vedeu
       #
       # @return [Array<Array<Vedeu::Views::Char>>]
       def clear
-        Vedeu::Output.render(Vedeu::Clear::NamedInterface.render(name))
+        Vedeu::Output::Output.render(Vedeu::Clear::NamedInterface.render(name))
       end
 
-      # Return a boolean indicating content presence on the buffer type.
+      # Return a boolean indicating content presence on the buffer
+      # type.
       #
       # @return [Boolean] Whether the buffer targetted has content.
       def front?
@@ -89,7 +93,8 @@ module Vedeu
         true
       end
 
-      # Return a boolean indicating content presence on the buffer type.
+      # Return a boolean indicating content presence on the buffer
+      # type.
       #
       # @return [Boolean] Whether the buffer targetted has content.
       def previous?
@@ -104,31 +109,33 @@ module Vedeu
       #   Vedeu.trigger(:_hide_interface_, name)
       #   Vedeu.hide_interface(name)
       #
-      # Will hide the named interface. If the interface is currently visible, it
-      # will be cleared- rendered blank. To show the interface, the
-      # ':_show_interface_' event should be triggered. Triggering the
-      # ':_hide_group_' event to which this named interface belongs will also
-      # hide the interface.
+      # Will hide the named interface. If the interface is currently
+      # visible, it will be cleared- rendered blank. To show the
+      # interface, the ':_show_interface_' event should be triggered.
+      # Triggering the ':_hide_group_' event to which this named
+      # interface belongs will also hide the interface.
       #
       # @return [Array<Array<Array<Vedeu::Views::Char>>>]
       def hide
-        Vedeu::Output.render(clear)
+        Vedeu::Output::Output.render(clear)
       end
 
       # Return the content for this buffer.
       #
-      # - If we have new content (i.e. content on 'back') to be shown, we first
-      #   clear the area occupied by the previous content, then clear the area
-      #   for the new content, and then finally render the new content.
-      # - If there is no new content (i.e. 'back' is empty), check the 'front'
-      #   buffer and display that.
-      # - If there is no new content, and the front buffer is empty, display the
-      #   'previous' buffer.
-      # - If the 'previous' buffer is empty, return an empty collection.
+      # - If we have new content (i.e. content on 'back') to be shown,
+      #   we first clear the area occupied by the previous content,
+      #   then clear the area for the new content, and then finally
+      #   render the new content.
+      # - If there is no new content (i.e. 'back' is empty), check the
+      #   'front' buffer and display that.
+      # - If there is no new content, and the front buffer is empty,
+      #   display the 'previous' buffer.
+      # - If the 'previous' buffer is empty, return an empty
+      #   collection.
       #
       # @return [Array<Array<Array<Vedeu::Views::Char>>>]
       def render
-        Vedeu::Output.render(buffer)
+        Vedeu::Output::Output.render(buffer)
       end
 
       # Show this buffer.
@@ -137,15 +144,15 @@ module Vedeu
       #   Vedeu.trigger(:_show_interface_, name)
       #   Vedeu.show_interface(name)
       #
-      # Will show the named interface. If the interface is currently invisible,
-      # it will be shown- rendered with its latest content. To hide the
-      # interface, the ':_hide_interface_' event should be triggered. Triggering
-      # the ':_show_group_' event to which this named interface belongs will
-      # also show the interface.
+      # Will show the named interface. If the interface is currently
+      # invisible, it will be shown- rendered with its latest content.
+      # To hide the interface, the ':_hide_interface_' event should be
+      # triggered. Triggering the ':_show_group_' event to which this
+      # named interface belongs will also show the interface.
       #
       # @return [Array<Array<Array<Vedeu::Views::Char>>>]
       def show
-        Vedeu::Output.render(buffer)
+        Vedeu::Output::Output.render(buffer)
       end
 
       private
@@ -181,7 +188,8 @@ module Vedeu
         }
       end
 
-      # Return a boolean indicating content was swapped between buffers.
+      # Return a boolean indicating content was swapped between
+      # buffers.
       #
       # @return [Boolean]
       def swap