vedeu 0.4.3 → 0.4.4

data/lib/vedeu/distributed/all.rb

@@ -5,4 +5,11 @@ require 'vedeu/distributed/subprocess'
 require 'vedeu/distributed/test_application'
 
 module Vedeu
+
+  # Provides a mechanism to control a running client application via DRb.
+  #
+  module Distributed
+
+  end # Distributed
+
 end # Vedeu

data/lib/vedeu/distributed/client.rb

@@ -19,7 +19,7 @@ module Vedeu
         new(uri).connect
       end
 
-      # @param uri [String]
+      # @param uri [Vedeu::Distributed::Uri|String]
       # @return [Client]
       def initialize(uri)
         @uri = uri.to_s
@@ -31,35 +31,37 @@ module Vedeu
       def connect
         server.status
 
+      rescue DRb::DRbConnError
+        drb_connection_error
+
       rescue DRb::DRbBadURI
-        puts "Could not connect to DRb server, URI may be bad."
+        puts 'Could not connect to DRb server, URI may be bad.'
 
-      rescue DRb::DRbConnError
-        puts "Could not connect to DRb server."
+        :drb_bad_uri
 
       end
 
       # Send input to the DRb server.
       #
       # @param data [String|Symbol]
-      # @return [void]
+      # @return [void|Symbol]
       def input(data)
         server.input(data)
 
       rescue DRb::DRbConnError
-        puts "Could not connect to DRb server."
+        drb_connection_error
 
       end
       alias_method :read, :input
 
       # Fetch output from the DRb server.
       #
-      # @return [void]
+      # @return [void|Symbol]
       def output
         server.output
 
       rescue DRb::DRbConnError
-        puts "Could not connect to DRb server."
+        drb_connection_error
 
       end
       alias_method :write, :output
@@ -70,17 +72,20 @@ module Vedeu
       #   {Vedeu::Application} will raise StopIteration when its `.stop` method
       #   is called. Here we rescue that to give a clean client exit.
       #
-      # @return [void]
+      # @return [void|Symbol]
       def shutdown
         server.shutdown
 
         Process.kill("KILL", server.pid)
 
       rescue DRb::DRbConnError
-        puts "Could not connect to DRb server."
+        drb_connection_error
 
       rescue Interrupt
-        puts "Client application exited."
+        puts 'Client application exited.'
+
+      ensure
+        :shutdown
 
       end
 
@@ -93,6 +98,13 @@ module Vedeu
         @server ||= DRbObject.new_with_uri(uri)
       end
 
+      # @return [Symbol]
+      def drb_connection_error
+        puts 'Could not connect to DRb server.'
+
+        :drb_connection_error
+      end
+
     end # Client
 
   end # Distributed

data/lib/vedeu/distributed/server.rb

@@ -69,6 +69,8 @@ module Vedeu
 
       # @return [void]
       def restart
+        Vedeu.log(type: :drb, message: 'Attempting to restart')
+
         return not_enabled unless drb?
 
         log('Not running') unless drb_running?
@@ -100,6 +102,8 @@ module Vedeu
 
       # @return [Vedeu::Distributed::Server]
       def start
+        Vedeu.log(type: :drb, message: 'Attempting to start')
+
         return not_enabled unless drb?
 
         if drb_running?
@@ -116,6 +120,8 @@ module Vedeu
 
       # @return [Symbol]
       def status
+        Vedeu.log(type: :drb, message: 'Fetching status')
+
         return not_enabled unless drb?
 
         if drb_running?
@@ -133,6 +139,8 @@ module Vedeu
 
       # @return [void]
       def stop
+        Vedeu.log(type: :drb, message: 'Attempting to stop')
+
         return not_enabled unless drb?
 
         if drb_running?

data/lib/vedeu/distributed/subprocess.rb

@@ -1,29 +1,5 @@
-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

data/lib/vedeu/distributed/uri.rb

@@ -22,14 +22,7 @@ module Vedeu
       #
       # @return [String] The host and port as a single value.
       def to_s
-        [scheme, host, ':', port].join
-      end
-
-      private
-
-      # @return [String]
-      def scheme
-        'druby://'
+        ['druby://', host, ':', port].join
       end
 
     end # Uri

data/lib/vedeu/dsl/all.rb

@@ -2,6 +2,7 @@ require 'vedeu/dsl/components/all'
 require 'vedeu/dsl/shared/all'
 
 require 'vedeu/dsl/composition'
+require 'vedeu/dsl/group'
 require 'vedeu/dsl/interface'
 require 'vedeu/dsl/line'
 require 'vedeu/dsl/stream'
@@ -13,6 +14,8 @@ module Vedeu
   #
   module DSL
 
+    private
+
     # Attempts to find the missing method on the client object.
     #
     # @param method [Symbol] The name of the method sought.

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

@@ -1,7 +1,7 @@
-require 'vedeu/dsl/components/border'
-require 'vedeu/dsl/components/geometry'
-require 'vedeu/dsl/components/keymap'
-require 'vedeu/dsl/components/menu'
+require_relative 'border'
+require_relative 'geometry'
+require_relative 'keymap'
+require_relative 'menu'
 
 module Vedeu
 end # Vedeu

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

@@ -32,6 +32,8 @@ module Vedeu
       # Returns an instance of DSL::Geometry.
       #
       # @param model [Geometry]
+      # @param client [Object]
+      # @return [Vedeu::DSL::Geometry]
       def initialize(model, client = nil)
         @model  = model
         @client = client

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

@@ -25,15 +25,26 @@ module Vedeu
       #
       #   Vedeu.interface 'my_interface' do
       #     keymap do
-      #       ...
+      #       # ...
       #
       # @param name [String] The name of the interface which this keymap relates
       #   to.
       # @param block [Proc]
       #
       # @example
-      #   keymap 'my_interface' do
-      #     ...
+      #   Vedeu.keymap 'my_interface' do
+      #     # ...
+      #
+      #   Vedeu.keys 'my_interface' do
+      #     # ...
+      #
+      #   Vedeu.interface 'my_interface' do
+      #     keymap do
+      #       # ...
+      #
+      #   Vedeu.interface 'my_interface' do
+      #     keys do
+      #       # ...
       #
       # @raise [InvalidSyntax] The required block was not given.
       # @return [Keymap]

data/lib/vedeu/dsl/group.rb

@@ -0,0 +1,69 @@
+require 'vedeu/models/group'
+
+module Vedeu
+
+  module DSL
+
+    # DSL for adding interfaces to a group.
+    #
+    class Group
+
+      include Vedeu::DSL
+
+      # Specify a new group of interfaces with a simple DSL.
+      #
+      # The example below resembles 'vim' (the popular terminal-based text
+      # editor):
+      #
+      # @example
+      #   Vedeu.group 'title_screen' do
+      #     add 'welcome_interface'
+      #     # ...
+      #
+      #   Vedeu.group 'main_screen' do
+      #     add 'editor_interface'
+      #     add 'status_interface'
+      #     add 'command_interface'
+      #     # ...
+      #
+      # @note
+      #   Creating a group with the same name as an existing group overwrites
+      #   the existing group.
+      #
+      # @param name [String] The name of this group.
+      # @param block [Proc]
+      # @raise [InvalidSyntax] The required block was not given.
+      # @return [Vedeu::Group]
+      def self.group(name, &block)
+        fail InvalidSyntax, 'block not given' unless block_given?
+
+        Vedeu::Group.build({ name: name }, &block).store
+      end
+
+      # Returns an instance of DSL::Group.
+      #
+      # @param model [Group]
+      # @param client [Object]
+      # @return [Vedeu::DSL::Group]
+      def initialize(model, client = nil)
+        @model  = model
+        @client = client
+      end
+
+      # Add the named interface to this group.
+      #
+      # @param interface_name [String]
+      # @return [void]
+      def add(interface_name)
+        model.add(interface_name)
+      end
+
+      private
+
+      attr_reader :client, :model
+
+    end # Group
+
+  end # DSL
+
+end # Vedeu

data/lib/vedeu/dsl/interface.rb

@@ -135,28 +135,29 @@ module Vedeu
       # targetted together; for example you may want to refresh multiple
       # interfaces at once.
       #
-      # @param value [String] The name for the group of interfaces.
-      #
       # @example
       #   interface 'my_interface' do
       #     group 'main_screen'
       #     # ...
       #
+      # @param name [String] The name of the group to which this interface
+      #   should belong.
       # @return [String]
-      def group(value)
-        return false unless defined_value?(value)
+      def group(name)
+        return false unless defined_value?(name)
 
         if defined_value?(model.name)
-          if Vedeu.groups.registered?(value)
-            Vedeu.groups.find(value).add(model.name)
+          if Vedeu.groups.registered?(name)
+            Vedeu.groups.find(name).add(model.name)
 
           else
-            Vedeu::Group.new(value, model.name).store
+            new_group = Vedeu::Group.new({ name: name })
+            new_group.add(model.name)
 
           end
         end
 
-        model.group = value
+        model.group = name
       end
 
       # @see Vedeu::DSL::Keymap.keymap

data/lib/vedeu/dsl/shared/text.rb

@@ -1,4 +1,6 @@
-require 'vedeu/support/text'
+require 'vedeu/output/text'
+require 'vedeu/models/view/line'
+require 'vedeu/models/view/stream'
 
 module Vedeu
 

data/lib/vedeu/events/event.rb

@@ -41,8 +41,8 @@ module Vedeu
       # Register an event by name with optional delay (throttling) which when
       # triggered will execute the code contained within the passed block.
       #
-      # @param name  [Symbol] The name of the event which will be triggered later.
-      # @param [Hash] options The options to register the event with.
+      # @param name [Symbol] The name of the event which will be triggered later.
+      # @param options [Hash] The options to register the event with.
       # @option options :delay [Fixnum|Float] Limits the execution of the
       #   triggered event to only execute when first triggered, with subsequent
       #   triggering being ignored until the delay has expired.

data/lib/vedeu/input/keymap.rb

@@ -1,6 +1,6 @@
 require 'vedeu/exceptions'
 require 'vedeu/models/model'
-require 'vedeu/dsl/components/keymap'
+require 'vedeu/dsl/components/all'
 
 module Vedeu
 

data/lib/vedeu/models/geometry.rb

@@ -1,4 +1,4 @@
-require 'vedeu/dsl/components/geometry'
+require 'vedeu/dsl/components/all'
 require 'vedeu/models/model'
 
 require 'vedeu/geometry/limit'

data/lib/vedeu/models/group.rb

@@ -7,17 +7,23 @@ module Vedeu
 
     include Vedeu::Model
 
-    attr_reader :name
+    attr_accessor :name
 
     # Return a new instance of Group.
     #
-    # @param name [String] The name of the group.
-    # @param members [Array]
+    # @param attributes [Hash]
+    # @option attributes members [Array] A collection of names of interfaces
+    #   belonging to this group.
+    # @option attributes name [String] The name of the group.
+    # @option attributes repository [Vedeu::Repository] The storage for all
+    #   Group models.
     # @return [Group]
-    def initialize(name, members = [])
-      @name       = name
-      @members    = Array(members)
-      @repository = Vedeu.groups
+    def initialize(attributes = {})
+      @attributes = defaults.merge!(attributes)
+
+      @members    = Array(@attributes[:members])
+      @name       = @attributes[:name]
+      @repository = @attributes[:repository]
     end
 
     # Add a member to the group by name.
@@ -25,7 +31,7 @@ module Vedeu
     # @param member [String]
     # @return [Group]
     def add(member)
-      Group.new(name, members.add(member)).store
+      Group.new({ name: name, members: members.add(member) }).store
     end
 
     # Return the members as a Set.
@@ -40,18 +46,26 @@ module Vedeu
     # @param member [String]
     # @return [Group]
     def remove(member)
-      Group.new(name, members.delete(member)).store
+      Group.new({ name: name, members: members.delete(member) }).store
     end
 
     # Remove all members from the group.
     #
     # @return [Group]
     def reset
-      Group.new(name).store
+      Group.new(defaults.merge!({ name: name })).store
     end
 
     private
 
+    def defaults
+      {
+        members:    [],
+        name:       '',
+        repository: Vedeu.groups,
+      }
+    end
+
   end # Group
 
 end # Vedeu