vedeu 0.6.20 → 0.6.21

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

@@ -1,12 +1,5 @@
-require 'vedeu/output/presentation/colour'
-require 'vedeu/output/presentation/styles'
-require 'vedeu/output/presentation/style'
-
 module Vedeu
 
-  # This module allows the sharing of presentation concerns between
-  # the models: Interface, View, Line and Stream.
-  #
   module Presentation
 
     include Vedeu::Presentation::Colour

data/lib/vedeu/output/refresh/refresh.rb

@@ -5,9 +5,7 @@ module Vedeu
     # @see Vedeu::Bindings::System#refresh!
     class Refresh
 
-      # Refresh all registered interfaces.
-      #
-      # @return [Array<Vedeu::Models::Interface>]
+      # @see #all
       def self.all
         new.all
       end

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

@@ -104,6 +104,16 @@ module Vedeu
 
   end # Renderers
 
+  # @example
+  #   Vedeu.renderer
+  #   Vedeu.renderers
+  #
+  # @!method renderer
+  #   @see Vedeu::Renderers#renderer
+  # @!method renderers
+  #   @see Vedeu::Renderers#renderers
+  def_delegators Vedeu::Renderers, :renderer, :renderers
+
 end # Vedeu
 
 require 'vedeu/output/renderers/options'

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

@@ -27,9 +27,7 @@ module Vedeu
       # @param output [Vedeu::Models::Page]
       # @return [Array<String>]
       def render(output)
-        output = parse(output)
-
-        Vedeu::Terminal.output(output)
+        Vedeu::Terminal.output(parse(output))
       end
 
       private

data/lib/vedeu/repositories/collection.rb

@@ -19,12 +19,12 @@ module Vedeu
       attr_accessor :parent
 
       # @!attribute [rw] name
-      # @return [String]
+      # @return [String|Symbol|NilClass]
       attr_accessor :name
 
       # @param collection [Array|Vedeu::Repositories::Collection]
       # @param parent [void]
-      # @param name [String|NilClass]
+      # @param name [String|Symbol|NilClass]
       # @return [Vedeu::Repositories::Collection]
       def self.coerce(collection = [], parent = nil, name = nil)
         if collection.is_a?(Vedeu::Repositories::Collection)
@@ -40,7 +40,7 @@ module Vedeu
       #
       # @param collection [void]
       # @param parent [void]
-      # @param name [String|NilClass]
+      # @param name [String|Symbol|NilClass]
       # @return [Vedeu::Repositories::Collection]
       def initialize(collection = [], parent = nil, name = nil)
         @collection = collection

data/lib/vedeu/repositories/model.rb

@@ -45,7 +45,7 @@ module Vedeu
 
         # Fetch an instance of a repository's model by name.
         #
-        # @param name [String]
+        # @param name [String|Symbol]
         # @return [void]
         def by_name(name)
           repository.by_name(name) if repository

data/lib/vedeu/repositories/repository.rb

@@ -55,12 +55,12 @@ module Vedeu
       # @example
       #   # Fetch the cursor belonging to the interface of the same
       #   # name.
-      #   Vedeu.cursors.by_name('some_name')
+      #   Vedeu.cursors.by_name(:some_name)
       #
       #   # Fetch the names of the interfaces belonging to this group.
       #   Vedeu.groups.by_name(name)
       #
-      # @param name [String] The name of the stored model.
+      # @param name [String|Symbol] The name of the stored model.
       # @return [void]
       def by_name(name)
         name ||= Vedeu.focus
@@ -79,7 +79,7 @@ module Vedeu
 
       # Find the model by name.
       #
-      # @param name [String]
+      # @param name [String|Symbol]
       # @return [Hash<String => Object>|NilClass]
       def find(name)
         storage[name]
@@ -88,7 +88,7 @@ module Vedeu
       # Find the model attributes by name, raises an exception when
       # the model cannot be found.
       #
-      # @param name [String]
+      # @param name [String|Symbol]
       # @raise [Vedeu::Error::ModelNotFound] When the model cannot be
       #   found with this name.
       # @return [Hash<String => Object>]
@@ -100,7 +100,7 @@ module Vedeu
       # Find a model by name, registers the model by name when not
       # found.
       #
-      # @param name [String]
+      # @param name [String|Symbol]
       # @return [void]
       def find_or_create(name)
         return find(name) if registered?(name)
@@ -119,10 +119,10 @@ module Vedeu
       # Returns a boolean indicating whether the named model is
       # registered.
       #
-      # @param name [String]
+      # @param name [String|Symbol]
       # @return [Boolean]
       def registered?(name)
-        return false if name.nil? || name.empty?
+        return false if absent?(name)
         return false if empty?
 
         storage.include?(name)
@@ -131,7 +131,7 @@ module Vedeu
       # Returns the storage with the named model removed, or false
       # when the model does not exist.
       #
-      # @param name [String]
+      # @param name [String|Symbol]
       # @return [Hash|FalseClass]
       def remove(name)
         return false if empty?

data/lib/vedeu/repositories/store.rb

@@ -7,6 +7,7 @@ module Vedeu
     module Store
 
       include Enumerable
+      include Vedeu::Common
 
       # @param block [Proc]
       # @return [Enumerator]
@@ -24,10 +25,10 @@ module Vedeu
       # Returns a boolean indicating whether the named model is
       # registered.
       #
-      # @param name [String]
+      # @param name [String|Symbol]
       # @return [Boolean]
       def exists?(name)
-        return false if empty? || name.nil? || name.empty?
+        return false if empty? || absent?(name)
 
         storage.include?(name)
       end

data/lib/vedeu/runtime/application.rb

@@ -132,4 +132,8 @@ module Vedeu
 
   end # Runtime
 
+  # @!method exit
+  #   @see Vedeu::Runtime::Application.stop
+  def_delegators Vedeu::Runtime::Application, :exit
+
 end # Vedeu

data/lib/vedeu/runtime/bootstrap.rb

@@ -10,7 +10,7 @@ module Vedeu
     #
     class Bootstrap
 
-      # @param argv [Array<String>]
+      # @param (see #initialize)
       # @return [void]
       def self.start(argv = ARGV)
         new(argv).start

data/lib/vedeu/runtime/flags.rb

@@ -58,4 +58,11 @@ module Vedeu
 
   end # Runtime
 
+  # Manipulate the internal flags.
+  #
+  # @!method ready?
+  # @!method ready!
+  # @return [Boolean]
+  def_delegators Vedeu::Runtime::Flags, :ready?, :ready!
+
 end # Vedeu

data/lib/vedeu/runtime/main_loop.rb

@@ -26,6 +26,8 @@ module Vedeu
 
             Vedeu.trigger(:_hide_cursor_)
 
+            Vedeu.log(type:    :info,
+                      message: 'MainLoop rendering terminal buffer.')
             Vedeu::Terminal::Buffer.render
 
             Vedeu.trigger(:_show_cursor_)

data/lib/vedeu/runtime/router.rb

@@ -187,4 +187,8 @@ module Vedeu
 
   end # Runtime
 
+  # @!method goto
+  #   @see Vedeu::Runtime::Router#goto
+  def_delegators Vedeu::Runtime::Router, :goto
+
 end # Vedeu

data/lib/vedeu/templating/decoder.rb

@@ -7,7 +7,7 @@ module Vedeu
     #
     class Decoder
 
-      # @param data [String]
+      # @param (see #initialize)
       # @return [Object]
       def self.process(data)
         new(data).process

data/lib/vedeu/templating/encoder.rb

@@ -7,7 +7,7 @@ module Vedeu
     #
     class Encoder
 
-      # @param data [Object]
+      # @param (see #initialize)
       # @return [String]
       def self.process(data)
         new(data).process

data/lib/vedeu/templating/helpers.rb

@@ -6,6 +6,8 @@ module Vedeu
     #
     module Helpers
 
+      include Vedeu::View
+
       # @param value [String] The HTML/CSS colour.
       # @param block [Proc]
       # @raise [Vedeu::Error::RequiresBlock]

data/lib/vedeu/templating/template.rb

@@ -17,7 +17,7 @@ module Vedeu
       # @param object [Class]
       # @param path [String]
       # @param options [Hash]
-      # @option options name [String] The name of an interface.
+      # @option options name [String|Symbol] The name of an interface.
       # @return [Vedeu::Templating::Template]
       def initialize(object, path, options = {})
         @object  = object

data/lib/vedeu/terminal/buffer.rb

@@ -26,6 +26,9 @@ module Vedeu
 
       # Clear the output.
       #
+      # @example
+      #   Vedeu.clear
+      #
       # @return [String|void] Most likely to be a String.
       def clear
         reset
@@ -137,4 +140,8 @@ module Vedeu
 
   end # Terminal
 
+  # @!method clear
+  #   @see Vedeu::Terminal::Buffer#clear
+  def_delegators Vedeu::Terminal::Buffer, :clear
+
 end # Vedeu

data/lib/vedeu/terminal/terminal.rb

@@ -216,4 +216,12 @@ module Vedeu
 
   end # Terminal
 
+  # @!method height
+  #   @see Vedeu::Terminal#height
+  # @!method resize
+  #   @see Vedeu::Terminal#resize
+  # @!method width
+  #   @see Vedeu::Terminal#width
+  def_delegators Vedeu::Terminal, :height, :resize, :width
+
 end # Vedeu

data/lib/vedeu/version.rb

@@ -1,6 +1,6 @@
 module Vedeu
 
   # The current version of Vedeu.
-  VERSION = '0.6.20'
+  VERSION = '0.6.21'
 
 end

data/test/lib/vedeu/borders/dsl_test.rb

@@ -13,12 +13,6 @@ module Vedeu
       let(:attributes) { { name: 'borders' } }
       let(:boolean)    { true }
 
-      describe '#initialize' do
-        it { instance.must_be_instance_of(described) }
-        it { instance.instance_variable_get('@model').must_equal(model) }
-        it { instance.instance_variable_get('@client').must_equal(client) }
-      end
-
       describe '.border' do
         it { described.must_respond_to(:border) }
       end

data/test/lib/vedeu/borders/null_test.rb

@@ -60,12 +60,6 @@ module Vedeu
         it { subject.must_equal(12) }
       end
 
-      describe '#enabled?' do
-        subject { instance.enabled? }
-
-        it { subject.must_be_instance_of(FalseClass) }
-      end
-
       describe '#height' do
         subject { instance.height }
 
@@ -73,12 +67,6 @@ module Vedeu
         it { subject.must_equal(7) }
       end
 
-      describe '#null?' do
-        subject { instance.null? }
-
-        it { subject.must_be_instance_of(TrueClass) }
-      end
-
       describe '#render' do
         subject { instance.render }
 

data/test/lib/vedeu/buffers/null_test.rb

@@ -7,43 +7,6 @@ module Vedeu
     describe Null do
 
       let(:described) { Vedeu::Buffers::Null }
-      let(:instance)  { described.new(attributes) }
-      let(:attributes){
-        {
-          name: _name
-        }
-      }
-      let(:_name)     { 'null_buffer' }
-
-      describe '#initialize' do
-        it { instance.must_be_instance_of(described) }
-        it {
-          instance.instance_variable_get('@attributes').must_equal(attributes)
-        }
-        it { instance.instance_variable_get('@name').must_equal(_name) }
-      end
-
-      describe 'accessors' do
-        it { instance.must_respond_to(:name) }
-      end
-
-      describe '#null' do
-        subject { instance.null }
-
-        it { subject.must_be_instance_of(NilClass) }
-
-        it { instance.must_respond_to(:clear) }
-        it { instance.must_respond_to(:hide) }
-        it { instance.must_respond_to(:render) }
-        it { instance.must_respond_to(:show) }
-        it { instance.must_respond_to(:toggle) }
-      end
-
-      describe '#null?' do
-        subject { instance.null? }
-
-        it { subject.must_be_instance_of(TrueClass) }
-      end
 
     end # Null
 

data/test/lib/vedeu/common_test.rb

@@ -10,6 +10,10 @@ module Vedeu
       present?(variable)
     end
 
+    def undefined_value_test(variable)
+      absent?(variable)
+    end
+
   end # VedeuCommonClass
 
   describe Common do
@@ -17,6 +21,35 @@ module Vedeu
     let(:described) { Vedeu::VedeuCommonClass }
     let(:instance) { described.new }
 
+    describe '#absent?' do
+      subject { instance.undefined_value_test(_value) }
+
+      context 'when the variable is a Fixnum' do
+        let(:_value) { 17 }
+
+        it { subject.must_equal(false) }
+      end
+
+      context 'when the variable is not nil or empty' do
+        let(:_value) { 'not empty' }
+
+        it { subject.must_equal(false) }
+      end
+
+      context 'when the variable is nil or empty' do
+        let(:_value) { [] }
+
+        it { subject.must_equal(true) }
+      end
+
+      context 'when dealing with keys which may not exist or have a value' do
+        let(:attributes) { {} }
+        let(:_value)     { attributes[:not_found] }
+
+        it { subject.must_equal(true) }
+      end
+    end
+
     describe '#demodulize' do
       let(:klass) { described }
 

data/test/lib/vedeu/cursors/cursor_test.rb

@@ -68,7 +68,7 @@ module Vedeu
           instance.must_respond_to(:ox=)
           instance.must_respond_to(:oy)
           instance.must_respond_to(:oy=)
-          instance.must_respond_to(:state)
+          instance.must_respond_to(:visible)
           instance.must_respond_to(:x=)
           instance.must_respond_to(:y=)
         }