capybara-playwright-driver 0.0.0.pre.r1 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b85ab44fa6fca141e177e1ef28197af313cda7e2e1f23cd4d51a8edf5b12e97f
-  data.tar.gz: 7b665e1abde79e8f41804773de8af36b46e438cca2908671b87e7190bc23268d
+  metadata.gz: 17075d587d4657d2c2f70b68256bbaeac10e011d553b092cbbed35cb33de6f05
+  data.tar.gz: c42763d910584f0687985887ab07180f1fde752c9b7543b1613d481757fd3898
 SHA512:
-  metadata.gz: 8a0190946c3581203b63000d5e3cf1a5b5c97daeacbbfb4c9eeaba0ab2c1aba1757492e59b9ccc286090f5763116b660b18095400e9e2343645f4fa28a9e6086
-  data.tar.gz: acc5f5d43c7c46efa61ed501bce789c4fb22e86c19eb83d3133aa1b32cc4521f456973fcedcc0b2b8930bcb31d2c52d253fbfb5649ffd6a1f9aed7b3a9aeba71
+  metadata.gz: 94bf8ef42f8d6a8e59b1f160eeb10f142432015beb9c219bab1c0dac31fbbf7dfcea1c2a63349aaf32dac58e87b33add9a690471eef90d96a5d228a9bc9f456e
+  data.tar.gz: 894cc32d6ef13f2611d81b240a56f75b4ea445667ad7b8215a8955c96e742118dcb08ddf2f15df02fe375674665f45ead8ae892869421e99b01b2ec4bb687082

data/README.md

@@ -1,5 +1,9 @@
+[![Gem Version](https://badge.fury.io/rb/capybara-playwright-driver.svg)](https://badge.fury.io/rb/capybara-playwright-driver)
+
 # 🎭 Playwright driver for Capybara
 
+#### [Docs](https://playwright-ruby-client.vercel.app/docs/article/guides/rails_integration)
+
 ```ruby
 gem 'capybara-playwright-driver'
 ```
@@ -22,14 +26,14 @@ Capybara.app_host = 'https://github.com'
 visit '/'
 fill_in('q', with: 'Capybara')
 
-## [REMARK] Use Playwright-native Page instead of flaky Capybara's selector/action.
+## [REMARK] We can use Playwright-native selector and action, instead of Capybara DSL.
 # 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.all('a').first.text} by Capybara"
   puts "#{li.with_playwright_element_handle { |handle| handle.query_selector('a').text_content }} by Playwright"
 end
 ```

data/capybara-playwright.gemspec

@@ -24,14 +24,15 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.required_ruby_version = '>= 2.4'
   spec.add_dependency 'capybara'
-  spec.add_dependency 'playwright-ruby-client', '>= 0.5.9'
+  spec.add_dependency 'playwright-ruby-client', '>= 0.6.2'
+  spec.add_development_dependency 'allure-rspec'
   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'

data/lib/capybara/playwright/browser.rb

@@ -1,16 +1,26 @@
+require_relative './tmpdir_owner'
+
 module Capybara
   module Playwright
+    # Responsibility of this class is:
+    # - Handling Capybara::Driver commands.
+    # - Managing Playwright browser contexts and pages.
+    #
+    # Note that this class doesn't manage Playwright::Browser.
+    # We should not use Playwright::Browser#close in this class.
     class Browser
+      include TmpdirOwner
       extend Forwardable
 
       class NoSuchWindowError < StandardError ; end
 
-      def initialize(playwright:, driver:, browser_type:, browser_options:, page_options:)
+      def initialize(driver:, playwright_browser:, page_options:, record_video: false)
         @driver = driver
-
-        browser_type = playwright.send(browser_type)
-        @playwright_browser = browser_type.launch(**browser_options)
+        @playwright_browser = playwright_browser
         @page_options = page_options
+        if record_video
+          @page_options[:record_video_dir] ||= tmpdir
+        end
         @playwright_page = create_page(create_browser_context)
       end
 
@@ -34,8 +44,8 @@ module Capybara
         end
       end
 
-      def quit
-        @playwright_browser.close
+      def clear_browser_contexts
+        @playwright_browser.contexts.each(&:close)
       end
 
       def current_url
@@ -69,7 +79,7 @@ module Capybara
         assert_page_alive
 
         @playwright_page.capybara_current_frame.query_selector_all("xpath=#{query}").map do |el|
-          Node.new(@driver, @puppeteer_page, el)
+          Node.new(@driver, @playwright_page, el)
         end
       end
 
@@ -155,6 +165,22 @@ module Capybara
         wrap_node(result)
       end
 
+      # Not used by Capybara::Session.
+      # Intended to be directly called by user.
+      def video_path
+        return nil if !@playwright_page || @playwright_page.closed?
+
+        @playwright_page.video&.path
+      end
+
+      # Not used by Capybara::Session.
+      # Intended to be directly called by user.
+      def raw_screenshot(**options)
+        return nil if !@playwright_page || @playwright_page.closed?
+
+        @playwright_page.screenshot(**options)
+      end
+
       def save_screenshot(path, **options)
         assert_page_alive
 
@@ -300,7 +326,7 @@ module Capybara
             [key, wrap_node(value)]
           end.to_h
         when ::Playwright::ElementHandle
-          Node.new(@driver, @puppeteer_page, arg)
+          Node.new(@driver, @playwright_page, arg)
         when ::Playwright::JSHandle
           arg.json_value
         else
@@ -310,7 +336,6 @@ module Capybara
 
       def with_playwright_page(&block)
         assert_page_alive
-        raise ArgumentError.new('block must be given') unless block
 
         block.call(@playwright_page)
       end

data/lib/capybara/playwright/driver.rb

@@ -1,7 +1,10 @@
+require_relative './driver_extension'
+
 module Capybara
   module Playwright
     class Driver < ::Capybara::Driver::Base
       extend Forwardable
+      include DriverExtension
 
       def initialize(app, **options)
         @playwright_cli_executable_path = options[:playwright_cli_executable_path] || 'npx playwright'
@@ -18,10 +21,20 @@ module Capybara
       def needs_server?; true; end
 
       def browser
-        @browser ||= create_browser
+        @browser ||= ::Capybara::Playwright::Browser.new(
+          driver: self,
+          playwright_browser: playwright_browser,
+          page_options: @page_options.value,
+          record_video: callback_on_save_screenrecord?,
+        )
       end
 
-      private def create_browser
+      private def playwright_browser
+        @playwright_browser ||= create_playwright_browser
+      end
+
+      private def create_playwright_browser
+        # clean up @playwright_browser and @playwright_execution on exit.
         main = Process.pid
         at_exit do
           # Store the exit status of the test run since it goes away after calling the at_exit proc...
@@ -30,27 +43,45 @@ module Capybara
           exit @exit_status if @exit_status # Force exit with stored status
         end
 
-        @execution = execute_playwright
-        ::Capybara::Playwright::Browser.new(
-          playwright: @execution.playwright,
-          driver: self,
-          browser_type: @browser_type,
-          browser_options: @browser_options.value,
-          page_options: @page_options.value,
-        )
+        browser_type = playwright_execution.playwright.send(@browser_type)
+        browser_options = @browser_options.value
+        browser_type.launch(**browser_options)
       end
 
-      private def execute_playwright
-        ::Playwright.create(playwright_cli_executable_path: @playwright_cli_executable_path)
+      private def playwright_execution
+        @playwright_execution ||= ::Playwright.create(
+          playwright_cli_executable_path: @playwright_cli_executable_path,
+        )
       end
 
       private def quit
-        @browser&.quit
-        @execution&.stop
+        @playwright_browser&.close
+        @playwright_browser = nil
+        @playwright_execution&.stop
+        @playwright_execution = nil
       end
 
       def reset!
-        quit
+        # screenshot is available only before closing page.
+        if callback_on_save_screenshot?
+          raw_screenshot = @browser&.raw_screenshot
+          if raw_screenshot
+            callback_on_save_screenshot(raw_screenshot)
+          end
+        end
+
+        # video path can be aquired only before closing context.
+        # video is completedly saved only after closing context.
+        video_path = @browser&.video_path
+
+        # [NOTE] @playwright_browser should keep alive for better performance.
+        # Only `Browser` is disposed.
+        @browser&.clear_browser_contexts
+
+        if video_path
+          callback_on_save_screenrecord(video_path)
+        end
+
         @browser = nil
       end
 
@@ -94,9 +125,6 @@ module Capybara
       def_delegator(:browser, :switch_to_window)
       def_delegator(:browser, :accept_modal)
       def_delegator(:browser, :dismiss_modal)
-
-      # capybara-playwright-driver specific methods
-      def_delegator(:browser, :with_playwright_page)
     end
   end
 end

data/lib/capybara/playwright/driver_extension.rb

@@ -0,0 +1,45 @@
+module Capybara
+  module Playwright
+    module DriverExtension
+      # Register screenshot save process.
+      # The callback is called just before page is closed.
+      # (just before #reset_session!)
+      #
+      # The **binary** (String) of the page screenshot is called back into the given block
+      def on_save_raw_screenshot_before_reset(&block)
+        @callback_on_save_screenshot = block
+      end
+
+      private def callback_on_save_screenshot?
+        !!@callback_on_save_screenshot
+      end
+
+      private def callback_on_save_screenshot(raw_screenshot)
+        @callback_on_save_screenshot&.call(raw_screenshot)
+      end
+
+      # Register screenrecord save process.
+      # The callback is called just after page is closed.
+      # (just after #reset_session!)
+      #
+      # The video path (String) is called back into the given block
+      def on_save_screenrecord(&block)
+        @callback_on_save_screenrecord = block
+      end
+
+      private def callback_on_save_screenrecord?
+        !!@callback_on_save_screenrecord
+      end
+
+      private def callback_on_save_screenrecord(video_path)
+        @callback_on_save_screenrecord&.call(video_path)
+      end
+
+      def with_playwright_page(&block)
+        raise ArgumentError.new('block must be given') unless block
+
+        @browser&.with_playwright_page(&block)
+      end
+    end
+  end
+end

data/lib/capybara/playwright/node.rb

@@ -406,8 +406,11 @@ module Capybara
 
         MODIFIERS = {
           alt: 'Alt',
+          ctrl: 'Control',
           control: 'Control',
           meta: 'Meta',
+          command: 'Meta',
+          cmd: 'Meta',
           shift: 'Shift',
         }.freeze
 
@@ -440,8 +443,11 @@ module Capybara
       class SendKeys
         MODIFIERS = {
           alt: 'Alt',
+          ctrl: 'Control',
           control: 'Control',
           meta: 'Meta',
+          command: 'Meta',
+          cmd: 'Meta',
           shift: 'Shift',
         }.freeze
 
@@ -576,7 +582,7 @@ module Capybara
 
         class PressKey
           def initialize(key:, modifiers:)
-            puts "PressKey: key=#{key} modifiers: #{modifiers}"
+            # puts "PressKey: key=#{key} modifiers: #{modifiers}"
             if modifiers.empty?
               @key = key
             else
@@ -605,7 +611,77 @@ module Capybara
       end
 
       def drag_to(element, **options)
-        raise NotImplementedError
+        DragTo.new(@page, @element, element.element, options).execute
+      end
+
+      class DragTo
+        MODIFIERS = {
+          alt: 'Alt',
+          ctrl: 'Control',
+          control: 'Control',
+          meta: 'Meta',
+          command: 'Meta',
+          cmd: 'Meta',
+          shift: 'Shift',
+        }.freeze
+
+        # @param page [Playwright::Page]
+        # @param source [Playwright::ElementHandle]
+        # @param target [Playwright::ElementHandle]
+        def initialize(page, source, target, options)
+          @page = page
+          @source = source
+          @target = target
+          @options = options
+        end
+
+        def execute
+          @source.scroll_into_view_if_needed
+
+          # down
+          position_from = center_of(@source)
+          @page.mouse.move(*position_from)
+          @page.mouse.down
+
+          @target.scroll_into_view_if_needed
+
+          # move and up
+          sleep_delay
+          position_to = center_of(@target)
+          with_key_pressing(drop_modifiers) do
+            @page.mouse.move(*position_to, steps: 6)
+            sleep_delay
+            @page.mouse.up
+          end
+          sleep_delay
+        end
+
+        # @param element [Playwright::ElementHandle]
+        private def center_of(element)
+          box = element.bounding_box
+          [box["x"] + box["width"] / 2, box["y"] + box["height"] / 2]
+        end
+
+        private def with_key_pressing(keys, &block)
+          keys.each { |key| @page.keyboard.down(key) }
+          block.call
+          keys.each { |key| @page.keyboard.up(key) }
+        end
+
+        # @returns Array<String>
+        private def drop_modifiers
+          return [] unless @options[:drop_modifiers]
+
+          Array(@options[:drop_modifiers]).map do |key|
+            MODIFIERS[key.to_sym]  or raise ArgumentError.new("Unknown modifier key: #{key}")
+          end
+        end
+
+        private def sleep_delay
+          return unless @options[:delay]
+
+          sleep @options[:delay]
+        end
       end
 
       def drop(*args)
@@ -696,6 +772,8 @@ module Capybara
       end
 
       def visible?
+        assert_element_not_stale
+
         # if an area element, check visibility of relevant image
         @element.evaluate(<<~JAVASCRIPT)
         function(el) {
@@ -732,10 +810,14 @@ module Capybara
       end
 
       def checked?
+        assert_element_not_stale
+
         @element.evaluate('el => !!el.checked')
       end
 
       def selected?
+        assert_element_not_stale
+
         @element.evaluate('el => !!el.selected')
       end
 

data/lib/capybara/playwright/page.rb

@@ -4,7 +4,11 @@ module Capybara
   module Playwright
     module PageExtension
       def initialize(*args, **kwargs)
-        super
+        if kwargs.empty?
+          super(*args)
+        else
+          super(*args, **kwargs)
+        end
         capybara_initialize
       end
 

data/lib/capybara/playwright/tmpdir_owner.rb

@@ -0,0 +1,40 @@
+module Capybara
+  module Playwright
+    module TmpdirOwner
+      require 'tmpdir'
+
+      def tmpdir
+        return @tmpdir if @tmpdir
+
+        dir = Dir.mktmpdir
+        ObjectSpace.define_finalizer(self, TmpdirRemover.new(dir))
+        @tmpdir = dir
+      end
+
+      def remove_tmpdir
+        if @tmpdir
+          FileUtils.remove_entry(@tmpdir, true)
+          ObjectSpace.undefine_finalizer(self)
+          @tmpdir = nil
+        end
+      end
+
+      class TmpdirRemover
+        def initialize(tmpdir)
+          @pid = Process.pid
+          @tmpdir = tmpdir
+        end
+
+        def call(*args)
+          return if @pid != Process.pid
+
+          begin
+            FileUtils.remove_entry(@tmpdir, true)
+          rescue => err
+            $stderr.puts err
+          end
+        end
+      end
+    end
+  end
+end

data/lib/capybara/playwright/version.rb

@@ -2,6 +2,6 @@
 
 module Capybara
   module Playwright
-    VERSION = '0.0.0-r1'
+    VERSION = '0.1.4'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capybara-playwright-driver
 version: !ruby/object:Gem::Version
-  version: 0.0.0.pre.r1
+  version: 0.1.4
 platform: ruby
 authors:
 - YusukeIwaki
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-05-17 00:00:00.000000000 Z
+date: 2021-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara
@@ -30,14 +30,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.9
+        version: 0.6.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.9
+        version: 0.6.2
+- !ruby/object:Gem::Dependency
+  name: allure-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: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -108,20 +122,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.10.0
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.7.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.7.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -186,9 +186,11 @@ files:
 - lib/capybara/playwright/browser_options.rb
 - lib/capybara/playwright/dialog_event_handler.rb
 - lib/capybara/playwright/driver.rb
+- lib/capybara/playwright/driver_extension.rb
 - lib/capybara/playwright/node.rb
 - lib/capybara/playwright/page.rb
 - lib/capybara/playwright/page_options.rb
+- lib/capybara/playwright/tmpdir_owner.rb
 - lib/capybara/playwright/version.rb
 homepage: https://github.com/YusukeIwaki/capybara-playwright-driver
 licenses:
@@ -202,14 +204,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Playwright driver for Capybara