vedeu 0.4.57 → 0.4.58

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1a0da67baa3addb0036a2b6abda7b67388a77a69
-  data.tar.gz: a485c5238c12220429d69c2bcd1349d3e6dec625
+  metadata.gz: 52a8757a96a4e695945e2c59065f847070891d3c
+  data.tar.gz: 6065e953ab86ba1b97d1989fdacf82d7cbcbbb92
 SHA512:
-  metadata.gz: 1a172e1281b71465ac807c5345e7807d6d8319e9a1933ebbeafef580ba5fffc330be8d27c35ee3713b82f0d5c7789bb1bd1e2aa124f3a82f1a0aec1b43d3bcb2
-  data.tar.gz: 241aad422c08ca44ca1671e78d6e2bab9cd80c27ffd5abe19b3b231a7bad946d8700024d3e1163cdd25d0ec806e48485d2674e6fc17dfc3e8e6930e9fa859fe6
+  metadata.gz: 30b4dbcbe0dd9a72aa9bde52d362cc6d0b8df74f4ce67143f0003cadfd5fada198db127c2d731ad1d73b8169603754adcc2d7150b0390859f661ed435ce395cd
+  data.tar.gz: 15c6d9d16e928e0c1bf8817bcee63fd759c46f17df16fd4b213625f7b7523917b322ca9ba7a4a676a550d132a26667e66fdfface9ad14e914d86b55579ec31db

data/bin/vedeu_drb_server

@@ -18,6 +18,7 @@ class VedeuTestApplication
     drb_width   80
     drb_height  25
 
+    # terminal_mode :raw
     # cooked!
     # raw!
 

data/examples/drb_app.rb

@@ -23,6 +23,7 @@ class VedeuTestApplication
     drb_width   80
     drb_height  25
 
+    # terminal_mode :raw
     # cooked!
     # raw!
 

data/lib/vedeu/all.rb

@@ -1,21 +1,34 @@
-
-# load order is important
-
 require 'vedeu/version'
+require 'vedeu/launcher'
+require 'vedeu/bootstrap'
 require 'vedeu/exceptions'
+require 'vedeu/log'
 require 'vedeu/debug'
 require 'vedeu/traps'
+require 'vedeu/common'
+require 'vedeu/terminal_mode'
+require 'vedeu/terminal'
+require 'vedeu/timer'
+require 'vedeu/main_loop'
+require 'vedeu/application'
+require 'vedeu/repositories'
 
-require 'vedeu/null/all'
+require 'vedeu/null'
+require 'vedeu/null/border'
+require 'vedeu/null/buffer'
+require 'vedeu/null/generic'
+require 'vedeu/null/geometry'
+require 'vedeu/null/interface'
+
+require 'vedeu/repositories/collection'
+require 'vedeu/repositories/store'
+require 'vedeu/repositories/registerable'
+require 'vedeu/repositories/repository'
 
 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'
@@ -23,95 +36,112 @@ require 'vedeu/geometry/position_index'
 require 'vedeu/geometry/position'
 require 'vedeu/geometry/position_validator'
 
-require 'vedeu/repositories/all'
-
-require 'vedeu/api'
-require 'vedeu/bindings/all'
-
-require 'vedeu/cli/generator/all'
-
-# load order has not been fully established beyond this point
+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/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/cursor'
 require 'vedeu/cursor/move'
 require 'vedeu/cursor/refresh_cursor'
 require 'vedeu/cursor/reposition'
 
+require 'vedeu/output/renderers'
+
+require 'vedeu/events/event_collection'
+require 'vedeu/events/events'
+require 'vedeu/events/event'
+require 'vedeu/events/trigger'
+
+require 'vedeu/models/cell'
+require 'vedeu/models/char'
+require 'vedeu/models/escape'
+require 'vedeu/models/stream'
+require 'vedeu/models/interfaces'
+require 'vedeu/models/composition'
+require 'vedeu/models/focus'
+require 'vedeu/models/groups'
+require 'vedeu/models/group'
+require 'vedeu/models/menus'
+
+require 'vedeu/templating/helpers'
+require 'vedeu/templating/directive'
+require 'vedeu/templating/preprocessor'
+require 'vedeu/templating/template'
+
+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/cli/generator/all'
+require 'vedeu/cli/main'
+
+require 'vedeu/configuration/cli'
+require 'vedeu/configuration/api'
+require 'vedeu/configuration/configuration'
+
 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/repositories/collection'
-
-require 'vedeu/events/events'
-require 'vedeu/events/event'
-require 'vedeu/events/trigger'
-
-require 'vedeu/input/all'
+require 'vedeu/dsl'
+require 'vedeu/dsl/use'
+require 'vedeu/dsl/presentation'
+require 'vedeu/dsl/border'
+require 'vedeu/dsl/composition'
+require 'vedeu/dsl/geometry'
+require 'vedeu/dsl/group'
+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/mapper'
+require 'vedeu/input/key'
+require 'vedeu/input/input'
+require 'vedeu/input/keymaps'
+require 'vedeu/input/keymap'
 
+require 'vedeu/output/clear/named_group'
+require 'vedeu/output/clear/named_interface'
 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/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/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/api'
 
-require 'vedeu/bootstrap'
+require 'vedeu/bindings/drb'
+require 'vedeu/bindings/menus'
+require 'vedeu/bindings/movement'
+require 'vedeu/bindings/system'
+require 'vedeu/bindings/visibility'
 
-require 'vedeu/cli/main'
+require 'vedeu/bindings'

data/lib/vedeu/api.rb

@@ -1,48 +1,3 @@
-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'
-require 'vedeu/common'
-require 'vedeu/terminal'
-require 'vedeu/timer'
-require 'vedeu/output/renderers/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/named_group'
-require 'vedeu/output/clear/named_interface'
-
 module Vedeu
 
   # Provides the API to Vedeu. Methods therein, and classes belonging to this

data/lib/vedeu/application.rb

@@ -34,6 +34,7 @@ module Vedeu
     end # Eigenclass
 
     # :nocov:
+
     # Returns a new instance of Vedeu::Application.
     #
     # @param configuration [Vedeu::Configuration]

data/lib/vedeu/{bindings/all.rb → bindings.rb}

@@ -1,9 +1,3 @@
-require 'vedeu/bindings/visibility'
-require 'vedeu/bindings/movement'
-require 'vedeu/bindings/menus'
-require 'vedeu/bindings/drb'
-require 'vedeu/bindings/system'
-
 module Vedeu
 
   # Binds various events for running and manipulating Vedeu.

data/lib/vedeu/bindings/system.rb

@@ -194,7 +194,7 @@ module Vedeu
       #
       # @return [void]
       def mode_switch!
-        Vedeu.bind(:_mode_switch_) { fail ModeSwitch }
+        Vedeu.bind(:_mode_switch_) { fail Vedeu::ModeSwitch }
       end
 
       # Will cause the named interface to refresh, or if a name is not given,

data/lib/vedeu/cli/generator/templates/application/config/configuration.erb

@@ -13,6 +13,7 @@ Vedeu.configure do
   # drb_width   80
   # drb_height  25
 
+  # terminal_mode :raw
   # cooked!
   # raw!
 

data/lib/vedeu/configuration/api.rb

@@ -44,12 +44,17 @@ module Vedeu
       #
       # @example
       #   Vedeu.configure do
-      #     interactive!
+      #     interactive! # => same as `interactive true` or `standalone false`
       #     # ...
       #   end
       #
       #   Vedeu.configure do
-      #     interactive false
+      #     interactive true # => Allow user input.
+      #     # ...
+      #   end
+      #
+      #   Vedeu.configure do
+      #     interactive false # => Disallow user input.
       #     # ...
       #   end
       #
@@ -65,7 +70,17 @@ module Vedeu
       #
       # @example
       #   Vedeu.configure do
-      #     standalone!
+      #     standalone! # => same as `standalone true` or `interactive false`
+      #     # ...
+      #   end
+      #
+      #   Vedeu.configure do
+      #     standalone true # => Disallow user input.
+      #     # ...
+      #   end
+      #
+      #   Vedeu.configure do
+      #     standalone false # => Allow user input.
       #     # ...
       #   end
       #
@@ -360,6 +375,35 @@ module Vedeu
       end
       alias_method :compression!, :compression
 
+      # Sets the terminal mode. Valid values can be either ':raw' or ':cooked'.
+      #
+      # @example
+      #   Vedeu.configure do
+      #     terminal_mode :raw
+      #     # ...
+      #   end
+      #
+      #   Vedeu.configure do
+      #     terminal_mode :cooked
+      #     # ...
+      #   end
+      #
+      # @param mode [Symbol] Either ':raw' or ':cooked'.
+      # @raise [Vedeu::InvalidSyntax] When the mode is not ':raw' or ':cooked'.
+      # @return [Symbol]
+      # @see Vedeu::Config::API#raw!
+      # @see Vedeu::Config::API#cooked!
+      def terminal_mode(value)
+        if value == :raw || value == :cooked
+          options[:terminal_mode] = value
+
+        else
+          fail Vedeu::InvalidSyntax, 'Terminal mode can be set to either :raw or ' \
+                              ':cooked'
+
+        end
+      end
+
       private
 
       # Returns the options set via the configuration API DSL or an empty Hash

data/lib/vedeu/configuration/configuration.rb

@@ -48,10 +48,10 @@ module Vedeu
       end
       alias_method :compression?, :compression
 
-      # Configure Vedeu with sensible defaults. If the client application sets
-      # options, override the defaults with those, and if command-line arguments
-      # are provided at application invocation, override any options with the
-      # arguments provided.
+      # Provides the mechanism to configure Vedeu. If the client application
+      # sets options, override the defaults with those, and if command-line
+      # arguments are provided at application invocation, override any options
+      # with the arguments provided.
       #
       # @example
       #   Vedeu.configure
@@ -71,11 +71,10 @@ module Vedeu
       end
 
       # Returns the configuration singleton.
+      # Append configuration methods to access the configuration variable.
       #
       # @example
       #   Vedeu.configuration
-      #     # ...
-      #   end
       #
       # @return [Vedeu::Configuration]
       def configuration
@@ -259,7 +258,7 @@ module Vedeu
     # The Vedeu default options, which of course are influenced by environment
     # variables also.
     #
-    # @return [Hash]
+    # @return [Hash<Symbol => void>]
     def defaults
       {
         base_path:     base_path,

data/lib/vedeu/distributed/templates/default_configuration.vedeu

@@ -8,6 +8,7 @@ Vedeu.configure do
   # drb_width   80
   # drb_height  25
 
+  # terminal_mode :raw
   # cooked!
   # raw!