vedeu 0.4.9 → 0.4.10

data/lib/vedeu/output/virtual_terminal.rb

@@ -16,6 +16,8 @@ module Vedeu
     # @return [Fixnum]
     attr_reader :width
 
+    # Returns a new instance of Vedeu::VirtualTerminal.
+    #
     # @param height [Fixnum]
     # @param width [Fixnum]
     # @param renderer [Object|HTMLRenderer] An object responding to .render.

data/lib/vedeu/output/wordwrap.rb

@@ -9,6 +9,8 @@ module Vedeu
       new(text, options).content
     end
 
+    # Returns a new instance of Vedeu::Wordwrap.
+    #
     # @param text [String]
     # @param options [Hash]
     # @option options ellipsis [String] For when using mode `:prune`.

data/lib/vedeu/repositories/all.rb

@@ -28,6 +28,88 @@ module Vedeu
 
   end # Buffers
 
+  # Allows the storing of HTML/CSS colours and their respective escape
+  # sequences.
+  #
+  class Colours
+
+    # @!attribute [r] storage
+    # @return [Hash<String => String>]
+    attr_reader :storage
+
+    # Returns a new instance of Vedeu::Colours.
+    #
+    # @return [Vedeu::Colours]
+    def initialize
+      @storage = {}
+    end
+
+    # Registers a colour with respective escape sequence.
+    #
+    # @return [String]
+    def register(colour, escape_sequence)
+      storage.store(colour, escape_sequence)
+    end
+
+    # Returns a boolean indicating whether the colour has been registered.
+    #
+    # @return [Boolean]
+    def registered?(colour)
+      storage.key?(colour)
+    end
+
+    # Removes all stored colours.
+    #
+    # @return [Hash]
+    def reset!
+      storage.clear
+    end
+
+    # Retrieves a registered colour.
+    #
+    # @return [String]
+    def retrieve(colour)
+      storage.fetch(colour, '')
+    end
+
+    # Retrieves a registered colour, or registers the colour with its respective
+    # escape sequence.
+    #
+    # @return [String]
+    def retrieve_or_register(colour, escape_sequence)
+      if registered?(colour)
+        retrieve(colour)
+
+      else
+        register(colour, escape_sequence)
+
+      end
+    end
+
+  end # Colours
+
+  # Store background colour escape sequences by HTML/CSS code.
+  #
+  class BackgroundColours < Colours
+
+    # @return [Vedeu::BackgroundColours]
+    def self.background_colours
+      @background_colours ||= new
+    end
+
+  end # BackgroundColours
+
+  # Store foreground colour escape sequences by HTML/CSS code.
+  #
+  class ForegroundColours < Colours
+
+    # @return [Vedeu::ForegroundColours]
+    def self.foreground_colours
+      @foreground_colours ||= new
+    end
+
+  end # ForegroundColours
+
   # Allows the storing of each interface's cursor.
   #
   class Cursors < Repository

data/lib/vedeu/repositories/collection.rb

@@ -29,6 +29,8 @@ module Vedeu
       end
     end
 
+    # Returns a new instance of Vedeu::Collection.
+    #
     # @param collection []
     # @param parent [void]
     # @param name [String|NilClass]
@@ -39,12 +41,16 @@ module Vedeu
       @name       = name
     end
 
+    # Fetch an entry from the collection via index.
+    #
     # @param value [Fixnum]
     # @return [void]
     def [](value)
       @collection[value]
     end
 
+    # Adds an entry to the collection.
+    #
     # @param other [Vedeu::Collection]
     # @return [Vedeu::Collection]
     def add(*other)
@@ -52,27 +58,37 @@ module Vedeu
     end
     alias_method :<<, :add
 
+    # Returns the whole collection.
+    #
     # @return [Array]
     def all
       @collection
     end
 
+    # Provides iteration over the collection.
+    #
     # @param block [Proc]
     # @return [Enumerator]
     def each(&block)
       @collection.each(&block)
     end
 
+    # Returns a boolean indicating whether the collection is empty.
+    #
     # @return [Boolean]
     def empty?
       @collection.empty?
     end
 
+    # Returns the size of the collection.
+    #
     # @return [Fixnum]
     def size
       @collection.size
     end
 
+    # Returns the collection as a String.
+    #
     # @return [String]
     def to_s
       @collection.map(&:to_s).join

data/lib/vedeu/repositories/repository.rb

@@ -24,6 +24,8 @@ module Vedeu
     # @return [void]
     attr_reader :storage
 
+    # Returns a new instance of Vedeu::Repository.
+    #
     # @param model [Class]
     # @param storage [Class|Hash]
     # @return [Vedeu::Repository]

data/lib/vedeu/support/log.rb

@@ -31,8 +31,11 @@ module Vedeu
 
     # Ensures we can always write to the log file by creating a lock-less
     # log device.
+    #
     class LocklessLogDevice < LogDevice
 
+      # Returns a new instance of Vedeu::LocklessLogDevice.
+      #
       # @param log []
       # @return []
       def initialize(log = nil)

data/lib/vedeu/support/sentence.rb

@@ -15,6 +15,8 @@ module Vedeu
       new(elements, label).construct
     end
 
+    # Returns a new instance of Vedeu::Sentence.
+    #
     # @param elements [Array]
     # @param label [String]
     # @return [Vedeu::Sentence]

data/lib/vedeu/support/template.rb

@@ -13,6 +13,8 @@ module Vedeu
       new(object, path).parse
     end
 
+    # Returns a new instance of Vedeu::Template.
+    #
     # @param object [Class]
     # @param path [String]
     # @return [Template]

data/lib/vedeu/support/terminal.rb

@@ -41,7 +41,7 @@ module Vedeu
     #
     # @return [String]
     def input
-      if raw_mode?
+      keys_or_cmd = if raw_mode?
         keys = console.getch
         if keys.ord == 27
           keys << console.read_nonblock(3) rescue nil
@@ -53,6 +53,10 @@ module Vedeu
         console.gets.chomp
 
       end
+
+      Vedeu.trigger(:tick, Time.now.to_f)
+
+      keys_or_cmd
     end
     alias_method :read, :input
 
@@ -62,6 +66,7 @@ module Vedeu
     # @return [Array]
     def output(*streams)
       streams.each do |stream|
+        # Write the stream to the log file.
         # Vedeu.log(Esc.escape(stream))
 
         console.print(stream)

data/lib/vedeu/support/trace.rb

@@ -32,6 +32,8 @@ module Vedeu
       new(options).trace
     end
 
+    # Returns a new instance of Vedeu::Trace
+    #
     # @param options [Hash]
     # @return [Trace]
     def initialize(options = {})

data/lib/vedeu/support/visible.rb

@@ -18,6 +18,8 @@ module Vedeu
       end
     end
 
+    # Returns a new instance of Vedeu::Visible
+    #
     # @param visible [Boolean|Symbol]
     # @return [Visible]
     def initialize(visible = nil)
@@ -49,11 +51,15 @@ module Vedeu
       end
     end
 
+    # Returns a boolean indicating whether the instance is visible.
+    #
     # @return [Boolean]
     def visible?
       @visible
     end
 
+    # Returns a boolean indicating whether the instance is invisible.
+    #
     # @return [Boolean]
     def invisible?
       !@visible

data/test/lib/vedeu/dsl/components/border_test.rb

@@ -48,33 +48,6 @@ module Vedeu
 
         it { subject.must_be_instance_of(String) }
         it { subject.must_equal('C') }
-
-        context 'DSL #bottom_left' do
-          subject {
-            Vedeu.interface 'borders' do
-              border do
-                bottom_left '<'
-              end
-              geometry do
-                height 3
-                width  3
-              end
-              lines do
-                line ''
-              end
-            end
-          }
-
-          it { subject.must_be_instance_of(Vedeu::Interface) }
-
-          it 'allows the use of bottom_left within border' do
-            subject.border.to_s.must_equal(
-              "\e(0l\e(B\e(0q\e(B\e(0k\e(B\n" \
-              "\e(0x\e(B \e(0x\e(B\n" \
-              "\e(0<\e(B\e(0q\e(B\e(0j\e(B"
-            )
-          end
-        end
       end
 
       describe '#bottom_right' do
@@ -84,33 +57,6 @@ module Vedeu
 
         it { subject.must_be_instance_of(String) }
         it { subject.must_equal('D') }
-
-        context 'DSL #bottom_right' do
-          subject {
-            Vedeu.interface 'borders' do
-              border do
-                bottom_right '>'
-              end
-              geometry do
-                height 3
-                width  3
-              end
-              lines do
-                line ''
-              end
-            end
-          }
-
-          it { subject.must_be_instance_of(Vedeu::Interface) }
-
-          it 'allows the use of bottom_right within border' do
-            subject.border.to_s.must_equal(
-              "\e(0l\e(B\e(0q\e(B\e(0k\e(B\n" \
-              "\e(0x\e(B \e(0x\e(B\n" \
-              "\e(0m\e(B\e(0q\e(B\e(0>\e(B"
-            )
-          end
-        end
       end
 
       describe '#horizontal' do
@@ -120,33 +66,6 @@ module Vedeu
 
         it { subject.must_be_instance_of(String) }
         it { subject.must_equal('H') }
-
-        context 'DSL #horizontal' do
-          subject {
-            Vedeu.interface 'borders' do
-              border do
-                horizontal '~'
-              end
-              geometry do
-                height 3
-                width  3
-              end
-              lines do
-                line ''
-              end
-            end
-          }
-
-          it { subject.must_be_instance_of(Vedeu::Interface) }
-
-          it 'allows the use of horizontal within border' do
-            subject.border.to_s.must_equal(
-              "\e(0l\e(B\e(0~\e(B\e(0k\e(B\n" \
-              "\e(0x\e(B \e(0x\e(B\n" \
-              "\e(0m\e(B\e(0~\e(B\e(0j\e(B"
-            )
-          end
-        end
       end
 
       describe '#show_bottom' do
@@ -160,33 +79,6 @@ module Vedeu
           it { subject.must_be_instance_of(FalseClass) }
         end
 
-        context 'DSL #show_bottom' do
-          subject {
-            Vedeu.interface 'borders' do
-              border do
-                show_bottom ''
-              end
-              geometry do
-                height 3
-                width  3
-              end
-              lines do
-                line ''
-              end
-            end
-          }
-
-          it { subject.must_be_instance_of(Vedeu::Interface) }
-
-          it 'allows the use of show_bottom within border' do
-            subject.border.to_s.must_equal(
-              "\e(0l\e(B\e(0q\e(B\e(0k\e(B\n" \
-              "\e(0x\e(B \e(0x\e(B\n" \
-              "\e(0m\e(B\e(0q\e(B\e(0j\e(B"
-            )
-          end
-        end
-
         it { instance.must_respond_to(:bottom) }
       end
 
@@ -214,33 +106,6 @@ module Vedeu
 
           it { subject.must_be_instance_of(FalseClass) }
         end
-
-        context 'DSL #show_left' do
-          subject {
-            Vedeu.interface 'borders' do
-              border do
-                show_left!
-              end
-              geometry do
-                height 3
-                width  3
-              end
-              lines do
-                line ''
-              end
-            end
-          }
-
-          it { subject.must_be_instance_of(Vedeu::Interface) }
-
-          it 'allows the use of show_left within border' do
-            subject.border.to_s.must_equal(
-              "\e(0l\e(B\e(0q\e(B\e(0k\e(B\n" \
-              "\e(0x\e(B \e(0x\e(B\n" \
-              "\e(0m\e(B\e(0q\e(B\e(0j\e(B"
-            )
-          end
-        end
       end
 
       describe '#hide_left!' do
@@ -267,33 +132,6 @@ module Vedeu
 
           it { subject.must_be_instance_of(FalseClass) }
         end
-
-        context 'DSL #show_right' do
-          subject {
-            Vedeu.interface 'borders' do
-              border do
-                show_right!
-              end
-              geometry do
-                height 3
-                width  3
-              end
-              lines do
-                line ''
-              end
-            end
-          }
-
-          it { subject.must_be_instance_of(Vedeu::Interface) }
-
-          it 'allows the use of show_right within border' do
-            subject.border.to_s.must_equal(
-              "\e(0l\e(B\e(0q\e(B\e(0k\e(B\n" \
-              "\e(0x\e(B \e(0x\e(B\n" \
-              "\e(0m\e(B\e(0q\e(B\e(0j\e(B"
-            )
-          end
-        end
       end
 
       describe '#hide_right!' do
@@ -320,33 +158,6 @@ module Vedeu
 
           it { subject.must_be_instance_of(FalseClass) }
         end
-
-        context 'DSL #show_top' do
-          subject {
-            Vedeu.interface 'borders' do
-              border do
-                show_top ''
-              end
-              geometry do
-                height 3
-                width  3
-              end
-              lines do
-                line ''
-              end
-            end
-          }
-
-          it { subject.must_be_instance_of(Vedeu::Interface) }
-
-          it 'allows the use of show_top within border' do
-            subject.border.to_s.must_equal(
-              "\e(0l\e(B\e(0q\e(B\e(0k\e(B\n" \
-              "\e(0x\e(B \e(0x\e(B\n" \
-              "\e(0m\e(B\e(0q\e(B\e(0j\e(B"
-            )
-          end
-        end
       end
 
       describe '#hide_top!' do
@@ -368,33 +179,6 @@ module Vedeu
 
         it { subject.must_be_instance_of(String) }
         it { subject.must_equal('A') }
-
-        context 'DSL #top_left' do
-          subject {
-            Vedeu.interface 'borders' do
-              border do
-                top_left '{'
-              end
-              geometry do
-                height 3
-                width  3
-              end
-              lines do
-                line ''
-              end
-            end
-          }
-
-          it { subject.must_be_instance_of(Vedeu::Interface) }
-
-          it 'allows the use of top_left within border' do
-            subject.border.to_s.must_equal(
-              "\e(0{\e(B\e(0q\e(B\e(0k\e(B\n" \
-              "\e(0x\e(B \e(0x\e(B\n" \
-              "\e(0m\e(B\e(0q\e(B\e(0j\e(B"
-            )
-          end
-        end
       end
 
       describe '#top_right' do
@@ -404,33 +188,6 @@ module Vedeu
 
         it { subject.must_be_instance_of(String) }
         it { subject.must_equal('B') }
-
-        context 'DSL #top_right' do
-          subject {
-            Vedeu.interface 'borders' do
-              border do
-                top_right '}'
-              end
-              geometry do
-                height 3
-                width  3
-              end
-              lines do
-                line ''
-              end
-            end
-          }
-
-          it { subject.must_be_instance_of(Vedeu::Interface) }
-
-          it 'allows the use of top_right within border' do
-            subject.border.to_s.must_equal(
-              "\e(0l\e(B\e(0q\e(B\e(0}\e(B\n" \
-              "\e(0x\e(B \e(0x\e(B\n" \
-              "\e(0m\e(B\e(0q\e(B\e(0j\e(B"
-            )
-          end
-        end
       end
 
       describe '#vertical' do
@@ -440,33 +197,6 @@ module Vedeu
 
         it { subject.must_be_instance_of(String) }
         it { subject.must_equal('V') }
-
-        context 'DSL #vertical' do
-          subject {
-            Vedeu.interface 'borders' do
-              border do
-                vertical ':'
-              end
-              geometry do
-                height 3
-                width  3
-              end
-              lines do
-                line ''
-              end
-            end
-          }
-
-          it { subject.must_be_instance_of(Vedeu::Interface) }
-
-          it 'allows the use of vertical within border' do
-            subject.border.to_s.must_equal(
-              "\e(0l\e(B\e(0q\e(B\e(0k\e(B\n" \
-              "\e(0:\e(B \e(0:\e(B\n" \
-              "\e(0m\e(B\e(0q\e(B\e(0j\e(B"
-            )
-          end
-        end
       end
 
     end # Border