vedeu 0.3.3 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 54bb0cd0826751a7fb718c0bd4a68aed54a12d1e
-  data.tar.gz: 06d71adf59c0300bd27812b07593bcfdfb71114a
+  metadata.gz: fccb60d2e33924a76f711a5ffccd643c7436a4fe
+  data.tar.gz: 03c59bf2a8d7c6265aa164807f9b72af46c7d055
 SHA512:
-  metadata.gz: 072569691f768aee22091160266ea4cb944865ecb186eb62eec47617f39a28d30d5629ff72b2c69919f82dbc3c41bb562dbef2afa00daaf91d466db358465a4b
-  data.tar.gz: 42074a95c54fedb6143ad082188185ca2e5bd6d60d0f092cb9e2d16bf9bfba2b49b40c0e1a7a23b0e218473415128cfe5d2d17bb7923fa3be8e9d5449542be2f
+  metadata.gz: 48627364195755fcd4390963bf27188ca813d62b2e1cf14d4c20b824ea087e36669942fbeedcf40df8857171a468e71505af437a0bfb93b0656c9a761a170532
+  data.tar.gz: 52c5edb46c2a7e72e11084670829ae1e913a3fb4f96245463a682b6047f9cc45be5a597142a96327e1698a42f75357d6115fbdd7062acf9cadbc8fb16d6646b7

data/bin/vedeu_drb_client

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+client = Vedeu::Distributed::Client.new("druby://localhost:21420")
+client.input('a')
+client.output # => 'some content...'
+client.stop

data/lib/vedeu/all.rb

@@ -14,6 +14,7 @@ require 'vedeu/bindings'
 require 'vedeu/buffers/all'
 require 'vedeu/configuration/all'
 require 'vedeu/cursor/all'
+require 'vedeu/distributed/all'
 
 require 'vedeu/dsl/shared/all'
 require 'vedeu/dsl/all'

data/lib/vedeu/application.rb

@@ -49,13 +49,19 @@ module Vedeu
     #
     # @return [Array] The last output sent to the terminal.
     def start
-      Terminal.open do
+      distributed_start
+
+      output = Terminal.open do
         Terminal.set_cursor_mode
 
         Vedeu.trigger(:_initialize_)
 
         runner { main_sequence }
       end
+
+      distributed_stop
+
+      output
     end
 
     private
@@ -109,10 +115,27 @@ module Vedeu
     rescue ModeSwitch
       Terminal.switch_mode!
 
+      distributed_stop
+
       Application.restart
 
     end
 
+    # @return []
+    def distributed_start
+      distributed.start if configuration.drb?
+    end
+
+    # @return []
+    def distributed_stop
+      distributed.stop if configuration.drb?
+    end
+
+    # @return [Vedeu::Distributed::Application]
+    def distributed
+      @distributed ||= Vedeu::Distributed::Application.new(configuration)
+    end
+
     # :nocov:
 
   end # Application

data/lib/vedeu/configuration/api.rb

@@ -105,6 +105,74 @@ module Vedeu
       end
       alias_method :run_once, :run_once!
 
+      # Sets boolean to run a DRb server.
+      #
+      # @example
+      #   Vedeu.configure do
+      #     drb!
+      #     ...
+      #
+      # @param value [Boolean]
+      # @return [Boolean]
+      def drb!(value = true)
+        Vedeu.log("Configuration::API drb: #{value}")
+
+        options[:drb] = value
+      end
+      alias_method :drb, :drb!
+
+      # Sets the hostname or IP address of the DRb server.
+      #
+      # @example
+      #   Vedeu.configure do
+      #     drb_host 'localhost'
+      #     ...
+      #
+      # @param hostname [String]
+      # @return [String]
+      def drb_host(hostname = '')
+        options[:drb_host] = hostname
+      end
+
+      # Sets the port of the DRb server.
+      #
+      # @example
+      #   Vedeu.configure do
+      #     drb_port 12345
+      #     ...
+      #
+      # @param port [Fixnum|String]
+      # @return [String]
+      def drb_port(port = '')
+        options[:drb_port] = port
+      end
+
+      # Sets the height of the fake terminal in the DRb server.
+      #
+      # @example
+      #   Vedeu.configure do
+      #     drb_height 25
+      #     ...
+      #
+      # @param height [Fixnum]
+      # @return [Fixnum]
+      def drb_height(height = 25)
+        options[:drb_height] = height
+      end
+
+      # Sets the width of the fake terminal in the DRb server.
+      #
+      # @example
+      #   Vedeu.configure do
+      #     drb_width 80
+      #     ...
+      #
+      # @param width [Fixnum]
+      # @return [Fixnum]
+      def drb_width(width = 80)
+        options[:drb_width] = width
+      end
+
       # Sets the terminal mode to `cooked`. Default terminal mode is `raw`.
       #
       # @example
@@ -223,6 +291,45 @@ module Vedeu
         options[:log] = filename
       end
 
+      # Sets the value of STDIN.
+      #
+      # @example
+      #   Vedeu.configure do
+      #     stdin IO.console
+      #     ...
+      #
+      # @param io [File|IO]
+      # @return [File|IO]
+      def stdin(io)
+        options[:stdin] = io
+      end
+
+      # Sets the value of STDOUT.
+      #
+      # @example
+      #   Vedeu.configure do
+      #     stdout IO.console
+      #     ...
+      #
+      # @param io [File|IO]
+      # @return [File|IO]
+      def stdout(io)
+        options[:stdout] = io
+      end
+
+      # Sets the value of STDERR.
+      #
+      # @example
+      #   Vedeu.configure do
+      #     stderr IO.console
+      #     ...
+      #
+      # @param io [File|IO]
+      # @return [File|IO]
+      def stderr(io)
+        options[:stderr] = io
+      end
+
       # Sets the key used to exit the client application. The default is `q`.
       #
       # @example

data/lib/vedeu/configuration/cli.rb

@@ -114,6 +114,40 @@ module Vedeu
 
             options[:log] = filename
           end
+
+          opts.on('--drb', 'Run application with DRb on.') do
+            Vedeu.log("Configuration::CLI drb: true")
+
+            options[:drb] = true
+          end
+
+          opts.on('--drb-host', 'Set the hostname/IP for the DRb server.') do |hostname|
+            Vedeu.log("Configuration::CLI drb_host: #{hostname}")
+
+            #options[:drb]      = true
+            options[:drb_host] = hostname
+          end
+
+          opts.on('--drb-port', 'Set the port for the DRb server.') do |port|
+            Vedeu.log("Configuration::CLI drb_port: #{port}")
+
+            #options[:drb]      = true
+            options[:drb_port] = port
+          end
+
+          opts.on('--drb-height', 'Set the height for fake terminal of the DRb server.') do |height|
+            Vedeu.log("Configuration::CLI drb_height: #{height}")
+
+            #options[:drb]      = true
+            options[:drb_height] = height
+          end
+
+          opts.on('--drb-width', 'Set the width for fake terminal of the DRb server.') do |width|
+            Vedeu.log("Configuration::CLI drb_width: #{width}")
+
+            #options[:drb]      = true
+            options[:drb_width] = width
+          end
         end
 
         parser.parse!(args)

data/lib/vedeu/configuration/configuration.rb

@@ -30,11 +30,15 @@ module Vedeu
       # arguments provided.
       #
       # @param args [Array]
+      # @param opts [Hash]
+      # @option opts stdin [File|IO]
+      # @option opts stdout [File|IO]
+      # @option opts stderr [File|IO]
       # @param block [Proc]
       # @raise [InvalidSyntax] When the required block is not given.
       # @return [Hash]
-      def configure(args = [], &block)
-        instance.configure(args, &block)
+      def configure(args = [], opts = {}, &block)
+        instance.configure(args, opts, &block)
       end
 
       # Returns the configuration singleton.
@@ -60,6 +64,42 @@ module Vedeu
       end
       alias_method :debug, :debug?
 
+      # Returns whether the DRb server is enabled or disabled. Default is false.
+      #
+      # @return [Boolean]
+      def drb?
+        instance.options[:drb]
+      end
+      alias_method :drb, :drb?
+
+      # Returns the hostname for the DRb server.
+      #
+      # @return [String]
+      def drb_host
+        instance.options[:drb_host]
+      end
+
+      # Returns the port for the DRb server.
+      #
+      # @return [String]
+      def drb_port
+        instance.options[:drb_port]
+      end
+
+      # Returns the height for the fake terminal in the DRb server.
+      #
+      # @return [Fixnum]
+      def drb_height
+        instance.options[:drb_height]
+      end
+
+      # Returns the width for the fake terminal in the DRb server.
+      #
+      # @return [Fixnum]
+      def drb_width
+        instance.options[:drb_width]
+      end
+
       # Returns whether the application is interactive (required user input) or
       # standalone (will run until terminates of natural causes.) Default is
       # true; meaning the application will require user input.
@@ -87,7 +127,28 @@ module Vedeu
       end
       alias_method :once, :once?
 
-      # Returns
+      # Returns the redefined setting for STDIN.
+      #
+      # @return [File|IO]
+      def stdin
+        instance.options[:stdin]
+      end
+
+      # Returns the redefined setting for STDOUT.
+      #
+      # @return [File|IO]
+      def stdout
+        instance.options[:stdout]
+      end
+
+      # Returns the redefined setting for STDERR.
+      #
+      # @return [File|IO]
+      def stderr
+        instance.options[:stderr]
+      end
+
+      # Returns the redefined system keys for vital Vedeu functions.
       #
       # @return [Hash]
       def system_keys
@@ -156,7 +217,9 @@ module Vedeu
     # @param args [Array]
     # @param block [Proc]
     # @return [Hash]
-    def configure(args = [], &block)
+    def configure(args = [], opts = {}, &block)
+      @options.merge!(opts)
+
       @options.merge!(Config::API.configure(&block)) if block_given?
 
       @options.merge!(Config::CLI.configure(args)) if args.any?
@@ -183,9 +246,17 @@ module Vedeu
       {
         colour_mode:   detect_colour_mode,
         debug:         false,
+        drb:           false,
+        drb_host:      nil,
+        drb_port:      nil,
+        drb_height:    25,
+        drb_width:     80,
         interactive:   true,
         log:           '/tmp/vedeu.log',
         once:          false,
+        stdin:         nil,
+        stdout:        nil,
+        stderr:        nil,
         system_keys:   Configuration.default_system_keys,
         terminal_mode: :raw,
         trace:         false,

data/lib/vedeu/distributed/all.rb

@@ -0,0 +1,8 @@
+require 'vedeu/distributed/uri'
+require 'vedeu/distributed/client'
+require 'vedeu/distributed/application'
+require 'vedeu/distributed/subprocess'
+require 'vedeu/distributed/test_application'
+
+module Vedeu
+end # Vedeu

data/lib/vedeu/distributed/application.rb

@@ -0,0 +1,91 @@
+require 'drb'
+
+module Vedeu
+
+  module Distributed
+
+    # Orchestrates the running of the main application loop via the DRb server.
+    #
+    # @example
+    #   app = Vedeu::Distributed::Application.start(configuration)
+    #   app.input('a')
+    #   app.output # => some output
+    #   app.stop
+    #
+    # @api private
+    class Application
+
+      class << self
+
+        # @param configuration [Vedeu::Configuration]
+        # @return []
+        def start(configuration)
+          new(configuration).start
+        end
+
+      end
+
+      # @param configuration [Vedeu::Configuration]
+      # @return []
+      def initialize(configuration)
+        @configuration = configuration
+
+        # $SAFE = 1 # stop eval and friends
+      end
+
+      # @return []
+      def start
+        Vedeu.bind(:_output_) { |data| self.output(data) }
+
+        Vedeu.log("Started distributed server: '#{uri}'")
+
+        DRb.start_service(uri, self)
+
+        self
+      end
+
+      # @param data []
+      # @return []
+      def input(data)
+        Vedeu.log("<<< DRb Input")
+
+        Vedeu.trigger(:_keypress_, data)
+      end
+      alias_method :read, :input
+
+      # @param data []
+      # @return []
+      def output(data = nil)
+        Vedeu.log(">>> DRb Output")
+
+        data
+      end
+      alias_method :write, :output
+
+      # @return []
+      def stop
+        Vedeu.log("Stopping distributed server: '#{uri}'")
+
+        DRb.stop_service
+
+        DRb.thread.join
+      rescue NoMethodError # raised when #join is called on NilClass.
+        # ...
+
+      end
+
+      private
+
+      attr_reader :configuration
+
+      # @return [String]
+      def uri
+        Vedeu::Distributed::Uri.new(configuration.drb_host,
+                                    configuration.drb_port).to_s
+      end
+
+    end # Application
+
+  end # Distributed
+
+end # Vedeu

data/lib/vedeu/distributed/client.rb

@@ -0,0 +1,58 @@
+require 'drb'
+
+module Vedeu
+
+  module Distributed
+
+    # @example
+    #   client = Vedeu::Distributed::Client.new("druby://localhost:21420")
+    #   client.input('a')
+    #   client.output # => 'some content...'
+    #   client.stop
+    #
+    class Client
+
+      # @param uri [String]
+      # @return [Client]
+      def initialize(uri)
+        @uri = uri.to_s
+      end
+
+      # @param data [String|Symbol]
+      # @return []
+      def input(data)
+        server.input(data)
+      end
+      alias_method :read, :input
+
+      # @return []
+      def output
+        server.output
+      end
+      alias_method :write, :output
+
+      # @return []
+      def start
+        # client should be able to start a server, but what if one already
+        # exists?
+      end
+
+      # @return []
+      def stop
+        server.stop
+      end
+
+      private
+
+      attr_reader :uri
+
+      # @return []
+      def server
+        @server ||= DRbObject.new_with_uri(uri)
+      end
+
+    end # Client
+
+  end # Distributed
+
+end # Vedeu

data/lib/vedeu/distributed/subprocess.rb

@@ -0,0 +1,111 @@
+require 'pty'
+require 'vedeu/distributed/test_application'
+
+# app_config = Vedeu::TestApplication.build
+# timestamp = Time.now.to_i
+# file = File.new("/tmp/foo_#{timestamp}", "w")
+# file.write(app_config)
+# file.close
+
+# cmd = "ruby #{file.path}"
+# begin
+#   PTY.spawn(cmd) do |stdin, stdout, pid|
+#     begin
+#       # Do stuff with the output here. Just printing to show it works
+#       stdin.each { |line| print line }
+#     rescue Errno::EIO
+#       puts "Errno:EIO error, but this probably just means " +
+#             "that the process has finished giving output"
+#     end
+#   end
+# rescue PTY::ChildExited
+#   puts "The child process exited!"
+# ensure
+#   File.unlink("/tmp/foo_#{timestamp}")
+# end
+
+module Vedeu
+
+  # @example
+  #   Vedeu::TestApplication.build
+  #
+  class Subprocess
+
+    # @param application [Vedeu::TestApplication]
+    # @return []
+    def self.execute!(application)
+      new(application).execute!
+    end
+
+    # @param application [Vedeu::TestApplication]
+    # @return [Vedeu::Subprocess]
+    def initialize(application)
+      @application = application
+    end
+
+    # @return []
+    def execute!
+      file_open && file_write && file_close
+
+      begin
+        PTY.spawn(command) do |stdin, stdout, pid|
+          begin
+            stdin.each { |line| print line }
+
+          rescue Errno::EIO
+            puts 'Errno::EIO: Process may have stopped giving output.'
+
+          end
+        end
+      rescue PTY::ChildExited
+        puts 'PTY::ChildExited: Process exited.'
+
+      ensure
+        file_unlink
+
+      end
+    end
+
+    private
+
+    attr_reader :application
+
+    # @return [String]
+    def command
+      "ruby #{file_path}"
+    end
+
+    # @return []
+    def file_write
+      file.write(application)
+    end
+
+    # @return []
+    def file_close
+      file.close
+    end
+
+    # @return []
+    def file_unlink
+      File.unlink("/tmp/foo_#{timestamp}")
+    end
+
+    # return [String]
+    def file_path
+      file.path
+    end
+
+    # @return []
+    def file_open
+      @file ||= File.new("/tmp/foo_#{timestamp}", "w")
+    end
+    alias_method :file, :file_open
+
+    # return [Fixnum]
+    def timestamp
+      @timestamp ||= Time.now.to_i
+    end
+
+  end # Subprocess
+
+end # Vedeu

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

@@ -0,0 +1,34 @@
+lib_dir = "<%= @object.lib_dir %>"
+$LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
+
+require 'vedeu'
+
+class VedeuTestApplication
+  # include Vedeu
+
+<%= @object.configuration -%>
+
+<%= @object.events -%>
+
+<%= @object.borders -%>
+
+<%= @object.geometries -%>
+
+<%= @object.interfaces -%>
+
+<%= @object.keymaps -%>
+
+<%= @object.menus -%>
+
+<%= @object.views -%>
+
+  def self.start(argv   = ARGV,
+                 stdin  = STDIN,
+                 stdout = STDOUT,
+                 stderr = STDERR,
+                 kernel = Kernel)
+    Vedeu::Launcher.new(argv, stdin, stdout, stderr, kernel).execute!
+  end
+end
+
+VedeuTestApplication.start(ARGV)

data/lib/vedeu/distributed/templates/default_borders.vedeu

@@ -0,0 +1,19 @@
+Vedeu.border 'test_interface' do
+  # Define colour and style of border
+  colour foreground: '#ffff00', background: '#0000ff'
+  style  'normal'
+
+  # Define visibility of border
+  show_bottom!
+  show_left!
+  show_right!
+  show_top!
+
+  # Define characters used to draw border
+  bottom_right '+'
+  bottom_left  '+'
+  horizontal   '-'
+  top_right    '+'
+  top_left     '+'
+  vertical     '|'
+end