ferrum 0.7 → 0.10.2

data/lib/ferrum/page/frames.rb

@@ -71,23 +71,37 @@ module Ferrum
         end
 
         on("Runtime.executionContextCreated") do |params|
+          setting_up_main_frame = false
           context_id = params.dig("context", "id")
           frame_id = params.dig("context", "auxData", "frameId")
+
+          unless @main_frame.id
+            root_frame = command("Page.getFrameTree").dig("frameTree", "frame", "id")
+            if frame_id == root_frame
+              setting_up_main_frame = true
+              @main_frame.id = frame_id
+              @frames[frame_id] = @main_frame
+            end
+          end
+
           frame = @frames[frame_id] || Frame.new(frame_id, self)
-          frame.execution_id = context_id
+          frame.set_execution_id(context_id)
+
+          # Set event because `execution_id` might raise NoExecutionContextError
+          @event.set if setting_up_main_frame
 
-          @main_frame ||= frame
           @frames[frame_id] ||= frame
         end
 
         on("Runtime.executionContextDestroyed") do |params|
           execution_id = params["executionContextId"]
           frame = frames.find { |f| f.execution_id?(execution_id) }
-          frame.execution_id = nil
+          frame.reset_execution_id
         end
 
         on("Runtime.executionContextsCleared") do
           @frames.delete_if { |_, f| !f.main? }
+          @main_frame.reset_execution_id
         end
       end
 

data/lib/ferrum/page/screenshot.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "ferrum/rbga"
+
 module Ferrum
   class Page
     module Screenshot
@@ -24,19 +26,33 @@ module Ferrum
         A6:       { width:  4.13, height:  5.83 },
       }.freeze
 
+      STREAM_CHUNK = 128 * 1024
+
       def screenshot(**opts)
         path, encoding = common_options(**opts)
         options = screenshot_options(path, **opts)
-        data = capture_screenshot(options, opts[:full])
+        data = capture_screenshot(options, opts[:full], opts[:background_color])
         return data if encoding == :base64
-        save_file(path, data)
+
+        bin = Base64.decode64(data)
+        save_file(path, bin)
       end
 
       def pdf(**opts)
         path, encoding = common_options(**opts)
-        options = pdf_options(**opts)
-        data = command("Page.printToPDF", **options).fetch("data")
-        return data if encoding == :base64
+        options = pdf_options(**opts).merge(transferMode: "ReturnAsStream")
+        handle = command("Page.printToPDF", **options).fetch("stream")
+
+        if path
+          stream_to_file(handle, path: path)
+        else
+          stream_to_memory(handle, encoding: encoding)
+        end
+      end
+
+      def mhtml(path: nil)
+        data = command("Page.captureSnapshot", format: :mhtml).fetch("data")
+        return data if path.nil?
         save_file(path, data)
       end
 
@@ -48,17 +64,39 @@ module Ferrum
 
       def document_size
         evaluate <<~JS
-          [document.documentElement.offsetWidth,
-           document.documentElement.offsetHeight]
+          [document.documentElement.scrollWidth,
+           document.documentElement.scrollHeight]
         JS
       end
 
       private
 
       def save_file(path, data)
-        bin = Base64.decode64(data)
-        return bin unless path
-        File.open(path.to_s, "wb") { |f| f.write(bin) }
+        return data unless path
+        File.open(path.to_s, "wb") { |f| f.write(data) }
+      end
+
+      def stream_to_file(handle, path:)
+        File.open(path, "wb") { |f| stream_to(handle, f) }
+        true
+      end
+
+      def stream_to_memory(handle, encoding:)
+        data = String.new("") # Mutable string has << and compatible to File
+        stream_to(handle, data)
+        encoding == :base64 ? Base64.encode64(data) : data
+      end
+
+      def stream_to(handle, output)
+        loop do
+          result = command("IO.read", handle: handle, size: STREAM_CHUNK)
+
+          data_chunk = result["data"]
+          data_chunk = Base64.decode64(data_chunk) if result["base64Encoded"]
+          output << data_chunk
+
+          break if result["eof"]
+        end
       end
 
       def common_options(encoding: :base64, path: nil, **_)
@@ -134,9 +172,11 @@ module Ferrum
         option.to_s.gsub(/(?:_|(\/))([a-z\d]*)/) { "#{$1}#{$2.capitalize}" }.to_sym
       end
 
-      def capture_screenshot(options, full)
+      def capture_screenshot(options, full, background_color)
         maybe_resize_fullscreen(full) do
-          command("Page.captureScreenshot", **options)
+          with_background_color(background_color) do
+            command("Page.captureScreenshot", **options)
+          end
         end.fetch("data")
       end
 
@@ -150,6 +190,18 @@ module Ferrum
       ensure
         resize(width: width, height: height) if full
       end
+
+      def with_background_color(color)
+        if color
+          raise ArgumentError, "Accept Ferrum::RGBA class only" unless color.is_a?(RGBA)
+
+          command("Emulation.setDefaultBackgroundColorOverride", color: color.to_h)
+        end
+
+        yield
+      ensure
+        command("Emulation.setDefaultBackgroundColorOverride") if color
+      end
     end
   end
 end

data/lib/ferrum/rbga.rb

@@ -0,0 +1,38 @@
+module Ferrum
+  class RGBA
+    def initialize(red, green, blue, alpha)
+      self.red = red
+      self.green = green
+      self.blue = blue
+      self.alpha = alpha
+
+      validate
+    end
+
+    def to_h
+      { r: red, g: green, b: blue, a: alpha }
+    end
+
+    private
+
+    attr_accessor :red, :green, :blue, :alpha
+
+    def validate
+      [red, green, blue].each(&method(:validate_color))
+      validate_alpha
+    end
+
+    def validate_color(value)
+      return if value && value.is_a?(Integer) && Range.new(0, 255).include?(value)
+
+      raise ArgumentError, "Wrong value of #{value} should be Integer from 0 to 255"
+    end
+
+    def validate_alpha
+      return if alpha && alpha.is_a?(Float) && Range.new(0.0, 1.0).include?(alpha)
+
+      raise ArgumentError,
+            "Wrong alpha value #{alpha} should be Float between 0.0 (fully transparent) and 1.0 (fully opaque)"
+    end
+  end
+end

data/lib/ferrum/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ferrum
 version: !ruby/object:Gem::Version
-  version: '0.7'
+  version: 0.10.2
 platform: ruby
 authors:
 - Dmitry Vorotilin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-28 00:00:00.000000000 Z
+date: 2021-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: websocket-driver
@@ -64,28 +64,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '2.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '2.5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -181,13 +181,15 @@ files:
 - README.md
 - lib/ferrum.rb
 - lib/ferrum/browser.rb
-- lib/ferrum/browser/chrome.rb
 - lib/ferrum/browser/client.rb
 - lib/ferrum/browser/command.rb
-- lib/ferrum/browser/firefox.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/subscriber.rb
 - lib/ferrum/browser/web_socket.rb
+- lib/ferrum/browser/xvfb.rb
 - lib/ferrum/context.rb
 - lib/ferrum/contexts.rb
 - lib/ferrum/cookies.rb
@@ -210,6 +212,7 @@ files:
 - lib/ferrum/page.rb
 - lib/ferrum/page/frames.rb
 - lib/ferrum/page/screenshot.rb
+- lib/ferrum/rbga.rb
 - lib/ferrum/target.rb
 - lib/ferrum/version.rb
 homepage: https://github.com/route/ferrum
@@ -231,7 +234,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Ruby headless Chrome driver

data/lib/ferrum/browser/chrome.rb

@@ -1,76 +0,0 @@
-# frozen_string_literal: true
-
-module Ferrum
-  class Browser
-    class Chrome < Command
-      DEFAULT_OPTIONS = {
-        "headless" => nil,
-        "disable-gpu" => nil,
-        "hide-scrollbars" => nil,
-        "mute-audio" => nil,
-        "enable-automation" => nil,
-        "disable-web-security" => nil,
-        "disable-session-crashed-bubble" => nil,
-        "disable-breakpad" => nil,
-        "disable-sync" => nil,
-        "no-first-run" => nil,
-        "use-mock-keychain" => nil,
-        "keep-alive-for-test" => nil,
-        "disable-popup-blocking" => nil,
-        "disable-extensions" => nil,
-        "disable-hang-monitor" => nil,
-        "disable-features" => "site-per-process,TranslateUI",
-        "disable-translate" => nil,
-        "disable-background-networking" => nil,
-        "enable-features" => "NetworkService,NetworkServiceInProcess",
-        "disable-background-timer-throttling" => nil,
-        "disable-backgrounding-occluded-windows" => nil,
-        "disable-client-side-phishing-detection" => nil,
-        "disable-default-apps" => nil,
-        "disable-dev-shm-usage" => nil,
-        "disable-ipc-flooding-protection" => nil,
-        "disable-prompt-on-repost" => nil,
-        "disable-renderer-backgrounding" => nil,
-        "force-color-profile" => "srgb",
-        "metrics-recording-only" => nil,
-        "safebrowsing-disable-auto-update" => nil,
-        "password-store" => "basic",
-        # Note: --no-sandbox is not needed if you properly setup a user in the container.
-        # https://github.com/ebidel/lighthouse-ci/blob/master/builder/Dockerfile#L35-L40
-        # "no-sandbox" => nil,
-      }.freeze
-
-      MAC_BIN_PATH = [
-        "/Applications/Chromium.app/Contents/MacOS/Chromium",
-        "/Applications/Google Chrome.app/Contents/MacOS/Google Chrome"
-      ].freeze
-      LINUX_BIN_PATH = %w[chromium google-chrome-unstable google-chrome-beta
-                          google-chrome chrome chromium-browser
-                          google-chrome-stable].freeze
-
-      private
-
-      def combine_flags
-        # Doesn't work on MacOS, so we need to set it by CDP as well
-        @flags.merge!("window-size" => options[:window_size].join(","))
-
-        port = options.fetch(:port, BROWSER_PORT)
-        @flags.merge!("remote-debugging-port" => port)
-
-        host = options.fetch(:host, BROWSER_HOST)
-        @flags.merge!("remote-debugging-address" => host)
-
-        @flags.merge!("user-data-dir" => @user_data_dir)
-
-        @flags = DEFAULT_OPTIONS.merge(@flags)
-
-        unless options.fetch(:headless, true)
-          @flags.delete("headless")
-          @flags.delete("disable-gpu")
-        end
-
-        @flags.merge!(options.fetch(:browser_options, {}))
-      end
-    end
-  end
-end

data/lib/ferrum/browser/firefox.rb

@@ -1,34 +0,0 @@
-# frozen_string_literal: true
-
-module Ferrum
-  class Browser
-    class Firefox < Command
-      DEFAULT_OPTIONS = {
-        "headless" => nil,
-      }.freeze
-
-      MAC_BIN_PATH = [
-        "/Applications/Firefox.app/Contents/MacOS/firefox-bin"
-      ].freeze
-      LINUX_BIN_PATH = %w[firefox].freeze
-
-      private
-
-      def combine_flags
-        port = options.fetch(:port, BROWSER_PORT)
-        host = options.fetch(:host, BROWSER_HOST)
-        @flags.merge!("remote-debugger" => "#{host}:#{port}")
-
-        @flags.merge!("profile" => @user_data_dir)
-
-        @flags = DEFAULT_OPTIONS.merge(@flags)
-
-        unless options.fetch(:headless, true)
-          @flags.delete("headless")
-        end
-
-        @flags.merge!(options.fetch(:browser_options, {}))
-      end
-    end
-  end
-end