vedeu 0.2.10 → 0.2.11

data/lib/vedeu/{models → repositories/models}/cursor.rb

@@ -6,6 +6,7 @@ module Vedeu
   # @api private
   class Cursor
 
+    include Model
     extend Forwardable
 
     def_delegators :interface, :top, :right, :bottom, :left
@@ -94,7 +95,7 @@ module Vedeu
     def show
       @state = :show
 
-      Cursors.update(attributes)
+      store
     end
 
     # Make the cursor invisible.
@@ -103,7 +104,7 @@ module Vedeu
     def hide
       @state = :hide
 
-      Cursors.update(attributes)
+      store
     end
 
     # Returns an escape sequence to position the cursor and set its visibility.
@@ -124,6 +125,11 @@ module Vedeu
 
     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]

data/lib/vedeu/{models → repositories/models}/event.rb

@@ -5,6 +5,8 @@ module Vedeu
   # @api private
   class Event
 
+    include Model
+
     # Returns a new instance of Event.
     #
     # @param name [Symbol]
@@ -37,6 +39,11 @@ module Vedeu
     attr_reader   :closure, :name
     attr_accessor :deadline, :executed_at, :now
 
+    # @return [Class] The repository class for this model.
+    def repository
+      Vedeu::Events
+    end
+
     # Execute the code stored in the event closure.
     #
     # @param args []

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

@@ -0,0 +1,56 @@
+module Vedeu
+
+  # Interfaces can be associated with one another by being members of the same
+  # Group. A Group is a collection of interface names.
+  #
+  class Group
+
+    attr_reader :name
+
+    # Return a new instance of Group.
+    #
+    # @param name [String] The name of the group.
+    # @param members [String]
+    # @return [Group]
+    def initialize(name, *members)
+      @members = members.to_set
+      @name    = name
+    end
+
+    # Add a member to the group by name.
+    #
+    # @param member [String]
+    # @return [Group]
+    def add(member)
+      new_members = @members.add(member)
+
+      Group.new(name, *new_members)
+    end
+
+    # Returns the members as a collection.
+    #
+    # @return [Array]
+    def members
+      @members.to_a
+    end
+
+    # Remove a member from the group by name.
+    #
+    # @param member [String]
+    # @return [Group]
+    def remove(member)
+      new_members = @members.delete(member)
+
+      Group.new(name, *new_members)
+    end
+
+    # Remove all members from the group.
+    #
+    # @return [Group]
+    def reset
+      Group.new(name)
+    end
+
+  end # Group
+
+end # Vedeu

data/lib/vedeu/{models → repositories/models}/interface.rb

@@ -9,6 +9,7 @@ module Vedeu
 
     include Coercions
     include Common
+    include Model
     include Presentation
 
     extend Forwardable
@@ -117,6 +118,11 @@ module Vedeu
 
     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]

data/lib/vedeu/{models → repositories/models}/keymap.rb

@@ -7,6 +7,7 @@ module Vedeu
   class Keymap
 
     include Common
+    include Model
 
     attr_reader :attributes
 
@@ -73,13 +74,18 @@ module Vedeu
         instance_eval(&block)
       end
 
-      Keymaps.add(attributes)
+      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]

data/lib/vedeu/{models → repositories/models}/menu.rb

@@ -6,6 +6,8 @@ module Vedeu
   # @api private
   class Menu
 
+    include Model
+
     # Returns a new instance of Menu.
     #
     # @param collection [Array]
@@ -157,6 +159,13 @@ module Vedeu
       @collection.size
     end
 
+    private
+
+    # @return [Class] The repository class for this model.
+    def repository
+      Vedeu::Menus
+    end
+
   end # Menu
 
 end # Vedeu

data/lib/vedeu/{models → repositories/models}/offset.rb

@@ -11,6 +11,8 @@ module Vedeu
   # @api private
   class Offset
 
+    include Model
+
     attr_reader :name
 
     # Returns a new instance of Offset.
@@ -45,7 +47,7 @@ module Vedeu
       @y += relative_y
       @x += relative_x
 
-      Offsets.update(attributes)
+      store
     end
 
     # Returns the current x offset, correcting to 0 if less than 0.
@@ -68,6 +70,11 @@ module Vedeu
 
     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]

data/lib/vedeu/repositories/offsets.rb

@@ -7,9 +7,22 @@ module Vedeu
   module Offsets
 
     include Repository
-    include Positional
     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)
@@ -41,9 +54,9 @@ module Vedeu
       Focus.refresh
     end
 
-    # @return [Class]
-    def entity
-      Offset
+    # @return [Class] The model class for this repository.
+    def model
+      Vedeu::Offset
     end
 
     # @return [Hash]
@@ -51,14 +64,6 @@ module Vedeu
       {}
     end
 
-    # System events which when called will move in the direction specified;
-    # these will update the cursor position or content offset (scrolling)
-    # according to the interface in focus.
-    Vedeu.event(:_cursor_up_)    { up    }
-    Vedeu.event(:_cursor_right_) { right }
-    Vedeu.event(:_cursor_down_)  { down  }
-    Vedeu.event(:_cursor_left_)  { left  }
-
   end # Offsets
 
 end # Vedeu

data/lib/vedeu/support/bounding_area.rb

@@ -0,0 +1,127 @@
+module Vedeu
+
+  class BoundingArea
+
+    attr_reader :height, :width
+
+    # Returns an instance of BoundingArea.
+    #
+    # @param height [Fixnum]
+    # @param width [Fixnum]
+    # @return [ConsoleGeometry]
+    def initialize(height, width)
+      @height = height
+      @width  = width
+    end
+
+    # Returns the top line (y) coordinate for the console.
+    #
+    # @example
+    #   # height = 20
+    #
+    #   top     # => 1
+    #   top(5)  # => 6
+    #   top(-5) # => 1
+    #   top(25) # => 20
+    #
+    # @param offset [Fixnum] When provided, returns the top coordinate plus
+    #   the offset.
+    # @return [Fixnum]
+    def top(offset = 0)
+      if offset >= height
+        height
+
+      elsif offset <= 1
+        1
+
+      else
+        1 + offset
+
+      end
+    end
+    alias_method :y, :top
+
+    # Returns the bottom line (yn) coordinate for the console.
+    #
+    # @example
+    #   # height = 20
+    #
+    #   bottom     # => 20
+    #   bottom(5)  # => 15
+    #   bottom(-5) # => 20
+    #   bottom(25) # => 1
+    #
+    # @param offset [Fixnum] When provided, returns the bottom coordinate minus
+    #   the offset.
+    # @return [Fixnum]
+    def bottom(offset = 0)
+      if offset >= height
+        1
+
+      elsif offset < 0
+        height
+
+      else
+        height - offset
+
+      end
+    end
+    alias_method :yn, :bottom
+
+    # Returns the leftmost column (x) coordinate for the console.
+    #
+    # @example
+    #   # width = 40
+    #
+    #   left     # => 1
+    #   left(5)  # => 6
+    #   left(-5) # => 1
+    #   left(45) # => 40
+    #
+    # @param offset [Fixnum] When provided, returns the left coordinate plus
+    #   the offset.
+    # @return [Fixnum]
+    def left(offset = 0)
+      if offset >= width
+        width
+
+      elsif offset <= 1
+        1
+
+      else
+        1 + offset
+
+      end
+    end
+    alias_method :x, :left
+
+    # Returns the rightmost column (yn) coordinate for the console.
+    #
+    # @example
+    #   # width = 40
+    #
+    #   right     # => 40
+    #   right(5)  # => 35
+    #   right(-5) # => 40
+    #   right(45) # => 1
+    #
+    # @param offset [Fixnum] When provided, returns the right coordinate minus
+    #   the offset.
+    # @return [Fixnum]
+    def right(offset = 0)
+      if offset >= width
+        1
+
+      elsif offset < 0
+        width
+
+      else
+        width - offset
+
+      end
+    end
+    alias_method :xn, :right
+
+  end # BoundingArea
+
+end # Vedeu

data/lib/vedeu/support/common.rb

@@ -16,6 +16,14 @@ module Vedeu
       false
     end
 
+    # Returns the array as a sentence.
+    #
+    # @param array [Array]
+    # @return [String]
+    def to_sentence(array)
+      Vedeu::Sentence.construct(array)
+    end
+
   end # Common
 
 end # Vedeu

data/lib/vedeu/support/exceptions.rb

@@ -1,14 +1,7 @@
 module Vedeu
 
-  # Raised when Vedeu attempts to access a named buffer that does not exist.
-  BufferNotFound = Class.new(StandardError)
-
-  # Raised when trying to access a group of interfaces which do not exist by
-  # this name.
-  GroupNotFound = Class.new(StandardError)
-
-  # Raised when an interface cannot be found by name.
-  InterfaceNotFound = Class.new(StandardError)
+  # 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.
@@ -17,9 +10,6 @@ module Vedeu
   # Raised when attempting to assign a key which is already in use.
   KeyInUse = Class.new(StandardError)
 
-  # Raised when a menu cannot be found by name.
-  MenuNotFound = 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)

data/lib/vedeu/support/model.rb

@@ -0,0 +1,14 @@
+module Vedeu
+
+  module Model
+
+    attr_reader :repository
+
+    # @return [void] The model instance stored in the repository.
+    def store
+      repository.store(self)
+    end
+
+  end # Model
+
+end # Vedeu