vedeu 0.6.4 → 0.6.5

data/lib/vedeu/dsl/interface.rb

@@ -53,17 +53,17 @@ module Vedeu
         # registered, and also adds interface's name to list of focussable
         # interfaces.
         #
-        # @see Vedeu::Buffer
-        # @return [void]
+        # @see Vedeu::Buffers::Buffer
+        # @return [Vedeu::Buffers::Buffer]
         def add_buffers!(name)
-          Vedeu::Buffer.new(name: name).store
+          Vedeu::Buffers::Buffer.new(name: name).store
         end
 
         # Registers a new cursor for the interface unless already registered.
         #
-        # @return [void]
+        # @return [Vedeu::Cursors::Cursor]
         def add_cursor!(name)
-          Vedeu::Cursor.new(name: name).store
+          Vedeu::Cursors::Cursor.new(name: name).store
         end
 
         # Registers interface name in focus list unless already registered.
@@ -120,16 +120,16 @@ module Vedeu
       #     # ...       #    is rendered.
       #   end
       #
-      # @return [Vedeu::Cursor]
+      # @return [Vedeu::Cursors::Cursor]
       def cursor(value = true)
         boolean = value ? true : false
 
-        Vedeu::Cursor.new(name: model.name, visible: boolean).store
+        Vedeu::Cursors::Cursor.new(name: model.name, visible: boolean).store
       end
 
       # Set the cursor to visible for the interface.
       #
-      # @return [Vedeu::Cursor]
+      # @return [Vedeu::Cursors::Cursor]
       def cursor!
         cursor(true)
       end
@@ -214,7 +214,7 @@ module Vedeu
 
       # Set the cursor to invisible for the interface.
       #
-      # @return [Vedeu::Cursor]
+      # @return [Vedeu::Cursors::Cursor]
       def no_cursor!
         cursor(false)
       end

data/lib/vedeu/dsl/shared.rb

@@ -12,17 +12,17 @@ module Vedeu
       # @example
       #   Vedeu.interface 'my_interface' do
       #     border do
-      #       # ... see Vedeu::DSL::Border for DSL methods for borders.
+      #       # ... see Vedeu::Borders::DSL for DSL methods for borders.
       #     end
       #   end
       #
       # @param name [String] The name of the interface; this is already provided
       #   when we define the interface or view, setting it here is just
-      #   mirroring functionality of {Vedeu::DSL::Border.border}.
+      #   mirroring functionality of {Vedeu::Borders::DSL.border}.
       # @param block [Proc]
       # @raise [Vedeu::Error::InvalidSyntax] The required block was not given.
-      # @return [Vedeu::Border]
-      # @see Vedeu::DSL::Border
+      # @return [Vedeu::Borders::Border]
+      # @see Vedeu::Borders::DSL
       def border(name = nil, &block)
         fail Vedeu::Error::InvalidSyntax, 'block not given' unless block_given?
 
@@ -31,7 +31,7 @@ module Vedeu
         border_attrs = attributes.merge!(enabled: true,
                                          name:    model_name)
 
-        Vedeu::Border.build(border_attrs, &block).store
+        Vedeu::Borders::Border.build(border_attrs, &block).store
       end
 
       # Applies the default border to the interface.
@@ -43,7 +43,7 @@ module Vedeu
       #     # ... some code
       #   end
       #
-      # @return [Vedeu::Border]
+      # @return [Vedeu::Borders::Border]
       def border!
         border do
           # adds default border
@@ -55,23 +55,23 @@ module Vedeu
       # @example
       #   Vedeu.interface 'my_interface' do
       #     geometry do
-      #       # ... see Vedeu::DSL::Geometry for DSL methods for geometries.
+      #       # ... see Vedeu::Geometry::DSL for DSL methods for geometries.
       #     end
       #   end
       #
       # @param name [String] The name of the interface; this is already provided
       #   when we define the interface or view, setting it here is just
-      #   mirroring functionality of {Vedeu::DSL::Geometry.geometry}.
+      #   mirroring functionality of {Vedeu::Geometry::DSL.geometry}.
       # @param block [Proc]
       # @raise [Vedeu::Error::InvalidSyntax] The required block was not given.
-      # @return [Vedeu::Geometry]
-      # @see Vedeu::DSL::Geometry
+      # @return [Vedeu::Geometry::Geometry]
+      # @see Vedeu::Geometry::DSL
       def geometry(name = nil, &block)
         fail Vedeu::Error::InvalidSyntax, 'block not given' unless block_given?
 
         model_name = name ? name : model.name
 
-        Vedeu::Geometry.build(name: model_name, &block).store
+        Vedeu::Geometry::Geometry.build(name: model_name, &block).store
       end
 
     end # Shared

data/lib/vedeu/{exceptions.rb → error.rb}

@@ -1,6 +1,6 @@
 module Vedeu
 
-  # Custom exceptions which Vedeu will raise in certain circumstances.
+  # Custom exceptions/errors which Vedeu will raise in certain circumstances.
   #
   module Error
 
@@ -73,7 +73,7 @@ module Vedeu
     # Raised when trying to access an interface column less than 1 or greater
     # than 12. Vedeu is hard-wired to a 12-column layout for the time being.
     #
-    # @see Vedeu::Grid
+    # @see Vedeu::Geometry::Grid
     #
     class OutOfRange < StandardError
 

data/lib/vedeu/esc/esc.rb

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

data/lib/vedeu/geometry/all.rb

@@ -0,0 +1,18 @@
+module Vedeu
+
+  module Geometry
+
+  end # Geometry
+
+end # Vedeu
+
+require 'vedeu/geometry/area'
+require 'vedeu/geometry/coordinate'
+require 'vedeu/geometry/dimension'
+require 'vedeu/geometry/dsl'
+require 'vedeu/geometry/generic_coordinate'
+require 'vedeu/geometry/geometry'
+require 'vedeu/geometry/grid'
+require 'vedeu/geometry/null'
+require 'vedeu/geometry/position'
+require 'vedeu/geometry/repository'

data/lib/vedeu/geometry/area.rb

@@ -1,166 +1,176 @@
 module Vedeu
 
-  # Define an area from dimensions or points.
-  #
-  class Area
-
-    # @!attribute [r] y
-    # @return [Fixnum] Returns the top coordinate of the interface.
-    attr_reader :y
-    alias_method :top, :y
-
-    # @!attribute [r] yn
-    # @return [Fixnum] Returns the bottom coordinate of the interface.
-    attr_reader :yn
-    alias_method :bottom, :yn
-
-    # @!attribute [r] x
-    # @return [Fixnum] Returns the left coordinate of the interface.
-    attr_reader :x
-    alias_method :left, :x
-
-    # @!attribute [r] xn
-    # @return [Fixnum] Returns the right coordinate of the interface.
-    attr_reader :xn
-    alias_method :right, :xn
-
-    # @param attributes [Hash]
-    # @option attributes y [Fixnum]
-    # @option attributes yn [Fixnum]
-    # @option attributes y_yn [Fixnum]
-    # @option attributes y_default [Fixnum]
-    # @option attributes x [Fixnum]
-    # @option attributes xn [Fixnum]
-    # @option attributes x_xn [Fixnum]
-    # @option attributes x_default [Fixnum]
-    # @option attributes options [Hash<Symbol => Boolean>]
-    # @return [Vedeu::Area]
-    def self.from_attributes(attributes = {})
-      y_yn = Vedeu::Dimension.pair(d:         attributes[:y],
-                                   dn:        attributes[:yn],
-                                   d_dn:      attributes[:y_yn],
-                                   default:   attributes[:y_default],
-                                   maximised: attributes[:maximised],
-                                   centred:   attributes[:centred])
-      x_xn = Vedeu::Dimension.pair(d:         attributes[:x],
-                                   dn:        attributes[:xn],
-                                   d_dn:      attributes[:x_xn],
-                                   default:   attributes[:x_default],
-                                   maximised: attributes[:maximised],
-                                   centred:   attributes[:centred])
-
-      new(y: y_yn[0], yn: y_yn[-1], x: x_xn[0], xn: x_xn[-1])
-    end
-
-    # Returns a new instance of Vedeu::Area.
-    #
-    # @param y [Fixnum] The starting row/line position.
-    # @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::Area]
-    def initialize(y:, yn:, x:, xn:)
-      @y  = y
-      @yn = yn
-      @x  = x
-      @xn = xn
-    end
-
-    # An object is equal when its values are the same.
-    #
-    # @param other [Vedeu::Area]
-    # @return [Boolean]
-    def eql?(other)
-      self.class == other.class && y == other.y && yn == other.yn &&
-        x == other.x && xn == other.xn
-    end
-    alias_method :==, :eql?
-
-    # @return [Array<Fixnum>]
-    def centre
-      [centre_y, centre_x]
-    end
-
-    # @return [Fixnum]
-    def centre_y
-      (height / 2) + y
-    end
-
-    # @return [Fixnum]
-    def centre_x
-      (width / 2) + x
-    end
-
-    # @return [Fixnum]
-    def height
-      (y..yn).size
-    end
-
-    # @return [Fixnum]
-    def width
-      (x..xn).size
-    end
-
-    # Returns the row above the top by default.
-    #
-    # @example
-    #   `top` or `y` is 4.
-    #
-    #   north     # => 3
-    #   north(2)  # => 2 (positive goes north)
-    #   north(-4) # => 8 (negative goes south)
-    #
-    # @param offset [Fixnum]
-    # @return [Fixnum]
-    def north(offset = 1)
-      y - offset
-    end
-
-    # Returns the column after right by default.
-    #
-    # @example
-    #   `right` or `xn` is 19.
-    #
-    #   east     # => 20
-    #   east(2)  # => 21 (positive goes east)
-    #   east(-4) # => 15 (negative goes west)
-    #
-    # @param offset [Fixnum]
-    # @return [Fixnum]
-    def east(offset = 1)
-      xn + offset
-    end
-
-    # Returns the row below the bottom by default.
-    #
-    # @example
-    #   `bottom` or `yn` is 12.
-    #
-    #   south     # => 13
-    #   south(2)  # => 14 (positive goes south)
-    #   south(-4) # => 8  (negative goes north)
-    #
-    # @param offset [Fixnum]
-    # @return [Fixnum]
-    def south(offset = 1)
-      yn + offset
-    end
+  module Geometry
 
-    # Returns the column before left by default.
-    #
-    # @example
-    #   `left` or `x` is 8.
+    # Define an area from dimensions or points.
     #
-    #   west      # => 7
-    #   west(2)   # => 6  (positive goes west)
-    #   west(-4)  # => 12 (negative goes east)
-    #
-    # @param offset [Fixnum]
-    # @return [Fixnum]
-    def west(offset = 1)
-      x - offset
-    end
-
-  end # Area
+    class Area
+
+      # @!attribute [r] y
+      # @return [Fixnum] Returns the top coordinate of the interface.
+      attr_reader :y
+      alias_method :top, :y
+
+      # @!attribute [r] yn
+      # @return [Fixnum] Returns the bottom coordinate of the interface.
+      attr_reader :yn
+      alias_method :bottom, :yn
+
+      # @!attribute [r] x
+      # @return [Fixnum] Returns the left coordinate of the interface.
+      attr_reader :x
+      alias_method :left, :x
+
+      # @!attribute [r] xn
+      # @return [Fixnum] Returns the right coordinate of the interface.
+      attr_reader :xn
+      alias_method :right, :xn
+
+      # @param attributes [Hash]
+      # @option attributes y [Fixnum]
+      # @option attributes yn [Fixnum]
+      # @option attributes y_yn [Fixnum]
+      # @option attributes y_default [Fixnum]
+      # @option attributes x [Fixnum]
+      # @option attributes xn [Fixnum]
+      # @option attributes x_xn [Fixnum]
+      # @option attributes x_default [Fixnum]
+      # @option attributes options [Hash<Symbol => Boolean>]
+      # @return [Vedeu::Geometry::Area]
+      def self.from_attributes(attributes = {})
+        y_attributes = {
+          d:         attributes[:y],
+          dn:        attributes[:yn],
+          d_dn:      attributes[:y_yn],
+          default:   attributes[:y_default],
+          maximised: attributes[:maximised],
+          centred:   attributes[:centred],
+        }
+        x_attributes = {
+          d:         attributes[:x],
+          dn:        attributes[:xn],
+          d_dn:      attributes[:x_xn],
+          default:   attributes[:x_default],
+          maximised: attributes[:maximised],
+          centred:   attributes[:centred],
+        }
+        y_yn = Vedeu::Geometry::Dimension.pair(y_attributes)
+        x_xn = Vedeu::Geometry::Dimension.pair(x_attributes)
+
+        new(y: y_yn[0], yn: y_yn[-1], x: x_xn[0], xn: x_xn[-1])
+      end
+
+      # Returns a new instance of Vedeu::Area.
+      #
+      # @param y [Fixnum] The starting row/line position.
+      # @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]
+      def initialize(y:, yn:, x:, xn:)
+        @y  = y
+        @yn = yn
+        @x  = x
+        @xn = xn
+      end
+
+      # An object is equal when its values are the same.
+      #
+      # @param other [Vedeu::Geometry::Area]
+      # @return [Boolean]
+      def eql?(other)
+        self.class == other.class && y == other.y && yn == other.yn &&
+          x == other.x && xn == other.xn
+      end
+      alias_method :==, :eql?
+
+      # @return [Array<Fixnum>]
+      def centre
+        [centre_y, centre_x]
+      end
+
+      # @return [Fixnum]
+      def centre_y
+        (height / 2) + y
+      end
+
+      # @return [Fixnum]
+      def centre_x
+        (width / 2) + x
+      end
+
+      # @return [Fixnum]
+      def height
+        (y..yn).size
+      end
+
+      # @return [Fixnum]
+      def width
+        (x..xn).size
+      end
+
+      # Returns the row above the top by default.
+      #
+      # @example
+      #   `top` or `y` is 4.
+      #
+      #   north     # => 3
+      #   north(2)  # => 2 (positive goes north)
+      #   north(-4) # => 8 (negative goes south)
+      #
+      # @param offset [Fixnum]
+      # @return [Fixnum]
+      def north(offset = 1)
+        y - offset
+      end
+
+      # Returns the column after right by default.
+      #
+      # @example
+      #   `right` or `xn` is 19.
+      #
+      #   east     # => 20
+      #   east(2)  # => 21 (positive goes east)
+      #   east(-4) # => 15 (negative goes west)
+      #
+      # @param offset [Fixnum]
+      # @return [Fixnum]
+      def east(offset = 1)
+        xn + offset
+      end
+
+      # Returns the row below the bottom by default.
+      #
+      # @example
+      #   `bottom` or `yn` is 12.
+      #
+      #   south     # => 13
+      #   south(2)  # => 14 (positive goes south)
+      #   south(-4) # => 8  (negative goes north)
+      #
+      # @param offset [Fixnum]
+      # @return [Fixnum]
+      def south(offset = 1)
+        yn + offset
+      end
+
+      # Returns the column before left by default.
+      #
+      # @example
+      #   `left` or `x` is 8.
+      #
+      #   west      # => 7
+      #   west(2)   # => 6  (positive goes west)
+      #   west(-4)  # => 12 (negative goes east)
+      #
+      # @param offset [Fixnum]
+      # @return [Fixnum]
+      def west(offset = 1)
+        x - offset
+      end
+
+    end # Area
+
+  end # Geometry
 
 end # Vedeu