vedeu 0.6.61 → 0.6.62

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: caa790910d980d060680517416aab7206faea84f
-  data.tar.gz: b8ce3a4ae71d898bbd1c99da090b3d66976b0bb9
+  metadata.gz: 161b51ae0f6dddf89fe026875fa21b5bcbef0b63
+  data.tar.gz: f724c3d3b35f703f2ba58800123628837fd7a8fa
 SHA512:
-  metadata.gz: 97f27f54135a8415d01fc5c2b3f65d1652ba3b057c63fc5f9f0baf67ec07f7560340b652b40fbeea864015e0423eac7d4b877c0259f7451fc5316965987e2dcb
-  data.tar.gz: f895269aef915276b769640d7f77e02cffb79f0ec920dc50a173967c737d80c2866bade305ff064e82465264caddcebec48c0481ed80ce4391edc045396af07c
+  metadata.gz: 66121dcb5d8c27bc23a7ec695a2eecf360dfe0946f7f0cb3cf85eb39682f6a0a683d14328987e3858807a8a3fbf75c3a440565ad0aa39c80d76eea9eea263396
+  data.tar.gz: c21adb2837c843bbb19a8b60ced2f19fa76835417ed86a15f769153c9e212f5a8b98133a5cf47446a4ab1a212971bff37321f360c2697f7849f258abece2654b

data/benchmarks/array_vs_range.rb

@@ -2,7 +2,7 @@
 
 # To test the suitability of using a range to determine a valid
 # coordinate instead of the current array method as used in
-# Vedeu::Terminal::Buffer#within_terminal_boundary?
+# Vedeu::Buffers::Terminal#within_terminal_boundary?
 #
 # vedeu/benchmarks:spike/benchmarking$ ./array_vs_range.rb
 # Calculating -------------------------------------

data/docs/events/drb.md

@@ -11,10 +11,10 @@ Note: See {Vedeu::Distributed::Server#input} for parameter details.
     Vedeu.trigger(:_drb_input_, data, type)
 
 ### `:\_drb_retrieve_output\_`
-See {Vedeu::Terminal::Buffer#output}
+See {Vedeu::Buffers::Terminal#output}
 
 ### `:\_drb_store_output\_`
-See {Vedeu::Terminal::Buffer#write}
+See {Vedeu::Buffers::Terminal#write}
 
 ### `:\_drb_restart\_`
 Use the DRb server to request the client application to restart.

data/docs/events/visibility.md

@@ -5,7 +5,7 @@
 Note: 'name' is a Symbol unless mentioned otherwise.
 
 ### `:\_clear\_`
-See {Vedeu::Terminal::Buffer#clear}
+See {Vedeu::Buffers::Terminal#clear}
 
 ### `:\_clear_group\_`
 Clears the spaces occupied by the interfaces belonging to the named

data/lib/vedeu/buffers/all.rb

@@ -24,3 +24,4 @@ require 'vedeu/buffers/buffer'
 require 'vedeu/buffers/null'
 require 'vedeu/buffers/repository'
 require 'vedeu/buffers/refresh'
+require 'vedeu/buffers/terminal'

data/lib/vedeu/buffers/empty.rb

@@ -17,9 +17,9 @@ module Vedeu
       # @return [Array<Array<Vedeu::Models::Cell>>]
       def buffer
         Array.new(height) do |y|
-          unless y == 0
+          if y > 0
             Array.new(width) do |x|
-              Vedeu::Models::Cell.new(name: name, position: [y, x]) unless x == 0
+              Vedeu::Models::Cell.new(name: name, position: [y, x]) if x > 0
             end.compact
           end
         end.compact

data/lib/vedeu/{terminal/buffer.rb → buffers/terminal.rb}

@@ -1,6 +1,6 @@
 module Vedeu
 
-  module Terminal
+  module Buffers
 
     # All output will be written to this singleton, and #render will
     # be called at the end of each run of {Vedeu::MainLoop};
@@ -11,7 +11,7 @@ module Vedeu
     # points and only at the end of each run of {Vedeu::MainLoop} will
     # it be actually output 'somewhere'.
     #
-    module Buffer
+    module Terminal
 
       extend self
 
@@ -66,8 +66,6 @@ module Vedeu
       # @return [Array<Array<Vedeu::Views::Char>>]
       def update(value_or_values)
         buffer.update(value_or_values)
-
-        self
       end
 
       # Write a collection of cells to the virtual terminal, will
@@ -79,14 +77,12 @@ module Vedeu
       # @example
       #   Vedeu.trigger(:_drb_store_output_, value_or_values)
       #
-      # @param value [Array<Array<Vedeu::Views::Char>>]
+      # @param value_or_values [Array<Array<Vedeu::Views::Char>>]
       # @return [Array<Array<Vedeu::Views::Char>>]
       def write(value_or_values)
         buffer.update(value_or_values)
 
         refresh
-
-        self
       end
 
       private
@@ -100,26 +96,26 @@ module Vedeu
       end
       alias_method :cells, :buffer
 
-    end # Buffer
+    end # Terminal
 
-  end # Terminal
+  end # Buffers
 
   # @!method clear
-  #   @see Vedeu::Terminal::Buffer#clear
-  def_delegators Vedeu::Terminal::Buffer,
+  #   @see Vedeu::Buffers::Terminal#clear
+  def_delegators Vedeu::Buffers::Terminal,
                  :clear,
                  :refresh
 
   # :nocov:
 
-  # @see Vedeu::Terminal::Buffer#clear
+  # @see Vedeu::Buffers::Terminal#clear
   Vedeu.bind(:_clear_) { Vedeu.clear }
 
-  # @see Vedeu::Terminal::Buffer#output
-  Vedeu.bind(:_drb_retrieve_output_) { Vedeu::Terminal::Buffer.output }
+  # @see Vedeu::Buffers::Terminal#output
+  Vedeu.bind(:_drb_retrieve_output_) { Vedeu::Buffers::Terminal.output }
 
-  # @see Vedeu::Terminal::Buffer#write
-  Vedeu.bind(:_drb_store_output_) { |data| Vedeu::Terminal::Buffer.write(data) }
+  # @see Vedeu::Buffers::Terminal#write
+  Vedeu.bind(:_drb_store_output_) { |data| Vedeu::Buffers::Terminal.write(data) }
 
   # :nocov:
 

data/lib/vedeu/cursors/cursor.rb

@@ -39,12 +39,6 @@ module Vedeu
       # @return [Fixnum]
       attr_writer :y
 
-      # @param (see #initialize)
-      # @return [Vedeu::Cursors::Cursor]
-      def self.store(attributes = {})
-        new(attributes).store
-      end
-
       # Returns a new instance of Vedeu::Cursors::Cursor.
       #
       # @param attributes [Hash<Symbol => Boolean|Fixnum|String|
@@ -162,8 +156,6 @@ module Vedeu
       #
       # @return [Array<Vedeu::Models::Escape>]
       def render
-        Vedeu.log(type: :output, message: "Refreshing cursor: '#{name}'".freeze)
-
         Vedeu.render_output(escape_sequence)
       end
 
@@ -199,6 +191,8 @@ module Vedeu
       def hide
         super
 
+        Vedeu.log(type: :output, message: "Hiding cursor: '#{name}'".freeze)
+
         render
       end
 
@@ -234,6 +228,8 @@ module Vedeu
       def show
         super
 
+        Vedeu.log(type: :output, message: "Showing cursor: '#{name}'".freeze)
+
         render
       end
 

data/lib/vedeu/cursors/refresh.rb

@@ -44,6 +44,11 @@ module Vedeu
       def by_name
         refresh_view if refresh_view?
 
+        Vedeu.log(type:    :output,
+                  message: "Refreshing cursor: '#{name}' (x:#{cursor.x}, " \
+                           "y:#{cursor.y}, ox:#{cursor.ox}, oy:#{cursor.oy}, " \
+                           "visible:#{cursor.visible})".freeze)
+
         cursor.render
       end
 

data/lib/vedeu/editor/all.rb

@@ -8,6 +8,7 @@ module Vedeu
 
 end # Vedeu
 
+require 'vedeu/editor/collection'
 require 'vedeu/editor/cropper'
 require 'vedeu/editor/delete'
 require 'vedeu/editor/editor'

data/lib/vedeu/editor/collection.rb

@@ -0,0 +1,26 @@
+module Vedeu
+
+  module Editor
+
+    # Used by {Vedeu::Editor::Lines} and {Vedeu::Editor::Line} to
+    # fetch an item from the respective collection.
+    #
+    # @api private
+    #
+    module Collection
+
+      include Vedeu::Repositories::Assemblage
+
+      # Fetches an item from a collection.
+      #
+      # @param index [Fixnum]
+      # @return [String]
+      def by_index(index)
+        Vedeu::Editor::Item.by_index(collection, index)
+      end
+
+    end # Collection
+
+  end # Editor
+
+end # Vedeu

data/lib/vedeu/editor/document.rb

@@ -31,14 +31,6 @@ module Vedeu
       # @return [String|Symbol]
       attr_accessor :name
 
-      # Store an instance of this class with its repository.
-      #
-      # @param (see #initialize)
-      # @return (see #initialize)
-      def self.store(attributes = {})
-        new(attributes).store
-      end
-
       # Returns the document as a string with line breaks if there is
       # more than one line.
       #

data/lib/vedeu/editor/line.rb

@@ -8,37 +8,31 @@ module Vedeu
     #
     class Line
 
-      # @!attribute [rw] line
+      include Vedeu::Editor::Collection
+
+      # @!attribute [rw] collection
       # @return [String]
-      attr_accessor :line
-      alias_method :to_s, :line
+      attr_accessor :collection
+      alias_method :line, :collection
+      alias_method :to_s, :collection
 
       # Coerce a line into a new instance of Vedeu::Editor::Line.
       #
-      # @param line [String|Vedeu::Editor::Line]
+      # @param collection [String|Vedeu::Editor::Line]
       # @return (see #initialize)
-      def self.coerce(line)
-        return line      if line.is_a?(self)
-        return new(line) if line.is_a?(String)
+      def self.coerce(collection)
+        return collection      if collection.is_a?(self)
+        return new(collection) if collection.is_a?(String)
 
         new
       end
 
       # Returns a new instance of Vedeu::Editor::Line.
       #
-      # @param line [String|NilClass]
+      # @param collection [String|NilClass]
       # @return [Vedeu::Editor::Line]
-      def initialize(line = nil)
-        @line = line || ''
-      end
-
-      # Return a character or collection of characters (if index is a
-      # Range).
-      #
-      # @param index [Fixnum|Range]
-      # @return [String]
-      def [](index)
-        line[index]
+      def initialize(collection = nil)
+        @collection = collection || ''
       end
 
       # Return the character at the given index.
@@ -46,10 +40,10 @@ module Vedeu
       # @param index [Fixnum|NilClass]
       # @return [String|NilClass]
       def character(index = nil)
-        return ''       if line && line.empty?
-        return line[-1] unless index
+        return ''             if collection && collection.empty?
+        return collection[-1] unless index
 
-        Vedeu::Editor::Item.by_index(line, index)
+        by_index(index)
       end
 
       # Delete the character from the line positioned at the given
@@ -62,23 +56,6 @@ module Vedeu
                                    .from(line, index, size))
       end
 
-      # Returns a boolean indicating whether there are characters on
-      # this line.
-      #
-      # @return [Boolean]
-      def empty?
-        line.empty?
-      end
-
-      # An object is equal when its values are the same.
-      #
-      # @param other [Vedeu::Editor::Line]
-      # @return [Boolean]
-      def eql?(other)
-        self.class == other.class && line == other.line
-      end
-      alias_method :==, :eql?
-
       # Insert the character on the line positioned at the given
       # index.
       #
@@ -89,14 +66,7 @@ module Vedeu
         return self unless character
 
         Vedeu::Editor::Line.coerce(Vedeu::Editor::Insert
-                                   .into(line, character, index, size))
-      end
-
-      # Return the size of the line in characters.
-      #
-      # @return [Fixnum]
-      def size
-        line.size
+                                   .into(collection, character, index, size))
       end
 
     end # Line

data/lib/vedeu/editor/lines.rb

@@ -9,10 +9,12 @@ module Vedeu
     class Lines
 
       include Enumerable
+      include Vedeu::Editor::Collection
 
-      # @!attribute [rw] lines
+      # @!attribute [rw] collection
       # @return [String]
-      attr_accessor :lines
+      attr_accessor :collection
+      alias_method :lines, :collection
 
       # Coerce a document into a new instance of Vedeu::Editor::Lines.
       #
@@ -23,16 +25,16 @@ module Vedeu
           new(document.lines)
 
         elsif document.is_a?(Array)
-          lines = document.map { |line| Vedeu::Editor::Line.coerce(line) }
+          collection = document.map { |line| Vedeu::Editor::Line.coerce(line) }
 
-          new(lines)
+          new(collection)
 
         elsif document.is_a?(String)
-          lines = document.lines.map(&:chomp).map do |line|
+          collection = document.lines.map(&:chomp).map do |line|
             Vedeu::Editor::Line.coerce(line)
           end
 
-          new(lines)
+          new(collection)
 
         else
           new
@@ -42,18 +44,10 @@ module Vedeu
 
       # Returns a new instance of Vedeu::Editor::Lines.
       #
-      # @param lines [Array<String>|NilClass]
+      # @param collection [Array<String>|NilClass]
       # @return [Vedeu::Editor::Lines]
-      def initialize(lines = nil)
-        @lines = lines || []
-      end
-
-      # Return a line or collection of lines (if index is a Range).
-      #
-      # @param index [Fixnum|Range]
-      # @return [Vedeu::Editor::Line]
-      def [](index)
-        lines[index]
+      def initialize(collection = nil)
+        @collection = collection || []
       end
 
       # Deletes the character from the line where the cursor is
@@ -63,9 +57,9 @@ module Vedeu
       # @param x [Fixnum]
       # @return [Vedeu::Editor::Lines]
       def delete_character(y, x)
-        lines[y] = line(y).delete_character(x) unless line(y).empty?
+        collection[y] = line(y).delete_character(x) unless line(y).empty?
 
-        Vedeu::Editor::Lines.coerce(lines)
+        Vedeu::Editor::Lines.coerce(collection)
       end
 
       # Delete the line from the lines positioned at the given index.
@@ -82,25 +76,9 @@ module Vedeu
       # @param block [Proc]
       # @return [Enumerator]
       def each(&block)
-        lines.each(&block)
-      end
-
-      # Returns a boolean indicating whether there are lines.
-      #
-      # @return [Boolean]
-      def empty?
-        lines.empty?
+        collection.each(&block)
       end
 
-      # An object is equal when its values are the same.
-      #
-      # @param other [Vedeu::Editor::Lines]
-      # @return [Boolean]
-      def eql?(other)
-        self.class == other.class && lines == other.lines
-      end
-      alias_method :==, :eql?
-
       # Insert a character in to a line.
       #
       # @param character [String]
@@ -108,9 +86,9 @@ module Vedeu
       # @param x [Fixnum]
       # @return [Vedeu::Editor::Lines]
       def insert_character(character, y, x)
-        lines[y] = line(y).insert_character(character, x)
+        collection[y] = line(y).insert_character(character, x)
 
-        Vedeu::Editor::Lines.coerce(lines)
+        Vedeu::Editor::Lines.coerce(collection)
       end
 
       # Insert the line on the line below the given index.
@@ -119,7 +97,7 @@ module Vedeu
       # @return [Vedeu::Editor::Lines]
       def insert_line(index = nil)
         Vedeu::Editor::Lines.coerce(
-          Vedeu::Editor::Insert.into(lines,
+          Vedeu::Editor::Insert.into(collection,
                                      Vedeu::Editor::Line.new,
                                      index,
                                      size))
@@ -130,27 +108,20 @@ module Vedeu
       # @param index [Fixnum|NilClass]
       # @return [Vedeu::Editor::Line]
       def line(index = nil)
-        return Vedeu::Editor::Line.new unless lines
-        return Vedeu::Editor::Line.coerce(lines[-1]) unless index
+        return Vedeu::Editor::Line.new unless collection
+        return Vedeu::Editor::Line.coerce(collection[-1]) unless index
 
-        Vedeu::Editor::Line.coerce(Vedeu::Editor::Item.by_index(lines, index))
-      end
-
-      # Return the number of lines.
-      #
-      # @return [Fixnum]
-      def size
-        lines.size
+        Vedeu::Editor::Line.coerce(by_index(index))
       end
 
       # Return the lines as a string.
       #
       # @return [String]
       def to_s
-        lines.map(&:to_s).join
+        collection.map(&:to_s).join
       end
 
-    end # Line
+    end # Lines
 
   end # Editor
 

data/lib/vedeu/geometries/geometry.rb

@@ -82,12 +82,6 @@ module Vedeu
       # @return [Object]
       attr_accessor :client
 
-      # @param (see #initialize)
-      # @return (see #initialize)
-      def self.store(attributes, &block)
-        new(attributes).store(&block)
-      end
-
       # Returns a new instance of Vedeu::Geometries::Geometry.
       #
       # @param attributes [Hash<Symbol => Boolean|Fixnum|String|

data/lib/vedeu/groups/group.rb

@@ -14,12 +14,6 @@ module Vedeu
       # @return [String]
       attr_accessor :name
 
-      # @param (see #initialize)
-      # @return (see #initialize)
-      def self.store(attributes = {})
-        new(attributes).store
-      end
-
       # Return a new instance of Vedeu::Groups::Group.
       #
       # @note

data/lib/vedeu/input/capture.rb

@@ -107,7 +107,7 @@ module Vedeu
       # Returns a boolean indicating whether a mouse click was
       # received.
       #
-      # @param key [NilClass|String|Symbol|Vedeu::Cursors::Cursor]
+      # @param input [NilClass|String|Symbol|Vedeu::Cursors::Cursor]
       # @return [Boolean]
       def click?(input)
         return false if input.nil? || input.is_a?(Symbol)

data/lib/vedeu/interfaces/clear.rb

@@ -65,7 +65,7 @@ module Vedeu
         if direct?
           Vedeu.direct_write(optimised_output)
 
-          Vedeu::Terminal::Buffer.update(output)
+          Vedeu::Buffers::Terminal.update(output)
 
         else
           Vedeu.render_output(output)

data/lib/vedeu/logging/log.rb

@@ -135,7 +135,7 @@ module Vedeu
         def message_type(type)
           Vedeu::EscapeSequences::Esc
             .send(message_types.fetch(type, :default)[0]) do
-            "[#{type}]".ljust(9)
+            "[#{type}]".ljust(11)
           end
         end
 
@@ -170,7 +170,10 @@ module Vedeu
             debug:  [:white, :light_grey],
 
             input:  [:light_yellow, :yellow],
-            output: [:light_green,  :green],
+
+            compress: [:white, :light_grey],
+            output:   [:light_green, :green],
+            render:   [:light_green, :green],
 
             error:  [:light_red, :red],
 

data/lib/vedeu/models/focus.rb

@@ -169,15 +169,13 @@ module Vedeu
         Vedeu.trigger(:_refresh_cursor_, current)
       end
 
-      # Returns a collection of the names of all the registered
-      # entities.
+      # Access to the storage for this repository.
       #
       # @return [Array]
-      def registered
-        return [] if empty?
-
-        storage
+      def storage
+        @storage ||= in_memory
       end
+      alias_method :registered, :storage
 
       # Returns a boolean indicating whether the named model is
       # registered.
@@ -229,13 +227,6 @@ module Vedeu
         current
       end
 
-      # Access to the storage for this repository.
-      #
-      # @return [Array]
-      def storage
-        @storage ||= in_memory
-      end
-
       # Returns an empty collection ready for the storing of interface
       # names.
       #

data/lib/vedeu/output/compressor.rb

@@ -51,9 +51,13 @@ module Vedeu
 
       # @return [Array]
       def content
-        return [] if absent?(output)
+        @content ||= if present?(output)
+                       output.content.reject(&:cell?)
 
-        @content ||= output.content.reject(&:cell?)
+                     else
+                       []
+
+                     end
       end
 
       # @return [String]
@@ -69,7 +73,7 @@ module Vedeu
             ].join
           end.join
 
-          Vedeu.log(type:    :output,
+          Vedeu.log(type:    :compress,
                     message: "Compression: #{content.size} objects -> " \
                              "#{out.size} characters".freeze)
 
@@ -81,7 +85,7 @@ module Vedeu
       def uncompress
         out = content.map(&:to_s).join
 
-        Vedeu.log(type:    :output,
+        Vedeu.log(type:    :compress,
                   message: "No compression: #{content.size} objects -> " \
                            "#{out.size} characters".freeze)
 

data/lib/vedeu/output/output.rb

@@ -74,7 +74,7 @@ module Vedeu
       # Send the view to the renderers. If the output is a
       # {Vedeu::Models::Escape} object (typical when showing or
       # hiding the cursor) then we bypass the
-      # {Vedeu::Terminal::Buffer} and write directly to the terminal
+      # {Vedeu::Buffers::Terminal} and write directly to the terminal
       # because escape sequences only make sense to the terminal and
       # not other renderers.
       #
@@ -100,12 +100,12 @@ module Vedeu
 
       # @return [Array]
       def buffer_update!
-        Vedeu::Terminal::Buffer.update(output)
+        Vedeu::Buffers::Terminal.update(output)
       end
 
       # @return [Array]
       def buffer_write!
-        Vedeu::Terminal::Buffer.write(output)
+        Vedeu::Buffers::Terminal.write(output)
       end
 
       # @return [Array<String>]

data/lib/vedeu/output/renderers/all.rb

@@ -18,7 +18,7 @@ module Vedeu
     # @return [Array<void>]
     def clear
       storage.map do |renderer|
-        Vedeu.log(type:    :output,
+        Vedeu.log(type:    :render,
                   message: "Clearing via #{renderer.class.name}".freeze)
 
         Thread.new(renderer) do
@@ -51,7 +51,7 @@ module Vedeu
     # @return [Array<void>]
     def render(output)
       storage.map do |renderer|
-        Vedeu.log(type:    :output,
+        Vedeu.log(type:    :render,
                   message: "Rendering via #{renderer.class.name}".freeze)
 
         Thread.new(renderer) do