vedeu 0.0.31 → 0.0.32

data/lib/vedeu/support/terminal.rb

@@ -31,6 +31,10 @@ module Vedeu
       stream
     end
 
+    def centre
+      [(height / 2), (width / 2)]
+    end
+
     def width
       size.last
     end

data/test/example_app/lib/app.rb

@@ -1,5 +1,6 @@
 require 'rubygems'
 require 'bundler/setup'
+require 'pry'
 require 'vedeu'
 
 module Example
@@ -35,16 +36,34 @@ module Example
   class App
     include Vedeu
 
+    def self.example_position
+      @_position = Vedeu::Coordinate.new({ width: 40, height: 5, centered: true }).position
+    end
+
+    def self.command_position
+      {
+        y:        example_position[:bottom],
+        x:        example_position[:x],
+        height:   1,
+        width:    40,
+        centered: true
+      }
+    end
+
     interface 'example',  {
-                            y: 1,  x: 1,  width: 80, height: 5,
-                            colour: { background: '#ff0000', foreground: '#000000' },
+                            colour: {
+                              background: '#ff0000',
+                              foreground: '#000000'
+                            },
                             cursor: false
-                          }
+                          }.merge(example_position)
     interface 'command',  {
-                            y: 6, x: 1, width: 80, height: 1,
-                            colour: { background: '#4040cc', foreground: '#aadd00' },
+                            colour: {
+                              background: '#4040cc',
+                              foreground: '#aadd00'
+                            },
                             cursor: true
-                          }
+                          }.merge(command_position)
     command 'time', {
                       entity:   ExampleCommand,
                       keyword: 'time',

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

@@ -0,0 +1,50 @@
+require_relative '../../../test_helper'
+require_relative '../../../../lib/vedeu/models/collection'
+
+module Vedeu
+  class TestClass
+    include Collection
+
+    def initialize(*args); end
+  end
+
+  describe Collection do
+    describe '#coercer' do
+      it 'returns an empty collection when nil or empty' do
+        Collection.coercer(nil, TestClass, :key).must_equal([])
+      end
+
+      it 'returns an empty collection when nil or empty' do
+        Collection.coercer('',  TestClass, :key).must_equal([])
+      end
+
+      it 'returns an empty collection when nil or empty' do
+        Collection.coercer([],  TestClass, :key).must_equal([])
+      end
+
+      it 'returns an empty collection when nil or empty' do
+        Collection.coercer({},  TestClass, :key).must_equal([])
+      end
+
+      it 'returns a single model in a collection when a String' do
+        Collection.coercer('test', TestClass, :key).size.must_equal(1)
+      end
+
+      it 'returns a collection of models when a single hash' do
+        Collection.coercer({ :test1 => 'test1' }, TestClass, :key)
+          .size.must_equal(1)
+      end
+
+      it 'returns a collection of models when multiple hashes' do
+        Collection.coercer([
+          { :test1 => 'test1' }, { :test2 => 'test2' }
+        ], TestClass, :key).size.must_equal(2)
+      end
+
+      it 'returns a collection of models when a single array' do
+        Collection.coercer([{ :test3 => 'test3' }], TestClass, :key)
+          .size.must_equal(1)
+      end
+    end
+  end
+end

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

@@ -3,12 +3,60 @@ require_relative '../../../../lib/vedeu/models/colour'
 
 module Vedeu
   describe Colour do
+    describe '#background' do
+      it 'returns an escape sequence' do
+        Colour.new({
+          background: '#000000'
+        }).background.must_equal("\e[48;5;16m")
+      end
+
+      it 'returns an empty string if the value is empty' do
+        Colour.new.background.must_equal('')
+      end
+    end
+
+    describe '#foreground' do
+      it 'returns an escape sequence' do
+        Colour.new({
+          foreground: '#ff0000'
+        }).foreground.must_equal("\e[38;5;196m")
+      end
+
+      it 'returns an empty string if the value is empty' do
+        Colour.new.foreground.must_equal('')
+      end
+    end
+
+    describe '#css_background' do
+      it 'returns an escape sequence' do
+        Colour.new({
+          background: '#000000'
+        }).css_background.must_equal('#000000')
+      end
+
+      it 'returns an empty string if the value is nil' do
+        Colour.new.css_background.must_equal('')
+      end
+    end
+
+    describe '#css_foreground' do
+      it 'returns an escape sequence' do
+        Colour.new({
+          foreground: '#ff0000'
+        }).css_foreground.must_equal('#ff0000')
+      end
+
+      it 'returns an empty string if the value is nil' do
+        Colour.new.css_foreground.must_equal('')
+      end
+    end
+
     describe '#to_json' do
       it 'returns the model as JSON' do
         Colour.new({
           foreground: '#ff0000',
           background: '#000000'
-        }).to_json.must_equal("{\"foreground\":\"\\u001b[38;5;196m\",\"background\":\"\\u001b[48;5;16m\"}")
+        }).to_json.must_equal("{\"foreground\":\"#ff0000\",\"background\":\"#000000\"}")
       end
     end
 
@@ -36,5 +84,14 @@ module Vedeu
         Colour.new.to_s.must_equal('')
       end
     end
+
+    describe '#as_hash' do
+      it 'returns the model as a Hash' do
+        Colour.new({
+          foreground: '#ff0000',
+          background: '#000000'
+        }).as_hash.must_equal({ foreground: '#ff0000', background: '#000000' })
+      end
+    end
   end
 end

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

@@ -9,7 +9,8 @@ module Vedeu
     end
 
     it 'has an entity attribute' do
-      Command.new({ entity: DummyCommand }).entity.must_equal(DummyCommand)
+      Command.new({ entity: DummyCommand }).entity
+        .must_equal(DummyCommand)
     end
 
     it 'has a keypress attribute' do

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

@@ -13,12 +13,13 @@ module Vedeu
         Composition.new.interfaces.must_equal([])
       end
 
-      it 'returns a collection of Interface objects when there is a single interface' do
+      it 'returns a collection when there is a single interface' do
         skip
-        Composition.new({ name: 'dummy' }).interfaces.first.must_be_instance_of(Interface)
+        Composition.new({ name: 'dummy' }).interfaces.first
+          .must_be_instance_of(Interface)
       end
 
-      it 'returns a collection of Interface objects when there are multiple interfaces' do
+      it 'returns a collection when there are multiple interfaces' do
         Composition.new({ interfaces: [
           { name: 'dumb' },
           { name: 'dumber' }

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

@@ -8,7 +8,9 @@ module Vedeu
     end
 
     it 'has a colour attribute' do
-      Line.new(colour: { foreground: '#ff0000', background: '#000000' }).colour.must_be_instance_of(Colour)
+      Line.new({
+        colour: { foreground: '#ff0000', background: '#000000' }
+      }).colour.must_be_instance_of(Colour)
     end
 
     it 'has a model attribute' do

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

@@ -4,7 +4,9 @@ require_relative '../../../../lib/vedeu/models/stream'
 module Vedeu
   describe Stream do
     it 'has a colour attribute' do
-      Stream.new({ colour: { foreground: '#ff0000', background: '#000000' } }).colour.must_be_instance_of(Colour)
+      Stream.new({
+        colour: { foreground: '#ff0000', background: '#000000' }
+      }).colour.must_be_instance_of(Colour)
     end
 
     it 'has a text attribute' do
@@ -12,7 +14,8 @@ module Vedeu
     end
 
     it 'has a style attribute' do
-      Stream.new({ style: 'normal' }).style.must_equal("\e[24m\e[21m\e[27m")
+      Stream.new({ style: 'normal' }).style
+        .must_equal("\e[24m\e[21m\e[27m")
     end
 
     describe '#to_s' do
@@ -31,7 +34,7 @@ module Vedeu
           style:  'normal',
           colour: { foreground: '#ff0000', background: '#000000' },
           text:   'Some text'
-        }).to_json.must_equal("{\"colour\":{\"foreground\":\"\\u001b[38;5;196m\",\"background\":\"\\u001b[48;5;16m\"},\"style\":\"\\u001b[24m\\u001b[21m\\u001b[27m\",\"text\":\"Some text\"}")
+        }).to_json.must_equal("{\"colour\":{\"foreground\":\"#ff0000\",\"background\":\"#000000\"},\"style\":\"\\u001b[24m\\u001b[21m\\u001b[27m\",\"text\":\"Some text\"}")
       end
     end
   end

data/test/lib/vedeu/output/text_adaptor_test.rb

@@ -4,7 +4,7 @@ require_relative '../../../../lib/vedeu/output/text_adaptor'
 module Vedeu
   describe TextAdaptor do
     describe '.adapt' do
-      it 'returns an empty collection when processing an empty string' do
+      it 'returns an empty collection for an empty string' do
         TextAdaptor.adapt('').must_be_empty
       end
 

data/test/lib/vedeu/repository/command_repository_test.rb

@@ -34,7 +34,8 @@ module Vedeu
       end
 
       it 'returns FalseClass when no command was found' do
-        CommandRepository.by_input('not_found').must_be_instance_of(FalseClass)
+        CommandRepository.by_input('not_found')
+          .must_be_instance_of(FalseClass)
       end
 
       it 'returns FalseClass when there is no input' do

data/test/lib/vedeu/repository/interface_repository_test.rb

@@ -20,7 +20,8 @@ module Vedeu
           width: 15,
           height: 2
         })
-        InterfaceRepository.find('dummy').must_be_instance_of(Interface)
+        InterfaceRepository.find('dummy')
+          .must_be_instance_of(Interface)
       end
 
       it 'raises an exception when the interface does not exist' do

data/test/lib/vedeu/repository/repository_test.rb

@@ -39,7 +39,8 @@ module Vedeu
     describe '#query' do
       it 'returns a Dummy' do
         dummy = DummyRepository.create(Dummy.new)
-        DummyRepository.query(Dummy, :name, 'dummy').must_be_instance_of(Dummy)
+        DummyRepository.query(Dummy, :name, 'dummy')
+          .must_be_instance_of(Dummy)
       end
     end
 

data/test/lib/vedeu/repository/storage_test.rb

@@ -6,13 +6,15 @@ module Vedeu
   describe Storage do
     describe '#create' do
       it 'returns the stored record' do
-        Storage.new.create(DummyCommand.new).must_be_instance_of(DummyCommand)
+        Storage.new.create(DummyCommand.new)
+          .must_be_instance_of(DummyCommand)
       end
     end
 
     describe '#delete' do
       it 'returns a NilClass' do
-        Storage.new.delete(DummyCommand.new).must_be_instance_of(NilClass)
+        Storage.new.delete(DummyCommand.new)
+          .must_be_instance_of(NilClass)
       end
     end
 
@@ -36,7 +38,8 @@ module Vedeu
 
     describe '#query' do
       it 'returns a FalseClass when the item cannot be found' do
-        Storage.new.query(nil, nil, nil).must_be_instance_of(FalseClass)
+        Storage.new.query(nil, nil, nil)
+          .must_be_instance_of(FalseClass)
       end
     end
   end

data/test/lib/vedeu/support/coordinate_test.rb

@@ -0,0 +1,363 @@
+require_relative '../../../test_helper'
+require_relative '../../../../lib/vedeu/support/coordinate'
+
+module Vedeu
+  describe Coordinate do
+    it 'raises an exception when the height attribute is not set' do
+      proc { Coordinate.new({ width: 18 }) }.must_raise(KeyError)
+    end
+
+    it 'raises an exception when the width attribute is not set' do
+      proc { Coordinate.new({ height: 6 }) }.must_raise(KeyError)
+    end
+
+    describe '#terminal_height' do
+      it 'raises an exception if the value is less than 1' do
+        coordinate = Coordinate.new({ height: 6, width: 18, terminal_height: -2 })
+        proc { coordinate.terminal_height }.must_raise(OutOfBoundsError)
+      end
+
+      it 'raises an exception if the value is greater than the terminal height' do
+        console = IO.console
+        console.stub :winsize, [25, 80] do
+          coordinate = Coordinate.new({ height: 6, width: 18, terminal_height: 30 })
+          proc { coordinate.terminal_height }.must_raise(OutOfBoundsError)
+        end
+      end
+
+      it 'returns the value of terminal_height' do
+        console = IO.console
+        console.stub :winsize, [25, 80] do
+          Coordinate.new({ height: 6, width: 18, terminal_height: 20 })
+            .terminal_height.must_equal(20)
+        end
+      end
+
+      it 'returns the default height if not set' do
+        console = IO.console
+        console.stub :winsize, [25, 80] do
+          Coordinate.new({ height: 6, width: 18 })
+            .instance_variable_get('@terminal_height').must_equal(25)
+        end
+      end
+    end
+
+    describe '#height' do
+      it 'raises an exception if the value is less than 1' do
+        coordinate = Coordinate.new({ height: -6, width: 18 })
+        proc { coordinate.height }.must_raise(OutOfBoundsError)
+      end
+
+      it 'raises an exception if the value is greater than the terminal height' do
+        console = IO.console
+        console.stub :winsize, [25, 80] do
+          coordinate = Coordinate.new({ height: 30, width: 18 })
+          proc { coordinate.height }.must_raise(OutOfBoundsError)
+        end
+      end
+
+      it 'returns the value of height' do
+        Coordinate.new({ height: 6, width: 18 }).height.must_equal(6)
+      end
+    end
+
+    describe '#y' do
+      it 'raises an exception if the value is less than 1' do
+        coordinate = Coordinate.new({ height: 6, width: 18, y: -2 })
+        proc { coordinate.y }.must_raise(OutOfBoundsError)
+      end
+
+      it 'raises an exception if the value is greater than the terminal height' do
+        console = IO.console
+        console.stub :winsize, [25, 80] do
+          coordinate = Coordinate.new({ height: 6, width: 18, y: 30 })
+          proc { coordinate.y }.must_raise(OutOfBoundsError)
+        end
+      end
+
+      it 'returns the value of y' do
+        Coordinate.new({ height: 6, width: 18, y: 6 }).y.must_equal(6)
+      end
+
+      it 'returns 1 if not set' do
+        Coordinate.new({ height: 6, width: 18 }).y.must_equal(1)
+      end
+    end
+
+    describe '#terminal_width' do
+      it 'raises an exception if the value is less than 1' do
+        coordinate = Coordinate.new({ height: 6, width: 18, terminal_width: -2 })
+        proc { coordinate.terminal_width }.must_raise(OutOfBoundsError)
+      end
+
+      it 'raises an exception if the value is greater than the terminal width' do
+        console = IO.console
+        console.stub :winsize, [25, 80] do
+          coordinate = Coordinate.new({ height: 6, width: 18, terminal_width: 85 })
+          proc { coordinate.terminal_width }.must_raise(OutOfBoundsError)
+        end
+      end
+
+      it 'returns the value of terminal_width' do
+        console = IO.console
+        console.stub :winsize, [25, 80] do
+          Coordinate.new({ height: 6, width: 18, terminal_width: 40 })
+            .terminal_width.must_equal(40)
+        end
+      end
+
+      it 'returns the default width if not set' do
+        console = IO.console
+        console.stub :winsize, [25, 80] do
+          Coordinate.new({ height: 6, width: 18 })
+            .terminal_width.must_equal(80)
+        end
+      end
+    end
+
+    describe '#width' do
+      it 'raises an exception if the value is less than 1' do
+        coordinate = Coordinate.new({ height: 6, width: -18 })
+        proc { coordinate.width }.must_raise(OutOfBoundsError)
+      end
+
+      it 'raises an exception if the value is greater than the terminal width' do
+        console = IO.console
+        console.stub :winsize, [25, 80] do
+          coordinate = Coordinate.new({ height: 6, width: 85 })
+          proc { coordinate.width }.must_raise(OutOfBoundsError)
+        end
+      end
+
+      it 'returns the value of width' do
+        Coordinate.new({ height: 6, width: 18, x: 6 }).width
+          .must_equal(18)
+      end
+    end
+
+    describe '#x' do
+      it 'raises an exception if the value is less than 1' do
+        coordinate = Coordinate.new({ height: 6, width: 18, x: -2 })
+        proc { coordinate.x }.must_raise(OutOfBoundsError)
+      end
+
+      it 'raises an exception if the value is greater than the terminal width' do
+        console = IO.console
+        console.stub :winsize, [25, 80] do
+          coordinate = Coordinate.new({ height: 6, width: 18, x: 85 })
+          proc { coordinate.x }.must_raise(OutOfBoundsError)
+        end
+      end
+
+      it 'returns the value of x' do
+        Coordinate.new({ height: 6, width: 18, x: 6 }).x.must_equal(6)
+      end
+
+      it 'returns 1 if not set' do
+        Coordinate.new({ height: 6, width: 18 }).x.must_equal(1)
+      end
+    end
+
+    describe '#centered' do
+      it 'has a centred attribute' do
+        Coordinate.new({ height: 6, width: 18, centred: false })
+          .centred.must_equal(false)
+      end
+
+      it 'sets the centred attribute to true if not set' do
+        Coordinate.new({ height: 6, width: 18 })
+          .centred.must_equal(true)
+      end
+    end
+
+    describe '#centre' do
+      it 'returns a tuple containing the default centre coordinates' do
+        console = IO.console
+        console.stub :winsize, [25, 80] do
+          coordinate = Coordinate.new({ height: 6, width: 18 })
+          coordinate.centre.must_equal([12, 40])
+        end
+      end
+
+      it 'returns a tuple containing the centre coordinates' do
+        coordinate = Coordinate.new({ height: 6, width: 18, terminal_height: 12, terminal_width: 40 })
+        coordinate.centre.must_equal([6, 20])
+      end
+
+      it 'returns a tuple containing the centre coordinates when an' \
+         ' alternative terminal height is set' do
+        console = IO.console
+        console.stub :winsize, [25, 80] do
+          coordinate = Coordinate.new({ height: 6, width: 18, terminal_height: 12 })
+          coordinate.centre.must_equal([6, 40])
+        end
+      end
+
+      it 'returns a tuple containing the centre coordinates when an' \
+         ' alternative terminal width is set' do
+        console = IO.console
+        console.stub :winsize, [25, 80] do
+          coordinate = Coordinate.new({ height: 6, width: 18, terminal_width: 40 })
+          coordinate.centre.must_equal([12, 20])
+        end
+      end
+    end
+
+    describe '#top' do
+      it 'centred is true and terminal height is set' do
+        coordinate = Coordinate.new({ height: 6, width: 18, terminal_height: 12 })
+        coordinate.top.must_equal(3)
+      end
+
+      it 'centred is true and with default terminal height' do
+        console = IO.console
+        console.stub :winsize, [25, 80] do
+          coordinate = Coordinate.new({ height: 6, width: 18 })
+          coordinate.top.must_equal(9)
+        end
+      end
+
+      it 'centred is false' do
+        coordinate = Coordinate.new({ height: 6, width: 18, centred: false })
+        coordinate.top.must_equal(1)
+      end
+
+      it 'centred is false and y is set' do
+        coordinate = Coordinate.new({ height: 6, width: 18, y: 4, centred: false })
+        coordinate.top.must_equal(4)
+      end
+    end
+
+    describe '#left' do
+      it 'centred is true and terminal width is set' do
+        coordinate = Coordinate.new({ height: 6, width: 18, terminal_width: 40 })
+        coordinate.left.must_equal(11)
+      end
+
+      it 'centred is true and with default terminal width' do
+        console = IO.console
+        console.stub :winsize, [25, 80] do
+          coordinate = Coordinate.new({ height: 6, width: 18 })
+          coordinate.left.must_equal(31)
+        end
+      end
+
+      it 'centred is false' do
+        coordinate = Coordinate.new({ height: 6, width: 18, centred: false })
+        coordinate.left.must_equal(1)
+      end
+
+      it 'centred is false and x is set' do
+        coordinate = Coordinate.new({ height: 6, width: 18, x: 5, centred: false })
+        coordinate.left.must_equal(5)
+      end
+    end
+
+    describe '#bottom' do
+      it 'centred is true and terminal height is set' do
+        coordinate = Coordinate.new({ height: 6, width: 18, terminal_height: 12 })
+        coordinate.bottom.must_equal(9)
+      end
+
+      it 'centred is true and with default terminal height' do
+        console = IO.console
+        console.stub :winsize, [25, 80] do
+          coordinate = Coordinate.new({ height: 6, width: 18 })
+          coordinate.bottom.must_equal(15)
+        end
+      end
+
+      it 'centred is false' do
+        coordinate = Coordinate.new({ height: 6, width: 18, centred: false })
+        coordinate.bottom.must_equal(7)
+      end
+
+      it 'centred is false and y is set' do
+        coordinate = Coordinate.new({ height: 6, width: 18, y: 5, centred: false })
+        coordinate.bottom.must_equal(11)
+      end
+    end
+
+    describe '#right' do
+      it 'centred is true and terminal width is set' do
+        coordinate = Coordinate.new({ height: 6, width: 18, terminal_width: 40 })
+        coordinate.right.must_equal(29)
+      end
+
+      it 'centred is true and with default terminal width' do
+        console = IO.console
+        console.stub :winsize, [25, 80] do
+          coordinate = Coordinate.new({ height: 6, width: 18 })
+          coordinate.right.must_equal(49)
+        end
+      end
+
+      it 'centred is false' do
+        coordinate = Coordinate.new({ height: 6, width: 18, centred: false })
+        coordinate.right.must_equal(19)
+      end
+
+      it 'centred is false and x is set' do
+        coordinate = Coordinate.new({ height: 6, width: 18, x: 5, centred: false })
+        coordinate.right.must_equal(23)
+      end
+    end
+
+    describe '#position' do
+      it 'centred is true' do
+        console = IO.console
+        console.stub :winsize, [25, 80] do
+          coordinate = Coordinate.new({ height: 6, width: 18 })
+          coordinate.position.must_equal({
+            y:       9,
+            x:       31,
+            height:  6,
+            width:   18,
+            centred: true,
+            bottom:  15,
+            right:   49,
+          })
+        end
+      end
+
+      it 'centred is false and x is set' do
+        coordinate = Coordinate.new({ height: 6, width: 18, x: 7, centred: false })
+        coordinate.position.must_equal({
+          y:       1,
+          x:       7,
+          height:  6,
+          width:   18,
+          centred: false,
+          bottom:  7,
+          right:   25,
+        })
+      end
+
+      it 'centred is false and y is set' do
+        coordinate = Coordinate.new({ height: 6, width: 18, y: 5, centred: false })
+        coordinate.position.must_equal({
+          y:       5,
+          x:       1,
+          height:  6,
+          width:   18,
+          centred: false,
+          bottom:  11,
+          right:   19,
+        })
+      end
+
+      it 'centred is false' do
+        coordinate = Coordinate.new({ height: 6, width: 18, centred: false })
+        coordinate.position.must_equal({
+          y:       1,
+          x:       1,
+          height:  6,
+          width:   18,
+          centred: false,
+          bottom:  7,
+          right:   19,
+        })
+      end
+    end
+  end
+end