vedeu 0.4.55 → 0.4.56

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e84104ce6f4159eb294124d8a6074932fa995a85
-  data.tar.gz: b7b8f4ebd1a8955378a9caec05edeee224910750
+  metadata.gz: 743d4a2661b960f89aa308cee33ba6e0625f76e6
+  data.tar.gz: 6df290d61f188f90a527fbdc49673b38e8f572dc
 SHA512:
-  metadata.gz: d354c6aa5c3e636dcffd8896eba97817ec24f53c125cb119018b8fea96659ec9000caec97e6687694193efff159fa33c05c45038ac2e6bfcd758a50d5251bd82
-  data.tar.gz: 6698d400d2c4ff865b8005d356feb294d266632431d964184ec9e9fd298a94c7fc17ebefefa3c925e2dacbf40c712da6c457f94887f4aa9755fee731f1f8915d
+  metadata.gz: 2b56f22b2eff13f49f599717e5c1dd8f1902d904965761c1076325cbfd9b2016e57278ab0e1000330e6ef2f358a004ecb9edfbdaf69704e565cf7f767dafad60
+  data.tar.gz: 779ad640efaab6cc5b7213e1e00b784353816386d892c0835613544f975e6e208b3052b72de5943b7ca56a23d983931d32215078accb6884243d1644382e1dd8

data/lib/vedeu.rb

@@ -45,7 +45,7 @@ module Vedeu
   #     # ...
   #   end
   #
-  # @param receiver []
+  # @param receiver [void]
   # @return [void]
   def included(receiver)
     receiver.send(:include, API)

data/lib/vedeu/application.rb

@@ -38,7 +38,7 @@ module Vedeu
     # Returns a new instance of Vedeu::Application.
     #
     # @param configuration [Vedeu::Configuration]
-    # @return [Application]
+    # @return [Vedeu::Application]
     def initialize(configuration)
       @configuration = configuration
     end
@@ -69,7 +69,7 @@ module Vedeu
     protected
 
     # @!attribute [r] configuration
-    # @return [Configuration]
+    # @return [Vedeu::Configuration]
     attr_reader :configuration
 
     private

data/lib/vedeu/buffers/buffer.rb

@@ -20,21 +20,21 @@ module Vedeu
     # on next refresh.
     #
     # @!attribute [rw] back
-    # @return [Interface]
+    # @return [Vedeu::Interface]
     attr_accessor :back
 
     # The currently displayed buffer, contains the content which was last
     # output.
     #
     # @!attribute [rw] front
-    # @return [Interface]
+    # @return [Vedeu::Interface]
     attr_accessor :front
 
     # The previous buffer which was displayed; contains the content that was
     # shown before 'front'.
     #
     # @!attribute [rw] previous
-    # @return [Interface]
+    # @return [Vedeu::Interface]
     attr_accessor :previous
 
     # @!attribute [r] name

data/lib/vedeu/buffers/buffers.rb

@@ -6,7 +6,7 @@ module Vedeu
   # Allows the storing of view buffers.
   #
   # @api public
-  class Buffers < Repository
+  class Buffers < Vedeu::Repository
 
     class << self
 

data/lib/vedeu/buffers/display_buffer.rb

@@ -11,7 +11,7 @@ module Vedeu
     # Store the view and immediate refresh it; causing to be pushed to the
     # Terminal.
     #
-    # @return [Interface]
+    # @return [Vedeu::Interface]
     def store_immediate
       store_deferred
 
@@ -23,11 +23,11 @@ module Vedeu
     # Store the view if it has a name. This view will be shown next time the
     # refresh event is triggered for the interface.
     #
-    # @raise [InvalidSyntax] The name is not defined.
+    # @raise [Vedeu::InvalidSyntax] The name is not defined.
     # @return [Vedeu::Interface]
     def store_deferred
       unless present?(name)
-        fail InvalidSyntax, 'Cannot store an interface without a name.'
+        fail Vedeu::InvalidSyntax, 'Cannot store an interface without a name.'
       end
 
       store_new_buffer

data/lib/vedeu/colours/colour.rb

@@ -41,7 +41,7 @@ module Vedeu
     # @return [Vedeu::Foreground]
     attr_reader :foreground
 
-    # @param value []
+    # @param value [Vedeu::Colour|Fixnum|Hash|String]
     # @return [Object]
     def self.coerce(value)
       return value if value.is_a?(self)

data/lib/vedeu/colours/colour_translator.rb

@@ -249,11 +249,11 @@ module Vedeu
       (css_to_rgb[2] / 51) * 1
     end
 
-    # @raise [NotImplemented] Subclasses of this class must implement this
-    #   method.
-    # @return [NotImplemented]
+    # @raise [Vedeu::NotImplemented] Subclasses of this class must implement
+    #   this method.
+    # @return [Vedeu::NotImplemented]
     def not_implemented
-      fail NotImplemented, 'Subclasses implement this.'
+      fail Vedeu::NotImplemented, 'Subclasses implement this.'
     end
     alias_method :named_codes,     :not_implemented
     alias_method :numbered_prefix, :not_implemented

data/lib/vedeu/configuration/api.rb

@@ -27,7 +27,7 @@ module Vedeu
       #   end
       #
       # @param block [Proc]
-      # @return [Configuration::API]
+      # @return [Vedeu::Configuration::API]
       def initialize(&block)
         instance_eval(&block) if block_given?
       end
@@ -233,11 +233,11 @@ module Vedeu
       #   the colour mode at all and allow it to be detected, or use 256 here.
       #
       # @param value [Fixnum]
-      # @raise [InvalidSyntax] When the value parameter is not one of +8+, +16+,
-      #   +256+ or +16777216+.
+      # @raise [Vedeu::InvalidSyntax] When the value parameter is not one of
+      #   +8+, +16+, +256+ or +16777216+.
       # @return [Boolean]
       def colour_mode(value = nil)
-        fail InvalidSyntax, '`colour_mode` must be `8`, `16`, `256`, ' \
+        fail Vedeu::InvalidSyntax, '`colour_mode` must be `8`, `16`, `256`, ' \
                             '`16777216`.' unless valid_colour_mode?(value)
         options[:colour_mode] = value
       end

data/lib/vedeu/configuration/cli.rb

@@ -20,7 +20,7 @@ module Vedeu
       # {Vedeu::API#configure}.
       #
       # @param args [Array]
-      # @return [Configuration::CLI]
+      # @return [Vedeu::Configuration::CLI]
       def initialize(args = [])
         @args    = args
         @options = {}

data/lib/vedeu/configuration/configuration.rb

@@ -65,7 +65,7 @@ module Vedeu
       # @option opts stdout [File|IO]
       # @option opts stderr [File|IO]
       # @param block [Proc]
-      # @raise [InvalidSyntax] When the required block is not given.
+      # @raise [Vedeu::InvalidSyntax] When the required block is not given.
       # @return [Hash]
       def configure(args = [], opts = {}, &block)
         instance.configure(args, opts, &block)
@@ -225,7 +225,7 @@ module Vedeu
 
     # Create a new singleton instance of Vedeu::Configuration.
     #
-    # @return [Configuration]
+    # @return [Vedeu::Configuration]
     def initialize
       @options = defaults
     end

data/lib/vedeu/cursor/cursor.rb

@@ -51,7 +51,7 @@ module Vedeu
     # @option attributes x [Fixnum] The terminal x coordinate for the cursor.
     # @option attributes y [Fixnum] The terminal y coordinate for the cursor.
     #
-    # @return [Cursor]
+    # @return [Vedeu::Cursor]
     def initialize(attributes = {})
       # Hack because Repository#by_name creates Cursor objects with just a
       # name.
@@ -98,7 +98,7 @@ module Vedeu
     # @example
     #   Vedeu.hide_cursor(name)
     #
-    # @return [Vedeu::EscapeChar]
+    # @return [Vedeu::Escape]
     def hide
       super
 
@@ -118,7 +118,7 @@ module Vedeu
     # @example
     #   Vedeu.show_cursor(name)
     #
-    # @return [Vedeu::EscapeChar]
+    # @return [Vedeu::Escape]
     def show
       super
 
@@ -153,9 +153,9 @@ module Vedeu
     #
     # @return [String]
     def visibility
-      return Vedeu::EscapeChar.new(Vedeu::Esc.show_cursor) if visible?
+      return Vedeu::Escape.new(Vedeu::Esc.show_cursor) if visible?
 
-      Vedeu::EscapeChar.new(Vedeu::Esc.hide_cursor)
+      Vedeu::Escape.new(Vedeu::Esc.hide_cursor)
     end
 
   end # Cursor

data/lib/vedeu/cursor/cursors.rb

@@ -5,7 +5,7 @@ module Vedeu
   # Allows the storing of each interface's cursor.
   #
   # @api public
-  class Cursors < Repository
+  class Cursors < Vedeu::Repository
 
     class << self
 

data/lib/vedeu/cursor/move.rb

@@ -55,7 +55,7 @@ module Vedeu
     # @param name [String|NilClass] The name of the interface/cursor to be
     #   moved; when not given, the interface currently in focus determines which
     #   cursor instance to move.
-    # @return [Cursor]
+    # @return [Vedeu::Cursor]
     def self.by_name(entity, direction, name = nil)
       name = name ? name : Vedeu.focus
 
@@ -66,7 +66,7 @@ module Vedeu
     #
     # @param entity [Class]
     # @param name [String]
-    # @return [Cursor]
+    # @return [Vedeu::Cursor]
     def self.down(entity, name)
       new(entity, name, 1, 0).move
     end
@@ -75,7 +75,7 @@ module Vedeu
     #
     # @param entity [Class]
     # @param name [String]
-    # @return [Cursor]
+    # @return [Vedeu::Cursor]
     def self.left(entity, name)
       new(entity, name, 0, -1).move
     end
@@ -84,7 +84,7 @@ module Vedeu
     #
     # @param entity [Class]
     # @param name [String]
-    # @return [Cursor]
+    # @return [Vedeu::Cursor]
     def self.right(entity, name)
       new(entity, name, 0, 1).move
     end
@@ -93,7 +93,7 @@ module Vedeu
     #
     # @param entity [Class]
     # @param name [String]
-    # @return [Cursor]
+    # @return [Vedeu::Cursor]
     def self.up(entity, name)
       new(entity, name, -1, 0).move
     end
@@ -103,7 +103,7 @@ module Vedeu
     #
     # @param entity [Class]
     # @param name [String]
-    # @return [Cursor]
+    # @return [Vedeu::Cursor]
     def self.origin(entity, name)
       new(entity, name, -2000, -2000).move
     end
@@ -114,7 +114,7 @@ module Vedeu
     # @param name [String] The name of the cursor or view.
     # @param dy [Fixnum] Move up (-1), or down (1), or no action (0).
     # @param dx [Fixnum] Move left (-1), or right (1), or no action (0).
-    # @return [Move]
+    # @return [Vedeu::Move]
     def initialize(entity, name, dy = 0, dx = 0)
       @entity = entity
       @name   = name
@@ -192,7 +192,7 @@ module Vedeu
       coordinate.y_position(oy)
     end
 
-    # @return [Coordinate]
+    # @return [Vedeu::Coordinate]
     def coordinate
       @coordinate ||= Vedeu::Coordinate.new(name)
     end

data/lib/vedeu/cursor/reposition.rb

@@ -13,7 +13,7 @@ module Vedeu
 
     # Returns a new instance of Vedeu::Reposition.
     #
-    # @param entity []
+    # @param entity [void]
     # @param name [String]
     # @param y [Fixnum]
     # @param x [Fixnum]
@@ -60,7 +60,7 @@ module Vedeu
 
     private
 
-    # @return [Coordinate]
+    # @return [Vedeu::Coordinate]
     def coordinate
       @coordinate ||= Vedeu::Coordinate.new(name)
     end

data/lib/vedeu/distributed/client.rb

@@ -18,7 +18,7 @@ module Vedeu
       # Returns a new instance of Vedeu::Distributed::Client.
       #
       # @param uri [Vedeu::Distributed::Uri|String]
-      # @return [Client]
+      # @return [Vedeu::Distributed::Client]
       def initialize(uri)
         @uri = uri.to_s
       end

data/lib/vedeu/distributed/server.rb

@@ -178,7 +178,7 @@ module Vedeu
       protected
 
       # @!attribute [r] configuration
-      # @return [Configuration]
+      # @return [Vedeu::Configuration]
       attr_reader :configuration
 
       private

data/lib/vedeu/distributed/test_application.rb

@@ -63,7 +63,7 @@ module Vedeu
     # @option attributes keymaps [String]
     # @option attributes menus [String]
     # @option attributes views [String]
-    # @return [TestApplication]
+    # @return [Vedeu::TestApplication]
     def initialize(attributes = {})
       @attributes = defaults.merge!(attributes)
 

data/lib/vedeu/distributed/uri.rb

@@ -20,7 +20,7 @@ module Vedeu
       #
       # @param host [String] Hostname or IP address.
       # @param port [Fixnum|String]
-      # @return [Uri]
+      # @return [Vedeu::Distributed::Uri]
       def initialize(host = 'localhost', port = 21_420)
         @host = host || 'localhost'
         @port = port || 21_420

data/lib/vedeu/dsl/border.rb

@@ -44,10 +44,10 @@ module Vedeu
       # @param name [String] The name of the interface or view to which this
       #   border belongs.
       # @param block [Proc]
-      # @raise [InvalidSyntax] The required block was not given.
+      # @raise [Vedeu::InvalidSyntax] The required block was not given.
       # @return [Vedeu::Border]
       def self.border(name, &block)
-        fail InvalidSyntax, 'block not given' unless block_given?
+        fail Vedeu::InvalidSyntax, 'block not given' unless block_given?
 
         Vedeu::Border.build({ enabled: true, name: name }, &block).store
       end
@@ -381,7 +381,7 @@ module Vedeu
       attr_reader :client
 
       # @!attribute [r] model
-      # @return [Border]
+      # @return [Vedeu::Border]
       attr_reader :model
 
     end # Border

data/lib/vedeu/dsl/composition.rb

@@ -43,7 +43,7 @@ module Vedeu
 
       # Returns an instance of DSL::Composition.
       #
-      # @param model [Composition]
+      # @param model [Vedeu::Composition]
       # @param client [Object]
       # @return [Vedeu::DSL::Composition]
       def initialize(model, client = nil)
@@ -69,10 +69,10 @@ module Vedeu
       #     # ...
       #   end
       #
-      # @raise [InvalidSyntax] The required block was not given.
+      # @raise [Vedeu::InvalidSyntax] The required block was not given.
       # @return [Vedeu::InterfaceCollection<Vedeu::Interface>]
       def view(name = '', &block)
-        fail InvalidSyntax, 'block not given' unless block_given?
+        fail Vedeu::InvalidSyntax, 'block not given' unless block_given?
 
         new_model = model.member.build(new_attributes(name), &block)
 
@@ -120,7 +120,7 @@ module Vedeu
       attr_reader :client
 
       # @!attribute [r] model
-      # @return [Composition]
+      # @return [Vedeu::Composition]
       attr_reader :model
 
       private

data/lib/vedeu/dsl/geometry.rb

@@ -42,17 +42,17 @@ module Vedeu
       # @param name [String] The name of the interface or view to which this
       #   geometry belongs.
       # @param block [Proc]
-      # @raise [InvalidSyntax] The required block was not given.
+      # @raise [Vedeu::InvalidSyntax] The required block was not given.
       # @return [Vedeu::Geometry]
       def self.geometry(name, &block)
-        fail InvalidSyntax, 'block not given' unless block_given?
+        fail Vedeu::InvalidSyntax, 'block not given' unless block_given?
 
         Vedeu::Geometry.build({ name: name }, &block).store
       end
 
       # Returns an instance of DSL::Geometry.
       #
-      # @param model [Geometry]
+      # @param model [Vedeu::Geometry]
       # @param client [Object]
       # @return [Vedeu::DSL::Geometry]
       def initialize(model, client = nil)
@@ -233,7 +233,7 @@ module Vedeu
       attr_reader :client
 
       # @!attribute [r] model
-      # @return [Geometry]
+      # @return [Vedeu::Geometry]
       attr_reader :model
 
     end # Geometry

data/lib/vedeu/dsl/group.rb

@@ -33,17 +33,17 @@ module Vedeu
       #
       # @param name [String] The name of this group.
       # @param block [Proc]
-      # @raise [InvalidSyntax] The required block was not given.
+      # @raise [Vedeu::InvalidSyntax] The required block was not given.
       # @return [Vedeu::Group]
       def self.group(name, &block)
-        fail InvalidSyntax, 'block not given' unless block_given?
+        fail Vedeu::InvalidSyntax, 'block not given' unless block_given?
 
         Vedeu::Group.build({ name: name }, &block).store
       end
 
       # Returns an instance of DSL::Group.
       #
-      # @param model [Group]
+      # @param model [Vedeu::Group]
       # @param client [Object]
       # @return [Vedeu::DSL::Group]
       def initialize(model, client = nil)
@@ -66,7 +66,7 @@ module Vedeu
       attr_reader :client
 
       # @!attribute [r] model
-      # @return [Group]
+      # @return [Vedeu::Group]
       attr_reader :model
 
     end # Group