vedeu 0.6.19 → 0.6.20

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 20a048bece8b32f4169265a0d8271e06451102eb
-  data.tar.gz: 89d5c68d612f71e82ec8b6eecafc291632b9a8af
+  metadata.gz: 0fbbcdaa8be4572e7426e84959d56e5932e90bba
+  data.tar.gz: 039d7499ad442e6eb675920ef27abb4d8560d9a3
 SHA512:
-  metadata.gz: 8ae2e4c6ca09d400668293fe9f15373fa3d4e1e5a676c5e8f517f78fba7ddca734eccea67225a3f4b2cce83223778cbabd45bed372f7e892ced183cb0806b645
-  data.tar.gz: b56a9309569b7dba5ebf5973ced1e911170980d11bde67f9851ba74ef099400acc793e04c9cabcb2b21b697e900999777b3717be83228b9bbb936dfedb0331b5
+  metadata.gz: 8711ec3ecd769c9924fcd0f9da09d18289a32ff86f03b44cc539c2909f54355563f1817e242d106a9e2deb7c5921dc1aea17e138ab444bdb2c86407a74162c80
+  data.tar.gz: e724e09e2aead30c2502c31d5aefd80b9481e9c493250991eb463f6b48940e14fce71a64d7fc4617a747ce5b2f345063c49989af8a1796270ef4a586e2fbec8f

data/docs/configuration.md

@@ -5,14 +5,16 @@ Vedeu provides a simple DSL for configuration.
 
     Vedeu.configure do
 
-      # add configuration options here, each of which are listed below...
+      # add configuration options here, each of which are listed
+      # below...
 
     end
 
-If you need to access the value of Vedeu's configuration for whatever reason,
-simply ask for it:
+If you need to access the value of Vedeu's configuration for whatever
+reason, simply ask for it:
 
-    Vedeu.configuration.base_path # => The current value of 'base_path'
+    # => The current value of 'base_path'
+    Vedeu.configuration.base_path
 
 ## Configuration Options
 

data/docs/dsl.md

@@ -1,19 +1,20 @@
 # @title The Vedeu DSL
 # The Vedeu DSL
 
-Coupled with the API (for interacting with the running client application), the
- DSL provides the mechanism to configure aspects of your application whilst
- using Vedeu.
+Coupled with the API (for interacting with the running client
+application), the DSL provides the mechanism to configure aspects of
+your application whilst using Vedeu.
 
 ## Interfaces
 
-An Interface is a basic element in the GUI. It usually but does not necessarily
-correspond to a region of the terminal screen (for example, an Interface might
-not be displayed at certain points in an application life cycle).
+An Interface is a basic element in the GUI. It usually but does not
+necessarily correspond to a region of the terminal screen (for
+example, an Interface might not be displayed at certain points in an
+application life cycle).
 
-Much of the behavior of an Interface comes from child objects that are defined
-under the Interface. These objects are described in more detail in their
-respective sections below.
+Much of the behavior of an Interface comes from child objects that
+are defined under the Interface. These objects are described in more
+detail in their respective sections below.
 
 Here is an example of declarations for an `interface` block:
 
@@ -43,13 +44,13 @@ end
 
 ### Declaring interface sub-objects
 
-Every object in the DSL besides interface itself is defined for a particular
-interface. This can either be declared implicitly by defining the object inside
-an `interface` block or explicitly, by passing the interface name as a first
-argument to the declaration.
+Every object in the DSL besides interface itself is defined for a
+particular interface. This can either be declared implicitly by
+defining the object inside an `interface` block or explicitly, by
+passing the interface name as a first argument to the declaration.
 
-That is, these are equivalent ways to declare a Geometry for an existing
-interface
+That is, these are equivalent ways to declare a Geometry for an
+existing interface
 
 ```ruby
 interface 'main' do
@@ -120,11 +121,11 @@ end
 
 ## Groups
 
-{include:Vedeu::DSL::Group}
+{include:Vedeu::Groups::DSL}
 
 ### Add interfaces to groups
 
-{include:Vedeu::DSL::Group.group}
+{include:Vedeu::Groups::DSL.group}
 
 ## Keymaps
 
@@ -162,8 +163,9 @@ end
 
 #### Authors Notes
 
-The Rubydoc documentation has more specific information about the DSL methods
- demonstrated above: [RubyDoc](http://rubydoc.info/gems/vedeu).
+The Rubydoc documentation has more specific information about the DSL
+methods demonstrated above: [RubyDoc](http://rubydoc.info/gems/vedeu).
 
-I've tried to write the DSL in a way which makes it read nice; believing that
- this will make it easier to use. I hope this is the case for you.
+I've tried to write the DSL in a way which makes it read nice;
+believing that this will make it easier to use. I hope this is the
+case for you.

data/docs/events/system.md

@@ -17,7 +17,7 @@ define to 'do things'.
     Vedeu.trigger(:_command_, command)
 
 ### :_editor_
-This event is called by {Vedeu::Input::Input#capture}. When
+This event is called by {Vedeu::Input::Capture#read}. When
 invoked, the key will be passed to the editor for currently
 focussed view.
 
@@ -39,11 +39,11 @@ action(s), like render the first screen, interface or make a sound.
 
 ### :_keypress_
 Will cause the triggering of the `:key` event; which you should define
-to 'do things'. If the `escape` key is pressed, then `key` is triggered
-with the argument `:escape`, also an internal event `_mode_switch_` is
-triggered. Vedeu recognises most key presses and some 'extended'
-keypress (eg. Ctrl+J), a list of supported keypresses can be found here:
-{Vedeu::Input::Input}.
+to 'do things'. If the `escape` key is pressed, then `key` is
+triggered with the argument `:escape`, also an internal event
+`_mode_switch_` is triggered. Vedeu recognises most key presses and
+some 'extended' keypress (eg. Ctrl+J), a list of supported keypresses
+can be found here: {Vedeu::Input::Capture}.
 
     Vedeu.trigger(:_keypress_, key)
 
@@ -56,8 +56,8 @@ logging is enabled in the configuration.
 ### :_mode_switch_
 When triggered (by default, after the user presses `escape`), Vedeu
 switches between modes of the terminal. The idea 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.
+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_)

data/docs/getting_started.md

@@ -7,22 +7,24 @@ First, install the gem locally:
 
     gem install vedeu
 
-This will provide a new command to help build your client application. Similar
-to Ruby on Rails, although not nearly as advanced as the Rails equivalent,
-hopefully the `vedeu` command generators will get you off the ground:
+This will provide a new command to help build your client application.
+Similar to Ruby on Rails, although not nearly as advanced as the Rails
+equivalent, hopefully the `vedeu` command generators will get you off
+the ground:
 
     vedeu
 
 ## Generating a new application
 
-The following command will build a new application. Substitute `your_app_name`
-for your desired application name.
+The following command will build a new application. Substitute
+`your_app_name` for your desired application name.
 
     vedeu new your_app_name
 
-If `your_app_name` already exists, Vedeu will only write new files that do not
-exist at the file path. The generated files are a skeleton Vedeu client
-application. Let's take a look at these files individually.
+If `your_app_name` already exists, Vedeu will only write new files
+that do not exist at the file path. The generated files are a skeleton
+Vedeu client application. Let's take a look at these files
+individually.
 
 ```bash
 |
@@ -59,38 +61,41 @@ application. Let's take a look at these files individually.
 
 ### app/controllers/
 
-The controllers directory is the place to store the events and behaviour logic
-of your application. It will manage the choosing of views and models based on
-previous choices. Think of them as the orchestrators of your application.
+The controllers directory is the place to store the events and
+behaviour logic of your application. It will manage the choosing of
+views and models based on previous choices. Think of them as the
+orchestrators of your application.
 
-In web applications, the controller typically handles the routed request and
-interacts with the models and sets up the views. In Vedeu, it does much the
-same, minus the requests.
+In web applications, the controller typically handles the routed
+request and interacts with the models and sets up the views. In Vedeu,
+it does much the same, minus the requests.
 
 ### app/helpers/
 
-Ruby on Rails has a concept of helpers which are not very object-oriented, but
-allow you to share functionality/behaviour across multiple views. Vedeu uses
-this concept as it will be familiar to many Rails developers and might be
-helpful to beginners.
+Ruby on Rails has a concept of helpers which are not very
+object-oriented, but allow you to share functionality/behaviour across
+multiple views. Vedeu uses this concept as it will be familiar to many
+Rails developers and might be helpful to beginners.
 
 ### app/models/
 
-Much like `lib`, this directory is for your application logic code. Some people
-prefer to use `app/models`, others like to use `lib`. Some even use both!
+Much like `lib`, this directory is for your application logic code.
+Some people prefer to use `app/models`, others like to use `lib`. Some
+even use both!
 
 ### app/models/keymaps/
 
-This will contain the global keymap (which affects all of your application)
-plus any specific interface keymaps which only affect a certain interface when
-in focus. By default the global keymap contains a few simple definitions:
+This will contain the global keymap (which affects all of your
+application) plus any specific interface keymaps which only affect a
+certain interface when in focus. By default the global keymap contains
+a few simple definitions:
 
 - **`q`**
 
-  **Quit**. Internally triggers the :_exit_ system event which in turn requests
-  the application stops. This triggers the event :cleanup which the client
-  application can bind to and perform any tidying up it wishes to perform
-  before exiting.
+  **Quit**. Internally triggers the :_exit_ system event which in turn
+  requests the application stops. This triggers the event :cleanup
+  which the client application can bind to and perform any tidying up
+  it wishes to perform before exiting.
 
 - **`<esc>`**
 
@@ -106,30 +111,31 @@ in focus. By default the global keymap contains a few simple definitions:
 
 ### app/views/
 
-This will contain classes which produce the views needed by Vedeu to make your
-application come alive!
+This will contain classes which produce the views needed by Vedeu to
+make your application come alive!
 
 ### app/views/interfaces/
 
-This will contain the information Vedeu needs to draw the various interfaces
-and views of your application.
+This will contain the information Vedeu needs to draw the various
+interfaces and views of your application.
 
 ### app/views/templates/
 
-This will house the templates your application will use to display views. You
-can populate templates with generic view information and supplement it with
-variable data from your application.
+This will house the templates your application will use to display
+views. You can populate templates with generic view information and
+supplement it with variable data from your application.
 
 ### bin/
 
-This will contain executable Ruby scripts (or Bash, or shell language of your
-choice) which will launch your application or provide command-line behaviours.
+This will contain executable Ruby scripts (or Bash, or shell language
+of your choice) which will launch your application or provide
+command-line behaviours.
 
 ### config/
 
-This will contain any configuration your application needs to run, plus the
-configuration for Vedeu. This configuration affects the way Vedeu works with
-your application.
+This will contain any configuration your application needs to run,
+plus the configuration for Vedeu. This configuration affects the way
+Vedeu works with your application.
 
 ### lib/
 
@@ -138,28 +144,28 @@ This is for code your application may use to support code you have in
 
 ### test/
 
-This is for the tests you might write to help ensure your application executes
-in the way you expect.
+This is for the tests you might write to help ensure your application
+executes in the way you expect.
 
 ### vendor/
 
-This is for third-party code which your application might want to ship with.
-Usually you will include various Ruby gems to provide functionality, but you
-might want to do something special.
+This is for third-party code which your application might want to
+ship with. Usually you will include various Ruby gems to provide
+functionality, but you might want to do something special.
 
 
 ## Adding a new view to your application
 
 The following command will build a new view within your application.
 Substitute `some_view_name` for your desired application name. As with
-generating a new application, If `some_view_name` already exists, Vedeu will
-only write new files that do not exist at the file path.
+generating a new application, If `some_view_name` already exists,
+Vedeu will only write new files that do not exist at the file path.
 
     cd your_app_name
     vedeu view some_view_name
 
-The generated files are skeleton Vedeu view files. Let's talk about the files it
-will create and populate:
+The generated files are skeleton Vedeu view files. Let's talk about
+the files it will create and populate:
 
 ```bash
 |

data/docs/object_graph.md

@@ -1,9 +1,9 @@
 # @title Producing an object graph of Vedeu
 
-Sometimes I find looking at the project as a graph helps me to understand the
-relationship between the various objects. To achieve this, I use Yard's graph
-options. If this sort of thing floats your boat too, and you have the
-appropriate software installed:
+Sometimes I find looking at the project as a graph helps me to
+understand the relationship between the various objects. To achieve
+this, I use Yard's graph options. If this sort of thing floats your
+boat too, and you have the appropriate software installed:
 
 ```shell
 yard graph --full --dependencies --private --protected --dot --file vedeu.dot

data/lib/vedeu/all.rb

@@ -25,7 +25,6 @@ require 'vedeu/output/output'
 require 'vedeu/output/viewport'
 require 'vedeu/output/wordwrap'
 require 'vedeu/output/refresh/refresh'
-require 'vedeu/output/refresh/refresh_group'
 require 'vedeu/output/renderers/all'
 
 require 'vedeu/esc/all'
@@ -42,6 +41,7 @@ require 'vedeu/distributed/all'
 require 'vedeu/editor/all'
 require 'vedeu/events/all'
 require 'vedeu/geometry/all'
+require 'vedeu/groups/all'
 require 'vedeu/input/all'
 require 'vedeu/menus/all'
 require 'vedeu/templating/all'

data/lib/vedeu/api/external.rb

@@ -55,8 +55,8 @@ module Vedeu
       def_delegators Vedeu::Geometry::DSL, :geometry
 
       # @!method group
-      #   @see Vedeu::DSL::Group.group
-      def_delegators Vedeu::DSL::Group, :group
+      #   @see Vedeu::Groups::DSL.group
+      def_delegators Vedeu::Groups::DSL, :group
 
       # @!method keymap
       #   @see Vedeu::DSL::Keymap.keymap
@@ -146,8 +146,8 @@ module Vedeu
       def_delegators Vedeu::Clear::Interface, :clear_by_name
 
       # @!method clear_by_group
-      #   @see Vedeu::Clear::Group.render
-      def_delegators Vedeu::Clear::Group, :clear_by_group
+      #   @see Vedeu::Groups::Clear.render
+      def_delegators Vedeu::Groups::Clear, :clear_by_group
 
       # @!method hide_cursor
       #   @see Vedeu::Cursors::Cursor#hide
@@ -162,16 +162,16 @@ module Vedeu
       def_delegators Vedeu::Cursors::Cursor, :toggle_cursor
 
       # @!method hide_group
-      #   @see Vedeu::Models::Group#hide
-      def_delegators Vedeu::Models::Group, :hide_group
+      #   @see Vedeu::Groups::Group#hide
+      def_delegators Vedeu::Groups::Group, :hide_group
 
       # @!method show_group
-      #   @see Vedeu::Models::Group#show
-      def_delegators Vedeu::Models::Group, :show_group
+      #   @see Vedeu::Groups::Group#show
+      def_delegators Vedeu::Groups::Group, :show_group
 
       # @!method toggle_group
-      #   @see Vedeu::Models::Group#toggle
-      def_delegators Vedeu::Models::Group, :toggle_group
+      #   @see Vedeu::Groups::Group#toggle
+      def_delegators Vedeu::Groups::Group, :toggle_group
 
       # @!method hide_interface
       #   @see Vedeu::Models::Interface#hide

data/lib/vedeu/api/internal.rb

@@ -100,8 +100,8 @@ module Vedeu
       #   Vedeu.groups
       #
       # @!method groups
-      # @return [Vedeu::Models::Groups]
-      def_delegators Vedeu::Models::Groups, :groups
+      # @return [Vedeu::Groups::Repository]
+      def_delegators Vedeu::Groups::Repository, :groups
 
       # Manipulate the repository of interfaces.
       #

data/lib/vedeu/bindings/application.rb

@@ -16,6 +16,11 @@ module Vedeu
         goto!
       end
 
+      # @return [TrueClass]
+      def setup_aliases!
+        Vedeu.bind_alias(:_action_, :_goto_)
+      end
+
       private
 
       # :nocov:
@@ -25,8 +30,6 @@ module Vedeu
         Vedeu.bind(:_goto_) do |controller, action, **args|
           Vedeu::Runtime::Router.goto(controller, action, **args)
         end
-
-        Vedeu.bind_alias(:_action_, :_goto_)
       end
 
       # :nocov:

data/lib/vedeu/bindings/bindings.rb

@@ -24,8 +24,21 @@ module Vedeu
       true
     end
 
+    # Setup aliases for certain registered events.
+    # This method is called by Vedeu.
+    #
+    # @return [TrueClass]
+    def setup_aliases!
+      Vedeu::Bindings::Application.setup_aliases!
+      Vedeu::Bindings::Movement.setup_aliases!
+      Vedeu::Bindings::Visibility.setup_aliases!
+
+      true
+    end
+
   end # Bindings
 
-end # Vedeu
+  Vedeu::Bindings.setup!
+  Vedeu::Bindings.setup_aliases!
 
-Vedeu::Bindings.setup!
+end # Vedeu