Contents

module Vedeu

  # Refreshes the terminal.
  #
  module Refresh

    module_function

    # Refresh all registered interfaces.
    #
    # @return [Array]
    def all
      message = 'Refreshing all interfaces'

      Vedeu::Timer.for(:info, message) do
        Vedeu.interfaces.registered.each { |name| by_name(name) }
      end
    end

    # Refresh the interface which is currently focussed.
    #
    # @return [Array|ModelNotFound|NilClass]
    def by_focus
      by_name(Vedeu.focus) if Vedeu.focus
    end

    # Refresh an interface, or collection of interfaces belonging to a group.
    #
    # @param group_name [String] The name of the group to be refreshed.
    # @return [Array|ModelNotFound] A collection of the names of interfaces
    #   refreshed, or an exception if the group was not found.
    def by_group(group_name)
      message = "Refreshing group: '#{group_name}'"

      Vedeu::Timer.for(:info, message) do
        Vedeu.groups.find!(group_name).members.each { |name| by_name(name) }
      end
    end

    # Refresh an interface by name.
    #
    # @param name [String] The name of the interface to be refreshed using the
    #   named buffer.
    # @return [Array|ModelNotFound]
    def by_name(name)
      message = "Refreshing interface: '#{name}'"

      Vedeu::Timer.for(:info, message) { Vedeu.buffers.by_name(name).render }
    end

  end # Refresh

end # Vedeu

Version data entries

3 entries across 3 versions & 1 rubygems

Version	Path
vedeu-0.4.26	lib/vedeu/output/refresh.rb
vedeu-0.4.25	lib/vedeu/output/refresh.rb
vedeu-0.4.24	lib/vedeu/output/refresh.rb