Module: Vizzly

Defined in:

lib/vizzly.rb

Overview

Vizzly visual regression testing client

Defined Under Namespace

Classes: Client, Error

Constant Summary

DEFAULT_TDD_PORT =

Default port for local TDD server

47392

Class Method Summary

• .client ⇒ Client

  Get or create the shared client instance.

• .flush ⇒ Object

  Flush the shared client.

• .ready? ⇒ Boolean

  Check if the shared client is ready.

• .reset! ⇒ Object

  Reset the shared client (useful for testing).

• .screenshot(name, image_data, options = {}) ⇒ Object

  Take a screenshot using the shared client.

Class Method Details

.client ⇒ Client

Get or create the shared client instance

Returns:

• (Client)

# File 'lib/vizzly.rb', line 227

def client
  @client ||= Client.new
end

.flush ⇒ Object

Flush the shared client

See Also:

• Vizzly::Client#flush

# File 'lib/vizzly.rb', line 241

def flush
  client.flush
end

.ready? ⇒ Boolean

Check if the shared client is ready

Returns:

• (Boolean)

See Also:

• Vizzly::Client#ready?

# File 'lib/vizzly.rb', line 248

def ready?
  client.ready?
end

.reset! ⇒ Object

Reset the shared client (useful for testing)

# File 'lib/vizzly.rb', line 253

def reset!
  @client = nil
end

.screenshot(name, image_data, options = {}) ⇒ Object

Take a screenshot using the shared client

See Also:

• Vizzly::Client#screenshot

# File 'lib/vizzly.rb', line 234

def screenshot(name, image_data, options = {})
  client.screenshot(name, image_data, options)
end