vedeu 0.8.1 → 0.8.2

data/lib/vedeu/cells/borders/bottom_right.rb

@@ -21,7 +21,7 @@ module Vedeu
       # @return [Hash<Symbol => String>]
       def defaults
         super.merge!(position: Vedeu::Geometries::Position.coerce([yn, xn]),
-                     value:    Vedeu::EscapeSequences::Borders.bottom_right)
+                     value:    Vedeu.esc.bottom_right)
       end
 
     end # BottomRight

data/lib/vedeu/cells/borders/horizontal.rb

@@ -25,7 +25,7 @@ module Vedeu
 
       # @return [Hash<Symbol => String>]
       def defaults
-        super.merge!(value: Vedeu::EscapeSequences::Borders.horizontal)
+        super.merge!(value: Vedeu.esc.horizontal)
       end
 
     end # Horizontal

data/lib/vedeu/cells/borders/left_vertical.rb

@@ -20,7 +20,7 @@ module Vedeu
 
       # @return [Hash<Symbol => String>]
       def defaults
-        super.merge!(value: Vedeu::EscapeSequences::Borders.vertical)
+        super.merge!(value: Vedeu.esc.vertical)
       end
 
     end # LeftVertical

data/lib/vedeu/cells/borders/right_vertical.rb

@@ -20,7 +20,7 @@ module Vedeu
 
       # @return [Hash<Symbol => String>]
       def defaults
-        super.merge!(value: Vedeu::EscapeSequences::Borders.vertical)
+        super.merge!(value: Vedeu.esc.vertical)
       end
 
     end # RightVertical

data/lib/vedeu/cells/borders/top_horizontal.rb

@@ -20,7 +20,7 @@ module Vedeu
 
       # @return [Hash<Symbol => String>]
       def defaults
-        super.merge!(value: Vedeu::EscapeSequences::Borders.horizontal)
+        super.merge!(value: Vedeu.esc.horizontal)
       end
 
     end # TopHorizontal

data/lib/vedeu/cells/borders/top_left.rb

@@ -21,7 +21,7 @@ module Vedeu
       # @return [Hash<Symbol => String>]
       def defaults
         super.merge!(position: Vedeu::Geometries::Position.coerce([y, x]),
-                     value:    Vedeu::EscapeSequences::Borders.top_left)
+                     value:    Vedeu.esc.top_left)
       end
 
     end # TopLeft

data/lib/vedeu/cells/borders/top_right.rb

@@ -21,7 +21,7 @@ module Vedeu
       # @return [Hash<Symbol => String>]
       def defaults
         super.merge!(position: Vedeu::Geometries::Position.coerce([y, xn]),
-                     value:    Vedeu::EscapeSequences::Borders.top_right)
+                     value:    Vedeu.esc.top_right)
       end
 
     end # TopRight

data/lib/vedeu/cells/borders/vertical.rb

@@ -25,7 +25,7 @@ module Vedeu
 
       # @return [Hash<Symbol => String>]
       def defaults
-        super.merge!(value: Vedeu::EscapeSequences::Borders.vertical)
+        super.merge!(value: Vedeu.esc.vertical)
       end
 
     end # Vertical

data/lib/vedeu/colours/background.rb

@@ -32,7 +32,7 @@ module Vedeu
       #
       # @return [String]
       def named_code
-        Vedeu::EscapeSequences::Esc.background_colour(colour)
+        Vedeu.esc.background_colour(colour)
       end
 
       # @return [Vedeu::Colours::Backgrounds]

data/lib/vedeu/colours/foreground.rb

@@ -32,7 +32,7 @@ module Vedeu
       #
       # @return [String]
       def named_code
-        Vedeu::EscapeSequences::Esc.foreground_colour(colour)
+        Vedeu.esc.foreground_colour(colour)
       end
 
       # @return [Vedeu::Colours::Foregrounds]

data/lib/vedeu/colours/translator.rb

@@ -155,14 +155,11 @@ module Vedeu
         if registered?(colour)
           retrieve(colour)
 
-        else
-          if Vedeu::Configuration.colour_mode == 16_777_216
-            register(colour, format(rgb_prefix, *css_to_rgb))
-
-          else
-            register(colour, numbered)
+        elsif Vedeu.config.colour_mode == 16_777_216
+          register(colour, format(rgb_prefix, *css_to_rgb))
 
-          end
+        else
+          register(colour, numbered)
 
         end
       end

data/lib/vedeu/colours/validator.rb

@@ -38,7 +38,7 @@ module Vedeu
       #
       # @return [Boolean]
       def named?
-        Vedeu::EscapeSequences::Esc.valid_name?(value)
+        Vedeu.esc.valid_name?(value)
       end
 
       # Returns a boolean indicated whether the colour is a valid

data/lib/vedeu/configuration/api.rb

@@ -36,7 +36,7 @@ module Vedeu
       # @return [Hash<Symbol => Boolean, Fixnum, String>]
       def configuration
         Vedeu::Config
-          .log(Vedeu::EscapeSequences::Esc.green { '[api]' }, options)
+          .log(Vedeu.esc.green { '[api]' }, options)
       end
 
       # Sets boolean to allow user input. The default behaviour of

data/lib/vedeu/configuration/configuration.rb

@@ -16,6 +16,8 @@ module Vedeu
 
     class << self
 
+      include Vedeu::Common
+
       # Return the configured background colour for the client
       # application.
       #
@@ -55,8 +57,9 @@ module Vedeu
       # {include:file:docs/dsl/by_method/configuration.md}
       # @return [Vedeu::Configuration]
       def configuration
-        instance
+        self
       end
+      alias_method :config, :configuration
 
       # @return [Hash]
       def colour
@@ -154,11 +157,11 @@ module Vedeu
       end
 
       # Returns a boolean indicating whether the log has been
-      # configured.
+      # configured; if {#log} contains a path, then this will be true.
       #
       # @return [Boolean]
       def log?
-        log != nil
+        present?(log)
       end
 
       # @return [Array<Symbol>]
@@ -178,8 +181,7 @@ module Vedeu
       # @param type [Symbol]
       # @return [Boolean]
       def loggable?(type)
-        Vedeu::Configuration.log_only.include?(type) ||
-        !Vedeu::Configuration.log_except.include?(type)
+        log_only.include?(type) || !log_except.include?(type)
       end
 
       # Returns whether mouse support was enabled or disabled.
@@ -350,10 +352,12 @@ module Vedeu
     # @return [Fixnum]
     def detect_colour_mode
       case ENV['TERM']
-      when /-truecolor$/         then 16_777_216
-      when /-256color$/, 'xterm' then 256
-      when /-color$/, 'rxvt'     then 16
-      else 256
+      when 'xterm-256color', 'screen-256color'
+        256
+      when 'xterm', 'screen', 'xterm-color', 'screen-color', 'rxvt'
+        16
+      else
+        256
       end
     end
 
@@ -364,14 +368,19 @@ module Vedeu
 
   end # Configuration
 
-  Vedeu::Configuration.configure({})
-
+  # @!method config
+  #   @see Vedeu::Configuration.config
   # @!method configure
   #   @see Vedeu::Configuration.configure
   # @!method configuration
   #   @see Vedeu::Configuration.configuration
   def_delegators Vedeu::Configuration,
+                 :config,
                  :configure,
                  :configuration
 
+  # Sets up a default configuration. Client applications calling using
+  # the `Vedeu.configure` API method will override these settings.
+  Vedeu.configure({})
+
 end # Vedeu

data/lib/vedeu/cursors/cursor.rb

@@ -305,9 +305,9 @@ module Vedeu
       #
       # @return [String]
       def visibility
-        return Vedeu::EscapeSequences::Esc.show_cursor if visible?
+        return Vedeu.esc.show_cursor if visible?
 
-        Vedeu::EscapeSequences::Esc.hide_cursor
+        Vedeu.esc.hide_cursor
       end
 
     end # Cursor

data/lib/vedeu/distributed/server.rb

@@ -96,7 +96,7 @@ module Vedeu
       def restart
         log('Attempting to restart')
 
-        return not_enabled unless Vedeu::Configuration.drb?
+        return not_enabled unless Vedeu.config.drb?
 
         if drb_running?
           log('Restarting')
@@ -122,7 +122,7 @@ module Vedeu
       #
       # @return [void]
       def shutdown
-        return not_enabled unless Vedeu::Configuration.drb?
+        return not_enabled unless Vedeu.config.drb?
 
         stop if drb_running?
 
@@ -140,7 +140,7 @@ module Vedeu
       def start
         log('Attempting to start')
 
-        return not_enabled unless Vedeu::Configuration.drb?
+        return not_enabled unless Vedeu.config.drb?
 
         if drb_running?
           log('Already started')
@@ -163,7 +163,7 @@ module Vedeu
       def status
         log('Fetching status')
 
-        return not_enabled unless Vedeu::Configuration.drb?
+        return not_enabled unless Vedeu.config.drb?
 
         if drb_running?
           log('Running')
@@ -187,7 +187,7 @@ module Vedeu
       def stop
         log('Attempting to stop')
 
-        return not_enabled unless Vedeu::Configuration.drb?
+        return not_enabled unless Vedeu.config.drb?
 
         if drb_running?
           log('Stopping')
@@ -232,8 +232,8 @@ module Vedeu
 
       # @return [String]
       def uri
-        Vedeu::Distributed::Uri.new(Vedeu::Configuration.drb_host,
-                                    Vedeu::Configuration.drb_port).to_s
+        Vedeu::Distributed::Uri.new(Vedeu.config.drb_host,
+                                    Vedeu.config.drb_port).to_s
       end
 
     end # Server

data/lib/vedeu/dsl/views.rb

@@ -202,7 +202,7 @@ module Vedeu
         # @param block [Proc]
         # @return [Vedeu::Views::Composition]
         def composition(client, &block)
-          attrs = { client: client, colour: Vedeu::Configuration.colour }
+          attrs = { client: client, colour: Vedeu.config.colour }
 
           Vedeu::Views::Composition.build(attrs, &block)
         end

data/lib/vedeu/esc/background.rb

@@ -4,7 +4,7 @@ module Vedeu
 
   module EscapeSequences
 
-    # Provides backgroundcolour related escape sequences.
+    # Provides background colour related escape sequences.
     #
     module Background
 

data/lib/vedeu/esc/colours.rb

@@ -95,6 +95,9 @@ module Vedeu
         end + foreground_codes.keys
       end
 
+      # Returns a boolean indicating whether the colour provided is a
+      # valid named colour.
+      #
       # @param named_colour [Symbol]
       # @return [Boolean]
       def valid_name?(named_colour)

data/lib/vedeu/esc/esc.rb

@@ -18,6 +18,11 @@ module Vedeu
       include Vedeu::EscapeSequences::Mouse
       extend self
 
+      # @return [Vedeu::EscapeSequences::Esc]
+      def esc
+        self
+      end
+
       # Return the stream with the escape sequences escaped so that
       # they can be printed to the terminal instead of being
       # interpreted by the terminal which will render them. This way
@@ -39,7 +44,7 @@ module Vedeu
       # @param value [String|Symbol]
       # @return [String]
       def string(value = '')
-        return '' if value.empty?
+        return '' unless present?(value)
 
         send(value)
       rescue NoMethodError
@@ -55,7 +60,7 @@ module Vedeu
       def border(&block)
         return '' unless block_given?
 
-        "#{border_on}#{yield}#{border_off}"
+        border_on + yield + border_off
       end
 
       # @return [String]
@@ -81,29 +86,7 @@ module Vedeu
 
       # @return [String]
       def colour_reset
-        Vedeu::Colours::Colour.coerce(Vedeu::Configuration.colour).to_s
-      end
-
-      # @return [String]
-      def disable_mouse
-        if truthy?(Vedeu::Configuration.mouse)
-          "#{mouse_x10_off}"
-
-        else
-          ''
-
-        end
-      end
-
-      # @return [String]
-      def enable_mouse
-        if truthy?(Vedeu::Configuration.mouse)
-          "#{mouse_x10_on}"
-
-        else
-          ''
-
-        end
+        Vedeu::Colours::Colour.coerce(Vedeu.config.colour).to_s
       end
 
       # @return [String]
@@ -125,4 +108,7 @@ module Vedeu
 
   end # EscapeSequences
 
+  def_delegators Vedeu::EscapeSequences::Esc.esc,
+                 :esc
+
 end # Vedeu

data/lib/vedeu/esc/mouse.rb

@@ -32,6 +32,20 @@ module Vedeu
 
       extend self
 
+      # @return [String]
+      def disable_mouse
+        return mouse_x10_off if Vedeu.config.mouse?
+
+        ''
+      end
+
+      # @return [String]
+      def enable_mouse
+        return mouse_x10_on if Vedeu.config.mouse?
+
+        ''
+      end
+
       # @return [String]
       def mouse_x10_on
         "\e[?9h"

data/lib/vedeu/events/aliases.rb

@@ -12,13 +12,7 @@ module Vedeu
       include Vedeu::Common
       extend self
 
-      # Add events by name to the alias name group. When an alias is
-      # triggered, all the events stored in the group are also
-      # triggered.
-      #
-      # @example
-      #   Vedeu.bind_alias(alias_name, event_name)
-      #
+      # {include:file:docs/dsl/by_method/bind_alias.md}
       # @param alias_name [Symbol] The name of the alias. This can
       #   represent a single event or group of events.
       # @param event_name [Symbol] The name of the event to bind to
@@ -53,12 +47,7 @@ module Vedeu
         storage.include?(alias_name)
       end
 
-      # Remove an alias by name. The alias name group is destroyed,
-      #   but events stored within this alias are not.
-      #
-      # @example
-      #   Vedeu.unbind_alias(alias_name)
-      #
+      # {include:file:docs/dsl/by_method/unbind_alias.md}
       # @param alias_name [Symbol] The name of the alias.
       # @return [Boolean|Hash<Symbol => Array<Symbol>>]
       def unbind_alias(alias_name)

data/lib/vedeu/events/event.rb

@@ -93,12 +93,7 @@ module Vedeu
         alias_method :event, :bind
         alias_method :register, :bind
 
-        # Return a boolean indicating whether the named event is
-        # registered.
-        #
-        # @example
-        #   Vedeu.bound?(:some_event)
-        #
+        # {include:file:docs/dsl/by_method/bound.md}
         # @param name [Symbol]
         # @return [Boolean]
         def bound?(name)
@@ -106,13 +101,7 @@ module Vedeu
             Vedeu::Events::Aliases.registered?(name)
         end
 
-        # Unbind events from a named handler.
-        #
-        # Removes all events associated with the given name.
-        #
-        # @example
-        #   Vedeu.unbind(:some_event)
-        #
+        # {include:file:docs/dsl/by_method/unbind.md}
         # @param name [Symbol]
         # @return [Boolean]
         def unbind(name)