vedeu 0.4.3 → 0.4.4

data/lib/vedeu/models/view/lines.rb

@@ -3,6 +3,7 @@ require 'vedeu/models/collection'
 module Vedeu
 
   # A collection of {Vedeu::Line} instances.
+  #
   class Lines < Vedeu::Model::Collection
   end # Lines
 

data/lib/vedeu/output/all.rb

@@ -1,3 +1,5 @@
+require 'vedeu/output/esc'
+
 require 'vedeu/output/translator'
 require 'vedeu/output/background'
 require 'vedeu/output/foreground'
@@ -8,17 +10,20 @@ require 'vedeu/output/compositor'
 
 require 'vedeu/output/presentation'
 require 'vedeu/output/style'
+require 'vedeu/output/text'
 require 'vedeu/output/position_index'
 require 'vedeu/output/index_position'
 require 'vedeu/output/virtual_buffer'
 require 'vedeu/output/html_char'
 require 'vedeu/output/html_renderer'
+require 'vedeu/output/refresh'
+
 require 'vedeu/output/renderer'
 require 'vedeu/output/output'
+
 require 'vedeu/output/viewport'
 require 'vedeu/output/virtual_terminal'
 require 'vedeu/output/wordwrap'
-require 'vedeu/output/writer'
 
 module Vedeu
 end # Vedeu

data/lib/vedeu/output/border.rb

@@ -1,4 +1,4 @@
-require 'vedeu/dsl/components/border'
+require 'vedeu/dsl/components/all'
 
 module Vedeu
 

data/lib/vedeu/output/foreground.rb

@@ -1,6 +1,6 @@
 require 'vedeu/configuration/configuration'
 require 'vedeu/output/translator'
-require 'vedeu/support/esc'
+require 'vedeu/output/esc'
 
 module Vedeu
 

data/lib/vedeu/output/html_char.rb

@@ -2,6 +2,8 @@ require 'vedeu/support/common'
 
 module Vedeu
 
+  # Represents a {Vedeu::Char} as a HTML table cell.
+  #
   class HTMLChar
 
     include Vedeu::Common

data/lib/vedeu/output/html_renderer.rb

@@ -1,5 +1,7 @@
 module Vedeu
 
+  # Renders a {Vedeu::VirtualBuffer} or {Vedeu::Output} as a HTML table.
+  #
   class HTMLRenderer
 
     # @param output [Array<Array<Vedeu::Char>>]
@@ -25,6 +27,9 @@ module Vedeu
       Template.parse(self, template)
     end
 
+    # Writes the parsed template to a file (at the given path) and returns the
+    # contents.
+    #
     # @param path [String]
     # @return [String]
     def to_file(path = file_path)
@@ -53,6 +58,7 @@ module Vedeu
 
     attr_reader :output
 
+    # @return [String]
     def template
       File.dirname(__FILE__) + '/templates/html_renderer.vedeu'
     end

data/lib/vedeu/output/output.rb

@@ -4,6 +4,14 @@ module Vedeu
   #
   class Output
 
+    # Clears the area defined by the interface.
+    #
+    # @return [Array|String]
+    # @see #initialize
+    def self.clear(interface)
+      new(interface).clear
+    end
+
     # Writes content (the provided interface object with associated lines,
     # streams, colours and styles) to the area defined by the interface.
     #
@@ -21,6 +29,19 @@ module Vedeu
       @interface = interface
     end
 
+    # Clear the view and send to the terminal.
+    #
+    # @return [Array]
+    def clear
+      if Vedeu::Configuration.drb?
+        Vedeu.trigger(:_drb_store_output_, virtual_clear)
+
+        HTMLRenderer.to_file(VirtualBuffer.retrieve)
+      end
+
+      Terminal.output(Renderer.render(virtual_clear))
+    end
+
     # Send the view to the terminal.
     #
     # @return [Array]

data/lib/vedeu/{support → output}/refresh.rb

@@ -15,7 +15,7 @@ module Vedeu
 
     # Refresh the interface which is currently focussed.
     #
-    # @return [|NilClass]
+    # @return [Array|ModelNotFound|NilClass]
     def by_focus
       by_name(Vedeu.focus) if Vedeu.focus
     end

data/lib/vedeu/output/renderer.rb

@@ -1,5 +1,8 @@
 module Vedeu
 
+  # Converts a grid of {Vedeu::Char} objects into a stream of escape sequences
+  # and content suitable for a terminal.
+  #
   class Renderer
 
     # @param output [Array<Array<Vedeu::Char>>]

data/lib/vedeu/output/virtual_terminal.rb

@@ -1,5 +1,7 @@
 module Vedeu
 
+  # Represents a {Vedeu::Terminal} view.
+  #
   class VirtualTerminal
 
     attr_accessor :renderer

data/lib/vedeu/support/all.rb

@@ -1,17 +1,10 @@
 require 'vedeu/support/coercions'
 require 'vedeu/support/common'
-require 'vedeu/support/console'
-require 'vedeu/support/esc'
-require 'vedeu/support/log'
-require 'vedeu/support/read'
-require 'vedeu/support/refresh'
 require 'vedeu/support/sentence'
 require 'vedeu/support/template'
 require 'vedeu/support/terminal'
-require 'vedeu/support/text'
 require 'vedeu/support/trace'
 require 'vedeu/support/visible'
-require 'vedeu/support/write'
 
 module Vedeu
 end # Vedeu

data/lib/vedeu/support/coercions.rb

@@ -10,13 +10,16 @@ module Vedeu
 
     # Produces new objects of the correct class from the value, ignores objects
     # that have already been coerced.
+    #
+    # @param value [Object|NilClass]
+    # @return [Object]
     def coerce(value)
-      if value.is_a?(self)
-        value
-
-      elsif value.nil?
+      if value.nil?
         new
 
+      elsif value.is_a?(self)
+        value
+
       else
         new(value)
 

data/lib/vedeu/support/terminal.rb

@@ -1,5 +1,5 @@
 require 'vedeu/configuration/configuration'
-require 'vedeu/support/esc'
+require 'vedeu/output/esc'
 require 'vedeu/support/log'
 
 module Vedeu

data/lib/vedeu/support/trace.rb

@@ -1,5 +1,5 @@
 require 'vedeu/configuration/configuration'
-require 'vedeu/support/esc'
+require 'vedeu/output/esc'
 require 'vedeu/support/log'
 
 module Vedeu

data/lib/vedeu/support/visible.rb

@@ -1,4 +1,4 @@
-require 'vedeu/support/esc'
+require 'vedeu/output/esc'
 
 module Vedeu
 

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

@@ -6,7 +6,14 @@ module Vedeu
 
     let(:described) { Vedeu::MoveCursor }
     let(:instance)  { described.new(cursor, interface, dy, dx) }
-    let(:cursor)    { Cursor.new({ name: 'MoveCursor', ox: ox, oy: oy, state: :show, x: x, y: y }) }
+    let(:cursor)    {
+      Cursor.new({ name: 'MoveCursor',
+                   ox:    ox,
+                   oy:    oy,
+                   state: :show,
+                   x:     x,
+                   y:     y })
+    }
     let(:ox)        { 0 }
     let(:oy)        { 0 }
     let(:x)         { 1 }
@@ -56,6 +63,58 @@ module Vedeu
       it { instance.instance_variable_get('@dx').must_equal(dx) }
     end
 
+    describe '.by_name' do
+      let(:direction) { :down }
+      let(:_name)     { 'manganese' }
+
+      before do
+        Vedeu.interfaces.reset
+        Vedeu.cursors.reset
+
+        interface_with_border
+        Vedeu::Cursor.new({ name: 'manganese', oy: 2, ox: 3, x: 8, y: 7 }).store
+      end
+
+      subject { MoveCursor.by_name(direction, _name) }
+
+      it { subject.must_be_instance_of(Vedeu::Cursor) }
+
+      context 'when the name is not specified' do
+        let(:_name) {}
+
+      end
+
+      context 'when the name is specified' do
+        let(:_name) { 'manganese' }
+
+        context 'and the direction is down' do
+          let(:direction) { :down }
+
+          it { subject.oy.must_equal(3) }
+        end
+        context 'and the direction is left' do
+          let(:direction) { :left }
+
+          it { subject.ox.must_equal(2) }
+        end
+        context 'and the direction is right' do
+          let(:direction) { :right }
+
+          it { subject.ox.must_equal(4) }
+        end
+        context 'and the direction is up' do
+          let(:direction) { :up }
+
+          it { subject.oy.must_equal(1) }
+        end
+
+        context 'but the interface does not exist' do
+          before { Vedeu.interfaces.stubs(:find).with(_name).returns(nil) }
+
+        end
+      end
+    end
+
     describe '.down' do
       subject { MoveCursor.down(cursor, interface) }
 

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

@@ -10,6 +10,13 @@ module Vedeu
       let(:instance)  { described.new(uri) }
       let(:uri)       { 'druby://localhost:21420' }
 
+      before { $stdout.stubs(:puts) }
+
+      describe 'alias methods' do
+        it { instance.must_respond_to(:read) }
+        it { instance.must_respond_to(:write) }
+      end
+
       describe '#initialize' do
         it { instance.must_be_instance_of(described) }
         it { instance.instance_variable_get('@uri').must_equal('druby://localhost:21420') }
@@ -17,6 +24,10 @@ module Vedeu
 
       describe '.connect' do
         subject { described.connect(uri) }
+
+        context 'when the DRb server is not available or not enabled' do
+          it { subject.must_equal(:drb_connection_error) }
+        end
       end
 
       describe '#input' do
@@ -24,17 +35,25 @@ module Vedeu
 
         subject { instance.input(data) }
 
-        it { instance.must_respond_to(:read) }
+        context 'when the DRb server is not available or not enabled' do
+          it { subject.must_equal(:drb_connection_error) }
+        end
       end
 
       describe '#output' do
         subject { instance.output }
 
-        it { instance.must_respond_to(:write) }
+        context 'when the DRb server is not available or not enabled' do
+          it { subject.must_equal(:drb_connection_error) }
+        end
       end
 
       describe '#shutdown' do
         subject { instance.shutdown }
+
+        context 'when the DRb server is not available or not enabled' do
+          it { subject.must_equal(:drb_connection_error) }
+        end
       end
 
     end # Client

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

@@ -0,0 +1,52 @@
+require 'test_helper'
+
+module Vedeu
+
+  module DSL
+
+    describe Group do
+
+      let(:described)  { Vedeu::DSL::Group }
+      let(:instance)   { described.new(model, client) }
+      let(:model)      { Vedeu::Group.new }
+      let(:client)     {}
+      let(:group_name) { 'main_screen' }
+
+      describe '#initialize' do
+        it { instance.must_be_instance_of(Vedeu::DSL::Group) }
+        it { instance.instance_variable_get('@model').must_equal(model) }
+        it { instance.instance_variable_get('@client').must_equal(client) }
+      end
+
+      describe '.group' do
+        context 'when the block is given' do
+          subject {
+            described.group(group_name) do
+              # ...
+            end
+          }
+
+        end
+
+        context 'when the block is not given' do
+          subject { described.group(group_name) }
+
+          it { proc { subject }.must_raise(InvalidSyntax) }
+        end
+      end
+
+      describe '#add' do
+        subject {
+          described.group(group_name) do
+            add('editor_interface')
+          end
+        }
+
+        it { subject.must_be_instance_of(Vedeu::Group) }
+      end
+
+    end # Group
+
+  end # DSL
+
+end # Vedeu

data/test/lib/vedeu/models/group_test.rb

@@ -4,13 +4,20 @@ module Vedeu
 
   describe Group do
 
-    let(:described) { Vedeu::Group }
-    let(:instance)  { described.new(_name, members) }
-    let(:_name)     { 'organics' }
-    let(:members)   { ['carbon', 'nitrogen', 'oxygen'] }
+    let(:described)  { Vedeu::Group }
+    let(:instance)   { described.new(attributes) }
+    let(:attributes) {
+      {
+        name:    _name,
+        members: members,
+      }
+    }
+    let(:_name)      { 'organics' }
+    let(:members)    { ['carbon', 'nitrogen', 'oxygen'] }
 
     describe '#initialize' do
       it { instance.must_be_instance_of(Group) }
+      it { instance.instance_variable_get('@attributes').must_be_instance_of(Hash) }
       it { instance.instance_variable_get('@members').must_equal(members) }
       it { instance.instance_variable_get('@name').must_equal(_name) }
       it { instance.instance_variable_get('@repository').must_equal(Vedeu.groups) }

data/test/test_helper.rb

@@ -1,4 +1,5 @@
 require 'simplecov'
+require 'simplecov-console'
 require 'pry'
 require 'minitest/autorun'
 require 'minitest/pride' unless ENV['NO_COLOR']
@@ -7,6 +8,7 @@ require 'minitest/hell'
 # GC.disable # uncomment to remove ~20ms from test run speed
 
 SimpleCov.start do
+  formatter    SimpleCov::Formatter::Console
   command_name 'MiniTest::Spec'
   add_filter '/test/'
   add_group  'api',           'vedeu/api'