vedeu 0.3.4 → 0.3.5

data/lib/vedeu/cursor/cursor.rb

@@ -9,6 +9,7 @@ module Vedeu
   # visibility of the cursor within that interface.
   #
   # @api private
+  #
   class Cursor
 
     extend Forwardable
@@ -49,6 +50,8 @@ module Vedeu
       @state      = Vedeu::Visible.coerce(@attributes.fetch(:state))
       @x          = @attributes.fetch(:x)
       @y          = @attributes.fetch(:y)
+
+      @position   = Vedeu::Position.new(@y, @x)
     end
 
     # Returns log friendly output.
@@ -76,6 +79,8 @@ module Vedeu
 
     private
 
+    attr_reader :position
+
     # The default values for a new instance of this class.
     #
     # @return [Hash]
@@ -85,7 +90,7 @@ module Vedeu
         ox:         0,
         oy:         0,
         repository: Vedeu.cursors,
-        state:      Vedeu::Visible.new(false),
+        state:      false,
         x:          1,
         y:          1,
       }
@@ -98,13 +103,6 @@ module Vedeu
       [ position, visibility ].join
     end
 
-    # Returns the escape sequence for setting the position of the cursor.
-    #
-    # @return [String]
-    def position
-      Vedeu::Position.new(y, x).to_s
-    end
-
     # Returns the escape sequence for setting the visibility of the cursor.
     #
     # @return [String]

data/lib/vedeu/cursor/move_cursor.rb

@@ -5,6 +5,7 @@ require 'vedeu/support/position_validator'
 module Vedeu
 
   # Adjusts the position of the cursor.
+  #
   class MoveCursor
 
     extend Forwardable

data/lib/vedeu/cursor/toggle_cursor.rb

@@ -1,6 +1,7 @@
 module Vedeu
 
   # Adjusts the visibility of the cursor.
+  #
   class ToggleCursor
 
     # @param cursor [Cursor]

data/lib/vedeu/debug.rb

@@ -0,0 +1,23 @@
+require 'ruby-prof'
+
+module Vedeu
+
+  # Helps to debug a running application by providing a stack trace of its
+  # execution upon exiting.
+  #
+  # @param filename [String]
+  # @param block [Proc]
+  def self.debug(filename = 'profile.html', &block)
+    RubyProf.start
+
+    yield
+
+    result = RubyProf.stop
+    result.eliminate_methods!([/^Array/, /^Hash/])
+
+    File.open('/tmp/' + filename, 'w') do |file|
+      RubyProf::CallStackPrinter.new(result).print(file)
+    end
+  end
+
+end # Vedeu

data/lib/vedeu/distributed/all.rb

@@ -1,6 +1,6 @@
 require 'vedeu/distributed/uri'
+require 'vedeu/distributed/server'
 require 'vedeu/distributed/client'
-require 'vedeu/distributed/application'
 require 'vedeu/distributed/subprocess'
 require 'vedeu/distributed/test_application'
 

data/lib/vedeu/distributed/client.rb

@@ -4,49 +4,91 @@ module Vedeu
 
   module Distributed
 
+    # A class for the client side of the DRb server/client relationship.
+    #
     # @example
-    #   client = Vedeu::Distributed::Client.new("druby://localhost:21420")
+    #   client = Vedeu::Distributed::Client.connect("druby://localhost:21420")
     #   client.input('a')
     #   client.output # => 'some content...'
-    #   client.stop
     #
     class Client
 
+      # @param uri [String]
+      # @return [Client]
+      def self.connect(uri)
+        new(uri).connect
+      end
+
       # @param uri [String]
       # @return [Client]
       def initialize(uri)
         @uri = uri.to_s
       end
 
+      # Simulate connecting to the DRb server by requesting its status.
+      #
+      # @return [Symbol]
+      def connect
+        server.status
+
+      rescue DRb::DRbBadURI
+        puts "Could not connect to DRb server, URI may be bad."
+
+      rescue DRb::DRbConnError
+        puts "Could not connect to DRb server."
+
+      end
+
+      # Send input to the DRb server.
+      #
       # @param data [String|Symbol]
-      # @return []
+      # @return [void]
       def input(data)
         server.input(data)
+
+      rescue DRb::DRbConnError
+        puts "Could not connect to DRb server."
+
       end
       alias_method :read, :input
 
-      # @return []
+      # Fetch output from the DRb server.
+      #
+      # @return [void]
       def output
         server.output
+
+      rescue DRb::DRbConnError
+        puts "Could not connect to DRb server."
+
       end
       alias_method :write, :output
 
-      # @return []
-      def start
-        # client should be able to start a server, but what if one already
-        # exists?
-      end
+      # Shutdown the DRb server and the client application.
+      #
+      # @note
+      #   {Vedeu::Application} will raise StopIteration when its `.stop` method
+      #   is called. Here we rescue that to give a clean client exit.
+      #
+      # @return [void]
+      def shutdown
+        server.shutdown
+
+        Process.kill("KILL", server.pid)
+
+      rescue DRb::DRbConnError
+        puts "Could not connect to DRb server."
+
+      rescue Interrupt
+        puts "Client application exited."
 
-      # @return []
-      def stop
-        server.stop
       end
 
       private
 
       attr_reader :uri
 
-      # @return []
+      # @return [void]
       def server
         @server ||= DRbObject.new_with_uri(uri)
       end

data/lib/vedeu/distributed/server.rb

@@ -0,0 +1,207 @@
+require 'drb'
+require 'singleton'
+
+module Vedeu
+
+  module Distributed
+
+    # A class for the server side of the DRb server/client relationship.
+    #
+    # @api private
+    #
+    class Server
+
+      $SAFE = 1 # disable `eval` and related calls on strings passed
+
+      include Singleton
+
+      # @param data [String|Symbol]
+      # @return [void]
+      def self.input(data)
+        instance.input(data)
+      end
+
+      # @return [void]
+      def self.output
+        instance.output
+      end
+
+      # @return [void]
+      def self.restart
+        instance.restart
+      end
+
+      # @return [void]
+      def self.shutdown
+        instance.shutdown
+      end
+
+      # @return [void]
+      def self.start
+        instance.start
+      end
+
+      # @return [Symbol]
+      def self.status
+        instance.status
+      end
+
+      # @return [void]
+      def self.stop
+        instance.stop
+      end
+
+      # @param data [String|Symbol]
+      # @return [void]
+      def input(data)
+        Vedeu.trigger(:_drb_input_, data)
+      end
+      alias_method :read, :input
+
+      # @return [void]
+      def output
+        Vedeu.trigger(:_drb_retrieve_output_)
+      end
+      alias_method :write, :output
+
+      # @return [Fixnum] The PID of the currently running application.
+      def pid
+        Process.pid
+      end
+
+      # @return [void]
+      def restart
+        return not_enabled unless drb?
+
+        if drb_running?
+          log('Restarting')
+
+          stop
+
+          start
+
+        else
+          log('Not running')
+
+          start
+
+        end
+      end
+
+      # When called will stop the DRb server and attempt to terminate the client
+      # application.
+      #
+      # @note
+      #   :_exit_ never gets triggered as when the DRb server goes away, no
+      #   further methods will be called.
+      #
+      # @return [void]
+      def shutdown
+        return not_enabled unless drb?
+
+        stop if drb_running?
+
+        Vedeu.trigger(:_exit_)
+
+        Terminal.restore_screen
+      end
+
+      # @return [Vedeu::Distributed::Server]
+      def start
+        return not_enabled unless drb?
+
+        if drb_running?
+          log('Already started')
+
+        else
+          log('Starting')
+
+          DRb.start_service(uri, self)
+
+          # DRb.thread.join # not convinced this is needed here
+        end
+      end
+
+      # @return [Symbol]
+      def status
+        return not_enabled unless drb?
+
+        if drb_running?
+          log('Running')
+
+          :running
+
+        else
+          log('Stopped')
+
+          :stopped
+
+        end
+      end
+
+      # @return [void]
+      def stop
+        return not_enabled unless drb?
+
+        if drb_running?
+          log('Stopping')
+
+          DRb.stop_service
+
+          DRb.thread.join
+
+        else
+          log('Already stopped')
+
+        end
+      rescue NoMethodError # raised when #join is called on NilClass.
+        # ...
+
+      end
+
+      private
+
+      attr_reader :configuration
+
+      # @return [Boolean]
+      def drb?
+        Vedeu::Configuration.drb?
+      end
+
+      # @return [String]
+      def drb_host
+        Vedeu::Configuration.drb_host
+      end
+
+      # @return [|NilClass]
+      def drb_running?
+        DRb.thread
+      end
+
+      # @return [Fixnum|String]
+      def drb_port
+        Vedeu::Configuration.drb_port
+      end
+
+      # @return [void]
+      def log(message)
+        Vedeu.log(type: :drb, message: "#{message}: '#{uri}'")
+      end
+
+      # @return [Symbol]
+      def not_enabled
+        log('Not enabled')
+
+        :drb_not_enabled
+      end
+
+      # @return [String]
+      def uri
+        Vedeu::Distributed::Uri.new(drb_host, drb_port).to_s
+      end
+
+    end # Server
+
+  end # Distributed
+
+end # Vedeu

data/lib/vedeu/distributed/subprocess.rb

@@ -32,7 +32,7 @@ module Vedeu
   class Subprocess
 
     # @param application [Vedeu::TestApplication]
-    # @return []
+    # @return [Array]
     def self.execute!(application)
       new(application).execute!
     end
@@ -41,51 +41,52 @@ module Vedeu
     # @return [Vedeu::Subprocess]
     def initialize(application)
       @application = application
+      @pid         = nil
     end
 
-    # @return []
+    # @return [Array]
     def execute!
       file_open && file_write && file_close
 
-      begin
-        PTY.spawn(command) do |stdin, stdout, pid|
-          begin
-            stdin.each { |line| print line }
+      @pid = fork do
+        exec(file_path)
+      end
 
-          rescue Errno::EIO
-            puts 'Errno::EIO: Process may have stopped giving output.'
+      Process.detach(@pid)
 
-          end
-        end
-      rescue PTY::ChildExited
-        puts 'PTY::ChildExited: Process exited.'
+      self
+    end
 
-      ensure
-        file_unlink
+    # Sends the KILL signal to the process.
+    #
+    # @return [void]
+    def kill
+      Process.kill('KILL', pid)
 
-      end
+      file_unlink
     end
 
     private
 
-    attr_reader :application
+    attr_reader   :application
+    attr_accessor :pid
 
     # @return [String]
     def command
       "ruby #{file_path}"
     end
 
-    # @return []
+    # @return [Fixnum] The number of bytes written.
     def file_write
       file.write(application)
     end
 
-    # @return []
+    # @return [NilClass]
     def file_close
       file.close
     end
 
-    # @return []
+    # @return [Fixnum] The number of files removed; 1.
     def file_unlink
       File.unlink("/tmp/foo_#{timestamp}")
     end
@@ -95,9 +96,9 @@ module Vedeu
       file.path
     end
 
-    # @return []
+    # @return [File]
     def file_open
-      @file ||= File.new("/tmp/foo_#{timestamp}", "w")
+      @file ||= File.new("/tmp/foo_#{timestamp}", "w", 0755)
     end
     alias_method :file, :file_open
 

data/lib/vedeu/distributed/templates/default_application.vedeu

@@ -1,3 +1,5 @@
+#!/usr/bin/env ruby
+
 lib_dir = "<%= @object.lib_dir %>"
 $LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
 
@@ -27,7 +29,7 @@ class VedeuTestApplication
                  stdout = STDOUT,
                  stderr = STDERR,
                  kernel = Kernel)
-    Vedeu::Launcher.new(argv, stdin, stdout, stderr, kernel).execute!
+    Vedeu::Launcher.execute!(argv, stdin, stdout, stderr, kernel)
   end
 end
 

data/lib/vedeu/distributed/test_application.rb

@@ -27,6 +27,8 @@ module Vedeu
       :menus,
       :views
 
+    # @param attributes [Hash]
+    # @param block [Proc]
     # @return [String]
     def self.build(attributes = {}, &block)
       new(attributes).build(&block)
@@ -41,7 +43,6 @@ module Vedeu
     # @option attributes keymaps [String]
     # @option attributes menus [String]
     # @option attributes views [String]
-    # @param block [Proc]
     # @return [TestApplication]
     def initialize(attributes = {})
       @attributes = defaults.merge(attributes)

data/lib/vedeu/distributed/uri.rb

@@ -4,6 +4,7 @@ module Vedeu
 
     # Value class which provides the host and port for the DRb server and
     # client.
+    #
     class Uri
 
       attr_reader :host, :port

data/lib/vedeu/dsl/all.rb

@@ -9,6 +9,8 @@ require 'vedeu/dsl/view'
 
 module Vedeu
 
+  # Provides a mechanism to help configure and use Vedeu.
+  #
   module DSL
 
     # Attempts to find the missing method on the client object.
@@ -16,9 +18,9 @@ module Vedeu
     # @param method [Symbol] The name of the method sought.
     # @param args [Array] The arguments which the method was to be invoked with.
     # @param block [Proc] The optional block provided to the method.
-    # @return []
+    # @return [void]
     def method_missing(method, *args, &block)
-      Vedeu.log("!!!method_missing '#{method}'")
+      Vedeu.log(type: :debug, message: "!!!method_missing '#{method}'")
 
       client.send(method, *args, &block) if client
     end

data/lib/vedeu/dsl/components/border.rb

@@ -39,6 +39,7 @@ module Vedeu
         # @param name [String] The name of the interface or view to which this
         #   border belongs.
         # @param block [Proc]
+        # @raise [InvalidSyntax] The required block was not given.
         # @return [Vedeu::Border]
         def border(name, &block)
           fail InvalidSyntax, 'block not given' unless block_given?
@@ -70,7 +71,7 @@ module Vedeu
       #   character.
       # @return [String]
       def bottom_left(char)
-        model.attributes[:bottom_left] = char
+        model.bottom_left = char
       end
 
       # Set the character to be used to draw the bottom right corner of the
@@ -87,7 +88,7 @@ module Vedeu
       #   character.
       # @return [String]
       def bottom_right(char)
-        model.attributes[:bottom_right] = char
+        model.bottom_right = char
       end
 
       # Set the character to be used to draw a horizontal part of the border.
@@ -103,7 +104,7 @@ module Vedeu
       #   character.
       # @return [String]
       def horizontal(char)
-        model.attributes[:horizontal] = char
+        model.horizontal = char
       end
 
       # Enable/disable the bottom border.
@@ -122,7 +123,7 @@ module Vedeu
       #   false.
       # @return [Boolean]
       def bottom(boolean)
-        model.attributes[:show_bottom] = !!boolean
+        model.show_bottom = !!boolean
       end
       alias_method :show_bottom, :bottom
 
@@ -152,7 +153,7 @@ module Vedeu
       #   false.
       # @return [Boolean]
       def left(boolean)
-        model.attributes[:show_left] = !!boolean
+        model.show_left = !!boolean
       end
       alias_method :show_left, :left
 
@@ -182,7 +183,7 @@ module Vedeu
       #   false.
       # @return [Boolean]
       def right(boolean)
-        model.attributes[:show_right] = !!boolean
+        model.show_right = !!boolean
       end
       alias_method :show_right, :right
 
@@ -212,7 +213,7 @@ module Vedeu
       #   false.
       # @return [Boolean]
       def top(boolean)
-        model.attributes[:show_top] = !!boolean
+        model.show_top = !!boolean
       end
       alias_method :show_top, :top
 
@@ -239,7 +240,7 @@ module Vedeu
       #   character.
       # @return [String]
       def top_left(char)
-        model.attributes[:top_left] = char
+        model.top_left = char
       end
 
       # Set the character to be used to draw the top right corner of the border.
@@ -255,7 +256,7 @@ module Vedeu
       #   character.
       # @return [String]
       def top_right(char)
-        model.attributes[:top_right] = char
+        model.top_right = char
       end
 
       # Set the character to be used to draw a vertical part of the border.
@@ -271,7 +272,7 @@ module Vedeu
       #   character.
       # @return [String]
       def vertical(char)
-        model.attributes[:vertical] = char
+        model.vertical = char
       end
 
       private

data/lib/vedeu/dsl/components/geometry.rb

@@ -23,6 +23,7 @@ module Vedeu
         # @param name [String] The name of the interface or view to which this
         #   geometry belongs.
         # @param block [Proc]
+        # @raise [InvalidSyntax] The required block was not given.
         # @return [Vedeu::Geometry]
         def geometry(name, &block)
           fail InvalidSyntax, 'block not given' unless block_given?

data/lib/vedeu/dsl/components/keymap.rb

@@ -9,6 +9,7 @@ module Vedeu
     # Provides methods to be used to define keypress mapped to actions.
     #
     # @api public
+    #
     class Keymap
 
       include Vedeu::Common

data/lib/vedeu/dsl/components/menu.rb

@@ -6,6 +6,7 @@ module Vedeu
     # events to drive them.
     #
     # @api public
+    #
     class Menu
 
       include Vedeu::DSL

data/lib/vedeu/dsl/interface.rb

@@ -11,6 +11,7 @@ module Vedeu
   module DSL
 
     # DSL for creating interfaces.
+    #
     class Interface
 
       include Vedeu::Common