vedeu 0.0.10 → 0.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5f3422a6093ab6c6c7cf502bc9cec28cb3834d84
-  data.tar.gz: c42685a3bdb1aa694e46665daccc70355e949ef3
+  metadata.gz: 91075694e8c8b20c64f154ab41f71176a871ca64
+  data.tar.gz: 1637599541bcad4e9895c55d58e2a180a0fe8f06
 SHA512:
-  metadata.gz: 548489372e87fd7001f8dd805d21d9328f345306c65e055a58f1a078aa0736267d5f467871f719d39c2de089b8c5e6004ec742010fc26fc2c803fbe71d4ebb08
-  data.tar.gz: 479d851256aa4961463fa0c7158e1b142c781fc529f29ea0075213aef661a9f6207a0abb4fce0fa50621af0aafff6deb90e7e686881313233e89489fd3b33f59
+  metadata.gz: b552c855f7c1b9d1774324ca2435d99dc85ed85bc5622a22b8284ee216dc93c5fe7f31c188cd19ce697085a821adae90f2359f49658e33acf4df268c34c93e73
+  data.tar.gz: f63e7b4cfff15aa2a65a6da620effc55c60544426fb50b334326adbe555f2f2ae6422a537742fe263185ed8cf53de570e8160db9ff3a566c4cfee23774f2a886

data/README.md

@@ -25,9 +25,10 @@ TODO: Write detailed documentation
 ## Notes
 
     Application
-      |-- Interfaces
-      |     |-- DummyInterface < Interface
+      |-- EventLoop
+      |     |-- InterfaceRepository
       |
+      |-- InterfaceRepository
       |-- Terminal
 
     Base
@@ -37,6 +38,8 @@ TODO: Write detailed documentation
     Interface
       |-- Commands
       |     |-- Command
+      |     |     |-- CommandRepository
+      |     |
       |     |-- Exit
       |
       |-- Compositor
@@ -51,6 +54,7 @@ TODO: Write detailed documentation
       |     |     |-- Style
       |     |           |-- Esc
       |     |
+      |     |-- InterfaceRepository
       |     |-- Position
       |     |     |-- Esc
       |     |
@@ -60,6 +64,9 @@ TODO: Write detailed documentation
       |-- Geometry
       |     |-- Terminal
       |
+      |-- Input
+      |-- InterfaceRepository
+      |-- Position
       |-- Terminal
 
     Terminal
@@ -87,6 +94,18 @@ These numbers are based on the area available to the terminal. If the terminal i
       ]
     ]
 
+## Usage
+
+    class MyApp
+      include Vedeu
+
+      interface :status, geometry: { y: 1, x: 1, width: :auto, height: 1     }
+      interface :main,   geometry: { y: 2, x: 1, width: :auto, height: :auto }
+
+      command :exit, Vedeu::Exit.dispatch, { keyword: "exit", keypress: "q" }
+      command :help, MyApp.help,           { keyword: "help", keypress: "h" }
+    end
+
 ## Contributing
 
 1. Fork it ( http://github.com/<my-github-username>/vedeu/fork )

data/Rakefile

@@ -1,5 +1,11 @@
 require "bundler/gem_tasks"
 require "rake/testtask"
+require 'cucumber'
+require 'cucumber/rake/task'
+
+Cucumber::Rake::Task.new(:cucumber) do |t|
+  t.cucumber_opts = "features --format progress"
+end
 
 Rake::TestTask.new do |t|
   t.libs << 'lib/vedeu'
@@ -9,3 +15,5 @@ Rake::TestTask.new do |t|
 end
 
 task :default => :test
+
+Rake::Task['cucumber'].execute

data/bin/vedeu

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

data/config/cucumber.yml

@@ -0,0 +1,8 @@
+<%
+rerun = File.file?('rerun.txt') ? IO.read('rerun.txt') : ""
+rerun_opts = rerun.to_s.strip.empty? ? "--format #{ENV['CUCUMBER_FORMAT'] || 'progress'} features" : "--format #{ENV['CUCUMBER_FORMAT'] || 'pretty'} #{rerun}"
+  std_opts = "--format #{ENV['CUCUMBER_FORMAT'] || 'rerun'} --strict --tags ~@wip --tags ~@ok --tags ~@pending --tags ~@failing"
+%>
+default: <%= std_opts %> features --format rerun
+wip: --tags @wip:99 --wip features --format pretty
+rerun: <%= rerun_opts %> --format rerun --out rerun.txt --strict --tags ~@wip

data/features/getting_started.feature

@@ -0,0 +1,10 @@
+Feature: Getting Started
+
+  Scenario: Hello World
+    Given the interface "main" is defined
+    And the command "hello" is defined
+    When the input "hello" is entered
+    Then the output should contain:
+      """
+      Hello World!
+      """

data/features/step_definitions/vedeu_steps.rb

@@ -0,0 +1,11 @@
+Given(/^the interface "(.*?)" is defined$/) do |interface|
+  Vedeu::Interface.create({ name: interface, klass: Vedeu::DummyInterface, options: {} })
+end
+
+Given(/^the command "(.*?)" is defined$/) do |command|
+  Vedeu::Command.create({ name: command, klass: Vedeu::DummyCommand, options: { keyword: command } })
+end
+
+When(/^the input "(.*?)" is entered$/) do |input|
+  pending
+end

data/features/support/env.rb

@@ -0,0 +1,12 @@
+require 'simplecov'
+require 'aruba'
+require 'aruba/cucumber'
+require 'aruba/in_process'
+require 'mocha/api'
+
+require_relative '../../lib/vedeu.rb'
+
+class CucumberError < StandardError; end
+
+Aruba::InProcess.main_class = Vedeu::Launcher
+Aruba.process = Aruba::InProcess

data/lib/vedeu.rb

@@ -18,23 +18,44 @@ require_relative 'vedeu/output/style'
 require_relative 'vedeu/output/translator'
 require_relative 'vedeu/output/wordwrap'
 
-require_relative 'vedeu/interface/interfaces'
-require_relative 'vedeu/interface/interface'
-require_relative 'vedeu/interface/dummy_interface'
-
-require_relative 'vedeu/process/dummy_command'
-require_relative 'vedeu/process/commands'
-require_relative 'vedeu/process/command'
 require_relative 'vedeu/process/event_loop'
 require_relative 'vedeu/process/exit'
+require_relative 'vedeu/process/input'
+
+require_relative 'vedeu/repository/repository'
+require_relative 'vedeu/repository/command_repository'
+require_relative 'vedeu/repository/command'
+require_relative 'vedeu/repository/interface_repository'
+require_relative 'vedeu/repository/interface'
+require_relative 'vedeu/repository/storage'
+require_relative 'vedeu/repository/dummy_interface'
+require_relative 'vedeu/repository/dummy_command'
 
 require_relative 'vedeu/application'
+require_relative 'vedeu/launcher'
 require_relative 'vedeu/version'
 
 module Vedeu
+  module ClassMethods
+    def interface(name, options = {})
+      interface_name = name.is_a?(Symbol) ? name.to_s : name
+
+      Interface.create({ name: interface_name, options: options })
+    end
+
+    def command(name, klass, options = {})
+      command_name = name.is_a?(Symbol) ? name.to_s : name
+
+      Command.create({ name: command_name, klass: klass, options: options })
+    end
+  end
+
+  def self.included(receiver)
+    receiver.extend(ClassMethods)
+  end
+
   def self.logger
-    @logger ||= Logger
-      .new(root_path + '/logs/vedeu.log').tap do |log|
+    @logger ||= Logger.new(root_path + '/logs/vedeu.log').tap do |log|
       log.formatter = proc do |mode, time, prog, msg|
         "\n#{time.iso8601}: #{msg}\n"
       end

data/lib/vedeu/application.rb

@@ -12,7 +12,7 @@ module Vedeu
 
     def start
       Terminal.open(options) do
-        Interfaces.initial_state
+        InterfaceRepository.initial_state
 
         EventLoop.main_sequence
       end

data/lib/vedeu/launcher.rb

@@ -0,0 +1,26 @@
+module Vedeu
+  class Launcher
+    def initialize(argv, stdin = STDIN,
+                         stdout = STDOUT,
+                         stderr = STDERR,
+                         kernel = Kernel)
+      @argv      = argv
+      @stdin     = stdin
+      @stdout    = stdout
+      @stderr    = stderr
+      @kernel    = kernel
+      @exit_code = 1
+    end
+
+    def execute!
+      $stdin, $stdout, $stderr = @stdin, @stdout, @stderr
+
+      Vedeu::Application.start
+
+      @exit_code = 0
+    ensure
+      $stdin, $stdout, $stderr = STDIN, STDOUT, STDERR
+      @kernel.exit(@exit_code)
+    end
+  end
+end

data/lib/vedeu/output/colour.rb

@@ -10,7 +10,7 @@ module Vedeu
     end
 
     def initialize(pair = [])
-      @pair = pair
+      @pair = pair || []
     end
 
     def define

data/lib/vedeu/output/compositor.rb

@@ -1,7 +1,9 @@
 module Vedeu
+  class UndefinedInterface < StandardError; end
+
   class Compositor
     class << self
-      def arrange(output = [], interface = :dummy)
+      def arrange(output = [], interface = 'dummy')
         return if output.nil? || output.empty?
 
         if output.is_a?(Array)
@@ -14,8 +16,9 @@ module Vedeu
       end
     end
 
-    def initialize(output = [], interface = :dummy)
-      @output, @interface = output, interface
+    def initialize(output = [], interface = 'dummy')
+      @output    = output || []
+      @interface = interface
     end
 
     def arrange
@@ -26,7 +29,7 @@ module Vedeu
 
     def composition
       container = []
-      streams = []
+      streams   = []
       output.map do |line|
         line.each_with_index do |stream, index|
           streams << clear(index)
@@ -43,7 +46,7 @@ module Vedeu
     end
 
     def origin(index)
-      Position.set(geometry.vy(index), geometry.vx)
+      target_interface.origin(index)
     end
 
     def width
@@ -65,7 +68,7 @@ module Vedeu
     end
 
     def interface
-      @_interface ||= Interfaces.defined.find(@interface)
+      @_interface ||= InterfaceRepository.find_by_name(@interface)
     end
   end
 end

data/lib/vedeu/output/directive.rb

@@ -9,7 +9,7 @@ module Vedeu
     end
 
     def initialize(directives = {})
-      @directives = directives
+      @directives = directives || {}
     end
 
     def enact

data/lib/vedeu/output/geometry.rb

@@ -1,7 +1,7 @@
 module Vedeu
   class Geometry
     def initialize(values = {})
-      @values = values
+      @values = values || {}
     end
 
     def z

data/lib/vedeu/output/position.rb

@@ -8,7 +8,7 @@ module Vedeu
       end
 
       def reset
-        new(0, 0).set
+        new(1, 1).set
       end
     end
 
@@ -17,7 +17,7 @@ module Vedeu
     end
 
     def set
-      [Esc.esc, (y + 1), ';', (x + 1), 'H'].join
+      [Esc.esc, y, ';', x, 'H'].join
     end
 
     private

data/lib/vedeu/output/style.rb

@@ -21,7 +21,7 @@ module Vedeu
       when :show_cursor then Esc.show_cursor
       when :underline   then Esc.underline
       else
-        ""
+        ''
       end
     end
 

data/lib/vedeu/output/wordwrap.rb

@@ -7,7 +7,8 @@ module Vedeu
     end
 
     def initialize(value, options = {})
-      @value, @options = value, options
+      @value   = value
+      @options = options || {}
     end
 
     def reformat

data/lib/vedeu/process/event_loop.rb

@@ -14,9 +14,9 @@ module Vedeu
 
     def main_sequence
       while @running do
-        Interfaces.defined.input
+        InterfaceRepository.input
 
-        Interfaces.defined.output
+        InterfaceRepository.output
       end
     rescue Collapse
       stop

data/lib/vedeu/process/input.rb

@@ -0,0 +1,30 @@
+module Vedeu
+  class Input
+    class << self
+      def evaluate(input, args = [])
+        new(input, args).evaluate
+      end
+    end
+
+    def initialize(input, args = [])
+      @input = input
+      @args  = args || []
+    end
+
+    def evaluate
+      command.execute(*args) if exists?
+    end
+
+    private
+
+    attr_reader :input, :args
+
+    def exists?
+      command.is_a?(Command)
+    end
+
+    def command
+      @command ||= CommandRepository.find_by_input(input)
+    end
+  end
+end

data/lib/vedeu/repository/command.rb

@@ -0,0 +1,32 @@
+module Vedeu
+  class Command
+    attr_accessor :id, :attributes, :name, :klass, :keyword, :keypress
+
+    class << self
+      def create(attributes = {})
+        new(attributes).create
+      end
+    end
+
+    def initialize(attributes = {})
+      @attributes = attributes || {}
+      @name       = attributes[:name]
+      @klass      = attributes[:klass]
+      @keyword    = attributes.fetch(:options, {}).fetch(:keyword, "")
+      @keypress   = attributes.fetch(:options, {}).fetch(:keypress, "")
+    end
+
+    def create
+      CommandRepository.create(self)
+      self
+    end
+
+    def execute(args = [])
+      executable.call(*args)
+    end
+
+    def executable
+      Proc.new { |*args| attributes[:klass].dispatch(*args) }
+    end
+  end
+end

data/lib/vedeu/repository/command_repository.rb

@@ -0,0 +1,27 @@
+module Vedeu
+  class CommandRepository
+    extend Repository
+
+    class << self
+      def find_by_input(input)
+        return nil if input.nil? || input.empty?
+        return by_keypress(input) if input.size == 1
+        return by_keyword(input)  if input.size > 1
+      end
+
+      def klass
+        Command
+      end
+
+      private
+
+      def by_keypress(input)
+        query(klass, :keypress, input)
+      end
+
+      def by_keyword(input)
+        query(klass, :keyword, input)
+      end
+    end
+  end
+end