vedeu 0.6.1 → 0.6.2

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

@@ -267,14 +267,14 @@ module Vedeu
       # Return a virtual cursor to track the cursor position within the
       # document.
       #
-      # @return [Vedeu::Editor::VirtualCursor]
+      # @return [Vedeu::Editor::Cursor]
       def cursor
-        @cursor ||= Vedeu::Editor::VirtualCursor.new(y:   0,
-                                                     x:   0,
-                                                     by:  by,
-                                                     bx:  bx,
-                                                     byn: byn,
-                                                     bxn: bxn)
+        @cursor ||= Vedeu::Editor::Cursor.new(y:   0,
+                                              x:   0,
+                                              by:  by,
+                                              bx:  bx,
+                                              byn: byn,
+                                              bxn: bxn)
       end
 
       # Return only the visible lines for the document based on the current

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

@@ -0,0 +1,70 @@
+module Vedeu
+
+  module Editor
+
+    # Manipulate the lines of an Vedeu::Editor::Document.
+    #
+    class Insert
+
+      # @return [Vedeu::Editor::Line|Vedeu::Editor::Lines]
+      # @see #initialize
+      def self.into(collection, entity, index = nil, size = 0)
+        new(collection, entity, index, size).insert
+      end
+
+      # Returns a new instance of Vedeu::Editor::Insert.
+      #
+      # @param collection [Vedeu::Editor::Line|Vedeu::Editor::Lines]
+      # @param entity [String]
+      # @param index [Fixnum]
+      # @param size [Fixnum]
+      # @return [Vedeu::Editor::Insert]
+      def initialize(collection, entity, index = nil, size = 0)
+        @collection = collection
+        @entity     = entity
+        @index      = index
+        @size       = size
+      end
+
+      # @return [Vedeu::Editor::Line|Vedeu::Editor::Lines]
+      def insert
+        if index
+          if index <= 0
+            collection.insert(0, entity)
+
+          elsif index >= size
+            collection << entity
+
+          else
+            collection.insert(index, entity)
+
+          end
+        else
+          collection << entity
+
+        end
+      end
+
+      protected
+
+      # @!attribute [r] collection
+      # @return [Vedeu::Editor::Line|Vedeu::Editor::Lines]
+      attr_reader :collection
+
+      # @!attribute [r] entity
+      # @return [String]
+      attr_reader :entity
+
+      # @!attribute [r] index
+      # @return [Fixnum]
+      attr_reader :index
+
+      # @!attribute [r] size
+      # @return [Fixnum]
+      attr_reader :size
+
+    end # Insert
+
+  end # Editor
+
+end # Vedeu

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

@@ -101,25 +101,13 @@ module Vedeu
       #
       # @param character [String]
       # @param index [Fixnum|NilClass]
-      # @return [String]
+      # @return [Vedeu::Editor::Line]
       def insert_character(character, index = nil)
-        new_line = if index
-                     if index <= 0
-                       line.insert(0, character)
-
-                     elsif index >= size
-                       line << character
-
-                     else
-                       line.insert(index, character)
+        return self unless character
 
-                     end
-                   else
-                     line + character
-
-                   end
+        insert = Vedeu::Editor::Insert.into(line, character, index, size)
 
-        Vedeu::Editor::Line.coerce(new_line)
+        Vedeu::Editor::Line.coerce(insert)
       end
 
       # Return the size of the line in characters.

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

@@ -137,23 +137,9 @@ module Vedeu
       def insert_line(line, index = nil)
         return self unless line
 
-        new_lines = if index
-                      if index <= 0
-                        lines.insert(0, line)
+        insert = Vedeu::Editor::Insert.into(lines, line, index, size)
 
-                      elsif index >= size
-                        lines << line
-
-                      else
-                        lines.insert(index, line)
-
-                      end
-                    else
-                      lines << line
-
-                    end
-
-        Vedeu::Editor::Lines.coerce(new_lines)
+        Vedeu::Editor::Lines.coerce(insert)
       end
 
       # Returns the line at the given index.

data/lib/vedeu/input/input_translator.rb

@@ -37,7 +37,7 @@ module Vedeu
       @symbols ||= f_keys.merge!(ctrl_letters).merge!(specials)
     end
 
-    # @return [Hash<String => Symbol]
+    # @return [Hash<String => Symbol>]
     def ctrl_letters
       {
         "\u0001"  => :ctrl_a,
@@ -72,7 +72,7 @@ module Vedeu
       }
     end
 
-    # @return [Hash<String => Symbol]
+    # @return [Hash<String => Symbol>]
     def f_keys
       {
         "\eOP"      => :f1,

data/lib/vedeu/input/key.rb

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

data/lib/vedeu/internal_api.rb

@@ -16,8 +16,8 @@ module Vedeu
     #   Vedeu.background_colours
     #
     # @!method background_colours
-    # @return [Vedeu::Backgrounds]
-    def_delegators Vedeu::Backgrounds, :background_colours
+    # @return [Vedeu::Colours::Backgrounds]
+    def_delegators Vedeu::Colours::Backgrounds, :background_colours
 
     # Manipulate the repository of borders.
     #
@@ -70,8 +70,8 @@ module Vedeu
     #   Vedeu.events
     #
     # @!method events
-    # @return [Vedeu::Events]
-    def_delegators Vedeu::Events, :events
+    # @return [Vedeu::Events::Repository]
+    def_delegators Vedeu::Events::Repository, :events
 
     # Manipulate the repository of foreground colours.
     #
@@ -79,8 +79,8 @@ module Vedeu
     #   Vedeu.foreground_colours
     #
     # @!method foreground_colours
-    # @return [Vedeu::Foregrounds]
-    def_delegators Vedeu::Foregrounds, :foreground_colours
+    # @return [Vedeu::Colours::Foregrounds]
+    def_delegators Vedeu::Colours::Foregrounds, :foreground_colours
 
     # Manipulate the repository of geometries.
     #

data/lib/vedeu/log/lockless_log_device.rb

@@ -59,77 +59,3 @@ module Vedeu
   end # LocklessLogDevice
 
 end # Vedeu
-
-# module Vedeu
-
-#   # Ensures we can always write to the log file by creating a lock-less
-#   # log device.
-#   #
-#   class LocklessLogDevice < Logger::LogDevice
-
-#     # Returns a new instance of Vedeu::LocklessLogDevice.
-#     #
-#     # @param file_or_filename [void]
-#     # @return [Vedeu::LocklessLogDevice]
-#     def initialize(file_or_filename = nil)
-#       @file_or_filename = file_or_filename
-#     end
-
-#     # @param message [String]
-#     # @return [void]
-#     def write(message)
-#       device.write(message)
-
-#     rescue StandardError => exception
-#       warn("Log writing failed. #{exception}")
-
-#     end
-
-#     # @return [void]
-#     def close
-#       device.close
-
-#     rescue
-#       nil
-
-#     end
-
-#     protected
-
-#     # @!attribute [r] file_or_filename
-#     # @return [String]
-#     attr_reader :file_or_filename
-#     alias_method :file,     :file_or_filename
-#     alias_method :filename, :file_or_filename
-
-#     private
-
-#     # @return [File]
-#     def device
-#       if file?
-#         file
-
-#       elsif exists?
-#         open(filename, (File::WRONLY | File::APPEND))
-
-#       else
-#         device      = open(filename, (File::WRONLY | File::APPEND | File::CREAT))
-#         device.sync = true
-
-#       end
-#     end
-
-#     # @return [Boolean]
-#     def exists?
-#       FileTest.exist?(filename)
-#     end
-
-#     # @return [Boolean]
-#     def file?
-#       file_or_filename.respond_to?(:write) &&
-#       file_or_filename.respond_to?(:close)
-#     end
-
-#   end # LocklessLogDevice
-
-# end # Vedeu

data/lib/vedeu/models/focus.rb

@@ -49,12 +49,12 @@ module Vedeu
     #   Vedeu.focus_by_name('name')
     #
     # @param name [String] The interface to focus; must be defined.
-    # @raise [Vedeu::ModelNotFound] When the interface cannot be found.
+    # @raise [Vedeu::Error::ModelNotFound] When the interface cannot be found.
     # @return [String] The name of the interface now in focus.
     def by_name(name)
       unless registered?(name)
-        fail Vedeu::ModelNotFound, "Cannot focus '#{name}' as this interface " \
-                                   'has not been registered.'
+        fail Vedeu::Error::ModelNotFound,
+             "Cannot focus '#{name}' as this interface has not been registered."
       end
 
       storage.rotate!(storage.index(name))

data/lib/vedeu/models/interface.rb

@@ -41,7 +41,7 @@ module Vedeu
     #
     # @param attributes [Hash]
     # @option attributes client [Vedeu::Client]
-    # @option attributes colour [Vedeu::Colour]
+    # @option attributes colour [Vedeu::Colours::Colour]
     # @option attributes delay [Float]
     # @option attributes group [String]
     # @option attributes name [String]
@@ -91,8 +91,8 @@ module Vedeu
     def defaults
       {
         client:     nil,
-        colour:     Vedeu::Colour.coerce(background: :default,
-                                         foreground: :default),
+        colour:     Vedeu::Colours::Colour.coerce(background: :default,
+                                                  foreground: :default),
         delay:      0.0,
         group:      '',
         name:       '',

data/lib/vedeu/models/menu.rb

@@ -49,10 +49,10 @@ module Vedeu
     #     # ...
     #   end
     #
-    # @raise [Vedeu::InvalidSyntax] The required block was not given.
+    # @raise [Vedeu::Error::InvalidSyntax] The required block was not given.
     # @return [API::Menu]
     def self.menu(name = '', &block)
-      fail Vedeu::InvalidSyntax, 'block not given' unless block_given?
+      fail Vedeu::Error::InvalidSyntax, 'block not given' unless block_given?
 
       build(name: name, &block).store
     end

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

@@ -34,7 +34,7 @@ module Vedeu
       # @param attributes [Hash]
       # @option attributes border [NilClass|Symbol] A symbol representing the
       #   border 'piece' this Vedeu::Views::Char represents.
-      # @option attributes colour [Vedeu::Colour]
+      # @option attributes colour [Vedeu::Colours::Colour]
       # @option attributes parent [Vedeu::Views::Line]
       # @option attributes position [Vedeu::Position]
       # @option attributes style [Vedeu::Style]

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

@@ -24,7 +24,7 @@ module Vedeu
       #
       # @param attributes [Hash]
       # @option attributes client [void]
-      # @option attributes colour [Vedeu::Colour]
+      # @option attributes colour [Vedeu::Colours::Colour]
       # @option attributes style [Vedeu::Style]
       # @option attributes value [Vedeu::Views::ViewCollection]
       # @return [Vedeu::Views::Composition]

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

@@ -25,7 +25,7 @@ module Vedeu
       # Returns a new instance of Vedeu::Views::Line.
       #
       # @param attributes [Hash]
-      # @option attributes colour [Vedeu::Colour]
+      # @option attributes colour [Vedeu::Colours::Colour]
       # @option attributes parent [Vedeu::Views::View]
       # @option attributes style [Vedeu::Style]
       # @option attributes value [Vedeu::Views::Streams]

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

@@ -31,7 +31,7 @@ module Vedeu
       # Returns a new instance of Vedeu::Views::Stream.
       #
       # @param attributes [Hash]
-      # @option attributes colour [Vedeu::Colour]
+      # @option attributes colour [Vedeu::Colours::Colour]
       # @option attributes style [Vedeu::Style]
       # @option attributes parent [Vedeu::Views::Line]
       # @option attributes value [String]

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

@@ -41,7 +41,7 @@ module Vedeu
       #
       # @param attributes [Hash]
       # @option attributes client [Vedeu::Client]
-      # @option attributes colour [Vedeu::Colour]
+      # @option attributes colour [Vedeu::Colours::Colour]
       # @option attributes value [Vedeu::Views::Lines]
       # @option attributes name [String]
       # @option attributes parent [Vedeu::Views::Composition]
@@ -100,12 +100,11 @@ module Vedeu
       # be shown next time a refresh event is triggered with this name.
       # Called by {Vedeu::DSL::View.views}.
       #
-      # @raise [Vedeu::InvalidSyntax] The name is not defined.
+      # @raise [Vedeu::Error::InvalidSyntax] The name is not defined.
       # @return [Vedeu::Views::View]
       def store_deferred
-        unless present?(name)
-          fail Vedeu::InvalidSyntax, 'Cannot store an interface without a name.'
-        end
+        fail Vedeu::Error::InvalidSyntax,
+             'Cannot store an interface without a name.' unless present?(name)
 
         Vedeu.buffers.by_name(name).add(self)
 
@@ -127,8 +126,8 @@ module Vedeu
       def defaults
         {
           client: nil,
-          colour: Vedeu::Colour.coerce(background: :default,
-                                       foreground: :default),
+          colour: Vedeu::Colours::Colour.coerce(background: :default,
+                                                foreground: :default),
           name:   '',
           parent: nil,
           style:  :normal,

data/lib/vedeu/output/presentation/colour.rb

@@ -7,9 +7,10 @@ module Vedeu
     module Colour
 
       # When the background colour for the model exists, return it, otherwise
-      # returns the parent background colour, or an empty Vedeu::Background.
+      # returns the parent background colour, or an empty
+      # Vedeu::Colours::Background.
       #
-      # @return [Vedeu::Background]
+      # @return [Vedeu::Colours::Background]
       def background
         @background ||= if colour
                           colour.background
@@ -18,47 +19,48 @@ module Vedeu
                           parent.background
 
                         else
-                          Vedeu::Background.new
+                          Vedeu::Colours::Background.new
 
                         end
       end
 
       # Allows the setting of the background colour by coercing the given value
-      # into a Vedeu::Background colour.
+      # into a Vedeu::Colours::Background colour.
       #
-      # @return [Vedeu::Background]
+      # @return [Vedeu::Colours::Background]
       def background=(value)
-        @colour = Vedeu::Colour.coerce(
-          background: Vedeu::Background.coerce(value),
+        @colour = Vedeu::Colours::Colour.coerce(
+          background: Vedeu::Colours::Background.coerce(value),
           foreground: colour.foreground)
       end
 
-      # @return [Vedeu::Colour]
+      # @return [Vedeu::Colours::Colour]
       def colour
         @colour ||= if attributes[:colour]
-                      Vedeu::Colour.coerce(attributes[:colour])
+                      Vedeu::Colours::Colour.coerce(attributes[:colour])
 
                     elsif parent
-                      Vedeu::Colour.coerce(parent.colour)
+                      Vedeu::Colours::Colour.coerce(parent.colour)
 
                     else
-                      Vedeu::Colour.new
+                      Vedeu::Colours::Colour.new
 
                     end
       end
 
       # Allows the setting of the model's colour by coercing the given value
-      # into a Vedeu::Colour.
+      # into a Vedeu::Colours::Colour.
       #
-      # @return [Vedeu::Colour]
+      # @return [Vedeu::Colours::Colour]
       def colour=(value)
-        @colour = Vedeu::Colour.coerce(value)
+        @colour = Vedeu::Colours::Colour.coerce(value)
       end
 
       # When the foreground colour for the model exists, return it, otherwise
-      # returns the parent foreground colour, or an empty Vedeu::Foreground.
+      # returns the parent foreground colour, or an empty
+      # Vedeu::Colours::Foreground.
       #
-      # @return [Vedeu::Foreground]
+      # @return [Vedeu::Colours::Foreground]
       def foreground
         @foreground ||= if colour
                           colour.foreground
@@ -67,19 +69,19 @@ module Vedeu
                           parent.foreground
 
                         else
-                          Vedeu::Foreground.new
+                          Vedeu::Colours::Foreground.new
 
                         end
       end
 
       # Allows the setting of the foreground colour by coercing the given value
-      # into a Vedeu::Foreground colour.
+      # into a Vedeu::Colours::Foreground colour.
       #
-      # @return [Vedeu::Foreground]
+      # @return [Vedeu::Colours::Foreground]
       def foreground=(value)
-        @colour = Vedeu::Colour.coerce(
+        @colour = Vedeu::Colours::Colour.coerce(
           background: colour.background,
-          foreground: Vedeu::Foreground.coerce(value))
+          foreground: Vedeu::Colours::Foreground.coerce(value))
       end
 
     end # Colour