vedeu 0.2.12 → 0.3.0

data/lib/vedeu/support/visible.rb

@@ -0,0 +1,75 @@
+require 'vedeu/support/esc'
+
+module Vedeu
+
+  class Visible
+
+    # @return [Visible]
+    def self.coerce(value)
+      if value.is_a?(self)
+        value
+
+      else
+        new(value)
+
+      end
+    end
+
+    # @return [Visible]
+    def initialize(visible = nil)
+      @visible = if visible == :hide || visible == false
+        false
+
+      elsif visible == :show || visible == true
+        true
+
+      else
+        !!visible
+
+      end
+    end
+
+    # Returns log friendly output.
+    #
+    # @return [String]
+    def inspect
+      "<#{self.class.name} (#{@visible.to_s})>"
+    end
+
+    # @return [String]
+    def cursor
+      if visible?
+        Esc.string('show_cursor')
+
+      else
+        Esc.string('hide_cursor')
+
+      end
+    end
+
+    def visible?
+      @visible
+    end
+
+    def invisible?
+      !@visible
+    end
+
+    # @return [Visible]
+    def hide
+      Visible.new(false)
+    end
+
+    # @return [Visible]
+    def show
+      Visible.new(true)
+    end
+
+    # @return [Visible]
+    def toggle
+      visible? ? hide : show
+    end
+
+  end # Visible
+
+end # Vedeu

data/lib/vedeu/support/write.rb

@@ -0,0 +1,85 @@
+module Vedeu
+
+  # The basis of a fake output device.
+  class Write
+
+    # @see Vedeu::Write#write
+    def self.to(console, data = nil)
+      new(console, data).write
+    end
+
+    # @return [Vedeu::Write]
+    def initialize(console, data = nil)
+      @console = console
+      @data    = data
+    end
+
+    # Provides IO.console emulation of #print.
+    #
+    # @return [Array]
+    def print(string = nil)
+      @data = string unless string.nil?
+
+      write
+    end
+
+    # @return [Array<Array>|Array<String>]
+    def write
+      streams
+    end
+
+    private
+
+    attr_reader :console, :data
+
+    # @return [Array<Char>|Array<String>]
+    def streams
+      lines.map do |line|
+        if line.size > visible_columns
+          line[0, visible_columns]
+
+        else
+          line
+
+        end
+      end
+    end
+
+    # @return [Array<Array>|Array<String>]
+    def lines
+      if content.size > visible_lines
+        content[0, visible_lines]
+
+      else
+        content
+
+      end
+    end
+
+    # @return [Array|Array<String>|Array<Array>]
+    def content
+      if data.nil? || data.empty?
+        []
+
+      elsif data.is_a?(String)
+        data.split(/\n/)
+
+      else
+        data
+
+      end
+    end
+
+    # @return [Fixnum]
+    def visible_columns
+      console.width #- 1
+    end
+
+    # @return [Fixnum]
+    def visible_lines
+      console.height #- 1
+    end
+
+  end # Write
+
+end # Vedeu

data/lib/vedeu/traps.rb

@@ -0,0 +1,18 @@
+module Vedeu
+
+  # Vedeu can respond to various signals which are handled here.
+  module Traps
+
+    Signal.trap('INT') { exit! }
+
+    Signal.trap('TERM') { exit! }
+
+    #TTIN
+    #USR1
+    #USR2
+
+    Signal.trap('SIGWINCH') { Vedeu.trigger(:_resize_) }
+
+  end # Traps
+
+end # Vedeu

data/lib/vedeu.rb

@@ -1,37 +1,3 @@
-# Vedeu is a GUI framework for terminal/console applications written in Ruby.
-#
-module Vedeu
-
-  # When Vedeu is included within one of your classes, you should have all
-  # API methods at your disposal.
-  #
-  # @example
-  #   class YourClassHere
-  #     include Vedeu
-  #     ...
-  #
-  def self.included(receiver)
-    receiver.send(:include, API)
-    receiver.extend(API)
-  end
-
-  # Write a message to the Vedeu log file.
-  #
-  # @param message [String] The message you wish to emit to the log
-  #   file, useful for debugging.
-  # @param force   [Boolean] When evaluates to true will attempt to
-  #   write to the log file regardless of the Configuration setting.
-  #
-  # @example
-  #   Vedeu.log('A useful debugging message: Error!')
-  #
-  # @return [TrueClass]
-  def self.log(message, force = false)
-    Vedeu::Log.logger.debug(message) if Configuration.debug? || force
-  end
-
-end # Vedeu
-
 $LIB_DIR = File.dirname(__FILE__) + '/../lib'
 $LOAD_PATH.unshift($LIB_DIR) unless $LOAD_PATH.include?($LIB_DIR)
 
@@ -44,85 +10,59 @@ require 'set'
 require 'singleton'
 require 'time'
 
-require 'vedeu/support/common'
-require 'vedeu/support/exceptions'
-require 'vedeu/support/model'
-
-require 'vedeu/configuration/cli'
-require 'vedeu/configuration/api'
-require 'vedeu/configuration/configuration'
-
 require 'vedeu/support/log'
-require 'vedeu/support/trace'
-
-require 'vedeu/support/repository'
-require 'vedeu/repositories/models/event'
-require 'vedeu/repositories/events'
-require 'vedeu/repositories/keymaps'
-require 'vedeu/repositories/models/keymap'
-require 'vedeu/api/keymap'
-require 'vedeu/api/api'
 
-require 'vedeu/colours/translator'
-require 'vedeu/colours/background'
-require 'vedeu/colours/foreground'
-require 'vedeu/colours/colour'
-
-require 'vedeu/support/coercions'
-require 'vedeu/support/esc'
-require 'vedeu/support/position'
-require 'vedeu/support/presentation'
-require 'vedeu/support/sentence'
-require 'vedeu/support/terminal'
+# Vedeu is a GUI framework for terminal/console applications written in Ruby.
+#
+module Vedeu
 
-require 'vedeu/models/border'
-require 'vedeu/models/char'
-require 'vedeu/models/composition'
-require 'vedeu/models/geometry'
-require 'vedeu/models/key'
-require 'vedeu/models/line'
-require 'vedeu/models/stream'
-require 'vedeu/models/style'
+  DOCS_URL = 'http://www.rubydoc.info/github/gavinlaking/vedeu/master'
 
-require 'vedeu/repositories/models/interface'
-require 'vedeu/repositories/interfaces'
+  extend Forwardable
+  extend self
 
-require 'vedeu/api/defined'
-require 'vedeu/api/composition'
-require 'vedeu/api/helpers'
-require 'vedeu/api/interface'
-require 'vedeu/api/line'
-require 'vedeu/api/menu'
-require 'vedeu/api/stream'
+  def_delegators Vedeu::Log, :log
 
-require 'vedeu/repositories/models/buffer'
-require 'vedeu/repositories/models/cursor'
-require 'vedeu/repositories/models/group'
-require 'vedeu/repositories/models/menu'
-require 'vedeu/repositories/models/offset'
+  # @return [Vedeu::Focus]
+  def self.focusable
+    @_focusable ||= Vedeu::Focus
+  end
 
-require 'vedeu/support/keymap_validator'
+  # @return [Vedeu::Repository]
+  def self.geometries
+    @_geometries ||= Vedeu::Repository.new(Vedeu::Geometry)
+  end
 
-require 'vedeu/repositories/buffers'
-require 'vedeu/repositories/cursors'
-require 'vedeu/repositories/focus'
-require 'vedeu/repositories/groups'
-require 'vedeu/repositories/menus'
-require 'vedeu/repositories/offsets'
+  # @return [Vedeu::Repository]
+  def self.groups
+    @_groups ||= Vedeu::Repository.new(Vedeu::Group)
+  end
 
-require 'vedeu/support/registrar'
-require 'vedeu/support/refresh'
+  # @return [Vedeu::Repository]
+  def self.interfaces
+    @_interfaces ||= Vedeu::Repository.new(Vedeu::Interface)
+  end
 
-require 'vedeu/output/compositor'
-require 'vedeu/output/output'
-require 'vedeu/output/viewport'
+  # When Vedeu is included within one of your classes, you should have all
+  # API methods at your disposal.
+  #
+  # @example
+  #   class YourClassHere
+  #     include Vedeu
+  #     ...
+  #
+  def included(receiver)
+    receiver.send(:include, API)
+    receiver.extend(API)
+  end
 
-require 'vedeu/support/bounding_area'
-require 'vedeu/support/grid'
+  private
 
-require 'vedeu/input/input'
+end # Vedeu
 
-require 'vedeu/application'
-require 'vedeu/launcher'
+require 'vedeu/all'
 
+require 'vedeu/support/trace'
+Vedeu::Trace.call
+# force tracing
 # Vedeu::Trace.call({ trace: true })

data/test/integration/dsl/compositions_test.rb

@@ -0,0 +1,27 @@
+require 'test_helper'
+
+describe 'Compositions' do
+
+  describe '#view' do
+    subject {
+      Vedeu.views do
+        view 'compositions' do
+          # ...
+        end
+      end
+    }
+
+    #it { subject.must_be_instance_of(Vedeu::Composition) }
+
+    # it 'allows the use of Vedeu.view' do
+    #   skip
+    # end
+
+    context 'when no block is given' do
+      subject { Vedeu.view }
+
+      #it { proc { subject }.must_raise(Vedeu::InvalidSyntax) }
+    end
+  end
+
+end

data/test/integration/dsl/interfaces_test.rb

@@ -0,0 +1,261 @@
+require 'test_helper'
+
+describe 'Interfaces' do
+
+  describe '#background' do
+    subject {
+      Vedeu.interface 'interfaces' do
+        background ''
+      end
+    }
+
+    it { subject.must_be_instance_of(Vedeu::Interface) }
+
+    # it 'allows the use of background within Vedeu.interface' do
+    #   skip
+    # end
+
+    context 'when no value is provided' do
+
+    end
+  end
+
+  describe '#border' do
+    subject {
+      Vedeu.interface 'interfaces' do
+        border do
+        end
+      end
+    }
+
+    it { subject.must_be_instance_of(Vedeu::Interface) }
+
+    # it 'allows the use of border within Vedeu.interface' do
+    #   skip
+    # end
+
+    context 'when no value is provided' do
+
+    end
+  end
+
+  describe '#colour' do
+    subject {
+      Vedeu.interface 'interfaces' do
+        colour ''
+      end
+    }
+
+    #it { subject.must_be_instance_of(Vedeu::Interface) }
+
+    # it 'allows the use of colour within Vedeu.interface' do
+    #   skip
+    # end
+
+    context 'when no value is provided' do
+
+    end
+  end
+
+  describe '#foreground' do
+    subject {
+      Vedeu.interface 'interfaces' do
+        foreground ''
+      end
+    }
+
+    it { subject.must_be_instance_of(Vedeu::Interface) }
+
+    # it 'allows the use of foreground within Vedeu.interface' do
+    #   skip
+    # end
+
+    context 'when no value is provided' do
+
+    end
+  end
+
+  describe '#cursor' do
+    subject {
+      Vedeu.interface 'interfaces' do
+        cursor ''
+      end
+    }
+
+    #it { subject.must_be_instance_of(Vedeu::Interface) }
+
+    # it 'allows the use of cursor within Vedeu.interface' do
+    #   skip
+    # end
+
+    context 'when no value is provided' do
+
+    end
+  end
+
+  describe '#cursor!' do
+    subject {
+      Vedeu.interface 'interfaces' do
+        cursor!
+      end
+    }
+
+    #it { subject.must_be_instance_of(Vedeu::Interface) }
+
+    # it 'allows the use of cursor! within Vedeu.interface' do
+    #   skip
+    # end
+
+    context 'when no value is provided' do
+
+    end
+  end
+
+  describe '#delay' do
+    subject {
+      Vedeu.interface 'interfaces' do
+        delay ''
+      end
+    }
+
+    it { subject.must_be_instance_of(Vedeu::Interface) }
+
+    # it 'allows the use of delay within Vedeu.interface' do
+    #   skip
+    # end
+
+    context 'when no value is provided' do
+
+    end
+  end
+
+  describe '#focus!' do
+    subject {
+      Vedeu.interface 'interfaces' do
+        focus!
+      end
+    }
+
+    #it { subject.must_be_instance_of(Vedeu::Interface) }
+
+    # it 'allows the use of focus! within Vedeu.interface' do
+    #   skip
+    # end
+
+    context 'when no value is provided' do
+
+    end
+  end
+
+  describe '#geometry' do
+    subject {
+      Vedeu.interface 'interfaces' do
+        geometry do
+        end
+      end
+    }
+
+    it { subject.must_be_instance_of(Vedeu::Interface) }
+
+    # it 'allows the use of geometry within Vedeu.interface' do
+    #   skip
+    # end
+
+    context 'when no value is provided' do
+
+    end
+  end
+
+  describe '#group' do
+    subject {
+      Vedeu.interface 'interfaces' do
+        group 'compounds'
+      end
+    }
+
+    it { subject.must_be_instance_of(Vedeu::Interface) }
+
+    # it 'allows the use of group within Vedeu.interface' do
+    #   skip
+    # end
+
+    context 'when no value is provided' do
+
+    end
+  end
+
+  describe '#keys' do
+    subject {
+      Vedeu.interface 'interfaces' do
+        keys do
+        end
+      end
+    }
+
+    #it { subject.must_be_instance_of(Vedeu::Interface) }
+
+    # it 'allows the use of keys within Vedeu.interface' do
+    #   skip
+    # end
+
+    context 'when no value is provided' do
+
+    end
+  end
+
+  describe '#lines' do
+    subject {
+      Vedeu.interface 'interfaces' do
+        lines do
+        end
+      end
+    }
+
+    #it { subject.must_be_instance_of(Vedeu::Interface) }
+
+    # it 'allows the use of lines within Vedeu.interface' do
+    #   skip
+    # end
+
+    context 'when no value is provided' do
+
+    end
+  end
+
+  describe '#name' do
+    subject {
+      Vedeu.interface do
+        name 'interfaces'
+      end
+    }
+
+    it { subject.must_be_instance_of(Vedeu::Interface) }
+
+    # it 'allows the use of name within Vedeu.interface' do
+    #   skip
+    # end
+
+    context 'when no value is provided' do
+
+    end
+  end
+
+  describe '#style' do
+    subject {
+      Vedeu.interface 'interfaces' do
+        style ''
+      end
+    }
+
+    it { subject.must_be_instance_of(Vedeu::Interface) }
+
+    # it 'allows the use of style within Vedeu.interface' do
+    #   skip
+    # end
+
+    context 'when no value is provided' do
+
+    end
+  end
+
+end

data/test/integration/dsl/keymaps_test.rb

@@ -0,0 +1,42 @@
+require 'test_helper'
+
+describe 'Keymaps' do
+
+  describe '#key' do
+    subject {
+      Vedeu.keymap 'keymaps' do
+        key '' do
+        end
+      end
+    }
+
+    #it { subject.must_be_instance_of(Vedeu::Keymap) }
+
+    # it 'allows the use of ... within Vedeu.keymap' do
+    #   skip
+    # end
+
+    context 'when no value is provided' do
+
+    end
+  end
+
+  describe '#name' do
+    subject {
+      Vedeu.keymap 'keymaps' do
+        name ''
+      end
+    }
+
+    #it { subject.must_be_instance_of(Vedeu::Keymap) }
+
+    # it 'allows the use of ... within Vedeu.keymap' do
+    #   skip
+    # end
+
+    context 'when no value is provided' do
+
+    end
+  end
+
+end