Class: Vedeu::Buffers::Refresh

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

Overview

Refreshes the given named interface.

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Common

#absent?, #array?, #boolean, #boolean?, #empty_value?, #escape?, #falsy?, #hash?, #line_model?, #numeric?, #positionable?, #present?, #snake_case, #stream_model?, #string?, #symbol?, #truthy?, #view_model?

Constructor Details

#initialize(name, options = {}) ⇒ Vedeu::Buffers::Refresh

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

Parameters:

  • name (NilClass|Symbol|String) —

    The name of the model or target model to act upon. May default to ‘Vedeu.focus`.

  • options (Hash<Symbol => Boolean>) (defaults to: {})

Options Hash (options):



37
38
39
40
 
# File 'lib/vedeu/buffers/refresh.rb', line 37

def initialize(name, options = {})
  @name    = name
  @options = options
end

Class Method Details

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

Parameters:

  • name (NilClass|Symbol|String) (defaults to: Vedeu.focus) —

    The name of the model or target model to act upon. May default to ‘Vedeu.focus`.

  • options (Hash<Symbol => Boolean>)

Returns:



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

def self.by_name(name = Vedeu.focus)
  name ||= Vedeu.focus

  new(name).by_name
end

.refresh_content_by_name(name = Vedeu.focus) ⇒ Array|Vedeu::Error::ModelNotFound

Parameters:

  • name (NilClass|Symbol|String) (defaults to: Vedeu.focus) —

    The name of the model or target model to act upon. May default to ‘Vedeu.focus`.

  • options (Hash<Symbol => Boolean>)

Returns:



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

def self.refresh_content_by_name(name = Vedeu.focus)
  name ||= Vedeu.focus

  new(name, content_only: true).by_name
end

Instance Method Details

#buffer ⇒ Vedeu::Buffers::Buffer (private)

Returns:



54
55
56
 
# File 'lib/vedeu/buffers/refresh.rb', line 54

def buffer
  Vedeu.buffers.by_name(name)
end

#by_name ⇒ Array|Vedeu::Error::ModelNotFound

Returns:



43
44
45
46
47
48
49
 
# File 'lib/vedeu/buffers/refresh.rb', line 43

def by_name
  Vedeu.trigger(:_clear_view_content_, name)

  buffer.render

  Vedeu.trigger(:_refresh_border_, name) unless content_only?
end

#content_only? ⇒ Boolean (private)

Returns:



59
60
61
 
# File 'lib/vedeu/buffers/refresh.rb', line 59

def content_only?
  truthy?(options[:content_only])
end

#defaults ⇒ Hash<Symbol => void> (private)

The default options/attributes for a new instance of this class.

Returns:

  • (Hash<Symbol => void>) 


74
75
76
77
78
 
# File 'lib/vedeu/buffers/refresh.rb', line 74

def defaults
  {
    content_only: false,
  }
end

#name ⇒ String|Symbol (private)

Returns:

  • (String|Symbol) 


64
65
66
 
# File 'lib/vedeu/buffers/refresh.rb', line 64

def name
  present?(@name) ? @name : Vedeu.focus
end

#options ⇒ Hash<Symbol => Boolean> (private)

Returns:



69
70
71
 
# File 'lib/vedeu/buffers/refresh.rb', line 69

def options
  defaults.merge!(@options)
end