ferrum 0.15 → 0.17

data/lib/ferrum/page/screenshot.rb

@@ -8,6 +8,9 @@ module Ferrum
       FULL_WARNING = "Ignoring :selector or :area in #screenshot since full: true was given at %s"
       AREA_WARNING = "Ignoring :area in #screenshot since selector: was given at %s"
 
+      DEFAULT_SCREENSHOT_FORMAT = "png"
+      SUPPORTED_SCREENSHOT_FORMAT = %w[png jpeg jpg webp].freeze
+
       DEFAULT_PDF_OPTIONS = {
         landscape: false,
         paper_width: 8.5,
@@ -41,7 +44,7 @@ module Ferrum
       # @option opts [:base64, :binary] :encoding
       #   The encoding the image should be returned in.
       #
-      # @option opts ["jpeg", "png"] :format
+      # @option opts ["jpeg", "jpg", "png", "webp"] :format
       #   The format the image should be returned in.
       #
       # @option opts [Integer] :quality
@@ -71,8 +74,11 @@ module Ferrum
       # @example Save on the disk in JPG:
       #   page.screenshot(path: "google.jpg") # => 30902
       #
+      # @example Save to Base64 in WebP with reduce quality:
+      #   page.screenshot(format: "webp", quality: 60) # "iVBORw0KGgoAAAANS...
+      #
       # @example Save to Base64 the whole page not only viewport and reduce quality:
-      #   page.screenshot(full: true, quality: 60) # "iVBORw0KGgoAAAANS...
+      #   page.screenshot(full: true, format: "jpeg", quality: 60) # "iVBORw0KGgoAAAANS...
       #
       # @example Save with specific background color:
       #   page.screenshot(background_color: Ferrum::RGBA.new(0, 0, 0, 0.0))
@@ -211,11 +217,19 @@ module Ferrum
       end
 
       def format_options(format, path, quality)
-        format ||= path ? File.extname(path).delete(".") : "png"
+        if !format && path # try to infer from path
+          extension = File.extname(path).delete(".").downcase
+          format = extension unless extension.empty?
+        end
+
+        format ||= DEFAULT_SCREENSHOT_FORMAT
+        format = format.to_s
+        raise Ferrum::InvalidScreenshotFormatError, format unless SUPPORTED_SCREENSHOT_FORMAT.include?(format)
+
         format = "jpeg" if format == "jpg"
-        raise "Not supported options `:format` #{format}. jpeg | png" if format !~ /jpeg|png/i
 
-        quality ||= 75 if format == "jpeg"
+        # Chrome supports screenshot qualities for JPEG and WebP
+        quality ||= 75 if format != "png"
 
         [format, quality]
       end

data/lib/ferrum/page.rb

@@ -10,6 +10,7 @@ require "ferrum/dialog"
 require "ferrum/network"
 require "ferrum/downloads"
 require "ferrum/page/frames"
+require "ferrum/page/screencast"
 require "ferrum/page/screenshot"
 require "ferrum/page/animation"
 require "ferrum/page/tracing"
@@ -27,6 +28,7 @@ module Ferrum
     delegate %i[base_url default_user_agent timeout timeout=] => :@options
 
     include Animation
+    include Screencast
     include Screenshot
     include Frames
     include Stream
@@ -336,6 +338,20 @@ module Ferrum
       enabled
     end
 
+    #
+    # Activates (focuses) the target for the given page.
+    # When you have multiple tabs you work with, and you need to switch a given one.
+    #
+    # @return [Boolean]
+    #
+    # @example
+    #   page.activate # => true
+    #
+    def activate
+      command("Target.activateTarget", targetId: target_id)
+      true
+    end
+
     def command(method, wait: 0, slowmoable: false, **params)
       iteration = @event.reset if wait.positive?
       sleep(@options.slowmo) if slowmoable && @options.slowmo.positive?
@@ -379,6 +395,19 @@ module Ferrum
       end
     end
 
+    def off(name, id)
+      case name
+      when :dialog
+        client.off("Page.javascriptDialogOpening", id)
+      when :request
+        client.off("Fetch.requestPaused", id)
+      when :auth
+        client.off("Fetch.authRequired", id)
+      else
+        client.off(name, id)
+      end
+    end
+
     def subscribed?(event)
       client.subscribed?(event)
     end
@@ -391,7 +420,9 @@ module Ferrum
       use_proxy? && @proxy_user && @proxy_password
     end
 
-    def document_node_id
+    def document_node_id(async: false)
+      return client.command("DOM.getDocument", async: true, depth: 0) if async
+
       command("DOM.getDocument", depth: 0).dig("root", "nodeId")
     end
 
@@ -459,7 +490,7 @@ module Ferrum
       # opens a new window for which `frameStoppedLoading` event never
       # occurs and thus search for nodes cannot be completed. Here we check
       # the history and if the transitionType for example `link` then
-      # content is already loaded and we can try to get the document.
+      # content is already loaded, and we can try to get the document.
       document_node_id
     end
 

data/lib/ferrum/target.rb

@@ -8,7 +8,8 @@ module Ferrum
     # where we enhance page class and build page ourselves.
     attr_writer :page
 
-    attr_reader :session_id, :options
+    attr_reader :options
+    attr_accessor :session_id
 
     def initialize(browser_client, session_id = nil, params = nil)
       @page = nil
@@ -67,11 +68,19 @@ module Ferrum
       !!opener_id
     end
 
+    def iframe?
+      type == "iframe"
+    end
+
     def maybe_sleep_if_new_window
       # Dirty hack because new window doesn't have events at all
       sleep(NEW_WINDOW_WAIT) if window?
     end
 
+    def command(...)
+      client.command(...)
+    end
+
     private
 
     def build_client

data/lib/ferrum/utils/elapsed_time.rb

@@ -9,6 +9,10 @@ module Ferrum
         @start ||= monotonic_time
       end
 
+      def reset
+        @start = monotonic_time
+      end
+
       def elapsed_time(start = nil)
         monotonic_time - (start || @start)
       end

data/lib/ferrum/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Ferrum
-  VERSION = "0.15"
+  VERSION = "0.17"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ferrum
 version: !ruby/object:Gem::Version
-  version: '0.15'
+  version: '0.17'
 platform: ruby
 authors:
 - Dmitry Vorotilin
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-17 00:00:00.000000000 Z
+date: 2025-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -115,6 +129,7 @@ files:
 - lib/ferrum/page.rb
 - lib/ferrum/page/animation.rb
 - lib/ferrum/page/frames.rb
+- lib/ferrum/page/screencast.rb
 - lib/ferrum/page/screenshot.rb
 - lib/ferrum/page/stream.rb
 - lib/ferrum/page/tracing.rb
@@ -152,7 +167,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.6
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: Ruby headless Chrome driver