puppeteer-ruby 0.0.17 → 0.0.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2277fda99720c2566927af9a2acfc56da2b8e87ee10521871c368fd4a05649b2
-  data.tar.gz: 59636e168935b0fb6c964cd62355ae3becf8199ed2ee1af58cb512ccacc9d7cb
+  metadata.gz: 63cde4d139f1dc95710efb059310822219b905ef4b44ec8a1347b4bdc97a6b2e
+  data.tar.gz: '0989de5d246bb1c2bcb5ab625eb0702f608ec6ec667db9bbcf4282cf419314fa'
 SHA512:
-  metadata.gz: b45495a2ae160e740e242bc04bb81bfa493c1101583393f78e8e7ff3d065c00594fe0196b8225ac73e281a17428127597d11c8f8323ba6b58d64b437e2979d97
-  data.tar.gz: 72c9bd1ca17f37927ceb51a79904583c638066e29cdb08cc2534e77bcc7b3ee348e53e69546ecd579917bd6d8db9c4413d4a63cf617ffa33b8c69c756603439e
+  metadata.gz: 96aaf3dc540e160dd983660f2ea4fa10a8c3a2126e9c56f57f9c7a11c31c956376f556473c2d6c591b4cf4253c92e91055cc564e1910fe6dbaf3eb8244d2e852
+  data.tar.gz: c2195746ce0ed09fb2be8e66cb842cc2fb9487c51cb2232e51f3970df0234aec97fce173627bbedd1c4d113cd82154c134a69d0f9eb02c23826ab0bc0ad7ee18

data/.rubocop.yml

@@ -146,17 +146,47 @@ Lint/AmbiguousOperator:
 Lint/AmbiguousRegexpLiteral:
   Enabled: true
 
+Lint/BinaryOperatorWithIdenticalOperands:
+  Enabled: true
+
+Lint/DeprecatedClassMethods:
+  Enabled: true
+
+Lint/DuplicateRescueException:
+  Enabled: true
+
 Lint/ErbNewArguments:
   Enabled: true
 
+Lint/EmptyConditionalBody:
+  Enabled: true
+
+Lint/FloatComparison:
+  Enabled: true
+
+Lint/MissingSuper:
+  Enabled: true
+
+Lint/OutOfRangeRegexpRef:
+  Enabled: true
+
+Lint/RedundantStringCoercion:
+  Enabled: true
+
 # Use my_method(my_arg) not my_method( my_arg ) or my_method my_arg.
 Lint/RequireParentheses:
   Enabled: true
 
+Lint/SelfAssignment:
+  Enabled: true
+
 Lint/ShadowingOuterLocalVariable:
   Enabled: true
 
-Lint/RedundantStringCoercion:
+Lint/TopLevelReturnWithArgument:
+  Enabled: true
+
+Lint/UnreachableLoop:
   Enabled: true
 
 Lint/UriEscapeUnescape:
@@ -165,15 +195,18 @@ Lint/UriEscapeUnescape:
 Lint/UselessAssignment:
   Enabled: true
 
-Lint/DeprecatedClassMethods:
+Style/ParenthesesAroundCondition:
   Enabled: true
 
-Style/ParenthesesAroundCondition:
+Style/ExplicitBlockArgument:
   Enabled: true
 
 Style/FrozenStringLiteralComment:
   Enabled: false
 
+Style/GlobalStdStream:
+  Enabled: true
+
 Style/HashEachMethods:
   Enabled: true
 
@@ -198,6 +231,9 @@ Style/Semicolon:
   Enabled: true
   AllowAsExpressionSeparator: true
 
+Style/StringConcatenation:
+  Enabled: true
+
 # Prefer Foo.method over Foo::method
 Style/ColonMethodCall:
   Enabled: true

data/README.md

@@ -1,3 +1,5 @@
+[![Gem Version](https://badge.fury.io/rb/puppeteer-ruby.svg)](https://badge.fury.io/rb/puppeteer-ruby)
+
 # Puppeteer in Ruby [UNDER HEAVY DEVELOPMENT]
 
 A Ruby port of [puppeteer](https://pptr.dev/).
@@ -47,7 +49,7 @@ end
 
 More usage examples can be found [here](https://github.com/YusukeIwaki/puppeteer-ruby-example)
 
-## Collaboration with Selenium or Capybara
+## :bulb: Collaboration with Selenium or Capybara
 
 It is really remarkable that we can use puppeteer functions in existing Selenium or Capybara codes, with a few configuration in advance.
 

data/lib/puppeteer/dom_world.rb

@@ -402,6 +402,26 @@ class Puppeteer::DOMWorld
   #   return new WaitTask(this, pageFunction, 'function', polling, timeout, ...args).promise;
   # }
 
+  # @param page_function [String]
+  # @param args [Array]
+  # @param polling [Integer|String]
+  # @param timeout [Integer]
+  # @return [Puppeteer::JSHandle]
+  def wait_for_function(page_function, args: [], polling: nil, timeout: nil)
+    option_polling = polling || 'raf'
+    option_timeout = timeout || @timeout_settings.timeout
+
+    Puppeteer::WaitTask.new(
+      dom_world: self,
+      predicate_body: page_function,
+      title: 'function',
+      polling: option_polling,
+      timeout: option_timeout,
+      args: args,
+    ).await_promise
+  end
+
+
   # @return [String]
   def title
     evaluate('() => document.title')
@@ -427,7 +447,7 @@ class Puppeteer::DOMWorld
 
     wait_task = Puppeteer::WaitTask.new(
       dom_world: self,
-      predicate_body: "return (#{PREDICATE})(...args)",
+      predicate_body: PREDICATE,
       title: title,
       polling: polling,
       timeout: option_timeout,

data/lib/puppeteer/element_handle.rb

@@ -3,6 +3,7 @@ require_relative './element_handle/box_model'
 require_relative './element_handle/point'
 
 class Puppeteer::ElementHandle < Puppeteer::JSHandle
+  include Puppeteer::DebugPrint
   include Puppeteer::IfPresent
   using Puppeteer::DefineAsyncMethod
 
@@ -62,7 +63,14 @@ class Puppeteer::ElementHandle < Puppeteer::JSHandle
   end
 
   def clickable_point
-    result = @remote_object.content_quads(@client)
+    result =
+      begin
+        @remote_object.content_quads(@client)
+      rescue => err
+        debug_puts(err)
+        nil
+      end
+
     if !result || result["quads"].empty?
       raise ElementNotVisibleError.new
     end
@@ -380,21 +388,24 @@ class Puppeteer::ElementHandle < Puppeteer::JSHandle
 
   define_async_method :async_Sx
 
-  #  /**
-  #   * @returns {!Promise<boolean>}
-  #   */
-  #  isIntersectingViewport() {
-  #    return this.evaluate(async element => {
-  #      const visibleRatio = await new Promise(resolve => {
-  #        const observer = new IntersectionObserver(entries => {
-  #          resolve(entries[0].intersectionRatio);
-  #          observer.disconnect();
-  #        });
-  #        observer.observe(element);
-  #      });
-  #      return visibleRatio > 0;
-  #    });
-  #  }
+  # in JS, #isIntersectingViewport.
+  # @return [Boolean]
+  def intersecting_viewport?
+    js = <<~JAVASCRIPT
+    async element => {
+      const visibleRatio = await new Promise(resolve => {
+        const observer = new IntersectionObserver(entries => {
+          resolve(entries[0].intersectionRatio);
+          observer.disconnect();
+        });
+        observer.observe(element);
+      });
+      return visibleRatio > 0;
+    }
+    JAVASCRIPT
+
+    evaluate(js)
+  end
 
   # @param quad [Array<Point>]
   private def compute_quad_area(quad)

data/lib/puppeteer/frame.rb

@@ -142,7 +142,7 @@ class Puppeteer::Frame
   end
 
   def child_frames
-    @child_frames.dup
+    @child_frames.to_a
   end
 
   def detached?
@@ -225,6 +225,11 @@ class Puppeteer::Frame
 
   define_async_method :async_wait_for_selector
 
+  # @param milliseconds [Integer] the number of milliseconds to wait.
+  def wait_for_timeout(milliseconds)
+    sleep(milliseconds / 1000.0)
+  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.
@@ -242,12 +247,13 @@ class Puppeteer::Frame
 
   define_async_method :async_wait_for_xpath
 
-  # @param {Function|string} pageFunction
-  # @param {!{polling?: string|number, timeout?: number}=} options
-  # @param {!Array<*>} args
-  # @return {!Promise<!Puppeteer.JSHandle>}
-  def wait_for_function(page_function, options = {}, *args)
-    @main_world.wait_for_function(page_function, options, *args)
+  # @param page_function [String]
+  # @param args [Integer|Array]
+  # @param polling [String]
+  # @param timeout [Integer]
+  # @return [Puppeteer::JSHandle]
+  def wait_for_function(page_function, args: [], polling: nil, timeout: nil)
+    @main_world.wait_for_function(page_function, args: args, polling: polling, timeout: timeout)
   end
 
   define_async_method :async_wait_for_function

data/lib/puppeteer/js_handle.rb

@@ -1,5 +1,6 @@
 class Puppeteer::JSHandle
   using Puppeteer::DefineAsyncMethod
+  include Puppeteer::IfPresent
 
   # @param context [Puppeteer::ExecutionContext]
   # @param remote_object [Puppeteer::RemoteObject]
@@ -57,21 +58,29 @@ class Puppeteer::JSHandle
 
   define_async_method :async_evaluate_handle
 
-  # /**
-  #  * @param {string} propertyName
-  #  * @return {!Promise<?JSHandle>}
-  #  */
-  # async getProperty(propertyName) {
-  #   const objectHandle = await this.evaluateHandle((object, propertyName) => {
-  #     const result = {__proto__: null};
-  #     result[propertyName] = object[propertyName];
-  #     return result;
-  #   }, propertyName);
-  #   const properties = await objectHandle.getProperties();
-  #   const result = properties.get(propertyName) || null;
-  #   await objectHandle.dispose();
-  #   return result;
-  # }
+  # getProperty(propertyName) in JavaScript
+  # @param name [String]
+  # @return [Puppeteer::JSHandle]
+  def property(name)
+    js = <<~JAVASCRIPT
+    (object, propertyName) => {
+      const result = {__proto__: null};
+      result[propertyName] = object[propertyName];
+      return result;
+    }
+    JAVASCRIPT
+    object_handle = evaluate_handle(js, name)
+    properties = object_handle.properties
+    result = properties[name]
+    object_handle.dispose
+    result
+  end
+
+  # @param name [String]
+  # @return [Puppeteer::JSHandle]
+  def [](name)
+    property(name)
+  end
 
   # getProperties in JavaScript.
   # @return [Hash<String, JSHandle>]
@@ -101,7 +110,7 @@ class Puppeteer::JSHandle
     #
     # However it would be better that RemoteObject is responsible for
     # the logic `if (this._remoteObject.objectId) { ... }`.
-    @remote_object.evaluate_self(@client) || @remote_object.value
+    @remote_object.evaluate_self(@client)&.value || @remote_object.value
   end
 
   def as_element
@@ -119,15 +128,16 @@ class Puppeteer::JSHandle
     @disposed
   end
 
-  # /**
-  #  * @override
-  #  * @return {string}
-  #  */
-  # toString() {
-  #   if (this._remoteObject.objectId) {
-  #     const type =  this._remoteObject.subtype || this._remoteObject.type;
-  #     return 'JSHandle@' + type;
-  #   }
-  #   return 'JSHandle:' + helper.valueFromRemoteObject(this._remoteObject);
-  # }
+  def to_s
+    # original logic was:
+    #   if (this._remoteObject.objectId) {
+    #     const type =  this._remoteObject.subtype || this._remoteObject.type;
+    #     return 'JSHandle@' + type;
+    #   }
+    #   return 'JSHandle:' + helper.valueFromRemoteObject(this._remoteObject);
+    #
+    # However it would be better that RemoteObject is responsible for
+    # the logic `if (this._remoteObject.objectId) { ... }`.
+    if_present(@remote_object.type_str) { |type_str| "JSHandle@#{type_str}" } || "JSHandle:#{@remote_object.value || 'undefined'}"
+  end
 end

data/lib/puppeteer/page.rb

@@ -1116,6 +1116,11 @@ class Puppeteer::Page
 
   define_async_method :async_wait_for_selector
 
+  # @param milliseconds [Integer] the number of milliseconds to wait.
+  def wait_for_timeout(milliseconds)
+    main_frame.wait_for_timeout(milliseconds)
+  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.
@@ -1126,12 +1131,13 @@ class Puppeteer::Page
 
   define_async_method :async_wait_for_xpath
 
-  # @param {Function|string} pageFunction
-  # @param {!{polling?: string|number, timeout?: number}=} options
-  # @param {!Array<*>} args
-  # @return {!Promise<!Puppeteer.JSHandle>}
-  def wait_for_function(page_function, options = {}, *args)
-    main_frame.wait_for_function(page_function, options, *args)
+  # @param page_function [String]
+  # @param args [Integer|Array]
+  # @param polling [String]
+  # @param timeout [Integer]
+  # @return [Puppeteer::JSHandle]
+  def wait_for_function(page_function, args: [], polling: nil, timeout: nil)
+    main_frame.wait_for_function(page_function, args: args, polling: polling, timeout: timeout)
   end
 
   define_async_method :async_wait_for_function

data/lib/puppeteer/remote_object.rb

@@ -6,6 +6,7 @@ class Puppeteer::RemoteObject
   # @param payload [Hash]
   def initialize(payload)
     @object_id = payload['objectId']
+    @type = payload['type']
     @sub_type = payload['subtype']
     @unserializable_value = payload['unserializableValue']
     @value = payload['value']
@@ -42,6 +43,21 @@ class Puppeteer::RemoteObject
     end
   end
 
+  # @return [String]
+  def type_str
+    # used in JSHandle#to_s
+    # original logic:
+    #   if (this._remoteObject.objectId) {
+    #     const type =  this._remoteObject.subtype || this._remoteObject.type;
+    #     return 'JSHandle@' + type;
+    #   }
+    if @object_id
+      @sub_type || @type
+    else
+      nil
+    end
+  end
+
   # used in JSHandle#properties
   def properties(client)
     # original logic:

data/lib/puppeteer/version.rb

@@ -1,3 +1,3 @@
 class Puppeteer
-  VERSION = '0.0.17'
+  VERSION = '0.0.18'
 end

data/lib/puppeteer/wait_task.rb

@@ -25,7 +25,7 @@ class Puppeteer::WaitTask
     @dom_world = dom_world
     @polling = polling
     @timeout = timeout
-    @predicate_body = predicate_body
+    @predicate_body = "return (#{predicate_body})(...args);"
     @args = args
     @run_count = 0
     @dom_world._wait_tasks.add(self)

data/puppeteer-ruby.gemspec

@@ -26,7 +26,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rspec_junit_formatter' # for CircleCI.
-  spec.add_development_dependency 'rubocop', '~> 0.86.0'
+  spec.add_development_dependency 'rubocop', '~> 0.89.0'
   spec.add_development_dependency 'rubocop-rspec'
   spec.add_development_dependency 'sinatra'
   spec.add_development_dependency 'yard'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppeteer-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.17
+  version: 0.0.18
 platform: ruby
 authors:
 - YusukeIwaki
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-28 00:00:00.000000000 Z
+date: 2020-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -128,14 +128,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.86.0
+        version: 0.89.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.86.0
+        version: 0.89.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement