vedeu 0.2.4 → 0.2.5

data/lib/vedeu/api/keymap.rb

@@ -58,10 +58,15 @@ module Vedeu
       #     key('s')  { :something }
       #     ...
       #
+      #   keys do
+      #     interfaces('main', 'other')
+      #     ...
+      #
       # @return [Array]
       def interface(*name_or_names)
         attributes[:interfaces] = name_or_names
       end
+      alias_method :interfaces, :interface
 
     end # Keymap
 

data/lib/vedeu/api/line.rb

@@ -4,11 +4,63 @@ module Vedeu
 
     # Provides methods to be used to define views.
     #
+    # @example
+    #   line do
+    #
+    #     background '#ffffff'
+    #
+    #     colour     background: '#222222', foreground: '#ff0000'
+    #
+    #     foreground '#000000'
+    #
+    #     stream do
+    #       # see {API::Stream} for directives
+    #     end
+    #
+    #     style 'normal' # or a collection: ['bold', 'underline']
+    #
+    #     text 'Some text...'
+    #
+    #
     # @api public
     class Line < Vedeu::Line
 
       include Helpers
 
+      # @param value [String]
+      # @param block [Proc]
+      #
+      # @example
+      #   ...
+      #     line do
+      #       background '#0022ff' do
+      #         ... other stream directives ...
+      #
+      # @return [Array]
+      def background(value = '', &block)
+        stream = API::Stream.build({ colour: { background: value },
+                                     parent: self.view_attributes }, &block)
+
+        attributes[:streams] << stream
+      end
+
+      # @param value [String]
+      # @param block [Proc]
+      #
+      # @example
+      #   ...
+      #     line do
+      #       foreground '#00ff00' do
+      #         ... other stream directives ...
+      #
+      # @return [Array]
+      def foreground(value = '', &block)
+        stream = API::Stream.build({ colour: { foreground: value },
+                                     parent: self.view_attributes }, &block)
+
+        attributes[:streams] << stream
+      end
+
       # Define a stream (a subset of a line).
       #
       # @param block [Proc] Block contains directives relating to API::Stream.
@@ -48,40 +100,6 @@ module Vedeu
         attributes[:streams] << { text: value }
       end
 
-      # @param value [String]
-      # @param block [Proc]
-      #
-      # @example
-      #   ...
-      #     line do
-      #       foreground '#00ff00' do
-      #         ... other stream directives ...
-      #
-      # @return [Array]
-      def foreground(value = '', &block)
-        stream = API::Stream.build({ colour: { foreground: value },
-                                     parent: self.view_attributes }, &block)
-
-        attributes[:streams] << stream
-      end
-
-      # @param value [String]
-      # @param block [Proc]
-      #
-      # @example
-      #   ...
-      #     line do
-      #       background '#0022ff' do
-      #         ... other stream directives ...
-      #
-      # @return [Array]
-      def background(value = '', &block)
-        stream = API::Stream.build({ colour: { background: value },
-                                     parent: self.view_attributes }, &block)
-
-        attributes[:streams] << stream
-      end
-
     end # Line
 
   end # API

data/lib/vedeu/api/menu.rb

@@ -97,7 +97,7 @@ module Vedeu
       # @param block [Proc] The optional block provided to the method.
       # @return []
       def method_missing(method, *args, &block)
-        Vedeu.log("API::Menu#method_missing '#{method.to_s}' (args: #{args.inspect})")
+        Vedeu.log("API::Menu#method_missing '#{method}' (args: #{args.inspect})")
 
         @self_before_instance_eval.send(method, *args, &block) if @self_before_instance_eval
       end

data/lib/vedeu/api/stream.rb

@@ -34,40 +34,6 @@ module Vedeu
         attributes[:align] = value.to_sym
       end
 
-      # Specify the background colour for a stream.
-      #
-      # @param value [String]
-      #
-      # @example
-      #   ...
-      #     stream do
-      #       background '#0022ff'
-      #       ... other stream directives ...
-      #
-      # @return [Hash]
-      def background(value = '')
-        fail InvalidSyntax, '`background` requires a value.' unless defined_value?(value)
-
-        attributes[:colour].merge!({ background: value })
-      end
-
-      # Specify the foreground colour for a stream.
-      #
-      # @param value [String]
-      #
-      # @example
-      #   ...
-      #     stream do
-      #       foreground '#0022ff'
-      #       ... other stream directives ...
-      #
-      # @return [Hash]
-      def foreground(value = '')
-        fail InvalidSyntax, '`foreground` requires a value.' unless defined_value?(value)
-
-        attributes[:colour].merge!({ foreground: value })
-      end
-
       # Syntactic sugar used with {#align} to left align content.
       #
       # @return [Symbol]

data/lib/vedeu/configuration/api.rb

@@ -60,7 +60,7 @@ module Vedeu
       # @param value [Boolean]
       # @return [Boolean]
       def interactive!(value = true)
-        Vedeu.log("Configuration::API interactive: #{value.to_s}")
+        Vedeu.log("Configuration::API interactive: #{value}")
 
         options[:interactive] = value
       end
@@ -77,7 +77,7 @@ module Vedeu
       # @param value [Boolean]
       # @return [Boolean]
       def standalone!(value = true)
-        Vedeu.log("Configuration::API interactive: #{!value.to_s}")
+        Vedeu.log("Configuration::API interactive: #{!value}")
 
         options[:interactive] = !value
       end
@@ -95,7 +95,7 @@ module Vedeu
       # @param value [Boolean]
       # @return [Boolean]
       def run_once!(value = true)
-        Vedeu.log("Configuration::API once: #{value.to_s}")
+        Vedeu.log("Configuration::API once: #{value}")
 
         options[:once] = value
       end
@@ -154,7 +154,7 @@ module Vedeu
           options[:debug] = true
 
         else
-          Vedeu.log("Configuration::API debug: #{value.to_s}")
+          Vedeu.log("Configuration::API debug: #{value}")
 
           options[:debug] = value
 
@@ -180,7 +180,7 @@ module Vedeu
       def trace!(value = true)
         options[:debug] = true if value === true
 
-        Vedeu.log("Configuration::API trace: #{value.to_s}")
+        Vedeu.log("Configuration::API trace: #{value}")
 
         options[:trace] = value
       end
@@ -201,7 +201,7 @@ module Vedeu
         fail InvalidSyntax, '`colour_mode` must be `8`, `16`, `256`, ' \
                             '`16777216`.' unless valid_colour_mode?(value)
 
-        Vedeu.log("Configuration::API colour_mode: #{value.to_s}")
+        Vedeu.log("Configuration::API colour_mode: #{value}")
 
         options[:colour_mode] = value
       end
@@ -222,7 +222,7 @@ module Vedeu
       def exit_key(value)
         return invalid_key('exit_key') unless valid_key?(value)
 
-        Vedeu.log("Configuration::API exit_key: #{value.to_s}")
+        Vedeu.log("Configuration::API exit_key: #{value}")
 
         system_key_options[:exit] = value
       end
@@ -244,7 +244,7 @@ module Vedeu
       def focus_next_key(value)
         return invalid_key('exit_key') unless valid_key?(value)
 
-        Vedeu.log("Configuration::API focus_next: #{value.to_s}")
+        Vedeu.log("Configuration::API focus_next: #{value}")
 
         system_key_options[:focus_next] = value
       end
@@ -266,7 +266,7 @@ module Vedeu
       def focus_prev_key(value)
         return invalid_key('exit_key') unless valid_key?(value)
 
-        Vedeu.log("Configuration::API focus_prev: #{value.to_s}")
+        Vedeu.log("Configuration::API focus_prev: #{value}")
 
         system_key_options[:focus_prev] = value
       end
@@ -288,7 +288,7 @@ module Vedeu
       def mode_switch_key(value)
         return invalid_key('exit_key') unless valid_key?(value)
 
-        Vedeu.log("Configuration::API mode_switch: #{value.to_s}")
+        Vedeu.log("Configuration::API mode_switch: #{value}")
 
         system_key_options[:mode_switch] = value
       end

data/lib/vedeu/configuration/cli.rb

@@ -93,7 +93,7 @@ module Vedeu
                   'Run application in either `8`, `16`, `256` or `16777216` ' \
                   'colour mode.') do |colours|
             if [8, 16, 256, 16777216].include?(colours)
-              Vedeu.log("Configuration::CLI colour_mode: #{colours.to_s}")
+              Vedeu.log("Configuration::CLI colour_mode: #{colours}")
 
               options[:colour_mode] = colours
 

data/lib/vedeu/launcher.rb

@@ -8,16 +8,32 @@ module Vedeu
   # @api public
   class Launcher
 
+    attr_reader :exit_code
+
+    # @see Vedeu::Launcher#initialize
+    def self.execute!(argv = [],
+                      stdin  = STDIN,
+                      stdout = STDOUT,
+                      stderr = STDERR,
+                      kernel = Kernel)
+      new(argv,
+          stdin  = STDIN,
+          stdout = STDOUT,
+          stderr = STDERR,
+          kernel = Kernel).execute!
+    end
+
     # @param argv [Array]
     # @param stdin []
     # @param stdout []
     # @param stderr []
     # @param kernel []
     # @return [Launcher]
-    def initialize(argv, stdin  = STDIN,
-                         stdout = STDOUT,
-                         stderr = STDERR,
-                         kernel = Kernel)
+    def initialize(argv   = [],
+                   stdin  = STDIN,
+                   stdout = STDOUT,
+                   stderr = STDERR,
+                   kernel = Kernel)
       @argv      = argv
       @stdin     = stdin
       @stdout    = stdout
@@ -43,8 +59,7 @@ module Vedeu
       Vedeu.log("Exiting gracefully.")
 
       $stdin, $stdout, $stderr = STDIN, STDOUT, STDERR
-      @kernel.exit(@exit_code)
-
+      @kernel.exit(exit_code)
     end
 
     private

data/lib/vedeu/models/background.rb

@@ -39,7 +39,7 @@ module Vedeu
     #
     # @return [Hash]
     def background_codes
-      codes.inject({}){ |h, (k, v)| h.merge(k => v + 10) }
+      Esc.codes.inject({}) { |h, (k, v)| h.merge(k => v + 10) }
     end
 
   end # Background

data/lib/vedeu/models/composition.rb

@@ -62,7 +62,7 @@ module Vedeu
     # @param block [Proc] The optional block provided to the method.
     # @return []
     def method_missing(method, *args, &block)
-      Vedeu.log("Composition#method_missing '#{method.to_s}' (args: #{args.inspect})")
+      Vedeu.log("Composition#method_missing '#{method}' (args: #{args.inspect})")
 
       @self_before_instance_eval.send(method, *args, &block) if @self_before_instance_eval
     end

data/lib/vedeu/models/cursor.rb

@@ -19,17 +19,17 @@ module Vedeu
     #   belongs to.
     # @option attributes :state [Symbol] The visibility of the cursor, either
     #   +:hide+ or +:show+.
-    # @option attributes :x [Fixnum]
-    # @option attributes :y [Fixnum]
+    # @option attributes :x [Fixnum] The terminal x coordinate for the cursor.
+    # @option attributes :y [Fixnum] The terminal y coordinate for the cursor.
     #
     # @return [Cursor]
     def initialize(attributes = {})
       @attributes = defaults.merge!(attributes)
 
-      @name       = @attributes[:name]
-      @state      = @attributes[:state]
-      @x          = @attributes[:x]
-      @y          = @attributes[:y]
+      @name  = @attributes[:name]
+      @state = @attributes[:state]
+      @x     = @attributes[:x]
+      @y     = @attributes[:y]
     end
 
     # Returns an attribute hash for the current position and visibility of the
@@ -38,19 +38,23 @@ module Vedeu
     # @return [Hash]
     def attributes
       {
-        name:     name,
-        state:    state,
-        x:        x,
-        y:        y,
+        name:  name,
+        state: state,
+        x:     x,
+        y:     y,
       }
     end
     alias_method :refresh, :attributes
 
     # Returns the x coordinate (column/character) of the cursor. Attempts to
-    # sensibly reposition the cursor if it is currently outside the interface.
+    # sensibly reposition the cursor if it is currently outside the interface,
+    # or outside the visible area of the terminal.
     #
     # @return [Fixnum]
     def x
+      @x = 1              if @x <= 1
+      @x = Terminal.width if @x >= Terminal.width
+
       if @x <= left
         @x = left
 
@@ -64,10 +68,14 @@ module Vedeu
     end
 
     # Returns the y coordinate (row/line) of the cursor. Attempts to sensibly
-    # reposition the cursor if it is currently outside the interface.
+    # reposition the cursor if it is currently outside the interface, or outside
+    # the visible area of the terminal.
     #
     # @return [Fixnum]
     def y
+      @y = 1               if @y <= 1
+      @y = Terminal.height if @y >= Terminal.height
+
       if @y <= top
         @y = top
 
@@ -114,17 +122,6 @@ module Vedeu
       end
     end
 
-    # Return a boolean indicating the visibility of the cursor, invisible if
-    # the state is not defined.
-    #
-    # @return [Boolean]
-    def visible?
-      return false unless states.include?(state)
-      return false if state == :hide
-
-      true
-    end
-
     private
 
     # Returns the escape sequence to position the cursor and set its visibility.
@@ -145,7 +142,7 @@ module Vedeu
     #
     # @return [String]
     def visibility
-      return Esc.string('show_cursor') if visible?
+      return Esc.string('show_cursor') if state == :show
 
       Esc.string('hide_cursor')
     end
@@ -162,22 +159,15 @@ module Vedeu
       @interface ||= Interfaces.build(name)
     end
 
-    # The valid visibility states for the cursor.
-    #
-    # @return [Array]
-    def states
-      [:show, :hide]
-    end
-
     # The default values for a new instance of Cursor.
     #
     # @return [Hash]
     def defaults
       {
-        name:     '',
-        state:    :show,
-        x:        1,
-        y:        1,
+        name:  '',
+        state: :hide,
+        x:     1,
+        y:     1,
       }
     end