Module: UiDelta

Defined in:
lib/ui_delta.rb,
lib/ui_delta/dsl.rb,
lib/ui_delta/utils.rb,
lib/ui_delta/runner.rb,
lib/ui_delta/version.rb,
lib/ui_delta/uploader.rb,
lib/ui_delta/run_details.rb,
lib/ui_delta/dummy_runner.rb,
lib/ui_delta/uploaders/concurrent.rb,
lib/ui_delta/uploaders/sequential.rb

Defined Under Namespace

Modules: Dsl, Uploaders, Utils Classes: DummyRunner, RunDetails, Runner, Uploader

Constant Summary collapse

VERSION = 
"0.5.3"
@@base_uri =

configure domain to which all images have to be uploaded.

"https://ui-delta.fly.dev"
@@project_name =

configure project name to which images belong to.

"idf"
@@api_key =

configure api_key required to authorize api access

''
@@javascript_driver =

configure js driver which is used for taking screenshots.

"poltergeist"
@@enable_service =

configure service to be mocked so that no screenshots are taken, and uploaded to service.

false
@@logger =

configure logger, which will be used to log issues if any

Logger.new(STDOUT)

Class Method Summary collapse

Class Method Details

.api_key ⇒ Object 



32
33
34
 
# File 'lib/ui_delta.rb', line 32

def self.api_key
  @@api_key
end

.api_key=(key) ⇒ Object 



29
30
31
 
# File 'lib/ui_delta.rb', line 29

def self.api_key=(key)
  @@api_key = key
end

.base_uri ⇒ Object 



14
15
16
 
# File 'lib/ui_delta.rb', line 14

def self.base_uri
  @@base_uri
end

.base_uri=(uri) ⇒ Object 



11
12
13
 
# File 'lib/ui_delta.rb', line 11

def self.base_uri=(uri)
  @@base_uri = uri
end

.configure {|_self| ... } ⇒ Object

helper to configure above variables.

Yields:

  • (_self)

Yield Parameters:

  • _self (UiDelta) —

    the object that the method was called on



65
66
67
 
# File 'lib/ui_delta.rb', line 65

def self.configure
  yield(self)
end

.enable_service ⇒ Object 



51
52
53
 
# File 'lib/ui_delta.rb', line 51

def self.enable_service
  @@enable_service
end

.enable_service=(enable) ⇒ Object 



48
49
50
 
# File 'lib/ui_delta.rb', line 48

def self.enable_service=(enable)
  @@enable_service = enable
end

.javascript_driver ⇒ Object 



41
42
43
 
# File 'lib/ui_delta.rb', line 41

def self.javascript_driver
  @@javascript_driver
end

.javascript_driver=(driver) ⇒ Object 



38
39
40
 
# File 'lib/ui_delta.rb', line 38

def self.javascript_driver=(driver)
  @@javascript_driver = driver
end

.logger ⇒ Object 



60
61
62
 
# File 'lib/ui_delta.rb', line 60

def self.logger
  @@logger
end

.logger=(new_logger) ⇒ Object 



57
58
59
 
# File 'lib/ui_delta.rb', line 57

def self.logger=(new_logger)
  @@logger = new_logger
end

.project_name ⇒ Object 



23
24
25
 
# File 'lib/ui_delta.rb', line 23

def self.project_name
  @@project_name
end

.project_name=(name) ⇒ Object 



20
21
22
 
# File 'lib/ui_delta.rb', line 20

def self.project_name=(name)
  @@project_name = name
end

.start_run ⇒ Object

helps in setting up the run



70
71
72
 
# File 'lib/ui_delta.rb', line 70

def self.start_run
  UiDelta::Dsl.ui_delta.start_run
end

.wrap_run ⇒ Object

helps in wrapping up run by uploading images



75
76
77
 
# File 'lib/ui_delta.rb', line 75

def self.wrap_run
  UiDelta::Dsl.ui_delta.wrap_run
end