puppeteer-ruby 0.0.10 → 0.0.15

data/lib/puppeteer/page.rb

@@ -1,11 +1,13 @@
 require 'base64'
+require "stringio"
 
+require_relative './page/pdf_options'
 require_relative './page/screenshot_options'
 
 class Puppeteer::Page
   include Puppeteer::EventCallbackable
   include Puppeteer::IfPresent
-  using Puppeteer::AsyncAwaitBehavior
+  using Puppeteer::DefineAsyncMethod
 
   # @param {!Puppeteer.CDPSession} client
   # @param {!Puppeteer.Target} target
@@ -124,6 +126,45 @@ class Puppeteer::Page
     )
   end
 
+  EVENT_MAPPINGS = {
+    close: 'Events.Page.Close',
+    # console: 'Events.Page.Console',
+    # dialog: 'Events.Page.Dialog',
+    domcontentloaded: 'Events.Page.DOMContentLoaded',
+    # error:
+    frameattached: 'Events.Page.FrameAttached',
+    framedetached: 'Events.Page.FrameDetached',
+    framenavigated: 'Events.Page.FrameNavigated',
+    load: 'Events.Page.Load',
+    # metrics: 'Events.Page.Metrics',
+    # pageerror: 'Events.Page.PageError',
+    popup: 'Events.Page.Popup',
+    request: 'Events.Page.Request',
+    requestfailed: 'Events.Page.RequestFailed',
+    requestfinished: 'Events.Page.RequestFinished',
+    response: 'Events.Page.Response',
+    # workercreated: 'Events.Page.WorkerCreated',
+    # workerdestroyed: 'Events.Page.WorkerDestroyed',
+  }
+
+  # @param event_name [Symbol]
+  def on(event_name, &block)
+    unless EVENT_MAPPINGS.has_key?(event_name.to_sym)
+      raise ArgumentError.new("Unknown event name: #{event_name}. Known events are #{EVENT_MAPPINGS.keys.join(", ")}")
+    end
+
+    add_event_listener(EVENT_MAPPINGS[event_name.to_sym], &block)
+  end
+
+  # @param event_name [Symbol]
+  def once(event_name, &block)
+    unless EVENT_MAPPINGS.has_key?(event_name.to_sym)
+      raise ArgumentError.new("Unknown event name: #{event_name}. Known events are #{EVENT_MAPPINGS.keys.join(", ")}")
+    end
+
+    observe_first(EVENT_MAPPINGS[event_name.to_sym], &block)
+  end
+
   def handle_file_chooser(event)
     return if @file_chooser_interceptors.empty?
 
@@ -166,12 +207,7 @@ class Puppeteer::Page
     end
   end
 
-  # @param timeout [Integer]
-  # @return [Future<Puppeteer::FileChooser>]
-  async def async_wait_for_file_chooser(timeout: nil)
-    wait_for_file_chooser(timeout: timeout)
-  end
-
+  define_async_method :async_wait_for_file_chooser
 
   # /**
   #  * @param {!{longitude: number, latitude: number, accuracy: (number|undefined)}} options
@@ -266,6 +302,8 @@ class Puppeteer::Page
     main_frame.S(selector)
   end
 
+  define_async_method :async_S
+
   # `$$()` in JavaScript. $ is not allowed to use as a method name in Ruby.
   # @param {string} selector
   # @return {!Promise<!Array<!Puppeteer.ElementHandle>>}
@@ -273,6 +311,8 @@ class Puppeteer::Page
     main_frame.SS(selector)
   end
 
+  define_async_method :async_SS
+
   # @param {Function|string} pageFunction
   # @param {!Array<*>} args
   # @return {!Promise<!Puppeteer.JSHandle>}
@@ -281,6 +321,8 @@ class Puppeteer::Page
     context.evaluate_handle(page_function, *args)
   end
 
+  define_async_method :async_evaluate_handle
+
   # @param {!Puppeteer.JSHandle} prototypeHandle
   # @return {!Promise<!Puppeteer.JSHandle>}
   def query_objects(prototype_handle)
@@ -296,13 +338,7 @@ class Puppeteer::Page
     main_frame.Seval(selector, page_function, *args)
   end
 
-  # `$eval()` in JavaScript. $ is not allowed to use as a method name in Ruby.
-  # @param selector [String]
-  # @param page_function [String]
-  # @return [Future]
-  async def async_Seval(selector, page_function, *args)
-    Seval(selector, page_function, *args)
-  end
+  define_async_method :async_Seval
 
   # `$$eval()` in JavaScript. $ is not allowed to use as a method name in Ruby.
   # @param selector [String]
@@ -312,13 +348,7 @@ class Puppeteer::Page
     main_frame.SSeval(selector, page_function, *args)
   end
 
-  # `$$eval()` in JavaScript. $ is not allowed to use as a method name in Ruby.
-  # @param selector [String]
-  # @param page_function [String]
-  # @return [Future]
-  async def async_SSeval(selector, page_function, *args)
-    SSeval(selector, page_function, *args)
-  end
+  define_async_method :async_SSeval
 
   # `$x()` in JavaScript. $ is not allowed to use as a method name in Ruby.
   # @param {string} expression
@@ -327,6 +357,8 @@ class Puppeteer::Page
     main_frame.Sx(expression)
   end
 
+  define_async_method :async_Sx
+
   # /**
   #  * @param {!Array<string>} urls
   #  * @return {!Promise<!Array<Network.Cookie>>}
@@ -619,13 +651,14 @@ class Puppeteer::Page
     main_frame.content
   end
 
-  # @param {string} html
-  # @param {!{timeout?: number, waitUntil?: string|!Array<string>}=} options
+  # @param html [String]
+  # @param timeout [Integer]
+  # @param wait_until [String|Array<String>]
   def set_content(html, timeout: nil, wait_until: nil)
     main_frame.set_content(html, timeout: timeout, wait_until: wait_until)
   end
 
-  # @param {string} html
+  # @param html [String]
   def content=(html)
     main_frame.set_content(html)
   end
@@ -651,15 +684,10 @@ class Puppeteer::Page
   # @param timeout [number|nil]
   # @param wait_until [string|nil] 'load' | 'domcontentloaded' | 'networkidle0' | 'networkidle2'
   private def wait_for_navigation(timeout: nil, wait_until: nil)
-    main_frame.wait_for_navigation(timeout: timeout, wait_until: wait_until)
+    main_frame.send(:wait_for_navigation, timeout: timeout, wait_until: wait_until)
   end
 
-  # @param timeout [number|nil]
-  # @param wait_until [string|nil] 'load' | 'domcontentloaded' | 'networkidle0' | 'networkidle2'
-  # @return [Future]
-  async def async_wait_for_navigation(timeout: nil, wait_until: nil)
-    wait_for_navigation(timeout: timeout, wait_until: wait_until)
-  end
+  define_async_method :async_wait_for_navigation
 
   # /**
   #  * @param {(string|Function)} urlOrPredicate
@@ -792,6 +820,8 @@ class Puppeteer::Page
     main_frame.evaluate(page_function, *args)
   end
 
+  define_async_method :async_evaluate
+
   # /**
   #  * @param {Function|string} pageFunction
   #  * @param {!Array<*>} args
@@ -806,9 +836,9 @@ class Puppeteer::Page
     @frame_manager.network_manager.cache_enabled = enabled
   end
 
-  # @return {!Promise<string>}
+  # @return [String]
   def title
-    @title
+    main_frame.title
   end
 
   # /**
@@ -888,71 +918,66 @@ class Puppeteer::Page
     buffer
   end
 
-  # /**
-  #  * @param {!PDFOptions=} options
-  #  * @return {!Promise<!Buffer>}
-  #  */
-  # async pdf(options = {}) {
-  #   const {
-  #     scale = 1,
-  #     displayHeaderFooter = false,
-  #     headerTemplate = '',
-  #     footerTemplate = '',
-  #     printBackground = false,
-  #     landscape = false,
-  #     pageRanges = '',
-  #     preferCSSPageSize = false,
-  #     margin = {},
-  #     path = null
-  #   } = options;
+  class ProtocolStreamReader
+    def initialize(client:, handle:, path:)
+      @client = client
+      @handle = handle
+      @path = path
+    end
 
-  #   let paperWidth = 8.5;
-  #   let paperHeight = 11;
-  #   if (options.format) {
-  #     const format = Page.PaperFormats[options.format.toLowerCase()];
-  #     assert(format, 'Unknown paper format: ' + options.format);
-  #     paperWidth = format.width;
-  #     paperHeight = format.height;
-  #   } else {
-  #     paperWidth = convertPrintParameterToInches(options.width) || paperWidth;
-  #     paperHeight = convertPrintParameterToInches(options.height) || paperHeight;
-  #   }
+    def read
+      out = StringIO.new
+      File.open(@path, 'w') do |file|
+        eof = false
+        until eof
+          response = @client.send_message('IO.read', handle: @handle)
+          eof = response['eof']
+          data =
+            if response['base64Encoded']
+              Base64.decode64(response['data'])
+            else
+              response['data']
+            end
+          out.write(data)
+          file.write(data)
+        end
+      end
+      @client.send_message('IO.close', handle: @handle)
+      out.read
+    end
+  end
 
-  #   const marginTop = convertPrintParameterToInches(margin.top) || 0;
-  #   const marginLeft = convertPrintParameterToInches(margin.left) || 0;
-  #   const marginBottom = convertPrintParameterToInches(margin.bottom) || 0;
-  #   const marginRight = convertPrintParameterToInches(margin.right) || 0;
-
-  #   const result = await this._client.send('Page.printToPDF', {
-  #     transferMode: 'ReturnAsStream',
-  #     landscape,
-  #     displayHeaderFooter,
-  #     headerTemplate,
-  #     footerTemplate,
-  #     printBackground,
-  #     scale,
-  #     paperWidth,
-  #     paperHeight,
-  #     marginTop,
-  #     marginBottom,
-  #     marginLeft,
-  #     marginRight,
-  #     pageRanges,
-  #     preferCSSPageSize
-  #   });
-  #   return await helper.readProtocolStream(this._client, result.stream, path);
-  # }
+  class PrintToPdfIsNotImplementedError < StandardError
+    def initialize
+      super('pdf() is only available in headless mode. See https://github.com/puppeteer/puppeteer/issues/1829')
+    end
+  end
 
-  # @param {!{runBeforeUnload: (boolean|undefined)}=} options
-  def close
-    # assert(!!this._client._connection, 'Protocol error: Connection closed. Most likely the page has been closed.');
-    # const runBeforeUnload = !!options.runBeforeUnload;
-    # if (runBeforeUnload) {
-    #   await this._client.send('Page.close');
-    # } else {
-    #   await this._client._connection.send('Target.closeTarget', { targetId: this._target._targetId });
-    #   await this._target._isClosedPromise;
-    # }
+  # @return [String]
+  def pdf(options = {})
+    pdf_options = PDFOptions.new(options)
+    result = @client.send_message('Page.printToPDF', pdf_options.page_print_args)
+    ProtocolStreamReader.new(client: @client, handle: result['stream'], path: pdf_options.path).read
+  rescue => err
+    if err.message.include?('PrintToPDF is not implemented')
+      raise PrintToPdfIsNotImplementedError.new
+    else
+      raise
+    end
+  end
+
+  # @param run_before_unload [Boolean]
+  def close(run_before_unload: false)
+    unless @client.connection
+      raise 'Protocol error: Connection closed. Most likely the page has been closed.'
+    end
+
+    if run_before_unload
+      @client.send_message('Page.close')
+    else
+      @client.connection.send_message('Target.closeTarget', targetId: @target.target_id)
+      await @target.is_closed_promise
+    end
   end
 
   # @return [boolean]
@@ -970,20 +995,15 @@ class Puppeteer::Page
     main_frame.click(selector, delay: delay, button: button, click_count: click_count)
   end
 
-  # @param selector [String]
-  # @param delay [Number]
-  # @param button [String] "left"|"right"|"middle"
-  # @param click_count [Number]
-  # @return [Future]
-  async def async_click(selector, delay: nil, button: nil, click_count: nil)
-    click(selector, delay: delay, button: button, click_count: click_count)
-  end
+  define_async_method :async_click
 
   # @param {string} selector
   def focus(selector)
     main_frame.focus(selector)
   end
 
+  define_async_method :async_focus
+
   # @param {string} selector
   def hover(selector)
     main_frame.hover(selector)
@@ -996,15 +1016,14 @@ class Puppeteer::Page
     main_frame.select(selector, *values)
   end
 
+  define_async_method :async_select
+
   # @param selector [String]
   def tap(selector)
     main_frame.tap(selector)
   end
 
-  # @param selector [String]
-  async def async_tap(selector)
-    tap(selector)
-  end
+  define_async_method :async_tap
 
   # @param selector [String]
   # @param text [String]
@@ -1013,6 +1032,8 @@ class Puppeteer::Page
     main_frame.type_text(selector, text, delay: delay)
   end
 
+  define_async_method :async_type_text
+
   # /**
   #  * @param {(string|number|Function)} selectorOrFunctionOrTimeout
   #  * @param {!{visible?: boolean, hidden?: boolean, timeout?: number, polling?: string|number}=} options
@@ -1031,13 +1052,7 @@ class Puppeteer::Page
     main_frame.wait_for_selector(selector, visible: visible, hidden: hidden, timeout: timeout)
   end
 
-  # @param selector [String]
-  # @param visible [Boolean] Wait for element visible (not 'display: none' nor 'visibility: hidden') on true. default to false.
-  # @param hidden [Boolean] Wait for element invisible ('display: none' nor 'visibility: hidden') on true. default to false.
-  # @param timeout [Integer]
-  async def async_wait_for_selector(selector, visible: nil, hidden: nil, timeout: nil)
-    wait_for_selector(selector, visible: visible, hidden: hidden, timeout: timeout)
-  end
+  define_async_method :async_wait_for_selector
 
   # @param xpath [String]
   # @param visible [Boolean] Wait for element visible (not 'display: none' nor 'visibility: hidden') on true. default to false.
@@ -1047,13 +1062,7 @@ class Puppeteer::Page
     main_frame.wait_for_xpath(xpath, visible: visible, hidden: hidden, timeout: timeout)
   end
 
-  # @param xpath [String]
-  # @param visible [Boolean] Wait for element visible (not 'display: none' nor 'visibility: hidden') on true. default to false.
-  # @param hidden [Boolean] Wait for element invisible ('display: none' nor 'visibility: hidden') on true. default to false.
-  # @param timeout [Integer]
-  async def async_wait_for_xpath(xpath, visible: nil, hidden: nil, timeout: nil)
-    wait_for_xpath(xpath, visible: visible, hidden: hidden, timeout: timeout)
-  end
+  define_async_method :async_wait_for_xpath
 
   # @param {Function|string} pageFunction
   # @param {!{polling?: string|number, timeout?: number}=} options
@@ -1062,4 +1071,6 @@ class Puppeteer::Page
   def wait_for_function(page_function, options = {}, *args)
     main_frame.wait_for_function(page_function, options, *args)
   end
+
+  define_async_method :async_wait_for_function
 end

data/lib/puppeteer/page/pdf_options.rb

@@ -0,0 +1,166 @@
+require 'mime/types'
+
+class Puppeteer::Page
+  # /**
+  # * @typedef {Object} PDFOptions
+  # * @property {number=} scale
+  # * @property {boolean=} displayHeaderFooter
+  # * @property {string=} headerTemplate
+  # * @property {string=} footerTemplate
+  # * @property {boolean=} printBackground
+  # * @property {boolean=} landscape
+  # * @property {string=} pageRanges
+  # * @property {string=} format
+  # * @property {string|number=} width
+  # * @property {string|number=} height
+  # * @property {boolean=} preferCSSPageSize
+  # * @property {!{top?: string|number, bottom?: string|number, left?: string|number, right?: string|number}=} margin
+  # * @property {string=} path
+  # */
+  class PDFOptions
+    # @params options [Hash]
+    def initialize(options)
+      unless options[:path]
+        # Original puppeteer allows path = nil, however nothing to do without path actually.
+        # Also in most case, users forget to specify path parameter. So let's raise ArgumentError.
+        raise ArgumentError('"path" parameter must be specified.')
+      end
+
+      @scale = options[:scale]
+      @display_header_footer = options[:display_header_footer]
+      @header_template = options[:header_template]
+      @footer_template = options[:footer_template]
+      @print_background = options[:print_background]
+      @landscape = options[:landscape]
+      @page_ranges = options[:page_ranges]
+      @format = options[:format]
+      @width = options[:width]
+      @height = options[:height]
+      @prefer_css_page_size = options[:prefer_css_page_size]
+      @margin = Margin.new(options[:margin] || {})
+      @path = options[:path]
+    end
+
+    attr_reader :path
+
+    class PaperSize
+      def initialize(width:, height:)
+        @width = width
+        @height = height
+      end
+      attr_reader :width, :height
+    end
+
+    PAPER_FORMATS = {
+      letter: PaperSize.new(width: 8.5, height: 11),
+      legal: PaperSize.new(width: 8.5, height: 14),
+      tabloid: PaperSize.new(width: 11, height: 17),
+      ledger: PaperSize.new(width: 17, height: 11),
+      a0: PaperSize.new(width: 33.1, height: 46.8),
+      a1: PaperSize.new(width: 23.4, height: 33.1),
+      a2: PaperSize.new(width: 16.54, height: 23.4),
+      a3: PaperSize.new(width: 11.7, height: 16.54),
+      a4: PaperSize.new(width: 8.27, height: 11.7),
+      a5: PaperSize.new(width: 5.83, height: 8.27),
+      a6: PaperSize.new(width: 4.13, height: 5.83),
+    }
+
+    UNIT_TO_PIXELS = {
+      px: 1,
+      in: 96,
+      cm: 37.8,
+      mm: 3.78,
+    }
+
+    # @param parameter [String|Integer|nil]
+    private def convert_print_parameter_to_inches(parameter)
+      return nil if parameter.nil?
+
+      pixels =
+        if parameter.is_a?(Numeric)
+          parameter.to_i
+        elsif parameter.is_a?(String)
+          unit = parameter[-2..-1].downcase
+          value =
+            if UNIT_TO_PIXELS.has_key?(unit)
+              parameter[0...-2].to_i
+            else
+              unit = 'px'
+              parameter.to_i
+            end
+
+          value * UNIT_TO_PIXELS[unit]
+        else
+          raise ArgumentError.new("page.pdf() Cannot handle parameter type: #{parameter.class}")
+        end
+
+      pixels / 96
+    end
+
+    private def paper_size
+      @paper_size ||= calc_paper_size
+    end
+
+    # @return [PaperSize]
+    private def calc_paper_size
+      if @format
+        PAPER_FORMATS[@format.downcase] or raise ArgumentError.new("Unknown paper format: #{@format}")
+      else
+        PaperSize.new(
+          width: convert_print_parameter_to_inches(@width) || 8.5,
+          height: convert_print_parameter_to_inches(@height) || 11.0,
+        )
+      end
+    end
+
+    class Margin
+      def initialize(options)
+        @top = options[:top]
+        @bottom = options[:bottom]
+        @left = options[:left]
+        @right = options[:right]
+      end
+
+      def translate(&block)
+        new_margin ={
+          top: block.call(@top),
+          bottom: block.call(@bottom),
+          left: block.call(@left),
+          right: block.call(@right),
+        }
+        Margin.new(new_margin)
+      end
+      attr_reader :top, :bottom, :left, :right
+    end
+
+    private def margin
+      @__margin ||= calc_margin
+    end
+
+    private def calc_margin
+      @margin.translate do |value|
+        convert_print_parameter_to_inches(value) || 0
+      end
+    end
+
+    def page_print_args
+      {
+        transferMode: 'ReturnAsStream',
+        landscape: @landscape || false,
+        displayHeaderFooter: @display_header_footer || false,
+        headerTemplate: @header_template || '',
+        footerTemplate: @footer_template || '',
+        printBackground: @print_background || false,
+        scale: @scale || 1,
+        paperWidth: paper_size.width,
+        paperHeight: paper_size.height,
+        marginTop: margin.top,
+        marginBottom: margin.bottom,
+        marginLeft: margin.left,
+        marginRight: margin.right,
+        pageRanges: @page_ranges || '',
+        preferCSSPageSize: @prefer_css_page_size || false,
+      }
+    end
+  end
+end