vedeu 0.6.4 → 0.6.5

data/lib/vedeu/cursor/cursors.rb

@@ -1,30 +0,0 @@
-module Vedeu
-
-  # Allows the storing of each interface's cursor.
-  #
-  class Cursors < Vedeu::Repository
-
-    singleton_class.send(:alias_method, :cursors, :repository)
-
-    class << self
-
-      # @return [Vedeu::Cursor]
-      # @see Vedeu::API.cursor
-      def cursor
-        cursors.by_name(Vedeu.focus) if Vedeu.focus
-      end
-
-    end # Eigenclass
-
-    null Vedeu::Cursor
-    real Vedeu::Cursor
-
-  end # Cursors
-
-  class Cursor
-
-    repo Vedeu::Cursors.repository
-
-  end # Cursor
-
-end # Vedeu

data/lib/vedeu/cursor/move.rb

@@ -1,239 +0,0 @@
-module Vedeu
-
-  # Adjusts the position of the cursor or view. To use this class, call the
-  # appropriate event:
-  #
-  # @example
-  #   Vedeu.trigger(:_cursor_down_)
-  #
-  #   Vedeu.trigger(:_cursor_left_) # When a name is not given, the cursor in
-  #                                 # the interface which is currently in focus
-  #                                 # should move to the left.
-  #
-  #   Vedeu.trigger(:_cursor_left_, 'my_interface')
-  #                                 # When a name is given, the cursor instance
-  #                                 # belonging to this interface moves to the
-  #                                 # left.
-  #
-  #   Vedeu.trigger(:_cursor_right_)
-  #   Vedeu.trigger(:_cursor_up_)
-  #
-  #   Vedeu.trigger(:_cursor_origin_)                 # /or/
-  #   Vedeu.trigger(:_cursor_origin_, 'my_interface')
-  #                                 # Moves the cursor to the top left of the
-  #                                 # named or current interface in focus.
-  #
-  #   Vedeu.trigger(:_view_down_,  'my_interface')
-  #   Vedeu.trigger(:_view_left_,  'my_interface')
-  #   Vedeu.trigger(:_view_right_, 'my_interface')
-  #   Vedeu.trigger(:_view_up_,    'my_interface')
-  #
-  # @note
-  #   The cursor or view may not be visible, but it will still move if
-  #     requested.
-  #   The cursor will not exceed the border or boundary of the interface, or
-  #     boundary of the visible terminal.
-  #   The cursor will move freely within the bounds of the interface,
-  #     irrespective of content.
-  #   The view will not exceed the boundary of the visible terminal.
-  #   The view will move freely within the bounds of the interface,
-  #     irrespective of content.
-  #
-  class Move
-
-    extend Forwardable
-
-    def_delegators :geometry, :x, :xn, :y, :yn
-
-    # Move the named cursor or view, or that which is currently in focus in the
-    # specified direction.
-    #
-    # @param direction [Symbol] The direction of travel. Directions include:
-    #   (:down, :left, :right, :up, :origin). When ':origin' the cursor is moved
-    #   to the top left of the interface.
-    # @param name [String|NilClass] The name of the interface/cursor to be
-    #   moved; when not given, the interface currently in focus determines which
-    #   cursor instance to move.
-    # @return [Vedeu::Cursor]
-    def self.by_name(entity, direction, name = nil)
-      name = name ? name : Vedeu.focus
-
-      Vedeu::Move.send(direction, entity, name)
-    end
-
-    # Moves the cursor or view down by one row.
-    #
-    # @param entity [Class]
-    # @param name [String]
-    # @return [Vedeu::Cursor]
-    def self.down(entity, name)
-      new(entity, name, 1, 0).move
-    end
-
-    # Moves the cursor or view left by one column.
-    #
-    # @param entity [Class]
-    # @param name [String]
-    # @return [Vedeu::Cursor]
-    def self.left(entity, name)
-      new(entity, name, 0, -1).move
-    end
-
-    # Moves the cursor or view right by one column.
-    #
-    # @param entity [Class]
-    # @param name [String]
-    # @return [Vedeu::Cursor]
-    def self.right(entity, name)
-      new(entity, name, 0, 1).move
-    end
-
-    # Moves the cursor or view up by one row.
-    #
-    # @param entity [Class]
-    # @param name [String]
-    # @return [Vedeu::Cursor]
-    def self.up(entity, name)
-      new(entity, name, -1, 0).move
-    end
-
-    # Moves the cursor or view to the top left coordinate of the interface or
-    # terminal screen.
-    #
-    # @param entity [Class]
-    # @param name [String]
-    # @return [Vedeu::Cursor]
-    def self.origin(entity, name)
-      new(entity, name, -2000, -2000).move
-    end
-
-    # Returns an instance of Vedeu::Move.
-    #
-    # @param entity [Class]
-    # @param name [String] The name of the cursor or view.
-    # @param dy [Fixnum] Move up (-1), or down (1), or no action (0).
-    # @param dx [Fixnum] Move left (-1), or right (1), or no action (0).
-    # @return [Vedeu::Move]
-    def initialize(entity, name = nil, dy = 0, dx = 0)
-      @entity = entity
-      @name   = name ? name : Vedeu.focus
-      @dy     = dy
-      @dx     = dx
-    end
-
-    # Returns a newly positioned and stored cursor or view.
-    #
-    # @return [Vedeu::Cursor|Vedeu::Geometry]
-    def move
-      model = entity.new(merged_attributes).store
-
-      refresh
-
-      model
-    end
-
-    # @return [void]
-    def refresh
-      if entity.to_s == 'Vedeu::Geometry'
-        Vedeu.trigger(:_clear_)
-        Vedeu.trigger(:_refresh_)
-        Vedeu.trigger(:_clear_, name)
-        Vedeu.trigger(:_refresh_, name)
-
-      else
-        Vedeu.trigger(:_refresh_cursor_, name)
-
-      end
-    end
-
-    # @return [Hash<Symbol => Boolean,Fixnum, String>]
-    def merged_attributes
-      if entity.to_s == 'Vedeu::Geometry'
-        geometry_attributes
-
-      else
-        cursor_attributes
-
-      end
-    end
-
-    protected
-
-    # @!attribute [r] dx
-    # @return [Fixnum]
-    attr_reader :dx
-
-    # @!attribute [r] dy
-    # @return [Fixnum]
-    attr_reader :dy
-
-    # @!attribute [r] entity
-    # @return [Fixnum]
-    attr_reader :entity
-
-    # @!attribute [r] name
-    # @return [String]
-    attr_reader :name
-
-    private
-
-    # @return [Vedeu::Coordinate]
-    def coordinate
-      @coordinate ||= Vedeu::Coordinate.new(name, oy, ox)
-    end
-
-    # @return [Vedeu::Cursor]
-    # @see Vedeu::Cursors#by_name
-    def cursor
-      @cursor ||= Vedeu.cursors.by_name(name)
-    end
-
-    # @return [Hash<Symbol => void>]
-    def cursor_attributes
-      cursor.attributes.merge!(x:  coordinate.x_position,
-                               y:  coordinate.y_position,
-                               ox: ox,
-                               oy: oy)
-    end
-
-    # @see Vedeu::Geometries#by_name
-    def geometry
-      @geometry ||= Vedeu.geometries.by_name(name)
-    end
-
-    # @return [Hash<Symbol => FalseClass,String,Fixnum>]
-    def geometry_attributes
-      {
-        centred:    false,
-        maximised:  false,
-        name:       name,
-        x:          (x + dx),
-        y:          (y + dy),
-        xn:         (xn + dx),
-        yn:         (yn + dy),
-      }
-    end
-
-    # Apply the direction amount to the cursor offset. If the offset is less
-    # than 0, correct to 0.
-    #
-    # @return [Fixnum]
-    def ox
-      ox = cursor.ox + dx
-      ox = 0 if ox < 0
-      ox
-    end
-
-    # Apply the direction amount to the cursor offset. If the offset is less
-    # than 0, correct to 0.
-    #
-    # @return [Fixnum]
-    def oy
-      oy = cursor.oy + dy
-      oy = 0 if oy < 0
-      oy
-    end
-
-  end # Move
-
-end # Vedeu

data/lib/vedeu/cursor/reposition.rb

@@ -1,78 +0,0 @@
-module Vedeu
-
-  # Provides the mechanism to arbitrarily move a cursor to a given position.
-  #
-  class Reposition
-
-    # @return [Vedeu::Cursor]
-    # @see Vedeu::Reposition.new
-    def self.to(entity, name, y, x)
-      new(entity, name, y, x).to
-    end
-
-    # Returns a new instance of Vedeu::Reposition.
-    #
-    # @param entity [void]
-    # @param name [String]
-    # @param y [Fixnum] The row/line position.
-    # @param x [Fixnum] The column/character position.
-    # @return [Vedeu::Reposition]
-    def initialize(entity, name, y, x)
-      @entity = entity
-      @name   = name
-      @y      = y
-      @x      = x
-    end
-
-    # @return [Vedeu::Cursor]
-    def to
-      build_entity!
-
-      Vedeu.trigger(:_clear_, name)
-      Vedeu.trigger(:_refresh_, name)
-      Vedeu.trigger(:_refresh_cursor_, name)
-
-      new_entity
-    end
-
-    protected
-
-    # @!attribute [r] entity
-    # @return [String]
-    attr_reader :entity
-
-    # @!attribute [r] name
-    # @return [String]
-    attr_reader :name
-
-    # @!attribute [r] x
-    # @return [Fixnum]
-    attr_reader :x
-
-    # @!attribute [r] y
-    # @return [Fixnum]
-    attr_reader :y
-
-    private
-
-    # Build a new instance of the entity that is being repositioned and replace
-    # existing stored version.
-    #
-    # @return [Vedeu::Cursor|Vedeu::Geometry]
-    def build_entity!
-      @_entity ||= entity.new(name: name,
-                              y:    coordinate.y_position,
-                              x:    coordinate.x_position,
-                              oy:   y,
-                              ox:   x).store
-    end
-    alias_method :new_entity, :build_entity!
-
-    # @return [Vedeu::Coordinate]
-    def coordinate
-      @coordinate ||= Vedeu::Coordinate.new(name, y, x)
-    end
-
-  end # Reposition
-
-end # Vedeu

data/lib/vedeu/geometry/geometries.rb

@@ -1,15 +0,0 @@
-module Vedeu
-
-  # Allows the storing of interface/view geometry independent of the interface
-  # instance.
-  #
-  class Geometries < Vedeu::Repository
-
-    singleton_class.send(:alias_method, :geometries, :repository)
-
-    null Vedeu::Null::Geometry
-    real Vedeu::Geometry
-
-  end # Geometries
-
-end # Vedeu

data/lib/vedeu/refresh/refresh_cursor.rb

@@ -1,92 +0,0 @@
-module Vedeu
-
-  # Handle the refreshing (redrawing) of a cursor, without redrawing the whole
-  # interface; unless the cursor's offset has caused the view to change.
-  #
-  class RefreshCursor
-
-    extend Forwardable
-
-    def_delegators :border,
-                   :height,
-                   :width
-
-    # @param (see #initialize)
-    def self.by_name(name = Vedeu.focus)
-      new(name).by_name
-    end
-
-    # Returns a new instance of Vedeu::RefreshCursor.
-    #
-    # @param name [String] The name of the cursor.
-    # @return [Vedeu::RefreshCursor]
-    def initialize(name)
-      @name = name
-    end
-
-    # Renders the cursor in the terminal. If the cursor's x or y offsets are
-    # greater or equal to the interface's width or height respectively, then
-    # the view is also refreshed, causing the content to be offset also.
-    #
-    # @return [Array]
-    def by_name
-      Vedeu.log(type: :info, message: "Refreshing cursor: '#{name}'")
-
-      Vedeu.trigger(:_refresh_, name) if refresh_view?
-
-      Vedeu::Terminal.output(new_cursor.to_s)
-    end
-
-    protected
-
-    # @!attribute [r] name
-    # @return [String]
-    attr_reader :name
-
-    private
-
-    # Returns true when the view should be refreshed. This is determined by
-    # checking that the offsets for x and y are outside the width and height
-    # of the named interface.
-    #
-    # @return [Boolean]
-    def refresh_view?
-      new_cursor.ox >= width || new_cursor.oy >= height
-    end
-
-    # @return [Vedeu::Cursor]
-    def new_cursor
-      @new_cursor ||= Vedeu::Cursor.new(cursor.attributes.merge!(position))
-    end
-
-    # @return [Hash<Symbol => Fixnum>]
-    def position
-      {
-        x: cursor.x,
-        y: cursor.y,
-      }
-    end
-
-    # @return [Vedeu::Cursor]
-    # @see Vedeu::Cursors#by_name
-    def cursor
-      @cursor ||= Vedeu.cursors.by_name(name)
-    end
-
-    # Fetch the border by name.
-    #
-    # @note
-    #   Vedeu::Border is used in this way because when there is not a border
-    #   defined, it will fallback to a Vedeu::Null::Border which uses
-    #   Vedeu::Geometry to determine it's dimensions based on the name also.
-    #   When a Vedeu::Geometry cannot be found, this falls back to a
-    #   Vedeu::Null::Geometry which uses the current terminal's dimensions.
-    #
-    # @return (see Vedeu::Borders#by_name)
-    def border
-      @border ||= Vedeu.borders.by_name(name)
-    end
-
-  end # RefreshCursor
-
-end # Vedeu