vedeu 0.6.1 → 0.6.2

data/lib/vedeu/output/renderers/renderer_options.rb

@@ -2,10 +2,9 @@ module Vedeu
 
   # Provides shared functionality to Vedeu::Renderer classes.
   #
+  # :nocov:
   module RendererOptions
 
-    # :nocov:
-
     private
 
     # Combines the options provided at instantiation with the default values.
@@ -22,8 +21,7 @@ module Vedeu
       {}
     end
 
-    # :nocov:
-
   end # RendererOptions
+  # :nocov:
 
 end # Vedeu

data/lib/vedeu/output/text.rb

@@ -86,7 +86,7 @@ module Vedeu
     # @return [void]
     def colour
       if options[:colour] || options[:background] || options[:foreground]
-        Vedeu::Colour.coerce(options)
+        Vedeu::Colours::Colour.coerce(options)
 
       else
         model.colour

data/lib/vedeu/output/wordwrap.rb

@@ -4,7 +4,7 @@ module Vedeu
   #
   class Wordwrap
 
-    # @see {Vedeu::Wordwrap#initialize}
+    # @see Vedeu::Wordwrap#initialize
     def self.for(text, options = {})
       new(text, options).content
     end
@@ -13,12 +13,9 @@ module Vedeu
     #
     # @param text [String]
     # @param options [Hash]
-    # @option options ellipsis [String] For when using mode `:prune`.
-    # @option options mode [Symbol] One of :default, :prune or :wrap;
-    #   :default = Renders the content as is.
-    #   :prune   = Discards the remainder of the content line after width.
-    #   :wrap    = Forces the content on to a new line after width.
-    # @option options width [Fixnum] The width to prune or wrap to.
+    # @option options ellipsis [String] See {#ellipsis}.
+    # @option options mode [Symbol] See {#mode}.
+    # @option options width [Fixnum] See {#width}.
     # @return [Vedeu::Wordwrap]
     def initialize(text, options = {})
       @text    = text
@@ -106,6 +103,8 @@ module Vedeu
       Vedeu::Views::Lines.new(line_objects)
     end
 
+    # Returns the text as an array of lines, split on '\n'.
+    #
     # @return [Array<String>]
     def split_lines
       text.split(/\n/)
@@ -123,27 +122,39 @@ module Vedeu
       end
     end
 
+    # Returns the string pruned.
+    #
     # @param string [String]
     # @return [String]
     def prune_string(string)
       string.chomp.slice(0..pruned_width)
     end
 
+    # Returns the width of the string minus the ellipsis.
+    #
     # @return [Fixnum]
     def pruned_width
       width - ellipsis.size
     end
 
+    # For when using mode `:prune`, by default, provides '...'.
+    #
     # @return [String]
     def ellipsis
       options.fetch(:ellipsis)
     end
 
+    # Returns the word wrapping mode. One of :default, :prune or :wrap;
+    #   :default = Renders the content as is.
+    #   :prune   = Discards the remainder of the content line after width.
+    #   :wrap    = Forces the content on to a new line after width.
     # @return [Symbol]
     def mode
       options.fetch(:mode)
     end
 
+    # Returns the width to prune or wrap to.
+    #
     # @return [Fixnum]
     def width
       options.fetch(:width)

data/lib/vedeu/plugins/plugin.rb

@@ -40,10 +40,10 @@ module Vedeu
       begin
         require gem_name unless enabled?
       rescue LoadError => error
-        raise Vedeu::VedeuError,
+        raise Vedeu::Error::Fatal,
               "Unable to load plugin #{gem_name} due to #{error}."
       rescue => error
-        raise Vedeu::VedeuError,
+        raise Vedeu::Error::Fatal,
               "require '#{gem_name}' failed with #{error}."
       end
 

data/lib/vedeu/refresh/refresh_buffer.rb

@@ -11,7 +11,7 @@ module Vedeu
 
     # @param name [String] The name of the interface to be refreshed using the
     #   named buffer.
-    # @return [Array|Vedeu::ModelNotFound]
+    # @return [Array|Vedeu::Error::ModelNotFound]
     def self.by_name(name)
       new(name).by_name
     end
@@ -39,12 +39,12 @@ module Vedeu
 
     private
 
-    # @raise [Vedeu::MissingRequired] When the name is empty or nil.
+    # @raise [Vedeu::Error::MissingRequired] When the name is empty or nil.
     # @return [String]
     def buffer_name
       return name if present?(name)
 
-      fail Vedeu::MissingRequired,
+      fail Vedeu::Error::MissingRequired,
            'Cannot refresh interface with an empty interface name.'
     end
 

data/lib/vedeu/refresh/refresh_group.rb

@@ -14,7 +14,7 @@ module Vedeu
     include Vedeu::Common
 
     # @param name [String] The name of the group to be refreshed.
-    # @return [Array|Vedeu::ModelNotFound] A collection of the names of
+    # @return [Array|Vedeu::Error::ModelNotFound] A collection of the names of
     #   interfaces refreshed, or an exception when the group was not found.
     def self.by_name(name)
       new(name).by_name
@@ -45,12 +45,12 @@ module Vedeu
 
     private
 
-    # @raise [Vedeu::MissingRequired] When the name is empty or nil.
+    # @raise [Vedeu::Error::MissingRequired] When the name is empty or nil.
     # @return [String]
     def group_name
       return name if present?(name)
 
-      fail Vedeu::MissingRequired,
+      fail Vedeu::Error::MissingRequired,
            'Cannot refresh group with an empty group name.'
     end
 

data/lib/vedeu/repositories/repository.rb

@@ -89,11 +89,11 @@ module Vedeu
     # cannot be found.
     #
     # @param name [String]
-    # @raise [Vedeu::ModelNotFound] When the model cannot be found with this
-    #   name.
+    # @raise [Vedeu::Error::ModelNotFound] When the model cannot be found with
+    #   this name.
     # @return [Hash<String => Object>]
     def find!(name)
-      find(name) || fail(Vedeu::ModelNotFound,
+      find(name) || fail(Vedeu::Error::ModelNotFound,
                          "Cannot find model by name: '#{name}'")
     end
 
@@ -148,12 +148,13 @@ module Vedeu
     # Stores the model instance by name in the repository of the model.
     #
     # @param model [void] A model instance.
-    # @raise [Vedeu::MissingRequired] When the name attribute is not defined.
+    # @raise [Vedeu::Error::MissingRequired] When the name attribute is not
+    #   defined.
     # @return [void] The model instance which was stored.
     def store(model)
       unless present?(model.name)
-        fail Vedeu::MissingRequired, "Cannot store model '#{model.class}' " \
-                                     'without a name attribute.'
+        fail Vedeu::Error::MissingRequired,
+             "Cannot store model '#{model.class}' without a name attribute."
       end
 
       log_store(model)

data/lib/vedeu/runtime/application.rb

@@ -114,7 +114,7 @@ module Vedeu
     def run_many
       Vedeu::MainLoop.start! { yield }
 
-    rescue Vedeu::ModeSwitch
+    rescue Vedeu::Error::ModeSwitch
       Vedeu::Terminal.switch_mode!
 
       Vedeu.trigger(:_drb_restart_)

data/lib/vedeu/runtime/main_loop.rb

@@ -24,7 +24,7 @@ module Vedeu
 
           safe_exit_point!
         end
-      rescue Vedeu::VedeuInterrupt
+      rescue Vedeu::Error::Interrupt
         Vedeu.log(type:    :info,
                   message: 'Vedeu execution interrupted, exiting.')
       end
@@ -40,11 +40,11 @@ module Vedeu
       # :nocov:
       # Check the application has started and we wish to continue running.
       #
-      # @raise [Vedeu::VedeuInterrupt] When we wish to terminate the running
+      # @raise [Vedeu::Error::Interrupt] When we wish to terminate the running
       #   application.
       # @return [void]
       def safe_exit_point!
-        fail Vedeu::VedeuInterrupt if @started && !@loop
+        fail Vedeu::Error::Interrupt if @started && !@loop
       end
       # :nocov:
 

data/lib/vedeu/runtime/router.rb

@@ -13,11 +13,12 @@ module Vedeu
     #
     # @param controller [Symbol]
     # @param klass [String]
-    # @raise [Vedeu::MissingRequired] When the controller name is not given.
+    # @raise [Vedeu::Error::MissingRequired] When the controller name is not
+    #   given.
     # @return [void]
     def add_controller(controller, klass)
       unless present?(controller)
-        fail Vedeu::MissingRequired,
+        fail Vedeu::Error::MissingRequired,
              'Cannot store controller without a name attribute.'
       end
 
@@ -40,8 +41,8 @@ module Vedeu
     #
     # @param controller [Symbol]
     # @param action [Symbol]
-    # @raise [Vedeu::MissingRequired] When the controller name or action name is
-    #   not given.
+    # @raise [Vedeu::Error::MissingRequired] When the controller name or action
+    #   name is not given.
     # @return [void]
     def add_action(controller, action)
       if present?(controller) && present?(action)
@@ -60,7 +61,7 @@ module Vedeu
         storage
 
       else
-        fail Vedeu::MissingRequired,
+        fail Vedeu::Error::MissingRequired,
              'Cannot store action without a controller or name attribute.'
 
       end
@@ -75,7 +76,8 @@ module Vedeu
     # @param controller [Symbol]
     # @param action [Symbol]
     # @param args [void]
-    # @raise [Vedeu::ModelNotFound] When the controller is not registered.
+    # @raise [Vedeu::Error::ModelNotFound] When the controller is not
+    #   registered.
     # @return [void]
     def goto(controller, action, **args)
       Vedeu.log(type:    :debug,
@@ -114,11 +116,12 @@ module Vedeu
       if registered?(controller)
         return true if storage[controller][:actions].include?(action)
 
-        fail Vedeu::ActionNotFound,
+        fail Vedeu::Error::ActionNotFound,
              "#{action} is not registered for #{controller}."
 
       else
-        fail Vedeu::ControllerNotFound, "#{controller} is not registered."
+        fail Vedeu::Error::ControllerNotFound,
+             "#{controller} is not registered."
 
       end
     end
@@ -138,15 +141,15 @@ module Vedeu
     # Fetch the class for the controller by name.
     #
     # @param controller [Symbol]
-    # @raise [Vedeu::MissingRequired] When the given controller name does not
-    #   have a class defined.
+    # @raise [Vedeu::Error::MissingRequired] When the given controller name does
+    #   not have a class defined.
     # @return [String]
     def klass_for(controller)
       if registered?(controller) && klass_defined?(controller)
         storage[controller][:klass]
 
       else
-        fail Vedeu::MissingRequired,
+        fail Vedeu::Error::MissingRequired,
              "Cannot route to #{controller} as no class defined."
 
       end

data/lib/vedeu/templating/helpers.rb

@@ -9,7 +9,7 @@ module Vedeu
       # @param value [String] The HTML/CSS colour.
       # @param block [Proc]
       # @return [Vedeu::Views::Stream]
-      # @raise [Vedeu::InvalidSyntax] The required block was not given.
+      # @raise [Vedeu::Error::InvalidSyntax] The required block was not given.
       def background(value, &block)
         define_stream(background: value, &block)
       end
@@ -20,7 +20,7 @@ module Vedeu
       # @option attributes background [String] The HTML/CSS background colour.
       # @param block [Proc]
       # @return [Vedeu::Views::Stream]
-      # @raise [Vedeu::InvalidSyntax] The required block was not given.
+      # @raise [Vedeu::Error::InvalidSyntax] The required block was not given.
       def colour(attributes = {}, &block)
         define_stream(attributes, &block)
       end
@@ -28,7 +28,7 @@ module Vedeu
       # @param value [String] The HTML/CSS colour.
       # @param block [Proc]
       # @return [Vedeu::Views::Stream]
-      # @raise [Vedeu::InvalidSyntax] The required block was not given.
+      # @raise [Vedeu::Error::InvalidSyntax] The required block was not given.
       def foreground(value, &block)
         define_stream(foreground: value, &block)
       end
@@ -45,11 +45,11 @@ module Vedeu
 
       # @see Vedeu::Templating::Helpers#colour
       def define_stream(attributes = {}, &block)
-        fail Vedeu::InvalidSyntax, 'block not given' unless block_given?
+        fail Vedeu::Error::InvalidSyntax, 'block not given' unless block_given?
 
         encode(
           Vedeu::Views::Stream.build(
-            colour: Vedeu::Colour.new(attributes),
+            colour: Vedeu::Colours::Colour.new(attributes),
             style:  Vedeu::Style.new(attributes[:style]),
             value:  block.call))
       end

data/lib/vedeu/templating/template.rb

@@ -47,15 +47,15 @@ module Vedeu
         File.read(path)
       end
 
-      # @raise [Vedeu::MissingRequired] when the path is empty.
-      # @raise [Vedeu::MissingRequired] when the path does not exist.
+      # @raise [Vedeu::Error::MissingRequired] When the path is empty or does
+      #   not exist.
       # @return [String]
       def path
-        fail Vedeu::MissingRequired,
+        fail Vedeu::Error::MissingRequired,
              'No path to template specified.' if @path.empty?
 
         unless File.exist?(@path)
-          fail Vedeu::MissingRequired,
+          fail Vedeu::Error::MissingRequired,
                "Template file cannot be found. (#{@path})"
         end
 

data/lib/vedeu/templating/view_template.rb

@@ -51,7 +51,7 @@ module Vedeu
       # Return the interface colours if a name option is set, otherwise use the
       # default colours.
       #
-      # @return [Vedeu::Colour|Hash<Symbol => Symbol>]
+      # @return [Vedeu::Colours::Colour|Hash<Symbol => Symbol>]
       def default_colour
         if options[:name]
           interface.colour

data/lib/vedeu/terminal/terminal.rb

@@ -11,10 +11,10 @@ module Vedeu
     # Opens a terminal screen in either `raw` or `cooked` mode. On exit,
     # attempts to restore the screen. See {Vedeu::Terminal#restore_screen}.
     #
-    # @raise [Vedeu::InvalidSyntax] The required block was not given.
+    # @raise [Vedeu::Error::InvalidSyntax] The required block was not given.
     # @return [Array]
     def open
-      fail Vedeu::InvalidSyntax, 'block not given' unless block_given?
+      fail Vedeu::Error::InvalidSyntax, 'block not given' unless block_given?
 
       if raw_mode? || fake_mode?
         console.raw    { initialize_screen(mode) { yield } }

data/lib/vedeu/version.rb

@@ -1,6 +1,6 @@
 module Vedeu
 
   # The current version of Vedeu.
-  VERSION = '0.6.1'
+  VERSION = '0.6.2'
 
 end

data/test/lib/vedeu/application/application_view_test.rb

@@ -43,7 +43,7 @@ module Vedeu
     describe '.render' do
       subject { described.render(params) }
 
-      it { proc { subject }.must_raise(Vedeu::NotImplemented) }
+      it { proc { subject }.must_raise(Vedeu::Error::NotImplemented) }
     end
 
     describe '#render' do

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

@@ -2,124 +2,128 @@ require 'test_helper'
 
 module Vedeu
 
-  describe Background do
+  module Colours
 
-    let(:described) { Vedeu::Background }
-    let(:instance)  { described.new(colour) }
-    let(:colour)    {}
+    describe Background do
 
-    before { Vedeu.background_colours.reset! }
+      let(:described) { Vedeu::Colours::Background }
+      let(:instance)  { described.new(colour) }
+      let(:colour)    {}
 
-    describe '#escape_sequence' do
-      subject { instance.escape_sequence }
+      before { Vedeu.background_colours.reset! }
 
-      context 'when the colour is empty' do
-        let(:colour) { '' }
+      describe '#escape_sequence' do
+        subject { instance.escape_sequence }
 
-        it { subject.must_equal('') }
-      end
+        context 'when the colour is empty' do
+          let(:colour) { '' }
+
+          it { subject.must_equal('') }
+        end
 
-      context 'when the colour is named (3-bit / 8 colours)' do
-        {
-          red:     "\e[41m",
-          yellow:  "\e[43m",
-          magenta: "\e[45m",
-          white:   "\e[107m",
-          default: "\e[49m",
-          unknown: '',
-        }.map do |colour, result|
-          it "returns the correct escape sequence for #{colour}" do
-            described.new(colour).escape_sequence.must_equal(result)
+        context 'when the colour is named (3-bit / 8 colours)' do
+          {
+            red:     "\e[41m",
+            yellow:  "\e[43m",
+            magenta: "\e[45m",
+            white:   "\e[107m",
+            default: "\e[49m",
+            unknown: '',
+          }.map do |colour, result|
+            it "returns the correct escape sequence for #{colour}" do
+              described.new(colour).escape_sequence.must_equal(result)
+            end
           end
         end
-      end
 
-      context 'when the colour is numbered (8-bit / 256 colours)' do
-        {
-          24  => "\e[48;5;24m",
-          56  => "\e[48;5;56m",
-          82  => "\e[48;5;82m",
-          118 => "\e[48;5;118m",
-          143 => "\e[48;5;143m",
-          219 => "\e[48;5;219m",
-          -2  => '',
-          442 => ''
-        }.map do |colour, result|
-          it "returns the correct escape sequence for #{colour}" do
-            described.new(colour).escape_sequence.must_equal(result)
+        context 'when the colour is numbered (8-bit / 256 colours)' do
+          {
+            24  => "\e[48;5;24m",
+            56  => "\e[48;5;56m",
+            82  => "\e[48;5;82m",
+            118 => "\e[48;5;118m",
+            143 => "\e[48;5;143m",
+            219 => "\e[48;5;219m",
+            -2  => '',
+            442 => ''
+          }.map do |colour, result|
+            it "returns the correct escape sequence for #{colour}" do
+              described.new(colour).escape_sequence.must_equal(result)
+            end
           end
         end
-      end
 
-      context 'when the colour is a CSS value (8-bit / 256 colours)' do
-        before { Configuration.stubs(:colour_mode).returns(8) }
-
-        {
-          '#5f0000' => "\e[48;5;52m",
-          '#008700' => "\e[48;5;28m",
-          '#0000d7' => "\e[48;5;20m",
-          '#afafaf' => "\e[48;5;145m",
-          '#afd700' => "\e[48;5;148m",
-          '#af005f' => "\e[48;5;125m",
-          '999999'  => '',
-          '#12121'  => '',
-          '#h11111' => '',
-        }.map do |colour, result|
-          it "returns the correct escape sequence for #{colour}" do
-            described.new(colour).escape_sequence.must_equal(result)
+        context 'when the colour is a CSS value (8-bit / 256 colours)' do
+          before { Vedeu::Configuration.stubs(:colour_mode).returns(8) }
+
+          {
+            '#5f0000' => "\e[48;5;52m",
+            '#008700' => "\e[48;5;28m",
+            '#0000d7' => "\e[48;5;20m",
+            '#afafaf' => "\e[48;5;145m",
+            '#afd700' => "\e[48;5;148m",
+            '#af005f' => "\e[48;5;125m",
+            '999999'  => '',
+            '#12121'  => '',
+            '#h11111' => '',
+          }.map do |colour, result|
+            it "returns the correct escape sequence for #{colour}" do
+              described.new(colour).escape_sequence.must_equal(result)
+            end
           end
         end
-      end
 
-      context 'when the colour is a CSS value (24-bit / 16.8mil colours)' do
-        {
-          '#5f0000' => "\e[48;2;95;0;0m",
-          '#008700' => "\e[48;2;0;135;0m",
-          '#0000d7' => "\e[48;2;0;0;215m",
-          '#afafaf' => "\e[48;2;175;175;175m",
-          '#afd700' => "\e[48;2;175;215;0m",
-          '#af005f' => "\e[48;2;175;0;95m",
-          '999999'  => '',
-          '#12121'  => '',
-          '#h11111' => '',
-        }.map do |colour, result|
-          it "returns the correct escape sequence for #{colour}" do
-            described.new(colour).escape_sequence.must_equal(result)
+        context 'when the colour is a CSS value (24-bit / 16.8mil colours)' do
+          {
+            '#5f0000' => "\e[48;2;95;0;0m",
+            '#008700' => "\e[48;2;0;135;0m",
+            '#0000d7' => "\e[48;2;0;0;215m",
+            '#afafaf' => "\e[48;2;175;175;175m",
+            '#afd700' => "\e[48;2;175;215;0m",
+            '#af005f' => "\e[48;2;175;0;95m",
+            '999999'  => '',
+            '#12121'  => '',
+            '#h11111' => '',
+          }.map do |colour, result|
+            it "returns the correct escape sequence for #{colour}" do
+              described.new(colour).escape_sequence.must_equal(result)
+            end
           end
         end
       end
-    end
 
-    describe '.to_html' do
-      subject { instance.to_html }
+      describe '.to_html' do
+        subject { instance.to_html }
 
-      context 'when the colour is empty' do
-        let(:colour) {}
+        context 'when the colour is empty' do
+          let(:colour) {}
 
-        it { subject.must_equal('') }
-      end
+          it { subject.must_equal('') }
+        end
 
-      context 'when the colour is named (3-bit / 8 colours)' do
-        let(:colour) { :red }
+        context 'when the colour is named (3-bit / 8 colours)' do
+          let(:colour) { :red }
 
-        it { subject.must_equal('') }
-      end
+          it { subject.must_equal('') }
+        end
 
-      context 'when the colour is numbered (8-bit / 256 colours)' do
-        let(:colour) { 118 }
+        context 'when the colour is numbered (8-bit / 256 colours)' do
+          let(:colour) { 118 }
 
-        it { subject.must_equal('') }
-      end
+          it { subject.must_equal('') }
+        end
 
-      context 'when the colour is a CSS value' do
-        let(:colour) { '#afd700' }
+        context 'when the colour is a CSS value' do
+          let(:colour) { '#afd700' }
 
-        it 'returns the colour as a CSS value' do
-          subject.must_equal('#afd700')
+          it 'returns the colour as a CSS value' do
+            subject.must_equal('#afd700')
+          end
         end
       end
-    end
 
-  end # Background
+    end # Background
+
+  end # Colours
 
 end # Vedeu