puppeteer-ruby 0.0.13 → 0.0.14

data/lib/puppeteer/mouse.rb

@@ -1,5 +1,5 @@
 class Puppeteer::Mouse
-  using Puppeteer::AsyncAwaitBehavior
+  using Puppeteer::DefineAsyncMethod
 
   module Button
     NONE = 'none'
@@ -44,13 +44,7 @@ class Puppeteer::Mouse
     end
   end
 
-  # @param x [number]
-  # @param y [number]
-  # @param steps [number]
-  # @return [Future]
-  async def async_move(x, y, steps: nil)
-    move(x, y, steps: steps)
-  end
+  define_async_method :async_move
 
   # @param x [number]
   # @param y [number]
@@ -70,13 +64,7 @@ class Puppeteer::Mouse
     up(button: button, click_count: click_count)
   end
 
-  # @param x [number]
-  # @param y [number]
-  # @param {!{delay?: number, button?: "left"|"right"|"middle", clickCount?: number}=} options
-  # @return [Future]
-  async def async_click(x, y, delay: nil, button: nil, click_count: nil)
-    click(x, y, delay: delay, button: button, click_count: click_count)
-  end
+  define_async_method :async_click
 
   # @param {!{button?: "left"|"right"|"middle", clickCount?: number}=} options
   def down(button: nil, click_count: nil)
@@ -91,11 +79,7 @@ class Puppeteer::Mouse
     )
   end
 
-  # @param {!{button?: "left"|"right"|"middle", clickCount?: number}=} options
-  # @return [Future]
-  async def async_down(button: nil, click_count: nil)
-    down(button: button, click_count: click_count)
-  end
+  define_async_method :async_down
 
   # @param {!{button?: "left"|"right"|"middle", clickCount?: number}=} options
   def up(button: nil, click_count: nil)
@@ -110,9 +94,5 @@ class Puppeteer::Mouse
     )
   end
 
-  # @param {!{button?: "left"|"right"|"middle", clickCount?: number}=} options
-  # @return [Future]
-  async def async_up(button: nil, click_count: nil)
-    up(button: button, click_count: click_count)
-  end
+  define_async_method :async_up
 end

data/lib/puppeteer/page.rb

@@ -5,7 +5,7 @@ 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
@@ -205,12 +205,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
@@ -305,6 +300,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>>}
@@ -312,6 +309,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>}
@@ -320,6 +319,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)
@@ -335,13 +336,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]
@@ -351,13 +346,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
@@ -366,6 +355,8 @@ class Puppeteer::Page
     main_frame.Sx(expression)
   end
 
+  define_async_method :async_Sx
+
   # /**
   #  * @param {!Array<string>} urls
   #  * @return {!Promise<!Array<Network.Cookie>>}
@@ -693,12 +684,7 @@ class Puppeteer::Page
     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
@@ -831,6 +817,8 @@ class Puppeteer::Page
     main_frame.evaluate(page_function, *args)
   end
 
+  define_async_method :async_evaluate
+
   # /**
   #  * @param {Function|string} pageFunction
   #  * @param {!Array<*>} args
@@ -982,16 +970,18 @@ class Puppeteer::Page
   #   return await helper.readProtocolStream(this._client, result.stream, path);
   # }
 
-  # @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;
-    # }
+  # @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]
@@ -1009,20 +999,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)
@@ -1035,15 +1020,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]
@@ -1052,6 +1036,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
@@ -1070,13 +1056,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.
@@ -1086,13 +1066,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
@@ -1101,4 +1075,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/remote_object.rb

@@ -1,7 +1,7 @@
 # providing #valueFromRemoteObject, #releaseObject
 class Puppeteer::RemoteObject
   include Puppeteer::DebugPrint
-  using Puppeteer::AsyncAwaitBehavior
+  using Puppeteer::DefineAsyncMethod
 
   # @param payload [Hash]
   def initialize(payload)
@@ -111,10 +111,7 @@ class Puppeteer::RemoteObject
     nil
   end
 
-  # @param client [Puppeteer::CDPSession]
-  async def async_release(client)
-    release(client)
-  end
+  define_async_method :async_release
 
   def converted_arg
     # ported logic from ExecutionContext#convertArgument

data/lib/puppeteer/touch_screen.rb

@@ -1,5 +1,5 @@
 class Puppeteer::TouchScreen
-  using Puppeteer::AsyncAwaitBehavior
+  using Puppeteer::DefineAsyncMethod
 
   # @param {Puppeteer.CDPSession} client
   # @param keyboard [Puppeteer::Keyboard]
@@ -34,10 +34,5 @@ class Puppeteer::TouchScreen
     )
   end
 
-  # @param x [number]
-  # @param y [number]
-  # @return [Future]
-  async def async_tap(x, y)
-    tap(x, y)
-  end
+  define_async_method :async_tap
 end

data/lib/puppeteer/version.rb

@@ -1,3 +1,3 @@
 class Puppeteer
-  VERSION = '0.0.13'
+  VERSION = '0.0.14'
 end

data/lib/puppeteer/wait_task.rb

@@ -1,5 +1,5 @@
 class Puppeteer::WaitTask
-  using Puppeteer::AsyncAwaitBehavior
+  using Puppeteer::DefineAsyncMethod
 
   class TerminatedError < StandardError; end
 
@@ -106,9 +106,7 @@ class Puppeteer::WaitTask
     @dom_world._wait_tasks.delete(self)
   end
 
-  private async def async_rerun
-    rerun
-  end
+  private define_async_method :async_rerun
 
   WAIT_FOR_PREDICATE_PAGE_FUNCTION = <<~JAVASCRIPT
   async function _(predicateBody, polling, timeout, ...args) {

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.82.0'
+  spec.add_development_dependency 'rubocop', '~> 0.86.0'
   spec.add_development_dependency 'rubocop-rspec'
   spec.add_development_dependency 'yard'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppeteer-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.13
+  version: 0.0.14
 platform: ruby
 authors:
 - YusukeIwaki
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-23 00:00:00.000000000 Z
+date: 2020-06-27 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.82.0
+        version: 0.86.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.82.0
+        version: 0.86.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -173,6 +173,8 @@ extra_rdoc_files: []
 files:
 - ".circleci/config.yml"
 - ".github/stale.yml"
+- ".github/workflows/docs.yml"
+- ".github/workflows/reviewdog.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -182,106 +184,7 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- docs/Puppeteer.html
-- docs/Puppeteer/AsyncAwaitBehavior.html
-- docs/Puppeteer/Browser.html
-- docs/Puppeteer/BrowserContext.html
-- docs/Puppeteer/BrowserFetcher.html
-- docs/Puppeteer/BrowserRunner.html
-- docs/Puppeteer/BrowserRunner/BrowserProcess.html
-- docs/Puppeteer/CDPSession.html
-- docs/Puppeteer/CDPSession/Error.html
-- docs/Puppeteer/ConcurrentRubyUtils.html
-- docs/Puppeteer/Connection.html
-- docs/Puppeteer/Connection/MessageCallback.html
-- docs/Puppeteer/Connection/ProtocolError.html
-- docs/Puppeteer/Connection/RequestDebugPrinter.html
-- docs/Puppeteer/Connection/ResponseDebugPrinter.html
-- docs/Puppeteer/ConsoleMessage.html
-- docs/Puppeteer/ConsoleMessage/Location.html
-- docs/Puppeteer/DOMWorld.html
-- docs/Puppeteer/DOMWorld/DetachedError.html
-- docs/Puppeteer/DOMWorld/DocumentEvaluationError.html
-- docs/Puppeteer/DebugPrint.html
-- docs/Puppeteer/Device.html
-- docs/Puppeteer/Devices.html
-- docs/Puppeteer/ElementHandle.html
-- docs/Puppeteer/ElementHandle/BoundingBox.html
-- docs/Puppeteer/ElementHandle/BoxModel.html
-- docs/Puppeteer/ElementHandle/ElementNotFoundError.html
-- docs/Puppeteer/ElementHandle/ElementNotVisibleError.html
-- docs/Puppeteer/ElementHandle/Point.html
-- docs/Puppeteer/ElementHandle/ScrollIntoViewError.html
-- docs/Puppeteer/EmulationManager.html
-- docs/Puppeteer/EventCallbackable.html
-- docs/Puppeteer/EventCallbackable/EventListeners.html
-- docs/Puppeteer/ExecutionContext.html
-- docs/Puppeteer/ExecutionContext/EvaluationError.html
-- docs/Puppeteer/ExecutionContext/JavaScriptExpression.html
-- docs/Puppeteer/ExecutionContext/JavaScriptFunction.html
-- docs/Puppeteer/FileChooser.html
-- docs/Puppeteer/Frame.html
-- docs/Puppeteer/FrameManager.html
-- docs/Puppeteer/FrameManager/NavigationError.html
-- docs/Puppeteer/IfPresent.html
-- docs/Puppeteer/JSHandle.html
-- docs/Puppeteer/Keyboard.html
-- docs/Puppeteer/Keyboard/KeyDefinition.html
-- docs/Puppeteer/Keyboard/KeyDescription.html
-- docs/Puppeteer/Launcher.html
-- docs/Puppeteer/Launcher/Base.html
-- docs/Puppeteer/Launcher/Base/ExecutablePathNotFound.html
-- docs/Puppeteer/Launcher/BrowserOptions.html
-- docs/Puppeteer/Launcher/Chrome.html
-- docs/Puppeteer/Launcher/Chrome/DefaultArgs.html
-- docs/Puppeteer/Launcher/ChromeArgOptions.html
-- docs/Puppeteer/Launcher/LaunchOptions.html
-- docs/Puppeteer/LifecycleWatcher.html
-- docs/Puppeteer/LifecycleWatcher/ExpectedLifecycle.html
-- docs/Puppeteer/LifecycleWatcher/FrameDetachedError.html
-- docs/Puppeteer/LifecycleWatcher/TerminatedError.html
-- docs/Puppeteer/Mouse.html
-- docs/Puppeteer/Mouse/Button.html
-- docs/Puppeteer/NetworkManager.html
-- docs/Puppeteer/NetworkManager/Credentials.html
-- docs/Puppeteer/Page.html
-- docs/Puppeteer/Page/FileChooserTimeoutError.html
-- docs/Puppeteer/Page/ScreenshotOptions.html
-- docs/Puppeteer/Page/ScriptTag.html
-- docs/Puppeteer/Page/StyleTag.html
-- docs/Puppeteer/Page/TargetCrashedError.html
-- docs/Puppeteer/RemoteObject.html
-- docs/Puppeteer/Target.html
-- docs/Puppeteer/Target/InitializeFailure.html
-- docs/Puppeteer/Target/TargetInfo.html
-- docs/Puppeteer/TimeoutError.html
-- docs/Puppeteer/TimeoutSettings.html
-- docs/Puppeteer/TouchScreen.html
-- docs/Puppeteer/Viewport.html
-- docs/Puppeteer/WaitTask.html
-- docs/Puppeteer/WaitTask/TerminatedError.html
-- docs/Puppeteer/WaitTask/TimeoutError.html
-- docs/Puppeteer/WebSocket.html
-- docs/Puppeteer/WebSocket/DriverImpl.html
-- docs/Puppeteer/WebSocket/TransportError.html
-- docs/Puppeteer/WebSocketTransport.html
-- docs/Puppeteer/WebSocktTransportError.html
-- docs/_index.html
-- docs/class_list.html
-- docs/css/common.css
-- docs/css/full_list.css
-- docs/css/style.css
-- docs/file.README.html
-- docs/file_list.html
-- docs/frames.html
-- docs/index.html
-- docs/js/app.js
-- docs/js/full_list.js
-- docs/js/jquery.js
-- docs/method_list.html
-- docs/top-level-namespace.html
 - lib/puppeteer.rb
-- lib/puppeteer/async_await_behavior.rb
 - lib/puppeteer/browser.rb
 - lib/puppeteer/browser_context.rb
 - lib/puppeteer/browser_fetcher.rb
@@ -291,6 +194,7 @@ files:
 - lib/puppeteer/connection.rb
 - lib/puppeteer/console_message.rb
 - lib/puppeteer/debug_print.rb
+- lib/puppeteer/define_async_method.rb
 - lib/puppeteer/device.rb
 - lib/puppeteer/devices.rb
 - lib/puppeteer/dom_world.rb