vedeu 0.5.11 → 0.5.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: edd33e8e10532a87dc3e6ea6c7aa2142227e70f7
-  data.tar.gz: 29b39513afa32eac1564900988eb5d28d386a17a
+  metadata.gz: 31e9c17f2fcd8a9e852e9e8ebed87d34f1d7b5aa
+  data.tar.gz: 43767a98407c836ddb20a6782f7828ab7ec7ce2e
 SHA512:
-  metadata.gz: 6d1cd9b457457e795e9779b9d1265b6db9e8669d29f03ab62079250b08ecd65f1091c046351e9ae849f3b7843313828652984e1bc4561eef43e972ec600c0a18
-  data.tar.gz: 679201d647f7663cbe6a3789d2967206232efef7636642150ad53bfbc92ccbd18ad55cf0dcd2e0488edaa454405bec7332b8d003825c35de353edf58223483d5
+  metadata.gz: 69e4146a2fa2ef01d4508344ec02b4557e4e4794e1f16ee43a7b691d58132d03f0494d9e76f7ce0adcdf5553d87f66420764460cd28fe7d61dd86be8764930a7
+  data.tar.gz: f2996b4ca485971f2468367dc7448f0d1b06d94df945c0e64a178bb517c56ae19cce0cc69527839da2152a9564e557392744cabd64d24fc86de6630695152cdb

data/.yardopts

@@ -3,6 +3,7 @@
 --embed-mixin ClassMethods
 -
 docs/api.md
+docs/configuration.md
 docs/dsl.md
 docs/events.md
 docs/getting_started.md

data/README.md

@@ -49,6 +49,7 @@ documentation shortly. In the meantime, please browse the
 - [Getting Started](http://rubydoc.info/gems/vedeu/file/docs/getting_started.md)
 - [The Vedeu DSL](http://rubydoc.info/gems/vedeu/file/docs/dsl.md)
 - [The Vedeu API](http://rubydoc.info/gems/vedeu/file/docs/api.md)
+- [Vedeu Configuration](http://rubydoc.info/gems/vedeu/file/docs/configuration.md)
 - [Vedeu Events](http://rubydoc.info/gems/vedeu/file/docs/events.md)
 - [Object Graphs](http://rubydoc.info/gems/vedeu/file/docs/object_graph.md)
 

data/docs/configuration.md

@@ -0,0 +1,94 @@
+# @title Vedeu Configuration
+# Vedeu Configuration
+
+Vedeu provides a simple DSL for configuration.
+
+```ruby
+Vedeu.configure do
+
+  # add configuration options here...
+
+end
+```
+
+## Configuration Options
+
+### base_path
+{include:Vedeu::Config::API#base_path}
+
+### colour_mode
+{include:Vedeu::Config::API#colour_mode}
+{include:Vedeu::Config::CLI#colour_mode}
+
+### compression / compression!
+{include:Vedeu::Config::API#compression}
+
+### cooked / cooked!
+{include:Vedeu::Config::API#cooked}
+{include:Vedeu::Config::CLI#cooked}
+
+### debug / debug!
+{include:Vedeu::Config::API#debug}
+{include:Vedeu::Config::CLI#debug}
+
+### drb / drb!
+{include:Vedeu::Config::API#drb}
+{include:Vedeu::Config::CLI#drb}
+
+### drb_host
+{include:Vedeu::Config::API#drb_host}
+{include:Vedeu::Config::CLI#drb_host}
+
+### drb_port
+{include:Vedeu::Config::API#drb_port}
+{include:Vedeu::Config::CLI#drb_port}
+
+### drb_height
+{include:Vedeu::Config::API#drb_height}
+{include:Vedeu::Config::CLI#drb_height}
+
+### drb_width
+{include:Vedeu::Config::API#drb_width}
+{include:Vedeu::Config::CLI#drb_width}
+
+### interactive / interactive!
+{include:Vedeu::Config::API#interactive}
+{include:Vedeu::Config::CLI#interactive}
+
+### log
+{include:Vedeu::Config::API#log}
+{include:Vedeu::Config::CLI#log}
+
+### log_only
+{include:Vedeu::Config::API#log_only}
+
+### raw / raw!
+{include:Vedeu::Config::API#raw}
+{include:Vedeu::Config::CLI#raw}
+
+### renderer / renderers
+{include:Vedeu::Config::API#renderer}
+
+### root
+{include:Vedeu::Config::API#root}
+{include:Vedeu::Config::CLI#root}
+
+### run_once / run_once!
+{include:Vedeu::Config::API#run_once}
+{include:Vedeu::Config::CLI#run_once}
+
+### standalone / standalone!
+{include:Vedeu::Config::API#standalone}
+{include:Vedeu::Config::CLI#standalone}
+
+### stderr
+{include:Vedeu::Config::API#stderr}
+
+### stdin
+{include:Vedeu::Config::API#stdin}
+
+### stdout
+{include:Vedeu::Config::API#stdout}
+
+### terminal_mode
+{include:Vedeu::Config::API#terminal_mode}

data/lib/vedeu/application/application_view.rb

@@ -21,6 +21,10 @@ module Vedeu
     # @return [Vedeu::ApplicationView]
     def initialize(**params)
       @params = params
+
+      @params.each do |key, value|
+        self.class.send(:define_method, key) { value } unless respond_to?(key)
+      end
     end
 
     # @raise [Vedeu::NotImplemented] Subclasses of this class must implement

data/lib/vedeu/bindings/system.rb

@@ -140,6 +140,7 @@ module Vedeu
       def initialize!
         Vedeu.bind(:_initialize_) do
           Vedeu.ready!
+          Vedeu.trigger(:_refresh_)
         end
       end
 

data/lib/vedeu/configuration/api.rb

@@ -20,7 +20,6 @@ module Vedeu
       # override the default Vedeu configuration set in
       # {Vedeu::Configuration#defaults}.
       #
-      # @example
       #   Vedeu.configure do
       #     # ...
       #   end
@@ -41,7 +40,6 @@ module Vedeu
       # Sets boolean to allow user input. The default behaviour of Vedeu is to
       # be interactive.
       #
-      # @example
       #   Vedeu.configure do
       #     interactive! # => same as `interactive true` or `standalone false`
       #     # ...
@@ -67,7 +65,6 @@ module Vedeu
       # Sets boolean to prevent user intervention. This is the same as setting
       # {#interactive!} to false.
       #
-      # @example
       #   Vedeu.configure do
       #     standalone! # => same as `standalone true` or `interactive false`
       #     # ...
@@ -94,7 +91,6 @@ module Vedeu
       # using `run_once!` or setting `run_once` to true will allow Vedeu to
       # initialize, run any client application code, cleanup, then terminate.
       #
-      # @example
       #   Vedeu.configure do
       #     run_once!
       #     # ...
@@ -109,7 +105,6 @@ module Vedeu
 
       # Sets boolean to run a DRb server.
       #
-      # @example
       #   Vedeu.configure do
       #     drb!
       #     # ...
@@ -124,7 +119,6 @@ module Vedeu
 
       # Sets the hostname or IP address of the DRb server.
       #
-      # @example
       #   Vedeu.configure do
       #     drb_host 'localhost'
       #     # ...
@@ -138,7 +132,6 @@ module Vedeu
 
       # Sets the port of the DRb server.
       #
-      # @example
       #   Vedeu.configure do
       #     drb_port 12345
       #     # ...
@@ -152,7 +145,6 @@ module Vedeu
 
       # Sets the height of the fake terminal in the DRb server.
       #
-      # @example
       #   Vedeu.configure do
       #     drb_height 25
       #     # ...
@@ -166,7 +158,6 @@ module Vedeu
 
       # Sets the width of the fake terminal in the DRb server.
       #
-      # @example
       #   Vedeu.configure do
       #     drb_width 80
       #     # ...
@@ -179,8 +170,8 @@ module Vedeu
       end
 
       # Sets the terminal mode to `cooked`. Default terminal mode is `raw`.
+      # Also, see {Vedeu::Config::API#raw!}
       #
-      # @example
       #   Vedeu.configure do
       #     cooked!
       #     # ...
@@ -193,8 +184,8 @@ module Vedeu
       alias_method :cooked, :cooked!
 
       # Sets the terminal mode to `raw`. Default terminal mode is `raw`.
+      # Also, see {Vedeu::Config::API#cooked!}
       #
-      # @example
       #   Vedeu.configure do
       #     raw!
       #     # ...
@@ -214,7 +205,6 @@ module Vedeu
       #   Be aware that running an application with debugging enabled will
       #   affect performance.
       #
-      # @example
       #   Vedeu.configure do
       #     debug!
       #     # ...
@@ -234,7 +224,6 @@ module Vedeu
 
       # Sets the colour mode of the terminal.
       #
-      # @example
       #   Vedeu.configure do
       #     colour_mode 256
       #     # ...
@@ -258,7 +247,6 @@ module Vedeu
 
       # Sets the location of the log file.
       #
-      # @example
       #   Vedeu.configure do
       #     log '/var/log/vedeu.log'
       #     # ...
@@ -270,6 +258,9 @@ 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}.
+      #
       # @param types [Array<Symbol>] The message types which should be logged.
       # @return [Array<Symbol>]
       def log_only(*types)
@@ -279,7 +270,6 @@ module Vedeu
       # Sets the renderers for Vedeu. Each renderer added must have the class
       # method '.render' defined as this will be called when rendering content.
       #
-      # @example
       #   Vedeu.configure do
       #     renderer MyRenderer
       #     # ...
@@ -308,22 +298,21 @@ module Vedeu
       end
 
       # Sets the root of the client application. Vedeu will execute this
-      # controller first.
+      # controller with action and optional arguments first.
       #
-      # @example
       #   Vedeu.configure do
-      #     root YourApp::SomeController.new
-      #     ...
+      #     root :controller, :action, args
+      #     # ...
+      #   end
       #
-      # @param controller [Class]
+      # @param args [Array<Symbol|void>]
       # @return [Class]
-      def root(controller)
-        options[:root] = controller
+      def root(*args)
+        options[:root] = args
       end
 
       # Sets the value of STDIN.
       #
-      # @example
       #   Vedeu.configure do
       #     stdin IO.console
       #     # ...
@@ -337,7 +326,6 @@ module Vedeu
 
       # Sets the value of STDOUT.
       #
-      # @example
       #   Vedeu.configure do
       #     stdout IO.console
       #     # ...
@@ -351,7 +339,6 @@ module Vedeu
 
       # Sets the value of STDERR.
       #
-      # @example
       #   Vedeu.configure do
       #     stderr IO.console
       #     # ...
@@ -371,12 +358,6 @@ module Vedeu
       # for compression to be enabled. Setting `compression` to false will
       # disable compression.
       #
-      # @note
-      #   - Be aware that running an application without compression will
-      #     affect performance.
-      #   - Compression cannot yet be configured using a CLI option flag.
-      #
-      # @example
       #   Vedeu.configure do
       #     compression! # enabled (default)
       #     # ...
@@ -387,6 +368,11 @@ module Vedeu
       #     # ...
       #   end
       #
+      # @note
+      # - Be aware that running an application without compression will
+      #   affect performance.
+      # - Compression cannot yet be configured using a CLI option flag.
+      #
       # @param value [Boolean]
       # @return [Boolean]
       def compression(value = true)
@@ -396,7 +382,6 @@ module Vedeu
 
       # Sets the terminal mode. Valid values can be either ':raw' or ':cooked'.
       #
-      # @example
       #   Vedeu.configure do
       #     terminal_mode :raw
       #     # ...

data/lib/vedeu/configuration/cli.rb

@@ -87,6 +87,10 @@ module Vedeu
         parser.banner = "Usage: #{$PROGRAM_NAME} [options]"
       end
 
+      # CLI arguments:
+      #
+      #    -C, --colour-mode
+      #
       # @return [OptionParser]
       def colour_mode
         parser.on('-C', '--colour-mode [COLOURS]', Integer,
@@ -102,6 +106,10 @@ module Vedeu
         end
       end
 
+      # CLI arguments:
+      #
+      #    -c, --cooked
+      #
       # @return [OptionParser]
       def cooked
         parser.on('-c', '--cooked', 'Run application in cooked mode.') do
@@ -109,6 +117,10 @@ module Vedeu
         end
       end
 
+      # CLI arguments:
+      #
+      #    -d, --debug
+      #
       # @return [OptionParser]
       def debug
         parser.on('-d', '--debug', 'Run application with debugging on.') do
@@ -116,6 +128,10 @@ module Vedeu
         end
       end
 
+      # CLI arguments:
+      #
+      #    --drb
+      #
       # @return [OptionParser]
       def drb
         parser.on('--drb', 'Run application with DRb on.') do
@@ -123,6 +139,10 @@ module Vedeu
         end
       end
 
+      # CLI arguments:
+      #
+      #    --drb-height
+      #
       # @return [OptionParser]
       def drb_height
         parser.on('--drb-height',
@@ -132,6 +152,10 @@ module Vedeu
         end
       end
 
+      # CLI arguments:
+      #
+      #    --drb-host
+      #
       # @return [OptionParser]
       def drb_host
         parser.on('--drb-host',
@@ -141,6 +165,10 @@ module Vedeu
         end
       end
 
+      # CLI arguments:
+      #
+      #    --drb-port
+      #
       # @return [OptionParser]
       def drb_port
         parser.on('--drb-port', 'Set the port for the DRb server.') do |port|
@@ -149,6 +177,10 @@ module Vedeu
         end
       end
 
+      # CLI arguments:
+      #
+      #    --drb-width
+      #
       # @return [OptionParser]
       def drb_width
         parser.on('--drb-width',
@@ -158,6 +190,10 @@ module Vedeu
         end
       end
 
+      # CLI arguments:
+      #
+      #    -i, --interactive
+      #
       # @return [OptionParser]
       def interactive
         parser.on('-i', '--interactive',
@@ -166,6 +202,10 @@ module Vedeu
         end
       end
 
+      # CLI arguments:
+      #
+      #    -l, --log
+      #
       # @return [OptionParser]
       def log
         parser.on('-l', '--log [FILENAME]', String,
@@ -174,6 +214,10 @@ module Vedeu
         end
       end
 
+      # CLI arguments:
+      #
+      #    -r, --raw
+      #
       # @return [OptionParser]
       def raw
         parser.on('-r', '--raw', 'Run application in raw mode (default).') do
@@ -181,7 +225,11 @@ module Vedeu
         end
       end
 
-      # # @return [OptionParser]
+      # CLI arguments:
+      #
+      #    -s, --root
+      #
+      # @return [OptionParser]
       def root
         parser.on('-s', '--root []', String,
                   'Start the application from the specified controller.') do |c|
@@ -189,6 +237,10 @@ module Vedeu
         end
       end
 
+      # CLI arguments:
+      #
+      #    -n, --run-many
+      #
       # @return [OptionParser]
       def run_many
         parser.on('-n', '--run-many',
@@ -197,6 +249,10 @@ module Vedeu
         end
       end
 
+      # CLI arguments:
+      #
+      #    -1, --run-once
+      #
       # @return [OptionParser]
       def run_once
         parser.on('-1', '--run-once', 'Run the application loop once.') do
@@ -204,6 +260,10 @@ module Vedeu
         end
       end
 
+      # CLI arguments:
+      #
+      #    -I, --noninteractive, --standalone
+      #
       # @return [OptionParser]
       def standalone
         parser.on('-I', '--noninteractive', '--standalone',