vedeu 0.6.8 → 0.6.9

data/lib/vedeu/colours/foreground.rb

@@ -3,7 +3,8 @@ module Vedeu
   module Colours
 
     # The class represents one half (the other, can be found at
-    # {Vedeu::Colours::Background}) of a terminal colour escape sequence.
+    # {Vedeu::Colours::Background}) of a terminal colour escape
+    # sequence.
     #
     class Foreground < Vedeu::Colours::Translator
 

data/lib/vedeu/colours/repository.rb

@@ -2,8 +2,8 @@ module Vedeu
 
   module Colours
 
-    # Allows the storing of HTML/CSS colours and their respective escape
-    # sequences.
+    # Allows the storing of HTML/CSS colours and their respective
+    # escape sequences.
     #
     class Repository
 
@@ -25,7 +25,8 @@ module Vedeu
         storage.store(colour, escape_sequence)
       end
 
-      # Returns a boolean indicating whether the colour has been registered.
+      # Returns a boolean indicating whether the colour has been
+      # sregistered.
       #
       # @param colour [String]
       # @return [Boolean]
@@ -49,8 +50,8 @@ module Vedeu
         storage.fetch(colour, '')
       end
 
-      # Retrieves the escape sequence of a registered colour, or registers the
-      # colour with its respective escape sequence.
+      # Retrieves the escape sequence of a registered colour, or
+      # registers the colour with its respective escape sequence.
       #
       # @return [String]
       def retrieve_or_register(colour, escape_sequence)

data/lib/vedeu/colours/translator.rb

@@ -2,23 +2,27 @@ module Vedeu
 
   module Colours
 
-    # Convert a CSS/HTML colour string into a terminal escape sequence.
+    # Convert a CSS/HTML colour string into a terminal escape
+    # sequence.
     #
-    # If provided with an empty value or a string it cannot convert, it will
-    # return an empty string.
+    # If provided with an empty value or a string it cannot convert,
+    # it will return an empty string.
     #
-    # When provided with a named colour, uses the terminal's value for that
-    # colour. If a theme is being used with the terminal, which overrides the
-    # defaults, then the theme's colour will be used. The recognised names are:
-    # :black, :red, :green, :yellow, :blue, :magenta, :cyan, :white, :default.
+    # When provided with a named colour, uses the terminal's value for
+    # that colour. If a theme is being used with the terminal, which
+    # overrides the defaults, then the theme's colour will be used.
+    # The recognised names are:
     #
-    # When a number between 0 and 255 is provided, Vedeu will use the terminal
-    # colour corresponding with that colour.
+    # :black, :red, :green, :yellow, :blue, :magenta, :cyan, :white,
+    # :default.
     #
-    # Finally, when provided a CSS/HTML colour string e.g. '#ff0000', Vedeu will
-    # translate that to the 8-bit escape sequence or when you have a capable
-    # terminal and the `TERM=xterm-truecolor` environment variable set,
-    # a 24-bit representation.
+    # When a number between 0 and 255 is provided, Vedeu will use the
+    # terminal colour corresponding with that colour.
+    #
+    # Finally, when provided a CSS/HTML colour string e.g. '#ff0000',
+    # Vedeu will translate that to the 8-bit escape sequence or when
+    # you have a capable terminal and the `TERM=xterm-truecolor`
+    # environment variable set, a 24-bit representation.
     #
     # @todo More documentation required (create a fancy chart!)
     #
@@ -29,8 +33,8 @@ module Vedeu
       attr_reader :colour
       alias_method :value, :colour
 
-      # Produces new objects of the correct class from the value, ignores
-      # objects Colours::that have already been coerced.
+      # Produces new objects of the correct class from the value,
+      # ignores objects Colours::that have already been coerced.
       #
       # @param value [Object|NilClass]
       # @return [Object]
@@ -113,8 +117,8 @@ module Vedeu
       # processing.
       #
       # @param colour [String] A HTML/CSS colour code.
-      # @param escape_sequence [String] The HTML/CSS colour code as an escape
-      #   sequence.
+      # @param escape_sequence [String] The HTML/CSS colour code as an
+      #   escape sequence.
       # @return [String]
       def register(colour, escape_sequence)
         repository.register(colour, escape_sequence)
@@ -144,16 +148,16 @@ module Vedeu
         "\e[#{named_codes}m"
       end
 
-      # Returns a boolean indicating whether the colour provided is a valid
-      # named colour.
+      # Returns a boolean indicating whether the colour provided is a
+      # valid named colour.
       #
       # @return [Boolean]
       def valid_name?
         Vedeu::Esc.codes.keys.include?(colour)
       end
 
-      # Returns a boolean indicating whether the colour provided is a terminal
-      # numbered colour.
+      # Returns a boolean indicating whether the colour provided is a
+      # terminal numbered colour.
       #
       # @return [Boolean]
       def numbered?
@@ -167,8 +171,8 @@ module Vedeu
         "#{numbered_prefix}#{css_to_numbered}m"
       end
 
-      # Returns a boolean indicated whether the colour is a valid HTML/CSS
-      # colour.
+      # Returns a boolean indicated whether the colour is a valid
+      # HTML/CSS colour.
       #
       # @return [Boolean]
       def rgb?
@@ -190,16 +194,16 @@ module Vedeu
         end
       end
 
-      # Returns a boolean indicating whether the numbered colour is within the
-      # range of valid terminal numbered colours.
+      # Returns a boolean indicating whether the numbered colour is
+      # within the range of valid terminal numbered colours.
       #
       # @return [Boolean]
       def valid_range?
         colour >= 0 && colour <= 255
       end
 
-      # Returns a collection of converted HTML/CSS octets as their decimal
-      # equivalents.
+      # Returns a collection of converted HTML/CSS octets as their
+      # decimal equivalents.
       #
       # @example
       #   colour = '#aadd55'
@@ -225,32 +229,32 @@ module Vedeu
         end
       end
 
-      # Takes the red component of {#css_to_rgb} and converts to the correct
-      # value for setting the terminal red value.
+      # Takes the red component of {#css_to_rgb} and converts to the
+      # correct value for setting the terminal red value.
       #
       # @return [Fixnum]
       def red
         (css_to_rgb[0] / 51) * 36
       end
 
-      # Takes the green component of {#css_to_rgb} and converts to the correct
-      # value for setting the terminal green value.
+      # Takes the green component of {#css_to_rgb} and converts to the
+      # correct value for setting the terminal green value.
       #
       # @return [Fixnum]
       def green
         (css_to_rgb[1] / 51) * 6
       end
 
-      # Takes the blue component of {#css_to_rgb} and converts to the correct
-      # value for setting the terminal blue value.
+      # Takes the blue component of {#css_to_rgb} and converts to the
+      # correct value for setting the terminal blue value.
       #
       # @return [Fixnum]
       def blue
         (css_to_rgb[2] / 51) * 1
       end
 
-      # @raise [Vedeu::Error::NotImplemented] Subclasses of this class must
-      #   implement this method.
+      # @raise [Vedeu::Error::NotImplemented] Subclasses of this class
+      #   must implement this method.
       # @return [Vedeu::Error::NotImplemented]
       def not_implemented
         fail Vedeu::Error::NotImplemented, 'Subclasses implement this.'

data/lib/vedeu/configuration/api.rb

@@ -2,8 +2,9 @@ module Vedeu
 
   module Config
 
-    # The Configuration::API class parses client application configuration into
-    # options used by Vedeu to affect certain behaviours.
+    # The Configuration::API class parses client application
+    # configuration into options used by Vedeu to affect certain
+    # behaviours.
     #
     class API
 
@@ -16,8 +17,8 @@ module Vedeu
 
       # Returns a new instance of Vedeu::Config::API.
       #
-      # Configure Vedeu via a simple configuration API DSL. Options set here
-      # override the default Vedeu configuration set in
+      # Configure Vedeu via a simple configuration API DSL. Options
+      # set here override the default Vedeu configuration set in
       # {Vedeu::Configuration#defaults}.
       #
       #   Vedeu.configure do
@@ -37,11 +38,12 @@ module Vedeu
         Vedeu::Config.log(Esc.green { '[api]' }, options)
       end
 
-      # Sets boolean to allow user input. The default behaviour of Vedeu is to
-      # be interactive.
+      # Sets boolean to allow user input. The default behaviour of
+      # Vedeu is to be interactive.
       #
       #   Vedeu.configure do
-      #     interactive! # => same as `interactive true` or `standalone false`
+      #     interactive! # => same as `interactive true` or
+      #                  #    `standalone false`
       #     # ...
       #   end
       #
@@ -62,11 +64,12 @@ module Vedeu
       end
       alias_method :interactive, :interactive!
 
-      # Sets boolean to prevent user intervention. This is the same as setting
-      # {include:Vedeu::Config::API#interactive!} to false.
+      # Sets boolean to prevent user intervention. This is the same as
+      # setting {include:Vedeu::Config::API#interactive!} to false.
       #
       #   Vedeu.configure do
-      #     standalone! # => same as `standalone true` or `interactive false`
+      #     standalone! # => same as `standalone true` or
+      #                 #    `interactive false`
       #     # ...
       #   end
       #
@@ -87,9 +90,10 @@ module Vedeu
       end
       alias_method :standalone, :standalone!
 
-      # Sets boolean to run the Vedeu main application loop once. In effect,
-      # using `run_once!` or setting `run_once` to true will allow Vedeu to
-      # initialize, run any client application code, cleanup, then terminate.
+      # Sets boolean to run the Vedeu main application loop once. In
+      # effect, using `run_once!` or setting `run_once` to true will
+      # allow Vedeu to initialize, run any client application code,
+      # cleanup, then terminate.
       #
       #   Vedeu.configure do
       #     run_once!
@@ -169,8 +173,8 @@ module Vedeu
         options[:drb_width] = width
       end
 
-      # Sets the terminal mode to `cooked`. Default terminal mode is `raw`.
-      # Also, see {Vedeu::Config::API#raw!}
+      # Sets the terminal mode to `cooked`. Default terminal mode is
+      # `raw`. Also, see {Vedeu::Config::API#raw!}
       #
       #   Vedeu.configure do
       #     cooked!
@@ -183,7 +187,8 @@ module Vedeu
       end
       alias_method :cooked, :cooked!
 
-      # Sets the terminal mode to `fake`. Default terminal mode is `raw`.
+      # Sets the terminal mode to `fake`. Default terminal mode is
+      # `raw`.
       #
       # @example
       #   Vedeu.configure do
@@ -197,8 +202,8 @@ module Vedeu
       end
       alias_method :fake, :fake!
 
-      # Sets the terminal mode to `raw`. Default terminal mode is `raw`.
-      # Also, see {Vedeu::Config::API#cooked!}
+      # Sets the terminal mode to `raw`. Default terminal mode is
+      # `raw`. Also, see {Vedeu::Config::API#cooked!}
       #
       #   Vedeu.configure do
       #     raw!
@@ -211,13 +216,13 @@ module Vedeu
       end
       alias_method :raw, :raw!
 
-      # Sets boolean to enable/disable debugging. Vedeu's default setting is
-      # for debugging to be disabled. Using `debug!` or setting `debug` to true
-      # will enable debugging.
+      # Sets boolean to enable/disable debugging. Vedeu's default
+      # setting is for debugging to be disabled. Using `debug!` or
+      # setting `debug` to true will enable debugging.
       #
       # @note
-      #   Be aware that running an application with debugging enabled will
-      #   affect performance.
+      #   Be aware that running an application with debugging enabled
+      #   will affect performance.
       #
       #   Vedeu.configure do
       #     debug!
@@ -244,14 +249,15 @@ module Vedeu
       #   end
       #
       # @note
-      #   iTerm 2 on Mac OSX will handle the true colour setting (16777216),
-      #   whereas Terminator on Linux will not display colours correctly. For
-      #   compatibility across platforms, it is recommended to either not set
-      #   the colour mode at all and allow it to be detected, or use 256 here.
+      #   iTerm 2 on Mac OSX will handle the true colour setting
+      #   (16777216), whereas Terminator on Linux will not display
+      #   colours correctly. For compatibility across platforms, it is
+      #   recommended to either not set the colour mode at all and
+      #   allow it to be detected, or use 256 here.
       #
       # @param value [Fixnum]
-      # @raise [Vedeu::Error::InvalidSyntax] When the value parameter is not one
-      #   of +8+, +16+, +256+ or +16777216+.
+      # @raise [Vedeu::Error::InvalidSyntax] When the value parameter
+      #   is not one of +8+, +16+, +256+ or +16777216+.
       # @return [Boolean]
       def colour_mode(value = nil)
         unless valid_colour_mode?(value)
@@ -290,8 +296,9 @@ module Vedeu
         options[:log_only] = types
       end
 
-      # Sets the renderers for Vedeu. Each renderer added must have the class
-      # method '.render' defined as this will be called when rendering content.
+      # Sets the renderers for Vedeu. Each renderer added must have
+      # the class method '.render' defined as this will be called when
+      # rendering content.
       #
       #   Vedeu.configure do
       #     renderer MyRenderer
@@ -310,9 +317,9 @@ module Vedeu
       end
       alias_method :renderers, :renderer
 
-      # Override the base path for the application (for locating templates and
-      # other resources). By default the base path is just cwd but this will
-      # not work for many applications.
+      # Override the base path for the application (for locating
+      # templates and other resources). By default the base path is
+      # just cwd but this will not work for many applications.
       #
       #   Vedeu.configure do
       #     base_path '/path/to/application'
@@ -325,8 +332,8 @@ module Vedeu
         options[:base_path] = path
       end
 
-      # Sets the root of the client application. Vedeu will execute this
-      # controller with action and optional arguments first.
+      # Sets the root of the client application. Vedeu will execute
+      # this controller with action and optional arguments first.
       #
       #   Vedeu.configure do
       #     root :controller, :action, args
@@ -378,13 +385,13 @@ module Vedeu
         options[:stderr] = io
       end
 
-      # Compression reduces the number of escape sequences being sent to the
-      # terminal which improves redraw/render/refresh rate. By default it is
-      # enabled.
+      # Compression reduces the number of escape sequences being sent
+      # to the terminal which improves redraw/render/refresh rate. By
+      # default it is enabled.
       #
-      # Sets boolean to enable/disable compression. Vedeu's default setting is
-      # for compression to be enabled. Setting `compression` to false will
-      # disable compression.
+      # Sets boolean to enable/disable compression. Vedeu's default
+      # setting is for compression to be enabled. Setting
+      # `compression` to false will disable compression.
       #
       #   Vedeu.configure do
       #     compression! # enabled (default)
@@ -397,9 +404,10 @@ module Vedeu
       #   end
       #
       # @note
-      # - Be aware that running an application without compression will
-      #   affect performance.
-      # - Compression cannot yet be configured using a CLI option flag.
+      # - Be aware that running an application without compression
+      #   will affect performance.
+      # - Compression cannot yet be configured using a CLI option
+      #   flag.
       #
       # @param value [Boolean]
       # @return [Boolean]
@@ -408,8 +416,8 @@ module Vedeu
       end
       alias_method :compression!, :compression
 
-      # Sets the terminal mode. Valid values can be either ':cooked', ':fake' or
-      # :raw'.
+      # Sets the terminal mode. Valid values can be either ':cooked',
+      # ':fake' or :raw'.
       #
       #   Vedeu.configure do
       #     terminal_mode :cooked
@@ -426,8 +434,8 @@ module Vedeu
       #   end
       #
       # @param mode [Symbol] Either ':cooked', ':fake' or ':raw'.
-      # @raise [Vedeu::Error::InvalidSyntax] When the mode is not ':cooked',
-      #   ':fake' or ':raw'.
+      # @raise [Vedeu::Error::InvalidSyntax] When the mode is not
+      #   ':cooked', ':fake' or ':raw'.
       # @return [Symbol]
       # @see Vedeu::Config::API#cooked!
       # @see Vedeu::Config::API#fake!
@@ -445,8 +453,8 @@ module Vedeu
 
       private
 
-      # Returns the options set via the configuration API DSL or an empty Hash
-      # when none were set.
+      # Returns the options set via the configuration API DSL or an
+      # empty Hash when none were set.
       #
       # @return [Hash]
       def options

data/lib/vedeu/configuration/cli.rb

@@ -3,7 +3,8 @@ module Vedeu
   module Config
 
     # The Configuration::CLI class parses command-line arguments using
-    # OptionParser into options used by Vedeu to affect certain behaviours.
+    # OptionParser into options used by Vedeu to affect certain
+    # behaviours.
     #
     class CLI
 
@@ -14,9 +15,9 @@ module Vedeu
 
       # Returns a new instance of Vedeu::Config::CLI.
       #
-      # Configure Vedeu via command-line arguments. Options set here via
-      # arguments override the client application configuration set via
-      # {Vedeu::API#configure}.
+      # Configure Vedeu via command-line arguments. Options set here
+      # via arguments override the client application configuration
+      # set via {Vedeu::API#configure}.
       #
       # @param args [Array]
       # @return [Vedeu::Configuration::CLI]
@@ -25,8 +26,8 @@ module Vedeu
         @options = {}
       end
 
-      # Returns the configuration options set up by parsing the command-line
-      # arguments passed to the client application.
+      # Returns the configuration options set up by parsing the
+      # command-line arguments passed to the client application.
       #
       # @return [Hash]
       def configuration
@@ -49,7 +50,8 @@ module Vedeu
 
       private
 
-      # Setup Vedeu using CLI configuration options for the client application.
+      # Setup Vedeu using CLI configuration options for the client
+      # application.
       #
       # @return [void]
       def setup!