capybara-puppeteer-driver 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0b6ce352841199c3218ea9b9ea07c24e54e8c25b72ef01c0f08614a49e7761e3
+  data.tar.gz: 5a81ff21fc5fbc5fc937076591ec622cb7d2c78b7ea2a636b40f84c41ef514af
+SHA512:
+  metadata.gz: cec655cd4c177f542aa34121fd8bc3ec756c7c75752fdda1ae7c1068ae4bafa0ef8c38fcb623e476db66eff9d6ae2aac644d048f1d1e5a6d2929ca5f491deeeb
+  data.tar.gz: 75b0259ac206c9dd9a0f407344f15850319bd476d96faca3322c7523c6fc5d65fec33fc004d431dfa16a9adf27d4c18890483aea9fc005c0c5e02d580b7259e7

data/.github/workflows/deploy.yml

@@ -0,0 +1,31 @@
+name: Deploy
+
+on:
+  push:
+    tags:
+      - '[0-9]+.[0-9]+.[0-9]+'
+
+jobs:
+  push_to_rubygems:
+    name: Push to RubyGems
+    runs-on: ubuntu-latest
+    steps:
+    - name: Set RELEASE_TAG
+      run: echo "RELEASE_TAG=${GITHUB_REF#refs/*/}" >> $GITHUB_ENV
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.7.3
+        bundler-cache: true
+    - name: Check Capybara::Puppeteer::VERSION
+      run: bundle exec ruby -e 'raise "invalid Capybara::Puppeteer::VERSION" unless Capybara::Puppeteer::VERSION == ENV["RELEASE_TAG"]'
+    - run: rake build
+    - name: setup API key
+      run: |
+        mkdir -p ~/.gem/
+        echo "---" > ~/.gem/credentials
+        echo ":rubygems_api_key: $RUBYGEMS_API_KEY" >> ~/.gem/credentials
+        chmod 600 ~/.gem/credentials
+      env:
+        RUBYGEMS_API_KEY: ${{secrets.RUBYGEMS_API_KEY}}
+    - run: gem push pkg/capybara-puppeteer-driver-$RELEASE_TAG.gem

data/.github/workflows/rspec.yml

@@ -0,0 +1,18 @@
+name: Check
+
+on: [pull_request]
+
+jobs:
+  check:
+    name: RSpec
+    runs-on: ubuntu-latest
+    container: circleci/ruby:2.7.3-buster-node-browsers
+    steps:
+      # @see https://docs.github.com/actions/reference/virtual-environments-for-github-hosted-runners#docker-container-filesystem
+      - name: Setup file system permissions
+        run: sudo chmod -R 777 $GITHUB_WORKSPACE /github /__w/_temp
+      - uses: actions/checkout@v2
+      - name: Install dependencies
+        run: gem install bundler:2.2.3 && bundle install --path vendor/bundle
+      - run: bundle exec rspec --format documentation
+        timeout-minutes: 45

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+/.ruby-version
+/.vscode
+/Gemfile.lock
+/vendor/bundle
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 1.17.2

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-puppeteer-driver.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 @@
+# capybara-puppeteer-driver
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/capybara/puppeteer`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'capybara-puppeteer-driver'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install capybara-puppeteer-driver
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/capybara-puppeteer-driver. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## 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::Puppeteer project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/capybara-puppeteer-driver/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,12 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'capybara/puppeteer'
+
+# 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

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-puppeteer-driver.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'capybara/puppeteer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'capybara-puppeteer-driver'
+  spec.version       = Capybara::Puppeteer::VERSION
+  spec.authors       = ['YusukeIwaki']
+  spec.email         = ['q7w8e9w8q7w8e9@yahoo.co.jp']
+
+  spec.summary       = 'Headless Chrome driver for Capybara using puppeteer-ruby'
+  spec.homepage      = 'https://github.com/YusukeIwaki/capybara-puppeteer-driver'
+  spec.license       = 'MIT'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  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 'puppeteer-ruby', '>= 0.34.3'
+  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-rspec'
+  spec.add_development_dependency 'sinatra', '>= 1.4.0'
+  spec.add_development_dependency 'webrick'
+end

data/lib/capybara/puppeteer.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'puppeteer'
+require 'capybara'
+
+require 'capybara/puppeteer/browser'
+require 'capybara/puppeteer/browser_options'
+require 'capybara/puppeteer/dialog_event_handler'
+require 'capybara/puppeteer/driver'
+require 'capybara/puppeteer/node'
+require 'capybara/puppeteer/page'

data/lib/capybara/puppeteer/browser.rb

@@ -0,0 +1,302 @@
+module Capybara
+  module Puppeteer
+    class Browser
+      class NoSuchWindowError < StandardError ; end
+
+      def initialize(driver:, puppeteer_browser:)
+        @driver = driver
+        @puppeteer_browser = puppeteer_browser
+        @puppeteer_page = puppeteer_browser.pages.first || puppeteer_browser.new_page
+
+        @puppeteer_browser.on('targetdestroyed') do |target|
+          if target.type == 'page'
+            if target.target_id == @puppeteer_page&.capybara_id
+              @puppeteer_page = nil
+            end
+          end
+        end
+      end
+
+      def current_url
+        assert_page_alive
+
+        @puppeteer_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
+
+        @puppeteer_page.capybara_current_frame.goto(url)
+      end
+
+      def refresh
+        assert_page_alive
+
+        @puppeteer_page.capybara_current_frame.evaluate('() => { location.reload(true) }')
+      end
+
+      private def find_with(query_method, query, **options)
+        begin
+          @puppeteer_page.capybara_current_frame.send(query_method, query).map do |el|
+            Node.new(@driver, @puppeteer_page, el)
+          end
+        rescue => err
+          # Navigation occured during finding Node.
+          if err.message =~ /Cannot find context with specified id/
+            return [] # Rely on Capybara's retry.
+          end
+
+          raise
+        end
+      end
+
+      def find_xpath(query, **options)
+        assert_page_alive
+
+        find_with(:Sx, query, **options)
+      end
+
+      def find_css(query, **options)
+        assert_page_alive
+
+        find_with(:query_selector_all, query, **options)
+      end
+
+      def response_headers
+        assert_page_alive
+
+        @puppeteer_page.capybara_response_headers
+      end
+
+      def status_code
+        assert_page_alive
+
+        @puppeteer_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
+        @puppeteer_page.capybara_current_frame.evaluate(js)
+      end
+
+      def title
+        assert_page_alive
+
+        @puppeteer_page.title
+      end
+
+      def go_back
+        assert_page_alive
+
+        @puppeteer_page.go_back
+      end
+
+      def go_forward
+        assert_page_alive
+
+        @puppeteer_page.go_forward
+      end
+
+      def execute_script(script, *args)
+        assert_page_alive
+
+        @puppeteer_page.capybara_current_frame.evaluate("function () { #{script} }", *unwrap_node(args))
+        nil
+      end
+
+      def evaluate_script(script, *args)
+        assert_page_alive
+
+        result = @puppeteer_page.capybara_current_frame.evaluate_handle("function () { return #{script} }", *unwrap_node(args))
+        wrap_node(result)
+      end
+
+      def evaluate_async_script(script, *args)
+        assert_page_alive
+
+        js = <<~JAVASCRIPT
+        function(){
+          let args = Array.prototype.slice.call(arguments);
+          return new Promise((resolve, reject) => {
+            args.push(resolve);
+            (function(){ #{script} }).apply(this, args);
+          });
+        }
+        JAVASCRIPT
+        result = @puppeteer_page.capybara_current_frame.evaluate_handle(js, *unwrap_node(args))
+        wrap_node(result)
+      end
+
+      def send_keys(*args)
+        assert_page_alive
+
+        Node::SendKeys.new(@puppeteer_page.keyboard, @puppeteer_page.keyboard, args).execute
+      end
+
+      def save_screenshot(path, **options)
+        assert_page_alive
+
+        @puppeteer_page.screenshot(path: path)
+      end
+
+      def switch_to_frame(frame)
+        case frame
+        when :top
+          @puppeteer_page.capybara_reset_frames
+        when :parent
+          @puppeteer_page.capybara_pop_frame
+        else
+          puppeteer_frame = frame.native.content_frame
+          raise ArgumentError.new("Not a frame element: #{frame}") unless puppeteer_frame
+          @puppeteer_page.capybara_push_frame(puppeteer_frame)
+        end
+      end
+
+      private def assert_page_alive
+        if !@puppeteer_page || @puppeteer_page.closed?
+          raise NoSuchWindowError
+        end
+      end
+
+      def window_handles
+        @puppeteer_browser.pages.map(&:capybara_id)
+      end
+
+      def current_window_handle
+        @puppeteer_page&.capybara_id
+      end
+
+      def open_new_window(kind = :tab)
+        @puppeteer_browser.new_page
+      end
+
+      private def on_window(handle, &block)
+        page = @puppeteer_browser.pages.find { |page| page.capybara_id == handle }
+        if page
+          block.call(page)
+        else
+          raise NoSuchWindowError
+        end
+      end
+
+      def switch_to_window(handle)
+        return if @puppeteer_page&.capybara_id == handle
+
+        on_window(handle) do |page|
+          @puppeteer_page = page.tap(&:bring_to_front)
+        end
+      end
+
+      def close_window(handle)
+        on_window(handle) do |page|
+          page.close
+        end
+
+        if @puppeteer_page&.capybara_id == handle
+          @puppeteer_page = nil
+        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 = ::Puppeteer::Viewport.new(width: width, height: height)
+        end
+      end
+
+      def maximize_window(handle)
+        on_window(handle) do |page|
+          screen_size = page.evaluate('() => ({ width: window.screen.width, height: window.screen.height})')
+          page.viewport = ::Puppeteer::Viewport.new(width: screen_size['width'], height: screen_size['height'])
+        end
+      end
+
+      def fullscreen_window(handle)
+        on_window(handle) do |page|
+          page.evaluate('() => document.body.requestFullscreen()')
+        end
+      end
+
+      def accept_modal(dialog_type, **options, &block)
+        assert_page_alive
+
+        @puppeteer_page.capybara_accept_modal(dialog_type, **options, &block)
+      end
+
+      def dismiss_modal(dialog_type, **options, &block)
+        assert_page_alive
+
+        @puppeteer_page.capybara_dismiss_modal(dialog_type, **options, &block)
+      end
+
+      private def capybara_default_wait_time
+        Capybara.default_max_wait_time * 1000
+      end
+
+      private def unwrap_node(args)
+        args.map do |arg|
+          if arg.is_a?(Node)
+            arg.native
+          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 ::Puppeteer::ElementHandle
+          Node.new(@driver, @puppeteer_page, arg)
+        when ::Puppeteer::JSHandle
+          obj_type, is_array = arg.evaluate('obj => [typeof obj, Array.isArray(obj)]')
+          if obj_type == 'object'
+            if is_array
+              arg.properties.map do |_, value|
+                wrap_node(value)
+              end
+            else
+              arg.properties.map do |key, value|
+                [key, wrap_node(value)]
+              end.to_h
+            end
+          else
+            arg.json_value
+          end
+        else
+          arg
+        end
+      end
+    end
+  end
+end