ferrum 0.18.0 → 0.19.0

data/lib/ferrum/page/stream.rb

@@ -70,7 +70,8 @@ module Ferrum
 
       #
       # Reads a CDP `IO` stream in chunks, writing each chunk to the given
-      # output until the stream is exhausted.
+      # output until the stream is exhausted, then releases the stream
+      # handle on the browser side.
       #
       # @param [#<<] output
       #   Anything that responds to `#<<`, e.g. an open `File` or a `String`.
@@ -88,6 +89,20 @@ module Ferrum
           output << chunk
           break if result["eof"]
         end
+        close_stream(handle: handle)
+      end
+
+      #
+      # Releases a CDP `IO` stream handle, discarding any backing storage
+      # the browser is holding for it.
+      #
+      # @param [String] handle
+      #   The CDP `IO` stream handle to close.
+      #
+      # @return [void]
+      #
+      def close_stream(handle:)
+        command("IO.close", handle: handle)
       end
     end
   end

data/lib/ferrum/page.rb

@@ -31,7 +31,7 @@ module Ferrum
 
     extend Forwardable
 
-    delegate %i[at_css at_xpath css xpath
+    delegate %i[at_css at_xpath css xpath wait_for_selector
                 current_url current_title url title body doctype content=
                 execution_id execution_id! evaluate evaluate_on evaluate_async execute evaluate_func
                 add_script_tag add_style_tag] => :main_frame
@@ -176,9 +176,15 @@ module Ferrum
     #
     # @param [Float] scale_factor device scale factor value. 0 disables the override
     #
-    # @param [Boolean] mobile whether to emulate mobile device
+    # @param [Boolean] mobile whether to emulate mobile device and enable touch
     #
-    def set_viewport(width:, height:, scale_factor: 0, mobile: false)
+    def set_viewport(width: 0, height: 0, scale_factor: 0, mobile: false)
+      command(
+        "Emulation.setTouchEmulationEnabled",
+        enabled: mobile,
+        maxTouchPoints: 1
+      )
+
       command(
         "Emulation.setDeviceMetricsOverride",
         slowmoable: true,
@@ -454,8 +460,8 @@ module Ferrum
       result
     end
 
-    # Subscribes to a CDP event, or to `:dialog`, `:request`, `:auth` (the
-    # latter two handled by {Interceptable}).
+    # Subscribes to a CDP event, or to `:dialog`, `:request`, `:response`,
+    # `:auth` (the latter three handled by {Interceptable}).
     #
     # @param [Symbol, String] name
     #

data/lib/ferrum/target.rb

@@ -17,11 +17,12 @@ module Ferrum
     attr_reader :options
     attr_accessor :session_id
 
-    def initialize(browser_client, session_id = nil, params = nil)
+    def initialize(browser_client, session_id = nil, params = nil, implicit: false)
       @page = nil
       @worker = nil
       @session_id = session_id
       @params = params
+      @implicit = implicit
       @browser_client = browser_client
       @options = browser_client.options
     end
@@ -137,11 +138,14 @@ module Ferrum
       @params["parentId"]
     end
 
-    # The id of the browser context this target belongs to.
+    # The id of the browser context this target belongs to, `nil` for the
+    # browser's implicit context, which Chrome doesn't let us address by id,
+    # see {Context#implicit?}. Commands scoped to a browser context target it
+    # by omitting `browserContextId`.
     #
     # @return [String, nil]
     def context_id
-      @params["browserContextId"]
+      @params["browserContextId"] unless @implicit
     end
 
     # Whether this target is a window/tab, i.e. was opened via

data/lib/ferrum/utils/thread.rb

@@ -14,10 +14,12 @@ module Ferrum
       #
       # @param [Boolean] abort_on_exception
       #   Whether the thread aborts the process if it raises an unhandled exception.
+      #   Off by default: an exception in one of Ferrum's own threads reaches the
+      #   main thread wherever it happens to be, or kills the process outright.
       #
       # @return [Thread]
       #
-      def spawn(abort_on_exception: true)
+      def spawn(abort_on_exception: false)
         ::Thread.new(abort_on_exception) do |whether_abort_on_exception|
           ::Thread.current.abort_on_exception = whether_abort_on_exception
           ::Thread.current.report_on_exception = true if ::Thread.current.respond_to?(:report_on_exception=)

data/lib/ferrum/version.rb

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

data/lib/ferrum.rb

@@ -11,7 +11,7 @@ require "ferrum/browser"
 require "ferrum/node"
 
 #
-# Ferrum is a pure Ruby driver for headless Chrome and Firefox. It talks
+# Ferrum is a pure Ruby driver for headless Chrome. It talks
 # directly to the browser over the Chrome DevTools Protocol (CDP), so it
 # doesn't depend on Selenium, WebDriver or any other third party gem.
 #

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ferrum
 version: !ruby/object:Gem::Version
-  version: 0.18.0
+  version: 0.19.0
 platform: ruby
 authors:
 - Dmitry Vorotilin
@@ -83,8 +83,8 @@ files:
 - lib/ferrum/browser/options.rb
 - lib/ferrum/browser/options/base.rb
 - lib/ferrum/browser/options/chrome.rb
-- lib/ferrum/browser/options/firefox.rb
 - lib/ferrum/browser/process.rb
+- lib/ferrum/browser/process/killer.rb
 - lib/ferrum/browser/version_info.rb
 - lib/ferrum/browser/xvfb.rb
 - lib/ferrum/client.rb
@@ -155,7 +155,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.16
+rubygems_version: 4.0.6
 specification_version: 4
 summary: Ruby headless Chrome driver
 test_files: []

data/lib/ferrum/browser/options/firefox.rb

@@ -1,70 +0,0 @@
-# frozen_string_literal: true
-
-module Ferrum
-  class Browser
-    class Options
-      #
-      # Firefox-specific default flags and binary locations. Provides the CLI
-      # flags required to drive Firefox over CDP (remote debugger address and
-      # profile directory) along with its (minimal) set of default flags.
-      #
-      class Firefox < Base
-        DEFAULT_OPTIONS = {
-          "headless" => nil
-        }.freeze
-
-        MAC_BIN_PATH = [
-          "/Applications/Firefox.app/Contents/MacOS/firefox-bin"
-        ].freeze
-        LINUX_BIN_PATH = %w[firefox].freeze
-        WINDOWS_BIN_PATH = [
-          "C:/Program Files/Firefox Developer Edition/firefox.exe",
-          "C:/Program Files/Mozilla Firefox/firefox.exe"
-        ].freeze
-        PLATFORM_PATH = {
-          mac: MAC_BIN_PATH,
-          windows: WINDOWS_BIN_PATH,
-          linux: LINUX_BIN_PATH
-        }.freeze
-
-        #
-        # Merges CLI flags required for Firefox to work with CDP.
-        #
-        # @param [Hash] flags
-        #   Flags to merge required ones into.
-        #
-        # @param [Ferrum::Browser::Options] options
-        #   Browser options.
-        #
-        # @param [String] user_data_dir
-        #   Path to the browser's profile directory.
-        #
-        # @return [Hash]
-        #   Merged flags.
-        #
-        def merge_required(flags, options, user_data_dir)
-          flags.merge("remote-debugger" => "#{options.host}:#{options.port}", "profile" => user_data_dir)
-        end
-
-        #
-        # Merges Firefox's default flags with the given ones.
-        #
-        # @param [Hash] flags
-        #   Flags that take precedence over the defaults.
-        #
-        # @param [Ferrum::Browser::Options] options
-        #   Browser options.
-        #
-        # @return [Hash]
-        #   Merged flags.
-        #
-        def merge_default(flags, options)
-          defaults = except("headless") unless options.headless
-
-          defaults ||= DEFAULT_OPTIONS
-          defaults.merge(flags)
-        end
-      end
-    end
-  end
-end