vedeu 0.6.1 → 0.6.2

data/lib/vedeu/events/repository.rb

@@ -0,0 +1,30 @@
+module Vedeu
+
+  module Events
+
+    # Allows the storing of events.
+    #
+    class Repository < Vedeu::Repository
+
+      singleton_class.send(:alias_method, :events, :repository)
+
+      class << self
+
+        # Remove all stored models from the repository.
+        #
+        # @example
+        #   Vedeu.events.reset!
+        #
+        # @return [Vedeu::Events::Repository]
+        def reset!
+          @events = new(Vedeu::Events::Collection)
+        end
+        alias_method :reset, :reset!
+
+      end # Eigenclass
+
+    end # Repository
+
+  end # Events
+
+end # Vedeu

data/lib/vedeu/events/trigger.rb

@@ -1,84 +1,88 @@
 module Vedeu
 
-  # Trigger a registered or system event by name with arguments. If the
-  # event stored returns a value, that is returned. If multiple events are
-  # registered for a name, then the result of each event will be returned as
-  # part of a collection.
-  #
-  # @example
-  #   Vedeu.trigger(:my_event, :oxidize, 'nitrogen')
-  #
-  class Trigger
-
-    # @param name [Symbol] The name of the event you wish to trigger. The event
-    #   does not have to exist.
-    # @param args [Array] Any arguments the event needs to execute correctly.
-    # @return [Array]
-    def self.trigger(name, *args)
-      new(name, *args).trigger
-    end
-
-    # Returns a new instance of Vedeu::Trigger.
+  module Events
+
+    # Trigger a registered or system event by name with arguments. If the
+    # event stored returns a value, that is returned. If multiple events are
+    # registered for a name, then the result of each event will be returned as
+    # part of a collection.
     #
-    # @param (see .trigger)
-    # @return [Vedeu::Trigger]
-    def initialize(name, *args)
-      @name = name
-      @args = args
-      @repository = Vedeu.events
-    end
-
-    # Trigger the event and return the result or an array of results.
+    # @example
+    #   Vedeu.trigger(:my_event, :oxidize, 'nitrogen')
     #
-    # @return [Array]
-    def trigger
-      if results.one?
-        results[0]
+    class Trigger
+
+      # @param name [Symbol] The name of the event you wish to trigger. The
+      #   event does not have to exist.
+      # @param args [Array] Any arguments the event needs to execute correctly.
+      # @return [Array]
+      def self.trigger(name, *args)
+        new(name, *args).trigger
+      end
+
+      # Returns a new instance of Vedeu::Events::Trigger.
+      #
+      # @param (see .trigger)
+      # @return [Vedeu::Events::Trigger]
+      def initialize(name, *args)
+        @name = name
+        @args = args
+        @repository = Vedeu.events
+      end
+
+      # Trigger the event and return the result or an array of results.
+      #
+      # @return [Array]
+      def trigger
+        if results.one?
+          results[0]
 
-      else
-        results
+        else
+          results
 
+        end
       end
-    end
 
-    protected
+      protected
 
-    # @!attribute [r] name
-    # @return [Symbol]
-    attr_reader :name
+      # @!attribute [r] name
+      # @return [Symbol]
+      attr_reader :name
 
-    # @!attribute [r] args
-    # @return [Array]
-    attr_reader :args
+      # @!attribute [r] args
+      # @return [Array]
+      attr_reader :args
 
-    # @!attribute [r]
-    # @return [Vedeu::Repository]
-    attr_reader :repository
+      # @!attribute [r]
+      # @return [Vedeu::Repository]
+      attr_reader :repository
 
-    private
+      private
 
-    # @return [Array<void>|void]
-    def results
-      @results ||= registered_events.map { |event| event.trigger(*args) }
-    end
+      # @return [Array<void>|void]
+      def results
+        @results ||= registered_events.map { |event| event.trigger(*args) }
+      end
 
-    # Return all of the registered events for this name.
-    #
-    # @return [Array|Array<Vedeu::Event>]
-    def registered_events
-      if repository.registered?(name)
-        repository.find(name)
-
-      else
-        Vedeu::EventAliases.find(name).map do |event_name|
-          Vedeu::Trigger.trigger(event_name, *args)
-        end
+      # Return all of the registered events for this name.
+      #
+      # @return [Array|Array<Vedeu::Events::Event>]
+      def registered_events
+        if repository.registered?(name)
+          repository.find(name)
 
-        []
+        else
+          Vedeu::Events::Aliases.find(name).map do |event_name|
+            Vedeu::Events::Trigger.trigger(event_name, *args)
+          end
 
+          []
+
+        end
       end
-    end
 
-  end # Trigger
+    end # Trigger
+
+  end # Events
 
 end # Vedeu

data/lib/vedeu/exceptions.rb

@@ -1,78 +1,89 @@
 module Vedeu
 
-  # Raised with Vedeu attempts to access a client application controller that
-  # does not exist.
+  # Custom exceptions which Vedeu will raise in certain circumstances.
   #
-  class ControllerNotFound < StandardError
+  module Error
 
-  end # ControllerNotFound
+    # Raised with Vedeu attempts to access a client application controller's
+    # action that does not exist.
+    #
+    class ActionNotFound < StandardError
 
-  # Raised with Vedeu attempts to access a client application controller's
-  # action that does not exist.
-  #
-  class ActionNotFound < StandardError
+    end # ActionNotFound
 
-  end # ActionNotFound
+    # Raised with Vedeu attempts to access a client application controller that
+    # does not exist.
+    #
+    class ControllerNotFound < StandardError
 
-  # Raised with Vedeu attempts to access a named model that does not exist.
-  #
-  class ModelNotFound < StandardError
+    end # ControllerNotFound
 
-  end # ModeSwitch
+    # Raised when Vedeu encounters an error.
+    #
+    class Fatal < StandardError
 
-  # Raised when Vedeu attempts to parse a {Vedeu.view} or {Vedeu.interface} and
-  # encounters a problem.
-  #
-  class InvalidSyntax < StandardError
+    end # Fatal
 
-  end # InvalidSyntax
+    # Raised when Vedeu wishes to exit.
+    #
+    # @see Vedeu::MainLoop
+    #
+    class Interrupt < StandardError
 
-  # Raised when a name is not provided for a model when attempting to store it
-  # in a repository.
-  #
-  class MissingRequired < StandardError
+    end # Interrupt
 
-  end # MissingRequired
+    # Raised when Vedeu attempts to parse a view or interface and encounters a
+    # problem.
+    #
+    class InvalidSyntax < StandardError
 
-  # Raised intentionally when the client application wishes to switch between
-  # cooked, fake and raw terminal modes.
-  #
-  # @see Vedeu::Application
-  #
-  class ModeSwitch < StandardError
+    end # InvalidSyntax
 
-  end # ModeSwitch
+    # Raised when a name is not provided for a model when attempting to store it
+    # in a repository.
+    #
+    class MissingRequired < StandardError
 
-  # Raised to remind me (or client application developers) that the subclass
-  # implements the functionality sought.
-  #
-  # @see Vedeu::ColourTranslator
-  #
-  class NotImplemented < StandardError
+    end # MissingRequired
 
-  end # NotImplemented
+    # Raised with Vedeu attempts to access a named model that does not exist.
+    #
+    class ModelNotFound < 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.
-  #
-  # @see Vedeu::Grid
-  #
-  class OutOfRange < StandardError
+    end # ModelNotFound
 
-  end # OutOfRange
+    # Raised intentionally when the client application wishes to switch between
+    # cooked, fake and raw terminal modes.
+    #
+    # @see Vedeu::Application
+    #
+    class ModeSwitch < StandardError
 
-  # Raised when Vedeu encounters an error.
-  #
-  class VedeuError < StandardError
+    end # ModeSwitch
 
-  end # VedeuError,
+    # Raised to remind me (or client application developers) that the subclass
+    # implements the functionality sought.
+    #
+    # @see Vedeu::Colours::Translator
+    #
+    class NotImplemented < StandardError
 
-  # Raised when Vedeu wishes to exit.
-  #
-  # @see Vedeu::MainLoop
-  #
-  class VedeuInterrupt < StandardError
+    end # NotImplemented
+
+    # 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.
+    #
+    # @see Vedeu::Grid
+    #
+    class OutOfRange < StandardError
+
+      # @return [String]
+      def message
+        'Valid value is between 1 and 12 inclusive.'
+      end
+
+    end # OutOfRange
 
-  end # VedeuInterrupt
+  end # Error
 
 end # Vedeu

data/lib/vedeu/geometry/coordinate.rb

@@ -159,13 +159,15 @@ module Vedeu
 
     # 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::InvalidSyntax,
+                   fail Vedeu::Error::InvalidSyntax,
                         'Coordinate type not given, cannot continue.'
                  end
     end

data/lib/vedeu/geometry/grid.rb

@@ -29,16 +29,14 @@ module Vedeu
 
     # @see Vedeu::DSL::Geometry#columns
     def columns
-      fail Vedeu::OutOfRange,
-           'Valid value between 1 and 12 inclusive.' if out_of_range?
+      fail Vedeu::Error::OutOfRange if out_of_range?
 
       column * value
     end
 
     # @see Vedeu::DSL::Geometry#rows
     def rows
-      fail Vedeu::OutOfRange,
-           'Valid value between 1 and 12 inclusive.' if out_of_range?
+      fail Vedeu::Error::OutOfRange if out_of_range?
 
       row * value
     end

data/lib/vedeu/input/editor/all.rb

@@ -11,8 +11,9 @@ end # Vedeu
 require 'vedeu/input/editor/capture'
 require 'vedeu/input/editor/cropper'
 require 'vedeu/input/editor/editor'
+require 'vedeu/input/editor/insert'
 require 'vedeu/input/editor/line'
 require 'vedeu/input/editor/lines'
-require 'vedeu/input/editor/virtual_cursor'
+require 'vedeu/input/editor/cursor'
 require 'vedeu/input/editor/document'
 require 'vedeu/input/editor/documents'

data/lib/vedeu/input/editor/{virtual_cursor.rb → cursor.rb}

@@ -4,7 +4,7 @@ module Vedeu
 
     # Maintains a cursor position within the Vedeu::Editor::Document class.
     #
-    class VirtualCursor
+    class Cursor
 
       # @!attribute [rw] bx
       # @return [Fixnum]
@@ -38,7 +38,7 @@ module Vedeu
       # @return [Fixnum]
       attr_accessor :y
 
-      # Returns a new instance of Vedeu::Editor::VirtualCursor.
+      # Returns a new instance of Vedeu::Editor::Cursor.
       #
       # @param attributes [Hash]
       # @option attributes y [Fixnum] The current line.
@@ -49,7 +49,7 @@ module Vedeu
       # @option attributes bxn [Fixnum]
       # @option attributes oy [Fixnum]
       # @option attributes ox [Fixnum]
-      # @return [Vedeu::Editor::VirtualCursor]
+      # @return [Vedeu::Editor::Cursor]
       def initialize(attributes = {})
         @attributes = defaults.merge!(attributes)
 
@@ -60,7 +60,7 @@ module Vedeu
 
       # Move the virtual cursor to the beginning of the line.
       #
-      # @return [Vedeu::Editor::VirtualCursor]
+      # @return [Vedeu::Editor::Cursor]
       def bol
         @ox = 0
         @x  = 0
@@ -70,7 +70,7 @@ module Vedeu
 
       # Move the virtual cursor down by one line.
       #
-      # @return [Vedeu::Editor::VirtualCursor]
+      # @return [Vedeu::Editor::Cursor]
       def down
         @y += 1
 
@@ -79,7 +79,7 @@ module Vedeu
 
       # Move the virtual cursor to the left.
       #
-      # @return [Vedeu::Editor::VirtualCursor]
+      # @return [Vedeu::Editor::Cursor]
       def left
         @ox -= 1 unless @ox == 0
         @x  -= 1
@@ -89,7 +89,7 @@ module Vedeu
 
       # Move the virtual cursor to the origin (0, 0).
       #
-      # @return [Vedeu::Editor::VirtualCursor]
+      # @return [Vedeu::Editor::Cursor]
       def reset!
         @x  = 0
         @y  = 0
@@ -101,7 +101,7 @@ module Vedeu
 
       # Move the virtual cursor to the right.
       #
-      # @return [Vedeu::Editor::VirtualCursor]
+      # @return [Vedeu::Editor::Cursor]
       def right
         @x += 1
 
@@ -118,7 +118,7 @@ module Vedeu
 
       # Move the virtual cursor up by one line.
       #
-      # @return [Vedeu::Editor::VirtualCursor]
+      # @return [Vedeu::Editor::Cursor]
       def up
         @oy -= 1 unless @oy == 0
         @y  -= 1
@@ -174,7 +174,7 @@ module Vedeu
         (bx + x) - ox
       end
 
-    end # VirtualCursor
+    end # Cursor
 
   end # Editor