vedeu 0.4.56 → 0.4.57

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 743d4a2661b960f89aa308cee33ba6e0625f76e6
-  data.tar.gz: 6df290d61f188f90a527fbdc49673b38e8f572dc
+  metadata.gz: 1a0da67baa3addb0036a2b6abda7b67388a77a69
+  data.tar.gz: a485c5238c12220429d69c2bcd1349d3e6dec625
 SHA512:
-  metadata.gz: 2b56f22b2eff13f49f599717e5c1dd8f1902d904965761c1076325cbfd9b2016e57278ab0e1000330e6ef2f358a004ecb9edfbdaf69704e565cf7f767dafad60
-  data.tar.gz: 779ad640efaab6cc5b7213e1e00b784353816386d892c0835613544f975e6e208b3052b72de5943b7ca56a23d983931d32215078accb6884243d1644382e1dd8
+  metadata.gz: 1a172e1281b71465ac807c5345e7807d6d8319e9a1933ebbeafef580ba5fffc330be8d27c35ee3713b82f0d5c7789bb1bd1e2aa124f3a82f1a0aec1b43d3bcb2
+  data.tar.gz: 241aad422c08ca44ca1671e78d6e2bab9cd80c27ffd5abe19b3b231a7bad946d8700024d3e1163cdd25d0ec806e48485d2674e6fc17dfc3e8e6930e9fa859fe6

data/examples/borders_app.rb

@@ -13,11 +13,9 @@ require 'vedeu'
 #
 class VedeuBordersApp
 
-  include Vedeu
-
   # Be aware that running an application with debugging enabled will affect
   # performance.
-  configure do
+  Vedeu.configure do
     # debug!
     log '/tmp/vedeu_borders_app.log'
     raw!
@@ -25,7 +23,7 @@ class VedeuBordersApp
     standalone!
   end
 
-  interface 'default_border' do
+  Vedeu.interface 'default_border' do
     geometry do
       x      2
       y      2
@@ -35,7 +33,7 @@ class VedeuBordersApp
     colour  foreground: '#ffffff', background: '#ff0000'
   end
 
-  interface 'border_off' do
+  Vedeu.interface 'border_off' do
     geometry do
       x      14
       y      2
@@ -45,7 +43,7 @@ class VedeuBordersApp
     colour  foreground: '#ffffff', background: '#ff0000'
   end
 
-  interface 'no_top' do
+  Vedeu.interface 'no_top' do
     geometry do
       x      26
       y      2
@@ -55,7 +53,7 @@ class VedeuBordersApp
     colour  foreground: '#000000', background: '#ff5500'
   end
 
-  interface 'no_bottom' do
+  Vedeu.interface 'no_bottom' do
     geometry do
       x      38
       y      2
@@ -65,7 +63,7 @@ class VedeuBordersApp
     colour  foreground: '#000000', background: '#ff5500'
   end
 
-  interface 'no_left' do
+  Vedeu.interface 'no_left' do
     geometry do
       x      50
       y      2
@@ -75,7 +73,7 @@ class VedeuBordersApp
     colour  foreground: '#000000', background: '#ff5500'
   end
 
-  interface 'no_right' do
+  Vedeu.interface 'no_right' do
     geometry do
       x      62
       y      2
@@ -85,7 +83,7 @@ class VedeuBordersApp
     colour  foreground: '#000000', background: '#ff5500'
   end
 
-  interface 'custom_corners' do
+  Vedeu.interface 'custom_corners' do
     geometry do
       x      2
       y      8
@@ -95,7 +93,7 @@ class VedeuBordersApp
     colour  foreground: '#ffffff', background: '#ff0000'
   end
 
-  interface 'custom_sides' do
+  Vedeu.interface 'custom_sides' do
     geometry do
       x      14
       y      8
@@ -105,7 +103,7 @@ class VedeuBordersApp
     colour  foreground: '#ffffff', background: '#ff0000'
   end
 
-  interface 'only_top' do
+  Vedeu.interface 'only_top' do
     geometry do
       x      26
       y      8
@@ -115,7 +113,7 @@ class VedeuBordersApp
     colour  foreground: '#ffffff', background: '#0000ff'
   end
 
-  interface 'only_bottom' do
+  Vedeu.interface 'only_bottom' do
     geometry do
       x      38
       y      8
@@ -125,7 +123,7 @@ class VedeuBordersApp
     colour  foreground: '#ffffff', background: '#0000ff'
   end
 
-  interface 'only_left' do
+  Vedeu.interface 'only_left' do
     geometry do
       x      50
       y      8
@@ -135,7 +133,7 @@ class VedeuBordersApp
     colour  foreground: '#ffffff', background: '#0000ff'
   end
 
-  interface 'only_right' do
+  Vedeu.interface 'only_right' do
     geometry do
       x      62
       y      8
@@ -145,7 +143,7 @@ class VedeuBordersApp
     colour  foreground: '#ffffff', background: '#0000ff'
   end
 
-  interface 'custom_colour' do
+  Vedeu.interface 'custom_colour' do
     geometry do
       x      2
       y      14
@@ -155,7 +153,7 @@ class VedeuBordersApp
     colour foreground: '#ffffff', background: '#ff0000'
   end
 
-  interface 'negative' do
+  Vedeu.interface 'negative' do
     geometry do
       x      14
       y      14
@@ -166,7 +164,7 @@ class VedeuBordersApp
     style  'normal'
   end
 
-  keymap '_global_' do
+  Vedeu.keymap '_global_' do
     key('r') { Vedeu.trigger(:_refresh_) }
 
     key('q')        { Vedeu.trigger(:_exit_) }
@@ -176,24 +174,24 @@ class VedeuBordersApp
   end
 
   # Borders can be defined as part of a view (see below), or standalone.
-  border 'no_bottom' do
+  Vedeu.border 'no_bottom' do
     foreground  '#ffffff'
     show_bottom false
   end
-  border 'no_left' do
+  Vedeu.border 'no_left' do
     foreground  '#ffffff'
     show_left false
   end
-  border 'no_right' do
+  Vedeu.border 'no_right' do
     foreground  '#ffffff'
     show_right false
   end
-  border 'no_top' do
+  Vedeu.border 'no_top' do
     foreground  '#ffffff'
     show_top false
   end
 
-  renders do
+  Vedeu.renders do
     view('default_border') do
       border do
         foreground '#ffffff'
@@ -322,6 +320,6 @@ class VedeuBordersApp
     Vedeu::Launcher.execute!(argv)
   end
 
-end
+end # VedeuBordersApp
 
 VedeuBordersApp.start(ARGV)

data/examples/colours_app.rb

@@ -13,16 +13,14 @@ require 'vedeu'
 #
 class VedeuColoursApp
 
-  include Vedeu
-
   # Be aware that running an application with debugging enabled will affect
   # performance.
-  configure do
+  Vedeu.configure do
     # debug!
     log '/tmp/vedeu_colours_app.log'
   end
 
-  interface 'colours_256' do
+  Vedeu.interface 'colours_256' do
     geometry do
       centred!
       height 16
@@ -30,7 +28,7 @@ class VedeuColoursApp
     end
   end
 
-  renders do
+  Vedeu.renders do
     view('colours_256') do
       lines do
         0.upto(16) do |row|
@@ -45,4 +43,4 @@ class VedeuColoursApp
     end
   end
 
-end
+end # VedeuColoursApp

data/examples/configuration_app.rb

@@ -22,14 +22,12 @@ require 'vedeu'
 #
 class VedeuConfigurationApp
 
-  include Vedeu
-
-  configure do
+  Vedeu.configure do
     # debug!
     log '/tmp/vedeu_configuration_app.log'
   end
 
-  interface 'config' do
+  Vedeu.interface 'config' do
     geometry do
       width  40
       height 2
@@ -37,7 +35,7 @@ class VedeuConfigurationApp
     end
   end
 
-  renders do
+  Vedeu.renders do
     view 'config' do
       lines do
         line Configuration.log.inspect + ' ' + Process.pid.to_s
@@ -45,7 +43,7 @@ class VedeuConfigurationApp
     end
   end
 
-  keymap('config') do
+  Vedeu.keymap('config') do
     key(' ') { Vedeu.trigger(:_refresh_, 'config') }
 
     key('q')        { Vedeu.trigger(:_exit_) }
@@ -58,6 +56,6 @@ class VedeuConfigurationApp
     Vedeu::Launcher.execute!(argv)
   end
 
-end
+end # VedeuConfigurationApp
 
 VedeuConfigurationApp.start(ARGV)

data/examples/drb_app.rb

@@ -115,6 +115,6 @@ class VedeuTestApplication
     Vedeu::Launcher.execute!(argv, stdin, stdout, stderr, kernel)
   end
 
-end
+end # VedeuTestApplication
 
 VedeuTestApplication.start(ARGV)

data/examples/focus_app.rb

@@ -126,6 +126,6 @@ class VedeuFocusApp
     Vedeu::Launcher.execute!(argv)
   end
 
-end
+end # VedeuFocusApp
 
 VedeuFocusApp.start(ARGV)

data/examples/geometry_app.rb

@@ -12,16 +12,14 @@ require 'vedeu'
 #
 class VedeuGeometryApp
 
-  include Vedeu
-
   # Be aware that running an application with debugging enabled will affect
   # performance.
-  configure do
+  Vedeu.configure do
     # debug!
     log '/tmp/vedeu_geometry_app.log'
   end
 
-  interface 'main_interface' do
+  Vedeu.interface 'main_interface' do
     colour foreground: '#ff0000', background: '#000000'
     cursor!
 
@@ -34,20 +32,20 @@ class VedeuGeometryApp
     end
   end
 
-  interface 'second' do
+  Vedeu.interface 'second' do
     colour foreground: '#0000ff', background: '#000000'
     cursor!
   end
 
   # Geometry can be defined either before or after the interface.
-  geometry 'second' do
+  Vedeu.geometry 'second' do
     height  8
     width   columns(1)
     x       12
     y       2
   end
 
-  keymap('_global_') do
+  Vedeu.keymap('_global_') do
     key(:up,    'k') { Vedeu.trigger(:_cursor_up_)    }
     key(:right, 'l') { Vedeu.trigger(:_cursor_right_) }
     key(:down,  'j') { Vedeu.trigger(:_cursor_down_)  }
@@ -59,7 +57,7 @@ class VedeuGeometryApp
     key(:tab)       { Vedeu.trigger(:_focus_next_) }
   end
 
-  renders do
+  Vedeu.renders do
     view 'second' do
       border!
       lines do
@@ -138,12 +136,12 @@ class VedeuGeometryApp
     end
   end
 
-  focus_by_name 'main_interface'
+  Vedeu.focus_by_name 'main_interface'
 
   def self.start(argv = ARGV)
     Vedeu::Launcher.execute!(argv)
   end
 
-end
+end # VedeuGeometryApp
 
 VedeuGeometryApp.start(ARGV)

data/examples/hello_world.rb

@@ -16,14 +16,12 @@ require 'vedeu'
 #
 class HelloWorldApp
 
-  include Vedeu
-
-  configure do
+  Vedeu.configure do
     # debug!
     log '/tmp/vedeu_hello_world.log'
   end
 
-  interface 'messages' do
+  Vedeu.interface 'messages' do
     background '#000000'
     foreground '#00ff00'
     geometry do
@@ -33,7 +31,7 @@ class HelloWorldApp
     end
   end
 
-  renders do
+  Vedeu.renders do
     view 'messages' do
       lines do
         centre 'Hello World!', width: 20
@@ -47,6 +45,6 @@ class HelloWorldApp
     Vedeu::Launcher.execute!(argv)
   end
 
-end
+end # HelloWorldApp
 
 HelloWorldApp.start(ARGV)

data/examples/material_colours_app.rb

@@ -12,19 +12,22 @@ require 'vedeu'
 #
 #     ./examples/material_colours_app.rb
 #
+# Running this application once, and immediately exiting produces the diagram
+# at `./examples/material_colours_app_20150721.svg`. Hopefully this will help
+# you to understand how parts of Vedeu work together. Questions are always
+# welcome at `https://github.com/gavinlaking/vedeu/issues`
+#
 class VedeuMaterialColoursApp
 
-  include Vedeu
-
   # Be aware that running an application with debugging enabled will affect
   # performance.
-  configure do
+  Vedeu.configure do
     # debug!
     log '/tmp/vedeu_material_colours_app.log'
     # renderers Vedeu::Renderers::File.new
   end
 
-  interface 'main_interface' do
+  Vedeu.interface 'main_interface' do
     border 'main_interface' do
       colour foreground: '#ffffff', background: :default
       title 'Rainbow!'
@@ -42,10 +45,17 @@ class VedeuMaterialColoursApp
 
   # This interface uses the 'parens' style for the DSL, which sometimes helps
   # Ruby to understand the values you provide.
-  interface 'other_interface' do
+  #
+  # It also uses custom border characters to demonstrate that functionality.
+  Vedeu.interface 'other_interface' do
     border 'other_interface' do
       colour(foreground: '#ffffff', background: :default)
       title('Wow!')
+      horizontal('-')
+      top_right('+')
+      top_left('+')
+      bottom_right('+')
+      bottom_left('+')
     end
     colour(foreground: '#ffffff', background: :default)
     cursor!
@@ -58,7 +68,7 @@ class VedeuMaterialColoursApp
     zindex(1)
   end
 
-  keymap('_global_') do
+  Vedeu.keymap('_global_') do
     key(:up)    { Vedeu.trigger(:_cursor_up_)    }
     key(:right) { Vedeu.trigger(:_cursor_right_) }
     key(:down)  { Vedeu.trigger(:_cursor_down_)  }
@@ -93,7 +103,7 @@ class VedeuMaterialColoursApp
     key('v') { Vedeu.trigger(:_unmaximise_, 'other_interface') }
   end
 
-  renders do
+  Vedeu.renders do
     view 'main_interface' do
       line { centre 'Red',         width: 20, background: '#f44336' }
       line { centre 'Pink',        width: 20, background: '#e91e63' }
@@ -139,12 +149,12 @@ class VedeuMaterialColoursApp
     end
   end
 
-  focus_by_name 'main_interface'
+  Vedeu.focus_by_name 'main_interface'
 
   def self.start(argv = ARGV)
     Vedeu::Launcher.execute!(argv)
   end
 
-end
+end # VedeuMaterialColoursApp
 
 VedeuMaterialColoursApp.start(ARGV)