vedeu 0.2.3 → 0.2.4

data/lib/vedeu/{models/attributes → support}/presentation.rb

@@ -49,7 +49,6 @@ module Vedeu
     # the styles) and once returned, attempts to set the colours back to the
     # those of the receiver's parent.
     #
-    # @api private
     # @return [String]
     def render_colour(&block)
       [ colour.to_s, yield, parent_colour ].join
@@ -59,7 +58,6 @@ module Vedeu
     # next model, or finally, the content) and once returned, attempts to set
     # the colours back to those of the receiver's parent.
     #
-    # @api private
     # @return [String]
     def render_style(&block)
       [ style.to_s, yield, parent_style ].join
@@ -67,7 +65,6 @@ module Vedeu
 
     # Returns the parent colour as an escape sequence if set.
     #
-    # @api private
     # @return [String]
     def parent_colour
       return '' if parent.nil?
@@ -76,7 +73,7 @@ module Vedeu
     end
 
     # Returns the parent style as an escape sequence if set.
-    # @api private
+    #
     # @return [String]
     def parent_style
       return '' if parent.nil?

data/lib/vedeu/support/registrar.rb

@@ -6,8 +6,6 @@ module Vedeu
   # @api private
   class Registrar
 
-    include Common
-
     # @param attributes [Hash]
     # @return [TrueClass|]
     def self.record(attributes = {})
@@ -26,6 +24,8 @@ module Vedeu
     def record
       Vedeu::Buffers.add(attributes)
 
+      Vedeu::Offsets.add(attributes)
+
       Vedeu::Interfaces.add(attributes)
 
       Vedeu::Cursors.add(attributes)

data/lib/vedeu/support/repository.rb

@@ -1,5 +1,6 @@
 module Vedeu
 
+  # @api private
   module Repository
 
     # Return the whole repository.
@@ -17,6 +18,20 @@ module Vedeu
       storage.fetch(name) { not_found(name) }
     end
 
+    # Find entity by named interface, registers an entity by interface name if
+    # not found.
+    #
+    # @param name [String]
+    # @return [Cursor|Offset]
+    def find_or_create(name)
+      storage.fetch(name) do
+        Vedeu.log("Entity (#{entity.to_s}) not found, " \
+                  "registering new for: '#{name}'")
+
+        storage.store(name, entity.new({ name: name }))
+      end
+    end
+
     # Returns a collection of the names of all the registered entities.
     #
     # @return [Array]
@@ -41,9 +56,16 @@ module Vedeu
 
     private
 
+    # @param method [Symbol]
+    # @return [String]
+    def action(method)
+      return 'Registering' if method == :add
+
+      'Updating'
+    end
+
     # Access to the storage for this repository.
     #
-    # @api private
     # @return [Hash]
     def storage
       @_storage ||= in_memory
@@ -52,7 +74,6 @@ module Vedeu
     # At present, validates that attributes has a `:name` key that is not nil or
     # empty.
     #
-    # @api private
     # @param attributes [Hash]
     # @return [TrueClass|MissingRequired]
     def validate_attributes!(attributes)

data/lib/vedeu/support/terminal.rb

@@ -37,7 +37,6 @@ module Vedeu
     # the F-Keys etc, by capturing the entire sequence.
     #
     # @return [String]
-    # :nocov:
     def input
       if raw_mode?
         keys = console.getch
@@ -52,7 +51,6 @@ module Vedeu
 
       end
     end
-    # :nocov:
 
     # Prints the streams to the screen and returns the streams.
     #

data/lib/vedeu/support/trace.rb

@@ -8,7 +8,6 @@ module Vedeu
   # @api private
   class Trace
 
-    # :nocov:
     # @param options [Hash]
     # @return []
     def self.call(options = {})
@@ -52,7 +51,6 @@ module Vedeu
 
     # Writes the message to the log file.
     #
-    # @api private
     # @param message [String]
     # @return [Boolean]
     def log_this(message)
@@ -63,7 +61,6 @@ module Vedeu
     # traced. Makes the log file extremely noisy, but very useful for hunting
     # down bugs.
     #
-    # @api private
     # @param binding [Class]
     # @return [String]
     def variables(binding)
@@ -84,25 +81,21 @@ module Vedeu
       entries.join("\n")
     end
 
-    # @api private
     # @return [String]
     def watched
       options[:event]
     end
 
-    # @api private
     # @return [Boolean]
     def trace?
       options[:trace]
     end
 
-    # @api private
     # @return [Hash]
     def options
       defaults.merge!(@options)
     end
 
-    # @api private
     # @return [Hash]
     def defaults
       {
@@ -132,7 +125,6 @@ module Vedeu
 
     # Returns the classes to be traced, without exceptions or ignored classes.
     #
-    # @api private
     # @return [Set]
     def classes
       @_classes ||= vedeu_classes - vedeu_exceptions - ignored_classes
@@ -155,7 +147,6 @@ module Vedeu
     def vedeu_exceptions
       Set.new [
         'Vedeu::BufferNotFound',
-        'Vedeu::CursorNotFound',
         'Vedeu::GroupNotFound',
         'Vedeu::InterfaceNotFound',
         'Vedeu::InvalidSyntax',
@@ -228,8 +219,6 @@ module Vedeu
       ]
     end
 
-    # :nocov:
-
   end # Trace
 
 end # Vedeu

data/lib/vedeu.rb

@@ -38,11 +38,11 @@ require 'vedeu/support/trace'
 
 require 'vedeu/api/api'
 
-require 'vedeu/models/attributes/coercions'
-require 'vedeu/models/attributes/colour_translator'
-require 'vedeu/models/attributes/background'
-require 'vedeu/models/attributes/foreground'
-require 'vedeu/models/attributes/presentation'
+require 'vedeu/support/coercions'
+require 'vedeu/support/colour_translator'
+require 'vedeu/models/background'
+require 'vedeu/models/foreground'
+require 'vedeu/support/presentation'
 require 'vedeu/models/composition'
 
 require 'vedeu/support/repository'
@@ -57,8 +57,10 @@ require 'vedeu/models/style'
 require 'vedeu/models/interface'
 require 'vedeu/models/cursor'
 require 'vedeu/models/keymap'
+require 'vedeu/models/char'
 require 'vedeu/models/line'
 require 'vedeu/models/stream'
+require 'vedeu/models/offset'
 
 require 'vedeu/repositories/events'
 
@@ -72,6 +74,7 @@ require 'vedeu/api/menu'
 require 'vedeu/api/stream'
 
 require 'vedeu/support/keymap_validator'
+require 'vedeu/repositories/offsets'
 require 'vedeu/repositories/menus'
 require 'vedeu/repositories/keymaps'
 require 'vedeu/repositories/interfaces'
@@ -83,14 +86,17 @@ require 'vedeu/repositories/cursors'
 
 require 'vedeu/support/registrar'
 
+require 'vedeu/output/area'
 require 'vedeu/output/clear'
 require 'vedeu/output/compositor'
 require 'vedeu/output/refresh'
 require 'vedeu/output/render'
 require 'vedeu/output/view'
+require 'vedeu/output/viewport'
 
 require 'vedeu/support/grid'
 require 'vedeu/support/menu'
+require 'vedeu/support/move'
 
 require 'vedeu/input/input'
 

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

@@ -106,7 +106,7 @@ module Vedeu
     end
 
     describe '.resize' do
-      it 'triggers the :_clear_, :_refresh_ and :_cursor_refresh_ events' do
+      it 'triggers the :_clear_, and :_refresh_ events' do
         skip
       end
     end
@@ -164,11 +164,20 @@ module Vedeu
     end
 
     describe '.views' do
-      it 'returns the view attributes for a composition (a collection of ' \
-         'interfaces)' do
+      it 'allows multiple views to be defined at once' do
         attrs = Vedeu.views do
-          view 'osmium'
-          view 'iridium'
+          view 'view_1' do
+            line do
+              text '1. A line of text in view 1.'
+              text '2. Another line of text in view 1.'
+            end
+          end
+          view 'view_2' do
+            line do
+              text '1. A line of text in view 2.'
+              text '2. Another line of text in view 2.'
+            end
+          end
         end
         attrs[:interfaces].size.must_equal(2)
       end

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

@@ -3,42 +3,25 @@ require 'test_helper'
 module Vedeu
   module API
     describe Composition do
+
       describe '.render' do
-        it 'directly writes a view buffer to the terminal' do
-          skip
+        it 'raises an exception when a block is not given' do
+          proc { Vedeu.render }.must_raise(InvalidSyntax)
         end
       end
 
-
       describe '#view' do
+        it 'returns a Hash' do
+          Vedeu.view('thulium') do
+            # ...
+          end.must_be_instance_of(Hash)
+        end
+
         it 'allows a single view to be defined' do
           skip
         end
       end
 
-      describe '#views' do
-        it 'allows multiple views to be defined at once' do
-          attrs = Vedeu.views do
-            view 'view_1' do
-              line do
-                text '1. A line of text in view 1.'
-                text '2. Another line of text in view 1.'
-              end
-            end
-            view 'view_2' do
-              line do
-                text '1. A line of text in view 2.'
-                text '2. Another line of text in view 2.'
-              end
-            end
-          end
-          attrs[:interfaces].size.must_equal(2)
-        end
-
-        it 'raises an exception when a block is not given' do
-          proc { Vedeu.views }.must_raise(InvalidSyntax)
-        end
-      end
     end
   end
 end

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

@@ -52,7 +52,7 @@ module Vedeu
           end.must_be_instance_of(API::Keymap)
         end
 
-        it 'returnsa collection of the interfaces' do
+        it 'returns a collection of the interfaces' do
           Keymap.new.interface('americium').must_equal(['americium'])
         end
       end

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

@@ -65,5 +65,11 @@ module Vedeu
       end
     end
 
+    describe '#method_missing' do
+      it 'returns nil' do
+        Menu.new.some_missing_method(:test).must_equal(nil)
+      end
+    end
+
   end
 end

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

@@ -4,6 +4,10 @@ module Vedeu
   module API
     describe Stream do
       describe '#align' do
+        it 'returns a Symbol' do
+          Stream.new.align(:left).must_be_instance_of(Symbol)
+        end
+
         it 'returns the value assigned' do
           Stream.new.align(:left).must_equal(:left)
         end
@@ -17,6 +21,34 @@ module Vedeu
         end
       end
 
+      describe '#background' do
+        it 'returns a Hash' do
+          Stream.new.background('#00ff00').must_be_instance_of(Hash)
+        end
+
+        it 'returns the value assigned' do
+          Stream.new.background('#00ff00').must_equal({ background: '#00ff00' })
+        end
+
+        it 'raises an exception if the value is not defined' do
+          proc { Stream.new.background('') }.must_raise(InvalidSyntax)
+        end
+      end
+
+      describe '#foreground' do
+        it 'returns a Hash' do
+          Stream.new.foreground('#00ff00').must_be_instance_of(Hash)
+        end
+
+        it 'returns the value assigned' do
+          Stream.new.foreground('#00ff00').must_equal({ foreground: '#00ff00' })
+        end
+
+        it 'raises an exception if the value is not defined' do
+          proc { Stream.new.foreground('') }.must_raise(InvalidSyntax)
+        end
+      end
+
       describe '#left' do
         it 'returns a Symbol' do
           Stream.new.left.must_equal(:left)

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

@@ -0,0 +1,46 @@
+require 'test_helper'
+
+module Vedeu
+  describe Char do
+    let(:instance)   { Char.new(attributes) }
+    let(:attributes) {
+      {
+        colour: { foreground: '#ffff00', background: '#0000ff' },
+        parent: {
+          colour: {
+            foreground: '#00ff00',
+            background: '#ff00ff'
+          },
+          style: []
+        },
+        style:  [],
+        value:  value,
+      }
+    }
+    let(:value) { 'a' }
+
+    describe '#initialize' do
+      it 'returns a new instance of Char' do
+        instance.must_be_instance_of(Char)
+      end
+    end
+
+    describe '#to_s' do
+      it 'returns a String' do
+        instance.to_s.must_be_instance_of(String)
+      end
+
+      it 'returns the escape sequences and content' do
+        # - char colours and style as set in Stream#chars.
+        # - the value.
+        # - the colours and style of the line which the Char belongs to.
+        instance.to_s.must_equal(
+          "\e[38;2;255;255;0m\e[48;2;0;0;255m" \
+          "a" \
+          "\e[38;2;0;255;0m\e[48;2;255;0;255m"
+        )
+      end
+    end
+
+  end
+end

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

@@ -4,6 +4,7 @@ require 'json'
 
 module Vedeu
   describe Composition do
+
     before { Buffers.reset }
 
     describe '#initialize' do
@@ -33,5 +34,11 @@ module Vedeu
       end
     end
 
+    describe '#method_missing' do
+      it 'returns nil' do
+        Composition.new.some_missing_method(:test).must_equal(nil)
+      end
+    end
+
   end
 end

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

@@ -4,21 +4,22 @@ module Vedeu
   describe Cursor do
     let(:attributes) {
       {
-        name:  'silver',
-        state: :show,
-        x:     12,
-        y:     5,
+        name:     'silver',
+        state:    :show,
+        x:        19,
+        y:        8
       }
     }
 
     before do
       Interfaces.reset
       Vedeu.interface 'silver' do
-        width  10
+        y      5
         height 4
         x      12
-        y      5
+        width  10
       end
+      Terminal.console.stubs(:print)
     end
 
     describe '#initialize' do
@@ -30,82 +31,78 @@ module Vedeu
     describe '#attributes' do
       it 'returns a hash containing the attributes of the instance' do
         Cursor.new(attributes).attributes.must_equal(
-          { name: 'silver', state: :show, x: 12, y: 5 }
+          { name: 'silver', state: :show, x: 19, y: 8 }
         )
       end
     end
 
-    describe '#move_up' do
-      it 'does not move up when already at the top' do
-        cursor = Cursor.new(attributes)
-        cursor.move_up
-        cursor.attributes.must_equal(
-          { name: 'silver', state: :show, x: 12, y: 5 }
-        )
+    describe '#x' do
+      it 'returns a Fixnum' do
+        Cursor.new(attributes).x.must_be_instance_of(Fixnum)
       end
 
-      it 'moves the cursor up' do
-        cursor = Cursor.new(attributes)
-        3.times { cursor.move_down }
-        cursor.move_up
-        cursor.attributes.must_equal(
-          { name: 'silver', state: :show, x: 12, y: 7 }
-        )
+      context 'when the cursors position is outside the interface' do
+        let(:attributes) { { name: 'silver', state: :show, x: 10, y: 8 } }
+
+        it 'repositions the cursor at the start of the line' do
+          Cursor.new(attributes).attributes.must_equal(
+            { name: 'silver', state: :show, x: 12, y: 8 }
+          )
+        end
+      end
+
+      context 'when the cursors position is outside the interface' do
+        let(:attributes) { { name: 'silver', state: :show, x: 25, y: 8 } }
+
+        it 'repositions the cursor at the end of the line' do
+          Cursor.new(attributes).attributes.must_equal(
+            { name: 'silver', state: :show, x: 21, y: 8 }
+          )
+        end
       end
     end
 
-    describe '#move_down' do
-      it 'moves the cursor down' do
-        cursor = Cursor.new(attributes)
-        cursor.move_down
-        cursor.attributes.must_equal(
-          { name: 'silver', state: :show, x: 12, y: 6 }
-        )
+    describe '#y' do
+      it 'returns a Fixnum' do
+        Cursor.new(attributes).y.must_be_instance_of(Fixnum)
       end
 
-      it 'does not move down when already at the bottom' do
-        cursor = Cursor.new(attributes)
-        5.times { cursor.move_down }
-        cursor.attributes.must_equal(
-          { name: 'silver', state: :show, x: 12, y: 8 }
-        )
+      context 'when the cursors position is outside the interface' do
+        let(:attributes) { { name: 'silver', state: :show, x: 19, y: 3 } }
+
+        it 'repositions the cursor at the start of the line' do
+          Cursor.new(attributes).attributes.must_equal(
+            { name: 'silver', state: :show, x: 19, y: 5 }
+          )
+        end
       end
-    end
 
-    describe '#move_left' do
-      it 'does not move left when already at leftmost' do
-        cursor = Cursor.new(attributes)
-        cursor.move_left
-        cursor.attributes.must_equal(
-          { name: 'silver', state: :show, x: 12, y: 5 }
-        )
+      context 'when the cursors position is outside the interface' do
+        let(:attributes) { { name: 'silver', state: :show, x: 19, y: 12 } }
+
+        it 'repositions the cursor at the end of the line' do
+          Cursor.new(attributes).attributes.must_equal(
+            { name: 'silver', state: :show, x: 19, y: 8 }
+          )
+        end
       end
+    end
 
-      it 'moves the cursor left' do
-        cursor = Cursor.new(attributes)
-        3.times { cursor.move_right }
-        cursor.move_left
-        cursor.attributes.must_equal(
-          { name: 'silver', state: :show, x: 14, y: 5 }
+    describe '#refresh' do
+      it 'returns a hash containing the attributes of the instance' do
+        Cursor.new(attributes).refresh.must_equal(
+          { name: 'silver', state: :show, x: 19, y: 8 }
         )
       end
     end
 
-    describe '#move_right' do
-      it 'does not move right when already at rightmost' do
-        cursor = Cursor.new(attributes)
-        11.times { cursor.move_right }
-        cursor.attributes.must_equal(
-          { name: 'silver', state: :show, x: 21, y: 5 }
-        )
+    describe '#visible?' do
+      it 'returns false when the cursor is not visible' do
+        Cursor.new({ state: :hide }).visible?.must_equal(false)
       end
 
-      it 'moves the cursor right' do
-        cursor = Cursor.new(attributes)
-        cursor.move_right
-        cursor.attributes.must_equal(
-          { name: 'silver', state: :show, x: 13, y: 5 }
-        )
+      it 'returns true when the cursor is visible' do
+        Cursor.new({ state: :show }).visible?.must_equal(true)
       end
     end
 
@@ -114,11 +111,11 @@ module Vedeu
         cursor = Cursor.new(attributes)
         cursor.hide
         cursor.attributes.must_equal(
-          { name: 'silver', state: :hide, x: 12, y: 5 }
+          { name: 'silver', state: :hide, x: 19, y: 8 }
         )
         cursor.show
         cursor.attributes.must_equal(
-          { name: 'silver', state: :show, x: 12, y: 5 }
+          { name: 'silver', state: :show, x: 19, y: 8 }
         )
       end
     end
@@ -128,21 +125,7 @@ module Vedeu
         cursor = Cursor.new(attributes)
         cursor.hide
         cursor.attributes.must_equal(
-          { name: 'silver', state: :hide, x: 12, y: 5 }
-        )
-      end
-    end
-
-    describe '#toggle' do
-      it 'sets the visibility to the opposite of its current state' do
-        cursor = Cursor.new(attributes)
-        cursor.toggle
-        cursor.attributes.must_equal(
-          { name: 'silver', state: :hide, x: 12, y: 5 }
-        )
-        cursor.toggle
-        cursor.attributes.must_equal(
-          { name: 'silver', state: :show, x: 12, y: 5 }
+          { name: 'silver', state: :hide, x: 19, y: 8 }
         )
       end
     end
@@ -150,14 +133,14 @@ module Vedeu
     describe '#to_s' do
       it 'returns the escape sequence to position and set the visibility of ' \
          'the cursor' do
-        Cursor.new(attributes).to_s.must_equal("\e[5;12H\e[?25h")
+        Cursor.new(attributes).to_s.must_equal("\e[8;19H\e[?25h")
       end
 
       it 'returns the escape sequence to position and set the visibility of ' \
          'the cursor and returns to that position after yielding the block' do
         Cursor.new(attributes).to_s do
           # ...
-        end.must_equal("\e[5;12H\e[?25h\e[5;12H\e[?25h")
+        end.must_equal("\e[8;19H\e[?25h\e[8;19H\e[?25h")
       end
     end
   end