vedeu 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2a1399f6a76d69ccbe0719a7b5fe44e830f875df
-  data.tar.gz: e12da3c72a4206b001e7e4edcebf92184bf16cfa
+  metadata.gz: 78eafb32b9a942a36cbc9ed4d65bf96542e39c03
+  data.tar.gz: 6e79f409e8be1e884060585b04066ae0995e7aac
 SHA512:
-  metadata.gz: 3ed55f709b264fea16d85ced18e5b39db468fa0a7e190ef0e05dd46fef640561d83f08efa634e97e498c92175aa042d21458f3609639795761892f376df16fcf
-  data.tar.gz: aad70ea8b6d3486cfeabebf1227b779553dcf224ffc6232e47d5b292515ea86a6eabc9b6a03a18e2433c7ef8f12ee367291beea132f264c68b2d00971eefbbe8
+  metadata.gz: 3fb0a166b340bae5d0ba423c698f6304f20777291ab316defa98b5b4dbcdf91fed7160b1c567663346052fdced575e11d32fc0aec7fc6c59cae10ce48993cccb
+  data.tar.gz: c4e0c6cdea25d795fde8bc46358f74656efc15e69609efcd390c24d8464ce9f1163dcceaf44337ecf6f9b05081e7ce2d248a692e7905ebe0899440546b190c71

data/README.md

@@ -24,32 +24,40 @@ TODO: Write detailed documentation
 
 ## Notes
 
-Application
-  |-- Interfaces
-  |     |-- Dummy < Interface
-  |
-  |-- Terminal
-        |-- Esc
-              |-- Colour
-
-Base
-  |-- Translator
-  |-- Esc
-        |-- Colour
-
-Compositor
-  |-- Colour
-  |     |-- Foreground < Base
-  |     |-- Background < Base
-  |     |-- Translator
-  |
-  |-- Esc
-        |-- Colour
-
-Interface
-  |-- Terminal
-        |-- Esc
-              |-- Colour
+    Application
+      |-- Interfaces
+      |     |-- Dummy < Interface
+      |
+      |-- Process
+      |     |-- Commands
+      |     |     |-- Command
+      |     |
+      |     |-- Compositor
+      |     |     |-- Directive
+      |     |     |     |-- Colour
+      |     |     |     |     |-- Foreground < Base
+      |     |     |     |     |-- Background < Base
+      |     |     |     |
+      |     |     |     |-- Position
+      |     |     |     |-- Style
+      |     |     |           |-- Esc
+      |     |     |
+      |     |     |-- Terminal
+      |     |
+      |     |-- Terminal
+      |
+      |-- Terminal
+
+    Base
+      |-- Translator
+      |-- Esc
+
+    Interface
+      |-- Terminal
+
+    Terminal
+      |-- Esc
+      |-- Position
 
 
 ## Contributing

data/lib/vedeu.rb

@@ -16,9 +16,11 @@ require_relative 'vedeu/output/translator'
 
 require_relative 'vedeu/interface/interfaces'
 require_relative 'vedeu/interface/interface'
+require_relative 'vedeu/interface/dummy'
 
 require_relative 'vedeu/process/commands'
 require_relative 'vedeu/process/command'
+require_relative 'vedeu/process/exit'
 require_relative 'vedeu/process/process'
 
 require_relative 'vedeu/application'

data/lib/vedeu/application.rb

@@ -1,8 +1,8 @@
 module Vedeu
   class Application
     class << self
-      def start(interfaces = nil, options = {}, &block)
-        new(interfaces, options).start(&block)
+      def start(interfaces = nil, options = {})
+        new(interfaces, options).start
       end
     end
 
@@ -10,15 +10,9 @@ module Vedeu
       @interfaces, @options = interfaces, options
     end
 
-    def start(&block)
-      if block_given?
-
-      else
-        Terminal.open(options) do
-          initial_state
-
-          Process.event_loop
-        end
+    def start
+      Terminal.open(options) do
+        Process.main_sequence(interfaces)
       end
     ensure
       Terminal.close
@@ -26,15 +20,7 @@ module Vedeu
 
     private
 
-    attr_reader :options
-
-    def initial_state
-      interfaces.initial
-    end
-
-    def interfaces
-      @interfaces ||= Interfaces.default
-    end
+    attr_reader :interfaces, :options
 
     def options
       defaults.merge!(@options)

data/lib/vedeu/interface/dummy.rb

@@ -0,0 +1,9 @@
+module Vedeu
+  class Dummy < Interface
+    def initial_state; end
+
+    # def input; end
+
+    # def output; end
+  end
+end

data/lib/vedeu/interface/interface.rb

@@ -1,37 +1,62 @@
 module Vedeu
+  class NotImplementedError < StandardError; end
+
   class Interface
     def initialize(options = {})
       @options = options
     end
 
-    def initial; end
+    def initial_state
+      raise NotImplementedError, 'Subclasses implement this method.'
+    end
 
-    def main
-      output
+    def event_loop
+      while true do
+        command = input
 
-      input
-    end
+        break if command == :stop
 
-    def output
-      Terminal.hide_cursor
+        output(command)
+      end
     end
 
     def input
-      Terminal.show_cursor
+      evaluate
+    end
+
+    def output(command)
+      Compositor.write(command)
+    end
+
+    private
+
+    attr_reader :options
+
+    def evaluate
+      Commands.execute(read)
+    end
+
+    def read
+      Terminal.input
     end
 
     def width
-      options[:width]  || Terminal.width
+      options[:width]
     end
 
     def height
-      options[:height] || Terminal.height
+      options[:height]
     end
 
-    private
+    def options
+      defaults.merge!(@options)
+    end
 
-    attr_reader :options
+    def defaults
+      {
+        width:  Terminal.width,
+        height: Terminal.height
+      }
+    end
   end
-
-  class Dummy < Interface; end
 end

data/lib/vedeu/interface/interfaces.rb

@@ -29,12 +29,12 @@ module Vedeu
       interfaces
     end
 
-    def initial
-      interfaces.values.map { |io| io.call.initial }
+    def initial_state
+      interfaces.values.map { |io| io.call.initial_state }
     end
 
-    def main
-      interfaces.values.map { |io| io.call.main }
+    def event_loop
+      interfaces.values.map { |io| io.call.event_loop }
     end
 
     private

data/lib/vedeu/process/commands.rb

@@ -49,10 +49,4 @@ module Vedeu
       commands.fetch(command, false)
     end
   end
-
-  class Exit
-    def self.dispatch
-      :stop
-    end
-  end
 end

data/lib/vedeu/process/exit.rb

@@ -0,0 +1,7 @@
+module Vedeu
+  class Exit
+    def self.dispatch
+      :stop
+    end
+  end
+end

data/lib/vedeu/process/process.rb

@@ -1,31 +1,33 @@
 module Vedeu
   class Process
     class << self
-      def event_loop
-        new.event_loop
+      def main_sequence(interfaces = nil)
+        new(interfaces).main_sequence
       end
     end
 
-    def initialize; end
-
-    def event_loop
-      while true do
-        command = evaluate
+    def initialize(interfaces = nil)
+      @interfaces = interfaces
+    end
 
-        break if command == :stop
+    def main_sequence
+      initial_state
 
-        Compositor.write(command)
-      end
+      event_loop
     end
 
     private
 
-    def evaluate
-      Commands.execute(read)
+    def event_loop
+      interfaces.event_loop
+    end
+
+    def initial_state
+      interfaces.initial_state
     end
 
-    def read
-      Terminal.input
+    def interfaces
+      @interfaces ||= Interfaces.default
     end
   end
 end

data/lib/vedeu/support/terminal.rb

@@ -85,7 +85,7 @@ module Vedeu
     def initial_setup!
       Terminal.clear_screen if clear_screen?
       set_cursor
-      output(Position.reset)
+      Terminal.output(Position.reset)
     end
 
     private

data/lib/vedeu/version.rb

@@ -1,3 +1,3 @@
 module Vedeu
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/test/lib/vedeu/application_test.rb

@@ -2,10 +2,10 @@ require_relative '../../test_helper'
 
 module Vedeu
   describe Application do
-    let(:described_class){ Application }
-    let(:instance)   { described_class.new(interfaces, options) }
-    let(:interfaces) {}
-    let(:options)    { {} }
+    let(:described_class) { Application }
+    let(:instance)        { described_class.new(interfaces, options) }
+    let(:interfaces)      {}
+    let(:options)         { {} }
 
     describe '#start' do
       before { Esc.stubs(:clear).returns('') }

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

@@ -0,0 +1,22 @@
+require_relative '../../../test_helper'
+
+module Vedeu
+  describe Dummy do
+    let(:described_class) { Dummy }
+    let(:instance)        { described_class.new }
+
+    describe '#initial_state' do
+      subject { instance.initial_state }
+
+      it { subject.must_be_instance_of(NilClass) }
+    end
+
+    describe '#input' do
+      subject { instance.input }
+    end
+
+    describe '#output' do
+      subject { instance.output }
+    end
+  end
+end

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

@@ -2,75 +2,39 @@ 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(:instance)        { described_class.new(options) }
+    let(:options)         { {} }
 
     before do
       Terminal.stubs(:width).returns(80)
       Terminal.stubs(:height).returns(25)
-      Terminal.stubs(:show_cursor)
-      Terminal.stubs(:hide_cursor)
     end
 
     it { instance.must_be_instance_of(Interface) }
 
-    describe '#initial' do
-      subject { instance.initial }
+    describe '#initial_state' do
+      subject { instance.initial_state }
 
-      context 'capturing output' do
-        let(:io) { capture_io { subject }.join }
-
-        it { io.must_be_instance_of(String) }
-      end
+      it { proc { subject }.must_raise(NotImplementedError) }
     end
 
-    describe '#main' do
-      subject { instance.main }
-
-      it { subject.must_be_instance_of(NilClass) }
+    describe '#event_loop' do
+      subject { instance.event_loop }
 
-      context 'capturing output' do
-        let(:io) { capture_io { subject }.join }
-
-        it { io.must_be_instance_of(String) }
-      end
+      it { skip }
     end
 
     describe '#input' do
       subject { instance.input }
 
-      it { subject.must_be_instance_of(NilClass) }
-
-      context 'capturing output' do
-        let(:io) { capture_io { subject }.join }
-
-        it { io.must_be_instance_of(String) }
-      end
+      it { skip }
     end
 
     describe '#output' do
       subject { instance.output }
 
-      it { subject.must_be_instance_of(NilClass) }
-
-      context 'capturing output' do
-        let(:io) { capture_io { subject }.join }
-
-        it { io.must_be_instance_of(String) }
-      end
-    end
-
-    describe '#width' do
-      subject { instance.width }
-
-      it { subject.must_be_instance_of(Fixnum) }
-    end
-
-    describe '#height' do
-      subject { instance.height }
-
-      it { subject.must_be_instance_of(Fixnum) }
+      it { skip }
     end
   end
 end

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

@@ -48,14 +48,14 @@ module Vedeu
       it { subject.must_be_instance_of(Hash) }
     end
 
-    describe '#initial' do
-      subject { instance.initial }
+    describe '#initial_state' do
+      subject { instance.initial_state }
 
       it { subject.must_be_instance_of(Array) }
     end
 
-    describe '#main' do
-      subject { instance.main }
+    describe '#event_loop' do
+      subject { instance.event_loop }
 
       it { subject.must_be_instance_of(Array) }
     end

data/test/lib/vedeu/process/commands_test.rb

@@ -47,16 +47,4 @@ module Vedeu
       it { subject.must_be_instance_of(String) }
     end
   end
-
-  describe Exit do
-    let(:described_class)    { Exit }
-
-    describe '.dispatch' do
-      subject { described_class.dispatch }
-
-      it { subject.must_be_instance_of(Symbol) }
-
-      it { subject.must_equal(:stop) }
-    end
-  end
 end

data/test/lib/vedeu/process/exit_test.rb

@@ -0,0 +1,15 @@
+require_relative '../../../test_helper'
+
+module Vedeu
+  describe Exit do
+    let(:described_class) { Exit }
+
+    describe '.dispatch' do
+      subject { described_class.dispatch }
+
+      it { subject.must_be_instance_of(Symbol) }
+
+      it { subject.must_equal(:stop) }
+    end
+  end
+end

data/test/lib/vedeu/process/process_test.rb

@@ -2,9 +2,8 @@ require_relative '../../../test_helper'
 
 module Vedeu
   describe Process do
-    let(:described_class)    { Process }
-    let(:instance) { described_class.new }
-    let(:block)    {}
+    let(:described_class) { Process }
+    let(:instance)        { described_class.new }
 
     it { instance.must_be_instance_of(Process) }
   end

data/test/support/test_app/bin/testapp

@@ -5,28 +5,20 @@ trap('INT') { exit! }
 
 require_relative '../../../../lib/vedeu'
 
-# define an interface
-# Vedeu::Interfaces.define do |interface|
-#   interface.add("", ...)
-# end
-
 class Fake
   def self.dispatch
     puts "Fake dispatched..."
     [
-      [[:white, :red], "Fake executed...",   :reset],
-      [[:white, :green], "Test executed...", :reset],
+      [[17, 6], [:red,   :white], "Fake executed...", :reset],
+      [[19, 5], [:green, :white], "Test executed...", :reset],
     ]
   end
 end
 
-# use default interface
 Vedeu::Interfaces.default
 
-# define some commands
 Vedeu::Commands.define do |command|
   command.add("test", Fake)
 end
 
-# create main loop
 Vedeu::Application.start

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vedeu
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Gavin Laking
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-20 00:00:00.000000000 Z
+date: 2014-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -154,6 +154,7 @@ files:
 - bin/vedeu
 - lib/vedeu.rb
 - lib/vedeu/application.rb
+- lib/vedeu/interface/dummy.rb
 - lib/vedeu/interface/interface.rb
 - lib/vedeu/interface/interfaces.rb
 - lib/vedeu/output/background.rb
@@ -168,10 +169,12 @@ files:
 - lib/vedeu/output/translator.rb
 - lib/vedeu/process/command.rb
 - lib/vedeu/process/commands.rb
+- lib/vedeu/process/exit.rb
 - lib/vedeu/process/process.rb
 - lib/vedeu/support/terminal.rb
 - lib/vedeu/version.rb
 - test/lib/vedeu/application_test.rb
+- test/lib/vedeu/interface/dummy_test.rb
 - test/lib/vedeu/interface/interface_test.rb
 - test/lib/vedeu/interface/interfaces_test.rb
 - test/lib/vedeu/output/background_test.rb
@@ -186,6 +189,7 @@ files:
 - test/lib/vedeu/output/translator_test.rb
 - test/lib/vedeu/process/command_test.rb
 - test/lib/vedeu/process/commands_test.rb
+- test/lib/vedeu/process/exit_test.rb
 - test/lib/vedeu/process/process_test.rb
 - test/lib/vedeu/support/terminal_test.rb
 - test/lib/vedeu/version_test.rb
@@ -218,6 +222,7 @@ specification_version: 4
 summary: A terminal case of wonderland.
 test_files:
 - test/lib/vedeu/application_test.rb
+- test/lib/vedeu/interface/dummy_test.rb
 - test/lib/vedeu/interface/interface_test.rb
 - test/lib/vedeu/interface/interfaces_test.rb
 - test/lib/vedeu/output/background_test.rb
@@ -232,6 +237,7 @@ test_files:
 - test/lib/vedeu/output/translator_test.rb
 - test/lib/vedeu/process/command_test.rb
 - test/lib/vedeu/process/commands_test.rb
+- test/lib/vedeu/process/exit_test.rb
 - test/lib/vedeu/process/process_test.rb
 - test/lib/vedeu/support/terminal_test.rb
 - test/lib/vedeu/version_test.rb