vedeu 0.4.14 → 0.4.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b7c54da4b2eda5de86cde144c882a63a2699475f
-  data.tar.gz: d3477590f4f488e40117aa284a57702e039df523
+  metadata.gz: 1c8865f24cef3c2543a91eb50d836dbc561e25d4
+  data.tar.gz: 36c470985cca56b3ce4971da527483b67371121b
 SHA512:
-  metadata.gz: a5868261a9d78a1fee37410fdc2eda682a90c4f631384fff07be495f83993869b5e6be62b246656c9ef6b6ea97389646d190295095c993c39f3fde1071322e5c
-  data.tar.gz: 7faf1541d7b987ace4a81d94714be0c5bec7a97e750e7dac8bf8cb0c8016fccc6a3e3ac99dd9a7df357629e659069473c6c463ef07e0e8a6a53762242b5b1a6c
+  metadata.gz: 6fd140c4261e97199d0ac05f7d1cd45bbbd6132b4fb34db4359786c35d5f2a2fdbb4957946647cded9fcc5eecf18b7eab4a57ade8aabfb47957661e04f6d7f09
+  data.tar.gz: 5b123a4c23bc9600064f974c2326c0b699747c689388ff096eb3e9cfd6417fb88d04168d392ea4c76717bc6beefb4508f0606f68fdf69b1138a6f80f97eb6630

data/.rubocop.yml

@@ -619,7 +619,7 @@ Style/WordArray:
 Metrics/AbcSize:
   # The ABC size is a calculated magnitude, so this number can be a Fixnum or
   # a Float.
-  Max: 15
+  Max: 20
 
 Metrics/BlockNesting:
   Max: 3
@@ -630,7 +630,7 @@ Metrics/ClassLength:
 
 # Avoid complex methods.
 Metrics/CyclomaticComplexity:
-  Max: 6
+  Max: 10
 
 Metrics/LineLength:
   Max: 80
@@ -650,7 +650,7 @@ Metrics/ParameterLists:
   CountKeywordArgs: true
 
 Metrics/PerceivedComplexity:
-  Max: 7
+  Max: 10
 
 ##################### Lint ##################################
 

data/README.md

@@ -4,7 +4,9 @@
 
 # Vedeu
 
-Vedeu (vee-dee-you; aka VDU) is my attempt at creating a terminal based application framework without the need for Ncurses. I've tried to make Vedeu as simple and flexible as possible.
+Vedeu (vee-dee-you; aka VDU) is my attempt at creating a terminal based
+ application framework without the need for Ncurses. I've tried to make Vedeu
+ as simple and flexible as possible.
 
 
 ## Requirements
@@ -12,7 +14,8 @@ Vedeu (vee-dee-you; aka VDU) is my attempt at creating a terminal based applicat
 Vedeu has been built primarily on MacOSX 10.9/10.10 (Mavericks/Yosemite) with
  Ruby v2.1.
 
-Note: You may have trouble running Vedeu with Windows installations. (Pull requests welcome!)
+Note: You may have trouble running Vedeu with Windows installations. (Pull
+ requests welcome!)
 
 
 ## Installation
@@ -28,7 +31,9 @@ And then execute:
 
 ## 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. The [RubyDoc](http://rubydoc.info/github/gavinlaking/vedeu/master/frames) may also help!
+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. The
+ [RubyDoc](http://rubydoc.info/gems/vedeu) may also help!
 
 
 ## Usage
@@ -66,20 +71,32 @@ end
 
 ### Building Interfaces & Views
 
-Views with Vedeu are made up of simple building blocks. These blocks can be arranged in a multitude of ways which I hope is more than sufficient for your design needs.
+Views with Vedeu are made up of simple building blocks. These blocks can be
+ arranged in a multitude of ways which I hope is more than sufficient for your
+ design needs.
 
 - A view (`Composition`) is made up of one or more interfaces.
-- An interface is an area on the screen where you can take input or direct output. You will define it's colour and style, its dimensions, including position and give it a name. You can then direct the output of a command, or event, to this interface and Vedeu will ensure the content is placed there.
-- Interfaces (`Interface`) are made up of lines (`Line`), their length being the width of the interface and their number being the height of the interface.
-- An interface with `width: 12, height: 5` will have five lines, each made of 12 characters- providing 60 cells. Colours and styles are handled by terminal escape sequences and therefore do not consume a cell.
-- Lines are made up of zero, one or multiple streams (`Stream`) which are basically subsets of the line.
+- An interface is an area on the screen where you can take input or direct
+  output. You will define it's colour and style, its dimensions, including
+  position and give it a name. You can then direct the output of a command, or
+  event, to this interface and Vedeu will ensure the content is placed there.
+- Interfaces (`Interface`) are made up of lines (`Line`), their length being the
+  width of the interface and their number being the height of the interface.
+- An interface with `width: 12, height: 5` will have five lines, each made of 12
+  characters- providing 60 cells. Colours and styles are handled by terminal
+  escape sequences and therefore do not consume a cell.
+- Lines are made up of zero, one or multiple streams (`Stream`) which are
+  basically subsets of the line.
 - An interface, line or stream can have a colour (`colour`) attribute.
 - An interface, line or stream can have a style (`style`) attribute.
-- Interfaces have a position (`y`, `x`) on the screen, and a size. (`width`, `height`)
+- Interfaces have a position (`y`, `x`) on the screen, and a size.
+  (`width`, `height`)
 - Interfaces can be placed relative to each other based on their attributes.
     - An interface has a `top`, `right`, `bottom`, `left`.
-    - An interface also has a `north` and `west` (`top` and `left` minus 1 respectively).
-    - An interface also has a `south` and `east` (`bottom` and `right` plus 1 respectively).
+    - An interface also has a `north` and `west` (`top` and `left` minus 1
+      respectively).
+    - An interface also has a `south` and `east` (`bottom` and `right` plus 1
+      respectively).
 - Colours are defined in CSS-style values, i.e. `#ff0000` would be red.
 - Styles are named. See the table below for supported styles.
 
@@ -98,7 +115,8 @@ interface 'main' do
 end
 ```
 
-Referring to the above example, interfaces have a name, and various default attributes.
+Referring to the above example, interfaces have a name, and various default
+ attributes.
 
 - `y`          sets the starting row point. (See Geometry)
 - `x`          sets the starting column point.
@@ -106,7 +124,8 @@ Referring to the above example, interfaces have a name, and various default attr
 - `width`      sets the character width of the interface
 - `height`     sets the character height of the interface
 
-Note: not setting a width or height will set the values to the terminal's reported width and height.
+Note: not setting a width or height will set the values to the terminal's
+ reported width and height.
 
 - `foreground` sets the default foreground colour.
 - `background` sets the default background colour.
@@ -114,34 +133,25 @@ Note: not setting a width or height will set the values to the terminal's report
 
 ### Events
 
-More information about events can be found in the [RubyDoc](http://rubydoc.info/github/gavinlaking/vedeu/master/frames).
+More information about events can be found in the
+ [RubyDoc](http://rubydoc.info/gems/vedeu).
 
 
 ### Geometry
 
-Geometry for Vedeu, as the same for ANSI terminals, is set top-left, which is cell/point 1, 1. Interfaces themselves have internal geometry which is handled automatically. Unless you are doing something special, you will probably only set it on a per-interface basis.
-
-
-## Debugging & Environment Variables
-
-Vedeu has two types of debugging; `VEDEU_DEBUG` and `VEDEU_TRACE`. Both of these can be configured at run-time using the arguments you pass to your application. They can also be enabled/disabled globally by setting environment variables (see below). These messages are written to `~/.vedeu/vedeu.log`.
-
-To enable or disable, use true or false:
-
-```bash
-echo "export VEDEU_DEBUG=true" >> ~/.bashrc
-echo "export VEDEU_TRACE=true" >> ~/.bashrc
-```
-
-Debugging (`VEDEU_DEBUG`) provides helpful messages which inform you what is happening in the application. Tracing (`VEDEU_TRACE`) is a noisy, blow-by-blow account of what is happening, letting you know which methods were called and which events have been triggered. Both (more so with tracing) can impact the performance of your application.
+Geometry for Vedeu, as the same for ANSI terminals, is set top-left, which is
+ cell/point 1, 1. Interfaces themselves have internal geometry which is handled
+ automatically. Unless you are doing something special, you will probably only
+ set it on a per-interface basis.
 
 
 ## Development / Contributing
 
-* Documentation hosted at [RubyDoc](http://rubydoc.info/github/gavinlaking/vedeu/master/frames).
+* Documentation hosted at [RubyDoc](http://rubydoc.info/gems/vedeu).
 * Source hosted at [GitHub](https://github.com/gavinlaking/vedeu).
 
-Pull requests are very welcome! Please try to follow these simple rules if applicable:
+Pull requests are very welcome! Please try to follow these simple rules if
+ applicable:
 
 * Please create a topic branch for every separate change you make.
 * Make sure your patches are well tested.
@@ -149,8 +159,10 @@ Pull requests are very welcome! Please try to follow these simple rules if appli
 * Update the [README](https://github.com/gavinlaking/vedeu/blob/master/README.md).
 * Please **do not change** the version number.
 
-Any branch on the repository that is not `master` is probably experimental; do not rely on anything in these branches. Typically, `twerks` will be merged into `master` before a release,
-and branches prefixed with `spike/` are me playing with ideas.
+Any branch on the repository that is not `master` is probably experimental; do
+ not rely on anything in these branches. Typically, `twerks` will be merged
+ into `master` before a release, and branches prefixed with `spike/` are me
+ playing with ideas.
 
 
 ### General contribution help
@@ -170,8 +182,8 @@ and branches prefixed with `spike/` are me playing with ideas.
 
 ### Author
 
-[Gavin Laking](https://github.com/gavinlaking) ([@gavinlaking](http://twitter.com/gavinlaking))
-
+[Gavin Laking](https://github.com/gavinlaking)
+ ([@gavinlaking](http://twitter.com/gavinlaking))
 
 ### Contributors
 

data/docs/views.md

@@ -151,7 +151,7 @@ renders/views
 #### Authors Notes
 
 The Rubydoc documentation has more specific information about the DSL methods
-demonstrated above; it can be accessed here.
+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/examples/material_colours_app.rb

@@ -119,8 +119,3 @@ class VedeuMaterialColoursApp
 end
 
 VedeuMaterialColoursApp.start(ARGV)
-
-
-
-
-

data/lib/vedeu/cursor/cursor.rb

@@ -8,7 +8,6 @@ module Vedeu
   #
   class Cursor
 
-    extend Forwardable
     include Vedeu::Model
 
     # @!attribute [r] attributes
@@ -89,9 +88,8 @@ module Vedeu
     # When passed a block, will position the cursor, yield and return the
     # original position.
     #
-    # @param block [Proc]
     # @return [String]
-    def to_s(&block)
+    def to_s
       if block_given?
         [sequence, yield, sequence].join
 
@@ -103,9 +101,10 @@ module Vedeu
 
     private
 
-    # @!attribute [r] position
     # @return [Vedeu::Position]
-    attr_reader :position
+    def position
+      @position ||= Vedeu::Position.new(y, x)
+    end
 
     # The default values for a new instance of this class.
     #

data/lib/vedeu/cursor/move.rb

@@ -37,27 +37,22 @@ module Vedeu
 
     extend Forwardable
 
-    def_delegators :@interface, :border,
-                   :border?,
-                   :geometry
-
-    def_delegators :geometry, :left,
-                   :top,
+    def_delegators :border,
                    :height,
-                   :width
+                   :width,
+                   :x,
+                   :y
 
     # Returns an instance of Vedeu::Move.
     #
-    # @param cursor    [Cursor]
-    # @param interface [Interface]
-    # @param dy        [Fixnum] Move up (-1), or down (1), or no action (0).
-    # @param dx        [Fixnum] Move left (-1), or right (1), or no action (0).
+    # @param name [String] The name of the cursor.
+    # @param dy [Fixnum] Move up (-1), or down (1), or no action (0).
+    # @param dx [Fixnum] Move left (-1), or right (1), or no action (0).
     # @return [Move]
-    def initialize(cursor, interface, dy = 0, dx = 0)
-      @cursor    = cursor
-      @dy        = dy || 0
-      @dx        = dx || 0
-      @interface = interface
+    def initialize(name, dy = 0, dx = 0)
+      @name = name
+      @dy   = dy
+      @dx   = dx
     end
 
     # Move the named cursor, or that which is currently in focus in the
@@ -71,85 +66,64 @@ module Vedeu
     #   cursor instance to move.
     # @return [Cursor]
     def self.by_name(direction, name = nil)
-      if name
-        cursor     = Vedeu.cursors.by_name(name)
-        interface  = Vedeu.interfaces.find(name)
-
-      else
-        cursor     = Vedeu.cursor
-        interface  = Vedeu.interfaces.current
-
-      end
+      name = name ? name : Vedeu.focus
 
-      new_cursor = Vedeu::Move.send(direction, cursor, interface)
-
-      Vedeu.trigger(:_refresh_cursor_, new_cursor.name)
-
-      new_cursor
+      Vedeu::Move.send(direction, name)
     end
 
     # Moves the cursor down by one row.
     #
-    # @param cursor    [Cursor]
-    # @param interface [Interface]
+    # @param name [String]
     # @return [Cursor]
-    def self.down(cursor, interface)
-      new(cursor, interface, 1, 0).move
+    def self.down(name)
+      new(name, 1, 0).move
     end
 
     # Moves the cursor left by one column.
     #
-    # @param cursor    [Cursor]
-    # @param interface [Interface]
+    # @param name [String]
     # @return [Cursor]
-    def self.left(cursor, interface)
-      return cursor unless cursor.ox > 0
-
-      new(cursor, interface, 0, -1).move
+    def self.left(name)
+      new(name, 0, -1).move
     end
 
     # Moves the cursor right by one column.
     #
-    # @param cursor    [Cursor]
-    # @param interface [Interface]
+    # @param name [String]
     # @return [Cursor]
-    def self.right(cursor, interface)
-      new(cursor, interface, 0, 1).move
+    def self.right(name)
+      new(name, 0, 1).move
     end
 
     # Moves the cursor up by one row.
     #
-    # @param cursor    [Cursor]
-    # @param interface [Interface]
+    # @param name [String]
     # @return [Cursor]
-    def self.up(cursor, interface)
-      return cursor unless cursor.oy > 0
-
-      new(cursor, interface, -1, 0).move
+    def self.up(name)
+      new(name, -1, 0).move
     end
 
     # Moves the cursor to the top left coordinate of the interface.
     #
-    # @param cursor    [Cursor]
-    # @param interface [Interface]
+    # @param name [String]
     # @return [Cursor]
-    def self.origin(cursor, interface)
-      new(cursor, interface, (0 - cursor.y), (0 - cursor.x)).move
+    def self.origin(name)
+      new(name, -2000, -2000).move
     end
 
     # Returns a newly positioned and stored Cursor.
     #
     # @return [Cursor]
     def move
-      Vedeu::Cursor.new(cursor.attributes.merge!(moved_attributes)).store
+      cursor = Vedeu::Cursor.new(attributes.merge!(new_attributes)).store
+
+      Vedeu.trigger(:_refresh_cursor_, name)
+
+      cursor
     end
 
     private
 
-    # @!attribute [r] cursor
-    # @return [Vedeu::Cursor]
-    attr_reader :cursor
-
     # @!attribute [r] dx
     # @return [Fixnum]
     attr_reader :dx
@@ -158,12 +132,17 @@ module Vedeu
     # @return [Fixnum]
     attr_reader :dy
 
-    # @!attribute [r] interface
-    # @return [Vedeu::Interface]
-    attr_reader :interface
+    # @!attribute [r] name
+    # @return [String]
+    attr_reader :name
+
+    # @return [Hash<Symbol => Fixnum, String>]
+    def attributes
+      cursor.attributes
+    end
 
     # @return [Hash<Symbol => Fixnum>]
-    def moved_attributes
+    def new_attributes
       {
         x:  validator.x,
         y:  validator.y,
@@ -174,7 +153,7 @@ module Vedeu
 
     # @return [PositionValidator]
     def validator
-      @validator ||= Vedeu::PositionValidator.validate(interface.name,
+      @validator ||= Vedeu::PositionValidator.validate(name,
                                                        x_position,
                                                        y_position)
     end
@@ -189,30 +168,19 @@ module Vedeu
       coordinate.y_position(oy)
     end
 
-    # @return [Coordinate]
-    def coordinate
-      @coordinate ||= Vedeu::Coordinate.new(bordered_height,
-                                            bordered_width,
-                                            left,
-                                            top)
+    # @return (see Vedeu::Borders#by_name)
+    def border
+      @border ||= Vedeu.borders.by_name(name)
     end
 
-    # Return the height of the interface, minus any borders.
-    #
-    # @return [Fixnum]
-    def bordered_height
-      return border.height if border?
-
-      height
+    # @return [Coordinate]
+    def coordinate
+      @coordinate ||= Vedeu::Coordinate.new(height, width, x, y)
     end
 
-    # Return the width of the interface, minus any borders.
-    #
-    # @return [Fixnum]
-    def bordered_width
-      return border.width if border?
-
-      width
+    # @return (see Vedeu::Cursors#by_name)
+    def cursor
+      @cursor ||= Vedeu.cursors.by_name(name)
     end
 
     # Apply the direction amount to the cursor offset. If the offset is less