vedeu 0.4.62 → 0.4.63

data/lib/vedeu/output/refresh.rb

@@ -41,7 +41,7 @@ module Vedeu
     #
     # @param group_name [String] The name of the group to be refreshed.
     # @return [Array|Vedeu::ModelNotFound] A collection of the names of
-    #   interfaces refreshed, or an exception if the group was not found.
+    #   interfaces refreshed, or an exception when the group was not found.
     def by_group(group_name)
       Vedeu.timer("Refresh Group: '#{group_name}'") do
         Vedeu::RefreshGroup.by_name(group_name)

data/lib/vedeu/output/renderers.rb

@@ -26,7 +26,7 @@ module Vedeu
       threads = storage.map do |renderer|
         Thread.new(renderer) do
           mutex.synchronize do
-            Vedeu.log(type:    :debug,
+            Vedeu.log(type:    :output,
                       message: "Renderer: '#{renderer.class.name}'")
 
             renderer.render(output)

data/lib/vedeu/output/text.rb

@@ -133,7 +133,7 @@ module Vedeu
       @line ||= Vedeu::Line.build(parent: parent)
     end
 
-    # Returns the model option if set.
+    # Returns the model option when set.
     #
     # @return [Vedeu::Interface|Vedeu::Line|Vedeu::Null::Generic|Vedeu::Stream]
     def model

data/lib/vedeu/output/viewport.rb

@@ -44,7 +44,7 @@ module Vedeu
       @interface = interface
     end
 
-    # Returns the interface with border (if enabled) and the content for the
+    # Returns the interface with border (when enabled) and the content for the
     # interface.
     #
     # @return [Array<Array<String>>]

data/lib/vedeu/repositories.rb

@@ -21,7 +21,7 @@ module Vedeu
       all.map do |repository|
         registered = repository.send(:registered)
 
-        Vedeu.log(type:    :debug,
+        Vedeu.log(type:    :store,
                   message: "Repository '#{repository.class.name}':" \
                            " #{registered.inspect}")
 

data/lib/vedeu/repositories/repository.rb

@@ -85,8 +85,8 @@ module Vedeu
       storage[name]
     end
 
-    # Find the model attributes by name, raises an exception if the model cannot
-    # be found.
+    # Find the model attributes by name, raises an exception when the model
+    # cannot be found.
     #
     # @param name [String]
     # @raise [Vedeu::ModelNotFound] When the model cannot be found with this
@@ -97,7 +97,7 @@ module Vedeu
                          "Cannot find model by name: '#{name}'")
     end
 
-    # Find a model by name, registers the model by name if not found.
+    # Find a model by name, registers the model by name when not found.
     #
     # @param name [String]
     # @return [void]
@@ -131,7 +131,7 @@ module Vedeu
       storage.include?(name)
     end
 
-    # Returns the storage with the named model removed, or false if the model
+    # Returns the storage with the named model removed, or false when the model
     # does not exist.
     #
     # @param name [String]

data/lib/vedeu/{launcher.rb → runtime/launcher.rb}

@@ -65,7 +65,7 @@ module Vedeu
 
     # Alters the STD[IN|OUT|ERR] to those requested by the client application,
     # then starts the application. If an uncaught exception occurs during the
-    # application runtime, we exit ungracefully with the error message if any.
+    # application runtime, we exit ungracefully with any error message(s).
     #
     # @return [void]
     def execute!

data/lib/vedeu/{main_loop.rb → runtime/main_loop.rb}

@@ -25,7 +25,7 @@ module Vedeu
           safe_exit_point!
         end
       rescue Vedeu::VedeuInterrupt
-        Vedeu.log(type:    :debug,
+        Vedeu.log(type:    :info,
                   message: 'Vedeu execution interrupted, exiting.')
       end
       # :nocov:

data/lib/vedeu/{router.rb → runtime/router.rb}

@@ -8,8 +8,12 @@ module Vedeu
 
     extend self
 
+    # Registers a controller with the given controller name for the client
+    # application.
+    #
     # @param controller_name [Symbol]
     # @param klass [String]
+    # @raise [Vedeu::MissingRequired] When the controller name is not given.
     # @return [void]
     def add_controller(controller_name, klass)
       unless present?(controller_name)
@@ -28,8 +32,13 @@ module Vedeu
       storage
     end
 
+    # Registers an action to the given controller name for the client
+    # application.
+    #
     # @param controller_name [Symbol]
     # @param action_name [Symbol]
+    # @raise [Vedeu::MissingRequired] When the controller name or action name is
+    #   not given.
     # @return [void]
     def add_action(controller_name, action_name)
       if present?(controller_name) && present?(action_name)
@@ -51,24 +60,35 @@ module Vedeu
       end
     end
 
+    # Instruct Vedeu to load the client application controller action with
+    # parameters.
+    #
+    # @example
+    #   Vedeu.goto(controller_name, action_name, args)
+    #
     # @param controller_name [Symbol]
     # @param action_name [Symbol]
     # @param args [void]
+    # @raise [Vedeu::ModelNotFound] When the controller is not registered.
     # @return [void]
     def goto(controller_name, action_name, **args)
-      unless registered?(controller_name)
-        fail Vedeu::ModelNotFound, "#{controller_name} is not registered."
+      if action_defined?(action_name, controller_name)
+        controller_with(controller_name).send(action_name, args)
       end
-
-      controller_with(controller_name).send(action_name, args)
     end
+    alias_method :action, :goto
 
+    # Returns a boolean indicating whether the given controller name is already
+    # registered.
+    #
     # @param controller_name [Symbol]
     # @return [Boolean]
     def registered?(controller_name)
       storage.key?(controller_name)
     end
 
+    # Removes all stored controllers with their respective actions.
+    #
     # @return [Hash<void>]
     def reset!
       @storage = in_memory
@@ -77,13 +97,38 @@ module Vedeu
 
     private
 
+    # Returns a boolean indicating whether the given action name is defined for
+    # the given controller.
+    #
+    # @param action_name [Symbol]
+    # @param controller_name [Symbol]
+    # @return [Boolean]
+    def action_defined?(action_name, controller_name)
+      if registered?(controller_name)
+        return true if storage[controller_name][:actions].include?(action_name)
+
+        fail Vedeu::ActionNotFound,
+             "#{action_name} is not registered for #{controller_name}."
+
+      else
+        fail Vedeu::ControllerNotFound, "#{controller_name} is not registered."
+
+      end
+    end
+
+    # Instantiate the given controller by name.
+    #
     # @param controller_name [Symbol]
     # @return [void]
     def controller_with(controller_name)
       Object.const_get(klass_for(controller_name)).new
     end
 
+    # Fetch the class for the controller by name.
+    #
     # @param controller_name [Symbol]
+    # @raise [Vedeu::MissingRequired] When the given controller name does not
+    #   have a class defined.
     # @return [String]
     def klass_for(controller_name)
       if registered?(controller_name) && klass_defined?(controller_name)
@@ -96,17 +141,25 @@ module Vedeu
       end
     end
 
+    # Returns a boolean indicating whether the given controller name has a class
+    # defined.
+    #
     # @param controller_name [Symbol]
     # @return [Boolean]
     def klass_defined?(controller_name)
       present?(storage[controller_name][:klass])
     end
 
+    # Returns all the stored controllers and their respective actions.
+    #
     # @return [Hash<Symbol => Hash<Symbol => String|Array<Symbol>>>]
     def storage
       @storage ||= in_memory
     end
 
+    # Returns an empty collection ready for the storing of client application
+    # controllers and actions.
+    #
     # @return [Hash<void>]
     def in_memory
       {}

data/lib/vedeu/terminal.rb

@@ -32,7 +32,7 @@ module Vedeu
     #
     # @return [String]
     def input
-      Vedeu.log(type: :debug, message: 'Waiting for user input...')
+      Vedeu.log(type: :input, message: 'Waiting for user input...')
 
       keys_or_cmd = if raw_mode?
                       keys = console.getch

data/lib/vedeu/version.rb

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

data/test/lib/vedeu/api_test.rb

@@ -4,13 +4,9 @@ module Vedeu
 
   describe API do
 
-    it { Vedeu.must_respond_to(:background_colours) }
-    it { Vedeu.must_respond_to(:borders) }
-    it { Vedeu.must_respond_to(:buffers) }
     it { Vedeu.must_respond_to(:configure) }
     it { Vedeu.must_respond_to(:configuration) }
     it { Vedeu.must_respond_to(:cursor) }
-    it { Vedeu.must_respond_to(:cursors) }
     it { Vedeu.must_respond_to(:drb_restart) }
     it { Vedeu.must_respond_to(:drb_start) }
     it { Vedeu.must_respond_to(:drb_status) }
@@ -26,29 +22,19 @@ module Vedeu
     it { Vedeu.must_respond_to(:bind) }
     it { Vedeu.must_respond_to(:bound?) }
     it { Vedeu.must_respond_to(:unbind) }
-    it { Vedeu.must_respond_to(:events) }
     it { Vedeu.must_respond_to(:focus) }
     it { Vedeu.must_respond_to(:focus_by_name) }
     it { Vedeu.must_respond_to(:focussed?) }
     it { Vedeu.must_respond_to(:focus_next) }
     it { Vedeu.must_respond_to(:focus_previous) }
-    it { Vedeu.must_respond_to(:foreground_colours) }
-    it { Vedeu.must_respond_to(:geometries) }
-    it { Vedeu.must_respond_to(:groups) }
-    it { Vedeu.must_respond_to(:interfaces) }
-    it { Vedeu.must_respond_to(:keymaps) }
+    it { Vedeu.must_respond_to(:goto) }
     it { Vedeu.must_respond_to(:log) }
     it { Vedeu.must_respond_to(:log_stdout) }
     it { Vedeu.must_respond_to(:log_stderr) }
     it { Vedeu.must_respond_to(:keypress) }
     it { Vedeu.must_respond_to(:menu) }
-    it { Vedeu.must_respond_to(:menus) }
-    it { Vedeu.must_respond_to(:renderer) }
-    it { Vedeu.must_respond_to(:renderers) }
     it { Vedeu.must_respond_to(:height) }
     it { Vedeu.must_respond_to(:width) }
-    it { Vedeu.must_respond_to(:resize) }
-    it { Vedeu.must_respond_to(:timer) }
     it { Vedeu.must_respond_to(:trigger) }
     it { Vedeu.must_respond_to(:exit) }
     it { Vedeu.must_respond_to(:clear) }

data/test/lib/vedeu/bindings/application_test.rb

@@ -7,10 +7,10 @@ module Vedeu
 	  describe Application do
 
       context 'the application specific events are defined' do
-        it { Vedeu.bound?(:_action_).must_equal(true) }
+        it { Vedeu.bound?(:_goto_).must_equal(true) }
       end
 
-      describe '.action!' do
+      describe '.goto!' do
         let(:controller) { :some_controller }
         let(:action)     { :show_basket }
         let(:args)       {
@@ -22,7 +22,7 @@ module Vedeu
 
         before { Vedeu::Router.stubs(:goto) }
 
-        subject { Vedeu.trigger(:_action_, controller, action, **args) }
+        subject { Vedeu.trigger(:_goto_, controller, action, **args) }
 
         it {
           Vedeu::Router.expects(:goto)

data/test/lib/vedeu/internal_api_test.rb

@@ -0,0 +1,25 @@
+require 'test_helper'
+
+module Vedeu
+
+	describe InternalAPI do
+
+    it { Vedeu.must_respond_to(:background_colours) }
+    it { Vedeu.must_respond_to(:borders) }
+    it { Vedeu.must_respond_to(:buffers) }
+    it { Vedeu.must_respond_to(:cursors) }
+    it { Vedeu.must_respond_to(:events) }
+    it { Vedeu.must_respond_to(:foreground_colours) }
+    it { Vedeu.must_respond_to(:geometries) }
+    it { Vedeu.must_respond_to(:groups) }
+    it { Vedeu.must_respond_to(:interfaces) }
+    it { Vedeu.must_respond_to(:keymaps) }
+    it { Vedeu.must_respond_to(:menus) }
+    it { Vedeu.must_respond_to(:renderer) }
+    it { Vedeu.must_respond_to(:renderers) }
+    it { Vedeu.must_respond_to(:resize) }
+    it { Vedeu.must_respond_to(:timer) }
+
+	end # InternalAPI
+
+end # Vedeu

data/test/lib/vedeu/output/clear/named_group_test.rb

@@ -16,22 +16,23 @@ module Vedeu
       end
 
       describe '.render' do
-        it { described.must_respond_to(:by_group) }
-        it { described.must_respond_to(:clear_by_group) }
-        it { described.must_respond_to(:render) }
-      end
-
-      describe '#render' do
         let(:group) { Vedeu::Group.new(members: [_name]) }
 
         before { Vedeu.groups.stubs(:by_name).returns(group) }
 
-        subject { instance.render }
+        subject { described.render(_name) }
 
         it {
           Vedeu::Clear::NamedInterface.expects(:render).with(_name)
           subject
         }
+
+        it { described.must_respond_to(:by_group) }
+        it { described.must_respond_to(:clear_by_group) }
+      end
+
+      describe '#render' do
+        it { instance.must_respond_to(:render) }
       end
 
     end # NamedGroup

data/test/lib/vedeu/output/presentation_test.rb

@@ -103,12 +103,41 @@ module Vedeu
 
       it { subject.must_be_instance_of(Vedeu::Background) }
       it { subject.colour.must_equal('#330000') }
+
+      context 'when no parent colour is set' do
+        before { includer.stubs(:parent).returns(nil) }
+
+        it { subject.colour.must_equal('') }
+      end
+    end
+
+    describe '#parent_colour' do
+      subject { includer.parent_colour }
+
+      context 'when a parent is available' do
+        it { subject.must_be_instance_of(Vedeu::Colour) }
+        it { subject.background.must_be_instance_of(Vedeu::Background) }
+        it { subject.foreground.must_be_instance_of(Vedeu::Foreground) }
+      end
+
+      context 'when a parent is not available' do
+        before { includer.stubs(:parent).returns(nil) }
+
+        it { subject.must_equal(nil) }
+      end
     end
 
     describe '#parent_foreground' do
       subject { includer.parent_foreground }
 
       it { subject.must_be_instance_of(Vedeu::Foreground) }
+      it { subject.colour.must_equal('#00aadd') }
+
+      context 'when no parent colour is set' do
+        before { includer.stubs(:parent).returns(nil) }
+
+        it { subject.colour.must_equal('') }
+      end
     end
 
     describe '#colour' do
@@ -125,6 +154,22 @@ module Vedeu
       it { subject.must_be_instance_of(Colour) }
     end
 
+    describe '#parent_style' do
+      subject { includer.parent_style }
+
+      it { subject.must_be_instance_of(Vedeu::Style) }
+
+      context 'when a parent is available' do
+        it { subject.value.must_equal(['bold']) }
+      end
+
+      context 'when a parent is not available' do
+        before { includer.stubs(:parent).returns(nil) }
+
+        it { subject.value.must_equal(nil) }
+      end
+    end
+
     describe '#style' do
       subject { includer.style }
 

data/test/lib/vedeu/output/renderers_test.rb

@@ -3,13 +3,13 @@ require 'test_helper'
 module Vedeu
 
   class DummyRenderer
-    def self.render
+    def self.render(*output)
       :dummy
     end
   end
 
   class FooRenderer
-    def self.render
+    def self.render(*output)
       :foo
     end
   end
@@ -55,11 +55,21 @@ module Vedeu
     end
 
     describe '.render' do
-      let(:args) {}
+      let(:output) {}
 
-      subject { described.render(args) }
+      before do
+        Vedeu::Renderers.reset
+        Vedeu::Renderers.renderer(DummyRenderer)
+      end
+
+      subject { described.render(output) }
 
       it { subject.must_be_instance_of(Array) }
+
+      it {
+        DummyRenderer.expects(:render).with(output)
+        subject
+      }
     end
 
     describe '.renderer' do