Class: Ferrum::Browser::Command

Inherits:
Object
  • Object
show all
Defined in:
lib/ferrum/browser/command.rb

Constant Summary collapse

NOT_FOUND =
"Could not find an executable for the browser. Try to make " \
"it available on the PATH or set environment variable for " \
"example BROWSER_PATH=\"/usr/bin/chrome\"".freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(defaults, options, user_data_dir) ⇒ Command

Returns a new instance of Command.

Raises:

  • (Cliver::Dependency::NotFound)


27
28
29
30
31
32
33
34
# File 'lib/ferrum/browser/command.rb', line 27

def initialize(defaults, options, user_data_dir)
  @flags = {}
  @defaults = defaults
  @options, @user_data_dir = options, user_data_dir
  @path = options[:browser_path] || ENV["BROWSER_PATH"] || defaults.detect_path
  raise Cliver::Dependency::NotFound.new(NOT_FOUND) unless @path
  merge_options
end

Instance Attribute Details

#defaultsObject (readonly)

Returns the value of attribute defaults.



25
26
27
# File 'lib/ferrum/browser/command.rb', line 25

def defaults
  @defaults
end

#optionsObject (readonly)

Returns the value of attribute options.



25
26
27
# File 'lib/ferrum/browser/command.rb', line 25

def options
  @options
end

#pathObject (readonly)

Returns the value of attribute path.



25
26
27
# File 'lib/ferrum/browser/command.rb', line 25

def path
  @path
end

Class Method Details

.build(options, user_data_dir) ⇒ Object

Currently only these browsers support CDP: github.com/cyrus-and/chrome-remote-interface#implementations



12
13
14
15
16
17
18
19
20
21
22
23
# File 'lib/ferrum/browser/command.rb', line 12

def self.build(options, user_data_dir)
  defaults = case options[:browser_name]
             when :firefox
               Options::Firefox.options
             when :chrome, :opera, :edge, nil
               Options::Chrome.options
             else
               raise NotImplementedError, "not supported browser"
             end

  new(defaults, options, user_data_dir)
end

Instance Method Details

#to_aObject



40
41
42
# File 'lib/ferrum/browser/command.rb', line 40

def to_a
  [path] + @flags.map { |k, v| v.nil? ? "--#{k}" : "--#{k}=#{v}" }
end

#xvfb?Boolean

Returns:

  • (Boolean)


36
37
38
# File 'lib/ferrum/browser/command.rb', line 36

def xvfb?
  !!options[:xvfb]
end