puppeteer-ruby 0.33.0 → 0.34.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 68ef509ae2e0a0f1be52df6634beebea376ddc3434c824599a05eb0cd9ebe11a
-  data.tar.gz: 8a36d162aef0170fd171a799082fadbf98dedabb994ffc02b788a3ddcc2d47e3
+  metadata.gz: e5338fde85118520d164288e9853e88f3edfadd0c0d6be491edcbde0c9d5609c
+  data.tar.gz: b6ac2dada9f4c7ce72401cf75b39ca452801165d68d5bd6ae537cf3a390e68ff
 SHA512:
-  metadata.gz: 9df18ddd7b7b224f514a31e1d9e936e84b8048457f91ad7e5e150190db7dc15f199714dcc00bad4d932393785fb8f8eeaa602ed65a0648ff53a1a8bc475fb5d9
-  data.tar.gz: bb7d4c01427fbf6d020dfdbd076ec7e75e7cdb37747a2742ab0a094f2feaebcf556ebaae8754b13249fa5b49142bdf19fb0be16daa0365b16a65eefa6bbbe0f8
+  metadata.gz: eacd79d2af5cf69228ef6592739d20fd4f1739ec990355d904c32eb226c5dc998f7a37df7364a145df3e8beb763c304eaa8b1e1707c6aa8a237d4d8ec40f3b07
+  data.tar.gz: f0a725e220a109e0498c34e2f3e0d8e8e979b89d6003124d8cff7bb30c8b3579e72e5d1531a6f80669307d5a81a13f62fe99ee3c811ab9cffcb617bd12969830

data/CHANGELOG.md

@@ -1,7 +1,13 @@
-### master [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.33.0...master)]
+### master [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.34.0...master)]
 
 * xxx
 
+### 0.34.0 [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.33.0...0.34.0)]
+
+New features:
+
+* Sync API with block
+
 ### 0.33.0 [[diff](https://github.com/YusukeIwaki/puppeteer-ruby/compare/0.32.4...0.33.0)]
 
 NOTE: Requires Ruby version >= 2.6 explicitly since this version.

data/README.md

@@ -49,12 +49,13 @@ Puppeteer.launch(headless: false, slow_mo: 50, args: ['--guest', '--window-size=
   page.goto("https://github.com/", wait_until: 'domcontentloaded')
 
   form = page.query_selector("form.js-site-search-form")
-  searchInput = form.query_selector("input.header-search-input")
-  searchInput.type_text("puppeteer")
-  await_all(
-    page.async_wait_for_navigation,
-    searchInput.async_press("Enter"),
-  )
+  search_input = form.query_selector("input.header-search-input")
+  search_input.click
+  page.keyboard.type_text("puppeteer")
+
+  page.wait_for_navigation do
+    search_input.press('Enter')
+  end
 
   list = page.query_selector("ul.repo-list")
   items = list.query_selector_all("div.f4")
@@ -136,10 +137,9 @@ RSpec.describe 'hotel.testplanisphere.dev', type: :feature do
 
     reservation_link = puppeteer_page.query_selector_all('li.nav-item')[1]
 
-    await_all(
-      puppeteer_page.async_wait_for_navigation,
-      reservation_link.async_click,
-    )
+    puppeteer_page.wait_for_navigation do
+      reservation_link.click
+    end
 
     # expectation with Capybara DSL
     expect(page).to have_text('宿泊プラン一覧')

data/docs/api_coverage.md

@@ -1,6 +1,6 @@
 # API coverages
 - Puppeteer version: v10.0.0
-- puppeteer-ruby version: 0.33.0
+- puppeteer-ruby version: 0.34.0
 
 ## Puppeteer
 
@@ -131,9 +131,9 @@
 * ~~waitFor~~
 * waitForFileChooser => `#wait_for_file_chooser`
 * waitForFunction => `#wait_for_function`
-* waitForNavigation => `#async_wait_for_navigation`
-* waitForRequest => `#async_wait_for_request`
-* waitForResponse => `#async_wait_for_response`
+* waitForNavigation => `#wait_for_navigation`
+* waitForRequest => `#wait_for_request`
+* waitForResponse => `#wait_for_response`
 * waitForSelector => `#wait_for_selector`
 * waitForTimeout => `#wait_for_timeout`
 * waitForXPath => `#wait_for_xpath`
@@ -226,7 +226,7 @@
 * url
 * ~~waitFor~~
 * waitForFunction => `#wait_for_function`
-* waitForNavigation => `#async_wait_for_navigation`
+* waitForNavigation => `#wait_for_navigation`
 * waitForSelector => `#wait_for_selector`
 * waitForTimeout => `#wait_for_timeout`
 * waitForXPath => `#wait_for_xpath`

data/lib/puppeteer/concurrent_ruby_utils.rb

@@ -1,5 +1,23 @@
 # utility methods for Concurrent::Promises.
 module Puppeteer::ConcurrentRubyUtils
+  module ConcurrentPromisesFutureExtension
+    # Extension for describing 2 concurrent tasks smartly.
+    #
+    # page.async_for_navigation.with_waiting_for_complete do
+    #   page.click('#submit')
+    # end
+    def with_waiting_for_complete(&block)
+      async_block_call = Concurrent::Promises.future do
+        block.call
+      rescue => err
+        Logger.new($stderr).warn(err)
+        raise err
+      end
+
+      Concurrent::Promises.zip(self, async_block_call).value!.first
+    end
+  end
+
   # wait for all promises.
   # REMARK: This method doesn't assure the order of calling.
   # for example, await_all(async1, async2) calls calls2 -> calls1 often.
@@ -48,7 +66,7 @@ module Puppeteer::ConcurrentRubyUtils
     rescue => err
       Logger.new($stderr).warn(err)
       raise err
-    end
+    end.extend(ConcurrentPromisesFutureExtension)
   end
 
   def resolvable_future(&block)
@@ -56,7 +74,7 @@ module Puppeteer::ConcurrentRubyUtils
     if block
       block.call(future)
     end
-    future
+    future.extend(ConcurrentPromisesFutureExtension)
   end
 end
 

data/lib/puppeteer/define_async_method.rb

@@ -9,22 +9,73 @@ module Puppeteer::DefineAsyncMethod
         raise ArgumentError.new("#{async_method_name} is already defined")
       end
 
-      original_method = instance_method(async_method_name[6..-1])
+      original_method_name = async_method_name[6..-1]
+      original_method = instance_method(original_method_name)
+
+      # - Modify only wait_for_xxx
+      # - Do not modify private methods.
+      if method_defined?(original_method_name) && original_method_name.start_with?('wait_for_')
+        # def wait_for_xxx(xx, yy, &block)
+        #
+        # -> await_all(
+        #      async_wait_for_xxx(xx, yy),
+        #      future { block.call },
+        #    ).first
+        define_method(original_method_name) do |*args, **kwargs, &block|
+          if block
+            async_method_call =
+              if kwargs.empty? # for Ruby 2.6
+                Concurrent::Promises.future do
+                  original_method.bind(self).call(*args)
+                rescue => err
+                  Logger.new($stderr).warn(err)
+                  raise err
+                end
+              else
+                Concurrent::Promises.future do
+                  original_method.bind(self).call(*args, **kwargs)
+                rescue => err
+                  Logger.new($stderr).warn(err)
+                  raise err
+                end
+              end
+
+            async_block_call = Concurrent::Promises.future do
+              block.call
+            rescue => err
+              Logger.new($stderr).warn(err)
+              raise err
+            end
+
+            Concurrent::Promises.zip(
+              async_method_call,
+              async_block_call,
+            ).value!.first
+          else
+            if kwargs.empty? # for Ruby 2.6
+              original_method.bind(self).call(*args)
+            else
+              original_method.bind(self).call(*args, **kwargs)
+            end
+          end
+        end
+      end
+
       define_method(async_method_name) do |*args, **kwargs|
-        if kwargs.empty? # for Ruby < 2.7
+        if kwargs.empty? # for Ruby 2.6
           Concurrent::Promises.future do
             original_method.bind(self).call(*args)
           rescue => err
             Logger.new($stderr).warn(err)
             raise err
-          end
+          end.extend(Puppeteer::ConcurrentRubyUtils::ConcurrentPromisesFutureExtension)
         else
           Concurrent::Promises.future do
             original_method.bind(self).call(*args, **kwargs)
           rescue => err
             Logger.new($stderr).warn(err)
             raise err
-          end
+          end.extend(Puppeteer::ConcurrentRubyUtils::ConcurrentPromisesFutureExtension)
         end
       end
     end

data/lib/puppeteer/frame.rb

@@ -35,7 +35,7 @@ class Puppeteer::Frame
 
   # @param timeout [number|nil]
   # @param wait_until [string|nil] 'load' | 'domcontentloaded' | 'networkidle0' | 'networkidle2'
-  private def wait_for_navigation(timeout: nil, wait_until: nil)
+  def wait_for_navigation(timeout: nil, wait_until: nil)
     @frame_manager.wait_for_frame_navigation(self, timeout: timeout, wait_until: wait_until)
   end
 

data/lib/puppeteer/page.rb

@@ -637,7 +637,7 @@ class Puppeteer::Page
     ).first
   end
 
-  private def wait_for_navigation(timeout: nil, wait_until: nil)
+  def wait_for_navigation(timeout: nil, wait_until: nil)
     main_frame.send(:wait_for_navigation, timeout: timeout, wait_until: wait_until)
   end
 
@@ -683,7 +683,7 @@ class Puppeteer::Page
     end
   end
 
-  private def wait_for_request(url: nil, predicate: nil, timeout: nil)
+  def wait_for_request(url: nil, predicate: nil, timeout: nil)
     if !url && !predicate
       raise ArgumentError.new('url or predicate must be specified')
     end
@@ -717,7 +717,7 @@ class Puppeteer::Page
   # @param predicate [Proc(Puppeteer::Request -> Boolean)]
   define_async_method :async_wait_for_request
 
-  private def wait_for_response(url: nil, predicate: nil, timeout: nil)
+  def wait_for_response(url: nil, predicate: nil, timeout: nil)
     if !url && !predicate
       raise ArgumentError.new('url or predicate must be specified')
     end

data/lib/puppeteer/version.rb

@@ -1,3 +1,3 @@
 module Puppeteer
-  VERSION = '0.33.0'
+  VERSION = '0.34.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppeteer-ruby
 version: !ruby/object:Gem::Version
-  version: 0.33.0
+  version: 0.34.0
 platform: ruby
 authors:
 - YusukeIwaki
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-06-22 00:00:00.000000000 Z
+date: 2021-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby