playwright-on-rails 0.7.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4c645ee1541e81fa978f7119b904a694f25e762c7a969ac3a3a4c0cd357f2d07
+  data.tar.gz: 516fb66ff81bae53fdae42429843d4728b25624e6a19215a208dad3d4293da35
+SHA512:
+  metadata.gz: 11e29411f55d355d4389ce5b7b3f6bd7c96b3719dc54249260c867f167df7c888bcb4cc00a855ced8d1e4c754258a3fc5daf216f7ea22d7add2d7882885e2c69
+  data.tar.gz: 751d9e0631f4ec11a7ec327dbc48ad9aaa26fddcfa937e7ea4af8aff47b3bccd1ad8dcaf4cae696ad8a2ec9e0171199d5b0154a33fa5a93f5110b2dfc23cb7c9

data/.github/workflows/main.yml

@@ -0,0 +1,21 @@
+name: CI
+
+on: [push, pull_request, workflow_dispatch]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby-version: ['3.0', '3.3']
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+
+      - name: Run tests
+        run: ./script/test

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.standard.yml

@@ -0,0 +1,5 @@
+ruby_version: 2.5
+ignore:
+  - 'vendor/bundle/**/*'
+  - 'example/node_modules/**/*'
+  - 'example/vendor/bundle/**/*'

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.3

data/CHANGELOG.md

@@ -0,0 +1,115 @@
+# CHANGELOG
+
+## 0.7.0
+git
+* Add a `CYPRESS_RAILS_CYPRESS_DIR` option for cases where
+the cypress tests live outside the CYPRESS_RAILS_DIR [#159](https://github.com/testdouble/cypress-rails/pull/159)
+
+## 0.6.1
+
+* Fix a deprecation warning in Rails
+  [#157](https://github.com/testdouble/cypress-rails/pull/157)
+
+## 0.6.0
+
+* Update initializer task to generate valid Cypress v10+ configurations
+  [#156](https://github.com/testdouble/cypress-rails/pull/156)
+
+## 0.5.5
+
+* Add Puma 6 support
+  [#136](https://github.com/testdouble/cypress-rails/pull/136)
+
+## 0.5.4
+
+* Fix Rails 5 support
+  [#126](https://github.com/testdouble/cypress-rails/pull/126)
+
+## 0.5.3
+
+* Fix 2.5 & 2.6 compatibility
+  [#100](https://github.com/testdouble/cypress-rails/issues/100)
+
+## 0.5.2
+
+* Fixes a puma deprecation warning
+  [#95](https://github.com/testdouble/cypress-rails/pull/95)
+
+## 0.5.1
+
+* Sprinkles two instance variables to the custom transaction manager that cribs
+  its implementation from ActiveRecord::TestFixtures (see f75f280)
+  [#88](https://github.com/testdouble/cypress-rails/issues/88)
+  [#89](https://github.com/testdouble/cypress-rails/pull/89)
+
+## 0.5.0
+
+* Add hook `after_server_start`
+  [#63](https://github.com/testdouble/cypress-rails/pull/63)
+* Fix namespace bug
+  [#64](https://github.com/testdouble/cypress-rails/pull/64)
+
+## 0.4.2
+
+* Add support to Rails 6.1 ([#52](https://github.com/testdouble/cypress-rails/issue/52))
+
+## 0.4.1
+
+* Add backcompat for Ruby 2.4
+  ([#47](https://github.com/testdouble/cypress-rails/pull/47))
+
+## 0.4.0
+
+* Add a `CYPRESS_RAILS_HOST` option that allows a hostname to be specified (as
+opposed to 127.0.0.1). Puma will still bind to 127.0.0.1, but Cypress will use
+the hostname in its `baseUrl`, which may be necessary for some folks' tests to
+work
+
+## 0.3.0
+
+* Add a `CYPRESS_RAILS_BASE_PATH` option which will be appended to the
+  `CYPRESS_BASE_URL` option that cypress-rails sets when launching cypress
+  commands. Apps that set `baseUrl` to something other than "/" can set this env
+  var to match for consistent behavior (or else set it using Cypress.config in a
+  support file)
+
+## 0.2.0
+
+* If `RAILS_ENV` has been explicitly set when the CLI or rake task is run,
+respect that set value instead of overriding it to "test"
+
+## 0.1.3
+
+* Improve behavior of SIGINT (Ctrl-C) so a traceback isn't printed and stdout
+  isn't flushed after the program exits
+
+## 0.1.2
+
+* Drop the hard deps on capybara and selenium-webdrivers (instead inlining
+  portions of the Capybara server logic). Additionally, add a hard dep on puma
+  since this gem is useless without it
+
+## 0.1.1
+
+* Fix the `before_server_stop` hook by rolling back transactions first so that
+  it can clean out test data
+
+## 0.1.0
+
+* **[Breaking]** Remove `CypressRails::TestCase`. Use `rake cypress:run` instead
+* **[Breaking]** cypress-rails now starts a transaction immediately after
+  launching the server, which could result in other processes not being able
+  to observe your changes. To revert to the old behavior, set the env var
+  `CYPRESS_RAILS_TRANSACTIONAL_SERVER=false`
+* Add configuration variables `CYPRESS_RAILS_DIR`,
+  `CYPRESS_RAILS_TRANSACTIONAL_SERVER`. Rename port and Cypress CLI forwarding
+  to `CYPRESS_RAILS_PORT` and `CYPRESS_RAILS_CYPRESS_OPTS`
+* Add test data configuration hooks (to be run in an initializer):
+  * `CypressRails.hooks.before_server_start`
+  * `CypressRails.hooks.after_transaction_start`
+  * `CypressRails.hooks.after_state_reset` - after a transaction rollback
+  * `CypressRails.hooks.before_server_stop` - called in an `at_exit` hook
+
+## 0.0.4
+
+* Started a changelog

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,155 @@
+PATH
+  remote: .
+  specs:
+    playwright-on-rails (0.7.0)
+      puma (>= 3.8.0)
+      railties (>= 5.2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (7.1.3)
+      actionview (= 7.1.3)
+      activesupport (= 7.1.3)
+      nokogiri (>= 1.8.5)
+      racc
+      rack (>= 2.2.4)
+      rack-session (>= 1.0.1)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    actionview (7.1.3)
+      activesupport (= 7.1.3)
+      builder (~> 3.1)
+      erubi (~> 1.11)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    activesupport (7.1.3)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      mutex_m
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    base64 (0.2.0)
+    bigdecimal (3.1.6)
+    builder (3.2.4)
+    concurrent-ruby (1.2.3)
+    connection_pool (2.4.1)
+    crass (1.0.6)
+    drb (2.2.0)
+      ruby2_keywords
+    erubi (1.12.0)
+    i18n (1.14.1)
+      concurrent-ruby (~> 1.0)
+    io-console (0.7.2)
+    irb (1.11.2)
+      rdoc
+      reline (>= 0.4.2)
+    json (2.7.1)
+    language_server-protocol (3.17.0.3)
+    lint_roller (1.1.0)
+    loofah (2.22.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
+    mini_portile2 (2.8.5)
+    minitest (5.22.2)
+    mutex_m (0.2.0)
+    nio4r (2.7.0)
+    nokogiri (1.16.2)
+      mini_portile2 (~> 2.8.2)
+      racc (~> 1.4)
+    parallel (1.24.0)
+    parser (3.3.0.5)
+      ast (~> 2.4.1)
+      racc
+    psych (5.1.2)
+      stringio
+    puma (6.4.2)
+      nio4r (~> 2.0)
+    racc (1.7.3)
+    rack (3.0.9)
+    rack-session (2.0.0)
+      rack (>= 3.0.0)
+    rack-test (2.1.0)
+      rack (>= 1.3)
+    rackup (2.1.0)
+      rack (>= 3)
+      webrick (~> 1.8)
+    rails-dom-testing (2.2.0)
+      activesupport (>= 5.0.0)
+      minitest
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.6.0)
+      loofah (~> 2.21)
+      nokogiri (~> 1.14)
+    railties (7.1.3)
+      actionpack (= 7.1.3)
+      activesupport (= 7.1.3)
+      irb
+      rackup (>= 1.0.0)
+      rake (>= 12.2)
+      thor (~> 1.0, >= 1.2.2)
+      zeitwerk (~> 2.6)
+    rainbow (3.1.1)
+    rake (13.1.0)
+    rdoc (6.6.2)
+      psych (>= 4.0.0)
+    regexp_parser (2.9.0)
+    reline (0.4.2)
+      io-console (~> 0.5)
+    rexml (3.2.6)
+    rubocop (1.59.0)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.4)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.30.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.30.0)
+      parser (>= 3.2.1.0)
+    rubocop-performance (1.20.2)
+      rubocop (>= 1.48.1, < 2.0)
+      rubocop-ast (>= 1.30.0, < 2.0)
+    ruby-progressbar (1.13.0)
+    ruby2_keywords (0.0.5)
+    standard (1.33.0)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.59.0)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.3)
+    standard-custom (1.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.50)
+    standard-performance (1.3.1)
+      lint_roller (~> 1.1)
+      rubocop-performance (~> 1.20.2)
+    stringio (3.1.0)
+    thor (1.3.0)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.5.0)
+    webrick (1.8.1)
+    zeitwerk (2.6.13)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  minitest (~> 5.0)
+  playwright-on-rails!
+  rake (~> 13.0)
+  standard (>= 0.2.0)
+
+BUNDLED WITH
+   2.3.13

data/LICENSE.txt

@@ -0,0 +1,25 @@
+The MIT License (MIT)
+
+Copyright (c) 2019-2020 Test Double, LLC
+
+Portions of the CypressRails::Server component:
+Copyright (c) 2009-2018 Thomas Walpole, Jonas Nicklas
+
+
+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,241 @@
+# playwright-on-rails
+
+**This is a downstream copy of [cypress-rails](https://github.com/testdouble/cypress-rails), adapted to support Playwright instead of [Cypress](http://cypress.io). All credit goes to [them](https://github.com/testdouble/cypress-rails). Changes here will be kept at a minimum, and suggestions should probably be sent to that project.**
+
+This is a simple gem to make it easier to start writing browser tests with
+[Playwright](https://playwright.dev/) for your [Rails](https://rubyonrails.org) apps,
+regardless of whether your app is server-side rendered HTML, completely
+client-side JavaScript, or something in-between.
+
+## Installation
+
+**tl;dr**:
+
+1. Install the npm package `playwright`
+2. Install this gem `playwright-on-rails`
+3. Run `rake playwright:init`
+
+### Installing Playwright itself
+
+The first step is making sure Playwright is installed (that's up to you, this
+library doesn't install Playwright, it just provides a little Rails-specific glue).
+
+If you're on newer versions of Rails and using
+[webpacker](https://www.github.com/rails/webpacker) for your front-end assets,
+then you're likely already using yarn to manage your JavaScript dependencies. If
+that's the case, you can add Playwright with:
+
+```sh
+$ yarn add --dev playwright
+```
+
+If you're not using yarn in conjunction with your Rails app, check out the
+Playwright docs on getting it installed. At the end of the day, this gem just needs
+the `playwright` binary to exist either in `./node_modules/.bin/playwright` or on your
+`PATH`.
+
+### Installing the playwright-on-rails gem
+
+Now, to install the playwright-on-rails gem, you'll want to add it to your development
+& test gem groups of your Gemfile, so that you have easy access to its rake
+tasks:
+
+```ruby
+group :development, :test do
+  gem "playwright-on-rails"
+end
+```
+
+Once installed, you'll want to run:
+
+```sh
+$ rake playwright:init
+```
+
+This will override a few configurations in your `playwright.config.js` configuration
+file.
+
+## Usage
+
+### Develop tests interactively with `playwright open`
+
+When writing tests with Playwright, you'll find the most pleasant experience (by
+way of a faster feedback loop and an interactive, easy-to-inspect test runner)
+using the `playwright open` command.
+
+When using Rails, however, you'll also want your Rails test server to be running
+so that there's something for Playwright to interact with. `playwright-on-rails` provides
+a wrapper for running `playwright open` with a dedicated Rails test server.
+
+So, by running:
+
+```sh
+$ rake playwright:open
+```
+
+Any JavaScript files added to `playwright/tests` will be identified by
+Playwright as tests. Simply click a test file in the Playwright application window to
+launch the test in a browser. Each time you save the test file, it will re-run
+itself.
+
+### Run tests headlessly with `playwright run`
+
+To run your tests headlessly (e.g. when you're in CI), you'll want the `run`
+command:
+
+```sh
+$ rake playwright:run
+```
+
+## Managing your test data
+
+The tricky thing about browser tests is that they usually depend on some test
+data being available with which to exercise the app efficiently. Because playwright
+is a JavaScript-based tool and can't easily manipulate your Rails app directly,
+playwright-on-rails provides a number of hooks that you can use to manage your test
+data.
+
+Here's what a `config/initializers/playwright-on-rails.rb` initializer might look
+like:
+
+```ruby
+return unless Rails.env.test?
+
+PlaywrightOnRails.hooks.before_server_start do
+  # Called once, before either the transaction or the server is started
+end
+
+PlaywrightOnRails.hooks.after_transaction_start do
+  # Called after the transaction is started (at launch and after each reset)
+end
+
+PlaywrightOnRails.hooks.after_state_reset do
+  # Triggered after `/playwright-on-rails_reset_state` is called
+end
+
+PlaywrightOnRails.hooks.before_server_stop do
+  # Called once, at_exit
+end
+```
+
+(You can find [an example initializer](/example/config/initializers/playwright-on-rails_initializer.rb)
+in this repo.)
+
+The gem also provides a special route on the test server:
+`/playwright-on-rails_reset_state`. Each time it's called, playwright-on-rails will do
+two things at the beginning of the next request received by the Rails app:
+
+* If `PLAYWRIGHT_RAILS_TRANSACTIONAL_SERVER` is enabled, roll back the transaction,
+effectively resetting the application state to whatever it was at the start of
+the test run
+
+* Trigger any `after_state_reset` hooks you've configured (regardless of the
+  transactional server setting)
+
+This way, you can easily instruct the server to reset its test state from your
+Playwright tests like so:
+
+```js
+beforeEach(() => {
+  cy.request('/playwright-on-rails_reset_state')
+})
+```
+
+(Remember, in Playwright, `before` is a before-all hook and `beforeEach` is run
+between each test case!)
+
+## Configuration
+
+### Environment variables
+
+The playwright-on-rails gem is configured entirely via environment variables. If you
+find yourself repeating a number of verbose environment variables as you run
+your tests, consider invoking the gem from a custom script or setting your
+preferred environment variables project-wide using a tool like
+[dotenv](https://github.com/bkeepers/dotenv).
+
+
+* **PLAYWRIGHT_RAILS_DIR** (default: `Dir.pwd`) the directory of your Rails project
+* **PLAYWRIGHT_RAILS_PLAYWRIGHT_DIR** (default: _same value as `rails_dir`_) the directory of your Playwright project
+* **PLAYWRIGHT_RAILS_HOST** (default: `"127.0.0.1"`) the hostname to bind to
+* **PLAYWRIGHT_RAILS_PORT** (default: _a random available port_) the port to run
+  the Rails test server on
+* **PLAYWRIGHT_RAILS_BASE_PATH** (default: `"/"`) the base path for all Playwright's
+  requests to the app (e.g. via `cy.visit()`). If you've customized your
+  `baseUrl` setting (e.g. in `playwright.config.js`), you'll need to duplicate it with
+  this environment variable
+* **PLAYWRIGHT_RAILS_TRANSACTIONAL_SERVER** (default: `true`) when true, will start
+  a transaction on all database connections before launching the server. In
+  general this means anything done during `playwright open` or `playwright run` will
+  be rolled back on exit (similar to running a Rails System test)
+* **PLAYWRIGHT_RAILS_PLAYWRIGHT_OPTS** (default: _none_) any options you want to
+  forward to the Playwright CLI when running its `open` or `run` commands.
+
+#### Example: Running a single spec from the command line
+
+It's a little verbose, but an example of using the above options to run a single
+Playwright test would look like this:
+
+```
+$ PLAYWRIGHT_RAILS_PLAYWRIGHT_OPTS="playwright/integration/a_test.js" bin/rake playwright:run
+```
+
+### Initializer hooks
+
+### before_server_start
+
+Pass a block to `PlaywrightOnRails.hooks.before_server_start` to register a hook that
+will execute before the server or any transaction has been started. If you use
+Rails fixtures, it may make sense to load them here, so they don't need to be
+re-inserted for each request
+
+### after_server_start
+
+Pass a block to `PlaywrightOnRails.hooks.after_server_start` to register a hook that
+will execute after the server has booted.
+
+### after_transaction_start
+
+If there's any custom behavior or state management you want to do inside the
+transaction (so that it's also rolled back each time a reset is triggered),
+pass a block to `PlaywrightOnRails.hooks.after_transaction_start`.
+
+### after_state_reset
+
+Every time the test server receives an HTTP request at
+`/playwright-on-rails_reset_state`, the transaction will be rolled back (if
+`PLAYWRIGHT_RAILS_TRANSACTIONAL_SERVER` is enabled) and the `after_state_reset`
+hook will be triggered. To set up the hook, pass a block to
+`PlaywrightOnRails.hooks.after_state_reset`.
+
+### before_server_stop
+
+In case you've made any permanent changes to your test database that could
+pollute other test suites or scripts, you can use the `before_server_stop` to
+(assuming everything exits gracefully) clean things up and restore the state
+of your test database. To set up the hook, pass a block to
+`PlaywrightOnRails.hooks.before_server_stop`.
+
+## Configuring Rails
+
+Beyond the configuration options above, you'll probably also want to disable caching
+in your Rails app's [config/environments/test.rb](/example/config/environments/test.rb#L9)
+file, so that changes to your Ruby code are reflected in your tests while you
+work on them with `rake playwright:open`. (If either option is set to
+`true`, any changes to your Ruby code will require a server restart to be reflected as you work
+on your tests.)
+
+To illustrate, here's what that might look like in `config/environments/test.rb`:
+
+```ruby
+config.cache_classes = false
+config.action_view.cache_template_loading = false
+```
+
+## Setting up continuous integration
+
+See [original](https://github.com/testdouble/cypress-rails/tree/main?tab=readme-ov-file#setting-up-continuous-integration).
+
+## Why use this?
+
+See [original](https://github.com/testdouble/cypress-rails/tree/main?tab=readme-ov-file#why-use-this).

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+require "standard/rake"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: [:test, "standard:fix"]

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "playwright-on-rails"
+
+# 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/exe/playwright-on-rails

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+ENV["RAILS_ENV"] ||= "test"
+require "pathname"
+require "playwright-on-rails"
+require Pathname.new(PlaywrightOnRails::Config.new.rails_dir).join("config/environment")
+
+command = ARGV[0]
+case command
+when "init"
+  PlaywrightOnRails::Init.new.call
+when "open"
+  PlaywrightOnRails::Open.new.call
+when "run"
+  passed = PlaywrightOnRails::Run.new.call
+  exit 1 unless passed
+end