Module: MagicTest::Support

Defined in:
lib/magic_test/support.rb

Instance Method Summary collapse

Instance Method Details

#assert_selected_existsObject



3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
# File 'lib/magic_test/support.rb', line 3

def assert_selected_exists
  selected_text = page.evaluate_script("window.selectedText()")
  return if selected_text.blank?

  # TODO this feels like it's going to end up burning people who have other support files in `test` or `spec` that don't include `helper` in the name.
  filepath, line = caller.select { |s| s.include?("/test/") || s.include?("/spec/") }.reject { |s| s.include?("helper") }.first.split(":")

  contents = File.open(filepath).read.lines
  chunks = contents.each_slice(line.to_i - 1 + @test_lines_written).to_a
  indentation = chunks[1].first.match(/^(\s*)/)[0]
  chunks.first << indentation + "assert(page.has_content?('#{selected_text.gsub("'", "\\\\'")}'))" + "\n"
  @test_lines_written += 1
  contents = chunks.flatten.join
  File.open(filepath, "w") do |file|
    file.puts(contents)
  end
end

#empty_cacheObject



86
87
88
89
90
91
# File 'lib/magic_test/support.rb', line 86

def empty_cache
  page.evaluate_script("sessionStorage.setItem('testingOutput', JSON.stringify([]))")
rescue Capybara::NotSupportedByDriverError => _
  # TODO we need to add more robust instructions for this.
  raise "You need to configure this test (or your test suite) to run in a real browser (Chrome, Firefox, etc.) in order for Magic Test to work. It also needs to run in non-headless mode if `ENV['MAGIC_TEST'].present?`"
end

#flushObject



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
# File 'lib/magic_test/support.rb', line 41

def flush
  filepath, line = caller.select { |s| s.include?("/test/") }.reject { |s| s.include?("helper") }.first.split(":")
  contents = File.open(filepath).read.lines
  chunks = contents.each_slice(line.to_i - 1 + @test_lines_written).to_a
  indentation = chunks[1].first.match(/^(\s*)/)[0]
  output = page.evaluate_script("JSON.parse(sessionStorage.getItem('testingOutput'))")
  puts
  puts "javascript recorded on the front-end looks like this:"
  puts output
  puts
  puts "(writing that to `#{filepath}`.)"
  if output
    output.each do |last|
      chunks.first << indentation + "#{last["action"]} #{last["target"]}#{last["options"]}" + "\n"
      @test_lines_written += 1
    end
    contents = chunks.flatten.join
    File.open(filepath, "w") do |file|
      file.puts(contents)
    end
    # clear the testing output now.
    empty_cache
  else
    puts "`window.testingOutput` was empty in the browser. Something must be wrong on the browser side."
  end
  true
end

#get_lastObject



25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
# File 'lib/magic_test/support.rb', line 25

def get_last
  history_lines = Readline::HISTORY.to_a.last(20)
  i = 2
  last = history_lines.last(2).first
  last_block = [last]
  if last == "end" || last.first(4) == "end "
    i += 1
    last_block.unshift(history_lines.last(i).first)
    until !last_block.first.match(/^(\s+)/) & [0]
      i += 1
      last_block.unshift(history_lines.last(i).first)
    end
  end
  last_block
end

#magic_testObject



93
94
95
96
97
98
99
100
101
102
# File 'lib/magic_test/support.rb', line 93

def magic_test
  empty_cache
  @test_lines_written = 0
  begin
    # 👋 This isn't helpful context. Type `up` and hit enter to see where you really are.
    binding.pry
  rescue
    retry
  end
end

#okObject



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
# File 'lib/magic_test/support.rb', line 69

def ok
  filepath, line = caller.select { |s| s.include?("/test/") }.reject { |s| s.include?("helper") }.first.split(":")
  puts "(writing that to `#{filepath}`.)"
  contents = File.open(filepath).read.lines
  chunks = contents.each_slice(line.to_i - 1 + @test_lines_written).to_a
  indentation = chunks[1].first.match(/^(\s*)/)[0]
  get_last.each do |last|
    chunks.first << indentation + last + "\n"
    @test_lines_written += 1
  end
  contents = chunks.flatten.join
  File.open(filepath, "w") do |file|
    file.puts(contents)
  end
  true
end

#track_keystrokesObject



21
22
23
# File 'lib/magic_test/support.rb', line 21

def track_keystrokes
  page.evaluate_script("trackKeystrokes()")
end