Module: SnapshotUI

Defined in:
lib/snapshot_ui.rb,
lib/snapshot_ui/cli.rb,
lib/snapshot_ui/web.rb,
lib/snapshot_ui/version.rb,
lib/snapshot_ui/colorize.rb,
lib/snapshot_ui/snapshot.rb,
lib/snapshot_ui/configuration.rb,
lib/snapshot_ui/web/application.rb,
lib/snapshot_ui/snapshot/context.rb,
lib/snapshot_ui/snapshot/storage.rb,
lib/snapshot_ui/test/minitest_helpers.rb

Defined Under Namespace

Modules: Colorize, Test Classes: CLI, Configuration, Snapshot, Web

Constant Summary collapse

DEFAULT_CONFIGURATION = 
{
  project_root_directory: nil,
  storage_directory: nil,
  web_url: "http://localhost:3000/ui/snapshots",
  live_websocket_url: "http://localhost:49152/live"
}.freeze
VERSION = 
"0.4.1"

Class Method Summary collapse

Class Method Details

.clear_snapshots ⇒ Object 



38
39
40
41
42
 
# File 'lib/snapshot_ui.rb', line 38

def self.clear_snapshots
  exit_if_not_configured!

  Snapshot.clear_snapshots
end

.clear_snapshots_in_progress ⇒ Object 



32
33
34
35
36
 
# File 'lib/snapshot_ui.rb', line 32

def self.clear_snapshots_in_progress
  exit_if_not_configured!

  Snapshot.clear_snapshots_in_progress
end

.configuration ⇒ Object 



18
19
20
 
# File 'lib/snapshot_ui.rb', line 18

def self.configuration
  @configuration ||= Configuration.new(**DEFAULT_CONFIGURATION)
end

.configure {|configuration| ... } ⇒ Object

Yields:



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

def self.configure
  yield(configuration)
end

.exit_if_not_configured! ⇒ Object 



44
45
46
 
# File 'lib/snapshot_ui.rb', line 44

def self.exit_if_not_configured!
  configuration.exit_if_not_configured!
end

.publish_snapshots_in_progress ⇒ Object 



26
27
28
29
30
 
# File 'lib/snapshot_ui.rb', line 26

def self.publish_snapshots_in_progress
  exit_if_not_configured!

  Snapshot.publish_snapshots_in_progress
end

.snapshot_taking_enabled? ⇒ Boolean

Returns:

  • (Boolean) 


22
23
24
 
# File 'lib/snapshot_ui.rb', line 22

def self.snapshot_taking_enabled?
  %w[1 true].include?(ENV["TAKE_SNAPSHOTS"])
end