vedeu 0.6.10 → 0.6.11

data/lib/vedeu/terminal/mode.rb

@@ -8,8 +8,8 @@ module Vedeu
 
       extend self
 
-      # Returns a boolean indicating whether the terminal is currently in
-      # `cooked` mode.
+      # Returns a boolean indicating whether the terminal is currently
+      # in `cooked` mode.
       #
       # @return [Boolean]
       def cooked_mode?
@@ -23,8 +23,8 @@ module Vedeu
         @mode = :cooked
       end
 
-      # Returns a boolean indicating whether the terminal is currently in `fake`
-      # mode.
+      # Returns a boolean indicating whether the terminal is currently
+      # in `fake` mode.
       #
       # @return [Boolean]
       def fake_mode?
@@ -38,8 +38,8 @@ module Vedeu
         @mode = :fake
       end
 
-      # Returns a boolean indicating whether the terminal is currently in `raw`
-      # mode.
+      # Returns a boolean indicating whether the terminal is currently
+      # in `raw` mode.
       #
       # @return [Boolean]
       def raw_mode?
@@ -53,8 +53,8 @@ module Vedeu
         @mode = :raw
       end
 
-      # Toggles the terminal's mode between `cooked`, `fake` and `raw`,
-      # depending on its current mode.
+      # Toggles the terminal's mode between `cooked`, `fake` and
+      # `raw`, depending on its current mode.
       #
       # @return [Symbol]
       def switch_mode!
@@ -64,8 +64,9 @@ module Vedeu
         raw_mode!
       end
 
-      # Returns the mode of the terminal, either `:cooked`, `:fake` or `:raw`.
-      # Can change throughout the lifespan of the client application.
+      # Returns the mode of the terminal, either `:cooked`, `:fake` or
+      # `:raw`. Can change throughout the lifespan of the client
+      # application.
       #
       # @return [Symbol]
       def mode

data/lib/vedeu/terminal/terminal.rb

@@ -1,17 +1,19 @@
 module Vedeu
 
-  # This module is the direct interface between Vedeu and your terminal/
-  # console, via Ruby's IO core library.
+  # This module is the direct interface between Vedeu and your
+  # terminal/ console, via Ruby's IO core library.
   #
   module Terminal
 
     include Vedeu::Terminal::Mode
     extend self
 
-    # Opens a terminal screen in either `raw` or `cooked` mode. On exit,
-    # attempts to restore the screen. See {Vedeu::Terminal#restore_screen}.
+    # Opens a terminal screen in either `raw` or `cooked` mode. On
+    # exit, attempts to restore the screen. See
+    # {Vedeu::Terminal#restore_screen}.
     #
-    # @raise [Vedeu::Error::InvalidSyntax] The required block was not given.
+    # @raise [Vedeu::Error::InvalidSyntax] The required block was not
+    #   given.
     # @return [Array]
     def open
       fail Vedeu::Error::InvalidSyntax, 'block not given' unless block_given?
@@ -27,8 +29,8 @@ module Vedeu
       restore_screen
     end
 
-    # Takes input from the user via the keyboard. Accepts special keys like
-    # the F-Keys etc, by capturing the entire sequence.
+    # Takes input from the user via the keyboard. Accepts special keys
+    # like the F-Keys etc, by capturing the entire sequence.
     #
     # @return [String]
     def input
@@ -53,9 +55,10 @@ module Vedeu
     end
     alias_method :write, :output
 
-    # When the terminal emit the 'SIGWINCH' signal, Vedeu can intercept this
-    # and attempt to redraw the current interface with varying degrees of
-    # success. Can also be used to simulate a terminal resize.
+    # When the terminal emit the 'SIGWINCH' signal, Vedeu can
+    # intercept this and attempt to redraw the current interface with
+    # varying degrees of success. Can also be used to simulate a
+    # terminal resize.
     #
     # @example
     #   Vedeu.resize
@@ -74,7 +77,7 @@ module Vedeu
     def initialize_screen(mode)
       Vedeu.log(type: :info, message: "Terminal entering '#{mode}' mode")
 
-      output(Esc.string('screen_init'))
+      output(Vedeu::EscapeSequences::Esc.string('screen_init'))
 
       yield if block_given?
     end
@@ -86,55 +89,53 @@ module Vedeu
     #
     # @return [String]
     def clear
-      virtual.clear if Vedeu::Configuration.drb?
-
-      output(Esc.string('clear'))
+      output(Vedeu::EscapeSequences::Esc.string('clear'))
     end
 
-    # Attempts to tidy up the screen just before the application terminates.
-    # The cursor is shown, colours are reset to terminal defaults, the
-    # terminal is told to reset, and finally we clear the last line ready for
-    # the prompt.
+    # Attempts to tidy up the screen just before the application
+    # terminates. The cursor is shown, colours are reset to terminal
+    # defaults, the terminal is told to reset, and finally we clear
+    # the last line ready for the prompt.
     #
     # @return [String]
     def restore_screen
-      output(Esc.string('screen_exit'))
+      output(Vedeu::EscapeSequences::Esc.string('screen_exit'))
     end
 
-    # Sets the cursor to be visible unless in raw mode, whereby it will be left
-    # hidden.
+    # Sets the cursor to be visible unless in raw mode, whereby it
+    # will be left hidden.
     #
     # @return [String]
     def set_cursor_mode
-      output(Esc.string('show_cursor')) unless raw_mode?
+      output(Vedeu::EscapeSequences::Esc.string('show_cursor')) unless raw_mode?
     end
 
-    # Returns a coordinate tuple of the format [y, x], where `y` is the row/line
-    # and `x` is the column/character.
+    # Returns a coordinate tuple of the format [y, x], where `y` is
+    # the row/line and `x` is the column/character.
     #
     # @return [Array]
     def centre
       [(height / 2), (width / 2)]
     end
 
-    # Returns the `y` (row/line) component of the coordinate tuple provided by
-    # {Vedeu::Terminal.centre}
+    # Returns the `y` (row/line) component of the coordinate tuple
+    # provided by {Vedeu::Terminal.centre}
     #
     # @return [Fixnum]
     def centre_y
       centre[0]
     end
 
-    # Returns the `x` (column/character) component of the coodinate tuple
-    # provided by {Vedeu::Terminal.centre}
+    # Returns the `x` (column/character) component of the coodinate
+    # tuple provided by {Vedeu::Terminal.centre}
     #
     # @return [Fixnum]
     def centre_x
       centre[-1]
     end
 
-    # Returns 1. This 1 is either the top-most or left-most coordinate of the
-    # terminal.
+    # Returns 1. This 1 is either the top-most or left-most coordinate
+    # of the terminal.
     #
     # @return [Fixnum]
     def origin
@@ -145,8 +146,8 @@ module Vedeu
     alias_method :tx, :origin
     alias_method :ty, :origin
 
-    # Returns the total width (number of columns/characters) of the current
-    # terminal.
+    # Returns the total width (number of columns/characters) of the
+    # current terminal.
     #
     # @example
     #   Vedeu.width # => provides the width via the Vedeu API.
@@ -160,7 +161,8 @@ module Vedeu
     alias_method :xn, :width
     alias_method :txn, :width
 
-    # Returns the total height (number of rows/lines) of the current terminal.
+    # Returns the total height (number of rows/lines) of the current
+    # terminal.
     #
     # @example
     #   Vedeu.height # => provides the height via the Vedeu API.
@@ -174,21 +176,23 @@ module Vedeu
     alias_method :yn, :height
     alias_method :tyn, :height
 
-    # Returns a tuple containing the height and width of the current terminal.
+    # Returns a tuple containing the height and width of the current
+    # terminal.
     #
     # @note
-    #   If the terminal is a odd number of characters in height or width, then
-    #   1 is deducted from the dimension to make it even. For example; the
-    #   actual terminal is height: 37, width: 145, then the reported size will
-    #   be 36, 144 respectively.
+    #   If the terminal is a odd number of characters in height or
+    #   width, then 1 is deducted from the dimension to make it even.
+    #   For example; the actual terminal is height: 37, width: 145,
+    #   then the reported size will be 36, 144 respectively.
     #
-    #   This is done to make it easier for client applications to divide the
-    #   terminal space up when defining interfaces or views, leading to more
-    #   consistent rendering.
+    #   This is done to make it easier for client applications to
+    #   divide the terminal space up when defining interfaces or
+    #   views, leading to more consistent rendering.
     #
-    #   If the client application is using the {Vedeu::Geometry::Grid#rows} or
-    #   {Vedeu::Geometry::Grid#columns} helpers, the dimensions are made more
-    #   consistent using this approach.
+    #   If the client application is using the
+    #   {Vedeu::Geometry::Grid#rows} or
+    #   {Vedeu::Geometry::Grid#columns} helpers, the dimensions are
+    #   made more consistent using this approach.
     #
     # @return [Array]
     def size
@@ -200,7 +204,8 @@ module Vedeu
       [h, w]
     end
 
-    # Provides our gateway into the wonderful rainbow-filled world of IO.
+    # Provides our gateway into the wonderful rainbow-filled world of
+    # IO.
     #
     # @return [File]
     def console

data/lib/vedeu/version.rb

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

data/test/lib/vedeu/cursors/cursor_test.rb

@@ -75,7 +75,8 @@ module Vedeu
       describe '#hide' do
         let(:visible)     { true }
         let(:hide_cursor) {
-          Vedeu::Models::Escape.new(value: Vedeu::Esc.hide_cursor)
+          Vedeu::Models::Escape
+            .new(value: Vedeu::EscapeSequences::Esc.hide_cursor)
         }
 
         before do
@@ -201,7 +202,8 @@ module Vedeu
       describe '#show' do
         let(:visible) { false }
         let(:show_cursor) {
-          Vedeu::Models::Escape.new(value: Vedeu::Esc.show_cursor)
+          Vedeu::Models::Escape
+            .new(value: Vedeu::EscapeSequences::Esc.show_cursor)
         }
 
         before do

data/test/lib/vedeu/editor/cursor_test.rb

@@ -31,9 +31,6 @@ module Vedeu
 
       describe '#initialize' do
         it { instance.must_be_instance_of(described) }
-        it {
-          instance.instance_variable_get('@attributes').must_equal(attributes)
-        }
         it { instance.instance_variable_get('@y').must_equal(y) }
         it { instance.instance_variable_get('@x').must_equal(x) }
         it { instance.instance_variable_get('@by').must_equal(by) }

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

@@ -2,75 +2,79 @@ require 'test_helper'
 
 module Vedeu
 
-  describe Esc do
+  module EscapeSequences
 
-    let(:described) { Vedeu::Esc }
+    describe Esc do
 
-    describe '.escape' do
-      let(:stream) { "\e[0m\e[38;2;39m\e[48;2;49m\e[2J\e[?25l" }
+      let(:described) { Vedeu::EscapeSequences::Esc }
 
-      subject { described.escape(stream) }
+      describe '.escape' do
+        let(:stream) { "\e[0m\e[38;2;39m\e[48;2;49m\e[2J\e[?25l" }
 
-      it { subject.must_be_instance_of(String) }
+        subject { described.escape(stream) }
 
-      it 'escapes the escape sequences' do
-        subject.must_equal('\e[0m\e[38;2;39m\e[48;2;49m\e[2J\e[?25l')
-      end
+        it { subject.must_be_instance_of(String) }
 
-      context 'when a stream is not given' do
-        let(:stream) { '' }
+        it 'escapes the escape sequences' do
+          subject.must_equal('\e[0m\e[38;2;39m\e[48;2;49m\e[2J\e[?25l')
+        end
 
-        it { subject.must_equal('') }
-      end
-    end
+        context 'when a stream is not given' do
+          let(:stream) { '' }
 
-    describe '.border' do
-      context 'when the block is given' do
-        it { described.border { 'b' }.must_equal("\e(0b\e(B") }
+          it { subject.must_equal('') }
+        end
       end
 
-      context 'when the block is not given' do
-        it { described.border.must_equal('') }
-      end
-    end
+      describe '.border' do
+        context 'when the block is given' do
+          it { described.border { 'b' }.must_equal("\e(0b\e(B") }
+        end
 
-    describe '.string' do
-      context 'when the style is not provided' do
-        it { described.string.must_equal('') }
+        context 'when the block is not given' do
+          it { described.border.must_equal('') }
+        end
       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('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") }
+      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('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
+
+        context 'screen_exit' do
+          before { Vedeu::Terminal.stubs(:size).returns([80, 25]) }
+
+          it { described.string('screen_exit').
+                 must_equal("\e[?25h\e[39m\e[49m\e[0m\e[80;25H\n") }
+        end
       end
 
-      context 'screen_exit' do
-        before { Vedeu::Terminal.stubs(:size).returns([80, 25]) }
-
-        it { described.string('screen_exit').
-               must_equal("\e[?25h\e[39m\e[49m\e[0m\e[80;25H\n") }
-      end
-    end
+    end # Esc
 
-  end # Esc
+  end # EscapeSequences
 
 end # Vedeu

data/test/lib/vedeu/events/collection_test.rb

@@ -9,7 +9,7 @@ module Vedeu
       let(:described) { Vedeu::Events::Collection }
       let(:instance)  { described.new }
 
-      it { described.superclass.must_equal(Vedeu::Collection) }
+      it { described.superclass.must_equal(Vedeu::Repositories::Collection) }
 
       describe '#initialize' do
         it { instance.must_be_instance_of(described) }

data/test/lib/vedeu/input/keys_test.rb

@@ -9,7 +9,7 @@ module Vedeu
       let(:described) { Vedeu::Input::Keys }
       let(:instance)  { described.new }
 
-      it { described.superclass.must_equal(Vedeu::Collection) }
+      it { described.superclass.must_equal(Vedeu::Repositories::Collection) }
 
       describe '#initialize' do
         it { instance.must_be_instance_of(described) }

data/test/lib/vedeu/input/mapper_test.rb

@@ -23,7 +23,7 @@ module Vedeu
         end
 
         context 'when the repository is provided' do
-          let(:repository) { Vedeu::Repository.new }
+          let(:repository) { Vedeu::Repositories::Repository.new }
 
           it do
             instance.instance_variable_get('@repository').must_equal(repository)

data/test/lib/vedeu/models/views/collections/chars_test.rb

@@ -9,7 +9,7 @@ module Vedeu
       let(:described) { Vedeu::Views::Chars }
       let(:instance)  { described.new }
 
-      it { described.superclass.must_equal(Vedeu::Collection) }
+      it { described.superclass.must_equal(Vedeu::Repositories::Collection) }
 
       describe '#initialize' do
         it { instance.must_be_instance_of(described) }

data/test/lib/vedeu/models/views/collections/lines_test.rb

@@ -9,7 +9,7 @@ module Vedeu
       let(:described) { Vedeu::Views::Lines }
       let(:instance)  { described.new }
 
-      it { described.superclass.must_equal(Vedeu::Collection) }
+      it { described.superclass.must_equal(Vedeu::Repositories::Collection) }
 
       describe '#initialize' do
         it { instance.must_be_instance_of(described) }

data/test/lib/vedeu/models/views/collections/streams_test.rb

@@ -9,7 +9,7 @@ module Vedeu
       let(:described) { Vedeu::Views::Streams }
       let(:instance)  { described.new }
 
-      it { described.superclass.must_equal(Vedeu::Collection) }
+      it { described.superclass.must_equal(Vedeu::Repositories::Collection) }
 
       describe '#initialize' do
         it { instance.must_be_instance_of(described) }

data/test/lib/vedeu/models/views/collections/view_collection_test.rb

@@ -9,7 +9,7 @@ module Vedeu
       let(:described) { Vedeu::Views::ViewCollection }
       let(:instance)  { described.new }
 
-      it { described.superclass.must_equal(Vedeu::Collection) }
+      it { described.superclass.must_equal(Vedeu::Repositories::Collection) }
 
       describe '#initialize' do
         it { instance.must_be_instance_of(described) }

data/test/lib/vedeu/output/refresh/refresh_group_test.rb

@@ -0,0 +1,43 @@
+require 'test_helper'
+
+module Vedeu
+
+  module Output
+
+    describe RefreshGroup do
+
+      let(:described) { Vedeu::Output::RefreshGroup }
+      let(:instance)  { described.new(_name) }
+      let(:_name)     { 'Vedeu::Output::RefreshGroup' }
+
+      describe '#initialize' do
+        it { instance.must_be_instance_of(described) }
+        it { instance.instance_variable_get('@name').must_equal(_name) }
+      end
+
+      describe '.by_name' do
+        subject { described.by_name(_name) }
+
+        context 'when the name is not present' do
+          let(:_name) { '' }
+
+          it { proc { subject }.must_raise(Vedeu::Error::MissingRequired) }
+        end
+
+        context 'when the name is present' do
+          it {
+            Vedeu::Output::RefreshGroup.expects(:by_name).with(_name)
+            subject
+          }
+        end
+      end
+
+      describe '#by_name' do
+        it { instance.must_respond_to(:by_name) }
+      end
+
+    end # RefreshGroup
+
+  end # Output
+
+end # Vedeu

data/test/lib/vedeu/output/refresh/refresh_test.rb

@@ -0,0 +1,50 @@
+require 'test_helper'
+
+module Vedeu
+
+  module Output
+
+    describe Refresh do
+
+      let(:described) { Vedeu::Output::Refresh }
+      let(:instance)  { described.new }
+
+      describe '.all' do
+        before { Vedeu.stubs(:trigger) }
+
+        subject { described.all }
+
+        it { subject.must_be_instance_of(Array) }
+
+        context 'when there are no registered interfaces' do
+          before { Vedeu.interfaces.reset }
+
+          it { subject.must_equal([]) }
+        end
+
+        context 'when there are registered interfaces' do
+          let(:interface)  {
+            Vedeu::Models::Interface.new(name: 'Vedeu::Output::Refresh')
+          }
+          let(:interfaces) { [interface] }
+
+          before { Vedeu.interfaces.stubs(:zindexed).returns(interfaces) }
+
+          it {
+            Vedeu.expects(:trigger).with(:_refresh_, 'Vedeu::Output::Refresh')
+            subject
+          }
+
+          it { subject.must_equal([interface]) }
+        end
+      end
+
+      describe '#all' do
+        it { instance.must_respond_to(:all) }
+      end
+
+    end # Refresh
+
+  end # Output
+
+end # Vedeu

data/test/lib/vedeu/output/renderers/renderer_options_test.rb

@@ -2,11 +2,15 @@ require 'test_helper'
 
 module Vedeu
 
-  describe RendererOptions do
+  module Renderers
 
-    # @todo Add more tests.
-    # it { skip }
+    describe RendererOptions do
 
-  end # RendererOptions
+      # @todo Add more tests.
+      # it { skip }
+
+    end # RendererOptions
+
+  end # Renderers
 
 end # Vedeu

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

@@ -73,7 +73,8 @@ module Vedeu
 
       context 'when there is content' do
         let(:output) {
-          Vedeu::Models::Escape.new(value: Vedeu::Esc.hide_cursor)
+          Vedeu::Models::Escape
+            .new(value: Vedeu::EscapeSequences::Esc.hide_cursor)
         }
 
         it { subject.must_be_instance_of(Vedeu::Models::Escape) }