vedeu 0.6.4 → 0.6.5

data/lib/vedeu/geometry/grid.rb

@@ -1,75 +1,79 @@
 module Vedeu
 
-  # The grid system splits the terminal height and width into 12 equal parts, by
-  # dividing the available height and width by 12. If the terminal height or
-  # width is not a multiple of 12, then Grid chooses the maximum value which
-  # will fit.
-  #
-  class Grid
-
-    # @see #initialize
-    # @see #columns
-    def self.columns(value)
-      new(value).columns
-    end
-
-    # @see #initialize
-    # @see #rows
-    def self.rows(value)
-      new(value).rows
-    end
-
-    # Returns a new instance of Vedeu::Grid.
-    #
-    # @param value [Fixnum]
-    # @return [Grid]
-    def initialize(value)
-      @value = value
-    end
-
-    # @see Vedeu::DSL::Geometry#columns
-    def columns
-      fail Vedeu::Error::OutOfRange if out_of_range?
-
-      column * value
-    end
-
-    # @see Vedeu::DSL::Geometry#rows
-    def rows
-      fail Vedeu::Error::OutOfRange if out_of_range?
-
-      row * value
-    end
-
-    protected
-
-    # @!attribute [r] value
-    # @return [Fixnum]
-    attr_reader :value
+  module Geometry
 
-    private
-
-    # Returns the height of a single row in characters.
-    #
-    # @return [Fixnum]
-    def row
-      Vedeu.height / 12
-    end
-
-    # Returns a boolean indicating whether the value is out of range.
+    # The grid system splits the terminal height and width into 12 equal parts,
+    # by dividing the available height and width by 12. If the terminal height
+    # or width is not a multiple of 12, then Grid chooses the maximum value
+    # which will fit.
     #
-    # @return [Boolean]
-    def out_of_range?
-      value < 1 || value > 12
-    end
-
-    # Returns the width of a single column in characters.
-    #
-    # @return [Fixnum]
-    def column
-      Vedeu.width / 12
-    end
-
-  end # Grid
+    class Grid
+
+      # @see #initialize
+      # @see #columns
+      def self.columns(value)
+        new(value).columns
+      end
+
+      # @see #initialize
+      # @see #rows
+      def self.rows(value)
+        new(value).rows
+      end
+
+      # Returns a new instance of Vedeu::Geometry::Grid.
+      #
+      # @param value [Fixnum]
+      # @return [Vedeu::Geometry::Grid]
+      def initialize(value)
+        @value = value
+      end
+
+      # @see Vedeu::Geometry::DSL#columns
+      def columns
+        fail Vedeu::Error::OutOfRange if out_of_range?
+
+        column * value
+      end
+
+      # @see Vedeu::Geometry::DSL#rows
+      def rows
+        fail Vedeu::Error::OutOfRange if out_of_range?
+
+        row * value
+      end
+
+      protected
+
+      # @!attribute [r] value
+      # @return [Fixnum]
+      attr_reader :value
+
+      private
+
+      # Returns the height of a single row in characters.
+      #
+      # @return [Fixnum]
+      def row
+        Vedeu.height / 12
+      end
+
+      # Returns a boolean indicating whether the value is out of range.
+      #
+      # @return [Boolean]
+      def out_of_range?
+        value < 1 || value > 12
+      end
+
+      # Returns the width of a single column in characters.
+      #
+      # @return [Fixnum]
+      def column
+        Vedeu.width / 12
+      end
+
+    end # Grid
+
+  end # Geometry
 
 end # Vedeu

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

@@ -1,10 +1,10 @@
 module Vedeu
 
-  module Null
+  module Geometry
 
     # Provides a non-existent model to swallow messages.
     #
-    class Geometry
+    class Null
 
       extend Forwardable
 
@@ -32,11 +32,11 @@ module Vedeu
       # @return [String|NilClass]
       attr_reader :name
 
-      # Returns a new instance of Vedeu::Null::Geometry.
+      # Returns a new instance of Vedeu::Geometry::Null.
       #
       # @param attributes [Hash<Symbol => void>]
       # @option attributes name [String|NilClass]
-      # @return [Vedeu::Null::Geometry]
+      # @return [Vedeu::Geometry::Null]
       def initialize(attributes = {})
         @attributes = attributes
         @name       = @attributes[:name]
@@ -60,21 +60,21 @@ module Vedeu
         true
       end
 
-      # @return [Vedeu::Null::Geometry]
+      # @return [Vedeu::Geometry::Null]
       def store
         self
       end
 
       private
 
-      # @return [Vedeu::Area]
+      # @return [Vedeu::Geometry::Area]
       def area
-        @area ||= Vedeu::Area.from_attributes(y_default: Vedeu.height,
-                                              x_default: Vedeu.width)
+        @area ||= Vedeu::Geometry::Area.from_attributes(y_default: Vedeu.height,
+                                                        x_default: Vedeu.width)
       end
 
-    end # Geometry
+    end # Null
 
-  end # Null
+  end # Geometry
 
 end # Vedeu

data/lib/vedeu/geometry/position.rb

@@ -1,147 +1,151 @@
 module Vedeu
 
-  # Change coordinates into an escape sequence to set the cursor position.
-  #
-  class Position
+  module Geometry
 
-    # @!attribute [r] y
-    # @return [Fixnum]
-    attr_reader :y
-    alias_method :first, :y
+    # Change coordinates into an escape sequence to set the cursor position.
+    #
+    class Position
+
+      # @!attribute [r] y
+      # @return [Fixnum]
+      attr_reader :y
+      alias_method :first, :y
+
+      # @!attribute [r] x
+      # @return [Fixnum]
+      attr_reader :x
+      alias_method :last, :x
+
+      # Convenience constructor for Vedeu::Geometry::Position.
+      #
+      # @param (see #initialize)
+      def self.[](y, x)
+        new(y, x)
+      end
 
-    # @!attribute [r] x
-    # @return [Fixnum]
-    attr_reader :x
-    alias_method :last, :x
+      # @param value [Array<Fixnum>|Vedeu::Position]
+      # @return [void]
+      def self.coerce(value)
+        if value.is_a?(self)
+          value
 
-    # Convenience constructor for Vedeu::Position.
-    #
-    # @param (see #initialize)
-    def self.[](y, x)
-      new(y, x)
-    end
+        elsif value.is_a?(Array)
+          new(*value)
 
-    # @param value [Array<Fixnum>|Vedeu::Position]
-    # @return [void]
-    def self.coerce(value)
-      if value.is_a?(self)
-        value
+        elsif value.is_a?(Hash)
+          new(value.fetch(:y, 1), value.fetch(:x, 1))
 
-      elsif value.is_a?(Array)
-        new(*value)
+        end
+      end
 
-      elsif value.is_a?(Hash)
-        new(value.fetch(:y, 1), value.fetch(:x, 1))
+      # Initializes a new instance of Vedeu::Geometry::Position.
+      #
+      # @param y [Fixnum] The row/line position.
+      # @param x [Fixnum] The column/character position.
+      # @return [Vedeu::Geometry::Position]
+      def initialize(y = 1, x = 1)
+        @y = (y.nil? || y < 1) ? 1 : y
+        @x = (x.nil? || x < 1) ? 1 : x
+      end
+
+      # Converts a position into an index for the terminal. An index is the
+      # position minus 1.
+      #
+      # @return [Array<Fixnum>]
+      def as_indices
+        xi = ((x - 1) <= 1) ? 0 : (x - 1)
+        yi = ((y - 1) <= 1) ? 0 : (y - 1)
 
+        [yi, xi]
       end
-    end
 
-    # Initializes a new instance of Vedeu::Position.
-    #
-    # @param y [Fixnum] The row/line position.
-    # @param x [Fixnum] The column/character position.
-    # @return [Vedeu::Position]
-    def initialize(y = 1, x = 1)
-      @y = (y.nil? || y < 1) ? 1 : y
-      @x = (x.nil? || x < 1) ? 1 : x
-    end
-
-    # Converts a position into an index for the terminal. An index is the
-    # position minus 1.
-    #
-    # @return [Array<Fixnum>]
-    def as_indices
-      xi = ((x - 1) <= 1) ? 0 : (x - 1)
-      yi = ((y - 1) <= 1) ? 0 : (y - 1)
+      # @param other [Vedeu::Geometry::Position]
+      # @return [Fixnum]
+      def <=>(other)
+        if y == other.y
+          x <=> other.x
 
-      [yi, xi]
-    end
+        else
+          y <=> other.y
 
-    # @param other [Vedeu::Position]
-    # @return [Fixnum]
-    def <=>(other)
-      if y == other.y
-        x <=> other.x
+        end
+      end
 
-      else
-        y <=> other.y
+      # An object is equal when its values are the same.
+      #
+      # @param other [Vedeu::Geometry::Position]
+      # @return [Boolean]
+      def eql?(other)
+        self.class == other.class && (x == other.x && y == other.y)
+      end
+      alias_method :==, :eql?
 
+      # Return a tuple containing the y and x coordinates.
+      #
+      # @return [Array<Fixnum>]
+      def to_a
+        [y, x]
       end
-    end
 
-    # An object is equal when its values are the same.
-    #
-    # @param other [Vedeu::Position]
-    # @return [Boolean]
-    def eql?(other)
-      self.class == other.class && (x == other.x && y == other.y)
-    end
-    alias_method :==, :eql?
-
-    # Return a tuple containing the y and x coordinates.
-    #
-    # @return [Array<Fixnum>]
-    def to_a
-      [y, x]
-    end
-
-    # @return [Vedeu::Position]
-    def to_position
-      self
-    end
-
-    # Return the escape sequence required to position the cursor at a particular
-    # point on the screen. When passed a block, will do the aforementioned,
-    # call the block and then reposition to this location.
-    #
-    # @return [String]
-    # @yieldreturn [void] Returns the block wrapped in position escape
-    #   sequences.
-    def to_s
-      return "#{sequence}#{yield}" if block_given?
+      # @return [Vedeu::Geometry::Position]
+      def to_position
+        self
+      end
 
-      sequence
-    end
-    alias_method :to_str, :to_s
+      # Return the escape sequence required to position the cursor at a
+      # particular point on the screen. When passed a block, will do the
+      # aforementioned, call the block and then reposition to this location.
+      #
+      # @return [String]
+      # @yieldreturn [void] Returns the block wrapped in position escape
+      #   sequences.
+      def to_s
+        return "#{sequence}#{yield}" if block_given?
+
+        sequence
+      end
+      alias_method :to_str, :to_s
 
-    # Increase y coordinate; moves down.
-    #
-    # @return [Vedeu::Position]
-    def down
-      Vedeu::Position.new(y + 1, x)
-    end
+      # Increase y coordinate; moves down.
+      #
+      # @return [Vedeu::Geometry::Position]
+      def down
+        Vedeu::Geometry::Position.new(y + 1, x)
+      end
 
-    # Decrease x coordinate; moves left.
-    #
-    # @return [Vedeu::Position]
-    def left
-      Vedeu::Position.new(y, x - 1)
-    end
+      # Decrease x coordinate; moves left.
+      #
+      # @return [Vedeu::Geometry::Position]
+      def left
+        Vedeu::Geometry::Position.new(y, x - 1)
+      end
 
-    # Increase x coordinate; moves right.
-    #
-    # @return [Vedeu::Position]
-    def right
-      Vedeu::Position.new(y, x + 1)
-    end
+      # Increase x coordinate; moves right.
+      #
+      # @return [Vedeu::Geometry::Position]
+      def right
+        Vedeu::Geometry::Position.new(y, x + 1)
+      end
 
-    # Decrease y coordinate; moves up.
-    #
-    # @return [Vedeu::Position]
-    def up
-      Vedeu::Position.new(y - 1, x)
-    end
+      # Decrease y coordinate; moves up.
+      #
+      # @return [Vedeu::Geometry::Position]
+      def up
+        Vedeu::Geometry::Position.new(y - 1, x)
+      end
 
-    private
+      private
 
-    # Returns the escape sequence to reposition the cursors at the coordinates
-    # specified by x and y.
-    #
-    # @return [String]
-    def sequence
-      "\e[#{y};#{x}H"
-    end
+      # Returns the escape sequence to reposition the cursors at the coordinates
+      # specified by x and y.
+      #
+      # @return [String]
+      def sequence
+        "\e[#{y};#{x}H"
+      end
+
+    end # Position
 
-  end # Position
+  end # Geometry
 
 end # Vedeu