vedeu 0.3.4 → 0.3.5

data/lib/vedeu/support/position.rb

@@ -3,6 +3,7 @@ module Vedeu
   # Change coordinates into an escape sequence to set the cursor position.
   #
   # @api private
+  #
   class Position
 
     attr_reader  :y,
@@ -11,6 +12,8 @@ module Vedeu
     alias_method :first, :y
     alias_method :last, :x
 
+    # @param value [Array<Fixnum>|Vedeu::Position]
+    # @return [void]
     def self.coerce(value)
       if value.is_a?(self)
         value
@@ -26,32 +29,34 @@ module Vedeu
 
     # Initializes a new instance of Position.
     #
-    # @param y [Fixnum]
-    # @param x [Fixnum]
+    # @param y [Fixnum] The row/line position.
+    # @param x [Fixnum] The column/character position.
     # @return [Position]
     def initialize(y = 1, x = 1)
-      @y = y
-      @x = x
+      @y = (y.nil? || y < 1) ? 1 : y
+      @x = (x.nil? || x < 1) ? 1 : x
     end
 
+    # @return [String]
     def inspect
       "<#{self.class.name} (y:#{@y} x:#{@x})>"
     end
 
-    # @param other []
+    # @param other [Vedeu::Position]
     # @return [Boolean]
     def ==(other)
       eql?(other)
     end
 
-    # @param other []
+    # @param other [Vedeu::Position]
     # @return [Boolean]
     def eql?(other)
       self.class == other.class && (x == other.x && y == other.y)
     end
 
-    # Returns an escape sequence to position the cursor. When passed a block,
-    # will position the cursor, yield and return the original position.
+    # Return the escape sequence required to position the cursor at a particular
+    # point on the screen. When passed a block, will do the aforementioned,
+    # call the block and then reposition to this location.
     #
     # @param block [Proc]
     # @return [String]
@@ -75,32 +80,6 @@ module Vedeu
       ["\e[", y, ';', x, 'H'].join
     end
 
-    # Returns the y coordinate.
-    #
-    # @return [Fixnum]
-    def y
-      if @y < 1 || @y.nil?
-        1
-
-      else
-        @y
-
-      end
-    end
-
-    # Returns the x coordinate.
-    #
-    # @return [Fixnum]
-    def x
-      if @x < 1 || @x.nil?
-        1
-
-      else
-        @x
-
-      end
-    end
-
   end # Position
 
 end # Vedeu

data/lib/vedeu/support/position_validator.rb

@@ -1,5 +1,8 @@
 module Vedeu
 
+  # Validates that the provided coordinates are within the terminal and
+  # interface (with or without a border).
+  #
   class PositionValidator
 
     extend Forwardable

data/lib/vedeu/support/read.rb

@@ -1,6 +1,7 @@
 module Vedeu
 
   # The basis of a fake input device.
+  #
   class Read
 
     # @param console []

data/lib/vedeu/support/refresh.rb

@@ -3,6 +3,7 @@ module Vedeu
   # Refreshes the terminal.
   #
   # @api private
+  #
   module Refresh
 
     extend self
@@ -27,7 +28,7 @@ module Vedeu
     # @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)
-      Vedeu.log("Refreshing group: '#{group_name}'")
+      Vedeu.log(type: :info, message: "Refreshing group: '#{group_name}'")
 
       Vedeu.groups.find(group_name).members.each { |name| by_name(name) }
     end
@@ -38,7 +39,7 @@ module Vedeu
     #   named buffer.
     # @return [Array|ModelNotFound]
     def by_name(name)
-      Vedeu.log("Refreshing interface: '#{name}'")
+      Vedeu.log(type: :info, message: "Refreshing interface: '#{name}'")
 
       Vedeu::Compositor.compose(name)
     end

data/lib/vedeu/support/terminal.rb

@@ -8,6 +8,7 @@ module Vedeu
   # console, via Ruby's IO core library.
   #
   # @api private
+  #
   module Terminal
 
     extend self
@@ -22,12 +23,12 @@ module Vedeu
       fail InvalidSyntax, 'block not given' unless block_given?
 
       if raw_mode?
-        Vedeu.log("Terminal entering 'raw' mode")
+        Vedeu.log(type: :info, message: "Terminal entering 'raw' mode")
 
         console.raw    { initialize_screen { yield } }
 
       else
-        Vedeu.log("Terminal entering 'cooked' mode")
+        Vedeu.log(type: :info, message: "Terminal entering 'cooked' mode")
 
         console.cooked { initialize_screen { yield } }
 
@@ -88,7 +89,7 @@ module Vedeu
     end
 
     # @param block [Proc]
-    # @return []
+    # @return [void]
     def initialize_screen(&block)
       output(Esc.string('screen_init'))
 
@@ -132,7 +133,7 @@ module Vedeu
     #
     # @return [Symbol]
     def cooked_mode!
-      Vedeu.log("Terminal switching to 'cooked' mode")
+      Vedeu.log(type: :info, message: "Terminal switching to 'cooked' mode")
 
       @_mode = :cooked
     end
@@ -149,7 +150,7 @@ module Vedeu
     #
     # @return [Symbol]
     def raw_mode!
-      Vedeu.log("Terminal switching to 'raw' mode")
+      Vedeu.log(type: :info, message: "Terminal switching to 'raw' mode")
 
       @_mode = :raw
     end
@@ -258,6 +259,11 @@ module Vedeu
       IO.console
     end
 
+    # @return [VirtualTerminal]
+    def virtual
+      @virtual ||= VirtualTerminal.new(height, width)
+    end
+
   end # Terminal
 
 end # Vedeu

data/lib/vedeu/support/trace.rb

@@ -10,10 +10,25 @@ module Vedeu
   # excruciatingly slow to run.
   #
   # @api private
+  #
   class Trace
 
+    # @todo
+    #   Replace this class with this:
+    #
+    # def self.trace
+    #   trace = TracePoint.new(:call) do |tp|
+    #     if tp.defined_class.to_s.match(/Troo/)
+    #       Vedeu.log(type: :debug, message: [tp.defined_class.to_s, tp.method_id.to_s].join(' '))
+    #     end
+    #   end
+    #   trace.enable
+    # end
+
     # @param options [Hash]
-    # @return []
+    # @option option event [Symbol]
+    # @option option trace [Boolean]
+    # @return [void]
     def self.call(options = {})
       new(options).trace
     end

data/lib/vedeu/support/visible.rb

@@ -2,6 +2,8 @@ require 'vedeu/support/esc'
 
 module Vedeu
 
+  # Represents the concept of a visible or invisible attribute.
+  #
   class Visible
 
     # @return [Visible]

data/lib/vedeu/support/write.rb

@@ -1,6 +1,7 @@
 module Vedeu
 
   # The basis of a fake output device.
+  #
   class Write
 
     # @see Vedeu::Write#write

data/lib/vedeu/traps.rb

@@ -1,6 +1,7 @@
 module Vedeu
 
   # Vedeu can respond to various signals which are handled here.
+  #
   module Traps
 
     Signal.trap('INT') { exit! }

data/lib/vedeu.rb

@@ -34,6 +34,8 @@ module Vedeu
   #     include Vedeu
   #     ...
   #
+  # @param receiver []
+  # @return [void]
   def included(receiver)
     receiver.send(:include, API)
     receiver.extend(API)

data/test/integration/distributed_test.rb

@@ -2,13 +2,15 @@ require 'test_helper'
 
 describe 'Running a distributed app' do
 
-  # it 'runs a simple app and exits' do
-  #   app    = Vedeu::TestApplication.build
-  #   client = Vedeu::Distributed::Client.new("druby://localhost:21420")
-  #   server = Vedeu::Subprocess.execute!(app)
-  #   client.input('q')
-  #   client.output.must_equal('')
-  #   client.stop
-  # end
+  it 'runs a simple app and exits' do
+    skip
+    app    = Vedeu::TestApplication.build
+    server = Vedeu::Subprocess.execute!(app)
+
+    client = Vedeu::Distributed::Client.connect("druby://localhost:21420")
+    client.input('q')
+    client.output.must_equal('')
+    client.shutdown
+  end
 
 end

data/test/lib/vedeu/api_test.rb

@@ -4,10 +4,6 @@ module Vedeu
 
   describe API do
 
-    let(:event) { mock('Event') }
-
-    before { Event.stubs(:new).returns(event) }
-
     # describe '.focus' do
     #   it 'sets the named interface to be focussed' do
     #     Interface.build({ name: 'plutonium' }).store
@@ -68,20 +64,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('Testing debugging to log').must_equal(true)
+          Vedeu.log(type: :test, message: '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 not logged...').must_equal(nil)
+          Vedeu.log(type: :test, message: '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('Testing forced debugging to log', true).must_equal(true)
+          Vedeu.log(type: :test, message: 'Testing forced debugging to log', force: true).must_equal(true)
         end
       end
     end

data/test/lib/vedeu/application_test.rb

@@ -6,7 +6,7 @@ module Vedeu
 
     let(:described)     { Vedeu::Application }
     let(:instance)      { described.new(configuration) }
-    let(:configuration) { mock('Vedeu::Configuration') }
+    let(:configuration) { test_configuration }
 
     before do
       configuration.stubs(:drb?).returns(false)
@@ -23,15 +23,12 @@ module Vedeu
 
       it { subject.must_be_instance_of(Array) }
 
-      context 'alias method: .restart' do
-        it { subject.must_be_instance_of(Array) }
-      end
+      it { described.must_respond_to(:restart) }
     end
 
     describe '.stop' do
       subject { described.stop }
 
-      it { proc { subject }.must_raise(StopIteration) }
     end
 
     describe '#start' do

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

@@ -37,6 +37,8 @@ module Vedeu
           configuration = Vedeu.configure { interactive }
           configuration.interactive?.must_equal(true)
         end
+
+        # it { configuration.must_respond_to(:interactive) }
       end
 
       describe '#standalone!' do
@@ -59,6 +61,8 @@ module Vedeu
           configuration = Vedeu.configure { standalone }
           configuration.interactive?.must_equal(false)
         end
+
+        # it { configuration.must_respond_to(:standalone) }
       end
 
       describe '#run_once!' do
@@ -81,6 +85,8 @@ module Vedeu
           configuration = Vedeu.configure { run_once }
           configuration.once.must_equal(true)
         end
+
+        # it { configuration.must_respond_to(:run_once) }
       end
 
       describe '#drb!' do
@@ -103,6 +109,8 @@ module Vedeu
           configuration = Vedeu.configure { drb }
           configuration.drb.must_equal(true)
         end
+
+        # it { configuration.must_respond_to(:drb) }
       end
 
       describe '#drb_host' do
@@ -138,6 +146,8 @@ module Vedeu
           configuration = Vedeu.configure { cooked! }
           configuration.terminal_mode.must_equal(:cooked)
         end
+
+        # it { configuration.must_respond_to(:cooked) }
       end
 
       describe '#raw!' do
@@ -145,6 +155,8 @@ module Vedeu
           configuration = Vedeu.configure { raw! }
           configuration.terminal_mode.must_equal(:raw)
         end
+
+        # it { configuration.must_respond_to(:raw) }
       end
 
       describe '#debug!' do

data/test/lib/vedeu/cursor/cursor_test.rb

@@ -37,6 +37,8 @@ module Vedeu
       it { instance.instance_variable_get('@state').must_be_instance_of(Vedeu::Visible) }
       it { instance.instance_variable_get('@x').must_equal(19) }
       it { instance.instance_variable_get('@y').must_equal(8) }
+
+      it { instance.instance_variable_get('@position').must_be_instance_of(Vedeu::Position) }
     end
 
     describe '#inspect' do

data/test/lib/vedeu/distributed/client_test.rb

@@ -8,25 +8,35 @@ module Vedeu
 
       let(:described) { Vedeu::Distributed::Client }
       let(:instance)  { described.new(uri) }
-      let(:uri)       {}
+      let(:uri)       { 'druby://localhost:21420' }
 
       describe '#initialize' do
-        subject { instance }
+        it { instance.must_be_instance_of(described) }
+        it { instance.instance_variable_get('@uri').must_equal('druby://localhost:21420') }
+      end
+
+      describe '.connect' do
+        subject { described.connect(uri) }
 
-        it { subject.must_be_instance_of(described) }
-        it { subject.instance_variable_get('@uri').must_equal('') }
+        # it { subject.must_be_instance_of(Symbol) }
       end
 
       describe '#input' do
+        let(:data) {}
+
+        subject { instance.input(data) }
+
+        it { instance.must_respond_to(:read) }
       end
 
       describe '#output' do
-      end
+        subject { instance.output }
 
-      describe '#start' do
+        it { instance.must_respond_to(:write) }
       end
 
-      describe '#stop' do
+      describe '#shutdown' do
+        subject { instance.shutdown }
       end
 
     end # Client

data/test/lib/vedeu/distributed/server_test.rb

@@ -0,0 +1,56 @@
+require 'test_helper'
+
+module Vedeu
+
+  module Distributed
+
+    describe Server do
+
+      let(:described)     { Vedeu::Distributed::Server }
+      let(:instance)      { described.instance }
+      let(:configuration) {}
+
+      describe '.input' do
+        let(:data) {}
+
+        subject { described.input(data) }
+      end
+
+      describe '.output' do
+        subject { described.output }
+      end
+
+      describe '#pid' do
+        before { Process.stubs(:pid).returns(9876) }
+
+        subject { instance.pid }
+
+        it { subject.must_be_instance_of(Fixnum) }
+        it { subject.must_equal(9876) }
+      end
+
+      describe '.restart' do
+        subject { described.restart }
+      end
+
+      describe '.shutdown' do
+        subject { described.shutdown }
+      end
+
+      describe '.start' do
+        subject { described.start }
+      end
+
+      describe '.status' do
+        subject { described.status }
+      end
+
+      describe '.stop' do
+        subject { described.stop }
+      end
+
+    end # Server
+
+  end # Distributed
+
+end # Vedeu

data/test/lib/vedeu/distributed/test_application_test.rb

@@ -9,12 +9,16 @@ module Vedeu
     let(:attributes) { {} }
 
     describe '#initialize' do
-      subject { instance }
-
-      it { subject.must_be_instance_of(Vedeu::TestApplication) }
+      it { instance.must_be_instance_of(Vedeu::TestApplication) }
       # it { subject.instance_variable_get('@attributes').must_equal(attributes) }
     end
 
+    describe '.build' do
+      subject { described.build(attributes) { } }
+
+      it { subject.must_be_instance_of(String) }
+    end
+
     describe '#lib_dir' do
       subject { instance.lib_dir }
 

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

@@ -179,6 +179,8 @@ module Vedeu
             )
           end
         end
+
+        it { instance.must_respond_to(:bottom) }
       end
 
       describe '#hide_bottom!' do
@@ -198,6 +200,8 @@ module Vedeu
 
         it { subject.must_be_instance_of(TrueClass) }
 
+        it { instance.must_respond_to(:left) }
+
         context 'when false' do
           let(:boolean) { false }
 
@@ -208,7 +212,7 @@ module Vedeu
           subject {
             Vedeu.interface 'borders' do
               border do
-                show_left ''
+                show_left!
               end
               geometry do
                 height 3
@@ -249,6 +253,8 @@ module Vedeu
 
         it { subject.must_be_instance_of(TrueClass) }
 
+        it { instance.must_respond_to(:right) }
+
         context 'when false' do
           let(:boolean) { false }
 
@@ -259,7 +265,7 @@ module Vedeu
           subject {
             Vedeu.interface 'borders' do
               border do
-                show_right ''
+                show_right!
               end
               geometry do
                 height 3
@@ -300,6 +306,8 @@ module Vedeu
 
         it { subject.must_be_instance_of(TrueClass) }
 
+        it { instance.must_respond_to(:top) }
+
         context 'when false' do
           let(:boolean) { false }
 

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

@@ -39,6 +39,12 @@ module Vedeu
         end
       end
 
+      describe '#border!' do
+        subject { instance.border! }
+
+        it { subject.must_be_instance_of(Vedeu::Border) }
+      end
+
       # describe '#define' do
       #   interface = Interface.new({ name: 'widget' })
 

data/test/lib/vedeu/dsl/line_test.rb

@@ -40,6 +40,23 @@ module Vedeu
 
         it { subject.must_be_instance_of(Vedeu::Lines) }
         it { subject.first.must_be_instance_of(Vedeu::Line) }
+
+        context 'when the block is given' do
+        end
+
+        context 'when the block is not given' do
+          context 'when the value is given' do
+            subject { instance.line(value) }
+          end
+
+          context 'when the value is not given' do
+            let(:value) {}
+
+            subject { instance.line(value) }
+
+            it { proc { subject }.must_raise(InvalidSyntax) }
+          end
+        end
       end
 
       describe '#streams' do
@@ -57,6 +74,8 @@ module Vedeu
         context 'when the block is not given' do
           it { proc { instance.streams }.must_raise(InvalidSyntax) }
         end
+
+        it { instance.must_respond_to(:stream) }
       end
 
     end # Line

data/test/lib/vedeu/dsl/shared/colour_test.rb

@@ -24,19 +24,8 @@ module Vedeu
           )
         end
 
-        context 'alias method #bg' do
-          subject { dsl_klass.bg(background) }
-
-          it { subject.attributes.
-                must_equal({ background: '#00ff00', foreground: '' }) }
-        end
-
-        context 'alias method #bgcolor' do
-          subject { dsl_klass.bgcolor(background) }
-
-          it { subject.attributes.
-                must_equal({ background: '#00ff00', foreground: '' }) }
-        end
+        it { dsl_klass.must_respond_to(:bg) }
+        it { dsl_klass.must_respond_to(:bgcolor) }
       end
 
       describe '#foreground' do
@@ -50,19 +39,8 @@ module Vedeu
           )
         end
 
-        context 'alias method #fg' do
-          subject { dsl_klass.fg(foreground) }
-
-          it { subject.attributes.
-                must_equal({ background: '', foreground: '#ff00ff' }) }
-        end
-
-        context 'alias method #fgcolor' do
-          subject { dsl_klass.fgcolor(foreground) }
-
-          it { subject.attributes.
-                must_equal({ background: '', foreground: '#ff00ff' }) }
-        end
+        it { dsl_klass.must_respond_to(:fg) }
+        it { dsl_klass.must_respond_to(:fgcolor) }
       end
 
       describe '#colour' do