vedeu 0.6.12 → 0.6.13

data/lib/vedeu/geometry/geometry.rb

@@ -2,12 +2,13 @@ module Vedeu
 
   module Geometry
 
-    # @todo Consider storing the Terminal size at the time of first creation,
-    # this allows us to return the interface to its original dimensions if
-    # the terminal resizes back to normal size.
+    # @todo Consider storing the Terminal size at the time of first
+    # creation, this allows us to return the interface to its original
+    # dimensions if the terminal resizes back to normal size.
     #
-    # Calculates and provides interface geometry determined by both the client's
-    # requirements and the terminal's current viewing area.
+    # Calculates and provides interface geometry determined by both
+    # the client's requirements and the terminal's current viewing
+    # area.
     #
     class Geometry
 
@@ -93,8 +94,8 @@ module Vedeu
         end
       end
 
-      # Will maximise the named interface geometry. This means it will occupy
-      # all of the available space on the terminal window.
+      # Will maximise the named interface geometry. This means it will
+      # occupy all of the available space on the terminal window.
       #
       # @example
       #   Vedeu.trigger(:_maximise_, name)
@@ -226,10 +227,11 @@ module Vedeu
         Vedeu::Geometry::Geometry.new(@attributes).store
       end
 
-      # Will unmaximise the named interface geometry. Previously, when a
-      # geometry was maximised, then triggering the unmaximise event will return
-      # it to its usual defined size (terminal size permitting: when the
-      # terminal has been resized, then the new geometry size should adapt).
+      # Will unmaximise the named interface geometry. Previously, when
+      # a geometry was maximised, then triggering the unmaximise event
+      # will return it to its usual defined size (terminal size
+      # permitting: when the terminal has been resized, then the new
+      # geometry size should adapt).
       #
       # @example
       #   Vedeu.trigger(:_unmaximise_, name)

data/lib/vedeu/geometry/grid.rb

@@ -2,10 +2,10 @@ module Vedeu
 
   module Geometry
 
-    # The grid system splits the terminal height and width into 12 equal parts,
-    # by dividing the available height and width by 12. If the terminal height
-    # or width is not a multiple of 12, then Grid chooses the maximum value
-    # which will fit.
+    # The grid system splits the terminal height and width into 12
+    # equal parts, by dividing the available height and width by 12.
+    # If the terminal height or width is not a multiple of 12, then
+    # Grid chooses the maximum value which will fit.
     #
     class Grid
 
@@ -58,7 +58,8 @@ module Vedeu
         Vedeu.height / 12
       end
 
-      # Returns a boolean indicating whether the value is out of range.
+      # Returns a boolean indicating whether the value is out of
+      # range.
       #
       # @return [Boolean]
       def out_of_range?

data/lib/vedeu/geometry/position.rb

@@ -2,7 +2,8 @@ module Vedeu
 
   module Geometry
 
-    # Change coordinates into an escape sequence to set the cursor position.
+    # Change coordinates into an escape sequence to set the cursor
+    # position.
     #
     class Position
 
@@ -48,8 +49,8 @@ module Vedeu
         @x = (x.nil? || x < 1) ? 1 : x
       end
 
-      # Converts a position into an index for the terminal. An index is the
-      # position minus 1.
+      # Converts a position into an index for the terminal. An index
+      # is the position minus 1.
       #
       # @return [Array<Fixnum>]
       def as_indices
@@ -92,13 +93,14 @@ module Vedeu
         self
       end
 
-      # Return the escape sequence required to position the cursor at a
-      # particular point on the screen. When passed a block, will do the
-      # aforementioned, call the block and then reposition to this location.
+      # Return the escape sequence required to position the cursor at
+      # a particular point on the screen. When passed a block, will do
+      # the aforementioned, call the block and then reposition to this
+      # location.
       #
       # @return [String]
-      # @yieldreturn [String] Returns the block wrapped in position escape
-      #   sequences.
+      # @yieldreturn [String] Returns the block wrapped in position
+      #   escape sequences.
       def to_s
         return "#{sequence}#{yield}" if block_given?
 
@@ -136,8 +138,8 @@ module Vedeu
 
       private
 
-      # Returns the escape sequence to reposition the cursors at the coordinates
-      # specified by x and y.
+      # Returns the escape sequence to reposition the cursors at the
+      # coordinates specified by x and y.
       #
       # @return [String]
       def sequence

data/lib/vedeu/input/key.rb

@@ -16,11 +16,10 @@ module Vedeu
       #
       # @param input [String|Symbol]
       # @param block [Proc]
-      # @raise [Vedeu::Error::InvalidSyntax] The required block was
-      #   not given.
+      # @raise [Vedeu::Error::RequiresBlock]
       # @return [Vedeu::Input::Key]
       def initialize(input = nil, &block)
-        fail Vedeu::Error::InvalidSyntax, 'block not given' unless block_given?
+        fail Vedeu::Error::RequiresBlock unless block_given?
 
         @input  = input
         @output = block

data/lib/vedeu/logging/log.rb

@@ -145,7 +145,7 @@ module Vedeu
             drb:    [:light_blue,    :blue],
             event:  [:light_magenta, :magenta],
             info:   [:white,         :default],
-            input:  [:light_yellow,  :yellow],
+            input:  [:light_red,     :red],
             output: [:light_green,   :green],
             reset:  [:light_cyan,    :cyan],
             store:  [:light_cyan,    :cyan],

data/lib/vedeu/menus/menu.rb

@@ -55,11 +55,10 @@ module Vedeu
       #     # ...
       #   end
       #
-      # @raise [Vedeu::Error::InvalidSyntax] The required block was
-      #   not given.
+      # @raise [Vedeu::Error::RequiresBlock]
       # @return [API::Menu]
       def self.menu(name = '', &block)
-        fail Vedeu::Error::InvalidSyntax, 'block not given' unless block_given?
+        fail Vedeu::Error::RequiresBlock unless block_given?
 
         build(name: name, &block).store
       end

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

@@ -74,11 +74,9 @@ module Vedeu
         return [] unless visible?
 
         output = [
-          Vedeu::Cursors::Cursor.hide_cursor(name),
           Vedeu::Clear::NamedInterface.render(name),
           Vedeu::Output::Viewport.render(self),
           Vedeu.borders.by_name(name).render,
-          Vedeu::Cursors::Cursor.show_cursor(name),
         ]
 
         output

data/lib/vedeu/output/output.rb

@@ -29,13 +29,22 @@ module Vedeu
       #
       # @return [Array]
       def render
-        Vedeu::Terminal::Buffer.write(output).render
+        return render_terminal_buffer unless output.is_a?(Vedeu::Models::Escape)
+
+        Vedeu::Output::Direct.write(value: output.value,
+                                    x:     output.position.x,
+                                    y:     output.position.y)
       end
 
       # @!attribute [r] output
       # @return [Array<Array<Vedeu::Views::Char>>]
       attr_reader :output
 
+      # @return [Array]
+      def render_terminal_buffer
+        Vedeu::Terminal::Buffer.write(output).render
+      end
+
     end # Output
 
   end # Output

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

@@ -25,10 +25,10 @@ module Vedeu
       # Render a cleared output.
       #
       # @return [String]
-      def clear
-        ::File.write(filename, '') if write_file?
+      def clear(output = '')
+        ::File.write(filename, output) if write_file?
 
-        ''
+        output
       end
 
       # @param output [Vedeu::Models::Page]

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

@@ -46,6 +46,8 @@ module Vedeu
       # @param output [Vedeu::Models::Page]
       # @return [Array]
       def as_hash(output)
+        return output if output.is_a?(Hash)
+
         output.content.map(&:to_hash)
       end
 

data/lib/vedeu/runtime/main_loop.rb

@@ -24,8 +24,12 @@ module Vedeu
           while @loop
             yield
 
+            Vedeu::Cursors::Cursor.hide_cursor
+
             Vedeu::Terminal::Buffer.render
 
+            Vedeu::Cursors::Cursor.show_cursor
+
             safe_exit_point!
           end
         rescue Vedeu::Error::Interrupt

data/lib/vedeu/templating/helpers.rb

@@ -8,9 +8,8 @@ module Vedeu
 
       # @param value [String] The HTML/CSS colour.
       # @param block [Proc]
+      # @raise [Vedeu::Error::RequiresBlock]
       # @return [Vedeu::Views::Stream]
-      # @raise [Vedeu::Error::InvalidSyntax] The required block was
-      #   not given.
       def background(value, &block)
         define_stream(background: value, &block)
       end
@@ -22,18 +21,16 @@ module Vedeu
       # @option attributes background [String] The HTML/CSS background
       #   colour.
       # @param block [Proc]
+      # @raise [Vedeu::Error::RequiresBlock]
       # @return [Vedeu::Views::Stream]
-      # @raise [Vedeu::Error::InvalidSyntax] The required block was
-      #   not given.
       def colour(attributes = {}, &block)
         define_stream(attributes, &block)
       end
 
       # @param value [String] The HTML/CSS colour.
       # @param block [Proc]
+      # @raise [Vedeu::Error::RequiresBlock]
       # @return [Vedeu::Views::Stream]
-      # @raise [Vedeu::Error::InvalidSyntax] The required block was
-      #   not given.
       def foreground(value, &block)
         define_stream(foreground: value, &block)
       end
@@ -50,7 +47,7 @@ module Vedeu
 
       # @see Vedeu::Templating::Helpers#colour
       def define_stream(attributes = {}, &block)
-        fail Vedeu::Error::InvalidSyntax, 'block not given' unless block_given?
+        fail Vedeu::Error::RequiresBlock unless block_given?
 
         encode(
           Vedeu::Views::Stream.build(

data/lib/vedeu/terminal/buffer.rb

@@ -130,8 +130,7 @@ module Vedeu
       # @param value [void]
       # @return [Boolean]
       def within_terminal_boundary?(value)
-        value.position.y > 0 && value.position.y <= Vedeu.height &&
-          value.position.x > 0 && value.position.x <= Vedeu.width
+        buffer[value.position.y] && buffer[value.position.y][value.position.x]
       end
 
     end # Buffer

data/lib/vedeu/terminal/terminal.rb

@@ -12,11 +12,11 @@ module Vedeu
     # exit, attempts to restore the screen. See
     # {Vedeu::Terminal#restore_screen}.
     #
-    # @raise [Vedeu::Error::InvalidSyntax] The required block was not
+    # @raise [Vedeu::Error::RequiresBlock] The required block was not
     #   given.
     # @return [Array]
     def open
-      fail Vedeu::Error::InvalidSyntax, 'block not given' unless block_given?
+      fail Vedeu::Error::RequiresBlock unless block_given?
 
       if raw_mode? || fake_mode?
         console.raw    { initialize_screen(mode) { yield } }
@@ -155,6 +155,7 @@ module Vedeu
     # @return [Fixnum]
     def width
       return Vedeu::Configuration.drb_width if Vedeu::Configuration.drb?
+      return Vedeu::Configuration.width     if Vedeu::Configuration.width
 
       size[-1]
     end
@@ -170,6 +171,7 @@ module Vedeu
     # @return [Fixnum]
     def height
       return Vedeu::Configuration.drb_height if Vedeu::Configuration.drb?
+      return Vedeu::Configuration.height     if Vedeu::Configuration.height
 
       size.first
     end

data/lib/vedeu/version.rb

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

data/test/lib/vedeu/api/external_test.rb

@@ -30,7 +30,14 @@ module Vedeu
       it { Vedeu.must_respond_to(:geometry) }
       it { Vedeu.must_respond_to(:goto) }
       it { Vedeu.must_respond_to(:group) }
-      it { Vedeu.must_respond_to(:height) }
+
+      describe 'Vedeu.height' do
+        before { Terminal.stubs(:size).returns([25, 40]) }
+
+        it { Vedeu.must_respond_to(:height) }
+        it { Vedeu.height.must_equal(25) }
+      end
+
       it { Vedeu.must_respond_to(:hide_cursor) }
       it { Vedeu.must_respond_to(:hide_group) }
       it { Vedeu.must_respond_to(:hide_interface) }
@@ -53,8 +60,13 @@ module Vedeu
       it { Vedeu.must_respond_to(:unbind) }
       it { Vedeu.must_respond_to(:unbind_alias) }
       it { Vedeu.must_respond_to(:views) }
-      it { Vedeu.must_respond_to(:width) }
 
+      describe 'Vedeu.width' do
+        before { Terminal.stubs(:size).returns([25, 40]) }
+
+        it { Vedeu.must_respond_to(:width) }
+        it { Vedeu.width.must_equal(40) }
+      end
     end # External
 
   end

data/test/lib/vedeu/bindings/visibility_test.rb

@@ -24,6 +24,21 @@ module Vedeu
         it { Vedeu.bound?(:_toggle_interface_).must_equal(true) }
       end
 
+      # describe ':_some_event_' do
+      #   let(:_name) { 'some_name' }
+      #
+      #   before do
+      #     # stub expectation
+      #   end
+      #
+      #   subject { Vedeu.trigger(:_some_event_, _name) }
+      #
+      #   it {
+      #     # expectation
+      #     subject
+      #   }
+      # end
+
     end # Visibility
 
   end # Bindings

data/test/lib/vedeu/dsl/composition_test.rb

@@ -28,7 +28,7 @@ module Vedeu
         it { subject[0].must_be_instance_of(Vedeu::Views::View) }
 
         context 'when the block is not given' do
-          it { proc { instance.view }.must_raise(Vedeu::Error::InvalidSyntax) }
+          it { proc { instance.view }.must_raise(Vedeu::Error::RequiresBlock) }
         end
       end
 

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

@@ -31,7 +31,7 @@ module Vedeu
         context 'when the block is not given' do
           subject { described.group(group_name) }
 
-          it { proc { subject }.must_raise(Vedeu::Error::InvalidSyntax) }
+          it { proc { subject }.must_raise(Vedeu::Error::RequiresBlock) }
         end
       end
 

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

@@ -34,7 +34,7 @@ module Vedeu
         context 'when the block is not given' do
           subject { described.interface('fluorine') }
 
-          it { proc { subject }.must_raise(Vedeu::Error::InvalidSyntax) }
+          it { proc { subject }.must_raise(Vedeu::Error::RequiresBlock) }
         end
 
         context 'when the name is not given' do
@@ -54,7 +54,7 @@ module Vedeu
         context 'when the block is not given' do
           subject { instance.border }
 
-          it { proc { subject }.must_raise(Vedeu::Error::InvalidSyntax) }
+          it { proc { subject }.must_raise(Vedeu::Error::RequiresBlock) }
         end
 
         context 'when the block is given' do
@@ -182,7 +182,7 @@ module Vedeu
         context 'when the required block is not provided' do
           subject { instance.geometry }
 
-          it { proc { subject }.must_raise(Vedeu::Error::InvalidSyntax) }
+          it { proc { subject }.must_raise(Vedeu::Error::RequiresBlock) }
         end
 
         context 'when the block is given' do

data/test/lib/vedeu/dsl/line_test.rb

@@ -57,7 +57,7 @@ module Vedeu
 
             subject { instance.line(_value) }
 
-            it { proc { subject }.must_raise(Vedeu::Error::InvalidSyntax) }
+            it { proc { subject }.must_raise(Vedeu::Error::RequiresBlock) }
           end
         end
       end
@@ -76,7 +76,7 @@ module Vedeu
 
         context 'when the block is not given' do
           it {
-            proc { instance.streams }.must_raise(Vedeu::Error::InvalidSyntax)
+            proc { instance.streams }.must_raise(Vedeu::Error::RequiresBlock)
           }
         end