vedeu 0.4.56 → 0.4.57

data/examples/panel_app.rb

@@ -14,18 +14,16 @@ require 'vedeu'
 #
 class VedeuPanelApp
 
-  include Vedeu
-
   # Be aware that running an application with debugging enabled will affect
   # performance.
-  configure do
+  Vedeu.configure do
     # debug!
     log '/tmp/vedeu_panel_app.log'
     # renderers Vedeu::Renderers::File.new
   end
 
   # line { centre 'Blue',        width: 20, background: '#2196f3' }
-  interface 'main_interface' do
+  Vedeu.interface 'main_interface' do
     border 'main_interface' do
       colour foreground: '#000000', background: '#cddc39' # lime
       title 'Panel: Yes/No'
@@ -39,7 +37,7 @@ class VedeuPanelApp
     end
   end
 
-  keymap('_global_') do
+  Vedeu.keymap('_global_') do
     key(:up)    { Vedeu.trigger(:_cursor_up_)    }
     key(:right) { Vedeu.trigger(:_cursor_right_) }
     key(:down)  { Vedeu.trigger(:_cursor_down_)  }
@@ -51,7 +49,7 @@ class VedeuPanelApp
     key(:tab)       { Vedeu.trigger(:_focus_next_) }
   end
 
-  renders do
+  Vedeu.renders do
     view 'main_interface' do
       lines do
         line ' '
@@ -62,12 +60,12 @@ class VedeuPanelApp
     end
   end
 
-  focus_by_name 'main_interface'
+  Vedeu.focus_by_name 'main_interface'
 
   def self.start(argv = ARGV)
     Vedeu::Launcher.execute!(argv)
   end
 
-end
+end # VedeuPanelApp
 
 VedeuPanelApp.start(ARGV)

data/examples/typed_commands/typed_commands_app.rb

@@ -9,31 +9,29 @@ require 'vedeu'
 # the functionality of 'cooked' mode.
 class VedeuTypedCommands
 
-  include Vedeu
-
-  configure do
+  Vedeu.configure do
     debug!
     log '/tmp/vedeu_typed_commands_app.log'
   end
 
-  bind(:_initialize_) { Vedeu.trigger(:_refresh_) }
+  Vedeu.bind(:_initialize_) { Vedeu.trigger(:_refresh_) }
 
-  interface 'output' do
+  Vedeu.interface 'output' do
     colour foreground: '#ff0000', background: '#000022'
     cursor!
   end
 
-  interface 'status' do
+  Vedeu.interface 'status' do
     colour foreground: '#00ff00', background: '#003300'
     cursor!
   end
 
-  interface 'command' do
+  Vedeu.interface 'command' do
     colour foreground: '#ffff00', background: '#111111'
     cursor!
   end
 
-  keymap('_global_') do
+  Vedeu.keymap('_global_') do
     key(:up,    'k') { Vedeu.trigger(:_cursor_up_)    }
     key(:right, 'l') { Vedeu.trigger(:_cursor_right_) }
     key(:down,  'j') { Vedeu.trigger(:_cursor_down_)  }
@@ -45,43 +43,43 @@ class VedeuTypedCommands
     key(:tab)       { Vedeu.trigger(:_focus_next_) }
   end
 
-  border('output') do
+  Vedeu.border('output') do
     colour foreground: '#aadd00', background: '#000022'
     hide_bottom!
   end
-  border('status') do
+  Vedeu.border('status') do
     colour foreground: '#aadd00', background: '#003300'
     hide_top!
     hide_bottom!
   end
-  border('command') do
+  Vedeu.border('command') do
     colour foreground: '#aadd00', background: '#111111'
     hide_top!
   end
 
-  geometry 'output' do
+  Vedeu.geometry 'output' do
     centred!
     height 7
     width  40
   end
 
-  geometry('status') do
+  Vedeu.geometry('status') do
     height 1
     width  40
     x      use('output').left
     y      use('output').south(0)
   end
 
-  geometry 'command' do
+  Vedeu.geometry 'command' do
     height 3
     width  40
     x      use('status').left
     y      use('status').south(0)
   end
 
-  focus_by_name 'command'
+  Vedeu.focus_by_name 'command'
 
-  renders do
+  Vedeu.renders do
     template_for('output', (File.dirname(__FILE__) + '/output.erb'), nil)
     template_for('status', (File.dirname(__FILE__) + '/status.erb'), nil)
     template_for('command', (File.dirname(__FILE__) + '/command.erb'), nil)
@@ -91,6 +89,6 @@ class VedeuTypedCommands
     Vedeu::Launcher.execute!(argv)
   end
 
-end
+end # VedeuTypedCommands
 
 VedeuTypedCommands.start(ARGV)

data/examples/view_templates_app/view_templates_app.rb

@@ -92,6 +92,6 @@ class VedeuViewTemplateApp
     Vedeu::Launcher.execute!(argv)
   end
 
-end
+end # VedeuViewTemplateApp
 
 VedeuViewTemplateApp.start(ARGV)

data/lib/vedeu/all.rb

@@ -7,7 +7,22 @@ require 'vedeu/debug'
 require 'vedeu/traps'
 
 require 'vedeu/null/all'
-require 'vedeu/geometry/all'
+
+require 'vedeu/geometry/area'
+require 'vedeu/geometry/coordinate'
+require 'vedeu/geometry/dimension'
+
+require 'vedeu/geometry/geometry'
+require 'vedeu/repositories/store'
+require 'vedeu/repositories/registerable'
+require 'vedeu/repositories/repository'
+require 'vedeu/geometry/geometries'
+require 'vedeu/geometry/grid'
+require 'vedeu/geometry/index_position'
+require 'vedeu/geometry/position_index'
+require 'vedeu/geometry/position'
+require 'vedeu/geometry/position_validator'
+
 require 'vedeu/repositories/all'
 
 require 'vedeu/api'
@@ -17,29 +32,86 @@ require 'vedeu/cli/generator/all'
 
 # load order has not been fully established beyond this point
 
-require 'vedeu/buffers/all'
-require 'vedeu/configuration/all'
-require 'vedeu/cursor/all'
-require 'vedeu/distributed/all'
+require 'vedeu/buffers/buffers'
+require 'vedeu/buffers/buffer'
+require 'vedeu/buffers/display_buffer'
+
+require 'vedeu/configuration/cli'
+require 'vedeu/configuration/api'
+require 'vedeu/configuration/configuration'
+
+require 'vedeu/repositories/all'
+
+require 'vedeu/cursor/cursor'
+require 'vedeu/cursor/cursors'
+require 'vedeu/cursor/move'
+require 'vedeu/cursor/refresh_cursor'
+require 'vedeu/cursor/reposition'
+
+require 'vedeu/distributed/uri'
+require 'vedeu/distributed/server'
+require 'vedeu/distributed/client'
+require 'vedeu/distributed/subprocess'
+require 'vedeu/distributed/test_application'
 
 require 'vedeu/dsl/all'
 
-require 'vedeu/events/all'
+require 'vedeu/repositories/collection'
+
+require 'vedeu/events/events'
+require 'vedeu/events/event'
+require 'vedeu/events/trigger'
+
 require 'vedeu/input/all'
-require 'vedeu/output/all'
+
+require 'vedeu/output/esc'
+require 'vedeu/colours/colour_translator'
+require 'vedeu/colours/background'
+require 'vedeu/colours/foreground'
+require 'vedeu/output/presentation'
+require 'vedeu/output/borders'
+require 'vedeu/output/border'
+require 'vedeu/colours/colour'
+require 'vedeu/output/compressor'
+
+require 'vedeu/output/clear/named_group'
+require 'vedeu/output/clear/named_interface'
+
+require 'vedeu/output/style'
+require 'vedeu/output/text'
+require 'vedeu/output/virtual_buffer'
+require 'vedeu/output/html_char'
+require 'vedeu/output/refresh_group'
+require 'vedeu/output/refresh'
+require 'vedeu/output/renderers/all'
+require 'vedeu/output/output'
+require 'vedeu/output/viewport'
+require 'vedeu/output/virtual_terminal'
+require 'vedeu/output/wordwrap'
+
 require 'vedeu/common'
 require 'vedeu/log'
 require 'vedeu/common'
 require 'vedeu/terminal'
 require 'vedeu/timer'
-require 'vedeu/templating/all'
+
+require 'vedeu/templating/helpers'
+require 'vedeu/templating/directive'
+require 'vedeu/templating/preprocessor'
+require 'vedeu/templating/template'
 
 require 'vedeu/main_loop'
 require 'vedeu/application'
 require 'vedeu/launcher'
 
-require 'vedeu/application/all'
+require 'vedeu/application/controller'
+require 'vedeu/application/helper'
+require 'vedeu/application/view'
+require 'vedeu/application/application_controller'
+require 'vedeu/application/application_helper'
+require 'vedeu/application/application_view'
+
 
 require 'vedeu/bootstrap'
 
-require 'vedeu/cli/all'
+require 'vedeu/cli/main'

data/lib/vedeu/api.rb

@@ -1,4 +1,11 @@
-require 'vedeu/colours/all'
+require 'vedeu/colours/colours'
+require 'vedeu/colours/backgrounds'
+require 'vedeu/colours/foregrounds'
+require 'vedeu/colours/colour_translator'
+require 'vedeu/colours/background'
+require 'vedeu/colours/foreground'
+require 'vedeu/colours/colour'
+
 require 'vedeu/buffers/buffers'
 require 'vedeu/output/borders'
 require 'vedeu/cursor/cursors'
@@ -6,12 +13,35 @@ require 'vedeu/common'
 require 'vedeu/terminal'
 require 'vedeu/timer'
 require 'vedeu/output/renderers/all'
-require 'vedeu/events/all'
-require 'vedeu/models/all'
+
+require 'vedeu/repositories/collection'
+
+require 'vedeu/events/events'
+require 'vedeu/events/event'
+require 'vedeu/events/trigger'
+
+require 'vedeu/repositories/all'
+
+require 'vedeu/models/toggleable'
+require 'vedeu/models/cell'
+require 'vedeu/models/char'
+require 'vedeu/models/escape'
+require 'vedeu/models/stream'
+require 'vedeu/models/line'
+require 'vedeu/models/interfaces'
+require 'vedeu/models/interface'
+require 'vedeu/models/composition'
+require 'vedeu/models/focus'
+require 'vedeu/models/groups'
+require 'vedeu/models/group'
+require 'vedeu/models/menus'
+require 'vedeu/models/menu'
+
 require 'vedeu/input/all'
 require 'vedeu/dsl/all'
 require 'vedeu/application'
-require 'vedeu/output/clear/all'
+require 'vedeu/output/clear/named_group'
+require 'vedeu/output/clear/named_interface'
 
 module Vedeu
 
@@ -379,20 +409,10 @@ module Vedeu
     #   @see Vedeu::Cursor#show
     def_delegators Vedeu::Cursor, :toggle_cursor
 
-    # Hide the group with the given name.
-    #
-    # @example
-    #   Vedeu.hide_group(name)
-    #
     # @!method hide_group
     #   @see Vedeu::Group#hide
     def_delegators Vedeu::Group, :hide_group
 
-    # Shows the group with the given name.
-    #
-    # @example
-    #   Vedeu.show_group(name)
-    #
     # @!method show_group
     #   @see Vedeu::Group#show
     def_delegators Vedeu::Group, :show_group

data/lib/vedeu/application.rb

@@ -2,7 +2,6 @@ module Vedeu
 
   # Orchestrates the running of the main application loop.
   #
-  # @api private
   class Application
 
     class << self

data/lib/vedeu/application/application_controller.rb

@@ -6,7 +6,6 @@ module Vedeu
   # controllers. The client application's ApplicationController will inherit
   # from this class.
   #
-  # @api private
   class ApplicationController
 
     include Vedeu::Controller

data/lib/vedeu/application/application_helper.rb

@@ -6,7 +6,6 @@ module Vedeu
   # helpers. The client application's ApplicationHelper will include this
   # module.
   #
-  # @api private
   module ApplicationHelper
 
     include Vedeu::Helper

data/lib/vedeu/application/application_view.rb

@@ -5,7 +5,6 @@ module Vedeu
   # Provides the mechanism to render views for the client application. The
   # client application's ApplicationView will inherit from this class.
   #
-  # @api private
   class ApplicationView
 
     include Vedeu::View

data/lib/vedeu/application/controller.rb

@@ -2,7 +2,6 @@ module Vedeu
 
   # Provides methods to be used by Vedeu::ApplicationController.
   #
-  # @api private
   module Controller
 
     # When included, provide these methods as class methods.

data/lib/vedeu/application/helper.rb

@@ -2,7 +2,6 @@ module Vedeu
 
   # Provides methods to be used by Vedeu::ApplicationHelper.
   #
-  # @api private
   module Helper
 
   end # Helper

data/lib/vedeu/application/view.rb

@@ -2,7 +2,6 @@ module Vedeu
 
   # Provides methods to be used by Vedeu::ApplicationView.
   #
-  # @api private
   module View
 
     # Returns the current local time.

data/lib/vedeu/bindings/all.rb

@@ -13,7 +13,6 @@ module Vedeu
   #   directly, however the produced events are all public and are highly
   #   recommended to be used.
   #
-  # @api private
   module Bindings
 
     # Setup events for running Vedeu. This method is called by Vedeu.

data/lib/vedeu/bindings/visibility.rb

@@ -60,17 +60,7 @@ module Vedeu
         end
       end
 
-      # Will hide all of the interfaces belonging to the named group. Useful for
-      # hiding part of that which is currently displaying in the terminal.
-
-      # This may be rarely used, since the action of showing a group will
-      # effectively clear the terminal and show the new group.
-      #
-      # @example
-      #   Vedeu.trigger(:_hide_group_, name)
-      #   Vedeu.hide_group(name)
-      #
-      # @return [void]
+      # @see Vedeu::Group#hide
       def hide_group!
         Vedeu.bind(:_hide_group_) do |name|
           Vedeu::Group.hide_group(name)
@@ -108,14 +98,7 @@ module Vedeu
         end
       end
 
-      # Will clear the terminal and then show all of the interfaces belonging to
-      # the named group.
-      #
-      # @example
-      #   Vedeu.trigger(:_show_group_, name)
-      #   Vedeu.show_group(name)
-      #
-      # @return [void]
+      # @see Vedeu::Group#show
       def show_group!
         Vedeu.bind(:_show_group_) do |name|
           Vedeu::Group.show_group(name)