vedeu 0.4.62 → 0.4.63

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 30927938a72729c5f3bae9a255a5c8b7602360f9
-  data.tar.gz: eeb3240c0d98fd5450ddf9f4a9cdf5f5e81ac1b3
+  metadata.gz: b5a611c12fd166638545458a66d83fefcceb4201
+  data.tar.gz: 4d7c37c1ac9281c6cae6a65dc83827e78b2ec578
 SHA512:
-  metadata.gz: 645204564d7353b20bd33141221af4a2fa1bca84da5990a4a0280041b304985ce5391809239fd3e08235deab9f87933ea38ead859e4653a494a2e70d49be64c4
-  data.tar.gz: 04ae7389a57c38d513a7f7a8f2af5d1910d8f5fe4881668453a6d2b7eb426450d997c0c7b2c6e938cd50d6c446f8c08f0f6b0bd168b4ea14e1fbc9c302f1b67d
+  metadata.gz: 134e9ebd933984c61d89832cef7da1583aa36ea046e440ccdf2afa1f1bc6858820a6f7d270b39dfda7fa5204da4925808164998d4210f24ff016798cbeda2bff
+  data.tar.gz: 19f6de39f023fe2bb7d9d0aab6014ce112227df1e8a2f8b8d511d6aea01c4e4015587077967a5b7f1b8da8633ab3bc724c4c34669f74220bc2f961e61b3d8d57

data/lib/vedeu/all.rb

@@ -1,13 +1,13 @@
 require 'vedeu/version'
-require 'vedeu/launcher'
-require 'vedeu/bootstrap'
+require 'vedeu/runtime/launcher'
+require 'vedeu/runtime/bootstrap'
 require 'vedeu/exceptions'
 require 'vedeu/log'
 require 'vedeu/debug'
 require 'vedeu/traps'
 require 'vedeu/common'
 require 'vedeu/terminal_mode'
-require 'vedeu/router'
+require 'vedeu/runtime/router'
 
 require 'vedeu/configuration/cli'
 require 'vedeu/configuration/api'
@@ -15,8 +15,8 @@ require 'vedeu/configuration/configuration'
 
 require 'vedeu/terminal'
 require 'vedeu/timer'
-require 'vedeu/main_loop'
-require 'vedeu/application'
+require 'vedeu/runtime/main_loop'
+require 'vedeu/runtime/application'
 
 require 'vedeu/models/toggleable'
 
@@ -172,6 +172,7 @@ require 'vedeu/output/virtual_terminal'
 require 'vedeu/output/wordwrap'
 
 require 'vedeu/api'
+require 'vedeu/internal_api'
 
 require 'vedeu/bindings/application'
 require 'vedeu/bindings/drb'

data/lib/vedeu/api.rb

@@ -22,33 +22,6 @@ module Vedeu
 
     module_function
 
-    # Manipulate the repository of background colours.
-    #
-    # @example
-    #   Vedeu.background_colours
-    #
-    # @!method background_colours
-    # @return [Vedeu::Backgrounds]
-    def_delegators Vedeu::Backgrounds, :background_colours
-
-    # Manipulate the repository of borders.
-    #
-    # @example
-    #   Vedeu.borders
-    #
-    # @!method borders
-    # @return [Vedeu::Borders]
-    def_delegators Vedeu::Borders, :borders
-
-    # Manipulate the repository of buffers.
-    #
-    # @example
-    #   Vedeu.buffers
-    #
-    # @!method buffers
-    # @return [Vedeu::Buffers]
-    def_delegators Vedeu::Buffers, :buffers
-
     # @!method configure
     #   @see Vedeu::Configuration.configure
     # @!method configuration
@@ -64,15 +37,6 @@ module Vedeu
     # @return [Vedeu::Cursor]
     def_delegators Vedeu::Cursors, :cursor
 
-    # Manipulate the repository of cursors.
-    #
-    # @example
-    #   Vedeu.cursors
-    #
-    # @!method cursors
-    # @return [Vedeu::Cursors]
-    def_delegators Vedeu::Cursors, :cursors
-
     # Manipulate the DRb server implementation.
     #
     # @example
@@ -149,15 +113,6 @@ module Vedeu
     #   @see Vedeu::Event.unbind
     def_delegators Vedeu::Event, :bind, :bound?, :unbind
 
-    # Manipulate the repository of events.
-    #
-    # @example
-    #   Vedeu.events
-    #
-    # @!method events
-    # @return [Vedeu::Events]
-    def_delegators Vedeu::Events, :events
-
     # @example
     #   Vedeu.focus
     #   Vedeu.focus_by_name
@@ -178,51 +133,6 @@ module Vedeu
     def_delegators Vedeu::Focus, :focus, :focus_by_name, :focussed?,
                    :focus_next, :focus_previous
 
-    # Manipulate the repository of foreground colours.
-    #
-    # @example
-    #   Vedeu.foreground_colours
-    #
-    # @!method foreground_colours
-    # @return [Vedeu::Foregrounds]
-    def_delegators Vedeu::Foregrounds, :foreground_colours
-
-    # Manipulate the repository of geometries.
-    #
-    # @example
-    #   Vedeu.geometries
-    #
-    # @!method geometries
-    # @return [Vedeu::Geometries]
-    def_delegators Vedeu::Geometries, :geometries
-
-    # Manipulate the repository of groups.
-    #
-    # @example
-    #   Vedeu.groups
-    #
-    # @!method groups
-    # @return [Vedeu::Groups]
-    def_delegators Vedeu::Groups, :groups
-
-    # Manipulate the repository of interfaces.
-    #
-    # @example
-    #   Vedeu.interfaces
-    #
-    # @!method interfaces
-    # @return [Vedeu::Interfaces]
-    def_delegators Vedeu::Interfaces, :interfaces
-
-    # Manipulate the repository of keymaps.
-    #
-    # @example
-    #   Vedeu.keymaps
-    #
-    # @!method keymaps
-    # @return [Vedeu::Keymaps]
-    def_delegators Vedeu::Keymaps, :keymaps
-
     # @example
     #   Vedeu.log
     #   Vedeu.log_stdout
@@ -250,24 +160,12 @@ module Vedeu
     #   @see Vedeu::Menu.menu
     def_delegators Vedeu::Menu, :menu
 
-    # Manipulate the repository of menus.
+    # Instruct Vedeu to load the client application controller action with
+    # parameters.
     #
-    # @example
-    #   Vedeu.menus
-    #
-    # @!method menus
-    # @return [Vedeu::Menus]
-    def_delegators Vedeu::Menus, :menus
-
-    # @example
-    #   Vedeu.renderer
-    #   Vedeu.renderers
-    #
-    # @!method renderer
-    #   @see Vedeu::Renderers#renderer
-    # @!method renderers
-    #   @see Vedeu::Renderers#renderers
-    def_delegators Vedeu::Renderers, :renderer, :renderers
+    # @!method goto
+    #   @see Vedeu::Router.goto
+    def_delegators Vedeu::Router, :goto
 
     # Return the height of the terminal running the client application.
     #
@@ -287,27 +185,6 @@ module Vedeu
     #   @see Vedeu::Terminal#width
     def_delegators Vedeu::Terminal, :width
 
-    # Instruct the terminal to resize. This will happen automatically as the
-    # terminal recieves SIGWINCH signals.
-    #
-    # @example
-    #   Vedeu.resize
-    #
-    # @!method resize
-    #   @see Vedeu::Terminal#resize
-    def_delegators Vedeu::Terminal, :resize
-
-    # Measure the execution time of the code in the given block.
-    #
-    # @example
-    #   Vedeu.timer do
-    #     # ... some code here ...
-    #   end
-    #
-    # @!method timer
-    #   @see Vedeu::Timer.timer
-    def_delegators Vedeu::Timer, :timer
-
     # Trigger an event by name.
     #
     # @example

data/lib/vedeu/application/application_controller.rb

@@ -1,5 +1,3 @@
-require 'vedeu/application/controller'
-
 module Vedeu
 
   # Provides methods which should be available to all client application

data/lib/vedeu/application/application_helper.rb

@@ -1,5 +1,3 @@
-require 'vedeu/application/helper'
-
 module Vedeu
 
   # Provides methods which should be available to all client application

data/lib/vedeu/application/application_view.rb

@@ -1,5 +1,3 @@
-require 'vedeu/application/view'
-
 module Vedeu
 
   # Provides the mechanism to render views for the client application. The

data/lib/vedeu/application/controller.rb

@@ -49,7 +49,7 @@ module Vedeu
       #
       #   end
       #
-      #   Vedeu.trigger(:_action_, :your_controller, :show, { some: :args })
+      #   Vedeu.trigger(:_goto_, :your_controller, :show, { some: :args })
       #
       # @param action_name [Symbol] THe name of the action.
       # @return [void]

data/lib/vedeu/bindings/application.rb

@@ -14,19 +14,27 @@ module Vedeu
       #
       # @return [void]
       def setup!
-        action!
+        goto!
       end
 
       private
 
+      # Call a client application controller's action with parameters.
+      #
       # @example
-      #   Vedeu.trigger(:_action_, :your_controller, :some_action, { id: 7 })
+      #   Vedeu.trigger(:_goto_, :your_controller, :some_action, { id: 7 })
+      #   Vedeu.goto(:your_controller, :some_action, { id: 7 })
       #
       # @return [void]
-      def action!
-        Vedeu.bind(:_action_) do |controller, action, **args|
+      def goto!
+        Vedeu.bind(:_goto_) do |controller, action, **args|
           Vedeu::Router.goto(controller, action, **args)
         end
+
+        # @todo Remove this aliasing event. (GL 2015-07-26)
+        Vedeu.bind(:_action_) do |controller, action, **args|
+          Vedeu.trigger(:_goto_, controller, action, **args)
+        end
       end
 
     end # Application

data/lib/vedeu/bindings/system.rb

@@ -7,7 +7,7 @@ module Vedeu
     #
     # @note
     #   Unbinding any of these events is likely to cause problems, so I would
-    #   advise leaving them alone. A safe rule: if the name starts with an
+    #   advise leaving them alone. A safe rule: when the name starts with an
     #   underscore, it's probably used by Vedeu internally.
     #
     # :nocov:
@@ -56,8 +56,8 @@ module Vedeu
         end
       end
 
-      # Clears the whole terminal space, or the named interface area to be
-      # cleared if given.
+      # Clears the whole terminal space, or when a name is given, the named
+      # interface area will be cleared.
       #
       # @example
       #   Vedeu.trigger(:_clear_)
@@ -196,7 +196,7 @@ module Vedeu
         Vedeu.bind(:_mode_switch_) { fail Vedeu::ModeSwitch }
       end
 
-      # Will cause the named interface to refresh, or if a name is not given,
+      # Will cause the named interface to refresh, or when a name is not given,
       # will refresh all interfaces.
       #
       # @note: Hidden interfaces will be still refreshed in memory but not

data/lib/vedeu/bindings/visibility.rb

@@ -41,7 +41,7 @@ module Vedeu
         end
       end
 
-      # Hide the cursor of the named interface or if a name is not given, the
+      # Hide the cursor of the named interface or when a name is not given, the
       # interface currently in focus.
       #
       # @example
@@ -54,6 +54,8 @@ module Vedeu
         Vedeu.bind(:_hide_cursor_) do |name|
           Vedeu::Cursor.hide_cursor(name)
         end
+
+        # @todo Remove this aliasing event. (GL 2015-07-26)
         Vedeu.bind(:_cursor_hide_) do |name|
           Vedeu.trigger(:_hide_cursor_, name)
         end
@@ -79,7 +81,7 @@ module Vedeu
         end
       end
 
-      # Show the cursor of the named interface or if a name is not given, the
+      # Show the cursor of the named interface or when a name is not given, the
       # interface currently in focus.
       #
       # @example
@@ -92,6 +94,8 @@ module Vedeu
         Vedeu.bind(:_show_cursor_) do |name|
           Vedeu::Cursor.show_cursor(name)
         end
+
+        # @todo Remove this aliasing event. (GL 2015-07-26)
         Vedeu.bind(:_cursor_show_) do |name|
           Vedeu.trigger(:_show_cursor_, name)
         end

data/lib/vedeu/buffers/buffer.rb

@@ -7,7 +7,7 @@ module Vedeu
   #
   # The content on the screen, or last output will always be the 'Front' buffer.
   # Content due to be displayed on next refresh will come from the 'Back' buffer
-  # if available, otherwise from the current 'Front' buffer. When new content
+  # when available, otherwise from the current 'Front' buffer. When new content
   # is copied to the 'Front' buffer, the current 'Front' buffer is also copied
   # to the 'Previous' buffer.
   #

data/lib/vedeu/buffers/display_buffer.rb

@@ -19,8 +19,8 @@ module Vedeu
       self
     end
 
-    # Store the view if it has a name. This view will be shown next time the
-    # refresh event is triggered for the interface.
+    # When a name is given, the view is stored with this name. This view will be
+    # shown next time the refresh event is triggered for the interface.
     #
     # @raise [Vedeu::InvalidSyntax] The name is not defined.
     # @return [Vedeu::Interface]

data/lib/vedeu/cli/generator/templates/application/Gemfile

@@ -1,4 +1,4 @@
 source 'https://rubygems.org'
 
 gem 'vedeu'
-# gem 'ruby-prof' # uncomment if using the `debug!` configuration option.
+# gem 'ruby-prof' # uncomment when using the `debug!` configuration option.

data/lib/vedeu/cli/generator/templates/application/application.erb

@@ -1,5 +1,5 @@
 require_relative 'config/configuration'
-# Uncomment this, if you are manually setting the entry point below
+# When manually setting the entry point below, uncomment this line:
 # require_relative 'app/controllers/some_controller'
 
 module <%= object.name_as_class %>

data/lib/vedeu/cli/generator/templates/application/config/configuration.erb

@@ -1,12 +1,12 @@
 Vedeu.configure do
   # base_path
 
-  # colour_mode 16_777_216 # Some terminals don't render colour at all if this
+  # colour_mode 16_777_216 # Some terminals don't render colour at all when this
                            # value is not one of 8, 16, 256 or 16777216.
 
   # compression false
 
-  # debug! # Add "gem 'ruby-prof'" to your Gemfile if uncommenting this line.
+  # debug! # Requires "gem 'ruby-prof'" in your Gemfile.
   # drb!
   # drb_host    'localhost'
   # drb_port    21420

data/lib/vedeu/cli/generator/view.rb

@@ -37,8 +37,8 @@ module Vedeu
         make_view_class_file
 
         output("Please update the 'root' setting in 'config/configuration.rb'" \
-               " to '#{app_name}::#{name_as_class}Controller.new' if you " \
-               'would like to start Vedeu at this controller.')
+               " to '#{app_name}::#{name_as_class}Controller.new' to start " \
+               'Vedeu at this controller.')
       end
 
       private

data/lib/vedeu/colours/colour.rb

@@ -23,7 +23,7 @@ module Vedeu
   # to): iTerm2 (OSX), Gnome Terminal (Linux).
   #
   # Setting your `$TERM` environment variable as above gets you up to 256
-  # colours, but if you then add the `colour_mode 16_777_216` configuration to
+  # colours, but when you then add the `colour_mode 16_777_216` configuration to
   # your client application, it's really a hit and miss affair. iTerm2 renders
   # all the colours correctly as does Gnome Terminal. Terminator (Linux) goes
   # crazy though and defaults to 16 colours despite the `$TERM` setting. This

data/lib/vedeu/colours/colour_translator.rb

@@ -14,8 +14,8 @@ module Vedeu
   # colour corresponding with that colour.
   #
   # Finally, when provided a CSS/HTML colour string e.g. '#ff0000', Vedeu will
-  # translate that to the 8-bit escape sequence or if you have a capable
-  # terminal and the `VEDEU_TERM=xterm-truecolor` environment variable set,
+  # translate that to the 8-bit escape sequence or when you have a capable
+  # terminal and the `TERM=xterm-truecolor` environment variable set,
   # a 24-bit representation.
   #
   # @todo More documentation required (create a fancy chart!)

data/lib/vedeu/configuration/api.rb

@@ -420,7 +420,7 @@ module Vedeu
       private
 
       # Returns the options set via the configuration API DSL or an empty Hash
-      # if none were set.
+      # when none were set.
       #
       # @return [Hash]
       def options

data/lib/vedeu/configuration/configuration.rb

@@ -49,7 +49,7 @@ module Vedeu
       alias_method :compression?, :compression
 
       # Provides the mechanism to configure Vedeu. If the client application
-      # sets options, override the defaults with those, and if command-line
+      # sets options, override the defaults with those, and when command-line
       # arguments are provided at application invocation, override any options
       # with the arguments provided.
       #