vedeu 0.4.13 → 0.4.14

data/lib/vedeu/support/common.rb

@@ -15,14 +15,6 @@ module Vedeu
       false
     end
 
-    # Returns the array as a sentence.
-    #
-    # @param array [Array]
-    # @return [String]
-    def to_sentence(array)
-      Vedeu::Sentence.construct(array)
-    end
-
   end # Common
 
 end # Vedeu

data/lib/vedeu/support/log.rb

@@ -10,23 +10,13 @@ module Vedeu
     #
     # @param logdev [String|IO] The filename (String) or IO object (typically
     #   STDOUT, STDERR or an open file).
-    # @param shift_age [] Number of old log files to keep, or frequency of
-    #   rotation (daily, weekly, monthly).
-    # @param shift_size [] Maximum log file size (only applies when shift_age
-    #   is a number).
     #
-    # @example
-    #   Logger.new(name, shift_age = 7, shift_size = 1048576)
-    #   Logger.new(name, shift_age = 'weekly')
-    #
-    def initialize(logdev, shift_age=nil, shift_size=nil)
+    def initialize(logdev)
       @level = DEBUG
       @default_formatter = Formatter.new
       @formatter = nil
       @logdev = nil
-      if logdev
-        @logdev = LocklessLogDevice.new(logdev)
-      end
+      @logdev = LocklessLogDevice.new(logdev) if logdev
     end
 
     # Ensures we can always write to the log file by creating a lock-less
@@ -41,8 +31,6 @@ module Vedeu
       def initialize(log = nil)
         @dev = nil
         @filename = nil
-        @shift_age = nil
-        @shift_size = nil
 
         if log.respond_to?(:write) && log.respond_to?(:close)
           @dev = log
@@ -60,9 +48,8 @@ module Vedeu
       def write(message)
         @dev.write(message)
 
-      rescue Exception => ignored
-        warn("log writing failed. #{ignored}")
-
+      rescue StandardError => exception
+        warn("log writing failed. #{exception}")
       end
 
       # @return []
@@ -75,7 +62,7 @@ module Vedeu
       # @param filename []
       # @return []
       def open_logfile(filename)
-        if (FileTest.exist?(filename))
+        if FileTest.exist?(filename)
           open(filename, (File::WRONLY | File::APPEND))
 
         else
@@ -98,16 +85,16 @@ module Vedeu
 
       # Write a message to the Vedeu log file.
       #
+      # @example
+      #   Vedeu.log(message: 'A useful debugging message: Error!')
+      #
       # @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
+      # @param force [Boolean] When evaluates to true will attempt to write to
       #   the log file regardless of the Configuration setting.
-      # @param type    [Symbol] Colour code messages in the log file depending
+      # @param type [Symbol] Colour code messages in the log file depending
       #   on their source.
       #
-      # @example
-      #   Vedeu.log(message: 'A useful debugging message: Error!')
-      #
       # @return [TrueClass]
       def log(message:, force: false, type: :info)
         logger.debug([message_type(type), message]) if enabled? || force
@@ -141,7 +128,9 @@ module Vedeu
 
       # @return [String]
       def message_type(type)
-        Vedeu::Esc.send(message_types.fetch(type, :default)) { "[#{type}]".ljust(9) }
+        Vedeu::Esc.send(message_types.fetch(type, :default)) do
+          "[#{type}]".ljust(9)
+        end
       end
 
       # @return [Hash<Symbol => Symbol>]

data/lib/vedeu/support/template.rb

@@ -43,7 +43,10 @@ module Vedeu
     # @return [String]
     def path
       fail MissingRequired, 'No path to template specified.' if @path.empty?
-      fail MissingRequired, 'Template file cannot be found.' unless File.exist?(@path)
+
+      unless File.exist?(@path)
+        fail MissingRequired, 'Template file cannot be found.'
+      end
 
       @path
     end

data/lib/vedeu/support/terminal.rb

@@ -33,7 +33,6 @@ module Vedeu
       end
     ensure
       restore_screen
-
     end
 
     # Takes input from the user via the keyboard. Accepts special keys like
@@ -42,17 +41,18 @@ module Vedeu
     # @return [String]
     def input
       keys_or_cmd = if raw_mode?
-        keys = console.getch
-        if keys.ord == 27
-          keys << console.read_nonblock(3) rescue nil
-          keys << console.read_nonblock(2) rescue nil
-        end
-        keys
+                      keys = console.getch
 
-      else
-        console.gets.chomp
+                      if keys.ord == 27
+                        keys << console.read_nonblock(3) rescue nil
+                        keys << console.read_nonblock(2) rescue nil
+                      end
+                      keys
 
-      end
+                    else
+                      console.gets.chomp
+
+                    end
 
       Vedeu.trigger(:tick, Time.now.to_f)
 

data/lib/vedeu/support/trace.rb

@@ -18,7 +18,9 @@ module Vedeu
     # def self.trace
     #   trace = TracePoint.new(:call) do |tp|
     #     if tp.defined_class.to_s.match(/Troo/)
-    #       Vedeu.log(type: :debug, message: [tp.defined_class.to_s, tp.method_id.to_s].join(' '))
+    #       Vedeu.log(type: :debug,
+    #                 message: [tp.defined_class.to_s,
+    #                           tp.method_id.to_s].join(' '))
     #     end
     #   end
     #   trace.enable
@@ -50,17 +52,15 @@ module Vedeu
     #
     # @return [NilClass|String]
     def trace
-      set_trace_func proc { |event, _file, _line, id, binding, classname|
-        if event == watched && id != :log && classes.include?(classname.to_s)
+      set_trace_func proc { |event, _file, _line, id, binding, name|
+        if event == watched && id != :log && classes.include?(name.to_s)
           vars = variables(binding)
 
           if vars.empty?
-            log_this(sprintf("%s %-25s #%-20s",
-              class_count, classname, id))
+            log_this(format('%s %-25s #%-20s', count, name, id))
 
           else
-            log_this(sprintf("%s %-25s #%-20s\n%s\n",
-              class_count, classname, id, vars))
+            log_this(format("%s %-25s #%-20s\n%s\n", count, name, id, vars))
 
           end
         end
@@ -86,21 +86,15 @@ module Vedeu
     # @param binding [Class]
     # @return [String]
     def variables(binding)
-      entries = []
       binding.eval('local_variables').each do |var|
-        variable = var.to_s
+        variable = Vedeu::Esc.green { var.to_s }
         value    = binding.local_variable_get(var)
-        valclass = value.class.to_s
+        klass    = Vedeu::Esc.magenta { value.class.to_s }
         output   = (value.is_a?(Proc)) ? '#<Proc:...' : value.inspect
+        content  = colour(value.class.to_s, output)
 
-        content  = Vedeu::Esc.send(class_colour.fetch(valclass, :white)) { output }
-
-        entries << sprintf("%33s %-10s = %s %s", " ",
-                                                 Vedeu::Esc.green { variable },
-                                                 Vedeu::Esc.magenta { valclass },
-                                                 content)
-      end
-      entries.join("\n")
+        format('%33s %-10s = %s %s', ' ', variable, klass, content)
+      end.join("\n")
     end
 
     # @return [String]
@@ -129,7 +123,7 @@ module Vedeu
     end
 
     # @return [Hash]
-    def class_colour
+    def colour(klass, output)
       {
         'Array'    => :yellow,
         'Fixnum'   => :cyan,
@@ -137,13 +131,13 @@ module Vedeu
         'NilClass' => :red,
         'String'   => :green,
         'Symbol'   => :magenta,
-      }
+      }.fetch(klass, :white) { |colour| Vedeu::Esc.send(colour) { output } }
     end
 
     # Returns the number of Vedeu classes/modules. (Useful for debugging.)
     #
     # @return [String]
-    def class_count
+    def count
       @count ||= "(#{classes.size}/#{vedeu_classes.size})"
     end
 
@@ -179,89 +173,22 @@ module Vedeu
     # @return [Set]
     def ignored_classes
       Set.new [
-        # 'Vedeu::API',
-        # 'Vedeu::Application',
-        # 'Vedeu::Background',
-        # 'Vedeu::Bindings',
-        # 'Vedeu::Border',
-        # 'Vedeu::BoundingArea',
-        # 'Vedeu::Buffer',
-        # 'Vedeu::Char',
-        # 'Vedeu::Chars',
         'Vedeu::Coercions',
         'Vedeu::Colour',
         'Vedeu::Common',
-        # 'Vedeu::Composition',
-        # 'Vedeu::Compositor',
-        # 'Vedeu::Config::API',
-        # 'Vedeu::Config::CLI',
         'Vedeu::Configuration',
-        # 'Vedeu::Console',
-        # 'Vedeu::Content',
-        # 'Vedeu::Coordinate',
-        # 'Vedeu::Cursor',
-        # 'Vedeu::DisplayBuffer',
-        # 'Vedeu::DSL::Border',
-        # 'Vedeu::DSL::Colour',
-        # 'Vedeu::DSL::Composition',
-        # 'Vedeu::DSL::Geometry',
-        # 'Vedeu::DSL::Interface',
-        # 'Vedeu::DSL::Keymap',
-        # 'Vedeu::DSL::Line',
-        # 'Vedeu::DSL::Menu',
-        # 'Vedeu::DSL::Stream',
-        # 'Vedeu::DSL::Style',
-        # 'Vedeu::DSL::Text',
-        # 'Vedeu::DSL::Use',
-        # 'Vedeu::DSL::View',
         'Vedeu::Esc',
         'Vedeu::Event',
-        # 'Vedeu::Focus',
-        # 'Vedeu::Foreground',
         'Vedeu::Geometry',
-        # 'Vedeu::Grid',
-        # 'Vedeu::Group',
-        # 'Vedeu::Input',
-        # 'Vedeu::Interface',
-        # 'Vedeu::Interfaces',
-        # 'Vedeu::Keymap',
-        # 'Vedeu::Keys',
-        # 'Vedeu::Key',
-        # 'Vedeu::Launcher',
-        # 'Vedeu::Line',
-        # 'Vedeu::Lines',
         'Vedeu::Log',
-        # 'Vedeu::Mapper',
-        # 'Vedeu::Menu',
-        # 'Vedeu::Menus',
-        # 'Vedeu::Model',
-        # 'Vedeu::Collection',
-        # 'Vedeu::Move',
-        # 'Vedeu::Node',
-        # 'Vedeu::Output',
         'Vedeu::Position',
-        # 'Vedeu::PositionValidator',
         'Vedeu::Presentation',
-        # 'Vedeu::Read',
-        # 'Vedeu::Refresh',
-        # 'Vedeu::Render',
         'Vedeu::Repository',
-        # 'Vedeu::Sentence',
         'Vedeu::Stream',
-        # 'Vedeu::Streams',
         'Vedeu::Style',
         'Vedeu::Terminal',
-        # 'Vedeu::Text',
-        # 'Vedeu::Toggle',
         'Vedeu::Trace',
         'Vedeu::Translator',
-        # 'Vedeu::Traps',
-        # 'Vedeu::Trigger',
-        # 'Vedeu::View',
-        # 'Vedeu::Viewport',
-        # 'Vedeu::Visible',
-        # 'Vedeu::Write',
-        # 'Vedeu::Writer',
       ]
     end
 

data/lib/vedeu/support/visibility.rb

@@ -0,0 +1,73 @@
+module Vedeu
+
+  # Change the visibility of the given model.
+  #
+  class Visibility
+
+    # @param model [void]
+    # @return [void]
+    def self.show(model)
+      new(model).show
+    end
+
+    # @param model [void]
+    # @return [void]
+    def self.hide(model)
+      new(model).hide
+    end
+
+    # @param model [void]
+    # @return [void]
+    def self.toggle(model)
+      new(model).toggle
+    end
+
+    # @param model [void]
+    # @return [Vedeu::Visibility]
+    def initialize(model)
+      @model = model
+    end
+
+    # @return [void]
+    def show
+      model.visible = true
+      model.store
+    end
+
+    # @return [Symbol]
+    def state
+      if model.visible?
+        :visible
+
+      else
+        :invisible
+
+      end
+    end
+
+    # @return [void]
+    def hide
+      model.visible = false
+      model.store
+    end
+
+    # @return [void]
+    def toggle
+      if model.visible?
+        hide
+
+      else
+        show
+
+      end
+    end
+
+    private
+
+    # @!attribute [r] model
+    # @return [void]
+    attr_reader :model
+
+  end # Visibility
+
+end # Vedeu

data/lib/vedeu.rb

@@ -2,12 +2,15 @@ $LIB_DIR = File.dirname(__FILE__) + '/../lib'
 $LOAD_PATH.unshift($LIB_DIR) unless $LOAD_PATH.include?($LIB_DIR)
 
 require 'date'
+require 'drb'
 require 'forwardable'
 require 'io/console'
+require 'json'
 require 'logger'
 require 'optparse'
 require 'set'
 require 'singleton'
+require 'thread'
 require 'time'
 
 require 'vedeu/support/log'
@@ -41,6 +44,40 @@ module Vedeu
     receiver.extend(API)
   end
 
+  # ModelNotFound: Raised with Vedeu attempts to access a named model that does
+  #   not exist.
+  #
+  # InvalidSyntax: Raised when Vedeu attempts to parse a {Vedeu.view} or
+  #   {Vedeu.interface} and encounters a problem.
+  #
+  # MissingRequired: Raised when a name is not provided for a model when
+  #   attempting to store it in a repository.
+  #
+  # ModeSwitch: Raised intentionally when the client application wishes to
+  #   switch between cooked and raw (or vice versa) terminal modes. Vedeu is
+  #   hard-wired to use the `Escape` key to trigger this change for the time
+  #   being.
+  #
+  # NotImplemented: Raised to remind me (or client application developers) that
+  #   the subclass implements the functionality sought.
+  #
+  # OutOfRange: Raised when trying to access an interface column less than 1 or
+  #   greater than 12. Vedeu is hard-wired to a 12-column layout for the time
+  #   being.
+  #
+  # VedeuInterrupt: Raised when Vedeu wishes to exit.
+  #
+  Exceptions = %w(
+    ModelNotFound
+    InvalidSyntax
+    MissingRequired
+    ModeSwitch
+    NotImplemented
+    OutOfRange
+    VedeuInterrupt
+  )
+  Exceptions.each { |e| const_set(e, Class.new(StandardError)) }
+
   private
 
 end # Vedeu

data/test/lib/vedeu/api_test.rb

@@ -7,20 +7,24 @@ module Vedeu
     describe '.log' do
       it 'writes the message to the log file when debugging is enabled' do
         Configuration.stub(:debug?, true) do
-          Vedeu.log(type: :test, message: 'Testing debugging to log').must_equal(true)
+          Vedeu.log(type: :test,
+                    message: 'Testing debugging to log').must_equal(true)
         end
       end
 
       it 'returns nil when debugging is disabled' do
         Configuration.stub(:debug?, false) do
-          Vedeu.log(type: :test, message: 'some message not logged...').must_equal(nil)
+          Vedeu.log(type: :test,
+                    message: 'some message not logged...').must_equal(nil)
         end
       end
 
       it 'write the message to the log file when the `force` argument ' \
          'evaluates to true' do
         Configuration.stub(:debug?, false) do
-          Vedeu.log(type: :test, message: 'Testing forced debugging to log', force: true).must_equal(true)
+          Vedeu.log(type: :test,
+                    message: 'Testing forced debugging to log',
+                    force: true).must_equal(true)
         end
       end
     end

data/test/lib/vedeu/application_test.rb

@@ -6,7 +6,7 @@ module Vedeu
 
     let(:described)     { Vedeu::Application }
     let(:instance)      { described.new(configuration) }
-    let(:configuration) { test_configuration }
+    let(:configuration) { Vedeu.configuration }
 
     before do
       configuration.stubs(:drb?).returns(false)
@@ -14,8 +14,13 @@ module Vedeu
     end
 
     describe '#initialize' do
-      it { instance.must_be_instance_of(described) }
-      it { instance.instance_variable_get('@configuration').must_equal(configuration) }
+      subject { instance }
+
+      it { subject.must_be_instance_of(described) }
+      it do
+        subject.instance_variable_get('@configuration').
+          must_equal(configuration)
+      end
     end
 
     describe '.start' do
@@ -29,6 +34,7 @@ module Vedeu
     describe '.stop' do
       subject { described.stop }
 
+      it { subject.must_equal(false) }
     end
 
     describe '#start' do

data/test/lib/vedeu/bindings_test.rb

@@ -6,12 +6,22 @@ module Vedeu
 
     context 'the system events needed by Vedeu to run are defined' do
       it { Vedeu.events.registered?(:_clear_).must_equal(true) }
+      it { Vedeu.events.registered?(:_clear_group_).must_equal(true) }
+      it { Vedeu.events.registered?(:_cleanup_).must_equal(true) }
+      it { Vedeu.events.registered?(:_command_).must_equal(true) }
       it { Vedeu.events.registered?(:_exit_).must_equal(true) }
+      it { Vedeu.events.registered?(:_hide_group_).must_equal(true) }
       it { Vedeu.events.registered?(:_initialize_).must_equal(true) }
       it { Vedeu.events.registered?(:_keypress_).must_equal(true) }
       it { Vedeu.events.registered?(:_log_).must_equal(true) }
       it { Vedeu.events.registered?(:_mode_switch_).must_equal(true) }
+      it { Vedeu.events.registered?(:_refresh_).must_equal(true) }
+      it { Vedeu.events.registered?(:_refresh_cursor_).must_equal(true) }
+      it { Vedeu.events.registered?(:_refresh_group_).must_equal(true) }
       it { Vedeu.events.registered?(:_resize_).must_equal(true) }
+      it { Vedeu.events.registered?(:_show_group_).must_equal(true) }
+      it { Vedeu.events.registered?(:tick).must_equal(true) }
+      it { Vedeu.events.registered?(:tock).must_equal(true) }
     end
 
     context 'the cursor specific events are defined' do
@@ -22,6 +32,17 @@ module Vedeu
       it { Vedeu.events.registered?(:_cursor_right_).must_equal(true) }
       it { Vedeu.events.registered?(:_cursor_up_).must_equal(true) }
       it { Vedeu.events.registered?(:_cursor_origin_).must_equal(true) }
+      it { Vedeu.events.registered?(:_cursor_reset_).must_equal(true) }
+    end
+
+    context 'the drb specific events are defined' do
+      it { Vedeu.events.registered?(:_drb_input_).must_equal(true) }
+      it { Vedeu.events.registered?(:_drb_retrieve_output_).must_equal(true) }
+      it { Vedeu.events.registered?(:_drb_store_output_).must_equal(true) }
+      it { Vedeu.events.registered?(:_drb_restart_).must_equal(true) }
+      it { Vedeu.events.registered?(:_drb_start_).must_equal(true) }
+      it { Vedeu.events.registered?(:_drb_status_).must_equal(true) }
+      it { Vedeu.events.registered?(:_drb_stop_).must_equal(true) }
     end
 
     context 'the focus specific events are defined' do