Module: Vedeu::Refresh

Extended by:
Refresh
Included in:
Refresh
Defined in:
lib/vedeu/output/refresh.rb

Overview

Refreshes the terminal.

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.all ⇒ Array

Refresh all registered interfaces.

Returns:

  • (Array) 


12
13
14
 
# File 'lib/vedeu/output/refresh.rb', line 12

def all
  Vedeu.interfaces.registered.each { |name| by_name(name) }
end

.by_focus ⇒ Array|ModelNotFound|NilClass

Refresh the interface which is currently focussed.

Returns:

  • (Array|ModelNotFound|NilClass) 


19
20
21
 
# File 'lib/vedeu/output/refresh.rb', line 19

def by_focus
  by_name(Vedeu.focus) if Vedeu.focus
end

.by_group(group_name) ⇒ Array|ModelNotFound

Refresh an interface, or collection of interfaces belonging to a group.

Parameters:

  • group_name (String) —

    The name of the group to be refreshed.

Returns:

  • (Array|ModelNotFound) —

    A collection of the names of interfaces refreshed, or an exception if the group was not found.



28
29
30
31
32
 
# File 'lib/vedeu/output/refresh.rb', line 28

def by_group(group_name)
  Vedeu.log(type: :info, message: "Refreshing group: '#{group_name}'")

  Vedeu.groups.find(group_name).members.each { |name| by_name(name) }
end

.by_name(name) ⇒ Array|ModelNotFound

Refresh an interface by name.

Parameters:

  • name (String) —

    The name of the interface to be refreshed using the named buffer.

Returns:

  • (Array|ModelNotFound) 


39
40
41
42
43
 
# File 'lib/vedeu/output/refresh.rb', line 39

def by_name(name)
  Vedeu.log(type: :info, message: "Refreshing interface: '#{name}'")

  Vedeu::Compositor.compose(name)
end

Instance Method Details

#all ⇒ Array

Refresh all registered interfaces.

Returns:

  • (Array) 


12
13
14
 
# File 'lib/vedeu/output/refresh.rb', line 12

def all
  Vedeu.interfaces.registered.each { |name| by_name(name) }
end

#by_focus ⇒ Array|ModelNotFound|NilClass

Refresh the interface which is currently focussed.

Returns:

  • (Array|ModelNotFound|NilClass) 


19
20
21
 
# File 'lib/vedeu/output/refresh.rb', line 19

def by_focus
  by_name(Vedeu.focus) if Vedeu.focus
end

#by_group(group_name) ⇒ Array|ModelNotFound

Refresh an interface, or collection of interfaces belonging to a group.

Parameters:

  • group_name (String) —

    The name of the group to be refreshed.

Returns:

  • (Array|ModelNotFound) —

    A collection of the names of interfaces refreshed, or an exception if the group was not found.



28
29
30
31
32
 
# File 'lib/vedeu/output/refresh.rb', line 28

def by_group(group_name)
  Vedeu.log(type: :info, message: "Refreshing group: '#{group_name}'")

  Vedeu.groups.find(group_name).members.each { |name| by_name(name) }
end

#by_name(name) ⇒ Array|ModelNotFound

Refresh an interface by name.

Parameters:

  • name (String) —

    The name of the interface to be refreshed using the named buffer.

Returns:

  • (Array|ModelNotFound) 


39
40
41
42
43
 
# File 'lib/vedeu/output/refresh.rb', line 39

def by_name(name)
  Vedeu.log(type: :info, message: "Refreshing interface: '#{name}'")

  Vedeu::Compositor.compose(name)
end