vedeu 0.1.17 → 0.1.18

data/lib/vedeu/support/log.rb

@@ -76,7 +76,7 @@ module Vedeu
 
   class Log
 
-    # @return []
+    # @return [TrueClass]
     def self.logger
       @logger ||= MonoLogger.new(filename).tap do |log|
         log.formatter = proc do |_, time, _, message|
@@ -87,16 +87,22 @@ module Vedeu
 
     private
 
+    # @api private
+    # @return [String]
     def self.filename
       @_filename ||= directory + '/vedeu.log'
     end
 
+    # @api private
+    # @return [String]
     def self.directory
       FileUtils.mkdir_p(path) unless File.directory?(path)
 
       path
     end
 
+    # @api private
+    # @return [String]
     def self.path
       Dir.home + '/.vedeu'
     end

data/lib/vedeu/support/position.rb

@@ -22,14 +22,20 @@ module Vedeu
 
     private
 
+    # @api private
+    # @return [String]
     def sequence
       ["\e[", y, ';', x, 'H'].join
     end
 
+    # @api private
+    # @return [Fixnum]
     def y
       (@y == 0 || @y == nil) ? 1 : @y
     end
 
+    # @api private
+    # @return [Fixnum]
     def x
       (@x == 0 || @x == nil) ? 1 : @x
     end

data/lib/vedeu/support/render.rb

@@ -1,18 +1,28 @@
 module Vedeu
   class Render
 
+    # Attempts to convert the provided interface object with associated lines,
+    # streams, colours, styles, etc, into a single string containing all content
+    # and escape sequences.
+    #
+    # @api private
     # @param interface [Interface]
     # @return [String]
     def self.call(interface)
       new(interface).render
     end
 
+    # Initializes a new Render object with the provided interface.
+    #
     # @param interface [Interface]
     # @return [Render]
     def initialize(interface)
       @interface = interface
     end
 
+    # Produces a single string which contains all content and escape sequences
+    # required to render this interface to a position in the terminal window.
+    #
     # @return [String]
     def render
       out = [ Clear.call(interface) ]
@@ -33,6 +43,9 @@ module Vedeu
     # The client application may have created a line that us too long for the
     # interface. This code tries to truncate streams whilst preserving styles
     # and colours.
+    #
+    # @api private
+    # @return [Array]
     def processed_lines
       return [] unless lines.any? { |line| line.streams.any? }
 
@@ -71,22 +84,47 @@ module Vedeu
       end
     end
 
+    # Converts all streams within a line into a single line of text to then
+    # check that this line (without formatting, as that is not visible) exceeds
+    # the width of the interface.
+    #
+    # @api private
+    # @param line [Line]
+    # @return [TrueClass|FalseClass]
     def exceeds_width?(line)
       line.streams.map(&:text).join.size > width
     end
 
+    # Truncates the provided text.
+    #
+    # @api private
+    # @param text [String] The text to be truncated.
+    # @param value [Fixnum] The total length of the text after truncation.
+    # @return [String]
     def truncate(text, value)
       text.chomp.slice(0...value)
     end
 
+    # Provides a collection of lines associated with the interface.
+    #
+    # @api private
+    # @return [Array]
     def lines
       interface.lines
     end
 
+    # Provides the currently available height of the interface.
+    #
+    # @api private
+    # @return [Fixnum]
     def height
       interface.viewport_height
     end
 
+    # Provides the currently available width of the interface.
+    #
+    # @api private
+    # @return [Fixnum]
     def width
       interface.viewport_width
     end

data/lib/vedeu/support/terminal.rb

@@ -1,24 +1,23 @@
 module Vedeu
   module Terminal
+
     extend self
 
-    # @param mode [Symbol]
     # @param block [Proc]
     # @return []
-    def open(mode, &block)
-      @mode = mode
+    def open(&block)
+      fail InvalidSyntax, '`open` requires a block.' unless block_given?
 
-      if block_given?
-        if raw_mode?
-          console.raw    { initialize_screen { yield } }
+      if raw_mode?
+        console.raw    { initialize_screen { yield } }
 
-        else
-          console.cooked { initialize_screen { yield } }
+      else
+        console.cooked { initialize_screen { yield } }
 
-        end
       end
     ensure
       restore_screen
+
     end
 
     # @return [String]
@@ -69,9 +68,35 @@ module Vedeu
       output Esc.string 'show_cursor' unless raw_mode?
     end
 
+    # @return [Boolean]
+    def cooked_mode?
+      mode == :cooked
+    end
+
+    # @return [Symbol]
+    def cooked_mode!
+      @_mode = :cooked
+    end
+
     # @return [Boolean]
     def raw_mode?
-      @mode == :raw
+      mode == :raw
+    end
+
+    # @return [Symbol]
+    def raw_mode!
+      @_mode = :raw
+    end
+
+    # @return [Symbol]
+    def switch_mode!
+      if raw_mode?
+        cooked_mode!
+
+      else
+        raw_mode!
+
+      end
     end
 
     # @return [String]
@@ -79,26 +104,54 @@ module Vedeu
       Esc.set_position((height - 1), 1) + Esc.string('clear_line')
     end
 
-    # @return [Fixnum]
-    def colour_mode
-      Configuration.options[:colour_mode]
+    # Returns the mode of the terminal, either `:raw` or `:cooked`
+    #
+    # @return [Symbol]
+    def mode
+      @_mode ||= Configuration.terminal_mode
     end
 
+    # 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
 
-    # @return [Fixnum] The total width of the current terminal.
+    # Returns the `y` (row/line) component of the coordinate tuple provided by
+    # {Terminal.centre}
+    #
+    # @return [Fixnum]
+    def centre_y
+      centre.first
+    end
+
+    # Returns the `x` (column/character) component of the coodinate tuple
+    # provided by {Terminal.centre}
+    #
+    # @return [Fixnum]
+    def centre_x
+      centre.last
+    end
+
+    # Returns the total width (number of columns/characters) of the current
+    # terminal.
+    #
+    # @return [Fixnum]
     def width
       size.last
     end
 
-    # @return [Fixnum] The total height of the current terminal.
+    # Returns the total height (number of rows/lines) of the current terminal.
+    #
+    # @return [Fixnum]
     def height
       size.first
     end
 
+    # Returns a tuple containing the height and width of the current terminal.
+    #
     # @return [Array]
     def size
       console.winsize
@@ -108,5 +161,6 @@ module Vedeu
     def console
       IO.console
     end
+
   end
 end

data/lib/vedeu/support/trace.rb

@@ -28,18 +28,26 @@ module Vedeu
 
     private
 
+    # @api private
+    # @return []
     def watched
       options[:event]
     end
 
+    # @api private
+    # @return []
     def klass
       options[:klass]
     end
 
+    # @api private
+    # @return [Hash]
     def options
       defaults.merge!(@options)
     end
 
+    # @api private
+    # @return [Hash]
     def defaults
       {
         event: 'call',

data/lib/vedeu/support/view.rb

@@ -30,14 +30,20 @@ module Vedeu
 
     attr_reader :object
 
+    # @api private
+    # @return [Array]
     def interfaces
       composition.interfaces
     end
 
+    # @api private
+    # @return [Composition]
     def composition
       @_composition ||= Composition.new(attributes)
     end
 
+    # @api private
+    # @return []
     def attributes
       render
     end

data/test/integration/run_once_test.rb

@@ -0,0 +1,26 @@
+require 'test_helper'
+
+class MyFirstApplication
+  include Vedeu
+
+  interface 'hydrogen' do
+    x       2
+    y       2
+    width   50
+    height  2
+  end
+
+  def self.start
+    Vedeu::Launcher.new(['--run-once', '--noninteractive']).execute!
+  end
+end
+
+describe 'Run the application once, printing a message on the screen and ' \
+         'gracefully terminating.' do
+  it 'writes a message to the screen' do
+    skip
+    stdout, stderr = capture_io { MyFirstApplication.start }
+    stdout.must_equal('Great success! Now, try something a little harder.')
+    stderr.must_equal('')
+  end
+end

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

@@ -24,10 +24,6 @@ module Vedeu
     end
 
     describe '.events' do
-      it 'should not be visible to the client' do
-        skip
-      end
-
       it 'returns the Events singleton' do
         Vedeu.events.must_be_instance_of(Vedeu::Events)
       end
@@ -45,7 +41,7 @@ module Vedeu
       it 'creates and stores a new interface' do
         Vedeu::Buffers.reset
 
-        Vedeu.interface('Vedeu.interface').must_equal(true)
+        Vedeu.interface('Vedeu.interface').must_be_instance_of(API::Interface)
       end
     end
 
@@ -53,11 +49,24 @@ module Vedeu
       before { event.stubs(:trigger).returns(nil) }
 
       it 'returns nil' do
-        skip
         Vedeu.keypress('k').must_equal(nil)
       end
     end
 
+    describe '.log' do
+      it 'writes the message to the log file when debugging is enabled' do
+        Configuration.stub(:debug?, true) do
+          Vedeu.log('some message...').must_equal(true)
+        end
+      end
+
+      it 'returns nil when debugging is disabled' do
+        Configuration.stub(:debug?, false) do
+          Vedeu.log('some message...').must_equal(nil)
+        end
+      end
+    end
+
     describe '.trigger' do
       it 'triggers the specifed event and returns the collection of events' \
          ' which this trigger triggers' do
@@ -128,6 +137,10 @@ module Vedeu
           }
         )
       end
+
+      it 'raises an exception if a block was not given' do
+        proc { Vedeu.views }.must_raise(InvalidSyntax)
+      end
     end
 
     describe '.width' do

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

@@ -8,7 +8,7 @@ module Vedeu
         interface = Interface.new({ name: 'widget' })
 
         it 'creates and stores a new interface' do
-          interface.define.must_equal(true)
+          interface.define.must_be_instance_of(API::Interface)
         end
 
         it 'allows the setting of colours' do
@@ -834,6 +834,72 @@ module Vedeu
           )
         end
 
+        it 'allows inline values for line' do
+          Vedeu.interface 'helium' do
+          end
+          attributes = Vedeu.view 'helium' do
+            line 'A headline, if you will.'
+            line # with a spacer line
+            line 'This is a line of text...'
+            line do
+              text '...we can mix and match...'
+            end
+            line '...to our hearts content.'
+          end
+          attributes[:interfaces].first[:lines].size.must_equal(5)
+        end
+      end
+
+      describe '#cursor' do
+        it 'raises an exception if the value is invalid' do
+          proc {
+            Vedeu.interface 'beryllium' do
+              cursor :invalid
+            end
+          }.must_raise(InvalidSyntax)
+        end
+
+        it 'sets the cursor to true (visible)' do
+          Vedeu.interface 'beryllium' do
+            cursor true
+          end
+
+          Vedeu.use('beryllium').attributes[:cursor].must_equal(true)
+        end
+
+        it 'sets the cursor to false (hidden)' do
+          Vedeu.interface 'beryllium' do
+            cursor false
+          end
+
+          Vedeu.use('beryllium').attributes[:cursor].must_equal(false)
+        end
+      end
+
+      describe '#centred' do
+        it 'raises an exception if the value is invalid' do
+          proc {
+            Vedeu.interface 'boron' do
+              centred :invalid
+            end
+          }.must_raise(InvalidSyntax)
+        end
+
+        it 'sets the centred to true (visible)' do
+          Vedeu.interface 'boron' do
+            centred true
+          end
+
+          Vedeu.use('boron').attributes[:geometry][:centred].must_equal(true)
+        end
+
+        it 'sets the centred to false (hidden)' do
+          Vedeu.interface 'boron' do
+            centred false
+          end
+
+          Vedeu.use('boron').attributes[:geometry][:centred].must_equal(false)
+        end
       end
     end
   end