puppeteer-ruby 0.29.0 → 0.31.4

data/lib/puppeteer/element_handle.rb

@@ -318,17 +318,19 @@ class Puppeteer::ElementHandle < Puppeteer::JSHandle
     Puppeteer::QueryHandlerManager.instance
   end
 
-  # `$()` in JavaScript. $ is not allowed to use as a method name in Ruby.
+  # `$()` in JavaScript.
   # @param selector [String]
-  def S(selector)
+  def query_selector(selector)
     query_handler_manager.detect_query_handler(selector).query_one(self)
   end
+  alias_method :S, :query_selector
 
-  # `$$()` in JavaScript. $ is not allowed to use as a method name in Ruby.
+  # `$$()` in JavaScript.
   # @param selector [String]
-  def SS(selector)
+  def query_selector_all(selector)
     query_handler_manager.detect_query_handler(selector).query_all(self)
   end
+  alias_method :SS, :query_selector_all
 
   class ElementNotFoundError < StandardError
     def initialize(selector)
@@ -336,12 +338,12 @@ class Puppeteer::ElementHandle < Puppeteer::JSHandle
     end
   end
 
-  # `$eval()` in JavaScript. $ is not allowed to use as a method name in Ruby.
+  # `$eval()` in JavaScript.
   # @param selector [String]
   # @param page_function [String]
   # @return [Object]
-  def Seval(selector, page_function, *args)
-    element_handle = S(selector)
+  def eval_on_selector(selector, page_function, *args)
+    element_handle = query_selector(selector)
     unless element_handle
       raise ElementNotFoundError.new(selector)
     end
@@ -350,22 +352,24 @@ class Puppeteer::ElementHandle < Puppeteer::JSHandle
 
     result
   end
+  alias_method :Seval, :eval_on_selector
 
-  define_async_method :async_Seval
+  define_async_method :async_eval_on_selector
 
-  # `$$eval()` in JavaScript. $ is not allowed to use as a method name in Ruby.
+  # `$$eval()` in JavaScript.
   # @param selector [String]
   # @param page_function [String]
   # @return [Object]
-  def SSeval(selector, page_function, *args)
+  def eval_on_selector_all(selector, page_function, *args)
     handles = query_handler_manager.detect_query_handler(selector).query_all_array(self)
     result = handles.evaluate(page_function, *args)
     handles.dispose
 
     result
   end
+  alias_method :SSeval, :eval_on_selector_all
 
-  define_async_method :async_SSeval
+  define_async_method :async_eval_on_selector_all
 
   # `$x()` in JavaScript. $ is not allowed to use as a method name in Ruby.
   # @param expression [String]

data/lib/puppeteer/env.rb

@@ -14,10 +14,14 @@ class Puppeteer::Env
   def darwin?
     RUBY_PLATFORM.include?('darwin')
   end
+
+  def windows?
+    RUBY_PLATFORM =~ /mswin|mingw|cygwin/
+  end
 end
 
-class Puppeteer
-  def self.env
-    Puppeteer::Env.new
+module Puppeteer
+  module_function def env
+    ::Puppeteer::Env.new
   end
 end

data/lib/puppeteer/frame.rb

@@ -61,14 +61,15 @@ class Puppeteer::Frame
 
   define_async_method :async_evaluate
 
-  # `$()` in JavaScript. $ is not allowed to use as a method name in Ruby.
+  # `$()` in JavaScript.
   # @param {string} selector
   # @return {!Promise<?Puppeteer.ElementHandle>}
-  def S(selector)
-    @main_world.S(selector)
+  def query_selector(selector)
+    @main_world.query_selector(selector)
   end
+  alias_method :S, :query_selector
 
-  define_async_method :async_S
+  define_async_method :async_query_selector
 
   # `$x()` in JavaScript. $ is not allowed to use as a method name in Ruby.
   # @param {string} expression
@@ -79,36 +80,39 @@ class Puppeteer::Frame
 
   define_async_method :async_Sx
 
-  # `$eval()` in JavaScript. $ is not allowed to use as a method name in Ruby.
+  # `$eval()` in JavaScript.
   # @param {string} selector
   # @param {Function|string} pageFunction
   # @param {!Array<*>} args
   # @return {!Promise<(!Object|undefined)>}
-  def Seval(selector, page_function, *args)
-    @main_world.Seval(selector, page_function, *args)
+  def eval_on_selector(selector, page_function, *args)
+    @main_world.eval_on_selector(selector, page_function, *args)
   end
+  alias_method :Seval, :eval_on_selector
 
-  define_async_method :async_Seval
+  define_async_method :async_eval_on_selector
 
-  # `$$eval()` in JavaScript. $ is not allowed to use as a method name in Ruby.
+  # `$$eval()` in JavaScript.
   # @param {string} selector
   # @param {Function|string} pageFunction
   # @param {!Array<*>} args
   # @return {!Promise<(!Object|undefined)>}
-  def SSeval(selector, page_function, *args)
-    @main_world.SSeval(selector, page_function, *args)
+  def eval_on_selector_all(selector, page_function, *args)
+    @main_world.eval_on_selector_all(selector, page_function, *args)
   end
+  alias_method :SSeval, :eval_on_selector_all
 
-  define_async_method :async_SSeval
+  define_async_method :async_eval_on_selector_all
 
-  # `$$()` in JavaScript. $ is not allowed to use as a method name in Ruby.
+  # `$$()` in JavaScript.
   # @param {string} selector
   # @return {!Promise<!Array<!Puppeteer.ElementHandle>>}
-  def SS(selector)
-    @main_world.SS(selector)
+  def query_selector_all(selector)
+    @main_world.query_selector_all(selector)
   end
+  alias_method :SS, :query_selector_all
 
-  define_async_method :async_SS
+  define_async_method :async_query_selector_all
 
   # @return [String]
   def content
@@ -149,16 +153,19 @@ class Puppeteer::Frame
     @detached
   end
 
-  # @param style_tag [Puppeteer::Page::ScriptTag]
-  # @return {!Promise<!ElementHandle>}
-  def add_script_tag(script_tag)
-    @main_world.add_script_tag(script_tag)
+  # @param url [String?]
+  # @param path [String?]
+  # @param content [String?]
+  # @param type [String?]
+  def add_script_tag(url: nil, path: nil, content: nil, type: nil)
+    @main_world.add_script_tag(url: url, path: path, content: content, type: type)
   end
 
-  # @param style_tag [Puppeteer::Page::StyleTag]
-  # @return {!Promise<!ElementHandle>}
-  def add_style_tag(style_tag)
-    @main_world.add_style_tag(style_tag)
+  # @param url [String?]
+  # @param path [String?]
+  # @param content [String?]
+  def add_style_tag(url: nil, path: nil, content: nil)
+    @main_world.add_style_tag(url: url, path: path, content: content)
   end
 
   # @param selector [String]

data/lib/puppeteer/launcher/base.rb

@@ -32,6 +32,14 @@ module Puppeteer::Launcher
         when Firefox
           '/Applications/Firefox Nightly.app/Contents/MacOS/firefox'
         end
+      elsif Puppeteer.env.windows?
+        case self
+        when Chrome
+          'C:\Program Files\Google\Chrome\Application\chrome.exe'
+          # 'C:\Program Files (x86)\Microsoft\Edge\Application\msedge.exe'
+        when Firefox
+          'C:\Program Files\Firefox Nightly\firefox.exe'
+        end
       else
         case self
         when Chrome

data/lib/puppeteer/page.rb

@@ -1,4 +1,5 @@
 require 'base64'
+require 'json'
 require "stringio"
 
 require_relative './page/pdf_options'
@@ -98,7 +99,9 @@ class Puppeteer::Page
     @client.on_event('Page.loadEventFired') do |event|
       emit_event(PageEmittedEvents::Load)
     end
-    # client.on('Runtime.consoleAPICalled', event => this._onConsoleAPI(event));
+    @client.on('Runtime.consoleAPICalled') do |event|
+      handle_console_api(event)
+    end
     # client.on('Runtime.bindingCalled', event => this._onBindingCalled(event));
     @client.on_event('Page.javascriptDialogOpening') do |event|
       handle_dialog_opening(event)
@@ -199,6 +202,7 @@ class Puppeteer::Page
   end
 
   attr_reader :javascript_enabled, :target
+  alias_method :javascript_enabled?, :javascript_enabled
 
   def browser
     @target.browser
@@ -276,23 +280,25 @@ class Puppeteer::Page
     @timeout_settings.default_timeout = timeout
   end
 
-  # `$()` in JavaScript. $ is not allowed to use as a method name in Ruby.
+  # `$()` in JavaScript.
   # @param {string} selector
   # @return {!Promise<?Puppeteer.ElementHandle>}
-  def S(selector)
-    main_frame.S(selector)
+  def query_selector(selector)
+    main_frame.query_selector(selector)
   end
+  alias_method :S, :query_selector
 
-  define_async_method :async_S
+  define_async_method :async_query_selector
 
-  # `$$()` in JavaScript. $ is not allowed to use as a method name in Ruby.
+  # `$$()` in JavaScript.
   # @param {string} selector
   # @return {!Promise<!Array<!Puppeteer.ElementHandle>>}
-  def SS(selector)
-    main_frame.SS(selector)
+  def query_selector_all(selector)
+    main_frame.query_selector_all(selector)
   end
+  alias_method :SS, :query_selector_all
 
-  define_async_method :async_SS
+  define_async_method :async_query_selector_all
 
   # @param {Function|string} pageFunction
   # @param {!Array<*>} args
@@ -311,25 +317,27 @@ class Puppeteer::Page
     context.query_objects(prototype_handle)
   end
 
-  # `$eval()` in JavaScript. $ is not allowed to use as a method name in Ruby.
+  # `$eval()` in JavaScript.
   # @param selector [String]
   # @param page_function [String]
   # @return [Object]
-  def Seval(selector, page_function, *args)
-    main_frame.Seval(selector, page_function, *args)
+  def eval_on_selector(selector, page_function, *args)
+    main_frame.eval_on_selector(selector, page_function, *args)
   end
+  alias_method :Seval, :eval_on_selector
 
-  define_async_method :async_Seval
+  define_async_method :async_eval_on_selector
 
-  # `$$eval()` in JavaScript. $ is not allowed to use as a method name in Ruby.
+  # `$$eval()` in JavaScript.
   # @param selector [String]
   # @param page_function [String]
   # @return [Object]
-  def SSeval(selector, page_function, *args)
-    main_frame.SSeval(selector, page_function, *args)
+  def eval_on_selector_all(selector, page_function, *args)
+    main_frame.eval_on_selector_all(selector, page_function, *args)
   end
+  alias_method :SSeval, :eval_on_selector_all
 
-  define_async_method :async_SSeval
+  define_async_method :async_eval_on_selector_all
 
   # `$x()` in JavaScript. $ is not allowed to use as a method name in Ruby.
   # @param {string} expression
@@ -369,37 +377,19 @@ class Puppeteer::Page
     end
   end
 
-  class ScriptTag
-    # @param {!{content?: string, path?: string, type?: string, url?: string}} options
-    def initialize(content: nil, path: nil, type: nil, url: nil)
-      @content = content
-      @path = path
-      @type = type
-      @url = url
-    end
-    attr_reader :content, :path, :type, :url
-  end
-
-  # @param style_tag [Puppeteer::Page::ScriptTag]
-  # @return {!Promise<!ElementHandle>}
-  def add_script_tag(script_tag)
-    main_frame.add_script_tag(script_tag)
-  end
-
-  class StyleTag
-    # @param {!{content?: string, path?: string, url?: string}} options
-    def initialize(content: nil, path: nil, url: nil)
-      @content = content
-      @path = path
-      @url = url
-    end
-    attr_reader :content, :path, :url
+  # @param url [String?]
+  # @param path [String?]
+  # @param content [String?]
+  # @param type [String?]
+  def add_script_tag(url: nil, path: nil, content: nil, type: nil)
+    main_frame.add_script_tag(url: url, path: path, content: content, type: type)
   end
 
-  # @param style_tag [Puppeteer::Page::StyleTag]
-  # @return {!Promise<!ElementHandle>}
-  def add_style_tag(style_tag)
-    main_frame.add_style_tag(style_tag)
+  # @param url [String?]
+  # @param path [String?]
+  # @param content [String?]
+  def add_style_tag(url: nil, path: nil, content: nil)
+    main_frame.add_style_tag(url: url, path: path, content: content)
   end
 
   # /**
@@ -490,30 +480,31 @@ class Puppeteer::Page
     emit_event(PageEmittedEvents::PageError, err)
   end
 
-  # /**
-  #  * @param {!Protocol.Runtime.consoleAPICalledPayload} event
-  #  */
-  # async _onConsoleAPI(event) {
-  #   if (event.executionContextId === 0) {
-  #     // DevTools protocol stores the last 1000 console messages. These
-  #     // messages are always reported even for removed execution contexts. In
-  #     // this case, they are marked with executionContextId = 0 and are
-  #     // reported upon enabling Runtime agent.
-  #     //
-  #     // Ignore these messages since:
-  #     // - there's no execution context we can use to operate with message
-  #     //   arguments
-  #     // - these messages are reported before Puppeteer clients can subscribe
-  #     //   to the 'console'
-  #     //   page event.
-  #     //
-  #     // @see https://github.com/puppeteer/puppeteer/issues/3865
-  #     return;
-  #   }
-  #   const context = this._frameManager.executionContextById(event.executionContextId);
-  #   const values = event.args.map(arg => createJSHandle(context, arg));
-  #   this._addConsoleMessage(event.type, values, event.stackTrace);
-  # }
+  private def handle_console_api(event)
+    if event['executionContextId'] == 0
+      # DevTools protocol stores the last 1000 console messages. These
+      # messages are always reported even for removed execution contexts. In
+      # this case, they are marked with executionContextId = 0 and are
+      # reported upon enabling Runtime agent.
+      #
+      # Ignore these messages since:
+      # - there's no execution context we can use to operate with message
+      #   arguments
+      # - these messages are reported before Puppeteer clients can subscribe
+      #   to the 'console'
+      #   page event.
+      #
+      # @see https://github.com/puppeteer/puppeteer/issues/3865
+      return
+    end
+
+    context = @frame_manager.execution_context_by_id(event['executionContextId'])
+    values = event['args'].map do |arg|
+      remote_object = Puppeteer::RemoteObject.new(arg)
+      Puppeteer::JSHandle.create(context: context, remote_object: remote_object)
+    end
+    add_console_message(event['type'], values, event['stackTrace'])
+  end
 
   # /**
   #  * @param {!Protocol.Runtime.bindingCalledPayload} event
@@ -566,32 +557,23 @@ class Puppeteer::Page
   #   }
   # }
 
-  # /**
-  #  * @param {string} type
-  #  * @param {!Array<!Puppeteer.JSHandle>} args
-  #  * @param {Protocol.Runtime.StackTrace=} stackTrace
-  #  */
-  # _addConsoleMessage(type, args, stackTrace) {
-  #   if (!this.listenerCount(PageEmittedEvents::Console)) {
-  #     args.forEach(arg => arg.dispose());
-  #     return;
-  #   }
-  #   const textTokens = [];
-  #   for (const arg of args) {
-  #     const remoteObject = arg._remoteObject;
-  #     if (remoteObject.objectId)
-  #       textTokens.push(arg.toString());
-  #     else
-  #       textTokens.push(helper.valueFromRemoteObject(remoteObject));
-  #   }
-  #   const location = stackTrace && stackTrace.callFrames.length ? {
-  #     url: stackTrace.callFrames[0].url,
-  #     lineNumber: stackTrace.callFrames[0].lineNumber,
-  #     columnNumber: stackTrace.callFrames[0].columnNumber,
-  #   } : {};
-  #   const message = new ConsoleMessage(type, textTokens.join(' '), args, location);
-  #   this.emit(PageEmittedEvents::Console, message);
-  # }
+  private def add_console_message(type, args, stack_trace)
+    text_tokens = args.map { |arg| arg.remote_object.value }
+
+    call_frame = stack_trace['callFrames']&.first
+    location =
+      if call_frame
+        Puppeteer::ConsoleMessage::Location.new(
+          url: call_frame['url'],
+          line_number: call_frame['lineNumber'],
+          column_number: call_frame['columnNumber'],
+        )
+      else
+        nil
+      end
+    console_message = Puppeteer::ConsoleMessage.new(type, text_tokens.join(' '), args, location)
+    emit_event(PageEmittedEvents::Console, console_message)
+  end
 
   private def handle_dialog_opening(event)
     dialog_type = event['type']
@@ -605,6 +587,16 @@ class Puppeteer::Page
     emit_event(PageEmittedEvents::Dialog, dialog)
   end
 
+  private def set_transparent_background_color(&block)
+    @client.send_message(
+      'Emulation.setDefaultBackgroundColorOverride',
+      color: { r: 0, g: 0, b: 0, a: 0 })
+  end
+
+  private def reset_default_background_color(&block)
+    @client.send_message('Emulation.setDefaultBackgroundColorOverride')
+  end
+
   # @return [String]
   def url
     main_frame.url
@@ -862,14 +854,41 @@ class Puppeteer::Page
 
   define_async_method :async_evaluate
 
-  # /**
-  #  * @param {Function|string} pageFunction
-  #  * @param {!Array<*>} args
-  #  */
-  # async evaluateOnNewDocument(pageFunction, ...args) {
-  #   const source = helper.evaluationString(pageFunction, ...args);
-  #   await this._client.send('Page.addScriptToEvaluateOnNewDocument', { source });
-  # }
+  class JavaScriptFunction
+    def initialize(expression, args)
+      @expression = expression
+      @args = args
+    end
+
+    def source
+      "(#{@expression})(#{arguments})"
+    end
+
+    private def arguments
+      @args.map { |arg| arg.nil? ? nil : JSON.dump(arg) }.join(", ")
+    end
+  end
+
+  class JavaScriptExpression
+    def initialize(expression)
+      @expression = expression
+    end
+
+    def source
+      @expression
+    end
+  end
+
+  def evaluate_on_new_document(page_function, *args)
+    source =
+      if ['=>', 'async', 'function'].any? { |keyword| page_function.include?(keyword) }
+        JavaScriptFunction.new(page_function, args).source
+      else
+        JavaScriptExpression.new(page_function).source
+      end
+
+    @client.send_message('Page.addScriptToEvaluateOnNewDocument', source: source)
+  end
 
   # @param {boolean} enabled
   def cache_enabled=(enabled)
@@ -940,18 +959,14 @@ class Puppeteer::Page
     end
 
     should_set_default_background = screenshot_options.omit_background? && format == 'png'
-    if should_set_default_background
-      @client.send_message('Emulation.setDefaultBackgroundColorOverride', color: { r: 0, g: 0, b: 0, a: 0 })
-    end
+    set_transparent_background_color if should_set_default_background
     screenshot_params = {
       format: format,
       quality: screenshot_options.quality,
       clip: clip,
     }.compact
     result = @client.send_message('Page.captureScreenshot', screenshot_params)
-    if should_set_default_background
-      @client.send_message('Emulation.setDefaultBackgroundColorOverride')
-    end
+    reset_default_background_color if should_set_default_background
 
     if screenshot_options.full_page? && @viewport
       self.viewport = @viewport
@@ -980,7 +995,7 @@ class Puppeteer::Page
 
     def read
       out = StringIO.new
-      File.open(@path, 'w') do |file|
+      File.open(@path, 'wb') do |file|
         eof = false
         until eof
           response = @client.send_message('IO.read', handle: @handle)
@@ -1009,7 +1024,10 @@ class Puppeteer::Page
   # @return [String]
   def pdf(options = {})
     pdf_options = PDFOptions.new(options)
+    omit_background = options[:omit_background]
+    set_transparent_background_color if omit_background
     result = @client.send_message('Page.printToPDF', pdf_options.page_print_args)
+    reset_default_background_color if omit_background
     ProtocolStreamReader.new(client: @client, handle: result['stream'], path: pdf_options.path).read
   rescue => err
     if err.message.include?('PrintToPDF is not implemented')