vedeu 0.2.1 → 0.2.2

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

@@ -6,6 +6,12 @@ module Vedeu
 
     before { Event.stubs(:new).returns(event) }
 
+    describe '.configure' do
+      it 'raises an exception unless a block was given' do
+        proc { Vedeu.configure }.must_raise(InvalidSyntax)
+      end
+    end
+
     describe '.defined' do
       it 'returns a reference to the API::Defined module' do
         Vedeu.defined.must_equal(Vedeu::API::Defined)
@@ -28,6 +34,12 @@ module Vedeu
       end
     end
 
+    describe '.focus' do
+      it 'sets the named interface to be focussed' do
+        skip
+      end
+    end
+
     describe '.height' do
       it 'returns the terminal height' do
         IO.console.stub(:winsize, [24, 40]) do
@@ -139,12 +151,11 @@ module Vedeu
         {
           interfaces: [{
             name: "some_interface",
-            group: "",
+            group: '',
             lines: [],
             colour: {},
-            style: "",
+            style: '',
             geometry: {},
-            cursor: true,
             delay: 0.0,
             parent: {}
           }]

data/test/lib/vedeu/api/helpers_test.rb

@@ -48,7 +48,7 @@ module Vedeu
           HelpersTestClass.new.style do
             #...
           end.must_equal(
-            [{ colour: {}, style: [], text: "", width: nil, align: :left, parent: nil, }]
+            [{ colour: {}, style: [], text: '', width: nil, align: :left, parent: nil, }]
           )
         end
 
@@ -60,7 +60,7 @@ module Vedeu
               {
                 colour: {},
                 style: ['italic'],
-                text: "",
+                text: '',
                 width: nil,
                 align: :left,
                 parent: nil,
@@ -77,7 +77,7 @@ module Vedeu
               {
                 colour: {},
                 style: ['italic', 'blink'],
-                text: "",
+                text: '',
                 width: nil,
                 align: :left,
                 parent: nil,

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

@@ -21,12 +21,11 @@ module Vedeu
               group: '',
               lines: [],
               colour: {
-                foreground: "#aadd00",
-                background: "#222222"
+                foreground: '#aadd00',
+                background: '#222222'
               },
-              style: "",
+              style: '',
               geometry: {},
-              cursor: true,
               delay: 0.0,
               parent: nil,
             }
@@ -44,7 +43,6 @@ module Vedeu
               colour: {},
               style: "underline",
               geometry: {},
-              cursor: true,
               delay: 0.0,
               parent: nil,
             }
@@ -64,14 +62,13 @@ module Vedeu
               y      use('my_interface').south
             end.must_equal({
               name: "my_other_interface",
-              group: "",
+              group: '',
               lines: [],
               colour: {},
-              style: "",
+              style: '',
               geometry: {
                 y: 11
               },
-              cursor: true,
               delay: 0.0,
               parent: nil,
             })
@@ -88,9 +85,8 @@ module Vedeu
               group: '',
               lines: [],
               colour: {},
-              style: "",
+              style: '',
               geometry: {},
-              cursor: true,
               delay: 1.0,
               parent: nil,
             })
@@ -102,32 +98,12 @@ module Vedeu
             group 'my_group'
           end.must_equal(
             {
-              name: "",
+              name: '',
               group: "my_group",
               lines: [],
               colour: {},
-              style: "",
-              geometry: {},
-              cursor: true,
-              delay: 0.0,
-              parent: nil,
-            }
-          )
-        end
-
-        it 'allows the setting of the cursor for the interface to be shown ' \
-           'or hidden' do
-          Interface.build do
-            cursor false
-          end.must_equal(
-            {
-              name: "",
-              group: "",
-              lines: [],
-              colour: {},
-              style: "",
+              style: '',
               geometry: {},
-              cursor: false,
               delay: 0.0,
               parent: nil,
             }
@@ -161,32 +137,6 @@ module Vedeu
         end
       end
 
-      describe '#cursor' do
-        it 'raises an exception if the value is invalid' do
-          proc {
-            Vedeu.interface 'beryllium' do
-              cursor :invalid
-            end
-          }.must_raise(InvalidSyntax)
-        end
-
-        it 'sets the cursor to true (visible)' do
-          Vedeu.interface 'beryllium' do
-            cursor true
-          end
-
-          Vedeu.use('beryllium').attributes[:cursor].must_equal(true)
-        end
-
-        it 'sets the cursor to false (hidden)' do
-          Vedeu.interface 'beryllium' do
-            cursor false
-          end
-
-          Vedeu.use('beryllium').attributes[:cursor].must_equal(false)
-        end
-      end
-
       describe '#delay' do
         it 'sets the delay attribute' do
           Vedeu.interface 'cobalt' do
@@ -221,22 +171,21 @@ module Vedeu
           interface.must_be_instance_of(API::Interface)
           interface.attributes.must_equal(
             {
-              name: "carbon",
-              group: "",
+              name: 'carbon',
+              group: '',
               lines: [
                 {
                   colour: {},
                   streams: {
-                    text: ""
+                    text: ''
                   },
                   style: [],
                   parent: interface.view_attributes,
                 }
               ],
               colour: {},
-              style: "",
+              style: '',
               geometry: {},
-              cursor: true,
               delay: 0.0,
               parent: nil,
             }
@@ -250,8 +199,8 @@ module Vedeu
           interface.must_be_instance_of(API::Interface)
           interface.attributes.must_equal(
             {
-              name: "carbon",
-              group: "",
+              name: 'carbon',
+              group: '',
               lines: [
                 {
                   colour: {},
@@ -263,9 +212,8 @@ module Vedeu
                 }
               ],
               colour: {},
-              style: "",
+              style: '',
               geometry: {},
-              cursor: true,
               delay: 0.0,
               parent: nil,
             }
@@ -282,7 +230,7 @@ module Vedeu
           interface.attributes.must_equal(
             {
               name: "silicon",
-              group: "",
+              group: '',
               lines: [
                 {
                   colour: {},
@@ -296,9 +244,8 @@ module Vedeu
                 }
               ],
               colour: {},
-              style: "",
+              style: '',
               geometry: {},
-              cursor: true,
               delay: 0.0,
               parent: nil
             }

data/test/lib/vedeu/api/keymap_test.rb

@@ -6,6 +6,8 @@ module Vedeu
     describe Keymap do
 
       describe '#key' do
+        before { Vedeu::Keymaps.reset }
+
         it 'raises an exception when a block is not given' do
           proc {
             Vedeu.keys do

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

@@ -48,28 +48,28 @@ module Vedeu
       describe '#foreground' do
         it 'returns the value assigned' do
           attrs = Line.new.foreground('#ff0000')
-          attrs.first[:colour].must_equal({ foreground: "#ff0000" })
+          attrs.first[:colour].must_equal({ foreground: '#ff0000' })
         end
 
         it 'returns the value assigned with a block' do
           attrs = Line.new.foreground('#00ff00') do
             # ...
           end
-          attrs.first[:colour].must_equal({ foreground: "#00ff00" })
+          attrs.first[:colour].must_equal({ foreground: '#00ff00' })
         end
       end
 
       describe '#background' do
         it 'returns the value assigned' do
           attrs = Line.new.background('#00ff00')
-          attrs.first[:colour].must_equal({ background: "#00ff00" })
+          attrs.first[:colour].must_equal({ background: '#00ff00' })
         end
 
         it 'returns the value assigned with a block' do
           attrs = Line.new.background('#0000ff') do
             # ...
           end
-          attrs.first[:colour].must_equal({ background: "#0000ff" })
+          attrs.first[:colour].must_equal({ background: '#0000ff' })
         end
       end
     end

data/test/lib/vedeu/api/menu_test.rb

@@ -38,15 +38,16 @@ module Vedeu
       end
 
       describe '#items' do
-        it 'returns an instance of Vedeu::Menu' do
-          menu = Menu.new
-          menu.items.must_be_instance_of(Vedeu::Menu)
+        it 'returns an empty collection when no items are provided' do
+          Menu.new.items.must_equal([])
         end
 
         it 'assigns the instance of Vedeu::Menu to the attributes' do
+          items = [:sodium, :magnesium, :aluminium, :silicon]
+
           menu = Menu.new
-          menu.items([:sodium, :magnesium, :aluminium, :silicon])
-          menu.attributes[:items].must_be_instance_of(Vedeu::Menu)
+          menu.items(items)
+          menu.attributes[:items].must_equal(items)
         end
       end
 

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

@@ -17,6 +17,24 @@ module Vedeu
         end
       end
 
+      describe '#left' do
+        it 'returns a Symbol' do
+          Stream.new.left.must_equal(:left)
+        end
+      end
+
+      describe '#right' do
+        it 'returns a Symbol' do
+          Stream.new.right.must_equal(:right)
+        end
+      end
+
+      describe '#centre' do
+        it 'returns a Symbol' do
+          Stream.new.centre.must_equal(:centre)
+        end
+      end
+
       describe '#text' do
         it 'returns the value assigned' do
           Stream.new.text('Some text...').must_equal('Some text...')

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

@@ -0,0 +1,248 @@
+require 'test_helper'
+
+module Vedeu
+  module Configuration
+
+    describe API do
+
+      before { Configuration.reset }
+      after  { Configuration.reset }
+
+      describe '.configure' do
+        it 'returns the default configuration' do
+          Vedeu.configure do
+            # ...
+          end.must_equal(
+            {
+              colour_mode: 16777216,
+              debug: false,
+              interactive: true,
+              once: false,
+              system_keys: {
+                exit:        'q',
+                focus_next:  :tab,
+                focus_prev:  :shift_tab,
+                mode_switch: :escape
+              },
+              terminal_mode: :raw,
+              trace: false
+            }
+          )
+        end
+      end
+
+      describe '#interactive!' do
+        it 'sets the option to the desired value' do
+          configuration = Vedeu.configure { interactive! }
+          configuration[:interactive].must_equal(true)
+        end
+
+        it 'sets the option to the desired value' do
+          configuration = Vedeu.configure { interactive(false) }
+          configuration[:interactive].must_equal(false)
+        end
+
+        it 'sets the option to the desired value' do
+          configuration = Vedeu.configure { interactive(true) }
+          configuration[:interactive].must_equal(true)
+        end
+
+        it 'sets the option to the desired value' do
+          configuration = Vedeu.configure { interactive }
+          configuration[:interactive].must_equal(true)
+        end
+      end
+
+      describe '#standalone!' do
+        it 'sets the option to the desired value' do
+          configuration = Vedeu.configure { standalone! }
+          configuration[:interactive].must_equal(false)
+        end
+
+        it 'sets the option to the desired value' do
+          configuration = Vedeu.configure { standalone(false) }
+          configuration[:interactive].must_equal(true)
+        end
+
+        it 'sets the option to the desired value' do
+          configuration = Vedeu.configure { standalone(true) }
+          configuration[:interactive].must_equal(false)
+        end
+
+        it 'sets the option to the desired value' do
+          configuration = Vedeu.configure { standalone }
+          configuration[:interactive].must_equal(false)
+        end
+      end
+
+      describe '#run_once!' do
+        it 'sets the option to the desired value' do
+          configuration = Vedeu.configure { run_once! }
+          configuration[:once].must_equal(true)
+        end
+
+        it 'sets the option to the desired value' do
+          configuration = Vedeu.configure { run_once(false) }
+          configuration[:once].must_equal(false)
+        end
+
+        it 'sets the option to the desired value' do
+          configuration = Vedeu.configure { run_once(true) }
+          configuration[:once].must_equal(true)
+        end
+
+        it 'sets the option to the desired value' do
+          configuration = Vedeu.configure { run_once }
+          configuration[:once].must_equal(true)
+        end
+      end
+
+      describe '#cooked!' do
+        it 'sets the option to the desired value' do
+          configuration = Vedeu.configure { cooked! }
+          configuration[:terminal_mode].must_equal(:cooked)
+        end
+      end
+
+      describe '#raw!' do
+        it 'sets the option to the desired value' do
+          configuration = Vedeu.configure { raw! }
+          configuration[:terminal_mode].must_equal(:raw)
+        end
+      end
+
+      describe '#debug!' do
+        it 'sets the option to the desired value' do
+          configuration = Vedeu.configure { debug! }
+          configuration[:debug].must_equal(true)
+        end
+
+        it 'sets the option to the desired value' do
+          configuration = Vedeu.configure { debug(true) }
+          configuration[:debug].must_equal(true)
+        end
+
+        it 'sets the option to the desired value' do
+          configuration = Vedeu.configure { debug(false) }
+          configuration[:debug].must_equal(false)
+        end
+
+        it 'sets the option to the desired value' do
+          configuration = Vedeu.configure { trace(true) }
+          configuration[:debug].must_equal(true)
+        end
+
+        it 'sets the option to the desired value' do
+          configuration = Vedeu.configure do
+            debug(false)
+            trace(true)
+          end
+
+          configuration[:debug].must_equal(true)
+        end
+
+        it 'sets the option to the desired value' do
+          configuration = Vedeu.configure do
+            debug(true)
+            trace(false)
+          end
+
+          configuration[:debug].must_equal(true)
+        end
+
+        it 'sets the option to the desired value' do
+          configuration = Vedeu.configure do
+            debug(false)
+            trace(false)
+          end
+
+          configuration[:debug].must_equal(false)
+        end
+      end
+
+      describe '#trace!' do
+        it 'sets the option to the desired value' do
+          configuration = Vedeu.configure { trace! }
+
+          configuration[:trace].must_equal(true)
+        end
+
+        it 'sets the option to the desired value' do
+          configuration = Vedeu.configure { trace(false) }
+
+          configuration[:trace].must_equal(false)
+          configuration[:debug].must_equal(false)
+        end
+
+        it 'sets the option to the desired value' do
+          configuration = Vedeu.configure { trace(true) }
+
+          configuration[:trace].must_equal(true)
+          configuration[:debug].must_equal(true)
+        end
+      end
+
+      describe '#colour_mode' do
+        it 'raises an exception for an invalid value' do
+          proc {
+            Vedeu.configure { colour_mode(nil) }
+          }.must_raise(InvalidSyntax)
+        end
+
+        it 'raises an exception for an invalid value' do
+          proc {
+            Vedeu.configure { colour_mode('') }
+          }.must_raise(InvalidSyntax)
+        end
+
+        it 'raises an exception for an invalid value' do
+          proc {
+            Vedeu.configure { colour_mode(1234) }
+          }.must_raise(InvalidSyntax)
+        end
+
+        it 'sets the option to the desired value' do
+          configuration = Vedeu.configure { colour_mode(256) }
+          configuration[:colour_mode].must_equal(256)
+        end
+      end
+
+      describe 'redefining system keys' do
+        methods_and_keys = {
+          exit_key:        :exit,
+          focus_next_key:  :focus_next,
+          focus_prev_key:  :focus_prev,
+          mode_switch_key: :mode_switch,
+        }
+
+        context 'when using an invalid value' do
+          invalid_params = [nil, '', 123, 'oops']
+
+          methods_and_keys.each do |meth, _|
+            invalid_params.each do |param|
+              it 'raises an exception with an invalid parameter' do
+                proc { Vedeu.configure { send(meth, param) } }.must_raise(InvalidSyntax)
+              end
+            end
+          end
+        end
+
+        context 'when using a valid value' do
+          valid_params = ['v', :f1]
+
+          methods_and_keys.each do |meth, key|
+            valid_params.each do |param|
+              it 'sets the system key to the desired value' do
+                configuration = Vedeu.configure { send(meth, param) }
+
+                configuration[:system_keys][key].must_equal(param)
+              end
+            end
+          end
+        end
+      end
+
+    end
+
+  end
+end