vedeu 0.2.12 → 0.3.0

data/examples/cursor_app.rb

@@ -11,103 +11,102 @@ require 'vedeu'
 class VedeuCursorApp
   include Vedeu
 
-  event(:_initialize_) { Vedeu.trigger(:_refresh_) }
+  configure do
+    colour_mode 16777216
+    debug!
+    log '/tmp/vedeu_cursor_app.log'
+  end
 
-  interface 'iron' do
-    cursor  true
-    centred true
-    colour  foreground: '#ff0000', background: '#000000'
-    height  4
-    width   15
+  bind(:_initialize_) { Vedeu.trigger(:_refresh_) }
 
-    # provide 'vim' direction keys
-    keys do
-      key('k') { Vedeu.trigger(:_cursor_up_)    }
-      key('l') { Vedeu.trigger(:_cursor_right_) }
-      key('j') { Vedeu.trigger(:_cursor_down_)  }
-      key('h') { Vedeu.trigger(:_cursor_left_)  }
+  interface 'main_interface' do
+    border do
+      # adds default border
     end
-  end
 
-  interface 'gold' do
-    cursor false
-    colour foreground: '#00ff00', background: '#001100'
-    height 4
-    width  15
-    x      use('iron').left
-    y      use('iron').south
+    cursor true
+    colour foreground: '#ff0000', background: '#000000'
+
+    geometry do
+      centred true
+      height  8
+      width   8
+    end
   end
 
-  keys do
-    key(:up)    { Vedeu.trigger(:_cursor_up_)    }
-    key(:right) { Vedeu.trigger(:_cursor_right_) }
-    key(:down)  { Vedeu.trigger(:_cursor_down_)  }
-    key(:left)  { Vedeu.trigger(:_cursor_left_)  }
+  keymap('_global_') 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
 
-  render do
-    view 'iron' do
-      line do
-        stream do
-          text 'A 23456789 '
+  renders do
+    view 'main_interface' do
+      lines do
+        streams do
+          text 'A.3456789 '
         end
-        stream do
+        streams do
           background '#550000'
           foreground '#ffff00'
           text 'hydrogen'
         end
-        stream do
+        streams do
           text ' helium'
         end
       end
-      line 'B 23456789 lithium beryllium boron nitrogen'
-      line do
-        stream do
-          text 'C 23456789'
+      lines do
+        streams do
+          text 'B.3456789 lithium beryllium boron nitrogen'
         end
-        stream do
+      end
+      lines do
+        streams do
+          text 'C.3456789'
           text ' carbon oxygen '
         end
-        stream do
+        streams do
           background '#aadd00'
           foreground '#000000'
           text 'fluorine'
         end
       end
-      line 'D 23456789'
-      line
-      line 'E 23456789 neon sodium'
-      line do
-        stream do
-          text 'F 23456789 magnesium '
+      lines do
+        streams do
+          text 'D.3456789'
         end
-        stream do
+      end
+      lines do
+        streams do
+          text 'E.3456789 neon sodium'
+        end
+      end
+      lines do
+        streams do
+          text 'F.3456789 magnesium '
+        end
+        streams do
           foreground '#00aaff'
           text 'aluminium'
         end
       end
-      line 'G 23456789 silicon'
-      line do
-        stream do
+      lines do
+        streams do
+          text 'G.3456789 silicon'
+        end
+      end
+      lines do
+        streams do
           background '#550000'
           foreground '#ff00ff'
-          text 'H 234'
+          text 'H.34'
         end
       end
     end
-
-    view 'gold' do
-      cursor false
-      line 'Cursor: '
-    end
   end
 
-  focus('iron') # not working right?!
-
-  Vedeu.configure do
-    debug!
-    log '/tmp/vedeu_cursor_app.log'
-  end
+  focus_by_name 'main_interface'
 
   def self.start(argv = ARGV)
     Vedeu::Launcher.new(argv).execute!

data/examples/focus_app.rb

@@ -19,67 +19,105 @@ require 'vedeu'
 class VedeuFocusApp
   include Vedeu
 
-  event(:_initialize_) { Vedeu.trigger(:_refresh_) }
+  configure do
+    colour_mode 16777216
+    debug!
+    log '/tmp/vedeu_focus_app.log'
+  end
+
+  bind(:_initialize_) { Vedeu.trigger(:_refresh_) }
+
+  update = Proc.new do
+    Vedeu.focus_next
+
+    Vedeu.renders { view('status') { lines { line(Vedeu.focus) } } }
+  end
 
   interface 'aluminium' do
     colour  foreground: '#ffffff', background: '#330000'
     cursor  true
-    height  2
-    width   2
-    x       3
-    y       3
+    geometry do
+      height 2
+      width  2
+      x      3
+      y      3
+    end
+    keymap { key(' ') { update.call } }
   end
 
   interface 'boron' do
     colour  foreground: '#ffffff', background: '#003300'
     cursor  true
-    height  2
-    width   2
-    x       6
-    y       3
+    geometry do
+      height 2
+      width  2
+      x      6
+      y      3
+    end
+    keymap { key(' ') { update.call } }
   end
 
   interface 'copper' do
     colour  foreground: '#ffffff', background: '#000033'
     cursor  true
     focus!
-    height  2
-    width   2
-    x       3
-    y       6
+    geometry do
+      height 2
+      width  2
+      x      3
+      y      6
+    end
+    keymap { key(' ') { update.call } }
   end
 
   interface 'dubnium' do
     colour  foreground: '#ffffff', background: '#333300'
     cursor  true
-    height  2
-    width   2
-    x       6
-    y       6
+    geometry do
+      height 2
+      width  2
+      x      6
+      y      6
+    end
+    keymap { key(' ') { update.call } }
   end
 
   interface 'status' do
     colour  foreground: '#ffffff', background: '#000000'
     cursor  false
-    height  2
-    width   10
-    x       9
-    y       3
+    geometry do
+      height 2
+      width  10
+      x      9
+      y      3
+    end
+    keymap { key(' ') { update.call } }
   end
 
-  render do
-    view('aluminium') { line 'Al' }
-    view('boron')     { line 'B' }
-    view('copper')    { line 'Cu' }
-    view('dubnium')   { line 'Db' }
-    view('status')    { line Vedeu::Focus.current }
-
-    # Tell Vedeu that each interface can use 'space'.
-    keys('aluminium', 'boron', 'copper', 'dubnium', 'status') do
-      key(' ') do
-        Vedeu::Focus.next_item
-
-        render { view('status') { line Vedeu::Focus.current } }
+  renders do
+    view('aluminium') do
+      lines do
+        line 'Al'
+      end
+    end
+    view('boron') do
+      lines do
+        line 'B'
+      end
+    end
+    view('copper') do
+      lines do
+        line 'Cu'
+      end
+    end
+    view('dubnium') do
+      lines do
+        line 'Db'
+      end
+    end
+    view('status') do
+      lines do
+        line Vedeu.focus
       end
     end
   end

data/examples/hello_world.rb

@@ -12,25 +12,30 @@ class HelloWorldApp
   include Vedeu
 
   configure do
+    colour_mode 16777216
     debug!
     log '/tmp/vedeu_hello_world.log'
   end
 
-  event(:_initialize_) { Vedeu.trigger(:_refresh_) }
+  bind(:_initialize_) { Vedeu.trigger(:_refresh_) }
 
   interface 'messages' do
     background '#000000'
-    centred!
     foreground '#00ff00'
-    height     3
-    width      20
+    geometry do
+      centred!
+      height   3
+      width    20
+    end
   end
 
-  render do
+  renders do
     view 'messages' do
-      line '    Hello World!'
-      line
-      line " Press 'q' to exit. "
+      lines do
+        centre 'Hello World!', width: 20
+        line
+        centre "Press 'q' to exit.", width: 20
+      end
     end
   end
 

data/examples/lines_app.rb

@@ -11,51 +11,60 @@ require 'vedeu'
 class VedeuLinesApp
   include Vedeu
 
-  event(:_initialize_) { trigger(:_refresh_) }
+  configure do
+    colour_mode 16777216
+    debug!
+    log '/tmp/vedeu_lines_app.log'
+  end
+
+  bind(:_initialize_) { Vedeu.trigger(:_refresh_) }
 
   interface 'ruthenium' do
-    centred true
+    geometry do
+      centred true
+      height  5
+      width   40
+    end
     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
+    geometry do
+      height  1
+      width   40
+      x       Vedeu.use('ruthenium').left
+      y       Vedeu.use('ruthenium').south
+    end
   end
 
-  keys do
-    key(:up)    { trigger(:_cursor_up_)    }
-    key(:right) { trigger(:_cursor_right_) }
-    key(:down)  { trigger(:_cursor_down_)  }
-    key(:left)  { trigger(:_cursor_left_)  }
+  keymap('_global_') do
+    key(:up)    { Vedeu.trigger(:_cursor_up_)    }
+    key(:right) { Vedeu.trigger(:_cursor_right_) }
+    key(:down)  { Vedeu.trigger(:_cursor_down_)  }
+    key(:left)  { Vedeu.trigger(:_cursor_left_)  }
   end
 
-  render do
+  renders 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.'
+      lines 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
     end
     view 'tantalum' do
-      line 'Use cursor keys to navigate, Q to quit.'
+      lines do
+        line 'Use cursor keys to navigate, Q to quit.'
+      end
     end
   end
 
-  focus 'ruthenium'
-
-  Vedeu.configure do
-    debug!
-    log '/tmp/vedeu_lines_app.log'
-  end
+  focus_by_name 'ruthenium'
 
   def self.start(argv = ARGV)
     Vedeu::Launcher.new(argv).execute!

data/features/start_stop.feature

@@ -0,0 +1,27 @@
+Feature: Starting and stopping a client application
+
+  @basic
+  Scenario: The simplest thing that could work
+    Given a file named "simple.rb" with mode "0755" and with:
+      """ruby
+      require 'vedeu'
+
+      class VedeuTestApp
+        include Vedeu
+
+        configure do
+          debug!
+          log '/tmp/vedeu_test_helper.log'
+        end
+
+        def self.start(argv = ARGV)
+          Vedeu::Launcher.new(argv).execute!
+        end
+      end
+
+      VedeuTestApp.start(ARGV)
+      """
+    When I run `ruby simple.rb` interactively
+    And I type "q"
+    And I close the stdin stream
+    Then the exit status should be 1

data/features/support/env.rb

@@ -0,0 +1,14 @@
+lib_dir = File.dirname(__FILE__) + '/../../lib'
+$LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
+
+require 'simplecov'
+require 'aruba'
+require 'aruba/cucumber'
+# require 'aruba/in_process'
+require 'mocha/api'
+require 'vedeu'
+
+class CucumberError < StandardError; end
+
+# Aruba::InProcess.main_class = Vedeu::Launcher
+# Aruba.process = Aruba::InProcess

data/lib/vedeu/all.rb

@@ -0,0 +1,29 @@
+
+# load order is important
+
+require 'vedeu/traps'
+require 'vedeu/exceptions'
+
+require 'vedeu/repositories/all'
+
+require 'vedeu/api'
+require 'vedeu/bindings'
+
+# load order has not been fully established beyond this point
+
+require 'vedeu/buffers/all'
+require 'vedeu/configuration/all'
+require 'vedeu/cursor/all'
+
+require 'vedeu/dsl/shared/all'
+require 'vedeu/dsl/all'
+
+require 'vedeu/events/all'
+require 'vedeu/input/all'
+require 'vedeu/models/all'
+require 'vedeu/output/all'
+require 'vedeu/presentation/all'
+require 'vedeu/support/all'
+
+require 'vedeu/application'
+require 'vedeu/launcher'

data/lib/vedeu/api.rb

@@ -0,0 +1,39 @@
+require 'vedeu/support/common'
+require 'vedeu/support/terminal'
+require 'vedeu/events/all'
+require 'vedeu/models/all'
+require 'vedeu/input/all'
+require 'vedeu/dsl/composition'
+require 'vedeu/dsl/shared/all'
+require 'vedeu/dsl/view'
+
+module Vedeu
+
+  # Provides the API to Vedeu. Methods therein, and classes belonging to this
+  # module expose Vedeu's core functionality.
+  #
+  # @api public
+  module API
+
+    extend Forwardable
+    extend self
+
+    def_delegators Vedeu::Event,         :bind, :trigger, :unbind
+    def_delegators Vedeu::Configuration, :configure, :configuration
+    def_delegators Vedeu::DSL::Use,      :use
+    def_delegators Vedeu::DSL::View,     :interface, :renders, :views
+
+    def_delegators Vedeu::Focus,         :focus, :focus_by_name, :focussed?,
+                                         :focus_next, :focus_previous
+    def_delegators Vedeu::Keymap,        :keymap
+    def_delegators Vedeu::Log,           :log
+    def_delegators Vedeu::Mapper,        :keypress
+    def_delegators Vedeu::Menu,          :menu
+    def_delegators Vedeu::Menus,         :menus
+    def_delegators Vedeu::Terminal,      :height, :width, :resize
+
+  end # API
+
+  extend API
+
+end # Vedeu

data/lib/vedeu/application.rb

@@ -8,13 +8,13 @@ module Vedeu
     class << self
 
       # @return []
-      def start
-        new.start
+      def start(configuration)
+        new(configuration).start
       end
       alias_method :restart, :start
 
       # Stops the application!
-      # - The `:_cleanup_` event is triggered. Vedeu does not handle this event;
+      # - The `:cleanup` event is triggered. Vedeu does not handle this event;
       #   the client application may treat this event as Vedeu signalling that it
       #   is about to terminate. Client applications are encouraged to use this
       #   event to close any open buffers, save files, empty trash, etc.
@@ -23,15 +23,19 @@ module Vedeu
       #   terminate the application.
       # @return [StopIteration]
       def stop
-        Vedeu.trigger(:_cleanup_)
+        Vedeu.trigger(:cleanup)
 
         fail StopIteration
       end
 
     end # Application eigenclass
 
+    # :nocov:
+
     # @return [Application]
-    def initialize; end
+    def initialize(configuration)
+      @configuration = configuration
+    end
 
     # Starts the application!
     # - A new terminal screen is opened (or rather the current terminal is
@@ -56,12 +60,14 @@ module Vedeu
 
     private
 
+    attr_reader :configuration
+
     # Runs the application loop either once, or forever (exceptions and signals
     # permitting).
     #
     # @return []
     def runner
-      if Configuration.once?
+      if configuration.once?
         yield
 
       else
@@ -79,7 +85,7 @@ module Vedeu
     #
     # @return []
     def main_sequence
-      if Configuration.interactive?
+      if configuration.interactive?
         Input.capture(Terminal)
 
       else
@@ -107,6 +113,8 @@ module Vedeu
 
     end
 
+    # :nocov:
+
   end # Application
 
 end # Vedeu