Module: Ferrum::Frame::Runtime

Included in:
Ferrum::Frame
Defined in:
lib/ferrum/frame/runtime.rb

Constant Summary collapse

INTERMITTENT_ATTEMPTS = 
ENV.fetch("FERRUM_INTERMITTENT_ATTEMPTS", 6).to_i
INTERMITTENT_SLEEP = 
ENV.fetch("FERRUM_INTERMITTENT_SLEEP", 0.1).to_f

Instance Method Summary collapse

Instance Method Details

#evaluate(expression, *args) ⇒ Object

Evaluate and return result for given JS expression.

Examples:

browser.evaluate("[window.scrollX, window.scrollY]")

Parameters:

  • expression (String) —

    The JavaScript to evaluate.

  • args (Array) —

    Additional arguments to pass to the JavaScript code.



31
32
33
34
 
# File 'lib/ferrum/frame/runtime.rb', line 31

def evaluate(expression, *args)
  expression = format("function() { return %s }", expression)
  call(expression: expression, arguments: args)
end

#evaluate_async(expression, wait, *args) ⇒ Object

Evaluate asynchronous expression and return result.

Examples:

browser.evaluate_async(%(arguments[0]({foo: "bar"})), 5) # => { "foo" => "bar" }

Parameters:

  • expression (String) —

    The JavaScript to evaluate.

  • wait (Integer) —

    How long we should wait for Promise to resolve or reject.

  • args (Array) —

    Additional arguments to pass to the JavaScript code.



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/ferrum/frame/runtime.rb', line 51

def evaluate_async(expression, wait, *args)
  template = "    function() {\n      return new Promise((__f, __r) => {\n        try {\n          arguments[arguments.length] = r => __f(r);\n          arguments.length = arguments.length + 1;\n          setTimeout(() => __r(new Error(\"timed out promise\")), %s);\n          %s\n        } catch(error) {\n          __r(error);\n        }\n      });\n    }\n  JS\n\n  expression = format(template, wait * 1000, expression)\n  call(expression: expression, arguments: args, awaitPromise: true)\nend\n"

#evaluate_func(expression, *args, on: nil) ⇒ Object 



89
90
91
 
# File 'lib/ferrum/frame/runtime.rb', line 89

def evaluate_func(expression, *args, on: nil)
  call(expression: expression, arguments: args, on: on)
end

#evaluate_on(node:, expression:, by_value: true, wait: 0) ⇒ Object 



93
94
95
96
97
98
 
# File 'lib/ferrum/frame/runtime.rb', line 93

def evaluate_on(node:, expression:, by_value: true, wait: 0)
  options = { handle: true }
  expression = format("function() { return %s }", expression)
  options = { handle: false, returnByValue: true } if by_value
  call(expression: expression, on: node, wait: wait, **options)
end

#execute(expression, *args) ⇒ Object

Execute expression. Doesn’t return the result.

Examples:

browser.execute(%(1 + 1)) # => true

Parameters:

  • expression (String) —

    The JavaScript to evaluate.

  • args (Array) —

    Additional arguments to pass to the JavaScript code.



83
84
85
86
87
 
# File 'lib/ferrum/frame/runtime.rb', line 83

def execute(expression, *args)
  expression = format("function() { %s }", expression)
  call(expression: expression, arguments: args, handle: false, returnByValue: true)
  true
end