vedeu 0.4.56 → 0.4.57

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

@@ -4,7 +4,6 @@ module Vedeu
 
     # Renders a {Vedeu::VirtualBuffer} or {Vedeu::Output} as JSON.
     #
-    # @api private
     class JSON < Vedeu::Renderers::File
 
       # Returns a new instance of Vedeu::Renderers::JSON.

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

@@ -4,7 +4,6 @@ module Vedeu
 
     # A renderer which returns nothing.
     #
-    # @api private
     class Null
 
       include Vedeu::RendererOptions

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

@@ -2,7 +2,6 @@ module Vedeu
 
   # Provides shared functionality to Vedeu::Renderer classes.
   #
-  # @api private
   module RendererOptions
 
     # :nocov:

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

@@ -5,7 +5,6 @@ module Vedeu
     # Converts a grid of {Vedeu::Char} objects into a stream of escape sequences
     # and content suitable for a terminal.
     #
-    # @api private
     class Terminal
 
       include Vedeu::RendererOptions

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

@@ -5,7 +5,6 @@ module Vedeu
     # Converts a grid of {Vedeu::Char} objects into a stream of escape sequences
     # and content.
     #
-    # @api private
     class Text
 
       include Vedeu::RendererOptions

data/lib/vedeu/output/style.rb

@@ -9,7 +9,6 @@ module Vedeu
   # Styles are applied as encountered.
   #
   # @see Vedeu::Esc
-  # @api private
   class Style
 
     include Vedeu::Common

data/lib/vedeu/output/text.rb

@@ -2,7 +2,6 @@ module Vedeu
 
   # Present a string (or object responding to `to_s`).
   #
-  # @api private
   class Text
 
     # @see Vedeu::DSL::Text#text

data/lib/vedeu/output/viewport.rb

@@ -6,7 +6,6 @@ module Vedeu
   # the defined width of the interface, the Viewport class provides 'scrolling'
   # via the cursor's position.
   #
-  # @api private
   class Viewport
 
     extend Forwardable

data/lib/vedeu/output/virtual_terminal.rb

@@ -2,7 +2,6 @@ module Vedeu
 
   # Represents a {Vedeu::Terminal} view as a grid of {Vedeu::Cell} objects.
   #
-  # @api private
   class VirtualTerminal
 
     # @!attribute [rw] renderer

data/lib/vedeu/output/wordwrap.rb

@@ -2,7 +2,6 @@ module Vedeu
 
   # Wrap or prune text.
   #
-  # @api private
   class Wordwrap
 
     # @see {Vedeu::Wordwrap#initialize}

data/lib/vedeu/repositories/collection.rb

@@ -3,7 +3,6 @@ module Vedeu
   # Convert an Array into an object which has some meaning in the context it
   # is being used.
   #
-  # @api private
   class Collection
 
     include Enumerable
@@ -98,42 +97,36 @@ module Vedeu
 
   # A collection of {Vedeu::Char} instances.
   #
-  # @api private
   class Chars < Vedeu::Collection
 
   end # Chars
 
   # A collection of {Vedeu::Event} instances.
   #
-  # @api private
   class EventCollection < Vedeu::Collection
 
   end # EventCollection
 
   # A collection of {Vedeu::Interface} instances.
   #
-  # @api private
   class InterfaceCollection < Vedeu::Collection
 
   end # InterfaceCollection
 
   # A collection of {Vedeu::Key} instances.
   #
-  # @api private
   class Keys < Vedeu::Collection
 
   end # Keys
 
   # A collection of {Vedeu::Line} instances.
   #
-  # @api private
   class Lines < Vedeu::Collection
 
   end # Lines
 
   # A collection of {Vedeu::Stream} instances.
   #
-  # @api private
   class Streams < Vedeu::Collection
 
   end # Streams

data/lib/vedeu/repositories/model.rb

@@ -5,7 +5,6 @@ module Vedeu
   # When included into a class, provides the mechanism to store the class in a
   # repository for later retrieval.
   #
-  # @api private
   module Model
 
     include Vedeu::Common

data/lib/vedeu/repositories/registerable.rb

@@ -3,7 +3,6 @@ module Vedeu
   # Repositories contain registerables, this module provides convenience methods
   # for them.
   #
-  # @api private
   module Registerable
 
     # These class methods are mixed into the repository.

data/lib/vedeu/repositories/repository.rb

@@ -9,7 +9,6 @@ module Vedeu
   #
   #   { 'models' => [Model] }
   #
-  # @api private
   class Repository
 
     include Vedeu::Common

data/lib/vedeu/repositories/store.rb

@@ -2,7 +2,6 @@ module Vedeu
 
   # Provides generic repository related behaviour.
   #
-  # @api private
   module Store
 
     include Enumerable

data/lib/vedeu/templating/directive.rb

@@ -1,10 +1,10 @@
 module Vedeu
 
+  # Provides means to use templates with Vedeu.
   module Templating
 
     # Converts a directive found in a template into a Vedeu::Stream object.
     #
-    # @api private
     class Directive
 
       include Vedeu::Templating::Helpers

data/lib/vedeu/templating/helpers.rb

@@ -1,10 +1,10 @@
 module Vedeu
 
+  # Provides means to use templates with Vedeu.
   module Templating
 
     # Provide helpers to be used with your Vedeu templates.
     #
-    # @api private
     module Helpers
 
       # @example

data/lib/vedeu/templating/preprocessor.rb

@@ -1,5 +1,6 @@
 module Vedeu
 
+  # Provides means to use templates with Vedeu.
   module Templating
 
     # preprocess
@@ -15,7 +16,6 @@ module Vedeu
     # Pre-processes a template, to convert all lines and lines with directives
     # into Vedeu::Streams.
     #
-    # @api private
     class Preprocessor
 
       # @param lines [Array<String>]

data/lib/vedeu/templating/template.rb

@@ -2,11 +2,11 @@ require 'vedeu/templating/preprocessor'
 
 module Vedeu
 
+  # Provides means to use templates with Vedeu.
   module Templating
 
     # Generic class to loading a template and parsing it via ERb.
     #
-    # @api private
     class Template
 
       # @param (see Vedeu::Templating::Template#new)

data/lib/vedeu/traps.rb

@@ -2,7 +2,6 @@ module Vedeu
 
   # Vedeu can respond to various signals which are handled here.
   #
-  # @api private
   module Traps
 
     # :nocov:

data/lib/vedeu/version.rb

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

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

@@ -14,7 +14,14 @@ module Vedeu
     let(:instance)  { described.new }
 
     context 'ClassMethods' do
-      # @todo
+      let(:_name) { :vedeu_controller_test }
+
+      subject { ControllerTestClass.controller_name(_name) }
+
+      it {
+        Vedeu.expects(:bind).with(:show_vedeu_controller_test)
+        subject
+      }
     end
 
   end # Controller

data/test/lib/vedeu/buffers/buffer_test.rb

@@ -161,6 +161,11 @@ module Vedeu
 
       subject { instance.render }
 
+      it {
+        Vedeu::Output.expects(:render)
+        subject
+      }
+
       # @todo
       # it { skip }
       # it { subject.must_be_instance_of(Array) }

data/test/lib/vedeu/cursor/reposition_test.rb

@@ -27,17 +27,13 @@ module Vedeu
     end
 
     describe '.to' do
-      it { described.must_respond_to(:to) }
-    end
-
-    describe '#to' do
       # let(:new_entity) { Vedeu::Cursor.new(name: _name, y: 8, x: 5, oy: 7, ox: 4) }
 
       # before do
       #   entity.stubs(:new).returns(new_entity)
       # end
 
-      subject { instance.to }
+      subject { described.to(entity, _name, y, x) }
 
       it { subject.must_be_instance_of(entity) }
 
@@ -62,6 +58,10 @@ module Vedeu
       it { subject.oy.must_equal(7) }
     end
 
+    describe '#to' do
+      it { instance.must_respond_to(:to) }
+    end
+
   end # Reposition
 
 end # Vedeu

data/test/lib/vedeu/models/group_test.rb

@@ -10,12 +10,13 @@ module Vedeu
       {
         name:       _name,
         members:    members,
-        repository: Vedeu.groups,
+        repository: repository,
         visible:    visible,
       }
     }
     let(:_name)      { 'organics' }
-    let(:members)    { ['carbon', 'nitrogen', 'oxygen'] }
+    let(:members)    { Set.new(['carbon', 'nitrogen', 'oxygen']) }
+    let(:repository) { Vedeu.groups }
     let(:visible)    { true }
 
     describe '#initialize' do
@@ -26,7 +27,7 @@ module Vedeu
       it { instance.instance_variable_get('@members').must_equal(members) }
       it { instance.instance_variable_get('@name').must_equal(_name) }
       it {
-        instance.instance_variable_get('@repository').must_equal(Vedeu.groups)
+        instance.instance_variable_get('@repository').must_equal(repository)
       }
       it { instance.instance_variable_get('@visible').must_equal(visible) }
     end

data/test/lib/vedeu/models/interface_test.rb

@@ -73,6 +73,13 @@ module Vedeu
       it { instance.must_respond_to(:add) }
     end
 
+    describe '#hide' do
+      subject { instance.hide }
+
+      # @todo
+      # it { skip }
+    end
+
     describe '#inspect' do
       subject { instance.inspect }
 
@@ -143,7 +150,7 @@ module Vedeu
           subject
         }
 
-        it { subject.must_equal([:clear, :border, :view]) }
+        it { subject.must_equal([:clear, :view, :border]) }
       end
 
       context 'when the interface is not visible' do
@@ -153,6 +160,13 @@ module Vedeu
       end
     end
 
+    describe '#show' do
+      subject { instance.show }
+
+      # @todo
+      # it { skip }
+    end
+
     describe '#store' do
       subject { instance.store }
 

data/test/lib/vedeu/null/interface_test.rb

@@ -29,45 +29,31 @@ module Vedeu
       end
 
       describe '#hide' do
-        subject { instance.hide }
-
-        it { subject.must_be_instance_of(NilClass) }
+        it { instance.hide.must_be_instance_of(NilClass) }
       end
 
       describe '#null?' do
-        subject { instance.null? }
-
-        it { subject.must_be_instance_of(TrueClass) }
+        it { instance.null?.must_be_instance_of(TrueClass) }
       end
 
       describe '#parent' do
-        subject { instance.parent }
-
-        it { subject.must_be_instance_of(NilClass) }
+        it { instance.parent.must_be_instance_of(NilClass) }
       end
 
       describe '#show' do
-        subject { instance.show }
-
-        it { subject.must_be_instance_of(NilClass) }
+        it { instance.show.must_be_instance_of(NilClass) }
       end
 
       describe '#store' do
-        subject { instance.store }
-
-        it { subject.must_be_instance_of(Vedeu::Null::Interface) }
+        it { instance.store.must_be_instance_of(Vedeu::Null::Interface) }
       end
 
       describe '#toggle' do
-        subject { instance.toggle }
-
-        it { subject.must_be_instance_of(NilClass) }
+        it { instance.toggle.must_be_instance_of(NilClass) }
       end
 
       describe '#visible?' do
-        subject { instance.visible? }
-
-        it { subject.must_be_instance_of(FalseClass) }
+        it { instance.visible?.must_be_instance_of(FalseClass) }
       end
 
       describe '#visible=' do

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

@@ -8,14 +8,24 @@ module Vedeu
 
     before { Vedeu::Terminal.stubs(:size).returns([80, 25]) }
 
-    describe 'alias methods' do
-      it { described.must_respond_to(:foreground_codes) }
-    end
-
-    describe 'colours defined via define_method' do
-      it 'returns an escape sequence for the foreground colour' do
-        described.magenta.must_equal("\e[35m")
-      end
+    describe 'foreground colour methods' do
+      it { described.black.must_equal("\e[30m") }
+      it { described.red.must_equal("\e[31m") }
+      it { described.green.must_equal("\e[32m") }
+      it { described.yellow.must_equal("\e[33m") }
+      it { described.blue.must_equal("\e[34m") }
+      it { described.magenta.must_equal("\e[35m") }
+      it { described.cyan.must_equal("\e[36m") }
+      it { described.light_grey.must_equal("\e[37m") }
+      it { described.default.must_equal("\e[39m") }
+      it { described.dark_grey.must_equal("\e[90m") }
+      it { described.light_red.must_equal("\e[91m") }
+      it { described.light_green.must_equal("\e[92m") }
+      it { described.light_yellow.must_equal("\e[93m") }
+      it { described.light_blue.must_equal("\e[94m") }
+      it { described.light_magenta.must_equal("\e[95m") }
+      it { described.light_cyan.must_equal("\e[96m") }
+      it { described.white.must_equal("\e[97m") }
 
       it 'returns an escape sequence for the foreground colour and resets ' \
          'after calling the block' do
@@ -23,10 +33,35 @@ module Vedeu
           'ununpentium'
         end.must_equal("\e[36mununpentium\e[39m")
       end
+    end
 
-      it 'returns an escape sequence for the background colour' do
-        described.on_yellow.must_equal("\e[43m")
-      end
+    describe '.codes' do
+      it { described.codes.must_be_instance_of(Hash) }
+      it { described.must_respond_to(:foreground_codes) }
+    end
+
+    describe '.background_codes' do
+      it { described.background_codes.must_be_instance_of(Hash) }
+    end
+
+    describe 'background colour methods' do
+      it { described.on_black.must_equal("\e[40m") }
+      it { described.on_red.must_equal("\e[41m") }
+      it { described.on_green.must_equal("\e[42m") }
+      it { described.on_yellow.must_equal("\e[43m") }
+      it { described.on_blue.must_equal("\e[44m") }
+      it { described.on_magenta.must_equal("\e[45m") }
+      it { described.on_cyan.must_equal("\e[46m") }
+      it { described.on_light_grey.must_equal("\e[47m") }
+      it { described.on_default.must_equal("\e[49m") }
+      it { described.on_dark_grey.must_equal("\e[100m") }
+      it { described.on_light_red.must_equal("\e[101m") }
+      it { described.on_light_green.must_equal("\e[102m") }
+      it { described.on_light_yellow.must_equal("\e[103m") }
+      it { described.on_light_blue.must_equal("\e[104m") }
+      it { described.on_light_magenta.must_equal("\e[105m") }
+      it { described.on_light_cyan.must_equal("\e[106m") }
+      it { described.on_white.must_equal("\e[107m") }
 
       it 'returns an escape sequence for the background colour and resets ' \
          'after calling the block' do
@@ -36,6 +71,30 @@ module Vedeu
       end
     end
 
+    describe 'action methods' do
+      it { described.hide_cursor.must_equal("\e[?25l") }
+      it { described.show_cursor.must_equal("\e[?25h") }
+      it { described.cursor_position.must_equal("\e[6n") }
+      it { described.bg_reset.must_equal("\e[49m") }
+      it { described.blink.must_equal("\e[5m") }
+      it { described.blink_off.must_equal("\e[25m") }
+      it { described.bold.must_equal("\e[1m") }
+      it { described.bold_off.must_equal("\e[22m") }
+      it { described.border_on.must_equal("\e(0") }
+      it { described.border_off.must_equal("\e(B") }
+      it { described.dim.must_equal("\e[2m") }
+      it { described.fg_reset.must_equal("\e[39m") }
+      it { described.negative.must_equal("\e[7m") }
+      it { described.positive.must_equal("\e[27m") }
+      it { described.reset.must_equal("\e[0m") }
+      it { described.underline.must_equal("\e[4m") }
+      it { described.underline_off.must_equal("\e[24m") }
+    end
+
+    describe '.actions' do
+      it { described.actions.must_be_instance_of(Hash) }
+    end
+
     describe '.escape' do
       let(:stream) { "\e[0m\e[38;2;39m\e[48;2;49m\e[2J\e[?25l" }
 
@@ -54,108 +113,45 @@ module Vedeu
       end
     end
 
-    describe '.hide_cursor' do
-      subject { described.hide_cursor }
-
-      it { subject.must_be_instance_of(String) }
-      it { subject.must_equal("\e[?25l") }
-    end
-
-    describe '.show_cursor' do
-      subject { described.show_cursor }
-
-      it { subject.must_be_instance_of(String) }
-      it { subject.must_equal("\e[?25h") }
-    end
-
-    describe '.string' do
-      it 'returns an empty string when the style is not provided' do
-        described.string.must_equal('')
-      end
-
-      it 'returns an escape sequence when the style is bg_reset' do
-        described.string('bg_reset').must_equal("\e[49m")
-      end
-
-      it 'returns an escape sequence when the style is blink' do
-        described.string('blink').must_equal("\e[5m")
-      end
-
-      it 'returns an escape sequence when the style is blink off' do
-        described.string('blink_off').must_equal("\e[25m")
-      end
-
-      it 'returns an escape sequence when the style is bold' do
-        described.string('bold').must_equal("\e[1m")
+    describe '.border' do
+      context 'when the block is given' do
+        it { described.border { 'b' }.must_equal("\e(0b\e(B") }
       end
 
-      it 'returns an escape sequence when the style is bold off' do
-        described.string('bold_off').must_equal("\e[22m")
-      end
-
-      it 'returns an escape sequence when the style is clear' do
-        described.string('clear').must_equal("\e[39m\e[49m\e[2J")
-      end
-
-      it 'returns an escape sequence when the style is clear_line' do
-        described.string('clear_line').must_equal("\e[39m\e[49m\e[2K")
-      end
-
-      it 'returns an escape sequence when the style is colour_reset' do
-        described.string('colour_reset').must_equal("\e[39m\e[49m")
-      end
-
-      it 'returns an escape sequence when the style is fg_reset' do
-        described.string('fg_reset').must_equal("\e[39m")
-      end
-
-      it 'returns an escape sequence when the style is hide_cursor' do
-        described.string('hide_cursor').must_equal("\e[?25l")
-      end
-
-      it 'returns an escape sequence when the style is screen_init' do
-        described.string('screen_init').must_equal("\e[0m\e[39m\e[49m\e[2J\e[?25l")
-      end
-
-      it 'returns an escape sequence when the style is screen_exit' do
-        described.string('screen_exit')
-          .must_equal("\e[?25h\e[39m\e[49m\e[0m\e[80;25H\n")
-      end
-
-      it 'returns an escape sequence when the style is negative' do
-        described.string('negative').must_equal("\e[7m")
-      end
-
-      it 'returns an escape sequence when the style is positive' do
-        described.string('positive').must_equal("\e[27m")
-      end
-
-      it 'returns an escape sequence when the style is reset' do
-        described.string('reset').must_equal("\e[0m")
-      end
-
-      it 'returns an escape sequence when the style is normal' do
-        described.string('normal').must_equal("\e[24m\e[22m\e[27m")
-      end
-
-      it 'returns an escape sequence when the style is dim' do
-        described.string('dim').must_equal("\e[2m")
-      end
-
-      it 'returns an escape sequence when the style is show_cursor' do
-        described.string('show_cursor').must_equal("\e[?25h")
-      end
-
-      it 'returns an escape sequence when the style is underline' do
-        described.string('underline').must_equal("\e[4m")
-      end
-
-      it 'returns an escape sequence when the style is underline off' do
-        described.string('underline_off').must_equal("\e[24m")
+      context 'when the block is not given' do
+        it { described.border.must_equal('') }
       end
+    end
 
-      it 'returns an escape sequence when the style is underline off' do
-        described.string('cursor_position').must_equal("\e[6n")
+    describe '.string' do
+      context 'when the style is not provided' do
+        it { described.string.must_equal('') }
+      end
+
+      context 'when the style is provided' do
+        it { described.string('bg_reset').must_equal("\e[49m") }
+        it { described.string('blink').must_equal("\e[5m") }
+        it { described.string('blink_off').must_equal("\e[25m") }
+        it { described.string('bold').must_equal("\e[1m") }
+        it { described.string('bold_off').must_equal("\e[22m") }
+        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('fg_reset').must_equal("\e[39m") }
+        it { described.string('hide_cursor').must_equal("\e[?25l") }
+        it { described.string('screen_init').
+               must_equal("\e[0m\e[39m\e[49m\e[2J\e[?25l") }
+        it { described.string('screen_exit').
+               must_equal("\e[?25h\e[39m\e[49m\e[0m\e[80;25H\n") }
+        it { described.string('negative').must_equal("\e[7m") }
+        it { described.string('positive').must_equal("\e[27m") }
+        it { described.string('reset').must_equal("\e[0m") }
+        it { described.string('normal').must_equal("\e[24m\e[22m\e[27m") }
+        it { described.string('dim').must_equal("\e[2m") }
+        it { described.string('show_cursor').must_equal("\e[?25h") }
+        it { described.string('underline').must_equal("\e[4m") }
+        it { described.string('underline_off').must_equal("\e[24m") }
+        it { described.string('cursor_position').must_equal("\e[6n") }
       end
     end