vedeu 0.6.42 → 0.6.43

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b62ee246d1c9de2ac2eb6550b9fde097a68fcefd
-  data.tar.gz: 6d5d120d36d610b98760645417b5f40b85efcec8
+  metadata.gz: 76cf0490e2ade62f367af8687bd0c3405cb50576
+  data.tar.gz: 22ead63f283a82e549c1473f894818d605e20c56
 SHA512:
-  metadata.gz: 459e560a74dc825caaca7d05cc0ceb1b786ddbe6e8b8eaeb3bd9bb7fdc7b0777cb5e8fc3491dcb55a574bf2a1e97f7207a2c81e4648b75fcc437952349dab18b
-  data.tar.gz: 0b24360813d018af3acd34282867274f8c835727da8411f2410e71e88a7fea98ea03c5979a4938b8ee6adfcae9da69736d53868cd3fa3a25d565d1910d28c349
+  metadata.gz: 1303f2563550fdf5fdcffe76e105d8841ed1b9e45ba7f8bfdaecdaab1215b1c4faa91dc19b0647f74262dd0631d669dc9a5c19c4ad194511c81dc74aeb2ace23
+  data.tar.gz: 98b5280ad56de99846f43bda276d3abb5dc55c94cf1cba0079042a2b1f89174d7a5b947583554d9217fb3b58f67ec7373d7f6cfec772ad7d8b03daf2345e9962

data/README.md

@@ -25,6 +25,7 @@ have any problems with either of these operating systems.
 Vedeu relies on the following gems, these will be automatically
  installed when you install Vedeu (as documented below).
 
+- benchmark-ips
 - bundler
 - rake
 - ruby-prof

data/lib/vedeu/all.rb

@@ -27,11 +27,11 @@ require 'vedeu/null/all'
 require 'vedeu/models/views/all'
 require 'vedeu/models/all'
 require 'vedeu/application/all'
+require 'vedeu/cursors/all'
 require 'vedeu/dsl/all'
 require 'vedeu/borders/all'
 require 'vedeu/buffers/all'
 require 'vedeu/colours/all'
-require 'vedeu/cursors/all'
 require 'vedeu/distributed/all'
 require 'vedeu/editor/all'
 require 'vedeu/geometry/all'

data/lib/vedeu/buffers/buffer.rb

@@ -74,6 +74,34 @@ module Vedeu
         true
       end
 
+      # Return a boolean indicating whether the cursor should be
+      # visible for this view.
+      #
+      # On a per-view (and per-interface) basis, the cursor can be
+      # set to be visible or not visible.
+      #
+      # - If the cursor is visible, then refresh actions or events
+      #   involving the cursor will act as normal; hiding and showing
+      #   as the view is rendered or as events are triggered to change
+      #   the visibility state.
+      # - If the cursor is not visible, then refresh actions and
+      #   events involving the cursor will be ignored- the cursor is
+      #   not shown, so do no work.
+      #
+      # @return [Boolean]
+      def cursor_visible?
+        if front?
+          front.cursor_visible?
+
+        elsif previous?
+          previous.cursor_visible?
+
+        else
+          Vedeu.interfaces.by_name(name).cursor_visible?
+
+        end
+      end
+
       # Return a boolean indicating content presence on the buffer
       # type.
       #

data/lib/vedeu/colours/colour.rb

@@ -66,6 +66,11 @@ module Vedeu
         end
       end
 
+      # @return [Vedeu::Colours::Colour]
+      def self.default
+        new(background: :default, foreground: :default)
+      end
+
       # Returns a new instance of Vedeu::Colours::Colour.
       #
       # @param attributes [Hash]

data/lib/vedeu/cursors/all.rb

@@ -16,5 +16,6 @@ module Vedeu
 end # Vedeu
 
 require 'vedeu/cursors/cursor'
+require 'vedeu/cursors/dsl'
 require 'vedeu/cursors/refresh'
 require 'vedeu/cursors/repository'

data/lib/vedeu/cursors/cursor.rb

@@ -200,8 +200,10 @@ module Vedeu
       # @example
       #   Vedeu.trigger(:_hide_cursor_, name)
       #   Vedeu.trigger(:_hide_cursor_, Vedeu.focus)
+      #   Vedeu.trigger(:_hide_cursor_)
       #   Vedeu.hide_cursor(name)
       #   Vedeu.hide_cursor(Vedeu.focus)
+      #   Vedeu.hide_cursor
       #
       # @return [Vedeu::Models::Escape]
       def hide
@@ -233,8 +235,10 @@ module Vedeu
       # @example
       #   Vedeu.trigger(:_show_cursor_, name)
       #   Vedeu.trigger(:_show_cursor_, Vedeu.focus)
+      #   Vedeu.trigger(:_show_cursor_)
       #   Vedeu.show_cursor(name)
       #   Vedeu.show_cursor(Vedeu.focus)
+      #   Vedeu.show_cursor
       #
       # @return [Vedeu::Models::Escape]
       def show
@@ -336,30 +340,46 @@ module Vedeu
 
   # See {file:docs/cursors.md}
   Vedeu.bind(:_cursor_left_) do |name|
-    Vedeu.cursors.by_name(name).move_left
+    cursor = Vedeu.cursors.by_name(name)
 
-    Vedeu.trigger(:_refresh_cursor_, name)
+    if cursor.visible?
+      cursor.move_left
+
+      Vedeu.trigger(:_refresh_cursor_, name)
+    end
   end
 
   # See {file:docs/cursors.md}
   Vedeu.bind(:_cursor_down_) do |name|
-    Vedeu.cursors.by_name(name).move_down
+    cursor = Vedeu.cursors.by_name(name)
 
-    Vedeu.trigger(:_refresh_cursor_, name)
+    if cursor.visible?
+      cursor.move_down
+
+      Vedeu.trigger(:_refresh_cursor_, name)
+    end
   end
 
   # See {file:docs/cursors.md}
   Vedeu.bind(:_cursor_up_) do |name|
-    Vedeu.cursors.by_name(name).move_up
+    cursor = Vedeu.cursors.by_name(name)
 
-    Vedeu.trigger(:_refresh_cursor_, name)
+    if cursor.visible?
+      cursor.move_up
+
+      Vedeu.trigger(:_refresh_cursor_, name)
+    end
   end
 
   # See {file:docs/cursors.md}
   Vedeu.bind(:_cursor_right_) do |name|
-    Vedeu.cursors.by_name(name).move_right
+    cursor = Vedeu.cursors.by_name(name)
 
-    Vedeu.trigger(:_refresh_cursor_, name)
+    if cursor.visible?
+      cursor.move_right
+
+      Vedeu.trigger(:_refresh_cursor_, name)
+    end
   end
 
   # See {file:docs/cursors.md}

data/lib/vedeu/cursors/dsl.rb

@@ -0,0 +1,68 @@
+module Vedeu
+
+  module Cursors
+
+    # Control the visibility of the cursor for each interface/view.
+    #
+    module DSL
+
+      # Set the cursor visibility on an interface.
+      #
+      # @param value [Boolean] Any value other than nil or false will
+      #   evaluate
+      #   to true.
+      #
+      # @example
+      #   Vedeu.interface :my_interface do
+      #     cursor  true  # => show the cursor for this interface
+      #     # or...
+      #     cursor  :show # => both of these are equivalent to line
+      #                   #    above
+      #     # or...
+      #     cursor!       #
+      #     # ...
+      #   end
+      #
+      #   Vedeu.interface :my_interface do
+      #     cursor false # => hide the cursor for this interface
+      #     # or...
+      #     cursor nil   # => as above
+      #     # ...
+      #   end
+      #
+      #   Vedeu.view :my_interface do
+      #     cursor true # => Specify the visibility of the cursor when
+      #                 #    the view is rendered.
+      #     # ...
+      #   end
+      #
+      # @return [Vedeu::Cursors::Cursor]
+      def cursor(value = true)
+        boolean = value ? true : false
+
+        model.cursor_visible = boolean
+
+        Vedeu::Cursors::Cursor.store(name: model.name, visible: boolean)
+      end
+
+      # Set the cursor to visible for the interface or view.
+      #
+      # @return [Vedeu::Cursors::Cursor]
+      def cursor!
+        cursor(true)
+      end
+      alias_method :show_cursor!, :cursor!
+
+      # Set the cursor to invisible for the interface or view.
+      #
+      # @return [Vedeu::Cursors::Cursor]
+      def no_cursor!
+        cursor(false)
+      end
+      alias_method :hide_cursor!, :no_cursor!
+
+    end # DSL
+
+  end # Cursors
+
+end # Vedeu

data/lib/vedeu/cursors/refresh.rb

@@ -21,8 +21,6 @@ module Vedeu
       # @param (see #initialize)
       # @return (see #by_name)
       def self.by_name(name = Vedeu.focus)
-        name || Vedeu.focus
-
         new(name).by_name
       end
 
@@ -32,7 +30,7 @@ module Vedeu
       #   cursor to be refreshed. Defaults to `Vedeu.focus`.
       # @return [Vedeu::Cursors::Refresh]
       def initialize(name)
-        @name = present?(name) ? name : Vedeu.focus
+        @name = name
       end
 
       # Renders the cursor in the terminal. If the cursor's x or y
@@ -42,18 +40,22 @@ module Vedeu
       #
       # @return [Array]
       def by_name
-        Vedeu.trigger(:_refresh_view_content_, name) if refresh_view?
+        refresh_view if refresh_view?
 
         cursor.render
       end
 
-      protected
+      private
 
-      # @!attribute [r] name
       # @return [String|Symbol]
-      attr_reader :name
+      def name
+        present?(@name) ? @name : Vedeu.focus
+      end
 
-      private
+      # @return [void]
+      def refresh_view
+        Vedeu.trigger(:_refresh_view_content_, name)
+      end
 
       # Returns true when the view should be refreshed. This is
       # determined by checking that the offsets for x and y are
@@ -61,7 +63,7 @@ module Vedeu
       #
       # @return [Boolean]
       def refresh_view?
-        cursor.ox >= width || cursor.oy >= height
+        cursor.visible? && cursor.ox >= width || cursor.oy >= height
       end
 
       # @return [Vedeu::Cursors::Cursor]

data/lib/vedeu/dsl/view.rb

@@ -84,6 +84,7 @@ module Vedeu
 
       include Vedeu::Common
       include Vedeu::DSL
+      include Vedeu::Cursors::DSL
       include Vedeu::DSL::Presentation
       include Vedeu::DSL::Shared
       include Vedeu::DSL::Text

data/lib/vedeu/interfaces/dsl.rb

@@ -8,6 +8,7 @@ module Vedeu
 
       include Vedeu::Common
       include Vedeu::DSL
+      include Vedeu::Cursors::DSL
       include Vedeu::DSL::Presentation
       include Vedeu::DSL::Shared
       include Vedeu::DSL::Text
@@ -101,49 +102,6 @@ module Vedeu
 
       end # Eigenclass
 
-      # Set the cursor visibility on an interface.
-      #
-      # @param value [Boolean] Any value other than nil or false will
-      #   evaluate to true.
-      #
-      # @example
-      #   Vedeu.interface :my_interface do
-      #     cursor  true  # => show the cursor for this interface
-      #     # or...
-      #     cursor  :show # => both of these are equivalent to line
-      #                   #    above
-      #     # or...
-      #     cursor!       #
-      #     # ...
-      #   end
-      #
-      #   Vedeu.interface :my_interface do
-      #     cursor false # => hide the cursor for this interface
-      #     # or...
-      #     cursor nil   # => as above
-      #     # ...
-      #   end
-      #
-      #   Vedeu.view :my_interface do
-      #     cursor true # => Specify the visibility of the cursor when
-      #                 #    the view is rendered.
-      #     # ...
-      #   end
-      #
-      # @return [Vedeu::Cursors::Cursor]
-      def cursor(value = true)
-        boolean = value ? true : false
-
-        Vedeu::Cursors::Cursor.store(name: model.name, visible: boolean)
-      end
-
-      # Set the cursor to visible for the interface.
-      #
-      # @return [Vedeu::Cursors::Cursor]
-      def cursor!
-        cursor(true)
-      end
-
       # To maintain performance interfaces can be delayed from
       # refreshing too often, the reduces artefacts particularly when
       # resizing the terminal screen.
@@ -271,13 +229,6 @@ module Vedeu
         model.name = value
       end
 
-      # Set the cursor to invisible for the interface.
-      #
-      # @return [Vedeu::Cursors::Cursor]
-      def no_cursor!
-        cursor(false)
-      end
-
       # Set the interface to visible.
       #
       # @example

data/lib/vedeu/interfaces/interface.rb

@@ -19,6 +19,11 @@ module Vedeu
       # @return [Fixnum|Float]
       attr_accessor :client
 
+      # @!attribute [rw] cursor_visible
+      # @return [Boolean]
+      attr_accessor :cursor_visible
+      alias_method :cursor_visible?, :cursor_visible
+
       # @!attribute [rw] delay
       # @return [Fixnum|Float]
       attr_accessor :delay
@@ -49,6 +54,7 @@ module Vedeu
       # @param attributes [Hash]
       # @option attributes client [Vedeu::Client]
       # @option attributes colour [Vedeu::Colours::Colour]
+      # @option attributes cursor_visible [Boolean]
       # @option attributes delay [Float]
       # @option attributes group [String]
       # @option attributes name [String|Symbol]
@@ -112,18 +118,18 @@ module Vedeu
       # @return [Hash]
       def defaults
         {
-          client:     nil,
-          colour:     Vedeu::Colours::Colour.coerce(background: :default,
-                                                    foreground: :default),
-          delay:      0.0,
-          editable:   false,
-          group:      '',
-          name:       '',
-          parent:     nil,
-          repository: Vedeu.interfaces,
-          style:      :normal,
-          visible:    true,
-          zindex:     0,
+          client:         nil,
+          colour:         Vedeu::Colours::Colour.default,
+          cursor_visible: true,
+          delay:          0.0,
+          editable:       false,
+          group:          '',
+          name:           '',
+          parent:         nil,
+          repository:     Vedeu.interfaces,
+          style:          :normal,
+          visible:        true,
+          zindex:         0,
         }
       end
 

data/lib/vedeu/models/toggleable.rb

@@ -46,10 +46,10 @@ module Vedeu
     #
     module ClassMethods
 
-      # Hides the model.
+      # Hides the named model, or without a name, the model with same
+      # name as the currently focussed interface.
       #
       # @example
-      #   Vedeu.hide_cursor(name)
       #   Vedeu.hide_group(name)
       #   Vedeu.hide_interface(name)
       #
@@ -58,14 +58,13 @@ module Vedeu
       def hide(name = Vedeu.focus)
         repository.by_name(name).hide
       end
-      alias_method :hide_cursor,    :hide
       alias_method :hide_group,     :hide
       alias_method :hide_interface, :hide
 
-      # Shows the model.
+      # Shows the named model, or without a name, the model with same
+      # name as the currently focussed interface.
       #
       # @example
-      #   Vedeu.show_cursor(name)
       #   Vedeu.show_group(name)
       #   Vedeu.show_interface(name)
       #
@@ -74,14 +73,13 @@ module Vedeu
       def show(name = Vedeu.focus)
         repository.by_name(name).show
       end
-      alias_method :show_cursor,    :show
       alias_method :show_group,     :show
       alias_method :show_interface, :show
 
-      # Toggles the visibility of the model.
+      # Toggles the visibility of the named model, or without a name,
+      # the model with same name as the currently focussed interface.
       #
       # @example
-      #   Vedeu.toggle_cursor(name)
       #   Vedeu.toggle_group(name)
       #   Vedeu.toggle_interface(name)
       #
@@ -90,10 +88,47 @@ module Vedeu
       def toggle(name = Vedeu.focus)
         repository.by_name(name).toggle
       end
-      alias_method :toggle_cursor,    :toggle
       alias_method :toggle_group,     :toggle
       alias_method :toggle_interface, :toggle
 
+      # @example
+      #   Vedeu.hide_cursor(name)
+      #
+      # @param name [String|Symbol]
+      # @return [void]
+      # @see Vedeu::Toggleable#hide
+      def hide_cursor(name = Vedeu.focus)
+        hide(name) if cursor_visible?(name)
+      end
+
+      # @example
+      #   Vedeu.show_cursor(name)
+      #
+      # @param name [String|Symbol]
+      # @return [void]
+      # @see Vedeu::Toggleable#show
+      def show_cursor(name = Vedeu.focus)
+        show(name) if cursor_visible?(name)
+      end
+
+      # @example
+      #   Vedeu.toggle_cursor(name)
+      #
+      # @param name [String|Symbol]
+      # @return [void]
+      # @see Vedeu::Toggleable#toggle
+      def toggle_cursor(name = Vedeu.focus)
+        toggle(name) if cursor_visible?(name)
+      end
+
+      private
+
+      # @param name [String|Symbol]
+      # @return [Boolean]
+      def cursor_visible?(name)
+        Vedeu.buffers.by_name(name).cursor_visible?
+      end
+
     end # ClassMethods
 
     # When this module is included in a class, provide ClassMethods as