vedeu 0.6.9 → 0.6.10

data/lib/vedeu/output/viewport.rb

@@ -1,166 +1,177 @@
 module Vedeu
 
-  # A Viewport is the visible part of the content within an interface.
-  #
-  # When a buffer has more lines than the defined height, or more columns than
-  # the defined width of the interface, the Viewport class provides 'scrolling'
-  # via the cursor's position.
-  #
-  class Viewport
-
-    extend Forwardable
-
-    def_delegators :view,
-                   :lines,
-                   :name,
-                   :visible?
-
-    def_delegators :border,
-                   :height,
-                   :width
-
-    def_delegators :cursor,
-                   :ox,
-                   :oy
-
-    # @param view [Vedeu::Views::View]
-    # @return [Array<Array<Vedeu::Views::Char>>]
-    def self.render(view)
-      new(view).render
-    end
-
-    # Returns an instance of Vedeu::Viewport.
-    #
-    # @param view [Vedeu::Views::View]
-    # @return [Vedeu::Viewport]
-    def initialize(view)
-      @view = view
-    end
+  module Output
 
-    # Returns the content for the view.
+    # A Viewport is the visible part of the content within an
+    # interface.
+    #
+    # When a buffer has more lines than the defined height, or more
+    # columns than the defined width of the interface, this class
+    # provides 'scrolling' via the cursor's position.
     #
-    # @return [Array<Array<String>>]
-    def render
-      return [] unless visible?
+    class Viewport
+
+      extend Forwardable
+
+      def_delegators :view,
+                     :lines,
+                     :name,
+                     :visible?
+
+      def_delegators :border,
+                     :height,
+                     :width
+
+      def_delegators :cursor,
+                     :ox,
+                     :oy
+
+      # @param view [Vedeu::Views::View]
+      # @return [Array<Array<Vedeu::Views::Char>>]
+      def self.render(view)
+        new(view).render
+      end
+
+      # Returns an instance of Vedeu::Output::Viewport.
+      #
+      # @param view [Vedeu::Views::View]
+      # @return [Vedeu::Output::Viewport]
+      def initialize(view)
+        @view = view
+      end
 
-      Vedeu.timer("Rendering: '#{name}'") do
-        out = []
+      # Returns the content for the view.
+      #
+      # @return [Array<Array<String>>]
+      def render
+        return [] unless visible?
 
-        show.each_with_index do |line, iy|
-          line.each_with_index do |column, ix|
-            column.position = [by + iy, bx + ix]
-            out << column
+        Vedeu.timer("Rendering: '#{name}'") do
+          out = []
+
+          show.each_with_index do |line, iy|
+            line.each_with_index do |column, ix|
+              column.position = [by + iy, bx + ix]
+              out << column
+            end
           end
+
+          out
         end
+      end
 
-        out
+      # Returns a string representation of the viewport.
+      #
+      # @return [String]
+      def to_s
+        render.map(&:to_s).join("\n")
+      end
+      alias_method :to_str, :to_s
+
+      protected
+
+      # @!attribute [r] view
+      # @return [Vedeu::Views::View]
+      attr_reader :view
+
+      private
+
+      # Returns the visible content for the view.
+      #
+      # @note If there are no lines of content, we return an empty
+      #   array. If there are no more columns of content we return a
+      #   space enclosed in an array; this prevents a weird line
+      #   hopping bug which occurs when the current line has no more
+      #   content, but subsequent lines do.
+      #
+      # @return [Array]
+      def show
+        (lines[rows] || []).map { |line| (line.chars[columns] || []) }
       end
-    end
 
-    # Returns a string representation of the viewport.
-    #
-    # @return [String]
-    def to_s
-      render.map(&:to_s).join("\n")
-    end
-    alias_method :to_str, :to_s
+      # Using the current cursor's y position, return a range of
+      # visible lines.
+      #
+      # Scrolls the content vertically when the stored cursor's y
+      # position for the interface is outside of the visible area.
+      #
+      # @note
+      #   The height is reduced by one as #rows is a range of Array
+      #   elements.
+      #
+      # @return [Range]
+      def rows
+        top...(top + height)
+      end
 
-    protected
+      # Using the current cursor's x position, return a range of
+      # visible columns.
+      #
+      # Scrolls the content horizontally when the stored cursor's x
+      # position for the interface is outside of the visible area.
+      #
+      # @note
+      #   The width is reduced by one as #columns is a range of Array
+      #   elements.
+      #
+      # @return [Range]
+      def columns
+        left...(left + width)
+      end
 
-    # @!attribute [r] view
-    # @return [Vedeu::Views::View]
-    attr_reader :view
+      # @return [Fixnum]
+      def left
+        @left ||= content_offset(ox, width)
+      end
 
-    private
+      # @return [Fixnum]
+      def top
+        @top ||= content_offset(oy, height)
+      end
 
-    # Returns the visible content for the view.
-    #
-    # @note If there are no lines of content, we return an empty array. If there
-    #   are no more columns of content we return a space enclosed in an array;
-    #   this prevents a weird line hopping bug which occurs when the current
-    #   line has no more content, but subsequent lines do.
-    #
-    # @return [Array]
-    def show
-      (lines[rows] || []).map { |line| (line.chars[columns] || []) }
-    end
+      # Returns the offset for the content (the number of rows or
+      # columns to change the viewport by on either the y or x axis)
+      # determined by the offset (the cursor's y or x offset position.
+      #
+      # @param offset [Fixnum] The cursor's oy or ox values.
+      # @param dimension [Fixnum] Either the height or width.
+      # @return [Fixnum]
+      def content_offset(offset, dimension)
+        if offset >= dimension
+          offset - dimension
 
-    # Using the current cursor's y position, return a range of visible lines.
-    #
-    # Scrolls the content vertically when the stored cursor's y position for the
-    # interface is outside of the visible area.
-    #
-    # @note
-    #   The height is reduced by one as #rows is a range of Array elements.
-    #
-    # @return [Range]
-    def rows
-      top...(top + height)
-    end
+        else
+          0
 
-    # Using the current cursor's x position, return a range of visible columns.
-    #
-    # Scrolls the content horizontally when the stored cursor's x position for
-    # the interface is outside of the visible area.
-    #
-    # @note
-    #   The width is reduced by one as #columns is a range of Array elements.
-    #
-    # @return [Range]
-    def columns
-      left...(left + width)
-    end
-
-    # @return [Fixnum]
-    def left
-      @left ||= content_offset(ox, width)
-    end
-
-    # @return [Fixnum]
-    def top
-      @top ||= content_offset(oy, height)
-    end
-
-    # Returns the offset for the content (the number of rows or columns to
-    # change the viewport by on either the y or x axis) determined by the offset
-    # (the cursor's y or x offset position.
-    #
-    # @param offset [Fixnum] The cursor's oy or ox values.
-    # @param dimension [Fixnum] Either the height or width.
-    # @return [Fixnum]
-    def content_offset(offset, dimension)
-      if offset >= dimension
-        offset - dimension
+        end
+      end
 
-      else
-        0
+      # Return the border associated with the interface/view we are
+      # drawing.
+      #
+      # @return (see Vedeu::Borders::Repository#by_name)
+      def border
+        @border ||= Vedeu.borders.by_name(name)
+      end
 
+      # @return [Fixnum]
+      def bx
+        @bx ||= border.bx
       end
-    end
 
-    # Return the border associated with the interface/view we are drawing.
-    #
-    # @return (see Vedeu::Borders::Repository#by_name)
-    def border
-      @border ||= Vedeu.borders.by_name(name)
-    end
-
-    # @return [Fixnum]
-    def bx
-      @bx ||= border.bx
-    end
-
-    # @return [Fixnum]
-    def by
-      @by ||= border.by
-    end
-
-    # @return [Vedeu::Cursors::Cursor]
-    # @see Vedeu::Cursors::Repository#by_name
-    def cursor
-      @cursor ||= Vedeu.cursors.by_name(name)
-    end
-
-  end # Viewport
+      # @return [Fixnum]
+      def by
+        @by ||= border.by
+      end
+
+      # @return [Vedeu::Cursors::Cursor]
+      # @see Vedeu::Cursors::Repository#by_name
+      def cursor
+        @cursor ||= Vedeu.cursors.by_name(name)
+      end
+
+    end # Viewport
+
+  end # Output
 
 end # Vedeu

data/lib/vedeu/repositories/collection.rb

@@ -1,7 +1,7 @@
 module Vedeu
 
-  # Convert an Array into an object which has some meaning in the context it
-  # is being used.
+  # Convert an Array into an object which has some meaning in the
+  # context it is being used.
   #
   class Collection
 

data/lib/vedeu/repositories/model.rb

@@ -1,7 +1,7 @@
 module Vedeu
 
-  # When included into a class, provides the mechanism to store the class in a
-  # repository for later retrieval.
+  # When included into a class, provides the mechanism to store the
+  # class in a repository for later retrieval.
   #
   module Model
 
@@ -11,8 +11,8 @@ module Vedeu
     # @return [Vedeu::Repository]
     attr_accessor :repository
 
-    # When {Vedeu::Model} is included in a class, the methods within this module
-    # are included as class methods on that class.
+    # When {Vedeu::Model} is included in a class, the methods within
+    # this module are included as class methods on that class.
     #
     module ClassMethods
 
@@ -20,11 +20,12 @@ module Vedeu
       # @return [Vedeu::Repository]
       attr_reader :repository
 
-      # Build models using a simple DSL when a block is given, otherwise returns
-      # a new instance of the class including this module.
+      # Build models using a simple DSL when a block is given,
+      # otherwise returns a new instance of the class including this
+      # module.
       #
-      # @param attributes [Hash] A collection of attributes specific to the
-      #   model.
+      # @param attributes [Hash] A collection of attributes specific
+      #   to the model.
       # @param block [Proc] The block passed to the build method.
       # @return [Object] An instance of the model.
       def build(attributes = {}, &block)
@@ -43,10 +44,11 @@ module Vedeu
         repository.by_name(name) if repository
       end
 
-      # Provide a convenient way to define the child or children of a model.
+      # Provide a convenient way to define the child or children of a
+      # model.
       #
-      # @param klass [Class] The member (singular) or collection (multiple)
-      #   class name for the respective model.
+      # @param klass [Class] The member (singular) or collection
+      #   (multiple) class name for the respective model.
       # @return [void]
       def child(klass)
         send(:define_method, __callee__) { klass }
@@ -76,8 +78,8 @@ module Vedeu
 
     end # ClassMethods
 
-    # When this module is included in a class, provide ClassMethods as class
-    # methods for the class.
+    # When this module is included in a class, provide ClassMethods as
+    # class methods for the class.
     #
     # @param klass [Class]
     # @return [void]
@@ -85,13 +87,13 @@ module Vedeu
       klass.send(:extend, ClassMethods)
     end
 
-    # Returns a DSL instance responsible for defining the DSL methods of this
-    # model.
+    # Returns a DSL instance responsible for defining the DSL methods
+    # of this model.
     #
     # @param client [Object|NilClass] The client binding represents
-    #   the client application object that is currently invoking a DSL method.
-    #   It is required so that we can send messages to the client application
-    #   object should we need to.
+    #   the client application object that is currently invoking a DSL
+    #   method. It is required so that we can send messages to the
+    #   client application object should we need to.
     # @return [void] The DSL instance for this model.
     def deputy(client = nil)
       Object.const_get(dsl_class).new(self, client)
@@ -109,14 +111,11 @@ module Vedeu
     #
     # @return [String]
     def dsl_class
-      if demodulize(self.class.name) == 'Border'
-        'Vedeu::Borders::DSL'
-      elsif demodulize(self.class.name) == 'Buffer'
-        'Vedeu::Buffers::DSL'
-      elsif demodulize(self.class.name) == 'Geometry'
-        'Vedeu::Geometry::DSL'
-      elsif demodulize(self.class.name) == 'Menu'
-        'Vedeu::Menus::DSL'
+      case demodulize(self.class.name)
+      when 'Border'   then 'Vedeu::Borders::DSL'
+      when 'Buffer'   then 'Vedeu::Buffers::DSL'
+      when 'Geometry' then 'Vedeu::Geometry::DSL'
+      when 'Menu'     then 'Vedeu::Menus::DSL'
       else
         'Vedeu::DSL::' + demodulize(self.class.name)
       end

data/lib/vedeu/repositories/registerable.rb

@@ -1,7 +1,7 @@
 module Vedeu
 
-  # Repositories contain registerables, this module provides convenience methods
-  # for them.
+  # Repositories contain registerables, this module provides
+  # convenience methods for them.
   #
   module Registerable
 
@@ -16,7 +16,8 @@ module Vedeu
         define_method(:null_model) { klass }
       end
 
-      # The real model is the usual model to use for a given repository.
+      # The real model is the usual model to use for a given
+      # repository.
       #
       # @param klass [Class]
       # @return [Symbol]
@@ -38,9 +39,9 @@ module Vedeu
       # Returns the repositories registered.
       #
       # @note
-      #   If the repository is 'Geometries', for example, then @models will be
-      #   either an empty Geometries repository or the collection of stored
-      #   models.
+      #   If the repository is 'Geometries', for example, then @models
+      #   will be either an empty Geometries repository or the
+      #   collection of stored models.
       #
       # @return [void]
       def repository
@@ -57,8 +58,8 @@ module Vedeu
 
     end # ClassMethods
 
-    # When this module is included in a class, provide ClassMethods as class
-    # methods for the class.
+    # When this module is included in a class, provide ClassMethods as
+    # class methods for the class.
     #
     # @param klass [Class]
     # @return [void]

data/lib/vedeu/repositories/repository.rb

@@ -1,6 +1,7 @@
 module Vedeu
 
-  # Provides common methods for accessing the various repositories Vedeu uses.
+  # Provides common methods for accessing the various repositories
+  # Vedeu uses.
   #
   # @example
   #   { 'models' => [Model, Model, Model] }
@@ -50,11 +51,12 @@ module Vedeu
     # Return the named model or a null object if not registered.
     #
     # @example
-    #   Vedeu.cursors.by_name('some_name') # => Fetch the cursor belonging to
-    #                                           the interface of the same name.
+    #   # Fetch the cursor belonging to the interface of the same
+    #   # name.
+    #   Vedeu.cursors.by_name('some_name')
     #
-    #   Vedeu.groups.by_name(name) # => Fetch the names of the interfaces
-    #                                   belonging to this group.
+    #   # Fetch the names of the interfaces belonging to this group.
+    #   Vedeu.groups.by_name(name)
     #
     # @param name [String] The name of the stored model.
     # @return [void]
@@ -85,19 +87,20 @@ module Vedeu
       storage[name]
     end
 
-    # Find the model attributes by name, raises an exception when the model
-    # cannot be found.
+    # Find the model attributes by name, raises an exception when the
+    # model cannot be found.
     #
     # @param name [String]
-    # @raise [Vedeu::Error::ModelNotFound] When the model cannot be found with
-    #   this name.
+    # @raise [Vedeu::Error::ModelNotFound] When the model cannot be
+    #   found with this name.
     # @return [Hash<String => Object>]
     def find!(name)
       find(name) || fail(Vedeu::Error::ModelNotFound,
                          "Cannot find model by name: '#{name}'")
     end
 
-    # Find a model by name, registers the model by name when not found.
+    # Find a model by name, registers the model by name when not
+    # found.
     #
     # @param name [String]
     # @return [void]
@@ -118,7 +121,8 @@ module Vedeu
       "<#{self.class.name}>"
     end
 
-    # Returns a boolean indicating whether the named model is registered.
+    # Returns a boolean indicating whether the named model is
+    # registered.
     #
     # @param name [String]
     # @return [Boolean]
@@ -129,8 +133,8 @@ module Vedeu
       storage.include?(name)
     end
 
-    # Returns the storage with the named model removed, or false when the model
-    # does not exist.
+    # Returns the storage with the named model removed, or false when
+    # the model does not exist.
     #
     # @param name [String]
     # @return [Hash|FalseClass]
@@ -150,11 +154,12 @@ module Vedeu
     alias_method :delete,     :remove
     alias_method :deregister, :remove
 
-    # Stores the model instance by name in the repository of the model.
+    # Stores the model instance by name in the repository of the
+    # model.
     #
     # @param model [void] A model instance.
-    # @raise [Vedeu::Error::MissingRequired] When the name attribute is not
-    #   defined.
+    # @raise [Vedeu::Error::MissingRequired] When the name attribute
+    #   is not defined.
     # @return [void] The model instance which was stored.
     def store(model)
       unless present?(model.name)

data/lib/vedeu/repositories/store.rb

@@ -19,7 +19,8 @@ module Vedeu
       storage.empty?
     end
 
-    # Returns a boolean indicating whether the named model is registered.
+    # Returns a boolean indicating whether the named model is
+    # registered.
     #
     # @param name [String]
     # @return [Boolean]
@@ -30,7 +31,8 @@ module Vedeu
     end
     alias_method :registered?, :exists?
 
-    # Returns a collection of the names of all the registered entities.
+    # Returns a collection of the names of all the registered
+    # entities.
     #
     # @return [Array]
     def registered
@@ -60,8 +62,8 @@ module Vedeu
       storage.size
     end
 
-    # Return whole repository; provides raw access to the storage for this
-    # repository.
+    # Return whole repository; provides raw access to the storage for
+    # this repository.
     #
     # @return [Array|Hash|Set]
     def storage

data/lib/vedeu/runtime/bootstrap.rb

@@ -4,8 +4,9 @@ module Vedeu
 
     # Provides the mechanism to start up a generated application.
     #
-    # This class loads all necessary client application files and initializes
-    # Vedeu with this data, then starts the client application.
+    # This class loads all necessary client application files and
+    # initializes Vedeu with this data, then starts the client
+    # application.
     #
     class Bootstrap
 
@@ -23,8 +24,8 @@ module Vedeu
         @argv = argv
       end
 
-      # Loads all of the client application files so that Vedeu has access to
-      # them, then launches the client application.
+      # Loads all of the client application files so that Vedeu has
+      # access to them, then launches the client application.
       #
       # @return [void]
       def start
@@ -50,7 +51,8 @@ module Vedeu
       end
 
       # @note
-      #   config/configuration.rb is already loaded so don't load it twice
+      #   config/configuration.rb is already loaded so don't load it
+      #   twice.
       # @return [void]
       def client_configuration!
         Dir[File.join(base_path, 'config/**/*')].each do |path|

data/lib/vedeu/runtime/main_loop.rb

@@ -24,6 +24,8 @@ module Vedeu
           while @loop
             yield
 
+            Vedeu::Terminal::Buffer.render
+
             safe_exit_point!
           end
         rescue Vedeu::Error::Interrupt