1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 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 68
|
# frozen_string_literal: true
# Licensed to the Software Freedom Conservancy (SFC) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The SFC licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
module Selenium
module WebDriver
#
# @api private
#
module TakesScreenshot
#
# Save a PNG screenshot of the viewport to the given path
#
# @api public
#
def save_screenshot(png_path, full_page: false)
extension = File.extname(png_path).downcase
if extension != '.png'
WebDriver.logger.warn 'name used for saved screenshot does not match file type. ' \
'It should end with .png extension',
id: :screenshot
end
WebDriver.logger.debug("Saving screenshot to #{Dir.pwd}/#{png_path}")
File.open(png_path, 'wb') { |f| f << screenshot_as(:png, full_page: full_page) }
end
#
# Return a PNG screenshot in the given format as a string
#
# @param [:base64, :png] format
# @param [Boolean] full_page allows taking full page screenshots if supported
# @return String screenshot
#
# @api public
def screenshot_as(format, full_page: false)
if full_page && !respond_to?(:save_full_page_screenshot)
raise Error::UnsupportedOperationError, "Full Page Screenshots are not supported for #{inspect}"
end
case format
when :base64
full_page ? full_screenshot : screenshot
when :png
screenshot_as(:base64, full_page: full_page).unpack1('m')
else
raise Error::UnsupportedOperationError, "unsupported format: #{format.inspect}"
end
end
end # TakesScreenshot
end # WebDriver
end # Selenium
|