vedeu 0.6.4 → 0.6.5

data/lib/vedeu/geometry/generic_coordinate.rb

@@ -1,172 +1,178 @@
 module Vedeu
 
-  # Crudely corrects out of range values.
-  #
-  class GenericCoordinate
+  module Geometry
 
-    # Return a new instance of Vedeu::GenericCoordinate.
+    # Crudely corrects out of range values.
     #
-    # @param attributes [Hash]
-    # @option attributes name [String]
-    # @option attributes type [Symbol]
-    # @option attributes offset [Fixnum]
-    # @return [Vedeu::GenericCoordinate]
-    def initialize(attributes = {})
-      @attributes = defaults.merge!(attributes)
-
-      @attributes.each { |key, value| instance_variable_set("@#{key}", value) }
-    end
-
-    # Returns the maximum coordinate for an area.
-    #
-    # @example
-    #   # d = 2
-    #   # d_dn = 4
-    #   dn # => 6
-    #
-    # @return [Fixnum]
-    def dn
-      if d_dn <= 0
-        0
+    class GenericCoordinate
+
+      # Return a new instance of Vedeu::Geometry::GenericCoordinate.
+      #
+      # @param attributes [Hash]
+      # @option attributes name [String]
+      # @option attributes type [Symbol]
+      # @option attributes offset [Fixnum]
+      # @return [Vedeu::Geometry::GenericCoordinate]
+      def initialize(attributes = {})
+        @attributes = defaults.merge!(attributes)
+
+        @attributes.each do |key, value|
+          instance_variable_set("@#{key}", value)
+        end
+      end
+
+      # Returns the maximum coordinate for an area.
+      #
+      # @example
+      #   # d = 2
+      #   # d_dn = 4 # represents width or height
+      #   dn # => 6
+      #
+      # @return [Fixnum]
+      def dn
+        if d_dn <= 0
+          0
+
+        else
+          d + d_dn
+
+        end
+      end
+      alias_method :xn, :dn
+      alias_method :yn, :dn
+
+      # Returns the coordinate for a given index.
+      #
+      # @example
+      #   # d_range = [4, 5, 6, 7, 8, 9, 10, 11, 12, 13]
+      #   position     # => 4
+      #   position(-2) # => 4
+      #   position(2)  # => 6
+      #   position(15) # => 13
+      #
+      # @return [Fixnum]
+      def position
+        pos = case
+              when offset <= 0       then d
+              when offset > dn_index then dn
+              else
+                d_range[offset]
+              end
+
+        pos = pos < bd ? bd : pos
+        pos = pos > bdn ? bdn : pos
+        pos
+      end
+      alias_method :x_position, :position
+      alias_method :y_position, :position
+
+      protected
+
+      # @!attribute [r] name
+      # @return [String]
+      attr_reader :name
 
-      else
-        d + d_dn
+      # @!attribute [r] offset
+      # @return [Fixnum]
+      attr_reader :offset
 
+      # @!attribute [r] type
+      # @return [Symbol]
+      attr_reader :type
+
+      private
+
+      # @see Vedeu::Borders::Repository#by_name
+      def border
+        @border ||= Vedeu.borders.by_name(name)
       end
-    end
-    alias_method :xn, :dn
-    alias_method :yn, :dn
 
-    # Returns the coordinate for a given index.
-    #
-    # @example
-    #   # d_range = [4, 5, 6, 7, 8, 9, 10, 11, 12, 13]
-    #   position     # => 4
-    #   position(-2) # => 4
-    #   position(2)  # => 6
-    #   position(15) # => 13
-    #
-    # @return [Fixnum]
-    def position
-      pos = case
-            when offset <= 0       then d
-            when offset > dn_index then dn
-            else
-              d_range[offset]
-            end
-
-      pos = pos < bd ? bd : pos
-      pos = pos > bdn ? bdn : pos
-      pos
-    end
-    alias_method :x_position, :position
-    alias_method :y_position, :position
-
-    protected
-
-    # @!attribute [r] name
-    # @return [String]
-    attr_reader :name
-
-    # @!attribute [r] offset
-    # @return [Fixnum]
-    attr_reader :offset
-
-    # @!attribute [r] type
-    # @return [Symbol]
-    attr_reader :type
-
-    private
-
-    # @see Vedeu::Borders#by_name
-    def border
-      @border ||= Vedeu.borders.by_name(name)
-    end
-
-    # Return the :x or :y value from the border.
-    #
-    # @return [Fixnum]
-    def d
-      border.send(coordinate_type[0])
-    end
+      # Return the :x or :y value from the border.
+      #
+      # @return [Fixnum]
+      def d
+        border.send(coordinate_type[0])
+      end
 
-    # Return the :bx or :by value from the border.
-    #
-    # @return [Fixnum]
-    def bd
-      border.send(coordinate_type[1])
-    end
+      # Return the :bx or :by value from the border.
+      #
+      # @return [Fixnum]
+      def bd
+        border.send(coordinate_type[1])
+      end
 
-    # Return the :bxn or :byn value from the border.
-    #
-    # @return [Fixnum]
-    def bdn
-      border.send(coordinate_type[2])
-    end
+      # Return the :bxn or :byn value from the border.
+      #
+      # @return [Fixnum]
+      def bdn
+        border.send(coordinate_type[2])
+      end
 
-    # Return the :width or :height value from the border.
-    #
-    # @return [Fixnum]
-    def d_dn
-      border.send(coordinate_type[3])
-    end
+      # Return the :width or :height value from the border.
+      #
+      # @return [Fixnum]
+      def d_dn
+        border.send(coordinate_type[3])
+      end
 
-    # Ascertain the correct methods to use for determining the coordinates.
-    #
-    # @raise [Vedeu::Error::InvalidSyntax] When the coordinate type is not
-    #   given.
-    # @return [Fixnum]
-    def coordinate_type
-      @_type ||= case type
-                 when :x then [:x, :bx, :bxn, :width]
-                 when :y then [:y, :by, :byn, :height]
-                 else
-                   fail Vedeu::Error::InvalidSyntax,
-                        'Coordinate type not given, cannot continue.'
-                 end
-    end
-
-    # Returns the maximum index for an area.
-    #
-    # @example
-    #   # d_dn = 3
-    #   dn_index # => 2
-    #
-    # @return [Fixnum]
-    def dn_index
-      if d_dn < 1
-        0
+      # Ascertain the correct methods to use for determining the coordinates.
+      #
+      # @raise [Vedeu::Error::InvalidSyntax] When the coordinate type is not
+      #   given.
+      # @return [Fixnum]
+      def coordinate_type
+        @_type ||= case type
+                   when :x then [:x, :bx, :bxn, :width]
+                   when :y then [:y, :by, :byn, :height]
+                   else
+                     fail Vedeu::Error::InvalidSyntax,
+                          'Coordinate type not given, cannot continue.'
+                   end
+      end
 
-      else
-        d_dn - 1
+      # Returns the maximum index for an area.
+      #
+      # @example
+      #   # d_dn = 3
+      #   dn_index # => 2
+      #
+      # @return [Fixnum]
+      def dn_index
+        if d_dn < 1
+          0
+
+        else
+          d_dn - 1
+
+        end
+      end
 
+      # Returns an array with all coordinates from d to dn.
+      #
+      # @example
+      #   # d_dn = 10
+      #   # d = 4
+      #   # dn = 14
+      #   d_range # => [4, 5, 6, 7, 8, 9, 10, 11, 12, 13]
+      #
+      # @return [Array]
+      def d_range
+        (d...dn).to_a
       end
-    end
 
-    # Returns an array with all coordinates from d to dn.
-    #
-    # @example
-    #   # d_dn = 10
-    #   # d = 4
-    #   # dn = 14
-    #   d_range # => [4, 5, 6, 7, 8, 9, 10, 11, 12, 13]
-    #
-    # @return [Array]
-    def d_range
-      (d...dn).to_a
-    end
+      # The default values for a new instance of this class.
+      #
+      # @return [Hash]
+      def defaults
+        {
+          name:   '',
+          offset: nil,
+          type:   :x,
+        }
+      end
 
-    # The default values for a new instance of this class.
-    #
-    # @return [Hash]
-    def defaults
-      {
-        name:   '',
-        offset: nil,
-        type:   :x,
-      }
-    end
-
-  end # GenericCoordinate
+    end # GenericCoordinate
+
+  end # Geometry
 
 end # Vedeu

data/lib/vedeu/geometry/geometry.rb

@@ -1,220 +1,318 @@
 module Vedeu
 
-  # @todo Consider storing the Terminal size at the time of first creation,
-  # this allows us to return the interface to its original dimensions if
-  # the terminal resizes back to normal size.
-  #
-  # Calculates and provides interface geometry determined by both the client's
-  # requirements and the terminal's current viewing area.
-  #
-  class Geometry
-
-    extend Forwardable
-    include Vedeu::Model
-
-    def_delegators :area,
-                   :north,
-                   :east,
-                   :south,
-                   :west,
-                   :top,
-                   :right,
-                   :bottom,
-                   :left,
-                   :y,
-                   :xn,
-                   :yn,
-                   :x,
-                   :height,
-                   :width
-
-    # @!attribute [rw] centred
-    # @return [Boolean]
-    attr_accessor :centred
-
-    # @!attribute [rw] name
-    # @return [String]
-    attr_accessor :name
-
-    # @!attribute [r] attributes
-    # @return [Hash]
-    attr_reader :attributes
-
-    # @!attribute [w] height
-    # @return [Fixnum]
-    attr_writer :height
-
-    # @!attribute [rw] maximised
-    # @return [Boolean]
-    attr_accessor :maximised
-    alias_method :maximised?, :maximised
-
-    # @!attribute [w] width
-    # @return [Fixnum]
-    attr_writer :width
-
-    # @!attribute [w] x
-    # @return [Fixnum]
-    attr_writer :x
-
-    # @!attribute [w] xn
-    # @return [Fixnum]
-    attr_writer :xn
-
-    # @!attribute [w] y
-    # @return [Fixnum]
-    attr_writer :y
-
-    # @!attribute [w] yn
-    # @return [Fixnum]
-    attr_writer :yn
-
-    # Returns a new instance of Vedeu::Geometry.
-    #
-    # @param attributes [Hash]
-    # @option attributes centred [Boolean]
-    # @option attributes maximised [Boolean]
-    # @option attributes height [Fixnum]
-    # @option attributes name [String]
-    # @option attributes repository [Vedeu::Geometries]
-    # @option attributes width [Fixnum]
-    # @option attributes x [Fixnum]
-    # @option attributes xn [Fixnum]
-    # @option attributes y [Fixnum]
-    # @option attributes yn [Fixnum]
-    # @return [Vedeu::Geometry]
-    def initialize(attributes = {})
-      @attributes = defaults.merge!(attributes)
-
-      @attributes.each { |key, value| instance_variable_set("@#{key}", value) }
-    end
-
-    # Will maximise the named interface geometry. This means it will occupy all
-    # of the available space on the terminal window.
-    #
-    # @example
-    #   Vedeu.trigger(:_maximise_, name)
-    #
-    # @return [Vedeu::Geometry|NilClass]
-    def maximise
-      return self if maximised?
-
-      Vedeu.trigger(:_clear_)
-
-      @maximised = true
-
-      work = store
-
-      Vedeu.trigger(:_refresh_, name)
-
-      work
-    end
-
-    # Will unmaximise the named interface geometry. Previously, when a geometry
-    # was maximised, then triggering the unmaximise event will return it to its
-    # usual defined size (terminal size permitting: when the terminal has been
-    # resized, then the new geometry size should adapt).
-    #
-    # @example
-    #   Vedeu.trigger(:_unmaximise_, name)
-    #
-    # @return [Vedeu::Geometry|NilClass]
-    def unmaximise
-      return self unless maximised?
-
-      Vedeu.trigger(:_clear_)
-
-      @maximised = false
-
-      work = store
-
-      Vedeu.trigger(:_refresh_)
+  module Geometry
 
-      work
-    end
-
-    private
-
-    # @return [Vedeu::Area]
-    def area
-      @area = Vedeu::Area.from_attributes(area_attributes)
-    end
-
-    # @return [Hash<Symbol => Fixnum, Boolean>]
-    def area_attributes
-      {
-        y:         _y,
-        yn:        _yn,
-        y_yn:      _height,
-        y_default: Vedeu.height,
-        x:         _x,
-        xn:        _xn,
-        x_xn:      _width,
-        x_default: Vedeu.width,
-        centred:   centred,
-        maximised: maximised,
-      }
-    end
-
-    # Returns the row/line start position for the interface.
-    #
-    # @return [Fixnum]
-    def _y
-      @y.is_a?(Proc) ? @y.call : @y
-    end
-
-    # Returns the row/line end position for the interface.
-    #
-    # @return [Fixnum]
-    def _yn
-      @yn.is_a?(Proc) ? @yn.call : @yn
-    end
-
-    # Returns the column/character start position for the interface.
+    # @todo Consider storing the Terminal size at the time of first creation,
+    # this allows us to return the interface to its original dimensions if
+    # the terminal resizes back to normal size.
     #
-    # @return [Fixnum]
-    def _x
-      @x.is_a?(Proc) ? @x.call : @x
-    end
-
-    # Returns the column/character end position for the interface.
-    #
-    # @return [Fixnum]
-    def _xn
-      @xn.is_a?(Proc) ? @xn.call : @xn
-    end
-
-    # Returns the width of the interface.
-    #
-    # @return [Fixnum]
-    def _width
-      @width.is_a?(Proc) ? @width.call : @width
-    end
-
-    # Returns the height of the interface.
-    #
-    # @return [Fixnum]
-    def _height
-      @height.is_a?(Proc) ? @height.call : @height
-    end
-
-    # Returns the default options/attributes for this class.
+    # Calculates and provides interface geometry determined by both the client's
+    # requirements and the terminal's current viewing area.
     #
-    # @return [Hash]
-    def defaults
-      {
-        centred:    nil,
-        height:     nil,
-        maximised:  false,
-        name:       nil,
-        repository: Vedeu.geometries,
-        width:      nil,
-        x:          nil,
-        xn:         nil,
-        y:          nil,
-        yn:         nil,
-      }
-    end
+    class Geometry
+
+      extend Forwardable
+      include Vedeu::Model
+
+      def_delegators :area,
+                     :north,
+                     :east,
+                     :south,
+                     :west,
+                     :top,
+                     :right,
+                     :bottom,
+                     :left,
+                     :y,
+                     :xn,
+                     :yn,
+                     :x,
+                     :height,
+                     :width
+
+      # @!attribute [rw] centred
+      # @return [Boolean]
+      attr_accessor :centred
+
+      # @!attribute [rw] name
+      # @return [String]
+      attr_accessor :name
+
+      # @!attribute [r] attributes
+      # @return [Hash]
+      attr_reader :attributes
+
+      # @!attribute [w] height
+      # @return [Fixnum]
+      attr_writer :height
+
+      # @!attribute [rw] maximised
+      # @return [Boolean]
+      attr_accessor :maximised
+      alias_method :maximised?, :maximised
+
+      # @!attribute [w] width
+      # @return [Fixnum]
+      attr_writer :width
+
+      # @!attribute [w] x
+      # @return [Fixnum]
+      attr_writer :x
+
+      # @!attribute [w] xn
+      # @return [Fixnum]
+      attr_writer :xn
+
+      # @!attribute [w] y
+      # @return [Fixnum]
+      attr_writer :y
+
+      # @!attribute [w] yn
+      # @return [Fixnum]
+      attr_writer :yn
+
+      # Returns a new instance of Vedeu::Geometry::Geometry.
+      #
+      # @param attributes [Hash]
+      # @option attributes centred [Boolean]
+      # @option attributes maximised [Boolean]
+      # @option attributes height [Fixnum]
+      # @option attributes name [String]
+      # @option attributes repository [Vedeu::Geometry::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]
+      def initialize(attributes = {})
+        @attributes = defaults.merge!(attributes)
+
+        @attributes.each do |key, value|
+          instance_variable_set("@#{key}", value)
+        end
+      end
+
+      # Will maximise the named interface geometry. This means it will occupy
+      # all of the available space on the terminal window.
+      #
+      # @example
+      #   Vedeu.trigger(:_maximise_, name)
+      #
+      # @return [Vedeu::Geometry::Geometry|NilClass]
+      def maximise
+        return self if maximised?
+
+        Vedeu.trigger(:_clear_)
+
+        @maximised = true
+
+        work = store
+
+        Vedeu.trigger(:_refresh_, name)
+
+        work
+      end
+
+      # Moves the geometry down by one row.
+      #
+      # TODO: Move cursor also.
+      # @return [Vedeu::Geometry::Geometry]
+      def move_down
+        dy  = (yn + 1 > Vedeu.height) ? y  : y + 1
+        dyn = (yn + 1 > Vedeu.height) ? yn : yn + 1
+
+        @attributes = attributes.merge(
+          centred:   false,
+          maximised: false,
+          x:         x,
+          xn:        xn,
+          y:         dy,
+          yn:        dyn,
+        )
+        Vedeu::Geometry::Geometry.new(@attributes).store
+      end
+
+      # Moves the geometry left by one column.
+      #
+      # TODO: Move cursor also.
+      # @return [Vedeu::Geometry::Geometry]
+      def move_left
+        dx  = (x - 1 < 1) ? x  : x - 1
+        dxn = (x - 1 < 1) ? xn : xn - 1
+
+        @attributes = attributes.merge(
+          centred:   false,
+          maximised: false,
+          x:         dx,
+          xn:        dxn,
+          y:         y,
+          yn:        yn,
+        )
+        Vedeu::Geometry::Geometry.new(@attributes).store
+      end
+
+      # Moves the geometry to the top left of the terminal.
+      #
+      # TODO: Move cursor also.
+      # @return [Vedeu::Geometry::Geometry]
+      def move_origin
+        @attributes = attributes.merge(
+          centred:   false,
+          maximised: false,
+          x:         1,
+          xn:        xn - x + 1,
+          y:         1,
+          yn:        yn - y + 1,
+        )
+        Vedeu::Geometry::Geometry.new(@attributes).store
+      end
+
+      # Moves the geometry right by one column.
+      #
+      # TODO: Move cursor also.
+      # @return [Vedeu::Geometry::Geometry]
+      def move_right
+        dx  = (xn + 1 > Vedeu.width) ? x  : x + 1
+        dxn = (xn + 1 > Vedeu.width) ? xn : xn + 1
+
+        @attributes = attributes.merge(
+          centred:   false,
+          maximised: false,
+          x:         dx,
+          xn:        dxn,
+          y:         y,
+          yn:        yn,
+        )
+        Vedeu::Geometry::Geometry.new(@attributes).store
+      end
+
+      # Moves the geometry up by one column.
+      #
+      # TODO: Move cursor also.
+      # @return [Vedeu::Geometry::Geometry]
+      def move_up
+        dy  = (y - 1 < 1) ? y  : y - 1
+        dyn = (y - 1 < 1) ? yn : yn - 1
+
+        @attributes = attributes.merge(
+          centred:   false,
+          maximised: false,
+          x:         x,
+          xn:        xn,
+          y:         dy,
+          yn:        dyn,
+        )
+        Vedeu::Geometry::Geometry.new(@attributes).store
+      end
+
+      # Will unmaximise the named interface geometry. Previously, when a
+      # geometry was maximised, then triggering the unmaximise event will return
+      # it to its usual defined size (terminal size permitting: when the
+      # terminal has been resized, then the new geometry size should adapt).
+      #
+      # @example
+      #   Vedeu.trigger(:_unmaximise_, name)
+      #
+      # @return [Vedeu::Geometry::Geometry|NilClass]
+      def unmaximise
+        return self unless maximised?
+
+        Vedeu.trigger(:_clear_)
+
+        @maximised = false
+
+        work = store
+
+        Vedeu.trigger(:_refresh_)
+
+        work
+      end
+
+      private
+
+      # @return [Vedeu::Geometry::Area]
+      def area
+        @area = Vedeu::Geometry::Area.from_attributes(area_attributes)
+      end
+
+      # @return [Hash<Symbol => Fixnum, Boolean>]
+      def area_attributes
+        {
+          y:         _y,
+          yn:        _yn,
+          y_yn:      _height,
+          y_default: Vedeu.height,
+          x:         _x,
+          xn:        _xn,
+          x_xn:      _width,
+          x_default: Vedeu.width,
+          centred:   centred,
+          maximised: maximised,
+        }
+      end
+
+      # Returns the row/line start position for the interface.
+      #
+      # @return [Fixnum]
+      def _y
+        @y.is_a?(Proc) ? @y.call : @y
+      end
+
+      # Returns the row/line end position for the interface.
+      #
+      # @return [Fixnum]
+      def _yn
+        @yn.is_a?(Proc) ? @yn.call : @yn
+      end
+
+      # Returns the column/character start position for the interface.
+      #
+      # @return [Fixnum]
+      def _x
+        @x.is_a?(Proc) ? @x.call : @x
+      end
+
+      # Returns the column/character end position for the interface.
+      #
+      # @return [Fixnum]
+      def _xn
+        @xn.is_a?(Proc) ? @xn.call : @xn
+      end
+
+      # Returns the width of the interface.
+      #
+      # @return [Fixnum]
+      def _width
+        @width.is_a?(Proc) ? @width.call : @width
+      end
+
+      # Returns the height of the interface.
+      #
+      # @return [Fixnum]
+      def _height
+        @height.is_a?(Proc) ? @height.call : @height
+      end
+
+      # Returns the default options/attributes for this class.
+      #
+      # @return [Hash]
+      def defaults
+        {
+          centred:    nil,
+          height:     nil,
+          maximised:  false,
+          name:       nil,
+          repository: Vedeu.geometries,
+          width:      nil,
+          x:          nil,
+          xn:         nil,
+          y:          nil,
+          yn:         nil,
+        }
+      end
+
+    end # Geometry
 
   end # Geometry