vedeu 0.2.0 → 0.2.1

data/lib/vedeu/support/trace.rb

@@ -21,20 +21,63 @@ module Vedeu
       @options = options
     end
 
+    # Performs the trace operation. Building strings which include:
+    # - a count of classes registered with Vedeu,
+    # - the class name being traced,
+    # - the method name being traced,
+    # - any local variables belonging to the method.
+    #
     # @return []
     def trace
       set_trace_func proc { |event, file, line, id, binding, classname|
-        if event == watched && classname.to_s.match(klass)
-          Vedeu.log(sprintf(" %s %-35s #%s", event, classname, id), true)
-          # binding.eval('local_variables').each do |var|
-          #   print("#{var.to_s} = #{binding.local_variable_get(var).inspect}\n")
-          # end
+        if event == watched && classes.include?(classname.to_s)
+          vars = variables(binding)
+
+          if vars.empty?
+            log_this(sprintf("(%s) %s %-25s #%-30s",
+              class_count, event, classname, id))
+
+          else
+            log_this(sprintf("(%s) %s %-25s #%-30s\n%s\n",
+              class_count, event, classname, id, vars))
+
+          end
         end
-      }
+      } if trace?
     end
 
     private
 
+    # Writes the message to the log file.
+    #
+    # @api private
+    # @param message [String]
+    # @return [Boolean]
+    def log_this(message)
+      Vedeu::Log.logger.debug(message)
+    end
+
+    # Provides inspection of the local variables set within the method being
+    # traced. Makes the log file extremely noisy, but very useful for hunting
+    # down bugs.
+    #
+    # @api private
+    # @param binding [Class]
+    # @return [String]
+    def variables(binding)
+      entries = []
+      binding.eval('local_variables').each do |var|
+        variable = var.to_s
+        value    = binding.local_variable_get(var)
+        output   = (value.is_a?(Proc)) ? '#<Proc:...' : value.inspect
+
+        entries << sprintf("\e[32m%57s %-10s\e[39m= \e[34m%s\e[39m", " ",
+                                                                     variable,
+                                                                     output)
+      end
+      entries.join("\n")
+    end
+
     # @api private
     # @return [String]
     def watched
@@ -42,9 +85,9 @@ module Vedeu
     end
 
     # @api private
-    # @return [Regexp]
-    def klass
-      options[:klass]
+    # @return [Boolean]
+    def trace?
+      options[:trace]
     end
 
     # @api private
@@ -57,13 +100,29 @@ module Vedeu
     # @return [Hash]
     def defaults
       {
+        trace: Vedeu::Configuration.trace?,
         event: 'call',
-        klass: /^Vedeu::.*/
       }
     end
 
-    # everything except Interface, Geometry and Terminal
-    # klass: /^Vedeu::(?!.*Interface|Geometry|Terminal).*/
+    # Returns the number of Vedeu classes/modules. (Useful for debugging.)
+    #
+    # @api private
+    # @return [Fixnum]
+    def class_count
+      classes.size.to_s
+    end
+
+    # Returns all the classes defined within Vedeu.
+    #
+    # @api private
+    # @return [Set]
+    def classes
+      @_classes ||= Vedeu.constants.collect do |c|
+        Vedeu.const_get(c).to_s
+      end.to_set
+    end
   end
   # :nocov:
 end
+

data/test/lib/vedeu/api/api_test.rb

@@ -45,10 +45,22 @@ module Vedeu
     end
 
     describe '.keypress' do
-      before { event.stubs(:trigger).returns(nil) }
+      before { Vedeu::Focus.stubs(:current).returns('') }
 
-      it 'returns nil' do
-        Vedeu.keypress('k').must_equal(nil)
+      it 'returns false when the key was not registered' do
+        Vedeu.keypress('k').must_equal(false)
+      end
+    end
+
+    describe '.keys' do
+      it 'returns an instance of API::Keymap' do
+        Vedeu.keys do
+          # ...
+        end.must_be_instance_of(API::Keymap)
+      end
+
+      it 'raises an exception when the block is not provided' do
+        proc { Vedeu.keys }.must_raise(InvalidSyntax)
       end
     end
 
@@ -73,12 +85,6 @@ module Vedeu
       end
     end
 
-    describe '.resize' do
-      it 'triggers the :_clear_ and :_refresh_ events' do
-        skip
-      end
-    end
-
     describe '.menu' do
       it 'creates and stores a new menu' do
         Vedeu.menu('Vedeu.menu') do
@@ -87,6 +93,18 @@ module Vedeu
       end
     end
 
+    describe '.render' do
+      it 'directly writes the view buffer to the terminal' do
+        skip
+      end
+    end
+
+    describe '.resize' do
+      it 'triggers the :_clear_ and :_refresh_ events' do
+        skip
+      end
+    end
+
     describe '.trigger' do
       it 'triggers the specifed event and returns the collection of events' \
          ' which this trigger triggers' do

data/test/lib/vedeu/api/composition_test.rb

@@ -3,7 +3,17 @@ require 'test_helper'
 module Vedeu
   module API
     describe Composition do
+      describe '.render' do
+        it 'directly writes a view buffer to the terminal' do
+          skip
+        end
+      end
+
+
       describe '#view' do
+        it 'allows a single view to be defined' do
+          skip
+        end
       end
 
       describe '#views' do

data/test/lib/vedeu/api/defined_test.rb

@@ -44,6 +44,20 @@ module Vedeu
           Defined.interfaces.must_equal(['hydrogen'])
         end
       end
+
+      describe '#menus' do
+        before { Vedeu::Menus.reset }
+
+        it 'returns no menus when none currently registered' do
+          Defined.menus.must_equal([])
+        end
+
+        it 'returns all menus currently registered' do
+          Vedeu.menu('seaborgium') { items [:promethium, :astatine, :niobium] }
+
+          Defined.menus.must_equal(['seaborgium'])
+        end
+      end
     end
   end
 end

data/test/lib/vedeu/api/interface_test.rb

@@ -135,11 +135,81 @@ module Vedeu
         end
       end
 
-      describe '#use' do
-        it 'returns the interface by name' do
-          interface = Vedeu.interface('tungsten') {}
+      describe '#centred' do
+        it 'raises an exception if the value is invalid' do
+          proc {
+            Vedeu.interface 'boron' do
+              centred :invalid
+            end
+          }.must_raise(InvalidSyntax)
+        end
 
-          Interface.new.use('tungsten').must_be_instance_of(Vedeu::Interface)
+        it 'sets the centred to true (visible)' do
+          Vedeu.interface 'boron' do
+            centred true
+          end
+
+          Vedeu.use('boron').attributes[:geometry][:centred].must_equal(true)
+        end
+
+        it 'sets the centred to false (hidden)' do
+          Vedeu.interface 'boron' do
+            centred false
+          end
+
+          Vedeu.use('boron').attributes[:geometry][:centred].must_equal(false)
+        end
+      end
+
+      describe '#cursor' do
+        it 'raises an exception if the value is invalid' do
+          proc {
+            Vedeu.interface 'beryllium' do
+              cursor :invalid
+            end
+          }.must_raise(InvalidSyntax)
+        end
+
+        it 'sets the cursor to true (visible)' do
+          Vedeu.interface 'beryllium' do
+            cursor true
+          end
+
+          Vedeu.use('beryllium').attributes[:cursor].must_equal(true)
+        end
+
+        it 'sets the cursor to false (hidden)' do
+          Vedeu.interface 'beryllium' do
+            cursor false
+          end
+
+          Vedeu.use('beryllium').attributes[:cursor].must_equal(false)
+        end
+      end
+
+      describe '#delay' do
+        it 'sets the delay attribute' do
+          Vedeu.interface 'cobalt' do
+            delay 0.25
+          end
+
+          Vedeu.use('cobalt').attributes[:delay].must_equal(0.25)
+        end
+      end
+
+      describe '#group' do
+        it 'sets the group attribute' do
+          Vedeu.interface 'iron' do
+            group 'elements'
+          end
+
+          Vedeu.use('iron').attributes[:group].must_equal('elements')
+        end
+      end
+
+      describe '#height' do
+        it 'sets the attribute to the value' do
+          skip
         end
       end
 
@@ -236,52 +306,6 @@ module Vedeu
         end
       end
 
-      describe '#cursor' do
-        it 'raises an exception if the value is invalid' do
-          proc {
-            Vedeu.interface 'beryllium' do
-              cursor :invalid
-            end
-          }.must_raise(InvalidSyntax)
-        end
-
-        it 'sets the cursor to true (visible)' do
-          Vedeu.interface 'beryllium' do
-            cursor true
-          end
-
-          Vedeu.use('beryllium').attributes[:cursor].must_equal(true)
-        end
-
-        it 'sets the cursor to false (hidden)' do
-          Vedeu.interface 'beryllium' do
-            cursor false
-          end
-
-          Vedeu.use('beryllium').attributes[:cursor].must_equal(false)
-        end
-      end
-
-      describe '#delay' do
-        it 'sets the delay attribute' do
-          Vedeu.interface 'cobalt' do
-            delay 0.25
-          end
-
-          Vedeu.use('cobalt').attributes[:delay].must_equal(0.25)
-        end
-      end
-
-      describe '#group' do
-        it 'sets the group attribute' do
-          Vedeu.interface 'iron' do
-            group 'elements'
-          end
-
-          Vedeu.use('iron').attributes[:group].must_equal('elements')
-        end
-      end
-
       describe '#name' do
         it 'sets the name attribute' do
           Vedeu.interface do
@@ -292,17 +316,21 @@ module Vedeu
         end
       end
 
-      describe '#x' do
-        it 'sets the attribute to the block if a block is given' do
-          skip
+      describe '#use' do
+        it 'returns the interface by name' do
+          interface = Vedeu.interface('tungsten') {}
+
+          Interface.new.use('tungsten').must_be_instance_of(Vedeu::Interface)
         end
+      end
 
-        it 'sets the attribute to the value if a block is not given' do
+      describe '#width' do
+        it 'sets the attribute to the value' do
           skip
         end
       end
 
-      describe '#y' do
+      describe '#x' do
         it 'sets the attribute to the block if a block is given' do
           skip
         end
@@ -312,43 +340,16 @@ module Vedeu
         end
       end
 
-      describe '#width' do
-        it 'sets the attribute to the value' do
+      describe '#y' do
+        it 'sets the attribute to the block if a block is given' do
           skip
         end
-      end
 
-      describe '#height' do
-        it 'sets the attribute to the value' do
+        it 'sets the attribute to the value if a block is not given' do
           skip
         end
       end
 
-      describe '#centred' do
-        it 'raises an exception if the value is invalid' do
-          proc {
-            Vedeu.interface 'boron' do
-              centred :invalid
-            end
-          }.must_raise(InvalidSyntax)
-        end
-
-        it 'sets the centred to true (visible)' do
-          Vedeu.interface 'boron' do
-            centred true
-          end
-
-          Vedeu.use('boron').attributes[:geometry][:centred].must_equal(true)
-        end
-
-        it 'sets the centred to false (hidden)' do
-          Vedeu.interface 'boron' do
-            centred false
-          end
-
-          Vedeu.use('boron').attributes[:geometry][:centred].must_equal(false)
-        end
-      end
     end
   end
 end

data/test/lib/vedeu/api/keymap_test.rb

@@ -0,0 +1,61 @@
+require 'test_helper'
+
+module Vedeu
+  module API
+
+    describe Keymap do
+
+      describe '#key' do
+        it 'raises an exception when a block is not given' do
+          proc {
+            Vedeu.keys do
+              key 'q'
+            end
+          }.must_raise(InvalidSyntax)
+        end
+
+        it 'raises an exception when a key is not given' do
+          proc {
+            Vedeu.keys do
+              key('') { :some_action }
+            end
+          }.must_raise(InvalidSyntax)
+        end
+
+        it 'returns the instance of API::Keymap' do
+          Vedeu.keys do
+            key('f') { :some_action }
+          end.must_be_instance_of(API::Keymap)
+        end
+
+        it 'returns a collection of the keypresses' do
+          Keymap.new.key('v', 'd', 'u') do
+            :some_action
+          end.must_equal(['v', 'd', 'u'])
+        end
+      end
+
+      describe '#interface' do
+        it 'returns the instance of API::Keymap' do
+          Vedeu.keys do
+            key('d') { :some_action }
+            interface 'neodymium'
+          end.must_be_instance_of(API::Keymap)
+        end
+
+        it 'returns the instance of API::Keymap' do
+          Vedeu.keys do
+            key('e') { :some_action }
+            interface ['neodymium', 'californium']
+          end.must_be_instance_of(API::Keymap)
+        end
+
+        it 'returnsa collection of the interfaces' do
+          Keymap.new.interface('americium').must_equal(['americium'])
+        end
+      end
+
+    end
+
+  end
+end