vedeu 0.3.4 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fccb60d2e33924a76f711a5ffccd643c7436a4fe
-  data.tar.gz: 03c59bf2a8d7c6265aa164807f9b72af46c7d055
+  metadata.gz: c55cc711fc37aa01aeaba23c8ababc6c983801c4
+  data.tar.gz: e86bdcf954386935f4710649322622de5afadb3e
 SHA512:
-  metadata.gz: 48627364195755fcd4390963bf27188ca813d62b2e1cf14d4c20b824ea087e36669942fbeedcf40df8857171a468e71505af437a0bfb93b0656c9a761a170532
-  data.tar.gz: 52c5edb46c2a7e72e11084670829ae1e913a3fb4f96245463a682b6047f9cc45be5a597142a96327e1698a42f75357d6115fbdd7062acf9cadbc8fb16d6646b7
+  metadata.gz: 78f9a8eb02a9b61bdb6f9c0943f016bce77f4747d327d93ea62fc56b024a457af78b4268095ef3141a7085fb500de741ba0dee15c114ccb5715bf819444cc0ec
+  data.tar.gz: cd92b729793a54269549769f3ca235e465297cd6eedf92e752fb1eb72e9a12d1991b55a540466c455684b1fe986e24ab840e28c57b34c92acacaefbde0562b32

data/README.md

@@ -4,7 +4,7 @@
 
 # Vedeu
 
-Vedeu 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

data/Rakefile

@@ -2,6 +2,7 @@ require 'bundler/gem_tasks'
 require 'rake/testtask'
 require 'cucumber'
 require 'cucumber/rake/task'
+require 'inch/rake'
 
 # Don't run cukes for the time being.
 # Cucumber::Rake::Task.new(:cucumber) do |t|
@@ -16,4 +17,9 @@ Rake::TestTask.new do |t|
   t.verbose = false
 end
 
+Inch::Rake::Suggest.new do |suggest|
+  suggest.args << "--pedantic"
+  suggest.args << "--all"
+end
+
 task :default => :test

data/bin/vedeu_drb_client

@@ -1,6 +1,11 @@
 #!/usr/bin/env ruby
 
+lib_dir = File.dirname(__FILE__) + '/../lib'
+$LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
+
+require 'vedeu'
+
 client = Vedeu::Distributed::Client.new("druby://localhost:21420")
-client.input('a')
-client.output # => 'some content...'
-client.stop
+client.input('l')
+sleep 1
+client.shutdown

data/bin/vedeu_drb_server

@@ -0,0 +1,113 @@
+#!/usr/bin/env ruby
+
+lib_dir = "/Users/gavinlaking/Source/vedeu/lib/vedeu/distributed/../../../lib"
+$LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
+
+require 'vedeu'
+
+class VedeuTestApplication
+  # include Vedeu
+
+Vedeu.configure do
+  colour_mode 16777216
+  log         '/tmp/vedeu_test_helper.log'
+  debug!
+  drb!
+  drb_host    'localhost'
+  drb_port    21420
+  drb_width   80
+  drb_height  25
+
+  # cooked!
+  # raw!
+
+  # run_once!
+
+  # interactive!
+  # standalone!
+
+  # trace!
+
+  # System keys can be redefined
+  # exit_key        'q'
+  # focus_next_key  :tab
+  # focus_prev_key  :shift_tab
+  # mode_switch_key :escape
+
+  # Not used yet
+  # stdin  File.open("/dev/tty", "r")
+  # stdout File.open("/dev/tty", "w")
+  # stderr File.open("/tmp/vedeu_error.log", "w+")
+end
+
+Vedeu.bind(:_initialize_) { Vedeu.trigger(:_refresh_) }
+
+Vedeu.border 'test_interface' do
+  # Define colour and style of border
+  colour foreground: '#ffff00', background: '#0000ff'
+  style  'normal'
+
+  # Define visibility of border
+  show_bottom!
+  show_left!
+  show_right!
+  show_top!
+
+  # Define characters used to draw border
+  bottom_right '+'
+  bottom_left  '+'
+  horizontal   '-'
+  top_right    '+'
+  top_left     '+'
+  vertical     '|'
+end
+
+Vedeu.geometry 'test_interface' do
+  # centred!
+  height 6
+  width  26
+  x      4
+  y      4
+end
+
+Vedeu.interface 'test_interface' do
+  colour foreground: '#ff0000', background: '#000000'
+  cursor!
+end
+
+Vedeu.keymap 'test_interface' do
+  key(:up,    'k') { Vedeu.trigger(:_cursor_up_)    }
+  key(:right, 'l') { Vedeu.trigger(:_cursor_right_) }
+  key(:down,  'j') { Vedeu.trigger(:_cursor_down_)  }
+  key(:left,  'h') { Vedeu.trigger(:_cursor_left_)  }
+end
+
+Vedeu.menu 'test_interface' do
+  # ...
+end
+
+Vedeu.renders do
+  view 'test_interface' do
+    lines do
+      line 'a1b1c1d1e1f1g1h1i1j1k1l1m1n1o1p1q1r1s1t1u1v1w1x1y1z1'
+      line 'a2b2c2d2e2f2g2h2i2j2k2l2m2n2o2p2q2r2s2t2u2v2w2x2y2z2'
+      line 'a3b3c3d3e3f3g3h3i3j3k3l3m3n3o3p3q3r3s3t3u3v3w3x3y3z3'
+      line 'a4b4c4d4e4f4g4h4i4j4k4l4m4n4o4p4q4r4s4t4u4v4w4x4y4z4'
+      line 'a5b5c5d5e5f5g5h5i5j5k5l5m5n5o5p5q5r5s5t5u5v5w5x5y5z5'
+      line 'a6b6c6d6e6f6g6h6i6j6k6l6m6n6o6p6q6r6s6t6u6v6w6x6y6z6'
+      line 'a7b7c7d7e7f7g7h7i7j7k7l7m7n7o7p7q7r7s7t7u7v7w7x7y7z7'
+      line 'a8b8c8d8e8f8g8h8i8j8k8l8m8n8o8p8q8r8s8t8u8v8w8x8y8z8'
+    end
+  end
+end
+
+  def self.start(argv   = ARGV,
+                 stdin  = STDIN,
+                 stdout = STDOUT,
+                 stderr = STDERR,
+                 kernel = Kernel)
+    Vedeu::Launcher.execute!(argv, stdin, stdout, stderr, kernel)
+  end
+end
+
+VedeuTestApplication.start(ARGV)

data/bin/vedeu_test

@@ -7,7 +7,7 @@ require 'vedeu'
 
 class VedeuTestApp
   def self.start(argv = ARGV)
-    Vedeu::Launcher.new(argv).execute!
+    Vedeu::Launcher.execute!(argv)
   end
 end
 

data/docs/events.md

@@ -15,118 +15,6 @@ class SomeClassInYourApplication
 
 System events generally control the internal state of Vedeu with respects to your application. They are soft-namespaced using underscores.
 
-### `:_clear_`
-
-Clears the whole terminal space.
-
-### `:_cursor_up_`
-
-Moves the cursor for the focussed interface up one row, but will not exceed the boundary of the interface.
-
-### `:_cursor_right_`
-
-Moves the cursor for the focussed interface right one column, but will not exceed the boundary of the interface.
-
-### `:_cursor_down_`
-
-Moves the cursor for the focussed interface down one row, but will not exceed the boundary of the interface.
-
-### `:_cursor_left_`
-
-Moves the cursor for the focussed interface left one column, but will not exceed the boundary of the interface.
-
-### `:_cursor_hide_`
-
-Hides the cursor for the focussed interface.
-
-### `:_cursor_show_`
-
-Shows the cursor for the focussed interface.
-
-### `:_cursor_hide_by_name_`
-
-Hides the cursor for the named interface.
-
-### `:_cursor_show_by_name_`
-
-Shows the cursor for the named interface.
-
-### `:_cursor_origin_`
-
-Moves the cursor to the top left position of the focussed interface. If this interface has a border,then this is respected.
-
-### `:_exit_`
-
-When triggered, Vedeu will trigger a `:cleanup` event which you can define (to save files, etc) and attempt to exit.
-
-### `:_focus_by_name_`
-
-When triggered with an interface name will focus that interface and restore the cursor position and visibility.
-
-### `:_focus_next_`
-
-When triggered will focus the next interface and restore the cursor position and visibility.
-
-### `:_focus_prev_`
-
-When triggered will focus the previous interface and restore the cursor position and visibility.
-
-### `:_keypress_`
-
-Triggering this event 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.
-
-### `:_log_`
-
-When triggered with a message will cause Vedeu to log the message if logging is enabled in the configuration.
-
-### `:_menu_current_`
-
-Requires target menu name as argument. Returns the current menu item.
-
-### `:_menu_selected_`
-
-Requires target menu name as argument. Returns the selected menu item.
-
-### `:_menu_next_`
-
-Requires target menu name as argument. Makes the next menu item the current menu item, until it reaches the last item.
-
-### `:_menu_prev_`
-
-Requires target menu name as argument. Makes the previous menu item the current menu item, until it reaches the first item.
-
-### `:_menu_top_`
-
-Requires target menu name as argument. Makes the first menu item the current menu item.
-
-### `:_menu_bottom_`
-
-Requires target menu name as argument. Makes the last menu item the current menu item.
-
-### `:_menu_select_`
-
-Requires target menu name as argument. Makes the current menu item also the selected menu item.
-
-### `:_menu_deselect_`
-
-Requires target menu name as argument. Deselects all menu items.
-
-### `:_menu_items_`
-
-Requires target menu name as argument. Returns all the menu items with respective `current` or `selected` boolean indicators.
-
-### `:_menu_view_`
-
-Requires target menu name as argument. Returns a subset of the menu items; starting at the current item to the last item.
-
-### `:_mode_switch_`
-
-When triggered (after the user presses `escape`), Vedeu switches from a "raw mode" terminal to a "cooked mode" terminal. The idea here being that the raw mode is for single keypress actions, whilst cooked mode allows the user to enter more elaborate commands- such as commands with arguments.
-
-### `:_refresh_`
-
-Triggering this event will cause all interfaces to refresh.
-
 ### `:_refresh_group_(group_name)_`
 
 Will refresh all interfaces belonging to this group. E.g. `_refresh_group_home_` will refresh all interfaces with the group of `home`.
@@ -135,10 +23,6 @@ Will refresh all interfaces belonging to this group. E.g. `_refresh_group_home_`
 
 Will refresh the interface with this name. E.g. `_refresh_widget_` will refresh the interface `widget`.
 
-### `:_resize_`
-
-When triggered will cause Vedeu to trigger the `:_clear_` and `:_refresh_` events. Please see those events for their behaviour.
-
 
 ##### Notes:
 
@@ -157,17 +41,6 @@ User events allow you to orchestrate behaviour within your application, ie. the
 
 Vedeu pre-defines a few user events, which client applications can listen for, or trigger themselves.
 
-### `:cleanup`
-
-Vedeu triggers this event when `:_exit_` is triggered. You can hook into this to perform a special action before the application terminates. Saving the user's work, session or preferences might be popular here.
-
-### `:_initialize_`
-
-Vedeu triggers this event when it is ready to enter the main loop. Client
-applications can listen for this event and perform some action(s), like render
-the first screen, interface or make a sound. When Vedeu triggers this event,
-the :_refresh_ event is also triggered automatically.
-
 ### `:_tick_`
 
 Each time Vedeu completes one cycle in the application loop

data/examples/borders_app.rb

@@ -46,7 +46,7 @@ class VedeuBordersApp
       height 3
       width  7
     end
-    colour  foreground: '#000000', background: '#ffff00'
+    colour  foreground: '#000000', background: '#ff5500'
   end
 
   interface 'no_bottom' do
@@ -56,7 +56,7 @@ class VedeuBordersApp
       height 3
       width  7
     end
-    colour  foreground: '#000000', background: '#ffff00'
+    colour  foreground: '#000000', background: '#ff5500'
   end
 
   interface 'no_left' do
@@ -66,7 +66,7 @@ class VedeuBordersApp
       height 3
       width  7
     end
-    colour  foreground: '#000000', background: '#ffff00'
+    colour  foreground: '#000000', background: '#ff5500'
   end
 
   interface 'no_right' do
@@ -76,7 +76,7 @@ class VedeuBordersApp
       height 3
       width  7
     end
-    colour  foreground: '#000000', background: '#ffff00'
+    colour  foreground: '#000000', background: '#ff5500'
   end
 
   interface 'custom_corners' do
@@ -166,21 +166,27 @@ class VedeuBordersApp
 
   # Borders can be defined as part of a view (see below), or standalone.
   border 'no_bottom' do
+    foreground  '#ffffff'
     show_bottom false
   end
   border 'no_left' do
+    foreground  '#ffffff'
     show_left false
   end
   border 'no_right' do
+    foreground  '#ffffff'
     show_right false
   end
   border 'no_top' do
+    foreground  '#ffffff'
     show_top false
   end
 
   renders do
     view('default_border') do
-      border!
+      border do
+        foreground '#ffffff'
+      end
       lines do
         line 'on'
       end
@@ -234,6 +240,7 @@ class VedeuBordersApp
     end
     view('only_top') do
       border do
+        foreground  '#ffffff'
         show_right  false
         show_bottom false
         show_left   false
@@ -245,6 +252,7 @@ class VedeuBordersApp
     end
     view('only_bottom') do
       border do
+        foreground  '#ffffff'
         show_top   false
         show_right false
         show_left  false
@@ -256,6 +264,7 @@ class VedeuBordersApp
     end
     view('only_left') do
       border do
+        foreground  '#ffffff'
         show_top    false
         show_bottom false
         show_right  false
@@ -267,6 +276,7 @@ class VedeuBordersApp
     end
     view('only_right') do
       border do
+        foreground  '#ffffff'
         show_top    false
         show_bottom false
         show_left   false
@@ -278,7 +288,7 @@ class VedeuBordersApp
     end
     view('custom_colour') do
       border do
-        colour foreground: '#ffff00', background: '#0000ff'
+        colour foreground: '#ff5500', background: '#0000ff'
       end
       lines do
         line 'color'
@@ -295,7 +305,7 @@ class VedeuBordersApp
   end
 
   def self.start(argv = ARGV)
-    Vedeu::Launcher.new(argv).execute!
+    Vedeu::Launcher.execute!(argv)
   end
 end
 

data/examples/configuration_app.rb

@@ -48,7 +48,7 @@ class VedeuConfigurationApp
   end
 
   def self.start(argv = ARGV)
-    Vedeu::Launcher.new(argv).execute!
+    Vedeu::Launcher.execute!(argv)
   end
 end
 

data/examples/cursor_app.rb

@@ -39,7 +39,9 @@ class VedeuCursorApp
 
   renders do
     view 'main_interface' do
-      border!
+      border do
+        colour foreground: '#aadd00', background: '#000000'
+      end
       lines do
         streams do
           text 'A.3456789 '
@@ -106,7 +108,7 @@ class VedeuCursorApp
   focus_by_name 'main_interface'
 
   def self.start(argv = ARGV)
-    Vedeu::Launcher.new(argv).execute!
+    Vedeu::Launcher.execute!(argv)
   end
 end
 

data/examples/drb_app.rb

@@ -0,0 +1,113 @@
+#!/usr/bin/env ruby
+
+lib_dir = "/Users/gavinlaking/Source/vedeu/lib/vedeu/distributed/../../../lib"
+$LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
+
+require 'vedeu'
+
+class VedeuTestApplication
+  # include Vedeu
+
+Vedeu.configure do
+  colour_mode 16777216
+  log         '/tmp/vedeu_test_helper.log'
+  debug!
+  drb!
+  drb_host    'localhost'
+  drb_port    21420
+  drb_width   80
+  drb_height  25
+
+  # cooked!
+  # raw!
+
+  # run_once!
+
+  # interactive!
+  # standalone!
+
+  # trace!
+
+  # System keys can be redefined
+  # exit_key        'q'
+  # focus_next_key  :tab
+  # focus_prev_key  :shift_tab
+  # mode_switch_key :escape
+
+  # Not used yet
+  # stdin  File.open("/dev/tty", "r")
+  # stdout File.open("/dev/tty", "w")
+  # stderr File.open("/tmp/vedeu_error.log", "w+")
+end
+
+Vedeu.bind(:_initialize_) { Vedeu.trigger(:_refresh_) }
+
+Vedeu.border 'test_interface' do
+  # Define colour and style of border
+  colour foreground: '#ffff00', background: '#0000ff'
+  style  'normal'
+
+  # Define visibility of border
+  show_bottom!
+  show_left!
+  show_right!
+  show_top!
+
+  # Define characters used to draw border
+  bottom_right '+'
+  bottom_left  '+'
+  horizontal   '-'
+  top_right    '+'
+  top_left     '+'
+  vertical     '|'
+end
+
+Vedeu.geometry 'test_interface' do
+  # centred!
+  height 6
+  width  26
+  x      4
+  y      4
+end
+
+Vedeu.interface 'test_interface' do
+  colour foreground: '#ff0000', background: '#000000'
+  cursor!
+end
+
+Vedeu.keymap 'test_interface' do
+  key(:up,    'k') { Vedeu.trigger(:_cursor_up_)    }
+  key(:right, 'l') { Vedeu.trigger(:_cursor_right_) }
+  key(:down,  'j') { Vedeu.trigger(:_cursor_down_)  }
+  key(:left,  'h') { Vedeu.trigger(:_cursor_left_)  }
+end
+
+Vedeu.menu 'test_interface' do
+  # ...
+end
+
+Vedeu.renders do
+  view 'test_interface' do
+    lines do
+      line 'a1b1c1d1e1f1g1h1i1j1k1l1m1n1o1p1q1r1s1t1u1v1w1x1y1z1'
+      line 'a2b2c2d2e2f2g2h2i2j2k2l2m2n2o2p2q2r2s2t2u2v2w2x2y2z2'
+      line 'a3b3c3d3e3f3g3h3i3j3k3l3m3n3o3p3q3r3s3t3u3v3w3x3y3z3'
+      line 'a4b4c4d4e4f4g4h4i4j4k4l4m4n4o4p4q4r4s4t4u4v4w4x4y4z4'
+      line 'a5b5c5d5e5f5g5h5i5j5k5l5m5n5o5p5q5r5s5t5u5v5w5x5y5z5'
+      line 'a6b6c6d6e6f6g6h6i6j6k6l6m6n6o6p6q6r6s6t6u6v6w6x6y6z6'
+      line 'a7b7c7d7e7f7g7h7i7j7k7l7m7n7o7p7q7r7s7t7u7v7w7x7y7z7'
+      line 'a8b8c8d8e8f8g8h8i8j8k8l8m8n8o8p8q8r8s8t8u8v8w8x8y8z8'
+    end
+  end
+end
+
+  def self.start(argv   = ARGV,
+                 stdin  = STDIN,
+                 stdout = STDOUT,
+                 stderr = STDERR,
+                 kernel = Kernel)
+    Vedeu::Launcher.execute!(argv, stdin, stdout, stderr, kernel)
+  end
+end
+
+VedeuTestApplication.start(ARGV)

data/examples/focus_app.rb

@@ -123,7 +123,7 @@ class VedeuFocusApp
   end
 
   def self.start(argv = ARGV)
-    Vedeu::Launcher.new(argv).execute!
+    Vedeu::Launcher.execute!(argv)
   end
 end
 

data/examples/geometry_app.rb

@@ -134,7 +134,7 @@ class VedeuGeometryApp
   focus_by_name 'main_interface'
 
   def self.start(argv = ARGV)
-    Vedeu::Launcher.new(argv).execute!
+    Vedeu::Launcher.execute!(argv)
   end
 end
 

data/examples/hello_world.rb

@@ -40,7 +40,7 @@ class HelloWorldApp
   end
 
   def self.start(argv = ARGV)
-    Vedeu::Launcher.new(argv).execute!
+    Vedeu::Launcher.execute!(argv)
   end
 end
 

data/examples/lines_app.rb

@@ -67,7 +67,7 @@ class VedeuLinesApp
   focus_by_name 'ruthenium'
 
   def self.start(argv = ARGV)
-    Vedeu::Launcher.new(argv).execute!
+    Vedeu::Launcher.execute!(argv)
   end
 end
 

data/features/start_stop.feature

@@ -15,7 +15,7 @@ Feature: Starting and stopping a client application
         end
 
         def self.start(argv = ARGV)
-          Vedeu::Launcher.new(argv).execute!
+          Vedeu::Launcher.execute!(argv)
         end
       end
 

data/inch.yml

@@ -0,0 +1,5 @@
+files:
+  included:
+    lib/**/*.rb
+  excluded:
+    vendor/**/*.rb

data/lib/vedeu/all.rb

@@ -1,6 +1,7 @@
 
 # load order is important
 
+require 'vedeu/debug'
 require 'vedeu/traps'
 require 'vedeu/exceptions'
 
@@ -26,5 +27,6 @@ require 'vedeu/output/all'
 require 'vedeu/presentation/all'
 require 'vedeu/support/all'
 
+require 'vedeu/main_loop'
 require 'vedeu/application'
 require 'vedeu/launcher'

data/lib/vedeu/api.rb

@@ -14,6 +14,7 @@ module Vedeu
   # module expose Vedeu's core functionality.
   #
   # @api public
+  #
   module API
 
     extend Forwardable