vedeu 0.6.8 → 0.6.9

data/lib/vedeu/distributed/uri.rb

@@ -1,11 +1,12 @@
 module Vedeu
 
-  # Provides a mechanism to control a running client application via DRb.
+  # Provides a mechanism to control a running client application via
+  # DRb.
   #
   module Distributed
 
-    # Value class which provides the host and port for the DRb server and
-    # client.
+    # Value class which provides the host and port for the DRb server
+    # and client.
     #
     class Uri
 

data/lib/vedeu/dsl/composition.rb

@@ -97,7 +97,7 @@ module Vedeu
       #   paths.
       # @param object [Object] The object for which the values of template's
       #   variables can be obtained.
-      # @param options [Hash] See {Vedeu::Wordwrap}
+      # @param options [Hash] See {Vedeu::Output::Wordwrap}
       # @raise [Vedeu::Error::MissingRequired]
       # @return [Vedeu::Views::Views<Vedeu::Views::View>]
       def template_for(name, filename, object = nil, options = {})
@@ -112,7 +112,7 @@ module Vedeu
                                                         filename,
                                                         options)
 
-        # lines     = Vedeu::Wordwrap.for(content, options)
+        # lines     = Vedeu::Output::Wordwrap.for(content, options)
 
         new_model = model.member.build(template_attributes(name, content))
 

data/lib/vedeu/dsl/group.rb

@@ -51,16 +51,16 @@ module Vedeu
       # @param name [String] The name of this group.
       # @param block [Proc]
       # @raise [Vedeu::Error::InvalidSyntax] The required block was not given.
-      # @return [Vedeu::Group]
+      # @return [Vedeu::Models::Group]
       def self.group(name, &block)
         fail Vedeu::Error::InvalidSyntax, 'block not given' unless block_given?
 
-        Vedeu::Group.build(name: name, &block).store
+        Vedeu::Models::Group.build(name: name, &block).store
       end
 
       # Returns an instance of DSL::Group.
       #
-      # @param model [Vedeu::Group]
+      # @param model [Vedeu::Models::Group]
       # @param client [Object]
       # @return [Vedeu::DSL::Group]
       def initialize(model, client = nil)
@@ -75,7 +75,7 @@ module Vedeu
       #   end
       #
       # @param interface_name [String]
-      # @return [Vedeu::Group]
+      # @return [Vedeu::Models::Group]
       def add(interface_name)
         model.add(interface_name)
       end

data/lib/vedeu/dsl/interface.rb

@@ -30,7 +30,7 @@ module Vedeu
         # @param block [Proc] A set of attributes which define the features of
         #   the interface.
         # @raise [Vedeu::Error::InvalidSyntax] The required block was not given.
-        # @return [Vedeu::Interface]
+        # @return [Vedeu::Models::Interface]
         # @todo More documentation required.
         def interface(name, &block)
           fail Vedeu::Error::InvalidSyntax,
@@ -44,7 +44,7 @@ module Vedeu
 
           attributes = { client: client(&block), name: name }
 
-          Vedeu::Interface.build(attributes, &block).store
+          Vedeu::Models::Interface.build(attributes, &block).store
         end
 
         private
@@ -166,7 +166,7 @@ module Vedeu
       #
       # @return [Array<String>] A list of focusable interfaces.
       def focus!
-        Vedeu::Focus.add(model.name, true) if present?(model.name)
+        Vedeu::Models::Focus.add(model.name, true) if present?(model.name)
       end
 
       # Specify a group for an interface. Interfaces of the same group can be
@@ -181,7 +181,7 @@ module Vedeu
       #
       # @param name [String] The name of the group to which this interface
       #   should belong.
-      # @return [Vedeu::Group]
+      # @return [Vedeu::Models::Group]
       def group(name)
         return false unless present?(name)
 
@@ -249,7 +249,7 @@ module Vedeu
       #
       # @param name [String] The name of the interface model you wish to use a
       #   value from.
-      # @return [Vedeu::Interface]
+      # @return [Vedeu::Models::Interface]
       def use(name)
         model.repository.by_name(name)
       end

data/lib/vedeu/dsl/presentation.rb

@@ -107,9 +107,9 @@ module Vedeu
       #     # ...
       #   end
       #
-      # @return [Vedeu::Style]
+      # @return [Vedeu::Presentation::Style]
       def style(value)
-        model.style = Vedeu::Style.coerce(value)
+        model.style = Vedeu::Presentation::Style.coerce(value)
       end
       alias_method :style=,  :style
       alias_method :styles,  :style

data/lib/vedeu/dsl/text.rb

@@ -56,7 +56,7 @@ module Vedeu
       def text(value = '', options = {})
         options.merge!(anchor: __callee__, model: model)
 
-        Vedeu::Text.add(value, options)
+        Vedeu::Output::Text.add(value, options)
       end
       alias_method :text=,   :text
       alias_method :align,   :text

data/lib/vedeu/editor/cropper.rb

@@ -2,8 +2,8 @@ module Vedeu
 
   module Editor
 
-    # Crop the lines to the visible area of the document, as defined by the
-    # geometry provided.
+    # Crop the lines to the visible area of the document, as defined
+    # by the geometry provided.
     #
     class Cropper
 
@@ -25,8 +25,8 @@ module Vedeu
 
       # Returns the lines cropped.
       #
-      # @note If there are no lines of content, we return an empty array. If
-      # there are any empty lines, then they are discarded.
+      # @note If there are no lines of content, we return an empty
+      # array. If there are any empty lines, then they are discarded.
       #
       # @return [Array<void>]
       def cropped

data/lib/vedeu/editor/cursor.rb

@@ -2,7 +2,8 @@ module Vedeu
 
   module Editor
 
-    # Maintains a cursor position within the Vedeu::Editor::Document class.
+    # Maintains a cursor position within the {Vedeu::Editor::Document}
+    # class.
     #
     class Cursor
 
@@ -42,7 +43,8 @@ module Vedeu
       #
       # @param attributes [Hash]
       # @option attributes y [Fixnum] The current line.
-      # @option attributes x [Fixnum] The current character with the line.
+      # @option attributes x [Fixnum] The current character with the
+      #   line.
       # @option attributes by [Fixnum]
       # @option attributes bx [Fixnum]
       # @option attributes byn [Fixnum]
@@ -108,8 +110,8 @@ module Vedeu
         self
       end
 
-      # Return the escape sequence for setting the cursor position and show the
-      # cursor.
+      # Return the escape sequence for setting the cursor position and
+      # show the cursor.
       #
       # @return [String]
       def to_s

data/lib/vedeu/editor/document.rb

@@ -55,11 +55,11 @@ module Vedeu
       #
       # @return [void]
       def clear
-        Vedeu::Direct.write(value: clear_output, x: bx, y: by)
+        Vedeu::Output::Direct.write(value: clear_output, x: bx, y: by)
       end
 
-      # Deletes the character from the line where the cursor is currently
-      # positioned.
+      # Deletes the character from the line where the cursor is
+      # currently positioned.
       #
       # @return [Vedeu::Editor::Document]
       def delete_character
@@ -90,8 +90,8 @@ module Vedeu
         refresh
       end
 
-      # Returns the document as a string with line breaks if there is more than
-      # one line.
+      # Returns the document as a string with line breaks if there is
+      # more than one line.
       #
       # @return [String]
       def execute
@@ -106,8 +106,8 @@ module Vedeu
         command
       end
 
-      # Inserts the given character in to the line where the cursor is currently
-      # positioned.
+      # Inserts the given character in to the line where the cursor is
+      # currently positioned.
       #
       # @param character [String|Symbol]
       # @return [Vedeu::Editor::Document]
@@ -150,7 +150,8 @@ module Vedeu
         lines.line(y)
       end
 
-      # Returns the collection of lines which constitutes the document content.
+      # Returns the collection of lines which constitutes the document
+      # content.
       #
       # @return [Array<String|void>]
       def lines
@@ -163,7 +164,7 @@ module Vedeu
       def render
         clear
 
-        Vedeu::Direct.write(value: output, x: bx, y: by)
+        Vedeu::Output::Direct.write(value: output, x: bx, y: by)
       end
 
       # Reset the document to the empty state.
@@ -177,8 +178,8 @@ module Vedeu
         refresh
       end
 
-      # Store the document in the documents repository, clear and render the
-      # view.
+      # Store the document in the documents repository, clear and
+      # render the view.
       #
       # @return [Vedeu::Editor::Document]
       def refresh
@@ -209,15 +210,16 @@ module Vedeu
 
       private
 
-      # Retrieve the dimensions of the document from the interface of the same
-      # name.
+      # Retrieve the dimensions of the document from the interface of
+      # the same name.
       #
       # @return [Vedeu::Borders::Border]
       def border
         @border ||= Vedeu.borders.by_name(name)
       end
 
-      # Return the data needed to clear the area which the document is using.
+      # Return the data needed to clear the area which the document is
+      # using.
       #
       # @return [String]
       def clear_output
@@ -258,8 +260,8 @@ module Vedeu
         output
       end
 
-      # Return a virtual cursor to track the cursor position within the
-      # document.
+      # Return a virtual cursor to track the cursor position within
+      # the document.
       #
       # @return [Vedeu::Editor::Cursor]
       def cursor
@@ -271,8 +273,8 @@ module Vedeu
                                               bxn: bxn)
       end
 
-      # Return only the visible lines for the document based on the current
-      # virtual cursor position.
+      # Return only the visible lines for the document based on the
+      # current virtual cursor position.
       #
       # @return [Vedeu::Editor::Lines]
       def visible

data/lib/vedeu/editor/editor.rb

@@ -2,8 +2,8 @@ module Vedeu
 
   module Editor
 
-    # Handles keypresses for a named document whilst the terminal is in fake
-    # mode.
+    # Handles keypresses for a named document whilst the terminal is
+    # in fake mode.
     #
     class Editor
 

data/lib/vedeu/editor/line.rb

@@ -35,7 +35,8 @@ module Vedeu
         @line = line || ''
       end
 
-      # Return a character or collection of characters (if index is a Range).
+      # Return a character or collection of characters (if index is a
+      # Range).
       #
       # @param index [Fixnum|Range]
       # @return [String]
@@ -43,7 +44,8 @@ module Vedeu
         line[index]
       end
 
-      # Return the character from the line positioned at the given index.
+      # Return the character from the line positioned at the given
+      # index.
       #
       # @param index [Fixnum|NilClass]
       # @return [String|NilClass]
@@ -63,7 +65,8 @@ module Vedeu
         end
       end
 
-      # Delete the character from the line positioned at the given index.
+      # Delete the character from the line positioned at the given
+      # index.
       #
       # @param index [Fixnum|NilClass]
       # @return [String]
@@ -81,7 +84,8 @@ module Vedeu
         Vedeu::Editor::Line.coerce(new_line)
       end
 
-      # Returns a boolean indicating whether there are characters on this line.
+      # Returns a boolean indicating whether there are characters on
+      # this line.
       #
       # @return [Boolean]
       def empty?
@@ -97,7 +101,8 @@ module Vedeu
       end
       alias_method :==, :eql?
 
-      # Insert the character on the line positioned at the given index.
+      # Insert the character on the line positioned at the given
+      # index.
       #
       # @param character [String]
       # @param index [Fixnum|NilClass]

data/lib/vedeu/editor/lines.rb

@@ -65,8 +65,8 @@ module Vedeu
         lines[index]
       end
 
-      # Deletes the character from the line where the cursor is currently
-      # positioned.
+      # Deletes the character from the line where the cursor is
+      # currently positioned.
       #
       # @param y [Fixnum]
       # @param x [Fixnum]

data/lib/vedeu/internal_api.rb

@@ -98,8 +98,8 @@ module Vedeu
     #   Vedeu.groups
     #
     # @!method groups
-    # @return [Vedeu::Groups]
-    def_delegators Vedeu::Groups, :groups
+    # @return [Vedeu::Models::Groups]
+    def_delegators Vedeu::Models::Groups, :groups
 
     # Manipulate the repository of interfaces.
     #
@@ -107,8 +107,8 @@ module Vedeu
     #   Vedeu.interfaces
     #
     # @!method interfaces
-    # @return [Vedeu::Interfaces]
-    def_delegators Vedeu::Interfaces, :interfaces
+    # @return [Vedeu::Models::Interfaces]
+    def_delegators Vedeu::Models::Interfaces, :interfaces
 
     # Manipulate the repository of keymaps.
     #

data/lib/vedeu/models/focus.rb

@@ -1,228 +1,234 @@
 module Vedeu
 
-  # The Focus repository is simply a collection of interface names, this module
-  # serving to store and manipulate the which interface is currently being
-  # focussed.
-  #
-  # @note
-  #   - Interfaces are added to the collection in the order they are defined.
-  #   - If the interface definition contains `focus!`,
-  #     (see Vedeu::DSL::Interface#focus!) then that interface is prepended to
-  #     the list.
-  #   - If the `Vedeu.focus_by_name 'some_interface'` declaration is used, then
-  #     the list pointer (`current`) is set to the interface of that name.
-  #
-  module Focus
-
-    extend self
-
-    # Add an interface name to the focus list unless it is already registered.
-    #
-    # @param name [String] The name of the interface.
-    # @param focus [Boolean] When true, prepends the interface name to the
-    #   collection, making that interface the currently focussed interface.
-    # @return [Array] The collection of interface names.
-    def add(name, focus = false)
-      if registered?(name)
-        return storage unless focus
-
-        by_name(name)
-        storage
+  module Models
+
+    # The Focus repository is simply a collection of interface names,
+    # this module serving to store and manipulate the which interface
+    # is currently being focussed.
+    #
+    # @note
+    #   - Interfaces are added to the collection in the order they are defined.
+    #   - If the interface definition contains `focus!`,
+    #     (see Vedeu::DSL::Interface#focus!) then that interface is prepended to
+    #     the list.
+    #   - If the `Vedeu.focus_by_name 'some_interface'` declaration is used,
+    #     then the list pointer (`current`) is set to the interface of
+    #     that name.
+    #
+    module Focus
+
+      extend self
+
+      # Add an interface name to the focus list unless it is already registered.
+      #
+      # @param name [String] The name of the interface.
+      # @param focus [Boolean] When true, prepends the interface name to the
+      #   collection, making that interface the currently focussed interface.
+      # @return [Array] The collection of interface names.
+      def add(name, focus = false)
+        if registered?(name)
+          return storage unless focus
+
+          by_name(name)
+          storage
 
-      else
-        Vedeu.log(type: :store, message: "Storing focus entry: '#{name}'")
+        else
+          Vedeu.log(type: :store, message: "Storing focus entry: '#{name}'")
 
-        if focus
-          storage.unshift(name)
+          if focus
+            storage.unshift(name)
 
-        else
-          storage.push(name)
+          else
+            storage.push(name)
 
+          end
         end
       end
-    end
-
-    # Focus an interface by name. Used after defining an interface or interfaces
-    # to set the initially focussed interface.
-    #
-    # @example
-    #   Vedeu.trigger(:_focus_by_name_, name)
-    #   Vedeu.focus_by_name('name')
-    #
-    # @param name [String] The interface to focus; must be defined.
-    # @raise [Vedeu::Error::ModelNotFound] When the interface cannot be found.
-    # @return [String] The name of the interface now in focus.
-    def by_name(name)
-      unless registered?(name)
-        fail Vedeu::Error::ModelNotFound,
-             "Cannot focus '#{name}' as this interface has not been registered."
-      end
-
-      storage.rotate!(storage.index(name))
-
-      update
-    end
-    alias_method :focus_by_name, :by_name
-
-    # Return the interface currently focussed.
-    #
-    # @example
-    #   Vedeu.focus
-    #
-    # @return [String]
-    def current
-      storage[0]
-    end
-    alias_method :focus, :current
 
-    # Returns a boolean indicating whether the named interface is focussed.
-    #
-    # @example
-    #   Vedeu.focussed?(name)
-    #
-    # @param name [String]
-    # @return [Boolean]
-    def current?(name)
-      current == name
-    end
-    alias_method :focussed?, :current?
-
-    # Return a boolean indicating whether the storage is empty.
-    #
-    # @return [Boolean]
-    def empty?
-      storage.empty?
-    end
-
-    # Put the next interface relative to the current interfaces in focus.
-    #
-    # @example
-    #   Vedeu.trigger(:_focus_next_)
-    #   Vedeu.focus_next
-    #
-    # @return [String]
-    def next_item
-      storage.rotate!
+      # Focus an interface by name. Used after defining an interface
+      # or interfaces to set the initially focussed interface.
+      #
+      # @example
+      #   Vedeu.trigger(:_focus_by_name_, name)
+      #   Vedeu.focus_by_name('name')
+      #
+      # @param name [String] The interface to focus; must be defined.
+      # @raise [Vedeu::Error::ModelNotFound] When the interface cannot be found.
+      # @return [String] The name of the interface now in focus.
+      def by_name(name)
+        unless registered?(name)
+          fail Vedeu::Error::ModelNotFound,
+               "Cannot focus '#{name}' as this interface has not been " \
+               'registered.'
+        end
 
-      update
-    end
-    alias_method :next, :next_item
+        storage.rotate!(storage.index(name))
 
-    # Put the next visible interface relative to the current interfaces in
-    # focus.
-    #
-    # @return [String]
-    def next_visible_item
-      return update unless visible_items?
+        update
+      end
+      alias_method :focus_by_name, :by_name
+
+      # Return the interface currently focussed.
+      #
+      # @example
+      #   Vedeu.focus
+      #
+      # @return [String]
+      def current
+        storage[0]
+      end
+      alias_method :focus, :current
+
+      # Returns a boolean indicating whether the named interface is focussed.
+      #
+      # @example
+      #   Vedeu.focussed?(name)
+      #
+      # @param name [String]
+      # @return [Boolean]
+      def current?(name)
+        current == name
+      end
+      alias_method :focussed?, :current?
 
-      loop do
-        storage.rotate!
-        break if Vedeu.interfaces.by_name(current).visible?
+      # Return a boolean indicating whether the storage is empty.
+      #
+      # @return [Boolean]
+      def empty?
+        storage.empty?
       end
 
-      update
-    end
-    alias_method :focus_next, :next_visible_item
+      # Put the next interface relative to the current interfaces in focus.
+      #
+      # @example
+      #   Vedeu.trigger(:_focus_next_)
+      #   Vedeu.focus_next
+      #
+      # @return [String]
+      def next_item
+        storage.rotate!
 
-    # Put the previous interface relative to the current interface in focus.
-    #
-    # @example
-    #   Vedeu.trigger(:_focus_prev_)
-    #   Vedeu.focus_previous
-    #
-    # @return [String]
-    def prev_item
-      storage.rotate!(-1)
+        update
+      end
+      alias_method :next, :next_item
+
+      # Put the next visible interface relative to the current interfaces in
+      # focus.
+      #
+      # @return [String]
+      def next_visible_item
+        return update unless visible_items?
+
+        loop do
+          storage.rotate!
+          break if Vedeu.interfaces.by_name(current).visible?
+        end
 
-      update
-    end
-    alias_method :prev,     :prev_item
-    alias_method :previous, :prev_item
+        update
+      end
+      alias_method :focus_next, :next_visible_item
+
+      # Put the previous interface relative to the current interface in focus.
+      #
+      # @example
+      #   Vedeu.trigger(:_focus_prev_)
+      #   Vedeu.focus_previous
+      #
+      # @return [String]
+      def prev_item
+        storage.rotate!(-1)
 
-    # Put the previous visible interface relative to the current interfaces in
-    # focus.
-    #
-    # @return [String]
-    def prev_visible_item
-      return update unless visible_items?
+        update
+      end
+      alias_method :prev,     :prev_item
+      alias_method :previous, :prev_item
+
+      # Put the previous visible interface relative to the current interfaces in
+      # focus.
+      #
+      # @return [String]
+      def prev_visible_item
+        return update unless visible_items?
+
+        loop do
+          storage.rotate!(-1)
+          break if Vedeu.interfaces.by_name(current).visible?
+        end
 
-      loop do
-        storage.rotate!(-1)
-        break if Vedeu.interfaces.by_name(current).visible?
+        update
       end
+      alias_method :focus_previous, :prev_visible_item
 
-      update
-    end
-    alias_method :focus_previous, :prev_visible_item
+      # Refresh the interface in focus.
+      #
+      # @return [Array]
+      def refresh
+        Vedeu.trigger(:_refresh_, current)
+      end
 
-    # Refresh the interface in focus.
-    #
-    # @return [Array]
-    def refresh
-      Vedeu.trigger(:_refresh_, current)
-    end
+      # Returns a collection of the names of all the registered entities.
+      #
+      # @return [Array]
+      def registered
+        return [] if empty?
 
-    # Returns a collection of the names of all the registered entities.
-    #
-    # @return [Array]
-    def registered
-      return [] if empty?
+        storage
+      end
 
-      storage
-    end
+      # Returns a boolean indicating whether the named model is registered.
+      #
+      # @param name [String]
+      # @return [Boolean]
+      def registered?(name)
+        return false if empty?
 
-    # Returns a boolean indicating whether the named model is registered.
-    #
-    # @param name [String]
-    # @return [Boolean]
-    def registered?(name)
-      return false if empty?
+        storage.include?(name)
+      end
 
-      storage.include?(name)
-    end
+      # Reset the repository.
+      #
+      # @return [Array|Hash|Set]
+      def reset
+        @storage = in_memory
+      end
 
-    # Reset the repository.
-    #
-    # @return [Array|Hash|Set]
-    def reset
-      @storage = in_memory
-    end
+      private
 
-    private
+      # Return the name of the interface in focus after triggering the refresh
+      # event for that interface. Returns false when the storage is empty.
+      #
+      # @return [String|FalseClass]
+      def update
+        return false if empty?
 
-    # Return the name of the interface in focus after triggering the refresh
-    # event for that interface. Returns false when the storage is empty.
-    #
-    # @return [String|FalseClass]
-    def update
-      return false if empty?
+        Vedeu.log(type: :info, message: "Interface in focus: '#{current}'")
 
-      Vedeu.log(type: :info, message: "Interface in focus: '#{current}'")
+        refresh
 
-      refresh
+        current
+      end
 
-      current
-    end
+      # Access to the storage for this repository.
+      #
+      # @return [Array]
+      def storage
+        @storage ||= in_memory
+      end
 
-    # Access to the storage for this repository.
-    #
-    # @return [Array]
-    def storage
-      @storage ||= in_memory
-    end
+      # Returns an empty collection ready for the storing of interface names.
+      #
+      # @return [Array]
+      def in_memory
+        []
+      end
 
-    # Returns an empty collection ready for the storing of interface names.
-    #
-    # @return [Array]
-    def in_memory
-      []
-    end
+      # @return [Boolean]
+      def visible_items?
+        storage.any? { |name| Vedeu.interfaces.by_name(name).visible? }
+      end
 
-    # @return [Boolean]
-    def visible_items?
-      storage.any? { |name| Vedeu.interfaces.by_name(name).visible? }
-    end
+    end # Focus
 
-  end # Focus
+  end # Models
 
 end # Vedeu