vedeu 0.1.15 → 0.1.16

data/lib/vedeu/support/terminal.rb

@@ -2,6 +2,9 @@ module Vedeu
   module Terminal
     extend self
 
+    # @param mode [Symbol]
+    # @param block [Proc]
+    # @return []
     def open(mode, &block)
       @mode = mode
 
@@ -18,6 +21,7 @@ module Vedeu
       restore_screen
     end
 
+    # @return [String]
     def input
       if raw_mode?
         keys = console.getch
@@ -33,39 +37,54 @@ module Vedeu
       end
     end
 
+    # @param stream [String]
+    # @return [String]
     def output(stream = '')
       console.print(stream)
 
       stream
     end
 
+    # @param block [Proc]
+    # @return []
     def initialize_screen(&block)
       output Esc.string 'screen_init'
 
       yield
     end
 
+    # @return [String]
     def clear_screen
       output Esc.string 'clear'
     end
 
+    # @return [String]
     def restore_screen
       output Esc.string 'screen_exit'
       output clear_last_line
     end
 
+    # @return [String]
     def set_cursor_mode
       output Esc.string 'show_cursor' unless raw_mode?
     end
 
+    # @return [Boolean]
     def raw_mode?
       @mode == :raw
     end
 
+    # @return [String]
     def clear_last_line
       Esc.set_position((height - 1), 1) + Esc.string('clear_line')
     end
 
+    # @return [Fixnum]
+    def colour_mode
+      Configuration.options[:colour_mode]
+    end
+
+    # @return [Array]
     def centre
       [(height / 2), (width / 2)]
     end
@@ -80,10 +99,12 @@ module Vedeu
       size.first
     end
 
+    # @return [Array]
     def size
       console.winsize
     end
 
+    # @return [File]
     def console
       IO.console
     end

data/lib/vedeu/support/trace.rb

@@ -0,0 +1,54 @@
+module Vedeu
+  class Trace
+
+    # :nocov:
+    # @param options [Hash]
+    # @return []
+    def self.call(options = {})
+      new(options).trace
+    end
+
+    # @param options [Hash]
+    # @return [Trace]
+    def initialize(options = {})
+      @options = options
+    end
+
+    # @return []
+    def trace
+      set_trace_func proc { |event, file, line, id, binding, classname|
+        if event == watched && classname.to_s.match(klass)
+          Vedeu.log(sprintf(" %s %-35s #%s", event, classname, id))
+          # binding.eval('local_variables').each do |var|
+          #   print("#{var.to_s} = #{binding.local_variable_get(var).inspect}\n")
+          # end
+        end
+      }
+    end
+
+    private
+
+    def watched
+      options[:event]
+    end
+
+    def klass
+      options[:klass]
+    end
+
+    def options
+      defaults.merge!(@options)
+    end
+
+    def defaults
+      {
+        event: 'call',
+        klass: /^Vedeu::(?!.*Log|Interface|Line|Stream|Style|Colour|Geometry|Terminal|Esc|ColourTranslator).*/
+      }
+    end
+
+    # everything except Interface, Geometry and Terminal
+    # klass: /^Vedeu::(?!.*Interface|Geometry|Terminal).*/
+  end
+  # :nocov:
+end

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

@@ -1,26 +1,30 @@
 module Vedeu
-  NotImplemented = Class.new(StandardError)
-
   class View
+
     include Vedeu::API
 
+    # @param object []
+    # @return [Array]
     def self.render(object = nil)
-      new(object).render
+      new(object).enqueue
     end
 
+    # @param object []
+    # @return [View]
     def initialize(object = nil)
       @object = object
     end
 
-    def render
-      interfaces.map do |interface|
-        Buffers.enqueue(interface.name, interface.to_s)
-      end
+    # @return [Array]
+    def enqueue
+      interfaces.map { |interface| Buffers.enqueue(interface.name, interface) }
     end
 
-    def output
-      fail NotImplemented, 'Implement #output on your subclass of Vedeu::View.'
+    # @return [Exception]
+    def render
+      fail NotImplemented, 'Implement #render on your subclass of Vedeu::View.'
     end
+    alias_method :output, :render
 
     private
 
@@ -35,7 +39,8 @@ module Vedeu
     end
 
     def attributes
-      output
+      render
     end
+
   end
 end

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

@@ -2,25 +2,34 @@ require 'test_helper'
 
 module Vedeu
   describe API do
+    let(:event) { mock('Event') }
+
+    before { Event.stubs(:new).returns(event) }
+
     describe '.event' do
       it 'registers and returns the event' do
         Vedeu.event(:some_event).must_equal(
           {
-            delay:     0,
-            events:    [nil],
-            last_exec: 0
+            events: [event],
           }
         )
       end
     end
 
+    describe '.unevent' do
+      it 'unregister the event by name' do
+        Vedeu.event(:calcium) { proc { |x| x } }
+        Vedeu.unevent(:calcium).wont_include(:calcium)
+      end
+    end
+
     describe '.events' do
       it 'should not be visible to the client' do
         skip
       end
 
       it 'returns the Events singleton' do
-        Vedeu.events.must_be_instance_of(API::Events)
+        Vedeu.events.must_be_instance_of(Vedeu::Events)
       end
     end
 
@@ -33,36 +42,19 @@ module Vedeu
     end
 
     describe '.interface' do
-      it 'returns the all of the defined interfaces attributes after defining' \
-         ' the interface' do
-        Vedeu::Store.reset
+      it 'creates and stores a new interface' do
+        Vedeu::Buffers.reset
 
-        Vedeu.interface('Vedeu.interface').must_equal(
-          {
-            "Vedeu.interface" => {
-              name: "Vedeu.interface",
-              group: "",
-              lines: [],
-              colour: {},
-              style: "",
-              geometry: {},
-              cursor: true,
-              delay: 0.0
-            }
-          }
-        )
+        Vedeu.interface('Vedeu.interface').must_equal(true)
       end
     end
 
     describe '.keypress' do
-      it 'returns' do
-        Vedeu.keypress('k').must_equal()
-      end
-    end
+      before { event.stubs(:trigger).returns(nil) }
 
-    describe '.log' do
-      it 'returns true after writing the message to the log' do
-        Vedeu.log('some message').must_equal(true)
+      it 'returns nil' do
+        skip
+        Vedeu.keypress('k').must_equal(nil)
       end
     end
 
@@ -75,7 +67,7 @@ module Vedeu
 
     describe '.use' do
       it 'raises an exception if the interface has not been defined' do
-        Vedeu::Store.reset
+        Vedeu::Buffers.reset
 
         proc { Vedeu.use('some_interface') }.must_raise(Vedeu::EntityNotFound)
       end
@@ -104,6 +96,40 @@ module Vedeu
       end
     end
 
+    describe '.views' do
+      it 'returns the view attributes for a composition (a collection of ' \
+         'interfaces)' do
+        Vedeu.views do
+          view 'osmium'
+          view 'iridium'
+        end.must_equal(
+          {
+            interfaces: [
+              {
+                name: "osmium",
+                group: "",
+                lines: [],
+                colour: {},
+                style: "",
+                geometry: {},
+                cursor: true,
+                delay: 0.0
+              }, {
+                name: "iridium",
+                group: "",
+                lines: [],
+                colour: {},
+                style: "",
+                geometry: {},
+                cursor: true,
+                delay: 0.0
+              }
+            ]
+          }
+        )
+      end
+    end
+
     describe '.width' do
       it 'returns the terminal width' do
         IO.console.stub(:winsize, [24, 40]) do

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

@@ -3,58 +3,12 @@ require 'test_helper'
 module Vedeu
   module API
     describe Interface do
+      before { Vedeu::Buffers.reset }
       describe '#define' do
-        before { Vedeu::Store.reset }
-
         interface = Interface.new({ name: 'widget' })
 
         it 'creates and stores a new interface' do
-          interface.define.must_equal(
-            {
-              'widget' => {
-                name:     'widget',
-                group:    '',
-                lines:    [],
-                colour:   {},
-                style:    '',
-                geometry: {},
-                cursor:   true,
-                delay:    0.0
-              }
-            }
-          )
-        end
-
-        it 'raises an exception when the value is out of bounds' do
-          proc { interface.define { x 0 } }.must_raise(XOutOfBounds)
-        end
-
-        it 'raises an exception when the value is out of bounds' do
-          proc { interface.define { x 999 } }.must_raise(XOutOfBounds)
-        end
-
-        it 'raises an exception when the value is out of bounds' do
-          proc { interface.define { y 0 } }.must_raise(YOutOfBounds)
-        end
-
-        it 'raises an exception when the value is out of bounds' do
-          proc { interface.define { y 999 } }.must_raise(YOutOfBounds)
-        end
-
-        it 'raises an exception when the value is out of bounds' do
-          proc { interface.define { width 0 } }.must_raise(InvalidWidth)
-        end
-
-        it 'raises an exception when the value is out of bounds' do
-          proc { interface.define { width 999 } }.must_raise(InvalidWidth)
-        end
-
-        it 'raises an exception when the value is out of bounds' do
-          proc { interface.define { height 0 } }.must_raise(InvalidHeight)
-        end
-
-        it 'raises an exception when the value is out of bounds' do
-          proc { interface.define { height 999 } }.must_raise(InvalidHeight)
+          interface.define.must_equal(true)
         end
 
         it 'allows the setting of colours' do
@@ -176,7 +130,7 @@ module Vedeu
 
       describe '#build' do
         before do
-          Vedeu::Store.reset
+
           Vedeu.interface('testing_view') do
             x       1
             y       1

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

@@ -0,0 +1,71 @@
+require 'test_helper'
+
+module Vedeu
+  module API
+    describe Line do
+      describe '#stream' do
+        it 'returns the value assigned' do
+          Line.new.stream do
+            text 'Some text...'
+          end.must_equal(
+            [
+              {
+                colour: {},
+                style: [],
+                text: "Some text...",
+                width: nil,
+                align: :left
+              }
+            ]
+          )
+        end
+      end
+
+      describe '#text' do
+        it 'returns the value assigned' do
+          Line.new.text('Some text...').must_equal(
+            [
+              { text: 'Some text...' }
+            ]
+          )
+        end
+      end
+
+      describe '#foreground' do
+        it 'returns the value assigned' do
+          Line.new.foreground('#ff0000').must_equal(
+            [
+              {
+                colour: {
+                  foreground: "#ff0000"
+                },
+                style: [],
+                text: "",
+                width: nil,
+                align: :left
+              }
+            ]
+          )
+        end
+      end
+
+      describe '#background' do
+        it 'returns the value assigned' do
+          Line.new.background('#00ff00').must_equal(
+            [
+              {
+                colour: {
+                  background: "#00ff00"
+                },
+                style: [],
+                text: "",
+                width: nil,
+                align: :left
+              }
+            ]
+          )
+        end
+      end
+    end
+  end
+end