vedeu 0.4.19 → 0.4.20

data/lib/vedeu/geometry/index_position.rb

@@ -38,12 +38,16 @@ module Vedeu
     end
     alias_method :==, :eql?
 
+    # Returns the y coordinate.
+    #
     # @return [Fixnum]
     def y
       (iy <= 0) ? oy : (iy + oy)
     end
     alias_method :first, :y
 
+    # Returns the x coordinate.
+    #
     # @return [Fixnum]
     def x
       (ix <= 0) ? ox : (ix + ox)

data/lib/vedeu/input/keymap.rb

@@ -29,6 +29,8 @@ module Vedeu
       end
     end
 
+    # Add a key to the keymap.
+    #
     # @param key [Key]
     # @return [void]
     def add(key)
@@ -37,11 +39,15 @@ module Vedeu
       @keys = keys.add(key)
     end
 
+    # Returns the collection of keys defined for this keymap.
+    #
     # @return [Vedeu::Keys]
     def keys
       collection.coerce(@keys, self)
     end
 
+    # Check whether the key is already defined for this keymap.
+    #
     # @param input [String|Symbol]
     # @return [Boolean] A boolean indicating the input provided is already in
     #   use for this keymap.

data/lib/vedeu/models/interface.rb

@@ -98,6 +98,14 @@ module Vedeu
     alias_method :content?, :lines?
     alias_method :value?, :lines?
 
+    # Returns a boolean indicating whether the interface belongs to a
+    # group.
+    #
+    # @return [Boolean]
+    def group?
+      !group.nil? && !group.empty?
+    end
+
     # @return [Array<Array<Vedeu::Char>>]
     def render
       return [] unless visible?

data/lib/vedeu/output/background.rb

@@ -6,32 +6,6 @@ module Vedeu
 
     private
 
-    # Registers a HTML/CSS colour code and escape sequence to reduce processing.
-    #
-    # @param colour [String] A HTML/CSS colour code.
-    # @param escape_sequence [String] The HTML/CSS colour code as an escape
-    #   sequence.
-    # @return [String]
-    def register(colour, escape_sequence)
-      Vedeu.background_colours.register(colour, escape_sequence)
-    end
-
-    # Returns a boolean indicating the HTML/CSS colour code has been registered.
-    #
-    # @param colour [String]
-    # @return [Boolean]
-    def registered?(colour)
-      Vedeu.background_colours.registered?(colour)
-    end
-
-    # Retrieves the escape sequence for the HTML/CSS colour code.
-    #
-    # @param colour [String]
-    # @return [String]
-    def retrieve(colour)
-      Vedeu.background_colours.retrieve(colour)
-    end
-
     # @return [String]
     def named_codes
       Vedeu::Esc.background_codes[colour]
@@ -42,6 +16,11 @@ module Vedeu
       "\e[48;5;"
     end
 
+    # @return [Vedeu::BackgroundColours]
+    def repository
+      Vedeu.background_colours
+    end
+
     # @return [String]
     def rgb_prefix
       "\e[48;2;%s;%s;%sm"

data/lib/vedeu/output/foreground.rb

@@ -6,32 +6,6 @@ module Vedeu
 
     private
 
-    # Registers a HTML/CSS colour code and escape sequence to reduce processing.
-    #
-    # @param colour [String] A HTML/CSS colour code.
-    # @param escape_sequence [String] The HTML/CSS colour code as an escape
-    #   sequence.
-    # @return [String]
-    def register(colour, escape_sequence)
-      Vedeu.foreground_colours.register(colour, escape_sequence)
-    end
-
-    # Returns a boolean indicating the HTML/CSS colour code has been registered.
-    #
-    # @param colour [String]
-    # @return [Boolean]
-    def registered?(colour)
-      Vedeu.foreground_colours.registered?(colour)
-    end
-
-    # Retrieves the escape sequence for the HTML/CSS colour code.
-    #
-    # @param colour [String]
-    # @return [String]
-    def retrieve(colour)
-      Vedeu.foreground_colours.retrieve(colour)
-    end
-
     # @return [String]
     def named_codes
       Vedeu::Esc.foreground_codes[colour]
@@ -42,6 +16,11 @@ module Vedeu
       "\e[38;5;"
     end
 
+    # @return [Vedeu::ForegroundColours]
+    def repository
+      Vedeu.foreground_colours
+    end
+
     # @return [String]
     def rgb_prefix
       "\e[38;2;%s;%s;%sm"

data/lib/vedeu/output/translator.rb

@@ -105,18 +105,30 @@ module Vedeu
 
     private
 
-    # Subclasses implement this method.
+    # Retrieves the escape sequence for the HTML/CSS colour code.
     #
+    # @param colour [String]
     # @return [String]
-    def retrieve(*)
-      ''
+    def retrieve(colour)
+      repository.retrieve(colour)
     end
 
-    # Subclasses implement this method.
+    # Registers a HTML/CSS colour code and escape sequence to reduce processing.
     #
-    # @return [FalseClass]
-    def registered?(*)
-      false
+    # @param colour [String] A HTML/CSS colour code.
+    # @param escape_sequence [String] The HTML/CSS colour code as an escape
+    #   sequence.
+    # @return [String]
+    def register(colour, escape_sequence)
+      repository.register(colour, escape_sequence)
+    end
+
+    # Returns a boolean indicating the HTML/CSS colour code has been registered.
+    #
+    # @param colour [String]
+    # @return [Boolean]
+    def registered?(colour)
+      repository.registered?(colour)
     end
 
     # @return [Boolean]
@@ -243,26 +255,16 @@ module Vedeu
       (css_to_rgb[2] / 51) * 1
     end
 
-    # @raise [NotImplemented] Subclasses of this class must implement this
-    #   method.
-    # @return [Exception]
-    def named_codes
-      fail NotImplemented, 'Subclasses implement this.'
-    end
-
-    # @raise [NotImplemented] Subclasses of this class must implement this
-    #   method.
-    # @return [NotImplemented]
-    def numbered_prefix
-      fail NotImplemented, 'Subclasses implement this.'
-    end
-
     # @raise [NotImplemented] Subclasses of this class must implement this
     #   method.
     # @return [NotImplemented]
-    def rgb_prefix
+    def not_implemented
       fail NotImplemented, 'Subclasses implement this.'
     end
+    alias_method :named_codes,     :not_implemented
+    alias_method :numbered_prefix, :not_implemented
+    alias_method :repository,      :not_implemented
+    alias_method :rgb_prefix,      :not_implemented
 
   end # Translator
 

data/test/lib/vedeu/api_test.rb

@@ -4,61 +4,310 @@ module Vedeu
 
   describe API do
 
-    describe '.log' do
-      it 'writes the message to the log file when debugging is enabled' do
-        Configuration.stub(:debug?, true) do
-          Vedeu.log(type: :test,
-                    message: 'Testing debugging to log').must_equal(true)
+    describe 'Forwardable' do
+
+      describe 'Vedeu::BackgroundColours' do
+        describe '.background_colours' do
+          subject { Vedeu.background_colours }
+
+          # it { subject.must_be_instance_of(Vedeu::BackgroundColours) }
         end
       end
 
-      it 'returns nil when debugging is disabled' do
-        Configuration.stub(:debug?, false) do
-          Vedeu.log(type: :test,
-                    message: 'some message not logged...').must_equal(nil)
+      describe 'Vedeu::Borders' do
+        describe '.borders' do
+          subject { Vedeu.borders }
+
+          # it { subject.must_be_instance_of(Vedeu::Borders) }
         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(type: :test,
-                    message: 'Testing forced debugging to log',
-                    force: true).must_equal(true)
+      describe 'Vedeu::Buffers' do
+        describe '.buffers' do
+          subject { Vedeu.buffers }
+
+          # it { subject.must_be_instance_of(Vedeu::Buffers) }
         end
       end
-    end
 
-    describe '.menu' do
-      it 'creates and stores a new menu' do
-        Vedeu.menu('Vedeu.menu') do
-          # ...
-        end.must_be_instance_of(Vedeu::Menu)
+      describe 'Vedeu::Canvas' do
+        describe '.canvas' do
+          subject { Vedeu.canvas }
+
+          # it { subject.must_be_instance_of(Vedeu::Canvas) }
+        end
       end
-    end
 
-    describe '.menus' do
-      it 'accesses the menus repository' do
-        Vedeu.menus.must_be_instance_of(Vedeu::Menus)
+      describe 'Vedeu::Configuration' do
+        describe '.configure' do
+          subject { Vedeu.configure }
+
+          # it { subject.must_be_instance_of(NilClass) }
+        end
+
+        describe '.configuration' do
+          subject { Vedeu.configuration }
+
+          # it { subject.must_be_instance_of(Vedeu::Configuration) }
+        end
       end
-    end
 
-    describe '.resize' do
-      before do
-        Vedeu.interfaces.reset
-        Terminal.console.stubs(:print)
+      describe 'Vedeu::Cursors' do
+        describe '.cursor' do
+          subject { Vedeu.cursor }
+
+          # when all tests run
+          # it { subject.must_be_instance_of(Vedeu::Cursor) }
+
+          # when just this test runs
+          # it { subject.must_be_instance_of(NilClass) }
+        end
+
+        describe '.cursors' do
+          subject { Vedeu.cursors }
+
+          # it { subject.must_be_instance_of(Vedeu::Cursors) }
+        end
       end
 
-      it 'returns a TrueClass' do
-        Vedeu.resize.must_be_instance_of(TrueClass)
+      describe 'Vedeu::DSL::Border' do
+        describe '.border' do
+          let(:arg) {}
+
+          subject { Vedeu.border(arg) {} }
+
+          # it { subject.must_be_instance_of(NilClass) }
+        end
       end
-    end
 
-    describe '.trigger' do
-      it 'triggers the specifed event and returns the collection of events' \
-         ' which this trigger triggers' do
-        Vedeu.trigger(:vedeu_trigger_event, :event_arguments).must_equal([])
+      describe 'Vedeu::DSL::Geometry' do
+        describe '.geometry' do
+          let(:arg) {}
+
+          subject { Vedeu.geometry(arg) { } }
+
+          # it { subject.must_be_instance_of(NilClass) }
+        end
       end
+
+      describe 'Vedeu::DSL::Group' do
+        describe '.group' do
+          let(:arg) {}
+
+          subject { Vedeu.group(arg) { } }
+
+          # it { subject.must_be_instance_of(NilClass) }
+        end
+      end
+
+      describe 'Vedeu::DSL::Keymap' do
+        describe '.keymap' do
+          let(:arg) {}
+
+          subject { Vedeu.keymap(arg) }
+
+          # it { subject.must_be_instance_of(NilClass) }
+        end
+      end
+
+      describe 'Vedeu::DSL::View' do
+        describe '.interface' do
+          subject { Vedeu.interface { } }
+
+          # it { subject.must_be_instance_of(NilClass) }
+        end
+
+        describe '.renders' do
+          subject { Vedeu.renders { } }
+
+          # it { subject.must_be_instance_of(Array) }
+        end
+
+        describe '.views' do
+          subject { Vedeu.views { } }
+
+          # it { subject.must_be_instance_of(Array) }
+        end
+      end
+
+      describe 'Vedeu::Event' do
+        describe '.bind' do
+          let(:args) {}
+
+          subject { Vedeu.bind(args) }
+
+          # it { subject.must_be_instance_of(NilClass) }
+        end
+
+        describe '.unbind' do
+          let(:args) {}
+
+          subject { Vedeu.unbind(args) }
+
+          # it { subject.must_be_instance_of(FalseClass) }
+        end
+      end
+
+      describe 'Vedeu::EventsRepository' do
+        describe '.events' do
+          subject { Vedeu.events }
+
+          # it { subject.must_be_instance_of(Vedeu::EventsRepository) }
+        end
+      end
+
+      describe 'Vedeu::Focus' do
+        describe '.focus' do
+          subject { Vedeu.focus }
+
+          # it { subject.must_be_instance_of(NilClass) }
+        end
+
+        describe '.focus_by_name' do
+          let(:_name) {}
+
+          subject { Vedeu.focus_by_name(_name) }
+
+          # it { subject.must_be_instance_of(NilClass) }
+        end
+
+        describe '.focussed?' do
+          let(:arg) {}
+
+          subject { Vedeu.focussed?(arg) }
+
+          # it { subject.must_be_instance_of(TrueClass) }
+        end
+
+        describe '.focus_next' do
+          subject { Vedeu.focus_next }
+
+          # it { subject.must_be_instance_of(FalseClass) }
+        end
+
+        describe '.focus_previous' do
+          subject { Vedeu.focus_previous }
+
+          # it { subject.must_be_instance_of(FalseClass) }
+        end
+      end
+
+      describe 'Vedeu::ForegroundColours' do
+        describe '.foreground_colours' do
+          subject { Vedeu.foreground_colours }
+
+          # it { subject.must_be_instance_of(Vedeu::ForegroundColours) }
+        end
+      end
+
+      describe 'Vedeu::Geometries' do
+        describe '.geometries' do
+          subject { Vedeu.geometries }
+
+          # it { subject.must_be_instance_of(Vedeu::Geometries) }
+        end
+      end
+
+      describe 'Vedeu::Groups' do
+        describe '.groups' do
+          subject { Vedeu.groups }
+
+          # it { subject.must_be_instance_of(Vedeu::Groups) }
+        end
+      end
+
+      describe 'Vedeu::InterfacesRepository' do
+        describe '.interfaces' do
+          subject { Vedeu.interfaces }
+
+          # it { subject.must_be_instance_of(Vedeu::InterfacesRepository) }
+        end
+      end
+
+      describe 'Vedeu::Keymaps' do
+        describe '.keymaps' do
+          subject { Vedeu.keymaps }
+
+          # it { subject.must_be_instance_of(Vedeu::Keymaps) }
+        end
+      end
+
+      describe 'Vedeu::Log' do
+        describe '.log' do
+          subject { Vedeu.log(message: '') }
+
+          # it { subject.must_be_instance_of(NilClass) }
+        end
+      end
+
+      describe 'Vedeu::Mapper' do
+        describe '.keypress' do
+          subject { Vedeu.keypress }
+
+          # it { subject.must_be_instance_of(FalseClass) }
+        end
+      end
+
+      describe 'Vedeu::Menu' do
+        describe '.menu' do
+          subject { Vedeu.menu { } }
+
+          # it { subject.must_be_instance_of(NilClass) }
+        end
+      end
+
+      describe 'Vedeu::Menus' do
+        describe '.menus' do
+          subject { Vedeu.menus }
+
+          # it { subject.must_be_instance_of(Vedeu::Menus) }
+        end
+      end
+
+      describe 'Vedeu::Renderers' do
+        describe '.renderer' do
+          subject { Vedeu.renderer }
+
+          # it { subject.must_be_instance_of(Set) }
+        end
+
+        describe '.renderers' do
+          subject { Vedeu.renderers }
+
+          # it { subject.must_be_instance_of(Module) }
+        end
+      end
+
+      describe 'Vedeu::Terminal' do
+        describe '.height' do
+          subject { Vedeu.height }
+
+          # it { subject.must_be_instance_of(Fixnum) }
+        end
+
+        describe '.width' do
+          subject { Vedeu.width }
+
+          # it { subject.must_be_instance_of(Fixnum) }
+        end
+
+        describe '.resize' do
+          subject { Vedeu.resize }
+
+          # it { subject.must_be_instance_of(TrueClass) }
+        end
+      end
+
+      describe 'Vedeu::Trigger' do
+        describe '.trigger' do
+          let(:args) {}
+
+          subject { Vedeu.trigger(args) }
+
+          # it { subject.must_be_instance_of(Array) }
+        end
+      end
+
     end
 
   end # API