capybara-screenshot 1.0.26 → 1.0.27

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b73d3b8338a3c2f426d7835f4396565c0bfe28b939f610337c331099f93f52b5
-  data.tar.gz: c5ec9f343c703e5ac2700b84dcde63a094c3609787ea7b1cfbbd1f470a5b0ce4
+  metadata.gz: 3622fc9e4c9348592f801aa4ded346ed13186a2a064d1cc93f004ab0a34a752d
+  data.tar.gz: 2388d305280af10e3ef3b6a13fd8b08e450f2922a1a35d6e8f32a50933ae82d1
 SHA512:
-  metadata.gz: 4cd11454a82290ef985a5341e0dad1eaea6296ca5b6ea1f17522a5f8f43b6c68dd71cfd17426c8204fd352488b6ea876d2e8493b2ec0ce2e575590e13302b456
-  data.tar.gz: d17d96491ebc960f4fa47eec58b9dd60610c4a7839e878d8d40c3003cb054e891fc38e958ba42dbcf7ded095385fbb725cdd9e33e368fec51cd89358653c3576
+  metadata.gz: eff915aea70bac7983ee64a7cae410181c11bcca379f2e11e48219a2fbf5811a1724aa761e9da6d5218f6700d1b687a91c29763c866c3f999d8d8a2cf9ba490a
+  data.tar.gz: 1cc29529123428346d2f0e85f26cf65d2140ab2fc2ae80f08548f32de97dea044fec9c4635b41d187774e56c08c44476aea3c509cf62f0a307d556b5d9389582

data/.github/workflows/ci.yml

@@ -0,0 +1,35 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: rspec
+
+on:
+  push:
+    branches: ["master"]
+  pull_request:
+    branches: ["master"]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ["2.6", "2.7", "3.0"]
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        # uses: ruby/setup-ruby@55283cc23133118229fd3f97f9336ee23a179fcf # v1.146.0
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+      - name: Run tests
+        run: bundle exec rspec

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+25 Feb 2025 - 1.0.26 -> 1.0.27
+
+* [Add ability to manually save screenshots with custom prefixes](https://github.com/mattheworiordan/capybara-screenshot/pull/302)
+* [Support headless Firefox screenshots](https://github.com/mattheworiordan/capybara-screenshot/pull/300)
+* [Add support for Playwright driver](https://github.com/mattheworiordan/capybara-screenshot/commit/23a27be5392c7dbc706651d7adc124d8e7c920a0)
+* [Add a workflow for CI on GitHub Actions](https://github.com/mattheworiordan/capybara-screenshot/pull/301)
+
 21 Dec 2021 - 1.0.25 -> 1.0.26
 
 * [Take screenshots of current window (when using multiple windows)](https://github.com/mattheworiordan/capybara-screenshot/pull/287)

data/Gemfile

@@ -4,6 +4,6 @@ source "http://rubygems.org"
 gemspec
 
 gem 'rack', '~> 1.0'
-gem 'rake', '~> 13.0'
+gem 'rake', '~> 10.0'
 gem 'appraisal', '~> 2.0'
 gem 'aruba', '~> 0.14.0'

data/README.md

@@ -1,7 +1,7 @@
 capybara-screenshot gem
 =======================
 
-[![Build Status](https://travis-ci.org/mattheworiordan/capybara-screenshot.svg)](https://travis-ci.org/mattheworiordan/capybara-screenshot)
+[![Build Status](https://github.com/mattheworiordan/capybara-screenshot/actions/workflows/ci.yml/badge.svg)](https://github.com/mattheworiordan/capybara-screenshot/actions/workflows/ci.yml)
 [![Code Climate](https://d3s6mut3hikguw.cloudfront.net/github/mattheworiordan/capybara-screenshot.svg)](https://codeclimate.com/github/mattheworiordan/capybara-screenshot)
 [![Gem Version](https://badge.fury.io/rb/capybara-screenshot.svg)](http://badge.fury.io/rb/capybara-screenshot)
 
@@ -100,12 +100,21 @@ Anywhere the Capybara DSL methods (visit, click etc.) are available so too are t
 
 ```ruby
 screenshot_and_save_page
+
+# with custom prefix
+screenshot_and_save_page(filename_prefix: 'custom_prefix')
+
+# image only, with custom prefix:
+screenshot_and_save_page(filename_prefix: 'custom_prefix', save_html: false)
 ```
 
 Or for screenshot only, which will automatically open the image:
 
 ```ruby
 screenshot_and_open_image
+
+# with custom prefix
+screenshot_and_open_image(filename_prefix: 'custom_prefix')
 ```
 
 These are just calls on the main library methods:
@@ -319,7 +328,7 @@ Please raise an issue at [https://github.com/mattheworiordan/capybara-screenshot
 
 #### Contributions
 
-Contributions are welcome.  Please fork this gem and then submit a pull request.  New features must include test coverage and must pass on all versions of the testing frameworks supported.  Run `appraisal` to set up the your Gems. then `appraisal "rake travis:ci"` locally to test your changes against all versions of testing framework gems supported.
+Contributions are welcome.  Please fork this gem and then submit a pull request.  New features must include test coverage and must pass on all versions of the testing frameworks supported.  Run `appraisal` to set up the your Gems. then `appraisal "rspec"` locally to test your changes against all versions of testing framework gems supported.
 
 #### Rubygems
 

data/Rakefile

@@ -1,40 +1,6 @@
-require 'rubygems'
-require 'bundler/setup'
+require "rubygems"
+require "bundler/setup"
 
 Bundler::GemHelper.install_tasks
 
-require 'rspec/core/rake_task'
-
-rspec_rake_task = RSpec::Core::RakeTask.new(:spec)
-
-task default: [:spec]
-
-def target_gem
-  gem_file = ENV['BUNDLE_GEMFILE'] || ''
-  targets = %w(cucumber spinach rspec)
-
-  target = gem_file.match(/(#{targets.join('|')})/)
-  if target && targets.include?(target[1])
-    target[1].to_sym
-  else
-    []
-  end
-end
-
-namespace :travis do
-  task :ci => target_gem do
-    Rake::Task['spec'].invoke
-  end
-
-  task :cucumber do
-    rspec_rake_task.pattern = 'spec/cucumber'
-  end
-
-  task :spinach do
-    rspec_rake_task.pattern = 'spec/spinach'
-  end
-
-  task :rspec do
-    rspec_rake_task.pattern = 'spec/rspec'
-  end
-end
+require "rspec/core/rake_task"

data/lib/capybara-screenshot/capybara.rb

@@ -19,12 +19,12 @@ module Capybara
     # Adds class methods to Capybara module and gets mixed into
     # the current scope during Cucumber and RSpec tests
 
-    def screenshot_and_save_page
-      Capybara::Screenshot.screenshot_and_save_page
+    def screenshot_and_save_page(filename_prefix: nil, save_html: true)
+      Capybara::Screenshot.screenshot_and_save_page(filename_prefix: filename_prefix, save_html: save_html)
     end
 
-    def screenshot_and_open_image
-      Capybara::Screenshot.screenshot_and_open_image
+    def screenshot_and_open_image(filename_prefix: nil)
+      Capybara::Screenshot.screenshot_and_open_image(filename_prefix: filename_prefix)
     end
   end
 

data/lib/capybara-screenshot/version.rb

@@ -1,5 +1,5 @@
 module Capybara
   module Screenshot
-    VERSION = '1.0.26'
+    VERSION = '1.0.27'
   end
 end

data/lib/capybara-screenshot.rb

@@ -29,17 +29,19 @@ module Capybara
       RSpec.add_link_to_screenshot_for_failed_examples = value
     end
 
-    def self.screenshot_and_save_page
-      saver = new_saver(Capybara, Capybara.page)
+    def self.screenshot_and_save_page(filename_prefix: nil, save_html: true)
+      saver = new_saver(Capybara, Capybara.page, save_html, filename_prefix)
       if saver.save
         {:html => saver.html_path, :image => saver.screenshot_path}
+      elsif !save_html
+        warn 'WARN: no screenshot has been saved. You should configure the driver used by Capybara to save images.'
       end
     end
 
-    def self.screenshot_and_open_image
+    def self.screenshot_and_open_image(filename_prefix: nil)
       require "launchy"
 
-      saver = new_saver(Capybara, Capybara.page, false)
+      saver = new_saver(Capybara, Capybara.page, false, filename_prefix)
       if saver.save
         Launchy.open saver.screenshot_path
         {:html => nil, :image => saver.screenshot_path}
@@ -161,6 +163,7 @@ Capybara::Screenshot.class_eval do
   end
 
   register_driver :selenium, &selenium_block
+  register_driver :selenium_headless, &selenium_block
   register_driver :selenium_chrome, &selenium_block
   register_driver :selenium_chrome_headless, &selenium_block
 
@@ -198,6 +201,12 @@ Capybara::Screenshot.class_eval do
   register_driver(:cuprite) do |driver, path|
     driver.render(path, :full => true)
   end
+
+  register_driver(:playwright) do |driver, path|
+    driver.with_playwright_page do |page|
+      page.screenshot(path: path, fullPage: true)
+    end
+  end
 end
 
 # Register filename prefix formatters

data/spec/cucumber/cucumber_spec.rb

@@ -61,6 +61,26 @@ describe "Using Capybara::Screenshot with Cucumber" do
     expect('tmp/my_screenshot.html').to have_file_content('This is a different page')
   end
 
+  it 'saves a screenshot with custom prefix' do
+    run_case(<<-CUCUMBER)
+      Feature: Custom prefix
+        Scenario: Screenshot with custom prefix
+          Given I visit "/"
+          And I save the page with a custom prefix
+    CUCUMBER
+    expect('tmp/custom_prefix.html').to have_file_content('This is the root page')
+  end
+
+  it 'displays a warning when a screenshot without HTML is asked but not saved' do
+    run_case(<<-CUCUMBER)
+      Feature: Custom prefix
+        Scenario: Empty screenshot
+          Given I visit "/different_page"
+          And I take a screenshot which is not saved
+    CUCUMBER
+    expect(last_command_started.output).to include('WARN: no screenshot has been saved.')
+  end
+
   context 'pruning' do
     before do
       create_screenshot_for_pruning

data/spec/cucumber/step_definitions/step_definitions.rb

@@ -16,3 +16,11 @@ end
 Then(/^I trigger an unhandled exception/) do
   raise "you can't handle me"
 end
+
+Then(/^I save the page with a custom prefix$/) do
+  screenshot_and_save_page filename_prefix: 'custom_prefix'
+end
+
+Then(/^I take a screenshot which is not saved$/) do
+  screenshot_and_save_page save_html: false
+end

data/spec/feature/minitest_spec.rb

@@ -28,7 +28,7 @@ describe "Using Capybara::Screenshot with MiniTest" do
 
   it 'saves a screenshot on failure' do
     run_failing_case <<-RUBY
-      class TestFailure < MiniTest::Unit::TestCase
+      class TestFailure < Minitest::Test
         include Capybara::DSL
 
         def test_failure
@@ -43,7 +43,7 @@ describe "Using Capybara::Screenshot with MiniTest" do
 
   it 'saves a screenshot for the correct session for failures using_session' do
     run_failing_case <<-RUBY
-      class TestFailure < Minitest::Unit::TestCase
+      class TestFailure < Minitest::Test
         include Capybara::DSL
 
         def test_failure
@@ -64,7 +64,7 @@ describe "Using Capybara::Screenshot with MiniTest" do
     create_screenshot_for_pruning
     configure_prune_strategy :last_run
     run_failing_case <<-RUBY
-      class TestFailure < Minitest::Unit::TestCase
+      class TestFailure < Minitest::Test
         include Capybara::DSL
 
         def test_failure

data/spec/unit/s3_saver_spec.rb

@@ -135,9 +135,11 @@ describe Capybara::Screenshot::S3Saver do
       expect(File).to receive(:open).with(html_path).and_yield(html_file)
 
       expect(s3_client).to receive(:put_object).with(
-        bucket: bucket_name,
-        key: 'bar.html',
-        body: html_file
+        {
+          bucket: bucket_name,
+          key: "bar.html",
+          body: html_file
+        }
       )
 
       expect(s3_saver).to receive(:determine_bucket_host).and_call_original
@@ -155,9 +157,11 @@ describe Capybara::Screenshot::S3Saver do
       expect(File).to receive(:open).with(screenshot_path).and_yield(screenshot_file)
 
       expect(s3_client).to receive(:put_object).with(
-        bucket: bucket_name,
-        key: 'bim.jpg',
-        body: screenshot_file
+        {
+          bucket: bucket_name,
+          key: "bim.jpg",
+          body: screenshot_file
+        }
       )
 
       s3_saver.save
@@ -177,10 +181,12 @@ describe Capybara::Screenshot::S3Saver do
         expect(File).to receive(:open).with(html_path).and_yield(html_file)
 
         expect(s3_client).to receive(:put_object).with(
-          bucket: bucket_name,
-          key: 'bar.html',
-          body: html_file,
-          acl: 'public-read'
+          {
+            bucket: bucket_name,
+            key: "bar.html",
+            body: html_file,
+            acl: "public-read"
+          }
         )
 
         s3_saver.save
@@ -196,10 +202,12 @@ describe Capybara::Screenshot::S3Saver do
         expect(File).to receive(:open).with(screenshot_path).and_yield(screenshot_file)
 
         expect(s3_client).to receive(:put_object).with(
-          bucket: bucket_name,
-          key: 'bim.jpg',
-          body: screenshot_file,
-          acl: 'public-read'
+          {
+            bucket: bucket_name,
+            key: "bim.jpg",
+            body: screenshot_file,
+            acl: "public-read"
+          }
         )
 
         s3_saver.save
@@ -217,9 +225,11 @@ describe Capybara::Screenshot::S3Saver do
         expect(File).to receive(:open).with(html_path).and_yield(html_file)
 
         expect(s3_client).to receive(:put_object).with(
-          bucket: bucket_name,
-          key: 'some/path/bar.html',
-          body: html_file
+          {
+            bucket: bucket_name,
+            key: "some/path/bar.html",
+            body: html_file
+          }
         )
 
         s3_saver_with_key_prefix.save
@@ -235,9 +245,11 @@ describe Capybara::Screenshot::S3Saver do
         expect(File).to receive(:open).with(screenshot_path).and_yield(screenshot_file)
 
         expect(s3_client).to receive(:put_object).with(
-          bucket: bucket_name,
-          key: 'some/path/bim.jpg',
-          body: screenshot_file
+          {
+            bucket: bucket_name,
+            key: "some/path/bim.jpg",
+            body: screenshot_file
+          }
         )
 
         s3_saver_with_key_prefix.save
@@ -256,10 +268,12 @@ describe Capybara::Screenshot::S3Saver do
           expect(File).to receive(:open).with(html_path).and_yield(html_file)
 
           expect(s3_client).to receive(:put_object).with(
-            bucket: bucket_name,
-            key: 'some/path/bar.html',
-            body: html_file,
-            acl: 'public-read'
+            {
+              bucket: bucket_name,
+              key: "some/path/bar.html",
+              body: html_file,
+              acl: "public-read"
+            }
           )
 
           s3_saver_with_key_prefix.save
@@ -275,10 +289,12 @@ describe Capybara::Screenshot::S3Saver do
           expect(File).to receive(:open).with(screenshot_path).and_yield(screenshot_file)
 
           expect(s3_client).to receive(:put_object).with(
-            bucket: bucket_name,
-            key: 'some/path/bim.jpg',
-            body: screenshot_file,
-            acl: 'public-read'
+            {
+              bucket: bucket_name,
+              key: "some/path/bim.jpg",
+              body: screenshot_file,
+              acl: "public-read"
+            }
           )
 
           s3_saver_with_key_prefix.save

data/spec/unit/saver_spec.rb

@@ -311,6 +311,24 @@ describe Capybara::Screenshot::Saver do
     end
   end
 
+  describe "with playwright driver" do
+    let(:playwright_page_mock) {
+      double('Playwright Page Mock').as_null_object
+    }
+
+    before do
+      allow(capybara_mock).to receive(:current_driver).and_return(:playwright)
+    end
+
+    it 'saves driver screenshot via playwright page with :fullPage => true' do
+      expect(driver_mock).to receive(:with_playwright_page).and_yield(playwright_page_mock)
+      expect(playwright_page_mock).to receive(:screenshot).with(path: screenshot_path, fullPage: true)
+
+      saver.save
+      expect(saver).to be_screenshot_saved
+    end
+  end
+
   describe "with webkit driver" do
     before do
       allow(capybara_mock).to receive(:current_driver).and_return(:webkit)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capybara-screenshot
 version: !ruby/object:Gem::Version
-  version: 1.0.26
+  version: 1.0.27
 platform: ruby
 authors:
 - Matthew O'Riordan
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-12 00:00:00.000000000 Z
+date: 2026-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara
@@ -178,9 +178,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - Appraisals
 - CHANGELOG.md
 - Gemfile
@@ -243,8 +243,8 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/mattheworiordan/capybara-screenshot/issues
   changelog_uri: https://github.com/mattheworiordan/capybara-screenshot/blob/master/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/capybara-screenshot/1.0.26
-  source_code_uri: https://github.com/mattheworiordan/capybara-screenshot/tree/v1.0.26
+  documentation_uri: https://www.rubydoc.info/gems/capybara-screenshot/1.0.27
+  source_code_uri: https://github.com/mattheworiordan/capybara-screenshot/tree/v1.0.27
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -260,7 +260,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
 summary: Automatically create snapshots when Cucumber steps fail with Capybara and

data/.travis.yml

@@ -1,17 +0,0 @@
-language: ruby
-script: "bundle exec rake travis:ci"
-rvm:
-  - 2.0.0
-  - 2.1.10
-  - 2.2.10
-  - 2.3.8
-  - 2.4.9
-  - 2.5.7
-  - 2.6.5
-gemfile:
-  - gemfiles/cucumber.1.3.gemfile
-  - gemfiles/cucumber.2.4.gemfile
-  - gemfiles/latest.gemfile
-  - gemfiles/rspec.3.0.gemfile
-  - gemfiles/rspec.3.3.gemfile
-  - gemfiles/spinach.0.8.gemfile