capybara-puppeteer-driver 0.1.0

data/lib/capybara/puppeteer/page.rb

@@ -0,0 +1,183 @@
+require 'fileutils'
+
+module Capybara
+  module Puppeteer
+    module PageExtension
+      def initialize(*args, **kwargs)
+        if kwargs.empty?
+          super(*args)
+        else
+          super(*args, **kwargs)
+        end
+        capybara_initialize
+      end
+
+      # object identifier used for Capybara
+      def capybara_id
+        @target.target_id
+      end
+
+      private def capybara_initialize
+        @capybara_all_responses = {}
+        @capybara_last_response = nil
+        @capybara_frames = []
+
+        on('dialog') do |dialog|
+          capybara_dialog_event_handler.handle_dialog(dialog)
+        end
+        on('response') do |response|
+          @capybara_all_responses[response.url] = response
+        end
+        on('framenavigated') do |frame|
+          @capybara_last_response = @capybara_all_responses[frame.url]
+          @capybara_all_responses.clear
+        end
+      end
+
+      private def capybara_dialog_event_handler
+        @capybara_dialog_event_handler ||= DialogEventHandler.new.tap do |h|
+          h.default_handler = method(:capybara_on_unexpected_modal)
+        end
+      end
+
+      private def capybara_on_unexpected_modal(dialog)
+        puts "[WARNING] Unexpected modal - \"#{dialog.message}\""
+        if dialog.type == 'beforeunload'
+          dialog.accept
+        else
+          dialog.dismiss
+        end
+      end
+
+      class DialogAcceptor
+        def initialize(dialog_type, options)
+          @dialog_type = dialog_type
+          @options = options
+        end
+
+        def handle(dialog)
+          if @dialog_type == :prompt
+            dialog.accept(@options[:with] || dialog.default_value)
+          else
+            dialog.accept
+          end
+        end
+      end
+
+      class DialogMessageMatcher
+        def initialize(text_or_regex_or_nil)
+          if [NilClass, Regexp, String].none? { |k| text_or_regex_or_nil.is_a?(k) }
+            raise ArgumentError.new("invalid type: #{text_or_regex_or_nil.inspect}")
+          end
+
+          @filter = text_or_regex_or_nil
+        end
+
+        def matches?(message)
+          case @filter
+          when nil
+            true
+          when Regexp
+            message =~ @filter
+          when String
+            message&.include?(@filter)
+          end
+        end
+      end
+
+      def capybara_accept_modal(dialog_type, **options, &block)
+        timeout_sec = options[:wait]
+        acceptor = DialogAcceptor.new(dialog_type, options)
+        matcher = DialogMessageMatcher.new(options[:text])
+        message_promise = Concurrent::Promises.resolvable_future
+        handler = -> (dialog) {
+          message = dialog.message
+          if matcher.matches?(message)
+            message_promise.fulfill(message)
+            acceptor.handle(dialog)
+          else
+            message_promise.reject(Capybara::ModalNotFound.new("Dialog message=\"#{message}\" dowsn't match"))
+            dialog.dismiss
+          end
+        }
+        capybara_dialog_event_handler.with_handler(handler) do
+          block.call
+
+          message = message_promise.value!(timeout_sec)
+          if message_promise.fulfilled?
+            message
+          else
+            # timed out
+            raise Capybara::ModalNotFound
+          end
+        end
+      end
+
+      def capybara_dismiss_modal(dialog_type, **options, &block)
+        timeout_sec = options[:wait]
+        matcher = DialogMessageMatcher.new(options[:text])
+        message_promise = Concurrent::Promises.resolvable_future
+        handler = -> (dialog) {
+          message = dialog.message
+          if matcher.matches?(message)
+            message_promise.fulfill(message)
+          else
+            message_promise.reject(Capybara::ModalNotFound.new("Dialog message=\"#{message}\" dowsn't match"))
+          end
+          dialog.dismiss
+        }
+        capybara_dialog_event_handler.with_handler(handler) do
+          block.call
+
+          message = message_promise.value!(timeout_sec)
+          if message_promise.fulfilled?
+            message
+          else
+            # timed out
+            raise Capybara::ModalNotFound
+          end
+        end
+      end
+
+      class Headers < Hash
+        def [](key)
+          # Puppeteer accepts lower-cased keys.
+          # However allow users to specify "Content-Type" or "User-Agent".
+          super(key.downcase)
+        end
+      end
+
+      def capybara_response_headers
+        headers = @capybara_last_response&.headers || {}
+
+        Headers.new.tap do |h|
+          headers.each do |key, value|
+            h[key] = value
+          end
+        end
+      end
+
+      def capybara_status_code
+        @capybara_last_response&.status.to_i
+      end
+
+      def capybara_reset_frames
+        @capybara_frames.clear
+      end
+
+      # @param frame [Puppeteer::Frame]
+      def capybara_push_frame(frame)
+        @capybara_frames << frame
+      end
+
+      def capybara_pop_frame
+        @capybara_frames.pop
+      end
+
+      def capybara_current_frame
+        @capybara_frames.last || main_frame
+      end
+    end
+    ::Puppeteer::Page.prepend(PageExtension)
+  end
+end

data/lib/capybara/puppeteer/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Capybara
+  module Puppeteer
+    VERSION = '0.1.0'
+  end
+end

metadata

@@ -0,0 +1,204 @@
+--- !ruby/object:Gem::Specification
+name: capybara-puppeteer-driver
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- YusukeIwaki
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-06-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: puppeteer-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.34.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.34.3
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.3
+- !ruby/object:Gem::Dependency
+  name: launchy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.4
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.10.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+- !ruby/object:Gem::Dependency
+  name: webrick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- q7w8e9w8q7w8e9@yahoo.co.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/deploy.yml"
+- ".github/workflows/rspec.yml"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- capybara-puppeteer-driver.gemspec
+- lib/capybara/puppeteer.rb
+- lib/capybara/puppeteer/browser.rb
+- lib/capybara/puppeteer/browser_options.rb
+- lib/capybara/puppeteer/dialog_event_handler.rb
+- lib/capybara/puppeteer/driver.rb
+- lib/capybara/puppeteer/node.rb
+- lib/capybara/puppeteer/page.rb
+- lib/capybara/puppeteer/version.rb
+homepage: https://github.com/YusukeIwaki/capybara-puppeteer-driver
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: Headless Chrome driver for Capybara using puppeteer-ruby
+test_files: []