Class: Vedeu::Buffers::Refresh

Inherits:
Object
  • Object
show all
Includes:
Common
Defined in:
lib/vedeu/buffers/refresh.rb

Overview

Refreshes the given named interface.

Examples:

Vedeu.trigger(:_refresh_, name)

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Common

#demodulize, #present?, #snake_case

Constructor Details

#initialize(name) ⇒ Vedeu::Buffers::Refresh

Return a new instance of Vedeu::Buffers::Refresh.

Parameters:

  • name (String) 


25
26
27
 
# File 'lib/vedeu/buffers/refresh.rb', line 25

def initialize(name)
  @name = name
end

Instance Attribute Details

#name ⇒ String (readonly, protected)

# @!attribute [r] name

Returns:

  • (String) 


40
41
42
 
# File 'lib/vedeu/buffers/refresh.rb', line 40

def name
  @name
end

Class Method Details

.by_name(name) ⇒ Array|Vedeu::Error::ModelNotFound

Parameters:

  • name (String) —

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

Returns:



17
18
19
 
# File 'lib/vedeu/buffers/refresh.rb', line 17

def self.by_name(name)
  new(name).by_name
end

Instance Method Details

#buffer_name ⇒ String (private)

Returns:

  • (String)

Raises:



47
48
49
50
51
52
 
# File 'lib/vedeu/buffers/refresh.rb', line 47

def buffer_name
  return name if present?(name)

  fail Vedeu::Error::MissingRequired,
       'Cannot refresh interface with an empty interface name.'
end

#by_name ⇒ void

This method returns an undefined value.



30
31
32
33
34
 
# File 'lib/vedeu/buffers/refresh.rb', line 30

def by_name
  Vedeu.timer("Refresh Buffer: '#{buffer_name}'") do
    Vedeu.buffers.by_name(buffer_name).render
  end
end