Module: SitePrism::Loadable

Included in:
Page, Section
Defined in:
lib/site_prism/loadable.rb

Defined Under Namespace

Modules: ClassMethods

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#load_error ⇒ Object

In certain circumstances, we cache that the page has already been confirmed to be loaded so that actions which call ‘loaded?` a second time do not need to perform the load_validation queries against the page a second time.



47
48
49
 
# File 'lib/site_prism/loadable.rb', line 47

def load_error
  @load_error
end

#loaded ⇒ Object

In certain circumstances, we cache that the page has already been confirmed to be loaded so that actions which call ‘loaded?` a second time do not need to perform the load_validation queries against the page a second time.



47
48
49
 
# File 'lib/site_prism/loadable.rb', line 47

def loaded
  @loaded
end

Class Method Details

.included(base) ⇒ Object 



39
40
41
 
# File 'lib/site_prism/loadable.rb', line 39

def self.included(base)
  base.extend(ClassMethods)
end

Instance Method Details

#loaded? ⇒ Boolean

Check if the page is loaded.

On failure, if an error was reported by a failing validation, it will be available via the ‘load_error` accessor.

Returns:

  • (Boolean) —

    True if the page loaded successfully; otherwise false.



79
80
81
82
83
84
85
 
# File 'lib/site_prism/loadable.rb', line 79

def loaded?
  self.load_error = nil

  return true if loaded

  load_validations_pass?
end

#when_loaded(&_block) ⇒ Object

Executes the given block after the page is loaded.

The loadable object instance is yielded into the block.

has finished loading.

Parameters:

  • block (&block) —

    The block to be executed once the page



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/site_prism/loadable.rb', line 55

def when_loaded(&_block)
  # Get original loaded value, in case we are nested
  # inside another when_loaded block.
  previously_loaded = loaded
  message = 'A block was expected, but none received.'
  raise ArgumentError, message unless block_given?

  # Within the block, cache loaded? to optimize performance.
  self.loaded = loaded?

  message = "Failed to load because: #{load_error || 'no reason given'}"
  raise ::SitePrism::NotLoadedError, message unless loaded

  yield self
ensure
  self.loaded = previously_loaded
end