vedeu 0.5.0 → 0.5.1

data/lib/vedeu/bindings/visibility.rb

@@ -11,7 +11,7 @@ module Vedeu
 
       # Setup events relating to visibility. This method is called by Vedeu.
       #
-      # @return [void]
+      # @return [TrueClass]
       def setup!
         clear_group!
         hide_cursor!
@@ -34,7 +34,7 @@ module Vedeu
       #   Vedeu.trigger(:_clear_group_, name)
       #   Vedeu.clear_by_group(name)
       #
-      # @return [void]
+      # @return [TrueClass]
       def clear_group!
         Vedeu.bind(:_clear_group_) do |name|
           Vedeu::Clear::NamedGroup.render(name)
@@ -49,7 +49,7 @@ module Vedeu
       #   Vedeu.trigger(:_cursor_hide_, name)
       #   Vedeu.hide_cursor(name)
       #
-      # @return [void]
+      # @return [TrueClass]
       def hide_cursor!
         Vedeu.bind(:_hide_cursor_) do |name|
           Vedeu::Cursor.hide_cursor(name)
@@ -74,7 +74,7 @@ module Vedeu
       #   Vedeu.trigger(:_hide_interface_, name)
       #   Vedeu.hide_interface(name)
       #
-      # @return [void]
+      # @return [TrueClass]
       def hide_interface!
         Vedeu.bind(:_hide_interface_) do |name|
           Vedeu::Interface.hide_interface(name)
@@ -89,7 +89,7 @@ module Vedeu
       #   Vedeu.trigger(:_cursor_show_, name)
       #   Vedeu.show_cursor(name)
       #
-      # @return [void]
+      # @return [TrueClass]
       def show_cursor!
         Vedeu.bind(:_show_cursor_) do |name|
           Vedeu::Cursor.show_cursor(name)
@@ -114,7 +114,7 @@ module Vedeu
       #   Vedeu.trigger(:_show_interface_, name)
       #   Vedeu.show_interface(name)
       #
-      # @return [void]
+      # @return [TrueClass]
       def show_interface!
         Vedeu.bind(:_show_interface_) do |name|
           Vedeu::Interface.show_interface(name)
@@ -127,7 +127,7 @@ module Vedeu
       #   Vedeu.trigger(:_toggle_cursor_, name)
       #   Vedeu.toggle_cursor(name)
       #
-      # @return [void]
+      # @return [TrueClass]
       def toggle_cursor!
         Vedeu.bind(:_toggle_cursor_) do |name|
           Vedeu::Cursor.toggle_cursor(name)
@@ -140,7 +140,7 @@ module Vedeu
       #   Vedeu.trigger(:_toggle_group_, name)
       #   Vedeu.toggle_group(name)
       #
-      # @return [void]
+      # @return [TrueClass]
       def toggle_group!
         Vedeu.bind(:_toggle_group_) do |name|
           Vedeu::Group.toggle_group(name)
@@ -153,7 +153,7 @@ module Vedeu
       #   Vedeu.trigger(:_toggle_interface_, name)
       #   Vedeu.toggle_interface(name)
       #
-      # @return [void]
+      # @return [TrueClass]
       def toggle_interface!
         Vedeu.bind(:_toggle_interface_) do |name|
           Vedeu::Interface.toggle_interface(name)

data/lib/vedeu/colours/colour.rb

@@ -54,7 +54,7 @@ module Vedeu
         new(value[:colour])
 
       elsif value[:background] || value[:foreground]
-         new(value)
+        new(value)
 
       else
         new

data/lib/vedeu/common.rb

@@ -10,7 +10,7 @@ module Vedeu
     #   demodulize('Vedeu::DSL::Interface') # => "Interface"
     #
     # @param klass [Class|String]
-    # @return [void]
+    # @return [String]
     def demodulize(klass)
       klass = klass.to_s
 

data/lib/vedeu/dsl/composition.rb

@@ -104,10 +104,15 @@ module Vedeu
         fail Vedeu::MissingRequired,
              'Cannot render template without a filename.' unless filename
 
-        content   = Vedeu::Templating::ViewTemplate.parse(object, filename)
-        lines     = Vedeu::Wordwrap.for(content, options)
+        options.merge!(name: name)
 
-        new_model = model.member.build(template_attributes(name, lines))
+        content = Vedeu::Templating::ViewTemplate.parse(object,
+                                                        filename,
+                                                        options)
+
+        # lines     = Vedeu::Wordwrap.for(content, options)
+
+        new_model = model.member.build(template_attributes(name, content))
 
         model.add(new_model)
       end

data/lib/vedeu/dsl/interface.rb

@@ -25,7 +25,7 @@ module Vedeu
       # Allows the setting of a border for the interface.
       #
       # @example
-      #   interface 'my_interface' do
+      #   Vedeu.interface 'my_interface' do
       #     border do
       #       # ... see Vedeu::DSL::Border for DSL methods for borders.
       #     end
@@ -51,6 +51,13 @@ module Vedeu
 
       # Applies the default border to the interface.
       #
+      # @example
+      #   Vedeu.interface 'my_interface' do
+      #     border!
+      #
+      #     # ... some code
+      #   end
+      #
       # @return [Vedeu::Border]
       def border!
         border do
@@ -64,20 +71,23 @@ module Vedeu
       #   to true.
       #
       # @example
-      #   interface 'my_interface' do
+      #   Vedeu.interface 'my_interface' do
       #     cursor  true  # => show the cursor for this interface
+      #     # or...
       #     cursor  :show # => both of these are equivalent to line above
+      #     # or...
       #     cursor!       #
       #     # ...
       #   end
       #
-      #   interface 'my_interface' do
+      #   Vedeu.interface 'my_interface' do
       #     cursor false # => hide the cursor for this interface
+      #     # or...
       #     cursor nil   # => as above
       #     # ...
       #   end
       #
-      #   view 'my_interface' do
+      #   Vedeu.view 'my_interface' do
       #     cursor true # => Specify the visibility of the cursor when the view
       #     # ...       #    is rendered.
       #   end
@@ -103,7 +113,7 @@ module Vedeu
       # @param value [Fixnum|Float] Time in seconds. (0.5 = 500ms).
       #
       # @example
-      #   interface 'my_interface' do
+      #   Vedeu.interface 'my_interface' do
       #     delay 0.5 # interface will not update more often than every 500ms.
       #     # ...
       #   end
@@ -134,7 +144,7 @@ module Vedeu
       # Define the geometry for an interface.
       #
       # @example
-      #   interface 'my_interface' do
+      #   Vedeu.interface 'my_interface' do
       #     geometry do
       #       # ... see Vedeu::DSL::Geometry for DSL methods for geometries.
       #     end
@@ -160,7 +170,7 @@ module Vedeu
       # interfaces at once.
       #
       # @example
-      #   interface 'my_interface' do
+      #   Vedeu.interface 'my_interface' do
       #     group 'main_screen'
       #     # ...
       #   end
@@ -187,13 +197,13 @@ module Vedeu
       # @param block [Proc]
       #
       # @example
-      #   view 'my_interface' do
+      #   Vedeu.view 'my_interface' do
       #     lines do
       #       # ... see {Vedeu::DSL::Line} and {Vedeu::DSL::Stream}
       #     end
       #   end
       #
-      #   view 'my_interface' do
+      #   Vedeu.view 'my_interface' do
       #     line do
       #       # ... see {Vedeu::DSL::Line} and {Vedeu::DSL::Stream}
       #     end
@@ -214,7 +224,7 @@ module Vedeu
       # @param value [String]
       #
       # @example
-      #   interface do
+      #   Vedeu.interface do
       #     name 'my_interface'
       #     # ...
       #   end
@@ -233,6 +243,13 @@ module Vedeu
 
       # Set the interface to visible.
       #
+      # @example
+      #   Vedeu.interface('my_interface') do
+      #     show!
+      #
+      #     # ... some code
+      #   end
+      #
       # @return [void]
       def show!
         visible(true)
@@ -240,6 +257,11 @@ module Vedeu
 
       # Set the interface to invisible.
       #
+      # @example
+      #   Vedeu.interface('my_interface') do
+      #     # ... some code
+      #   end
+      #
       # @return [void]
       def hide!
         visible(false)
@@ -260,21 +282,23 @@ module Vedeu
       #   to true.
       #
       # @example
-      #   interface 'my_interface' do
+      #   Vedeu.interface 'my_interface' do
       #     visible true  # => show the interface
+      #     # or...
       #     show!         # => as above
-      #     # ...
+      #     # ... some code
       #   end
       #
-      #   interface 'my_interface' do
+      #   Vedeu.interface 'my_interface' do
       #     visible false # => hide the interface
+      #     # or...
       #     hide!         # => as above
-      #     # ...
+      #     # ... some code
       #   end
       #
-      #   view 'my_interface' do
+      #   Vedeu.view 'my_interface' do
       #     visible false
-      #     # ...
+      #     # ... some code
       #   end
       #
       # @return [void]
@@ -294,7 +318,7 @@ module Vedeu
       #   --2--
       #   --1-- # rendered first
       #
-      #   interface 'my_interface' do
+      #   Vedeu.interface 'my_interface' do
       #     zindex 3
       #     # ...
       #   end

data/lib/vedeu/log/debug.rb

@@ -1,5 +1,8 @@
 module Vedeu
 
+  # Provides a stack trace of a running client application upon exit in a file
+  # for further analysis.
+  #
   module Debug
 
     extend self
@@ -62,7 +65,8 @@ module Vedeu
         # - Creates a call tree report compatible with KCachegrind.
         # RubyProf::CallTreePrinter
 
-        # - Uses the other printers to create several reports in one profiling run
+        # - Uses the other printers to create several reports in one profiling
+        #   run
         # RubyProf::MultiPrinter
       end
 

data/lib/vedeu/log/log.rb

@@ -184,6 +184,7 @@ module Vedeu
           config: [:light_yellow,  :yellow],
           create: [:light_green,   :green],
           debug:  [:light_red,     :red],
+          error:  [:light_red,     :red],
           drb:    [:light_blue,    :blue],
           event:  [:light_magenta, :magenta],
           info:   [:white,         :default],

data/lib/vedeu/models/interface.rb

@@ -168,14 +168,15 @@ module Vedeu
     def defaults
       {
         client:     nil,
-        colour:     nil,
+        colour:     Vedeu::Colour.coerce(background: :default,
+                                         foreground: :default),
         delay:      0.0,
         group:      '',
         lines:      [],
         name:       '',
         parent:     nil,
         repository: Vedeu.interfaces,
-        style:      nil,
+        style:      :normal,
         visible:    true,
         zindex:     0,
       }

data/lib/vedeu/plugins.rb

@@ -22,7 +22,7 @@ module Vedeu
     #
     # @param name [String]
     # @param plugin [Vedeu::Plugin]
-    # @return [void]
+    # @return [Array<void>]
     def register(name, plugin = false)
       plugins << plugin if plugin && not_loaded?(name)
     end

data/lib/vedeu/runtime/bootstrap.rb

@@ -31,11 +31,8 @@ module Vedeu
     # @return [void]
     def start
       configure_log!
-
       client_configuration!
-
       client_application!
-
       client_initialize!
 
       Vedeu::Launcher.execute!(argv)

data/lib/vedeu/runtime/launcher.rb

@@ -78,10 +78,11 @@ module Vedeu
       @exit_code = 0
 
     rescue StandardError => uncaught_exception
-      Vedeu.log_stdout(message: uncaught_exception.message)
+      Vedeu.log_stdout(type: :error, message: uncaught_exception.message)
 
       if configuration.debug?
-        Vedeu.log_stdout(message: uncaught_exception.backtrace.join("\n"))
+        Vedeu.log_stdout(type:    :error,
+                         message: uncaught_exception.backtrace.join("\n"))
       end
     end
 

data/lib/vedeu/runtime/router.rb

@@ -11,24 +11,24 @@ module Vedeu
     # Registers a controller with the given controller name for the client
     # application.
     #
-    # @param controller_name [Symbol]
+    # @param controller [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)
+    def add_controller(controller, klass)
+      unless present?(controller)
         fail Vedeu::MissingRequired,
              'Cannot store controller without a name attribute.'
       end
 
       Vedeu.log(type:    :create,
-                message: "Adding ':#{controller_name}'")
+                message: "Adding ':#{controller}'")
 
-      if registered?(controller_name)
-        storage[controller_name].merge!(klass: klass)
+      if registered?(controller)
+        storage[controller].merge!(klass: klass)
 
       else
-        storage.store(controller_name, klass: klass, actions: [])
+        storage.store(controller, klass: klass, actions: [])
 
       end
 
@@ -38,22 +38,22 @@ module Vedeu
     # Registers an action to the given controller name for the client
     # application.
     #
-    # @param controller_name [Symbol]
-    # @param action_name [Symbol]
+    # @param controller [Symbol]
+    # @param action [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)
+    def add_action(controller, action)
+      if present?(controller) && present?(action)
         Vedeu.log(type:    :create,
-                  message: "Adding ':#{action_name}' for ':#{controller_name}'")
+                  message: "Adding ':#{action}' for ':#{controller}'")
 
-        if registered?(controller_name)
-          storage[controller_name][:actions] << action_name
+        if registered?(controller)
+          storage[controller][:actions] << action
 
         else
-          add_controller(controller_name, '')
-          add_action(controller_name, action_name)
+          add_controller(controller, '')
+          add_action(controller, action)
 
         end
 
@@ -70,30 +70,28 @@ module Vedeu
     # parameters.
     #
     # @example
-    #   Vedeu.goto(controller_name, action_name, args)
+    #   Vedeu.goto(controller, action, args)
     #
-    # @param controller_name [Symbol]
-    # @param action_name [Symbol]
+    # @param controller [Symbol]
+    # @param action [Symbol]
     # @param args [void]
     # @raise [Vedeu::ModelNotFound] When the controller is not registered.
     # @return [void]
-    def goto(controller_name, action_name, **args)
-      if action_defined?(action_name, controller_name)
-        Vedeu.log(type:    :debug,
-                  message: "Routing: #{controller_name} #{action_name}")
+    def goto(controller, action, **args)
+      Vedeu.log(type:    :debug,
+                message: "Routing: #{controller} #{action}")
 
-        controller_with(controller_name).send(action_name, args)
-      end
+      route(controller, action, args) if action_defined?(action, controller)
     end
     alias_method :action, :goto
 
     # Returns a boolean indicating whether the given controller name is already
     # registered.
     #
-    # @param controller_name [Symbol]
+    # @param controller [Symbol]
     # @return [Boolean]
-    def registered?(controller_name)
-      storage.key?(controller_name)
+    def registered?(controller)
+      storage.key?(controller)
     end
 
     # Removes all stored controllers with their respective actions.
@@ -109,43 +107,47 @@ module Vedeu
     # Returns a boolean indicating whether the given action name is defined for
     # the given controller.
     #
-    # @param action_name [Symbol]
-    # @param controller_name [Symbol]
+    # @param action [Symbol]
+    # @param controller [Symbol]
     # @return [Boolean]
-    def action_defined?(action_name, controller_name)
-      if registered?(controller_name)
-        return true if storage[controller_name][:actions].include?(action_name)
+    def action_defined?(action, controller)
+      if registered?(controller)
+        return true if storage[controller][:actions].include?(action)
 
         fail Vedeu::ActionNotFound,
-             "#{action_name} is not registered for #{controller_name}."
+             "#{action} is not registered for #{controller}."
 
       else
-        fail Vedeu::ControllerNotFound, "#{controller_name} is not registered."
+        fail Vedeu::ControllerNotFound, "#{controller} is not registered."
 
       end
     end
 
-    # Instantiate the given controller by name.
+    # Instantiate the given controller by name, the call the action (method)
+    # with any given arguments.
     #
-    # @param controller_name [Symbol]
+    # @param controller [Symbol]
+    # @param action [Symbol]
+    # @param args [Symbol]
     # @return [void]
-    def controller_with(controller_name)
-      Object.const_get(klass_for(controller_name)).new
+    def route(controller, action, **args)
+      klass = Object.const_get(klass_for(controller)).new
+      klass.send(action, args)
     end
 
     # Fetch the class for the controller by name.
     #
-    # @param controller_name [Symbol]
+    # @param controller [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)
-        storage[controller_name][:klass]
+    def klass_for(controller)
+      if registered?(controller) && klass_defined?(controller)
+        storage[controller][:klass]
 
       else
         fail Vedeu::MissingRequired,
-             "Cannot route to #{controller_name} as no class defined."
+             "Cannot route to #{controller} as no class defined."
 
       end
     end
@@ -153,10 +155,10 @@ module Vedeu
     # Returns a boolean indicating whether the given controller name has a class
     # defined.
     #
-    # @param controller_name [Symbol]
+    # @param controller [Symbol]
     # @return [Boolean]
-    def klass_defined?(controller_name)
-      present?(storage[controller_name][:klass])
+    def klass_defined?(controller)
+      present?(storage[controller][:klass])
     end
 
     # Returns all the stored controllers and their respective actions.