vedeu 0.4.1 → 0.4.2

data/lib/vedeu/support/template.rb

@@ -0,0 +1,39 @@
+require 'erb'
+
+module Vedeu
+
+  # Generic class to loading a template and parsing it via ERb.
+  #
+  class Template
+
+    # @param object [Class]
+    # @param path [String]
+    # @return [void]
+    def self.parse(object, path)
+      new(object, path).parse
+    end
+
+    # @param object [Class]
+    # @param path [String]
+    # @return [Template]
+    def initialize(object, path)
+      @object, @path = object, path
+    end
+
+    # @return [void]
+    def parse
+      ERB.new(load, nil, '-').result(binding)
+    end
+
+    private
+
+    attr_reader :object, :path
+
+    # @return [String]
+    def load
+      File.read(path)
+    end
+
+  end # Template
+
+end # Vedeu

data/lib/vedeu/support/terminal.rb

@@ -135,7 +135,7 @@ module Vedeu
     def cooked_mode!
       Vedeu.log(type: :info, message: "Terminal switching to 'cooked' mode")
 
-      @_mode = :cooked
+      @mode = :cooked
     end
 
     # Returns a boolean indicating whether the terminal is currently in `raw`
@@ -152,7 +152,7 @@ module Vedeu
     def raw_mode!
       Vedeu.log(type: :info, message: "Terminal switching to 'raw' mode")
 
-      @_mode = :raw
+      @mode = :raw
     end
 
     # Toggles the terminal's mode between `cooked` and `raw`, depending on its
@@ -169,7 +169,7 @@ module Vedeu
     #
     # @return [Symbol]
     def mode
-      @_mode ||= Configuration.terminal_mode
+      @mode ||= Configuration.terminal_mode
     end
 
     # Returns a coordinate tuple of the format [y, x], where `y` is the row/line

data/lib/vedeu/support/text.rb

@@ -19,7 +19,7 @@ module Vedeu
     # @return [Text]
     def initialize(value = '', options = {})
       @value   = value
-      @options = defaults.merge(options)
+      @options = defaults.merge!(options)
     end
 
     # Aligns the value.

data/lib/vedeu/support/trace.rb

@@ -114,7 +114,7 @@ module Vedeu
 
     # @return [Hash]
     def options
-      defaults.merge(@options)
+      defaults.merge!(@options)
     end
 
     # The default values for a new instance of this class.
@@ -143,21 +143,21 @@ module Vedeu
     #
     # @return [String]
     def class_count
-      @_count ||= "(#{classes.size}/#{vedeu_classes.size})"
+      @count ||= "(#{classes.size}/#{vedeu_classes.size})"
     end
 
     # Returns the classes to be traced, without exceptions or ignored classes.
     #
     # @return [Set]
     def classes
-      @_classes ||= vedeu_classes - vedeu_exceptions - ignored_classes
+      @classes ||= vedeu_classes - vedeu_exceptions - ignored_classes
     end
 
     # Returns all the classes defined within Vedeu.
     #
     # @return [Set]
     def vedeu_classes
-      @_vedeu_classes ||= Vedeu.constants.collect do |c|
+      @vedeu_classes ||= Vedeu.constants.collect do |c|
         Vedeu.const_get(c).to_s
       end.to_set
     end

data/lib/vedeu/support/visible.rb

@@ -6,6 +6,7 @@ module Vedeu
   #
   class Visible
 
+    # @param visible [Boolean|Symbol]
     # @return [Visible]
     def self.coerce(value)
       if value.is_a?(self)
@@ -17,6 +18,7 @@ module Vedeu
       end
     end
 
+    # @param visible [Boolean|Symbol]
     # @return [Visible]
     def initialize(visible = nil)
       @visible = if visible == :hide || visible == false
@@ -31,13 +33,6 @@ module Vedeu
       end
     end
 
-    # Returns log friendly output.
-    #
-    # @return [String]
-    def inspect
-      "<#{self.class.name} (#{@visible.to_s})>"
-    end
-
     # @return [String]
     def cursor
       if visible?

data/test/lib/vedeu/buffers/buffer_test.rb

@@ -23,12 +23,6 @@ module Vedeu
       it { instance.instance_variable_get('@repository').must_equal(Vedeu.buffers) }
     end
 
-    describe '#inspect' do
-      subject { instance.inspect }
-
-      it { subject.must_equal('<Vedeu::Buffer ( back?:false front?:false previous?:false )>') }
-    end
-
     describe '#add' do
       let(:back) {
         Vedeu.interface 'buffer' do

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

@@ -39,12 +39,6 @@ module Vedeu
       it { instance.instance_variable_get('@position').must_be_instance_of(Vedeu::Position) }
     end
 
-    describe '#inspect' do
-      subject { instance.inspect }
-
-      it { subject.must_equal('<Vedeu::Cursor (silver: x:19 y:8 ox:3 oy:2)>') }
-    end
-
     describe '#to_s' do
       let(:state) { true }
 

data/test/lib/vedeu/{support → geometry}/content_geometry_test.rb

@@ -26,12 +26,6 @@ module Vedeu
       it { instance.instance_variable_get('@interface').must_equal(interface) }
     end
 
-    describe '#inspect' do
-      subject { instance.inspect }
-
-      it { subject.must_equal('<Vedeu::ContentGeometry (y:1 x:1 yn:3 xn:5)>') }
-    end
-
     describe '#yn' do
       subject { instance.yn }
 

data/test/lib/vedeu/{support → geometry}/coordinate_test.rb

@@ -19,14 +19,6 @@ module Vedeu
       it { instance.instance_variable_get('@y').must_equal(y) }
     end
 
-    describe '#inspect' do
-      subject { instance.inspect }
-
-      it { subject.must_equal(
-        '<Vedeu::Coordinate ( height:6 width:6 x:7 xn:13 y:5 yn:11 )>'
-      ) }
-    end
-
     describe '#yn' do
       subject { instance.yn }
 

data/test/lib/vedeu/{support → geometry}/position_test.rb

@@ -34,17 +34,19 @@ module Vedeu
         it { subject.x.must_equal(8) }
       end
 
+      context 'when the value is a Hash' do
+        let(:value) { { y: 3, x: 9 } }
+
+        it { subject.must_be_instance_of(described) }
+        it { subject.y.must_equal(3) }
+        it { subject.x.must_equal(9) }
+      end
+
       context 'when the value is something unhandled' do
         it { subject.must_be_instance_of(NilClass) }
       end
     end
 
-    describe '#inspect' do
-      subject { instance.inspect }
-
-      it { subject.must_equal("<Vedeu::Position (y:12 x:19)>") }
-    end
-
     describe '#==' do
       let(:other) {}
 

data/test/lib/vedeu/input/key_test.rb

@@ -8,18 +8,6 @@ module Vedeu
     let(:instance)  { described.new(input) { :output } }
     let(:input)     { 'a' }
 
-    describe '.build' do
-      subject { described.build(input) { :output } }
-
-      it { subject.must_be_instance_of(Key) }
-
-      context 'when the required block is not given' do
-        subject { described.build(input) }
-
-        it { proc { subject }.must_raise(InvalidSyntax) }
-      end
-    end
-
     describe '#initialize' do
       it { instance.must_be_instance_of(Key) }
       it { instance.instance_variable_get('@input').must_equal(input) }

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

@@ -40,14 +40,6 @@ module Vedeu
       end
     end
 
-    describe '#inspect' do
-      subject { instance.inspect }
-
-      it { subject.must_equal(
-        '<Vedeu::Geometry (height:(25/24) width:(80/79) top:1 bottom:25 left:1 right:80)>'
-      ) }
-    end
-
     describe '#y' do
       subject { instance.y }
 
@@ -148,45 +140,6 @@ module Vedeu
       end
     end
 
-    describe '#origin' do
-      it 'returns the origin for the interface' do
-        geometry = Geometry.new({ width: 5, height: 5 })
-        geometry.origin.must_be_instance_of(Vedeu::Position)
-        geometry.origin.y.must_equal(1)
-        geometry.origin.x.must_equal(1)
-      end
-
-      it 'returns the origin for the interface' do
-        geometry = Geometry.new({ width: 5, height: 5, centred: true })
-        geometry.origin.must_be_instance_of(Vedeu::Position)
-        geometry.origin.y.must_equal(10)
-        geometry.origin.x.must_equal(38)
-      end
-
-      it 'returns the line position relative to the origin' do
-        geometry = Geometry.new({ width: 5, height: 5 })
-        geometry.origin(3).must_be_instance_of(Vedeu::Position)
-        geometry.origin(3).y.must_equal(4)
-        geometry.origin(3).x.must_equal(1)
-      end
-
-      it 'returns the origin for the interface when the interface' \
-         ' is at a custom position' do
-        geometry = Geometry.new({ width: 5, height: 5, x: 3, y: 6 })
-        geometry.origin.must_be_instance_of(Vedeu::Position)
-        geometry.origin.y.must_equal(6)
-        geometry.origin.x.must_equal(3)
-      end
-
-      it 'returns the line position relative to the origin when the' \
-         ' interface is at a custom position' do
-        geometry = Geometry.new({ width: 5, height: 5, x: 3, y: 6 })
-        geometry.origin(3).must_be_instance_of(Vedeu::Position)
-        geometry.origin(3).y.must_equal(9)
-        geometry.origin(3).x.must_equal(3)
-      end
-    end
-
     describe '#top' do
       it 'centred is true' do
         console = IO.console

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

@@ -33,19 +33,13 @@ module Vedeu
 
     describe '#initialize' do
       it { instance.must_be_instance_of(Char) }
-      it { instance.instance_variable_get('@colour').must_be_instance_of(Vedeu::Colour) }
+      it { instance.instance_variable_get('@colour').must_equal(colour) }
       it { instance.instance_variable_get('@parent').must_equal(parent) }
       it { instance.instance_variable_get('@style').must_equal(style) }
       it { instance.instance_variable_get('@value').must_equal(value) }
       it { instance.instance_variable_get('@position').must_equal(position) }
     end
 
-    describe '#inspect' do
-      subject { instance.inspect }
-
-      it { subject.must_equal("<Vedeu::Char (value:'a')>") }
-    end
-
     describe '#value' do
       subject { instance.value }
 
@@ -84,10 +78,12 @@ module Vedeu
       end
 
       context 'when a colour is specified' do
-        let(:colour) { Colour.new({ foreground: '#00ff00', background: '#005500' }) }
+        let(:colour) { Colour.new({ foreground: '#00ff00',
+                                    background: '#005500' }) }
 
         context 'when a parent colour is specified' do
-          let(:parent_colour) { Colour.new({ foreground: '#ff0000', background: '#550000' }) }
+          let(:parent_colour) { Colour.new({ foreground: '#ff0000',
+                                             background: '#550000' }) }
 
           it { subject.must_equal("\e[38;2;0;255;0m\e[48;2;0;85;0ma\e[38;2;255;0;0m\e[48;2;85;0;0m") }
         end

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

@@ -30,14 +30,8 @@ module Vedeu
     describe '#initialize' do
       it { instance.must_be_instance_of(described) }
       it { instance.instance_variable_get('@interfaces').must_equal(interfaces) }
-      it { instance.instance_variable_get('@colour').must_be_instance_of(Vedeu::Colour) }
-      it { instance.instance_variable_get('@style').must_be_instance_of(Vedeu::Style) }
-    end
-
-    describe '#inspect' do
-      subject { instance.inspect }
-
-      it { subject.must_equal('<Vedeu::Composition (interfaces:0)>') }
+      it { instance.instance_variable_get('@colour').must_equal(colour) }
+      it { instance.instance_variable_get('@style').must_equal(style) }
     end
 
   end # Composition

data/test/lib/vedeu/models/view/interface_test.rb

@@ -25,8 +25,8 @@ module Vedeu
       it { instance.instance_variable_get('@name').must_equal(_name) }
       it { instance.instance_variable_get('@lines').must_equal(lines) }
       it { instance.instance_variable_get('@parent').must_equal(parent) }
-      it { instance.instance_variable_get('@colour').must_be_instance_of(Vedeu::Colour) }
-      it { instance.instance_variable_get('@style').must_be_instance_of(Vedeu::Style) }
+      it { instance.instance_variable_get('@colour').must_equal(colour) }
+      it { instance.instance_variable_get('@style').must_equal(style) }
       it { instance.instance_variable_get('@border').must_equal(nil) }
       it { instance.instance_variable_get('@delay').must_equal(0.0) }
       it { instance.instance_variable_get('@geometry').must_equal(nil) }
@@ -68,12 +68,6 @@ module Vedeu
       it { subject.must_be_instance_of(Vedeu::Cursor) }
     end
 
-    describe '#inspect' do
-      subject { instance.inspect }
-
-      it { subject.must_equal('<Vedeu::Interface (lines:0)>') }
-    end
-
     describe '#store' do
       subject { instance.store }
 

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

@@ -138,12 +138,6 @@ module Vedeu
       end
     end
 
-    describe '#inspect' do
-      subject { instance.inspect }
-
-      it { subject.must_equal('<Vedeu::Line (streams:3)>') }
-    end
-
     describe '#size' do
       subject { instance.size }
 

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

@@ -90,12 +90,6 @@ module Vedeu
       end
     end
 
-    describe '#inspect' do
-      subject { instance.inspect }
-
-      it { subject.must_equal('<Vedeu::Stream (value:Some text, size:9)>') }
-    end
-
     describe '#size' do
       subject { instance.size }
 

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

@@ -62,10 +62,10 @@ module Vedeu
           vertical:     'x',
         })
       }
-      it { instance.instance_variable_get('@colour').must_be_instance_of(Vedeu::Colour) }
+      it { instance.instance_variable_get('@colour').must_equal({}) }
       it { instance.instance_variable_get('@name').must_equal('borders') }
       it { instance.instance_variable_get('@repository').must_be_instance_of(Vedeu::Borders) }
-      it { instance.instance_variable_get('@style').must_be_instance_of(Vedeu::Style) }
+      it { instance.instance_variable_get('@style').must_equal([]) }
     end
 
     describe '#width' do

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

@@ -11,7 +11,6 @@ module Vedeu
     describe '#initialize' do
       it { instance.must_be_instance_of(Vedeu::HTMLRenderer) }
       it { instance.instance_variable_get('@output').must_equal(output) }
-      it { instance.instance_variable_get('@object').must_be_instance_of(Vedeu::HTMLRenderer) }
     end
 
     describe '#render' do