vedeu 0.4.18 → 0.4.19

data/lib/vedeu/input/keymap.rb

@@ -1,11 +1,8 @@
-require 'vedeu/repositories/all'
-require 'vedeu/dsl/components/all'
-require 'vedeu/input/key'
+require 'vedeu/dsl/components/keymap'
 
 module Vedeu
 
   # A container class for keys associated with a particular interface.
-  #
   class Keymap
 
     include Vedeu::Model
@@ -27,9 +24,9 @@ module Vedeu
     def initialize(attributes = {})
       @attributes = defaults.merge!(attributes)
 
-      @name       = @attributes[:name]
-      @keys       = @attributes[:keys]
-      @repository = @attributes[:repository]
+      @attributes.each do |key, value|
+        instance_variable_set("@#{key}", value)
+      end
     end
 
     # @param key [Key]

data/lib/vedeu/input/mapper.rb

@@ -1,7 +1,6 @@
 module Vedeu
 
   # Maps keys to keymaps.
-  #
   class Mapper
 
     # Takes a key as a keypress and sends it to registered keymaps. If found,
@@ -65,7 +64,7 @@ module Vedeu
       true
     end
 
-    private
+    protected
 
     # @!attribute [r] key
     # @return [String|Symbol]
@@ -75,6 +74,8 @@ module Vedeu
     # @return [Vedeu::Repository]
     attr_reader :repository
 
+    private
+
     # Is the key a global key?
     #
     # @return [Boolean]

data/lib/vedeu/launcher.rb

@@ -6,7 +6,6 @@ module Vedeu
   # finally the exiting of the application with the correct exit code.
   #
   # @api public
-  #
   class Launcher
 
     # @!attribute [r] exit_code
@@ -70,12 +69,14 @@ module Vedeu
       puts uncaught_exception.backtrace.join("\n") if configuration.debug?
     end
 
-    private
+    protected
 
     # @!attribute [r] argv
     # @return [Array<String>] The command line arguments provided.
     attr_reader :argv
 
+    private
+
     # Terminates the application after resetting $stdin, $stdout and $stderr.
     #
     # @return [void]

data/lib/vedeu/main_loop.rb

@@ -5,7 +5,6 @@ module Vedeu
   # Each time Vedeu starts one cycle in the application loop, it triggers the
   # `:tick` event. A completion of that cycle will trigger `:tock`. This can be
   # used by the client application for timing amongst other things.
-  #
   class MainLoop
 
     trap('SIGTERM') { stop! }
@@ -27,6 +26,7 @@ module Vedeu
         safe_exit_point!
       end
     rescue VedeuInterrupt
+      Vedeu.log(type: :debug, message: 'Vedeu execution interrupted, exiting.')
     end
     # :nocov:
 

data/lib/vedeu/models/cell.rb

@@ -1,7 +1,6 @@
 module Vedeu
 
   # A Cell represents a single square of the terminal.
-  #
   class Cell
 
     # @!attribute [r] colour

data/lib/vedeu/models/char.rb

@@ -10,7 +10,6 @@ module Vedeu
   #
   # Though a multi-character String can be passed as a value, only the first
   # character is returned in the escape sequence.
-  #
   class Char
 
     include Vedeu::Presentation

data/lib/vedeu/models/composition.rb

@@ -1,12 +1,6 @@
-require 'vedeu/dsl/composition'
-require 'vedeu/repositories/all'
-require 'vedeu/output/presentation'
-require 'vedeu/support/common'
-
 module Vedeu
 
   # A composition is a collection of interfaces.
-  #
   class Composition
 
     include Vedeu::Model
@@ -30,7 +24,6 @@ module Vedeu
       @attributes = defaults.merge!(attributes)
 
       @interfaces = @attributes[:interfaces]
-      @repository = Vedeu.interfaces
     end
 
     # @param child [Vedeu::Interface]
@@ -62,6 +55,7 @@ module Vedeu
         client:     nil,
         colour:     nil,
         interfaces: [],
+        repository: Vedeu.interfaces,
         style:      nil,
       }
     end

data/lib/vedeu/models/group.rb

@@ -1,10 +1,7 @@
-require 'vedeu/repositories/model'
-
 module Vedeu
 
   # Interfaces can be associated with one another by being members of the same
   # Group. A Group is a collection of interface names.
-  #
   class Group
 
     include Vedeu::Model

data/lib/vedeu/models/interface.rb

@@ -1,5 +1,3 @@
-require 'vedeu/models/all'
-require 'vedeu/output/presentation'
 require 'vedeu/buffers/display_buffer'
 
 module Vedeu
@@ -7,7 +5,6 @@ module Vedeu
   # An Interface represents a portion of the terminal defined by
   # {Vedeu::Geometry}. It is a container for {Vedeu::Line} and {Vedeu::Stream}
   # objects.
-  #
   class Interface
 
     extend Forwardable

data/lib/vedeu/models/line.rb

@@ -1,12 +1,8 @@
-require 'vedeu/output/presentation'
-require 'vedeu/models/all'
-
 module Vedeu
 
   # A Line represents a single row of the terminal. It is a container for
   # {Vedeu::Stream} objects. A line's width is determined by the
   # {Vedeu::Interface} it belongs to.
-  #
   class Line
 
     include Vedeu::Model

data/lib/vedeu/models/menu.rb

@@ -1,10 +1,7 @@
-require 'vedeu/repositories/model'
-
 module Vedeu
 
   # Converts the collection passed into a list of menu items which can be
   # navigated using the instance methods or events provided.
-  #
   class Menu
 
     include Vedeu::Model
@@ -67,11 +64,10 @@ module Vedeu
     # @return [Menu]
     def initialize(attributes = {})
       @attributes = defaults.merge!(attributes)
-      @collection = @attributes[:collection]
-      @current    = @attributes[:current]
-      @name       = @attributes[:name]
-      @repository = Vedeu.menus
-      @selected   = @attributes[:selected]
+
+      @attributes.each do |key, value|
+        instance_variable_set("@#{key}", value)
+      end
     end
 
     # Returns the item from the collection which shares the same index as the
@@ -210,6 +206,7 @@ module Vedeu
         collection: [],
         current:    0,
         name:       '',
+        repository: Vedeu.menus,
         selected:   nil,
       }
     end

data/lib/vedeu/models/stream.rb

@@ -1,12 +1,8 @@
-require 'vedeu/output/presentation'
-require 'vedeu/models/all'
-
 module Vedeu
 
   # A Stream can represent a character or collection of characters as part of a
   # {Vedeu::Line} which you wish to colour and style independently of the other
   # characters in that line.
-  #
   class Stream
 
     include Vedeu::Model

data/lib/vedeu/null/all.rb

@@ -1,3 +1,14 @@
+module Vedeu
+
+  # A group of objects that serve to intercept messages destined for their
+  # real counterpart. In most cases the call is muted or returns a generic
+  # value that does not halt processing.
+  module Null
+
+  end
+
+end
+
 require_relative 'border'
 require_relative 'buffer'
 require_relative 'generic'

data/lib/vedeu/null/border.rb

@@ -4,7 +4,6 @@ module Vedeu
 
     # Provides a non-existent Vedeu::Border that acts like the real thing, but
     # does nothing.
-    #
     class Border
 
       # @!attribute [r] name
@@ -43,6 +42,9 @@ module Vedeu
       end
       alias_method :yn, :byn
 
+      # The null border should not be enabled, so that named geometry
+      # or null geometry is used.
+      #
       # @return [FalseClass]
       def enabled?
         false

data/lib/vedeu/null/buffer.rb

@@ -4,7 +4,6 @@ module Vedeu
 
     # Provides a non-existent Vedeu::Buffer that acts like the real thing, but
     # does nothing.
-    #
     class Buffer
 
       # @!attribute [r] name

data/lib/vedeu/null/generic.rb

@@ -3,9 +3,10 @@ module Vedeu
   module Null
 
     # Provides a non-existent model to swallow messages.
-    #
     class Generic
 
+      # Returns an instance of the Vedeu::Null::Generic class.
+      #
       # @return [Vedeu::Null::Generic]
       def initialize; end
 
@@ -34,6 +35,8 @@ module Vedeu
         nil
       end
 
+      # The generic null should not be visible.
+      #
       # @return [FalseClass]
       def visible?
         false

data/lib/vedeu/null/geometry.rb

@@ -3,7 +3,6 @@ module Vedeu
   module Null
 
     # Provides a non-existent model to swallow messages.
-    #
     class Geometry
 
       extend Forwardable

data/lib/vedeu/null/interface.rb

@@ -3,19 +3,48 @@ module Vedeu
   module Null
 
     # Provides a non-existent model to swallow messages.
-    #
     class Interface
 
-      # @!attribute [r] attributes
-      # @return [Hash]
-      attr_reader :attributes
+      # @param name [String]
+      # @return [Vedeu::Null::Interface]
+      def initialize(name = nil)
+        @name = name
+      end
 
-      # @param attributes [Hash]
+      # @return [Hash<Symbol => String>]
+      def attributes
+        {
+          name: name,
+        }
+      end
+
+      # Pretend to store this model in the repository.
+      #
       # @return [Vedeu::Null::Interface]
-      def initialize(attributes = {})
-        @attributes = attributes
+      def store
+        self
+      end
+
+      # The null interface should not be visible.
+      #
+      # @return [FalseClass]
+      def visible?
+        false
+      end
+
+      # Override the visible= setter usually found on a Vedeu::Interface.
+      #
+      # @return [FalseClass]
+      def visible=(*)
+        false
       end
 
+      protected
+
+      # @!attribute [r] name
+      # @return [String]
+      attr_reader :name
+
     end # Interface
 
   end # Null

data/lib/vedeu/output/background.rb

@@ -2,7 +2,6 @@ module Vedeu
 
   # The class represents one half (the other, can be found at
   # {Vedeu::Foreground}) of a terminal colour escape sequence.
-  #
   class Background < Vedeu::Translator
 
     private

data/lib/vedeu/output/border.rb

@@ -1,6 +1,3 @@
-require 'vedeu/repositories/all'
-require 'vedeu/dsl/components/all'
-
 module Vedeu
 
   # Provides the mechanism to decorate an interface with a border on all edges,
@@ -10,7 +7,6 @@ module Vedeu
   #
   # @note Refer to UTF-8 U+2500 to U+257F for border characters. More details
   #   can be found at: http://en.wikipedia.org/wiki/Box-drawing_character
-  #
   class Border
 
     extend Forwardable
@@ -241,9 +237,8 @@ module Vedeu
     # @param position [Symbol] Either :top_horizontal, or :bottom_horizontal.
     # @return [Array<Vedeu::Char>]
     def horizontal_border(position)
-      width.times.inject([]) do |a, ix|
+      width.times.each_with_object([]) do |ix, a|
         a << border(horizontal, position, nil, ix)
-        a
       end
     end
 

data/lib/vedeu/output/clear.rb

@@ -1,7 +1,6 @@
 module Vedeu
 
   # Clears the area defined by an interface.
-  #
   class Clear
 
     extend Forwardable
@@ -84,12 +83,14 @@ module Vedeu
       Vedeu::Output.render(rendered)
     end
 
-    private
+    protected
 
     # @!attribute [r] interface
     # @return [Interface]
     attr_reader :interface
 
+    private
+
     # @return (see Vedeu::Borders#by_name)
     def border
       @border ||= Vedeu.borders.by_name(name)

data/lib/vedeu/output/colour.rb

@@ -30,7 +30,6 @@ module Vedeu
   # area needs more work in Vedeu.
   #
   # @todo Fix colours in all terminals. (GL: 2015-04-13)
-  #
   class Colour
 
     # @!attribute [r] attributes
@@ -42,21 +41,12 @@ module Vedeu
     def self.coerce(value)
       return value if value.is_a?(self)
       return new unless value.is_a?(Hash)
-      return new unless value[:colour] ||
-                        value[:background] ||
-                        value[:foreground]
 
       if value[:colour]
         return value[:colour] if value[:colour].is_a?(self)
-
-        if value[:colour].is_a?(Hash) && (value[:colour][:background] ||
-                                          value[:colour][:foreground])
-          new(value[:colour])
-
-        else
-          new
-
-        end
+        return new unless value[:colour].is_a?(Hash)
+        return new(value[:colour]) if value[:colour][:background] ||
+                                      value[:colour][:foreground]
 
       elsif value[:background] || value[:foreground]
         new(value)
@@ -72,7 +62,7 @@ module Vedeu
     # @param attributes [Hash]
     # @option attributes background [String]
     # @option attributes foreground [String]
-    # @return [Colour]
+    # @return [Vedeu::Colour]
     def initialize(attributes = {})
       @attributes = defaults.merge!(attributes)
     end
@@ -89,8 +79,7 @@ module Vedeu
     # @param value [String]
     # @return [String]
     def background=(value)
-      @attributes[:background] = value
-      @background = Vedeu::Background.coerce(value)
+      @background = @attributes[:background] = Vedeu::Background.coerce(value)
     end
 
     # @param other [Vedeu::Char]
@@ -113,8 +102,7 @@ module Vedeu
     # @param value [String]
     # @return [String]
     def foreground=(value)
-      @attributes[:foreground] = value
-      @foreground = Vedeu::Foreground.coerce(value)
+      @foreground = @attributes[:foreground] = Vedeu::Foreground.coerce(value)
     end
 
     # Returns both or either of the converted attributes into a single escape

data/lib/vedeu/output/compressor.rb

@@ -3,7 +3,6 @@ module Vedeu
   # During the conversion of a Vedeu::Char object into a string of escape
   # sequences, this class removes multiple occurences of the same escape
   # sequence, resulting in a smaller payload being sent to the renderer.
-  #
   class Compressor
 
     # @param output [Array<Array<Vedeu::Char>>]
@@ -32,10 +31,14 @@ module Vedeu
       end.join
     end
 
-    private
+    protected
 
+    # @!attribute [r] output
+    # @return [Array<Array<Vedeu::Char>>]
     attr_reader :output
 
+    private
+
     # @param char [Vedeu::Char]
     # @return [String]
     def colour_for(char)

data/lib/vedeu/output/esc.rb

@@ -121,7 +121,10 @@ module Vedeu
 
       return '' if name.empty?
 
-      send(name) rescue ''
+      send(name)
+
+    rescue NoMethodError
+      ''
     end
 
     # Return the escape sequence to render a border character.

data/lib/vedeu/output/foreground.rb

@@ -1,12 +1,7 @@
-require 'vedeu/configuration/configuration'
-require 'vedeu/output/translator'
-require 'vedeu/output/esc'
-
 module Vedeu
 
   # The class represents one half (the other, can be found at
   # {Vedeu::Background}) of a terminal colour escape sequence.
-  #
   class Foreground < Vedeu::Translator
 
     private

data/lib/vedeu/output/html_char.rb

@@ -3,7 +3,6 @@ require 'vedeu/support/common'
 module Vedeu
 
   # Represents a {Vedeu::Char} as a HTML table cell.
-  #
   class HTMLChar
 
     include Vedeu::Common
@@ -27,12 +26,14 @@ module Vedeu
       "<td#{td_style}>#{td_value}</td>"
     end
 
-    private
+    protected
 
     # @!attribute [r] char
     # @return [Vedeu::Char]
     attr_reader :char
 
+    private
+
     # @return [String]
     def td_style
       return '' unless border || defined_value?(value)

data/lib/vedeu/output/output.rb

@@ -1,10 +1,6 @@
-require 'vedeu/output/renderers/all'
-require 'vedeu/output/virtual_buffer'
-
 module Vedeu
 
   # Sends the content to the renderers.
-  #
   class Output
 
     # Writes content to the defined renderers.
@@ -36,7 +32,7 @@ module Vedeu
       Vedeu.renderers.render(content)
     end
 
-    private
+    protected
 
     # @!attribute [r] content
     # @return [Array<Array<Vedeu::Char>>]

data/lib/vedeu/output/refresh.rb

@@ -4,7 +4,7 @@ module Vedeu
   #
   module Refresh
 
-    extend self
+    module_function
 
     # Refresh all registered interfaces.
     #

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

@@ -9,7 +9,6 @@ require_relative 'text'
 module Vedeu
 
   # Provides a single interface to all registered renderers.
-  #
   module Renderers
 
     extend Enumerable

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

@@ -3,7 +3,6 @@ module Vedeu
   module Renderers
 
     # A renderer which returns the escape sequence for each character.
-    #
     class EscapeSequence
 
       # @param output [Array<Array<Vedeu::Char>>]
@@ -25,12 +24,14 @@ module Vedeu
         parsed
       end
 
-      private
+      protected
 
       # @!attribute [r] output
       # @return [Array<Array<Vedeu::Char>>]
       attr_reader :output
 
+      private
+
       # Escapes the escape sequences.
       #
       # @return [String]