vedeu 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 53b812fdf424dda850a0a008b824cb388a2329cb
-  data.tar.gz: 85d3208b47291886ed7dad1913fe29bb7806b2b8
+  metadata.gz: 5ab3b3e107a170520a384cb15529a6cb087b6aae
+  data.tar.gz: 96170b0362f0584f7ce527290cf3068bb2fe26bf
 SHA512:
-  metadata.gz: 6d2e44aebbefa2314e55ba466f262d9417ed6380872746d23f2b9e9fe940c70f9fbbc741ec756e1069211c54498d8da09de57702076814bf014f717bdb7908a5
-  data.tar.gz: 4cc8fd2986658da91d8d4b10d48da4514e9eaf588c11dc4941b2173471e85ccaf1adea8e5d19453f1f65532c5395e6234f5ffcca656743b7a9609e86dfb35adb
+  metadata.gz: 08584d6388fbac9ee09e678a22362aaff1028cbd547b3583dad82c67ae8cfb790989066412bc9de4ca0ff800127f7c5fd7a3f36281ee7329c0c04e6eec1ff574
+  data.tar.gz: 96a95d7eca4e92b3794eb96e3183fb75b908e74ea77aff7f561051ee37aac9ec2dd057e128c27e4acec3815c0c3bf0079cf4c8fc6fe312b59845cf639730a9a5

data/docs/api.md

@@ -85,7 +85,9 @@ Note: Nesting indicates where an API method is allowed/supposed to be used.
       - foreground
       - stream
         - align
+        - background
         - colour
+        - foreground
         - style
         - text
         - width

data/docs/events.md

@@ -43,10 +43,6 @@ Hides the cursor for the focussed interface.
 
 Shows the cursor for the focussed interface.
 
-### `:_cursor_refresh_`
-
-Refreshes the cursor for the focussed interface.
-
 ### `:_exit_`
 
 When triggered, Vedeu will trigger a `:_cleanup_` event which you can define (to save files, etc) and attempt to exit.

data/examples/cursor_app/cursor_app.rb

@@ -17,34 +17,15 @@ class VedeuCursorApp
     centred true
     colour  foreground: '#ff0000', background: '#000000'
     height  4
-    width   12
+    width   15
   end
 
-  interface 'krypton' do
-    centred false
-    colour  foreground: '#ffff00', background: '#000000'
-    height  4
-    width   12
-    y       { use('iron').south }
-    x       { use('iron').east(1) }
-  end
-
-  interface 'francium' do
-    centred false
-    colour  foreground: '#ff00ff', background: '#000000'
-    height  4
-    width   12
-    y       { use('iron').north(5) }
-    x       { use('iron').west(13) }
-  end
-
-  interface 'argon' do
-    centred  false
-    colour   foreground: '#00ff00', background: '#000000'
-    height   4
-    width    12
-    y        { use('iron').south }
-    x        { use('iron').west(13) }
+  interface 'gold' do
+    colour foreground: '#00ff00', background: '#001100'
+    height 4
+    width  15
+    x      use('iron').left
+    y      use('iron').south
   end
 
   keys do
@@ -54,26 +35,57 @@ class VedeuCursorApp
     key(:left)  { trigger(:_cursor_left_)  }
   end
 
+  focus('iron')
+
   render do
     view 'iron' do
-      line 'shift+tab to'
-      line 'move to the'
-      line 'previous one'
-    end
-    view 'francium' do
-      line 'Press tab to'
-      line 'move to next'
-      line 'interface or'
-    end
-    view 'krypton' do
-      line 'Position is'
-      line 'remembered'
-      line 'between'
-      line 'interfaces.'
-    end
-    view 'argon' do
-      line 'To exit this'
-      line 'just press Q'
+      line do
+        stream do
+          text 'A 23456789 '
+        end
+        stream do
+          background '#550000'
+          foreground '#ffff00'
+          text 'hydrogen'
+        end
+        stream do
+          text ' helium'
+        end
+      end
+      line 'B 23456789 lithium beryllium boron nitrogen'
+      line do
+        stream do
+          text 'C 23456789'
+        end
+        stream do
+          text ' carbon oxygen '
+        end
+        stream do
+          background '#aadd00'
+          foreground '#000000'
+          text 'fluorine'
+        end
+      end
+      line 'D 23456789'
+      line
+      line 'E 23456789 neon sodium'
+      line do
+        stream do
+          text 'F 23456789 magnesium '
+        end
+        stream do
+          foreground '#00aaff'
+          text 'aluminium'
+        end
+      end
+      line 'G 23456789 silicon'
+      line do
+        stream do
+          background '#550000'
+          foreground '#ff00ff'
+          text 'H 234'
+        end
+      end
     end
   end
 

data/lib/vedeu/api/api.rb

@@ -214,7 +214,10 @@ module Vedeu
     #       view 'my_interface' do
     #         ...
     #
-    # @return [Array]
+    # @raise [InvalidSyntax] When the required block is not given.
+    # @return [Array] A collection of strings, each defining containing the
+    #   escape sequences and content. This data has already been sent to the
+    #   terminal to be output.
     def render(&block)
       API::Composition.render(&block)
     end
@@ -223,19 +226,14 @@ module Vedeu
     # and attempt to redraw the current interface with varying degrees of
     # success. Can also be used to simulate a terminal resize.
     #
-    # @api private
     # @return [TrueClass]
-    # :nocov:
     def resize
       trigger(:_clear_)
 
       trigger(:_refresh_)
 
-      trigger(:_cursor_refresh_)
-
       true
     end
-    # :nocov:
 
     # Trigger a registered or system event by name with arguments. If the
     # event stored returns a value, that is returned.

data/lib/vedeu/api/composition.rb

@@ -7,13 +7,9 @@ module Vedeu
     # @api public
     class Composition < Vedeu::Composition
 
-      # Directly write a view buffer to the terminal.
-      #
       # @param block [Proc]
-      # @raise [InvalidSyntax] When the required block is not given.
-      # @return [Array] A collection of strings, each defining containing the
-      #   escape sequences and content. This data has already been sent to the
-      #   terminal to be output.
+      # @return [Array]
+      # @see Vedeu::API#render
       def self.render(&block)
         fail InvalidSyntax, '`render` requires a block.' unless block_given?
 
@@ -28,7 +24,7 @@ module Vedeu
 
       # @param name [String]
       # @param block [Proc]
-      # @return []
+      # @return [Hash]
       # @see Vedeu::API#view
       def view(name, &block)
         attributes[:interfaces] << API::Interface

data/lib/vedeu/api/interface.rb

@@ -193,7 +193,6 @@ module Vedeu
 
       # Returns the out of bounds error message for the given named attribute.
       #
-      # @api private
       # @param name [String]
       # @return [String]
       def out_of_bounds(name)
@@ -203,7 +202,7 @@ module Vedeu
 
       # Checks the value is within the terminal's confines.
       #
-      # @api private
+      # @param value [Fixnum]
       # @return [Boolean]
       def y_out_of_bounds?(value)
         value < 1 || value > Terminal.height
@@ -211,7 +210,7 @@ module Vedeu
 
       # Checks the value is within the terminal's confines.
       #
-      # @api private
+      # @param value [Fixnum]
       # @return [Boolean]
       def x_out_of_bounds?(value)
         value < 1 || value > Terminal.width

data/lib/vedeu/api/menu.rb

@@ -83,7 +83,6 @@ module Vedeu
 
       # The default values for a new instance of Menu.
       #
-      # @api private
       # @return [Hash]
       def defaults
         {
@@ -92,12 +91,15 @@ module Vedeu
         }
       end
 
-      # @api private
+      # @param method [Symbol] The name of the method sought.
+      # @param args [Array] The arguments which the method was to be invoked
+      #   with.
+      # @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})")
 
-        @self_before_instance_eval.send(method, *args, &block)
+        @self_before_instance_eval.send(method, *args, &block) if @self_before_instance_eval
       end
 
     end # Menu

data/lib/vedeu/api/stream.rb

@@ -34,6 +34,40 @@ 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/application.rb

@@ -4,7 +4,7 @@ module Vedeu
   #
   # @api private
   class Application
-    # :nocov:
+
     class << self
 
       # @return []
@@ -19,7 +19,6 @@ module Vedeu
       #   is about to terminate. Client applications are encouraged to use this
       #   event to close any open buffers, save files, empty trash, etc.
       #
-      # @api private
       # @raise [StopIteration] Will cause {#start} to exit its loop and
       #   terminate the application.
       # @return [StopIteration]
@@ -28,7 +27,8 @@ module Vedeu
 
         fail StopIteration
       end
-    end
+
+    end # self
 
     # @return [Application]
     def initialize; end
@@ -60,7 +60,6 @@ module Vedeu
     # Runs the application loop either once, or forever (exceptions and signals
     # permitting).
     #
-    # @api private
     # @return []
     def runner
       if Configuration.once?
@@ -79,7 +78,6 @@ module Vedeu
     # and 'do something useful'. When the client application has finished, it
     # should trigger the `:_exit_` event.
     #
-    # @api private
     # @return []
     def main_sequence
       if Configuration.interactive?
@@ -95,7 +93,6 @@ module Vedeu
     # uncaught exception occurs or when either the `:_mode_switch_` or `:_exit_`
     # event is triggered.
     #
-    # @api private
     # @return []
     def run_many
       loop { yield }
@@ -108,5 +105,5 @@ module Vedeu
     end
 
   end # Application
-  # :nocov:
+
 end # Vedeu

data/lib/vedeu/configuration/api.rb

@@ -298,7 +298,6 @@ module Vedeu
       # Returns the options set via the configuration API DSL or an empty Hash
       # if none were set.
       #
-      # @api private
       # @return [Hash]
       def options
         @_options ||= {}
@@ -307,7 +306,6 @@ module Vedeu
       # Returns the system keys set via the configuration API DSL or an empty
       # hash if none were redefined.
       #
-      # @api private
       # @return [Hash]
       def system_key_options
         @_system_key_options ||= Configuration.default_system_keys
@@ -315,7 +313,6 @@ module Vedeu
 
       # Checks that the value provided to {#colour_mode} is valid.
       #
-      # @api private
       # @param value [Fixnum]
       # @return [Boolean]
       def valid_colour_mode?(value)
@@ -326,7 +323,6 @@ module Vedeu
       # {#focus_prev_key} and {#mode_switch_key} is valid. Must be a Symbol or a
       # non-empty String.
       #
-      # @api private
       # @param value [String|Symbol]
       # @return [Boolean]
       def valid_key?(value)
@@ -340,7 +336,6 @@ module Vedeu
       # Raises an exception on behalf of the calling method to report that the
       # value provided is not valid.
       #
-      # @api private
       # @param system_key [String] The calling method wishing to raise an
       #   exception.
       # @raise [InvalidSyntax] When the system_key parameter is not a String or

data/lib/vedeu/configuration/cli.rb

@@ -117,7 +117,6 @@ module Vedeu
       # Returns the options set via command-line arguments parsed by
       # OptionParser, or an empty Hash if none were set or parsed.
       #
-      # @api private
       # @return [Hash]
       def options
         @_options ||= {}

data/lib/vedeu/configuration/configuration.rb

@@ -98,7 +98,6 @@ module Vedeu
 
     # Vedeu's default system keys. Use {#system_keys}.
     #
-    # @api private
     # @return [Hash]
     def default_system_keys
       {
@@ -113,7 +112,6 @@ module Vedeu
 
     # Returns all the options current configured.
     #
-    # @api private
     # @return [Hash]
     def options
       @options ||= defaults
@@ -122,7 +120,6 @@ module Vedeu
     # The Vedeu default options, which of course are influenced by environment
     # variables also.
     #
-    # @api private
     # @return [Hash]
     def defaults
       {
@@ -139,9 +136,7 @@ module Vedeu
     # Attempt to determine the terminal colour mode via environment variables,
     # or be optimistic and settle for 256 colours.
     #
-    # @api private
     # @return [Fixnum]
-    # :nocov:
     def detect_colour_mode
       return 16777216 if ENV['VEDEU_TESTMODE']
 
@@ -164,13 +159,10 @@ module Vedeu
 
       end
     end
-    # :nocov:
 
     # Determine the debug mode via an environment variable.
     #
-    # @api private
     # @return [Boolean]
-    # :nocov:
     def detect_debug_mode
       return false if ENV['VEDEU_TESTMODE']
 
@@ -178,13 +170,10 @@ module Vedeu
 
       false
     end
-    # :nocov:
 
     # Determine the trace mode via an environment variable.
     #
-    # @api private
     # @return [Boolean]
-    # :nocov:
     def detect_trace_mode
       return false if ENV['VEDEU_TESTMODE']
 
@@ -192,7 +181,6 @@ module Vedeu
 
       false
     end
-    # :nocov:
 
   end # Configuration
 

data/lib/vedeu/input/input.rb

@@ -23,13 +23,11 @@ module Vedeu
 
     private
 
-    # @api private
     # @return [String]
     def input
       @_input ||= Terminal.input
     end
 
-    # @api private
     # @return [String|Symbol]
     def keypress
       key = input
@@ -40,7 +38,6 @@ module Vedeu
     # Translates (if possible) entered escape sequences into symbols
     # representing the key which was pressed.
     #
-    # @api private
     # @return [Hash]
     def specials
       {

data/lib/vedeu/launcher.rb

@@ -8,7 +8,6 @@ module Vedeu
   # @api public
   class Launcher
 
-    # :nocov:
     # @param argv [Array]
     # @param stdin []
     # @param stdout []

data/lib/vedeu/models/{attributes/background.rb → background.rb}

@@ -13,19 +13,16 @@ module Vedeu
     # Valid names are: `:black`, `:red`, `:green`, `:yellow`, `:blue`,
     # `:magenta`, `:cyan`, `:white` and `:default`.
     #
-    # @api private
     # @return [String]
     def named
       ["\e[", background_codes[colour], 'm'].join
     end
 
-    # @api private
     # @return [String]
     def numbered
       ["\e[48;5;", css_to_numbered, 'm'].join
     end
 
-    # @api private
     # @return [String]
     def rgb
       if Configuration.colour_mode == 16777216
@@ -40,7 +37,6 @@ module Vedeu
     # Produces the background named colour escape sequence hash from the
     # foreground escape sequence hash.
     #
-    # @api private
     # @return [Hash]
     def background_codes
       codes.inject({}){ |h, (k, v)| h.merge(k => v + 10) }

data/lib/vedeu/models/char.rb

@@ -0,0 +1,43 @@
+module Vedeu
+
+  # A Char represents a single character of the terminal. It is a container for
+  # the a single character in a {Vedeu::Stream}.
+  #
+  # @note The parent of a Char is a Line.
+  # @todo Colour and style is not being correctly reset. (GL 2014-10-19)
+  #
+  # @api private
+  class Char
+
+    include Presentation
+
+    attr_reader :attributes, :parent, :value
+    alias_method :data, :value
+
+    # Returns a new instance of Char.
+    #
+    # @param attributes [Hash]
+    # @return [Char]
+    def initialize(attributes = {})
+      @attributes = defaults.merge!(attributes)
+      @parent     = @attributes[:parent]
+      @value      = @attributes[:value]
+    end
+
+    private
+
+    # The default values for a new instance of Char.
+    #
+    # @return [Hash]
+    def defaults
+      {
+        colour: {},
+        parent: nil,
+        style:  [],
+        value:  '',
+      }
+    end
+
+  end # Char
+
+end # Vedeu

data/lib/vedeu/models/colour.rb

@@ -41,7 +41,6 @@ module Vedeu
 
     private
 
-    # @api private
     # @return [Hash]
     def defaults
       {

data/lib/vedeu/models/composition.rb

@@ -50,7 +50,6 @@ module Vedeu
 
     # The default values for a new instance of Composition.
     #
-    # @api private
     # @return [Hash]
     def defaults
       {
@@ -58,12 +57,14 @@ module Vedeu
       }
     end
 
-    # @api private
+    # @param method [Symbol] The name of the method sought.
+    # @param args [Array] The arguments which the method was to be invoked with.
+    # @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})")
 
-      @self_before_instance_eval.send(method, *args, &block)
+      @self_before_instance_eval.send(method, *args, &block) if @self_before_instance_eval
     end
 
   end # Composition