vedeu 0.6.10 → 0.6.11

data/lib/vedeu/models/views/collections/view_collection.rb

@@ -5,7 +5,7 @@ module Vedeu
     # A collection of {Vedeu::Views::View} instances.
     #
     # @api private
-    class ViewCollection < Vedeu::Collection
+    class ViewCollection < Vedeu::Repositories::Collection
 
     end # ViewCollection
 

data/lib/vedeu/models/views/composition.rb

@@ -6,7 +6,7 @@ module Vedeu
     #
     class Composition
 
-      include Vedeu::Model
+      include Vedeu::Repositories::Model
       include Vedeu::Presentation
 
       collection Vedeu::Views::ViewCollection

data/lib/vedeu/models/views/line.rb

@@ -3,12 +3,12 @@ module Vedeu
   module Views
 
     # Represents a single row of the terminal. It is a container for
-    # {Vedeu::Views::Stream} objects. A line's width is determined by the
-    # {Vedeu::Geometry::Geometry} it belongs to.
+    # {Vedeu::Views::Stream} objects. A line's width is determined by
+    # the {Vedeu::Geometry::Geometry} it belongs to.
     #
     class Line
 
-      include Vedeu::Model
+      include Vedeu::Repositories::Model
       include Vedeu::Presentation
 
       collection Vedeu::Views::Streams
@@ -45,7 +45,8 @@ module Vedeu
       end
       alias_method :<<, :add
 
-      # Returns an array of all the characters with formatting for this line.
+      # Returns an array of all the characters with formatting for
+      # this line.
       #
       # @return [Array]
       # @see Vedeu::Views::Stream
@@ -57,14 +58,15 @@ module Vedeu
 
       # An object is equal when its values are the same.
       #
-      # @param other [Vedeu::Collection]
+      # @param other [Vedeu::Repositories::Collection]
       # @return [Boolean]
       def eql?(other)
         self.class == other.class && value == other.value
       end
       alias_method :==, :eql?
 
-      # Returns the size of the content in characters without formatting.
+      # Returns the size of the content in characters without
+      # formatting.
       #
       # @return [Fixnum]
       def size

data/lib/vedeu/models/views/stream.rb

@@ -8,7 +8,7 @@ module Vedeu
     #
     class Stream
 
-      include Vedeu::Model
+      include Vedeu::Repositories::Model
       include Vedeu::Presentation
 
       collection Vedeu::Views::Chars

data/lib/vedeu/models/views/view.rb

@@ -7,7 +7,7 @@ module Vedeu
     #
     class View
 
-      include Vedeu::Model
+      include Vedeu::Repositories::Model
       include Vedeu::Presentation
 
       collection Vedeu::Views::Lines

data/lib/vedeu/null/all.rb

@@ -0,0 +1,12 @@
+module Vedeu
+
+  module Null
+
+  end # Null
+
+end # Vedeu
+
+require 'vedeu/null/null'
+require 'vedeu/null/generic'
+require 'vedeu/null/interface'
+require 'vedeu/null/view'

data/lib/vedeu/output/clear/named_group.rb

@@ -1,6 +1,7 @@
 module Vedeu
 
-  # Provides the mechanisms to clear an interface or group of interfaces.
+  # Provides the mechanisms to clear an interface or group of
+  # interfaces.
   #
   module Clear
 

data/lib/vedeu/output/clear/named_interface.rb

@@ -1,6 +1,7 @@
 module Vedeu
 
-  # Provides the mechanisms to clear an interface or group of interfaces.
+  # Provides the mechanisms to clear an interface or group of
+  # interfaces.
   #
   module Clear
 
@@ -57,9 +58,9 @@ module Vedeu
       end
 
       # For each visible line of the interface, set the foreground and
-      # background colours to those specified when the interface was defined,
-      # then starting write space characters over the area which the interface
-      # occupies.
+      # background colours to those specified when the interface was
+      # defined, then starting write space characters over the area
+      # which the interface occupies.
       #
       # @return [Array<Array<Vedeu::Views::Char>>]
       def output

data/lib/vedeu/output/compressor.rb

@@ -42,6 +42,7 @@ module Vedeu
 
       private
 
+      # @return [Array]
       def content
         return [] if output.nil? || output.empty?
 

data/lib/vedeu/output/output.rb

@@ -1,5 +1,8 @@
 module Vedeu
 
+  # Classes within the Output namespace handle various aspects of
+  # rendering content.
+  #
   module Output
 
     # Sends the output to the renderers.

data/lib/vedeu/output/presentation/colour.rb

@@ -6,8 +6,8 @@ module Vedeu
     #
     module Colour
 
-      # When the background colour for the model exists, return it, otherwise
-      # returns the parent background colour, or an empty
+      # When the background colour for the model exists, return it,
+      # otherwise returns the parent background colour, or an empty
       # Vedeu::Colours::Background.
       #
       # @return [Vedeu::Colours::Background]
@@ -24,8 +24,8 @@ module Vedeu
                         end
       end
 
-      # Allows the setting of the background colour by coercing the given value
-      # into a Vedeu::Colours::Background colour.
+      # Allows the setting of the background colour by coercing the
+      # given value into a Vedeu::Colours::Background colour.
       #
       # @return [Vedeu::Colours::Background]
       def background=(value)
@@ -48,16 +48,16 @@ module Vedeu
                     end
       end
 
-      # Allows the setting of the model's colour by coercing the given value
-      # into a Vedeu::Colours::Colour.
+      # Allows the setting of the model's colour by coercing the given
+      # value into a Vedeu::Colours::Colour.
       #
       # @return [Vedeu::Colours::Colour]
       def colour=(value)
         @colour = Vedeu::Colours::Colour.coerce(value)
       end
 
-      # When the foreground colour for the model exists, return it, otherwise
-      # returns the parent foreground colour, or an empty
+      # When the foreground colour for the model exists, return it,
+      # otherwise returns the parent foreground colour, or an empty
       # Vedeu::Colours::Foreground.
       #
       # @return [Vedeu::Colours::Foreground]
@@ -74,8 +74,8 @@ module Vedeu
                         end
       end
 
-      # Allows the setting of the foreground colour by coercing the given value
-      # into a Vedeu::Colours::Foreground colour.
+      # Allows the setting of the foreground colour by coercing the
+      # given value into a Vedeu::Colours::Foreground colour.
       #
       # @return [Vedeu::Colours::Foreground]
       def foreground=(value)

data/lib/vedeu/output/presentation/presentation.rb

@@ -4,17 +4,17 @@ require 'vedeu/output/presentation/style'
 
 module Vedeu
 
-  # This module allows the sharing of presentation concerns between the models:
-  # Interface, View, Line and Stream.
+  # This module allows the sharing of presentation concerns between
+  # the models: Interface, View, Line and Stream.
   #
   module Presentation
 
     include Vedeu::Presentation::Colour
     include Vedeu::Presentation::Styles
 
-    # Converts the colours and styles to escape sequences, and when the parent
-    # model has previously set the colour and style, reverts back to that for
-    # consistent formatting.
+    # Converts the colours and styles to escape sequences, and when
+    # the parent model has previously set the colour and style,
+    # reverts back to that for consistent formatting.
     #
     # @return [String] An escape sequence with value interpolated.
     def to_s
@@ -24,8 +24,8 @@ module Vedeu
 
     private
 
-    # Renders the colour attributes of the receiver and yields (to then render
-    # the styles).
+    # Renders the colour attributes of the receiver and yields (to
+    # then render the styles).
     #
     # @return [String]
     def render_colour
@@ -44,8 +44,8 @@ module Vedeu
       end
     end
 
-    # Renders the style attributes of the receiver and yields (to then render
-    # the next model, or finally, the content).
+    # Renders the style attributes of the receiver and yields (to
+    # then render the next model, or finally, the content).
     #
     # @return [String]
     def render_style

data/lib/vedeu/output/presentation/style.rb

@@ -11,7 +11,7 @@ module Vedeu
     # be defined in either interfaces, for specific lines or within
     # streams. Styles are applied as encountered.
     #
-    # @see Vedeu::Esc
+    # @see Vedeu::EscapeSequences::Esc
     #
     class Style
 
@@ -71,7 +71,7 @@ module Vedeu
         return '' unless present?(value)
 
         @sequences ||= Array(value).flatten.map do |v|
-          Vedeu::Esc.string(v)
+          Vedeu::EscapeSequences::Esc.string(v)
         end.join
       end
       alias_method :escape_sequences, :to_s

data/lib/vedeu/output/refresh/refresh.rb

@@ -0,0 +1,35 @@
+module Vedeu
+
+  module Output
+
+    # @see Vedeu::Bindings::System#refresh!
+    class Refresh
+
+      # Refresh all registered interfaces.
+      #
+      # @return [Array<Vedeu::Models::Interface>]
+      def self.all
+        new.all
+      end
+
+      # Return a new instance of Vedeu::Output::Refresh.
+      #
+      # @return [Vedeu::Output::Refresh]
+      def initialize; end
+
+      # Refresh all registered interfaces.
+      #
+      # @return [Array<Vedeu::Models::Interface>]
+      def all
+        Vedeu.timer('Refreshing all') do
+          Vedeu.interfaces.zindexed.each do |interface|
+            Vedeu.trigger(:_refresh_, interface.name)
+          end
+        end
+      end
+
+    end # Refresh
+
+  end # Output
+
+end # Vedeu

data/lib/vedeu/output/refresh/refresh_group.rb

@@ -0,0 +1,66 @@
+module Vedeu
+
+  module Output
+
+    # Refresh an interface, or collection of interfaces belonging to a
+    # group.
+    #
+    # The interfaces will be refreshed in z-index order, meaning that
+    # interfaces with a lower z-index will be drawn first. This means
+    # overlapping interfaces will be drawn as specified.
+    #
+    # @example
+    #   Vedeu.trigger(:_refresh_group_, group_name)
+    #
+    class RefreshGroup
+
+      include Vedeu::Common
+
+      # @param name [String] The name of the group to be refreshed.
+      # @return [Array|Vedeu::Error::ModelNotFound] A collection of
+      #   the names of interfaces refreshed, or an exception when the
+      #   group was not found.
+      def self.by_name(name)
+        new(name).by_name
+      end
+
+      # Return a new instance of Vedeu::Output::RefreshGroup.
+      #
+      # @param name [String]
+      # @return [Vedeu::Output::RefreshGroup]
+      def initialize(name)
+        @name = name
+      end
+
+      # @return [void]
+      def by_name
+        Vedeu.timer("Refresh Group: '#{group_name}'") do
+          Vedeu.groups.by_name(group_name).by_zindex.each do |name|
+            Vedeu::Buffers::Refresh.by_name(name)
+          end
+        end
+      end
+
+      protected
+
+      # @!attribute [r] name
+      # @return [String]
+      attr_reader :name
+
+      private
+
+      # @raise [Vedeu::Error::MissingRequired] When the name is empty
+      #   or nil.
+      # @return [String]
+      def group_name
+        return name if present?(name)
+
+        fail Vedeu::Error::MissingRequired,
+             'Cannot refresh group with an empty group name.'
+      end
+
+    end # RefreshGroup
+
+  end # Output
+
+end # Vedeu

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

@@ -0,0 +1,17 @@
+module Vedeu
+
+  module Renderers
+
+  end # Renderers
+
+end # Vedeu
+
+require 'vedeu/output/renderers/renderer_options'
+require 'vedeu/output/renderers/escape_sequence'
+require 'vedeu/output/renderers/file'
+require 'vedeu/output/renderers/html'
+require 'vedeu/output/renderers/json'
+require 'vedeu/output/renderers/null'
+require 'vedeu/output/renderers/terminal'
+require 'vedeu/output/renderers/text'
+require 'vedeu/output/renderers'

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

@@ -6,7 +6,7 @@ module Vedeu
     #
     class EscapeSequence
 
-      include Vedeu::RendererOptions
+      include Vedeu::Renderers::RendererOptions
 
       # Returns a new instance of Vedeu::Renderers::EscapeSequence.
       #
@@ -24,7 +24,9 @@ module Vedeu
         out = ''
 
         output.each do |row|
-          row.each { |cell| out << Vedeu::Esc.escape(cell.to_s) }
+          row.each do |cell|
+            out << Vedeu::EscapeSequences::Esc.escape(cell.to_s)
+          end
         end
 
         out

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

@@ -6,16 +6,17 @@ module Vedeu
     #
     class File
 
-      include Vedeu::RendererOptions
+      include Vedeu::Renderers::RendererOptions
 
       # Returns a new instance of Vedeu::Renderers::File.
       #
       # @param options [Hash]
-      # @option options filename [String] Provide a filename for the output.
-      #   Defaults to 'out'.
-      # @option options timestamp [Boolean] Append a timestamp to the filename.
-      # @option options write_file [Boolean] Whether to write the file to the
-      #   given filename.
+      # @option options filename [String] Provide a filename for the
+      #   output. Defaults to 'out'.
+      # @option options timestamp [Boolean] Append a timestamp to the
+      #   filename.
+      # @option options write_file [Boolean] Whether to write the file
+      #   to the given filename.
       # @return [Vedeu::Renderers::File]
       def initialize(options = {})
         @options = options || {}

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

@@ -13,15 +13,17 @@ module Vedeu
       # @option options content [String] Defaults to an empty string.
       # @option options end_tag [String] Defaults to '</td>'.
       # @option options end_row_tag [String] Defaults to '</tr>'.
-      # @option options filename [String] Provide a filename for the output.
-      #   Defaults to 'out'.
-      # @option options start_tag [String] Defaults to '<td' (note the end of
-      #   the tag is missing, this is so that inline styles can be added later).
+      # @option options filename [String] Provide a filename for the
+      #   output. Defaults to 'out'.
+      # @option options start_tag [String] Defaults to '<td' (note the
+      #   end of the tag is missing, this is so that inline styles can
+      #   be added later).
       # @option options start_row_tag [String] Defaults to '<tr>'.
       # @option options template [String]
-      # @option options timestamp [Boolean] Append a timestamp to the filename.
-      # @option options write_file [Boolean] Whether to write the file to the
-      #   given filename.
+      # @option options timestamp [Boolean] Append a timestamp to the
+      #   filename.
+      # @option options write_file [Boolean] Whether to write the file
+      #   to the given filename.
       # @return [Vedeu::Renderers::HTML]
       def initialize(options = {})
         @options = options || {}

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

@@ -6,7 +6,7 @@ module Vedeu
     #
     class Null
 
-      include Vedeu::RendererOptions
+      include Vedeu::Renderers::RendererOptions
 
       # Returns a new instance of Vedeu::Renderers::Null.
       #

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

@@ -1,28 +1,32 @@
 module Vedeu
 
-  # Provides shared functionality to Vedeu::Renderer classes.
-  #
-  # :nocov:
-  module RendererOptions
+  module Renderers
 
-    private
-
-    # Combines the options provided at instantiation with the default
-    # values.
+    # Provides shared functionality to Vedeu::Renderer classes.
     #
-    # @return [Hash<Symbol => void>]
-    def options
-      defaults.merge!(@options)
-    end
+    # :nocov:
+    module RendererOptions
 
-    # The default values for a new instance of this class.
-    #
-    # @return [Hash<Symbol => void>]
-    def defaults
-      {}
-    end
+      private
+
+      # Combines the options provided at instantiation with the
+      # default values.
+      #
+      # @return [Hash<Symbol => void>]
+      def options
+        defaults.merge!(@options)
+      end
+
+      # The default values for a new instance of this class.
+      #
+      # @return [Hash<Symbol => void>]
+      def defaults
+        {}
+      end
+
+    end # RendererOptions
+    # :nocov:
 
-  end # RendererOptions
-  # :nocov:
+  end # Renderers
 
 end # Vedeu

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

@@ -7,7 +7,7 @@ module Vedeu
     #
     class Terminal
 
-      include Vedeu::RendererOptions
+      include Vedeu::Renderers::RendererOptions
 
       # Returns a new instance of Vedeu::Renderers::Terminal.
       #

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

@@ -7,7 +7,7 @@ module Vedeu
     #
     class Text
 
-      include Vedeu::RendererOptions
+      include Vedeu::Renderers::RendererOptions
 
       # Returns a new instance of Vedeu::Renderers::Text.
       #

data/lib/vedeu/output/wordwrap.rb

@@ -146,10 +146,13 @@ module Vedeu
         options.fetch(:ellipsis)
       end
 
-      # Returns the word wrapping mode. One of :default, :prune or :wrap;
-      #   :default = Renders the content as is.
-      #   :prune   = Discards the remainder of the content line after width.
-      #   :wrap    = Forces the content on to a new line after width.
+      # Returns the word wrapping mode. One of :default, :prune or
+      #   :wrap;
+      #     :default = Renders the content as is.
+      #     :prune   = Discards the remainder of the content line
+      #                after width.
+      #     :wrap    = Forces the content on to a new line after
+      #                width.
       # @return [Symbol]
       def mode
         options.fetch(:mode)

data/lib/vedeu/plugins/all.rb

@@ -0,0 +1,2 @@
+require 'vedeu/plugins/plugins'
+require 'vedeu/plugins/plugin'

data/lib/vedeu/repositories/all.rb

@@ -0,0 +1,16 @@
+module Vedeu
+
+  # Provides all registered repositories.
+  #
+  module Repositories
+
+  end # Repositories
+
+end # Vedeu
+
+require 'vedeu/repositories/collection'
+require 'vedeu/repositories/repositories'
+require 'vedeu/repositories/model'
+require 'vedeu/repositories/store'
+require 'vedeu/repositories/registerable'
+require 'vedeu/repositories/repository'