vedeu 0.4.59 → 0.4.60

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9d42efc42e66cb1d9fdc36ec19e54ddb05ecae3f
-  data.tar.gz: 1ece4b4a8e6492d6ee360a517fbe060f18be5e00
+  metadata.gz: 8ccce2439bd00b49d1f30c708db9f3f80c9b423a
+  data.tar.gz: bf39e8c7e0c0deeba71d696ca8f71dd051dc6a4e
 SHA512:
-  metadata.gz: 851df985ee89a74620a1b35ffabb58d2b8a40248991d8b6846c1cc1850dadb9b159b1623a913db7ff51b3a3358f7f2bdc1eab8f568b2272abb7c1550f2057e1f
-  data.tar.gz: 9e2c4ad401bc028172a05826c37b6af642c8558481b4e9db6742c014d99eed9a621490a9d9129e20eedbf9833a5ede4707d68c0951da2c15a49dcb66f4979bdc
+  metadata.gz: 1881880f64dbde3efd8c923a23d8dc55020d93512cefbcc9aa104909d861e75f0fbce90c7610c84bd015825cf0184c2c71a019816ad2c2ea935a638a393eb137
+  data.tar.gz: 0a972640a9811013c39909df190d6965af0f1f21197658d9a64611ba53a811193cddf89d4d1ecf734cb919b989b0c74241311babac1aada03aac428085397ed6

data/.yardopts

@@ -3,9 +3,7 @@
 --embed-mixin ClassMethods
 -
 docs/api.md
-docs/applications.md
 docs/dsl.md
 docs/events.md
 docs/getting_started.md
 docs/object_graph.md
-docs/views.md

data/LICENSE.txt

@@ -5,7 +5,10 @@ Copyright (c) 2013 Steve Klabnik - Monologger
 Copyright (c) 2013 Michael Grosser - Ruco
                    (https://github.com/grosser/ruco)
                    Note: Code from ruco's Window class was used as basis of
-                     Vedeu::Viewport.
+                   Vedeu::Viewport.
+Copyright (c) 2012 Piotr Murach - TTY
+                   (https://github.com/peter-murach/tty)
+                   Note: Code used from Plugins infrastructure.
 
 MIT License
 

data/README.md

@@ -14,7 +14,8 @@ Vedeu was been built primarily with Ruby v2.1; however, the
 [.ruby-version](https://github.com/gavinlaking/vedeu/blob/master/.ruby-version)
 file will indicate the currently used Ruby version.
 
-When Vedeu started I was a MacOSX user, I've since moved to Linux. You shouldn't have any problems with either of these operating systems.
+When Vedeu started I was a MacOSX user, I've since moved to Linux. You shouldn't
+have any problems with either of these operating systems.
 
 Note: You may have trouble running Vedeu with Windows installations. (Pull
  requests welcome!)
@@ -26,23 +27,28 @@ To install Vedeu, simply:
 
     gem install 'vedeu'
 
-To use Vedeu's application scaffolding, see the [RubyDoc](http://www.rubydoc.info/gems/vedeu/file/docs/applications.md)
+To use Vedeu's application scaffolding, see the
+[RubyDoc](http://www.rubydoc.info/gems/vedeu/file/docs/getting_started.md)
 
 ## Example
 
-Have a look at: [Playa](https://github.com/gavinlaking/playa). Please browse the source of Playa and Vedeu to get a feel for how it all works.
+Have a look at: [Playa](https://github.com/gavinlaking/playa). Please browse the
+source of Playa and Vedeu to get a feel for how it all works.
 
 If you have produced software which uses Vedeu, please let me know, I'll link
 to your project here.
 
-
 ## Documentation & Usage
 
 Vedeu is largely documented using Yard. I hope to produce more 'General Usage'
-documentation shortly. In the meantime, please browse the [RubyDoc](http://rubydoc.info/gems/vedeu).
+documentation shortly. In the meantime, please browse the
+[RubyDoc](http://rubydoc.info/gems/vedeu).
 
+- [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 Events](http://rubydoc.info/gems/vedeu/file/docs/events.md)
+- [Object Graphs](http://rubydoc.info/gems/vedeu/file/docs/object_graph.md)
 
 ## Development / Contributing
 

data/Rakefile

@@ -17,7 +17,6 @@ YARD::Rake::YardocTask.new(:yard) do |t|
     '-',
     'docs/api.md',
     'docs/getting_started.md',
-    'docs/views.md',
   ]
 end
 

data/docs/api.md

@@ -1,4 +1,5 @@
 # @title Vedeu API
+# The Vedeu API
 
 Vedeu provides a simple DSL for the creation of terminal/console based
 applications. Below is a list of all the API methods:
@@ -16,30 +17,30 @@ class OtherClassInYourApplication
 
 Note: Nesting indicates where an API method is allowed/supposed to be used.
 
-#### Borders
+### Borders
 
 - Vedeu.border
 
-#### Configuration
+### Configuration
 
 - Vedeu.configure
 - Vedeu.configuration
 
-#### Events
+### Events
 
 - Vedeu.bind
 - Vedeu.trigger
 - Vedeu.unbind
 
-#### Geometry
+### Geometry
 
 - Vedeu.geometry
 
-#### Groups
+### Groups
 
 - Vedeu.group
 
-#### Input
+### Input
 
 - Vedeu.keypress
 - Vedeu.keymap
@@ -47,7 +48,7 @@ Note: Nesting indicates where an API method is allowed/supposed to be used.
   - name
   - interface
 
-#### Interfaces
+### Interfaces
 
 - Vedeu.interface
   - background
@@ -73,7 +74,7 @@ Note: Nesting indicates where an API method is allowed/supposed to be used.
   - style
   - use
 
-#### Views
+### Views
 
 - Vedeu.renders
 - Vedeu.render
@@ -109,18 +110,18 @@ Note: Nesting indicates where an API method is allowed/supposed to be used.
 - Vedeu.views
   - ... as #renders
 
-#### Menus
+### Menus
 
 - Vedeu.menu
   - items
   - name
 
-#### Renderers
+### Renderers
 
 - Vedeu.renderer
 - Vedeu.renderers
 
-#### Repositories
+### Repositories
 
 These are collections which you can access:
 
@@ -136,7 +137,7 @@ These are collections which you can access:
 - Vedeu.keymaps
 - Vedeu.menus
 
-#### Miscellany
+### Miscellany
 
 - Vedeu.cursor
 - Vedeu.focus
@@ -151,4 +152,3 @@ These are collections which you can access:
 - Vedeu.resize
 - Vedeu.timer
 - Vedeu.width
-

data/docs/dsl.md

@@ -1,10 +1,11 @@
 # @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.
 
-### Interfaces
+## 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
@@ -140,6 +141,7 @@ end
 
 ## Views
 
+{include:Vedeu::DSL::View}
 {include:Vedeu::DSL::View.interface}
 
 ### Immediate rendering
@@ -158,3 +160,10 @@ end
 
 `@todo` More documentation coming soon.
 
+#### Authors Notes
+
+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.

data/docs/events.md

@@ -1,5 +1,4 @@
 # @title Vedeu Events
-
 # Vedeu Events
 
 ## System Events

data/docs/getting_started.md

@@ -1,27 +1,185 @@
 # @title Getting Started with Vedeu
+# Getting Started with Vedeu
 
-- Set your configuration.
-- Define your interfaces.
-  - Define the border.
-  - Define the geometry.
-  - Define the keymap.
-- Define the global keymap, this will be used irrespective of the interface
-  currently in focus.
+## Installation
 
+First, install the gem locally:
 
-### Predefined Keys
+    gem install vedeu
 
-Vedeu automatically defines four keys for your client application:
+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:
 
-  - 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.
+    vedeu
 
-  - <esc> = Mode Switch. Toggle between cooked and raw terminal modes.
+## Generating a new application
 
-  - <tab> = Focus Next. Focus the next interface in the focus list.
+The following command will build a new application. Substitute `your_app_name`
+for your desired application name.
 
-  - <shift+tab> = Focus Previous. Focus the previous interface in the focus
-    list.
+    vedeu new your_app_name
 
+The generated files are a skeleton Vedeu client application. Let's take a look
+at these files individually.
+
+```bash
+|
+|- app_name/
+|   |
+    |- app/
+    |   |- controllers/
+    |   |   |- application_controller.rb
+    |   |
+    |   |- helpers/
+    |   |   |- application_helper.rb
+    |   |
+    |   |- models/
+    |   |   |- keymaps/
+    |   |       |- _global_.rb
+    |   |
+    |   |- views/
+    |       |- interfaces/
+    |       |- templates/
+    |
+    |- bin/
+    |   |- app_name
+    |
+    |- config/
+    |   |- add_name
+    |   |- configuration.rb
+    |
+    |- lib/
+    |- test/
+    |- vendor/
+    |- application.rb
+    |- Gemfile
+```
+
+### 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.
+
+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.
+
+### 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!
+
+### 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:
+
+- **`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.
+
+- **`<esc>`**
+
+  **Mode Switch**. Toggle between cooked and raw terminal modes.
+
+- **`<tab>`**
+
+  **Focus Next**. Focus the next interface in the focus list.
+
+- **`<shift+tab>`**
+
+  **Focus Previous**. Focus the previous interface in the focus list.
+
+### app/views/
+
+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.
+
+### 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.
+
+### 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.
+
+### 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.
+
+### lib/
+
+This is for code your application may use to support code you have in
+`app/models`.
+
+### test/
+
+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.
+
+
+## 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.
+
+    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:
+
+```bash
+|
+|- app_name/
+|   |
+    |- app/
+    |   |- controllers/
+    |   |   |- view_name_controller.rb
+    |   |
+    |   |- helpers/
+    |   |   |- view_name_helper.rb
+    |   |
+    |   |- models/
+    |   |   |- keymaps/
+    |   |       |- view_name.rb
+    |   |
+    |   |- views/
+    |       |- interfaces/
+    |       |   |- view_name.rb
+    |       |
+    |       |- templates/
+    |       |   |- view_name.erb
+    |       |
+    |       |- view_name.rb
+    |...
+```

data/lib/vedeu/all.rb

@@ -35,6 +35,7 @@ require 'vedeu/null/buffer'
 require 'vedeu/null/generic'
 require 'vedeu/null/geometry'
 require 'vedeu/null/interface'
+require 'vedeu/null/menu'
 
 require 'vedeu/geometry/area'
 require 'vedeu/geometry/coordinate'
@@ -47,6 +48,7 @@ require 'vedeu/geometry/position_index'
 require 'vedeu/geometry/position'
 require 'vedeu/geometry/position_validator'
 
+require 'vedeu/colours/escape_sequences'
 require 'vedeu/colours/colours'
 require 'vedeu/colours/backgrounds'
 require 'vedeu/colours/foregrounds'
@@ -173,3 +175,6 @@ require 'vedeu/bindings/system'
 require 'vedeu/bindings/visibility'
 
 require 'vedeu/bindings'
+
+require 'vedeu/plugins'
+require 'vedeu/plugins/plugin'

data/lib/vedeu/api.rb

@@ -73,6 +73,25 @@ module Vedeu
     # @return [Vedeu::Cursors]
     def_delegators Vedeu::Cursors, :cursors
 
+    # Manipulate the DRb server implementation.
+    #
+    # @example
+    #   Vedeu.drb_restart
+    #   Vedeu.drb_start
+    #   Vedeu.drb_status
+    #   Vedeu.drb_stop
+    #
+    # @!method drb_restart
+    #   @see Vedeu::Distributed::Server#restart
+    # @!method drb_start
+    #   @see Vedeu::Distributed::Server#start
+    # @!method drb_status
+    #   @see Vedeu::Distributed::Server#status
+    # @!method drb_stop
+    #   @see Vedeu::Distributed::Server#stop
+    def_delegators Vedeu::Distributed::Server, :drb_restart, :drb_start,
+                   :drb_status, :drb_stop
+
     # @example
     #   Vedeu.border
     #