capybara-playwright-driver 0.0.0.pre.r1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b85ab44fa6fca141e177e1ef28197af313cda7e2e1f23cd4d51a8edf5b12e97f
+  data.tar.gz: 7b665e1abde79e8f41804773de8af36b46e438cca2908671b87e7190bc23268d
+SHA512:
+  metadata.gz: 8a0190946c3581203b63000d5e3cf1a5b5c97daeacbbfb4c9eeaba0ab2c1aba1757492e59b9ccc286090f5763116b660b18095400e9e2343645f4fa28a9e6086
+  data.tar.gz: acc5f5d43c7c46efa61ed501bce789c4fb22e86c19eb83d3133aa1b32cc4521f456973fcedcc0b2b8930bcb31d2c52d253fbfb5649ffd6a1f9aed7b3a9aeba71

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at iwaki@i3-systems.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in capybara-playwright.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 YusukeIwaki
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,43 @@
+# 🎭 Playwright driver for Capybara
+
+```ruby
+gem 'capybara-playwright-driver'
+```
+
+## Examples
+
+```ruby
+require 'capybara-playwright-driver'
+
+# setup
+Capybara.register_driver(:playwright) do |app|
+  Capybara::Playwright::Driver.new(app, browser_type: :firefox, headless: false)
+end
+Capybara.default_max_wait_time = 15
+Capybara.default_driver = :playwright
+Capybara.save_path = 'tmp/capybara'
+
+# run
+Capybara.app_host = 'https://github.com'
+visit '/'
+fill_in('q', with: 'Capybara')
+
+## [REMARK] Use Playwright-native Page instead of flaky Capybara's selector/action.
+# find('a[data-item-type="global_search"]').click
+page.driver.with_playwright_page do |page|
+  page.click('a[data-item-type="global_search"]')
+end
+
+all('.repo-list-item').each do |li|
+  puts "#{li.all('a').first.text} by Capybara"
+  puts "#{li.with_playwright_element_handle { |handle| handle.query_selector('a').text_content }} by Playwright"
+end
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Capybara::Playwright project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/capybara-playwright/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'capybara/playwright'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/capybara-playwright.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'capybara/playwright/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'capybara-playwright-driver'
+  spec.version       = Capybara::Playwright::VERSION
+
+  spec.authors       = ['YusukeIwaki']
+  spec.email         = ['q7w8e9w8q7w8e9@yahoo.co.jp']
+
+  spec.summary       = 'Playwright driver for Capybara'
+  spec.homepage      = 'https://github.com/YusukeIwaki/capybara-playwright-driver'
+  spec.license       = 'MIT'
+
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{^(test|spec|features)/}) || f.include?('.git')
+    end
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'capybara'
+  spec.add_dependency 'playwright-ruby-client', '>= 0.5.9'
+  spec.add_development_dependency 'bundler', '~> 2.2.3'
+  spec.add_development_dependency 'launchy', '>= 2.0.4'
+  spec.add_development_dependency 'pry-byebug'
+  spec.add_development_dependency 'rake', '~> 13.0.3'
+  spec.add_development_dependency 'rspec', '~> 3.10.0'
+  spec.add_development_dependency 'rubocop', '~> 1.7.0'
+  spec.add_development_dependency 'rubocop-rspec'
+  spec.add_development_dependency 'sinatra', '>= 1.4.0'
+  spec.add_development_dependency 'webrick'
+end

data/lib/capybara-playwright-driver.rb

@@ -0,0 +1,2 @@
+# just an alias.
+require 'capybara/playwright'

data/lib/capybara/playwright.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'capybara'
+require 'playwright'
+
+require 'capybara/playwright/browser'
+require 'capybara/playwright/browser_options'
+require 'capybara/playwright/dialog_event_handler'
+require 'capybara/playwright/driver'
+require 'capybara/playwright/node'
+require 'capybara/playwright/page'
+require 'capybara/playwright/page_options'
+require 'capybara/playwright/version'

data/lib/capybara/playwright/browser.rb

@@ -0,0 +1,319 @@
+module Capybara
+  module Playwright
+    class Browser
+      extend Forwardable
+
+      class NoSuchWindowError < StandardError ; end
+
+      def initialize(playwright:, driver:, browser_type:, browser_options:, page_options:)
+        @driver = driver
+
+        browser_type = playwright.send(browser_type)
+        @playwright_browser = browser_type.launch(**browser_options)
+        @page_options = page_options
+        @playwright_page = create_page(create_browser_context)
+      end
+
+      private def create_browser_context
+        @playwright_browser.new_context(**@page_options).tap do |browser_context|
+          browser_context.on('page', ->(page) {
+            unless @playwright_page
+              @playwright_page = page
+            end
+          })
+        end
+      end
+
+      private def create_page(browser_context)
+        browser_context.new_page.tap do |page|
+          page.on('close', -> {
+            if @playwright_page
+              @playwright_page = nil
+            end
+          })
+        end
+      end
+
+      def quit
+        @playwright_browser.close
+      end
+
+      def current_url
+        assert_page_alive
+
+        @playwright_page.url
+      end
+
+      def visit(path)
+        assert_page_alive
+
+        url =
+          if Capybara.app_host
+            URI(Capybara.app_host).merge(path)
+          elsif Capybara.default_host
+            URI(Capybara.default_host).merge(path)
+          else
+            path
+          end
+
+        @playwright_page.capybara_current_frame.goto(url)
+      end
+
+      def refresh
+        assert_page_alive
+
+        @playwright_page.capybara_current_frame.evaluate('() => { location.reload(true) }')
+      end
+
+      def find_xpath(query, **options)
+        assert_page_alive
+
+        @playwright_page.capybara_current_frame.query_selector_all("xpath=#{query}").map do |el|
+          Node.new(@driver, @puppeteer_page, el)
+        end
+      end
+
+      def find_css(query, **options)
+        assert_page_alive
+
+        @playwright_page.capybara_current_frame.query_selector_all(query).map do |el|
+          Node.new(@driver, @playwright_page, el)
+        end
+      end
+
+      def response_headers
+        assert_page_alive
+
+        @playwright_page.capybara_response_headers
+      end
+
+      def status_code
+        assert_page_alive
+
+        @playwright_page.capybara_status_code
+      end
+
+      def html
+        assert_page_alive
+
+        js = <<~JAVASCRIPT
+        () => {
+          let html = '';
+          if (document.doctype) html += new XMLSerializer().serializeToString(document.doctype);
+          if (document.documentElement) html += document.documentElement.outerHTML;
+          return html;
+        }
+        JAVASCRIPT
+        @playwright_page.capybara_current_frame.evaluate(js)
+      end
+
+      def title
+        assert_page_alive
+
+        @playwright_page.title
+      end
+
+      def go_back
+        assert_page_alive
+
+        @playwright_page.go_back
+      end
+
+      def go_forward
+        assert_page_alive
+
+        @playwright_page.go_forward
+      end
+
+      def execute_script(script, *args)
+        assert_page_alive
+
+        @playwright_page.capybara_current_frame.evaluate("function (arguments) { #{script} }", arg: unwrap_node(args))
+        nil
+      end
+
+      def evaluate_script(script, *args)
+        assert_page_alive
+
+        result = @playwright_page.capybara_current_frame.evaluate_handle("function (arguments) { return #{script} }", arg: unwrap_node(args))
+        wrap_node(result)
+      end
+
+      def evaluate_async_script(script, *args)
+        assert_page_alive
+
+        js = <<~JAVASCRIPT
+        function(_arguments){
+          let args = Array.prototype.slice.call(_arguments);
+          return new Promise((resolve, reject) => {
+            args.push(resolve);
+            (function(){ #{script} }).apply(this, args);
+          });
+        }
+        JAVASCRIPT
+        result = @playwright_page.capybara_current_frame.evaluate_handle(js, arg: unwrap_node(args))
+        wrap_node(result)
+      end
+
+      def save_screenshot(path, **options)
+        assert_page_alive
+
+        @playwright_page.screenshot(path: path)
+      end
+
+      def send_keys(*args)
+        Node::SendKeys.new(@playwright_page.keyboard, args).execute
+      end
+
+      def switch_to_frame(frame)
+        assert_page_alive
+
+        case frame
+        when :top
+          @playwright_page.capybara_reset_frames
+        when :parent
+          @playwright_page.capybara_pop_frame
+        else
+          playwright_frame = frame.native.content_frame
+          raise ArgumentError.new("Not a frame element: #{frame}") unless playwright_frame
+          @playwright_page.capybara_push_frame(playwright_frame)
+        end
+      end
+
+      private def assert_page_alive
+        if !@playwright_page || @playwright_page.closed?
+          raise NoSuchWindowError
+        end
+      end
+
+      private def pages
+        @playwright_browser.contexts.flat_map(&:pages)
+      end
+
+      def window_handles
+        pages.map(&:guid)
+      end
+
+      def current_window_handle
+        @playwright_page&.guid
+      end
+
+      def open_new_window(kind = :tab)
+        browser_context =
+          if kind == :tab
+            @playwright_page&.context || create_browser_context
+          else
+            create_browser_context
+          end
+
+        create_page(browser_context)
+      end
+
+      private def on_window(handle, &block)
+        page = pages.find { |page| page.guid == handle }
+        if page
+          block.call(page)
+        else
+          raise NoSuchWindowError
+        end
+      end
+
+      def switch_to_window(handle)
+        if @playwright_page&.guid != handle
+          on_window(handle) do |page|
+            @playwright_page = page.tap(&:bring_to_front)
+          end
+        end
+      end
+
+      def close_window(handle)
+        on_window(handle) do |page|
+          page.close
+
+          if @playwright_page&.guid == handle
+            @playwright_page = nil
+          end
+        end
+      end
+
+      def window_size(handle)
+        on_window(handle) do |page|
+          page.evaluate('() => [window.innerWidth, window.innerHeight]')
+        end
+      end
+
+      def resize_window_to(handle, width, height)
+        on_window(handle) do |page|
+          page.viewport_size = { width: width, height: height }
+        end
+      end
+
+      def maximize_window(handle)
+        puts "[WARNING] maximize_window is not supported in Playwright driver"
+        # incomplete in Playwright
+        # ref: https://github.com/twalpole/apparition/blob/11aca464b38b77585191b7e302be2e062bdd369d/lib/capybara/apparition/page.rb#L346
+        on_window(handle) do |page|
+          screen_size = page.evaluate('() => ({ width: window.screen.width, height: window.screen.height})')
+          page.viewport_size = screen_size
+        end
+      end
+
+      def fullscreen_window(handle)
+        puts "[WARNING] fullscreen_window is not supported in Playwright driver"
+        # incomplete in Playwright
+        # ref: https://github.com/twalpole/apparition/blob/11aca464b38b77585191b7e302be2e062bdd369d/lib/capybara/apparition/page.rb#L341
+        on_window(handle) do |page|
+          page.evaluate('() => document.body.requestFullscreen()')
+        end
+      end
+
+      def accept_modal(dialog_type, **options, &block)
+        assert_page_alive
+
+        @playwright_page.capybara_accept_modal(dialog_type, **options, &block)
+      end
+
+      def dismiss_modal(dialog_type, **options, &block)
+        assert_page_alive
+
+        @playwright_page.capybara_dismiss_modal(dialog_type, **options, &block)
+      end
+
+      private def unwrap_node(args)
+        args.map do |arg|
+          if arg.is_a?(Node)
+            arg.send(:element)
+          else
+            arg
+          end
+        end
+      end
+
+      private def wrap_node(arg)
+        case arg
+        when Array
+          arg.map do |item|
+            wrap_node(item)
+          end
+        when Hash
+          arg.map do |key, value|
+            [key, wrap_node(value)]
+          end.to_h
+        when ::Playwright::ElementHandle
+          Node.new(@driver, @puppeteer_page, arg)
+        when ::Playwright::JSHandle
+          arg.json_value
+        else
+          arg
+        end
+      end
+
+      def with_playwright_page(&block)
+        assert_page_alive
+        raise ArgumentError.new('block must be given') unless block
+
+        block.call(@playwright_page)
+      end
+    end
+  end
+end