vedeu 0.4.53 → 0.4.54

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: af96b5d6c566e54996cf3c560a60650c5aec5492
-  data.tar.gz: 29d0ba76490206ea43cfb3d24a17a6f81fb9ff8f
+  metadata.gz: 144b0ad6061194dfc5cb20651b818ed2512df6a0
+  data.tar.gz: 22ce31896daf7963b207766b655f41d31b8aa68d
 SHA512:
-  metadata.gz: f9f76c20306185777104a808a6f23a3b3c6199e6712207c7246e8758cbd2be8a456d132bfb0a2c3afce79285d3d2b8661ee8a60d592137ec21149f5cfea71edd
-  data.tar.gz: a7e80e7662f4c59de7ede8cea19b2feeb847a544a583d6de92888cda507794a2c96de1e8b6af19fb6e1f74dab04876f47a5c95aa77a4890729110d10ec2a9d20
+  metadata.gz: d0327fe74a67980d3db9b0f96479fd32e9cc32590b70dbabf52c8db7ad667df9948fcd280b5b417e21cde5d5a1ef1f72d96f5861a1d957447f03f5218ac8ed17
+  data.tar.gz: 2e8a1974fb367819b03a0b9baab9e341b8ec1a44ac20a44da22f091bd60e1fea47cdcb5ad1fb4bf27252b4544d44a265cbfd67f5f62f3ea5b494c5f316d3e178

data/lib/vedeu/api.rb

@@ -1,7 +1,6 @@
 require 'vedeu/support/common'
 require 'vedeu/support/terminal'
 require 'vedeu/support/timer'
-require 'vedeu/support/visibility'
 require 'vedeu/output/renderers/all'
 require 'vedeu/events/all'
 require 'vedeu/models/all'
@@ -354,8 +353,8 @@ module Vedeu
     #   Vedeu.hide_cursor(name)
     #
     # @!method hide_cursor
-    #   @see Vedeu::Visibility.hide_cursor
-    def_delegators Vedeu::Visibility, :hide_cursor
+    #   @see Vedeu::Cursor#hide
+    def_delegators Vedeu::Cursor, :hide_cursor
 
     # Shows the cursor for the interface of the given name.
     #
@@ -363,8 +362,72 @@ module Vedeu
     #   Vedeu.show_cursor(name)
     #
     # @!method show_cursor
-    #   @see Vedeu::Visibility.show_cursor
-    def_delegators Vedeu::Visibility, :show_cursor
+    #   @see Vedeu::Cursor#show
+    def_delegators Vedeu::Cursor, :show_cursor
+
+    # Toggle the visibility of the cursor with the given name.
+    #
+    # @example
+    #   Vedeu.toggle_cursor(name)
+    #
+    # @!method toggle_cursor
+    #   @see Vedeu::Cursor#hide
+    #   @see Vedeu::Cursor#show
+    def_delegators Vedeu::Cursor, :toggle_cursor
+
+    # Hide the group with the given name.
+    #
+    # @example
+    #   Vedeu.hide_group(name)
+    #
+    # @!method hide_group
+    #   @see Vedeu::Group#hide
+    def_delegators Vedeu::Group, :hide_group
+
+    # Shows the group with the given name.
+    #
+    # @example
+    #   Vedeu.show_group(name)
+    #
+    # @!method show_group
+    #   @see Vedeu::Group#show
+    def_delegators Vedeu::Group, :show_group
+
+    # Toggle the visibility of the group with the given name.
+    #
+    # @example
+    #   Vedeu.toggle_group(name)
+    #
+    # @!method toggle_group
+    #   @see Vedeu::Group#toggle
+    def_delegators Vedeu::Group, :toggle_group
+
+    # Hide the interface with the given name.
+    #
+    # @example
+    #   Vedeu.hide_interface(name)
+    #
+    # @!method hide_interface
+    #   @see Vedeu::Interface#hide
+    def_delegators Vedeu::Interface, :hide_interface
+
+    # Shows the interface with the given name.
+    #
+    # @example
+    #   Vedeu.show_interface(name)
+    #
+    # @!method show_interface
+    #   @see Vedeu::Interface#show
+    def_delegators Vedeu::Interface, :show_interface
+
+    # Toggle the visibility of the interface with the given name.
+    #
+    # @example
+    #   Vedeu.toggle_interface(name)
+    #
+    # @!method toggle_interface
+    #   @see Vedeu::Interface#toggle
+    def_delegators Vedeu::Interface, :toggle_interface
 
   end # API
 

data/lib/vedeu/bindings/system.rb

@@ -22,7 +22,6 @@ module Vedeu
       def setup!
         cleanup!
         clear!
-        clear_group!
         command!
         exit!
         focus_next!
@@ -78,20 +77,6 @@ module Vedeu
         end
       end
 
-      # Clears the spaces occupied by the interfaces belonging to the named
-      # group.
-      #
-      # @example
-      #   Vedeu.trigger(:_clear_group_, name)
-      #   Vedeu.clear_by_group(name)
-      #
-      # @return [void]
-      def clear_group!
-        Vedeu.bind(:_clear_group_) do |name|
-          Vedeu::Clear::NamedGroup.render(name)
-        end
-      end
-
       # Will cause the triggering of the `:command` event; which you should
       # define to 'do things'
       #

data/lib/vedeu/bindings/visibility.rb

@@ -14,17 +14,34 @@ module Vedeu
       #
       # @return [void]
       def setup!
+        clear_group!
         hide_cursor!
         hide_group!
         hide_interface!
         show_cursor!
         show_group!
         show_interface!
+        toggle_cursor!
+        toggle_group!
         toggle_interface!
       end
 
       private
 
+      # Clears the spaces occupied by the interfaces belonging to the named
+      # group.
+      #
+      # @example
+      #   Vedeu.trigger(:_clear_group_, name)
+      #   Vedeu.clear_by_group(name)
+      #
+      # @return [void]
+      def clear_group!
+        Vedeu.bind(:_clear_group_) do |name|
+          Vedeu::Clear::NamedGroup.render(name)
+        end
+      end
+
       # Hide the cursor of the named interface or if a name is not given, the
       # interface currently in focus.
       #
@@ -36,7 +53,7 @@ module Vedeu
       # @return [void]
       def hide_cursor!
         Vedeu.bind(:_hide_cursor_) do |name|
-          Vedeu::Visibility.hide_cursor(name)
+          Vedeu::Cursor.hide_cursor(name)
         end
         Vedeu.bind(:_cursor_hide_) do |name|
           Vedeu.trigger(:_hide_cursor_, name)
@@ -50,12 +67,13 @@ module Vedeu
       # effectively clear the terminal and show the new group.
       #
       # @example
-      #   Vedeu.trigger(:_hide_group_, group_name)
+      #   Vedeu.trigger(:_hide_group_, name)
+      #   Vedeu.hide_group(name)
       #
       # @return [void]
       def hide_group!
         Vedeu.bind(:_hide_group_) do |name|
-          Vedeu.trigger(:_clear_group_, name)
+          Vedeu::Group.hide_group(name)
         end
       end
 
@@ -63,12 +81,12 @@ module Vedeu
       #
       # @example
       #   Vedeu.trigger(:_hide_interface_, name)
+      #   Vedeu.hide_interface(name)
       #
       # @return [void]
-      # @see Vedeu::Buffer#hide
       def hide_interface!
         Vedeu.bind(:_hide_interface_) do |name|
-          Vedeu.buffers.by_name(name).hide
+          Vedeu::Interface.hide_interface(name)
         end
       end
 
@@ -83,7 +101,7 @@ module Vedeu
       # @return [void]
       def show_cursor!
         Vedeu.bind(:_show_cursor_) do |name|
-          Vedeu::Visibility.show_cursor(name)
+          Vedeu::Cursor.show_cursor(name)
         end
         Vedeu.bind(:_cursor_show_) do |name|
           Vedeu.trigger(:_show_cursor_, name)
@@ -94,13 +112,13 @@ module Vedeu
       # the named group.
       #
       # @example
-      #   Vedeu.trigger(:_show_group_, group_name)
+      #   Vedeu.trigger(:_show_group_, name)
+      #   Vedeu.show_group(name)
       #
       # @return [void]
       def show_group!
         Vedeu.bind(:_show_group_) do |name|
-          Vedeu.trigger(:_clear_)
-          Vedeu.trigger(:_refresh_group_, name)
+          Vedeu::Group.show_group(name)
         end
       end
 
@@ -108,12 +126,38 @@ module Vedeu
       #
       # @example
       #   Vedeu.trigger(:_show_interface_, name)
+      #   Vedeu.show_interface(name)
       #
       # @return [void]
-      # @see Vedeu::Buffer#show
       def show_interface!
         Vedeu.bind(:_show_interface_) do |name|
-          Vedeu.buffers.by_name(name).show
+          Vedeu::Interface.show_interface(name)
+        end
+      end
+
+      # Toggling a cursor.
+      #
+      # @example
+      #   Vedeu.trigger(:_toggle_cursor_, name)
+      #   Vedeu.toggle_cursor(name)
+      #
+      # @return [void]
+      def toggle_cursor!
+        Vedeu.bind(:_toggle_cursor_) do |name|
+          Vedeu::Cursor.toggle_cursor(name)
+        end
+      end
+
+      # Toggling a group.
+      #
+      # @example
+      #   Vedeu.trigger(:_toggle_group_, name)
+      #   Vedeu.toggle_group(name)
+      #
+      # @return [void]
+      def toggle_group!
+        Vedeu.bind(:_toggle_group_) do |name|
+          Vedeu::Group.toggle_group(name)
         end
       end
 
@@ -121,12 +165,12 @@ module Vedeu
       #
       # @example
       #   Vedeu.trigger(:_toggle_interface_, name)
+      #   Vedeu.toggle_interface(name)
       #
       # @return [void]
-      # @see Vedeu::Buffer#toggle
       def toggle_interface!
         Vedeu.bind(:_toggle_interface_) do |name|
-          Vedeu.buffers.by_name(name).toggle
+          Vedeu::Interface.toggle_interface(name)
         end
       end
 

data/lib/vedeu/buffers/buffer.rb

@@ -79,13 +79,6 @@ module Vedeu
       true
     end
 
-    # Returns the front buffer or, if that is empty, the interface cleared.
-    #
-    # @return [void]
-    def clear
-      Vedeu::Output.render(clear_buffer)
-    end
-
     # Return a boolean indicating content presence on the buffer type.
     #
     # @return [Boolean] Whether the buffer targetted has content.
@@ -108,6 +101,7 @@ module Vedeu
     #
     # @example
     #   Vedeu.trigger(:_hide_interface_, name)
+    #   Vedeu.hide_interface(name)
     #
     # Will hide the named interface. If the interface is currently visible, it
     # will be cleared- rendered blank. To show the interface, the
@@ -117,11 +111,7 @@ module Vedeu
     #
     # @return [void]
     def hide
-      return nil unless visible?
-
-      Vedeu::Visibility.hide(interface)
-
-      clear
+      Vedeu::Output.render(clear_buffer)
     end
 
     # Return the content for this buffer.
@@ -139,12 +129,12 @@ module Vedeu
     def render
       Vedeu::Output.render(buffer)
     end
-    alias_method :content, :render
 
     # Show this buffer.
     #
     # @example
     #   Vedeu.trigger(:_show_interface_, name)
+    #   Vedeu.show_interface(name)
     #
     # Will show the named interface. If the interface is currently invisible, it
     # will be shown- rendered with its latest content. To hide the interface,
@@ -154,37 +144,7 @@ module Vedeu
     #
     # @return [void]
     def show
-      return nil if visible?
-
-      Vedeu::Visibility.show(interface)
-
-      render
-    end
-
-    # Toggles the visibility of this buffer.
-    #
-    # @example
-    #   Vedeu.trigger(:_toggle_interface_, name)
-    #
-    # Will toggle the visibility of the named interface. If the interface is
-    # currently visible, the area it occupies will be clears and the interface
-    # will be marked invisible. If the interface is invisible, then the
-    # interface will be marked visible and rendered in the area it occupies.
-    #
-    # @note
-    #   If an interface is marked visible whilst another view is occupying some
-    #   or all of the interface's current position, the interface will overwrite
-    #   this area- this may cause visual corruption.
-    #
-    # @return [void]
-    def toggle
-      if visible?
-        hide
-
-      else
-        show
-
-      end
+      Vedeu::Output.render(buffer)
     end
 
     private
@@ -249,18 +209,7 @@ module Vedeu
     #
     # @return [Vedeu::Interface]
     def interface
-      @interface ||= Vedeu.interfaces.by_name(name)
-    end
-
-    # @return [Vedeu::Interface]
-    def view
-      if front?
-        front
-
-      else
-        interface
-
-      end
+      Vedeu.interfaces.by_name(name)
     end
 
     # @see Vedeu::Interface#visible

data/lib/vedeu/cursor/cursor.rb

@@ -1,3 +1,5 @@
+require 'vedeu/support/toggleable'
+
 module Vedeu
 
   # Each interface has its own Cursor which maintains the position and
@@ -7,6 +9,7 @@ module Vedeu
   class Cursor
 
     include Vedeu::Model
+    include Vedeu::Toggleable
 
     # @!attribute [r] attributes
     # @return [Hash]
@@ -28,11 +31,6 @@ module Vedeu
     # @return [Boolean|Symbol]
     attr_reader :state
 
-    # @!attribute [r] visible
-    # @return [Boolean|Symbol]
-    attr_reader :visible
-    alias_method :visible?, :visible
-
     # @!attribute [rw] x
     # @return [Fixnum]
     attr_accessor :x
@@ -94,9 +92,17 @@ module Vedeu
     end
     alias_method :to_str, :to_s
 
+    # Hide a named cursor, or without a name, the cursor of the currently
+    # focussed interface.
+    #
+    # @example
+    #   Vedeu.hide_cursor(name)
+    #
     # @return [Vedeu::EscapeChar]
-    def hide_cursor
-      @hide_cursor ||= Vedeu::EscapeChar.new(Vedeu::Esc.hide_cursor)
+    def hide
+      super
+
+      visibility
     end
 
     # Return the position of this cursor.
@@ -106,15 +112,17 @@ module Vedeu
       @position ||= Vedeu::Position[y, x]
     end
 
+    # Show a named cursor, or without a name, the cursor of the currently
+    # focussed interface.
+    #
+    # @example
+    #   Vedeu.show_cursor(name)
+    #
     # @return [Vedeu::EscapeChar]
-    def show_cursor
-      @show_cursor ||= Vedeu::EscapeChar.new(Vedeu::Esc.show_cursor)
-    end
+    def show
+      super
 
-    # @param value [Boolean]
-    # @return [void]
-    def visible=(value)
-      @visible = @attributes[:visible] = value
+      visibility
     end
 
     private
@@ -145,9 +153,9 @@ module Vedeu
     #
     # @return [String]
     def visibility
-      return show_cursor if visible?
+      return Vedeu::EscapeChar.new(Vedeu::Esc.show_cursor) if visible?
 
-      hide_cursor
+      Vedeu::EscapeChar.new(Vedeu::Esc.hide_cursor)
     end
 
   end # Cursor