vedeu 0.8.31 → 0.8.32

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 54d020b1ed4da7b4cf81758fa09f9dfc06112407
-  data.tar.gz: a09b4f6ac797e2948d01816492dd384fc61c88c3
+  metadata.gz: 9c6a63a708b1da36cce817a2cf967c797568f38d
+  data.tar.gz: 7d2dacec9712ceec80f1dde0cbe978cb3244ddd1
 SHA512:
-  metadata.gz: fd78a43accb8571c469797daeb2f3fd753c11540612a7001e5a67d65066d6b9b55edd97ad943b67e04e4557c39a0d9e3a6d0ffc5b7c1bb7f7f9fc9c0d53d3082
-  data.tar.gz: 048c82e69c2fd6ae30a142da63ad24109d5a0ad444ef4aa9dc94e389786e62255928117f34eb2a25e5337f8d3bbc131b8edd472da1496e1cdde7215e19288578
+  metadata.gz: be12e0fe16084dc19477645d29a26f56e49f647ae81065a448842460a385b820a12d96f35304e0e9c2c2faf25fa7afb97e211fac182ae2deacc76b248325fc30
+  data.tar.gz: 380948fa0c9f567df1b3bb776bea188ee075c5d3976e77bf26cc240cfff34e9d3f1ba82471085ef62963ff0c38f8681abb8e3b8d86e39be5f405d61506a1b140

data/docs/configuration/compression.md

@@ -18,6 +18,7 @@ disable compression.
     end
 
     # Get:
+    Vedeu.config.compression?
     Vedeu.config.compression
 
 Note:

data/docs/configuration/cooked.md

@@ -8,4 +8,4 @@ Also, see {Vedeu::Config::API#raw!}
     end
 
     # Get:
-    Vedeu.config.cooked?
+    Vedeu.config.terminal_mode

data/docs/configuration/debug.md

@@ -22,3 +22,4 @@ Enabling debugging will:
 
     # Get:
     Vedeu.config.debug?
+    Vedeu.config.debug

data/docs/configuration/drb.md

@@ -8,3 +8,4 @@ Sets boolean to run a DRb server.
 
     # Get:
     Vedeu.config.drb?
+    Vedeu.config.drb

data/docs/configuration/drb_height.md

@@ -1,6 +1,10 @@
 Sets the height of the fake terminal in the DRb server.
 
+    # Set:
     Vedeu.configure do
       drb_height 25
       # ...
     end
+
+    # Get:
+    Vedeu.config.drb_height

data/docs/configuration/drb_host.md

@@ -1,6 +1,10 @@
 Sets the hostname or IP address of the DRb server.
 
+    # Set:
     Vedeu.configure do
       drb_host 'localhost'
       # ...
     end
+
+    # Get:
+    Vedeu.config.drb_host

data/docs/configuration/drb_port.md

@@ -1,6 +1,10 @@
 Sets the port of the DRb server.
 
+    # Set:
     Vedeu.configure do
       drb_port 12345
       # ...
     end
+
+    # Get:
+    Vedeu.config.drb_port

data/docs/configuration/drb_width.md

@@ -1,6 +1,10 @@
 Sets the width of the fake terminal in the DRb server.
 
+    # Set:
     Vedeu.configure do
       drb_width 80
       # ...
     end
+
+    # Get:
+    Vedeu.config.drb_width

data/docs/configuration/fake.md

@@ -1,6 +1,10 @@
 Sets the terminal mode to `fake`. Default terminal mode is `raw`.
 
+    # Set:
     Vedeu.configure do
       fake!
       # ...
     end
+
+    # Get:
+    Vedeu.config.terminal_mode

data/docs/configuration/height.md

@@ -1,5 +1,6 @@
 Sets the height of the terminal.
 
+    # Set:
     Vedeu.configure do
       height 25
 
@@ -10,3 +11,5 @@ Sets the height of the terminal.
       # ...
     end
 
+    # Get:
+    Vedeu.config.height

data/docs/configuration/interactive.md

@@ -2,6 +2,7 @@ Sets boolean to allow user input. The default behaviour of Vedeu is to
 be interactive. This is the same as setting
 {Vedeu::Config::API#standalone} to false.
 
+    # Set:
     # same as `interactive true` or `standalone false`.
     Vedeu.configure do
       interactive!
@@ -19,3 +20,7 @@ be interactive. This is the same as setting
       interactive false
       # ...
     end
+
+    # Get:
+    Vedeu.config.interactive?
+    Vedeu.config.interactive

data/docs/configuration/log.md

@@ -3,6 +3,7 @@ the log file is set to '/tmp/vedeu_bootstrap.log'. Note: On Windows
 systems, the log directory is determined by the output from
 `Dir.tmpdir`.
 
+    # Set:
     # Log messages will be sent to the path given.
     Vedeu.configure do
       log '/var/log/vedeu.log'
@@ -15,3 +16,6 @@ systems, the log directory is determined by the output from
       # ...
     end
 
+    # Get:
+    Vedeu.config.log? # Returns whether logging is enabled
+    Vedeu.config.log  # Returns the configured log file.

data/docs/configuration/log_except.md

@@ -1,6 +1,7 @@
 Log specific message types except those given. A complete list of
 message types can be found at {Vedeu::LOG_TYPES}.
 
+    # Set:
     Vedeu.configure do
       log_except :debug, :event
 
@@ -9,3 +10,6 @@ message types can be found at {Vedeu::LOG_TYPES}.
 
       # ...
     end
+
+    # Get:
+    Vedeu.config.log_except

data/docs/configuration/log_only.md

@@ -1,6 +1,7 @@
 Only log specific message types. A complete list of message types can
 be found at {Vedeu::LOG_TYPES}.
 
+    # Set:
     Vedeu.configure do
       log_only :debug, :event
 
@@ -9,3 +10,6 @@ be found at {Vedeu::LOG_TYPES}.
 
       # ...
     end
+
+    # Get:
+    Vedeu.config.log_only

data/docs/configuration/mouse.md

@@ -1,5 +1,6 @@
 Sets boolean to enable/disable mouse support.
 
+    # Set:
     Vedeu.configure do
       mouse! # => same as `mouse true`
 
@@ -8,4 +9,9 @@ Sets boolean to enable/disable mouse support.
 
       mouse false
 
+      # ...
     end
+
+    # Get:
+    Vedeu.config.mouse?
+    Vedeu.config.mouse

data/docs/configuration/profile.md

@@ -12,6 +12,7 @@ Note:
 Be aware that running an application with profiling enabled will
 affect performance considerably.
 
+    # Set:
     Vedeu.configure do
       profile!
       # ...
@@ -21,3 +22,7 @@ affect performance considerably.
       profile false
       # ...
     end
+
+    # Get:
+    Vedeu.config.profile?
+    Vedeu.config.profile

data/docs/configuration/raw.md

@@ -1,7 +1,11 @@
 Sets the terminal mode to `raw`. Default terminal mode is `raw`. Also,
 see {Vedeu::Config::API#cooked!}
 
+    # Set:
     Vedeu.configure do
       raw!
       # ...
     end
+
+    # Get:
+    Vedeu.config.terminal_mode

data/docs/configuration/renderer.md

@@ -2,6 +2,7 @@ Sets the renderers for Vedeu. Each renderer added must have the class
 method '.render' defined as this will be called when rendering
 content.
 
+    # Set:
     Vedeu.configure do
       renderer MyRenderer
       # ...
@@ -11,3 +12,6 @@ content.
       renderers MyRenderer, MyOtherRenderer
       # ...
     end
+
+    # Get:
+    Vedeu.config.renderers

data/docs/configuration/root.md

@@ -3,7 +3,11 @@ Configure the root class of the client application.
 Vedeu will execute this controller with action and optional arguments
 first.
 
+    # Set:
     Vedeu.configure do
       root :controller, :action, args
       # ...
     end
+
+    # Get:
+    Vedeu.config.root

data/docs/configuration/run_once.md

@@ -2,7 +2,11 @@ Sets boolean to run the Vedeu main application loop once. In effect,
 using `run_once!` or setting `run_once` to true will allow Vedeu to
 initialize, run any client application code, cleanup, then terminate.
 
+    # Set:
     Vedeu.configure do
       run_once!
       # ...
     end
+
+    # Get:
+    Vedeu.config.run_once

data/docs/configuration/standalone.md

@@ -1,20 +1,21 @@
 Sets boolean to prevent user intervention. This is the same as setting
 {Vedeu::Config::API#interactive} to false.
 
-    # Same as `standalone true` or `interactive false`.
+    # Set:
     Vedeu.configure do
-      standalone!
+      standalone! # Same as `standalone true` or `interactive false`.
       # ...
     end
 
-    # => Disallow user input.
     Vedeu.configure do
-      standalone true
+      standalone true # Disallow user input.
       # ...
     end
 
-    # => Allow user input.
     Vedeu.configure do
-      standalone false
+      standalone false # Allow user input.
       # ...
     end
+
+    # Get:
+    Vedeu.config.standalone

data/docs/configuration/stderr.md

@@ -1,6 +1,10 @@
 Sets the value of STDERR.
 
+    # Set:
     Vedeu.configure do
       stderr IO.console
       # ...
     end
+
+    # Get:
+    Vedeu.config.stderr

data/docs/configuration/stdin.md

@@ -1,6 +1,10 @@
 Sets the value of STDIN.
 
+    # Set:
     Vedeu.configure do
       stdin IO.console
       # ...
     end
+
+    # Get:
+    Vedeu.config.stdin

data/docs/configuration/stdout.md

@@ -1,6 +1,10 @@
 Sets the value of STDOUT.
 
+    # Set:
     Vedeu.configure do
       stdout IO.console
       # ...
     end
+
+    # Get:
+    Vedeu.config.stdout

data/docs/configuration/terminal_mode.md

@@ -1,6 +1,7 @@
 Sets the terminal mode. Valid values can be either ':cooked', ':fake'
 or :raw'.
 
+    # Set:
     Vedeu.configure do
       terminal_mode :cooked
 
@@ -21,3 +22,5 @@ or :raw'.
       # ... some code
     end
 
+    # Get:
+    Vedeu.config.terminal_mode

data/docs/configuration/threaded.md

@@ -1,3 +1,13 @@
 Instructs Vedeu to use threads to perform certain actions.
 
 This can have a performance impact.
+
+    # Set:
+    Vedeu.configure do
+      threaded false
+      # ...
+    end
+
+    # Get:
+    Vedeu.config.threaded?
+    Vedeu.config.threaded

data/docs/configuration/width.md

@@ -1,5 +1,6 @@
 Sets the width of the terminal.
 
+    # Set:
     Vedeu.configure do
       width 80
 
@@ -9,3 +10,6 @@ Sets the width of the terminal.
 
       # ...
     end
+
+    # Get:
+    Vedeu.config.width

data/docs/dsl/by_method/add_command.md

@@ -1,4 +1,5 @@
 ### Vedeu.add_command
+
 Add a command (a collection of characters/keypresses from a
 Vedeu::Editor::Document) to the store. Used by Vedeu internally to
 store commands entered.

data/docs/dsl/by_method/add_keypress.md

@@ -1,4 +1,5 @@
 ### Vedeu.add_keypress
+
 Add a keypress to the store. Used by Vedeu internally to store a
 keypress entered.
 

data/docs/dsl/by_method/all_commands.md

@@ -1,4 +1,5 @@
 ### Vedeu.all_commands
+
 Returns an array of all commands received by Vedeu.
 
     Vedeu.all_commands

data/docs/dsl/by_method/all_keypresses.md

@@ -1,4 +1,5 @@
 ### Vedeu.all_keypresses
+
 Returns an array of all keypresses received by Vedeu.
 
     Vedeu.all_keypresses

data/docs/dsl/by_method/background_colours.md

@@ -1,4 +1,5 @@
 ### Vedeu.background_colours
+
 Manipulate the repository of background colours.
 
     Vedeu.background_colours

data/docs/dsl/by_method/bind.md

@@ -1,4 +1,5 @@
 ### Vedeu.bind
+
 Register an event by name with optional delay (throttling)
 which when triggered will execute the code contained within
 the passed block.

data/docs/dsl/by_method/bind_alias.md

@@ -1,4 +1,5 @@
 ### Vedeu.bind_alias
+
 Add events by name to the alias name group. When an alias is
 triggered, all the events stored in the group are also triggered.
 

data/docs/dsl/by_method/borders.md

@@ -1,4 +1,5 @@
 ### `borders`
+
 Repository method. Access registered borders.
 
     Vedeu.borders # [Vedeu::Borders::Repository]

data/docs/dsl/by_method/bottom.md

@@ -1,4 +1,5 @@
 ### `bottom`
+
 Enable/disable the bottom border.
 
     Vedeu.border :border_demo do

data/docs/dsl/by_method/bottom_horizontal.md

@@ -1,4 +1,5 @@
 ### `bottom_horizontal`
+
 Set the character to be used to draw the bottom horizontal
 part of the border.
 

data/docs/dsl/by_method/bottom_left.md

@@ -1,4 +1,5 @@
 ### `bottom_left`
+
 Set the character to be used to draw the bottom left corner of the
 border.