vedeu 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7524aaacdae0af0c028b3fe2f6eabbea601099c8
-  data.tar.gz: a8ed59caec01210c9a71971828ffabf1c994fbc9
+  metadata.gz: f6d179b45a82d00d57376efe3683b168f9184554
+  data.tar.gz: 6ba43f5ff413f4165fda160cd425e410e62b57f7
 SHA512:
-  metadata.gz: 91b571759068fef75df5942f4ca957a8d4237c2dc8b77731fb11df1178e043819f493ebf96d615b892172a9d29a2536f118ebee39d960e362b76c855ce4da4f3
-  data.tar.gz: 917454f5c7d6d280552259bc795dd9b54a16dc162b24919e3edc17f0e6c475f7b2cbece626626c0c4043294eb0ff5d375566486d54773a70901b7ac639534ccf
+  metadata.gz: 6d7d5f0548a15c0df95506edbde7600242c6c16e9963028eb0dda37160f73d96fc066e20f293093a06d428100d88b055e59cef0788856fc2c23d27dc5e3e99e8
+  data.tar.gz: 4e8d42728d9dfb365402aac29cb6fb737f7af73c9fb4310c03ffbf0d7c778f7a39ebe6f73877d434abd74fc9b3152ad854198b2791d285d63f09ac8027d88c9d

data/lib/vedeu/all.rb

@@ -5,7 +5,7 @@ require 'vedeu/exceptions'
 require 'vedeu/log/log'
 require 'vedeu/log/debug'
 require 'vedeu/log/timer'
-require 'vedeu/traps'
+require 'vedeu/runtime/traps'
 require 'vedeu/common'
 require 'vedeu/terminal_mode'
 require 'vedeu/runtime/router'

data/lib/vedeu/application/controller.rb

@@ -25,7 +25,7 @@ module Vedeu
       #   end
       #
       # @param controller_name [Symbol] The name of the controller.
-      # @return [void]
+      # @return [Hash<Symbol => Hash<Symbol => String, Array<Symbol>>>]
       def controller(controller_name = nil)
         @controller_name = controller_name
 
@@ -55,7 +55,7 @@ module Vedeu
       #
       # @param action_names [Array<Symbol>, Symbol] A collection of action names
       #   or the name of the action.
-      # @return [void]
+      # @return [Array<Symbol>]
       def action(*action_names)
         action_names.each do |action_name|
           Vedeu::Router.add_action(@controller_name, action_name)

data/lib/vedeu/bindings.rb

@@ -13,7 +13,7 @@ module Vedeu
 
     # Setup events for running Vedeu. This method is called by Vedeu.
     #
-    # @return [void]
+    # @return [TrueClass]
     def setup!
       Vedeu::Bindings::Application.setup!
       Vedeu::Bindings::Visibility.setup!

data/lib/vedeu/bindings/application.rb

@@ -12,7 +12,7 @@ module Vedeu
       # Setup events relating to client applications. This method is called by
       # Vedeu.
       #
-      # @return [void]
+      # @return [TrueClass]
       def setup!
         goto!
       end
@@ -25,7 +25,7 @@ module Vedeu
       #   Vedeu.trigger(:_goto_, :your_controller, :some_action, { id: 7 })
       #   Vedeu.goto(:your_controller, :some_action, { id: 7 })
       #
-      # @return [void]
+      # @return [TrueClass]
       def goto!
         Vedeu.bind(:_goto_) do |controller, action, **args|
           Vedeu::Router.goto(controller, action, **args)

data/lib/vedeu/bindings/drb.rb

@@ -11,7 +11,7 @@ module Vedeu
 
       # Setup events relating to the DRb server. This method is called by Vedeu.
       #
-      # @return [void]
+      # @return [TrueClass]
       def setup!
         drb_input!
         drb_retrieve_output!
@@ -30,7 +30,7 @@ module Vedeu
       # @example
       #   Vedeu.trigger(:_drb_input_, data, type)
       #
-      # @return [void]
+      # @return [TrueClass]
       def drb_input!
         Vedeu.bind(:_drb_input_) do |data, type|
           Vedeu.log(type: :drb, message: "Sending input (#{type})")
@@ -47,7 +47,7 @@ module Vedeu
       #
       # @todo This event queries Vedeu. Events should only be commands.
       #
-      # @return [void]
+      # @return [TrueClass]
       def drb_retrieve_output!
         Vedeu.bind(:_drb_retrieve_output_) { Vedeu::VirtualBuffer.retrieve }
       end
@@ -58,7 +58,7 @@ module Vedeu
       # @example
       #   Vedeu.trigger(:_drb_store_output_, data)
       #
-      # @return [void]
+      # @return [TrueClass]
       def drb_store_output!
         Vedeu.bind(:_drb_store_output_) do |data|
           Vedeu::VirtualBuffer.store(Vedeu::Terminal.virtual.output(data))
@@ -71,7 +71,7 @@ module Vedeu
       #   Vedeu.trigger(:_drb_restart_)
       #   Vedeu.drb_restart
       #
-      # @return [void]
+      # @return [TrueClass]
       def drb_restart!
         Vedeu.bind(:_drb_restart_) { Vedeu::Distributed::Server.restart }
       end
@@ -82,7 +82,7 @@ module Vedeu
       #   Vedeu.trigger(:_drb_start_)
       #   Vedeu.drb_start
       #
-      # @return [void]
+      # @return [TrueClass]
       def drb_start!
         Vedeu.bind(:_drb_start_) { Vedeu::Distributed::Server.start }
       end
@@ -93,7 +93,7 @@ module Vedeu
       #   Vedeu.trigger(:_drb_status_)
       #   Vedeu.drb_status
       #
-      # @return [void]
+      # @return [TrueClass]
       def drb_status!
         Vedeu.bind(:_drb_status_) { Vedeu::Distributed::Server.status }
       end
@@ -104,7 +104,7 @@ module Vedeu
       #   Vedeu.trigger(:_drb_stop_)
       #   Vedeu.drb_stop
       #
-      # @return [void]
+      # @return [TrueClass]
       def drb_stop!
         Vedeu.bind(:_drb_stop_) { Vedeu::Distributed::Server.stop }
       end

data/lib/vedeu/bindings/menus.rb

@@ -12,7 +12,7 @@ module Vedeu
 
       # Setup events relating to menus. This method is called by Vedeu.
       #
-      # @return [void]
+      # @return [TrueClass]
       def setup!
         menu_bottom!
         menu_current!
@@ -33,7 +33,7 @@ module Vedeu
       # @example
       #   Vedeu.trigger(:_menu_bottom_, name)
       #
-      # @return [void]
+      # @return [TrueClass]
       def menu_bottom!
         Vedeu.bind(:_menu_bottom_) do |name|
           Vedeu.menus.by_name(name).bottom_item
@@ -45,7 +45,7 @@ module Vedeu
       # @example
       #   Vedeu.trigger(:_menu_current_, name)
       #
-      # @return [void]
+      # @return [TrueClass]
       def menu_current!
         Vedeu.bind(:_menu_current_) do |name|
           Vedeu.menus.by_name(name).current_item
@@ -57,7 +57,7 @@ module Vedeu
       # @example
       #   Vedeu.trigger(:_menu_deselect_, name)
       #
-      # @return [void]
+      # @return [TrueClass]
       def menu_deselect!
         Vedeu.bind(:_menu_deselect_) do |name|
           Vedeu.menus.by_name(name).deselect_item
@@ -70,7 +70,7 @@ module Vedeu
       # @example
       #   Vedeu.trigger(:_menu_items_, name)
       #
-      # @return [void]
+      # @return [TrueClass]
       def menu_items!
         Vedeu.bind(:_menu_items_) { |name| Vedeu.menus.by_name(name).items }
       end
@@ -81,7 +81,7 @@ module Vedeu
       # @example
       #   Vedeu.trigger(:_menu_next_, name)
       #
-      # @return [void]
+      # @return [TrueClass]
       def menu_next!
         Vedeu.bind(:_menu_next_) { |name| Vedeu.menus.by_name(name).next_item }
       end
@@ -92,7 +92,7 @@ module Vedeu
       # @example
       #   Vedeu.trigger(:_menu_prev_, name)
       #
-      # @return [void]
+      # @return [TrueClass]
       def menu_prev!
         Vedeu.bind(:_menu_prev_) { |name| Vedeu.menus.by_name(name).prev_item }
       end
@@ -102,7 +102,7 @@ module Vedeu
       # @example
       #   Vedeu.trigger(:_menu_selected_, name)
       #
-      # @return [void]
+      # @return [TrueClass]
       def menu_selected!
         Vedeu.bind(:_menu_selected_) do |name|
           Vedeu.menus.by_name(name).selected_item
@@ -114,7 +114,7 @@ module Vedeu
       # @example
       #   Vedeu.trigger(:_menu_select_, name)
       #
-      # @return [void]
+      # @return [TrueClass]
       def menu_select!
         Vedeu.bind(:_menu_select_) do |name|
           Vedeu.menus.by_name(name).select_item
@@ -126,7 +126,7 @@ module Vedeu
       # @example
       #   Vedeu.trigger(:_menu_top_, name)
       #
-      # @return [void]
+      # @return [TrueClass]
       def menu_top!
         Vedeu.bind(:_menu_top_) { |name| Vedeu.menus.by_name(name).top_item }
       end
@@ -137,7 +137,7 @@ module Vedeu
       # @example
       #   Vedeu.trigger(:_menu_view_, name)
       #
-      # @return [void]
+      # @return [TrueClass]
       def menu_view!
         Vedeu.bind(:_menu_view_) { |name| Vedeu.menus.by_name(name).view }
       end

data/lib/vedeu/bindings/movement.rb

@@ -11,7 +11,7 @@ module Vedeu
 
       # Setup events relating to movement. This method is called by Vedeu.
       #
-      # @return [void]
+      # @return [TrueClass]
       def setup!
         cursor_down!
         cursor_left!
@@ -33,7 +33,7 @@ module Vedeu
       # @example
       #   Vedeu.trigger(:_cursor_down_, name)
       #
-      # @return [void]
+      # @return [TrueClass]
       # @see Vedeu::Move
       def cursor_down!
         Vedeu.bind(:_cursor_down_) do |name|
@@ -46,7 +46,7 @@ module Vedeu
       # @example
       #   Vedeu.trigger(:_cursor_left_, name)
       #
-      # @return [void]
+      # @return [TrueClass]
       # @see Vedeu::Move
       def cursor_left!
         Vedeu.bind(:_cursor_left_) do |name|
@@ -61,7 +61,7 @@ module Vedeu
       #   Vedeu.trigger(:_cursor_origin_, name)
       #   Vedeu.trigger(:_cursor_reset_, name)
       #
-      # @return [void]
+      # @return [TrueClass]
       # @see Vedeu::Move
       def cursor_origin!
         Vedeu.bind(:_cursor_origin_) do |name|
@@ -79,7 +79,7 @@ module Vedeu
       #
       # @todo This event queries Vedeu. Events should only be commands.
       #
-      # @return [void]
+      # @return [TrueClass]
       # @see Vedeu::Move
       def cursor_position!
         Vedeu.bind(:_cursor_position_) do |name|
@@ -92,7 +92,7 @@ module Vedeu
       # @example
       #   Vedeu.trigger(:_cursor_reposition_, name, y, x)
       #
-      # @return [void]
+      # @return [TrueClass]
       # @see Vedeu::Move
       def cursor_reposition!
         Vedeu.bind(:_cursor_reposition_) do |name, y, x|
@@ -105,7 +105,7 @@ module Vedeu
       # @example
       #   Vedeu.trigger(:_cursor_right_, name)
       #
-      # @return [void]
+      # @return [TrueClass]
       # @see Vedeu::Move
       def cursor_right!
         Vedeu.bind(:_cursor_right_) do |name|
@@ -118,7 +118,7 @@ module Vedeu
       # @example
       #   Vedeu.trigger(:_cursor_up, name)
       #
-      # @return [void]
+      # @return [TrueClass]
       # @see Vedeu::Move
       def cursor_up!
         Vedeu.bind(:_cursor_up_) do |name|
@@ -131,7 +131,7 @@ module Vedeu
       # @example
       #   Vedeu.trigger(:_geometry_down_, name)
       #
-      # @return [void]
+      # @return [TrueClass]
       # @see Vedeu::Move
       def geometry_down!
         Vedeu.bind(:_geometry_down_) do |name|
@@ -144,7 +144,7 @@ module Vedeu
       # @example
       #   Vedeu.trigger(:_geometry_left_, name)
       #
-      # @return [void]
+      # @return [TrueClass]
       # @see Vedeu::Move
       def geometry_left!
         Vedeu.bind(:_geometry_left_) do |name|
@@ -157,7 +157,7 @@ module Vedeu
       # @example
       #   Vedeu.trigger(:_geometry_right_, name)
       #
-      # @return [void]
+      # @return [TrueClass]
       # @see Vedeu::Move
       def geometry_right!
         Vedeu.bind(:_geometry_right_) do |name|
@@ -170,7 +170,7 @@ module Vedeu
       # @example
       #   Vedeu.trigger(:_geometry_up_, name)
       #
-      # @return [void]
+      # @return [TrueClass]
       # @see Vedeu::Move
       def geometry_up!
         Vedeu.bind(:_geometry_up_) do |name|

data/lib/vedeu/bindings/system.rb

@@ -17,7 +17,7 @@ module Vedeu
 
       # Setup events relating to running Vedeu. This method is called by Vedeu.
       #
-      # @return [void]
+      # @return [TrueClass]
       def setup!
         cleanup!
         clear!
@@ -48,7 +48,7 @@ module Vedeu
       # @example
       #   Vedeu.trigger(:_exit_)
       #
-      # @return [void]
+      # @return [TrueClass]
       def cleanup!
         Vedeu.bind(:_cleanup_) do
           Vedeu.trigger(:_drb_stop_)
@@ -63,7 +63,7 @@ module Vedeu
       #   Vedeu.trigger(:_clear_)
       #   Vedeu.clear_by_name(name)
       #
-      # @return [void]
+      # @return [TrueClass]
       def clear!
         Vedeu.bind(:_clear_) do |name|
           if name
@@ -82,7 +82,7 @@ module Vedeu
       # @example
       #   Vedeu.trigger(:_command_, command)
       #
-      # @return [void]
+      # @return [TrueClass]
       def command!
         Vedeu.bind(:_command_) { |command| Vedeu.trigger(:command, command) }
       end
@@ -94,7 +94,7 @@ module Vedeu
       #   Vedeu.trigger(:_exit_)
       #   Vedeu.exit
       #
-      # @return [void]
+      # @return [TrueClass]
       def exit!
         Vedeu.bind(:_exit_) { Vedeu::Application.stop }
       end
@@ -105,7 +105,7 @@ module Vedeu
       # @example
       #   Vedeu.trigger(:_focus_by_name_, name)
       #
-      # @return [void]
+      # @return [TrueClass]
       def focus_by_name!
         Vedeu.bind(:_focus_by_name_) { |name| Vedeu.focus_by_name(name) }
       end
@@ -116,7 +116,7 @@ module Vedeu
       # @example
       #   Vedeu.trigger(:_focus_next_)
       #
-      # @return [void]
+      # @return [TrueClass]
       def focus_next!
         Vedeu.bind(:_focus_next_) { Vedeu.focus_next }
       end
@@ -127,7 +127,7 @@ module Vedeu
       # @example
       #   Vedeu.trigger(:_focus_prev_)
       #
-      # @return [void]
+      # @return [TrueClass]
       def focus_prev!
         Vedeu.bind(:_focus_prev_) { Vedeu.focus_previous }
       end
@@ -138,7 +138,7 @@ module Vedeu
       # When Vedeu triggers this event, the :_refresh_ event is also triggered
       # automatically.
       #
-      # @return [void]
+      # @return [TrueClass]
       def initialize!
         Vedeu.bind(:_initialize_) { Vedeu.trigger(:_refresh_) }
       end
@@ -153,7 +153,7 @@ module Vedeu
       # @example
       #   Vedeu.trigger(:_keypress_, key)
       #
-      # @return [void]
+      # @return [TrueClass]
       def keypress!
         Vedeu.bind(:_keypress_) { |key| Vedeu.keypress(key) }
       end
@@ -164,7 +164,7 @@ module Vedeu
       # @example
       #   Vedeu.trigger(:_log_, message)
       #
-      # @return [void]
+      # @return [TrueClass]
       def log!
         Vedeu.bind(:_log_) { |msg| Vedeu.log(type: :debug, message: msg) }
       end
@@ -174,7 +174,7 @@ module Vedeu
       # @example
       #   Vedeu.trigger(:_maximise_, name)
       #
-      # @return [void]
+      # @return [TrueClass]
       # @see Vedeu::Geometry#maximise
       def maximise!
         Vedeu.bind(:_maximise_) do |name|
@@ -191,7 +191,7 @@ module Vedeu
       # @example
       #   Vedeu.trigger(:_mode_switch_)
       #
-      # @return [void]
+      # @return [TrueClass]
       def mode_switch!
         Vedeu.bind(:_mode_switch_) { fail Vedeu::ModeSwitch }
       end
@@ -206,7 +206,7 @@ module Vedeu
       #   Vedeu.trigger(:_refresh_)
       #   Vedeu.trigger(:_refresh_, name)
       #
-      # @return [void]
+      # @return [TrueClass]
       def refresh!
         Vedeu.bind(:_refresh_) do |name|
           name ? Vedeu::Refresh.by_name(name) : Vedeu::Refresh.all
@@ -219,7 +219,7 @@ module Vedeu
       # @example
       #   Vedeu.trigger(:_refresh_cursor_, name)
       #
-      # @return [void]
+      # @return [TrueClass]
       def refresh_cursor!
         Vedeu.bind(:_refresh_cursor_) do |name|
           Vedeu::RefreshCursor.render(name)
@@ -231,7 +231,7 @@ module Vedeu
       # @example
       #   Vedeu.trigger(:_refresh_group_, name)
       #
-      # @return [void]
+      # @return [TrueClass]
       def refresh_group!
         Vedeu.bind(:_refresh_group_) { |name| Vedeu::Refresh.by_group(name) }
       end
@@ -242,7 +242,7 @@ module Vedeu
       # @example
       #   Vedeu.trigger(:_resize_)
       #
-      # @return [void]
+      # @return [TrueClass]
       def resize!
         Vedeu.bind(:_resize_, delay: 0.25) { Vedeu.resize }
       end
@@ -252,7 +252,7 @@ module Vedeu
       # @example
       #   Vedeu.trigger(:_unmaximise_, name)
       #
-      # @return [void]
+      # @return [TrueClass]
       # @see Vedeu::Geometry#unmaximise
       def unmaximise!
         Vedeu.bind(:_unmaximise_) do |name|