module ActionDispatch::SystemTesting::TestHelpers::ScreenshotHelper

def absolute_html_path 

def absolute_html_path
  "#{absolute_path}.html"
end

def absolute_image_path 

def absolute_image_path
  "#{absolute_path}.png"
end

def absolute_path 

def absolute_path
  Rails.root.join(screenshots_dir, image_name)
end

def display_image 

def display_image
  message = +"[Screenshot Image]: #{image_path}\n"
  message << +"[Screenshot HTML]: #{html_path}\n" if save_html?
  case output_type
  when "artifact"
    message << "\e]1338;url=artifact://#{absolute_image_path}\a\n"
  when "inline"
    name = inline_base64(File.basename(absolute_image_path))
    image = inline_base64(File.read(absolute_image_path))
    message << "\e]1337;File=name=#{name};height=400px;inline=1:#{image}\a\n"
  end
  message
end

def failed? 

def failed?
  !passed? && !skipped?
end

def html_path 

def html_path
  absolute_html_path.to_s
end

def image_name 

def image_name
  sanitized_method_name = method_name.tr("/\\", "--")
  name = "#{unique}_#{sanitized_method_name}"
  name[0...225]
end

def image_path 

def image_path
  absolute_image_path.to_s
end

def increment_unique 

def increment_unique
  @_screenshot_counter ||= 0
  @_screenshot_counter += 1
end

def inline_base64(path) 

def inline_base64(path)
  Base64.strict_encode64(path)
end

def output_type 

def output_type
  # Environment variables have priority
  output_type = ENV["RAILS_SYSTEM_TESTING_SCREENSHOT"] || ENV["CAPYBARA_INLINE_SCREENSHOT"]
  # Default to outputting a path to the screenshot
  output_type ||= "simple"
  output_type
end

def save_html 

def save_html
  page.save_page(absolute_html_path)
end

def save_html? 

def save_html?
  ENV["RAILS_SYSTEM_TESTING_SCREENSHOT_HTML"] == "1"
end

def save_image 

def save_image
  page.save_screenshot(absolute_image_path)
end

def screenshots_dir 

def screenshots_dir
  Capybara.save_path.presence || "tmp/screenshots"
end

def supports_screenshot? 

def supports_screenshot?
  Capybara.current_driver != :rack_test
end

def take_failed_screenshot

+take_failed_screenshot+ is called during system test teardown.

failed.
Takes a screenshot of the current page in the browser if the test 
def take_failed_screenshot
  take_screenshot if failed? && supports_screenshot? && Capybara::Session.instance_created?
end

def take_screenshot

artifact format (https://buildkite.github.io/terminal-to-html/inline-images/).
* [+artifact+] Display the screenshot in the terminal, using the terminal
iTerm image protocol (https://iterm2.com/documentation-images.html).
* [+inline+] Display the screenshot in the terminal using the
This is the default value.
* [+simple+ (default)] Only displays the screenshot path.
control the output. Possible values are:
You can set the +RAILS_SYSTEM_TESTING_SCREENSHOT+ environment variable to

elements on the page at the time of the screenshot
save the HTML from the page that is being screenshotted so you can investigate the
You can set the +RAILS_SYSTEM_TESTING_SCREENSHOT_HTML+ environment variable to

one with +Capybara.save_path+
The default screenshots directory is +tmp/screenshots+ but you can set a different

The screenshot will be displayed in your console, if supported.

named with a sequential prefix (or 'failed' for failing tests)
to investigate changes at different points during your test. These will be
automating visual testing. You can take multiple screenshots per test
a screenshot of the current state. This can be useful for debugging or
+take_screenshot+ can be used at any point in your system tests to take

Takes a screenshot of the current page in the browser. 
def take_screenshot
  increment_unique
  save_html if save_html?
  save_image
  puts display_image
end

def unique 

def unique
  failed? ? "failures" : (_screenshot_counter || 0).to_s
end