vedeu 0.6.60 → 0.6.61

data/lib/vedeu/esc/esc.rb

@@ -119,7 +119,7 @@ module Vedeu
 
       # @return [String]
       def last_character_position
-        Vedeu::Geometry::Position[Vedeu.height, Vedeu.width].to_s
+        Vedeu::Geometries::Position[Vedeu.height, Vedeu.width].to_s
       end
 
     end # Esc

data/lib/vedeu/events/aliases.rb

@@ -69,10 +69,10 @@ module Vedeu
       alias_method :remove, :unbind_alias
 
       # @return [Hash<Symbol => Array<Symbol>>]
-      def reset
+      def reset!
         @storage = in_memory
       end
-      alias_method :reset!, :reset
+      alias_method :reset, :reset!
 
       # Access to the storage for this repository.
       #

data/lib/vedeu/{geometry → geometries}/alignment.rb

@@ -1,14 +1,14 @@
 module Vedeu
 
-  module Geometry
+  module Geometries
 
     # The subclasses of this class, HorizontalAlignment and
     # VerticalAlignment provide the mechanism to align an interface or
     # view horizontally or vertically within the available terminal
     # space.
     #
-    # @see Vedeu::Geometry::HorizontalAlignment
-    # @see Vedeu::Geometry::VerticalAlignment
+    # @see Vedeu::Geometries::HorizontalAlignment
+    # @see Vedeu::Geometries::VerticalAlignment
     #
     # @api private
     #
@@ -20,8 +20,8 @@ module Vedeu
         new(value).align
       end
 
-      # @param value [NilClass|Symbol|Vedeu::Geometry::Alignment]
-      # @return [Vedeu::Geometry::Alignment]
+      # @param value [NilClass|Symbol|Vedeu::Geometries::Alignment]
+      # @return [Vedeu::Geometries::Alignment]
       def self.coerce(value = nil)
         if value.is_a?(self)
           value
@@ -35,10 +35,10 @@ module Vedeu
         end
       end
 
-      # Returns a new instance of Vedeu::Geometry::Alignment.
+      # Returns a new instance of Vedeu::Geometries::Alignment.
       #
       # @param value [NilClass|Symbol]
-      # @return [Vedeu::Geometry::Alignment]
+      # @return [Vedeu::Geometries::Alignment]
       def initialize(value = nil)
         @value = value
       end
@@ -139,6 +139,6 @@ module Vedeu
 
     end # Alignment
 
-  end # Geometry
+  end # Geometries
 
 end # Vedeu

data/lib/vedeu/geometries/all.rb

@@ -0,0 +1,31 @@
+module Vedeu
+
+  # The Geometry group of classes all handle the size of interfaces in
+  # relation to the current size of the terminal. This helps Vedeu to
+  # draw content in a consistent way.
+  #
+  # You can define the geometry of your interfaces using the
+  # {Vedeu::Geometries::DSL}.
+  #
+  module Geometries
+
+  end # Geometries
+
+end # Vedeu
+
+require 'vedeu/geometries/alignment'
+require 'vedeu/geometries/horizontal_alignment'
+require 'vedeu/geometries/vertical_alignment'
+require 'vedeu/geometries/area'
+require 'vedeu/geometries/coordinate'
+require 'vedeu/geometries/dimension'
+require 'vedeu/geometries/x_dimension'
+require 'vedeu/geometries/y_dimension'
+require 'vedeu/geometries/validator'
+require 'vedeu/geometries/dsl'
+require 'vedeu/geometries/coordinate'
+require 'vedeu/geometries/geometry'
+require 'vedeu/geometries/grid'
+require 'vedeu/geometries/move'
+require 'vedeu/geometries/position'
+require 'vedeu/geometries/repository'

data/lib/vedeu/{geometry → geometries}/area.rb

@@ -1,6 +1,6 @@
 module Vedeu
 
-  module Geometry
+  module Geometries
 
     # Define an area from dimensions or points.
     #
@@ -54,7 +54,7 @@ module Vedeu
       # @option attributes yn [Fixnum]
       # @option attributes y_yn [Fixnum]
       # @option attributes y_default [Fixnum]
-      # @return [Vedeu::Geometry::Area]
+      # @return [Vedeu::Geometries::Area]
       def self.from_attributes(attributes = {})
         y_attributes = {
           alignment: attributes[:vertical_alignment],
@@ -70,8 +70,8 @@ module Vedeu
           d_dn:      attributes[:x_xn],
           maximised: attributes[:maximised],
         }
-        y_yn = Vedeu::Geometry::YDimension.pair(y_attributes)
-        x_xn = Vedeu::Geometry::XDimension.pair(x_attributes)
+        y_yn = Vedeu::Geometries::YDimension.pair(y_attributes)
+        x_xn = Vedeu::Geometries::XDimension.pair(x_attributes)
 
         new(name: attributes[:name],
             y:    y_yn[0],
@@ -87,7 +87,7 @@ module Vedeu
       # @param yn [Fixnum] The ending row/line position.
       # @param x [Fixnum] The starting column/character position.
       # @param xn [Fixnum] The ending column/character position.
-      # @return [Vedeu::Geometry::Area]
+      # @return [Vedeu::Geometries::Area]
       def initialize(name:, y:, yn:, x:, xn:)
         @name = name
         @y    = y
@@ -98,7 +98,7 @@ module Vedeu
 
       # An object is equal when its values are the same.
       #
-      # @param other [Vedeu::Geometry::Area]
+      # @param other [Vedeu::Geometries::Area]
       # @return [Boolean]
       def eql?(other)
         self.class == other.class && y == other.y && yn == other.yn &&
@@ -262,11 +262,11 @@ module Vedeu
 
       # @return [Vedeu::Borders::Border]
       def border
-        @border = Vedeu.borders.by_name(name)
+        @_border ||= Vedeu.borders.by_name(name)
       end
 
     end # Area
 
-  end # Geometry
+  end # Geometries
 
 end # Vedeu

data/lib/vedeu/{geometry → geometries}/coordinate.rb

@@ -1,6 +1,6 @@
 module Vedeu
 
-  module Geometry
+  module Geometries
 
     # Crudely corrects out of range values.
     #
@@ -8,13 +8,13 @@ module Vedeu
     #
     class Coordinate
 
-      # Return a new instance of Vedeu::Geometry::Coordinate.
+      # Return a new instance of Vedeu::Geometries::Coordinate.
       #
       # @param attributes [Hash<Symbol => Fixnum|String|Symbol>]
       # @option attributes name [String|Symbol]
       # @option attributes type [Symbol]
       # @option attributes offset [Fixnum]
-      # @return [Vedeu::Geometry::Coordinate]
+      # @return [Vedeu::Geometries::Coordinate]
       def initialize(attributes = {})
         defaults.merge!(attributes).each do |key, value|
           instance_variable_set("@#{key}", value)
@@ -84,7 +84,7 @@ module Vedeu
 
       # Returns the geometry for the interface.
       #
-      # @return (see Vedeu::Geometry::Repository#by_name)
+      # @return (see Vedeu::Geometries::Repository#by_name)
       def geometry
         @geometry ||= Vedeu.geometries.by_name(name)
       end
@@ -172,6 +172,6 @@ module Vedeu
 
     end # Coordinate
 
-  end # Geometry
+  end # Geometries
 
 end # Vedeu

data/lib/vedeu/{geometry → geometries}/dimension.rb

@@ -1,6 +1,6 @@
 module Vedeu
 
-  module Geometry
+  module Geometries
 
     # A Dimension is either the height or width of an entity.
     #
@@ -25,7 +25,7 @@ module Vedeu
         new(attributes).pair
       end
 
-      # Returns a new instance of Vedeu::Geometry::Dimension.
+      # Returns a new instance of Vedeu::Geometries::Dimension.
       #
       # @param attributes [Hash<Symbol => Fixnum, NilClass>]
       # @option attributes alignment [Symbol]
@@ -37,7 +37,7 @@ module Vedeu
       # @option attributes default [Fixnum|NilClass]
       #   The terminal width or height.
       # @option attributes maximised [Boolean]
-      # @return [Vedeu::Geometry::Dimension]
+      # @return [Vedeu::Geometries::Dimension]
       def initialize(attributes = {})
         defaults.merge!(attributes).each do |key, value|
           instance_variable_set("@#{key}", value)
@@ -76,9 +76,9 @@ module Vedeu
 
       private
 
-      # @return [Vedeu::Geometry::Alignment]
+      # @return [Vedeu::Geometries::Alignment]
       def alignment
-        Vedeu::Geometry::Alignment.coerce(@alignment)
+        Vedeu::Geometries::Alignment.coerce(@alignment)
       end
 
       # Return the dimension.
@@ -257,6 +257,6 @@ module Vedeu
 
     end # Dimension
 
-  end # Geometry
+  end # Geometries
 
 end # Vedeu

data/lib/vedeu/{geometry → geometries}/dsl.rb

@@ -1,6 +1,6 @@
 module Vedeu
 
-  module Geometry
+  module Geometries
 
     # Geometry allows the configuration of the position and size of an
     # interface. Within Vedeu, as the same for ANSI terminals, has the
@@ -76,7 +76,7 @@ module Vedeu
       include Vedeu::Common
       include Vedeu::DSL
       include Vedeu::DSL::Use
-      include Vedeu::Geometry::Validator
+      include Vedeu::Geometries::Validator
 
       # Specify the geometry of an interface or view with a simple
       # DSL.
@@ -89,11 +89,11 @@ module Vedeu
       #   to which this geometry belongs.
       # @param block [Proc]
       # @raise [Vedeu::Error::RequiresBlock]
-      # @return [Vedeu::Geometry::Geometry]
+      # @return [Vedeu::Geometries::Geometry]
       def self.geometry(name, &block)
         fail Vedeu::Error::RequiresBlock unless block_given?
 
-        Vedeu::Geometry::Geometry.build(name: name, &block).store
+        Vedeu::Geometries::Geometry.build(name: name, &block).store
       end
 
       # Instructs Vedeu to align the interface/view either left,
@@ -114,7 +114,7 @@ module Vedeu
       # @param width [Fixnum] The width of the aligned interface/view.
       # @raise [Vedeu::Error::InvalidSyntax] When the value or width
       #   is not given.
-      # @return [Vedeu::Geometry::Geometry]
+      # @return [Vedeu::Geometries::Geometry]
       # def alignment(value, width)
       #   fail Vedeu::Error::InvalidSyntax,
       #        'No alignment given. Valid values are :center, :centre, ' \
@@ -122,7 +122,7 @@ module Vedeu
       #   fail Vedeu::Error::InvalidSyntax,
       #        'No width given.'.freeze unless present?(width)
 
-      #   model.alignment = Vedeu::Geometry::Alignment.align(value)
+      #   model.alignment = Vedeu::Geometries::Alignment.align(value)
       #   model.width     = width
       #   model
       # end
@@ -146,7 +146,7 @@ module Vedeu
       #     is not given.
       #   - When the vertical is given (and not :none) and the height
       #     is not given.
-      # @return [Vedeu::Geometry::Geometry]
+      # @return [Vedeu::Geometries::Geometry]
       def align(vertical, horizontal, width, height)
         validate_vertical_alignment!(vertical)
         validate_horizontal_alignment!(horizontal)
@@ -160,12 +160,12 @@ module Vedeu
       # @param value [Symbol] One of :center, :centre, :left, :none,
       #   :right.
       # @param width [Fixnum] The number of characters/columns.
-      # @return [Vedeu::Geometry::Geometry]
+      # @return [Vedeu::Geometries::Geometry]
       def horizontal_alignment(value, width)
         validate_horizontal_alignment!(value)
         validate_width!(width)
 
-        model.horizontal_alignment = Vedeu::Geometry::HorizontalAlignment
+        model.horizontal_alignment = Vedeu::Geometries::HorizontalAlignment
           .coerce(value)
         model.width = width
         model
@@ -173,12 +173,12 @@ module Vedeu
 
       # @param value [Symbol] One of :bottom, :middle, :none, :top.
       # @param height [Fixnum] The number of lines/rows.
-      # @return [Vedeu::Geometry::Geometry]
+      # @return [Vedeu::Geometries::Geometry]
       def vertical_alignment(value, height)
         validate_vertical_alignment!(value)
         validate_height!(height)
 
-        model.vertical_alignment = Vedeu::Geometry::VerticalAlignment
+        model.vertical_alignment = Vedeu::Geometries::VerticalAlignment
           .coerce(value)
         model.height = height
         model
@@ -207,7 +207,7 @@ module Vedeu
       # @param height [Fixnum] The number of lines/rows.
       # @raise [Vedeu::Error::InvalidSyntax] When the height is not
       #   given.
-      # @return [Vedeu::Geometry::Geometry]
+      # @return [Vedeu::Geometries::Geometry]
       def align_bottom(height)
         vertical_alignment(:bottom, height)
       end
@@ -236,7 +236,7 @@ module Vedeu
       # @param width [Fixnum] The number of characters/columns.
       # @raise [Vedeu::Error::InvalidSyntax] When the width is not
       #   given.
-      # @return [Vedeu::Geometry::Geometry]
+      # @return [Vedeu::Geometries::Geometry]
       def align_centre(width)
         horizontal_alignment(:centre, width)
       end
@@ -264,7 +264,7 @@ module Vedeu
       # @param width [Fixnum] The number of characters/columns.
       # @raise [Vedeu::Error::InvalidSyntax] When the width is not
       #   given.
-      # @return [Vedeu::Geometry::Geometry]
+      # @return [Vedeu::Geometries::Geometry]
       def align_left(width)
         horizontal_alignment(:left, width)
       end
@@ -292,7 +292,7 @@ module Vedeu
       # @param height [Fixnum] The number of lines/rows.
       # @raise [Vedeu::Error::InvalidSyntax] When the height is not
       #   given.
-      # @return [Vedeu::Geometry::Geometry]
+      # @return [Vedeu::Geometries::Geometry]
       def align_middle(height)
         vertical_alignment(:middle, height)
       end
@@ -319,7 +319,7 @@ module Vedeu
       # @param width [Fixnum] The number of characters/columns.
       # @raise [Vedeu::Error::InvalidSyntax] When the width is not
       #   given.
-      # @return [Vedeu::Geometry::Geometry]
+      # @return [Vedeu::Geometries::Geometry]
       def align_right(width)
         horizontal_alignment(:right, width)
       end
@@ -347,7 +347,7 @@ module Vedeu
       # @param height [Fixnum] The number of lines/rows.
       # @raise [Vedeu::Error::InvalidSyntax] When the height is not
       #   given.
-      # @return [Vedeu::Geometry::Geometry]
+      # @return [Vedeu::Geometries::Geometry]
       def align_top(height)
         vertical_alignment(:top, height)
       end
@@ -368,7 +368,7 @@ module Vedeu
       #   not between 1 and 12 inclusive.
       # @return [Fixnum|Vedeu::Error::OutOfRange]
       def columns(value)
-        Vedeu::Geometry::Grid.columns(value)
+        Vedeu::Geometries::Grid.columns(value)
       end
 
       # Specify the number of characters/rows/lines tall the interface
@@ -402,7 +402,7 @@ module Vedeu
       #   not between 1 and 12 inclusive.
       # @return [Fixnum]
       def rows(value)
-        Vedeu::Geometry::Grid.rows(value)
+        Vedeu::Geometries::Grid.rows(value)
       end
 
       # Specify the number of characters/columns wide the interface
@@ -508,11 +508,11 @@ module Vedeu
 
     end # DSL
 
-  end # Geometry
+  end # Geometries
 
   # @!method geometry
-  #   @see Vedeu::Geometry::DSL.geometry
-  def_delegators Vedeu::Geometry::DSL,
+  #   @see Vedeu::Geometries::DSL.geometry
+  def_delegators Vedeu::Geometries::DSL,
                  :geometry
 
 end # Vedeu

data/lib/vedeu/{geometry → geometries}/geometry.rb

@@ -1,6 +1,6 @@
 module Vedeu
 
-  module Geometry
+  module Geometries
 
     # @todo Consider storing the Terminal size at the time of first
     # creation, this allows us to return the interface to its original
@@ -88,22 +88,22 @@ module Vedeu
         new(attributes).store(&block)
       end
 
-      # Returns a new instance of Vedeu::Geometry::Geometry.
+      # Returns a new instance of Vedeu::Geometries::Geometry.
       #
       # @param attributes [Hash<Symbol => Boolean|Fixnum|String|
-      #   Symbol|Vedeu::Geometry::Repository]
+      #   Symbol|Vedeu::Geometries::Repository]
       # @option attributes horizontal_alignment [Symbol]
       # @option attributes vertical_alignment [Symbol]
       # @option attributes maximised [Boolean]
       # @option attributes height [Fixnum]
       # @option attributes name [String|Symbol]
-      # @option attributes repository [Vedeu::Geometry::Repository]
+      # @option attributes repository [Vedeu::Geometries::Repository]
       # @option attributes width [Fixnum]
       # @option attributes x [Fixnum]
       # @option attributes xn [Fixnum]
       # @option attributes y [Fixnum]
       # @option attributes yn [Fixnum]
-      # @return [Vedeu::Geometry::Geometry]
+      # @return [Vedeu::Geometries::Geometry]
       def initialize(attributes = {})
         defaults.merge!(attributes).each do |key, value|
           instance_variable_set("@#{key}", value)
@@ -111,7 +111,7 @@ module Vedeu
       end
 
       # @return [Hash<Symbol => Boolean|Fixnum|String|Symbol|
-      #   Vedeu::Geometry::Repository]
+      #   Vedeu::Geometries::Repository]
       def attributes
         {
           client:               @client,
@@ -136,15 +136,15 @@ module Vedeu
       #   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 [Vedeu::Geometry::DSL] The DSL instance for this
+      # @return [Vedeu::Geometries::DSL] The DSL instance for this
       #   model.
       def deputy(client = nil)
-        Vedeu::Geometry::DSL.new(self, client)
+        Vedeu::Geometries::DSL.new(self, client)
       end
 
       # An object is equal when its values are the same.
       #
-      # @param other [Vedeu::Geometry::Geometry]
+      # @param other [Vedeu::Geometries::Geometry]
       # @return [Boolean]
       def eql?(other)
         self.class == other.class && name == other.name
@@ -157,7 +157,7 @@ module Vedeu
       # @example
       #   Vedeu.trigger(:_maximise_, name)
       #
-      # @return [Vedeu::Geometry::Geometry|NilClass]
+      # @return [Vedeu::Geometries::Geometry|NilClass]
       def maximise
         return self if maximised?
 
@@ -178,7 +178,7 @@ module Vedeu
       # @example
       #   Vedeu.trigger(:_unmaximise_, name)
       #
-      # @return [Vedeu::Geometry::Geometry|NilClass]
+      # @return [Vedeu::Geometries::Geometry|NilClass]
       def unmaximise
         return self unless maximised?
 
@@ -193,9 +193,9 @@ module Vedeu
 
       private
 
-      # @return [Vedeu::Geometry::Area]
+      # @return [Vedeu::Geometries::Area]
       def area
-        @area = Vedeu::Geometry::Area.from_attributes(area_attributes)
+        @area = Vedeu::Geometries::Area.from_attributes(area_attributes)
       end
 
       # @return [Hash<Symbol => Boolean|Fixnum>]
@@ -217,7 +217,7 @@ module Vedeu
       # Returns the default options/attributes for this class.
       #
       # @return [Hash<Symbol => Boolean|Fixnum|NilClass|String|Symbol|
-      #   Vedeu::Geometry::Repository]
+      #   Vedeu::Geometries::Repository]
       def defaults
         {
           client:               nil,
@@ -237,6 +237,6 @@ module Vedeu
 
     end # Geometry
 
-  end # Geometry
+  end # Geometries
 
 end # Vedeu