vedeu 0.1.3 → 0.1.4

data/lib/vedeu/support/helpers.rb

@@ -1,3 +1,4 @@
+require 'pry'
 require 'vedeu/support/esc'
 require 'vedeu/models/colour'
 
@@ -5,41 +6,61 @@ require 'vedeu/models/colour'
 
 module Vedeu
   module Helpers
+    def line(&block)
+      output = capture(&block)
+      ERB.new(output.gsub(/\n/, ''), nil, '-').result(block.binding)
+    end
+
     def foreground(value, &block)
-      @output = ''
-      @output << Esc.foreground_colour(value)
-      @output << block.call if block_given?
-      @output
+      output = Esc.foreground_colour(value)
+
+      if block_given?
+        output << block.call
+        output << Esc.string('fg_reset')
+      end
+
+      output
     end
     alias_method :fg, :foreground
 
     def background(value, &block)
-      @output = ''
-      @output << Esc.background_colour(value)
-      @output << block.call if block_given?
-      @output
+      output = Esc.background_colour(value)
+
+      if block_given?
+        output << block.call
+        output << Esc.string('bg_reset')
+      end
+
+      output
     end
     alias_method :bg, :background
 
     def colour(attributes = {}, &block)
-      @output = ''
-      @output << Colour.new(attributes).to_s
-      @output << block.call if block_given?
-      @output
+      output = Colour.new(attributes).to_s
+
+      if block_given?
+        output << block.call
+        output << Esc.string('colour_reset')
+      end
+
+      output
     end
 
     def style(*value_or_values, &block)
-      @output = ''
       if value_or_values.one?
-        @output << Esc.string(value_or_values.first)
-        @output << block.call if block_given?
+        output = Esc.string(value_or_values.first)
       else
-        @output << value_or_values.map do |s|
+        output = value_or_values.map do |s|
           Esc.string(s)
         end.join
-        @output << block.call if block_given?
       end
-      @output
+
+      if block_given?
+        output << block.call
+        output << Esc.string('reset')
+      end
+
+      output
     end
   end
 end

data/lib/vedeu/support/interface_template.rb

@@ -1,7 +1,13 @@
-require 'vedeu/support/geometry'
+require 'vedeu/models/geometry'
 require 'vedeu/support/interface_store'
+require 'vedeu/support/terminal'
 
 module Vedeu
+  InvalidHeight = Class.new(StandardError)
+  InvalidWidth  = Class.new(StandardError)
+  XOutOfBounds  = Class.new(StandardError)
+  YOutOfBounds  = Class.new(StandardError)
+
   class InterfaceTemplate
     def self.save(name, &block)
       new(name).save(&block)
@@ -17,35 +23,52 @@ module Vedeu
       InterfaceStore.create(attributes)
     end
 
-    private
+    def x(value)
+      fail XOutOfBounds if x_out_of_bounds?(value)
 
-    attr_reader :name
+      attributes[:geometry][:x] = value
+    end
+
+    def y(value)
+      fail YOutOfBounds if y_out_of_bounds?(value)
 
-    def overrides
-      @overrides = if user_attributes[:centred] == true
-        { x: geometry.left, y: geometry.top }
-      else
-        {}
-      end
+      attributes[:geometry][:y] = value
     end
 
-    def geometry
-      @_geometry ||= Geometry.new({
-        height: user_attributes[:height],
-        width:  user_attributes[:width],
-      })
+    def width(value)
+      fail InvalidWidth if x_out_of_bounds?(value)
+
+      attributes[:geometry][:width] = value
     end
 
-    def attributes
-      user_attributes.merge!(overrides)
+    def height(value)
+      fail InvalidHeight if y_out_of_bounds?(value)
+
+      attributes[:geometry][:height] = value
     end
 
-    def user_attributes
-      @attributes ||= { name: name }
+    def centred(value)
+      attributes[:geometry][:centred] = value
+    end
+
+    private
+
+    attr_reader :name
+
+    def attributes
+      @attributes ||= { name: name, geometry: {} }
     end
 
     def method_missing(method_name, arg, &block)
-      user_attributes[method_name] = arg
+      attributes[method_name] = arg
+    end
+
+    def y_out_of_bounds?(value)
+      value < 1 || value > Terminal.height
+    end
+
+    def x_out_of_bounds?(value)
+      value < 1 || value > Terminal.width
     end
   end
 end

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

@@ -10,8 +10,10 @@ module Vedeu
           interfaces: [
             {
               name: 'Composition.enqueue_1',
-              width: 35,
-              height: 5,
+              geometry: {
+                width: 35,
+                height: 5,
+              },
               lines: {
                 streams: {
                   text: 'bd459118e6175689e4394e242debc2ae'
@@ -19,8 +21,10 @@ module Vedeu
               }
             }, {
               name: 'Composition.enqueue_2',
-              width: 35,
-              height: 5,
+              geometry: {
+                width: 35,
+                height: 5,
+              },
               lines: {
                 streams: {
                   text: '837acb2cb2ea3ef359257851142a7830'
@@ -45,8 +49,10 @@ module Vedeu
         Composition.new({
           interfaces: {
             name:   'dummy',
-            width:  5,
-            height: 5
+            geometry: {
+              width:  5,
+              height: 5
+            }
           }
         }).interfaces.first.must_be_instance_of(Interface)
       end
@@ -58,7 +64,7 @@ module Vedeu
 
     describe '#to_s' do
       it 'returns the stringified content for a single interface, single line, single stream' do
-        InterfaceStore.create({ name: 'int1_lin1_str1', y: 3, x: 3, width: 15, height: 3 })
+        InterfaceStore.create({ name: 'int1_lin1_str1', geometry: { y: 3, x: 3, width: 15, height: 3 } })
         json = File.read('test/support/json/int1_lin1_str1.json')
         attributes = JSON.load(json, nil, symbolize_names: true)
 
@@ -71,7 +77,7 @@ module Vedeu
       end
 
       it 'returns the stringified content for a single interface, single line, multiple streams' do
-        InterfaceStore.create({ name: 'int1_lin1_str3', y: 3, x: 3, width: 30, height: 3 })
+        InterfaceStore.create({ name: 'int1_lin1_str3', geometry: { y: 3, x: 3, width: 30, height: 3 } })
         json = File.read('test/support/json/int1_lin1_str3.json')
         attributes = JSON.load(json, nil, symbolize_names: true)
 
@@ -84,7 +90,7 @@ module Vedeu
       end
 
       it 'returns the stringified content for a single interface, multiple lines, single stream' do
-        InterfaceStore.create({ name: 'int1_lin2_str1', y: 3, x: 3, width: 15, height: 3 })
+        InterfaceStore.create({ name: 'int1_lin2_str1', geometry: { y: 3, x: 3, width: 15, height: 3 } })
         json = File.read('test/support/json/int1_lin2_str1.json')
         attributes = JSON.load(json, nil, symbolize_names: true)
 
@@ -98,7 +104,7 @@ module Vedeu
       end
 
       it 'returns the stringified content for a single interface, multiple lines, multiple streams' do
-        InterfaceStore.create({ name: 'int1_lin2_str3', y: 3, x: 3, width: 30, height: 3 })
+        InterfaceStore.create({ name: 'int1_lin2_str3', geometry: { y: 3, x: 3, width: 30, height: 3 } })
         json = File.read('test/support/json/int1_lin2_str3.json')
         attributes = JSON.load(json, nil, symbolize_names: true)
 
@@ -114,7 +120,7 @@ module Vedeu
       it 'returns the stringified content for a single interface, multiple lines, multiple streams, streams contain styles' do
         json = File.read('test/support/json/int1_lin2_str3_styles.json')
         attributes = JSON.load(json, nil, symbolize_names: true)
-        InterfaceStore.create({ name: 'int1_lin2_str3_styles', y: 3, x: 3, width: 30, height: 3 })
+        InterfaceStore.create({ name: 'int1_lin2_str3_styles', geometry: { y: 3, x: 3, width: 30, height: 3 } })
 
         Composition.new(attributes).to_s.must_equal(
           "\e[3;3H                              \e[3;3H" \
@@ -125,8 +131,8 @@ module Vedeu
       end
 
       it 'returns the stringified content for multiple interfaces, single line, single stream' do
-        InterfaceStore.create({ name: 'int2_lin1_str1_1', y: 3, x: 3, width: 15, height: 3 })
-        InterfaceStore.create({ name: 'int2_lin1_str1_2', y: 6, x: 6, width: 15, height: 3 })
+        InterfaceStore.create({ name: 'int2_lin1_str1_1', geometry: { y: 3, x: 3, width: 15, height: 3 } })
+        InterfaceStore.create({ name: 'int2_lin1_str1_2', geometry: { y: 6, x: 6, width: 15, height: 3 } })
         json = File.read('test/support/json/int2_lin1_str1.json')
         attributes = JSON.load(json, nil, symbolize_names: true)
 
@@ -143,8 +149,8 @@ module Vedeu
       end
 
       it 'returns the stringified content for multiple interfaces, single line, multiple streams' do
-        InterfaceStore.create({ name: 'int2_lin1_str3_1', y: 3, x: 3, width: 30, height: 3 })
-        InterfaceStore.create({ name: 'int2_lin1_str3_2', y: 6, x: 6, width: 30, height: 3 })
+        InterfaceStore.create({ name: 'int2_lin1_str3_1', geometry: { y: 3, x: 3, width: 30, height: 3 } })
+        InterfaceStore.create({ name: 'int2_lin1_str3_2', geometry: { y: 6, x: 6, width: 30, height: 3 } })
         json = File.read('test/support/json/int2_lin1_str3.json')
         attributes = JSON.load(json, nil, symbolize_names: true)
 
@@ -161,8 +167,8 @@ module Vedeu
       end
 
       it 'returns the stringified content for multiple interfaces, multiple lines, single stream' do
-        InterfaceStore.create({ name: 'int2_lin2_str1_1', y: 3, x: 3, width: 15, height: 3 })
-        InterfaceStore.create({ name: 'int2_lin2_str1_2', y: 6, x: 6, width: 15, height: 3 })
+        InterfaceStore.create({ name: 'int2_lin2_str1_1', geometry: { y: 3, x: 3, width: 15, height: 3 } })
+        InterfaceStore.create({ name: 'int2_lin2_str1_2', geometry: { y: 6, x: 6, width: 15, height: 3 } })
         json = File.read('test/support/json/int2_lin2_str1.json')
         attributes = JSON.load(json, nil, symbolize_names: true)
 
@@ -181,8 +187,8 @@ module Vedeu
       end
 
       it 'returns the stringified content for multiple interfaces, multiple lines, multiple streams' do
-        InterfaceStore.create({ name: 'int2_lin2_str3_1', y: 3, x: 3, width: 30, height: 3 })
-        InterfaceStore.create({ name: 'int2_lin2_str3_2', y: 6, x: 6, width: 30, height: 3 })
+        InterfaceStore.create({ name: 'int2_lin2_str3_1', geometry: { y: 3, x: 3, width: 30, height: 3 } })
+        InterfaceStore.create({ name: 'int2_lin2_str3_2', geometry: { y: 6, x: 6, width: 30, height: 3 } })
         json = File.read('test/support/json/int2_lin2_str3.json')
         attributes = JSON.load(json, nil, symbolize_names: true)
 
@@ -201,8 +207,8 @@ module Vedeu
       end
 
       it 'returns the stringified content for multiple interfaces, multiple lines, multiple streams, streams contain styles' do
-        InterfaceStore.create({ name: 'int2_lin2_str3_styles_1', y: 3, x: 3, width: 30, height: 3 })
-        InterfaceStore.create({ name: 'int2_lin2_str3_styles_2', y: 6, x: 6, width: 30, height: 3 })
+        InterfaceStore.create({ name: 'int2_lin2_str3_styles_1', geometry: { y: 3, x: 3, width: 30, height: 3 } })
+        InterfaceStore.create({ name: 'int2_lin2_str3_styles_2', geometry: { y: 6, x: 6, width: 30, height: 3 } })
         json = File.read('test/support/json/int2_lin2_str3_styles.json')
         attributes = JSON.load(json, nil, symbolize_names: true)
 

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

@@ -0,0 +1,183 @@
+require 'test_helper'
+require 'vedeu/models/geometry'
+
+module Vedeu
+  describe Geometry do
+    describe '#origin' do
+      it 'returns the origin for the interface' do
+        geometry = Geometry.new({ width: 5, height: 5 })
+        geometry.origin.must_equal("\e[1;1H")
+      end
+
+      it 'returns the origin for the interface' do
+        console = IO.console
+        console.stub :winsize, [25, 80] do
+          geometry = Geometry.new({ width: 5, height: 5, centred: true })
+          geometry.origin.must_equal("\e[10;38H")
+        end
+      end
+
+      it 'returns the line position relative to the origin' do
+        geometry = Geometry.new({ width: 5, height: 5 })
+        geometry.origin(3).must_equal("\e[4;1H")
+      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_equal("\e[6;3H")
+      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_equal("\e[9;3H")
+      end
+    end
+
+    describe '#top' do
+      it 'centred is true' do
+        console = IO.console
+        console.stub :winsize, [12, 80] do
+          geometry = Geometry.new({ height: 6, width: 18, centred: true })
+          geometry.top.must_equal(3)
+        end
+      end
+
+      it 'centred is false' do
+        geometry = Geometry.new({ height: 6, width: 18 })
+        geometry.top.must_equal(1)
+      end
+
+      it 'centred is false and y is set' do
+        geometry = Geometry.new({ height: 6, width: 18, y: 4 })
+        geometry.top.must_equal(4)
+      end
+    end
+
+    describe '#left' do
+      it 'centred is true' do
+        console = IO.console
+        console.stub :winsize, [25, 40] do
+          geometry = Geometry.new({ height: 6, width: 18, centred: true })
+          geometry.left.must_equal(11)
+        end
+      end
+
+      it 'centred is false' do
+        geometry = Geometry.new({ height: 6, width: 18 })
+        geometry.left.must_equal(1)
+      end
+
+      it 'centred is false and x is set' do
+        geometry = Geometry.new({ height: 6, width: 18, x: 5 })
+        geometry.left.must_equal(5)
+      end
+    end
+
+    describe '#bottom' do
+      it 'centred is true' do
+        console = IO.console
+        console.stub :winsize, [20, 40] do
+          geometry = Geometry.new({ height: 6, width: 18, centred: true })
+          geometry.bottom.must_equal(13)
+        end
+      end
+
+      it 'centred is false' do
+        geometry = Geometry.new({ height: 6, width: 18 })
+        geometry.bottom.must_equal(7)
+      end
+
+      it 'centred is false and y is set' do
+        geometry = Geometry.new({ height: 6, width: 18, y: 5 })
+        geometry.bottom.must_equal(11)
+      end
+    end
+
+    describe '#right' do
+      it 'centred is true' do
+        console = IO.console
+        console.stub :winsize, [25, 40] do
+          geometry = Geometry.new({ height: 6, width: 18, centred: true })
+          geometry.right.must_equal(29)
+        end
+      end
+
+      it 'centred is false' do
+        geometry = Geometry.new({ height: 6, width: 18 })
+        geometry.right.must_equal(19)
+      end
+
+      it 'centred is false and x is set' do
+        geometry = Geometry.new({ height: 6, width: 18, x: 5 })
+        geometry.right.must_equal(23)
+      end
+    end
+
+    describe '#position' do
+      it 'centred is true' do
+        console = IO.console
+        console.stub :winsize, [25, 80] do
+          geometry = Geometry.new({ height: 6, width: 18, centred: true })
+          geometry.position.must_equal({
+            y:       9,
+            x:       31,
+            height:  6,
+            width:   18,
+            centred: true,
+            top:     9,
+            bottom:  15,
+            left:    31,
+            right:   49,
+          })
+        end
+      end
+
+      it 'centred is false and x is set' do
+        geometry = Geometry.new({ height: 6, width: 18, x: 7 })
+        geometry.position.must_equal({
+          y:       1,
+          x:       7,
+          height:  6,
+          width:   18,
+          centred: false,
+          top:     1,
+          bottom:  7,
+          left:    7,
+          right:   25,
+        })
+      end
+
+      it 'centred is false and y is set' do
+        geometry = Geometry.new({ height: 6, width: 18, y: 5 })
+        geometry.position.must_equal({
+          y:       5,
+          x:       1,
+          height:  6,
+          width:   18,
+          centred: false,
+          top:     5,
+          bottom:  11,
+          left:    1,
+          right:   19,
+        })
+      end
+
+      it 'centred is false' do
+        geometry = Geometry.new({ height: 6, width: 18 })
+        geometry.position.must_equal({
+          y:       1,
+          x:       1,
+          height:  6,
+          width:   18,
+          centred: false,
+          top:     1,
+          bottom:  7,
+          left:    1,
+          right:   19,
+        })
+      end
+    end
+  end
+end