vedeu 0.6.45 → 0.6.46

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c76c4e0d9abb0d4ce8fd8f6161c07504a3d6cbbb
-  data.tar.gz: 7ee11459a372f200d2d2ae141fc159c96b941fbe
+  metadata.gz: 1ff740a5d8a382dc5f6e01353c52fc4c8785934d
+  data.tar.gz: fdf167026d1ab0633c6e7dbc17e4f13c6ead54c7
 SHA512:
-  metadata.gz: cc488bb31f2ba6d6a6fc2dfe6b808ea88dda9627ef7f9b767273ecf00538ef72205f20683ea7f0e6b4d96173d6dcd07b3e3747d6a604d1535dd003979a39d041
-  data.tar.gz: b1683006f7daa19a790928fd58ccd03fab1567064c67240db9813776389d300b65cab261bcf03cacff38e6949661aae2a02c0d86f577176bdeaa4f9103657562
+  metadata.gz: ecd1e62df7d6590cb80d159f749622495eab7984c34f3f880afdfa71ab1e790070915d09702e60d02778120d10c4b80cff864aced98e3cdf9882b922ea8a6d18
+  data.tar.gz: 8b72b7cf6dea8fb4c4343405f295c68f67b920ddf4574d95ba06cb2360066b4d6462d850c471804bdc15d96dba12c6fcc66b4ba624e9e6946d499b1059173734

data/README.md

@@ -56,23 +56,46 @@ to your project here.
 
 Vedeu is documented using Yard. I hope to produce more 'General Usage'
 documentation shortly. In the meantime, please browse the
-[RubyDoc](http://rubydoc.info/gems/vedeu). In no particular order,
-here is some documentation for the various aspects of Vedeu:
+[RubyDoc](http://rubydoc.info/gems/vedeu). Finally, here is some
+documentation for the various aspects of Vedeu (not comprehensive):
 
-- [Interfaces](http://rubydoc.info/gems/vedeu/file/docs/.md)
-- [Groups](http://rubydoc.info/gems/vedeu/file/docs/group.md)
-- [Views](http://rubydoc.info/gems/vedeu/file/docs/view.md)
-- [Buffers](http://rubydoc.info/gems/vedeu/file/docs/buffer.md)
-- [Geometry](http://rubydoc.info/gems/vedeu/file/docs/geometry.md)
+- [The Vedeu API](http://rubydoc.info/gems/vedeu/file/docs/api.md)
 - [Borders](http://rubydoc.info/gems/vedeu/file/docs/borders.md)
+- [Buffers](http://rubydoc.info/gems/vedeu/file/docs/buffer.md)
+- [Cell](http://rubydoc.info/gems/vedeu/file/docs/cell.md)
+- [Chars](http://rubydoc.info/gems/vedeu/file/docs/chars.md)
+- [Colours & Styles](http://rubydoc.info/gems/vedeu/file/docs/colours_styles.md)
+- [Configuration](http://rubydoc.info/gems/vedeu/file/docs/configuration.md)
 - [Cursors](http://rubydoc.info/gems/vedeu/file/docs/cursors.md)
-- [Keymaps](http://rubydoc.info/gems/vedeu/file/docs/keymaps.md)
+- [Debugging](http://rubydoc.info/gems/vedeu/file/docs/debugging.md)
+- [The Vedeu DSL](http://rubydoc.info/gems/vedeu/file/docs/dsl.md)
 - [Events](http://rubydoc.info/gems/vedeu/file/docs/events.md)
-- [Configuration](http://rubydoc.info/gems/vedeu/file/docs/configuration.md)
+    - [Application Events](http://rubydoc.info/gems/vedeu/file/docs/events/application.md)
+    - [Document Events](http://rubydoc.info/gems/vedeu/file/docs/events/document.md)
+    - [Focus Events](http://rubydoc.info/gems/vedeu/file/docs/events/focus.md)
+    - [Menu Events](http://rubydoc.info/gems/vedeu/file/docs/events/menu.md)
+    - [Movement Events](http://rubydoc.info/gems/vedeu/file/docs/events/movement.md)
+    - [Refresh Events](http://rubydoc.info/gems/vedeu/file/docs/events/refresh.md)
+    - [System Events](http://rubydoc.info/gems/vedeu/file/docs/events/system.md)
+    - [View Events](http://rubydoc.info/gems/vedeu/file/docs/events/view.md)
+    - [Visibility Events](http://rubydoc.info/gems/vedeu/file/docs/events/visibility.md)
+- [Geometry](http://rubydoc.info/gems/vedeu/file/docs/geometry.md)
 - [Getting Started](http://rubydoc.info/gems/vedeu/file/docs/getting_started.md)
-- [The Vedeu DSL](http://rubydoc.info/gems/vedeu/file/docs/dsl.md)
-- [The Vedeu API](http://rubydoc.info/gems/vedeu/file/docs/api.md)
+- [Groups](http://rubydoc.info/gems/vedeu/file/docs/group.md)
+- [Input](http://rubydoc.info/gems/vedeu/file/docs/input.md)
+- [Interfaces](http://rubydoc.info/gems/vedeu/file/docs/.md)
+- [Keymaps](http://rubydoc.info/gems/vedeu/file/docs/keymaps.md)
+- [Lines](http://rubydoc.info/gems/vedeu/file/docs/lines.md)
 - [Object Graphs](http://rubydoc.info/gems/vedeu/file/docs/object_graph.md)
+- [Output](http://rubydoc.info/gems/vedeu/file/docs/output.md)
+- [Streams](http://rubydoc.info/gems/vedeu/file/docs/streams.md)
+- [Template](http://rubydoc.info/gems/vedeu/file/docs/template.md)
+- [Views](http://rubydoc.info/gems/vedeu/file/docs/view.md)
+
+There are also some small, simple applications in the
+[examples/](https://github.com/gavinlaking/vedeu/blob/master/examples)
+directory to show some concepts and basic functionality. This is not
+exhaustive, but are being added to and improved fairly regularly.
 
 ## Development / Contributing
 

data/docs/configuration.md

@@ -18,9 +18,15 @@ reason, simply ask for it:
 
 ## Configuration Options
 
+### background
+{include:Vedeu::Config::API#background}
+
 ### base_path
 {include:Vedeu::Config::API#base_path}
 
+### colour
+{include:Vedeu::Config::API#colour}
+
 ### colour_mode
 {include:Vedeu::Config::API#colour_mode}
 
@@ -48,6 +54,9 @@ reason, simply ask for it:
 ### drb_width
 {include:Vedeu::Config::API#drb_width}
 
+### foreground
+{include:Vedeu::Config::API#foreground}
+
 ### interactive / interactive!
 {include:Vedeu::Config::API#interactive}
 

data/lib/vedeu/all.rb

@@ -1,6 +1,7 @@
 require 'vedeu/version'
 
 require 'vedeu/common'
+require 'vedeu/colours/all'
 require 'vedeu/configuration/api'
 require 'vedeu/configuration/configuration'
 require 'vedeu/repositories/all'

data/lib/vedeu/borders/border.rb

@@ -28,34 +28,41 @@ module Vedeu
                      :yn
 
       # @!attribute [rw] bottom_left
-      # @return [String]
+      # @return [String] The character to be used for the bottom left
+      #   border if enabled.
       attr_accessor :bottom_left
 
       # @!attribute [rw] bottom_right
-      # @return [String]
+      # @return [String] The character to be used for the bottom right
+      #   border if enabled.
       attr_accessor :bottom_right
 
       # @!attribute [rw] horizontal
-      # @return [String]
+      # @return [String] The character to be used for the horizontal
+      #   side border.
       attr_accessor :horizontal
 
       # @!attribute [rw] show_bottom
-      # @return [Boolean]
+      # @return [Boolean] Determines whether the bottom border should
+      #   be shown.
       attr_accessor :show_bottom
       alias_method :bottom?, :show_bottom
 
       # @!attribute [rw] show_left
-      # @return [Boolean]
+      # @return [Boolean] Determines whether the left border should
+      #   be shown.
       attr_accessor :show_left
       alias_method :left?, :show_left
 
       # @!attribute [rw] show_right
-      # @return [Boolean]
+      # @return [Boolean] Determines whether the right border should
+      #   be shown.
       attr_accessor :show_right
       alias_method :right?, :show_right
 
       # @!attribute [rw] show_top
-      # @return [Boolean]
+      # @return [Boolean] Determines whether the top border should
+      #   be shown.
       attr_accessor :show_top
       alias_method :top?, :show_top
 
@@ -70,27 +77,33 @@ module Vedeu
       attr_accessor :title
 
       # @!attribute [rw] top_left
-      # @return [String]
+      # @return [String] The character to be used for the top left
+      #   border if enabled.
       attr_accessor :top_left
 
       # @!attribute [rw] top_right
-      # @return [String]
+      # @return [String] The character to be used for the top right
+      #   border if enabled.
       attr_accessor :top_right
 
       # @!attribute [rw] vertical
-      # @return [String]
+      # @return [String] The character to be used for the vertical
+      #   side border.
       attr_accessor :vertical
 
       # @!attribute [r] name
-      # @return [String]
+      # @return [String] Associates the border with the same-named
+      #   interface/view.
       attr_reader :name
 
       # @!attribute [r] parent
-      # @return [Vedeu::Interfaces::Interface|NilClass]
+      # @return [Vedeu::Interfaces::Interface|NilClass] The interface/
+      #   view associated with this border.
       attr_reader :parent
 
       # @!attribute [r] enabled
-      # @return [Boolean]
+      # @return [Boolean] Determines whether this border should be
+      #   rendered.
       attr_accessor :enabled
       alias_method :enabled?, :enabled
 
@@ -159,21 +172,33 @@ module Vedeu
         }
       end
 
+      # Return the column position for 1 character right of the left
+      #   border.
+      #
       # @return [Fixnum]
       def bx
         (enabled? && left?) ? x + 1 : x
       end
 
+      # Return the column position for 1 character left of the right
+      #   border.
+      #
       # @return [Fixnum]
       def bxn
         (enabled? && right?) ? xn - 1 : xn
       end
 
+      # Return the row position for 1 character under of the top
+      #   border.
+      #
       # @return [Fixnum]
       def by
         (enabled? && top?) ? y + 1 : y
       end
 
+      # Return the column position for 1 character above of the bottom
+      #   border.
+      #
       # @return [Fixnum]
       def byn
         (enabled? && bottom?) ? yn - 1 : yn
@@ -197,7 +222,9 @@ module Vedeu
 
       private
 
-      # @return [Vedeu::Geometry::Geometry]
+      # Returns the geometry for the interface.
+      #
+      # @return (see Vedeu::Geometry::Repository#by_name)
       def geometry
         Vedeu.geometries.by_name(name)
       end

data/lib/vedeu/borders/refresh.rb

@@ -75,7 +75,9 @@ module Vedeu
 
       private
 
-      # @return [Vedeu::Borders::Border]
+      # Returns the border for the interface.
+      #
+      # @return (see Vedeu::Borders::Repository#by_name)
       def border
         @border ||= Vedeu.borders.by_name(name)
       end
@@ -161,7 +163,9 @@ module Vedeu
         [build_bottom_left, captionbar, build_bottom_right].compact
       end
 
-      # @return [Vedeu::Geometry::Geometry]
+      # Returns the geometry for the interface.
+      #
+      # @return (see Vedeu::Geometry::Repository#by_name)
       def geometry
         Vedeu.geometries.by_name(name)
       end
@@ -176,9 +180,12 @@ module Vedeu
         end
       end
 
-      # The parent of a border is always an interface.
+      # Returns the interface by name.
+      #
+      # @note
+      #   The parent of a border is always an interface.
       #
-      # @return [Vedeu::Interfaces::Interface]
+      # @return (see Vedeu::Interfaces::Repository#by_name)
       def interface
         @interface ||= Vedeu.interfaces.by_name(name)
       end

data/lib/vedeu/colours/colour.rb

@@ -82,6 +82,15 @@ module Vedeu
         @foreground = Vedeu::Colours::Foreground.coerce(attributes[:foreground])
       end
 
+      # @return [Hash<Symbol => Vedeu::Colours::Background,
+      #   Vedeu::Colours::Foreground>]
+      def attributes
+        {
+          background: Vedeu::Colours::Background.coerce(@background),
+          foreground: Vedeu::Colours::Foreground.coerce(@foreground),
+        }
+      end
+
       # Converts the value into a Vedeu::Colours::Background.
       #
       # @param value [String]

data/lib/vedeu/configuration/api.rb

@@ -504,8 +504,71 @@ module Vedeu
         options[:width] = width
       end
 
+      # Sets the background of the terminal.
+      #
+      #   Vedeu.configure do
+      #     background '#ff0000'
+      #     # ...
+      #   end
+      #
+      # @param value [String]
+      # @return [Vedeu::Colours::Background]
+      def background(value = nil)
+        return options[:background] unless value
+
+        new_background = Vedeu::Colours::Background.coerce(value)
+
+        options[:background] = colour_attributes(background: new_background)
+                               .fetch(:background)
+      end
+
+      # Sets the foreground of the terminal.
+      #
+      #   Vedeu.configure do
+      #     foreground '#ffff00'
+      #     # ...
+      #   end
+      #
+      # @param value [String]
+      # @return [Vedeu::Colours::Foreground]
+      def foreground(value = nil)
+        return options[:foreground] unless value
+
+        new_foreground = Vedeu::Colours::Foreground.coerce(value)
+
+        options[:foreground] = colour_attributes(foreground: new_foreground)
+                               .fetch(:foreground)
+      end
+
+      # Sets the background and foreground of the terminal.
+      #
+      #   Vedeu.configure do
+      #     colour background: '#ff0000', foreground: '#ffff00'
+      #     # ...
+      #   end
+      #
+      # @param attrs [Hash<Symbol => String>]
+      # @return [Hash]
+      def colour(attrs = {})
+        options[:background] = background(attrs[:background])
+        options[:foreground] = foreground(attrs[:foreground])
+        options
+      end
+
       private
 
+      # @params attrs [Hash<Symbol => Vedeu::Colours::Background,
+      #   Vedeu::Colours::Foreground>]
+      # @options attrs background [Vedeu::Colours::Background]
+      # @options attrs foreground [Vedeu::Colours::Foreground]
+      # @return [Hash<Symbol => Symbol>]
+      def colour_attributes(attrs = {})
+        {
+          background: Vedeu::Configuration.background,
+          foreground: Vedeu::Configuration.foreground,
+        }.merge!(attrs)
+      end
+
       # @raise [Vedeu::Error::InvalidSyntax]
       def invalid_mode!
         fail Vedeu::Error::InvalidSyntax,

data/lib/vedeu/configuration/configuration.rb

@@ -34,6 +34,14 @@ module Vedeu
 
     class << self
 
+      # Return the configured background colour for the client
+      # application.
+      #
+      # @return [Vedeu::Colours::Background]
+      def background
+        instance.options[:background]
+      end
+
       # Returns the base_path value.
       #
       # @return [String]
@@ -81,6 +89,12 @@ module Vedeu
         instance
       end
 
+      # @return [Vedeu::Colours::Colour]
+      def colour
+        Vedeu::Colours::Colour.coerce(background: background,
+                                      foreground: foreground)
+      end
+
       # Returns the chosen colour mode.
       #
       # @return [Fixnum]
@@ -135,6 +149,14 @@ module Vedeu
         instance.options[:drb_width]
       end
 
+      # Return the configured foreground colour for the client
+      # application.
+      #
+      # @return [Vedeu::Colours::Foreground]
+      def foreground
+        instance.options[:foreground]
+      end
+
       # Returns the client defined height for the terminal.
       #
       # @return [Fixnum]
@@ -299,6 +321,7 @@ module Vedeu
     # @return [Hash<Symbol => void>]
     def defaults
       {
+        background:    Vedeu::Colours::Background.coerce(:default),
         base_path:     base_path,
         colour_mode:   detect_colour_mode,
         compression:   true,
@@ -308,6 +331,7 @@ module Vedeu
         drb_port:      nil,
         drb_height:    25,
         drb_width:     80,
+        foreground:    Vedeu::Colours::Foreground.coerce(:default),
         height:        nil,
         interactive:   true,
         log:           nil,

data/lib/vedeu/cursors/cursor.rb

@@ -263,7 +263,9 @@ module Vedeu
 
       private
 
-      # @see Vedeu::Borders::Repository#by_name
+      # Returns the border for the interface.
+      #
+      # @return (see Vedeu::Borders::Repository#by_name)
       def border
         @border ||= Vedeu.borders.by_name(name)
       end

data/lib/vedeu/dsl/view.rb

@@ -197,7 +197,9 @@ module Vedeu
         # @param block [Proc]
         # @return [Vedeu::Views::Composition]
         def composition(client, &block)
-          Vedeu::Views::Composition.build(client: client, &block)
+          attrs = { client: client, colour: Vedeu::Configuration.colour }
+
+          Vedeu::Views::Composition.build(attrs, &block)
         end
 
         # Stores each of the views defined in their respective buffers

data/lib/vedeu/editor/cropper.rb

@@ -88,7 +88,9 @@ module Vedeu
         @lines[oy...(oy + height)] || []
       end
 
-      # @return [Vedeu::Interfaces::Interface]
+      # Returns the interface by name.
+      #
+      # @return (see Vedeu::Interfaces::Repository#by_name)
       def interface
         @interface ||= Vedeu.interfaces.by_name(name)
       end
@@ -100,7 +102,9 @@ module Vedeu
         line[ox...(ox + width)] || ''
       end
 
-      # @return [Vedeu::Borders::Border]
+      # Returns the border for the interface.
+      #
+      # @return (see Vedeu::Borders::Repository#by_name)
       def border
         @border ||= Vedeu.borders.by_name(name)
       end

data/lib/vedeu/editor/cursor.rb

@@ -156,7 +156,9 @@ module Vedeu
 
       private
 
-      # @return [Vedeu::Borders::Border]
+      # Returns the border for the interface.
+      #
+      # @return (see Vedeu::Borders::Repository#by_name)
       def border
         @border ||= Vedeu.borders.by_name(name)
       end

data/lib/vedeu/error.rb

@@ -86,6 +86,8 @@ module Vedeu
     #
     class OutOfRange < StandardError
 
+      # Returns an error message.
+      #
       # @return [String]
       def message
         'Valid value is between 1 and 12 inclusive.'.freeze
@@ -98,6 +100,8 @@ module Vedeu
     #
     class RequiresBlock < StandardError
 
+      # Returns an error message.
+      #
       # @return [String]
       def message
         'The required block was not given.'.freeze

data/lib/vedeu/esc/esc.rb

@@ -70,7 +70,7 @@ module Vedeu
 
       # @return [String]
       def colour_reset
-        "#{fg_reset}#{bg_reset}".freeze
+        Vedeu::Configuration.colour.to_s
       end
 
       # @return [String]
@@ -83,9 +83,14 @@ module Vedeu
         "#{reset}#{clear}#{hide_cursor}".freeze
       end
 
+      # @return [String]
+      def screen_colour_reset
+        "#{fg_reset}#{bg_reset}".freeze
+      end
+
       # @return [String]
       def screen_exit
-        "#{show_cursor}#{colour_reset}#{reset}" \
+        "#{show_cursor}#{screen_colour_reset}#{reset}" \
         "#{last_character_position}\n".freeze
       end
 

data/lib/vedeu/geometry/coordinate.rb

@@ -80,7 +80,9 @@ module Vedeu
 
       private
 
-      # @see Vedeu::Borders::Repository#by_name
+      # Returns the border for the interface.
+      #
+      # @return (see Vedeu::Borders::Repository#by_name)
       def border
         @border ||= Vedeu.borders.by_name(name)
       end

data/lib/vedeu/geometry/validator.rb

@@ -2,6 +2,8 @@ module Vedeu
 
   module Geometry
 
+    # Validate values given to {Vedeu::Geometry::DSL}.
+    #
     module Validator
 
       include Vedeu::Common
@@ -28,7 +30,7 @@ module Vedeu
         true
       end
 
-      # @param vertical [Symbol] One of :bottom, :middle, :none, :top.
+      # @param value [Symbol] One of :bottom, :middle, :none, :top.
       # @raise [Vedeu::Error::InvalidSyntax] When the value is nil.
       # @return [TrueClass]
       def validate_vertical_alignment!(value)

data/lib/vedeu/interfaces/clear.rb

@@ -81,7 +81,9 @@ module Vedeu
 
       private
 
-      # @see Vedeu::Borders::Repository#by_name
+      # Returns the border for the interface.
+      #
+      # @return (see Vedeu::Borders::Repository#by_name)
       def border
         @border ||= Vedeu.borders.by_name(name)
       end
@@ -109,7 +111,9 @@ module Vedeu
         options[:direct]
       end
 
-      # @see Vedeu::Geometry::Repository#by_name
+      # Returns the geometry for the interface.
+      #
+      # @return (see Vedeu::Geometry::Repository#by_name)
       def geometry
         @geometry ||= Vedeu.geometries.by_name(name)
       end
@@ -121,7 +125,9 @@ module Vedeu
         geometry.height
       end
 
-      # @see Vedeu::Interfaces::Repository#by_name
+      # Returns the interface by name.
+      #
+      # @return (see Vedeu::Interfaces::Repository#by_name)
       def interface
         @interface ||= Vedeu.interfaces.by_name(name)
       end

data/lib/vedeu/interfaces/interface.rb

@@ -119,7 +119,7 @@ module Vedeu
       def defaults
         {
           client:         nil,
-          colour:         Vedeu::Colours::Colour.default,
+          colour:         Vedeu::Configuration.colour,
           cursor_visible: true,
           delay:          0.0,
           editable:       false,

data/lib/vedeu/models/views/view.rb

@@ -125,7 +125,7 @@ module Vedeu
       def defaults
         {
           client:         nil,
-          colour:         Vedeu::Colours::Colour.default,
+          colour:         Vedeu::Configuration.colour,
           cursor_visible: true,
           name:           '',
           parent:         nil,

data/lib/vedeu/output/viewport.rb

@@ -145,8 +145,7 @@ module Vedeu
         offset - dimension
       end
 
-      # Return the border associated with the interface/view we are
-      # drawing.
+      # Returns the border for the interface.
       #
       # @return (see Vedeu::Borders::Repository#by_name)
       def border

data/lib/vedeu/templating/view_template.rb

@@ -72,9 +72,9 @@ module Vedeu
         :normal
       end
 
-      # Fetch the interface by name.
+      # Returns the interface by name.
       #
-      # @return [Vedeu::Interfaces::Interface]
+      # @return (see Vedeu::Interfaces::Repository#by_name)
       def interface
         Vedeu.interfaces.by_name(options[:name])
       end

data/lib/vedeu/version.rb

@@ -1,6 +1,6 @@
 module Vedeu
 
   # The current version of Vedeu.
-  VERSION = '0.6.45'.freeze
+  VERSION = '0.6.46'.freeze
 
 end

data/test/lib/vedeu/colours/colour_test.rb

@@ -173,6 +173,20 @@ module Vedeu
         it { subject.must_be_instance_of(Vedeu::Colours::Colour) }
       end
 
+      describe '#attributes' do
+        let(:expected) {
+          {
+            background: Vedeu::Colours::Background.new,
+            foreground: Vedeu::Colours::Foreground.new,
+          }
+        }
+
+        subject { instance.attributes }
+
+        it { subject.must_be_instance_of(Hash) }
+        it { subject.must_equal(expected) }
+      end
+
       describe '#background=' do
         let(:_value) { '#000000' }
 

data/test/lib/vedeu/configuration/api_test.rb

@@ -356,6 +356,76 @@ module Vedeu
         end
       end
 
+      describe '#background' do
+        context 'when a value is given' do
+          it {
+            configuration = Vedeu.configure { background '#ff0000' }
+            configuration.background.must_be_instance_of(Vedeu::Colours::Background)
+            configuration.background.to_s.must_equal("\e[48;2;255;0;0m")
+          }
+        end
+
+        context 'when a value is not given' do
+          it {
+            configuration = Vedeu.configure { background nil }
+            configuration.background.must_be_instance_of(Vedeu::Colours::Background)
+            configuration.background.to_s.must_equal("\e[49m")
+          }
+        end
+      end
+
+      describe '#colour' do
+        context 'when a background and foreground is given' do
+          it {
+            configuration = Vedeu.configure { colour background: '#ff0000', foreground: '#ffff00' }
+            configuration.colour.must_be_instance_of(Vedeu::Colours::Colour)
+            configuration.colour.to_s.must_equal("\e[38;2;255;255;0m\e[48;2;255;0;0m")
+          }
+        end
+
+        context 'when only a background is given' do
+          it {
+            configuration = Vedeu.configure { colour background: '#ff0000' }
+            configuration.colour.must_be_instance_of(Vedeu::Colours::Colour)
+            configuration.colour.to_s.must_equal("\e[48;2;255;0;0m")
+          }
+        end
+
+        context 'when only a foreground is given' do
+          it {
+            configuration = Vedeu.configure { colour foreground: '#ffff00' }
+            configuration.colour.must_be_instance_of(Vedeu::Colours::Colour)
+            configuration.colour.to_s.must_equal("\e[38;2;255;255;0m")
+          }
+        end
+
+        context 'when neither a background nor foreground is given' do
+          it {
+            configuration = Vedeu.configure { colour background: nil, foreground: nil }
+            configuration.colour.must_be_instance_of(Vedeu::Colours::Colour)
+            configuration.colour.to_s.must_equal('')
+          }
+        end
+      end
+
+      describe '#foreground' do
+        context 'when a value is given' do
+          it {
+            configuration = Vedeu.configure { foreground '#ffff00' }
+            configuration.foreground.must_be_instance_of(Vedeu::Colours::Foreground)
+            configuration.foreground.to_s.must_equal("\e[38;2;255;255;0m")
+          }
+        end
+
+        context 'when a value is not given' do
+          it {
+            configuration = Vedeu.configure { background nil }
+            configuration.foreground.must_be_instance_of(Vedeu::Colours::Foreground)
+            configuration.foreground.to_s.must_equal("\e[39m")
+          }
+        end
+      end
+
     end # API
 
   end # Config

data/test/lib/vedeu/configuration/configuration_test.rb

@@ -9,11 +9,17 @@ module Vedeu
     before { Configuration.reset! }
     after  { test_configuration }
 
+    describe '.background' do
+      it 'returns the value of the background option' do
+        described.background.must_be_instance_of(Vedeu::Colours::Background)
+      end
+    end
+
     describe '.base_path' do
       it { described.must_respond_to(:base_path) }
 
       it 'returns the value of the base_path option' do
-        Configuration.base_path.must_equal(Dir.pwd)
+        described.base_path.must_equal(Dir.pwd)
       end
     end
 
@@ -21,7 +27,7 @@ module Vedeu
       it { described.must_respond_to(:compression) }
 
       it 'returns the value of the compression option' do
-        Configuration.compression?.must_equal(true)
+        described.compression?.must_equal(true)
       end
     end
 
@@ -29,7 +35,7 @@ module Vedeu
       it { described.must_respond_to(:debug) }
 
       it 'returns the value of the debug option' do
-        Configuration.debug?.must_equal(false)
+        described.debug?.must_equal(false)
       end
     end
 
@@ -37,7 +43,13 @@ module Vedeu
       it { described.must_respond_to(:drb) }
 
       it 'returns the value of the drb option' do
-        Configuration.drb?.must_equal(false)
+        described.drb?.must_equal(false)
+      end
+    end
+
+    describe '.foreground' do
+      it 'returns the value of the foreground option' do
+        described.foreground.must_be_instance_of(Vedeu::Colours::Foreground)
       end
     end
 
@@ -45,7 +57,7 @@ module Vedeu
       it { described.must_respond_to(:interactive) }
 
       it 'returns the value of the interactive option' do
-        Configuration.interactive?.must_equal(true)
+        described.interactive?.must_equal(true)
       end
     end
 
@@ -101,37 +113,37 @@ module Vedeu
       it { described.must_respond_to(:once) }
 
       it 'returns the value of the once option' do
-        Configuration.once?.must_equal(false)
+        described.once?.must_equal(false)
       end
     end
 
     describe '.stdin' do
       it 'returns the value of the redefined STDIN' do
-        Configuration.stdin.must_equal(nil)
+        described.stdin.must_equal(nil)
       end
     end
 
     describe '.stdout' do
       it 'returns the value of the redefined STDOUT' do
-        Configuration.stdout.must_equal(nil)
+        described.stdout.must_equal(nil)
       end
     end
 
     describe '.stderr' do
       it 'returns the value of the redefined STDERR' do
-        Configuration.stderr.must_equal(nil)
+        described.stderr.must_equal(nil)
       end
     end
 
     describe '.terminal_mode' do
       it 'returns the value of the mode option' do
-        Configuration.terminal_mode.must_equal(:raw)
+        described.terminal_mode.must_equal(:raw)
       end
     end
 
     describe '.configure' do
       it 'returns the options configured' do
-        Configuration.configure do
+        described.configure do
           # ...
         end.must_equal(Vedeu::Configuration)
       end

data/test/lib/vedeu/esc/esc_test.rb

@@ -50,6 +50,7 @@ module Vedeu
           it { described.string('clear').must_equal("\e[39m\e[49m\e[2J") }
           it { described.string('clear_line').must_equal("\e[39m\e[49m\e[2K") }
           it { described.string('colour_reset').must_equal("\e[39m\e[49m") }
+          it { described.string('screen_colour_reset').must_equal("\e[39m\e[49m") }
           it { described.string('fg_reset').must_equal("\e[39m") }
           it { described.string('hide_cursor').must_equal("\e[?25l") }
           it { described.string('screen_init').

data/test/support/examples/material_colours_app.rb

@@ -17,7 +17,10 @@ class VedeuMaterialColoursApp
   # Be aware that running an application with debugging enabled will affect
   # performance.
   Vedeu.configure do
+    # background '#607d8b'
+    # colour background: '#607d8b', foreground: '#ffff00'
     debug!
+    # foreground '#ffff00'
     # profile!
     log '/tmp/vedeu_material_colours_app.log'
     # height 11

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vedeu
 version: !ruby/object:Gem::Version
-  version: 0.6.45
+  version: 0.6.46
 platform: ruby
 authors:
 - Gavin Laking
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-02 00:00:00.000000000 Z
+date: 2015-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: guard