vedeu 0.5.3 → 0.5.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 52f99e59a2bd4ab818933894f1954ab87447ca02
-  data.tar.gz: 137357a572a617e95530c6300beb880ec541f517
+  metadata.gz: e8cbfce4cf0a82bd72ea2ca4db302211611f3c58
+  data.tar.gz: 5d77ffbb1325cd04c79c6173aad0805acb53fc8c
 SHA512:
-  metadata.gz: 1d9db9d21a9bc04bda9b3039cef7aca59be615c0ac1ed1b0064855420e84a80cf58b978e533e8bb03319165a947a714129384751bef5f3729edcb11d6656d9be
-  data.tar.gz: 5e7aaaf8b00d308237e4a46886ef7b61bd1eac408cf091df3f65fbb605d8c2f2687cbd932aa514d1b8a87314ad978dec6fe890a0737d882f60d83cc427d488f0
+  metadata.gz: 0d35ab6387b6ad9b8999444d82f5c7ec622d63b98eceda8706a3f4cfd669756618335a31f05868fb681ba97dbc6d2f2ebeb562c6eb7eba8b1064284f49da051d
+  data.tar.gz: bf839e0f88b3390edf7f995025223df62b7b6f6eb921c42974dbed6d5923be597bf0ce230c3451598fd84d4305ae8f90ebf718784618b8108cb0c4338fdcb341

data/README.md

@@ -7,7 +7,6 @@ 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
 
 Vedeu was been built primarily with Ruby v2.1; however, the
@@ -17,7 +16,7 @@ file will indicate the currently used Ruby version.
 When Vedeu started I was a MacOSX user, I've since moved to Linux. You shouldn't
 have any problems with either of these operating systems.
 
-Note: You may have trouble running Vedeu with Windows installations. (Pull
+**Note**: You may have trouble running Vedeu with Windows installations. (Pull
  requests welcome!)
 
 
@@ -35,12 +34,15 @@ To use Vedeu's application scaffolding, see the
 Have a look at: [Playa](https://github.com/gavinlaking/playa). Please browse the
 source of Playa and Vedeu to get a feel for how it all works.
 
+**Note**: Playa is based on an old version of Vedeu. Vedeu has significantly
+ improved since then and a better example is coming soon!
+
 If you have produced software which uses Vedeu, please let me know, I'll link
 to your project here.
 
 ## Documentation & Usage
 
-Vedeu is largely documented using Yard. I hope to produce more 'General Usage'
+Vedeu is documented using Yard. I hope to produce more 'General Usage'
 documentation shortly. In the meantime, please browse the
 [RubyDoc](http://rubydoc.info/gems/vedeu).
 
@@ -70,7 +72,6 @@ Any branch on the repository that is not `master` is probably experimental; do
  into `master` before a release, and branches prefixed with `spike/` are me
  playing with ideas.
 
-
 ### General contribution help
 
 1. Fork it ([https://github.com/gavinlaking/vedeu/fork](https://github.com/gavinlaking/vedeu/fork))
@@ -83,7 +84,6 @@ Any branch on the repository that is not `master` is probably experimental; do
 8. Push to the branch (`git push origin my-new-feature`)
 9. Create a new pull request.
 
-
 ## Author & Contributors
 
 ### Author

data/docs/events.md

@@ -1,6 +1,10 @@
 # @title Vedeu Events
 # Vedeu Events
 
+## Application Events
+
+See {Vedeu::Bindings::Application}
+
 ## System Events
 
 See {Vedeu::Bindings::System}

data/examples/borders_app.rb

@@ -30,7 +30,7 @@ class VedeuBordersApp
       height 4
       width  10
     end
-    colour  foreground: '#ffffff', background: '#ff0000'
+    colour  foreground: '#ffffff', background: '#f44336'
   end
 
   Vedeu.interface 'border_off' do
@@ -40,7 +40,7 @@ class VedeuBordersApp
       height 4
       width  10
     end
-    colour  foreground: '#ffffff', background: '#ff0000'
+    colour  foreground: '#ffffff', background: '#e91e63'
   end
 
   Vedeu.interface 'no_top' do
@@ -50,7 +50,7 @@ class VedeuBordersApp
       height 4
       width  10
     end
-    colour  foreground: '#000000', background: '#ff5500'
+    colour  foreground: '#000000', background: '#9c27b0'
   end
 
   Vedeu.interface 'no_bottom' do
@@ -60,7 +60,7 @@ class VedeuBordersApp
       height 4
       width  10
     end
-    colour  foreground: '#000000', background: '#ff5500'
+    colour  foreground: '#000000', background: '#673ab7'
   end
 
   Vedeu.interface 'no_left' do
@@ -70,7 +70,7 @@ class VedeuBordersApp
       height 4
       width  10
     end
-    colour  foreground: '#000000', background: '#ff5500'
+    colour  foreground: '#000000', background: '#3f51b5'
   end
 
   Vedeu.interface 'no_right' do
@@ -80,7 +80,7 @@ class VedeuBordersApp
       height 4
       width  10
     end
-    colour  foreground: '#000000', background: '#ff5500'
+    colour  foreground: '#000000', background: '#2196f3'
   end
 
   Vedeu.interface 'custom_corners' do
@@ -90,7 +90,7 @@ class VedeuBordersApp
       height 4
       width  10
     end
-    colour  foreground: '#ffffff', background: '#ff0000'
+    colour  foreground: '#000000', background: '#03a9f4'
   end
 
   Vedeu.interface 'custom_sides' do
@@ -100,47 +100,72 @@ class VedeuBordersApp
       height 4
       width  10
     end
-    colour  foreground: '#ffffff', background: '#ff0000'
+    colour  foreground: '#000000', background: '#00bcd4'
   end
 
+  # Borders can be defined as part of the interface definition.
   Vedeu.interface 'only_top' do
+    border do
+      foreground  '#ffffff'
+      show_right  false
+      show_bottom false
+      show_left   false
+    end
     geometry do
       x      26
       y      8
       height 4
       width  10
     end
-    colour  foreground: '#ffffff', background: '#0000ff'
+    colour  foreground: '#ffffff', background: '#009688'
   end
 
   Vedeu.interface 'only_bottom' do
+    border do
+      foreground  '#000000'
+      show_top   false
+      show_right false
+      show_left  false
+    end
     geometry do
       x      38
       y      8
       height 4
       width  10
     end
-    colour  foreground: '#ffffff', background: '#0000ff'
+    colour  foreground: '#000000', background: '#8bc34a'
   end
 
   Vedeu.interface 'only_left' do
+    border do
+      foreground  '#000000'
+      show_top    false
+      show_bottom false
+      show_right  false
+    end
     geometry do
       x      50
       y      8
       height 4
       width  10
     end
-    colour  foreground: '#ffffff', background: '#0000ff'
+    colour  foreground: '#000000', background: '#cddc39'
   end
 
   Vedeu.interface 'only_right' do
+    border do
+      foreground  '#000000'
+      show_top    false
+      show_bottom false
+      show_left   false
+    end
     geometry do
       x      62
       y      8
       height 4
       width  10
     end
-    colour  foreground: '#ffffff', background: '#0000ff'
+    colour  foreground: '#000000', background: '#ffeb3b'
   end
 
   Vedeu.interface 'custom_colour' do
@@ -150,7 +175,7 @@ class VedeuBordersApp
       height 4
       width  10
     end
-    colour foreground: '#ffffff', background: '#ff0000'
+    colour foreground: '#000000', background: '#ffc107'
   end
 
   Vedeu.interface 'negative' do
@@ -160,7 +185,7 @@ class VedeuBordersApp
       height 4
       width  10
     end
-    colour foreground: '#000000', background: '#00ff00'
+    colour foreground: '#000000', background: '#ff9800'
     style  'normal'
   end
 
@@ -173,7 +198,7 @@ class VedeuBordersApp
     key(:tab)       { Vedeu.trigger(:_focus_next_) }
   end
 
-  # Borders can be defined as part of a view (see below), or standalone.
+  # Borders can be defined as standalone declarations.
   Vedeu.border 'no_bottom' do
     foreground  '#ffffff'
     show_bottom false
@@ -191,6 +216,7 @@ class VedeuBordersApp
     show_top false
   end
 
+  # Borders can be defined as part of a view.
   Vedeu.renders do
     view('default_border') do
       border do
@@ -228,6 +254,7 @@ class VedeuBordersApp
     end
     view('custom_corners') do
       border do
+        foreground   '#ffffff'
         top_right    'B'
         top_left     'A'
         bottom_right 'D'
@@ -240,6 +267,7 @@ class VedeuBordersApp
     end
     view('custom_sides') do
       border do
+        background '#ff5722'
         horizontal '*'
         vertical   '$'
       end
@@ -249,48 +277,24 @@ class VedeuBordersApp
       end
     end
     view('only_top') do
-      border do
-        foreground  '#ffffff'
-        show_right  false
-        show_bottom false
-        show_left   false
-      end
       lines do
         line 'only'
         line 'top'
       end
     end
     view('only_bottom') do
-      border do
-        foreground  '#ffffff'
-        show_top   false
-        show_right false
-        show_left  false
-      end
       lines do
         line 'only'
         line 'bottom'
       end
     end
     view('only_left') do
-      border do
-        foreground  '#ffffff'
-        show_top    false
-        show_bottom false
-        show_right  false
-      end
       lines do
         line 'only'
         line 'left'
       end
     end
     view('only_right') do
-      border do
-        foreground  '#ffffff'
-        show_top    false
-        show_bottom false
-        show_left   false
-      end
       lines do
         line 'only'
         line 'right'

data/examples/focus_app.rb

@@ -33,6 +33,10 @@ class VedeuFocusApp
     Vedeu.renders { view('status') { lines { line(Vedeu.focus) } } }
   end
 
+  Vedeu.keymap('_global_') do
+    key('q') { Vedeu.exit }
+  end
+
   Vedeu.interface 'aluminium' do
     colour  foreground: '#ffffff', background: '#330000'
     cursor  true

data/examples/hello_world.rb

@@ -26,17 +26,24 @@ class HelloWorldApp
     foreground '#00ff00'
     geometry do
       centred!
-      height   3
+      height   5
       width    20
     end
+    keymap do
+      key('q') { Vedeu.exit }
+    end
   end
 
   Vedeu.renders do
     view 'messages' do
       lines do
-        centre 'Hello World!', width: 20
+        line do
+          centre 'Hello World!', width: 20
+        end
         line
-        centre "Press 'q' to exit.", width: 20
+        line do
+          centre "Press 'q' to exit.", width: 20
+        end
       end
     end
   end

data/lib/vedeu/all.rb

@@ -16,6 +16,7 @@ require 'vedeu/configuration/configuration'
 
 require 'vedeu/terminal'
 require 'vedeu/runtime/main_loop'
+require 'vedeu/runtime/flags'
 require 'vedeu/runtime/application'
 
 require 'vedeu/models/toggleable'
@@ -44,10 +45,8 @@ require 'vedeu/geometry/dimension'
 require 'vedeu/geometry/geometry'
 require 'vedeu/geometry/geometries'
 require 'vedeu/geometry/grid'
-require 'vedeu/geometry/index_position'
 require 'vedeu/geometry/position_index'
 require 'vedeu/geometry/position'
-require 'vedeu/geometry/position_validator'
 
 require 'vedeu/colours/escape_sequences'
 require 'vedeu/colours/colours'

data/lib/vedeu/api.rb

@@ -98,7 +98,10 @@ module Vedeu
     #   @see Vedeu::DSL::View.renders
     # @!method views
     #   @see Vedeu::DSL::View.views
-    def_delegators Vedeu::DSL::View, :interface, :renders, :render, :views
+    # @!method view
+    #   @see Vedeu::DSL::View.view
+    def_delegators Vedeu::DSL::View, :interface, :renders, :render, :views,
+                                     :view
 
     # @example
     #   Vedeu.bind(name) { }

data/lib/vedeu/application/application_controller.rb

@@ -8,6 +8,30 @@ module Vedeu
 
     include Vedeu::Controller
 
+    # @param params [Hash] The named parameters provided to the controller which
+    #   will be used by the actions within the controller.
+    # @return [Vedeu::ApplicationController]
+    def initialize(**params)
+      @params = params
+    end
+
+    # @param controller [Symbol] The name of controller to be redirected to.
+    # @param action [Symbol] The name of the action within the controller to be
+    #   called.
+    # @param params [Hash] Any named parameter which need to be passed to the
+    #   action.
+    def redirect_to(controller, action, **params)
+      Vedeu.trigger(:_goto_, controller, action, params)
+    end
+    alias_method :redirect, :redirect_to
+    alias_method :goto, :redirect_to
+
+    protected
+
+    # @!attribute [rw] params
+    # @return [Hash] The named parameters passed to the controller.
+    attr_accessor :params
+
   end # ApplicationController
 
 end # Vedeu

data/lib/vedeu/application/application_view.rb

@@ -9,18 +9,18 @@ module Vedeu
 
     # Renders the view.
     #
-    # @param args [void]
+    # @param params [Hash]
     # @return [void]
-    def self.render(*args)
-      new(args).render
+    def self.render(**params)
+      new(params).render
     end
 
     # Returns a new instance of Vedeu::ApplicationView.
     #
-    # @param args [void]
+    # @param params [Hash]
     # @return [Vedeu::ApplicationView]
-    def initialize(*args)
-      @args = args
+    def initialize(**params)
+      @params = params
     end
 
     # @raise [Vedeu::NotImplemented] Subclasses of this class must implement
@@ -33,9 +33,9 @@ module Vedeu
 
     protected
 
-    # @!attribute [r] args
-    # @return [void]
-    attr_reader :args
+    # @!attribute [rw] params
+    # @return [Hash]
+    attr_accessor :params
 
     private