vedeu 0.2.2 → 0.2.3

data/lib/vedeu/support/repository.rb

@@ -0,0 +1,77 @@
+module Vedeu
+
+  module Repository
+
+    # Return the whole repository.
+    #
+    # @return [Hash]
+    def all
+      storage
+    end
+
+    # Find the entity attributes by name.
+    #
+    # @param name [String]
+    # @return [Hash]
+    def find(name)
+      storage.fetch(name) { not_found(name) }
+    end
+
+    # Returns a collection of the names of all the registered entities.
+    #
+    # @return [Array]
+    def registered
+      storage.keys
+    end
+
+    # Returns a boolean indicating whether the named entity is registered.
+    #
+    # @param name [String]
+    # @return [Boolean]
+    def registered?(name)
+      storage.key?(name)
+    end
+
+    # Reset the repository.
+    #
+    # @return [Hash]
+    def reset
+      @_storage = in_memory
+    end
+
+    private
+
+    # Access to the storage for this repository.
+    #
+    # @api private
+    # @return [Hash]
+    def storage
+      @_storage ||= in_memory
+    end
+
+    # At present, validates that attributes has a `:name` key that is not nil or
+    # empty.
+    #
+    # @api private
+    # @param attributes [Hash]
+    # @return [TrueClass|MissingRequired]
+    def validate_attributes!(attributes)
+      return missing_required unless attributes.key?(:name)
+      return missing_required unless defined_value?(attributes[:name])
+
+      true
+    end
+
+    # Raises the MissingRequired exception.
+    #
+    # @param attr [String] A textual representation of the attribute.
+    # @raise [MissingRequired] When an attribute, defined by the attr parameter
+    #   is missing.
+    # @return [MissingRequired]
+    def missing_required(attr = 'name')
+      fail MissingRequired, "Cannot store data without a #{attr} attribute."
+    end
+
+  end # Repository
+
+end # Vedeu

data/lib/vedeu/support/terminal.rb

@@ -12,14 +12,19 @@ module Vedeu
     # attempts to restore the screen. See {Vedeu::Terminal#restore_screen}.
     #
     # @param block [Proc]
+    # @raise [InvalidSyntax] When the required block is not given.
     # @return [Array]
     def open(&block)
       fail InvalidSyntax, '`open` requires a block.' unless block_given?
 
       if raw_mode?
+        Vedeu.log("Terminal entering 'raw' mode")
+
         console.raw    { initialize_screen { yield } }
 
       else
+        Vedeu.log("Terminal entering 'cooked' mode")
+
         console.cooked { initialize_screen { yield } }
 
       end
@@ -128,9 +133,13 @@ module Vedeu
     # @return [Symbol]
     def switch_mode!
       if raw_mode?
+        Vedeu.log("Terminal switching to 'cooked' mode")
+
         cooked_mode!
 
       else
+        Vedeu.log("Terminal switching to 'raw' mode")
+
         raw_mode!
 
       end
@@ -196,5 +205,6 @@ module Vedeu
       IO.console
     end
 
-  end
-end
+  end # Terminal
+
+end # Vedeu

data/lib/vedeu/support/trace.rb

@@ -22,24 +22,26 @@ module Vedeu
     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.
+    # - (class_count) a count of classes registered with Vedeu,
+    # - (classname) the class name being traced,
+    # - (id) the method name being traced,
+    # - (vars) any local variables belonging to the method.
+    #
+    # @todo Deprecate, and use TracePoint instead.
     #
     # @return []
     def trace
       set_trace_func proc { |event, file, line, id, binding, classname|
-        if event == watched && classes.include?(classname.to_s)
+        if event == watched && id != :log && classes.include?(classname.to_s)
           vars = variables(binding)
 
           if vars.empty?
-            log_this(sprintf("(%s) %s %-25s #%-30s",
-              class_count, event, classname, id))
+            log_this(sprintf("%s %-25s #%-20s",
+              class_count, classname, id))
 
           else
-            log_this(sprintf("(%s) %s %-25s #%-30s\n%s\n",
-              class_count, event, classname, id, vars))
+            log_this(sprintf("%s %-25s #%-20s\n%s\n",
+              class_count, classname, id, vars))
 
           end
         end
@@ -69,11 +71,15 @@ module Vedeu
       binding.eval('local_variables').each do |var|
         variable = var.to_s
         value    = binding.local_variable_get(var)
+        valclass = value.class.to_s
         output   = (value.is_a?(Proc)) ? '#<Proc:...' : value.inspect
 
-        entries << sprintf("\e[32m%57s %-10s\e[39m= \e[34m%s\e[39m", " ",
-                                                                     variable,
-                                                                     output)
+        content  = Esc.send(class_colour.fetch(valclass, :white)) { output }
+
+        entries << sprintf("%33s %-10s = %s %s", " ",
+                                                 Esc.green { variable },
+                                                 Esc.magenta { valclass },
+                                                 content)
       end
       entries.join("\n")
     end
@@ -105,24 +111,125 @@ module Vedeu
       }
     end
 
+    # @return [Hash]
+    def class_colour
+      {
+        'Array'    => :yellow,
+        'Fixnum'   => :cyan,
+        'Hash'     => :blue,
+        'NilClass' => :red,
+        'String'   => :green,
+        'Symbol'   => :magenta,
+      }
+    end
+
     # Returns the number of Vedeu classes/modules. (Useful for debugging.)
     #
-    # @api private
-    # @return [Fixnum]
+    # @return [String]
     def class_count
-      classes.size.to_s
+      @_count ||= "(#{classes.size.to_s}/#{vedeu_classes.size.to_s})"
     end
 
-    # Returns all the classes defined within Vedeu.
+    # Returns the classes to be traced, without exceptions or ignored classes.
     #
     # @api private
     # @return [Set]
     def classes
-      @_classes ||= Vedeu.constants.collect do |c|
+      @_classes ||= vedeu_classes - vedeu_exceptions - ignored_classes
+    end
+
+    # Returns all the classes defined within Vedeu.
+    #
+    # @return [Set]
+    def vedeu_classes
+      @_vedeu_classes ||= Vedeu.constants.collect do |c|
         Vedeu.const_get(c).to_s
       end.to_set
     end
-  end
-  # :nocov:
-end
 
+    # Returns all the exceptions defined within Vedeu.
+    #
+    # @todo Vedeu should produce this set.
+    #
+    # @return [Set]
+    def vedeu_exceptions
+      Set.new [
+        'Vedeu::BufferNotFound',
+        'Vedeu::CursorNotFound',
+        'Vedeu::GroupNotFound',
+        'Vedeu::InterfaceNotFound',
+        'Vedeu::InvalidSyntax',
+        'Vedeu::KeyInUse',
+        'Vedeu::MenuNotFound',
+        'Vedeu::MissingRequired',
+        'Vedeu::ModeSwitch',
+        'Vedeu::NoInterfacesDefined',
+        'Vedeu::NotImplemented',
+        'Vedeu::OutOfRange',
+      ]
+    end
+
+    # Returns a set of classes to ignore during tracing.
+    #
+    # @todo Make this configurable at runtime.
+    #
+    # @return [Set]
+    def ignored_classes
+      Set.new [
+        # 'Vedeu::API',
+        # 'Vedeu::Application',
+        # 'Vedeu::Area',
+        # 'Vedeu::Background',
+        # 'Vedeu::Buffers',
+        # 'Vedeu::Clear',
+        'Vedeu::Coercions',
+        'Vedeu::Colour',
+        'Vedeu::ColourTranslator',
+        'Vedeu::Common',
+        # 'Vedeu::Composition',
+        # 'Vedeu::Compositor',
+        'Vedeu::Configuration',
+        # 'Vedeu::Cursor',
+        # 'Vedeu::Cursors',
+        'Vedeu::Esc',
+        'Vedeu::Event',
+        # 'Vedeu::Events',
+        # 'Vedeu::Focus',
+        # 'Vedeu::Foreground',
+        'Vedeu::Geometry',
+        # 'Vedeu::Grid',
+        # 'Vedeu::Groups',
+        # 'Vedeu::Input',
+        # 'Vedeu::Interface',
+        # 'Vedeu::Interfaces',
+        # 'Vedeu::Keymap',
+        # 'Vedeu::Keymaps',
+        # 'Vedeu::KeymapValidator',
+        # 'Vedeu::Launcher',
+        # 'Vedeu::Line',
+        'Vedeu::Log',
+        # 'Vedeu::Menu',
+        # 'Vedeu::Menus',
+        'Vedeu::MonoLogger',
+        # 'Vedeu::Offset',
+        # 'Vedeu::Offsets',
+        'Vedeu::Position',
+        'Vedeu::Presentation',
+        # 'Vedeu::Refresh',
+        # 'Vedeu::Registrar',
+        # 'Vedeu::Render',
+        'Vedeu::Repository',
+        'Vedeu::Stream',
+        'Vedeu::Style',
+        'Vedeu::Terminal',
+        'Vedeu::Trace',
+        # 'Vedeu::View',
+        # 'Vedeu::Viewport',
+      ]
+    end
+
+    # :nocov:
+
+  end # Trace
+
+end # Vedeu

data/lib/vedeu.rb

@@ -2,50 +2,6 @@
 #
 module Vedeu
 
-  # Raised when Vedeu attempts to access a named buffer that does not exist.
-  BufferNotFound = Class.new(StandardError)
-
-  # Raised when a cursor cannot be found by name.
-  CursorNotFound = Class.new(StandardError)
-
-  # Raised when trying to access a group of interfaces which do not exist by
-  # this name.
-  GroupNotFound = Class.new(StandardError)
-
-  # Raised when an interface cannot be found by name.
-  InterfaceNotFound = Class.new(StandardError)
-
-  # Raised when Vedeu attempts to parse a {Vedeu.view} or {Vedeu.interface} and
-  # encounters a problem.
-  InvalidSyntax = Class.new(StandardError)
-
-  # Raised when attempting to assign a key which is already in use.
-  KeyInUse = Class.new(StandardError)
-
-  # Raised when a menu cannot be found by name.
-  MenuNotFound = Class.new(StandardError)
-
-  # Raised when the attributes argument to {Vedeu::Registrar} does not contain
-  # a required key or the value to that key is nil or empty.
-  MissingRequired = Class.new(StandardError)
-
-  # Raised intentionally when the client application wishes to switch between
-  # cooked and raw (or vice versa) terminal modes. Vedeu is hard-wired to use
-  # the `Escape` key to trigger this change for the time being.
-  ModeSwitch = Class.new(StandardError)
-
-  # Raised when attempting to reach the currently in focus interface, when no
-  # interfaces have been defined yet.
-  NoInterfacesDefined = Class.new(StandardError)
-
-  # Raised to remind me (or client application developers) that the subclass
-  # implements the functionality sought.
-  NotImplemented = Class.new(StandardError)
-
-  # Raised when trying to access an interface column less than 1 or greater
-  # than 12. Vedeu is hard-wired to a 12-column layout for the time being.
-  OutOfRange = Class.new(StandardError)
-
   # When Vedeu is included within one of your classes, you should have all
   # API methods at your disposal.
   #
@@ -59,7 +15,10 @@ module Vedeu
     receiver.extend(API)
   end
 
-end
+end # Vedeu
+
+$LIB_DIR = File.dirname(__FILE__) + '/../lib'
+$LOAD_PATH.unshift($LIB_DIR) unless $LOAD_PATH.include?($LIB_DIR)
 
 require 'date'
 require 'forwardable'
@@ -68,13 +27,17 @@ require 'logger'
 require 'optparse'
 require 'set'
 
+require 'vedeu/support/exceptions'
 require 'vedeu/support/common'
 require 'vedeu/configuration/cli'
 require 'vedeu/configuration/api'
 require 'vedeu/configuration/configuration'
+
 require 'vedeu/support/log'
 require 'vedeu/support/trace'
 
+require 'vedeu/api/api'
+
 require 'vedeu/models/attributes/coercions'
 require 'vedeu/models/attributes/colour_translator'
 require 'vedeu/models/attributes/background'
@@ -82,6 +45,7 @@ require 'vedeu/models/attributes/foreground'
 require 'vedeu/models/attributes/presentation'
 require 'vedeu/models/composition'
 
+require 'vedeu/support/repository'
 require 'vedeu/support/position'
 require 'vedeu/support/esc'
 require 'vedeu/support/terminal'
@@ -99,7 +63,6 @@ require 'vedeu/models/stream'
 require 'vedeu/repositories/events'
 
 require 'vedeu/api/defined'
-require 'vedeu/api/api'
 require 'vedeu/api/composition'
 require 'vedeu/api/helpers'
 require 'vedeu/api/interface'
@@ -133,3 +96,5 @@ require 'vedeu/input/input'
 
 require 'vedeu/application'
 require 'vedeu/launcher'
+
+# Vedeu::Trace.call({ trace: true })

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

@@ -19,24 +19,18 @@ module Vedeu
     end
 
     describe '.event' do
-      it 'registers and returns the event' do
-        Vedeu.event(:some_event).must_equal(
-          {
-            events: [event],
-          }
-        )
-      end
-    end
+      it 'delegates to the Events repository' do
+        Events.expects(:add)
 
-    describe '.events' do
-      it 'returns the Events singleton' do
-        Vedeu.events.must_be_instance_of(Vedeu::Events)
+        Vedeu.event(:some_event)
       end
     end
 
     describe '.focus' do
       it 'sets the named interface to be focussed' do
-        skip
+        Vedeu.expects(:trigger).with(:_focus_by_name_, 'plutonium')
+
+        Vedeu.focus('plutonium')
       end
     end
 
@@ -79,20 +73,20 @@ module Vedeu
     describe '.log' do
       it 'writes the message to the log file when debugging is enabled' do
         Configuration.stub(:debug?, true) do
-          Vedeu.log('some message...').must_equal(true)
+          Vedeu.log('Testing debugging to log').must_equal(true)
         end
       end
 
       it 'returns nil when debugging is disabled' do
         Configuration.stub(:debug?, false) do
-          Vedeu.log('some message...').must_equal(nil)
+          Vedeu.log('some message not logged...').must_equal(nil)
         end
       end
 
       it 'write the message to the log file when the `force` argument ' \
          'evaluates to true' do
         Configuration.stub(:debug?, false) do
-          Vedeu.log('some message...', true).must_equal(true)
+          Vedeu.log('Testing forced debugging to log', true).must_equal(true)
         end
       end
     end
@@ -112,7 +106,7 @@ module Vedeu
     end
 
     describe '.resize' do
-      it 'triggers the :_clear_ and :_refresh_ events' do
+      it 'triggers the :_clear_, :_refresh_ and :_cursor_refresh_ events' do
         skip
       end
     end
@@ -127,7 +121,9 @@ module Vedeu
     describe '.unevent' do
       it 'unregister the event by name' do
         Vedeu.event(:calcium) { proc { |x| x } }
-        Vedeu.unevent(:calcium).wont_include(:calcium)
+        Events.registered.must_include(:calcium)
+        Vedeu.unevent(:calcium)
+        Events.registered.wont_include(:calcium)
       end
     end
 
@@ -139,7 +135,7 @@ module Vedeu
           .must_raise(Vedeu::InterfaceNotFound)
       end
 
-      it 'returns' do
+      it 'returns an instance of the named interface' do
         Vedeu.interface('aluminium')
 
         Vedeu.use('aluminium').must_be_instance_of(Vedeu::Interface)

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

@@ -4,12 +4,6 @@ module Vedeu
   module API
     describe Defined do
       describe '#events' do
-        it 'returns no events when none currently registered' do
-          Vedeu.stub(:events, Events.new) do
-            Defined.events.must_equal([])
-          end
-        end
-
         it 'returns all events currently registered' do
           Vedeu.event(:birthday) { :eat_too_much_cake }
 
@@ -45,6 +39,22 @@ module Vedeu
         end
       end
 
+      describe '#keymaps' do
+        before { Vedeu::Keymaps.reset }
+
+        it 'returns the default keymap when no others are registered' do
+          Defined.keymaps.must_equal(['_global_keymap_'])
+        end
+
+        it 'returns all keymaps currently registered' do
+          Vedeu.keys('flerovium') do
+            key('u') { :some_action }
+          end
+
+          Defined.keymaps.must_equal(['_global_keymap_', 'flerovium'])
+        end
+      end
+
       describe '#menus' do
         before { Vedeu::Menus.reset }
 

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

@@ -2,6 +2,7 @@ require 'test_helper'
 
 module Vedeu
   module API
+
     describe Interface do
       before { Vedeu::Buffers.reset }
 
@@ -112,28 +113,12 @@ module Vedeu
       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)
+        it 'returns false if the value is false or nil' do
+          API::Interface.new.centred(false).must_equal(false)
         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)
+        it 'returns true' do
+          API::Interface.new.centred.must_equal(true)
         end
       end
 

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

@@ -12,7 +12,7 @@ module Vedeu
         end
 
         it 'raises an exception if no name was specified for the menu' do
-          proc { Menu.define { } }.must_raise(InvalidSyntax)
+          proc { Menu.define { } }.must_raise(MissingRequired)
         end
 
         it 'adds the menu to the menus repository' do

data/test/lib/vedeu/models/geometry_test.rb

@@ -234,5 +234,46 @@ module Vedeu
         geometry.east.must_equal(26)
       end
     end
+
+    describe '#virtual_y' do
+      it 'returns the virtual y positions within the interfaces dimensions' do
+        geometry = Geometry.new({ height: 6, width: 6, x: 7, y: 5 })
+        geometry.virtual_y.must_equal([5, 6, 7, 8, 9, 10])
+      end
+    end
+
+    describe '#virtual_x' do
+      it 'returns the virtual x positions within the interfaces dimensions' do
+        geometry = Geometry.new({ height: 6, width: 6, x: 7, y: 5 })
+        geometry.virtual_x.must_equal([7, 8, 9, 10, 11, 12])
+      end
+    end
+
+    describe '#to_h' do
+      it 'returns all the values within the instance as a hash' do
+        geometry = Geometry.new({ height: 6, width: 6, x: 3, y: 3 })
+        geometry.to_h.must_equal(
+          {
+            centred:         false,
+            height:          6,
+            width:           6,
+            x:               3,
+            y:               3,
+            viewport_height: 6,
+            viewport_width:  6,
+            top:             3,
+            right:           9,
+            bottom:          9,
+            left:            3,
+            north:           2,
+            east:            10,
+            south:           10,
+            west:            2,
+            virtual_x:       [3, 4, 5, 6, 7, 8],
+            virtual_y:       [3, 4, 5, 6, 7, 8]
+          }
+        )
+      end
+    end
   end
 end

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

@@ -60,6 +60,20 @@ module Vedeu
       end
     end
 
+    describe '#in_focus?' do
+      context 'when the interface is currently in focus' do
+        before { Focus.stubs(:current?).returns(true) }
+
+        it { interface.in_focus?.must_equal(true) }
+      end
+
+      context 'when the interface is not currently in focus' do
+        before { Focus.stubs(:current?).returns(false) }
+
+        it { interface.in_focus?.must_equal(false) }
+      end
+    end
+
     describe '#group' do
       it 'returns the value' do
         interface.group.must_equal('my_group')