vedeu 0.2.10 → 0.2.11

data/lib/vedeu/support/refresh.rb

@@ -8,9 +8,6 @@ module Vedeu
     include Common
     extend self
 
-    # System event to refresh all registered interfaces.
-    Vedeu.event(:_refresh_) { Vedeu::Refresh.all }
-
     # Refresh all registered interfaces.
     #
     # @return [Array]
@@ -28,7 +25,7 @@ module Vedeu
     # Refresh an interface, or collection of interfaces belonging to a group.
     #
     # @param group_name [String] The name of the group to be refreshed.
-    # @return [Array|GroupNotFound] A collection of the names of interfaces
+    # @return [Array|ModelNotFound] A collection of the names of interfaces
     #   refreshed, or an exception if the group was not found.
     def by_group(group_name)
       Groups.find(group_name).each { |name| by_name(name) }
@@ -36,10 +33,14 @@ module Vedeu
 
     # Refresh an interface by name.
     #
-    # @param name [String] The name of the interface to be refreshed.
-    # @return [Array|BufferNotFound]
+    # @param name [String] The name of the interface to be refreshed using the
+    #   named buffer.
+    # @return [Array|ModelNotFound]
     def by_name(name)
-      Compositor.render(name)
+      interface = Interfaces.find(name)
+      buffer    = Buffers.find(name)
+
+      Compositor.compose(interface, buffer)
     end
 
     # Register a refresh event for an interface or group of interfaces by name.

data/lib/vedeu/support/registrar.rb

@@ -6,7 +6,7 @@ module Vedeu
   # @api private
   class Registrar
 
-    REPOSITORIES = [Buffers, Cursors, Focus, Groups, Interfaces, Offsets]
+    REPOSITORIES = [Buffers, Cursors, Groups, Interfaces, Offsets]
 
     # @param attributes [Hash]
     # @return [TrueClass|MissingRequired]
@@ -33,6 +33,8 @@ module Vedeu
     #
     # @return [TrueClass|MissingRequired]
     def record
+      focus
+
       REPOSITORIES.each { |repository| repository.add(attributes) }
 
       true
@@ -42,6 +44,10 @@ module Vedeu
 
     attr_reader :attributes
 
+    def focus
+      Focus.add(attributes[:name], attributes[:focus])
+    end
+
   end # Registrar
 
 end # Vedeu

data/lib/vedeu/support/repository.rb

@@ -14,7 +14,14 @@ module Vedeu
       storage
     end
 
-    # Find the entity attributes by name.
+    # Return a boolean indicating whether the storage is empty.
+    #
+    # @return [Boolean]
+    def empty?
+      storage.empty?
+    end
+
+    # Find the model attributes by name.
     #
     # @param name [String]
     # @return [Hash]
@@ -22,16 +29,15 @@ module Vedeu
       storage.fetch(name) { not_found(name) }
     end
 
-    # Find entity by named interface, registers an entity by interface name if
-    # not found.
+    # Find a model by name, registers the model by name if not found.
     #
     # @param name [String]
     # @return [Cursor|Offset]
     def find_or_create(name)
       storage.fetch(name) do
-        Vedeu.log("Entity (#{entity}) not found, registering: '#{name}'")
+        Vedeu.log("Model (#{model}) not found, registering: '#{name}'")
 
-        storage.store(name, entity.new({ name: name }))
+        model.new({ name: name }).store
       end
     end
 
@@ -39,7 +45,7 @@ module Vedeu
     #
     # @return [Array]
     def registered
-      return [] if storage.empty?
+      return [] if empty?
 
       return storage.keys if storage.is_a?(Hash)
       return storage.to_a if storage.is_a?(Set)
@@ -47,23 +53,23 @@ module Vedeu
       storage
     end
 
-    # Returns a boolean indicating whether the named entity is registered.
+    # Returns a boolean indicating whether the named model is registered.
     #
     # @param name [String]
     # @return [Boolean]
     def registered?(name)
-      return false if storage.empty?
+      return false if empty?
 
       storage.include?(name)
     end
 
-    # Returns the storage with the named entity removed, or false if the entity
+    # Returns the storage with the named model removed, or false if the model
     # does not exist.
     #
     # @param name [String]
     # @return [Hash|FalseClass]
     def remove(name)
-      return false if storage.empty?
+      return false if empty?
 
       if registered?(name)
         storage.delete(name)
@@ -84,6 +90,14 @@ module Vedeu
       @_storage = in_memory
     end
 
+    # Stores the model instance by name in the repository of the model.
+    #
+    # @param model [void] A model instance.
+    # @return [void] The model instance which was stored.
+    def store(model)
+      storage[model.name] = model
+    end
+
     private
 
     # @param method [Symbol]
@@ -94,6 +108,13 @@ module Vedeu
       'Updating'
     end
 
+    # @param name [String]
+    # @raise [ModelNotFound] When the model cannot be found with this name.
+    # @return [ModelNotFound]
+    def not_found(name)
+      fail ModelNotFound, "Cannot find model by name: '#{name}'"
+    end
+
     # Access to the storage for this repository.
     #
     # @return [Hash]

data/lib/vedeu/support/sentence.rb

@@ -0,0 +1,67 @@
+module Vedeu
+
+  class Sentence
+
+    class << self
+
+      def construct(elements, label = 'elements')
+        new(elements, label).construct
+      end
+
+    end # Sentence eigenclass
+
+    def initialize(elements, label)
+      @elements, @label = elements, label
+    end
+
+    def construct
+      if one?
+        first
+
+      elsif two?
+        elements.join(' and ')
+
+      elsif many?
+        [but_last, last].join(' and ')
+
+      else
+        "No #{label} have been assigned."
+
+      end
+    end
+
+    private
+
+    attr_reader :elements, :label
+
+    def one?
+      count == 1
+    end
+
+    def two?
+      count == 2
+    end
+
+    def many?
+      count > 2
+    end
+
+    def but_last
+      elements[0...-1].join(', ')
+    end
+
+    def first
+      elements.first
+    end
+
+    def last
+      elements[-1]
+    end
+
+    def count
+      elements.size
+    end
+
+  end # Sentence
+
+end # Vedeu

data/lib/vedeu/support/terminal.rb

@@ -51,6 +51,7 @@ module Vedeu
 
       end
     end
+    alias_method :read, :input
 
     # Prints the streams to the screen and returns the streams.
     #
@@ -170,20 +171,38 @@ module Vedeu
       centre.last
     end
 
+    # Returns 1. This 1 is either the top-most or left-most coordinate of the
+    # terminal.
+    #
+    # @return [Fixnum]
+    def origin
+      1
+    end
+    alias_method :x, :origin
+    alias_method :y, :origin
+
     # Returns the total width (number of columns/characters) of the current
     # terminal.
     #
+    # @example
+    #   Vedeu.width # => provides the width via the Vedeu API.
+    #
     # @return [Fixnum]
     def width
       size.last
     end
+    alias_method :xn, :width
 
     # Returns the total height (number of rows/lines) of the current terminal.
     #
+    # @example
+    #   Vedeu.height # => provides the height via the Vedeu API.
+    #
     # @return [Fixnum]
     def height
       size.first
     end
+    alias_method :yn, :height
 
     # Returns a tuple containing the height and width of the current terminal.
     #

data/lib/vedeu/support/trace.rb

@@ -146,12 +146,9 @@ module Vedeu
     # @return [Set]
     def vedeu_exceptions
       Set.new [
-        'Vedeu::BufferNotFound',
-        'Vedeu::GroupNotFound',
-        'Vedeu::InterfaceNotFound',
+        'Vedeu::ModelNotFound',
         'Vedeu::InvalidSyntax',
         'Vedeu::KeyInUse',
-        'Vedeu::MenuNotFound',
         'Vedeu::MissingRequired',
         'Vedeu::ModeSwitch',
         'Vedeu::NoInterfacesDefined',
@@ -174,7 +171,7 @@ module Vedeu
         # 'Vedeu::Clear',
         'Vedeu::Coercions',
         'Vedeu::Colour',
-        'Vedeu::ColourTranslator',
+        'Vedeu::Translator',
         'Vedeu::Common',
         # 'Vedeu::Composition',
         # 'Vedeu::Compositor',

data/test/integration/api/api_test.rb

@@ -0,0 +1,97 @@
+require 'test_helper'
+
+describe 'Testing Vedeu::API methods' do
+
+  describe '.configure' do
+    it 'raises an exception when the required block is not given' do
+      proc { Vedeu.configure }.must_raise(Vedeu::InvalidSyntax)
+    end
+  end
+
+  describe '.defined' do
+    it 'returns the Vedeu::API::Defined module name' do
+      Vedeu.defined.must_equal(Vedeu::API::Defined)
+    end
+  end
+
+  describe '.event' do
+    it 'returns a list of event associated with the provided event name ' \
+    'after adding the event' do
+      skip 'Need to mock an event'
+      Vedeu.event(:_hydrogen_event_).must_equal('')
+    end
+
+    it 'should raise an exception when the event name is nil or empty' do
+      skip 'Need to raise an exception'
+      Vedeu.event(nil).must_equal('')
+    end
+  end
+
+  describe '.focus' do
+    it 'raises an exception when the interface does not exist' do
+      proc { Vedeu.focus(nil) }.must_raise(Vedeu::ModelNotFound)
+    end
+
+    it 'raises an exception when the interface does not exist' do
+      proc { Vedeu.focus('not_defined') }.must_raise(Vedeu::ModelNotFound)
+    end
+
+    it 'sets the specified interface as in focus' do
+      skip 'Finish this test off'
+      Vedeu.focus('hydrogen')
+    end
+  end
+
+  describe '.height' do
+    before { Vedeu::Terminal.console.stubs(:winsize).returns([25, 80]) }
+
+    it 'returns the height of the terminal' do
+      Vedeu.height.must_equal(25)
+    end
+  end
+
+  describe '.interface' do
+  end
+
+  describe '.keypress' do
+  end
+
+  describe '.keys' do
+  end
+
+  describe '.log' do
+  end
+
+  describe '.menu' do
+  end
+
+  describe '.render' do
+  end
+
+  describe '.resize' do
+  end
+
+  describe '.trigger' do
+  end
+
+  describe '.unevent' do
+  end
+
+  describe '.use' do
+  end
+
+  describe '.view' do
+  end
+
+  describe '.views' do
+  end
+
+  describe '.width' do
+    before { Vedeu::Terminal.console.stubs(:winsize).returns([25, 80]) }
+
+    it 'returns the width of the terminal' do
+      Vedeu.width.must_equal(80)
+    end
+  end
+
+end

data/test/integration/api_dsl/dsl_api_test.rb

@@ -0,0 +1,4 @@
+require 'test_helper'
+
+describe 'DSL API tests' do
+end

data/test/integration/api_dsl/dsl_composition_test.rb

@@ -0,0 +1,4 @@
+require 'test_helper'
+
+describe 'DSL Composition tests' do
+end

data/test/integration/api_dsl/dsl_defined_test.rb

@@ -0,0 +1,4 @@
+require 'test_helper'
+
+describe 'DSL Defined tests' do
+end

data/test/integration/api_dsl/dsl_helpers_test.rb

@@ -0,0 +1,4 @@
+require 'test_helper'
+
+describe 'DSL Helpers tests' do
+end

data/test/integration/api_dsl/dsl_interface_test.rb

@@ -0,0 +1,4 @@
+require 'test_helper'
+
+describe 'DSL Interface tests' do
+end

data/test/integration/api_dsl/dsl_keymap.rb

@@ -0,0 +1,4 @@
+require 'test_helper'
+
+describe 'DSL Keymap tests' do
+end

data/test/integration/api_dsl/dsl_line_test.rb

@@ -0,0 +1,4 @@
+require 'test_helper'
+
+describe 'DSL Line tests' do
+end

data/test/integration/api_dsl/dsl_menu_test.rb

@@ -0,0 +1,4 @@
+require 'test_helper'
+
+describe 'DSL Menu tests' do
+end