vedeu 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dec7d96b1f14de41e305192ec084b5f16ea39779
-  data.tar.gz: afd4cc9b1eea2d7eb9c781abbdf71feab39514ed
+  metadata.gz: c51db32c71781208264d0ea69bf433a5bde9bf75
+  data.tar.gz: bb5067249adad44b4788b4abcb0471c513d0ec9b
 SHA512:
-  metadata.gz: c008ae703f26a202bb20b3c0909dc1779a4d30606365f96342637e5c3715018fa75d16ddf12f7087599a99aa24785830ca55683b286246e77e2ad444101f2fbe
-  data.tar.gz: f587307ac3e309e74b018770048f90dae43cae84b8805f041df8d29c0231c42191d5d92337a5625ceb11c71fc24aca8cb072170227bc7cde177082f299d42833
+  metadata.gz: 16bbad5b4ffb6b0748dbef756d4b5db9ef0abb562c842246a66aee21cbd3c3f1bcf7d0aeb43cf44171b958be9f8c821e199b61eea0439b571536238894341545
+  data.tar.gz: a29d38fd26002e43980502708196e9d3434a7a92f7b952feafc571e74dce7b27664c962bb0674a2607284824af145b6554f85616c256d48528b31c0288e986c3

data/.yardopts

@@ -4,3 +4,4 @@
 -
 docs/api.md
 docs/events.md
+docs/getting_started.md

data/README.md

@@ -92,7 +92,6 @@ interface 'main' do
   width  10 # see notes below
   height 10
   colour foreground: '#ffffff', background: '#000000'
-  cursor false
 end
 ```
 
@@ -108,7 +107,6 @@ Note: not setting a width or height will set the values to the terminal's report
 
 - `foreground` sets the default foreground colour. (See Colours)
 - `background` sets the default background colour.
-- `cursor` is a Boolean specifying whether the cursor should show.
 
 
 ### Events
@@ -176,6 +174,7 @@ 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.
 
 ### General contribution help
 

data/Rakefile

@@ -1,10 +1,10 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
+require 'bundler/gem_tasks'
+require 'rake/testtask'
 
 task :default => :test
 
 Rake::TestTask.new do |t|
-  t.libs.push "lib"
-  t.libs.push "test"
-  t.pattern = "test/**/*_test.rb"
+  t.libs.push 'lib'
+  t.libs.push 'test'
+  t.pattern = 'test/**/*_test.rb'
 end

data/bin/vedeu

@@ -1,9 +1,13 @@
 #!/usr/bin/env ruby
-$:.unshift(File.dirname(__FILE__) + '/../lib') unless $:.include?(File.dirname(__FILE__) + '/../lib')
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib') unless $LOAD_PATH.include?(File.dirname(__FILE__) + '/../lib')
 
 -> { its -> { a } }
 trap('INT') { exit! }
 
-require 'vedeu'
-
-Vedeu::Launcher.new(ARGV.dup).execute!
+puts ''
+puts 'Vedeu is a Ruby gem. This executable serves for a future in which ' \
+     'Vedeu can generate a starting point for your terminal-based GUI '   \
+     'application.'
+puts ''
+puts 'Please see: https://github.com/gavinlaking/vedeu for more details.'
+puts ''

data/docs/api.md

@@ -39,6 +39,8 @@ class OtherClassInYourApplication
 
 ### API DSL methods
 
+Note: Nesting indicates where an API method is allowed/supposed to be used.
+
 #### Events
 
 - event
@@ -59,7 +61,6 @@ class OtherClassInYourApplication
 - interface
   - centred
   - colour
-  - cursor
   - delay
   - group
   - height
@@ -104,6 +105,7 @@ class OtherClassInYourApplication
 #### Miscellany
 
 - defined
+- focus
 - height
 - log
 - resize

data/docs/events.md

@@ -1,11 +1,8 @@
 ## Vedeu Events
 
-Vedeu provides an event mechanism to facilitate the functionality of your
-application. The events are either Vedeu defined, ie. system events or
-user defined, ie. user events.
+Vedeu provides an event mechanism to facilitate the functionality of your application. The events are either Vedeu defined, ie. system events or user defined, ie. user events.
 
-Events described in this document assume that you have included Vedeu in your
-class:
+Events described in this document assume that you have included Vedeu in your class:
 
 ```ruby
   class SomeClassInYourApplication
@@ -16,8 +13,7 @@ class:
 
 ## System Events
 
-System events generally control the internal state of Vedeu with respects to
-your application. They are soft-namespaced using underscores.
+System events generally control the internal state of Vedeu with respects to your application. They are soft-namespaced using underscores.
 
 ### `:_cleanup_`
 
@@ -27,21 +23,49 @@ This event is fired by Vedeu when `:_exit_` is triggered. You can hook into this
 
 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_refresh_`
+
+Refreshes the cursor for the focussed interface.
+
 ### `:_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.
+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.
+When triggered will focus the next interface and restore the cursor position and visibility.
 
 ### `:_focus_prev_`
 
-When triggered will focus the previous interface.
+When triggered will focus the previous interface and restore the cursor position and visibility.
 
 ### `:_initialize_`
 
@@ -65,28 +89,23 @@ 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.
+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.
+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.
+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.
+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.
+Requires target menu name as argument. Makes the current menu item also the selected menu item.
 
 ### `:_menu_deselect_`
 
@@ -94,13 +113,11 @@ 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.
+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.
+Requires target menu name as argument. Returns a subset of the menu items; starting at the current item to the last item.
 
 ### `:_mode_switch_`
 
@@ -120,15 +137,12 @@ Will refresh the interface with this name. E.g. `_refresh_widget_` will refresh
 
 ### `:_resize_`
 
-When triggered will cause Vedeu to trigger the `:_clear_` and `:_refresh_`
-events. Please see those events for their behaviour.
+When triggered will cause Vedeu to trigger the `:_clear_` and `:_refresh_` events. Please see those events for their behaviour.
 
 
 ##### Notes:
 
-System events can be handled or triggered by your application also, but overriding or adding additional events to the Vedeu system event namespace may cause unpredictable results. It is recommended to only to hook into events like :_cleanup_, :_initialize_ and :key if you need to do something respective
-to those events.
-
+System events can be handled or triggered by your application also, but overriding or adding additional events to the Vedeu system event namespace may cause unpredictable results. It is recommended to only to hook into events like :_cleanup_, :_initialize_ and :key if you need to do something respective to those events.
 
 ... TODO ... What about events in Vedeu::Menu?
 

data/docs/getting_started.md

@@ -0,0 +1,2 @@
+## Getting Started with Vedeu
+

data/examples/cursor_app/cursor_app.rb

@@ -0,0 +1,85 @@
+#!/usr/bin/env ruby
+
+lib_dir = File.dirname(__FILE__) + '/../../lib'
+$LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
+
+-> { its -> { a } }
+trap('INT') { exit! }
+
+require 'vedeu'
+
+class VedeuCursorApp
+  include Vedeu
+
+  event(:_initialize_) { trigger(:_refresh_) }
+
+  interface 'iron' do
+    centred true
+    colour  foreground: '#ff0000', background: '#000000'
+    height  4
+    width   12
+  end
+
+  interface 'krypton' do
+    centred false
+    colour  foreground: '#ffff00', background: '#000000'
+    height  4
+    width   12
+    y       { use('iron').south }
+    x       { use('iron').east(1) }
+  end
+
+  interface 'francium' do
+    centred false
+    colour  foreground: '#ff00ff', background: '#000000'
+    height  4
+    width   12
+    y       { use('iron').north(5) }
+    x       { use('iron').west(13) }
+  end
+
+  interface 'argon' do
+    centred  false
+    colour   foreground: '#00ff00', background: '#000000'
+    height   4
+    width    12
+    y        { use('iron').south }
+    x        { use('iron').west(13) }
+  end
+
+  keys do
+    key(:up)    { trigger(:_cursor_up_)    }
+    key(:right) { trigger(:_cursor_right_) }
+    key(:down)  { trigger(:_cursor_down_)  }
+    key(:left)  { trigger(:_cursor_left_)  }
+  end
+
+  render do
+    view 'iron' do
+      line 'shift+tab to'
+      line 'move to the'
+      line 'previous one'
+    end
+    view 'francium' do
+      line 'Press tab to'
+      line 'move to next'
+      line 'interface or'
+    end
+    view 'krypton' do
+      line 'Position is'
+      line 'remembered'
+      line 'between'
+      line 'interfaces.'
+    end
+    view 'argon' do
+      line 'To exit this'
+      line 'just press Q'
+    end
+  end
+
+  def self.start
+    Vedeu::Launcher.new(['--debug']).execute!
+  end
+end
+
+VedeuCursorApp.start

data/examples/lines_app/lines_app.rb

@@ -0,0 +1,60 @@
+#!/usr/bin/env ruby
+
+lib_dir = File.dirname(__FILE__) + '/../../lib'
+$LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
+
+-> { its -> { a } }
+trap('INT') { exit! }
+
+require 'vedeu'
+
+class VedeuLinesApp
+  include Vedeu
+
+  event(:_initialize_) { trigger(:_refresh_) }
+
+  interface 'ruthenium' do
+    centred true
+    colour  foreground: '#ffffff', background: '#000000'
+    height  5
+    width   40
+  end
+
+  interface 'tantalum' do
+    colour  foreground: '#00aadd', background: '#000000'
+    height  1
+    width   40
+    x       use('ruthenium').left
+    y       use('ruthenium').south
+  end
+
+  keys do
+    key(:up)    { trigger(:_cursor_up_)    }
+    key(:right) { trigger(:_cursor_right_) }
+    key(:down)  { trigger(:_cursor_down_)  }
+    key(:left)  { trigger(:_cursor_left_)  }
+  end
+
+  render do
+    view 'ruthenium' do
+      line 'Ruthenium is a chemical element with'
+      line 'symbol Ru and atomic number 44. It is a'
+      line 'rare transition metal belonging to the'
+      line 'platinum group of the periodic table.'
+      line 'Like the other metals of the platinum'
+      line 'group, ruthenium is inert to most other'
+      line 'chemicals.'
+    end
+    view 'tantalum' do
+      line 'Use cursor keys to navigate, Q to quit.'
+    end
+  end
+
+  focus 'ruthenium'
+
+  def self.start
+    Vedeu::Launcher.new(['--debug']).execute!
+  end
+end
+
+VedeuLinesApp.start

data/lib/vedeu.rb

@@ -5,6 +5,9 @@ module Vedeu
   # Raised when Vedeu attempts to access a named buffer that does not exist.
   BufferNotFound = Class.new(StandardError)
 
+  # Raised when a cursor cannot be found by name.
+  CursorNotFound = Class.new(StandardError)
+
   # Raised when trying to access a group of interfaces which do not exist by
   # this name.
   GroupNotFound = Class.new(StandardError)
@@ -65,8 +68,10 @@ require 'logger'
 require 'optparse'
 require 'set'
 
-require 'vedeu/configuration'
 require 'vedeu/support/common'
+require 'vedeu/configuration/cli'
+require 'vedeu/configuration/api'
+require 'vedeu/configuration/configuration'
 require 'vedeu/support/log'
 require 'vedeu/support/trace'
 
@@ -86,6 +91,7 @@ require 'vedeu/models/geometry'
 require 'vedeu/models/colour'
 require 'vedeu/models/style'
 require 'vedeu/models/interface'
+require 'vedeu/models/cursor'
 require 'vedeu/models/keymap'
 require 'vedeu/models/line'
 require 'vedeu/models/stream'
@@ -102,14 +108,15 @@ require 'vedeu/api/line'
 require 'vedeu/api/menu'
 require 'vedeu/api/stream'
 
+require 'vedeu/support/keymap_validator'
 require 'vedeu/repositories/menus'
-require 'vedeu/repositories/keymap_validator'
 require 'vedeu/repositories/keymaps'
 require 'vedeu/repositories/interfaces'
 require 'vedeu/repositories/groups'
 require 'vedeu/repositories/focus'
 require 'vedeu/repositories/events'
 require 'vedeu/repositories/buffers'
+require 'vedeu/repositories/cursors'
 
 require 'vedeu/support/registrar'
 
@@ -121,7 +128,6 @@ require 'vedeu/output/view'
 
 require 'vedeu/support/grid'
 require 'vedeu/support/menu'
-require 'vedeu/support/cursor'
 
 require 'vedeu/input/input'