puppeteer-bidi 0.0.1.beta9 → 0.0.1.beta10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: edd194659eaec6868546e49ad1536020e2038a24f67a93ed9e001ea6eaeaa2d1
-  data.tar.gz: c3953c37832af8ed0d5bba54d874d8ac11e7aeae1dd4ce3def5351ce4b0bcac0
+  metadata.gz: 9a52c1dcb0d3a791f2754c968a543411c98051380796455da1f0e24404923aa8
+  data.tar.gz: cd9c3880fe2f8ab49201c681efd39a95a77b477e6445cd620e3cdb3e7a7014d3
 SHA512:
-  metadata.gz: 4cf895f21941069d8734ed19cea9e74d337741788cef5077fbcafa3ead9d48863c49004d6979f4433646422902893aa91c79ca7c304431686c2bda040e034b26
-  data.tar.gz: 5006742e6f06dc708ae506ed4489a107d34981e29d14de71568f8a9d0ed0411c1f2e29de2b0fd8c039d81b5369895db3a0705b331b125e4f2fb6f5c7c4dabdb4
+  metadata.gz: 516d9e6b86a99902e20db1fd43d7d8521fcf8ce6850d72cf253cc6ae5af97f5bd591e2138f0c733d2d96f89f606e45f3d8b6f015ca4730e7b8f75b306dcbd0df
+  data.tar.gz: a2314ab02834c9ded0abdf5ba85bbae5dcf2252c9dbeaaf81c9f2d6c332d16fc291a6b18d6e36bc470d0585f960fb4cac8aa090467329fa816b47e693df7b024

data/CLAUDE/javascript_evaluation.md

@@ -179,7 +179,7 @@ end
 # In spec_helper.rb
 config.before(:suite) do
   if RSpec.configuration.files_to_run.any? { |f| f.include?('spec/integration') }
-    $shared_browser = Puppeteer::Bidi.launch(headless: headless_mode?)
+    $shared_browser = Puppeteer::Bidi.launch_browser_instance(headless: headless_mode?)
     $shared_test_server = TestServer::Server.new
     $shared_test_server.start
   end

data/CLAUDE/testing_strategy.md

@@ -74,7 +74,7 @@ end
 # In spec_helper.rb
 config.before(:suite) do
   if RSpec.configuration.files_to_run.any? { |f| f.include?('spec/integration') }
-    $shared_browser = Puppeteer::Bidi.launch(headless: headless_mode?)
+    $shared_browser = Puppeteer::Bidi.launch_browser_instance(headless: headless_mode?)
     $shared_test_server = TestServer::Server.new
     $shared_test_server.start
   end

data/README.md

@@ -54,84 +54,81 @@ gem 'puppeteer-bidi'
 require 'puppeteer/bidi'
 
 # Launch Firefox with BiDi protocol
-browser = Puppeteer::Bidi.launch(headless: false)
-
-# Create a new page
-page = browser.new_page
-
-# Set viewport size
-page.set_viewport(width: 1280, height: 720)
-
-# Navigate to a URL
-page.goto('https://example.com')
-
-# Take a screenshot
-page.screenshot(path: 'screenshot.png')
-
-# Take a full page screenshot
-page.screenshot(path: 'fullpage.png', full_page: true)
-
-# Screenshot with clipping
-page.screenshot(
-  path: 'clip.png',
-  clip: { x: 0, y: 0, width: 100, height: 100 }
-)
-
-# Evaluate JavaScript expressions
-title = page.evaluate('document.title')
-puts "Page title: #{title}"
-
-# Evaluate JavaScript functions with arguments
-sum = page.evaluate('(a, b) => a + b', 3, 4)
-puts "Sum: #{sum}"  # => 7
-
-# Access frame and evaluate
-frame = page.main_frame
-result = frame.evaluate('() => window.innerWidth')
-
-# Query selectors
-section = page.query_selector('section')
-divs = page.query_selector_all('div')
-
-# Evaluate on selectors (convenience methods)
-# Equivalent to Puppeteer's $eval and $$eval
-id = page.eval_on_selector('section', 'e => e.id')
-count = page.eval_on_selector_all('div', 'divs => divs.length')
-
-# Set page content
-page.set_content('<h1>Hello, World!</h1>')
-
-# Wait for navigation (Async/Fiber-based, no race conditions)
-# Block pattern - executes code and waits for resulting navigation
-response = page.wait_for_navigation do
-  page.click('a#navigation-link')
-end
-
-# Wait for fragment navigation (#hash changes)
-page.wait_for_navigation do
-  page.click('a[href="#section"]')
-end  # => nil (fragment navigation returns nil)
-
-# Wait for History API navigation
-page.wait_for_navigation do
-  page.evaluate('history.pushState({}, "", "/new-url")')
-end  # => nil (History API returns nil)
-
-# Wait with different conditions
-page.wait_for_navigation(wait_until: 'domcontentloaded') do
-  page.click('a')
+Puppeteer::Bidi.launch(headless: false) do |browser|
+  # Create a new page
+  page = browser.new_page
+
+  # Set viewport size
+  page.set_viewport(width: 1280, height: 720)
+
+  # Navigate to a URL
+  page.goto('https://example.com')
+
+  # Take a screenshot
+  page.screenshot(path: 'screenshot.png')
+
+  # Take a full page screenshot
+  page.screenshot(path: 'fullpage.png', full_page: true)
+
+  # Screenshot with clipping
+  page.screenshot(
+    path: 'clip.png',
+    clip: { x: 0, y: 0, width: 100, height: 100 }
+  )
+
+  # Evaluate JavaScript expressions
+  title = page.evaluate('document.title')
+  puts "Page title: #{title}"
+
+  # Evaluate JavaScript functions with arguments
+  sum = page.evaluate('(a, b) => a + b', 3, 4)
+  puts "Sum: #{sum}"  # => 7
+
+  # Access frame and evaluate
+  frame = page.main_frame
+  result = frame.evaluate('() => window.innerWidth')
+
+  # Query selectors
+  section = page.query_selector('section')
+  divs = page.query_selector_all('div')
+
+  # Evaluate on selectors (convenience methods)
+  # Equivalent to Puppeteer's $eval and $$eval
+  id = page.eval_on_selector('section', 'e => e.id')
+  count = page.eval_on_selector_all('div', 'divs => divs.length')
+
+  # Set page content
+  page.set_content('<h1>Hello, World!</h1>')
+
+  # Wait for navigation (Async/Fiber-based, no race conditions)
+  # Block pattern - executes code and waits for resulting navigation
+  response = page.wait_for_navigation do
+    page.click('a#navigation-link')
+  end
+
+  # Wait for fragment navigation (#hash changes)
+  page.wait_for_navigation do
+    page.click('a[href="#section"]')
+  end  # => nil (fragment navigation returns nil)
+
+  # Wait for History API navigation
+  page.wait_for_navigation do
+    page.evaluate('history.pushState({}, "", "/new-url")')
+  end  # => nil (History API returns nil)
+
+  # Wait with different conditions
+  page.wait_for_navigation(wait_until: 'domcontentloaded') do
+    page.click('a')
+  end
+
+  # User input simulation
+  page.click('button#submit')
+  page.type('input[name="email"]', 'user@example.com', delay: 100)
+  page.focus('textarea')
+
+  # Close the page
+  page.close
 end
-
-# User input simulation
-page.click('button#submit')
-page.type('input[name="email"]', 'user@example.com', delay: 100)
-page.focus('textarea')
-
-# Close the page
-page.close
-
-# Close the browser
-browser.close
 ```
 
 ### Low-Level BiDi API
@@ -140,30 +137,27 @@ browser.close
 require 'puppeteer/bidi'
 
 # Launch Firefox with BiDi protocol
-browser = Puppeteer::Bidi.launch(headless: false)
-
-# Create a new browsing context (tab)
-result = browser.new_context(type: 'tab')
-context_id = result['context']
-
-# Navigate to a URL
-browser.navigate(
-  context: context_id,
-  url: 'https://example.com',
-  wait: 'complete'
-)
-
-# Close the browsing context
-browser.close_context(context_id)
-
-# Close the browser
-browser.close
+Puppeteer::Bidi.launch(headless: false) do |browser|
+  # Create a new browsing context (tab)
+  result = browser.new_context(type: 'tab')
+  context_id = result['context']
+
+  # Navigate to a URL
+  browser.navigate(
+    context: context_id,
+    url: 'https://example.com',
+    wait: 'complete'
+  )
+
+  # Close the browsing context
+  browser.close_context(context_id)
+end
 ```
 
 ### Launch Options
 
 ```ruby
-browser = Puppeteer::Bidi.launch(
+Puppeteer::Bidi.launch(
   headless: true,              # Run in headless mode (default: true)
   executable_path: '/path/to/firefox',  # Path to Firefox executable (optional)
   user_data_dir: '/path/to/profile',    # User data directory (optional)
@@ -176,26 +170,26 @@ browser = Puppeteer::Bidi.launch(
 ```ruby
 require 'puppeteer/bidi'
 
-browser = Puppeteer::Bidi.launch(headless: false)
-
-# Subscribe to BiDi events
-browser.subscribe([
-  'browsingContext.navigationStarted',
-  'browsingContext.navigationComplete'
-])
-
-# Register event handlers
-browser.on('browsingContext.navigationStarted') do |params|
-  puts "Navigation started: #{params['url']}"
-end
-
-browser.on('browsingContext.navigationComplete') do |params|
-  puts "Navigation completed: #{params['url']}"
+Puppeteer::Bidi.launch(headless: false) do |browser|
+  # Subscribe to BiDi events
+  browser.subscribe([
+    'browsingContext.navigationStarted',
+    'browsingContext.navigationComplete'
+  ])
+
+  # Register event handlers
+  browser.on('browsingContext.navigationStarted') do |params|
+    puts "Navigation started: #{params['url']}"
+  end
+
+  browser.on('browsingContext.navigationComplete') do |params|
+    puts "Navigation completed: #{params['url']}"
+  end
+
+  # Create context and navigate
+  result = browser.new_context(type: 'tab')
+  browser.navigate(context: result['context'], url: 'https://example.com')
 end
-
-# Create context and navigate
-result = browser.new_context(type: 'tab')
-browser.navigate(context: result['context'], url: 'https://example.com')
 ```
 
 ### Connecting to Existing Browser
@@ -219,47 +213,47 @@ The Core layer provides a structured API over BiDi protocol:
 require 'puppeteer/bidi'
 
 # Launch browser and access connection
-browser = Puppeteer::Bidi.launch(headless: false)
-
-# Create Core layer objects
-session_info = { 'sessionId' => 'default-session', 'capabilities' => {} }
-session = Puppeteer::Bidi::Core::Session.new(browser.connection, session_info)
-core_browser = Puppeteer::Bidi::Core::Browser.from(session)
-session.browser = core_browser
-
-# Get default user context
-context = core_browser.default_user_context
-
-# Create browsing context with Core API
-browsing_context = context.create_browsing_context('tab')
-
-# Subscribe to events
-browsing_context.on(:load) do
-  puts "Page loaded!"
+Puppeteer::Bidi.launch(headless: false) do |browser|
+  # Create Core layer objects
+  session_info = { 'sessionId' => 'default-session', 'capabilities' => {} }
+  session = Puppeteer::Bidi::Core::Session.new(browser.connection, session_info)
+  core_browser = Puppeteer::Bidi::Core::Browser.from(session)
+  session.browser = core_browser
+
+  # Get default user context
+  context = core_browser.default_user_context
+
+  # Create browsing context with Core API
+  browsing_context = context.create_browsing_context('tab')
+
+  # Subscribe to events
+  browsing_context.on(:load) do
+    puts "Page loaded!"
+  end
+
+  browsing_context.subscribe(['browsingContext.load'])
+
+  # Navigate
+  browsing_context.navigate('https://example.com', wait: 'complete')
+
+  # Evaluate JavaScript
+  result = browsing_context.default_realm.evaluate('document.title', true)
+  puts "Title: #{result['value']}"
+
+  # Take screenshot
+  image_data = browsing_context.capture_screenshot(format: 'png')
+
+  # Error handling with custom exceptions
+  begin
+    browsing_context.navigate('https://example.com')
+  rescue Puppeteer::Bidi::Core::BrowsingContextClosedError => e
+    puts "Context was closed: #{e.reason}"
+  end
+
+  # Clean up
+  browsing_context.close
+  core_browser.close
 end
-
-browsing_context.subscribe(['browsingContext.load'])
-
-# Navigate
-browsing_context.navigate('https://example.com', wait: 'complete')
-
-# Evaluate JavaScript
-result = browsing_context.default_realm.evaluate('document.title', true)
-puts "Title: #{result['value']}"
-
-# Take screenshot
-image_data = browsing_context.capture_screenshot(format: 'png')
-
-# Error handling with custom exceptions
-begin
-  browsing_context.navigate('https://example.com')
-rescue Puppeteer::Bidi::Core::BrowsingContextClosedError => e
-  puts "Context was closed: #{e.reason}"
-end
-
-# Clean up
-browsing_context.close
-core_browser.close
 ```
 
 For more details on the Core layer, see `lib/puppeteer/bidi/core/README.md`.

data/lib/puppeteer/bidi/version.rb

@@ -2,6 +2,6 @@
 
 module Puppeteer
   module Bidi
-    VERSION = "0.0.1.beta9"
+    VERSION = "0.0.1.beta10"
   end
 end

data/lib/puppeteer/bidi.rb

@@ -33,42 +33,51 @@ require "puppeteer/bidi/browser"
 module Puppeteer
   module Bidi
     # Launch a new browser instance
-    #
     # @rbs executable_path: String? -- Path to browser executable
     # @rbs user_data_dir: String? -- Path to user data directory
-    # @rbs headless: bool? -- Run browser in headless mode
+    # @rbs headless: bool -- Run browser in headless mode
     # @rbs args: Array[String]? -- Additional browser arguments
     # @rbs timeout: Numeric? -- Launch timeout in seconds
-    #
-    #: (executable_path: String? , user_data_dir: String? , headless: bool , args: Array[String]? , timeout: Numeric?) -> Browser
-    #: (executable_path: String? , user_data_dir: String? , headless: bool , args: Array[String]? , timeout: Numeric?) { (Browser) -> untyped } -> untyped
+    # @rbs &block: (Browser) -> untyped -- Block to execute with the browser instance
+    # @rbs return: untyped
     def self.launch(executable_path: nil, user_data_dir: nil, headless: true, args: nil, timeout: nil, &block)
-      if block
-        Sync do
-          begin
-            browser = Browser.launch(
-              executable_path: executable_path,
-              user_data_dir: user_data_dir,
-              headless: headless,
-              args: args,
-              timeout: timeout
-            )
-            block.call(browser)
-          ensure
-            browser&.close
-          end
+      unless block
+        raise ArgumentError, 'Block is required for launch_with_sync'
+      end
+
+      Sync do
+        begin
+          browser = launch_browser_instance(
+            executable_path: executable_path,
+            user_data_dir: user_data_dir,
+            headless: headless,
+            args: args,
+            timeout: timeout
+          )
+          block.call(browser)
+        ensure
+          browser&.close
         end
-      else
-        Browser.launch(
-          executable_path: executable_path,
-          user_data_dir: user_data_dir,
-          headless: headless,
-          args: args,
-          timeout: timeout
-        )
       end
     end
 
+    # Launch a new browser instance
+    # @rbs executable_path: String? -- Path to browser executable
+    # @rbs user_data_dir: String? -- Path to user data directory
+    # @rbs headless: bool -- Run browser in headless mode
+    # @rbs args: Array[String]? -- Additional browser arguments
+    # @rbs timeout: Numeric? -- Launch timeout in seconds
+    # @rbs return: Browser -- Browser instance (if no block given)
+    def self.launch_browser_instance(executable_path: nil, user_data_dir: nil, headless: true, args: nil, timeout: nil)
+      Browser.launch(
+        executable_path: executable_path,
+        user_data_dir: user_data_dir,
+        headless: headless,
+        args: args,
+        timeout: timeout
+      )
+    end
+
     # Connect to an existing browser instance
     # @rbs ws_endpoint: String -- WebSocket endpoint URL
     # @rbs return: Browser -- Browser instance

data/sig/puppeteer/bidi.rbs

@@ -3,17 +3,23 @@
 module Puppeteer
   module Bidi
     # Launch a new browser instance
-    #
     # @rbs executable_path: String? -- Path to browser executable
     # @rbs user_data_dir: String? -- Path to user data directory
-    # @rbs headless: bool? -- Run browser in headless mode
+    # @rbs headless: bool -- Run browser in headless mode
     # @rbs args: Array[String]? -- Additional browser arguments
     # @rbs timeout: Numeric? -- Launch timeout in seconds
-    #
-    # : (executable_path: String? , user_data_dir: String? , headless: bool , args: Array[String]? , timeout: Numeric?) -> Browser
-    # : (executable_path: String? , user_data_dir: String? , headless: bool , args: Array[String]? , timeout: Numeric?) { (Browser) -> untyped } -> untyped
-    def self.launch: (executable_path: String?, user_data_dir: String?, headless: bool, args: Array[String]?, timeout: Numeric?) -> Browser
-                   | (executable_path: String?, user_data_dir: String?, headless: bool, args: Array[String]?, timeout: Numeric?) { (Browser) -> untyped } -> untyped
+    # @rbs &block: (Browser) -> untyped -- Block to execute with the browser instance
+    # @rbs return: untyped
+    def self.launch: (?executable_path: String?, ?user_data_dir: String?, ?headless: bool, ?args: Array[String]?, ?timeout: Numeric?) { (Browser) -> untyped } -> untyped
+
+    # Launch a new browser instance
+    # @rbs executable_path: String? -- Path to browser executable
+    # @rbs user_data_dir: String? -- Path to user data directory
+    # @rbs headless: bool -- Run browser in headless mode
+    # @rbs args: Array[String]? -- Additional browser arguments
+    # @rbs timeout: Numeric? -- Launch timeout in seconds
+    # @rbs return: Browser -- Browser instance (if no block given)
+    def self.launch_browser_instance: (?executable_path: String?, ?user_data_dir: String?, ?headless: bool, ?args: Array[String]?, ?timeout: Numeric?) -> Browser
 
     # Connect to an existing browser instance
     # @rbs ws_endpoint: String -- WebSocket endpoint URL

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: puppeteer-bidi
 version: !ruby/object:Gem::Version
-  version: 0.0.1.beta9
+  version: 0.0.1.beta10
 platform: ruby
 authors:
 - YusukeIwaki