vedeu 0.8.7 → 0.8.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e661f87496fae0bee6cfad0f28107ef83de0afd7
-  data.tar.gz: e9c940bfeba84b518e8c9aae271b78e64ece3e7b
+  metadata.gz: 8abebd20481d927ef3b7de1f4a21c566109fcb5a
+  data.tar.gz: 3db48c0f3218d6d534cf731f256084e6a98efb91
 SHA512:
-  metadata.gz: 2f690ac0877398edcf8cae81bf4d82d0da2bc997e938fec1680cd527d544b036363295bc9cfaf0a79c8cbef1fef4d7bde28b7f7580a46da72d02cab7a4407c42
-  data.tar.gz: f383c6aa69b348950df538a5cf5df7b942adc99d3ce927d62cd88c54d51450511c337b0d642b32e66217ceee5528cb2159caab913ef42e09b7a2a256e22b3a1f
+  metadata.gz: e6555ade9af405d42797525c9ce496d4e6f105babf54d6edbfe5cf2fcbc618b71823b9709544fca60c8c2a853918d4d259dc372ca56bf037061d351add0f5016
+  data.tar.gz: 057a89420029e115a3a87bcdc56872d0e01b0149e08c4d29899870632a0e989377b09b295bf7be4f94f4e8ed8800c1fec1a59292cb635696bca7d2604edee9c5

data/TODO.md

@@ -2,3 +2,11 @@
 
 - Add Vedeu::Index which converts a Vedeu::Point to an array index.
   i.e. Never less than 0, always 1 less than the Vedeu::Point value.
+
+## 2016-01-11
+
+- Investigate the differences between memoizing in
+  Vedeu::Geometries::Geometry#area and not memoizing. Memoizing saves
+  ~80ms on running test suite and considerably impacts app
+  responsiveness, however changes to the geometry (such as movement or
+  maximising) are not reflected.

data/docs/dsl/by_method/buffer_update.md

@@ -1 +1,3 @@
-@todo Add more documentation.
+Write the given output to the configured or default renderers.
+
+    Vedeu.buffer_update(output)

data/docs/dsl/by_method/buffer_write.md

@@ -1 +1,3 @@
-@todo Add more documentation.
+Write the given output to the configured or default renderers.
+
+    Vedeu.buffer_write(output)

data/docs/dsl/by_method/cursor.md

@@ -1 +1,3 @@
-@todo Add more documentation.
+Fetch the cursor of the currently focussed interface/view.
+
+    Vedeu.cursor

data/docs/dsl/by_method/cursors.md

@@ -1 +1,3 @@
-@todo Add more documentation.
+Manipulate the repository of cursors.
+
+    Vedeu.cursors

data/docs/dsl/by_method/direct_write.md

@@ -1 +1,3 @@
-@todo Add more documentation.
+Write the given output to the configured or default renderers.
+
+    Vedeu.direct_write(output)

data/docs/dsl/by_method/log_stderr.md

@@ -1 +1,4 @@
-@todo Add more documentation.
+Write a message to STDERR. Will also attempt to write to the log file
+if configured for later reference.
+
+    Vedeu.log_stderr(message: message, type: type)

data/docs/dsl/by_method/log_stdout.md

@@ -1 +1,4 @@
-@todo Add more documentation.
+Write a message to STDOUT. Will also attempt to write to the log file
+if configured for later reference.
+
+    Vedeu.log_stdout(message: message, type: type)

data/docs/dsl/by_method/log_timestamp.md

@@ -1 +1,7 @@
-@todo Add more documentation.
+Returns a formatted timestamp indicating the number of seconds the
+client application has been running.
+
+The first time this method is called, it will return `[ 0.0000] `.
+Subsequent calls will be relative to this first time entry.
+
+    Vedeu.log_timestamp # => [137.7842]

data/docs/dsl/by_method/render_output.md

@@ -1 +1,3 @@
-@todo Add more documentation.
+Write the given output to the configured or default renderers.
+
+    Vedeu.render_output(output)

data/docs/events/by_name/cursor_down.md

@@ -1,4 +1,9 @@
 ### `:_cursor_down_`
+Moves the cursor one line down, unless the bottom-most position for
+the view or terminal is reached.
 
     Vedeu.trigger(:_cursor_down_, name)
     Vedeu.trigger(:_cursor_down_, Vedeu.focus)
+
+Note: `name` is a Symbol unless mentioned otherwise, and can be
+substituted for `Vedeu.focus` to use the interface currently in focus.

data/docs/events/by_name/cursor_left.md

@@ -4,3 +4,6 @@ for the view or terminal is reached.
 
     Vedeu.trigger(:_cursor_left_, name)
     Vedeu.trigger(:_cursor_left_, Vedeu.focus)
+
+Note: `name` is a Symbol unless mentioned otherwise, and can be
+substituted for `Vedeu.focus` to use the interface currently in focus.

data/docs/events/by_name/cursor_origin.md

@@ -3,4 +3,7 @@ This event moves the cursor to the interface origin; the top left
 corner of the named interface.
 
     Vedeu.trigger(:_cursor_origin_, name)
+    Vedeu.trigger(:_cursor_origin_, Vedeu.focus)
+
     Vedeu.trigger(:_cursor_reset_, name)
+    Vedeu.trigger(:_cursor_reset_, Vedeu.focus)

data/docs/events/by_name/cursor_right.md

@@ -1,4 +1,9 @@
 ### `:_cursor_right_`
+Moves the cursor one character to the right, unless the right-most
+position for the view or terminal is reached.
 
     Vedeu.trigger(:_cursor_right_, name)
     Vedeu.trigger(:_cursor_right_, Vedeu.focus)
+
+Note: `name` is a Symbol unless mentioned otherwise, and can be
+substituted for `Vedeu.focus` to use the interface currently in focus.

data/docs/events/by_name/cursor_top.md

@@ -5,3 +5,6 @@ to the first line of the content.
 
     Vedeu.trigger(:_cursor_top_, name)
     Vedeu.trigger(:_cursor_top_, Vedeu.focus)
+
+Note: `name` is a Symbol unless mentioned otherwise, and can be
+substituted for `Vedeu.focus` to use the interface currently in focus.

data/docs/events/by_name/cursor_up.md

@@ -4,3 +4,6 @@ view or terminal is reached.
 
     Vedeu.trigger(:_cursor_up_, name)
     Vedeu.trigger(:_cursor_up_, Vedeu.focus)
+
+Note: `name` is a Symbol unless mentioned otherwise, and can be
+substituted for `Vedeu.focus` to use the interface currently in focus.

data/docs/events/by_name/hide_cursor.md

@@ -1,10 +1,15 @@
 ### Vedeu.hide_cursor / `:_hide_cursor_`
-Hide the cursor.
+Hide a named cursor, or without a name, the cursor of the currently
+focussed interface.
 
     Vedeu.trigger(:_hide_cursor_, name)
     Vedeu.trigger(:_hide_cursor_, Vedeu.focus)
+    Vedeu.trigger(:_hide_cursor_)
+
     Vedeu.trigger(:_cursor_hide_, name)
     Vedeu.trigger(:_cursor_hide_, Vedeu.focus)
+    Vedeu.trigger(:_cursor_hide_)
 
     Vedeu.hide_cursor(name)
     Vedeu.hide_cursor(Vedeu.focus)
+    Vedeu.hide_cursor

data/docs/events/by_name/maximise.md

@@ -1,6 +1,5 @@
 ### `:_maximise_`
-Maximising an interface.
+Will maximise the named interface geometry. This means it will occupy
+all of the available space on the terminal window.
 
     Vedeu.trigger(:_maximise_, name)
-
-See {Vedeu::Geometries::Geometry#maximise}

data/docs/events/by_name/show_cursor.md

@@ -1,10 +1,15 @@
 ### Vedeu.show_cursor / `:_show_cursor_`
-Show the cursor.
+Show a named cursor, or without a name, the cursor of the currently
+focussed interface.
 
     Vedeu.trigger(:_show_cursor_, name)
     Vedeu.trigger(:_show_cursor_, Vedeu.focus)
+    Vedeu.trigger(:_show_cursor_)
+
     Vedeu.trigger(:_cursor_show_, name)
     Vedeu.trigger(:_cursor_show_, Vedeu.focus)
+    Vedeu.trigger(:_cursor_show_)
 
     Vedeu.show_cursor(name)
     Vedeu.show_cursor(Vedeu.focus)
+    Vedeu.show_cursor

data/docs/events/by_name/unmaximise.md

@@ -1,6 +1,8 @@
 ### `:_unmaximise_`
-Unmaximising an interface.
+Will unmaximise the named interface geometry. Previously, when a
+geometry was maximised, then triggering the unmaximise event will
+return it to its usual defined size (terminal size permitting: when
+the terminal has been resized, then the new geometry size should
+adapt).
 
     Vedeu.trigger(:_unmaximise_, name)
-
-See {Vedeu::Geometries::Geometry#unmaximise}

data/docs/events/by_name/view_down.md

@@ -1,4 +1,12 @@
 ### `:_view_down_`
+Moves the view one row/line down, unless the bottom/last row/line for
+the terminal is reached.
 
     Vedeu.trigger(:_view_down_, name)
     Vedeu.trigger(:_view_down_, Vedeu.focus)
+
+    Vedeu.trigger(:_geometry_down_, name)
+    Vedeu.trigger(:_geometry_down_, Vedeu.focus)
+
+Note: `name` is a Symbol unless mentioned otherwise, and can be
+substituted for `Vedeu.focus` to use the interface currently in focus.

data/docs/events/by_name/view_left.md

@@ -1,4 +1,12 @@
 ### `:_view_left_`
+Moves the view one column/character left, unless the left-most
+column/character for the terminal is reached.
 
     Vedeu.trigger(:_view_left_, name)
     Vedeu.trigger(:_view_left_, Vedeu.focus)
+
+    Vedeu.trigger(:_geometry_left_, name)
+    Vedeu.trigger(:_geometry_left_, Vedeu.focus)
+
+Note: `name` is a Symbol unless mentioned otherwise, and can be
+substituted for `Vedeu.focus` to use the interface currently in focus.

data/docs/events/by_name/view_right.md

@@ -1,4 +1,12 @@
 ### `:_view_right_`
+Moves the view one row/line right, unless the right-most row/line for
+the terminal is reached.
 
     Vedeu.trigger(:_view_right_, name)
     Vedeu.trigger(:_view_right_, Vedeu.focus)
+
+    Vedeu.trigger(:_geometry_right_, name)
+    Vedeu.trigger(:_geometry_right_, Vedeu.focus)
+
+Note: `name` is a Symbol unless mentioned otherwise, and can be
+substituted for `Vedeu.focus` to use the interface currently in focus.

data/docs/events/by_name/view_up.md

@@ -1,4 +1,12 @@
 ### `:_view_up_`
+Moves the view one row/line up, unless the top/first row/line for
+the terminal is reached.
 
     Vedeu.trigger(:_view_up_, name)
     Vedeu.trigger(:_view_up_, Vedeu.focus)
+
+    Vedeu.trigger(:_geometry_up_, name)
+    Vedeu.trigger(:_geometry_up_, Vedeu.focus)
+
+Note: `name` is a Symbol unless mentioned otherwise, and can be
+substituted for `Vedeu.focus` to use the interface currently in focus.

data/docs/events/document.md

@@ -2,7 +2,8 @@
 
 ## Document Events
 
-Note: 'name' is a Symbol unless mentioned otherwise.
+Note: `name` is a Symbol unless mentioned otherwise, and can be
+substituted for `Vedeu.focus` to use the interface currently in focus.
 
 {include:file:docs/events/by_name/editor_execute.md}
 

data/docs/events/focus.md

@@ -2,7 +2,8 @@
 
 ## Focus Events
 
-Note: 'name' is a Symbol unless mentioned otherwise.
+Note: `name` is a Symbol unless mentioned otherwise, and can be
+substituted for `Vedeu.focus` to use the interface currently in focus.
 
 {include:file:docs/events/by_name/focus_by_name.md}
 

data/docs/events/menu.md

@@ -2,7 +2,8 @@
 
 ## Menu Events
 
-Note: 'name' is a Symbol unless mentioned otherwise.
+Note: `name` is a Symbol unless mentioned otherwise, and can be
+substituted for `Vedeu.focus` to use the interface currently in focus.
 
 {include:file:docs/events/by_name/menu_bottom.md}
 

data/docs/events/movement.md

@@ -2,7 +2,8 @@
 
 ## Movement Events
 
-Note: 'name' is a Symbol unless mentioned otherwise.
+Note: `name` is a Symbol unless mentioned otherwise, and can be
+substituted for `Vedeu.focus` to use the interface currently in focus.
 
 For cursor related movement events, please refer to
 {file:docs/cursors.md} Cursors.

data/docs/events/refresh.md

@@ -2,7 +2,8 @@
 
 ## Refresh Events
 
-Note: 'name' is a Symbol unless mentioned otherwise.
+Note: `name` is a Symbol unless mentioned otherwise, and can be
+substituted for `Vedeu.focus` to use the interface currently in focus.
 
 {include:file:docs/events/by_name/refresh.md}
 

data/docs/events/view.md

@@ -2,7 +2,8 @@
 
 ## View Events
 
-Note: 'name' is a Symbol unless mentioned otherwise.
+Note: `name` is a Symbol unless mentioned otherwise, and can be
+substituted for `Vedeu.focus` to use the interface currently in focus.
 
 {include:file:docs/events/by_name/maximise.md}
 

data/docs/events/visibility.md

@@ -2,7 +2,8 @@
 
 ## Visibility Events
 
-Note: 'name' is a Symbol unless mentioned otherwise.
+Note: `name` is a Symbol unless mentioned otherwise, and can be
+substituted for `Vedeu.focus` to use the interface currently in focus.
 
 {include:file:docs/events/by_name/clear.md}
 

data/examples/dsl_horizontal_alignment.rb

@@ -38,7 +38,7 @@ class HorizontalAlignmentApp
         end
       end
 
-      Vedeu.trigger(:_refresh_view, :centre_interface)
+      Vedeu.trigger(:_refresh_view_, :centre_interface)
     end
 
     def gc

data/examples/dsl_vertical_alignment.rb

@@ -38,7 +38,7 @@ class VerticalAlignmentApp
         end
       end
 
-      Vedeu.trigger(:_refresh_view, :middle_interface)
+      Vedeu.trigger(:_refresh_view_, :middle_interface)
     end
 
     def gc

data/integrations/dsl_app_border_001.rb

@@ -0,0 +1,63 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'vedeu'
+
+class DSLApp
+
+  Vedeu.bind(:_initialize_) { Vedeu.trigger(:_refresh_) }
+
+  Vedeu.configure do
+    debug!
+    log '/tmp/vedeu_views_dsl.log'
+    renderers [
+                Vedeu::Renderers::Terminal.new(
+                  filename:   '/tmp/dsl_app_border_001.out',
+                  write_file: true),
+                # Vedeu::Renderers::JSON.new(filename: '/tmp/dsl_app_border_001.json'),
+                # Vedeu::Renderers::HTML.new(filename: '/tmp/dsl_app_border_001.html'),
+                # Vedeu::Renderers::Text.new(filename: '/tmp/dsl_app_border_001.txt'),
+              ]
+    run_once!
+    standalone!
+  end
+
+  load './support/test_interface.rb'
+
+  Vedeu.border :test_interface do
+    disable!
+  end
+
+  Vedeu.render do
+    view(:test_interface) do
+      lines do
+        line 'border off'
+      end
+    end
+  end
+
+  def self.actual
+    File.read('/tmp/dsl_app_border_001.out')
+  end
+
+  def self.expected
+    File.read(File.expand_path('../expected/dsl_app_border_001.out', __FILE__))
+  end
+
+  def self.start(argv = ARGV)
+    Vedeu::Launcher.execute!(argv)
+  end
+
+end # DSLApp
+
+DSLApp.start
+
+if DSLApp.expected == DSLApp.actual
+  puts "#{__FILE__} \e[32mPassed.\e[39m"
+  exit 0;
+else
+  puts "#{__FILE__} \e[31mFailed.\e[39m"
+  exit 1;
+end

data/integrations/dsl_app_border_002.rb

@@ -0,0 +1,63 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'vedeu'
+
+class DSLApp
+
+  Vedeu.bind(:_initialize_) { Vedeu.trigger(:_refresh_) }
+
+  Vedeu.configure do
+    debug!
+    log '/tmp/vedeu_views_dsl.log'
+    renderers [
+                Vedeu::Renderers::Terminal.new(
+                  filename:   '/tmp/dsl_app_border_002.out',
+                  write_file: true),
+                # Vedeu::Renderers::JSON.new(filename: '/tmp/dsl_app_border_002.json'),
+                # Vedeu::Renderers::HTML.new(filename: '/tmp/dsl_app_border_002.html'),
+                # Vedeu::Renderers::Text.new(filename: '/tmp/dsl_app_border_002.txt'),
+              ]
+    run_once!
+    standalone!
+  end
+
+  load './support/test_interface.rb'
+
+  Vedeu.border :test_interface do
+    show_top false
+  end
+
+  Vedeu.render do
+    view(:test_interface) do
+      lines do
+        line 'no top'
+      end
+    end
+  end
+
+  def self.actual
+    File.read('/tmp/dsl_app_border_002.out')
+  end
+
+  def self.expected
+    File.read(File.expand_path('../expected/dsl_app_border_002.out', __FILE__))
+  end
+
+  def self.start(argv = ARGV)
+    Vedeu::Launcher.execute!(argv)
+  end
+
+end # DSLApp
+
+DSLApp.start
+
+if DSLApp.expected == DSLApp.actual
+  puts "#{__FILE__} \e[32mPassed.\e[39m"
+  exit 0;
+else
+  puts "#{__FILE__} \e[31mFailed.\e[39m"
+  exit 1;
+end