vedeu 0.6.4 → 0.6.5

data/lib/vedeu/geometry/coordinate.rb

@@ -1,49 +1,71 @@
 module Vedeu
 
-  # Crudely corrects out of range values.
-  #
-  class Coordinate
+  module Geometry
 
-    extend Forwardable
+    # Crudely corrects out of range values.
+    #
+    class Coordinate
 
-    def_delegators :x,
-                   :x_position,
-                   :xn
+      extend Forwardable
 
-    def_delegators :y,
-                   :y_position,
-                   :yn
+      def_delegators :x,
+                     :x_position,
+                     :xn
 
-    # Returns a new instance of Vedeu::Coordinate.
-    #
-    # @param name [String]
-    # @param oy [Fixnum]
-    # @param ox [Fixnum]
-    # @return [Vedeu::Coordinate]
-    def initialize(name, oy, ox)
-      @name = name
-      @ox   = ox
-      @oy   = oy
-    end
-
-    private
-
-    # Provide an instance of Vedeu::GenericCoordinate to determine correct x
-    # related coordinates.
-    #
-    # @return [Vedeu::GenericCoordinate]
-    def x
-      @x ||= Vedeu::GenericCoordinate.new(name: @name, offset: @ox, type: :x)
-    end
+      def_delegators :y,
+                     :y_position,
+                     :yn
 
-    # Provide an instance of Vedeu::GenericCoordinate to determine correct y
-    # related coordinates.
-    #
-    # @return [Vedeu::GenericCoordinate]
-    def y
-      @y ||= Vedeu::GenericCoordinate.new(name: @name, offset: @oy, type: :y)
-    end
+      # Returns a new instance of Vedeu::Geometry::Coordinate.
+      #
+      # @param name [String]
+      # @param oy [Fixnum]
+      # @param ox [Fixnum]
+      # @return [Vedeu::Geometry::Coordinate]
+      def initialize(name, oy, ox)
+        @name = name
+        @ox   = ox
+        @oy   = oy
+      end
+
+      protected
+
+      # @!attribute [r] name
+      # @return [String]
+      attr_reader :name
+
+      # @!attribute [rw] ox
+      # @return [Fixnum]
+      attr_accessor :ox
+
+      # @!attribute [rw] oy
+      # @return [Fixnum]
+      attr_accessor :oy
+
+      private
+
+      # Provide an instance of Vedeu::Geometry::GenericCoordinate to determine
+      # correct x related coordinates.
+      #
+      # @return [Vedeu::Geometry::GenericCoordinate]
+      def x
+        @x ||= Vedeu::Geometry::GenericCoordinate.new(name:   name,
+                                                      offset: ox,
+                                                      type:   :x)
+      end
+
+      # Provide an instance of Vedeu::Geometry::GenericCoordinate to determine
+      # correct y related coordinates.
+      #
+      # @return [Vedeu::Geometry::GenericCoordinate]
+      def y
+        @y ||= Vedeu::Geometry::GenericCoordinate.new(name:   name,
+                                                      offset: oy,
+                                                      type:   :y)
+      end
+
+    end # Coordinate
 
-  end # Coordinate
+  end # Geometry
 
 end # Vedeu

data/lib/vedeu/geometry/dimension.rb

@@ -1,168 +1,175 @@
 module Vedeu
 
-  # A Dimension is either the height or width of an entity.
-  #
-  class Dimension
+  module Geometry
 
-    # @param (see #initialize)
-    # @return [Array<Fixnum>]
-    def self.pair(attributes = {})
-      new(attributes).pair
-    end
-
-    # Returns a new instance of Vedeu::Dimension.
-    #
-    # @param attributes [Hash<Symbol => Fixnum, NilClass>]
-    # @option attributes d [Fixnum|NilClass] The starting value (y or x).
-    # @option attributes dn [Fixnum|NilClass] The ending value (yn or xn).
-    # @option attributes d_dn [Fixnum|NilClass] A width or a height.
-    # @option attributes default [Fixnum|NilClass] The terminal width or height.
-    # @option attributes options [Hash]
-    # @return [Vedeu::Dimension]
-    def initialize(attributes = {})
-      @attributes = defaults.merge!(attributes)
-
-      @attributes.each { |key, value| instance_variable_set("@#{key}", value) }
-    end
-
-    # Fetch the starting coordinate.
+    # A Dimension is either the height or width of an entity.
     #
-    # @return [Fixnum]
-    def d1
-      dimension[0] < 1 ? 1 : dimension[0]
-    end
+    class Dimension
 
-    # Fetch the ending coordinate.
-    #
-    # @return [Fixnum]
-    def d2
-      dimension[-1]
-    end
+      # @param (see #initialize)
+      # @return [Array<Fixnum>]
+      def self.pair(attributes = {})
+        new(attributes).pair
+      end
 
-    # Fetch the coordinates.
-    #
-    # @return [Array<Fixnum>]
-    def pair
-      dimension
-    end
+      # Returns a new instance of Vedeu::Geometry::Dimension.
+      #
+      # @param attributes [Hash<Symbol => Fixnum, NilClass>]
+      # @option attributes d [Fixnum|NilClass] The starting value (y or x).
+      # @option attributes dn [Fixnum|NilClass] The ending value (yn or xn).
+      # @option attributes d_dn [Fixnum|NilClass] A width or a height.
+      # @option attributes default [Fixnum|NilClass] The terminal width or
+      #   height.
+      # @option attributes options [Hash]
+      # @return [Vedeu::Geometry::Dimension]
+      def initialize(attributes = {})
+        @attributes = defaults.merge!(attributes)
+
+        @attributes.each do |key, value|
+          instance_variable_set("@#{key}", value)
+        end
+      end
 
-    protected
+      # Fetch the starting coordinate.
+      #
+      # @return [Fixnum]
+      def d1
+        dimension[0] < 1 ? 1 : dimension[0]
+      end
 
-    # @!attribute [r] d
-    # @return [Fixnum|NilClass]
-    attr_reader :d
+      # Fetch the ending coordinate.
+      #
+      # @return [Fixnum]
+      def d2
+        dimension[-1]
+      end
+
+      # Fetch the coordinates.
+      #
+      # @return [Array<Fixnum>]
+      def pair
+        dimension
+      end
 
-    # @!attribute [r] dn
-    # @return [Fixnum|NilClass]
-    attr_reader :dn
+      protected
 
-    # @!attribute [r] d_dn
-    # @return [Fixnum|NilClass]
-    attr_reader :d_dn
+      # @!attribute [r] d
+      # @return [Fixnum|NilClass]
+      attr_reader :d
 
-    # @!attribute [r] default
-    # @return [Fixnum|NilClass]
-    attr_reader :default
+      # @!attribute [r] dn
+      # @return [Fixnum|NilClass]
+      attr_reader :dn
 
-    # @!attribute [r] maximised
-    # @return [Boolean]
-    attr_reader :maximised
-    alias_method :maximised?, :maximised
+      # @!attribute [r] d_dn
+      # @return [Fixnum|NilClass]
+      attr_reader :d_dn
 
-    # @!attribute [r] centred
-    # @return [Boolean]
-    attr_reader :centred
-    alias_method :centred?, :centred
+      # @!attribute [r] default
+      # @return [Fixnum|NilClass]
+      attr_reader :default
 
-    private
+      # @!attribute [r] maximised
+      # @return [Boolean]
+      attr_reader :maximised
+      alias_method :maximised?, :maximised
 
-    # @return [Array<Fixnum>]
-    def dimension
-      @dimension = if maximised?
-                     [1, default]
+      # @!attribute [r] centred
+      # @return [Boolean]
+      attr_reader :centred
+      alias_method :centred?, :centred
 
-                   elsif centred? && length?
-                     [centred_d, centred_dn]
+      private
 
-                   else
-                     [_d, _dn]
+      # @return [Array<Fixnum>]
+      def dimension
+        @dimension = if maximised?
+                       [1, default]
 
-                   end
-    end
+                     elsif centred? && length?
+                       [centred_d, centred_dn]
 
-    # @return [Boolean]
-    def length?
-      default && length
-    end
+                     else
+                       [_d, _dn]
 
-    # @return [Fixnum|NilClass]
-    def length
-      if d && dn
-        (d..dn).size
+                     end
+      end
+
+      # @return [Boolean]
+      def length?
+        default && length
+      end
 
-      elsif d_dn
-        d_dn
+      # @return [Fixnum|NilClass]
+      def length
+        if d && dn
+          (d..dn).size
 
-      elsif default
-        default
+        elsif d_dn
+          d_dn
 
+        elsif default
+          default
+
+        end
       end
-    end
 
-    # Ascertains the centred starting coordinate.
-    #
-    # @return [Fixnum]
-    def centred_d
-      (default / 2) - (length / 2)
-    end
+      # Ascertains the centred starting coordinate.
+      #
+      # @return [Fixnum]
+      def centred_d
+        (default / 2) - (length / 2)
+      end
 
-    # Ascertains the centred ending coordinate.
-    #
-    # @return [Fixnum]
-    def centred_dn
-      (default / 2) + (length / 2)
-    end
+      # Ascertains the centred ending coordinate.
+      #
+      # @return [Fixnum]
+      def centred_dn
+        (default / 2) + (length / 2)
+      end
 
-    # Fetch the starting coordinate, or use 1 when not set.
-    #
-    # @return [Fixnum]
-    def _d
-      d || 1
-    end
+      # Fetch the starting coordinate, or use 1 when not set.
+      #
+      # @return [Fixnum]
+      def _d
+        d || 1
+      end
 
-    # Fetch the ending coordinate.
-    #
-    # @return [Fixnum]
-    def _dn
-      if dn
-        dn
+      # Fetch the ending coordinate.
+      #
+      # @return [Fixnum]
+      def _dn
+        if dn
+          dn
 
-      elsif d.nil? && d_dn
-        d_dn
+        elsif d.nil? && d_dn
+          d_dn
 
-      elsif d && d_dn
-        (d + d_dn) - 1
+        elsif d && d_dn
+          (d + d_dn) - 1
 
-      else
-        default
+        else
+          default
 
+        end
       end
-    end
 
-    # Returns the default options/attributes for this class.
-    #
-    # @return [Hash<Symbol => NilClass,Boolean>]
-    def defaults
-      {
-        d:         nil,
-        dn:        nil,
-        d_dn:      nil,
-        default:   nil,
-        centred:   false,
-        maximised: false,
-      }
-    end
-
-  end # Dimension
+      # Returns the default options/attributes for this class.
+      #
+      # @return [Hash<Symbol => NilClass,Boolean>]
+      def defaults
+        {
+          d:         nil,
+          dn:        nil,
+          d_dn:      nil,
+          default:   nil,
+          centred:   false,
+          maximised: false,
+        }
+      end
+
+    end # Dimension
+
+  end # Geometry
 
 end # Vedeu

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

@@ -1,6 +1,6 @@
 module Vedeu
 
-  module DSL
+  module Geometry
 
     # Geometry allows the configuration of the position and size of an
     # interface. Within Vedeu, as the same for ANSI terminals, has the origin at
@@ -68,7 +68,7 @@ module Vedeu
     #     yn +--------------+           # south:  yn + 1
     #             south
     #
-    class Geometry
+    class DSL
 
       include Vedeu::DSL
       include Vedeu::DSL::Use
@@ -83,18 +83,18 @@ module Vedeu
       #   geometry belongs.
       # @param block [Proc]
       # @raise [Vedeu::Error::InvalidSyntax] The required block was not given.
-      # @return [Vedeu::Geometry]
+      # @return [Vedeu::Geometry::Geometry]
       def self.geometry(name, &block)
         fail Vedeu::Error::InvalidSyntax, 'block not given' unless block_given?
 
-        Vedeu::Geometry.build(name: name, &block).store
+        Vedeu::Geometry::Geometry.build(name: name, &block).store
       end
 
-      # Returns an instance of DSL::Geometry.
+      # Returns an instance of Vedeu::Geometry::DSL.
       #
-      # @param model [Vedeu::Geometry]
+      # @param model [Vedeu::Geometry::Geometry]
       # @param client [Object]
-      # @return [Vedeu::DSL::Geometry]
+      # @return [Vedeu::Geometry::DSL]
       def initialize(model, client = nil)
         @model  = model
         @client = client
@@ -137,7 +137,7 @@ module Vedeu
       #   between 1 and 12 inclusive.
       # @return [Fixnum|Vedeu::Error::OutOfRange]
       def columns(value)
-        Vedeu::Grid.columns(value)
+        Vedeu::Geometry::Grid.columns(value)
       end
 
       # Specify the number of characters/rows/lines tall the interface will be.
@@ -170,7 +170,7 @@ module Vedeu
       #   between 1 and 12 inclusive.
       # @return [Fixnum]
       def rows(value)
-        Vedeu::Grid.rows(value)
+        Vedeu::Geometry::Grid.rows(value)
       end
 
       # Specify the number of characters/columns wide the interface will be.
@@ -269,8 +269,8 @@ module Vedeu
       end
       alias_method :yn=, :yn
 
-    end # Geometry
+    end # DSL
 
-  end # DSL
+  end # Geometry
 
 end # Vedeu