vedeu 0.4.24 → 0.4.25

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d53834cae0f1a3dc8708b3706bf87d4014f16c90
-  data.tar.gz: 08bc9cd02ad0672be13d272172912d6b7975fd41
+  metadata.gz: bb6dc29e78bc70eab80c780ef16626cddbdcdf0b
+  data.tar.gz: e83efc8abd484c8436ae562fd393bfb745706475
 SHA512:
-  metadata.gz: 522ba5bc35cfb89d15c28b8784da90634a80106e3aaa463e039c9b1c01c310a4cec9e87dccc7b9fba55a6b5f81bd39573cf854241e203c7400bbe8652cc593d1
-  data.tar.gz: 44e0de6a4e2541b1672e0c79bfdf183bd4b2ce9e408525c41c79c9772ca160a6e6387d46950201ef05eb925672e3b6329347eaa61db186d08525af144fed640e
+  metadata.gz: fe72d64a341a1447e93f85ffcc7213d3e598ad682ab912689be1c3a0b825c82c9dcaa4402513a9b738f0f9b43b18257d8d161ef384573248588c1690a40d2e4f
+  data.tar.gz: 183b719c6624c17c606fc29a3d163cd2b6ded9138a9943c032292f50a0155c8c47abc2474cfcd0da284a506c0830d48761cbcf18e679808b9daae2aaa17458db

data/examples/material_colours_app.rb

@@ -5,23 +5,24 @@ $LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
 
 require 'vedeu'
 
-# An example application to demonstrate colours.
+# An example application to demonstrate colours, cursor and interface movement,
+# maximising/unmaximising of interfaces and toggling of cursors and interfaces.
 class VedeuMaterialColoursApp
 
   include Vedeu
 
   configure do
-    # debug!
+    debug!
     log '/tmp/vedeu_material_colours_app.log'
-    renderers Vedeu::Renderers::File
+    # renderers Vedeu::Renderers::File
   end
 
   interface 'main_interface' do
     border 'main_interface' do
-      colour foreground: '#ffffff', background: '#000000'
+      colour foreground: '#ffffff', background: :default
       title 'Rainbow!'
     end
-    colour foreground: '#ffffff', background: '#000000'
+    colour foreground: '#ffffff', background: :default
     cursor!
     geometry 'main_interface' do
       x  5
@@ -33,10 +34,10 @@ class VedeuMaterialColoursApp
 
   interface 'other_interface' do
     border 'other_interface' do
-      colour foreground: '#ffffff', background: '#000000'
+      colour foreground: '#ffffff', background: :default
       title 'Wow!'
     end
-    colour foreground: '#ffffff', background: '#000000'
+    colour foreground: '#ffffff', background: :default
     cursor!
     geometry 'other_interface' do
       x  27
@@ -47,10 +48,21 @@ class VedeuMaterialColoursApp
   end
 
   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_)  }
+    key(:up)    { Vedeu.trigger(:_cursor_up_)    }
+    key(:right) { Vedeu.trigger(:_cursor_right_) }
+    key(:down)  { Vedeu.trigger(:_cursor_down_)  }
+    key(:left)  { Vedeu.trigger(:_cursor_left_)  }
+
+    key('a') { Vedeu.trigger(:_view_left_, 'main_interface')  }
+    key('s') { Vedeu.trigger(:_view_down_, 'main_interface')  }
+    key('d') { Vedeu.trigger(:_view_up_, 'main_interface')    }
+    key('f') { Vedeu.trigger(:_view_right_, 'main_interface') }
+
+    key('h') { Vedeu.trigger(:_view_left_, 'other_interface')  }
+    key('j') { Vedeu.trigger(:_view_down_, 'other_interface')  }
+    key('k') { Vedeu.trigger(:_view_up_, 'other_interface')    }
+    key('l') { Vedeu.trigger(:_view_right_, 'other_interface') }
+
     key('t')         do
       Vedeu.trigger(:_toggle_interface_, 'main_interface')
       Vedeu.trigger(:_toggle_interface_, 'other_interface')
@@ -59,6 +71,10 @@ class VedeuMaterialColoursApp
     key('2') { Vedeu.trigger(:_show_interface_, 'main_interface') }
     key('3') { Vedeu.trigger(:_hide_interface_, 'other_interface') }
     key('4') { Vedeu.trigger(:_show_interface_, 'other_interface') }
+    key('m') { Vedeu.trigger(:_maximise_, 'main_interface') }
+    key('n') { Vedeu.trigger(:_unmaximise_, 'main_interface') }
+    key('b') { Vedeu.trigger(:_maximise_, 'other_interface') }
+    key('v') { Vedeu.trigger(:_unmaximise_, 'other_interface') }
   end
 
   renders do

data/lib/vedeu/bindings.rb

@@ -92,23 +92,17 @@ module Vedeu
     end
 
     # @see {Vedeu::Move}
-    Vedeu.bind(:_cursor_down_) do |name|
-      Vedeu::Move.by_name(Vedeu::Cursor, :down, name)
-    end
-
-    # @see {Vedeu::Move}
-    Vedeu.bind(:_cursor_left_) do |name|
-      Vedeu::Move.by_name(Vedeu::Cursor, :left, name)
-    end
-
-    # @see {Vedeu::Move}
-    Vedeu.bind(:_cursor_right_) do |name|
-      Vedeu::Move.by_name(Vedeu::Cursor, :right, name)
-    end
-
-    # @see {Vedeu::Move}
-    Vedeu.bind(:_cursor_up_) do |name|
-      Vedeu::Move.by_name(Vedeu::Cursor, :up, name)
+    %w(cursor view).each do |model|
+      [:down, :left, :right, :up].each do |direction|
+        Vedeu.bind("_#{model}_#{direction}_".to_sym) do |name|
+          klass = {
+            'cursor' => Vedeu::Cursor,
+            'view'   => Vedeu::Geometry,
+          }.fetch(model)
+
+          Vedeu::Move.by_name(klass, direction, name)
+        end
+      end
     end
 
     # @see {Vedeu::Move}
@@ -116,26 +110,6 @@ module Vedeu
       Vedeu::Move.by_name(Vedeu::Cursor, :origin, name)
     end
 
-    # @see {Vedeu::Move}
-    Vedeu.bind(:_geometry_down_) do |name|
-      Vedeu.geometries.by_name(name).move(1, 0)
-    end
-
-    # @see {Vedeu::Move}
-    Vedeu.bind(:_geometry_left_) do |name|
-      Vedeu.geometries.by_name(name).move(0, -1)
-    end
-
-    # @see {Vedeu::Move}
-    Vedeu.bind(:_geometry_right_) do |name|
-      Vedeu.geometries.by_name(name).move(0, 1)
-    end
-
-    # @see {Vedeu::Move}
-    Vedeu.bind(:_geometry_up_) do |name|
-      Vedeu.geometries.by_name(name).move(-1, 0)
-    end
-
     # @see {Vedeu::Move}
     Vedeu.bind(:_cursor_reset_) { |name| Vedeu.trigger(:_cursor_origin_, name) }
 
@@ -191,14 +165,10 @@ module Vedeu
     # Clears the whole terminal space, or the named interface area to be cleared
     # if given.
     Vedeu.bind(:_clear_) do |name|
-      if name
-        Vedeu::Clear.clear(Vedeu.interfaces.by_name(name),
-                           clear_border: true, use_terminal_colours: true)
+      Vedeu::Terminal.clear unless name
 
-      else
-        Vedeu::Terminal.virtual.clear if Vedeu::Configuration.drb?
-        Vedeu::Terminal.clear
-      end
+      Vedeu::Clear.clear(Vedeu.interfaces.by_name(name),
+                         clear_border: true, use_terminal_colours: true)
     end
 
     # Clears the spaces occupied by the interfaces belonging to the named group.
@@ -237,27 +207,21 @@ module Vedeu
     #   This may be rarely used, since the action of showing a group using
     #   `Vedeu.trigger(:_show_group_, group_name)` will effectively clear the
     #   terminal and show the new group.
-    Vedeu.bind(:_hide_group_) do |name|
-      Vedeu.trigger(:_clear_group_, name)
-    end
+    Vedeu.bind(:_hide_group_) { |name| Vedeu.trigger(:_clear_group_, name) }
 
     # Will hide the named interface. If the interface is currently visible, it
     # will be cleared- rendered blank. To show the interface, the
     # ':_show_interface_' event should be triggered.
     # Triggering the ':_hide_group_' event to which this named interface belongs
     # will also hide the interface.
-    Vedeu.bind(:_hide_interface_) do |name|
-      Vedeu.buffers.by_name(name).hide
-    end
+    Vedeu.bind(:_hide_interface_) { |name| Vedeu.buffers.by_name(name).hide }
 
     # Will show the named interface. If the interface is currently invisible, it
     # will be shown- rendered with its latest content. To hide the interface,
     # the ':_hide_interface_' event should be triggered.
     # Triggering the ':_show_group_' event to which this named interface belongs
     # will also show the interface.
-    Vedeu.bind(:_show_interface_) do |name|
-      Vedeu.buffers.by_name(name).show
-    end
+    Vedeu.bind(:_show_interface_) { |name| Vedeu.buffers.by_name(name).show }
 
     # Will toggle the visibility of the named interface. If the interface is
     # currently visible, the area it occupies will be clears and the interface
@@ -269,24 +233,18 @@ module Vedeu
     #   or all of the interface's current position, the interface will overwrite
     #   this area- this may cause visual corruption.
     Vedeu.bind(:_toggle_interface_) do |name|
-      if name && Vedeu.interfaces.registered?(name)
-        interface = Vedeu.interfaces.find(name)
+      if Vedeu.interfaces.by_name(name).visible?
+        Vedeu.trigger(:_hide_interface_, name)
 
-        if interface.visible?
-          Vedeu.trigger(:_hide_interface_, name)
-
-        else
-          Vedeu.trigger(:_show_interface_, name)
+      else
+        Vedeu.trigger(:_show_interface_, name)
 
-        end
       end
     end
 
     # Will maximise the named interface geometry. This means it will occupy all
     # of the available space on the terminal window.
-    Vedeu.bind(:_maximise_) do |name|
-      Vedeu.geometries.by_name(name).maximise
-    end
+    Vedeu.bind(:_maximise_) { |name| Vedeu.geometries.by_name(name).maximise }
 
     # Will unmaximise the named interface geometry. Previously, if a geometry
     # was maximised, then triggering the unmaximise event will return it to its

data/lib/vedeu/cursor/cursor.rb

@@ -4,11 +4,8 @@ module Vedeu
   # visibility of the cursor within that interface.
   class Cursor
 
-    extend Forwardable
     include Vedeu::Model
 
-    def_delegators Vedeu::Esc, :hide_cursor, :show_cursor
-
     # @!attribute [r] attributes
     # @return [Hash]
     attr_reader :attributes
@@ -97,6 +94,17 @@ module Vedeu
 
       end
     end
+    alias_method :to_str, :to_s
+
+    # @return [Vedeu::EscapeChar]
+    def hide_cursor
+      @hide_cursor ||= Vedeu::EscapeChar.new(Vedeu::Esc.hide_cursor)
+    end
+
+    # @return [Vedeu::EscapeChar]
+    def show_cursor
+      @show_cursor ||= Vedeu::EscapeChar.new(Vedeu::Esc.show_cursor)
+    end
 
     private
 
@@ -133,13 +141,9 @@ module Vedeu
     #
     # @return [String]
     def visibility
-      if visible?
-        show_cursor
-
-      else
-        hide_cursor
+      return show_cursor if visible?
 
-      end
+      hide_cursor
     end
 
   end # Cursor

data/lib/vedeu/cursor/move.rb

@@ -1,7 +1,7 @@
 module Vedeu
 
-  # Adjusts the position of the cursor. To use this class, call the appropriate
-  # event:
+  # Adjusts the position of the cursor or view. To use this class, call the
+  # appropriate event:
   #
   # @example
   #   Vedeu.trigger(:_cursor_down_)
@@ -23,14 +23,28 @@ module Vedeu
   #                                 # Moves the cursor to the top left of the
   #                                 # named or current interface in focus.
   #
+  #   Vedeu.trigger(:_view_down_,  'my_interface')
+  #   Vedeu.trigger(:_view_left_,  'my_interface')
+  #   Vedeu.trigger(:_view_right_, 'my_interface')
+  #   Vedeu.trigger(:_view_up_,    'my_interface')
+  #
   # @note
-  #   The cursor may not be visible, but it will still move if requested.
-  #   The cursor will not exceed the border or boundary of the interface.
+  #   The cursor or view may not be visible, but it will still move if
+  #     requested.
+  #   The cursor will not exceed the border or boundary of the interface, or
+  #     boundary of the visible terminal.
   #   The cursor will move freely within the bounds of the interface,
   #     irrespective of content.
+  #   The view will not exceed the boundary of the visible terminal.
+  #   The view will move freely within the bounds of the interface,
+  #     irrespective of content.
   class Move
 
-    # Move the named cursor, or that which is currently in focus in the
+    extend Forwardable
+
+    def_delegators :geometry, :x, :xn, :y, :yn
+
+    # Move the named cursor or view, or that which is currently in focus in the
     # specified direction.
     #
     # @param direction [Symbol] The direction of travel. Directions include:
@@ -46,7 +60,7 @@ module Vedeu
       Vedeu::Move.send(direction, entity, name)
     end
 
-    # Moves the cursor down by one row.
+    # Moves the cursor or view down by one row.
     #
     # @param entity [Class]
     # @param name [String]
@@ -55,7 +69,7 @@ module Vedeu
       new(entity, name, 1, 0).move
     end
 
-    # Moves the cursor left by one column.
+    # Moves the cursor or view left by one column.
     #
     # @param entity [Class]
     # @param name [String]
@@ -64,7 +78,7 @@ module Vedeu
       new(entity, name, 0, -1).move
     end
 
-    # Moves the cursor right by one column.
+    # Moves the cursor or view right by one column.
     #
     # @param entity [Class]
     # @param name [String]
@@ -73,7 +87,7 @@ module Vedeu
       new(entity, name, 0, 1).move
     end
 
-    # Moves the cursor up by one row.
+    # Moves the cursor or view up by one row.
     #
     # @param entity [Class]
     # @param name [String]
@@ -82,7 +96,8 @@ module Vedeu
       new(entity, name, -1, 0).move
     end
 
-    # Moves the cursor to the top left coordinate of the interface.
+    # Moves the cursor or view to the top left coordinate of the interface or
+    # terminal screen.
     #
     # @param entity [Class]
     # @param name [String]
@@ -94,7 +109,7 @@ module Vedeu
     # Returns an instance of Vedeu::Move.
     #
     # @param entity [Class]
-    # @param name [String] The name of the cursor.
+    # @param name [String] The name of the cursor or view.
     # @param dy [Fixnum] Move up (-1), or down (1), or no action (0).
     # @param dx [Fixnum] Move left (-1), or right (1), or no action (0).
     # @return [Move]
@@ -105,23 +120,52 @@ module Vedeu
       @dx     = dx
     end
 
-    # Returns a newly positioned and stored Cursor.
+    # Returns a newly positioned and stored cursor or view.
     #
-    # @return [Cursor]
+    # @return [Vedeu::Cursor|Vedeu::Geometry]
     def move
-      attrs = attributes.merge!(new_attributes)
+      model = entity.new(merged_attributes).store
 
-      model = entity.new(attrs).store
+      refresh
 
-      if model.is_a?(Vedeu::Cursor)
-        Vedeu.trigger(:_refresh_cursor_, name)
+      model
+    end
 
-      else
+    # @return [void]
+    def refresh
+      if entity.to_s == 'Vedeu::Geometry'
+        Vedeu.trigger(:_clear_)
+        Vedeu.trigger(:_refresh_)
+        Vedeu.trigger(:_clear_, name)
         Vedeu.trigger(:_refresh_, name)
 
+      else
+        Vedeu.trigger(:_refresh_cursor_, name)
+
       end
+    end
 
-      model
+    # @return [Hash<Symbol => Boolean,Fixnum, String>]
+    def merged_attributes
+      if entity.to_s == 'Vedeu::Geometry'
+        {
+          centred:    false,
+          maximised:  false,
+          name:       name,
+          x:          (x + dx),
+          y:          (y + dy),
+          xn:         (xn + dx),
+          yn:         (yn + dy),
+        }
+
+      else
+        cursor.attributes.merge!(
+          x:  x_position,
+          y:  y_position,
+          ox: ox,
+          oy: oy)
+
+      end
     end
 
     protected
@@ -144,25 +188,6 @@ module Vedeu
 
     private
 
-    # Retrieve the attributes of the cursor.
-    #
-    # @return [Hash<Symbol => Fixnum, String>]
-    def attributes
-      cursor.attributes
-    end
-
-    # Provide the new attributes for the cursor.
-    #
-    # @return [Hash<Symbol => Fixnum>]
-    def new_attributes
-      {
-        x:  x_position,
-        y:  y_position,
-        ox: ox,
-        oy: oy,
-      }
-    end
-
     # Returns the cursors x position based on its current offset.
     #
     # @return [Fixnum]
@@ -187,6 +212,11 @@ module Vedeu
       @cursor ||= Vedeu.cursors.by_name(name)
     end
 
+    # @return (see Vedeu::Geometries#by_name)
+    def geometry
+      @geometry ||= Vedeu.geometries.by_name(name)
+    end
+
     # Apply the direction amount to the cursor offset. If the offset is less
     # than 0, correct to 0.
     #