vedeu 0.6.53 → 0.6.54

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 851012d18b1c012db01d31e28a898832ef40d051
-  data.tar.gz: 4e0d8666b35747f42d090b35fdcd24ae1651b993
+  metadata.gz: f9ec93e874a9c70bde34345200a2bb628af03e63
+  data.tar.gz: 1a5e51d11cdbaff802b4169f4a6cd3f854a84898
 SHA512:
-  metadata.gz: f4a99e9cca93e0bcae05902b107e90e1d774367000711e4e990afaf2e87f640d67ccf781ab46fc1750a992522cb91b8e3953a4620934bbf97c5ab09e8cd3f8ed
-  data.tar.gz: 0bda0129905a48b8621361357ae495f8acab349dbdfce41ef962ed20887c69766284ef030d940f9cd47515610dac58dd768ce1b8c2bb12fab29a570dbe892667
+  metadata.gz: 43e8380fb175c457417c1fa586a0d0ae91d468118179d7965f2280544cfa0710858991de19c6cb34c14b192dd4959cb4da69fdaed462261b8011542cbf4629a9
+  data.tar.gz: 8315f1aca1e347d7c0de04ba0be011d42e4f1000c835e09efdf2fceed71aa6eecb42511002c45f9714cd5023b257a2d7aef6d98d6aade1fd81b0bc2702b27430

data/docs/events/system.md

@@ -109,4 +109,4 @@ here being that the raw mode is for single keypress actions, whilst
 fake and cooked modes allow the user to enter more elaborate commands-
 such as commands with arguments.
 
-    Vedeu.trigger(:_mode_switch_)
+    Vedeu.trigger(:_mode_switch_, mode)

data/lib/vedeu/borders/border.rb

@@ -109,7 +109,9 @@ module Vedeu
 
       # Returns a new instance of Vedeu::Borders::Border.
       #
-      # @param attributes [Hash]
+      # @param attributes [Hash<Symbol => Boolean|Hash|NilClass|
+      #   String|Symbol|Vedeu::Borders::Repository|
+      #   Vedeu::Presentation::Style>]
       # @option attributes bottom_left [String] The bottom left border
       #   character.
       # @option attributes bottom_right [String] The bottom right
@@ -147,7 +149,8 @@ module Vedeu
         end
       end
 
-      # @return [Hash]
+      # @return [Hash<Symbol => Boolean|Hash|NilClass|String|Symbol|
+      #   Vedeu::Borders::Repository|Vedeu::Presentation::Style>]
       def attributes
         {
           bottom_left:  @bottom_left,
@@ -265,7 +268,8 @@ module Vedeu
 
       # The default values for a new instance of this class.
       #
-      # @return [Hash]
+      # @return [Hash<Symbol => Boolean|Hash|NilClass|String|Symbol|
+      #   Vedeu::Borders::Repository|Vedeu::Presentation::Style>]
       # @see Vedeu::EscapeSequences::Borders
       def defaults
         {

data/lib/vedeu/buffers/refresh.rb

@@ -34,7 +34,7 @@ module Vedeu
       #
       # @param name [String|Symbol] The name of the interface/view to
       #   be refreshed. Defaults to `Vedeu.focus`.
-      # @param options [Hash]
+      # @param options [Hash<Symbol => Boolean>]
       # @option options content_only [Boolean]
       # @return [Vedeu::Buffers::Refresh]
       def initialize(name, options = {})

data/lib/vedeu/buffers/view.rb

@@ -2,8 +2,17 @@ module Vedeu
 
   module Buffers
 
+    # Allow the creation of individual named buffers for views.
+    #
+    # @api private
+    #
     class View
 
+      # Returns a new instance of Vedeu::Buffers::View.
+      #
+      # @param attributes [Hash<Symbol => NilClass|String|Symbol]
+      # @option attributes name [NilClass|String|Symbol]
+      # @return [Vedeu::Buffers::View]
       def initialize(attributes = {})
         defaults.merge!(attributes).each do |key, value|
           instance_variable_set("@#{key}", value || defaults.fetch(key))
@@ -12,34 +21,41 @@ module Vedeu
 
       private
 
+      # @return [Vedeu::Borders::Border]
       def border
         Vedeu.borders.by_name(name)
       end
 
+      # @return [Vedeu::Buffers::Empty]
       def buffer
         @_buffer ||= Vedeu::Buffers::Empty.new(height: border.height,
                                                name:   name,
                                                width:  border.width).buffer
       end
 
+      # @return [Vedeu::Buffers::Empty]
       def current
         @current ||= buffer
       end
 
+      # @return [Vedeu::Buffers::Empty]
       def current_reset!
         @current = buffer
       end
 
+      # @return [Hash<Symbol => NilClass|String|Symbol]
       def defaults
         {
           name: ''
         }
       end
 
+      # @return [Vedeu::Buffers::Empty]
       def dirty
         @dirty ||= buffer
       end
 
+      # @return [Vedeu::Buffers::Empty]
       def dirty_reset!
         @dirty = buffer
       end

data/lib/vedeu/colours/colour.rb

@@ -65,7 +65,8 @@ module Vedeu
 
       # Returns a new instance of Vedeu::Colours::Colour.
       #
-      # @param attributes [Hash]
+      # @param attributes [Hash<Symbol => String|
+      #   Vedeu::Colours::Background|Vedeu::Colours:Foreground>]
       # @option attributes background [String]
       # @option attributes foreground [String]
       # @return [Vedeu::Colours::Colour]
@@ -131,10 +132,12 @@ module Vedeu
 
       private
 
+      # @return [Hash<Symbol => Vedeu::Colours::Background|
+      #   Vedeu::Colours:Foreground]
       def defaults
         {
           background: Vedeu::Colours::Background.new,
-          foreground: Vedeu::Colours::Foreground.new
+          foreground: Vedeu::Colours::Foreground.new,
         }
       end
 

data/lib/vedeu/configuration/api.rb

@@ -275,6 +275,11 @@ module Vedeu
       #
       #   Vedeu.configure do
       #     height 25
+      #
+      #     # or...
+      #
+      #     height = 25
+      #
       #     # ...
       #   end
       #
@@ -283,6 +288,7 @@ module Vedeu
       def height(height = 25)
         options[:height] = height
       end
+      alias_method :height=, :height
 
       # Sets the location of the log file.
       #
@@ -478,6 +484,12 @@ module Vedeu
       #
       #     terminal_mode :raw
       #
+      #     # or...
+      #
+      #     terminal_mode = :raw
+      #     terminal_mode = :fake
+      #     terminal_mode = :cooked
+      #
       #     # ... some code
       #   end
       #
@@ -493,11 +505,17 @@ module Vedeu
 
         options[:terminal_mode] = mode
       end
+      alias_method :terminal_mode=, :terminal_mode
 
       # Sets the width of the terminal.
       #
       #   Vedeu.configure do
       #     width 80
+      #
+      #     # or...
+      #
+      #     width = 80
+      #
       #     # ...
       #   end
       #
@@ -506,6 +524,7 @@ module Vedeu
       def width(width = 80)
         options[:width] = width
       end
+      alias_method :width=, :width
 
       # Sets the background of the terminal.
       #
@@ -551,7 +570,7 @@ module Vedeu
       #   end
       #
       # @param attrs [Hash<Symbol => String>]
-      # @return [Hash]
+      # @return [Hash<Symbol => void>]
       def colour(attrs = {})
         options[:background] = background(attrs[:background])
         options[:foreground] = foreground(attrs[:foreground])
@@ -600,7 +619,7 @@ module Vedeu
       # Returns the options set via the configuration API DSL or an
       # empty Hash when none were set.
       #
-      # @return [Hash]
+      # @return [Hash<Symbol => void>]
       def options
         @options ||= {}
       end

data/lib/vedeu/configuration/configuration.rb

@@ -9,8 +9,8 @@ module Vedeu
     # Custom log for configuration.
     #
     # @param from [String] Which configuration set the options.
-    # @param options [Hash] The configuration options set.
-    # @return [Hash] The options param.
+    # @param options [Hash<Symbol => void>] The configuration options set.
+    # @return [Hash<Symbol => void>] The options param.
     def log(from, options)
       options.each do |option, value|
         Vedeu.log(type:    :config,
@@ -65,14 +65,14 @@ module Vedeu
       #     # ...
       #   end
       #
-      # @param opts [Hash]
+      # @param opts [Hash<Symbol => void>]
       # @option opts stdin [File|IO]
       # @option opts stdout [File|IO]
       # @option opts stderr [File|IO]
       # @param block [Proc]
       # @raise [Vedeu::Error::InvalidSyntax]
       #   When the required block is not given.
-      # @return [Hash]
+      # @return [Hash<Symbol => void>]
       def configure(opts = {}, &block)
         instance.configure(opts, &block)
       end
@@ -281,7 +281,7 @@ module Vedeu
 
       # Reset the configuration to the default values.
       #
-      # @return [Hash]
+      # @return [Hash<Symbol => void>]
       def reset!
         instance.reset!
       end
@@ -289,7 +289,7 @@ module Vedeu
     end # Eigenclass
 
     # @!attribute [r] options
-    # @return [Hash]
+    # @return [Hash<Symbol => void>]
     attr_reader :options
 
     # Create a new singleton instance of Vedeu::Configuration.
@@ -303,7 +303,7 @@ module Vedeu
     # application to modify it via the configuration API.
     #
     # @param block [Proc]
-    # @return [Hash]
+    # @return [Hash<Symbol => void>]
     def configure(opts = {}, &block)
       @options.merge!(opts)
 
@@ -316,7 +316,7 @@ module Vedeu
 
     # Reset the configuration to the default values.
     #
-    # @return [Hash]
+    # @return [Hash<Symbol => void>]
     def reset!
       @options = defaults
     end

data/lib/vedeu/cursors/cursor.rb

@@ -47,7 +47,8 @@ module Vedeu
 
       # Returns a new instance of Vedeu::Cursors::Cursor.
       #
-      # @param attributes [Hash]
+      # @params attributes [Hash<Symbol => Boolean|Fixnum|String|
+      #   Vedeu::Cursors::Repository>]
       # @option attributes name [String|Symbol] The name of the
       #   interface this cursor belongs to.
       # @option attributes ox [Fixnum] The offset x coordinate.
@@ -67,7 +68,8 @@ module Vedeu
         end
       end
 
-      # @return [Hash]
+      # @return [Hash<Symbol => Boolean|Fixnum|String|
+      #   Vedeu::Cursors::Repository>]
       def attributes
         {
           name:       @name,
@@ -267,7 +269,8 @@ module Vedeu
 
       # The default values for a new instance of this class.
       #
-      # @return [Hash]
+      # @return [Hash<Symbol => Boolean|Fixnum|String|
+      #   Vedeu::Cursors::Repository>]
       def defaults
         {
           name:       '',
@@ -285,7 +288,7 @@ module Vedeu
         Vedeu::Models::Escape.new(position: position, value: visibility)
       end
 
-      # @return [Hash]
+      # @return [Hash<Symbol => Fixnum>]
       def new_attributes(new_y = y, new_x = x, new_oy = oy, new_ox = ox)
         attributes.merge!(x: new_x, y: new_y, ox: new_ox, oy: new_oy)
       end

data/lib/vedeu/distributed/test_application.rb

@@ -93,7 +93,7 @@ module Vedeu
 
     # @todo Don't like all this file reading.
     #
-    # @return [Hash]
+    # @return [Hash<Symbol => String>]
     def defaults
       {
         borders:       read('default_borders.vedeu'),

data/lib/vedeu/dsl/composition.rb

@@ -89,7 +89,7 @@ module Vedeu
       #   use relative paths.
       # @param object [Object] The object for which the values of
       #   template's variables can be obtained.
-      # @param options [Hash] See {Vedeu::Output::Wordwrap}
+      # @param options [Hash<Symbol => void>] See {Vedeu::Output::Wordwrap}
       # @raise [Vedeu::Error::MissingRequired]
       # @return [Vedeu::Views::Views<Vedeu::Views::View>]
       def template_for(name, filename, object = nil, options = {})
@@ -116,7 +116,7 @@ module Vedeu
 
       # @param name [String|Symbol]
       # @param lines [Vedeu::Views::Lines]
-      # @return [Hash]
+      # @return [Hash<Symbol => void>]
       def template_attributes(name, lines)
         new_attributes(name).merge!(value: lines)
       end
@@ -125,7 +125,7 @@ module Vedeu
       # interface attributes defined by the interface.
       #
       # @param name [String|Symbol] The name of the interface.
-      # @return [Hash]
+      # @return [Hash<Symbol => void>]
       def new_attributes(name)
         existing_attributes(name).merge!(attributes)
       end
@@ -133,7 +133,7 @@ module Vedeu
       # Retrieve the attributes of the interface by name.
       #
       # @param name [String|Symbol] The name of the interface.
-      # @return [Hash]
+      # @return [Hash<Symbol => void>]
       def existing_attributes(name)
         Vedeu.interfaces.by_name(name).attributes
       end

data/lib/vedeu/dsl/presentation.rb

@@ -66,7 +66,8 @@ module Vedeu
       #   stream overrides previously defined entries in the same
       #   block.
       #
-      # @param attrs [Hash] See {Vedeu::Colours::Colour}
+      # @param attrs [Hash<Symbol => void>]
+      #   See {Vedeu::Colours::Colour}
       #
       # @example
       #   interface 'my_interface' do

data/lib/vedeu/dsl/stream.rb

@@ -25,7 +25,7 @@ module Vedeu
       #
       # Overrides {Vedeu::DSL#attributes}.
       #
-      # @return [Hash]
+      # @return [Hash<Symbol => void>]
       def attributes
         {
           client: client,

data/lib/vedeu/dsl/text.rb

@@ -50,7 +50,7 @@ module Vedeu
       #
       # @param value [String|Object] A string or object that responds
       #   to `to_s`.
-      # @param options [Hash] Text options.
+      # @param options [Hash<Symbol => void>] Text options.
       # @option options :anchor [Symbol] One of `:left`,
       #   `:centre`/`:center`, or `:right`.
       # @option options :width [Integer|NilClass] The width of the

data/lib/vedeu/editor/capture.rb

@@ -34,22 +34,10 @@ module Vedeu
         keys = console.getch
 
         if keys.ord == ESCAPE_KEY_CODE
-          @chars = 5
-
-          begin
-            keys << console.read_nonblock(@chars)
-
-          rescue IO::WaitReadable
-            IO.select([console])
-            @chars -= 1
-            retry
-
-          rescue IO::WaitWritable
-            IO.select(nil, [console])
-            @chars -= 1
-            retry
-
-          end
+          keys << console.read_nonblock(5) rescue nil
+          keys << console.read_nonblock(4) rescue nil
+          keys << console.read_nonblock(3) rescue nil
+          keys << console.read_nonblock(2) rescue nil
         end
 
         return Vedeu::Input::Mouse.click(keys) if click?(keys)

data/lib/vedeu/editor/cursor.rb

@@ -39,7 +39,7 @@ module Vedeu
 
       # Returns a new instance of Vedeu::Editor::Cursor.
       #
-      # @param attributes [Hash]
+      # @param attributes [Hash<Symbol => Fixnum|String|Symbol>]
       # @option attributes y [Fixnum] The current line.
       # @option attributes x [Fixnum] The current character with the
       #   line.

data/lib/vedeu/editor/document.rb

@@ -44,7 +44,8 @@ module Vedeu
       #   parameter, then it is added with the respective value from
       #   #defaults.
       #
-      # @param attributes [Hash]
+      # @param attributes [Hash<Symbol => String|Symbol|
+      #   Vedeu::Repositories::Repository>]
       # @option attributes data [String]
       # @option attributes name [String|Symbol]
       # @option attributes repository

data/lib/vedeu/events/event.rb

@@ -41,8 +41,8 @@ module Vedeu
         #
         # @param name [Symbol] The name of the event to be triggered
         #   later.
-        # @param options [Hash] The options to register the event
-        #   with.
+        # @param options [Hash<Symbol => void>] The options to
+        #   register the event with.
         # @option options :delay [Fixnum|Float] Limits the execution
         #   of the triggered event to only execute when first
         #   triggered, with subsequent triggering being ignored until
@@ -281,14 +281,14 @@ module Vedeu
       # Combines the options provided at instantiation with the
       # default values.
       #
-      # @return [Hash]
+      # @return [Hash<Symbol => void>]
       def options
         defaults.merge!(@options)
       end
 
       # The default values for a new instance of this class.
       #
-      # @return [Hash]
+      # @return [Hash<Symbol => void>]
       def defaults
         {
           delay:      0.0,

data/lib/vedeu/geometry/area.rb

@@ -32,7 +32,7 @@ module Vedeu
       attr_reader :xn
       alias_method :right, :xn
 
-      # @param attributes [Hash]
+      # @param attributes [Hash<Symbol => Boolean|Fixnum|Symbol>]
       # @option attributes y [Fixnum]
       # @option attributes yn [Fixnum]
       # @option attributes y_yn [Fixnum]

data/lib/vedeu/geometry/coordinate.rb

@@ -10,7 +10,7 @@ module Vedeu
 
       # Return a new instance of Vedeu::Geometry::Coordinate.
       #
-      # @param attributes [Hash]
+      # @param attributes [Hash<Symbol => Fixnum|String|Symbol>]
       # @option attributes name [String|Symbol]
       # @option attributes type [Symbol]
       # @option attributes offset [Fixnum]
@@ -161,7 +161,7 @@ module Vedeu
 
       # The default values for a new instance of this class.
       #
-      # @return [Hash]
+      # @return [Hash<Symbol => Fixnum|String|Symbol>]
       def defaults
         {
           name:   '',

data/lib/vedeu/geometry/geometry.rb

@@ -84,7 +84,8 @@ module Vedeu
 
       # Returns a new instance of Vedeu::Geometry::Geometry.
       #
-      # @param attributes [Hash]
+      # @param attributes [Hash<Symbol => Boolean|Fixnum|String|
+      #   Symbol|Vedeu::Geometry::Repository]
       # @option attributes horizontal_alignment [Symbol]
       # @option attributes vertical_alignment [Symbol]
       # @option attributes maximised [Boolean]
@@ -103,7 +104,8 @@ module Vedeu
         end
       end
 
-      # @return [Hash]
+      # @return [Hash<Symbol => Boolean|Fixnum|String|Symbol|
+      #   Vedeu::Geometry::Repository]
       def attributes
         {
           client:               @client,
@@ -238,7 +240,7 @@ module Vedeu
         @area = Vedeu::Geometry::Area.from_attributes(area_attributes)
       end
 
-      # @return [Hash<Symbol => Boolean, Fixnum>]
+      # @return [Hash<Symbol => Boolean|Fixnum>]
       def area_attributes
         {
           horizontal_alignment: @horizontal_alignment,
@@ -253,6 +255,11 @@ module Vedeu
         }
       end
 
+      # @return [Vedeu::Borders::Border]
+      def border
+        @border = Vedeu.borders.by_name(name)
+      end
+
       # When moving an interface;
       # 1) Reset the alignment and maximised states to false;
       #    it wont be aligned to a side if moved, and cannot be moved
@@ -281,7 +288,8 @@ module Vedeu
 
       # Returns the default options/attributes for this class.
       #
-      # @return [Hash]
+      # @return [Hash<Symbol => Boolean|Fixnum|NilClass|String|Symbol|
+      #   Vedeu::Geometry::Repository]
       def defaults
         {
           client:               nil,

data/lib/vedeu/groups/group.rb

@@ -26,7 +26,8 @@ module Vedeu
       #   A group being visible or not may not necessarily mean the
       #   members are of the same state.
       #
-      # @param attributes [Hash]
+      # @param attributes [Hash<Symbol => Boolean|Set|String|
+      #   Vedeu::Groups::Repository]
       # @option attributes members [Set] A collection of names of
       #   interfaces belonging to this group.
       # @option attributes name [String|Symbol] The name of the group.
@@ -162,7 +163,8 @@ module Vedeu
 
       # Returns the default options/attributes for this class.
       #
-      # @return [Hash]
+      # @return [Hash<Symbol => Boolean|Set|String|
+      #   Vedeu::Groups::Repository]
       def defaults
         {
           members:    Set.new,

data/lib/vedeu/input/all.rb

@@ -13,8 +13,8 @@ require 'vedeu/input/capture'
 require 'vedeu/input/dsl'
 require 'vedeu/input/key'
 require 'vedeu/input/keymap'
-require 'vedeu/input/keymaps'
 require 'vedeu/input/mapper'
 require 'vedeu/input/mouse'
+require 'vedeu/input/repository'
 require 'vedeu/input/store'
 require 'vedeu/input/translator'

data/lib/vedeu/input/keymap.rb

@@ -18,7 +18,8 @@ module Vedeu
 
       # Returns a new instance of Vedeu::Input::Keymap.
       #
-      # @param attributes [Hash]
+      # @param attributes [Hash<Symbol => Array|String|Symbol|
+      #   Vedeu::Input::Keys|Vedeu::Repositories::Repository>]
       # @option attributes name [String|Symbol] The name of the
       #   keymap.
       # @option attributes keys [Vedeu::Input::Keys|Array]
@@ -89,12 +90,12 @@ module Vedeu
 
       # Returns the default options/attributes for this class.
       #
-      # @return [Hash]
+      # @return [Hash<Symbol => Array|String|Vedeu::Input::Repository]
       def defaults
         {
           name:       '',
           keys:       [],
-          repository: Vedeu::Input::Keymaps.keymaps,
+          repository: Vedeu::Input::Repository.keymaps,
         }
       end
 

data/lib/vedeu/input/{keymaps.rb → repository.rb}

@@ -4,13 +4,13 @@ module Vedeu
 
     # Allows the storing of keymaps.
     #
-    class Keymaps < Vedeu::Repositories::Repository
+    class Repository < Vedeu::Repositories::Repository
 
       singleton_class.send(:alias_method, :keymaps, :repository)
 
       real Vedeu::Input::Keymap
 
-    end # Keymaps
+    end # Repository
 
   end # Input
 
@@ -20,8 +20,8 @@ module Vedeu
   #   Vedeu.keymaps
   #
   # @!method keymaps
-  # @return [Vedeu::Input::Keymaps]
-  def_delegators Vedeu::Input::Keymaps,
+  # @return [Vedeu::Input::Repository]
+  def_delegators Vedeu::Input::Repository,
                  :keymaps
 
 end # Vedeu

data/lib/vedeu/logging/clock_time.rb

@@ -10,16 +10,15 @@ module Vedeu
     #
     module ClockTime
 
-      if defined?(Process::CLOCK_MONOTONIC)
-        def self.clock_time
+      # @return [Float|Time]
+      def self.clock_time
+        if defined?(Process::CLOCK_MONOTONIC)
           Process.clock_gettime(Process::CLOCK_MONOTONIC)
-        end
 
-      else
-        def self.clock_time
+        else
           Time.now
-        end
 
+        end
       end
 
     end # ClockTime

data/lib/vedeu/runtime/application.rb

@@ -44,7 +44,7 @@ module Vedeu
       #
       # @param configuration [Vedeu::Configuration]
       # @return [Vedeu::Runtime::Application]
-      def initialize(configuration)
+      def initialize(configuration = Vedeu::Configuration)
         @configuration = configuration
       end
 
@@ -120,11 +120,7 @@ module Vedeu
         Vedeu::Runtime::MainLoop.start! { yield }
 
       rescue Vedeu::Error::ModeSwitch
-        Vedeu::Terminal.switch_mode!
-
-        Vedeu.trigger(:_drb_restart_)
-
-        Vedeu::Runtime::Application.restart(configuration)
+        Vedeu::Runtime::Application.restart(Vedeu::Configuration)
       end
 
       # :nocov:
@@ -144,7 +140,9 @@ module Vedeu
   Vedeu.bind(:_exit_) { Vedeu.exit }
 
   # See {file:docs/events/system.md#\_mode_switch_}
-  Vedeu.bind(:_mode_switch_) { fail Vedeu::Error::ModeSwitch }
+  Vedeu.bind(:_mode_switch_) do |mode|
+    Vedeu::Runtime::MainLoop.mode_switch!(mode)
+  end
 
   # See {file:docs/events/system.md#\_cleanup_}
   Vedeu.bind(:_cleanup_) do

data/lib/vedeu/runtime/main_loop.rb

@@ -14,13 +14,26 @@ module Vedeu
 
         # :nocov:
 
+        # @param mode [Symbol]
+        def mode_switch!(mode = nil)
+          @loop        = false
+          @mode_switch = true
+
+          Vedeu::Terminal::Mode.switch_mode!(mode)
+
+          Vedeu.trigger(:_drb_restart_)
+
+          fail Vedeu::Error::ModeSwitch
+        end
+
         # Start the main loop.
         #
         # @return [void]
         # @yieldreturn [void] The client application.
         def start!
-          @started = true
-          @loop    = true
+          @started     = true
+          @loop        = true
+          @mode_switch = false
 
           Vedeu.trigger(:_refresh_cursor_, Vedeu.focus)
 
@@ -35,8 +48,6 @@ module Vedeu
           Vedeu.log(message: 'Vedeu execution interrupted, exiting.'.freeze)
         end
 
-        # :nocov:
-
         # Signal that we wish to terminate the running application.
         #
         # @return [void]
@@ -44,8 +55,6 @@ module Vedeu
           @loop = false
         end
 
-        # :nocov:
-
         # Check the application has started and we wish to continue
         # running.
         #

data/lib/vedeu/terminal/mode.rb

@@ -6,6 +6,7 @@ module Vedeu
     #
     module Mode
 
+      include Vedeu::Common
       extend self
 
       # Returns a boolean indicating whether the terminal is currently
@@ -20,7 +21,7 @@ module Vedeu
       #
       # @return [Symbol]
       def cooked_mode!
-        @mode = :cooked
+        switch_mode!(:cooked)
       end
 
       # Returns a boolean indicating whether the terminal is currently
@@ -35,7 +36,7 @@ module Vedeu
       #
       # @return [Symbol]
       def fake_mode!
-        @mode = :fake
+        switch_mode!(:fake)
       end
 
       # Returns a boolean indicating whether the terminal is currently
@@ -50,18 +51,26 @@ module Vedeu
       #
       # @return [Symbol]
       def raw_mode!
-        @mode = :raw
+        switch_mode!(:raw)
       end
 
-      # Toggles the terminal's mode between `cooked`, `fake` and
-      # `raw`, depending on its current mode.
+      # Changes the mode of the terminal to the mode given or toggles
+      # the terminal mode between `cooked`, `fake` and `raw`,
+      # depending on the current mode.
       #
+      # @param mode [NilClass|Symbol]
       # @return [Symbol]
-      def switch_mode!
-        return fake_mode!   if raw_mode?
-        return cooked_mode! if fake_mode?
+      def switch_mode!(mode = nil)
+        if present?(mode) && valid_mode?(mode)
+          Vedeu.configure { |config| config.terminal_mode = mode }
 
-        raw_mode!
+        else
+          return fake_mode!   if raw_mode?
+          return cooked_mode! if fake_mode?
+
+          raw_mode!
+
+        end
       end
 
       # Returns the mode of the terminal, either `:cooked`, `:fake` or
@@ -70,7 +79,27 @@ module Vedeu
       #
       # @return [Symbol]
       def mode
-        @mode ||= Vedeu::Configuration.terminal_mode
+        @mode = Vedeu::Configuration.terminal_mode
+      end
+
+      private
+
+      # Returns a boolean indicating whether the given mode is valid.
+      #
+      # @param mode [Symbol] Should be one of the modes listed in
+      #   {#valid_modes}.
+      # @return [Boolean]
+      def valid_mode?(mode)
+        valid_modes.include?(mode)
+      end
+
+      # @return [Array<Symbol>]
+      def valid_modes
+        [
+          :cooked,
+          :fake,
+          :raw,
+        ]
       end
 
     end # Mode

data/lib/vedeu/version.rb

@@ -1,6 +1,6 @@
 module Vedeu
 
   # The current version of Vedeu.
-  VERSION = '0.6.53'.freeze
+  VERSION = '0.6.54'.freeze
 
 end

data/test/lib/vedeu/input/{keymaps_test.rb → repository_test.rb}

@@ -4,13 +4,13 @@ module Vedeu
 
   module Input
 
-    describe Keymaps do
+    describe Repository do
 
-      let(:described) { Vedeu::Input::Keymaps }
+      let(:described) { Vedeu::Input::Repository }
 
       it { described.must_respond_to(:keymaps) }
 
-    end # Keymaps
+    end # Repository
 
   end # Input
 

data/test/lib/vedeu/terminal/mode_test.rb

@@ -51,41 +51,67 @@ module Vedeu
       end
 
       describe '.switch_mode!' do
-        subject { described.switch_mode! }
-
-        it 'returns a Symbol' do
-          subject.must_be_instance_of(Symbol)
+        let(:mode) {}
+
+        subject { described.switch_mode!(mode) }
+
+        context 'when the mode is not given' do
+          it 'returns :fake if previously :raw' do
+            described.raw_mode!
+            subject
+            Vedeu::Configuration.terminal_mode.must_equal(:fake)
+          end
+
+          it 'returns :cooked if previously :fake' do
+            described.fake_mode!
+            subject
+            Vedeu::Configuration.terminal_mode.must_equal(:cooked)
+          end
+
+          it 'returns :raw if previously :cooked' do
+            described.cooked_mode!
+            subject
+            Vedeu::Configuration.terminal_mode.must_equal(:raw)
+          end
         end
 
-        it 'returns :fake if previously :raw' do
-          described.raw_mode!
-          subject.must_equal(:fake)
-        end
+        context 'when the mode is given' do
+          let(:mode) { :cooked }
 
-        it 'returns :cooked if previously :fake' do
-          described.fake_mode!
-          subject.must_equal(:cooked)
-        end
+          it {
+            subject
+            Vedeu::Configuration.terminal_mode.must_equal(:cooked)
+          }
 
-        it 'returns :raw if previously :cooked' do
-          described.cooked_mode!
-          subject.must_equal(:raw)
+          context 'when the mode given is not valid' do
+            let(:mode) { :invalid }
+
+            before { described.cooked_mode! }
+
+            it {
+              subject
+              Vedeu::Configuration.terminal_mode.must_equal(:raw)
+            }
+          end
         end
       end
 
       describe '.mode' do
         subject { described.mode }
 
-        before do
-          described.raw_mode!
-          Vedeu::Configuration.stubs(:terminal_mode).returns(:raw)
-        end
+        before { described.raw_mode! }
 
         it { subject.must_be_instance_of(Symbol) }
 
         it 'returns the configured terminal mode' do
           subject.must_equal(:raw)
         end
+
+        context 'when the mode has been changed' do
+          before { described.fake_mode! }
+
+          it { subject.must_equal(:fake) }
+        end
       end
 
     end # Mode

data/test/support/examples/material_colours_app.rb

@@ -120,7 +120,10 @@ class VedeuMaterialColoursApp
     end
 
     key('q')        { Vedeu.trigger(:_exit_) }
-    key(:escape)    { Vedeu.trigger(:_mode_switch_) }
+    # key(:escape)    { Vedeu.trigger(:_mode_switch_, :fake) }
+    key(:f1)    { Vedeu.trigger(:_mode_switch_, :fake) }
+    key(:f2)    { Vedeu.trigger(:_mode_switch_, :raw) }
+    key(:f3)    { Vedeu.trigger(:_mode_switch_, :cooked) }
     key(:shift_tab) { Vedeu.trigger(:_focus_prev_) }
     key(:tab)       { Vedeu.trigger(:_focus_next_) }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vedeu
 version: !ruby/object:Gem::Version
-  version: 0.6.53
+  version: 0.6.54
 platform: ruby
 authors:
 - Gavin Laking
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-13 00:00:00.000000000 Z
+date: 2015-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: guard
@@ -436,9 +436,9 @@ files:
 - lib/vedeu/input/dsl.rb
 - lib/vedeu/input/key.rb
 - lib/vedeu/input/keymap.rb
-- lib/vedeu/input/keymaps.rb
 - lib/vedeu/input/mapper.rb
 - lib/vedeu/input/mouse.rb
+- lib/vedeu/input/repository.rb
 - lib/vedeu/input/store.rb
 - lib/vedeu/input/translator.rb
 - lib/vedeu/interfaces/all.rb
@@ -617,9 +617,9 @@ files:
 - test/lib/vedeu/input/dsl_test.rb
 - test/lib/vedeu/input/key_test.rb
 - test/lib/vedeu/input/keymap_test.rb
-- test/lib/vedeu/input/keymaps_test.rb
 - test/lib/vedeu/input/mapper_test.rb
 - test/lib/vedeu/input/mouse_test.rb
+- test/lib/vedeu/input/repository_test.rb
 - test/lib/vedeu/input/store_test.rb
 - test/lib/vedeu/input/translator_test.rb
 - test/lib/vedeu/interfaces/clear_test.rb
@@ -828,9 +828,9 @@ test_files:
 - test/lib/vedeu/input/dsl_test.rb
 - test/lib/vedeu/input/key_test.rb
 - test/lib/vedeu/input/keymap_test.rb
-- test/lib/vedeu/input/keymaps_test.rb
 - test/lib/vedeu/input/mapper_test.rb
 - test/lib/vedeu/input/mouse_test.rb
+- test/lib/vedeu/input/repository_test.rb
 - test/lib/vedeu/input/store_test.rb
 - test/lib/vedeu/input/translator_test.rb
 - test/lib/vedeu/interfaces/clear_test.rb