vedeu 0.2.12 → 0.3.0

data/lib/vedeu/repositories/models/cursor.rb

@@ -1,209 +0,0 @@
-module Vedeu
-
-  # Each interface has its own Cursor which maintains the position and
-  # visibility of the cursor within that interface.
-  #
-  # @api private
-  class Cursor
-
-    include Model
-    extend Forwardable
-
-    def_delegators :interface, :top, :right, :bottom, :left
-
-    attr_reader :name, :state
-
-    # Provides a new instance of Cursor.
-    #
-    # @param attributes [Hash] The stored attributes for a cursor.
-    # @option attributes :name [String] The name of the interface this cursor
-    #   belongs to.
-    # @option attributes :state [Symbol] The visibility of the cursor, either
-    #   +:hide+ or +:show+.
-    # @option attributes :x [Fixnum] The terminal x coordinate for the cursor.
-    # @option attributes :y [Fixnum] The terminal y coordinate for the cursor.
-    #
-    # @return [Cursor]
-    def initialize(attributes = {})
-      @attributes = defaults.merge(attributes)
-
-      @name  = @attributes[:name]
-      @state = @attributes[:state]
-      @x     = @attributes[:x]
-      @y     = @attributes[:y]
-    end
-
-    # Returns an attribute hash for the current position and visibility of the
-    # cursor.
-    #
-    # @return [Hash]
-    def attributes
-      {
-        name:  name,
-        state: state,
-        x:     x,
-        y:     y,
-      }
-    end
-    alias_method :refresh, :attributes
-
-    # Returns the x coordinate (column/character) of the cursor. Attempts to
-    # sensibly reposition the cursor if it is currently outside the interface,
-    # or outside the visible area of the terminal. If the interface has either a
-    # left or right border, then the cursor will be repositioned to be inside
-    # the border not on it.
-    #
-    # @return [Fixnum]
-    def x
-      @x = 1              if @x <= 1
-      @x = Terminal.width if @x >= Terminal.width
-
-      if border? && border.left? && @x <= (left + 1)
-        @x = (left + 1)
-
-      elsif @x <= left
-        @x = left
-
-      elsif border? && border.right? && @x >= (right - 1)
-        @x = (right - 2)
-
-      elsif @x >= right
-        @x = right
-
-      else
-        @x
-
-      end
-    end
-
-    # Returns the y coordinate (row/line) of the cursor. Attempts to sensibly
-    # reposition the cursor if it is currently outside the interface, or outside
-    # the visible area of the terminal. If the interface has either a top or
-    # bottom border, then the cursor will be repositioned to be inside the
-    # border not on it.
-    #
-    # @return [Fixnum]
-    def y
-      @y = 1               if @y <= 1
-      @y = Terminal.height if @y >= Terminal.height
-
-      if border? && border.top? && @y <= (top + 1)
-        @y = (top + 1)
-
-      elsif @y <= top
-        @y = top
-
-      elsif border? && border.bottom? && @y >= (bottom - 1)
-        @y = (bottom - 2)
-
-      elsif @y >= bottom
-        @y = bottom
-
-      else
-        @y
-
-      end
-    end
-
-    # Make the cursor visible.
-    #
-    # @return [Hash]
-    def show
-      @state = :show
-
-      store
-    end
-
-    # Make the cursor invisible.
-    #
-    # @return [Hash]
-    def hide
-      @state = :hide
-
-      store
-    end
-
-    # Returns an escape sequence to position the cursor and set its visibility.
-    # When passed a block, will position the cursor, yield and return the
-    # original position.
-    #
-    # @param block [Proc]
-    # @return [String]
-    def to_s(&block)
-      if block_given?
-        [ sequence, yield, sequence ].join
-
-      else
-        sequence
-
-      end
-    end
-
-    private
-
-    # @return [Class] The repository class for this model.
-    def repository
-      Vedeu::Cursors
-    end
-
-    # Returns the escape sequence to position the cursor and set its visibility.
-    #
-    # @return [String]
-    def sequence
-      [ position, visibility ].join
-    end
-
-    # Returns the escape sequence for setting the position of the cursor.
-    #
-    # @return [String]
-    def position
-      @_position ||= Position.new(y, x).to_s
-    end
-
-    # Returns the escape sequence for setting the visibility of the cursor.
-    #
-    # @return [String]
-    def visibility
-      return Esc.string('show_cursor') if state == :show
-
-      Esc.string('hide_cursor')
-    end
-
-    # Returns a boolean indicating whether the interface has a border.
-    #
-    # @return [Boolean]
-    def border?
-      border.enabled?
-    end
-
-    def border
-      interface.border
-    end
-
-    # Returns an instance of the associated interface for this cursor, used to
-    # ensure that {x} and {y} are still 'inside' the interface. A cursor could
-    # be 'outside' the interface if the terminal has resized, causing the
-    # geometry of an interface to change and therefore invalidating the cursor's
-    # position.
-    #
-    # @api private
-    # @return [Interface]
-    def interface
-      @interface ||= Interfaces.build(name)
-    end
-
-    # The default values for a new instance of Cursor.
-    #
-    # @return [Hash]
-    def defaults
-      {
-        name:  '',
-        state: :hide,
-        x:     1,
-        y:     1,
-      }
-    end
-
-  end # Cursor
-
-end # Vedeu

data/lib/vedeu/repositories/models/interface.rb

@@ -1,163 +0,0 @@
-module Vedeu
-
-  # An Interface represents a portion of the terminal defined by
-  # {Vedeu::Geometry}. It is a container for {Vedeu::Line} and {Vedeu::Stream}
-  # objects.
-  #
-  # @api private
-  class Interface
-
-    include Coercions
-    include Common
-    include Model
-    include Presentation
-
-    extend Forwardable
-
-    def_delegators :geometry, :north, :east, :south, :west, :top, :right,
-                              :bottom, :left, :width, :height, :origin
-
-    attr_reader :attributes, :delay, :group, :name, :parent
-
-    # Builds up a new Interface object and returns the attributes.
-    #
-    # @param  attributes [Hash]
-    # @param  block [Proc]
-    # @return [Hash]
-    def self.build(attributes = {}, &block)
-      new(attributes, &block).attributes
-    end
-
-    # @see Vedeu::API#interface
-    # @param attributes [Hash]
-    # @param block [Proc]
-    # @return []
-    def self.define(attributes = {}, &block)
-      new(attributes).define(&block)
-    end
-
-    # Return a new instance of Interface.
-    #
-    # @param  attributes [Hash]
-    # @param  block [Proc]
-    # @return [Interface]
-    def initialize(attributes = {}, &block)
-      @attributes = defaults.merge(attributes)
-
-      @cursor     = @attributes[:cursor]
-      @delay      = @attributes[:delay]
-      @group      = @attributes[:group]
-      @name       = @attributes[:name]
-      @parent     = @attributes[:parent]
-
-      if block_given?
-        @self_before_instance_eval = eval('self', block.binding)
-
-        instance_eval(&block)
-      end
-    end
-
-    # @see Vedeu::API#interface
-    # @param block [Proc]
-    # @return [Interface]
-    def define(&block)
-      instance_eval(&block) if block_given?
-
-      Registrar.record(attributes)
-
-      self
-    end
-
-    # Returns an instance of Border.
-    #
-    # @return [Border]
-    def border
-      @_border ||= Border.new(self, attributes[:border])
-    end
-
-    # Returns an instance of Cursor.
-    #
-    # @return [Cursor]
-    def cursor
-      @_cursor ||= Cursor.new({
-        name:  name,
-        state: attributes[:cursor],
-        x:     geometry.x_position(offset.x),
-        y:     geometry.y_position(offset.y),
-      })
-    end
-
-    # Returns a boolean indicating whether this interface is currently in focus.
-    #
-    # @return [Boolean]
-    def in_focus?
-      Focus.current?(name)
-    end
-
-    # Returns a collection of lines associated with this interface.
-    #
-    # @return [Array]
-    def lines
-      @lines ||= Line.coercer(attributes[:lines])
-    end
-    alias_method :content, :lines
-
-    # Returns the position and size of the interface.
-    #
-    # @return [Geometry]
-    def geometry
-      @geometry ||= Geometry.new(attributes[:geometry])
-    end
-
-    # Returns the current offset for the content within the interface.
-    #
-    # @return [Offset]
-    def offset
-      @offset ||= Offsets.find_or_create(name)
-    end
-
-    # Returns the currently visible area of the interface.
-    #
-    # @return [Viewport]
-    def viewport
-      @_viewport ||= Viewport.show(self)
-    end
-
-    private
-
-    # @return [Class] The repository class for this model.
-    def repository
-      Vedeu::Interfaces
-    end
-
-    # The default values for a new instance of Interface.
-    #
-    # @return [Hash]
-    def defaults
-      {
-        border:   {},
-        colour:   {},
-        cursor:   :hide,
-        delay:    0.0,
-        geometry: {},
-        group:    '',
-        lines:    [],
-        name:     '',
-        parent:   nil,
-        style:    '',
-      }
-    end
-
-    # @param method [Symbol] The name of the method sought.
-    # @param args [Array] The arguments which the method was to be invoked with.
-    # @param block [Proc] The optional block provided to the method.
-    # @return []
-    def method_missing(method, *args, &block)
-      Vedeu.log("Interface#method_missing '#{method}' (args: #{args.inspect})")
-
-      @self_before_instance_eval.send(method, *args, &block) if @self_before_instance_eval
-    end
-
-  end # Interface
-
-end # Vedeu

data/lib/vedeu/repositories/models/keymap.rb

@@ -1,111 +0,0 @@
-module Vedeu
-
-  # A Keymap is the binding of a keypress to one or more interfaces; or globally
-  # to perform a client application defined action.
-  #
-  # @api private
-  class Keymap
-
-    include Common
-    include Model
-
-    attr_reader :attributes
-
-    # Define actions for keypresses for when specific interfaces are in focus.
-    # Unless an interface is specified, the key will be assumed to be global,
-    # meaning its action will happen regardless of the interface in focus.
-    #
-    # @param name_or_names [String] The name or names of the interface(s) which
-    #   will handle these keys.
-    # @param block [Proc]
-    #
-    # @example
-    #   keys do                    # => will be global
-    #     key('s') { :something }
-    #     ...
-    #
-    #   keys 'my_interface' do     # => will only function when 'my_interface'
-    #     ...                      #    is in focus
-    #
-    #   keys('main', 'other') do   # => will function for both 'main' and
-    #     ...                      #    'other' interfaces
-    #
-    #   keys do
-    #     interface 'my_interface' # => will only function when 'my_interface'
-    #     ...                      #    is in focus
-    #
-    # @raise [InvalidSyntax] When the required block is not given.
-    # @return [Keymap]
-    def self.keys(*name_or_names, &block)
-      fail InvalidSyntax, '`keys` requires a block.' unless block_given?
-
-      define({ interfaces: name_or_names }, &block)
-    end
-
-    # Define a keymap for an interface or interfaces to perform an action when
-    # a key is pressed whilst an aforementioned interface is in focus.
-    #
-    # @param attributes [Hash] The attributes to register the keymap with.
-    # @option attributes :interfaces [] the interface(s) which will respond to
-    #   the keypress(es)
-    # @option attributes :keys [] the keypress/action pairs for this keymap
-    # @param block [Proc]
-    # @return [Keymap]
-    def self.define(attributes = {}, &block)
-      new(attributes).define(&block)
-    end
-
-    # Instantiate a new instance of the Keymap model.
-    #
-    # @param attributes [Hash]
-    # @return [Keymap]
-    def initialize(attributes = {})
-      @attributes = defaults.merge(attributes)
-    end
-
-    # Adds the attributes to the Keymaps repository.
-    #
-    # @param block [Proc]
-    # @return [Keymap]
-    def define(&block)
-      if block_given?
-        @self_before_instance_eval = eval('self', block.binding)
-
-        instance_eval(&block)
-      end
-
-      repository.add(attributes)
-
-      self
-    end
-
-    private
-
-    # @return [Class] The repository class for this model.
-    def repository
-      Vedeu::Keymaps
-    end
-
-    # The default attributes of the Keymap model.
-    #
-    # @return [Hash]
-    def defaults
-      {
-        interfaces: [],
-        keys:       [],
-      }
-    end
-
-    # @param method [Symbol] The name of the method sought.
-    # @param args [Array] The arguments which the method was to be invoked with.
-    # @param block [Proc] The optional block provided to the method.
-    # @return []
-    def method_missing(method, *args, &block)
-      Vedeu.log("Keymap#method_missing '#{method}' (args: #{args.inspect})")
-
-      @self_before_instance_eval.send(method, *args, &block) if @self_before_instance_eval
-    end
-
-  end # Keymap
-
-end # Vedeu

data/lib/vedeu/repositories/models/offset.rb

@@ -1,91 +0,0 @@
-module Vedeu
-
-  # Offset represents the scroll position of the content for an interface. The
-  # values herein are relative to the geometry of the interface.
-  #
-  # @note (to self) An offset is a position. A cursor resides at a position in
-  #   an interface, ergo we can calculate cursors based from offsets. Also, we
-  #   could rename Offset to Position, then kill Cursor, Cursors, and the old
-  #   Position class.
-  #
-  # @api private
-  class Offset
-
-    include Model
-
-    attr_reader :name
-
-    # Returns a new instance of Offset.
-    #
-    # @param attributes [Hash]
-    # @return [Offset]
-    def initialize(attributes = {})
-      @attributes = defaults.merge(attributes)
-      @name       = @attributes[:name]
-      @y          = @attributes[:y]
-      @x          = @attributes[:x]
-    end
-
-    # Return a convenient hash of the current values of this instance.
-    #
-    # @return [Hash]
-    def attributes
-      {
-        name: name,
-        y:    y,
-        x:    x,
-      }
-    end
-
-    # Adjusts the offset using the relative values provided, and updates the
-    # stored attributes. The values passed are -1, 0 or 1.
-    #
-    # @param relative_y [Fixnum] Move up (-1), or down (1), or no action (0).
-    # @param relative_x [Fixnum] Move left (-1), or right (1), or no action (0).
-    # @return [Offset]
-    def move(relative_y, relative_x)
-      @y += relative_y
-      @x += relative_x
-
-      store
-    end
-
-    # Returns the current x offset, correcting to 0 if less than 0.
-    #
-    # @return [Fixnum]
-    def x
-      return @x = 0 if @x <= 0
-
-      @x
-    end
-
-    # Returns the current y offset, correcting to 0 if less than 0.
-    #
-    # @return [Fixnum]
-    def y
-      return @y = 0 if @y <= 0
-
-      @y
-    end
-
-    private
-
-    # @return [Class] The repository class for this model.
-    def repository
-      Vedeu::Offsets
-    end
-
-    # Return the default values for an instance of Offset.
-    #
-    # @return [Hash]
-    def defaults
-      {
-        name: '',
-        y:    0,
-        x:    0,
-      }
-    end
-
-  end # Offset
-
-end # Vedeu

data/lib/vedeu/repositories/offsets.rb

@@ -1,69 +0,0 @@
-module Vedeu
-
-  # Repository for storing and retrieving content offsets; i.e. scroll
-  # position for a named interface.
-  #
-  # @api private
-  module Offsets
-
-    include Repository
-    extend self
-
-    # Add or update the offset coordinates.
-    #
-    # @param attributes [Hash]
-    # @return [Offset]
-    def add(attributes)
-      validate_attributes!(attributes)
-
-      Vedeu.log("#{action(__callee__)} positional (#{model}): " \
-                "'#{attributes[:name]}'")
-
-      model.new(attributes).store
-    end
-    alias_method :update, :add
-
-    # @return [Array]
-    def down
-      move(1, 0)
-    end
-
-    # @return [Array]
-    def up
-      move(-1, 0)
-    end
-
-    # @return [Array]
-    def right
-      move(0, 1)
-    end
-
-    # @return [Array]
-    def left
-      move(0, -1)
-    end
-
-    private
-
-    # @param y [Fixnum]
-    # @param x [Fixnum]
-    # @return [Array]
-    def move(y, x)
-      find_or_create(Focus.current).move(y, x)
-
-      Focus.refresh
-    end
-
-    # @return [Class] The model class for this repository.
-    def model
-      Vedeu::Offset
-    end
-
-    # @return [Hash]
-    def in_memory
-      {}
-    end
-
-  end # Offsets
-
-end # Vedeu

data/lib/vedeu/support/exceptions.rb

@@ -1,34 +0,0 @@
-module Vedeu
-
-  # Raised with Vedeu attempts to access a named model that does not exist.
-  ModelNotFound = Class.new(StandardError)
-
-  # Raised when Vedeu attempts to parse a {Vedeu.view} or {Vedeu.interface} and
-  # encounters a problem.
-  InvalidSyntax = Class.new(StandardError)
-
-  # Raised when attempting to assign a key which is already in use.
-  KeyInUse = Class.new(StandardError)
-
-  # Raised when the attributes argument to {Vedeu::Registrar} does not contain
-  # a required key or the value to that key is nil or empty.
-  MissingRequired = Class.new(StandardError)
-
-  # Raised intentionally when the client application wishes to switch between
-  # cooked and raw (or vice versa) terminal modes. Vedeu is hard-wired to use
-  # the `Escape` key to trigger this change for the time being.
-  ModeSwitch = Class.new(StandardError)
-
-  # Raised when attempting to reach the currently in focus interface, when no
-  # interfaces have been defined yet.
-  NoInterfacesDefined = Class.new(StandardError)
-
-  # Raised to remind me (or client application developers) that the subclass
-  # implements the functionality sought.
-  NotImplemented = Class.new(StandardError)
-
-  # 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.
-  OutOfRange = Class.new(StandardError)
-
-end # Vedeu