cypress-on-rails 1.13.1 → 1.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f65fc72c40d5d7016113ff6af471a1557de37b794a6812d8a03bcd9f16d78917
-  data.tar.gz: 14fc7d218866e99cd51970b587782d9a66eca9dc7face4b497f3035c3e17a587
+  metadata.gz: bc763de97980a2be63d8eac1ca850d9695c7e1778c8678d83cec0de7c8270b37
+  data.tar.gz: 9c830d9c70faebc8aac3891caa6ab3547cdf66fe9c89d3eda131248086ff55a2
 SHA512:
-  metadata.gz: ac7fd90c3ba3748bb4a4aaae00615abfad1f2046fd8358f1d674e3e9086abd34489fd1b07fec4c043fd9e588600aaf9f6bc3c0328c7cdf99b598d221d710a7f6
-  data.tar.gz: 7b7d371e24aea239174384b9f5fddfa218739e15f5f01256f42821f6ebfbaf42e914404b8dfeab68e77444792ca79226c6f756cbc23e1833dc6d47db2935c215
+  metadata.gz: 88104bb87f1ab6933c17495ff3cbe112a27fc8daa5ee97752eb25e72e46d1ca6e2b54b907857650d49455ca3cb30534e6a6e4d02a6d5f240ddc69ea9d9c5cdac
+  data.tar.gz: 61f547751df2b0500d15b3480732823916a6b3ce0a768cbed696764ec9ddb3853b0d4919e9f2a8249803830b70334f0914c8075d0eb97d84abf68c9835747d1a

data/.github/workflows/ruby.yml

@@ -16,13 +16,15 @@ jobs:
       uses: ruby/setup-ruby@v1
       with:
         ruby-version: 2.3
-        bundler-cache: true 
+        bundler-cache: true
     - name: Run tests
       run: bundle exec rake
     - run: gem uninstall -v '>= 2' -ax bundler || true
     - run: gem install bundler -v '< 2'
     - name: Run interaction tests
       run: ./specs_e2e/rails_3_2/test.sh
+      env:
+        CYPRESS_RECORD_KEY: ${{ secrets.CYPRESS_RECORD_KEY }}
 
   rails_4_2:
     runs-on: ubuntu-latest
@@ -40,6 +42,8 @@ jobs:
     - run: gem install bundler -v '< 2'
     - name: Run interaction tests
       run: ./specs_e2e/rails_4_2/test.sh
+      env:
+        CYPRESS_RECORD_KEY: ${{ secrets.CYPRESS_RECORD_KEY }}
 
   rails_5_2:
     runs-on: ubuntu-latest
@@ -50,8 +54,10 @@ jobs:
       uses: ruby/setup-ruby@v1
       with:
         ruby-version: 2.6
-        bundler-cache: true 
+        bundler-cache: true
     - name: Run tests
       run: bundle exec rake
     - name: Run interaction tests
       run: ./specs_e2e/rails_5_2/test.sh
+      env:
+        CYPRESS_RECORD_KEY: ${{ secrets.CYPRESS_RECORD_KEY }}

data/CHANGELOG.md

@@ -1,3 +1,21 @@
+## [1.15.0]
+[Compare]: https://github.com/shakacode/cypress-on-rails/compare/v1.14.0...v1.15.0
+
+### Changed
+* Add support for any e2e testing framewrok starting with Playwright [PR 131](https://github.com/shakacode/cypress-on-rails/pull/131) by [KhaledEmaraDev]
+
+## [1.14.0]
+[Compare]: https://github.com/shakacode/cypress-on-rails/compare/v1.13.1...v1.14.0
+
+### Changed
+* Add support for proxy routes through `api_prefix` [PR 130](https://github.com/shakacode/cypress-on-rails/pull/130) by [RomainEndelin]
+
+### Fixed
+* Properly copies the cypress_helper file when running the update generator [PR 117](https://github.com/shakacode/cypress-on-rails/pull/117) by [alvincrespo]
+
+### Tasks
+* pass cypress record key to github action [PR 110](https://github.com/shakacode/cypress-on-rails/pull/110)
+
 ## [1.13.1]
 [Compare]: https://github.com/shakacode/cypress-on-rails/compare/v1.13.0...v1.13.1
 
@@ -34,7 +52,7 @@
 [Compare]: https://github.com/shakacode/cypress-on-rails/compare/v1.10.1...v1.11.0
 
 ### Changed
-* improve app command logging on cypress 
+* improve app command logging on cypress
 * Allow build and build_list commands to be executed against factory bot [PR 87](https://github.com/shakacode/cypress-on-rails/pull/87) by [Alexander-Blair]
 
 ## [1.10.1]

data/README.md

@@ -1,11 +1,12 @@
 # CypressOnRails
 
 ![Build Status](https://github.com/shakacode/cypress-on-rails/actions/workflows/ruby.yml/badge.svg)
+[![cypress-on-rails](https://img.shields.io/endpoint?url=https://dashboard.cypress.io/badge/simple/2b6cjr/master&style=plastic&logo=cypress)](https://dashboard.cypress.io/projects/2b6cjr/runs)
 [![Gem Version](https://badge.fury.io/rb/cypress-on-rails.svg)](https://badge.fury.io/rb/cypress-on-rails)
 
 ----
 
-This project is sponsored by the software consulting firm [ShakaCode](https://www.shakacode.com), creator of the [React on Rails Gem](https://github.com/shakacode/react_on_rails). We focus on React (with TS or ReScript) front-ends, often with Ruby on Rails or Gatsby. See [our recent work](https://www.shakacode.com/recent-work) and [client engagement model](https://www.shakacode.com/blog/client-engagement-model/). Feel free to engage in discussions around this gem at our [Slack Channel](https://join.slack.com/t/reactrails/shared_invite/enQtNjY3NTczMjczNzYxLTlmYjdiZmY3MTVlMzU2YWE0OWM0MzNiZDI0MzdkZGFiZTFkYTFkOGVjODBmOWEyYWQ3MzA2NGE1YWJjNmVlMGE) or our [forum category for Cypress](https://forum.shakacode.com/c/cypress-on-rails/55). 
+This project is sponsored by the software consulting firm [ShakaCode](https://www.shakacode.com), creator of the [React on Rails Gem](https://github.com/shakacode/react_on_rails). We focus on React (with TS or ReScript) front-ends, often with Ruby on Rails or Gatsby. See [our recent work](https://www.shakacode.com/recent-work) and [client engagement model](https://www.shakacode.com/blog/client-engagement-model/). Feel free to engage in discussions around this gem at our [Slack Channel](https://join.slack.com/t/reactrails/shared_invite/enQtNjY3NTczMjczNzYxLTlmYjdiZmY3MTVlMzU2YWE0OWM0MzNiZDI0MzdkZGFiZTFkYTFkOGVjODBmOWEyYWQ3MzA2NGE1YWJjNmVlMGE) or our [forum category for Cypress](https://forum.shakacode.com/c/cypress-on-rails/55).
 
 Interested in joining a small team that loves open source? Check our [careers page](https://www.shakacode.com/career/).
 
@@ -18,12 +19,16 @@ Suggest you first learn the basics of Cypress before attempting to integrate wit
 
 * [Good start Here](https://docs.cypress.io/examples/examples/tutorials.html#Best-Practices)
 
+# Totally new to Playwright?
+Suggest you first learn the basics of Playwright before attempting to integrate with Ruby on Rails
+
+* [Good start Here](https://playwright.dev/docs/writing-tests)
+
 ## Overview
 
-Gem for using [cypress.io](http://github.com/cypress-io/) in Rails and ruby rack applications
-with the goal of controlling State as mentioned in [Cypress Best Practices](https://docs.cypress.io/guides/references/best-practices.html#Organizing-Tests-Logging-In-Controlling-State)
+Gem for using [cypress.io](http://github.com/cypress-io/) or [playwright.dev](https://playwright.dev/) in Rails and Ruby Rack applications with the goal of controlling state as mentioned in [Cypress Best Practices](https://docs.cypress.io/guides/references/best-practices.html#Organizing-Tests-Logging-In-Controlling-State)
 
-It allows to run code in the application context when executing cypress tests.
+It allows you to run code in the application context when executing cypress or playwright tests.
 Do things like:
 * use database_cleaner before each test
 * seed the database with default data for each test
@@ -42,7 +47,7 @@ Has examples of setting up state with:
 
 ## Installation
 
-Add this to your Gemfile:
+Add this to your `Gemfile`:
 
 ```ruby
 group :test, :development do
@@ -53,11 +58,21 @@ end
 Generate the boilerplate code using:
 
 ```shell
+# by default installs only cypress
 bin/rails g cypress_on_rails:install
 
 # if you have/want a different cypress folder (default is cypress)
 bin/rails g cypress_on_rails:install --cypress_folder=spec/cypress
 
+# to install both cypress and playwright
+bin/rails g cypress_on_rails:install --install_cypress --install_playwright --playwright_folder=playwright
+
+# to change where the Ruby files reside (default is e2e)
+bin/rails g cypress_on_rails:install --install_folder=test/e2e
+
+# if you target the Rails server with a path prefix to your URL
+bin/rails g cypress_on_rails:install --api_prefix=/api
+
 # if you want to install cypress with npm
 bin/rails g cypress_on_rails:install --install_cypress_with=npm
 
@@ -69,27 +84,27 @@ bin/rails g cypress_on_rails:update
 ```
 
 The generator modifies/adds the following files/directory in your application:
-* `config/environments/test.rb`
-* `config/initializers/cypress_on_rails` used to configure CypressDev
+* `config/initializers/cypress_on_rails.rb` used to configure Cypress on Rails
 * `spec/cypress/e2e/` contains your cypress tests
-* `spec/cypress/support/on-rails.js` contains CypressDev support code
-* `spec/cypress/app_commands/scenarios/` contains your CypressDev scenario definitions
-* `spec/cypress/cypress_helper.rb` contains helper code for CypressDev app commands
+* `spec/playwright/e2e/` contains your playwright tests
+* `spec/cypress/support/on-rails.js` contains Cypress on Rails support code
+* `spec/playwright/support/on-rails.js` contains Playwright on Rails support code
+* `spec/e2e/app_commands/scenarios/` contains your Cypress on Rails scenario definitions
+* `spec/e2e/cypress_helper.rb` contains helper code for Cypress on Rails app commands
 
-if you are not using database_cleaner look at `spec/cypress/app_commands/clean.rb`.
-if you are not using factory_bot look at `spec/cypress/app_commands/factory_bot.rb`.
+If you are not using `database_cleaner` look at `spec/e2e/app_commands/clean.rb`.
+If you are not using `factory_bot` look at `spec/e2e/app_commands/factory_bot.rb`.
 
-Now you can create scenarios and commands that are plain ruby files that get loaded through middleware, the ruby sky is your limit.
+Now you can create scenarios and commands that are plain Ruby files that get loaded through middleware, the ruby sky is your limit.
 
 ### Update your database.yml
 
-When writing cypress test on your local it's recommended to start your server in development mode so that changes you
-make are picked up without having to restart the server. 
-It's recommend you update your database.yml to check if the CYPRESS environment variable is set and switch it to the test database
+When running `cypress test` or `playwright test` on your local computer it's recommended to start your server in development mode so that changes you
+make are picked up without having to restart the server.
+It's recommended you update your `database.yml` to check if the `CYPRESS` environment variable is set and switch it to the test database
 otherwise cypress will keep clearing your development database.
 
-for example:
-
+For example:
 ```yaml
 development:
   <<: *default
@@ -112,11 +127,15 @@ Getting started on your local environment
 CYPRESS=1 bin/rails server -p 5017
 
 # in separate window start cypress
-yarn cypress open 
+yarn cypress open
 # or for npm
-node_modules/.bin/cypress open 
+node_modules/.bin/cypress open
 # or if you changed the cypress folder to spec/cypress
 yarn cypress open --project ./spec
+# or for playwright
+yarn playwright test --ui
+# or using npm
+npx playwright test --ui
 ```
 
 How to run cypress on CI
@@ -127,7 +146,7 @@ How to run cypress on CI
 
 yarn run cypress run
 # or for npm
-node_modules/.bin/cypress run 
+npx cypress run
 ```
 
 ### Example of using factory bot
@@ -136,8 +155,8 @@ You can run your [factory_bot](https://github.com/thoughtbot/factory_bot) direct
 
 ```js
 // spec/cypress/e2e/simple.cy.js
-describe('My First Test', function() {
-  it('visit root', function() {
+describe('My First Test', () => {
+  it('visit root', () => {
     // This calls to the backend to prepare the application state
     cy.appFactories([
       ['create_list', 'post', 10],
@@ -148,7 +167,7 @@ describe('My First Test', function() {
     // Visit the application under test
     cy.visit('/')
 
-    cy.contains("Hello World")
+    cy.contains('Hello World')
 
     // Accessing result
     cy.appFactories([['create', 'invoice', { paid: false }]]).then((records) => {
@@ -157,9 +176,9 @@ describe('My First Test', function() {
   })
 })
 ```
-You can check the [association Docs](https://github.com/shakacode/cypress-on-rails/blob/master/docs/factory_bot_associations.md) on more ways to setup association with the correct data.
+You can check the [association docs](docs/factory_bot_associations.md) on more ways to setup association with the correct data.
 
-In some cases, using static Cypress fixtures may not provide sufficient flexibility when mocking HTTP response bodies - it's possible to use `FactoryBot.build` to generate Ruby hashes that can then be used as mock JSON responses:
+In some cases, using static Cypress fixtures may not provide sufficient flexibility when mocking HTTP response bodies. It's possible to use `FactoryBot.build` to generate Ruby hashes that can then be used as mock JSON responses:
 ```ruby
 FactoryBot.define do
   factory :some_web_response, class: Hash do
@@ -171,13 +190,13 @@ FactoryBot.define do
   end
 end
 
-FactoryBot.build(:some_web_response) => { 'id' => 123, 'name' => 'Mr Blobby', 'occupation' => 'Evil pink clown' }
+FactoryBot.build(:some_web_response => { 'id' => 123, 'name' => 'Mr Blobby', 'occupation' => 'Evil pink clown' })
 ```
 
 This can then be combined with Cypress mocks:
 ```js
-describe('My First Test', function() {
-  it('visit root', function() {
+describe('My First Test', () => {
+  it('visit root', () => {
     // This calls to the backend to generate the mocked response
     cy.appFactories([
       ['build', 'some_web_response', { name: 'Baby Blobby' }]
@@ -190,14 +209,14 @@ describe('My First Test', function() {
       cy.visit('/')
     })
 
-    cy.contains("Hello World")
+    cy.contains('Hello World')
   })
 })
 ```
 
-### Example of loading rails test fixtures
+### Example of loading Rails test fixtures
 ```ruby
-# spec/cypress/app_commands/activerecord_fixtures.rb
+# spec/e2e/app_commands/activerecord_fixtures.rb
 require "active_record/fixtures"
 
 fixtures_dir = ActiveRecord::Tasks::DatabaseTasks.fixtures_path
@@ -210,15 +229,15 @@ ActiveRecord::FixtureSet.create_fixtures(fixtures_dir, fixture_files)
 
 ```js
 // spec/cypress/e2e/simple.cy.js
-describe('My First Test', function() {
-  it('visit root', function() {
+describe('My First Test', () => {
+  it('visit root', () => {
     // This calls to the backend to prepare the application state
     cy.appFixtures()
 
     // Visit the application under test
     cy.visit('/')
 
-    cy.contains("Hello World")
+    cy.contains('Hello World')
   })
 })
 ```
@@ -227,7 +246,7 @@ describe('My First Test', function() {
 
 Scenarios are named `before` blocks that you can reference in your test.
 
-You define a scenario in the `spec/cypress/app_commands/scenarios` directory:
+You define a scenario in the `spec/e2e/app_commands/scenarios` directory:
 ```ruby
 # spec/cypress/app_commands/scenarios/basic.rb
 Profile.create name: "Cypress Hill"
@@ -239,33 +258,33 @@ CypressOnRails::SmartFactoryWrapper.create(:profile, name: "Cypress Hill")
 Then reference the scenario in your test:
 ```js
 // spec/cypress/e2e/scenario_example.cy.js
-describe('My First Test', function() {
-  it('visit root', function() {
+describe('My First Test', () => {
+  it('visit root', () => {
     // This calls to the backend to prepare the application state
     cy.appScenario('basic')
 
     cy.visit('/profiles')
 
-    cy.contains("Cypress Hill")
+    cy.contains('Cypress Hill')
   })
 })
 ```
 
 ### Example of using app commands
 
-create a ruby file in `spec/cypress/app_commands` directory:
+Create a Ruby file in the `spec/e2e/app_commands` directory:
 ```ruby
-# spec/cypress/app_commands/load_seed.rb
+# spec/e2e/app_commands/load_seed.rb
 load "#{Rails.root}/db/seeds.rb"
 ```
 
 Then reference the command in your test with `cy.app('load_seed')`:
 ```js
 // spec/cypress/e2e/simple.cy.js
-describe('My First Test', function() {
+describe('My First Test', () => {
   beforeEach(() => { cy.app('load_seed') })
 
-  it('visit root', function() {
+  it('visit root', () => {
     cy.visit('/')
 
     cy.contains("Seeds")
@@ -273,11 +292,42 @@ describe('My First Test', function() {
 })
 ```
 
-## Expermintal Features (matching npm package)
+### Example of using scenario with Playwright
 
-Please test and give feedback
+Scenarios are named `before` blocks that you can reference in your test.
 
-add the npm package:
+You define a scenario in the `spec/e2e/app_commands/scenarios` directory:
+```ruby
+# spec/e2e/app_commands/scenarios/basic.rb
+Profile.create name: "Cypress Hill"
+
+# or if you have factory_bot enabled in your cypress_helper
+CypressOnRails::SmartFactoryWrapper.create(:profile, name: "Cypress Hill")
+```
+
+Then reference the scenario in your test:
+```js
+// spec/playwright/e2e/scenario_example.spec.js
+import { test, expect } from "@playwright/test";
+import { app, appScenario } from '../../support/on-rails';
+
+test.describe("Rails using scenarios examples", () => {
+  test.beforeEach(async ({ page }) => {
+    await app('clean');
+  });
+
+  test("setup basic scenario", async ({ page }) => {
+    await appScenario('basic');
+    await page.goto("/");
+  });
+});
+```
+
+## Experimental Features (matching npm package)
+
+Please test and give feedback.
+
+Add the npm package:
 
 ```
 yarn add cypress-on-rails --dev
@@ -285,7 +335,7 @@ yarn add cypress-on-rails --dev
 
 ### for VCR
 
-This only works when you start the rails server with a single worker and single thread
+This only works when you start the Rails server with a single worker and single thread
 
 #### setup
 
@@ -298,13 +348,13 @@ VCR.configure do |config|
 end
 ```
 
-Add to you `cypress/support/index.js`
+Add to your `cypress/support/index.js`:
 
 ```js
 import 'cypress-on-rails/support/index'
 ```
 
-Add to you `clean.rb`
+Add to your `cypress/app_commands/clean.rb`:
 
 ```ruby
 VCR.eject_cassette # make sure we no cassettes inserted before the next test starts
@@ -312,7 +362,7 @@ VCR.turn_off!
 WebMock.disable! if defined?(WebMock)
 ```
 
-Add to you `config/cypress_on_rails.rb`
+Add to your `config/cypress_on_rails.rb`:
 
 ```ruby
   c.use_vcr_middleware = !Rails.env.production? && ENV['CYPRESS'].present?
@@ -324,11 +374,11 @@ You have `vcr_insert_cassette` and `vcr_eject_cassette` available. https://www.r
 
 
 ```js
-describe('My First Test', function() {
+describe('My First Test', () => {
   beforeEach(() => { cy.app('load_seed') })
 
-  it('visit root', function() {
-    cy.app('clean') // have a look at cypress/app_commands/clean.rb
+  it('visit root', () => {
+    cy.app('clean') // have a look at e2e/app_commands/clean.rb
 
     cy.vcr_insert_cassette('cats', { record: "new_episodes" })
     cy.visit('/using_vcr/index')
@@ -336,7 +386,7 @@ describe('My First Test', function() {
     cy.get('a').contains('Cats').click()
     cy.contains('Wikipedia has a recording of a cat meowing, because why not?')
 
-    cy.vcr_eject_cassette();
+    cy.vcr_eject_cassette()
 
     cy.vcr_insert_cassette('cats')
     cy.visit('/using_vcr/record_cats')
@@ -362,30 +412,30 @@ use CypressOnRails::Middleware
 run MyApp
 ```
 
-add the following file to cypress
+add the following file to Cypress
 
 ```js
 // test/cypress/support/on-rails.js
-// CypressOnRails: dont remove these command
-Cypress.Commands.add('appCommands', function (body) {
+// CypressOnRails: don't remove these commands
+Cypress.Commands.add('appCommands', (body) => {
   cy.request({
     method: 'POST',
-    url: "/__cypress__/command",
+    url: '/__cypress__/command',
     body: JSON.stringify(body),
     log: true,
     failOnStatusCode: true
   })
 });
 
-Cypress.Commands.add('app', function (name, command_options) {
+Cypress.Commands.add('app', (name, command_options) => {
   cy.appCommands({name: name, options: command_options})
 });
 
-Cypress.Commands.add('appScenario', function (name) {
+Cypress.Commands.add('appScenario', (name) => {
   cy.app('scenarios/' + name)
 });
 
-Cypress.Commands.add('appFactories', function (options) {
+Cypress.Commands.add('appFactories', (options) => {
   cy.app('factory_bot', options)
 });
 // CypressOnRails: end
@@ -396,6 +446,17 @@ beforeEach(() => {
 });
 ```
 
+## API Prefix
+
+If your Rails server is exposed under a proxy, typically https://my-local.dev/api, you can use the `api_prefix` option.
+In `config/initializers/cypress_on_rails.rb`, add this line:
+```ruby
+  CypressOnRails.configure do |c|
+    # ...
+    c.api_prefix = '/api'
+  end
+```
+
 ## Contributing
 
 1. Fork it ( https://github.com/shakacode/cypress-on-rails/fork )
@@ -404,14 +465,37 @@ beforeEach(() => {
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
 
-# Supporters
-
-The following companies support this open source project, and ShakaCode uses their products! Justin writes React on Rails on [RubyMine](https://www.jetbrains.com/ruby/). We use [Scout](https://scoutapp.com/) to monitor the live performance of [HiChee.com](https://HiChee.com), [Rails AutoScale](https://railsautoscale.com) to scale the dynos of HiChee, and [HoneyBadger](https://www.honeybadger.io/) to monitor application errors. We love [BrowserStack](https://www.browserstack.com) to solve problems with oddball browsers.
-
-[![RubyMine](https://user-images.githubusercontent.com/1118459/114100597-3b0e3000-9860-11eb-9b12-73beb1a184b2.png)](https://www.jetbrains.com/ruby/)
-[![Scout](https://user-images.githubusercontent.com/1118459/171088197-81555b69-9ed0-4235-9acf-fcb37ecfb949.png)](https://scoutapp.com/)
-[![Rails AutoScale](https://user-images.githubusercontent.com/1118459/103197530-48dc0e80-488a-11eb-8b1b-a16664b30274.png)](https://railsautoscale.com/)
-[![BrowserStack](https://cloud.githubusercontent.com/assets/1118459/23203304/1261e468-f886-11e6-819e-93b1a3f17da4.png)](https://www.browserstack.com)
-[![HoneyBadger](https://user-images.githubusercontent.com/1118459/114100696-63962a00-9860-11eb-8ac1-75ca02856d8e.png)](https://www.honeybadger.io/)
-
-ShakaCode's favorite project tracking tool is [Shortcut](https://shortcut.com/). If you want to **try Shortcut and get 2 months free beyond the 14-day trial period**, click [here to use ShakaCode's referral code](http://r.clbh.se/mvfoNeH). We're participating in their awesome triple-sided referral program, which you can read about [here](https://shortcut.com/referral/). By using our [referral code](http://r.clbh.se/mvfoNeH) you'll be supporting ShakaCode and, thus, React on Rails!
+## Supporters
+
+<a href="https://www.jetbrains.com">
+  <img src="https://user-images.githubusercontent.com/4244251/184881139-42e4076b-024b-4b30-8c60-c3cd0e758c0a.png" alt="JetBrains" height="120px">
+</a>
+<a href="https://scoutapp.com">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/4244251/184881147-0d077438-3978-40da-ace9-4f650d2efe2e.png">
+    <source media="(prefers-color-scheme: light)" srcset="https://user-images.githubusercontent.com/4244251/184881152-9f2d8fba-88ac-4ba6-873b-22387f8711c5.png">
+    <img alt="ScoutAPM" src="https://user-images.githubusercontent.com/4244251/184881152-9f2d8fba-88ac-4ba6-873b-22387f8711c5.png" height="120px">
+  </picture>
+</a>
+<br />
+<a href="https://www.browserstack.com">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/4244251/184881122-407dcc29-df78-4b20-a9ad-f597b56f6cdb.png">
+    <source media="(prefers-color-scheme: light)" srcset="https://user-images.githubusercontent.com/4244251/184881129-e1edf4b7-3ae1-4ea8-9e6d-3595cf01609e.png">
+    <img alt="BrowserStack" src="https://user-images.githubusercontent.com/4244251/184881129-e1edf4b7-3ae1-4ea8-9e6d-3595cf01609e.png" height="55px">
+  </picture>
+</a>
+<a href="https://railsautoscale.com">
+  <img src="https://user-images.githubusercontent.com/4244251/184881144-95c2c25c-9879-4069-864d-4e67d6ed39d2.png" alt="Rails Autoscale" height="55px">
+</a>
+<a href="https://www.honeybadger.io">
+  <img src="https://user-images.githubusercontent.com/4244251/184881133-79ee9c3c-8165-4852-958e-31687b9536f4.png" alt="Honeybadger" height="55px">
+</a>
+<a href="https://reviewable.io">
+  <img src="https://user-images.githubusercontent.com/20628911/230848305-c94510a4-82d7-468f-bf9f-eeb81d3f2ce0.png" alt="Reviewable" height="55px">
+</a>
+
+<br />
+<br />
+
+The following companies support our open source projects, and ShakaCode uses their products!

data/docs/authentication.md

@@ -1,6 +1,6 @@
 # Example for Authenticating a User
 
-in routes.rb
+In `config/routes.rb`:
 ```rb
 Rails.application.routes.draw do
   # ...... your other routes
@@ -12,7 +12,7 @@ Rails.application.routes.draw do
 end
 ```
 
-app/controllers/cypress_controller.rb
+`app/controllers/cypress_controller.rb`:
 ```rb
 class CypressController < ApplicationController
   skip_before_action :verify_authenticity_token
@@ -29,21 +29,23 @@ class CypressController < ApplicationController
 end
 ```
 
-in cypress/support/on-rails.js
+In `cypress/support/on-rails.js`:
 ```js
-Cypress.Commands.add("forceLogin", (details) => {
-  if(!details)
+Cypress.Commands.add('forceLogin', (details) => {
+  if (!details) {
     details = {}
+  }
 
-  if(!details.redirect_to)
+  if (!details.redirect_to) {
     details.redirect_to = '/'
+  }
 
-  cy.visit("__cypress__/forceLogin",
-    { method: "POST", body: { email: details.email, redirect_to: details.redirect_to }  })
-});
+  cy.visit('__cypress__/forceLogin',
+    { method: 'POST', body: { email: details.email, redirect_to: details.redirect_to } })
+})
 ```
 
-examples of usage in cypress specs
+Examples of usage in Cypress specs:
 ```js
 cy.forceLogin()
 cy.forceLogin({redirect_to: '/profile'})

data/docs/factory_bot_associations.md

@@ -1,6 +1,6 @@
 # Setting up associations with the correct data
 
-You cannot access associations directly from Cypress like you can do with ruby tests.
+You cannot access associations directly from Cypress like you can do with Ruby tests.
 So setting up associations has to be done differently from within Cypress.
 
 There are a few ways you can setup associations with the correct data using Cypress and FactoryBot.
@@ -27,7 +27,7 @@ You can do the following:
 
 ## 1. Setting the foreign keys
 
-factories.rb
+`factories.rb`:
 ```rb
 FactoryBot.define do
   factory :author do
@@ -45,13 +45,13 @@ then in Cypress
 ```js
 // example with overriding the defaults
 cy.appFactories([['create', 'author', { name: 'James' }]]).then((records) => {
-  cy.appFactories([['create', 'post', { title: 'Cypress is cool', author_id: records[0].id }]]
-});
+  cy.appFactories([['create', 'post', { title: 'Cypress is cool', author_id: records[0].id }]])
+})
 
 // example without overriding anything
 cy.appFactories([['create', 'author']]).then((records) => {
-  cy.appFactories([['create', 'post', { author_id: records[0].id }]]
-});
+  cy.appFactories([['create', 'post', { author_id: records[0].id }]])
+})
 ```
 
 ## 2. Using transient attributes
@@ -75,10 +75,10 @@ end
 then in Cypress
 ```js
 // example with overriding the defaults
-cy.appFactories([['create', 'post', { title: 'Cypress is cool', author_name: 'James' }]]
+cy.appFactories([['create', 'post', { title: 'Cypress is cool', author_name: 'James' }]])
 
 // example without overriding
-cy.appFactories([['create', 'post']]
+cy.appFactories([['create', 'post']])
 ```
 
 ## 3. Using Nested Attributes
@@ -99,11 +99,11 @@ end
 then in Cypress
 ```js
 // example with overriding the defaults
-cy.appFactories([['create', 'post', { title: 'Cypress is cool', author_attributes: { name: 'James' } }]]
+cy.appFactories([['create', 'post', { title: 'Cypress is cool', author_attributes: { name: 'James' } }]])
 
 // example without overriding
-cy.appFactories([['create', 'post']]
+cy.appFactories([['create', 'post']])
 
 // example of creating author with multiple posts
-cy.appFactories([['create', 'author', { name: 'James', posts_attributes: [{ name: 'Cypress is cool' }, {name: 'Rails is awesome' }] ]]
+cy.appFactories([['create', 'author', { name: 'James', posts_attributes: [{ name: 'Cypress is cool' }, {name: 'Rails is awesome' }] }]])
 ```