vedeu 0.1.19 → 0.2.0

data/lib/vedeu/output/clear.rb

@@ -36,6 +36,7 @@ module Vedeu
 
     private
 
+    # @return [Interface]
     attr_reader :interface
 
     # @api private

data/lib/vedeu/output/compositor.rb

@@ -31,6 +31,7 @@ module Vedeu
 
     private
 
+    # @return [String]
     attr_reader :name
 
     # @api private

data/lib/vedeu/output/render.rb

@@ -45,6 +45,7 @@ module Vedeu
 
     private
 
+    # @return [Interface]
     attr_reader :interface
 
     # The client application may have created a line that us too long for the

data/lib/vedeu/repositories/events.rb

@@ -52,7 +52,15 @@ module Vedeu
 
     # @see Vedeu::API#trigger
     def trigger(name, *args)
-      handlers[name][:events].each { |event| event.trigger(*args) }
+      results = handlers[name][:events].map { |event| event.trigger(*args) }
+
+      if results.one?
+        results.first
+
+      else
+        results
+
+      end
     end
 
     # Remove all registered events. Used for testing purposes.
@@ -64,6 +72,7 @@ module Vedeu
 
     private
 
+    # @return [Hash]
     attr_reader :handlers
 
     # @api private

data/lib/vedeu/repositories/interfaces.rb

@@ -10,8 +10,10 @@ module Vedeu
     # Stores the interface attributes defined by the API.
     #
     # @param attributes [Hash]
-    # @return [Hash]
+    # @return [Hash|FalseClass]
     def add(attributes)
+      return false if attributes[:name].empty?
+
       storage.store(attributes[:name], attributes)
     end
 

data/lib/vedeu/repositories/menus.rb

@@ -0,0 +1,111 @@
+module Vedeu
+
+  # Repository for storing and retrieving defined menus.
+  #
+  # @api private
+  module Menus
+
+    extend self
+
+    # System events which when called with the appropriate menu name will
+    # update the menu accordingly.
+    Vedeu.event(:_menu_current_)  { |name| Menus.use(name).current_item  }
+    Vedeu.event(:_menu_selected_) { |name| Menus.use(name).selected_item }
+    Vedeu.event(:_menu_next_)     { |name| Menus.use(name).next_item     }
+    Vedeu.event(:_menu_prev_)     { |name| Menus.use(name).prev_item     }
+    Vedeu.event(:_menu_top_)      { |name| Menus.use(name).top_item      }
+    Vedeu.event(:_menu_bottom_)   { |name| Menus.use(name).bottom_item   }
+    Vedeu.event(:_menu_select_)   { |name| Menus.use(name).select_item   }
+    Vedeu.event(:_menu_deselect_) { |name| Menus.use(name).deselect_item }
+    Vedeu.event(:_menu_items_)    { |name| Menus.use(name).items         }
+    Vedeu.event(:_menu_view_)     { |name| Menus.use(name).view          }
+
+    # Stores the menu attributes defined by the API.
+    #
+    # @param attributes [Hash]
+    # @return [Hash|FalseClass]
+    def add(attributes)
+      return false if attributes[:name].empty?
+
+      storage.store(attributes[:name], attributes)
+    end
+
+    # Return the whole repository of menus.
+    #
+    # @return [Hash]
+    def all
+      storage
+    end
+
+    # Find a menu by name.
+    #
+    # @param name [String]
+    # @return [Hash]
+    def find(name)
+      storage.fetch(name) do
+        fail MenuNotFound,
+          "Menu was not found with this name: #{name.to_s}."
+      end
+    end
+
+    # Returns a collection of the names of all the registered menus.
+    #
+    # @return [Array]
+    def registered
+      storage.keys
+    end
+
+    # Returns a boolean indicating whether the named menu is registered.
+    #
+    # @return [TrueClass|FalseClass]
+    def registered?(name)
+      storage.key?(name)
+    end
+
+    # Removes the menu from the repository and associated events.
+    #
+    # @param name [String]
+    # @return [TrueClass|FalseClass]
+    def remove(name)
+      return false unless registered?(name)
+
+      storage.delete(name) { false }
+
+      true
+    end
+
+    # Reset the menus repository; removing all registered menus.
+    # This will delete the menus themselves, and the client application
+    # will need to either redefine menus before using them, or restart.
+    #
+    # @return [Hash]
+    def reset
+      @_storage = in_memory
+    end
+
+    # Access a menu by name.
+    #
+    # @param name [String]
+    # @return [Vedeu::Menu|MenuNotFound]
+    def use(name)
+      find(name).fetch(:items) do
+        fail MenuNotFound, "This menu '#{name}' has no items."
+      end
+    end
+
+    private
+
+    # @api private
+    # @return [Hash]
+    def storage
+      @_storage ||= in_memory
+    end
+
+    # @api private
+    # @return [Hash]
+    def in_memory
+      {}
+    end
+
+  end
+end

data/lib/vedeu/support/cursor.rb

@@ -5,7 +5,23 @@ module Vedeu
   # @api private
   class Cursor
 
-    attr_reader :top, :bottom, :left, :right, :cursor_x, :cursor_y
+    # @return [Fixnum]
+    attr_reader :top
+
+    # @return [Fixnum]
+    attr_reader :bottom
+
+    # @return [Fixnum]
+    attr_reader :left
+
+    # @return [Fixnum]
+    attr_reader :right
+
+    # @return [Fixnum]
+    attr_reader :cursor_x
+
+    # @return [Fixnum]
+    attr_reader :cursor_y
 
     # Provides a new instance of Cursor.
     #

data/lib/vedeu/support/event.rb

@@ -32,8 +32,17 @@ module Vedeu
 
     private
 
+    # @return [Proc]
     attr_reader   :closure
-    attr_accessor :deadline, :executed_at, :now
+
+    # @return []
+    attr_accessor :deadline
+
+    # @return []
+    attr_accessor :executed_at
+
+    # @return []
+    attr_accessor :now
 
     # Execute the code stored in the event closure.
     #

data/lib/vedeu/support/grid.rb

@@ -47,6 +47,7 @@ module Vedeu
 
     private
 
+    # @return [Fixnum]
     attr_reader :value
 
     # @api private

data/lib/vedeu/support/menu.rb

@@ -7,31 +7,12 @@ module Vedeu
 
     # Returns a new instance of Menu.
     #
-    # @param collection []
+    # @param collection [Array]
     # @return [Menu]
     def initialize(collection)
       @collection = collection
       @current    = 0
       @selected   = nil
-      @events     = events
-    end
-
-    # Creates events to manipulate this menu.
-    #
-    # @return []
-    def events
-      @_events ||= Vedeu.events.add(self) do
-        event(:menu_next)     { next_item     }
-        event(:menu_prev)     { prev_item     }
-        event(:menu_top)      { top_item      }
-        event(:menu_bottom)   { bottom_item   }
-        event(:menu_select)   { select_item   }
-        event(:menu_deselect) { deselect_item }
-
-        event(:menu_selected) { selected_item }
-        event(:menu_current)  { current_item  }
-        event(:menu_items)    { items         }
-      end
     end
 
     # Returns the index of the value in the collection which is current.
@@ -66,8 +47,14 @@ module Vedeu
       @collection[@selected]
     end
 
-    # Returns a new collection of items, which includes the `current` and
-    # `selected` states.
+    # Returns a new collection of items.
+    # Each element of the collection is of the format:
+    #
+    #   [ selected, current, item ]
+    #
+    # `selected` is a boolean indicating whether the item is selected.
+    # `current`  is a boolean indicating whether the item is current.
+    # `item`     is the item itself.
     #
     # @return [Array]
     def items
@@ -90,6 +77,8 @@ module Vedeu
       items
     end
 
+    # Returns a subset of all the items.
+    #
     # @return [Array]
     def view
       items[@current, @collection.size]

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

@@ -22,13 +22,6 @@ module Vedeu
       end
     end
 
-    describe '.unevent' do
-      it 'unregister the event by name' do
-        Vedeu.event(:calcium) { proc { |x| x } }
-        Vedeu.unevent(:calcium).wont_include(:calcium)
-      end
-    end
-
     describe '.events' do
       it 'returns the Events singleton' do
         Vedeu.events.must_be_instance_of(Vedeu::Events)
@@ -71,6 +64,27 @@ module Vedeu
           Vedeu.log('some message...').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)
+        end
+      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
+          # ...
+        end.must_be_instance_of(API::Menu)
+      end
     end
 
     describe '.trigger' do
@@ -80,6 +94,13 @@ module Vedeu
       end
     end
 
+    describe '.unevent' do
+      it 'unregister the event by name' do
+        Vedeu.event(:calcium) { proc { |x| x } }
+        Vedeu.unevent(:calcium).wont_include(:calcium)
+      end
+    end
+
     describe '.use' do
       before { Vedeu::Interfaces.reset }
 
@@ -140,10 +161,5 @@ module Vedeu
       end
     end
 
-    describe '.resize' do
-      it 'triggers the :_clear_ and :_refresh_ events' do
-        skip
-      end
-    end
   end
 end

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

@@ -4,16 +4,16 @@ module Vedeu
   module API
     describe Defined do
       describe '#events' do
-        before { Vedeu.events.reset }
-
         it 'returns no events when none currently registered' do
-          Defined.events.must_equal([])
+          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 }
 
-          Defined.events.must_equal([:birthday])
+          Defined.events.must_include(:birthday)
         end
       end
 

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

@@ -0,0 +1,68 @@
+require 'test_helper'
+
+module Vedeu
+  module API
+
+    describe Menu do
+      describe '.define' do
+        before { Menus.reset }
+
+        it 'raises an exception if no block was given' do
+          proc { Menu.define }.must_raise(InvalidSyntax)
+        end
+
+        it 'raises an exception if no name was specified for the menu' do
+          proc { Menu.define { } }.must_raise(InvalidSyntax)
+        end
+
+        it 'adds the menu to the menus repository' do
+          Menu.define do
+            name  'elements'
+            items [:sodium, :magnesium, :aluminium, :silicon]
+          end
+
+          Vedeu::Menus.registered.must_equal(['elements'])
+        end
+
+        it 'returns the API::Menu instance' do
+          Menu.define do
+            name 'elements'
+          end.must_be_instance_of(API::Menu)
+        end
+      end
+
+      describe '#initialize' do
+        it 'returns an instance of itself' do
+          Menu.new.must_be_instance_of(Menu)
+        end
+      end
+
+      describe '#items' do
+        it 'returns an instance of Vedeu::Menu' do
+          menu = Menu.new
+          menu.items.must_be_instance_of(Vedeu::Menu)
+        end
+
+        it 'assigns the instance of Vedeu::Menu to the attributes' do
+          menu = Menu.new
+          menu.items([:sodium, :magnesium, :aluminium, :silicon])
+          menu.attributes[:items].must_be_instance_of(Vedeu::Menu)
+        end
+      end
+
+      describe '#name' do
+        it 'returns the name of the menu' do
+          menu = Menu.new
+          menu.name('elements').must_equal('elements')
+        end
+
+        it 'assigns the name to the attributes' do
+          menu = Menu.new
+          menu.name('elements')
+          menu.attributes[:name].must_equal('elements')
+        end
+      end
+    end
+
+  end
+end