vedeu 0.2.10 → 0.2.11

data/lib/vedeu/repositories/cursors.rb

@@ -7,13 +7,21 @@ module Vedeu
   module Cursors
 
     include Repository
-    include Positional
     extend self
 
-    # System events which when called will update the cursor visibility
-    # accordingly for the interface in focus.
-    Vedeu.event(:_cursor_hide_) { Cursors.hide }
-    Vedeu.event(:_cursor_show_) { Cursors.show }
+    # Add or update the cursor coordinates.
+    #
+    # @param attributes [Hash]
+    # @return [Offset]
+    def add(attributes)
+      validate_attributes!(attributes)
+
+      Vedeu.log("#{action(__callee__)} positional (#{model}): " \
+                "'#{attributes[:name]}'")
+
+      model.new(attributes).store
+    end
+    alias_method :update, :add
 
     # Make the cursor of this interface invisible.
     #
@@ -31,9 +39,9 @@ module Vedeu
 
     private
 
-    # @return [Class]
-    def entity
-      Cursor
+    # @return [Class] The model class for this repository.
+    def model
+      Vedeu::Cursor
     end
 
     # Returns an empty collection ready for the storing of cursors by name with

data/lib/vedeu/repositories/events.rb

@@ -14,11 +14,53 @@ module Vedeu
     # @see Vedeu::API#unevent
     alias_method :unevent, :remove
 
-    # @see Vedeu::API#event
+    # Register an event by name with optional delay (throttling) which when
+    # triggered will execute the code contained within the passed block.
+    #
+    # @param name  [Symbol] The name of the event which will be triggered later.
+    # @param [Hash] opts The options to register the event with.
+    # @option opts :delay [Fixnum|Float] Limits the execution of the
+    #   triggered event to only execute when first triggered, with subsequent
+    #   triggering being ignored until the delay has expired.
+    # @option opts :debounce [Fixnum|Float] Limits the execution of the
+    #   triggered event to only execute once the debounce has expired.
+    #   Subsequent triggers before debounce expiry are ignored.
+    # @param block [Proc] The event to be executed when triggered. This block
+    #   could be a method call, or the triggering of another event, or sequence
+    #   of either/both.
+    #
+    # @example
+    #   Vedeu.event :my_event do |some, args|
+    #     ... some code here ...
+    #
+    #     Vedeu.trigger(:my_other_event)
+    #   end
+    #
+    #   T = Triggered, X = Executed, i = Ignored.
+    #
+    #   0.0.....0.2.....0.4.....0.6.....0.8.....1.0.....1.2.....1.4.....1.6...
+    #   .T...T...T...T...T...T...T...T...T...T...T...T...T...T...T...T...T...T
+    #   .X...i...i...i...i...X...i...i...i...i...X...i...i...i...i...i...i...i
+    #
+    #   Vedeu.event(:my_delayed_event, { delay: 0.5 })
+    #     ... some code here ...
+    #   end
+    #
+    #   T = Triggered, X = Executed, i = Ignored.
+    #
+    #   0.0.....0.2.....0.4.....0.6.....0.8.....1.0.....1.2.....1.4.....1.6...
+    #   .T...T...T...T...T...T...T...T...T...T...T...T...T...T...T...T...T...T
+    #   .i...i...i...i...i...i...i...X...i...i...i...i...i...i...X...i...i...i
+    #
+    #   Vedeu.event(:my_debounced_event, { debounce: 0.7 })
+    #     ... some code here ...
+    #   end
+    #
+    # @return [Hash]
     def add(name, options = {}, &block)
       Vedeu.log("Registering event: '#{name}'")
 
-      events(name) << Event.new(name, options, block)
+      events(name) << model.new(name, options, block)
     end
     alias_method :event, :add
 
@@ -34,6 +76,11 @@ module Vedeu
 
     private
 
+    # @return [Class] The model class for this repository.
+    def model
+      Vedeu::Event
+    end
+
     def events(name)
       storage[name][:events]
     end
@@ -47,13 +94,53 @@ module Vedeu
     end
 
     # System events needed by Vedeu to run.
-    event(:_clear_)                   { Terminal.clear_screen     }
-    event(:_exit_)                    { Vedeu::Application.stop   }
-    event(:_initialize_)              { Vedeu.trigger(:_refresh_) }
-    event(:_keypress_)                { |key| Vedeu.keypress(key) }
-    event(:_log_)                     { |msg| Vedeu.log(msg)      }
-    event(:_mode_switch_)             { fail ModeSwitch           }
-    event(:_resize_, { delay: 0.25 }) { Vedeu.resize              }
+    event(:_clear_)                   { Vedeu::Terminal.clear_screen }
+    event(:_exit_)                    { Vedeu::Application.stop      }
+    event(:_initialize_)              { Vedeu.trigger(:_refresh_)    }
+    event(:_keypress_)                { |key| Vedeu.keypress(key)    }
+    event(:_log_)                     { |msg| Vedeu.log(msg)         }
+    event(:_mode_switch_)             { fail ModeSwitch              }
+    event(:_resize_, { delay: 0.25 }) { Vedeu.resize                 }
+
+    # System events which when called will update the cursor visibility
+    # accordingly for the interface in focus.
+    # From: Cursors (top)
+    event(:_cursor_hide_) { Vedeu::Cursors.hide }
+    event(:_cursor_show_) { Vedeu::Cursors.show }
+
+    # System events which when called will change which interface is currently
+    # focussed. When the interface is brought into focus, its cursor position
+    # and visibility is restored.
+    # From: Focus (top)
+    event(:_focus_by_name_) { |name| Vedeu::Focus.by_name(name) }
+    event(:_focus_next_)    {        Vedeu::Focus.next_item }
+    event(:_focus_prev_)    {        Vedeu::Focus.prev_item }
+
+    # System events which when called will move in the direction specified;
+    # these will update the cursor position or content offset (scrolling)
+    # according to the interface in focus.
+    # From: Offsets (bottom)
+    event(:_cursor_down_)  { Vedeu::Offsets.down  }
+    event(:_cursor_left_)  { Vedeu::Offsets.left  }
+    event(:_cursor_right_) { Vedeu::Offsets.right }
+    event(:_cursor_up_)    { Vedeu::Offsets.up    }
+
+    # System events which when called with the appropriate menu name will
+    # update the menu accordingly.
+    # From: Menus (top)
+    event(:_menu_bottom_)   { |name| Vedeu::Menus.use(name).bottom_item   }
+    event(:_menu_current_)  { |name| Vedeu::Menus.use(name).current_item  }
+    event(:_menu_deselect_) { |name| Vedeu::Menus.use(name).deselect_item }
+    event(:_menu_items_)    { |name| Vedeu::Menus.use(name).items         }
+    event(:_menu_next_)     { |name| Vedeu::Menus.use(name).next_item     }
+    event(:_menu_prev_)     { |name| Vedeu::Menus.use(name).prev_item     }
+    event(:_menu_selected_) { |name| Vedeu::Menus.use(name).selected_item }
+    event(:_menu_select_)   { |name| Vedeu::Menus.use(name).select_item   }
+    event(:_menu_top_)      { |name| Vedeu::Menus.use(name).top_item      }
+    event(:_menu_view_)     { |name| Vedeu::Menus.use(name).view          }
+
+    # System event to refresh all registered interfaces.
+    event(:_refresh_) { Vedeu::Refresh.all }
 
   end # Events
 

data/lib/vedeu/repositories/focus.rb

@@ -10,27 +10,20 @@ module Vedeu
     include Repository
     extend self
 
-    # System events which when called will change which interface is currently
-    # focussed. When the interface is brought into focus, its cursor position
-    # and visibility is restored.
-    Vedeu.event(:_focus_by_name_) { |name| Vedeu::Focus.by_name(name) }
-    Vedeu.event(:_focus_next_)    { Vedeu::Focus.next_item }
-    Vedeu.event(:_focus_prev_)    { Vedeu::Focus.prev_item }
-
     # Add an interface name to the focus list unless it is already registered.
     #
-    # @param attributes [String]
-    # @return [Array]
-    def add(attributes)
-      validate_attributes!(attributes)
-
-      return storage if registered?(attributes[:name])
+    # @param name [String] The name of the interface.
+    # @param focus [Boolean] When true, prepends the interface name to the
+    #   collection, making that interface the currently focussed interface.
+    # @return [Array] The collection of interface names.
+    def add(name, focus = false)
+      return storage if registered?(name)
 
-      if attributes[:focus]
-        storage.unshift(attributes[:name])
+      if focus
+        storage.unshift(name)
 
       else
-        storage.push(attributes[:name])
+        storage.push(name)
 
       end
     end
@@ -38,10 +31,10 @@ module Vedeu
     # Focus an interface by name.
     #
     # @param name [String]
-    # @raise [InterfaceNotFound] When the interface cannot be found.
+    # @raise [ModelNotFound] When the interface cannot be found.
     # @return [String]
     def by_name(name)
-      fail InterfaceNotFound unless storage.include?(name)
+      fail ModelNotFound unless registered?(name)
 
       storage.rotate!(storage.index(name))
 
@@ -54,11 +47,19 @@ module Vedeu
     #   make one focussed.
     # @return [String]
     def current
-      fail NoInterfacesDefined if storage.empty?
+      fail NoInterfacesDefined if empty?
 
       storage.first
     end
 
+    # Return the cursor for the currently focussed interface. May be hidden.
+    #
+    # @return [String] The escape sequence to render the cursor as shown or
+    #   hidden.
+    def cursor
+      Interface.new(Interfaces.find(current)).cursor.to_s
+    end
+
     # Returns a boolean indicating whether the named interface is focussed.
     #
     # @param name [String]
@@ -102,7 +103,7 @@ module Vedeu
     #
     # @return [String|FalseClass]
     def update
-      return false if storage.empty?
+      return false if empty?
 
       Vedeu.log("Interface in focus: '#{current}'")
 

data/lib/vedeu/repositories/groups.rb

@@ -31,10 +31,10 @@ module Vedeu
     # @param attributes [Hash]
     # @return [Boolean]
     def register_event(attributes)
-      name  = attributes[:group]
-      delay = attributes[:delay] || 0.0
+      group_name = attributes[:group]
+      delay      = attributes[:delay] || 0.0
 
-      Vedeu::Refresh.register_event(:by_group, name, delay)
+      Vedeu::Refresh.register_event(:by_group, group_name, delay)
     end
 
     # @return [Hash]
@@ -42,14 +42,6 @@ module Vedeu
       Hash.new { |hash, key| hash[key] = Set.new }
     end
 
-    # @param name [String]
-    # @raise [GroupNotFound] When the entity cannot be found with this name.
-    # @return [GroupNotFound]
-    def not_found(name)
-      fail GroupNotFound,
-        "Cannot find interface group with this name: #{name}."
-    end
-
   end # Groups
 
 end # Vedeu

data/lib/vedeu/repositories/interfaces.rb

@@ -29,7 +29,7 @@ module Vedeu
     # @param name [String]
     # @return [Interface]
     def build(name)
-      Interface.new(find(name))
+      model.new(find(name))
     end
 
     # Reset the interfaces repository; removing all registered interfaces.
@@ -53,6 +53,11 @@ module Vedeu
 
     private
 
+    # @return [Class] The model class for this repository.
+    def model
+      Vedeu::Interface
+    end
+
     # @see Vedeu::Refresh.register_event
     # @param attributes [Hash]
     # @return [Boolean]
@@ -68,14 +73,6 @@ module Vedeu
       {}
     end
 
-    # @param name [String]
-    # @raise [InterfaceNotFound] When the entity cannot be found with this name.
-    # @return [InterfaceNotFound]
-    def not_found(name)
-      fail InterfaceNotFound,
-        "Interface was not found with this name: #{name}."
-    end
-
   end # Interfaces
 
 end # Vedeu

data/lib/vedeu/repositories/keymaps.rb

@@ -119,7 +119,7 @@ module Vedeu
     # @example
     #   Vedeu.keypress('s')
     #
-    # @return [|FalseClass]
+    # @return [Array|FalseClass]
     def use(key)
       Vedeu.log("Key pressed: '#{key}'")
 
@@ -145,10 +145,15 @@ module Vedeu
 
     private
 
+    # @return [Class] The model class for this repository.
+    def model
+      Vedeu::Keymap
+    end
+
     # Triggers the system event defined for this key.
     #
     # @param key [String|Symbol]
-    # @return [] The result(s) of triggering the event.
+    # @return [Array] The result(s) of triggering the event.
     def system_key(key)
       action = Vedeu::Configuration.system_keys.key(key)
       event  = ['_', action, '_'].join.to_sym
@@ -160,7 +165,7 @@ module Vedeu
     #
     # @param attributes [Hash]
     # @param interface [String]
-    # @return []
+    # @return [Array]
     def register(attributes, interface = '_global_keymap_')
       attributes[:keys].map do |keymap|
         KeymapValidator.check(storage, keymap[:key], interface)

data/lib/vedeu/repositories/menus.rb

@@ -8,19 +8,6 @@ module Vedeu
     include Repository
     extend self
 
-    # System events which when called with the appropriate menu name will
-    # update the menu accordingly.
-    Vedeu.event(:_menu_current_)  { |name| Menus.use(name).current_item  }
-    Vedeu.event(:_menu_selected_) { |name| Menus.use(name).selected_item }
-    Vedeu.event(:_menu_next_)     { |name| Menus.use(name).next_item     }
-    Vedeu.event(:_menu_prev_)     { |name| Menus.use(name).prev_item     }
-    Vedeu.event(:_menu_top_)      { |name| Menus.use(name).top_item      }
-    Vedeu.event(:_menu_bottom_)   { |name| Menus.use(name).bottom_item   }
-    Vedeu.event(:_menu_select_)   { |name| Menus.use(name).select_item   }
-    Vedeu.event(:_menu_deselect_) { |name| Menus.use(name).deselect_item }
-    Vedeu.event(:_menu_items_)    { |name| Menus.use(name).items         }
-    Vedeu.event(:_menu_view_)     { |name| Menus.use(name).view          }
-
     # Stores the menu attributes defined by the API.
     #
     # @param attributes [Hash]
@@ -30,7 +17,7 @@ module Vedeu
 
       Vedeu.log("Registering menu: '#{attributes[:name]}'")
 
-      attributes.merge!({ items: Vedeu::Menu.new(attributes[:items]) })
+      attributes.merge!({ items: model.new(attributes[:items]) })
 
       storage.store(attributes[:name], attributes)
     end
@@ -45,6 +32,11 @@ module Vedeu
 
     private
 
+    # @return [Class] The model class for this repository.
+    def model
+      Vedeu::Menu
+    end
+
     # Returns an empty collection ready for the storing of menus by name with
     # associated menu instance.
     #
@@ -53,13 +45,6 @@ module Vedeu
       {}
     end
 
-    # @param name [String]
-    # @raise [MenuNotFound] When the entity cannot be found with this name.
-    # @return [MenuNotFound]
-    def not_found(name)
-      fail MenuNotFound, "Menu was not found with this name: #{name}."
-    end
-
   end # Menus
 
 end # Vedeu

data/lib/vedeu/{models → repositories/models}/buffer.rb

@@ -12,6 +12,8 @@ module Vedeu
   #
   class Buffer
 
+    include Model
+
     attr_reader :back, :front, :name, :previous
     alias_method :current, :front
 
@@ -28,28 +30,6 @@ module Vedeu
       @previous = @attributes[:previous]
     end
 
-    # Return a boolean indicating content on the front buffer.
-    #
-    # @return [Boolean]
-    def front?
-      front.any? { |k, v| k == :lines && v.any? }
-    end
-    alias_method :current?, :front?
-
-    # Return a boolean indicating content on the back buffer.
-    #
-    # @return [Boolean]
-    def back?
-      back.any? { |k, v| k == :lines && v.any? }
-    end
-
-    # Return a boolean indicating content on the previous buffer.
-    #
-    # @return [Boolean]
-    def previous?
-      previous.any? { |k, v| k == :lines && v.any? }
-    end
-
     # Add the content to the back buffer, then update the repository. Returns
     # boolean indicating that the repository was updated.
     #
@@ -58,7 +38,9 @@ module Vedeu
     def add(content = {})
       self.back = content
 
-      update!
+      store
+
+      true
     end
 
     # Return a boolean indicating content was swapped between buffers. It also
@@ -66,7 +48,7 @@ module Vedeu
     #
     # @return [Boolean]
     def swap
-      return false unless back?
+      return false unless content_for?(:back)
 
       # Offsets.update({ name: name })
 
@@ -74,16 +56,68 @@ module Vedeu
       self.front    = back
       self.back     = {}
 
-      update!
+      store
+
+      true
+    end
+
+    # Return the content for this buffer.
+    #
+    # - If we have new content (i.e. content on 'back') to be shown, we first
+    #   clear the area occupied by the previous content, then clear the area for
+    #   the new content, and then finally render the new content.
+    # - If there is no new content (i.e. 'back' is empty), check the 'front'
+    #   buffer and display that.
+    # - If there is no new content, and the front buffer is empty, display the
+    #   'previous' buffer.
+    # - If the 'previous' buffer is empty, return an empty hash.
+    #
+    # @return [Array<Hash>]
+    def content
+      if content_for?(:back)
+        swap
+
+        [clear_if_previous, front]
+
+      elsif content_for?(:front)
+        [front]
+
+      elsif content_for?(:previous)
+        [previous]
+
+      else
+        [{}]
+
+      end
     end
 
     private
 
     attr_writer :back, :front, :previous
 
-    # @see Buffers#update
-    def update!
-      Buffers.update(self)
+    def clear_if_previous
+      if content_for?(:previous)
+        previous
+
+      else
+        {}
+
+      end
+    end
+
+    # Return a boolean indicating content presence on the buffer type.
+    #
+    # @param buffer [Symbol] One of; :back, :current/:front or :previous.
+    # @return [Boolean] Whether the buffer targetted has content.
+    def content_for?(buffer)
+      public_send(buffer).any? do |k, v|
+        k == :lines && v && v.any?
+      end
+    end
+
+    # @return [Class] The repository class for this model.
+    def repository
+      Vedeu::Buffers
     end
 
     # Return the default attributes of a Buffer.