vedeu 0.4.55 → 0.4.56

data/lib/vedeu/dsl/interface.rb

@@ -36,11 +36,11 @@ module Vedeu
       #   when we define the interface or view, setting it here is just
       #   mirroring functionality of {Vedeu::DSL::Border.border}.
       # @param block [Proc]
-      # @raise [InvalidSyntax] The required block was not given.
+      # @raise [Vedeu::InvalidSyntax] The required block was not given.
       # @return [Vedeu::Border]
       # @see Vedeu::DSL::Border
       def border(name = nil, &block)
-        fail InvalidSyntax, 'block not given' unless block_given?
+        fail Vedeu::InvalidSyntax, 'block not given' unless block_given?
 
         model_name = name ? name : model.name
 
@@ -83,7 +83,7 @@ module Vedeu
       #     # ...       #    is rendered.
       #   end
       #
-      # @return [Cursor]
+      # @return [Vedeu::Cursor]
       def cursor(value = true)
         boolean = value ? true : false
 
@@ -145,11 +145,11 @@ module Vedeu
       #   when we define the interface or view, setting it here is just
       #   mirroring functionality of {Vedeu::DSL::Geometry.geometry}.
       # @param block [Proc]
-      # @raise [InvalidSyntax] The required block was not given.
-      # @return [Geometry]
+      # @raise [Vedeu::InvalidSyntax] The required block was not given.
+      # @return [Vedeu::Geometry]
       # @see Vedeu::DSL::Geometry
       def geometry(name = nil, &block)
-        fail InvalidSyntax, 'block not given' unless block_given?
+        fail Vedeu::InvalidSyntax, 'block not given' unless block_given?
 
         model_name = name ? name : model.name
 
@@ -200,10 +200,10 @@ module Vedeu
       #     end
       #   end
       #
-      # @raise [InvalidSyntax] The required block was not given.
+      # @raise [Vedeu::InvalidSyntax] The required block was not given.
       # @return [Line]
       def lines(&block)
-        fail InvalidSyntax, 'block not given' unless block_given?
+        fail Vedeu::InvalidSyntax, 'block not given' unless block_given?
 
         model.add(model.member.build(attributes, &block))
       end
@@ -315,7 +315,7 @@ module Vedeu
       attr_reader :client
 
       # @!attribute [r] model
-      # @return [Interface]
+      # @return [Vedeu::Interface]
       attr_reader :model
 
       private

data/lib/vedeu/dsl/keymap.rb

@@ -49,8 +49,8 @@ module Vedeu
       #     end
       #   end
       #
-      # @raise [InvalidSyntax] The required block was not given.
-      # @return [Keymap]
+      # @raise [Vedeu::InvalidSyntax] The required block was not given.
+      # @return [Vedeu::Keymap]
       # @todo Try to remember why we need to pre-create the keymap in the
       #   repository.
       def self.keymap(name, &block)
@@ -61,7 +61,7 @@ module Vedeu
 
       # Returns an instance of DSL::Keymap.
       #
-      # @param model [Keymap]
+      # @param model [Vedeu::Keymap]
       # @param client [Object]
       # @return [Vedeu::DSL::Keymap]
       def initialize(model, client = nil)
@@ -89,20 +89,22 @@ module Vedeu
       #     # ...
       #   end
       #
-      # @raise [InvalidSyntax] When the required block is not given, the
+      # @raise [Vedeu::InvalidSyntax] When the required block is not given, the
       #   value_or_values parameter is undefined, or when processing the
       #   collection, a member is undefined.
       # @return [Array] A collection containing the keypress(es).
       def key(*value_or_values, &block)
-        fail InvalidSyntax, 'No action defined for `key`.' unless block_given?
+        fail Vedeu::InvalidSyntax,
+             'No action defined for `key`.' unless block_given?
 
         unless present?(value_or_values)
-          fail InvalidSyntax, 'No keypress(es) defined for `key`.'
+          fail Vedeu::InvalidSyntax, 'No keypress(es) defined for `key`.'
         end
 
         value_or_values.each do |value|
           unless present?(value)
-            fail InvalidSyntax, 'An invalid value for `key` was encountered.'
+            fail Vedeu::InvalidSyntax,
+                 'An invalid value for `key` was encountered.'
           end
 
           model.add(model.member.new(value, &block))
@@ -131,7 +133,7 @@ module Vedeu
       attr_reader :client
 
       # @!attribute [r] model
-      # @return [Keymap]
+      # @return [Vedeu::Keymap]
       attr_reader :model
 
     end # Keymap

data/lib/vedeu/dsl/line.rb

@@ -62,7 +62,7 @@ module Vedeu
       #     end
       #   end
       #
-      # @raise [InvalidSyntax] When no block or value is provided.
+      # @raise [Vedeu::InvalidSyntax] When no block or value is provided.
       # @return [Vedeu::Lines]
       def line(value = '', &block)
         if block_given?
@@ -75,7 +75,7 @@ module Vedeu
                                       streams: [build_stream(value)])
 
         else
-          fail InvalidSyntax, 'block not given'
+          fail Vedeu::InvalidSyntax, 'block not given'
 
         end
 
@@ -102,11 +102,11 @@ module Vedeu
       #     end
       #   end
       #
-      # @raise [InvalidSyntax] The required block was not given.
+      # @raise [Vedeu::InvalidSyntax] The required block was not given.
       # @return [Vedeu::Streams<Vedeu::Stream>]
       # @see Vedeu::DSL::Stream for subdirectives.
       def streams(&block)
-        fail InvalidSyntax, 'block not given' unless block_given?
+        fail Vedeu::InvalidSyntax, 'block not given' unless block_given?
 
         model.add(model.member.build(attributes, &block))
       end
@@ -119,7 +119,7 @@ module Vedeu
       attr_reader :client
 
       # @!attribute [r] model
-      # @return [Line]
+      # @return [Vedeu::Line]
       attr_reader :model
 
       private

data/lib/vedeu/dsl/stream.rb

@@ -22,10 +22,10 @@ module Vedeu
       end
 
       # @param block [Proc]
-      # @raise [InvalidSyntax] The required block was not given.
+      # @raise [Vedeu::InvalidSyntax] The required block was not given.
       # @return [void]
       def stream(&block)
-        fail InvalidSyntax, 'block not given' unless block_given?
+        fail Vedeu::InvalidSyntax, 'block not given' unless block_given?
 
         model.add(model.class.build(attributes, &block))
       end

data/lib/vedeu/dsl/use.rb

@@ -63,8 +63,8 @@ module Vedeu
       #
       # @param name [String] The name of the model with the value you wish to
       #   use.
-      # @raise [ModelNotFound|NoMethodError] The model or attribute cannot be
-      #   found.
+      # @raise [Vedeu::ModelNotFound|Vedeu::NoMethodError] The model or
+      #   attribute cannot be found.
       # @return [void] The stored model.
       def use(name)
         model.repository.by_name(name)

data/lib/vedeu/dsl/view.rb

@@ -30,10 +30,10 @@ module Vedeu
         #     # ...
         #   end
         #
-        # @raise [InvalidSyntax] The required block was not given.
-        # @return [Interface]
+        # @raise [Vedeu::InvalidSyntax] The required block was not given.
+        # @return [Vedeu::Interface]
         def interface(name = '', &block)
-          fail InvalidSyntax, 'block not given' unless block_given?
+          fail Vedeu::InvalidSyntax, 'block not given' unless block_given?
 
           attributes = { client: client(&block), name: name }
 
@@ -56,10 +56,10 @@ module Vedeu
         #     end
         #   end
         #
-        # @raise [InvalidSyntax] The required block was not given.
+        # @raise [Vedeu::InvalidSyntax] The required block was not given.
         # @return [Array<Interface>]
         def render(&block)
-          fail InvalidSyntax, 'block not given' unless block_given?
+          fail Vedeu::InvalidSyntax, 'block not given' unless block_given?
 
           store(:store_immediate, &block)
         end
@@ -89,10 +89,10 @@ module Vedeu
         #     # ...
         #   end
         #
-        # @raise [InvalidSyntax] The required block was not given.
+        # @raise [Vedeu::InvalidSyntax] The required block was not given.
         # @return [Array<Interface>]
         def views(&block)
-          fail InvalidSyntax, 'block not given' unless block_given?
+          fail Vedeu::InvalidSyntax, 'block not given' unless block_given?
 
           store(:store_deferred, &block)
         end

data/lib/vedeu/events/event.rb

@@ -127,7 +127,7 @@ module Vedeu
     # Returns a new instance of Vedeu::Event.
     #
     # @param (see Vedeu::Event.bind)
-    # @return [Event]
+    # @return [Vedeu::Event]
     def initialize(name, options = {}, closure)
       @name         = name
       @options      = options

data/lib/vedeu/events/events.rb

@@ -3,7 +3,7 @@ module Vedeu
   # Allows the storing of events.
   #
   # @api public
-  class Events < Repository
+  class Events < Vedeu::Repository
 
     class << self
 

data/lib/vedeu/geometry/geometries.rb

@@ -7,7 +7,7 @@ module Vedeu
   # instance.
   #
   # @api public
-  class Geometries < Repository
+  class Geometries < Vedeu::Repository
 
     class << self
 

data/lib/vedeu/geometry/grid.rb

@@ -37,11 +37,11 @@ module Vedeu
     #                      # 7 * 9 = 63
     #                      # Therefore, width is 63 characters.
     #
-    # @raise [OutOfRange] When the value parameter is not between 1 and 12
-    #   inclusive.
-    # @return [Fixnum|OutOfRange]
+    # @raise [Vedeu::OutOfRange] When the value parameter is not between 1 and
+    #   12 inclusive.
+    # @return [Fixnum|Vedeu::OutOfRange]
     def columns
-      fail OutOfRange,
+      fail Vedeu::OutOfRange,
            'Valid value between 1 and 12 inclusive.' if out_of_range?
 
       column * value
@@ -56,11 +56,11 @@ module Vedeu
     #                    # 3 * 3 = 9
     #                    # Therefore, height is 9 characters.
     #
-    # @raise [OutOfRange] When the value parameter is not between 1 and 12
-    #   inclusive.
-    # @return [Fixnum|OutOfRange]
+    # @raise [Vedeu::OutOfRange] When the value parameter is not between 1 and
+    #   12 inclusive.
+    # @return [Fixnum|Vedeu::OutOfRange]
     def rows
-      fail OutOfRange,
+      fail Vedeu::OutOfRange,
            'Valid value between 1 and 12 inclusive.' if out_of_range?
 
       row * value

data/lib/vedeu/geometry/position_validator.rb

@@ -32,7 +32,7 @@ module Vedeu
     # @param name [String]
     # @param x [Fixnum]
     # @param y [Fixnum]
-    # @return [PositionValidator]
+    # @return [Vedeu::PositionValidator]
     def initialize(name, x, y)
       @name = name
       @x    = x

data/lib/vedeu/input/input.rb

@@ -18,7 +18,7 @@ module Vedeu
     #
     # @param reader [IO] An object that responds to `#read`. Typically, this is
     #   Vedeu::Terminal.
-    # @return [Input]
+    # @return [Vedeu::Input]
     def initialize(reader)
       @reader = reader
     end

data/lib/vedeu/input/key.rb

@@ -14,10 +14,10 @@ module Vedeu
     #
     # @param input [String|Symbol]
     # @param block [Proc]
-    # @raise [InvalidSyntax] The required block was not given.
+    # @raise [Vedeu::InvalidSyntax] The required block was not given.
     # @return [Key]
     def initialize(input = nil, &block)
-      fail InvalidSyntax, 'block not given' unless block_given?
+      fail Vedeu::InvalidSyntax, 'block not given' unless block_given?
 
       @input  = input
       @output = block

data/lib/vedeu/input/keymap.rb

@@ -32,7 +32,7 @@ module Vedeu
 
     # Add a key to the keymap.
     #
-    # @param key [Key]
+    # @param key [Vedeu::Key]
     # @return [void]
     def add(key)
       return false unless valid?(key)

data/lib/vedeu/input/keymaps.rb

@@ -5,7 +5,7 @@ module Vedeu
   # Allows the storing of keymaps.
   #
   # @api public
-  class Keymaps < Repository
+  class Keymaps < Vedeu::Repository
 
     class << self
 

data/lib/vedeu/input/mapper.rb

@@ -37,8 +37,8 @@ module Vedeu
     #
     # @param key [NilClass|String|Symbol]
     # @param name [NilClass|String]
-    # @param repository [NilClass|Repository]
-    # @return [Mapper]
+    # @param repository [NilClass|Vedeu::Repository]
+    # @return [Vedeu::Mapper]
     def initialize(key = nil, name = nil, repository = nil)
       @key        = key
       @name       = name
@@ -101,7 +101,7 @@ module Vedeu
     # Fetch the named keymap from the repository.
     #
     # @param named [NilClass|String]
-    # @return [Keymap]
+    # @return [Vedeu::Keymap]
     def keymap(named = name)
       repository.find(named)
     end

data/lib/vedeu/launcher.rb

@@ -31,7 +31,7 @@ module Vedeu
     # @param stdout [IO]
     # @param stderr [IO]
     # @param kernel [Kernel]
-    # @return [Launcher]
+    # @return [Vedeu::Launcher]
     def initialize(argv   = [],
                    stdin  = STDIN,
                    stdout = STDOUT,

data/lib/vedeu/log.rb

@@ -25,8 +25,8 @@ module Vedeu
 
       # Returns a new instance of Vedeu::LocklessLogDevice.
       #
-      # @param log []
-      # @return []
+      # @param log [void]
+      # @return [void]
       def initialize(log = nil)
         @dev      = nil
         @filename = nil
@@ -42,8 +42,8 @@ module Vedeu
         end
       end
 
-      # @param message []
-      # @return []
+      # @param message [String]
+      # @return [void]
       def write(message)
         @dev.write(message)
 
@@ -51,15 +51,15 @@ module Vedeu
         warn("log writing failed. #{exception}")
       end
 
-      # @return []
+      # @return [void]
       def close
         @dev.close rescue nil
       end
 
       private
 
-      # @param filename []
-      # @return []
+      # @param filename [String]
+      # @return [void]
       def open_logfile(filename)
         if FileTest.exist?(filename)
           open(filename, (File::WRONLY | File::APPEND))

data/lib/vedeu/models/all.rb

@@ -3,7 +3,7 @@ require 'vedeu/repositories/all'
 require 'vedeu/models/toggleable'
 require 'vedeu/models/cell'
 require 'vedeu/models/char'
-require 'vedeu/models/escape_char'
+require 'vedeu/models/escape'
 require 'vedeu/models/stream'
 require 'vedeu/models/line'
 require 'vedeu/models/interfaces'
@@ -14,4 +14,3 @@ require 'vedeu/models/groups'
 require 'vedeu/models/group'
 require 'vedeu/models/menus'
 require 'vedeu/models/menu'
-

data/lib/vedeu/models/char.rb

@@ -47,7 +47,7 @@ module Vedeu
     # @option attributes position [Vedeu::Position]
     # @option attributes border   [NilClass|Symbol] A symbol representing the
     #   border 'piece' this Char represents.
-    # @return [Char]
+    # @return [Vedeu::Char]
     def initialize(attributes = {})
       @attributes = attributes
       @border     = @attributes[:border]

data/lib/vedeu/models/composition.rb

@@ -19,9 +19,9 @@ module Vedeu
     #
     # @param attributes [Hash]
     # @option attributes colour [Vedeu::Colour]
-    # @option attributes interfaces []
+    # @option attributes interfaces [void]
     # @option attributes style [Vedeu::Style]
-    # @return [Composition]
+    # @return [Vedeu::Composition]
     def initialize(attributes = {})
       @attributes = defaults.merge!(attributes)
 

data/lib/vedeu/models/{escape_char.rb → escape.rb}

@@ -3,7 +3,7 @@ module Vedeu
   # Represents an invisible escape character sequence.
   #
   # @api private
-  class EscapeChar
+  class Escape
 
     # @!attribute [r] value
     # @return [String]
@@ -11,10 +11,10 @@ module Vedeu
     alias_method :to_s, :value
     alias_method :to_str, :value
 
-    # Returns a new instance of Vedeu::EscapeChar.
+    # Returns a new instance of Vedeu::Escape.
     #
     # @param value [String]
-    # @return [Vedeu::EscapeChar]
+    # @return [Vedeu::Escape]
     def initialize(value)
       @value = value
     end
@@ -37,7 +37,7 @@ module Vedeu
     #
     # @return [String]
     def inspect
-      "<Vedeu::EscapeChar '#{Vedeu::Esc.escape(to_s)}'>"
+      "<Vedeu::Escape '#{Vedeu::Esc.escape(to_s)}'>"
     end
 
     # @return [String]
@@ -50,6 +50,6 @@ module Vedeu
       ''
     end
 
-  end # EscapeChar
+  end # Escape
 
 end # Vedeu