vedeu 0.6.7 → 0.6.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c8361e0f679e7a752058e9a18febf179a3866dcb
-  data.tar.gz: 48b0d34dc40c43fad42cc60c9c768716fea5fc55
+  metadata.gz: 43c20341c0356017348e3f761aa1b1371b5d5d53
+  data.tar.gz: bc914cbb3ca7912bc37b6d519edd74caafc71945
 SHA512:
-  metadata.gz: 78eaf93359ac8620f7039ef9f15aef044c6023e1cb71baff51809bd0d70bea21665223f43a810d061cbe42d72059bc325d999890ce407a6ae432007b67a810e0
-  data.tar.gz: ecdaafd1a7c70f86d9bf4ce2358135646b2692974b4de25a683b57c8771c218f0cb50942d9eec6e15adfa7ce1ddd83b6047563c0daf269cd46ceb39c74e4f8a4
+  metadata.gz: bc099e2bab2c7849429e57de5de0549889195bfc19833ee93644a45d609e8426cae6289c3df6e97846fe8d4a2eaecf3219ff4d1d32688387e69c4c2bf76e68af
+  data.tar.gz: 2c28487ea4337f6887775d6eeedf9d77f70766a3e7db89e915f9e61577c7b9103574cf537536b1fac39b0b1ca9762832282fc06de0ed775bae0f6ea868ae410a

data/LICENSE.txt

@@ -1,7 +1,7 @@
 Copyright (c) 2014 Gavin Laking
 Copyright (c) 2013 Steve Klabnik - Monologger
                    (https://github.com/steveklabnik/mono_logger)
-                   Note: Code used inline in Vedeu::Log.
+                   Note: Code used inline in Vedeu::Logging::Log.
 Copyright (c) 2013 Michael Grosser - Ruco
                    (https://github.com/grosser/ruco)
                    Note: Code from ruco's Window class was used as basis of

data/docs/dsl.md

@@ -134,10 +134,10 @@ end
 
 ## Menus
 
-{include:Vedeu::DSL::Menu}
-{include:Vedeu::DSL::Menu#item}
-{include:Vedeu::DSL::Menu#items}
-{include:Vedeu::DSL::Menu#name}
+{include:Vedeu::Menus::DSL}
+{include:Vedeu::Menus::DSL#item}
+{include:Vedeu::Menus::DSL#items}
+{include:Vedeu::Menus::DSL#name}
 
 ## Views
 

data/lib/vedeu/all.rb

@@ -4,11 +4,9 @@ require 'vedeu/options'
 require 'vedeu/runtime/launcher'
 require 'vedeu/runtime/bootstrap'
 require 'vedeu/error'
-require 'vedeu/log/lockless_log_device'
-require 'vedeu/log/mono_logger'
-require 'vedeu/log/log'
-require 'vedeu/log/debug'
-require 'vedeu/log/timer'
+
+require 'vedeu/logging/all'
+
 require 'vedeu/runtime/traps'
 require 'vedeu/common'
 require 'vedeu/runtime/router'
@@ -37,7 +35,6 @@ require 'vedeu/repositories/repository'
 require 'vedeu/null/null'
 require 'vedeu/null/generic'
 require 'vedeu/null/interface'
-require 'vedeu/null/menu'
 require 'vedeu/null/view'
 
 require 'vedeu/refresh/refresh'
@@ -57,8 +54,6 @@ require 'vedeu/models/escape'
 require 'vedeu/models/focus'
 require 'vedeu/models/group'
 require 'vedeu/models/groups'
-require 'vedeu/models/menu'
-require 'vedeu/models/menus'
 require 'vedeu/models/row'
 require 'vedeu/models/page'
 
@@ -92,24 +87,18 @@ require 'vedeu/dsl/keymap'
 require 'vedeu/dsl/text'
 require 'vedeu/dsl/interface'
 require 'vedeu/dsl/line'
-require 'vedeu/dsl/menu'
 require 'vedeu/dsl/stream'
 require 'vedeu/dsl/view'
 
-require 'vedeu/input/input_translator'
-require 'vedeu/input/mapper'
-require 'vedeu/input/key'
-require 'vedeu/input/input'
-require 'vedeu/input/keymap'
-require 'vedeu/input/keymaps'
-require 'vedeu/input/editor/all'
-
 require 'vedeu/borders/all'
 require 'vedeu/buffers/all'
 require 'vedeu/colours/all'
 require 'vedeu/cursors/all'
+require 'vedeu/editor/all'
 require 'vedeu/events/all'
 require 'vedeu/geometry/all'
+require 'vedeu/input/all'
+require 'vedeu/menus/all'
 
 require 'vedeu/output/direct'
 require 'vedeu/output/clear/named_group'
@@ -118,7 +107,6 @@ require 'vedeu/output/presentation'
 require 'vedeu/output/compressor'
 require 'vedeu/output/style'
 require 'vedeu/output/text'
-require 'vedeu/output/html_char'
 require 'vedeu/output/output'
 require 'vedeu/output/viewport'
 require 'vedeu/output/wordwrap'

data/lib/vedeu/api.rb

@@ -1,9 +1,10 @@
 module Vedeu
 
-  # Provides the API to Vedeu. Methods therein, and classes belonging to this
-  # module expose Vedeu's core functionality.
+  # Provides the API to Vedeu. Methods therein, and classes belonging
+  # to this module expose Vedeu's core functionality.
   #
-  # These methods are used in a variety of ways, sometimes in combination:
+  # These methods are used in a variety of ways, sometimes in
+  # combination:
   #
   #   # with parameters
   #   Vedeu.method_name(*params)
@@ -99,20 +100,20 @@ module Vedeu
                    :focus_next, :focus_previous
 
     # @!method log
-    #   @see Vedeu::Log.log
+    #   @see Vedeu::Logging::Log.log
     # @!method log_stdout
-    #   @see Vedeu::Log.log_stdout
+    #   @see Vedeu::Logging::Log.log_stdout
     # @!method log_stderr
-    #   @see Vedeu::Log.log_stderr
-    def_delegators Vedeu::Log, :log, :log_stdout, :log_stderr
+    #   @see Vedeu::Logging::Log.log_stderr
+    def_delegators Vedeu::Logging::Log, :log, :log_stdout, :log_stderr
 
     # @!method keypress
-    #   @see Vedeu::Mapper.keypress
-    def_delegators Vedeu::Mapper, :keypress
+    #   @see Vedeu::Input::Mapper.keypress
+    def_delegators Vedeu::Input::Mapper, :keypress
 
     # @!method menu
-    #   @see Vedeu::Menu.menu
-    def_delegators Vedeu::Menu, :menu
+    #   @see Vedeu::Menus::Menu.menu
+    def_delegators Vedeu::Menus::Menu, :menu
 
     # @!method goto
     #   @see Vedeu::Router#goto
@@ -131,8 +132,8 @@ module Vedeu
     def_delegators Vedeu::Events::Trigger, :trigger
 
     # @!method exit
-    #   @see Vedeu::Application.stop
-    def_delegators Vedeu::Application, :exit
+    #   @see Vedeu::Runtime::Application.stop
+    def_delegators Vedeu::Runtime::Application, :exit
 
     # @!method clear
     #   @see Vedeu::Terminal#clear

data/lib/vedeu/bindings/system.rb

@@ -77,8 +77,9 @@ module Vedeu
         Vedeu.bind(:_command_) { |command| Vedeu.trigger(:command, command) }
       end
 
-      # This event is called by {Vedeu::Input#capture}. When invoked, the
-      # key will be passed to the editor for currently focussed view.
+      # This event is called by {Vedeu::Input::Input#capture}. When
+      # invoked, the key will be passed to the editor for currently
+      # focussed view.
       #
       # @example
       #   Vedeu.trigger(:_editor_, key)
@@ -99,7 +100,7 @@ module Vedeu
       #
       # @return [TrueClass]
       def exit!
-        Vedeu.bind(:_exit_) { Vedeu::Application.stop }
+        Vedeu.bind(:_exit_) { Vedeu::Runtime::Application.stop }
       end
 
       # Vedeu triggers this event when it is ready to enter the main loop.
@@ -119,7 +120,7 @@ module Vedeu
       # with the argument `:escape`, also an internal event `_mode_switch_` is
       # triggered. Vedeu recognises most key presses and some 'extended'
       # keypress (eg. Ctrl+J), a list of supported keypresses can be found here:
-      # {Vedeu::Input#specials} and {Vedeu::Input#f_keys}.
+      # {Vedeu::Input::Input#specials} and {Vedeu::Input::Input#f_keys}.
       #
       # @example
       #   Vedeu.trigger(:_keypress_, key)

data/lib/vedeu/buffers/virtual_buffer.rb

@@ -1,6 +1,7 @@
 module Vedeu
 
-  # Represents a {Vedeu::Terminal} view as a grid of {Vedeu::Cell} objects.
+  # Represents a {Vedeu::Terminal} view as a grid of
+  # {Vedeu::Models::Cell} objects.
   #
   class VirtualBuffer
 
@@ -27,8 +28,8 @@ module Vedeu
     #
     # @param height [Fixnum]
     # @param width [Fixnum]
-    # @param renderer [Object|Vedeu::Renderers::HTML] An object responding to
-    #   .render.
+    # @param renderer [Object|Vedeu::Renderers::HTML] An object
+    #   responding to .render.
     # @return [Vedeu::VirtualBuffer]
     def initialize(height, width, renderer = Vedeu::Renderers::HTML.new)
       @height   = height
@@ -36,8 +37,8 @@ module Vedeu
       @renderer = renderer
     end
 
-    # Return a grid of {Vedeu::Views::Char} objects defined by the height and
-    # width of this virtual terminal.
+    # Return a grid of {Vedeu::Views::Char} objects defined by the
+    # height and width of this virtual terminal.
     #
     # @return [Array<Array<Vedeu::Views::Char>>]
     def cells
@@ -82,7 +83,8 @@ module Vedeu
       renderer.render(cells)
     end
 
-    # Removes all content from the virtual terminal; effectively clearing it.
+    # Removes all content from the virtual terminal; effectively
+    # clearing it.
     #
     # @return [Array<Array<Vedeu::Views::Char>>]
     def reset
@@ -101,7 +103,7 @@ module Vedeu
     # @param data [Vedeu::Views::Char]
     # @return [Vedeu::Views::Char]
     def write(y, x, data)
-      return false unless read(y, x).is_a?(Vedeu::Cell)
+      return false unless read(y, x).is_a?(Vedeu::Models::Cell)
 
       cy, cx = Vedeu::Geometry::Position[y, x].as_indices
       cells[cy][cx] = data
@@ -112,17 +114,17 @@ module Vedeu
     private
 
     # @param from [Array] An Array of rows, or an Array of cells.
-    # @param which [Fixnum] A Fixnum representing the index; the row number or
-    #   the cell number for a row.
+    # @param which [Fixnum] A Fixnum representing the index; the row
+    #   number or the cell number for a row.
     # @return [Array<Vedeu::Views::Char>|Array]
     def fetch(from, which)
       from[which] || []
     end
 
-    # @return [Array<Array<Vedeu::Cell>>]
+    # @return [Array<Array<Vedeu::Models::Cell>>]
     # @see Vedeu::VirtualBuffer#cells
     def new_virtual_buffer
-      Array.new(height) { Array.new(width) { Vedeu::Cell.new } }
+      Array.new(height) { Array.new(width) { Vedeu::Models::Cell.new } }
     end
 
   end # VirtualBuffer

data/lib/vedeu/configuration/api.rb

@@ -275,15 +275,16 @@ module Vedeu
         options[:log] = filename
       end
 
-      # Only log specific message types. A complete list of message types can
-      # be found at {Vedeu::Log.message_types}.
+      # Only log specific message types. A complete list of message
+      # types can be found at {Vedeu::Logging::Log.message_types}.
       #
       #   Vedeu.configure do
       #     log_only :debug, :event
       #     # ...
       #   end
       #
-      # @param types [Array<Symbol>] The message types which should be logged.
+      # @param types [Array<Symbol>] The message types which should be
+      #   slogged.
       # @return [Array<Symbol>]
       def log_only(*types)
         options[:log_only] = types

data/lib/vedeu/cursors/cursor.rb

@@ -2,8 +2,8 @@ module Vedeu
 
   module Cursors
 
-    # Each interface has its own Cursor which maintains the position and
-    # visibility of the cursor within that interface.
+    # Each interface has its own Cursor which maintains the position
+    # and visibility of the cursor within that interface.
     #
     class Cursor
 
@@ -48,14 +48,17 @@ module Vedeu
       # Returns a new instance of Vedeu::Cursors::Cursor.
       #
       # @param attributes [Hash]
-      # @option attributes name [String] The name of the interface this cursor
-      #   belongs to.
+      # @option attributes name [String] The name of the interface
+      #   this cursor belongs to.
       # @option attributes ox [Fixnum] The offset x coordinate.
       # @option attributes oy [Fixnum] The offset y coordinate.
       # @option attributes repository [Vedeu::Repository]
-      # @option attributes visible [Boolean] The visibility of the cursor.
-      # @option attributes x [Fixnum] The terminal x coordinate for the cursor.
-      # @option attributes y [Fixnum] The terminal y coordinate for the cursor.
+      # @option attributes visible [Boolean] The visibility of the
+      #   cursor.
+      # @option attributes x [Fixnum] The terminal x coordinate for
+      #   the cursor.
+      # @option attributes y [Fixnum] The terminal y coordinate for
+      #   the cursor.
       #
       # @return [Vedeu::Cursors::Cursor]
       def initialize(attributes = {})
@@ -133,7 +136,7 @@ module Vedeu
 
       # Renders the cursor.
       #
-      # @return [Array<Vedeu::Escape>]
+      # @return [Array<Vedeu::Models::Escape>]
       def render
         Vedeu::Output.render(visibility)
       end
@@ -153,8 +156,8 @@ module Vedeu
       end
 
       # Returns an escape sequence to position the cursor and set its
-      # visibility. When passed a block, will position the cursor, yield and
-      # return the original position.
+      # visibility. When passed a block, will position the cursor,
+      # yield and return the original position.
       #
       # @return [String]
       def to_s
@@ -168,13 +171,14 @@ module Vedeu
       end
       alias_method :to_str, :to_s
 
-      # Hide a named cursor, or without a name, the cursor of the currently
+      # Hide a named cursor, or without a name, the cursor of the
+      # currently
       # focussed interface.
       #
       # @example
       #   Vedeu.hide_cursor(name)
       #
-      # @return [Vedeu::Escape]
+      # @return [Vedeu::Models::Escape]
       def hide
         super
 
@@ -200,13 +204,13 @@ module Vedeu
         @position = Vedeu::Geometry::Position[y, x]
       end
 
-      # Show a named cursor, or without a name, the cursor of the currently
-      # focussed interface.
+      # Show a named cursor, or without a name, the cursor of the
+      # currently focussed interface.
       #
       # @example
       #   Vedeu.show_cursor(name)
       #
-      # @return [Vedeu::Escape]
+      # @return [Vedeu::Models::Escape]
       def show
         super
 
@@ -218,7 +222,7 @@ module Vedeu
       # @example
       #   Vedeu.toggle_cursor(name)
       #
-      # @return [Vedeu::Escape]
+      # @return [Vedeu::Models::Escape]
       def toggle
         if visible?
           hide
@@ -276,13 +280,14 @@ module Vedeu
         }
       end
 
-      # Returns the escape sequence for setting the visibility of the cursor.
+      # Returns the escape sequence for setting the visibility of the
+      # cursor.
       #
       # @return [String]
       def visibility
         value = visible? ? Vedeu::Esc.show_cursor : Vedeu::Esc.hide_cursor
 
-        Vedeu::Escape.new(position: position, value: value)
+        Vedeu::Models::Escape.new(position: position, value: value)
       end
 
     end # Cursor

data/lib/vedeu/distributed/client.rb

@@ -1,13 +1,16 @@
 module Vedeu
 
-  # Provides a mechanism to control a running client application via DRb.
+  # Provides a mechanism to control a running client application via
+  # DRb.
   #
   module Distributed
 
-    # A class for the client side of the DRb server/client relationship.
+    # A class for the client side of the DRb server/client
+    # relationship.
     #
     # @example
-    #   client = Vedeu::Distributed::Client.connect("druby://localhost:21420")
+    #   client = Vedeu::Distributed::Client.
+    #              connect("druby://localhost:21420")
     #   client.input('a')
     #   client.output # => 'some content...'
     class Client
@@ -25,7 +28,8 @@ module Vedeu
         @uri = uri.to_s
       end
 
-      # Simulate connecting to the DRb server by requesting its status.
+      # Simulate connecting to the DRb server by requesting its
+      # status.
       #
       # @return [Symbol]
       def connect
@@ -67,8 +71,9 @@ module Vedeu
       # Shutdown the DRb server and the client application.
       #
       # @note
-      #   {Vedeu::Application} will raise StopIteration when its `.stop` method
-      #   is called. Here we rescue that to give a clean client exit.
+      #   {Vedeu::Runtime::Application} will raise StopIteration when
+      #   its `.stop` method is called. Here we rescue that to give a
+      #   clean client exit.
       #
       # @return [void|Symbol]
       def shutdown

data/lib/vedeu/distributed/server.rb

@@ -62,9 +62,10 @@ module Vedeu
       end # Eigenclass
 
       # @param data [String|Symbol] The input to send to Vedeu.
-      # @param type [Symbol] Either :command or :keypress. Will trigger the
-      #   respective capture mode within {Vedeu::Input}, or if not given, will
-      #   treat the data as a keypress.
+      # @param type [Symbol] Either :command or :keypress. Will
+      #   trigger the respective capture mode within
+      #   {Vedeu::Input::Input}, or if not given, will treat the data
+      #   as a keypress.
       # @return [void]
       def input(data, type = :keypress)
         Vedeu.trigger(:_drb_input_, data, type)

data/lib/vedeu/dsl/keymap.rb

@@ -48,18 +48,18 @@ module Vedeu
       #   to.
       # @param block [Proc]
       # @raise [Vedeu::Error::InvalidSyntax] The required block was not given.
-      # @return [Vedeu::Keymap]
+      # @return [Vedeu::Input::Keymap]
       # @todo Try to remember why we need to pre-create the keymap in the
       #   repository.
       def self.keymap(name, &block)
-        Vedeu::Keymap.new(name: name).store
+        Vedeu::Input::Keymap.new(name: name).store
 
-        Vedeu::Keymap.build(name: name, &block).store
+        Vedeu::Input::Keymap.build(name: name, &block).store
       end
 
       # Returns an instance of DSL::Keymap.
       #
-      # @param model [Vedeu::Keymap]
+      # @param model [Vedeu::Input::Keymap]
       # @param client [Object]
       # @return [Vedeu::DSL::Keymap]
       def initialize(model, client = nil)
@@ -71,8 +71,8 @@ module Vedeu
       #
       # @param value_or_values [Array<String>|Array<Symbol>|String|Symbol]
       #   The key(s) pressed. Special keys can be found in
-      #   {Vedeu::Input#specials}. When more than one key is defined, then the
-      #   extras are treated as aliases.
+      #   {Vedeu::Input::Input#specials}. When more than one key is
+      #   defined, then the extras are treated as aliases.
       # @param block [Proc] The action to perform when this key is pressed. Can
       #   be a method call or event triggered.
       # @raise [Vedeu::Error::InvalidSyntax]

data/lib/vedeu/editor/all.rb

@@ -0,0 +1,19 @@
+module Vedeu
+
+  # Provide a mechanism to edit individual lines of the view.
+  #
+  module Editor
+
+  end # Editor
+
+end # Vedeu
+
+require 'vedeu/editor/capture'
+require 'vedeu/editor/cropper'
+require 'vedeu/editor/editor'
+require 'vedeu/editor/insert'
+require 'vedeu/editor/line'
+require 'vedeu/editor/lines'
+require 'vedeu/editor/cursor'
+require 'vedeu/editor/document'
+require 'vedeu/editor/documents'

data/lib/vedeu/{input/editor → editor}/capture.rb

@@ -24,7 +24,7 @@ module Vedeu
 
       # @return [String|Symbol]
       def read
-        Vedeu::InputTranslator.translate(keys)
+        Vedeu::Input::Translator.translate(keys)
       end
 
       private

data/lib/vedeu/error.rb

@@ -1,18 +1,19 @@
 module Vedeu
 
-  # Custom exceptions/errors which Vedeu will raise in certain circumstances.
+  # Custom exceptions/errors which Vedeu will raise in certain
+  # circumstances.
   #
   module Error
 
-    # Raised with Vedeu attempts to access a client application controller's
-    # action that does not exist.
+    # Raised with Vedeu attempts to access a client application
+    # controller's action that does not exist.
     #
     class ActionNotFound < StandardError
 
     end # ActionNotFound
 
-    # Raised with Vedeu attempts to access a client application controller that
-    # does not exist.
+    # Raised with Vedeu attempts to access a client application
+    # controller that does not exist.
     #
     class ControllerNotFound < StandardError
 
@@ -26,43 +27,44 @@ module Vedeu
 
     # Raised when Vedeu wishes to exit.
     #
-    # @see Vedeu::MainLoop
+    # @see Vedeu::Runtime::MainLoop
     #
     class Interrupt < StandardError
 
     end # Interrupt
 
-    # Raised when Vedeu attempts to parse a view or interface and encounters a
-    # problem.
+    # Raised when Vedeu attempts to parse a view or interface and
+    # encounters a problem.
     #
     class InvalidSyntax < StandardError
 
     end # InvalidSyntax
 
-    # Raised when a name is not provided for a model when attempting to store it
-    # in a repository.
+    # Raised when a name is not provided for a model when attempting
+    # to store it in a repository.
     #
     class MissingRequired < StandardError
 
     end # MissingRequired
 
-    # Raised with Vedeu attempts to access a named model that does not exist.
+    # Raised with Vedeu attempts to access a named model that does not
+    # exist.
     #
     class ModelNotFound < StandardError
 
     end # ModelNotFound
 
-    # Raised intentionally when the client application wishes to switch between
-    # cooked, fake and raw terminal modes.
+    # Raised intentionally when the client application wishes to
+    # switch between cooked, fake and raw terminal modes.
     #
-    # @see Vedeu::Application
+    # @see Vedeu::Runtime::Application
     #
     class ModeSwitch < StandardError
 
     end # ModeSwitch
 
-    # Raised to remind me (or client application developers) that the subclass
-    # implements the functionality sought.
+    # Raised to remind me (or client application developers) that the
+    # subclass implements the functionality sought.
     #
     # @see Vedeu::Colours::Translator
     #
@@ -70,8 +72,9 @@ module Vedeu
 
     end # NotImplemented
 
-    # Raised when trying to access an interface column less than 1 or greater
-    # than 12. Vedeu is hard-wired to a 12-column layout for the time being.
+    # Raised when trying to access an interface column less than 1 or
+    # greater than 12. Vedeu is hard-wired to a 12-column layout for
+    # the time being.
     #
     # @see Vedeu::Geometry::Grid
     #

data/lib/vedeu/esc/borders.rb

@@ -7,11 +7,13 @@ module Vedeu
     # Provides border/box related escape sequences.
     #
     # @note
-    #   Refer to UTF-8 U+2500 to U+257F for border characters. More details can
-    #   be found at: http://en.wikipedia.org/wiki/Box-drawing_character
+    #   Refer to UTF-8 U+2500 to U+257F for border characters. More
+    #   details can be found at:
     #
-    #   Using the '\uXXXX' variant produces gaps in the border, whilst the
-    #   '\xXX' renders 'nicely'.
+    #   http://en.wikipedia.org/wiki/Box-drawing_character
+    #
+    #   Using the '\uXXXX' variant produces gaps in the border, whilst
+    #   the '\xXX' renders 'nicely'.
     #
     module Borders