vedeu 0.6.10 → 0.6.11

data/lib/vedeu/esc/esc.rb

@@ -4,91 +4,96 @@ require 'vedeu/esc/colours'
 
 module Vedeu
 
-  # Provides escape sequence strings for setting the cursor position
-  # and various display related functions.
-  #
-  module Esc
-
-    include Vedeu::EscapeSequences::Actions
-    include Vedeu::EscapeSequences::Borders
-    include Vedeu::EscapeSequences::Colours
-    extend self
-
-    # Return the stream with the escape sequences escaped so that they
-    # can be printed to the terminal instead of being interpreted by
-    # the terminal which will render them. This way we can see what
-    # escape sequences are being sent along with the content.
-    #
-    # @param stream [String]
-    # @return [String]
-    def escape(stream = '')
-      return stream if stream.nil? || stream.empty?
-
-      stream.gsub(/\e/, '\\e')
-    end
-
-    # Return the escape sequence string from the list of recognised
-    # sequence 'commands', or an empty string when the 'command'
-    # cannot be found.
-    #
-    # @param value [String|Symbol]
-    # @return [String]
-    def string(value = '')
-      return '' if value.empty?
-
-      send(value.to_sym)
-    rescue NoMethodError
-      ''
-    end
+  module EscapeSequences
 
-    # Return the escape sequence to render a border character.
+    # Provides escape sequence strings for setting the cursor position
+    # and various display related functions.
     #
-    # @return [String]
-    # @yieldreturn [void] The border character to wrap with border on
-    #   and off escape sequences.
-    def border
-      return '' unless block_given?
-
-      "#{border_on}#{yield}#{border_off}"
-    end
-
-    private
-
-    # @return [String]
-    def clear
-      "#{colour_reset}\e[2J"
-    end
-
-    # @return [String]
-    def clear_line
-      "#{colour_reset}\e[2K"
-    end
-
-    # @return [String]
-    def colour_reset
-      "#{fg_reset}#{bg_reset}"
-    end
-
-    # @return [String]
-    def normal
-      "#{underline_off}#{bold_off}#{positive}"
-    end
-
-    # @return [String]
-    def screen_init
-      "#{reset}#{clear}#{hide_cursor}"
-    end
-
-    # @return [String]
-    def screen_exit
-      "#{show_cursor}#{colour_reset}#{reset}#{last_character_position}\n"
-    end
-
-    # @return [String]
-    def last_character_position
-      Vedeu::Geometry::Position[Vedeu.height, Vedeu.width].to_s
-    end
-
-  end # Esc
+    module Esc
+
+      include Vedeu::EscapeSequences::Actions
+      include Vedeu::EscapeSequences::Borders
+      include Vedeu::EscapeSequences::Colours
+      extend self
+
+      # Return the stream with the escape sequences escaped so that
+      # they can be printed to the terminal instead of being
+      # interpreted by the terminal which will render them. This way
+      # we can see what escape sequences are being sent along with
+      # the content.
+      #
+      # @param stream [String]
+      # @return [String]
+      def escape(stream = '')
+        return stream if stream.nil? || stream.empty?
+
+        stream.gsub(/\e/, '\\e')
+      end
+
+      # Return the escape sequence string from the list of recognised
+      # sequence 'commands', or an empty string when the 'command'
+      # cannot be found.
+      #
+      # @param value [String|Symbol]
+      # @return [String]
+      def string(value = '')
+        return '' if value.empty?
+
+        send(value.to_sym)
+      rescue NoMethodError
+        ''
+      end
+
+      # Return the escape sequence to render a border character.
+      #
+      # @return [String]
+      # @yieldreturn [void] The border character to wrap with border
+      #   on and off escape sequences.
+      def border
+        return '' unless block_given?
+
+        "#{border_on}#{yield}#{border_off}"
+      end
+
+      private
+
+      # @return [String]
+      def clear
+        "#{colour_reset}\e[2J"
+      end
+
+      # @return [String]
+      def clear_line
+        "#{colour_reset}\e[2K"
+      end
+
+      # @return [String]
+      def colour_reset
+        "#{fg_reset}#{bg_reset}"
+      end
+
+      # @return [String]
+      def normal
+        "#{underline_off}#{bold_off}#{positive}"
+      end
+
+      # @return [String]
+      def screen_init
+        "#{reset}#{clear}#{hide_cursor}"
+      end
+
+      # @return [String]
+      def screen_exit
+        "#{show_cursor}#{colour_reset}#{reset}#{last_character_position}\n"
+      end
+
+      # @return [String]
+      def last_character_position
+        Vedeu::Geometry::Position[Vedeu.height, Vedeu.width].to_s
+      end
+
+    end # Esc
+
+  end # EscapeSequences
 
 end # Vedeu

data/lib/vedeu/events/aliases.rb

@@ -48,8 +48,7 @@ module Vedeu
       # @param alias_name [Symbol]
       # @return [Boolean]
       def registered?(alias_name)
-        return false if alias_name.nil? || alias_name.empty?
-        return false if empty?
+        return false if empty? || alias_name.nil? || alias_name.empty?
 
         storage.include?(alias_name)
       end

data/lib/vedeu/events/collection.rb

@@ -5,7 +5,7 @@ module Vedeu
     # A collection of {Vedeu::Events::Event} instances.
     #
     # @api private
-    class Collection < Vedeu::Collection
+    class Collection < Vedeu::Repositories::Collection
 
     end # Collection
 

data/lib/vedeu/events/event.rb

@@ -32,7 +32,7 @@ module Vedeu
     #
     class Event
 
-      include Vedeu::Model
+      include Vedeu::Repositories::Model
 
       class << self
 

data/lib/vedeu/events/repository.rb

@@ -4,7 +4,7 @@ module Vedeu
 
     # Allows the storing of events.
     #
-    class Repository < Vedeu::Repository
+    class Repository < Vedeu::Repositories::Repository
 
       singleton_class.send(:alias_method, :events, :repository)
 

data/lib/vedeu/events/trigger.rb

@@ -2,10 +2,10 @@ module Vedeu
 
   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.
+    # 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.
     #
     class Trigger
 
@@ -14,9 +14,10 @@ module Vedeu
       # @example
       #   Vedeu.trigger(:my_event, :oxidize, 'nitrogen')
       #
-      # @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.
+      # @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
@@ -32,7 +33,8 @@ module Vedeu
         @repository = Vedeu.events
       end
 
-      # Trigger the event and return the result or an array of results.
+      # Trigger the event and return the result or an array of
+      # results.
       #
       # @return [Array]
       def trigger
@@ -56,7 +58,7 @@ module Vedeu
       attr_reader :args
 
       # @!attribute [r]
-      # @return [Vedeu::Repository]
+      # @return [Vedeu::Repositories::Repository]
       attr_reader :repository
 
       private

data/lib/vedeu/geometry/dimension.rb

@@ -23,9 +23,7 @@ module Vedeu
       # @option attributes options [Hash]
       # @return [Vedeu::Geometry::Dimension]
       def initialize(attributes = {})
-        @attributes = defaults.merge!(attributes)
-
-        @attributes.each do |key, value|
+        defaults.merge!(attributes).each do |key, value|
           instance_variable_set("@#{key}", value)
         end
       end

data/lib/vedeu/geometry/generic_coordinate.rb

@@ -14,9 +14,7 @@ module Vedeu
       # @option attributes offset [Fixnum]
       # @return [Vedeu::Geometry::GenericCoordinate]
       def initialize(attributes = {})
-        @attributes = defaults.merge!(attributes)
-
-        @attributes.each do |key, value|
+        defaults.merge!(attributes).each do |key, value|
           instance_variable_set("@#{key}", value)
         end
       end

data/lib/vedeu/geometry/geometry.rb

@@ -12,7 +12,7 @@ module Vedeu
     class Geometry
 
       extend Forwardable
-      include Vedeu::Model
+      include Vedeu::Repositories::Model
 
       def_delegators :area,
                      :north,

data/lib/vedeu/geometry/repository.rb

@@ -2,10 +2,10 @@ module Vedeu
 
   module Geometry
 
-    # Allows the storing of interface/view geometry independent of the interface
-    # instance.
+    # Allows the storing of interface/view geometry independent of the
+    # interface instance.
     #
-    class Repository < Vedeu::Repository
+    class Repository < Vedeu::Repositories::Repository
 
       singleton_class.send(:alias_method, :geometries, :repository)
 

data/lib/vedeu/input/all.rb

@@ -1,5 +1,8 @@
 module Vedeu
 
+  # Classes within the Input namespace handle various aspects of
+  # user input.
+  #
   module Input
 
   end # Input

data/lib/vedeu/input/keymap.rb

@@ -2,11 +2,12 @@ module Vedeu
 
   module Input
 
-    # A container class for keys associated with a particular interface.
+    # A container class for keys associated with a particular
+    # interface.
     #
     class Keymap
 
-      include Vedeu::Model
+      include Vedeu::Repositories::Model
 
       collection Vedeu::Input::Keys
       member     Vedeu::Input::Key
@@ -21,13 +22,11 @@ module Vedeu
       # @option attributes name [String] The name of the keymap.
       # @option attributes keys [Vedeu::Input::Keys|Array]
       #   A collection of keys.
-      # @option attributes repository [Vedeu::Repository]
-      #   This model's storage.
+      # @option attributes repository
+      #   [Vedeu::Repositories::Repository] This model's storage.
       # @return [Vedeu::Input::Keymap]
       def initialize(attributes = {})
-        @attributes = defaults.merge!(attributes)
-
-        @attributes.each do |key, value|
+        defaults.merge!(attributes).each do |key, value|
           instance_variable_set("@#{key}", value)
         end
       end
@@ -58,8 +57,8 @@ module Vedeu
         keys.any? { |key| key.input == input }
       end
 
-      # When the given input is registered with this keymap, this method
-      # triggers the action associated with the key.
+      # When the given input is registered with this keymap, this
+      # method triggers the action associated with the key.
       #
       # @param input [String|Symbol]
       # @return [Array|FalseClass]
@@ -86,8 +85,8 @@ module Vedeu
         }
       end
 
-      # Checks that the provided key is not already registered with this
-      # keymap.
+      # Checks that the provided key is not already registered with
+      # this keymap.
       #
       # @param key [Vedeu::Input::Key]
       # @return [Boolean]

data/lib/vedeu/input/keymaps.rb

@@ -4,7 +4,7 @@ module Vedeu
 
     # Allows the storing of keymaps.
     #
-    class Keymaps < Vedeu::Repository
+    class Keymaps < Vedeu::Repositories::Repository
 
       singleton_class.send(:alias_method, :keymaps, :repository)
 

data/lib/vedeu/input/keys.rb

@@ -4,7 +4,7 @@ module Vedeu
 
     # A collection of {Vedeu::Input::Key} instances.
     #
-    class Keys < Vedeu::Collection
+    class Keys < Vedeu::Repositories::Collection
 
     end # Keys
 

data/lib/vedeu/input/mapper.rb

@@ -6,9 +6,9 @@ module Vedeu
     #
     class Mapper
 
-      # Takes a key as a keypress and sends it to registered keymaps. If found,
-      # the associated action is fired, otherwise, we move to the next keymap or
-      # return false.
+      # Takes a key as a keypress and sends it to registered keymaps.
+      # If found, the associated action is fired, otherwise, we move
+      # to the next keymap or return false.
       #
       # @example
       #   Vedeu.keypress(key_name, keymap_name)
@@ -23,8 +23,9 @@ module Vedeu
         new(key, name).keypress
       end
 
-      # Checks a key is valid; i.e. not already registered to a keymap. When the
-      # key is registered, then the key is invalid and cannot be used again.
+      # Checks a key is valid; i.e. not already registered to a
+      # keymap. When the key is registered, then the key is invalid
+      # and cannot be used again.
       #
       # @param (see #initialize)
       # @return [Boolean]
@@ -38,7 +39,7 @@ module Vedeu
       #
       # @param key [NilClass|String|Symbol]
       # @param name [NilClass|String]
-      # @param repository [NilClass|Vedeu::Repository]
+      # @param repository [NilClass|Vedeu::Repositories::Repository]
       # @return [Vedeu::Input::Mapper]
       def initialize(key = nil, name = nil, repository = nil)
         @key        = key
@@ -46,8 +47,8 @@ module Vedeu
         @repository = repository || Vedeu.keymaps
       end
 
-      # Returns a boolean indicating that the key is registered to the current
-      # keymap, or the global keymap.
+      # Returns a boolean indicating that the key is registered to the
+      # current keymap, or the global keymap.
       #
       # @return [Boolean]
       def keypress
@@ -79,7 +80,7 @@ module Vedeu
       attr_reader :key
 
       # @!attribute [r] repository
-      # @return [Vedeu::Repository]
+      # @return [Vedeu::Repositories::Repository]
       attr_reader :repository
 
       private
@@ -107,7 +108,8 @@ module Vedeu
         repository.find(named)
       end
 
-      # Does the keymaps repository have the named keymap already registered?
+      # Does the keymaps repository have the named keymap already
+      # registered?
       #
       # @param named [NilClass|String]
       # @return [Boolean]
@@ -115,8 +117,8 @@ module Vedeu
         repository.registered?(named)
       end
 
-      # With a name, we check the keymap with that name, otherwise we use the
-      # name of the interface currently in focus.
+      # With a name, we check the keymap with that name, otherwise we
+      # use the name of the interface currently in focus.
       #
       # @return [String|NilClass]
       def name

data/lib/vedeu/logging/all.rb

@@ -1,5 +1,8 @@
 module Vedeu
 
+  # Classes within the Logging namespace handle various aspects of
+  # logging for Vedeu.
+  #
   module Logging
 
   end # Logging

data/lib/vedeu/logging/log.rb

@@ -103,7 +103,8 @@ module Vedeu
         # @param body [String] The log message itself.
         # @return [String]
         def message_body(type, body)
-          Vedeu::Esc.send(message_types.fetch(type, :default)[-1]) do
+          Vedeu::EscapeSequences::Esc
+            .send(message_types.fetch(type, :default)[-1]) do
             body
           end
         end
@@ -114,7 +115,8 @@ module Vedeu
         # @param type [Symbol] The type of log message.
         # @return [String]
         def message_type(type)
-          Vedeu::Esc.send(message_types.fetch(type, :default)[0]) do
+          Vedeu::EscapeSequences::Esc
+            .send(message_types.fetch(type, :default)[0]) do
             "[#{type}]".ljust(9)
           end
         end

data/lib/vedeu/menus/menu.rb

@@ -7,7 +7,7 @@ module Vedeu
     #
     class Menu
 
-      include Vedeu::Model
+      include Vedeu::Repositories::Model
 
       # @!attribute [rw] collection
       # @return [Array]
@@ -73,9 +73,7 @@ module Vedeu
       # @option attributes selected [Fixnum|NilClass]
       # @return [Vedeu::Menus::Menu]
       def initialize(attributes = {})
-        @attributes = defaults.merge!(attributes)
-
-        @attributes.each do |key, value|
+        defaults.merge!(attributes).each do |key, value|
           instance_variable_set("@#{key}", value)
         end
       end

data/lib/vedeu/menus/repository.rb

@@ -4,7 +4,7 @@ module Vedeu
 
     # Allows the storing of menus by name.
     #
-    class Repository < Vedeu::Repository
+    class Repository < Vedeu::Repositories::Repository
 
       singleton_class.send(:alias_method, :menus, :repository)
 

data/lib/vedeu/models/all.rb

@@ -0,0 +1,15 @@
+module Vedeu
+
+  module Models
+
+  end # Models
+
+end # Vedeu
+
+require 'vedeu/models/cell'
+require 'vedeu/models/escape'
+require 'vedeu/models/focus'
+require 'vedeu/models/group'
+require 'vedeu/models/groups'
+require 'vedeu/models/row'
+require 'vedeu/models/page'

data/lib/vedeu/models/cell.rb

@@ -59,7 +59,7 @@ module Vedeu
         }
       end
 
-      # @param options [Hash] Ignored.
+      # @param _options [Hash] Ignored.
       # @return [String]
       def to_html(_options = {})
         ''

data/lib/vedeu/models/escape.rb

@@ -57,7 +57,7 @@ module Vedeu
       # Return an empty string as most escape sequences won't make
       # sense as HTML.
       #
-      # @param options [Hash] Ignored.
+      # @param _options [Hash] Ignored.
       # @return [String]
       def to_html(_options = {})
         ''

data/lib/vedeu/models/group.rb

@@ -7,7 +7,7 @@ module Vedeu
     #
     class Group
 
-      include Vedeu::Model
+      include Vedeu::Repositories::Model
       include Vedeu::Toggleable
 
       # @!attribute [rw] name
@@ -24,8 +24,9 @@ module Vedeu
       # @option attributes members [Set] A collection of names of
       #   interfaces belonging to this group.
       # @option attributes name [String] The name of the group.
-      # @option attributes repository [Vedeu::Repository] The storage
-      #   for all Group models.
+      # @option attributes repository
+      #   [Vedeu::Repositories::Repository]
+      #   The storage for all Group models.
       # @option attributes visible [Boolean] Whether the group is
       #   visible or not.
       # @return [Vedeu::Models::Group]

data/lib/vedeu/models/groups.rb

@@ -4,7 +4,7 @@ module Vedeu
 
     # Allows the storing of view groups.
     #
-    class Groups < Vedeu::Repository
+    class Groups < Vedeu::Repositories::Repository
 
       singleton_class.send(:alias_method, :groups, :repository)
 

data/lib/vedeu/models/interface.rb

@@ -7,7 +7,7 @@ module Vedeu
     #
     class Interface
 
-      include Vedeu::Model
+      include Vedeu::Repositories::Model
       include Vedeu::Presentation
       include Vedeu::Toggleable
 

data/lib/vedeu/models/interfaces.rb

@@ -4,7 +4,7 @@ module Vedeu
 
     # Allows the storing of interfaces and views.
     #
-    class Interfaces < Vedeu::Repository
+    class Interfaces < Vedeu::Repositories::Repository
 
       singleton_class.send(:alias_method, :interfaces, :repository)
 

data/lib/vedeu/models/views/char.rb

@@ -85,7 +85,7 @@ module Vedeu
       # @return [String]
       def value
         if border
-          Vedeu::Esc.border { @value }
+          Vedeu::EscapeSequences::Esc.border { @value }
 
         else
           @value

data/lib/vedeu/models/views/collections/chars.rb

@@ -5,7 +5,7 @@ module Vedeu
     # A collection of {Vedeu::Views::Char} instances.
     #
     # @api private
-    class Chars < Vedeu::Collection
+    class Chars < Vedeu::Repositories::Collection
 
     end # Chars
 

data/lib/vedeu/models/views/collections/lines.rb

@@ -5,7 +5,7 @@ module Vedeu
     # A collection of {Vedeu::Views::Line} instances.
     #
     # @api private
-    class Lines < Vedeu::Collection
+    class Lines < Vedeu::Repositories::Collection
 
     end # Lines
 

data/lib/vedeu/models/views/collections/streams.rb

@@ -5,7 +5,7 @@ module Vedeu
     # A collection of {Vedeu::Views::Stream} instances.
     #
     # @api private
-    class Streams < Vedeu::Collection
+    class Streams < Vedeu::Repositories::Collection
 
     end # Streams