vedeu 0.8.17 → 0.8.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 428c6ce796c2302c1c1ffdc4fe0e24dbc93bd72d
-  data.tar.gz: f2be6bebebfc68dad88801c1d28100bcd615a7fe
+  metadata.gz: bed6cd0c3c695df9f891c552340787a070f6f54a
+  data.tar.gz: 8dcad64d499e1cf9dffb5dda7451b050f9a09a12
 SHA512:
-  metadata.gz: ea73e52d7a7641e7d201508946bd444f8010c33d43b198ae2a8db66b634beb2f6604eaae721f1123a3fdb7a7580635c677419f6de963eb6c4d4eef366abf14af
-  data.tar.gz: 29571610db40d58fdb32d01ce87719da00ff8f28f5f67bb0776156d9a79a4affe5f3b48ed76b90a0fb7e87e44bfaa4c9ded1194508b6340e2cf8e8b14f5d510e
+  metadata.gz: 179414aaacba620522ea4005d8c353609ea5deab9e9ad4d7d0d5431ee31bc634ca32c42df602056a41078f8eb3a8a779758fe2a1d07257c71a037e41d1420460
+  data.tar.gz: 1ddf063acbd38734c3098c5cc88b4cb1bf0aa9240ec8d9f806be1c82c2107d80890d1b3d9c639b81264ccfcc6e230832a6b7a7e0cdb78fa659b8c7664b863722

data/Guardfile

@@ -10,7 +10,7 @@ end
 guard :minitest, all_after_pass: true,
                  focus_on_failed: true do
   watch(%r{^test/(.*)_test\.rb})
-  watch(%r{^lib/(.+)\.rb}) { |m| "test/lib/#{m[1]}_test.rb" }
+  watch(%r{^lib/(.+)\.rb})         { |m| "test/lib/#{m[1]}_test.rb" }
   watch(%r{^test/test_helper\.rb}) { 'test' }
   watch(%r{^lib/(.+)all\.rb})      { 'test' }
 end

data/docs/configuration/base_path.md

@@ -0,0 +1,11 @@
+Configure the base path of the client application.
+
+Override the base path for the application (for locating
+templates and other resources). By default the base path is
+just the current working directory but this will not work for many
+applications.
+
+    Vedeu.configure do
+      base_path '/path/to/application'
+      # ...
+    end

data/docs/configuration/colour.md

@@ -0,0 +1,6 @@
+Sets the background and foreground of the terminal.
+
+    Vedeu.configure do
+      colour background: '#ff0000', foreground: '#ffff00'
+      # ...
+    end

data/docs/configuration/colour_mode.md

@@ -0,0 +1,13 @@
+Sets the colour mode of the terminal.
+
+    Vedeu.configure do
+      colour_mode 256
+      # ...
+    end
+
+Note
+- iTerm 2 on Mac OSX will handle the true colour setting
+  (16777216), whereas Terminator on Linux will not display
+  colours correctly. For compatibility across platforms, it is
+  recommended to either not set the colour mode at all and
+  allow it to be detected, or use 256 here.

data/docs/configuration/compression.md

@@ -0,0 +1,22 @@
+Compression reduces the number of escape sequences being sent to the
+terminal which improves redraw/render/refresh rate. By default it is
+enabled.
+
+Sets boolean to enable/disable compression. Vedeu's default setting is
+for compression to be enabled. Setting `compression` to false will
+disable compression.
+
+    Vedeu.configure do
+      compression! # enabled (default)
+      # ...
+    end
+
+    Vedeu.configure do
+      compression false
+      # ...
+    end
+
+Note:
+
+- Be aware that running an application without compression will affect
+  performance.

data/docs/configuration/cooked.md

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

data/docs/configuration/debug.md

@@ -0,0 +1,20 @@
+Sets boolean to enable/disable debugging. Vedeu's default setting is
+for debugging to be disabled. Using `debug!` or setting `debug` to
+true will enable debugging.
+
+Enabling debugging will:
+- Log when an event is triggered which has no action registered.
+- Enable `Vedeu::Logging::Timer` meaning various timing information is
+  output to the log file.
+- Produce a full a backtrace to STDOUT and the log file upon
+  unrecoverable error or unhandled exception.
+
+    Vedeu.configure do
+      debug!
+      # ...
+    end
+
+    Vedeu.configure do
+      debug false
+      # ...
+    end

data/docs/configuration/drb_height.md

@@ -0,0 +1,6 @@
+Sets the height of the fake terminal in the DRb server.
+
+    Vedeu.configure do
+      drb_height 25
+      # ...
+    end

data/docs/configuration/drb_width.md

@@ -0,0 +1,6 @@
+Sets the width of the fake terminal in the DRb server.
+
+    Vedeu.configure do
+      drb_width 80
+      # ...
+    end

data/docs/configuration/fake.md

@@ -0,0 +1,6 @@
+Sets the terminal mode to `fake`. Default terminal mode is `raw`.
+
+    Vedeu.configure do
+      fake!
+      # ...
+    end

data/docs/configuration/height.md

@@ -0,0 +1,12 @@
+Sets the height of the terminal.
+
+    Vedeu.configure do
+      height 25
+
+      # or...
+
+      height = 25
+
+      # ...
+    end
+

data/docs/configuration/log.md

@@ -0,0 +1,15 @@
+Sets the location of the log file, or disables the log. By default,
+the log file is set to '/tmp/vedeu_bootstrap.log'.
+
+    # Log messages will be sent to the path given.
+    Vedeu.configure do
+      log '/var/log/vedeu.log'
+      # ...
+    end
+
+    # Log messages will be silently dropped.
+    Vedeu.configure do
+      log false
+      # ...
+    end
+

data/docs/configuration/log_except.md

@@ -0,0 +1,11 @@
+Log specific message types except those given. A complete list of
+message types can be found at {Vedeu::LOG_TYPES}.
+
+    Vedeu.configure do
+      log_except :debug, :event
+
+      # or
+      log_except [:debug, :info]
+
+      # ...
+    end

data/docs/configuration/log_only.md

@@ -0,0 +1,11 @@
+Only log specific message types. A complete list of message types can
+be found at {Vedeu::LOG_TYPES}.
+
+    Vedeu.configure do
+      log_only :debug, :event
+
+      # or
+      log_only [:debug, :info]
+
+      # ...
+    end

data/docs/configuration/mouse.md

@@ -0,0 +1,11 @@
+Sets boolean to enable/disable mouse support.
+
+    Vedeu.configure do
+      mouse! # => same as `mouse true`
+
+      # or...
+      mouse true
+
+      mouse false
+
+    end

data/docs/configuration/profile.md

@@ -0,0 +1,22 @@
+Sets boolean to enable/disable profiling. Vedeu's default setting is
+for profiling to be disabled. Using `profile!` or setting `profile` to
+true will enable profiling.
+
+Profile uses 'ruby-prof' to write a 'vedeu_profile' file to the /tmp
+directory which contains a call trace of the running application.
+Upon exit, this file can be examined to ascertain certain behaviours
+of Vedeu.
+
+Note:
+Be aware that running an application with profiling enabled will
+affect performance considerably.
+
+    Vedeu.configure do
+      profile!
+      # ...
+    end
+
+    Vedeu.configure do
+      profile false
+      # ...
+    end

data/docs/configuration/raw.md

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

data/docs/configuration/renderer.md

@@ -0,0 +1,13 @@
+Sets the renderers for Vedeu. Each renderer added must have the class
+method '.render' defined as this will be called when rendering
+content.
+
+    Vedeu.configure do
+      renderer MyRenderer
+      # ...
+    end
+
+    Vedeu.configure do
+      renderers MyRenderer, MyOtherRenderer
+      # ...
+    end

data/docs/configuration/root.md

@@ -0,0 +1,9 @@
+Configure the root class of the client application.
+
+Vedeu will execute this controller with action and optional arguments
+first.
+
+    Vedeu.configure do
+      root :controller, :action, args
+      # ...
+    end

data/docs/configuration/stderr.md

@@ -0,0 +1,6 @@
+Sets the value of STDERR.
+
+    Vedeu.configure do
+      stderr IO.console
+      # ...
+    end

data/docs/configuration/stdin.md

@@ -0,0 +1,6 @@
+Sets the value of STDIN.
+
+    Vedeu.configure do
+      stdin IO.console
+      # ...
+    end

data/docs/configuration/stdout.md

@@ -0,0 +1,6 @@
+Sets the value of STDOUT.
+
+    Vedeu.configure do
+      stdout IO.console
+      # ...
+    end

data/docs/configuration/terminal_mode.md

@@ -0,0 +1,23 @@
+Sets the terminal mode. Valid values can be either ':cooked', ':fake'
+or :raw'.
+
+    Vedeu.configure do
+      terminal_mode :cooked
+
+      # or...
+
+      terminal_mode :fake
+
+      # or...
+
+      terminal_mode :raw
+
+      # or...
+
+      terminal_mode = :raw
+      terminal_mode = :fake
+      terminal_mode = :cooked
+
+      # ... some code
+    end
+

data/docs/configuration/threaded.md

@@ -0,0 +1,3 @@
+Instructs Vedeu to use threads to perform certain actions.
+
+This can have a performance impact.

data/docs/configuration/width.md

@@ -0,0 +1,11 @@
+Sets the width of the terminal.
+
+    Vedeu.configure do
+      width 80
+
+      # or...
+
+      width = 80
+
+      # ...
+    end

data/integrations/dsl_app_001.rb

@@ -25,7 +25,7 @@ class DSLApp
     standalone!
   end
 
-  load './support/test_interface.rb'
+  load File.dirname(__FILE__) + '/support/test_interface.rb'
 
   Vedeu.render do
     view(:test_interface) do

data/integrations/dsl_app_002.rb

@@ -25,7 +25,7 @@ class DSLApp
     standalone!
   end
 
-  load './support/test_interface.rb'
+  load File.dirname(__FILE__) + '/support/test_interface.rb'
 
   Vedeu.render do
     view(:test_interface) do

data/integrations/dsl_app_003.rb

@@ -25,7 +25,7 @@ class DSLApp
     standalone!
   end
 
-  load './support/test_interface.rb'
+  load File.dirname(__FILE__) + '/support/test_interface.rb'
 
   Vedeu.render do
     view(:test_interface) do

data/integrations/dsl_app_004.rb

@@ -25,7 +25,7 @@ class DSLApp
     standalone!
   end
 
-  load './support/test_interface.rb'
+  load File.dirname(__FILE__) + '/support/test_interface.rb'
 
   Vedeu.render do
     view(:test_interface) do

data/integrations/dsl_app_005.rb

@@ -25,7 +25,7 @@ class DSLApp
     standalone!
   end
 
-  load './support/test_interface.rb'
+  load File.dirname(__FILE__) + '/support/test_interface.rb'
 
   Vedeu.render do
     view(:test_interface) do

data/integrations/dsl_app_006.rb

@@ -25,7 +25,7 @@ class DSLApp
     standalone!
   end
 
-  load './support/test_interface.rb'
+  load File.dirname(__FILE__) + '/support/test_interface.rb'
 
   Vedeu.render do
     view(:test_interface) do

data/integrations/dsl_app_007.rb

@@ -25,7 +25,7 @@ class DSLApp
     standalone!
   end
 
-  load './support/test_interface.rb'
+  load File.dirname(__FILE__) + '/support/test_interface.rb'
 
   Vedeu.render do
     view(:test_interface) do

data/integrations/dsl_app_008.rb

@@ -25,7 +25,7 @@ class DSLApp
     standalone!
   end
 
-  load './support/test_interface.rb'
+  load File.dirname(__FILE__) + '/support/test_interface.rb'
 
   Vedeu.render do
     view(:test_interface) do

data/integrations/dsl_app_009.rb

@@ -25,7 +25,7 @@ class DSLApp
     standalone!
   end
 
-  load './support/test_interface.rb'
+  load File.dirname(__FILE__) + '/support/test_interface.rb'
 
   Vedeu.render do
     view(:test_interface) do

data/integrations/dsl_app_010.rb

@@ -25,7 +25,7 @@ class DSLApp
     standalone!
   end
 
-  load './support/test_interface.rb'
+  load File.dirname(__FILE__) + '/support/test_interface.rb'
 
   Vedeu.render do
     view(:test_interface) do

data/integrations/dsl_app_011.rb

@@ -25,7 +25,7 @@ class DSLApp
     standalone!
   end
 
-  load './support/test_interface.rb'
+  load File.dirname(__FILE__) + '/support/test_interface.rb'
 
   Vedeu.render do
     view(:test_interface) do