vedeu 0.2.10 → 0.2.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bff39cd80bb0bca7448d6cf083f2115665e55054
-  data.tar.gz: 93bc4d77d71b14632868a4389f150c7a48b15e31
+  metadata.gz: f2e18e1de7f428b1890aacc71abffae0ea935431
+  data.tar.gz: 3c32f191ff6dfead712551de9c4375261d46dc54
 SHA512:
-  metadata.gz: 8c51486199b28763e4fee45eb2dcf7404bc4cd35c308237ad475dbd051d2ddbe826b8d3201e2abe5716eb24149cb14ffcde30512f0732c89e4c10d604d49146b
-  data.tar.gz: 1b4d18498d51ed6653501b017ecefd09e42daaaffd797c3e5a6f66ee204784938de563df224700624ffd22a786396c81c65e62c27365680f77eadec734383e2b
+  metadata.gz: 5b2dc0ebd0bfa591774ead8d58fdd090ca80152619545226230a02d72c2b9a0f991aa0813eec3bffeee38070091cedfce8a0e6df2648a8a740ffe6589bfe6c18
+  data.tar.gz: a785503d6086eaa2b8a4d1c4aa882f99d03ff4a791c42828fef352e053d0f146b67b4b6fa0e6bb2f9f87b46be82d8e1c42100e4d64c6d059263cff3cd9d9c01a

data/docs/events.md

@@ -156,6 +156,12 @@ applications can listen for this event and perform some action(s), like render
 the first screen, interface or make a sound. When Vedeu triggers this event,
 the :_refresh_ event is also triggered automatically.
 
+### `:_tick_`
+
+Each time Vedeu completes one cycle in the application loop
+(Application#run_many), it triggers the `:_tick_` event. This can be used by the
+client application for timing amongst other things.
+
 #### How to define user events
 
 ```ruby

data/examples/{cursor_app/cursor_app.rb → cursor_app.rb}

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-lib_dir = File.dirname(__FILE__) + '/../../lib'
+lib_dir = File.dirname(__FILE__) + '/../lib'
 $LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
 
 -> { its -> { a } }

data/examples/{lines_app/lines_app.rb → lines_app.rb}

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-lib_dir = File.dirname(__FILE__) + '/../../lib'
+lib_dir = File.dirname(__FILE__) + '/../lib'
 $LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
 
 -> { its -> { a } }

data/lib/vedeu.rb

@@ -15,6 +15,21 @@ module Vedeu
     receiver.extend(API)
   end
 
+  # Write a message to the Vedeu log file.
+  #
+  # @param message [String] The message you wish to emit to the log
+  #   file, useful for debugging.
+  # @param force   [Boolean] When evaluates to true will attempt to
+  #   write to the log file regardless of the Configuration setting.
+  #
+  # @example
+  #   Vedeu.log('A useful debugging message: Error!')
+  #
+  # @return [TrueClass]
+  def self.log(message, force = false)
+    Vedeu::Log.logger.debug(message) if Configuration.debug? || force
+  end
+
 end # Vedeu
 
 $LIB_DIR = File.dirname(__FILE__) + '/../lib'
@@ -29,8 +44,10 @@ require 'set'
 require 'singleton'
 require 'time'
 
-require 'vedeu/support/exceptions'
 require 'vedeu/support/common'
+require 'vedeu/support/exceptions'
+require 'vedeu/support/model'
+
 require 'vedeu/configuration/cli'
 require 'vedeu/configuration/api'
 require 'vedeu/configuration/configuration'
@@ -38,36 +55,36 @@ require 'vedeu/configuration/configuration'
 require 'vedeu/support/log'
 require 'vedeu/support/trace'
 
-require 'vedeu/models/keymap'
+require 'vedeu/support/repository'
+require 'vedeu/repositories/models/event'
+require 'vedeu/repositories/events'
+require 'vedeu/repositories/keymaps'
+require 'vedeu/repositories/models/keymap'
 require 'vedeu/api/keymap'
 require 'vedeu/api/api'
 
-require 'vedeu/support/coercions'
-require 'vedeu/support/colour_translator'
-require 'vedeu/models/background'
-require 'vedeu/models/foreground'
-require 'vedeu/support/presentation'
-require 'vedeu/models/composition'
+require 'vedeu/colours/translator'
+require 'vedeu/colours/background'
+require 'vedeu/colours/foreground'
+require 'vedeu/colours/colour'
 
-require 'vedeu/support/repository'
-require 'vedeu/support/position'
+require 'vedeu/support/coercions'
 require 'vedeu/support/esc'
+require 'vedeu/support/position'
+require 'vedeu/support/presentation'
+require 'vedeu/support/sentence'
 require 'vedeu/support/terminal'
 
-require 'vedeu/models/buffer'
 require 'vedeu/models/char'
-require 'vedeu/models/colour'
-require 'vedeu/models/cursor'
-require 'vedeu/models/event'
+require 'vedeu/models/composition'
 require 'vedeu/models/geometry'
-require 'vedeu/models/interface'
+require 'vedeu/models/key'
 require 'vedeu/models/line'
-require 'vedeu/models/menu'
-require 'vedeu/models/offset'
 require 'vedeu/models/stream'
 require 'vedeu/models/style'
 
-require 'vedeu/repositories/events'
+require 'vedeu/repositories/models/interface'
+require 'vedeu/repositories/interfaces'
 
 require 'vedeu/api/defined'
 require 'vedeu/api/composition'
@@ -77,27 +94,30 @@ require 'vedeu/api/line'
 require 'vedeu/api/menu'
 require 'vedeu/api/stream'
 
+require 'vedeu/repositories/models/buffer'
+require 'vedeu/repositories/models/cursor'
+require 'vedeu/repositories/models/group'
+require 'vedeu/repositories/models/menu'
+require 'vedeu/repositories/models/offset'
+
 require 'vedeu/support/keymap_validator'
-require 'vedeu/repositories/positional'
-require 'vedeu/repositories/offsets'
-require 'vedeu/repositories/menus'
-require 'vedeu/repositories/keymaps'
-require 'vedeu/repositories/interfaces'
-require 'vedeu/repositories/groups'
-require 'vedeu/repositories/focus'
-require 'vedeu/repositories/events'
+
 require 'vedeu/repositories/buffers'
 require 'vedeu/repositories/cursors'
+require 'vedeu/repositories/focus'
+require 'vedeu/repositories/groups'
+require 'vedeu/repositories/menus'
+require 'vedeu/repositories/offsets'
 
 require 'vedeu/support/registrar'
 require 'vedeu/support/refresh'
 
-require 'vedeu/output/clear'
 require 'vedeu/output/compositor'
-require 'vedeu/output/render'
+require 'vedeu/output/output'
 require 'vedeu/output/view'
 require 'vedeu/output/viewport'
 
+require 'vedeu/support/bounding_area'
 require 'vedeu/support/grid'
 
 require 'vedeu/input/input'

data/lib/vedeu/api/api.rb

@@ -1,3 +1,5 @@
+require 'vedeu/support/terminal'
+
 module Vedeu
 
   # Provides the API to Vedeu. Methods therein, and classes belonging to this
@@ -8,7 +10,11 @@ module Vedeu
 
     extend Forwardable
 
-    def_delegators Keymap, :keys
+    # @see Vedeu::Events#add
+    def_delegators Events,          :event
+    def_delegators Keymap,          :keys
+    def_delegators Keymaps,         :keypress
+    def_delegators Vedeu::Terminal, :height, :width
 
     # Configure Vedeu using a simple configuration DSL.
     #
@@ -31,72 +37,16 @@ module Vedeu
       Vedeu::API::Defined
     end
 
-    # Register an event by name with optional delay (throttling) which when
-    # triggered will execute the code contained within the passed block.
-    #
-    # @param name  [Symbol] The name of the event which will be triggered later.
-    # @param [Hash] opts The options to register the event with.
-    # @option opts :delay [Fixnum|Float] Limits the execution of the
-    #   triggered event to only execute when first triggered, with subsequent
-    #   triggering being ignored until the delay has expired.
-    # @option opts :debounce [Fixnum|Float] Limits the execution of the
-    #   triggered event to only execute once the debounce has expired.
-    #   Subsequent triggers before debounce expiry are ignored.
-    # @param block [Proc] The event to be executed when triggered. This block
-    #   could be a method call, or the triggering of another event, or sequence
-    #   of either/both.
-    #
-    # @example
-    #   Vedeu.event :my_event do |some, args|
-    #     ... some code here ...
-    #
-    #     Vedeu.trigger(:my_other_event)
-    #   end
-    #
-    #   T = Triggered, X = Executed, i = Ignored.
-    #
-    #   0.0.....0.2.....0.4.....0.6.....0.8.....1.0.....1.2.....1.4.....1.6...
-    #   .T...T...T...T...T...T...T...T...T...T...T...T...T...T...T...T...T...T
-    #   .X...i...i...i...i...X...i...i...i...i...X...i...i...i...i...i...i...i
-    #
-    #   Vedeu.event(:my_delayed_event, { delay: 0.5 })
-    #     ... some code here ...
-    #   end
-    #
-    #   T = Triggered, X = Executed, i = Ignored.
-    #
-    #   0.0.....0.2.....0.4.....0.6.....0.8.....1.0.....1.2.....1.4.....1.6...
-    #   .T...T...T...T...T...T...T...T...T...T...T...T...T...T...T...T...T...T
-    #   .i...i...i...i...i...i...i...X...i...i...i...i...i...i...X...i...i...i
-    #
-    #   Vedeu.event(:my_debounced_event, { debounce: 0.7 })
-    #     ... some code here ...
-    #   end
-    #
-    # @return [Hash]
-    def event(name, opts = {}, &block)
-      Events.add(name, opts, &block)
-    end
-
     # Used after defining an interface or interfaces to set the initially
     # focussed interface.
     #
     # @param name [String] The interface to focus; must be defined.
     # @return [String] The name of the interface now in focus.
-    # @raise [InterfaceNotFound] When the interface cannot be found.
+    # @raise [ModelNotFound] When the interface cannot be found.
     def focus(name)
       Vedeu.trigger(:_focus_by_name_, name)
     end
 
-    # Find out how many lines the current terminal is able to display.
-    #
-    # @example
-    #   Vedeu.height
-    #
-    # @return [Fixnum] The total height of the current terminal.
-    def height
-      Terminal.height
-    end
 
     # Register an interface by name which will display output from a event or
     # command. This provides the means for you to define your application's
@@ -121,33 +71,6 @@ module Vedeu
       API::Interface.define({ name: name }, &block)
     end
 
-    # Simulate a keypress.
-    #
-    # @todo Replace with: def_delegators Keymaps, :keypress
-    #
-    # @example
-    #   Vedeu.keypress('s')
-    #
-    # @see Vedeu::Keymaps.use
-    def keypress(key)
-      Vedeu::Keymaps.use(key)
-    end
-
-    # Write a message to the Vedeu log file.
-    #
-    # @param message [String] The message you wish to emit to the log
-    #   file, useful for debugging.
-    # @param force   [Boolean] When evaluates to true will attempt to
-    #   write to the log file regardless of the Configuration setting.
-    #
-    # @example
-    #   Vedeu.log('A useful debugging message: Error!')
-    #
-    # @return [TrueClass]
-    def log(message, force = false)
-      Vedeu::Log.logger.debug(message) if Configuration.debug? || force
-    end
-
     # Register a menu by name which will display a collection of items for your
     # users to select; and provide interactivity within your application.
     #
@@ -307,16 +230,6 @@ module Vedeu
     end
     alias_method :composition, :views
 
-    # Find out how many columns the current terminal is able to display.
-    #
-    # @example
-    #   Vedeu.width
-    #
-    # @return [Fixnum] The total width of the current terminal.
-    def width
-      Terminal.width
-    end
-
   end # API
 
   extend API

data/lib/vedeu/application.rb

@@ -80,7 +80,7 @@ module Vedeu
     # @return []
     def main_sequence
       if Configuration.interactive?
-        Input.capture
+        Input.capture(Terminal)
 
       else
         Vedeu.trigger(:_standalone_)
@@ -94,7 +94,11 @@ module Vedeu
     #
     # @return []
     def run_many
-      loop { yield }
+      loop do
+        Vedeu.trigger(:_tick_)
+        yield
+
+      end
 
     rescue ModeSwitch
       Terminal.switch_mode!

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

@@ -4,7 +4,7 @@ module Vedeu
   # {Vedeu::Foreground}) of a terminal colour escape sequence.
   #
   # @api private
-  class Background < ColourTranslator
+  class Background < Translator
 
     private
 

data/lib/vedeu/{models → colours}/foreground.rb

@@ -4,7 +4,7 @@ module Vedeu
   # {Vedeu::Background}) of a terminal colour escape sequence.
   #
   # @api private
-  class Foreground < ColourTranslator
+  class Foreground < Translator
 
     private
 
@@ -39,7 +39,7 @@ module Vedeu
     end
 
     # Produces the foreground named colour escape sequence hash from
-    # {Vedeu::ColourTranslator#codes}
+    # {Vedeu::Translator#codes}
     #
     # @return [Hash]
     def foreground_codes

data/lib/vedeu/{support/colour_translator.rb → colours/translator.rb}

@@ -20,26 +20,26 @@ module Vedeu
   #
   # @todo More documentation required (create a fancy chart!)
   # @api private
-  class ColourTranslator
+  class Translator
 
     # Convert a CSS/HTML colour string into a terminal escape sequence.
     #
-    # @param colour [String]
+    # @param colour [Fixnum|String|Symbol]
     # @return [String]
     def self.escape_sequence(colour = '')
       new(colour).escape_sequence
     end
 
-    # Return a new instance of ColourTranslator.
+    # Return a new instance of Translator.
     #
-    # @param colour [String]
-    # @return [ColourTranslator]
+    # @param colour [Fixnum|String|Symbol]
+    # @return [Translator]
     def initialize(colour = '')
       @colour = colour
     end
 
     # @return [String]
-    # @see Vedeu::ColourTranslator
+    # @see Vedeu::Translator
     def escape_sequence
       if no_colour?
         ''
@@ -183,6 +183,6 @@ module Vedeu
       (css_to_rgb[2] / 51) * 1
     end
 
-  end # ColourTranslator
+  end # Translator
 
 end # Vedeu

data/lib/vedeu/input/input.rb

@@ -8,30 +8,38 @@ module Vedeu
 
     # Instantiate Input and capture keypress(es).
     #
+    # @param reader [IO] An object that responds to `#read`. Typically, this is
+    #   Vedeu::Terminal.
     # @return [String|Symbol]
-    def self.capture
-      new.capture
+    def self.capture(reader)
+      new(reader).capture
     end
 
     # Returns a new instance of Input.
     #
+    # @param reader [IO] An object that responds to `#read`. Typically, this is
+    #   Vedeu::Terminal.
     # @return [Input]
-    def initialize; end
+    def initialize(reader)
+      @reader = reader
+    end
 
     # Triggers the keypress event with the key(s) pressed.
     #
-    # @return []
+    # @return [Array|String|Symbol]
     def capture
       Vedeu.trigger(:_keypress_, keypress)
     end
 
     private
 
+    attr_reader :reader
+
     # Returns the input from the terminal.
     #
     # @return [String]
     def input
-      @_input ||= Terminal.input
+      @_input ||= reader.read
     end
 
     # Returns the translated (if possible) keypress(es) as either a String or a