vedeu 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e3051d98a552c6a3129de526b25593c3e7f0be00
-  data.tar.gz: 32c2e964c4556e84f06f02bd0278fd466281693b
+  metadata.gz: f49a2565aad7f4e16195f4669892ace8f6d0f8c7
+  data.tar.gz: 04ddcf49ad7df1af4681bfbf0109af0f0da54037
 SHA512:
-  metadata.gz: b9fd3e03a60603baf573466fcf384b8b625fa5be156ab87e321c060eb391fbe84b1113ff4f27c1dc1a0fbc307fb536802436a894c958f864b5f1b2ea24564d8b
-  data.tar.gz: a09c6e80a05b2a44bfc029b563acbb79d09d2fd16b00355b29d074176a72090d2a2dd3745e12b17a5b414f7b2c953f50a7f7278294ae682e634e029faf101ac2
+  metadata.gz: b6712ac5a5121704148d9afeb3a8ed7655e4b523f5b71f2d8d4fd477f4feff62b45ab61a598de0064491fc682698e9cc94a53587bf0c2f6ed16f633e07bb9914
+  data.tar.gz: 8bb9e432e9178e755b68771d51f3fbfcdd8a1eba33b4bf6ed4794dfbebb6c38a97ea44a031b12dd514902e255aef82972fc3b0b5f37706297fd42ccd26f845ae

data/README.md

@@ -46,9 +46,18 @@ TODO: Write detailed documentation
       |     |     |     |-- Background < Base
       |     |     |
       |     |     |-- Position
+      |     |     |     |-- Esc
+      |     |     |
       |     |     |-- Style
       |     |           |-- Esc
       |     |
+      |     |-- Position
+      |     |     |-- Esc
+      |     |
+      |     |-- Renderer
+      |           |-- Terminal
+      |
+      |-- Geometry
       |     |-- Terminal
       |
       |-- Terminal
@@ -56,6 +65,12 @@ TODO: Write detailed documentation
     Terminal
       |-- Esc
       |-- Position
+            |-- Esc
+
+### On Interfaces
+
+When we create the interface we define it's width, height, and origin (y, x).
+These numbers are based on the area available to the terminal. If the terminal is 80x25, then our interface can use all or some of this area.
 
 
 ## Contributing

data/bin/vedeu

@@ -6,4 +6,4 @@ trap('INT') { exit! }
 
 require 'vedeu'
 
-Vedeu::Application.new(nil).start
+Vedeu::Application.start

data/lib/vedeu.rb

@@ -7,9 +7,11 @@ require_relative 'vedeu/output/background'
 require_relative 'vedeu/output/compositor'
 require_relative 'vedeu/output/directive'
 require_relative 'vedeu/output/foreground'
+require_relative 'vedeu/output/geometry'
 require_relative 'vedeu/output/esc'
 require_relative 'vedeu/output/colour'
 require_relative 'vedeu/output/position'
+require_relative 'vedeu/output/renderer'
 require_relative 'vedeu/output/style'
 require_relative 'vedeu/output/translator'
 

data/lib/vedeu/interface/interface.rb

@@ -25,7 +25,11 @@ module Vedeu
     end
 
     def output(command)
-      Compositor.write(command)
+      Compositor.write(command, self)
+    end
+
+    def geometry
+      @geometry ||= Geometry.new(options[:geometry])
     end
 
     private
@@ -40,22 +44,13 @@ module Vedeu
       Terminal.input
     end
 
-    def width
-      options[:width]
-    end
-
-    def height
-      options[:height]
-    end
-
     def options
       defaults.merge!(@options)
     end
 
     def defaults
       {
-        width:  Terminal.width,
-        height: Terminal.height
+        geometry: {}
       }
     end
   end

data/lib/vedeu/output/compositor.rb

@@ -1,34 +1,32 @@
 module Vedeu
   class Compositor
     class << self
-      def write(output = [])
+      def write(output = [], interface = Dummy)
         return if output.nil? || output.empty?
 
-        new(output).write
+        new(output, interface).write
       end
     end
 
-    def initialize(output = [])
-      @output = output
+    def initialize(output = [], interface = Dummy)
+      @output, @interface = output, interface
     end
 
     def write
-      parsed.each_with_index do |data, index|
-        clear_line(index)
-
-        write_line(data)
-      end.join("\n")
+      Renderer.write(composition)
     end
 
     private
 
-    attr_reader :output
+    attr_reader :output, :interface
 
-    def parsed
+    def composition
       container = []
       streams = []
       output.map do |line|
-        line.map do |stream|
+        line.each_with_index do |stream, index|
+          streams << clear_line(index)
+
           if stream.is_a?(String)
             streams << stream
           else
@@ -42,11 +40,47 @@ module Vedeu
     end
 
     def clear_line(index)
-      Terminal.clear_line(index)
+      [position(vy(index), vx), (" " * width), position(vy(index), vx)].join
+    end
+
+    def vx(index = 0)
+      geometry.vx(index)
+    end
+
+    def vy(index = 0)
+      geometry.vy(index)
+    end
+
+    def height
+      geometry.height
+    end
+
+    def width
+      geometry.width
+    end
+
+    def y
+      geometry.y
+    end
+
+    def dy
+      geometry.dy
+    end
+
+    def x
+      geometry.x
+    end
+
+    def dx
+      geometry.dx
+    end
+
+    def geometry
+      interface.geometry
     end
 
-    def write_line(data)
-      Terminal.output(data)
+    def position(y, x)
+      Position.set(y, x)
     end
   end
 end

data/lib/vedeu/output/geometry.rb

@@ -0,0 +1,72 @@
+module Vedeu
+  class Geometry
+    def initialize(values = {})
+      @values = values
+    end
+
+    def z
+      values[:z]
+    end
+    alias_method :layer, :z
+
+    def y
+      values[:y]
+    end
+    alias_method :row,  :y
+    alias_method :line, :y
+
+    def x
+      values[:x]
+    end
+    alias_method :column, :x
+    alias_method :col,    :x
+
+    def width
+      values[:width]
+    end
+
+    def height
+      values[:height]
+    end
+
+    def dy
+      clip_y? ? defaults[:height] : (y + height)
+    end
+
+    def dx
+      clip_x? ? defaults[:width] : (x + width)
+    end
+
+    def vx(index = 0) # virtual x position
+      ((x..dx).to_a)[index]
+    end
+
+    def vy(index = 0) # virtual y position
+      ((y..dy).to_a)[index]
+    end
+
+    private
+
+    def clip_y?
+      ((y + height) > defaults[:height])
+    end
+
+    def clip_x?
+      ((x + width) > defaults[:width])
+    end
+
+    def values
+      defaults.merge(@values)
+    end
+
+    def defaults
+      {
+        width:  Terminal.width,
+        height: Terminal.height,
+        z:      0,
+        y:      1,
+        x:      1
+      }
+    end
+  end
+end

data/lib/vedeu/output/renderer.rb

@@ -0,0 +1,21 @@
+module Vedeu
+  class Renderer
+    class << self
+      def write(composition)
+        new(composition).write
+      end
+    end
+
+    def initialize(composition)
+      @composition = composition
+    end
+
+    def write
+      composition.map { |stream| Terminal.output(stream) }
+    end
+
+    private
+
+    attr_reader :composition
+  end
+end

data/lib/vedeu/support/terminal.rb

@@ -6,7 +6,7 @@ module Vedeu
       end
 
       def output(stream = '')
-        console.puts(stream)
+        console.print(stream)
       end
 
       def width
@@ -35,7 +35,7 @@ module Vedeu
         console.cooked do
           instance.initial_setup!
 
-          yield
+          yield instance
         end if block_given?
       end
       alias_method :open_cooked, :cooked
@@ -44,7 +44,7 @@ module Vedeu
         console.raw do
           instance.initial_setup!
 
-          yield
+          yield instance
         end if block_given?
       end
       alias_method :open_raw, :raw

data/lib/vedeu/version.rb

@@ -1,3 +1,3 @@
 module Vedeu
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

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

@@ -2,39 +2,40 @@ require_relative '../../../test_helper'
 
 module Vedeu
   describe Interface do
-    let(:described_class) { Interface }
-    let(:instance)        { described_class.new(options) }
-    let(:options)         { {} }
+    let(:described_class)    { Interface }
+    let(:described_instance) { described_class.new(options) }
+    let(:options)            { {} }
 
-    before do
-      Terminal.stubs(:width).returns(80)
-      Terminal.stubs(:height).returns(25)
-    end
-
-    it { instance.must_be_instance_of(Interface) }
+    it { described_instance.must_be_instance_of(Interface) }
 
     describe '#initial_state' do
-      subject { instance.initial_state }
+      subject { described_instance.initial_state }
 
       it { proc { subject }.must_raise(NotImplementedError) }
     end
 
     describe '#event_loop' do
-      subject { instance.event_loop }
+      subject { described_instance.event_loop }
 
       it { skip }
     end
 
     describe '#input' do
-      subject { instance.input }
+      subject { described_instance.input }
 
       it { skip }
     end
 
     describe '#output' do
-      subject { instance.output }
+      subject { described_instance.output }
 
       it { skip }
     end
+
+    describe '#geometry' do
+      subject { described_instance.geometry }
+
+      it { subject.must_be_instance_of(Geometry) }
+    end
   end
 end

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

@@ -3,101 +3,128 @@ require_relative '../../../test_helper'
 module Vedeu
   describe Compositor do
     let(:described_class) { Compositor }
-    let(:instance) { described_class.new(rows) }
-    let(:rows)     { [[]] }
-
-    before { Terminal.stubs(:output) }
+    let(:instance)        { described_class.new(output, interface) }
+    let(:output)          { [[]] }
+    let(:stream)          {}
+    let(:interface)       {
+      Vedeu::Interface.new({
+        geometry: {
+          y: 2,
+          x: 2,
+          width: 20,
+          height: 10
+        }
+      })
+    }
+
+    before do
+      Terminal.stubs(:output)
+      Renderer.stubs(:write).returns(stream)
+    end
 
     it { instance.must_be_instance_of(Compositor) }
 
     describe '.write' do
-      subject { described_class.write(rows) }
-
-      it { subject.must_be_instance_of(String) }
+      subject { described_class.write(output, interface) }
 
       context 'when empty' do
-        let(:rows) { [] }
+        let(:output) { [] }
 
         it { subject.must_be_instance_of(NilClass) }
       end
 
       context 'when unstyled' do
         context 'and a single line' do
-          let(:rows) { [['Some text...']] }
+          let(:output) { [['Some text...']] }
+          let(:stream) { 'Some text...' }
 
-          it { subject.must_equal('Some text...') }
+          it { subject.must_equal(stream) }
         end
 
         context 'and multi-line' do
-          let(:rows) {
+          let(:output) {
             [
               ['Some text...'],
               ['Some more text...']
             ]
           }
+          let(:stream) { "Some text...\nSome more text..." }
 
-          it { subject.must_equal("Some text...\nSome more text...") }
+          it { subject.must_equal(stream) }
         end
       end
 
       context 'when styled' do
         context 'with colour pair' do
           context 'and a single line' do
-            let(:rows) {
+            let(:output) {
               [
                 [[:red, :white], 'Some text...']
               ]
             }
+            let(:stream) { "\e[38;5;31m\e[48;5;47mSome text..." }
 
-            it { subject.must_equal("\e[38;5;31m\e[48;5;47mSome text...") }
+            it { subject.must_equal(stream) }
           end
 
           context 'and multi-line' do
-            let(:rows) {
+            let(:output) {
               [
                 [[:red, :white],   'Some text...'],
                 [[:blue, :yellow], 'Some more text...']
               ]
             }
+            let(:stream) {
+              "\e[38;5;31m\e[48;5;47mSome text...\n" \
+              "\e[38;5;34m\e[48;5;43mSome more text..."
+            }
 
-            it { subject.must_equal("\e[38;5;31m\e[48;5;47mSome text...\n" \
-                                    "\e[38;5;34m\e[48;5;43mSome more text...") }
+            it { subject.must_equal(stream) }
           end
         end
 
         context 'with a style' do
           context 'and a single line' do
-            let(:rows) {
+            let(:output) {
               [
                 [:bold, 'Some text...']
               ]
             }
+            let(:stream) {
+              "\e[1mSome text..."
+            }
 
-            it { subject.must_equal("\e[1mSome text...") }
+            it { subject.must_equal(stream) }
           end
 
           context 'and multi-line' do
-            let(:rows) {
+            let(:output) {
               [
                 [:inverse,   'Some text...'],
                 [:underline, 'Some more text...']
               ]
             }
+            let(:stream) {
+              "\e[7mSome text...\n" \
+              "\e[4mSome more text..."
+            }
 
-            it { subject.must_equal("\e[7mSome text...\n" \
-                                    "\e[4mSome more text...") }
+            it { subject.must_equal(stream) }
           end
         end
 
         context 'with an unknown style' do
-          let(:rows) {
+          let(:output) {
             [
               [:unknown, 'Some text...']
             ]
           }
+          let(:stream) {
+            "Some text..."
+          }
 
           it 'renders in the default style' do
-            subject.must_equal("Some text...")
+            subject.must_equal(stream)
           end
         end
       end

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

@@ -0,0 +1,118 @@
+require_relative '../../../test_helper'
+
+module Vedeu
+  describe Geometry do
+    let(:described_class)    { Geometry }
+    let(:described_instance) { described_class.new(values) }
+    let(:values)             { {} }
+
+    before do
+      Terminal.stubs(:width).returns(80)
+      Terminal.stubs(:height).returns(25)
+    end
+
+    it { described_instance.must_be_instance_of(Geometry) }
+
+    describe '#z' do
+      subject { described_instance.z }
+
+      context 'using a value' do
+        let(:values) { { z: 2 } }
+
+        it { subject.must_equal(2) }
+      end
+
+      context 'using the default' do
+        it { subject.must_equal(0) }
+      end
+    end
+
+    describe '#y' do
+      subject { described_instance.y }
+
+      context 'using a value' do
+        let(:values) { { y: 17 } }
+
+        it { subject.must_equal(17) }
+      end
+
+      context 'using the default' do
+        it { subject.must_equal(1) }
+      end
+    end
+
+    describe '#x' do
+      subject { described_instance.x }
+
+      context 'using a value' do
+        let(:values) { { x: 33 } }
+
+        it { subject.must_equal(33) }
+      end
+
+      context 'using the default' do
+        it { subject.must_equal(1) }
+      end
+    end
+
+    describe '#width' do
+      subject { described_instance.width }
+
+      context 'using a value' do
+        let(:values) { { width: 50 } }
+
+        it { subject.must_equal(50) }
+      end
+
+      context 'using the default' do
+        it { subject.must_equal(80) }
+      end
+    end
+
+    describe '#height' do
+      subject { described_instance.height }
+
+      context 'using a value' do
+        let(:values) { { height: 20 } }
+
+        it { subject.must_equal(20) }
+      end
+
+      context 'using the default' do
+        it { subject.must_equal(25) }
+      end
+    end
+
+    describe '#dy' do
+      subject { described_instance.dy }
+
+      context 'when the value is greater than the available terminal size' do
+        it 'clips the value to the terminal size' do
+          subject.must_equal(25)
+        end
+      end
+
+      context 'when the value is less than the available size' do
+        let(:values) { { y: 20, height: 4 } }
+
+        it { subject.must_equal(24) }
+      end
+    end
+
+    describe '#dx' do
+      subject { described_instance.dx }
+
+      context 'when the value is greater than the available terminal size' do
+        it 'clips the value to the terminal size' do
+          subject.must_equal(80)
+        end
+      end
+
+      context 'when the value is less than the available size' do
+        let(:values) { { x: 17, width: 21 } }
+
+        it { subject.must_equal(38) }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+require_relative '../../../test_helper'
+
+module Vedeu
+  describe Renderer do
+    let(:described_class)    { Renderer }
+    let(:described_instance) { described_class.new(composition) }
+    let(:composition)        {}
+  end
+end

data/test/lib/vedeu/support/terminal_test.rb

@@ -8,6 +8,7 @@ module Vedeu
     before do
       IO.stubs(:console).returns(console)
       console.stubs(:winsize).returns([25, 80])
+      console.stubs(:print)
     end
 
     describe '.input' do
@@ -19,7 +20,7 @@ module Vedeu
     end
 
     describe '.output' do
-      before { console.stubs(:puts).returns("test") }
+      before { console.stubs(:print).returns("test") }
 
       subject { described_class.output }
 
@@ -87,10 +88,7 @@ module Vedeu
     end
 
     describe '.clear_screen' do
-      before do
-        Esc.stubs(:clear).returns('')
-        console.stubs(:puts)
-      end
+      before { Esc.stubs(:clear).returns('') }
 
       subject { described_class.clear_screen }
 
@@ -110,8 +108,6 @@ module Vedeu
     end
 
     describe '.show_cursor' do
-      before { console.stubs(:puts) }
-
       subject { described_class.show_cursor }
 
       it { subject.must_be_instance_of(NilClass) }
@@ -124,8 +120,6 @@ module Vedeu
     end
 
     describe '.hide_cursor' do
-      before { console.stubs(:puts) }
-
       subject { described_class.hide_cursor }
 
       it { subject.must_be_instance_of(NilClass) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vedeu
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Gavin Laking
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-22 00:00:00.000000000 Z
+date: 2014-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -164,7 +164,9 @@ files:
 - lib/vedeu/output/directive.rb
 - lib/vedeu/output/esc.rb
 - lib/vedeu/output/foreground.rb
+- lib/vedeu/output/geometry.rb
 - lib/vedeu/output/position.rb
+- lib/vedeu/output/renderer.rb
 - lib/vedeu/output/style.rb
 - lib/vedeu/output/translator.rb
 - lib/vedeu/process/command.rb
@@ -183,7 +185,9 @@ files:
 - test/lib/vedeu/output/directive_test.rb
 - test/lib/vedeu/output/esc_test.rb
 - test/lib/vedeu/output/foreground_test.rb
+- test/lib/vedeu/output/geometry_test.rb
 - test/lib/vedeu/output/position_test.rb
+- test/lib/vedeu/output/renderer_test.rb
 - test/lib/vedeu/output/style_test.rb
 - test/lib/vedeu/output/translator_test.rb
 - test/lib/vedeu/process/command_test.rb
@@ -191,7 +195,6 @@ files:
 - test/lib/vedeu/process/exit_test.rb
 - test/lib/vedeu/support/terminal_test.rb
 - test/lib/vedeu/version_test.rb
-- test/support/test_app/bin/testapp
 - test/test_helper.rb
 - vedeu.gemspec
 homepage: http://www.gavinlaking.name/
@@ -230,7 +233,9 @@ test_files:
 - test/lib/vedeu/output/directive_test.rb
 - test/lib/vedeu/output/esc_test.rb
 - test/lib/vedeu/output/foreground_test.rb
+- test/lib/vedeu/output/geometry_test.rb
 - test/lib/vedeu/output/position_test.rb
+- test/lib/vedeu/output/renderer_test.rb
 - test/lib/vedeu/output/style_test.rb
 - test/lib/vedeu/output/translator_test.rb
 - test/lib/vedeu/process/command_test.rb
@@ -238,6 +243,5 @@ test_files:
 - test/lib/vedeu/process/exit_test.rb
 - test/lib/vedeu/support/terminal_test.rb
 - test/lib/vedeu/version_test.rb
-- test/support/test_app/bin/testapp
 - test/test_helper.rb
 has_rdoc: 

data/test/support/test_app/bin/testapp

@@ -1,24 +0,0 @@
-#!/usr/bin/env ruby
-
--> { its -> { a } }
-trap('INT') { exit! }
-
-require_relative '../../../../lib/vedeu'
-
-class Fake
-  def self.dispatch
-    puts "Fake dispatched..."
-    [
-      [[17, 6], [:red,   :white], "Fake executed...", :reset],
-      [[19, 5], [:green, :white], "Test executed...", :reset],
-    ]
-  end
-end
-
-Vedeu::Interfaces.default
-
-Vedeu::Commands.define do |command|
-  command.add("test", Fake)
-end
-
-Vedeu::Application.start