vedeu 0.6.4 → 0.6.5

data/lib/vedeu/geometry/repository.rb

@@ -0,0 +1,19 @@
+module Vedeu
+
+  module Geometry
+
+    # Allows the storing of interface/view geometry independent of the interface
+    # instance.
+    #
+    class Repository < Vedeu::Repository
+
+      singleton_class.send(:alias_method, :geometries, :repository)
+
+      null Vedeu::Geometry::Null
+      real Vedeu::Geometry::Geometry
+
+    end # Repository
+
+  end # Geometry
+
+end # Vedeu

data/lib/vedeu/input/editor/document.rb

@@ -212,7 +212,7 @@ module Vedeu
       # Retrieve the dimensions of the document from the interface of the same
       # name.
       #
-      # @return [Vedeu::Border]
+      # @return [Vedeu::Borders::Border]
       def border
         @border ||= Vedeu.borders.by_name(name)
       end
@@ -249,7 +249,7 @@ module Vedeu
         output = ''
 
         visible.each_with_index do |line, y_index|
-          output << Vedeu::Position.new((by + y_index), bx).to_s
+          output << Vedeu::Geometry::Position.new((by + y_index), bx).to_s
           output << line.to_s
         end
 

data/lib/vedeu/internal_api.rb

@@ -25,8 +25,8 @@ module Vedeu
     #   Vedeu.borders
     #
     # @!method borders
-    # @return [Vedeu::Borders]
-    def_delegators Vedeu::Borders, :borders
+    # @return [Vedeu::Borders::Repository]
+    def_delegators Vedeu::Borders::Repository, :borders
 
     # Manipulate the repository of buffers.
     #
@@ -34,8 +34,8 @@ module Vedeu
     #   Vedeu.buffers
     #
     # @!method buffers
-    # @return [Vedeu::Buffers]
-    def_delegators Vedeu::Buffers, :buffers
+    # @return [Vedeu::Buffers::Repository]
+    def_delegators Vedeu::Buffers::Repository, :buffers
 
     # Manipulate the repository of cursors.
     #
@@ -43,8 +43,8 @@ module Vedeu
     #   Vedeu.cursors
     #
     # @!method cursors
-    # @return [Vedeu::Cursors]
-    def_delegators Vedeu::Cursors, :cursors
+    # @return [Vedeu::Cursors::Repository]
+    def_delegators Vedeu::Cursors::Repository, :cursors
 
     # Allow debugging via the creation of stack traces courtesy of ruby-prof.
     #
@@ -88,8 +88,8 @@ module Vedeu
     #   Vedeu.geometries
     #
     # @!method geometries
-    # @return [Vedeu::Geometries]
-    def_delegators Vedeu::Geometries, :geometries
+    # @return [Vedeu::Geometry::Repository]
+    def_delegators Vedeu::Geometry::Repository, :geometries
 
     # Manipulate the repository of groups.
     #

data/lib/vedeu/models/escape.rb

@@ -11,7 +11,7 @@ module Vedeu
     # Returns a new instance of Vedeu::Escape.
     #
     # @param attributes [String]
-    # @option attributes position [Vedeu::Position|Array<Fixnum>]
+    # @option attributes position [Vedeu::Geometry::Position|Array<Fixnum>]
     # @option attributes value [String]
     # @return [Vedeu::Escape]
     def initialize(attributes = {})
@@ -40,7 +40,7 @@ module Vedeu
 
     # @return [String]
     def position
-      Vedeu::Position.coerce(@position)
+      Vedeu::Geometry::Position.coerce(@position)
     end
 
     # @return [String]

data/lib/vedeu/models/interface.rb

@@ -1,7 +1,7 @@
 module Vedeu
 
   # An Interface represents a portion of the terminal defined by
-  # {Vedeu::Geometry}.
+  # {Vedeu::Geometry::Geometry}.
   #
   class Interface
 

data/lib/vedeu/models/page.rb

@@ -0,0 +1,89 @@
+module Vedeu
+
+  # A Page represents an array of Vedeu::Row objects.
+  #
+  class Page
+
+    include Enumerable
+
+    # @!attribute [r] rows
+    # @return [Array<NilClass|Vedeu::Row>]
+    attr_reader :rows
+
+    # @param value [Vedeu::Page|Vedeu::Row|Array<void>|void]
+    # @return [Vedeu::Page]
+    def self.coerce(value)
+      if value.is_a?(Vedeu::Page)
+        value
+
+      elsif value.is_a?(Vedeu::Row)
+        Vedeu::Page.new([value])
+
+      elsif value.is_a?(Array) && value.empty?
+        Vedeu::Page.new([Vedeu::Row.coerce(value)])
+
+      elsif value.is_a?(Array)
+        values = value.map do |v|
+          if v.is_a?(Vedeu::Row)
+            v
+
+          else
+            Vedeu::Row.coerce(v)
+
+          end
+        end
+        Vedeu::Page.new(values)
+
+      else
+        fail Vedeu::Error::InvalidSyntax,
+             'Cannot coerce as value is not an Array.'
+
+      end
+    end
+
+    # Returns an instance of Vedeu::Page.
+    #
+    # @param rows [Array<NilClass|Vedeu::Row>]
+    # @return [Vedeu::Page]
+    def initialize(rows = [])
+      @rows = rows || []
+    end
+
+    # Provides iteration over the collection.
+    #
+    # @param block [Proc]
+    # @return [Enumerator]
+    def each(&block)
+      rows.each(&block)
+    end
+
+    # An object is equal when its values are the same.
+    #
+    # @param other [Vedeu::Page]
+    # @return [Boolean]
+    def eql?(other)
+      self.class == other.class && rows == other.rows
+    end
+    alias_method :==, :eql?
+
+    # @param index [Fixnum]
+    # @return [NilClass|Vedeu::Row]
+    def row(index = nil)
+      return nil if index.nil?
+
+      rows[index]
+    end
+
+    # @param row_index [Fixnum]
+    # @param cell_index [Fixnum]
+    # @return [NilClass|void]
+    def cell(row_index = nil, cell_index = nil)
+      return nil if row_index.nil? || cell_index.nil?
+      return nil unless row(row_index)
+
+      row(row_index)[cell_index]
+    end
+
+  end # Page
+
+end # Vedeu

data/lib/vedeu/models/row.rb

@@ -0,0 +1,66 @@
+module Vedeu
+
+  # A Row represents an array of Vedeu::Cell objects.
+  #
+  class Row
+
+    include Enumerable
+
+    # @!attribute [r] cells
+    # @return [Array<NilClass|void>]
+    attr_reader :cells
+
+    # @param value [Vedeu::Row|Array<void>|void]
+    # @return [Vedeu::Row]
+    def self.coerce(value)
+      if value.is_a?(self)
+        value
+
+      elsif value.is_a?(Array)
+        new(value.compact)
+
+      elsif value.nil?
+        new
+
+      else
+        new([value])
+
+      end
+    end
+
+    # Returns an instance of Vedeu::Row.
+    #
+    # @param cells [Array<NilClass|void>]
+    # @return [Vedeu::Row]
+    def initialize(cells = [])
+      @cells = cells || []
+    end
+
+    # Provides iteration over the collection.
+    #
+    # @param block [Proc]
+    # @return [Enumerator]
+    def each(&block)
+      cells.each(&block)
+    end
+
+    # An object is equal when its values are the same.
+    #
+    # @param other [Vedeu::Row]
+    # @return [Boolean]
+    def eql?(other)
+      self.class == other.class && cells == other.cells
+    end
+    alias_method :==, :eql?
+
+    # @param index [Fixnum]
+    # @return [NilClass|void]
+    def cell(index)
+      return nil if index.nil?
+
+      cells[index]
+    end
+
+  end # Row
+
+end # Vedeu

data/lib/vedeu/models/toggleable.rb

@@ -3,7 +3,7 @@ module Vedeu
   # This module provides behaviour for certain classes which can be toggled
   # between being shown and hidden.
   #
-  # Currently using this are: {Vedeu::Cursor}, {Vedeu::Group} and
+  # Currently using this are: {Vedeu::Cursors::Cursor}, {Vedeu::Group} and
   # {Vedeu::Interface}.
   #
   module Toggleable

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

@@ -36,7 +36,7 @@ module Vedeu
       #   border 'piece' this Vedeu::Views::Char represents.
       # @option attributes colour [Vedeu::Colours::Colour]
       # @option attributes parent [Vedeu::Views::Line]
-      # @option attributes position [Vedeu::Position]
+      # @option attributes position [Vedeu::Geometry::Position]
       # @option attributes style [Vedeu::Style]
       # @option attributes value [String]
       # @return [Vedeu::Views::Char]
@@ -68,17 +68,18 @@ module Vedeu
       end
       alias_method :==, :eql?
 
-      # @return [Vedeu::Position]
+      # @return [Vedeu::Geometry::Position]
       def position
-        @position = Vedeu::Position.coerce(@attributes[:position])
+        @position = Vedeu::Geometry::Position.coerce(@attributes[:position])
       end
 
       # Sets the position of the Vedeu::Views::Char.
       #
-      # @param value [Vedeu::Position]
-      # @return [Vedeu::Position]
+      # @param value [Vedeu::Geometry::Position]
+      # @return [Vedeu::Geometry::Position]
       def position=(value)
-        @position = @attributes[:position] = Vedeu::Position.coerce(value)
+        @position = @attributes[:position] = Vedeu::Geometry::Position
+                                             .coerce(value)
       end
 
       # @return [String]

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

@@ -4,7 +4,7 @@ module Vedeu
 
     # 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} it belongs to.
+    # {Vedeu::Geometry::Geometry} it belongs to.
     #
     class Line
 

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

@@ -74,11 +74,11 @@ module Vedeu
         return [] unless visible?
 
         output = [
-          Vedeu::Cursor.hide_cursor(name),
+          Vedeu::Cursors::Cursor.hide_cursor(name),
           Vedeu::Clear::NamedInterface.render(name),
           Vedeu::Viewport.render(self),
           Vedeu.borders.by_name(name).render,
-          Vedeu::Cursor.show_cursor(name),
+          Vedeu::Cursors::Cursor.show_cursor(name),
         ]
 
         output

data/lib/vedeu/options.rb

@@ -0,0 +1,19 @@
+module Vedeu
+
+  class Options
+
+    # @param options [Hash]
+    # @param defaults [Hash]
+    def initialize(options = {}, defaults = {})
+      @options  = options  || {}
+      @defaults = defaults || {}
+
+      @defaults.merge!(@options).each do |key, value|
+        instance_variable_set("@#{key}", value)
+        self.class.send(:define_method, key) { value }
+      end
+    end
+
+  end # Options
+
+end # Vedeu

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

@@ -41,7 +41,7 @@ module Vedeu
 
       private
 
-      # @see Vedeu::Geometries#by_name
+      # @see Vedeu::Geometry::Repository#by_name
       def geometry
         @geometry ||= Vedeu.geometries.by_name(name)
       end

data/lib/vedeu/output/direct.rb

@@ -54,7 +54,7 @@ module Vedeu
 
     # @return [String]
     def position
-      Vedeu::Position.new(y, x).to_s
+      Vedeu::Geometry::Position.new(y, x).to_s
     end
 
   end # Direct

data/lib/vedeu/output/presentation.rb

@@ -33,7 +33,8 @@ module Vedeu
 
     # @return [String]
     def render_position
-      if self.respond_to?(:position) && position.is_a?(Vedeu::Position)
+      if self.respond_to?(:position) &&
+         position.is_a?(Vedeu::Geometry::Position)
         position.to_s { yield }
 
       else

data/lib/vedeu/output/viewport.rb

@@ -140,7 +140,7 @@ module Vedeu
 
     # Return the border associated with the interface/view we are drawing.
     #
-    # @return (see Vedeu::Borders#by_name)
+    # @return (see Vedeu::Borders::Repository#by_name)
     def border
       @border ||= Vedeu.borders.by_name(name)
     end
@@ -155,8 +155,8 @@ module Vedeu
       @by ||= border.by
     end
 
-    # @return [Vedeu::Cursor]
-    # @see Vedeu::Cursors#by_name
+    # @return [Vedeu::Cursors::Cursor]
+    # @see Vedeu::Cursors::Repository#by_name
     def cursor
       @cursor ||= Vedeu.cursors.by_name(name)
     end

data/lib/vedeu/repositories/model.rb

@@ -109,7 +109,15 @@ module Vedeu
     #
     # @return [String]
     def dsl_class
-      'Vedeu::DSL::' + demodulize(self.class.name)
+      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'
+      else
+        'Vedeu::DSL::' + demodulize(self.class.name)
+      end
     end
 
   end # Model

data/lib/vedeu/repositories/repository.rb

@@ -113,6 +113,11 @@ module Vedeu
       end
     end
 
+    # @return [String]
+    def inspect
+      "<#{self.class.name}>"
+    end
+
     # Returns a boolean indicating whether the named model is registered.
     #
     # @param name [String]

data/lib/vedeu/terminal/terminal.rb

@@ -183,9 +183,9 @@ module Vedeu
     #   terminal space up when defining interfaces or views, leading to more
     #   consistent rendering.
     #
-    #   If the client application is using the {Vedeu::Grid#rows} or
-    #   {Vedeu::Grid#columns} helpers, the dimensions are made more consistent
-    #   using this approach.
+    #   If the client application is using the {Vedeu::Geometry::Grid#rows} or
+    #   {Vedeu::Geometry::Grid#columns} helpers, the dimensions are made more
+    #   consistent using this approach.
     #
     # @return [Array]
     def size