Module: Selenium::WebDriver::Platform Private

Defined in:

lib/selenium/webdriver/common/platform.rb

This module is part of a private API. You should avoid using this module if possible, as it may be removed or be changed in the future.

Class Method Summary

• .assert_executable(path) ⇒ Object private
• .bitsize ⇒ Object private
• .cygwin? ⇒ Boolean private
• .cygwin_path(path, opts = {}) ⇒ Object private
• .engine ⇒ Object private
• .find_binary(*binary_names) ⇒ Object private
• .home ⇒ Object private
• .ironruby? ⇒ Boolean private
• .jruby? ⇒ Boolean private
• .linux? ⇒ Boolean private
• .localhost ⇒ Object private
• .mac? ⇒ Boolean private
• .make_writable(file) ⇒ Object private
• .os ⇒ Object private
• .ruby187? ⇒ Boolean private
• .ruby19? ⇒ Boolean private
• .win? ⇒ Boolean private
• .wrap_in_quotes_if_necessary(str) ⇒ Object private

Class Method Details

.assert_executable(path) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

# File 'lib/selenium/webdriver/common/platform.rb', line 106

def assert_executable(path)
  unless File.file? path
    raise Error::WebDriverError, "not a file: #{path.inspect}"
  end

  unless File.executable? path
    raise Error::WebDriverError, "not executable: #{path.inspect}"
  end
end

.bitsize ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

# File 'lib/selenium/webdriver/common/platform.rb', line 45

def bitsize
  @bitsize ||= (
    if defined?(FFI::BITSIZE)
      FFI::BITSIZE
    elsif defined?(FFI)
      FFI.type_size(:pointer) == 4 ? 32 : 64
    elsif jruby?
      Integer(ENV_JAVA['sun.arch.data.model'])
    else
      1.size == 4 ? 32 : 64
    end
  )
end

.cygwin? ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

• (Boolean)

# File 'lib/selenium/webdriver/common/platform.rb', line 87

def cygwin?
  !!(RUBY_PLATFORM =~ /cygwin/)
end

.cygwin_path(path, opts = {}) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

# File 'lib/selenium/webdriver/common/platform.rb', line 95

def cygwin_path(path, opts = {})
  flags = []
  opts.each { |k,v| flags << "--#{k}" if v }

  `cygpath #{flags.join ' '} "#{path}"`.strip
end

.engine ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

# File 'lib/selenium/webdriver/common/platform.rb', line 17

def engine
  @engine ||= (
    if defined? RUBY_ENGINE
      RUBY_ENGINE.to_sym
    else
      :ruby
    end
  )
end

.find_binary(*binary_names) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

# File 'lib/selenium/webdriver/common/platform.rb', line 116

def find_binary(*binary_names)
  paths = ENV['PATH'].split(File::PATH_SEPARATOR)
  binary_names.map! { |n| "#{n}.exe" } if win?

  binary_names.each do |binary_name|
    paths.each do |path|
      exe = File.join(path, binary_name)
      return exe if File.executable?(exe)
    end
  end

  nil
end

.home ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

# File 'lib/selenium/webdriver/common/platform.rb', line 12

def home
  # jruby has an issue with ENV['HOME'] on Windows
  @home ||= jruby? ? ENV_JAVA['user.home'] : ENV['HOME']
end

.ironruby? ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

• (Boolean)

# File 'lib/selenium/webdriver/common/platform.rb', line 63

def ironruby?
  engine == :ironruby
end

.jruby? ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

• (Boolean)

# File 'lib/selenium/webdriver/common/platform.rb', line 59

def jruby?
  engine == :jruby
end

.linux? ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

• (Boolean)

# File 'lib/selenium/webdriver/common/platform.rb', line 83

def linux?
  os == :linux
end

.localhost ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

# File 'lib/selenium/webdriver/common/platform.rb', line 130

def localhost
  info = Socket.getaddrinfo "localhost", 80, Socket::AF_INET, Socket::SOCK_STREAM

  if info.empty?
    raise Error::WebDriverError, "unable to translate 'localhost' for TCP+IPv6"
  end

  info[0][3]
end

.mac? ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

• (Boolean)

# File 'lib/selenium/webdriver/common/platform.rb', line 79

def mac?
  os == :macosx
end

.make_writable(file) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

# File 'lib/selenium/webdriver/common/platform.rb', line 102

def make_writable(file)
  File.chmod 0766, file
end

.os ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

# File 'lib/selenium/webdriver/common/platform.rb', line 27

def os
  @os ||= (
    host_os = RbConfig::CONFIG['host_os']
    case host_os
    when /mswin|msys|mingw|cygwin|bccwin|wince|emc/
      :windows
    when /darwin|mac os/
      :macosx
    when /linux/
      :linux
    when /solaris|bsd/
      :unix
    else
      raise Error::WebDriverError, "unknown os: #{host_os.inspect}"
    end
  )
end

.ruby187? ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

• (Boolean)

# File 'lib/selenium/webdriver/common/platform.rb', line 67

def ruby187?
  !!(RUBY_VERSION =~ /^1\.8\.7/)
end

.ruby19? ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

• (Boolean)

# File 'lib/selenium/webdriver/common/platform.rb', line 71

def ruby19?
  !!(RUBY_VERSION =~ /^1\.9/)
end

.win? ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

• (Boolean)

# File 'lib/selenium/webdriver/common/platform.rb', line 75

def win?
  os == :windows
end

.wrap_in_quotes_if_necessary(str) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

# File 'lib/selenium/webdriver/common/platform.rb', line 91

def wrap_in_quotes_if_necessary(str)
  win? && !cygwin? ? %{"#{str}"} : str
end