vedeu 0.2.9 → 0.2.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fd5bd7cd569896aed34eadea8a2bb15312c99d4a
-  data.tar.gz: ea45bf2468c2ce0d22250da6f2b903ada4ed5028
+  metadata.gz: bff39cd80bb0bca7448d6cf083f2115665e55054
+  data.tar.gz: 93bc4d77d71b14632868a4389f150c7a48b15e31
 SHA512:
-  metadata.gz: 796459529347814e7644f0d9c4903c74dd197c93c548f50b06eb2c8fe5fc13c783f93bb8a09e02de6668da7b739310ee0f428521c2a5bf68eb5addc0f3cb32b9
-  data.tar.gz: 18c57141d04b4a2f2034ebdbe0384ba05d29a2f6e3ccf64166192c999b55ca6123264da5cfaabd26d3a22d8aee28e5d6f20309caa56131a13270b00bf00639d0
+  metadata.gz: 8c51486199b28763e4fee45eb2dcf7404bc4cd35c308237ad475dbd051d2ddbe826b8d3201e2abe5716eb24149cb14ffcde30512f0732c89e4c10d604d49146b
+  data.tar.gz: 1b4d18498d51ed6653501b017ecefd09e42daaaffd797c3e5a6f66ee204784938de563df224700624ffd22a786396c81c65e62c27365680f77eadec734383e2b

data/LICENSE.txt

@@ -1,7 +1,4 @@
 Copyright (c) 2014 Gavin Laking
-Copyright (c) 2013 Steve Klabnik - Monologger
-                   (https://github.com/steveklabnik/mono_logger)
-                   Note: Code used inline in Vedeu::Log.
 Copyright (c) 2013 Michael Grosser - Ruco
                    (https://github.com/grosser/ruco)
                    Note: Code from ruco's Window class was used as basis of

data/examples/configuration_app.rb

@@ -0,0 +1,50 @@
+#!/usr/bin/env ruby
+
+lib_dir = File.dirname(__FILE__) + '/../lib'
+$LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
+
+-> { its -> { a } }
+trap('INT') { exit! }
+
+require 'vedeu'
+
+# This example application shows how configuration works.
+#
+# First, we use the configuration API to switch debugging on, and set the
+# logging to go to a file in the /tmp directory.
+#
+# By passing the arguments: --log /path/to/log_file.log when executing this
+# example, we can demonstrate that the client application configuration is
+# overridden by command line arguments.
+#
+# Use 'space' to refresh, 'q' to exit.
+class VedeuConfigurationApp
+  include Vedeu
+
+  configure do
+    debug!
+    log '/tmp/vedeu_configuration_app.log'
+  end
+
+  interface 'config' do
+    width 40
+    height 2
+    centred!
+  end
+
+  render do
+    view 'config' do
+      line Configuration.log.inspect + " " + Process.pid.to_s
+    end
+  end
+
+  keys('config') do
+    key(' ') { Vedeu.trigger(:_refresh_config_) }
+  end
+
+  def self.start(argv = ARGV)
+    Vedeu::Launcher.new(argv).execute!
+  end
+end
+
+VedeuConfigurationApp.start(ARGV)

data/examples/cursor_app/cursor_app.rb

@@ -104,9 +104,14 @@ class VedeuCursorApp
 
   focus('iron') # not working right?!
 
-  def self.start
-    Vedeu::Launcher.new(['--debug']).execute!
+  Vedeu.configure do
+    debug!
+    log '/tmp/vedeu_cursor_app.log'
+  end
+
+  def self.start(argv = ARGV)
+    Vedeu::Launcher.new(argv).execute!
   end
 end
 
-VedeuCursorApp.start
+VedeuCursorApp.start(ARGV)

data/examples/focus_app.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-lib_dir = File.dirname(__FILE__) + '/../../lib'
+lib_dir = File.dirname(__FILE__) + '/../lib'
 $LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
 
 -> { its -> { a } }
@@ -15,7 +15,7 @@ require 'vedeu'
 #
 # The focus order is: copper, aluminium, boron, dubnium, status.
 #
-# Use 'space' to change focus.
+# Use 'space' to change focus, 'q' to exit.
 class VedeuFocusApp
   include Vedeu
 
@@ -84,9 +84,9 @@ class VedeuFocusApp
     end
   end
 
-  def self.start
-    Vedeu::Launcher.new(['--debug']).execute!
+  def self.start(argv = ARGV)
+    Vedeu::Launcher.new(argv).execute!
   end
 end
 
-VedeuFocusApp.start
+VedeuFocusApp.start(ARGV)

data/examples/hello_world.rb

@@ -13,7 +13,7 @@ class HelloWorldApp
 
   configure do
     debug!
-    log '/tmp/hello_world_vedeu.log'
+    log '/tmp/vedeu_hello_world.log'
   end
 
   event(:_initialize_) { Vedeu.trigger(:_refresh_) }
@@ -34,9 +34,9 @@ class HelloWorldApp
     end
   end
 
-  def self.start
-    Vedeu::Launcher.execute!(ARGV)
+  def self.start(argv = ARGV)
+    Vedeu::Launcher.new(argv).execute!
   end
 end
 
-HelloWorldApp.start
+HelloWorldApp.start(ARGV)

data/examples/lines_app/lines_app.rb

@@ -52,9 +52,14 @@ class VedeuLinesApp
 
   focus 'ruthenium'
 
-  def self.start
-    Vedeu::Launcher.new(['--debug']).execute!
+  Vedeu.configure do
+    debug!
+    log '/tmp/vedeu_lines_app.log'
+  end
+
+  def self.start(argv = ARGV)
+    Vedeu::Launcher.new(argv).execute!
   end
 end
 
-VedeuLinesApp.start
+VedeuLinesApp.start(ARGV)

data/lib/vedeu.rb

@@ -26,6 +26,8 @@ require 'io/console'
 require 'logger'
 require 'optparse'
 require 'set'
+require 'singleton'
+require 'time'
 
 require 'vedeu/support/exceptions'
 require 'vedeu/support/common'

data/lib/vedeu/api/api.rb

@@ -133,11 +133,11 @@ module Vedeu
       Vedeu::Keymaps.use(key)
     end
 
-    # Write a message to the Vedeu log file located at `$HOME/.vedeu/vedeu.log`
+    # Write a message to the Vedeu log file.
     #
     # @param message [String] The message you wish to emit to the log
     #   file, useful for debugging.
-    # @param force   [Boolean] When evaluates to true will
+    # @param force   [Boolean] When evaluates to true will attempt to
     #   write to the log file regardless of the Configuration setting.
     #
     # @example

data/lib/vedeu/application.rb

@@ -28,7 +28,7 @@ module Vedeu
         fail StopIteration
       end
 
-    end # self
+    end # Application eigenclass
 
     # @return [Application]
     def initialize; end

data/lib/vedeu/configuration/api.rb

@@ -1,6 +1,6 @@
 module Vedeu
 
-  module Configuration
+  module Config
 
     # The Configuration::API class parses client application configuration into
     # options used by Vedeu to affect certain behaviours.
@@ -36,8 +36,10 @@ module Vedeu
       #
       # @return [Hash]
       def configuration
-        if system_key_options.any?
-          options.merge({ system_keys: system_key_options })
+        if system_keys.any?
+          options.merge({
+            system_keys: Configuration.default_system_keys.merge(system_keys)
+          })
 
         else
           options
@@ -206,6 +208,19 @@ module Vedeu
         options[:colour_mode] = value
       end
 
+      # Sets the location of the log file.
+      #
+      # @example
+      #   Vedeu.configure do
+      #     log '/var/log/vedeu.log'
+      #     ...
+      #
+      # @param filename [String]
+      # @return [String]
+      def log(filename = '')
+        options[:log] = filename
+      end
+
       # Sets the key used to exit the client application. The default is `q`.
       #
       # @example
@@ -224,7 +239,7 @@ module Vedeu
 
         Vedeu.log("Configuration::API exit_key: #{value}")
 
-        system_key_options[:exit] = value
+        system_keys[:exit] = value
       end
 
       # Sets the key used to switch focus to the next defined interface. The
@@ -246,7 +261,7 @@ module Vedeu
 
         Vedeu.log("Configuration::API focus_next: #{value}")
 
-        system_key_options[:focus_next] = value
+        system_keys[:focus_next] = value
       end
 
       # Sets the key used to switch focus to the previous interface. The default
@@ -268,7 +283,7 @@ module Vedeu
 
         Vedeu.log("Configuration::API focus_prev: #{value}")
 
-        system_key_options[:focus_prev] = value
+        system_keys[:focus_prev] = value
       end
 
       # Sets the key used to switch between raw and cooked mode in Vedeu. The
@@ -290,7 +305,7 @@ module Vedeu
 
         Vedeu.log("Configuration::API mode_switch: #{value}")
 
-        system_key_options[:mode_switch] = value
+        system_keys[:mode_switch] = value
       end
 
       private
@@ -307,8 +322,8 @@ module Vedeu
       # hash if none were redefined.
       #
       # @return [Hash]
-      def system_key_options
-        @_system_key_options ||= Configuration.default_system_keys
+      def system_keys
+        @_system_keys ||= {}
       end
 
       # Checks that the value provided to {#colour_mode} is valid.

data/lib/vedeu/configuration/cli.rb

@@ -1,6 +1,6 @@
 module Vedeu
 
-  module Configuration
+  module Config
 
     # The Configuration::CLI class parses command-line arguments using
     # OptionParser into options used by Vedeu to affect certain behaviours.
@@ -15,7 +15,7 @@ module Vedeu
       # @param args [Array]
       # @return [Hash]
       def self.configure(args = [])
-        new(args = []).configuration
+        new(args).configuration
       end
 
       # Returns an instance of Configuration::CLI.
@@ -23,7 +23,8 @@ module Vedeu
       # @param args [Array]
       # @return [Configuration::CLI]
       def initialize(args = [])
-        @args = args
+        @args    = args
+        @options = {}
       end
 
       # Returns the configuration options set up by parsing the command-line
@@ -104,7 +105,15 @@ module Vedeu
 
             end
           end
+
+          opts.on('-l', '--log [FILENAME]', String,
+                  'Specify the path for the log file.') do |filename|
+            Vedeu.log("Configuration::CLI log: #{filename}")
+
+            options[:log] = filename
+          end
         end
+
         parser.parse!(args)
 
         options
@@ -112,15 +121,7 @@ module Vedeu
 
       private
 
-      attr_reader :args
-
-      # Returns the options set via command-line arguments parsed by
-      # OptionParser, or an empty Hash if none were set or parsed.
-      #
-      # @return [Hash]
-      def options
-        @_options ||= {}
-      end
+      attr_reader :args, :options
 
     end # CLI
 

data/lib/vedeu/configuration/configuration.rb

@@ -2,121 +2,160 @@ module Vedeu
 
   # 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.
   #
   # @api private
-  module Configuration
+  class Configuration
+
+    include Singleton
+
+    class << self
+
+      # Configure Vedeu with sensible defaults. If the client application sets
+      # options, override the defaults with those, and if command-line arguments
+      # are provided at application invocation, override any options with the
+      # arguments provided.
+      #
+      # @param args [Array]
+      # @param block [Proc]
+      # @return [Hash]
+      def configure(args = [], &block)
+        instance.configure(args, &block)
+      end
 
-    extend self
+      # Returns the chosen colour mode.
+      #
+      # @return [Fixnum]
+      def colour_mode
+        instance.options[:colour_mode]
+      end
 
-    # Configure Vedeu with sensible defaults. If the client application sets
-    # options, override the defaults with those, and if command-line arguments
-    # are provided at application invocation, override any options with the
-    # arguments provided.
-    #
-    # @param args [Array]
-    # @param block [Proc]
-    # @return [Hash]
-    def configure(args = [], &block)
-      options.merge!(API.configure(&block)) if block_given?
+      # 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?
+        instance.options[:debug]
+      end
+      alias_method :debug, :debug?
+
+      # 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?
+        instance.options[:interactive]
+      end
+      alias_method :interactive, :interactive?
 
-      options.merge!(CLI.configure(args)) if args.any?
+      # Returns the path to the log file.
+      #
+      # @return [String]
+      def log
+        instance.options[:log]
+      end
 
-      options
-    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.
+      #
+      # @return [Boolean]
+      def once?
+        instance.options[:once]
+      end
+      alias_method :once, :once?
 
-    # Returns the chosen colour mode.
-    #
-    # @return [Fixnum]
-    def colour_mode
-      options[:colour_mode]
-    end
+      # Returns
+      #
+      # @return [Hash]
+      def system_keys
+        instance.options[:system_keys]
+      end
 
-    # 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?
-      options[:debug]
-    end
-    alias_method :debug, :debug?
+      # Returns the terminal mode for the application. Default is `:raw`.
+      #
+      # @return [Symbol]
+      def terminal_mode
+        instance.options[:terminal_mode]
+      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.
-    #
-    # @return [Boolean]
-    def interactive?
-      options[:interactive]
-    end
-    alias_method :interactive, :interactive?
+      # Returns whether tracing is enabled or disabled. Tracing is very noisy in
+      # the log file (logging method calls and events trigger). Default is
+      # false; meaning tracing is disabled.
+      #
+      # @return [Boolean]
+      def trace?
+        instance.options[:trace]
+      end
+      alias_method :trace, :trace?
+
+      # Vedeu's default system keys. Use {#system_keys}.
+      #
+      # @return [Hash]
+      def default_system_keys
+        {
+          exit:        'q',
+          focus_next:  :tab,
+          focus_prev:  :shift_tab,
+          mode_switch: :escape,
+        }
+      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.
-    #
-    # @return [Boolean]
-    def once?
-      options[:once]
-    end
-    alias_method :once, :once?
+      def options=(value)
+        instance.options = value
+      end
 
-    # Returns
-    #
-    # @return [Hash]
-    def system_keys
-      options[:system_keys]
-    end
+      # Reset the configuration to the default values.
+      #
+      # @return [Hash]
+      def reset!
+        # Vedeu::Log.logger.debug('Resetting configuration.')
 
-    # Returns the terminal mode for the application. Default is `:raw`.
-    #
-    # @return [Symbol]
-    def terminal_mode
-      options[:terminal_mode]
-    end
+        instance.reset!
+      end
 
-    # Returns whether tracing is enabled or disabled. Tracing is very noisy in
-    # the log file (logging method calls and events trigger). Default is false;
-    # meaning tracing is disabled.
-    #
-    # @return [Boolean]
-    def trace?
-      options[:trace]
-    end
-    alias_method :trace, :trace?
+    end # Configuration eigenclass
+
+    attr_reader :options
 
-    # Resets all options to Vedeu defaults.
+    # Create a new singleton instance of Configuration.
     #
-    # @return [Hash]
-    def reset
+    # @return [Configuration]
+    def initialize
       @options = defaults
     end
 
-    # Vedeu's default system keys. Use {#system_keys}.
+    # 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]
     # @return [Hash]
-    def default_system_keys
-      {
-        exit:        'q',
-        focus_next:  :tab,
-        focus_prev:  :shift_tab,
-        mode_switch: :escape,
-      }
-    end
+    def configure(args = [], &block)
+      @options.merge!(Config::API.configure(&block)) if block_given?
 
-    private
+      @options.merge!(Config::CLI.configure(args)) if args.any?
 
-    # Returns all the options current configured.
+      @options
+    end
+
+    # Reset the configuration to the default values.
     #
     # @return [Hash]
-    def options
-      @options ||= defaults
+    def reset!
+      # Vedeu::Log.logger.debug('Resetting configuration.')
+
+      @options = defaults
     end
 
+    private
+
     # The Vedeu default options, which of course are influenced by environment
     # variables also.
     #
@@ -124,64 +163,29 @@ module Vedeu
     def defaults
       {
         colour_mode:   detect_colour_mode,
-        debug:         detect_debug_mode,
+        debug:         false,
         interactive:   true,
+        log:           '/tmp/vedeu.log',
         once:          false,
-        system_keys:   default_system_keys,
+        system_keys:   Configuration.default_system_keys,
         terminal_mode: :raw,
-        trace:         detect_trace_mode,
+        trace:         false,
       }
     end
 
-    # Attempt to determine the terminal colour mode via environment variables,
-    # 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
-      return 16777216 if ENV['VEDEU_TESTMODE']
-
-      if ENV['VEDEU_TERM']
-        case ENV['VEDEU_TERM']
-        when /-256color$/  then 256
-        when /-truecolor$/ then 16777216
-        else 256
-        end
-
-      elsif ENV['TERM']
-        case ENV['TERM']
-        when /-256color$/, 'xterm' then 256
-        when /-color$/, 'rxvt'     then 16
-        else 256
-        end
-
-      else
-        256
-
+      case ENV['TERM']
+      when /-truecolor$/         then 16777216
+      when /-256color$/, 'xterm' then 256
+      when /-color$/, 'rxvt'     then 16
+      else 256
       end
     end
 
-    # Determine the debug mode via an environment variable.
-    #
-    # @return [Boolean]
-    def detect_debug_mode
-      return false if ENV['VEDEU_TESTMODE']
-
-      return true if ENV['VEDEU_DEBUG']
-
-      false
-    end
-
-    # Determine the trace mode via an environment variable.
-    #
-    # @return [Boolean]
-    def detect_trace_mode
-      return false if ENV['VEDEU_TESTMODE']
-
-      return true if ENV['VEDEU_TRACE']
-
-      false
-    end
-
   end # Configuration
 
 end # Vedeu