vedeu 0.6.8 → 0.6.9

data/lib/vedeu/configuration/configuration.rb

@@ -8,7 +8,8 @@ module Vedeu
 
     # Custom log for configuration.
     #
-    # @param from [String] Which configuration set the options ('API' or 'CLI').
+    # @param from [String] Which configuration set the options
+    #   ('API' or 'CLI').
     # @param options [Hash] The configuration options set.
     # @return [Hash] The options param.
     def log(from, options)
@@ -20,13 +21,13 @@ module Vedeu
 
   end
 
-  # Allows the customisation of Vedeu's behaviour through the configuration API
-  # or command-line arguments.
+  # Allows the customisation of Vedeu's behaviour through the
+  # configuration API or command-line arguments.
   #
-  # Provides access to Vedeu's configuration, which was set with sensible
-  # defaults (influenced by environment variables), overridden by client
-  # application settings (via the configuration API), or any command-line
-  # arguments provided.
+  # Provides access to Vedeu's configuration, which was set with
+  # sensible defaults (influenced by environment variables),
+  # overridden by client application settings (via the configuration
+  # API), or any command-line arguments provided.
   #
   class Configuration
 
@@ -49,10 +50,10 @@ module Vedeu
       end
       alias_method :compression?, :compression
 
-      # Provides the mechanism to configure Vedeu. If the client application
-      # sets options, override the defaults with those, and when command-line
-      # arguments are provided at application invocation, override any options
-      # with the arguments provided.
+      # Provides the mechanism to configure Vedeu. If the client
+      # application sets options, override the defaults with those,
+      # and when command-line arguments are provided at application
+      # invocation, override any options with the arguments provided.
       #
       # @example
       #   Vedeu.configure do
@@ -73,7 +74,8 @@ module Vedeu
       end
 
       # Returns the configuration singleton.
-      # Append configuration methods to access the configuration variable.
+      # Append configuration methods to access the configuration
+      # variable.
       #
       # @example
       #   Vedeu.configuration
@@ -90,8 +92,9 @@ module Vedeu
         instance.options[:colour_mode]
       end
 
-      # Returns whether debugging is enabled or disabled. Default is false;
-      # meaning nothing apart from warnings are written to the log file.
+      # Returns whether debugging is enabled or disabled. Default is
+      # false; meaning nothing apart from warnings are written to the
+      # log file.
       #
       # @return [Boolean]
       def debug?
@@ -99,7 +102,8 @@ module Vedeu
       end
       alias_method :debug, :debug?
 
-      # Returns whether the DRb server is enabled or disabled. Default is false.
+      # Returns whether the DRb server is enabled or disabled. Default
+      # is false.
       #
       # @return [Boolean]
       def drb?
@@ -135,9 +139,10 @@ module Vedeu
         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.
+      # 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.
       #
       # @return [Boolean]
       def interactive?
@@ -152,7 +157,8 @@ module Vedeu
         instance.options[:log]
       end
 
-      # Returns a boolean indicating whether the log has been configured.
+      # Returns a boolean indicating whether the log has been
+      # configured.
       #
       # @return [Boolean]
       def log?
@@ -164,9 +170,9 @@ module Vedeu
         instance.options[:log_only] || []
       end
 
-      # Returns whether the application will run through its main loop once or
-      # not. Default is false; meaning the application will loop forever or
-      # until terminated by the user.
+      # Returns whether the application will run through its main loop
+      # once or not. Default is false; meaning the application will
+      # loop forever or until terminated by the user.
       #
       # @return [Boolean]
       def once?
@@ -181,8 +187,8 @@ module Vedeu
         instance.options[:renderers]
       end
 
-      # Returns the root of the client application. Vedeu will execute this
-      # controller first.
+      # Returns the root of the client application. Vedeu will execute
+      # this controller first.
       #
       # @return [Class]
       def root
@@ -210,7 +216,8 @@ module Vedeu
         instance.options[:stderr]
       end
 
-      # Returns the terminal mode for the application. Default is `:raw`.
+      # Returns the terminal mode for the application. Default is
+      # `:raw`.
       #
       # @return [Symbol]
       def terminal_mode
@@ -243,9 +250,10 @@ module Vedeu
       @options = defaults
     end
 
-    # Set up default configuration and then allow the client application to
-    # modify it via the configuration API. After this, process any command line
-    # arguments as potential configuration and apply that.
+    # Set up default configuration and then allow the client
+    # application to modify it via the configuration API. After this,
+    # process any command line arguments as potential configuration
+    # and apply that.
     #
     # @param args [Array]
     # @param block [Proc]
@@ -270,8 +278,8 @@ module Vedeu
 
     private
 
-    # The Vedeu default options, which of course are influenced by environment
-    # variables also.
+    # The Vedeu default options, which of course are influenced by
+    # environment variables also.
     #
     # @return [Hash<Symbol => void>]
     def defaults
@@ -298,8 +306,9 @@ module Vedeu
       }
     end
 
-    # Attempt to determine the terminal colour mode via $TERM environment
-    # variable, or be optimistic and settle for 256 colours.
+    # Attempt to determine the terminal colour mode via $TERM
+    # environment variable, or be optimistic and settle for 256
+    # colours.
     #
     # @return [Fixnum]
     def detect_colour_mode

data/lib/vedeu/cursors/cursor.rb

@@ -138,7 +138,7 @@ module Vedeu
       #
       # @return [Array<Vedeu::Models::Escape>]
       def render
-        Vedeu::Output.render(visibility)
+        Vedeu::Output::Output.render(visibility)
       end
 
       # Arbitrarily move the cursor to a given position.

data/lib/vedeu/cursors/refresh.rb

@@ -2,8 +2,9 @@ module Vedeu
 
   module Cursors
 
-    # Handle the refreshing (redrawing) of a cursor, without redrawing the whole
-    # interface; unless the cursor's offset has caused the view to change.
+    # Handle the refreshing (redrawing) of a cursor, without redrawing
+    # the whole interface; unless the cursor's offset has caused the
+    # view to change.
     #
     class Refresh
 
@@ -14,7 +15,7 @@ module Vedeu
                      :width
 
       # @param (see #initialize)
-      def self.by_name(name = Vedeu.focus)
+      def self.by_name(name = nil)
         new(name).by_name
       end
 
@@ -22,13 +23,14 @@ module Vedeu
       #
       # @param name [String] The name of the cursor.
       # @return [Vedeu::Cursors::Refresh]
-      def initialize(name)
-        @name = name
+      def initialize(name = nil)
+        @name = name || Vedeu.focus
       end
 
-      # Renders the cursor in the terminal. If the cursor's x or y offsets are
-      # greater or equal to the interface's width or height respectively, then
-      # the view is also refreshed, causing the content to be offset also.
+      # Renders the cursor in the terminal. If the cursor's x or y
+      # offsets are greater or equal to the interface's width or
+      # height respectively, then the view is also refreshed, causing
+      # the content to be offset also.
       #
       # @return [Array]
       def by_name
@@ -47,9 +49,9 @@ module Vedeu
 
       private
 
-      # Returns true when the view should be refreshed. This is determined by
-      # checking that the offsets for x and y are outside the width and height
-      # of the named interface.
+      # Returns true when the view should be refreshed. This is
+      # determined by checking that the offsets for x and y are
+      # outside the width and height of the named interface.
       #
       # @return [Boolean]
       def refresh_view?
@@ -65,11 +67,13 @@ module Vedeu
       # Fetch the border by name.
       #
       # @note
-      #   Vedeu::Borders::Border is used in this way because when there is not a
-      #   border defined, it will fallback to a Vedeu::Borders::Null which uses
-      #   Vedeu::Geometry::Geometry to determine it's dimensions based on the
-      #   name also. When a Vedeu::Geometry::Geometry cannot be found, this
-      #   falls back to a Vedeu::Geometry::Null which uses the dimensions of the
+      #   {Vedeu::Borders::Border} is used in this way because when
+      #   there is not a border defined, it will fallback to a
+      #   {Vedeu::Borders::Null} which uses
+      #   {Vedeu::Geometry::Geometry} to determine it's dimensions
+      #   based on the name also. When a {Vedeu::Geometry::Geometry}
+      #   cannot be found, this falls back to a
+      #   {Vedeu::Geometry::Null} which uses the dimensions of the
       #   current terminal.
       #
       # @return (see Vedeu::Borders::Repository#by_name)

data/lib/vedeu/distributed/server.rb

@@ -1,10 +1,12 @@
 module Vedeu
 
-  # Provides a mechanism to control a running client application via DRb.
+  # Provides a mechanism to control a running client application via
+  # DRb.
   #
   module Distributed
 
-    # A class for the server side of the DRb server/client relationship.
+    # A class for the server side of the DRb server/client
+    # relationship.
     class Server
 
       $SAFE = 1 # disable `eval` and related calls on strings passed
@@ -106,12 +108,12 @@ module Vedeu
         end
       end
 
-      # When called will stop the DRb server and attempt to terminate the client
-      # application.
+      # 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.
+      #   :_exit_ never gets triggered as when the DRb server goes
+      #   away, no further methods will be called.
       #
       # @return [void]
       def shutdown

data/lib/vedeu/distributed/subprocess.rb

@@ -1,96 +1,100 @@
 module Vedeu
 
-  # @example
-  #   Vedeu::TestApplication.build
-  #
-  class Subprocess
+  module Distributed
 
-    # @param (see #initialize)
-    def self.execute!(application)
-      new(application).execute!
-    end
-
-    # Returns a new instance of Vedeu::Subprocess.
+    # @example
+    #   Vedeu::TestApplication.build
     #
-    # @param application [Vedeu::TestApplication]
-    # @return [Vedeu::Subprocess]
-    def initialize(application)
-      @application = application
-      @pid         = nil
-    end
-
-    # :nocov:
-    # @return [Array]
-    def execute!
-      file_open && file_write && file_close
-
-      @pid = fork do
-        exec(file_path)
+    class Subprocess
+
+      # @param (see #initialize)
+      def self.execute!(application)
+        new(application).execute!
       end
 
-      Process.detach(@pid)
+      # Returns a new instance of Vedeu::Distributed::Subprocess.
+      #
+      # @param application [Vedeu::TestApplication]
+      # @return [Vedeu::Distributed::Subprocess]
+      def initialize(application)
+        @application = application
+        @pid         = nil
+      end
 
-      self
-    end
-    # :nocov:
+      # :nocov:
+      # @return [Array]
+      def execute!
+        file_open && file_write && file_close
 
-    # Sends the KILL signal to the process.
-    #
-    # @return [void]
-    def kill
-      Process.kill('KILL', pid)
-
-      file_unlink
-    end
-
-    protected
-
-    # @!attribute [r] application
-    # @return [Vedeu::TestApplication]
-    attr_reader :application
-
-    # @!attribute [r] pid
-    # @return [Fixnum]
-    attr_reader :pid
-
-    private
-
-    # @return [String]
-    def command
-      "ruby #{file_path}"
-    end
-
-    # @return [Fixnum] The number of bytes written.
-    def file_write
-      file.write(application)
-    end
-
-    # @return [NilClass]
-    def file_close
-      file.close
-    end
-
-    # @return [Fixnum] The number of files removed; 1.
-    def file_unlink
-      File.unlink("/tmp/foo_#{timestamp}")
-    end
-
-    # return [String]
-    def file_path
-      file.path
-    end
-
-    # @return [File]
-    def file_open
-      @file ||= File.new("/tmp/foo_#{timestamp}", 'w', 0755)
-    end
-    alias_method :file, :file_open
-
-    # return [Fixnum]
-    def timestamp
-      @timestamp ||= Time.now.to_i
-    end
-
-  end # Subprocess
+        @pid = fork do
+          exec(file_path)
+        end
+
+        Process.detach(@pid)
+
+        self
+      end
+      # :nocov:
+
+      # Sends the KILL signal to the process.
+      #
+      # @return [void]
+      def kill
+        Process.kill('KILL', pid)
+
+        file_unlink
+      end
+
+      protected
+
+      # @!attribute [r] application
+      # @return [Vedeu::TestApplication]
+      attr_reader :application
+
+      # @!attribute [r] pid
+      # @return [Fixnum]
+      attr_reader :pid
+
+      private
+
+      # @return [String]
+      def command
+        "ruby #{file_path}"
+      end
+
+      # @return [Fixnum] The number of bytes written.
+      def file_write
+        file.write(application)
+      end
+
+      # @return [NilClass]
+      def file_close
+        file.close
+      end
+
+      # @return [Fixnum] The number of files removed; 1.
+      def file_unlink
+        File.unlink("/tmp/foo_#{timestamp}")
+      end
+
+      # return [String]
+      def file_path
+        file.path
+      end
+
+      # @return [File]
+      def file_open
+        @file ||= File.new("/tmp/foo_#{timestamp}", 'w', 0755)
+      end
+      alias_method :file, :file_open
+
+      # return [Fixnum]
+      def timestamp
+        @timestamp ||= Time.now.to_i
+      end
+
+    end # Subprocess
+
+  end # Distributed
 
 end # Vedeu